passenger 2.2.11 → 2.2.12

Sign up to get free protection for your applications and to get access to all the features.

Potentially problematic release.


This version of passenger might be problematic. Click here for more details.

Files changed (287) hide show
  1. data/NEWS +29 -0
  2. data/bin/passenger-install-nginx-module +1 -1
  3. data/doc/Users guide Apache.html +38 -7
  4. data/doc/Users guide Nginx.html +36 -5
  5. data/doc/cxxapi/AbstractSpawnManager_8h-source.html +1 -1
  6. data/doc/cxxapi/Account_8h-source.html +1 -1
  7. data/doc/cxxapi/AccountsDatabase_8h-source.html +1 -1
  8. data/doc/cxxapi/AgentsStarter_8h-source.html +1 -1
  9. data/doc/cxxapi/BCrypt_8h-source.html +1 -1
  10. data/doc/cxxapi/Blowfish_8h-source.html +1 -1
  11. data/doc/cxxapi/Bucket_8h-source.html +5 -4
  12. data/doc/cxxapi/Constants_8h-source.html +2 -2
  13. data/doc/cxxapi/ContentHandler_8h-source.html +1 -1
  14. data/doc/cxxapi/DirectoryMapper_8h-source.html +10 -9
  15. data/doc/cxxapi/EventedServer_8h-source.html +415 -0
  16. data/doc/cxxapi/Exceptions_8h-source.html +1 -1
  17. data/doc/cxxapi/FileDescriptor_8h-source.html +1 -1
  18. data/doc/cxxapi/Hooks_8h-source.html +3 -2
  19. data/doc/cxxapi/HttpStatusExtractor_8h-source.html +324 -323
  20. data/doc/cxxapi/Logging_8h-source.html +643 -546
  21. data/doc/cxxapi/MessageChannel_8h-source.html +429 -404
  22. data/doc/cxxapi/MessageClient_8h-source.html +1 -1
  23. data/doc/cxxapi/MessageReadersWriters_8h-source.html +451 -0
  24. data/doc/cxxapi/MessageServer_8h-source.html +1 -1
  25. data/doc/cxxapi/PoolOptions_8h-source.html +287 -279
  26. data/doc/cxxapi/Process_8h-source.html +178 -167
  27. data/doc/cxxapi/RandomGenerator_8h-source.html +45 -18
  28. data/doc/cxxapi/ResourceLocator_8h-source.html +3 -3
  29. data/doc/cxxapi/ScgiRequestParser_8h-source.html +344 -343
  30. data/doc/cxxapi/ServerInstanceDir_8h-source.html +1 -1
  31. data/doc/cxxapi/Session_8h-source.html +387 -374
  32. data/doc/cxxapi/SpawnManager_8h-source.html +547 -538
  33. data/doc/cxxapi/StaticContentHandler_8h-source.html +1 -1
  34. data/doc/cxxapi/StaticString_8h-source.html +1 -1
  35. data/doc/cxxapi/StringListCreator_8h-source.html +1 -1
  36. data/doc/cxxapi/Utils_8h-source.html +545 -520
  37. data/doc/cxxapi/annotated.html +11 -8
  38. data/doc/cxxapi/apache2_2Configuration_8h-source.html +1 -1
  39. data/doc/cxxapi/classAgentWatcher-members.html +1 -1
  40. data/doc/cxxapi/classAgentWatcher.html +1 -1
  41. data/doc/cxxapi/classClient-members.html +1 -1
  42. data/doc/cxxapi/classClient.html +1 -1
  43. data/doc/cxxapi/classHooks-members.html +16 -13
  44. data/doc/cxxapi/classHooks.html +69 -73
  45. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager-members.html +1 -1
  46. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager.html +1 -1
  47. data/doc/cxxapi/classPassenger_1_1ArgumentException-members.html +1 -1
  48. data/doc/cxxapi/classPassenger_1_1ArgumentException.html +1 -1
  49. data/doc/cxxapi/classPassenger_1_1ArrayReader-members.html +33 -0
  50. data/doc/cxxapi/classPassenger_1_1ArrayReader.html +47 -0
  51. data/doc/cxxapi/classPassenger_1_1BufferedUpload-members.html +1 -1
  52. data/doc/cxxapi/classPassenger_1_1BufferedUpload.html +1 -1
  53. data/doc/cxxapi/classPassenger_1_1BusyException-members.html +1 -1
  54. data/doc/cxxapi/classPassenger_1_1BusyException.html +1 -1
  55. data/doc/cxxapi/classPassenger_1_1ConfigurationException-members.html +1 -1
  56. data/doc/cxxapi/classPassenger_1_1ConfigurationException.html +1 -1
  57. data/doc/cxxapi/classPassenger_1_1DirectoryMapper-members.html +18 -15
  58. data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html +89 -99
  59. data/doc/cxxapi/classPassenger_1_1EOFException-members.html +1 -1
  60. data/doc/cxxapi/classPassenger_1_1EOFException.html +1 -1
  61. data/doc/cxxapi/classPassenger_1_1EventFd-members.html +1 -1
  62. data/doc/cxxapi/classPassenger_1_1EventFd.html +1 -1
  63. data/doc/cxxapi/classPassenger_1_1FileDescriptor-members.html +1 -1
  64. data/doc/cxxapi/classPassenger_1_1FileDescriptor.html +1 -1
  65. data/doc/cxxapi/classPassenger_1_1FileNotFoundException-members.html +1 -1
  66. data/doc/cxxapi/classPassenger_1_1FileNotFoundException.html +1 -1
  67. data/doc/cxxapi/classPassenger_1_1FileSystemException-members.html +1 -1
  68. data/doc/cxxapi/classPassenger_1_1FileSystemException.html +1 -1
  69. data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor-members.html +1 -1
  70. data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor.html +2 -2
  71. data/doc/cxxapi/classPassenger_1_1IOException-members.html +1 -1
  72. data/doc/cxxapi/classPassenger_1_1IOException.html +1 -1
  73. data/doc/cxxapi/classPassenger_1_1MemZeroGuard-members.html +1 -1
  74. data/doc/cxxapi/classPassenger_1_1MemZeroGuard.html +1 -1
  75. data/doc/cxxapi/classPassenger_1_1MessageChannel-members.html +1 -1
  76. data/doc/cxxapi/classPassenger_1_1MessageChannel.html +1 -1
  77. data/doc/cxxapi/classPassenger_1_1MessageServer-members.html +1 -1
  78. data/doc/cxxapi/classPassenger_1_1MessageServer.html +1 -1
  79. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext-members.html +1 -1
  80. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext.html +1 -1
  81. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext-members.html +1 -1
  82. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext.html +1 -1
  83. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler-members.html +1 -1
  84. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler.html +1 -1
  85. data/doc/cxxapi/classPassenger_1_1Process-members.html +4 -3
  86. data/doc/cxxapi/classPassenger_1_1Process.html +40 -9
  87. data/doc/cxxapi/classPassenger_1_1RandomGenerator-members.html +2 -1
  88. data/doc/cxxapi/classPassenger_1_1RandomGenerator.html +29 -2
  89. data/doc/cxxapi/classPassenger_1_1RuntimeException-members.html +1 -1
  90. data/doc/cxxapi/classPassenger_1_1RuntimeException.html +1 -1
  91. data/doc/cxxapi/classPassenger_1_1ScalarReader-members.html +33 -0
  92. data/doc/cxxapi/classPassenger_1_1ScalarReader.html +47 -0
  93. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser-members.html +1 -1
  94. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser.html +1 -1
  95. data/doc/cxxapi/classPassenger_1_1SecurityException-members.html +1 -1
  96. data/doc/cxxapi/classPassenger_1_1SecurityException.html +1 -1
  97. data/doc/cxxapi/classPassenger_1_1Session-members.html +1 -1
  98. data/doc/cxxapi/classPassenger_1_1Session.html +2 -2
  99. data/doc/cxxapi/classPassenger_1_1SpawnException-members.html +1 -1
  100. data/doc/cxxapi/classPassenger_1_1SpawnException.html +1 -1
  101. data/doc/cxxapi/classPassenger_1_1SpawnManager-members.html +2 -2
  102. data/doc/cxxapi/classPassenger_1_1SpawnManager.html +6 -18
  103. data/doc/cxxapi/classPassenger_1_1StandardSession-members.html +1 -1
  104. data/doc/cxxapi/classPassenger_1_1StandardSession.html +1 -1
  105. data/doc/cxxapi/classPassenger_1_1StaticString-members.html +1 -1
  106. data/doc/cxxapi/classPassenger_1_1StaticString.html +1 -1
  107. data/doc/cxxapi/classPassenger_1_1SystemException-members.html +1 -1
  108. data/doc/cxxapi/classPassenger_1_1SystemException.html +1 -1
  109. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException-members.html +1 -1
  110. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException.html +1 -1
  111. data/doc/cxxapi/classPassenger_1_1TimeoutException-members.html +1 -1
  112. data/doc/cxxapi/classPassenger_1_1TimeoutException.html +1 -1
  113. data/doc/cxxapi/classPassenger_1_1Uint16Reader-members.html +33 -0
  114. data/doc/cxxapi/classPassenger_1_1Uint16Reader.html +47 -0
  115. data/doc/cxxapi/classPassenger_1_1Uint32Reader-members.html +33 -0
  116. data/doc/cxxapi/classPassenger_1_1Uint32Reader.html +47 -0
  117. data/doc/cxxapi/classServer-members.html +1 -1
  118. data/doc/cxxapi/classServer.html +1 -1
  119. data/doc/cxxapi/classServerInstanceDirToucher-members.html +1 -1
  120. data/doc/cxxapi/classServerInstanceDirToucher.html +1 -1
  121. data/doc/cxxapi/classes.html +13 -10
  122. data/doc/cxxapi/definitions_8h-source.html +2 -1
  123. data/doc/cxxapi/doxygen.css +91 -0
  124. data/doc/cxxapi/files.html +16 -13
  125. data/doc/cxxapi/functions.html +32 -21
  126. data/doc/cxxapi/functions_enum.html +1 -1
  127. data/doc/cxxapi/functions_eval.html +1 -1
  128. data/doc/cxxapi/functions_func.html +32 -21
  129. data/doc/cxxapi/functions_vars.html +3 -1
  130. data/doc/cxxapi/graph_legend.html +20 -15
  131. data/doc/cxxapi/graph_legend.png +0 -0
  132. data/doc/cxxapi/group__Configuration.html +51 -64
  133. data/doc/cxxapi/group__Configuration.png +0 -0
  134. data/doc/cxxapi/group__Core.html +24 -26
  135. data/doc/cxxapi/group__Core.png +0 -0
  136. data/doc/cxxapi/group__Exceptions.html +1 -1
  137. data/doc/cxxapi/group__Hooks.html +17 -15
  138. data/doc/cxxapi/group__Hooks.png +0 -0
  139. data/doc/cxxapi/group__Support.html +11 -9
  140. data/doc/cxxapi/hierarchy.html +6 -1
  141. data/doc/cxxapi/index.html +10 -5
  142. data/doc/cxxapi/inherit__graph__10.map +1 -1
  143. data/doc/cxxapi/inherit__graph__10.md5 +1 -1
  144. data/doc/cxxapi/inherit__graph__10.png +0 -0
  145. data/doc/cxxapi/inherit__graph__11.map +1 -1
  146. data/doc/cxxapi/inherit__graph__11.md5 +1 -1
  147. data/doc/cxxapi/inherit__graph__11.png +0 -0
  148. data/doc/cxxapi/inherit__graph__12.map +1 -1
  149. data/doc/cxxapi/inherit__graph__12.md5 +1 -1
  150. data/doc/cxxapi/inherit__graph__12.png +0 -0
  151. data/doc/cxxapi/inherit__graph__13.map +1 -1
  152. data/doc/cxxapi/inherit__graph__13.md5 +1 -1
  153. data/doc/cxxapi/inherit__graph__13.png +0 -0
  154. data/doc/cxxapi/inherit__graph__14.map +1 -3
  155. data/doc/cxxapi/inherit__graph__14.md5 +1 -1
  156. data/doc/cxxapi/inherit__graph__14.png +0 -0
  157. data/doc/cxxapi/inherit__graph__15.map +1 -1
  158. data/doc/cxxapi/inherit__graph__15.md5 +1 -1
  159. data/doc/cxxapi/inherit__graph__15.png +0 -0
  160. data/doc/cxxapi/inherit__graph__16.map +3 -1
  161. data/doc/cxxapi/inherit__graph__16.md5 +1 -1
  162. data/doc/cxxapi/inherit__graph__16.png +0 -0
  163. data/doc/cxxapi/inherit__graph__17.map +1 -1
  164. data/doc/cxxapi/inherit__graph__17.md5 +1 -1
  165. data/doc/cxxapi/inherit__graph__17.png +0 -0
  166. data/doc/cxxapi/inherit__graph__18.map +1 -2
  167. data/doc/cxxapi/inherit__graph__18.md5 +1 -1
  168. data/doc/cxxapi/inherit__graph__18.png +0 -0
  169. data/doc/cxxapi/inherit__graph__19.map +1 -1
  170. data/doc/cxxapi/inherit__graph__19.md5 +1 -1
  171. data/doc/cxxapi/inherit__graph__19.png +0 -0
  172. data/doc/cxxapi/inherit__graph__20.map +2 -1
  173. data/doc/cxxapi/inherit__graph__20.md5 +1 -1
  174. data/doc/cxxapi/inherit__graph__20.png +0 -0
  175. data/doc/cxxapi/inherit__graph__21.map +1 -1
  176. data/doc/cxxapi/inherit__graph__21.md5 +1 -1
  177. data/doc/cxxapi/inherit__graph__21.png +0 -0
  178. data/doc/cxxapi/inherit__graph__22.map +1 -1
  179. data/doc/cxxapi/inherit__graph__22.md5 +1 -1
  180. data/doc/cxxapi/inherit__graph__22.png +0 -0
  181. data/doc/cxxapi/inherit__graph__23.map +1 -1
  182. data/doc/cxxapi/inherit__graph__23.md5 +1 -1
  183. data/doc/cxxapi/inherit__graph__23.png +0 -0
  184. data/doc/cxxapi/inherit__graph__24.map +1 -1
  185. data/doc/cxxapi/inherit__graph__24.md5 +1 -1
  186. data/doc/cxxapi/inherit__graph__24.png +0 -0
  187. data/doc/cxxapi/inherit__graph__25.map +1 -1
  188. data/doc/cxxapi/inherit__graph__25.md5 +1 -1
  189. data/doc/cxxapi/inherit__graph__25.png +0 -0
  190. data/doc/cxxapi/inherit__graph__26.map +1 -1
  191. data/doc/cxxapi/inherit__graph__26.md5 +1 -1
  192. data/doc/cxxapi/inherit__graph__26.png +0 -0
  193. data/doc/cxxapi/inherit__graph__27.map +1 -2
  194. data/doc/cxxapi/inherit__graph__27.md5 +1 -1
  195. data/doc/cxxapi/inherit__graph__27.png +0 -0
  196. data/doc/cxxapi/inherit__graph__28.map +1 -1
  197. data/doc/cxxapi/inherit__graph__28.md5 +1 -1
  198. data/doc/cxxapi/inherit__graph__28.png +0 -0
  199. data/doc/cxxapi/inherit__graph__29.map +1 -1
  200. data/doc/cxxapi/inherit__graph__29.md5 +1 -1
  201. data/doc/cxxapi/inherit__graph__29.png +0 -0
  202. data/doc/cxxapi/inherit__graph__30.map +2 -1
  203. data/doc/cxxapi/inherit__graph__30.md5 +1 -1
  204. data/doc/cxxapi/inherit__graph__30.png +0 -0
  205. data/doc/cxxapi/inherit__graph__31.map +1 -3
  206. data/doc/cxxapi/inherit__graph__31.md5 +1 -1
  207. data/doc/cxxapi/inherit__graph__31.png +0 -0
  208. data/doc/cxxapi/inherit__graph__32.map +1 -1
  209. data/doc/cxxapi/inherit__graph__32.md5 +1 -1
  210. data/doc/cxxapi/inherit__graph__32.png +0 -0
  211. data/doc/cxxapi/inherit__graph__33.map +1 -1
  212. data/doc/cxxapi/inherit__graph__33.md5 +1 -1
  213. data/doc/cxxapi/inherit__graph__33.png +0 -0
  214. data/doc/cxxapi/inherit__graph__34.map +3 -1
  215. data/doc/cxxapi/inherit__graph__34.md5 +1 -1
  216. data/doc/cxxapi/inherit__graph__34.png +0 -0
  217. data/doc/cxxapi/inherit__graph__35.map +1 -1
  218. data/doc/cxxapi/inherit__graph__35.md5 +1 -1
  219. data/doc/cxxapi/inherit__graph__35.png +0 -0
  220. data/doc/cxxapi/inherit__graph__36.map +1 -1
  221. data/doc/cxxapi/inherit__graph__36.md5 +1 -1
  222. data/doc/cxxapi/inherit__graph__36.png +0 -0
  223. data/doc/cxxapi/inherit__graph__37.map +1 -0
  224. data/doc/cxxapi/inherit__graph__37.md5 +1 -0
  225. data/doc/cxxapi/inherit__graph__37.png +0 -0
  226. data/doc/cxxapi/inherit__graph__38.map +1 -0
  227. data/doc/cxxapi/inherit__graph__38.md5 +1 -0
  228. data/doc/cxxapi/inherit__graph__38.png +0 -0
  229. data/doc/cxxapi/inherit__graph__39.map +1 -0
  230. data/doc/cxxapi/inherit__graph__39.md5 +1 -0
  231. data/doc/cxxapi/inherit__graph__39.png +0 -0
  232. data/doc/cxxapi/inherit__graph__5.map +1 -1
  233. data/doc/cxxapi/inherit__graph__5.md5 +1 -1
  234. data/doc/cxxapi/inherit__graph__5.png +0 -0
  235. data/doc/cxxapi/inherit__graph__6.map +1 -1
  236. data/doc/cxxapi/inherit__graph__6.md5 +1 -1
  237. data/doc/cxxapi/inherit__graph__6.png +0 -0
  238. data/doc/cxxapi/inherit__graph__7.map +1 -1
  239. data/doc/cxxapi/inherit__graph__7.md5 +1 -1
  240. data/doc/cxxapi/inherit__graph__7.png +0 -0
  241. data/doc/cxxapi/inherit__graph__8.map +1 -1
  242. data/doc/cxxapi/inherit__graph__8.md5 +1 -1
  243. data/doc/cxxapi/inherit__graph__8.png +0 -0
  244. data/doc/cxxapi/inherit__graph__9.map +1 -1
  245. data/doc/cxxapi/inherit__graph__9.md5 +1 -1
  246. data/doc/cxxapi/inherit__graph__9.png +0 -0
  247. data/doc/cxxapi/inherits.html +46 -31
  248. data/doc/cxxapi/main.html +12 -11
  249. data/doc/cxxapi/modules.html +16 -13
  250. data/doc/cxxapi/namespacePassenger.html +82 -5
  251. data/doc/cxxapi/namespacemembers.html +5 -3
  252. data/doc/cxxapi/namespacemembers_enum.html +1 -1
  253. data/doc/cxxapi/namespacemembers_eval.html +1 -1
  254. data/doc/cxxapi/namespacemembers_func.html +5 -3
  255. data/doc/cxxapi/namespacemembers_type.html +1 -1
  256. data/doc/cxxapi/namespaces.html +2 -2
  257. data/doc/cxxapi/nginx_2Configuration_8h-source.html +43 -42
  258. data/doc/cxxapi/ngx__http__passenger__module_8h-source.html +1 -1
  259. data/doc/cxxapi/structPassenger_1_1AnythingToString-members.html +1 -1
  260. data/doc/cxxapi/structPassenger_1_1AnythingToString.html +1 -1
  261. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01StaticString_01_4_01_4-members.html +33 -0
  262. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01StaticString_01_4_01_4.html +52 -0
  263. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4-members.html +1 -1
  264. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html +1 -1
  265. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard-members.html +1 -1
  266. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html +1 -1
  267. data/doc/cxxapi/structPassenger_1_1PoolOptions-members.html +3 -2
  268. data/doc/cxxapi/structPassenger_1_1PoolOptions.html +25 -5
  269. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash-members.html +1 -1
  270. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash.html +1 -1
  271. data/doc/cxxapi/tabs.css +1 -1
  272. data/doc/cxxapi/tree.html +20 -17
  273. data/doc/users_guide_snippets/tips.txt +28 -0
  274. data/ext/apache2/Hooks.cpp +19 -2
  275. data/ext/common/Utils.cpp +15 -4
  276. data/ext/common/Version.h +1 -1
  277. data/ext/nginx/StaticContentHandler.c +6 -3
  278. data/ext/phusion_passenger/native_support.c +25 -0
  279. data/lib/phusion_passenger/abstract_request_handler.rb +1 -0
  280. data/lib/phusion_passenger/constants.rb +1 -1
  281. data/lib/phusion_passenger/events.rb +3 -0
  282. data/lib/phusion_passenger/platform_info.rb +2 -1
  283. data/lib/phusion_passenger/rack/application_spawner.rb +2 -0
  284. data/lib/phusion_passenger/railz/application_spawner.rb +8 -0
  285. data/lib/phusion_passenger/utils.rb +69 -9
  286. data/lib/phusion_passenger/utils/rewindable_input.rb +10 -6
  287. metadata +55 -17
@@ -58,7 +58,7 @@
58
58
  <a name="l00036"></a>00036
59
59
  <a name="l00037"></a>00037 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_NGINX_STATIC_CONTENT_HANDLER_H_ */</span>
60
60
  </pre></div></div>
61
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
61
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
62
62
  <a href="http://www.doxygen.org/index.html">
63
63
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
64
64
  </body>
@@ -207,7 +207,7 @@
207
207
  <a name="l00185"></a>00185
208
208
  <a name="l00186"></a>00186 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_STATIC_STRING_H_ */</span>
209
209
  </pre></div></div>
210
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
210
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
211
211
  <a href="http://www.doxygen.org/index.html">
212
212
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
213
213
  </body>
@@ -104,7 +104,7 @@
104
104
  <a name="l00082"></a>00082
105
105
  <a name="l00083"></a>00083 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_STRING_LIST_CREATOR_H_ */</span>
106
106
  </pre></div></div>
107
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
107
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
108
108
  <a href="http://www.doxygen.org/index.html">
109
109
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
110
110
  </body>
@@ -125,538 +125,563 @@
125
125
  <a name="l00103"></a>00103 <span class="comment"></span>
126
126
  <a name="l00104"></a>00104 <span class="comment">/**</span>
127
127
  <a name="l00105"></a>00105 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
128
- <a name="l00106"></a>00106 <span class="comment"> *</span>
129
- <a name="l00107"></a>00107 <span class="comment"> * @internal</span>
130
- <a name="l00108"></a>00108 <span class="comment"> */</span>
131
- <a name="l00109"></a>00109 <span class="keyword">template</span>&lt;&gt;
132
- <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>&lt; vector&lt;string&gt; &gt; {
133
- <a name="l00111"></a>00111 <span class="keywordtype">string</span> operator()(<span class="keyword">const</span> vector&lt;string&gt; &amp;v) {
134
- <a name="l00112"></a>00112 <span class="keywordtype">string</span> result(<span class="stringliteral">"["</span>);
135
- <a name="l00113"></a>00113 vector&lt;string&gt;::const_iterator it;
136
- <a name="l00114"></a>00114 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
137
- <a name="l00115"></a>00115 <span class="keywordflow">for</span> (it = v.begin(), i = 0; it != v.end(); it++, i++) {
138
- <a name="l00116"></a>00116 result.append(<span class="stringliteral">"'"</span>);
139
- <a name="l00117"></a>00117 result.append(*it);
140
- <a name="l00118"></a>00118 <span class="keywordflow">if</span> (i == v.size() - 1) {
141
- <a name="l00119"></a>00119 result.append(<span class="stringliteral">"'"</span>);
142
- <a name="l00120"></a>00120 } <span class="keywordflow">else</span> {
143
- <a name="l00121"></a>00121 result.append(<span class="stringliteral">"', "</span>);
144
- <a name="l00122"></a>00122 }
145
- <a name="l00123"></a>00123 }
146
- <a name="l00124"></a>00124 result.append(<span class="stringliteral">"]"</span>);
147
- <a name="l00125"></a>00125 <span class="keywordflow">return</span> result;
148
- <a name="l00126"></a>00126 }
149
- <a name="l00127"></a>00127 };
150
- <a name="l00128"></a>00128 <span class="comment"></span>
151
- <a name="l00129"></a>00129 <span class="comment">/**</span>
152
- <a name="l00130"></a>00130 <span class="comment"> * Convert anything to a string.</span>
153
- <a name="l00131"></a>00131 <span class="comment"> *</span>
154
- <a name="l00132"></a>00132 <span class="comment"> * @param something The thing to convert.</span>
155
- <a name="l00133"></a>00133 <span class="comment"> * @ingroup Support</span>
156
- <a name="l00134"></a>00134 <span class="comment"> */</span>
157
- <a name="l00135"></a>00135 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">string</span>
158
- <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) {
159
- <a name="l00137"></a>00137 <span class="keywordflow">return</span> <a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString&lt;T&gt;</a>()(something);
160
- <a name="l00138"></a>00138 }
161
- <a name="l00139"></a>00139 <span class="comment"></span>
162
- <a name="l00140"></a>00140 <span class="comment">/**</span>
163
- <a name="l00141"></a>00141 <span class="comment"> * Converts the given string to an integer.</span>
164
- <a name="l00142"></a>00142 <span class="comment"> * @ingroup Support</span>
165
- <a name="l00143"></a>00143 <span class="comment"> */</span>
166
- <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> &amp;s);
167
- <a name="l00145"></a>00145 <span class="comment"></span>
168
- <a name="l00146"></a>00146 <span class="comment">/**</span>
169
- <a name="l00147"></a>00147 <span class="comment"> * Converts the given string to a long integer.</span>
170
- <a name="l00148"></a>00148 <span class="comment"> * @ingroup Support</span>
171
- <a name="l00149"></a>00149 <span class="comment"> */</span>
172
- <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> &amp;s);
128
+ <a name="l00106"></a>00106 <span class="comment"> * @internal</span>
129
+ <a name="l00107"></a>00107 <span class="comment"> */</span>
130
+ <a name="l00108"></a>00108 <span class="keyword">template</span>&lt;&gt;
131
+ <a name="l00109"></a><a class="code" href="structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html">00109</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a>&lt; vector&lt;string&gt; &gt; {
132
+ <a name="l00110"></a>00110 <span class="keywordtype">string</span> operator()(<span class="keyword">const</span> vector&lt;string&gt; &amp;v) {
133
+ <a name="l00111"></a>00111 <span class="keywordtype">string</span> result = <span class="stringliteral">"["</span>;
134
+ <a name="l00112"></a>00112 vector&lt;string&gt;::const_iterator it;
135
+ <a name="l00113"></a>00113 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
136
+ <a name="l00114"></a>00114 <span class="keywordflow">for</span> (it = v.begin(), i = 0; it != v.end(); it++, i++) {
137
+ <a name="l00115"></a>00115 result.append(<span class="stringliteral">"'"</span>);
138
+ <a name="l00116"></a>00116 result.append(*it);
139
+ <a name="l00117"></a>00117 <span class="keywordflow">if</span> (i == v.size() - 1) {
140
+ <a name="l00118"></a>00118 result.append(<span class="stringliteral">"'"</span>);
141
+ <a name="l00119"></a>00119 } <span class="keywordflow">else</span> {
142
+ <a name="l00120"></a>00120 result.append(<span class="stringliteral">"', "</span>);
143
+ <a name="l00121"></a>00121 }
144
+ <a name="l00122"></a>00122 }
145
+ <a name="l00123"></a>00123 result.append(<span class="stringliteral">"]"</span>);
146
+ <a name="l00124"></a>00124 <span class="keywordflow">return</span> result;
147
+ <a name="l00125"></a>00125 }
148
+ <a name="l00126"></a>00126 };
149
+ <a name="l00127"></a>00127 <span class="comment"></span>
150
+ <a name="l00128"></a>00128 <span class="comment">/**</span>
151
+ <a name="l00129"></a>00129 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
152
+ <a name="l00130"></a>00130 <span class="comment"> * @internal</span>
153
+ <a name="l00131"></a>00131 <span class="comment"> */</span>
154
+ <a name="l00132"></a>00132 <span class="keyword">template</span>&lt;&gt;
155
+ <a name="l00133"></a><a class="code" href="structPassenger_1_1AnythingToString_3_01vector_3_01StaticString_01_4_01_4.html">00133</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a>&lt; vector&lt;<a class="code" href="classPassenger_1_1StaticString.html" title="An immutable, static byte buffer.">StaticString</a>&gt; &gt; {
156
+ <a name="l00134"></a>00134 <span class="keywordtype">string</span> operator()(<span class="keyword">const</span> vector&lt;StaticString&gt; &amp;v) {
157
+ <a name="l00135"></a>00135 <span class="keywordtype">string</span> result = <span class="stringliteral">"["</span>;
158
+ <a name="l00136"></a>00136 vector&lt;StaticString&gt;::const_iterator it;
159
+ <a name="l00137"></a>00137 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
160
+ <a name="l00138"></a>00138 <span class="keywordflow">for</span> (it = v.begin(), i = 0; it != v.end(); it++, i++) {
161
+ <a name="l00139"></a>00139 result.append(<span class="stringliteral">"'"</span>);
162
+ <a name="l00140"></a>00140 result.append(it-&gt;data(), it-&gt;size());
163
+ <a name="l00141"></a>00141 <span class="keywordflow">if</span> (i == v.size() - 1) {
164
+ <a name="l00142"></a>00142 result.append(<span class="stringliteral">"'"</span>);
165
+ <a name="l00143"></a>00143 } <span class="keywordflow">else</span> {
166
+ <a name="l00144"></a>00144 result.append(<span class="stringliteral">"', "</span>);
167
+ <a name="l00145"></a>00145 }
168
+ <a name="l00146"></a>00146 }
169
+ <a name="l00147"></a>00147 result.append(<span class="stringliteral">"]"</span>);
170
+ <a name="l00148"></a>00148 <span class="keywordflow">return</span> result;
171
+ <a name="l00149"></a>00149 }
172
+ <a name="l00150"></a>00150 };
173
173
  <a name="l00151"></a>00151 <span class="comment"></span>
174
- <a name="l00152"></a>00152 <span class="comment">/** Round &lt;em&gt;number&lt;/em&gt; up to the nearest multiple of &lt;em&gt;multiple&lt;/em&gt;. */</span>
175
- <a name="l00153"></a>00153 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> IntType&gt; IntType
176
- <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) {
177
- <a name="l00155"></a>00155 <span class="keywordflow">return</span> (number + multiple - 1) / multiple * multiple;
178
- <a name="l00156"></a>00156 }
179
- <a name="l00157"></a>00157 <span class="comment"></span>
180
- <a name="l00158"></a>00158 <span class="comment">/**</span>
181
- <a name="l00159"></a>00159 <span class="comment"> * Split the given string using the given separator.</span>
182
- <a name="l00160"></a>00160 <span class="comment"> *</span>
183
- <a name="l00161"></a>00161 <span class="comment"> * @param str The string to split.</span>
184
- <a name="l00162"></a>00162 <span class="comment"> * @param sep The separator to use.</span>
185
- <a name="l00163"></a>00163 <span class="comment"> * @param output The vector to write the output to.</span>
186
- <a name="l00164"></a>00164 <span class="comment"> * @ingroup Support</span>
187
- <a name="l00165"></a>00165 <span class="comment"> */</span>
188
- <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> &amp;str, <span class="keywordtype">char</span> sep, vector&lt;string&gt; &amp;output);
189
- <a name="l00167"></a>00167 <span class="comment"></span>
190
- <a name="l00168"></a>00168 <span class="comment">/**</span>
191
- <a name="l00169"></a>00169 <span class="comment"> * Check whether the specified file exists.</span>
192
- <a name="l00170"></a>00170 <span class="comment"> *</span>
193
- <a name="l00171"></a>00171 <span class="comment"> * @param filename The filename to check.</span>
194
- <a name="l00172"></a>00172 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
195
- <a name="l00173"></a>00173 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
196
- <a name="l00174"></a>00174 <span class="comment"> * @return Whether the file exists.</span>
197
- <a name="l00175"></a>00175 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
198
- <a name="l00176"></a>00176 <span class="comment"> * @throws TimeRetrievalException</span>
199
- <a name="l00177"></a>00177 <span class="comment"> * @throws boost::thread_interrupted</span>
200
- <a name="l00178"></a>00178 <span class="comment"> * @ingroup Support</span>
201
- <a name="l00179"></a>00179 <span class="comment"> */</span>
202
- <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 &amp;filename, CachedFileStat *cstat = 0,
203
- <a name="l00181"></a>00181 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
204
- <a name="l00182"></a>00182 <span class="comment"></span>
205
- <a name="l00183"></a>00183 <span class="comment">/**</span>
206
- <a name="l00184"></a>00184 <span class="comment"> * Check whether 'filename' exists and what kind of file it is.</span>
207
- <a name="l00185"></a>00185 <span class="comment"> *</span>
208
- <a name="l00186"></a>00186 <span class="comment"> * @param filename The filename to check.</span>
209
- <a name="l00187"></a>00187 <span class="comment"> * @param mstat A CachedFileStat object, if you want to use cached statting.</span>
210
- <a name="l00188"></a>00188 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
211
- <a name="l00189"></a>00189 <span class="comment"> * @return The file type.</span>
212
- <a name="l00190"></a>00190 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
213
- <a name="l00191"></a>00191 <span class="comment"> * @throws TimeRetrievalException</span>
214
- <a name="l00192"></a>00192 <span class="comment"> * @throws boost::thread_interrupted</span>
215
- <a name="l00193"></a>00193 <span class="comment"> * @ingroup Support</span>
216
- <a name="l00194"></a>00194 <span class="comment"> */</span>
217
- <a name="l00195"></a>00195 FileType <a class="code" href="group__Support.html#g15298b031377d3ecb80295bd5b1a8180" title="Check whether &amp;#39;filename&amp;#39; exists and what kind of file it is.">getFileType</a>(<span class="keyword">const</span> StaticString &amp;filename, CachedFileStat *cstat = 0,
218
- <a name="l00196"></a>00196 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
219
- <a name="l00197"></a>00197 <span class="comment"></span>
220
- <a name="l00198"></a>00198 <span class="comment">/**</span>
221
- <a name="l00199"></a>00199 <span class="comment"> * Create the given file with the given contents, permissions and ownership.</span>
222
- <a name="l00200"></a>00200 <span class="comment"> * This function does not leave behind junk files: if the ownership cannot be set</span>
223
- <a name="l00201"></a>00201 <span class="comment"> * or if not all data can be written then then the file will be deleted.</span>
224
- <a name="l00202"></a>00202 <span class="comment"> *</span>
225
- <a name="l00203"></a>00203 <span class="comment"> * @param filename The file to create.</span>
226
- <a name="l00204"></a>00204 <span class="comment"> * @param contents The contents to write to the file.</span>
227
- <a name="l00205"></a>00205 <span class="comment"> * @param permissions The desired file permissions.</span>
228
- <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>
229
- <a name="l00207"></a>00207 <span class="comment"> * process's owner as the file owner.</span>
230
- <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>
231
- <a name="l00209"></a>00209 <span class="comment"> * process's group as the file group.</span>
232
- <a name="l00210"></a>00210 <span class="comment"> * @param overwrite Whether to overwrite the file if it exists. If set to false</span>
233
- <a name="l00211"></a>00211 <span class="comment"> * and the file exists then nothing will happen.</span>
234
- <a name="l00212"></a>00212 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
235
- <a name="l00213"></a>00213 <span class="comment"> * @ingroup Support</span>
236
- <a name="l00214"></a>00214 <span class="comment"> */</span>
237
- <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> &amp;filename, <span class="keyword">const</span> StaticString &amp;contents,
238
- <a name="l00216"></a>00216 mode_t permissions = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH,
239
- <a name="l00217"></a>00217 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN,
240
- <a name="l00218"></a>00218 <span class="keywordtype">bool</span> overwrite = <span class="keyword">true</span>);
241
- <a name="l00219"></a>00219 <span class="comment"></span>
242
- <a name="l00220"></a>00220 <span class="comment">/**</span>
243
- <a name="l00221"></a>00221 <span class="comment"> * Returns a canonical version of the specified path. All symbolic links</span>
244
- <a name="l00222"></a>00222 <span class="comment"> * and relative path elements are resolved.</span>
245
- <a name="l00223"></a>00223 <span class="comment"> *</span>
246
- <a name="l00224"></a>00224 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
247
- <a name="l00225"></a>00225 <span class="comment"> * @ingroup Support</span>
248
- <a name="l00226"></a>00226 <span class="comment"> */</span>
249
- <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> &amp;path);
250
- <a name="l00228"></a>00228 <span class="comment"></span>
251
- <a name="l00229"></a>00229 <span class="comment">/**</span>
252
- <a name="l00230"></a>00230 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; refers to a symlink, then this function resolves the</span>
253
- <a name="l00231"></a>00231 <span class="comment"> * symlink for 1 level. That is, if the symlink points to another symlink,</span>
254
- <a name="l00232"></a>00232 <span class="comment"> * then the other symlink will not be resolved. The resolved path is returned.</span>
255
- <a name="l00233"></a>00233 <span class="comment"> *</span>
256
- <a name="l00234"></a>00234 <span class="comment"> * If the symlink doesn't point to an absolute path, then this function will</span>
257
- <a name="l00235"></a>00235 <span class="comment"> * prepend &lt;em&gt;path&lt;/em&gt;'s directory to the result.</span>
258
- <a name="l00236"></a>00236 <span class="comment"> *</span>
259
- <a name="l00237"></a>00237 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; doesn't refer to a symlink then this method will return</span>
260
- <a name="l00238"></a>00238 <span class="comment"> * &lt;em&gt;path&lt;/em&gt;.</span>
261
- <a name="l00239"></a>00239 <span class="comment"> *</span>
262
- <a name="l00240"></a>00240 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
263
- <a name="l00241"></a>00241 <span class="comment"> * @ingroup Support</span>
264
- <a name="l00242"></a>00242 <span class="comment"> */</span>
265
- <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> &amp;path);
266
- <a name="l00244"></a>00244 <span class="comment"></span>
267
- <a name="l00245"></a>00245 <span class="comment">/**</span>
268
- <a name="l00246"></a>00246 <span class="comment"> * Given a path, extracts its directory name.</span>
269
- <a name="l00247"></a>00247 <span class="comment"> *</span>
174
+ <a name="l00152"></a>00152 <span class="comment">/**</span>
175
+ <a name="l00153"></a>00153 <span class="comment"> * Convert anything to a string.</span>
176
+ <a name="l00154"></a>00154 <span class="comment"> *</span>
177
+ <a name="l00155"></a>00155 <span class="comment"> * @param something The thing to convert.</span>
178
+ <a name="l00156"></a>00156 <span class="comment"> * @ingroup Support</span>
179
+ <a name="l00157"></a>00157 <span class="comment"> */</span>
180
+ <a name="l00158"></a>00158 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">string</span>
181
+ <a name="l00159"></a><a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407">00159</a> <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(T something) {
182
+ <a name="l00160"></a>00160 <span class="keywordflow">return</span> <a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString&lt;T&gt;</a>()(something);
183
+ <a name="l00161"></a>00161 }
184
+ <a name="l00162"></a>00162 <span class="comment"></span>
185
+ <a name="l00163"></a>00163 <span class="comment">/**</span>
186
+ <a name="l00164"></a>00164 <span class="comment"> * Converts the given string to an integer.</span>
187
+ <a name="l00165"></a>00165 <span class="comment"> * @ingroup Support</span>
188
+ <a name="l00166"></a>00166 <span class="comment"> */</span>
189
+ <a name="l00167"></a>00167 <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> &amp;s);
190
+ <a name="l00168"></a>00168 <span class="comment"></span>
191
+ <a name="l00169"></a>00169 <span class="comment">/**</span>
192
+ <a name="l00170"></a>00170 <span class="comment"> * Converts the given string to a long integer.</span>
193
+ <a name="l00171"></a>00171 <span class="comment"> * @ingroup Support</span>
194
+ <a name="l00172"></a>00172 <span class="comment"> */</span>
195
+ <a name="l00173"></a>00173 <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> &amp;s);
196
+ <a name="l00174"></a>00174 <span class="comment"></span>
197
+ <a name="l00175"></a>00175 <span class="comment">/** Round &lt;em&gt;number&lt;/em&gt; up to the nearest multiple of &lt;em&gt;multiple&lt;/em&gt;. */</span>
198
+ <a name="l00176"></a>00176 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> IntType&gt; IntType
199
+ <a name="l00177"></a><a class="code" href="namespacePassenger.html#6b2bc9d6fa3848e01fd8c164d30737cc">00177</a> <a class="code" href="namespacePassenger.html#6b2bc9d6fa3848e01fd8c164d30737cc" title="Round number up to the nearest multiple of multiple.">roundUp</a>(IntType number, IntType multiple) {
200
+ <a name="l00178"></a>00178 <span class="keywordflow">return</span> (number + multiple - 1) / multiple * multiple;
201
+ <a name="l00179"></a>00179 }
202
+ <a name="l00180"></a>00180 <span class="comment"></span>
203
+ <a name="l00181"></a>00181 <span class="comment">/**</span>
204
+ <a name="l00182"></a>00182 <span class="comment"> * Split the given string using the given separator.</span>
205
+ <a name="l00183"></a>00183 <span class="comment"> *</span>
206
+ <a name="l00184"></a>00184 <span class="comment"> * @param str The string to split.</span>
207
+ <a name="l00185"></a>00185 <span class="comment"> * @param sep The separator to use.</span>
208
+ <a name="l00186"></a>00186 <span class="comment"> * @param output The vector to write the output to.</span>
209
+ <a name="l00187"></a>00187 <span class="comment"> * @ingroup Support</span>
210
+ <a name="l00188"></a>00188 <span class="comment"> */</span>
211
+ <a name="l00189"></a>00189 <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> &amp;str, <span class="keywordtype">char</span> sep, vector&lt;string&gt; &amp;output);
212
+ <a name="l00190"></a>00190 <span class="comment"></span>
213
+ <a name="l00191"></a>00191 <span class="comment">/**</span>
214
+ <a name="l00192"></a>00192 <span class="comment"> * Check whether the specified file exists.</span>
215
+ <a name="l00193"></a>00193 <span class="comment"> *</span>
216
+ <a name="l00194"></a>00194 <span class="comment"> * @param filename The filename to check.</span>
217
+ <a name="l00195"></a>00195 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
218
+ <a name="l00196"></a>00196 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
219
+ <a name="l00197"></a>00197 <span class="comment"> * @return Whether the file exists.</span>
220
+ <a name="l00198"></a>00198 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
221
+ <a name="l00199"></a>00199 <span class="comment"> * @throws TimeRetrievalException</span>
222
+ <a name="l00200"></a>00200 <span class="comment"> * @throws boost::thread_interrupted</span>
223
+ <a name="l00201"></a>00201 <span class="comment"> * @ingroup Support</span>
224
+ <a name="l00202"></a>00202 <span class="comment"> */</span>
225
+ <a name="l00203"></a>00203 <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 &amp;filename, CachedFileStat *cstat = 0,
226
+ <a name="l00204"></a>00204 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
227
+ <a name="l00205"></a>00205 <span class="comment"></span>
228
+ <a name="l00206"></a>00206 <span class="comment">/**</span>
229
+ <a name="l00207"></a>00207 <span class="comment"> * Check whether 'filename' exists and what kind of file it is.</span>
230
+ <a name="l00208"></a>00208 <span class="comment"> *</span>
231
+ <a name="l00209"></a>00209 <span class="comment"> * @param filename The filename to check.</span>
232
+ <a name="l00210"></a>00210 <span class="comment"> * @param mstat A CachedFileStat object, if you want to use cached statting.</span>
233
+ <a name="l00211"></a>00211 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
234
+ <a name="l00212"></a>00212 <span class="comment"> * @return The file type.</span>
235
+ <a name="l00213"></a>00213 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
236
+ <a name="l00214"></a>00214 <span class="comment"> * @throws TimeRetrievalException</span>
237
+ <a name="l00215"></a>00215 <span class="comment"> * @throws boost::thread_interrupted</span>
238
+ <a name="l00216"></a>00216 <span class="comment"> * @ingroup Support</span>
239
+ <a name="l00217"></a>00217 <span class="comment"> */</span>
240
+ <a name="l00218"></a>00218 FileType <a class="code" href="group__Support.html#g15298b031377d3ecb80295bd5b1a8180" title="Check whether &amp;#39;filename&amp;#39; exists and what kind of file it is.">getFileType</a>(<span class="keyword">const</span> StaticString &amp;filename, CachedFileStat *cstat = 0,
241
+ <a name="l00219"></a>00219 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
242
+ <a name="l00220"></a>00220 <span class="comment"></span>
243
+ <a name="l00221"></a>00221 <span class="comment">/**</span>
244
+ <a name="l00222"></a>00222 <span class="comment"> * Create the given file with the given contents, permissions and ownership.</span>
245
+ <a name="l00223"></a>00223 <span class="comment"> * This function does not leave behind junk files: if the ownership cannot be set</span>
246
+ <a name="l00224"></a>00224 <span class="comment"> * or if not all data can be written then then the file will be deleted.</span>
247
+ <a name="l00225"></a>00225 <span class="comment"> *</span>
248
+ <a name="l00226"></a>00226 <span class="comment"> * @param filename The file to create.</span>
249
+ <a name="l00227"></a>00227 <span class="comment"> * @param contents The contents to write to the file.</span>
250
+ <a name="l00228"></a>00228 <span class="comment"> * @param permissions The desired file permissions.</span>
251
+ <a name="l00229"></a>00229 <span class="comment"> * @param owner The desired file owner. Specify USER_NOT_GIVEN if you want to use the current</span>
252
+ <a name="l00230"></a>00230 <span class="comment"> * process's owner as the file owner.</span>
253
+ <a name="l00231"></a>00231 <span class="comment"> * @param group The desired file group. Specify GROUP_NOT_GIVEN if you want to use the current</span>
254
+ <a name="l00232"></a>00232 <span class="comment"> * process's group as the file group.</span>
255
+ <a name="l00233"></a>00233 <span class="comment"> * @param overwrite Whether to overwrite the file if it exists. If set to false</span>
256
+ <a name="l00234"></a>00234 <span class="comment"> * and the file exists then nothing will happen.</span>
257
+ <a name="l00235"></a>00235 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
258
+ <a name="l00236"></a>00236 <span class="comment"> * @ingroup Support</span>
259
+ <a name="l00237"></a>00237 <span class="comment"> */</span>
260
+ <a name="l00238"></a>00238 <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> &amp;filename, <span class="keyword">const</span> StaticString &amp;contents,
261
+ <a name="l00239"></a>00239 mode_t permissions = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH,
262
+ <a name="l00240"></a>00240 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN,
263
+ <a name="l00241"></a>00241 <span class="keywordtype">bool</span> overwrite = <span class="keyword">true</span>);
264
+ <a name="l00242"></a>00242 <span class="comment"></span>
265
+ <a name="l00243"></a>00243 <span class="comment">/**</span>
266
+ <a name="l00244"></a>00244 <span class="comment"> * Returns a canonical version of the specified path. All symbolic links</span>
267
+ <a name="l00245"></a>00245 <span class="comment"> * and relative path elements are resolved.</span>
268
+ <a name="l00246"></a>00246 <span class="comment"> *</span>
269
+ <a name="l00247"></a>00247 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
270
270
  <a name="l00248"></a>00248 <span class="comment"> * @ingroup Support</span>
271
271
  <a name="l00249"></a>00249 <span class="comment"> */</span>
272
- <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 &amp;path);
272
+ <a name="l00250"></a>00250 <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> &amp;path);
273
273
  <a name="l00251"></a>00251 <span class="comment"></span>
274
274
  <a name="l00252"></a>00252 <span class="comment">/**</span>
275
- <a name="l00253"></a>00253 <span class="comment"> * Given a path, extracts its base name.</span>
276
- <a name="l00254"></a>00254 <span class="comment"> *</span>
277
- <a name="l00255"></a>00255 <span class="comment"> * @ingroup Support</span>
278
- <a name="l00256"></a>00256 <span class="comment"> */</span>
279
- <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 &amp;path);
280
- <a name="l00258"></a>00258 <span class="comment"></span>
281
- <a name="l00259"></a>00259 <span class="comment">/**</span>
282
- <a name="l00260"></a>00260 <span class="comment"> * Escape the given raw string into an XML value.</span>
283
- <a name="l00261"></a>00261 <span class="comment"> *</span>
284
- <a name="l00262"></a>00262 <span class="comment"> * @throws std::bad_alloc Something went wrong.</span>
285
- <a name="l00263"></a>00263 <span class="comment"> * @ingroup Support</span>
286
- <a name="l00264"></a>00264 <span class="comment"> */</span>
287
- <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> &amp;input);
288
- <a name="l00266"></a>00266 <span class="comment"></span>
289
- <a name="l00267"></a>00267 <span class="comment">/**</span>
290
- <a name="l00268"></a>00268 <span class="comment"> * Returns the username of the user that the current process is running as.</span>
291
- <a name="l00269"></a>00269 <span class="comment"> * If the user has no associated username, then "UID xxxx" is returned,</span>
292
- <a name="l00270"></a>00270 <span class="comment"> * where xxxx is the current UID.</span>
293
- <a name="l00271"></a>00271 <span class="comment"> */</span>
294
- <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>();
295
- <a name="l00273"></a>00273 <span class="comment"></span>
296
- <a name="l00274"></a>00274 <span class="comment">/**</span>
297
- <a name="l00275"></a>00275 <span class="comment"> * Converts a mode string into a mode_t value.</span>
298
- <a name="l00276"></a>00276 <span class="comment"> *</span>
299
- <a name="l00277"></a>00277 <span class="comment"> * At this time only the symbolic mode strings are supported, e.g. something like looks</span>
300
- <a name="l00278"></a>00278 <span class="comment"> * this: "u=rwx,g=w,o=rx". The grammar is as follows:</span>
301
- <a name="l00279"></a>00279 <span class="comment"> * @code</span>
302
- <a name="l00280"></a>00280 <span class="comment"> * mode ::= (clause ("," clause)*)?</span>
303
- <a name="l00281"></a>00281 <span class="comment"> * clause ::= who "=" permission*</span>
304
- <a name="l00282"></a>00282 <span class="comment"> * who ::= "u" | "g" | "o"</span>
305
- <a name="l00283"></a>00283 <span class="comment"> * permission ::= "r" | "w" | "x" | "s"</span>
306
- <a name="l00284"></a>00284 <span class="comment"> * @endcode</span>
307
- <a name="l00285"></a>00285 <span class="comment"> *</span>
308
- <a name="l00286"></a>00286 <span class="comment"> * Notes:</span>
309
- <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>
310
- <a name="l00288"></a>00288 <span class="comment"> * permissions will be empty (set to 0).</span>
311
- <a name="l00289"></a>00289 <span class="comment"> * - The "s" permission is only allowed for who == "u" or who == "g".</span>
312
- <a name="l00290"></a>00290 <span class="comment"> * - The return value does not depend on the umask.</span>
313
- <a name="l00291"></a>00291 <span class="comment"> *</span>
314
- <a name="l00292"></a>00292 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
315
- <a name="l00293"></a>00293 <span class="comment"> */</span>
316
- <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 &amp;mode);
317
- <a name="l00295"></a>00295 <span class="comment"></span>
318
- <a name="l00296"></a>00296 <span class="comment">/**</span>
319
- <a name="l00297"></a>00297 <span class="comment"> * Return the path name for the directory in which the system stores general</span>
320
- <a name="l00298"></a>00298 <span class="comment"> * temporary files. This is usually "/tmp", but might be something else depending</span>
321
- <a name="l00299"></a>00299 <span class="comment"> * on some environment variables.</span>
322
- <a name="l00300"></a>00300 <span class="comment"> *</span>
323
- <a name="l00301"></a>00301 <span class="comment"> * @ensure result != NULL</span>
324
- <a name="l00302"></a>00302 <span class="comment"> * @ingroup Support</span>
325
- <a name="l00303"></a>00303 <span class="comment"> */</span>
326
- <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>();
327
- <a name="l00305"></a>00305
328
- <a name="l00306"></a>00306 <span class="comment">/* Create a temporary directory for storing Phusion Passenger instance-specific</span>
329
- <a name="l00307"></a>00307 <span class="comment"> * temp files, such as temporarily buffered uploads, sockets for backend</span>
330
- <a name="l00308"></a>00308 <span class="comment"> * processes, etc.</span>
331
- <a name="l00309"></a>00309 <span class="comment"> * The directory that will be created is the one returned by</span>
332
- <a name="l00310"></a>00310 <span class="comment"> * &lt;tt&gt;getPassengerTempDir(false, parentDir)&lt;/tt&gt;. This call stores the path to</span>
333
- <a name="l00311"></a>00311 <span class="comment"> * this temp directory in an internal variable, so that subsequent calls to</span>
334
- <a name="l00312"></a>00312 <span class="comment"> * getPassengerTempDir() will return the same path.</span>
335
- <a name="l00313"></a>00313 <span class="comment"> *</span>
336
- <a name="l00314"></a>00314 <span class="comment"> * The created temp directory will have several subdirectories:</span>
337
- <a name="l00315"></a>00315 <span class="comment"> * - webserver_private - for storing the web server's buffered uploads.</span>
338
- <a name="l00316"></a>00316 <span class="comment"> * - info - for storing files that allow external tools to query information</span>
339
- <a name="l00317"></a>00317 <span class="comment"> * about a running Phusion Passenger instance.</span>
340
- <a name="l00318"></a>00318 <span class="comment"> * - backends - for storing Unix sockets created by backend processes.</span>
341
- <a name="l00319"></a>00319 <span class="comment"> * - master - for storing files such as the Passenger HelperServer socket.</span>
342
- <a name="l00320"></a>00320 <span class="comment"> *</span>
343
- <a name="l00321"></a>00321 <span class="comment"> * If a (sub)directory already exists, then it will not result in an error.</span>
275
+ <a name="l00253"></a>00253 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; refers to a symlink, then this function resolves the</span>
276
+ <a name="l00254"></a>00254 <span class="comment"> * symlink for 1 level. That is, if the symlink points to another symlink,</span>
277
+ <a name="l00255"></a>00255 <span class="comment"> * then the other symlink will not be resolved. The resolved path is returned.</span>
278
+ <a name="l00256"></a>00256 <span class="comment"> *</span>
279
+ <a name="l00257"></a>00257 <span class="comment"> * If the symlink doesn't point to an absolute path, then this function will</span>
280
+ <a name="l00258"></a>00258 <span class="comment"> * prepend &lt;em&gt;path&lt;/em&gt;'s directory to the result.</span>
281
+ <a name="l00259"></a>00259 <span class="comment"> *</span>
282
+ <a name="l00260"></a>00260 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; doesn't refer to a symlink then this method will return</span>
283
+ <a name="l00261"></a>00261 <span class="comment"> * &lt;em&gt;path&lt;/em&gt;.</span>
284
+ <a name="l00262"></a>00262 <span class="comment"> *</span>
285
+ <a name="l00263"></a>00263 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
286
+ <a name="l00264"></a>00264 <span class="comment"> * @ingroup Support</span>
287
+ <a name="l00265"></a>00265 <span class="comment"> */</span>
288
+ <a name="l00266"></a>00266 <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> &amp;path);
289
+ <a name="l00267"></a>00267 <span class="comment"></span>
290
+ <a name="l00268"></a>00268 <span class="comment">/**</span>
291
+ <a name="l00269"></a>00269 <span class="comment"> * Given a path, extracts its directory name.</span>
292
+ <a name="l00270"></a>00270 <span class="comment"> *</span>
293
+ <a name="l00271"></a>00271 <span class="comment"> * @ingroup Support</span>
294
+ <a name="l00272"></a>00272 <span class="comment"> */</span>
295
+ <a name="l00273"></a>00273 <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 &amp;path);
296
+ <a name="l00274"></a>00274 <span class="comment"></span>
297
+ <a name="l00275"></a>00275 <span class="comment">/**</span>
298
+ <a name="l00276"></a>00276 <span class="comment"> * Given a path, extracts its base name.</span>
299
+ <a name="l00277"></a>00277 <span class="comment"> *</span>
300
+ <a name="l00278"></a>00278 <span class="comment"> * @ingroup Support</span>
301
+ <a name="l00279"></a>00279 <span class="comment"> */</span>
302
+ <a name="l00280"></a>00280 <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 &amp;path);
303
+ <a name="l00281"></a>00281 <span class="comment"></span>
304
+ <a name="l00282"></a>00282 <span class="comment">/**</span>
305
+ <a name="l00283"></a>00283 <span class="comment"> * Escape the given raw string into an XML value.</span>
306
+ <a name="l00284"></a>00284 <span class="comment"> *</span>
307
+ <a name="l00285"></a>00285 <span class="comment"> * @throws std::bad_alloc Something went wrong.</span>
308
+ <a name="l00286"></a>00286 <span class="comment"> * @ingroup Support</span>
309
+ <a name="l00287"></a>00287 <span class="comment"> */</span>
310
+ <a name="l00288"></a>00288 <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> &amp;input);
311
+ <a name="l00289"></a>00289 <span class="comment"></span>
312
+ <a name="l00290"></a>00290 <span class="comment">/**</span>
313
+ <a name="l00291"></a>00291 <span class="comment"> * Sets a socket in non-blocking mode.</span>
314
+ <a name="l00292"></a>00292 <span class="comment"> *</span>
315
+ <a name="l00293"></a>00293 <span class="comment"> * @throws SystemException Something went wrong.</span>
316
+ <a name="l00294"></a>00294 <span class="comment"> * @ingroup Support</span>
317
+ <a name="l00295"></a>00295 <span class="comment"> */</span>
318
+ <a name="l00296"></a>00296 <span class="keywordtype">void</span> <a class="code" href="group__Support.html#g7e3fdc923bdf6efeab407cdd325883a8" title="Sets a socket in non-blocking mode.">setNonBlocking</a>(<span class="keywordtype">int</span> fd);
319
+ <a name="l00297"></a>00297 <span class="comment"></span>
320
+ <a name="l00298"></a>00298 <span class="comment">/**</span>
321
+ <a name="l00299"></a>00299 <span class="comment"> * Returns the username of the user that the current process is running as.</span>
322
+ <a name="l00300"></a>00300 <span class="comment"> * If the user has no associated username, then "UID xxxx" is returned,</span>
323
+ <a name="l00301"></a>00301 <span class="comment"> * where xxxx is the current UID.</span>
324
+ <a name="l00302"></a>00302 <span class="comment"> */</span>
325
+ <a name="l00303"></a>00303 <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>();
326
+ <a name="l00304"></a>00304 <span class="comment"></span>
327
+ <a name="l00305"></a>00305 <span class="comment">/**</span>
328
+ <a name="l00306"></a>00306 <span class="comment"> * Converts a mode string into a mode_t value.</span>
329
+ <a name="l00307"></a>00307 <span class="comment"> *</span>
330
+ <a name="l00308"></a>00308 <span class="comment"> * At this time only the symbolic mode strings are supported, e.g. something like looks</span>
331
+ <a name="l00309"></a>00309 <span class="comment"> * this: "u=rwx,g=w,o=rx". The grammar is as follows:</span>
332
+ <a name="l00310"></a>00310 <span class="comment"> * @code</span>
333
+ <a name="l00311"></a>00311 <span class="comment"> * mode ::= (clause ("," clause)*)?</span>
334
+ <a name="l00312"></a>00312 <span class="comment"> * clause ::= who "=" permission*</span>
335
+ <a name="l00313"></a>00313 <span class="comment"> * who ::= "u" | "g" | "o"</span>
336
+ <a name="l00314"></a>00314 <span class="comment"> * permission ::= "r" | "w" | "x" | "s"</span>
337
+ <a name="l00315"></a>00315 <span class="comment"> * @endcode</span>
338
+ <a name="l00316"></a>00316 <span class="comment"> *</span>
339
+ <a name="l00317"></a>00317 <span class="comment"> * Notes:</span>
340
+ <a name="l00318"></a>00318 <span class="comment"> * - The mode value starts with 0. So if you specify "u=rwx", then the group and world</span>
341
+ <a name="l00319"></a>00319 <span class="comment"> * permissions will be empty (set to 0).</span>
342
+ <a name="l00320"></a>00320 <span class="comment"> * - The "s" permission is only allowed for who == "u" or who == "g".</span>
343
+ <a name="l00321"></a>00321 <span class="comment"> * - The return value does not depend on the umask.</span>
344
344
  <a name="l00322"></a>00322 <span class="comment"> *</span>
345
- <a name="l00323"></a>00323 <span class="comment"> * The &lt;em&gt;userSwitching&lt;/em&gt; and &lt;em&gt;lowestUser&lt;/em&gt; arguments passed to</span>
346
- <a name="l00324"></a>00324 <span class="comment"> * this method are used for determining the optimal permissions for the</span>
347
- <a name="l00325"></a>00325 <span class="comment"> * (sub)directories. The permissions will be set as tightly as possible based</span>
348
- <a name="l00326"></a>00326 <span class="comment"> * on the values. The &lt;em&gt;workerUid&lt;/em&gt; and &lt;em&gt;workerGid&lt;/em&gt; arguments</span>
349
- <a name="l00327"></a>00327 <span class="comment"> * will be used for determining the owner of certain subdirectories.</span>
350
- <a name="l00328"></a>00328 <span class="comment"> *</span>
351
- <a name="l00329"></a>00329 <span class="comment"> * @note You should only call this method inside the web server's master</span>
352
- <a name="l00330"></a>00330 <span class="comment"> * process. In case of Apache, this is the Apache control process,</span>
353
- <a name="l00331"></a>00331 <span class="comment"> * the one that tends to run as root. This is because this function</span>
354
- <a name="l00332"></a>00332 <span class="comment"> * will set directory permissions and owners/groups, which may require</span>
355
- <a name="l00333"></a>00333 <span class="comment"> * root privileges.</span>
356
- <a name="l00334"></a>00334 <span class="comment"> *</span>
357
- <a name="l00335"></a>00335 <span class="comment"> * @param parentDir The directory under which the Phusion Passenger-specific</span>
358
- <a name="l00336"></a>00336 <span class="comment"> * temp directory should be created. This argument may be the</span>
359
- <a name="l00337"></a>00337 <span class="comment"> * empty string, in which case getSystemTempDir() will be used</span>
360
- <a name="l00338"></a>00338 <span class="comment"> * as the parent directory.</span>
361
- <a name="l00339"></a>00339 <span class="comment"> * @param userSwitching Whether user switching is turned on.</span>
362
- <a name="l00340"></a>00340 <span class="comment"> * @param lowestUser The user that the spawn manager and the pool server will</span>
363
- <a name="l00341"></a>00341 <span class="comment"> * run as, if user switching is turned off.</span>
364
- <a name="l00342"></a>00342 <span class="comment"> * @param workerUid The UID that the web server's worker processes are running</span>
365
- <a name="l00343"></a>00343 <span class="comment"> * as. On Apache, this is the UID that's associated with the</span>
366
- <a name="l00344"></a>00344 <span class="comment"> * 'User' directive.</span>
367
- <a name="l00345"></a>00345 <span class="comment"> * @param workerGid The GID that the web server's worker processes are running</span>
368
- <a name="l00346"></a>00346 <span class="comment"> * as. On Apache, this is the GID that's associated with the</span>
369
- <a name="l00347"></a>00347 <span class="comment"> * 'Group' directive.</span>
370
- <a name="l00348"></a>00348 <span class="comment"> * @throws IOException Something went wrong.</span>
371
- <a name="l00349"></a>00349 <span class="comment"> * @throws SystemException Something went wrong.</span>
372
- <a name="l00350"></a>00350 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
373
- <a name="l00351"></a>00351 <span class="comment"> */</span>
374
- <a name="l00352"></a>00352 <span class="comment">/* void createPassengerTempDir(const string &amp;parentDir, bool userSwitching,</span>
375
- <a name="l00353"></a>00353 <span class="comment"> const string &amp;lowestUser,</span>
376
- <a name="l00354"></a>00354 <span class="comment"> uid_t workerUid, gid_t workerGid); */</span>
377
- <a name="l00355"></a>00355 <span class="comment"></span>
378
- <a name="l00356"></a>00356 <span class="comment">/**</span>
379
- <a name="l00357"></a>00357 <span class="comment"> * Create the directory at the given path, creating intermediate directories</span>
380
- <a name="l00358"></a>00358 <span class="comment"> * if necessary. The created directories' permissions are exactly as specified</span>
381
- <a name="l00359"></a>00359 <span class="comment"> * by the 'mode' parameter (i.e. the umask will be ignored). You can specify</span>
382
- <a name="l00360"></a>00360 <span class="comment"> * this directory's owner and group through the 'owner' and 'group' parameters.</span>
383
- <a name="l00361"></a>00361 <span class="comment"> * A value of USER_NOT_GIVEN for 'owner' and/or GROUP_NOT_GIVEN 'group' means</span>
384
- <a name="l00362"></a>00362 <span class="comment"> * that the owner/group should not be changed.</span>
385
- <a name="l00363"></a>00363 <span class="comment"> *</span>
386
- <a name="l00364"></a>00364 <span class="comment"> * If 'path' already exists, then nothing will happen.</span>
345
+ <a name="l00323"></a>00323 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
346
+ <a name="l00324"></a>00324 <span class="comment"> */</span>
347
+ <a name="l00325"></a>00325 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 &amp;mode);
348
+ <a name="l00326"></a>00326 <span class="comment"></span>
349
+ <a name="l00327"></a>00327 <span class="comment">/**</span>
350
+ <a name="l00328"></a>00328 <span class="comment"> * Return the path name for the directory in which the system stores general</span>
351
+ <a name="l00329"></a>00329 <span class="comment"> * temporary files. This is usually "/tmp", but might be something else depending</span>
352
+ <a name="l00330"></a>00330 <span class="comment"> * on some environment variables.</span>
353
+ <a name="l00331"></a>00331 <span class="comment"> *</span>
354
+ <a name="l00332"></a>00332 <span class="comment"> * @ensure result != NULL</span>
355
+ <a name="l00333"></a>00333 <span class="comment"> * @ingroup Support</span>
356
+ <a name="l00334"></a>00334 <span class="comment"> */</span>
357
+ <a name="l00335"></a>00335 <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>();
358
+ <a name="l00336"></a>00336
359
+ <a name="l00337"></a>00337 <span class="comment">/* Create a temporary directory for storing Phusion Passenger instance-specific</span>
360
+ <a name="l00338"></a>00338 <span class="comment"> * temp files, such as temporarily buffered uploads, sockets for backend</span>
361
+ <a name="l00339"></a>00339 <span class="comment"> * processes, etc.</span>
362
+ <a name="l00340"></a>00340 <span class="comment"> * The directory that will be created is the one returned by</span>
363
+ <a name="l00341"></a>00341 <span class="comment"> * &lt;tt&gt;getPassengerTempDir(false, parentDir)&lt;/tt&gt;. This call stores the path to</span>
364
+ <a name="l00342"></a>00342 <span class="comment"> * this temp directory in an internal variable, so that subsequent calls to</span>
365
+ <a name="l00343"></a>00343 <span class="comment"> * getPassengerTempDir() will return the same path.</span>
366
+ <a name="l00344"></a>00344 <span class="comment"> *</span>
367
+ <a name="l00345"></a>00345 <span class="comment"> * The created temp directory will have several subdirectories:</span>
368
+ <a name="l00346"></a>00346 <span class="comment"> * - webserver_private - for storing the web server's buffered uploads.</span>
369
+ <a name="l00347"></a>00347 <span class="comment"> * - info - for storing files that allow external tools to query information</span>
370
+ <a name="l00348"></a>00348 <span class="comment"> * about a running Phusion Passenger instance.</span>
371
+ <a name="l00349"></a>00349 <span class="comment"> * - backends - for storing Unix sockets created by backend processes.</span>
372
+ <a name="l00350"></a>00350 <span class="comment"> * - master - for storing files such as the Passenger HelperServer socket.</span>
373
+ <a name="l00351"></a>00351 <span class="comment"> *</span>
374
+ <a name="l00352"></a>00352 <span class="comment"> * If a (sub)directory already exists, then it will not result in an error.</span>
375
+ <a name="l00353"></a>00353 <span class="comment"> *</span>
376
+ <a name="l00354"></a>00354 <span class="comment"> * The &lt;em&gt;userSwitching&lt;/em&gt; and &lt;em&gt;lowestUser&lt;/em&gt; arguments passed to</span>
377
+ <a name="l00355"></a>00355 <span class="comment"> * this method are used for determining the optimal permissions for the</span>
378
+ <a name="l00356"></a>00356 <span class="comment"> * (sub)directories. The permissions will be set as tightly as possible based</span>
379
+ <a name="l00357"></a>00357 <span class="comment"> * on the values. The &lt;em&gt;workerUid&lt;/em&gt; and &lt;em&gt;workerGid&lt;/em&gt; arguments</span>
380
+ <a name="l00358"></a>00358 <span class="comment"> * will be used for determining the owner of certain subdirectories.</span>
381
+ <a name="l00359"></a>00359 <span class="comment"> *</span>
382
+ <a name="l00360"></a>00360 <span class="comment"> * @note You should only call this method inside the web server's master</span>
383
+ <a name="l00361"></a>00361 <span class="comment"> * process. In case of Apache, this is the Apache control process,</span>
384
+ <a name="l00362"></a>00362 <span class="comment"> * the one that tends to run as root. This is because this function</span>
385
+ <a name="l00363"></a>00363 <span class="comment"> * will set directory permissions and owners/groups, which may require</span>
386
+ <a name="l00364"></a>00364 <span class="comment"> * root privileges.</span>
387
387
  <a name="l00365"></a>00365 <span class="comment"> *</span>
388
- <a name="l00366"></a>00366 <span class="comment"> * @param mode A mode string, as supported by parseModeString().</span>
389
- <a name="l00367"></a>00367 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
390
- <a name="l00368"></a>00368 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
391
- <a name="l00369"></a>00369 <span class="comment"> */</span>
392
- <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> &amp;path, <span class="keyword">const</span> StaticString &amp;mode = <span class="stringliteral">"u=rwx,g=,o="</span>,
393
- <a name="l00371"></a>00371 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN);
394
- <a name="l00372"></a>00372 <span class="comment"></span>
395
- <a name="l00373"></a>00373 <span class="comment">/**</span>
396
- <a name="l00374"></a>00374 <span class="comment"> * Remove an entire directory tree recursively. If the directory doesn't exist then this</span>
397
- <a name="l00375"></a>00375 <span class="comment"> * function does nothing.</span>
398
- <a name="l00376"></a>00376 <span class="comment"> *</span>
399
- <a name="l00377"></a>00377 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
400
- <a name="l00378"></a>00378 <span class="comment"> */</span>
401
- <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> &amp;path);
402
- <a name="l00380"></a>00380 <span class="comment"></span>
403
- <a name="l00381"></a>00381 <span class="comment">/**</span>
404
- <a name="l00382"></a>00382 <span class="comment"> * Check whether the specified directory is a valid Ruby on Rails</span>
405
- <a name="l00383"></a>00383 <span class="comment"> * application root directory.</span>
406
- <a name="l00384"></a>00384 <span class="comment"> *</span>
407
- <a name="l00385"></a>00385 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
408
- <a name="l00386"></a>00386 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
409
- <a name="l00387"></a>00387 <span class="comment"> * @throws FileSystemException Unable to check because of a system error.</span>
410
- <a name="l00388"></a>00388 <span class="comment"> * @throws TimeRetrievalException</span>
411
- <a name="l00389"></a>00389 <span class="comment"> * @throws boost::thread_interrupted</span>
412
- <a name="l00390"></a>00390 <span class="comment"> * @ingroup Support</span>
413
- <a name="l00391"></a>00391 <span class="comment"> */</span>
414
- <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> &amp;dir, CachedFileStat *cstat = 0,
415
- <a name="l00393"></a>00393 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
416
- <a name="l00394"></a>00394 <span class="comment"></span>
417
- <a name="l00395"></a>00395 <span class="comment">/**</span>
418
- <a name="l00396"></a>00396 <span class="comment"> * Check whether the specified directory is a valid Rack application</span>
419
- <a name="l00397"></a>00397 <span class="comment"> * root directory.</span>
420
- <a name="l00398"></a>00398 <span class="comment"> *</span>
421
- <a name="l00399"></a>00399 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
422
- <a name="l00400"></a>00400 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
423
- <a name="l00401"></a>00401 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
424
- <a name="l00402"></a>00402 <span class="comment"> * @throws TimeRetrievalException</span>
425
- <a name="l00403"></a>00403 <span class="comment"> * @throws boost::thread_interrupted</span>
426
- <a name="l00404"></a>00404 <span class="comment"> * @ingroup Support</span>
427
- <a name="l00405"></a>00405 <span class="comment"> */</span>
428
- <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> &amp;dir, CachedFileStat *cstat = 0,
429
- <a name="l00407"></a>00407 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
430
- <a name="l00408"></a>00408 <span class="comment"></span>
431
- <a name="l00409"></a>00409 <span class="comment">/**</span>
432
- <a name="l00410"></a>00410 <span class="comment"> * Check whether the specified directory is a valid WSGI application</span>
433
- <a name="l00411"></a>00411 <span class="comment"> * root directory.</span>
434
- <a name="l00412"></a>00412 <span class="comment"> *</span>
435
- <a name="l00413"></a>00413 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
436
- <a name="l00414"></a>00414 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
437
- <a name="l00415"></a>00415 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
438
- <a name="l00416"></a>00416 <span class="comment"> * @throws TimeRetrievalException</span>
439
- <a name="l00417"></a>00417 <span class="comment"> * @throws boost::thread_interrupted</span>
440
- <a name="l00418"></a>00418 <span class="comment"> * @ingroup Support</span>
441
- <a name="l00419"></a>00419 <span class="comment"> */</span>
442
- <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> &amp;dir, CachedFileStat *cstat = 0,
443
- <a name="l00421"></a>00421 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
444
- <a name="l00422"></a>00422
445
- <a name="l00423"></a>00423 <span class="keywordtype">void</span> prestartWebApps(<span class="keyword">const</span> ResourceLocator &amp;locator, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;serializedprestartURLs);
446
- <a name="l00424"></a>00424 <span class="comment"></span>
447
- <a name="l00425"></a>00425 <span class="comment">/**</span>
448
- <a name="l00426"></a>00426 <span class="comment"> * Generate a secure, random token of the &lt;tt&gt;size&lt;/tt&gt; bytes and put</span>
449
- <a name="l00427"></a>00427 <span class="comment"> * the result into &lt;tt&gt;buf&lt;/tt&gt;.</span>
450
- <a name="l00428"></a>00428 <span class="comment"> *</span>
451
- <a name="l00429"></a>00429 <span class="comment"> * This method is thread-safe.</span>
452
- <a name="l00430"></a>00430 <span class="comment"> *</span>
453
- <a name="l00431"></a>00431 <span class="comment"> * @throws FileSystemException</span>
454
- <a name="l00432"></a>00432 <span class="comment"> * @throws IOException</span>
455
- <a name="l00433"></a>00433 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
456
- <a name="l00434"></a>00434 <span class="comment"> * @ingroup Support</span>
457
- <a name="l00435"></a>00435 <span class="comment"> */</span>
458
- <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);
459
- <a name="l00437"></a>00437 <span class="comment"></span>
460
- <a name="l00438"></a>00438 <span class="comment">/**</span>
461
- <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>
462
- <a name="l00440"></a>00440 <span class="comment"> * that looks like &lt;tt&gt;prefix + middle + postfix&lt;/tt&gt;, with as many characters from</span>
463
- <a name="l00441"></a>00441 <span class="comment"> * &lt;tt&gt;midle&lt;/tt&gt; preserved as possible.</span>
464
- <a name="l00442"></a>00442 <span class="comment"> *</span>
465
- <a name="l00443"></a>00443 <span class="comment"> * If &lt;tt&gt;prefix + middle + postfix&lt;/tt&gt; does not fit in &lt;tt&gt;max&lt;/tt&gt; characters,</span>
466
- <a name="l00444"></a>00444 <span class="comment"> * then &lt;tt&gt;middle&lt;/tt&gt; will be truncated so that it fits. If &lt;tt&gt;max&lt;/tt&gt; is too</span>
467
- <a name="l00445"></a>00445 <span class="comment"> * small to contain even 1 character from &lt;tt&gt;middle&lt;/tt&gt;, then an ArgumentException</span>
468
- <a name="l00446"></a>00446 <span class="comment"> * will be thrown.</span>
469
- <a name="l00447"></a>00447 <span class="comment"> *</span>
470
- <a name="l00448"></a>00448 <span class="comment"> * @code</span>
471
- <a name="l00449"></a>00449 <span class="comment"> * fillInMiddle(18, "server.", "1234", ".socket"); // "server.1234.socket"</span>
472
- <a name="l00450"></a>00450 <span class="comment"> * fillInMiddle(16, "server.", "1234", ".socket"); // "server.12.socket"</span>
473
- <a name="l00451"></a>00451 <span class="comment"> * fillInMiddle(14, "server.", "1234", ".socket"); // ArgumentException</span>
474
- <a name="l00452"></a>00452 <span class="comment"> * @endcode</span>
475
- <a name="l00453"></a>00453 <span class="comment"> *</span>
476
- <a name="l00454"></a>00454 <span class="comment"> * @returns The resulting string, with &lt;tt&gt;middle&lt;/tt&gt; possibly truncated.</span>
477
- <a name="l00455"></a>00455 <span class="comment"> * @throws ArgumentException &lt;tt&gt;max&lt;/tt&gt; is too small to contain even 1</span>
478
- <a name="l00456"></a>00456 <span class="comment"> * character from &lt;tt&gt;middle&lt;/tt&gt;.</span>
479
- <a name="l00457"></a>00457 <span class="comment"> * @post result.size() &lt;= max</span>
480
- <a name="l00458"></a>00458 <span class="comment"> */</span>
481
- <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> &amp;prefix, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;middle, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;postfix = <span class="stringliteral">""</span>);
482
- <a name="l00460"></a>00460 <span class="comment"></span>
483
- <a name="l00461"></a>00461 <span class="comment">/**</span>
484
- <a name="l00462"></a>00462 <span class="comment"> * Convert the given binary data to hexadecimal.</span>
485
- <a name="l00463"></a>00463 <span class="comment"> */</span>
486
- <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 &amp;data);
487
- <a name="l00465"></a>00465 <span class="comment"></span>
488
- <a name="l00466"></a>00466 <span class="comment">/**</span>
489
- <a name="l00467"></a>00467 <span class="comment"> * Convert the given binary data to hexadecimal. This form accepts an</span>
490
- <a name="l00468"></a>00468 <span class="comment"> * output buffer which must be at least data.size() * 2 bytes large.</span>
491
- <a name="l00469"></a>00469 <span class="comment"> */</span>
492
- <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 &amp;data, <span class="keywordtype">char</span> *output);
493
- <a name="l00471"></a>00471 <span class="comment"></span>
494
- <a name="l00472"></a>00472 <span class="comment">/**</span>
495
- <a name="l00473"></a>00473 <span class="comment"> * Convert a signal number to its associated name.</span>
496
- <a name="l00474"></a>00474 <span class="comment"> */</span>
497
- <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);
498
- <a name="l00476"></a>00476 <span class="comment"></span>
499
- <a name="l00477"></a>00477 <span class="comment">/**</span>
500
- <a name="l00478"></a>00478 <span class="comment"> * Create a new Unix server socket which is bounded to &lt;tt&gt;filename&lt;/tt&gt;.</span>
501
- <a name="l00479"></a>00479 <span class="comment"> *</span>
502
- <a name="l00480"></a>00480 <span class="comment"> * @param filename The filename to bind the socket to.</span>
503
- <a name="l00481"></a>00481 <span class="comment"> * @param backlogSize The size of the socket's backlog. Specify 0 to use the</span>
504
- <a name="l00482"></a>00482 <span class="comment"> * platform's maximum allowed backlog size.</span>
505
- <a name="l00483"></a>00483 <span class="comment"> * @param autoDelete Whether &lt;tt&gt;filename&lt;/tt&gt; should be deleted, if it already exists.</span>
506
- <a name="l00484"></a>00484 <span class="comment"> * @return The file descriptor of the newly created Unix server socket.</span>
507
- <a name="l00485"></a>00485 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
508
- <a name="l00486"></a>00486 <span class="comment"> * @throws SystemException Something went wrong while creating the Unix server socket.</span>
509
- <a name="l00487"></a>00487 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
510
- <a name="l00488"></a>00488 <span class="comment"> * @ingroup Support</span>
511
- <a name="l00489"></a>00489 <span class="comment"> */</span>
512
- <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>);
513
- <a name="l00491"></a>00491 <span class="comment"></span>
514
- <a name="l00492"></a>00492 <span class="comment">/**</span>
515
- <a name="l00493"></a>00493 <span class="comment"> * Connect to a Unix server socket at &lt;tt&gt;filename&lt;/tt&gt;.</span>
516
- <a name="l00494"></a>00494 <span class="comment"> *</span>
517
- <a name="l00495"></a>00495 <span class="comment"> * @param filename The filename of the socket to connect to.</span>
518
- <a name="l00496"></a>00496 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
519
- <a name="l00497"></a>00497 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
520
- <a name="l00498"></a>00498 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
521
- <a name="l00499"></a>00499 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
522
- <a name="l00500"></a>00500 <span class="comment"> * @ingroup Support</span>
523
- <a name="l00501"></a>00501 <span class="comment"> */</span>
524
- <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);
525
- <a name="l00503"></a>00503 <span class="comment"></span>
526
- <a name="l00504"></a>00504 <span class="comment">/**</span>
527
- <a name="l00505"></a>00505 <span class="comment"> * Connect to a TCP server socket at the given host name and port.</span>
528
- <a name="l00506"></a>00506 <span class="comment"> *</span>
529
- <a name="l00507"></a>00507 <span class="comment"> * @param hostname The host name of the TCP server.</span>
530
- <a name="l00508"></a>00508 <span class="comment"> * @param port The port number of the TCP server.</span>
531
- <a name="l00509"></a>00509 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
532
- <a name="l00510"></a>00510 <span class="comment"> * @throws IOException Something went wrong while connecting to the Unix server.</span>
533
- <a name="l00511"></a>00511 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
388
+ <a name="l00366"></a>00366 <span class="comment"> * @param parentDir The directory under which the Phusion Passenger-specific</span>
389
+ <a name="l00367"></a>00367 <span class="comment"> * temp directory should be created. This argument may be the</span>
390
+ <a name="l00368"></a>00368 <span class="comment"> * empty string, in which case getSystemTempDir() will be used</span>
391
+ <a name="l00369"></a>00369 <span class="comment"> * as the parent directory.</span>
392
+ <a name="l00370"></a>00370 <span class="comment"> * @param userSwitching Whether user switching is turned on.</span>
393
+ <a name="l00371"></a>00371 <span class="comment"> * @param lowestUser The user that the spawn manager and the pool server will</span>
394
+ <a name="l00372"></a>00372 <span class="comment"> * run as, if user switching is turned off.</span>
395
+ <a name="l00373"></a>00373 <span class="comment"> * @param workerUid The UID that the web server's worker processes are running</span>
396
+ <a name="l00374"></a>00374 <span class="comment"> * as. On Apache, this is the UID that's associated with the</span>
397
+ <a name="l00375"></a>00375 <span class="comment"> * 'User' directive.</span>
398
+ <a name="l00376"></a>00376 <span class="comment"> * @param workerGid The GID that the web server's worker processes are running</span>
399
+ <a name="l00377"></a>00377 <span class="comment"> * as. On Apache, this is the GID that's associated with the</span>
400
+ <a name="l00378"></a>00378 <span class="comment"> * 'Group' directive.</span>
401
+ <a name="l00379"></a>00379 <span class="comment"> * @throws IOException Something went wrong.</span>
402
+ <a name="l00380"></a>00380 <span class="comment"> * @throws SystemException Something went wrong.</span>
403
+ <a name="l00381"></a>00381 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
404
+ <a name="l00382"></a>00382 <span class="comment"> */</span>
405
+ <a name="l00383"></a>00383 <span class="comment">/* void createPassengerTempDir(const string &amp;parentDir, bool userSwitching,</span>
406
+ <a name="l00384"></a>00384 <span class="comment"> const string &amp;lowestUser,</span>
407
+ <a name="l00385"></a>00385 <span class="comment"> uid_t workerUid, gid_t workerGid); */</span>
408
+ <a name="l00386"></a>00386 <span class="comment"></span>
409
+ <a name="l00387"></a>00387 <span class="comment">/**</span>
410
+ <a name="l00388"></a>00388 <span class="comment"> * Create the directory at the given path, creating intermediate directories</span>
411
+ <a name="l00389"></a>00389 <span class="comment"> * if necessary. The created directories' permissions are exactly as specified</span>
412
+ <a name="l00390"></a>00390 <span class="comment"> * by the 'mode' parameter (i.e. the umask will be ignored). You can specify</span>
413
+ <a name="l00391"></a>00391 <span class="comment"> * this directory's owner and group through the 'owner' and 'group' parameters.</span>
414
+ <a name="l00392"></a>00392 <span class="comment"> * A value of USER_NOT_GIVEN for 'owner' and/or GROUP_NOT_GIVEN 'group' means</span>
415
+ <a name="l00393"></a>00393 <span class="comment"> * that the owner/group should not be changed.</span>
416
+ <a name="l00394"></a>00394 <span class="comment"> *</span>
417
+ <a name="l00395"></a>00395 <span class="comment"> * If 'path' already exists, then nothing will happen.</span>
418
+ <a name="l00396"></a>00396 <span class="comment"> *</span>
419
+ <a name="l00397"></a>00397 <span class="comment"> * @param mode A mode string, as supported by parseModeString().</span>
420
+ <a name="l00398"></a>00398 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
421
+ <a name="l00399"></a>00399 <span class="comment"> * @throws InvalidModeStringException The mode string cannot be parsed.</span>
422
+ <a name="l00400"></a>00400 <span class="comment"> */</span>
423
+ <a name="l00401"></a>00401 <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> &amp;path, <span class="keyword">const</span> StaticString &amp;mode = <span class="stringliteral">"u=rwx,g=,o="</span>,
424
+ <a name="l00402"></a>00402 uid_t owner = USER_NOT_GIVEN, gid_t group = GROUP_NOT_GIVEN);
425
+ <a name="l00403"></a>00403 <span class="comment"></span>
426
+ <a name="l00404"></a>00404 <span class="comment">/**</span>
427
+ <a name="l00405"></a>00405 <span class="comment"> * Remove an entire directory tree recursively. If the directory doesn't exist then this</span>
428
+ <a name="l00406"></a>00406 <span class="comment"> * function does nothing.</span>
429
+ <a name="l00407"></a>00407 <span class="comment"> *</span>
430
+ <a name="l00408"></a>00408 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
431
+ <a name="l00409"></a>00409 <span class="comment"> */</span>
432
+ <a name="l00410"></a>00410 <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> &amp;path);
433
+ <a name="l00411"></a>00411 <span class="comment"></span>
434
+ <a name="l00412"></a>00412 <span class="comment">/**</span>
435
+ <a name="l00413"></a>00413 <span class="comment"> * Check whether the specified directory is a valid Ruby on Rails</span>
436
+ <a name="l00414"></a>00414 <span class="comment"> * application root directory.</span>
437
+ <a name="l00415"></a>00415 <span class="comment"> *</span>
438
+ <a name="l00416"></a>00416 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
439
+ <a name="l00417"></a>00417 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
440
+ <a name="l00418"></a>00418 <span class="comment"> * @throws FileSystemException Unable to check because of a system error.</span>
441
+ <a name="l00419"></a>00419 <span class="comment"> * @throws TimeRetrievalException</span>
442
+ <a name="l00420"></a>00420 <span class="comment"> * @throws boost::thread_interrupted</span>
443
+ <a name="l00421"></a>00421 <span class="comment"> * @ingroup Support</span>
444
+ <a name="l00422"></a>00422 <span class="comment"> */</span>
445
+ <a name="l00423"></a>00423 <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> &amp;dir, CachedFileStat *cstat = 0,
446
+ <a name="l00424"></a>00424 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
447
+ <a name="l00425"></a>00425 <span class="comment"></span>
448
+ <a name="l00426"></a>00426 <span class="comment">/**</span>
449
+ <a name="l00427"></a>00427 <span class="comment"> * Check whether the specified directory is a valid Rack application</span>
450
+ <a name="l00428"></a>00428 <span class="comment"> * root directory.</span>
451
+ <a name="l00429"></a>00429 <span class="comment"> *</span>
452
+ <a name="l00430"></a>00430 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
453
+ <a name="l00431"></a>00431 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
454
+ <a name="l00432"></a>00432 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
455
+ <a name="l00433"></a>00433 <span class="comment"> * @throws TimeRetrievalException</span>
456
+ <a name="l00434"></a>00434 <span class="comment"> * @throws boost::thread_interrupted</span>
457
+ <a name="l00435"></a>00435 <span class="comment"> * @ingroup Support</span>
458
+ <a name="l00436"></a>00436 <span class="comment"> */</span>
459
+ <a name="l00437"></a>00437 <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> &amp;dir, CachedFileStat *cstat = 0,
460
+ <a name="l00438"></a>00438 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
461
+ <a name="l00439"></a>00439 <span class="comment"></span>
462
+ <a name="l00440"></a>00440 <span class="comment">/**</span>
463
+ <a name="l00441"></a>00441 <span class="comment"> * Check whether the specified directory is a valid WSGI application</span>
464
+ <a name="l00442"></a>00442 <span class="comment"> * root directory.</span>
465
+ <a name="l00443"></a>00443 <span class="comment"> *</span>
466
+ <a name="l00444"></a>00444 <span class="comment"> * @param cstat A CachedFileStat object, if you want to use cached statting.</span>
467
+ <a name="l00445"></a>00445 <span class="comment"> * @param throttleRate A throttle rate for cstat. Only applicable if cstat is not NULL.</span>
468
+ <a name="l00446"></a>00446 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
469
+ <a name="l00447"></a>00447 <span class="comment"> * @throws TimeRetrievalException</span>
470
+ <a name="l00448"></a>00448 <span class="comment"> * @throws boost::thread_interrupted</span>
471
+ <a name="l00449"></a>00449 <span class="comment"> * @ingroup Support</span>
472
+ <a name="l00450"></a>00450 <span class="comment"> */</span>
473
+ <a name="l00451"></a>00451 <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> &amp;dir, CachedFileStat *cstat = 0,
474
+ <a name="l00452"></a>00452 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
475
+ <a name="l00453"></a>00453
476
+ <a name="l00454"></a>00454 <span class="keywordtype">void</span> prestartWebApps(<span class="keyword">const</span> ResourceLocator &amp;locator, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;serializedprestartURLs);
477
+ <a name="l00455"></a>00455 <span class="comment"></span>
478
+ <a name="l00456"></a>00456 <span class="comment">/**</span>
479
+ <a name="l00457"></a>00457 <span class="comment"> * Returns the system's host name.</span>
480
+ <a name="l00458"></a>00458 <span class="comment"> *</span>
481
+ <a name="l00459"></a>00459 <span class="comment"> * @throws SystemException The host name cannot be retrieved.</span>
482
+ <a name="l00460"></a>00460 <span class="comment"> */</span>
483
+ <a name="l00461"></a>00461 <span class="keywordtype">string</span> <a class="code" href="namespacePassenger.html#1d0a66b0e207c46dc6124ff3b2f331e6" title="Returns the system&amp;#39;s host name.">getHostName</a>();
484
+ <a name="l00462"></a>00462 <span class="comment"></span>
485
+ <a name="l00463"></a>00463 <span class="comment">/**</span>
486
+ <a name="l00464"></a>00464 <span class="comment"> * Given a prefix string, a middle string and a postfix string, try to build a string</span>
487
+ <a name="l00465"></a>00465 <span class="comment"> * that looks like &lt;tt&gt;prefix + middle + postfix&lt;/tt&gt;, with as many characters from</span>
488
+ <a name="l00466"></a>00466 <span class="comment"> * &lt;tt&gt;midle&lt;/tt&gt; preserved as possible.</span>
489
+ <a name="l00467"></a>00467 <span class="comment"> *</span>
490
+ <a name="l00468"></a>00468 <span class="comment"> * If &lt;tt&gt;prefix + middle + postfix&lt;/tt&gt; does not fit in &lt;tt&gt;max&lt;/tt&gt; characters,</span>
491
+ <a name="l00469"></a>00469 <span class="comment"> * then &lt;tt&gt;middle&lt;/tt&gt; will be truncated so that it fits. If &lt;tt&gt;max&lt;/tt&gt; is too</span>
492
+ <a name="l00470"></a>00470 <span class="comment"> * small to contain even 1 character from &lt;tt&gt;middle&lt;/tt&gt;, then an ArgumentException</span>
493
+ <a name="l00471"></a>00471 <span class="comment"> * will be thrown.</span>
494
+ <a name="l00472"></a>00472 <span class="comment"> *</span>
495
+ <a name="l00473"></a>00473 <span class="comment"> * @code</span>
496
+ <a name="l00474"></a>00474 <span class="comment"> * fillInMiddle(18, "server.", "1234", ".socket"); // "server.1234.socket"</span>
497
+ <a name="l00475"></a>00475 <span class="comment"> * fillInMiddle(16, "server.", "1234", ".socket"); // "server.12.socket"</span>
498
+ <a name="l00476"></a>00476 <span class="comment"> * fillInMiddle(14, "server.", "1234", ".socket"); // ArgumentException</span>
499
+ <a name="l00477"></a>00477 <span class="comment"> * @endcode</span>
500
+ <a name="l00478"></a>00478 <span class="comment"> *</span>
501
+ <a name="l00479"></a>00479 <span class="comment"> * @returns The resulting string, with &lt;tt&gt;middle&lt;/tt&gt; possibly truncated.</span>
502
+ <a name="l00480"></a>00480 <span class="comment"> * @throws ArgumentException &lt;tt&gt;max&lt;/tt&gt; is too small to contain even 1</span>
503
+ <a name="l00481"></a>00481 <span class="comment"> * character from &lt;tt&gt;middle&lt;/tt&gt;.</span>
504
+ <a name="l00482"></a>00482 <span class="comment"> * @post result.size() &lt;= max</span>
505
+ <a name="l00483"></a>00483 <span class="comment"> */</span>
506
+ <a name="l00484"></a>00484 <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> &amp;prefix, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;middle, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;postfix = <span class="stringliteral">""</span>);
507
+ <a name="l00485"></a>00485 <span class="comment"></span>
508
+ <a name="l00486"></a>00486 <span class="comment">/**</span>
509
+ <a name="l00487"></a>00487 <span class="comment"> * Convert the given binary data to hexadecimal.</span>
510
+ <a name="l00488"></a>00488 <span class="comment"> */</span>
511
+ <a name="l00489"></a>00489 <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 &amp;data);
512
+ <a name="l00490"></a>00490 <span class="comment"></span>
513
+ <a name="l00491"></a>00491 <span class="comment">/**</span>
514
+ <a name="l00492"></a>00492 <span class="comment"> * Convert the given binary data to hexadecimal. This form accepts an</span>
515
+ <a name="l00493"></a>00493 <span class="comment"> * output buffer which must be at least data.size() * 2 bytes large.</span>
516
+ <a name="l00494"></a>00494 <span class="comment"> */</span>
517
+ <a name="l00495"></a>00495 <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 &amp;data, <span class="keywordtype">char</span> *output);
518
+ <a name="l00496"></a>00496 <span class="comment"></span>
519
+ <a name="l00497"></a>00497 <span class="comment">/**</span>
520
+ <a name="l00498"></a>00498 <span class="comment"> * Convert a signal number to its associated name.</span>
521
+ <a name="l00499"></a>00499 <span class="comment"> */</span>
522
+ <a name="l00500"></a>00500 <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);
523
+ <a name="l00501"></a>00501 <span class="comment"></span>
524
+ <a name="l00502"></a>00502 <span class="comment">/**</span>
525
+ <a name="l00503"></a>00503 <span class="comment"> * Create a new Unix server socket which is bounded to &lt;tt&gt;filename&lt;/tt&gt;.</span>
526
+ <a name="l00504"></a>00504 <span class="comment"> *</span>
527
+ <a name="l00505"></a>00505 <span class="comment"> * @param filename The filename to bind the socket to.</span>
528
+ <a name="l00506"></a>00506 <span class="comment"> * @param backlogSize The size of the socket's backlog. Specify 0 to use the</span>
529
+ <a name="l00507"></a>00507 <span class="comment"> * platform's maximum allowed backlog size.</span>
530
+ <a name="l00508"></a>00508 <span class="comment"> * @param autoDelete Whether &lt;tt&gt;filename&lt;/tt&gt; should be deleted, if it already exists.</span>
531
+ <a name="l00509"></a>00509 <span class="comment"> * @return The file descriptor of the newly created Unix server socket.</span>
532
+ <a name="l00510"></a>00510 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
533
+ <a name="l00511"></a>00511 <span class="comment"> * @throws SystemException Something went wrong while creating the Unix server socket.</span>
534
534
  <a name="l00512"></a>00512 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
535
535
  <a name="l00513"></a>00513 <span class="comment"> * @ingroup Support</span>
536
536
  <a name="l00514"></a>00514 <span class="comment"> */</span>
537
- <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);
538
- <a name="l00516"></a>00516
539
- <a name="l00517"></a>00517
540
- <a name="l00518"></a>00518 <span class="comment"></span>
541
- <a name="l00519"></a>00519 <span class="comment">/**</span>
542
- <a name="l00520"></a>00520 <span class="comment"> * Represents a buffered upload file.</span>
543
- <a name="l00521"></a>00521 <span class="comment"> *</span>
544
- <a name="l00522"></a>00522 <span class="comment"> * @ingroup Support</span>
545
- <a name="l00523"></a>00523 <span class="comment"> */</span>
546
- <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> {
547
- <a name="l00525"></a>00525 <span class="keyword">public</span>:<span class="comment"></span>
548
- <a name="l00526"></a>00526 <span class="comment"> /** The file handle. */</span>
549
- <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>;
550
- <a name="l00528"></a>00528 <span class="comment"></span>
551
- <a name="l00529"></a>00529 <span class="comment"> /**</span>
552
- <a name="l00530"></a>00530 <span class="comment"> * Create an empty upload bufer file, and open it for reading and writing.</span>
553
- <a name="l00531"></a>00531 <span class="comment"> *</span>
554
- <a name="l00532"></a>00532 <span class="comment"> * @throws SystemException Something went wrong.</span>
555
- <a name="l00533"></a>00533 <span class="comment"> */</span>
556
- <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> &amp;dir, <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier = <span class="stringliteral">"temp"</span>) {
557
- <a name="l00535"></a>00535 <span class="keywordtype">char</span> templ[PATH_MAX];
558
- <a name="l00536"></a>00536 <span class="keywordtype">int</span> fd;
559
- <a name="l00537"></a>00537
560
- <a name="l00538"></a>00538 snprintf(templ, <span class="keyword">sizeof</span>(templ), <span class="stringliteral">"%s/%s.XXXXXX"</span>, dir.c_str(), identifier);
561
- <a name="l00539"></a>00539 templ[<span class="keyword">sizeof</span>(templ) - 1] = <span class="charliteral">'\0'</span>;
562
- <a name="l00540"></a>00540 fd = mkstemp(templ);
563
- <a name="l00541"></a>00541 <span class="keywordflow">if</span> (fd == -1) {
564
- <a name="l00542"></a>00542 <span class="keywordtype">char</span> message[1024];
565
- <a name="l00543"></a>00543 <span class="keywordtype">int</span> e = errno;
566
- <a name="l00544"></a>00544
567
- <a name="l00545"></a>00545 snprintf(message, <span class="keyword">sizeof</span>(message), <span class="stringliteral">"Cannot create a temporary file '%s'"</span>, templ);
568
- <a name="l00546"></a>00546 message[<span class="keyword">sizeof</span>(message) - 1] = <span class="charliteral">'\0'</span>;
569
- <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);
570
- <a name="l00548"></a>00548 }
571
- <a name="l00549"></a>00549
572
- <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>
573
- <a name="l00551"></a>00551 <span class="comment"> * and the file is deleted immediately from the filesystem, while we</span>
574
- <a name="l00552"></a>00552 <span class="comment"> * keep its file handle open. The result is that no other processes</span>
575
- <a name="l00553"></a>00553 <span class="comment"> * will be able to access this file's contents anymore, except us.</span>
576
- <a name="l00554"></a>00554 <span class="comment"> * We now have an anonymous disk-backed buffer.</span>
577
- <a name="l00555"></a>00555 <span class="comment"> */</span>
578
- <a name="l00556"></a>00556 fchmod(fd, 0000);
579
- <a name="l00557"></a>00557 unlink(templ);
580
- <a name="l00558"></a>00558
581
- <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>);
582
- <a name="l00560"></a>00560 }
583
- <a name="l00561"></a>00561
584
- <a name="l00562"></a>00562 ~<a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a>() {
585
- <a name="l00563"></a>00563 fclose(<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>);
586
- <a name="l00564"></a>00564 }
587
- <a name="l00565"></a>00565 };
588
- <a name="l00566"></a>00566 <span class="comment"></span>
589
- <a name="l00567"></a>00567 <span class="comment">/**</span>
590
- <a name="l00568"></a>00568 <span class="comment"> * Fills the given memory space or string with zeroes when a MemoryZeroGuard object</span>
591
- <a name="l00569"></a>00569 <span class="comment"> * is destroyed. Useful for ensuring that buffers containing password data or</span>
592
- <a name="l00570"></a>00570 <span class="comment"> * other sensitive information is cleared when it goes out of scope.</span>
593
- <a name="l00571"></a>00571 <span class="comment"> */</span>
594
- <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> {
595
- <a name="l00573"></a>00573 <span class="keyword">private</span>:
596
- <a name="l00574"></a>00574 <span class="keywordtype">void</span> *data;
597
- <a name="l00575"></a>00575 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
598
- <a name="l00576"></a>00576 <span class="keywordtype">string</span> *str;
599
- <a name="l00577"></a>00577
600
- <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) {
601
- <a name="l00579"></a>00579 <span class="comment">/* We do not use memset() here because the compiler may</span>
602
- <a name="l00580"></a>00580 <span class="comment"> * optimize out memset() calls. Instead, the following</span>
603
- <a name="l00581"></a>00581 <span class="comment"> * code is guaranteed to zero the memory.</span>
604
- <a name="l00582"></a>00582 <span class="comment"> * http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/protect-secrets.html</span>
605
- <a name="l00583"></a>00583 <span class="comment"> */</span>
606
- <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;
607
- <a name="l00585"></a>00585 <span class="keywordflow">while</span> (size--) {
608
- <a name="l00586"></a>00586 *p++ = 0;
609
- <a name="l00587"></a>00587 }
610
- <a name="l00588"></a>00588 }
611
- <a name="l00589"></a>00589
612
- <a name="l00590"></a>00590 <span class="keyword">public</span>:<span class="comment"></span>
613
- <a name="l00591"></a>00591 <span class="comment"> /**</span>
614
- <a name="l00592"></a>00592 <span class="comment"> * Creates a new MemZeroGuard object with a memory region to zero.</span>
615
- <a name="l00593"></a>00593 <span class="comment"> *</span>
616
- <a name="l00594"></a>00594 <span class="comment"> * @param data The data to zero after destruction.</span>
617
- <a name="l00595"></a>00595 <span class="comment"> * @param size The size of the data.</span>
618
- <a name="l00596"></a>00596 <span class="comment"> * @pre data != NULL</span>
619
- <a name="l00597"></a>00597 <span class="comment"> */</span>
620
- <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) {
621
- <a name="l00599"></a>00599 this-&gt;data = data;
622
- <a name="l00600"></a>00600 this-&gt;size = size;
623
- <a name="l00601"></a>00601 this-&gt;str = NULL;
624
- <a name="l00602"></a>00602 }
625
- <a name="l00603"></a>00603 <span class="comment"></span>
626
- <a name="l00604"></a>00604 <span class="comment"> /**</span>
627
- <a name="l00605"></a>00605 <span class="comment"> * Creates a new MemoryZeroGuard object with a string to zero.</span>
628
- <a name="l00606"></a>00606 <span class="comment"> *</span>
629
- <a name="l00607"></a>00607 <span class="comment"> * @param str The string to zero after destruction.</span>
630
- <a name="l00608"></a>00608 <span class="comment"> */</span>
631
- <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> &amp;str) {
632
- <a name="l00610"></a>00610 this-&gt;data = NULL;
633
- <a name="l00611"></a>00611 this-&gt;size = NULL;
634
- <a name="l00612"></a>00612 this-&gt;str = &amp;str;
537
+ <a name="l00515"></a>00515 <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>);
538
+ <a name="l00516"></a>00516 <span class="comment"></span>
539
+ <a name="l00517"></a>00517 <span class="comment">/**</span>
540
+ <a name="l00518"></a>00518 <span class="comment"> * Connect to a Unix server socket at &lt;tt&gt;filename&lt;/tt&gt;.</span>
541
+ <a name="l00519"></a>00519 <span class="comment"> *</span>
542
+ <a name="l00520"></a>00520 <span class="comment"> * @param filename The filename of the socket to connect to.</span>
543
+ <a name="l00521"></a>00521 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
544
+ <a name="l00522"></a>00522 <span class="comment"> * @throws RuntimeException Something went wrong.</span>
545
+ <a name="l00523"></a>00523 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
546
+ <a name="l00524"></a>00524 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
547
+ <a name="l00525"></a>00525 <span class="comment"> * @ingroup Support</span>
548
+ <a name="l00526"></a>00526 <span class="comment"> */</span>
549
+ <a name="l00527"></a>00527 <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);
550
+ <a name="l00528"></a>00528 <span class="comment"></span>
551
+ <a name="l00529"></a>00529 <span class="comment">/**</span>
552
+ <a name="l00530"></a>00530 <span class="comment"> * Connect to a TCP server socket at the given host name and port.</span>
553
+ <a name="l00531"></a>00531 <span class="comment"> *</span>
554
+ <a name="l00532"></a>00532 <span class="comment"> * @param hostname The host name of the TCP server.</span>
555
+ <a name="l00533"></a>00533 <span class="comment"> * @param port The port number of the TCP server.</span>
556
+ <a name="l00534"></a>00534 <span class="comment"> * @return The file descriptor of the connected client socket.</span>
557
+ <a name="l00535"></a>00535 <span class="comment"> * @throws IOException Something went wrong while connecting to the Unix server.</span>
558
+ <a name="l00536"></a>00536 <span class="comment"> * @throws SystemException Something went wrong while connecting to the Unix server.</span>
559
+ <a name="l00537"></a>00537 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
560
+ <a name="l00538"></a>00538 <span class="comment"> * @ingroup Support</span>
561
+ <a name="l00539"></a>00539 <span class="comment"> */</span>
562
+ <a name="l00540"></a>00540 <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);
563
+ <a name="l00541"></a>00541
564
+ <a name="l00542"></a>00542
565
+ <a name="l00543"></a>00543 <span class="comment"></span>
566
+ <a name="l00544"></a>00544 <span class="comment">/**</span>
567
+ <a name="l00545"></a>00545 <span class="comment"> * Represents a buffered upload file.</span>
568
+ <a name="l00546"></a>00546 <span class="comment"> *</span>
569
+ <a name="l00547"></a>00547 <span class="comment"> * @ingroup Support</span>
570
+ <a name="l00548"></a>00548 <span class="comment"> */</span>
571
+ <a name="l00549"></a><a class="code" href="classPassenger_1_1BufferedUpload.html">00549</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a> {
572
+ <a name="l00550"></a>00550 <span class="keyword">public</span>:<span class="comment"></span>
573
+ <a name="l00551"></a>00551 <span class="comment"> /** The file handle. */</span>
574
+ <a name="l00552"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac">00552</a> FILE *<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>;
575
+ <a name="l00553"></a>00553 <span class="comment"></span>
576
+ <a name="l00554"></a>00554 <span class="comment"> /**</span>
577
+ <a name="l00555"></a>00555 <span class="comment"> * Create an empty upload bufer file, and open it for reading and writing.</span>
578
+ <a name="l00556"></a>00556 <span class="comment"> *</span>
579
+ <a name="l00557"></a>00557 <span class="comment"> * @throws SystemException Something went wrong.</span>
580
+ <a name="l00558"></a>00558 <span class="comment"> */</span>
581
+ <a name="l00559"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#51489619731ea95c2ece27faab9e24fc">00559</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> &amp;dir, <span class="keyword">const</span> <span class="keywordtype">char</span> *identifier = <span class="stringliteral">"temp"</span>) {
582
+ <a name="l00560"></a>00560 <span class="keywordtype">char</span> templ[PATH_MAX];
583
+ <a name="l00561"></a>00561 <span class="keywordtype">int</span> fd;
584
+ <a name="l00562"></a>00562
585
+ <a name="l00563"></a>00563 snprintf(templ, <span class="keyword">sizeof</span>(templ), <span class="stringliteral">"%s/%s.XXXXXX"</span>, dir.c_str(), identifier);
586
+ <a name="l00564"></a>00564 templ[<span class="keyword">sizeof</span>(templ) - 1] = <span class="charliteral">'\0'</span>;
587
+ <a name="l00565"></a>00565 fd = mkstemp(templ);
588
+ <a name="l00566"></a>00566 <span class="keywordflow">if</span> (fd == -1) {
589
+ <a name="l00567"></a>00567 <span class="keywordtype">char</span> message[1024];
590
+ <a name="l00568"></a>00568 <span class="keywordtype">int</span> e = errno;
591
+ <a name="l00569"></a>00569
592
+ <a name="l00570"></a>00570 snprintf(message, <span class="keyword">sizeof</span>(message), <span class="stringliteral">"Cannot create a temporary file '%s'"</span>, templ);
593
+ <a name="l00571"></a>00571 message[<span class="keyword">sizeof</span>(message) - 1] = <span class="charliteral">'\0'</span>;
594
+ <a name="l00572"></a>00572 <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);
595
+ <a name="l00573"></a>00573 }
596
+ <a name="l00574"></a>00574
597
+ <a name="l00575"></a>00575 <span class="comment">/* We use a POSIX trick here: the file's permissions are set to "u=,g=,o="</span>
598
+ <a name="l00576"></a>00576 <span class="comment"> * and the file is deleted immediately from the filesystem, while we</span>
599
+ <a name="l00577"></a>00577 <span class="comment"> * keep its file handle open. The result is that no other processes</span>
600
+ <a name="l00578"></a>00578 <span class="comment"> * will be able to access this file's contents anymore, except us.</span>
601
+ <a name="l00579"></a>00579 <span class="comment"> * We now have an anonymous disk-backed buffer.</span>
602
+ <a name="l00580"></a>00580 <span class="comment"> */</span>
603
+ <a name="l00581"></a>00581 fchmod(fd, 0000);
604
+ <a name="l00582"></a>00582 unlink(templ);
605
+ <a name="l00583"></a>00583
606
+ <a name="l00584"></a>00584 <a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a> = fdopen(fd, <span class="stringliteral">"w+"</span>);
607
+ <a name="l00585"></a>00585 }
608
+ <a name="l00586"></a>00586
609
+ <a name="l00587"></a>00587 ~<a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a>() {
610
+ <a name="l00588"></a>00588 fclose(<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>);
611
+ <a name="l00589"></a>00589 }
612
+ <a name="l00590"></a>00590 };
613
+ <a name="l00591"></a>00591 <span class="comment"></span>
614
+ <a name="l00592"></a>00592 <span class="comment">/**</span>
615
+ <a name="l00593"></a>00593 <span class="comment"> * Fills the given memory space or string with zeroes when a MemoryZeroGuard object</span>
616
+ <a name="l00594"></a>00594 <span class="comment"> * is destroyed. Useful for ensuring that buffers containing password data or</span>
617
+ <a name="l00595"></a>00595 <span class="comment"> * other sensitive information is cleared when it goes out of scope.</span>
618
+ <a name="l00596"></a>00596 <span class="comment"> */</span>
619
+ <a name="l00597"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html">00597</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> {
620
+ <a name="l00598"></a>00598 <span class="keyword">private</span>:
621
+ <a name="l00599"></a>00599 <span class="keywordtype">void</span> *data;
622
+ <a name="l00600"></a>00600 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> size;
623
+ <a name="l00601"></a>00601 <span class="keywordtype">string</span> *str;
624
+ <a name="l00602"></a>00602
625
+ <a name="l00603"></a>00603 <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) {
626
+ <a name="l00604"></a>00604 <span class="comment">/* We do not use memset() here because the compiler may</span>
627
+ <a name="l00605"></a>00605 <span class="comment"> * optimize out memset() calls. Instead, the following</span>
628
+ <a name="l00606"></a>00606 <span class="comment"> * code is guaranteed to zero the memory.</span>
629
+ <a name="l00607"></a>00607 <span class="comment"> * http://www.dwheeler.com/secure-programs/Secure-Programs-HOWTO/protect-secrets.html</span>
630
+ <a name="l00608"></a>00608 <span class="comment"> */</span>
631
+ <a name="l00609"></a>00609 <span class="keyword">volatile</span> <span class="keywordtype">char</span> *p = (<span class="keyword">volatile</span> <span class="keywordtype">char</span> *) data;
632
+ <a name="l00610"></a>00610 <span class="keywordflow">while</span> (size--) {
633
+ <a name="l00611"></a>00611 *p++ = 0;
634
+ <a name="l00612"></a>00612 }
635
635
  <a name="l00613"></a>00613 }
636
- <a name="l00614"></a>00614 <span class="comment"></span>
637
- <a name="l00615"></a>00615 <span class="comment"> /**</span>
638
- <a name="l00616"></a>00616 <span class="comment"> * Zero the data immediately. The data will still be zeroed after</span>
639
- <a name="l00617"></a>00617 <span class="comment"> * destruction of this object.</span>
640
- <a name="l00618"></a>00618 <span class="comment"> */</span>
641
- <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>() {
642
- <a name="l00620"></a>00620 <span class="keywordflow">if</span> (str == NULL) {
643
- <a name="l00621"></a>00621 securelyZeroMemory(data, size);
644
- <a name="l00622"></a>00622 } <span class="keywordflow">else</span> {
645
- <a name="l00623"></a>00623 securelyZeroMemory((<span class="keyword">volatile</span> <span class="keywordtype">void</span> *) str-&gt;c_str(), str-&gt;size());
646
- <a name="l00624"></a>00624 }
647
- <a name="l00625"></a>00625 }
648
- <a name="l00626"></a>00626
649
- <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>() {
650
- <a name="l00628"></a>00628 <a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c" title="Zero the data immediately.">zeroNow</a>();
651
- <a name="l00629"></a>00629 }
652
- <a name="l00630"></a>00630 };
653
- <a name="l00631"></a>00631
654
- <a name="l00632"></a>00632 } <span class="comment">// namespace Passenger</span>
655
- <a name="l00633"></a>00633
656
- <a name="l00634"></a>00634 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_UTILS_H_ */</span>
657
- <a name="l00635"></a>00635
636
+ <a name="l00614"></a>00614
637
+ <a name="l00615"></a>00615 <span class="keyword">public</span>:<span class="comment"></span>
638
+ <a name="l00616"></a>00616 <span class="comment"> /**</span>
639
+ <a name="l00617"></a>00617 <span class="comment"> * Creates a new MemZeroGuard object with a memory region to zero.</span>
640
+ <a name="l00618"></a>00618 <span class="comment"> *</span>
641
+ <a name="l00619"></a>00619 <span class="comment"> * @param data The data to zero after destruction.</span>
642
+ <a name="l00620"></a>00620 <span class="comment"> * @param size The size of the data.</span>
643
+ <a name="l00621"></a>00621 <span class="comment"> * @pre data != NULL</span>
644
+ <a name="l00622"></a>00622 <span class="comment"> */</span>
645
+ <a name="l00623"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#73d032a0d185fe1a70683fbf25d12b50">00623</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) {
646
+ <a name="l00624"></a>00624 this-&gt;data = data;
647
+ <a name="l00625"></a>00625 this-&gt;size = size;
648
+ <a name="l00626"></a>00626 this-&gt;str = NULL;
649
+ <a name="l00627"></a>00627 }
650
+ <a name="l00628"></a>00628 <span class="comment"></span>
651
+ <a name="l00629"></a>00629 <span class="comment"> /**</span>
652
+ <a name="l00630"></a>00630 <span class="comment"> * Creates a new MemoryZeroGuard object with a string to zero.</span>
653
+ <a name="l00631"></a>00631 <span class="comment"> *</span>
654
+ <a name="l00632"></a>00632 <span class="comment"> * @param str The string to zero after destruction.</span>
655
+ <a name="l00633"></a>00633 <span class="comment"> */</span>
656
+ <a name="l00634"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#f2c179005d02719cee006280ffbba345">00634</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> &amp;str) {
657
+ <a name="l00635"></a>00635 this-&gt;data = NULL;
658
+ <a name="l00636"></a>00636 this-&gt;size = NULL;
659
+ <a name="l00637"></a>00637 this-&gt;str = &amp;str;
660
+ <a name="l00638"></a>00638 }
661
+ <a name="l00639"></a>00639 <span class="comment"></span>
662
+ <a name="l00640"></a>00640 <span class="comment"> /**</span>
663
+ <a name="l00641"></a>00641 <span class="comment"> * Zero the data immediately. The data will still be zeroed after</span>
664
+ <a name="l00642"></a>00642 <span class="comment"> * destruction of this object.</span>
665
+ <a name="l00643"></a>00643 <span class="comment"> */</span>
666
+ <a name="l00644"></a><a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c">00644</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c" title="Zero the data immediately.">zeroNow</a>() {
667
+ <a name="l00645"></a>00645 <span class="keywordflow">if</span> (str == NULL) {
668
+ <a name="l00646"></a>00646 securelyZeroMemory(data, size);
669
+ <a name="l00647"></a>00647 } <span class="keywordflow">else</span> {
670
+ <a name="l00648"></a>00648 securelyZeroMemory((<span class="keyword">volatile</span> <span class="keywordtype">void</span> *) str-&gt;c_str(), str-&gt;size());
671
+ <a name="l00649"></a>00649 }
672
+ <a name="l00650"></a>00650 }
673
+ <a name="l00651"></a>00651
674
+ <a name="l00652"></a>00652 ~<a class="code" href="classPassenger_1_1MemZeroGuard.html" title="Fills the given memory space or string with zeroes when a MemoryZeroGuard object...">MemZeroGuard</a>() {
675
+ <a name="l00653"></a>00653 <a class="code" href="classPassenger_1_1MemZeroGuard.html#fbefb3b41c341bcaeaa9c23f698df15c" title="Zero the data immediately.">zeroNow</a>();
676
+ <a name="l00654"></a>00654 }
677
+ <a name="l00655"></a>00655 };
678
+ <a name="l00656"></a>00656
679
+ <a name="l00657"></a>00657 } <span class="comment">// namespace Passenger</span>
680
+ <a name="l00658"></a>00658
681
+ <a name="l00659"></a>00659 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_UTILS_H_ */</span>
682
+ <a name="l00660"></a>00660
658
683
  </pre></div></div>
659
- <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
684
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Mar 28 14:11:56 2010 for Passenger by&nbsp;
660
685
  <a href="http://www.doxygen.org/index.html">
661
686
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
662
687
  </body>