passenger 2.2.9 → 2.2.10

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 (435) hide show
  1. data/NEWS +10 -0
  2. data/doc/Architectural overview.html +202 -65
  3. data/doc/Security of user switching support.html +200 -63
  4. data/doc/Users guide Apache.html +266 -129
  5. data/doc/Users guide Nginx.html +234 -97
  6. data/doc/cxxapi/AbstractSpawnManager_8h-source.html +138 -0
  7. data/doc/cxxapi/Account_8h-source.html +202 -0
  8. data/doc/cxxapi/AccountsDatabase_8h-source.html +158 -0
  9. data/doc/cxxapi/AgentsStarter_8h-source.html +79 -0
  10. data/doc/cxxapi/BCrypt_8h-source.html +101 -0
  11. data/doc/cxxapi/BacktracesServer_8h-source.html +87 -0
  12. data/doc/cxxapi/Base64_8h-source.html +85 -0
  13. data/doc/cxxapi/Blowfish_8h-source.html +131 -0
  14. data/doc/cxxapi/Bucket_8h-source.html +1 -1
  15. data/doc/cxxapi/CachedFileStat_8h-source.html +49 -157
  16. data/doc/cxxapi/Configuration_8h-source.html +1 -1
  17. data/doc/cxxapi/Constants_8h-source.html +71 -0
  18. data/doc/cxxapi/ContentHandler_8h-source.html +92 -0
  19. data/doc/cxxapi/DirectoryMapper_8h-source.html +1 -1
  20. data/doc/cxxapi/Exceptions_8h-source.html +332 -236
  21. data/doc/cxxapi/FileChangeChecker_8h-source.html +237 -0
  22. data/doc/cxxapi/FileDescriptor_8h-source.html +206 -0
  23. data/doc/cxxapi/Hooks_8h-source.html +1 -1
  24. data/doc/cxxapi/HttpStatusExtractor_8h-source.html +378 -0
  25. data/doc/cxxapi/LoggingServer_8h-source.html +165 -0
  26. data/doc/cxxapi/Logging_8h-source.html +580 -112
  27. data/doc/cxxapi/MessageChannel_8h-source.html +789 -599
  28. data/doc/cxxapi/MessageClient_8h-source.html +297 -0
  29. data/doc/cxxapi/MessageServer_8h-source.html +607 -0
  30. data/doc/cxxapi/PoolOptions_8h-source.html +471 -278
  31. data/doc/cxxapi/Process_8h-source.html +272 -0
  32. data/doc/cxxapi/RandomGenerator_8h-source.html +156 -0
  33. data/doc/cxxapi/ResourceLocator_8h-source.html +104 -0
  34. data/doc/cxxapi/ScgiRequestParser_8h-source.html +399 -0
  35. data/doc/cxxapi/ServerInstanceDir_8h-source.html +356 -0
  36. data/doc/cxxapi/Session_8h-source.html +483 -0
  37. data/doc/cxxapi/SpawnManager_8h-source.html +590 -546
  38. data/doc/cxxapi/StaticContentHandler_8h-source.html +65 -0
  39. data/doc/cxxapi/StaticString_8h-source.html +214 -0
  40. data/doc/cxxapi/StringListCreator_8h-source.html +111 -0
  41. data/doc/cxxapi/SystemTime_8h-source.html +191 -78
  42. data/doc/cxxapi/Timer_8h-source.html +157 -0
  43. data/doc/cxxapi/Utils_8h-source.html +621 -434
  44. data/doc/cxxapi/Version_8h-source.html +59 -0
  45. data/doc/cxxapi/annotated.html +1 -1
  46. data/doc/cxxapi/apache2_2Configuration_8h-source.html +79 -0
  47. data/doc/cxxapi/classAgentWatcher-members.html +50 -0
  48. data/doc/cxxapi/classAgentWatcher.html +445 -0
  49. data/doc/cxxapi/classClient-members.html +4 -3
  50. data/doc/cxxapi/classClient.html +50 -46
  51. data/doc/cxxapi/classHooks-members.html +1 -1
  52. data/doc/cxxapi/classHooks.html +1 -1
  53. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager-members.html +37 -0
  54. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager.html +191 -0
  55. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.map +1 -0
  56. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.md5 +1 -0
  57. data/doc/cxxapi/classPassenger_1_1AbstractSpawnManager__inherit__graph.png +0 -0
  58. data/doc/cxxapi/{classPassenger_1_1DummySpawnManager-members.html → classPassenger_1_1ArgumentException-members.html} +3 -2
  59. data/doc/cxxapi/classPassenger_1_1ArgumentException.html +52 -0
  60. data/doc/cxxapi/classPassenger_1_1BacktracesServer-members.html +36 -0
  61. data/doc/cxxapi/classPassenger_1_1BacktracesServer.html +107 -0
  62. data/doc/cxxapi/classPassenger_1_1BacktracesServer__inherit__graph.map +1 -0
  63. data/doc/cxxapi/classPassenger_1_1BacktracesServer__inherit__graph.md5 +1 -0
  64. data/doc/cxxapi/classPassenger_1_1BacktracesServer__inherit__graph.png +0 -0
  65. data/doc/cxxapi/classPassenger_1_1BufferedUpload-members.html +3 -3
  66. data/doc/cxxapi/classPassenger_1_1BufferedUpload.html +18 -34
  67. data/doc/cxxapi/classPassenger_1_1BusyException-members.html +2 -1
  68. data/doc/cxxapi/classPassenger_1_1BusyException.html +3 -2
  69. data/doc/cxxapi/classPassenger_1_1ConfigurationException-members.html +2 -1
  70. data/doc/cxxapi/classPassenger_1_1ConfigurationException.html +3 -2
  71. data/doc/cxxapi/classPassenger_1_1DirectoryMapper-members.html +1 -1
  72. data/doc/cxxapi/classPassenger_1_1DirectoryMapper.html +1 -1
  73. data/doc/cxxapi/{classPassenger_1_1FileChecker-members.html → classPassenger_1_1EOFException-members.html} +3 -4
  74. data/doc/cxxapi/classPassenger_1_1EOFException.html +57 -0
  75. data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.map +1 -0
  76. data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.md5 +1 -0
  77. data/doc/cxxapi/classPassenger_1_1EOFException__inherit__graph.png +0 -0
  78. data/doc/cxxapi/classPassenger_1_1EventFd-members.html +33 -0
  79. data/doc/cxxapi/classPassenger_1_1EventFd.html +49 -0
  80. data/doc/cxxapi/classPassenger_1_1FileChangeChecker-members.html +37 -0
  81. data/doc/cxxapi/classPassenger_1_1FileChangeChecker.html +166 -0
  82. data/doc/cxxapi/classPassenger_1_1FileDescriptor-members.html +37 -0
  83. data/doc/cxxapi/classPassenger_1_1FileDescriptor.html +159 -0
  84. data/doc/cxxapi/classPassenger_1_1FileNotFoundException-members.html +2 -1
  85. data/doc/cxxapi/classPassenger_1_1FileNotFoundException.html +3 -2
  86. data/doc/cxxapi/classPassenger_1_1FileSystemException-members.html +2 -1
  87. data/doc/cxxapi/classPassenger_1_1FileSystemException.html +3 -2
  88. data/doc/cxxapi/{classPassenger_1_1ApplicationPoolServer-members.html → classPassenger_1_1HttpStatusExtractor-members.html} +6 -5
  89. data/doc/cxxapi/classPassenger_1_1HttpStatusExtractor.html +128 -0
  90. data/doc/cxxapi/classPassenger_1_1IOException-members.html +2 -1
  91. data/doc/cxxapi/classPassenger_1_1IOException.html +4 -3
  92. data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.map +2 -1
  93. data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.md5 +1 -1
  94. data/doc/cxxapi/classPassenger_1_1IOException__inherit__graph.png +0 -0
  95. data/doc/cxxapi/classPassenger_1_1MemZeroGuard-members.html +36 -0
  96. data/doc/cxxapi/classPassenger_1_1MemZeroGuard.html +147 -0
  97. data/doc/cxxapi/classPassenger_1_1MessageChannel-members.html +12 -5
  98. data/doc/cxxapi/classPassenger_1_1MessageChannel.html +267 -34
  99. data/doc/cxxapi/classPassenger_1_1MessageServer-members.html +46 -0
  100. data/doc/cxxapi/classPassenger_1_1MessageServer.html +438 -0
  101. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext-members.html +33 -0
  102. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext.html +56 -0
  103. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.map +1 -0
  104. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.md5 +1 -0
  105. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1ClientContext__inherit__graph.png +0 -0
  106. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext-members.html +38 -0
  107. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext.html +175 -0
  108. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.map +1 -0
  109. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.md5 +1 -0
  110. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1CommonClientContext__inherit__graph.png +0 -0
  111. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler-members.html +36 -0
  112. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler.html +176 -0
  113. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler__inherit__graph.map +1 -0
  114. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler__inherit__graph.md5 +1 -0
  115. data/doc/cxxapi/classPassenger_1_1MessageServer_1_1Handler__inherit__graph.png +0 -0
  116. data/doc/cxxapi/classPassenger_1_1Process-members.html +40 -0
  117. data/doc/cxxapi/classPassenger_1_1Process.html +266 -0
  118. data/doc/cxxapi/classPassenger_1_1RandomGenerator-members.html +33 -0
  119. data/doc/cxxapi/classPassenger_1_1RandomGenerator.html +51 -0
  120. data/doc/cxxapi/classPassenger_1_1RuntimeException-members.html +2 -1
  121. data/doc/cxxapi/classPassenger_1_1RuntimeException.html +3 -2
  122. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser-members.html +47 -0
  123. data/doc/cxxapi/classPassenger_1_1ScgiRequestParser.html +302 -0
  124. data/doc/cxxapi/classPassenger_1_1SecurityException-members.html +33 -0
  125. data/doc/cxxapi/classPassenger_1_1SecurityException.html +52 -0
  126. data/doc/cxxapi/classPassenger_1_1Session-members.html +50 -0
  127. data/doc/cxxapi/classPassenger_1_1Session.html +577 -0
  128. data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.map +1 -0
  129. data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.md5 +1 -0
  130. data/doc/cxxapi/classPassenger_1_1Session__inherit__graph.png +0 -0
  131. data/doc/cxxapi/classPassenger_1_1SpawnException-members.html +2 -1
  132. data/doc/cxxapi/classPassenger_1_1SpawnException.html +5 -4
  133. data/doc/cxxapi/classPassenger_1_1SpawnManager-members.html +8 -5
  134. data/doc/cxxapi/classPassenger_1_1SpawnManager.html +127 -45
  135. data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.map +1 -0
  136. data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.md5 +1 -0
  137. data/doc/cxxapi/classPassenger_1_1SpawnManager__inherit__graph.png +0 -0
  138. data/doc/cxxapi/classPassenger_1_1StandardSession-members.html +51 -0
  139. data/doc/cxxapi/classPassenger_1_1StandardSession.html +415 -0
  140. data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.map +1 -0
  141. data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.md5 +1 -0
  142. data/doc/cxxapi/classPassenger_1_1StandardSession__inherit__graph.png +0 -0
  143. data/doc/cxxapi/classPassenger_1_1StaticString-members.html +33 -0
  144. data/doc/cxxapi/classPassenger_1_1StaticString.html +54 -0
  145. data/doc/cxxapi/classPassenger_1_1SystemException-members.html +2 -1
  146. data/doc/cxxapi/classPassenger_1_1SystemException.html +4 -3
  147. data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.map +1 -0
  148. data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.md5 +1 -1
  149. data/doc/cxxapi/classPassenger_1_1SystemException__inherit__graph.png +0 -0
  150. data/doc/cxxapi/classPassenger_1_1SystemTime-members.html +9 -1
  151. data/doc/cxxapi/classPassenger_1_1SystemTime.html +92 -8
  152. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException-members.html +37 -0
  153. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException.html +57 -0
  154. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.map +1 -0
  155. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.md5 +1 -0
  156. data/doc/cxxapi/classPassenger_1_1TimeRetrievalException__inherit__graph.png +0 -0
  157. data/doc/cxxapi/classPassenger_1_1TimeoutException-members.html +33 -0
  158. data/doc/cxxapi/classPassenger_1_1TimeoutException.html +50 -0
  159. data/doc/cxxapi/{classPassenger_1_1Application-members.html → classPassenger_1_1Timer-members.html} +8 -7
  160. data/doc/cxxapi/classPassenger_1_1Timer.html +163 -0
  161. data/doc/cxxapi/classServer-members.html +33 -0
  162. data/doc/cxxapi/classServer.html +46 -0
  163. data/doc/cxxapi/classServerInstanceDirToucher-members.html +33 -0
  164. data/doc/cxxapi/classServerInstanceDirToucher.html +43 -0
  165. data/doc/cxxapi/classes.html +1 -1
  166. data/doc/cxxapi/definitions_8h-source.html +1 -1
  167. data/doc/cxxapi/files.html +1 -1
  168. data/doc/cxxapi/functions.html +1 -1
  169. data/doc/cxxapi/{functions_type.html → functions_enum.html} +7 -5
  170. data/doc/cxxapi/functions_eval.html +55 -0
  171. data/doc/cxxapi/functions_func.html +1 -1
  172. data/doc/cxxapi/functions_vars.html +106 -9
  173. data/doc/cxxapi/graph_legend.html +1 -1
  174. data/doc/cxxapi/group__Configuration.html +1 -1
  175. data/doc/cxxapi/group__Core.html +1 -1
  176. data/doc/cxxapi/group__Exceptions.html +17 -1
  177. data/doc/cxxapi/group__Hooks.html +1 -1
  178. data/doc/cxxapi/group__Support.html +1 -1
  179. data/doc/cxxapi/hierarchy.html +34 -12
  180. data/doc/cxxapi/inherit__graph__0.map +1 -1
  181. data/doc/cxxapi/inherit__graph__0.md5 +1 -1
  182. data/doc/cxxapi/inherit__graph__0.png +0 -0
  183. data/doc/cxxapi/inherit__graph__1.map +1 -1
  184. data/doc/cxxapi/inherit__graph__1.md5 +1 -1
  185. data/doc/cxxapi/inherit__graph__1.png +0 -0
  186. data/doc/cxxapi/inherit__graph__10.map +1 -1
  187. data/doc/cxxapi/inherit__graph__10.md5 +1 -1
  188. data/doc/cxxapi/inherit__graph__10.png +0 -0
  189. data/doc/cxxapi/inherit__graph__11.map +1 -1
  190. data/doc/cxxapi/inherit__graph__11.md5 +1 -1
  191. data/doc/cxxapi/inherit__graph__11.png +0 -0
  192. data/doc/cxxapi/inherit__graph__12.map +1 -1
  193. data/doc/cxxapi/inherit__graph__12.md5 +1 -1
  194. data/doc/cxxapi/inherit__graph__12.png +0 -0
  195. data/doc/cxxapi/inherit__graph__13.map +1 -1
  196. data/doc/cxxapi/inherit__graph__13.md5 +1 -1
  197. data/doc/cxxapi/inherit__graph__13.png +0 -0
  198. data/doc/cxxapi/inherit__graph__14.map +3 -2
  199. data/doc/cxxapi/inherit__graph__14.md5 +1 -1
  200. data/doc/cxxapi/inherit__graph__14.png +0 -0
  201. data/doc/cxxapi/inherit__graph__15.map +1 -1
  202. data/doc/cxxapi/inherit__graph__15.md5 +1 -1
  203. data/doc/cxxapi/inherit__graph__15.png +0 -0
  204. data/doc/cxxapi/inherit__graph__16.map +1 -1
  205. data/doc/cxxapi/inherit__graph__16.md5 +1 -1
  206. data/doc/cxxapi/inherit__graph__16.png +0 -0
  207. data/doc/cxxapi/inherit__graph__17.map +1 -1
  208. data/doc/cxxapi/inherit__graph__17.md5 +1 -1
  209. data/doc/cxxapi/inherit__graph__17.png +0 -0
  210. data/doc/cxxapi/inherit__graph__18.map +2 -1
  211. data/doc/cxxapi/inherit__graph__18.md5 +1 -1
  212. data/doc/cxxapi/inherit__graph__18.png +0 -0
  213. data/doc/cxxapi/inherit__graph__19.map +1 -1
  214. data/doc/cxxapi/inherit__graph__19.md5 +1 -1
  215. data/doc/cxxapi/inherit__graph__19.png +0 -0
  216. data/doc/cxxapi/inherit__graph__2.map +1 -1
  217. data/doc/cxxapi/inherit__graph__2.md5 +1 -1
  218. data/doc/cxxapi/inherit__graph__2.png +0 -0
  219. data/doc/cxxapi/inherit__graph__20.map +1 -2
  220. data/doc/cxxapi/inherit__graph__20.md5 +1 -1
  221. data/doc/cxxapi/inherit__graph__20.png +0 -0
  222. data/doc/cxxapi/inherit__graph__21.map +1 -1
  223. data/doc/cxxapi/inherit__graph__21.md5 +1 -1
  224. data/doc/cxxapi/inherit__graph__21.png +0 -0
  225. data/doc/cxxapi/inherit__graph__22.map +1 -0
  226. data/doc/cxxapi/inherit__graph__22.md5 +1 -0
  227. data/doc/cxxapi/inherit__graph__22.png +0 -0
  228. data/doc/cxxapi/inherit__graph__23.map +1 -0
  229. data/doc/cxxapi/inherit__graph__23.md5 +1 -0
  230. data/doc/cxxapi/inherit__graph__23.png +0 -0
  231. data/doc/cxxapi/inherit__graph__24.map +1 -0
  232. data/doc/cxxapi/inherit__graph__24.md5 +1 -0
  233. data/doc/cxxapi/inherit__graph__24.png +0 -0
  234. data/doc/cxxapi/inherit__graph__25.map +1 -0
  235. data/doc/cxxapi/inherit__graph__25.md5 +1 -0
  236. data/doc/cxxapi/inherit__graph__25.png +0 -0
  237. data/doc/cxxapi/inherit__graph__26.map +1 -0
  238. data/doc/cxxapi/inherit__graph__26.md5 +1 -0
  239. data/doc/cxxapi/inherit__graph__26.png +0 -0
  240. data/doc/cxxapi/inherit__graph__27.map +2 -0
  241. data/doc/cxxapi/inherit__graph__27.md5 +1 -0
  242. data/doc/cxxapi/inherit__graph__27.png +0 -0
  243. data/doc/cxxapi/inherit__graph__28.map +1 -0
  244. data/doc/cxxapi/inherit__graph__28.md5 +1 -0
  245. data/doc/cxxapi/inherit__graph__28.png +0 -0
  246. data/doc/cxxapi/inherit__graph__29.map +1 -0
  247. data/doc/cxxapi/inherit__graph__29.md5 +1 -0
  248. data/doc/cxxapi/inherit__graph__29.png +0 -0
  249. data/doc/cxxapi/inherit__graph__3.map +2 -1
  250. data/doc/cxxapi/inherit__graph__3.md5 +1 -1
  251. data/doc/cxxapi/inherit__graph__3.png +0 -0
  252. data/doc/cxxapi/inherit__graph__30.map +1 -0
  253. data/doc/cxxapi/inherit__graph__30.md5 +1 -0
  254. data/doc/cxxapi/inherit__graph__30.png +0 -0
  255. data/doc/cxxapi/inherit__graph__31.map +3 -0
  256. data/doc/cxxapi/inherit__graph__31.md5 +1 -0
  257. data/doc/cxxapi/inherit__graph__31.png +0 -0
  258. data/doc/cxxapi/inherit__graph__32.map +1 -0
  259. data/doc/cxxapi/inherit__graph__32.md5 +1 -0
  260. data/doc/cxxapi/inherit__graph__32.png +0 -0
  261. data/doc/cxxapi/inherit__graph__33.map +1 -0
  262. data/doc/cxxapi/inherit__graph__33.md5 +1 -0
  263. data/doc/cxxapi/inherit__graph__33.png +0 -0
  264. data/doc/cxxapi/inherit__graph__34.map +1 -0
  265. data/doc/cxxapi/inherit__graph__34.md5 +1 -0
  266. data/doc/cxxapi/inherit__graph__34.png +0 -0
  267. data/doc/cxxapi/inherit__graph__35.map +1 -0
  268. data/doc/cxxapi/inherit__graph__35.md5 +1 -0
  269. data/doc/cxxapi/inherit__graph__35.png +0 -0
  270. data/doc/cxxapi/inherit__graph__36.map +1 -0
  271. data/doc/cxxapi/inherit__graph__36.md5 +1 -0
  272. data/doc/cxxapi/inherit__graph__36.png +0 -0
  273. data/doc/cxxapi/inherit__graph__4.map +1 -1
  274. data/doc/cxxapi/inherit__graph__4.md5 +1 -1
  275. data/doc/cxxapi/inherit__graph__4.png +0 -0
  276. data/doc/cxxapi/inherit__graph__5.map +1 -1
  277. data/doc/cxxapi/inherit__graph__5.md5 +1 -1
  278. data/doc/cxxapi/inherit__graph__5.png +0 -0
  279. data/doc/cxxapi/inherit__graph__6.map +1 -2
  280. data/doc/cxxapi/inherit__graph__6.md5 +1 -1
  281. data/doc/cxxapi/inherit__graph__6.png +0 -0
  282. data/doc/cxxapi/inherit__graph__7.map +1 -1
  283. data/doc/cxxapi/inherit__graph__7.md5 +1 -1
  284. data/doc/cxxapi/inherit__graph__7.png +0 -0
  285. data/doc/cxxapi/inherit__graph__8.map +1 -1
  286. data/doc/cxxapi/inherit__graph__8.md5 +1 -1
  287. data/doc/cxxapi/inherit__graph__8.png +0 -0
  288. data/doc/cxxapi/inherit__graph__9.map +1 -1
  289. data/doc/cxxapi/inherit__graph__9.md5 +1 -1
  290. data/doc/cxxapi/inherit__graph__9.png +0 -0
  291. data/doc/cxxapi/inherits.html +81 -41
  292. data/doc/cxxapi/main.html +1 -1
  293. data/doc/cxxapi/md5_8h-source.html +121 -0
  294. data/doc/cxxapi/modules.html +1 -1
  295. data/doc/cxxapi/namespacePassenger.html +651 -0
  296. data/doc/cxxapi/namespacemembers.html +155 -0
  297. data/doc/cxxapi/namespacemembers_enum.html +46 -0
  298. data/doc/cxxapi/namespacemembers_eval.html +52 -0
  299. data/doc/cxxapi/namespacemembers_func.html +139 -0
  300. data/doc/cxxapi/namespacemembers_type.html +50 -0
  301. data/doc/cxxapi/namespaces.html +34 -0
  302. data/doc/cxxapi/nginx_2Configuration_8h-source.html +114 -0
  303. data/doc/cxxapi/ngx__http__passenger__module_8h-source.html +91 -0
  304. data/doc/cxxapi/structPassenger_1_1AnythingToString-members.html +2 -1
  305. data/doc/cxxapi/structPassenger_1_1AnythingToString.html +3 -2
  306. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4-members.html +2 -1
  307. data/doc/cxxapi/structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html +3 -2
  308. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard-members.html +33 -0
  309. data/doc/cxxapi/structPassenger_1_1MessageServer_1_1DisconnectEventBroadcastGuard.html +49 -0
  310. data/doc/cxxapi/structPassenger_1_1PoolOptions-members.html +19 -7
  311. data/doc/cxxapi/structPassenger_1_1PoolOptions.html +323 -53
  312. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash-members.html +33 -0
  313. data/doc/cxxapi/structPassenger_1_1StaticString_1_1Hash.html +49 -0
  314. data/ext/common/MessageChannel.h +48 -4
  315. data/ext/common/Version.h +1 -1
  316. data/ext/nginx/HttpStatusExtractor.h +1 -0
  317. data/ext/nginx/ScgiRequestParser.h +1 -0
  318. data/ext/phusion_passenger/native_support.c +5 -1
  319. data/lib/phusion_passenger/constants.rb +1 -1
  320. data/lib/phusion_passenger/message_channel.rb +45 -3
  321. data/lib/phusion_passenger/rack/application_spawner.rb +4 -0
  322. data/lib/phusion_passenger/railz/application_spawner.rb +19 -1
  323. data/lib/phusion_passenger/utils.rb +3 -3
  324. data/lib/phusion_passenger/utils/rewindable_input.rb +5 -0
  325. data/test/MessageChannelTest.cpp +9 -1
  326. data/test/stub/message_channel.rb +1 -1
  327. data/test/stub/message_channel_2.rb +1 -1
  328. data/test/stub/message_channel_3.rb +2 -2
  329. metadata +173 -113
  330. data/doc/cxxapi/ApplicationPoolServer_8h-source.html +0 -833
  331. data/doc/cxxapi/ApplicationPool_8h-source.html +0 -226
  332. data/doc/cxxapi/Application_8h-source.html +0 -553
  333. data/doc/cxxapi/DummySpawnManager_8h-source.html +0 -130
  334. data/doc/cxxapi/FileChecker_8h-source.html +0 -134
  335. data/doc/cxxapi/StandardApplicationPool_8h-source.html +0 -842
  336. data/doc/cxxapi/classPassenger_1_1Application.html +0 -231
  337. data/doc/cxxapi/classPassenger_1_1ApplicationPool-members.html +0 -41
  338. data/doc/cxxapi/classPassenger_1_1ApplicationPool.html +0 -323
  339. data/doc/cxxapi/classPassenger_1_1ApplicationPoolServer.html +0 -227
  340. data/doc/cxxapi/classPassenger_1_1ApplicationPool__inherit__graph.map +0 -1
  341. data/doc/cxxapi/classPassenger_1_1ApplicationPool__inherit__graph.md5 +0 -1
  342. data/doc/cxxapi/classPassenger_1_1ApplicationPool__inherit__graph.png +0 -0
  343. data/doc/cxxapi/classPassenger_1_1Application_1_1Session-members.html +0 -44
  344. data/doc/cxxapi/classPassenger_1_1Application_1_1Session.html +0 -403
  345. data/doc/cxxapi/classPassenger_1_1DummySpawnManager.html +0 -53
  346. data/doc/cxxapi/classPassenger_1_1FileChecker.html +0 -124
  347. data/doc/cxxapi/classPassenger_1_1StandardApplicationPool-members.html +0 -44
  348. data/doc/cxxapi/classPassenger_1_1StandardApplicationPool.html +0 -342
  349. data/doc/cxxapi/classPassenger_1_1StandardApplicationPool__inherit__graph.map +0 -1
  350. data/doc/cxxapi/classPassenger_1_1StandardApplicationPool__inherit__graph.md5 +0 -1
  351. data/doc/cxxapi/classPassenger_1_1StandardApplicationPool__inherit__graph.png +0 -0
  352. data/doc/rdoc/classes/ConditionVariable.html +0 -194
  353. data/doc/rdoc/classes/Exception.html +0 -120
  354. data/doc/rdoc/classes/GC.html +0 -113
  355. data/doc/rdoc/classes/IO.html +0 -169
  356. data/doc/rdoc/classes/PhusionPassenger.html +0 -239
  357. data/doc/rdoc/classes/PhusionPassenger/AbstractInstaller.html +0 -153
  358. data/doc/rdoc/classes/PhusionPassenger/AbstractRequestHandler.html +0 -517
  359. data/doc/rdoc/classes/PhusionPassenger/AbstractServer.html +0 -719
  360. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerAlreadyStarted.html +0 -97
  361. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerError.html +0 -96
  362. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/ServerNotStarted.html +0 -97
  363. data/doc/rdoc/classes/PhusionPassenger/AbstractServer/UnknownMessage.html +0 -96
  364. data/doc/rdoc/classes/PhusionPassenger/AbstractServerCollection.html +0 -598
  365. data/doc/rdoc/classes/PhusionPassenger/AdminTools.html +0 -140
  366. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ControlProcess.html +0 -317
  367. data/doc/rdoc/classes/PhusionPassenger/AdminTools/ControlProcess/Instance.html +0 -138
  368. data/doc/rdoc/classes/PhusionPassenger/AppInitError.html +0 -154
  369. data/doc/rdoc/classes/PhusionPassenger/Application.html +0 -283
  370. data/doc/rdoc/classes/PhusionPassenger/ConsoleTextTemplate.html +0 -172
  371. data/doc/rdoc/classes/PhusionPassenger/FrameworkInitError.html +0 -145
  372. data/doc/rdoc/classes/PhusionPassenger/HTMLTemplate.html +0 -175
  373. data/doc/rdoc/classes/PhusionPassenger/InitializationError.html +0 -141
  374. data/doc/rdoc/classes/PhusionPassenger/InvalidPath.html +0 -92
  375. data/doc/rdoc/classes/PhusionPassenger/MessageChannel.html +0 -489
  376. data/doc/rdoc/classes/PhusionPassenger/NativeSupport.html +0 -350
  377. data/doc/rdoc/classes/PhusionPassenger/Rack.html +0 -91
  378. data/doc/rdoc/classes/PhusionPassenger/Rack/ApplicationSpawner.html +0 -188
  379. data/doc/rdoc/classes/PhusionPassenger/Rack/RequestHandler.html +0 -199
  380. data/doc/rdoc/classes/PhusionPassenger/Railz.html +0 -95
  381. data/doc/rdoc/classes/PhusionPassenger/Railz/ApplicationSpawner.html +0 -438
  382. data/doc/rdoc/classes/PhusionPassenger/Railz/ApplicationSpawner/Error.html +0 -98
  383. data/doc/rdoc/classes/PhusionPassenger/Railz/CGIFixed.html +0 -200
  384. data/doc/rdoc/classes/PhusionPassenger/Railz/FrameworkSpawner.html +0 -436
  385. data/doc/rdoc/classes/PhusionPassenger/Railz/FrameworkSpawner/Error.html +0 -98
  386. data/doc/rdoc/classes/PhusionPassenger/Railz/RequestHandler.html +0 -155
  387. data/doc/rdoc/classes/PhusionPassenger/SpawnManager.html +0 -402
  388. data/doc/rdoc/classes/PhusionPassenger/UnknownError.html +0 -125
  389. data/doc/rdoc/classes/PhusionPassenger/Utils.html +0 -805
  390. data/doc/rdoc/classes/PhusionPassenger/Utils/PseudoIO.html +0 -169
  391. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput.html +0 -247
  392. data/doc/rdoc/classes/PhusionPassenger/Utils/RewindableInput/Tempfile.html +0 -120
  393. data/doc/rdoc/classes/PhusionPassenger/VersionNotFound.html +0 -140
  394. data/doc/rdoc/classes/PhusionPassenger/WSGI.html +0 -89
  395. data/doc/rdoc/classes/PhusionPassenger/WSGI/ApplicationSpawner.html +0 -188
  396. data/doc/rdoc/classes/PlatformInfo.html +0 -866
  397. data/doc/rdoc/classes/RakeExtensions.html +0 -197
  398. data/doc/rdoc/classes/Signal.html +0 -139
  399. data/doc/rdoc/created.rid +0 -1
  400. data/doc/rdoc/files/DEVELOPERS_TXT.html +0 -255
  401. data/doc/rdoc/files/README.html +0 -157
  402. data/doc/rdoc/files/ext/phusion_passenger/native_support_c.html +0 -92
  403. data/doc/rdoc/files/lib/phusion_passenger/abstract_installer_rb.html +0 -129
  404. data/doc/rdoc/files/lib/phusion_passenger/abstract_request_handler_rb.html +0 -129
  405. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_collection_rb.html +0 -126
  406. data/doc/rdoc/files/lib/phusion_passenger/abstract_server_rb.html +0 -128
  407. data/doc/rdoc/files/lib/phusion_passenger/admin_tools/control_process_rb.html +0 -130
  408. data/doc/rdoc/files/lib/phusion_passenger/admin_tools_rb.html +0 -122
  409. data/doc/rdoc/files/lib/phusion_passenger/application_rb.html +0 -127
  410. data/doc/rdoc/files/lib/phusion_passenger/console_text_template_rb.html +0 -126
  411. data/doc/rdoc/files/lib/phusion_passenger/constants_rb.html +0 -122
  412. data/doc/rdoc/files/lib/phusion_passenger/dependencies_rb.html +0 -134
  413. data/doc/rdoc/files/lib/phusion_passenger/events_rb.html +0 -122
  414. data/doc/rdoc/files/lib/phusion_passenger/exceptions_rb.html +0 -122
  415. data/doc/rdoc/files/lib/phusion_passenger/html_template_rb.html +0 -126
  416. data/doc/rdoc/files/lib/phusion_passenger/message_channel_rb.html +0 -120
  417. data/doc/rdoc/files/lib/phusion_passenger/packaging_rb.html +0 -122
  418. data/doc/rdoc/files/lib/phusion_passenger/platform_info_rb.html +0 -127
  419. data/doc/rdoc/files/lib/phusion_passenger/rack/application_spawner_rb.html +0 -133
  420. data/doc/rdoc/files/lib/phusion_passenger/rack/request_handler_rb.html +0 -125
  421. data/doc/rdoc/files/lib/phusion_passenger/railz/application_spawner_rb.html +0 -140
  422. data/doc/rdoc/files/lib/phusion_passenger/railz/cgi_fixed_rb.html +0 -126
  423. data/doc/rdoc/files/lib/phusion_passenger/railz/framework_spawner_rb.html +0 -145
  424. data/doc/rdoc/files/lib/phusion_passenger/railz/request_handler_rb.html +0 -125
  425. data/doc/rdoc/files/lib/phusion_passenger/simple_benchmarking_rb.html +0 -122
  426. data/doc/rdoc/files/lib/phusion_passenger/spawn_manager_rb.html +0 -159
  427. data/doc/rdoc/files/lib/phusion_passenger/utils/rewindable_input_rb.html +0 -100
  428. data/doc/rdoc/files/lib/phusion_passenger/utils_rb.html +0 -174
  429. data/doc/rdoc/files/lib/phusion_passenger/wsgi/application_spawner_rb.html +0 -129
  430. data/doc/rdoc/files/misc/rake/extensions_rb.html +0 -130
  431. data/doc/rdoc/fr_class_index.html +0 -93
  432. data/doc/rdoc/fr_file_index.html +0 -77
  433. data/doc/rdoc/fr_method_index.html +0 -212
  434. data/doc/rdoc/index.html +0 -26
  435. data/doc/rdoc/rdoc-style.css +0 -187
@@ -0,0 +1,157 @@
1
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
+ <html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
3
+ <title>Passenger: Timer.h Source File</title>
4
+ <link href="tabs.css" rel="stylesheet" type="text/css">
5
+ <link href="doxygen.css" rel="stylesheet" type="text/css">
6
+ </head><body>
7
+ <!-- Generated by Doxygen 1.5.8 -->
8
+ <div class="navigation" id="top">
9
+ <div class="tabs">
10
+ <ul>
11
+ <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12
+ <li><a href="modules.html"><span>Modules</span></a></li>
13
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
14
+ <li><a href="annotated.html"><span>Classes</span></a></li>
15
+ <li class="current"><a href="files.html"><span>Files</span></a></li>
16
+ </ul>
17
+ </div>
18
+ <div class="tabs">
19
+ <ul>
20
+ <li><a href="files.html"><span>File&nbsp;List</span></a></li>
21
+ </ul>
22
+ </div>
23
+ <h1>Timer.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
24
+ <a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
25
+ <a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
26
+ <a name="l00004"></a>00004 <span class="comment"> *</span>
27
+ <a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
28
+ <a name="l00006"></a>00006 <span class="comment"> *</span>
29
+ <a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
30
+ <a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
31
+ <a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
32
+ <a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
33
+ <a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
34
+ <a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
35
+ <a name="l00013"></a>00013 <span class="comment"> *</span>
36
+ <a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
37
+ <a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
38
+ <a name="l00016"></a>00016 <span class="comment"> *</span>
39
+ <a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
40
+ <a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
41
+ <a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
42
+ <a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
43
+ <a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
44
+ <a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
45
+ <a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
46
+ <a name="l00024"></a>00024 <span class="comment"> */</span>
47
+ <a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_TIMER_H_</span>
48
+ <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_TIMER_H_</span>
49
+ <a name="l00027"></a>00027 <span class="preprocessor"></span>
50
+ <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/thread.hpp&gt;</span>
51
+ <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;oxt/system_calls.hpp&gt;</span>
52
+ <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;sys/time.h&gt;</span>
53
+ <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;cerrno&gt;</span>
54
+ <a name="l00032"></a>00032
55
+ <a name="l00033"></a>00033 <span class="keyword">namespace </span>Passenger {
56
+ <a name="l00034"></a>00034
57
+ <a name="l00035"></a>00035 <span class="keyword">using namespace </span>boost;
58
+ <a name="l00036"></a>00036 <span class="keyword">using namespace </span>oxt;
59
+ <a name="l00037"></a>00037 <span class="comment"></span>
60
+ <a name="l00038"></a>00038 <span class="comment">/**</span>
61
+ <a name="l00039"></a>00039 <span class="comment"> * A Timer which one can use to check how much time has elapsed since the</span>
62
+ <a name="l00040"></a>00040 <span class="comment"> * timer started. This timer support miliseconds-resolution, but the exact</span>
63
+ <a name="l00041"></a>00041 <span class="comment"> * resolution depends on the OS and the hardware.</span>
64
+ <a name="l00042"></a>00042 <span class="comment"> *</span>
65
+ <a name="l00043"></a>00043 <span class="comment"> * This class is thread-safe.</span>
66
+ <a name="l00044"></a>00044 <span class="comment"> *</span>
67
+ <a name="l00045"></a>00045 <span class="comment"> * @code</span>
68
+ <a name="l00046"></a>00046 <span class="comment"> * Timer timer;</span>
69
+ <a name="l00047"></a>00047 <span class="comment"> * sleep(10);</span>
70
+ <a name="l00048"></a>00048 <span class="comment"> * timer.elapsed(); // =&gt; about 10000 (msec)</span>
71
+ <a name="l00049"></a>00049 <span class="comment"> * @endcode</span>
72
+ <a name="l00050"></a>00050 <span class="comment"> */</span>
73
+ <a name="l00051"></a><a class="code" href="classPassenger_1_1Timer.html">00051</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1Timer.html" title="A Timer which one can use to check how much time has elapsed since the timer started...">Timer</a> {
74
+ <a name="l00052"></a>00052 <span class="keyword">private</span>:
75
+ <a name="l00053"></a>00053 <span class="keyword">struct </span>timeval startTime;
76
+ <a name="l00054"></a>00054 <span class="keyword">mutable</span> boost::mutex lock;
77
+ <a name="l00055"></a>00055 <span class="keyword">public</span>:<span class="comment"></span>
78
+ <a name="l00056"></a>00056 <span class="comment"> /**</span>
79
+ <a name="l00057"></a>00057 <span class="comment"> * Creates a new Timer object.</span>
80
+ <a name="l00058"></a>00058 <span class="comment"> *</span>
81
+ <a name="l00059"></a>00059 <span class="comment"> * @param startNow Whether the timer should be started immediately.</span>
82
+ <a name="l00060"></a>00060 <span class="comment"> */</span>
83
+ <a name="l00061"></a><a class="code" href="classPassenger_1_1Timer.html#6be9070c1a2d0a9abbd98a1a90f916c6">00061</a> <a class="code" href="classPassenger_1_1Timer.html#6be9070c1a2d0a9abbd98a1a90f916c6" title="Creates a new Timer object.">Timer</a>(<span class="keywordtype">bool</span> startNow = <span class="keyword">true</span>) {
84
+ <a name="l00062"></a>00062 <span class="keywordflow">if</span> (startNow) {
85
+ <a name="l00063"></a>00063 <a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5" title="Start the timer.">start</a>();
86
+ <a name="l00064"></a>00064 } <span class="keywordflow">else</span> {
87
+ <a name="l00065"></a>00065 <a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063" title="Stop the timer.">stop</a>();
88
+ <a name="l00066"></a>00066 }
89
+ <a name="l00067"></a>00067 }
90
+ <a name="l00068"></a>00068 <span class="comment"></span>
91
+ <a name="l00069"></a>00069 <span class="comment"> /**</span>
92
+ <a name="l00070"></a>00070 <span class="comment"> * Start the timer. If the timer was already started, then this will</span>
93
+ <a name="l00071"></a>00071 <span class="comment"> * restart the timer.</span>
94
+ <a name="l00072"></a>00072 <span class="comment"> */</span>
95
+ <a name="l00073"></a><a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5">00073</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#3808e3b519b4d59894ae3390bc19e7a5" title="Start the timer.">start</a>() {
96
+ <a name="l00074"></a>00074 <span class="comment">// TODO: We really use should clock_gettime() and the monotonic</span>
97
+ <a name="l00075"></a>00075 <span class="comment">// clock whenever possible, instead of gettimeofday()...</span>
98
+ <a name="l00076"></a>00076 lock_guard&lt;boost::mutex&gt; l(lock);
99
+ <a name="l00077"></a>00077 <span class="keywordtype">int</span> ret;
100
+ <a name="l00078"></a>00078 <span class="keywordflow">do</span> {
101
+ <a name="l00079"></a>00079 ret = gettimeofday(&amp;startTime, NULL);
102
+ <a name="l00080"></a>00080 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
103
+ <a name="l00081"></a>00081 }
104
+ <a name="l00082"></a>00082 <span class="comment"></span>
105
+ <a name="l00083"></a>00083 <span class="comment"> /**</span>
106
+ <a name="l00084"></a>00084 <span class="comment"> * Stop the timer. If there's currently another thread waiting on the wait()</span>
107
+ <a name="l00085"></a>00085 <span class="comment"> * call, then that wait() call will block indefinitely until you call start()</span>
108
+ <a name="l00086"></a>00086 <span class="comment"> * and sufficient amount of time has elapsed.</span>
109
+ <a name="l00087"></a>00087 <span class="comment"> */</span>
110
+ <a name="l00088"></a><a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063">00088</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#15aadf8f5b520c18ccd87b9d2bc7e063" title="Stop the timer.">stop</a>() {
111
+ <a name="l00089"></a>00089 lock_guard&lt;boost::mutex&gt; l(lock);
112
+ <a name="l00090"></a>00090 startTime.tv_sec = 0;
113
+ <a name="l00091"></a>00091 startTime.tv_usec = 0;
114
+ <a name="l00092"></a>00092 }
115
+ <a name="l00093"></a>00093 <span class="comment"></span>
116
+ <a name="l00094"></a>00094 <span class="comment"> /**</span>
117
+ <a name="l00095"></a>00095 <span class="comment"> * Returns the amount of time that has elapsed since the timer was last started,</span>
118
+ <a name="l00096"></a>00096 <span class="comment"> * in miliseconds. If the timer is currently stopped, then 0 is returned.</span>
119
+ <a name="l00097"></a>00097 <span class="comment"> */</span>
120
+ <a name="l00098"></a><a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2">00098</a> <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> <a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2" title="Returns the amount of time that has elapsed since the timer was last started, in...">elapsed</a>()<span class="keyword"> const </span>{
121
+ <a name="l00099"></a>00099 lock_guard&lt;boost::mutex&gt; l(lock);
122
+ <a name="l00100"></a>00100 <span class="keywordflow">if</span> (startTime.tv_sec == 0 &amp;&amp; startTime.tv_usec == 0) {
123
+ <a name="l00101"></a>00101 <span class="keywordflow">return</span> 0;
124
+ <a name="l00102"></a>00102 } <span class="keywordflow">else</span> {
125
+ <a name="l00103"></a>00103 <span class="keyword">struct </span>timeval t;
126
+ <a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> now, beginning;
127
+ <a name="l00105"></a>00105 <span class="keywordtype">int</span> ret;
128
+ <a name="l00106"></a>00106
129
+ <a name="l00107"></a>00107 <span class="keywordflow">do</span> {
130
+ <a name="l00108"></a>00108 ret = gettimeofday(&amp;t, NULL);
131
+ <a name="l00109"></a>00109 } <span class="keywordflow">while</span> (ret == -1 &amp;&amp; errno == EINTR);
132
+ <a name="l00110"></a>00110 now = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> long) t.tv_sec * 1000 + t.tv_usec / 1000;
133
+ <a name="l00111"></a>00111 beginning = (<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span>) startTime.tv_sec * 1000 + startTime.tv_usec / 1000;
134
+ <a name="l00112"></a>00112 <span class="keywordflow">return</span> now - beginning;
135
+ <a name="l00113"></a>00113 }
136
+ <a name="l00114"></a>00114 }
137
+ <a name="l00115"></a>00115 <span class="comment"></span>
138
+ <a name="l00116"></a>00116 <span class="comment"> /**</span>
139
+ <a name="l00117"></a>00117 <span class="comment"> * Wait until &lt;em&gt;time&lt;/em&gt; miliseconds have elapsed since the timer</span>
140
+ <a name="l00118"></a>00118 <span class="comment"> * was last started.</span>
141
+ <a name="l00119"></a>00119 <span class="comment"> */</span>
142
+ <a name="l00120"></a><a class="code" href="classPassenger_1_1Timer.html#5f8667ebab3890ddc412b2086dbec14c">00120</a> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1Timer.html#5f8667ebab3890ddc412b2086dbec14c" title="Wait until time miliseconds have elapsed since the timer was last started.">wait</a>(<span class="keywordtype">unsigned</span> <span class="keywordtype">long</span> <span class="keywordtype">long</span> time)<span class="keyword"> const </span>{
143
+ <a name="l00121"></a>00121 <span class="keywordflow">while</span> (<a class="code" href="classPassenger_1_1Timer.html#b65b046b385b6d964f685ada320fe5f2" title="Returns the amount of time that has elapsed since the timer was last started, in...">elapsed</a>() &lt; time) {
144
+ <a name="l00122"></a>00122 syscalls::usleep(25000);
145
+ <a name="l00123"></a>00123 }
146
+ <a name="l00124"></a>00124 }
147
+ <a name="l00125"></a>00125 };
148
+ <a name="l00126"></a>00126
149
+ <a name="l00127"></a>00127 } <span class="comment">// namespace Passenger</span>
150
+ <a name="l00128"></a>00128
151
+ <a name="l00129"></a>00129 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_TIMER_H_ */</span>
152
+ </pre></div></div>
153
+ <hr size="1"><address style="text-align: right;"><small>Generated on Mon Feb 8 22:53:22 2010 for Passenger by&nbsp;
154
+ <a href="http://www.doxygen.org/index.html">
155
+ <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
156
+ </body>
157
+ </html>
@@ -10,6 +10,7 @@
10
10
  <ul>
11
11
  <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
12
12
  <li><a href="modules.html"><span>Modules</span></a></li>
13
+ <li><a href="namespaces.html"><span>Namespaces</span></a></li>
13
14
  <li><a href="annotated.html"><span>Classes</span></a></li>
14
15
  <li class="current"><a href="files.html"><span>Files</span></a></li>
15
16
  </ul>
@@ -21,455 +22,641 @@
21
22
  </div>
22
23
  <h1>Utils.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
23
24
  <a name="l00002"></a>00002 <span class="comment"> * Phusion Passenger - http://www.modrails.com/</span>
24
- <a name="l00003"></a>00003 <span class="comment"> * Copyright (C) 2008 Phusion</span>
25
+ <a name="l00003"></a>00003 <span class="comment"> * Copyright (c) 2010 Phusion</span>
25
26
  <a name="l00004"></a>00004 <span class="comment"> *</span>
26
- <a name="l00005"></a>00005 <span class="comment"> * Phusion Passenger is a trademark of Hongli Lai &amp; Ninh Bui.</span>
27
+ <a name="l00005"></a>00005 <span class="comment"> * "Phusion Passenger" is a trademark of Hongli Lai &amp; Ninh Bui.</span>
27
28
  <a name="l00006"></a>00006 <span class="comment"> *</span>
28
- <a name="l00007"></a>00007 <span class="comment"> * This program is free software; you can redistribute it and/or modify</span>
29
- <a name="l00008"></a>00008 <span class="comment"> * it under the terms of the GNU General Public License as published by</span>
30
- <a name="l00009"></a>00009 <span class="comment"> * the Free Software Foundation; version 2 of the License.</span>
31
- <a name="l00010"></a>00010 <span class="comment"> *</span>
32
- <a name="l00011"></a>00011 <span class="comment"> * This program is distributed in the hope that it will be useful,</span>
33
- <a name="l00012"></a>00012 <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
34
- <a name="l00013"></a>00013 <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span>
35
- <a name="l00014"></a>00014 <span class="comment"> * GNU General Public License for more details.</span>
36
- <a name="l00015"></a>00015 <span class="comment"> *</span>
37
- <a name="l00016"></a>00016 <span class="comment"> * You should have received a copy of the GNU General Public License along</span>
38
- <a name="l00017"></a>00017 <span class="comment"> * with this program; if not, write to the Free Software Foundation, Inc.,</span>
39
- <a name="l00018"></a>00018 <span class="comment"> * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.</span>
40
- <a name="l00019"></a>00019 <span class="comment"> */</span>
41
- <a name="l00020"></a>00020 <span class="preprocessor">#ifndef _PASSENGER_UTILS_H_</span>
42
- <a name="l00021"></a>00021 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_UTILS_H_</span>
43
- <a name="l00022"></a>00022 <span class="preprocessor"></span>
44
- <a name="l00023"></a>00023 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
45
- <a name="l00024"></a>00024 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
46
- <a name="l00025"></a>00025 <span class="preprocessor">#include &lt;sys/stat.h&gt;</span>
47
- <a name="l00026"></a>00026 <span class="preprocessor">#include &lt;string&gt;</span>
48
- <a name="l00027"></a>00027 <span class="preprocessor">#include &lt;vector&gt;</span>
49
- <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;utility&gt;</span>
50
- <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sstream&gt;</span>
51
- <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;cstdio&gt;</span>
52
- <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;climits&gt;</span>
53
- <a name="l00032"></a>00032 <span class="preprocessor">#include &lt;cstdlib&gt;</span>
54
- <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;cstring&gt;</span>
55
- <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;errno.h&gt;</span>
56
- <a name="l00035"></a>00035 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
57
- <a name="l00036"></a>00036 <span class="preprocessor">#include "Exceptions.h"</span>
58
- <a name="l00037"></a>00037
59
- <a name="l00038"></a>00038 <span class="keyword">typedef</span> <span class="keyword">struct </span>CachedMultiFileStat CachedMultiFileStat;
60
- <a name="l00039"></a>00039
61
- <a name="l00040"></a>00040 <span class="keyword">namespace </span>Passenger {
62
- <a name="l00041"></a>00041
63
- <a name="l00042"></a>00042 <span class="keyword">using namespace </span>std;
64
- <a name="l00043"></a>00043 <span class="keyword">using namespace </span>boost;
65
- <a name="l00044"></a>00044 <span class="comment"></span>
66
- <a name="l00045"></a>00045 <span class="comment">/** Enumeration which indicates what kind of file a file is. */</span>
67
- <a name="l00046"></a>00046 <span class="keyword">typedef</span> <span class="keyword">enum</span> {<span class="comment"></span>
68
- <a name="l00047"></a>00047 <span class="comment"> /** The file doesn't exist. */</span>
69
- <a name="l00048"></a>00048 FT_NONEXISTANT,<span class="comment"></span>
70
- <a name="l00049"></a>00049 <span class="comment"> /** A regular file or a symlink to a regular file. */</span>
71
- <a name="l00050"></a>00050 FT_REGULAR,<span class="comment"></span>
72
- <a name="l00051"></a>00051 <span class="comment"> /** A directory. */</span>
73
- <a name="l00052"></a>00052 FT_DIRECTORY,<span class="comment"></span>
74
- <a name="l00053"></a>00053 <span class="comment"> /** Something else, e.g. a pipe or a socket. */</span>
75
- <a name="l00054"></a>00054 FT_OTHER
76
- <a name="l00055"></a>00055 } FileType;
77
- <a name="l00056"></a>00056 <span class="comment"></span>
78
- <a name="l00057"></a>00057 <span class="comment">/**</span>
79
- <a name="l00058"></a>00058 <span class="comment"> * Convenience shortcut for creating a &lt;tt&gt;shared_ptr&lt;/tt&gt;.</span>
80
- <a name="l00059"></a>00059 <span class="comment"> * Instead of:</span>
81
- <a name="l00060"></a>00060 <span class="comment"> * @code</span>
82
- <a name="l00061"></a>00061 <span class="comment"> * shared_ptr&lt;Foo&gt; foo;</span>
83
- <a name="l00062"></a>00062 <span class="comment"> * ...</span>
84
- <a name="l00063"></a>00063 <span class="comment"> * foo = shared_ptr&lt;Foo&gt;(new Foo());</span>
85
- <a name="l00064"></a>00064 <span class="comment"> * @endcode</span>
86
- <a name="l00065"></a>00065 <span class="comment"> * one can write:</span>
87
- <a name="l00066"></a>00066 <span class="comment"> * @code</span>
88
- <a name="l00067"></a>00067 <span class="comment"> * shared_ptr&lt;Foo&gt; foo;</span>
89
- <a name="l00068"></a>00068 <span class="comment"> * ...</span>
90
- <a name="l00069"></a>00069 <span class="comment"> * foo = ptr(new Foo());</span>
91
- <a name="l00070"></a>00070 <span class="comment"> * @endcode</span>
92
- <a name="l00071"></a>00071 <span class="comment"> *</span>
93
- <a name="l00072"></a>00072 <span class="comment"> * @param pointer The item to put in the shared_ptr object.</span>
94
- <a name="l00073"></a>00073 <span class="comment"> * @ingroup Support</span>
95
- <a name="l00074"></a>00074 <span class="comment"> */</span>
96
- <a name="l00075"></a>00075 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; shared_ptr&lt;T&gt;
97
- <a name="l00076"></a><a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396">00076</a> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(T *pointer) {
98
- <a name="l00077"></a>00077 <span class="keywordflow">return</span> shared_ptr&lt;T&gt;(pointer);
99
- <a name="l00078"></a>00078 }
100
- <a name="l00079"></a>00079 <span class="comment"></span>
101
- <a name="l00080"></a>00080 <span class="comment">/**</span>
102
- <a name="l00081"></a>00081 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
103
- <a name="l00082"></a>00082 <span class="comment"> *</span>
104
- <a name="l00083"></a>00083 <span class="comment"> * @internal</span>
29
+ <a name="l00007"></a>00007 <span class="comment"> * Permission is hereby granted, free of charge, to any person obtaining a copy</span>
30
+ <a name="l00008"></a>00008 <span class="comment"> * of this software and associated documentation files (the "Software"), to deal</span>
31
+ <a name="l00009"></a>00009 <span class="comment"> * in the Software without restriction, including without limitation the rights</span>
32
+ <a name="l00010"></a>00010 <span class="comment"> * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
33
+ <a name="l00011"></a>00011 <span class="comment"> * copies of the Software, and to permit persons to whom the Software is</span>
34
+ <a name="l00012"></a>00012 <span class="comment"> * furnished to do so, subject to the following conditions:</span>
35
+ <a name="l00013"></a>00013 <span class="comment"> *</span>
36
+ <a name="l00014"></a>00014 <span class="comment"> * The above copyright notice and this permission notice shall be included in</span>
37
+ <a name="l00015"></a>00015 <span class="comment"> * all copies or substantial portions of the Software.</span>
38
+ <a name="l00016"></a>00016 <span class="comment"> *</span>
39
+ <a name="l00017"></a>00017 <span class="comment"> * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
40
+ <a name="l00018"></a>00018 <span class="comment"> * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
41
+ <a name="l00019"></a>00019 <span class="comment"> * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
42
+ <a name="l00020"></a>00020 <span class="comment"> * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
43
+ <a name="l00021"></a>00021 <span class="comment"> * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
44
+ <a name="l00022"></a>00022 <span class="comment"> * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
45
+ <a name="l00023"></a>00023 <span class="comment"> * THE SOFTWARE.</span>
46
+ <a name="l00024"></a>00024 <span class="comment"> */</span>
47
+ <a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_UTILS_H_</span>
48
+ <a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_UTILS_H_</span>
49
+ <a name="l00027"></a>00027 <span class="preprocessor"></span>
50
+ <a name="l00028"></a>00028 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
51
+ <a name="l00029"></a>00029 <span class="preprocessor">#include &lt;sys/types.h&gt;</span>
52
+ <a name="l00030"></a>00030 <span class="preprocessor">#include &lt;sys/stat.h&gt;</span>
53
+ <a name="l00031"></a>00031 <span class="preprocessor">#include &lt;string&gt;</span>
54
+ <a name="l00032"></a>00032 <span class="preprocessor">#include &lt;vector&gt;</span>
55
+ <a name="l00033"></a>00033 <span class="preprocessor">#include &lt;utility&gt;</span>
56
+ <a name="l00034"></a>00034 <span class="preprocessor">#include &lt;sstream&gt;</span>
57
+ <a name="l00035"></a>00035 <span class="preprocessor">#include &lt;cstdio&gt;</span>
58
+ <a name="l00036"></a>00036 <span class="preprocessor">#include &lt;climits&gt;</span>
59
+ <a name="l00037"></a>00037 <span class="preprocessor">#include &lt;cstdlib&gt;</span>
60
+ <a name="l00038"></a>00038 <span class="preprocessor">#include &lt;cstring&gt;</span>
61
+ <a name="l00039"></a>00039 <span class="preprocessor">#include &lt;errno.h&gt;</span>
62
+ <a name="l00040"></a>00040 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
63
+ <a name="l00041"></a>00041 <span class="preprocessor">#include "StaticString.h"</span>
64
+ <a name="l00042"></a>00042 <span class="preprocessor">#include "Exceptions.h"</span>
65
+ <a name="l00043"></a>00043
66
+ <a name="l00044"></a>00044 <span class="keyword">namespace </span>Passenger {
67
+ <a name="l00045"></a>00045
68
+ <a name="l00046"></a>00046 <span class="keyword">using namespace </span>std;
69
+ <a name="l00047"></a>00047 <span class="keyword">using namespace </span>boost;
70
+ <a name="l00048"></a>00048
71
+ <a name="l00049"></a>00049 <span class="keyword">static</span> <span class="keyword">const</span> uid_t USER_NOT_GIVEN = (uid_t) -1;
72
+ <a name="l00050"></a>00050 <span class="keyword">static</span> <span class="keyword">const</span> gid_t GROUP_NOT_GIVEN = (gid_t) -1;
73
+ <a name="l00051"></a>00051
74
+ <a name="l00052"></a>00052 <span class="keyword">typedef</span> <span class="keyword">struct </span>CachedFileStat CachedFileStat;
75
+ <a name="l00053"></a>00053 <span class="keyword">class </span>ResourceLocator;
76
+ <a name="l00054"></a>00054 <span class="comment"></span>
77
+ <a name="l00055"></a>00055 <span class="comment">/** Enumeration which indicates what kind of file a file is. */</span>
78
+ <a name="l00056"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d">00056</a> <span class="keyword">typedef</span> <span class="keyword">enum</span> {<span class="comment"></span>
79
+ <a name="l00057"></a>00057 <span class="comment"> /** The file doesn't exist. */</span>
80
+ <a name="l00058"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d9fc66834fe96c52799397496b8df8486">00058</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d9fc66834fe96c52799397496b8df8486" title="The file doesn&amp;#39;t exist.">FT_NONEXISTANT</a>,<span class="comment"></span>
81
+ <a name="l00059"></a>00059 <span class="comment"> /** A regular file or a symlink to a regular file. */</span>
82
+ <a name="l00060"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d1538596a928321d1a282c6bb06e80563">00060</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d1538596a928321d1a282c6bb06e80563" title="A regular file or a symlink to a regular file.">FT_REGULAR</a>,<span class="comment"></span>
83
+ <a name="l00061"></a>00061 <span class="comment"> /** A directory. */</span>
84
+ <a name="l00062"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07dbb09dbba1071b4770913363db2462eee">00062</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07dbb09dbba1071b4770913363db2462eee" title="A directory.">FT_DIRECTORY</a>,<span class="comment"></span>
85
+ <a name="l00063"></a>00063 <span class="comment"> /** Something else, e.g. a pipe or a socket. */</span>
86
+ <a name="l00064"></a><a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d3e89b9a7be074975e007d9f7cd77f4ff">00064</a> <a class="code" href="namespacePassenger.html#14174b712df6046cb823cde43d7ef07d3e89b9a7be074975e007d9f7cd77f4ff" title="Something else, e.g.">FT_OTHER</a>
87
+ <a name="l00065"></a>00065 } FileType;
88
+ <a name="l00066"></a>00066 <span class="comment"></span>
89
+ <a name="l00067"></a>00067 <span class="comment">/**</span>
90
+ <a name="l00068"></a>00068 <span class="comment"> * Convenience shortcut for creating a &lt;tt&gt;shared_ptr&lt;/tt&gt;.</span>
91
+ <a name="l00069"></a>00069 <span class="comment"> * Instead of:</span>
92
+ <a name="l00070"></a>00070 <span class="comment"> * @code</span>
93
+ <a name="l00071"></a>00071 <span class="comment"> * shared_ptr&lt;Foo&gt; foo;</span>
94
+ <a name="l00072"></a>00072 <span class="comment"> * ...</span>
95
+ <a name="l00073"></a>00073 <span class="comment"> * foo = shared_ptr&lt;Foo&gt;(new Foo());</span>
96
+ <a name="l00074"></a>00074 <span class="comment"> * @endcode</span>
97
+ <a name="l00075"></a>00075 <span class="comment"> * one can write:</span>
98
+ <a name="l00076"></a>00076 <span class="comment"> * @code</span>
99
+ <a name="l00077"></a>00077 <span class="comment"> * shared_ptr&lt;Foo&gt; foo;</span>
100
+ <a name="l00078"></a>00078 <span class="comment"> * ...</span>
101
+ <a name="l00079"></a>00079 <span class="comment"> * foo = ptr(new Foo());</span>
102
+ <a name="l00080"></a>00080 <span class="comment"> * @endcode</span>
103
+ <a name="l00081"></a>00081 <span class="comment"> *</span>
104
+ <a name="l00082"></a>00082 <span class="comment"> * @param pointer The item to put in the shared_ptr object.</span>
105
+ <a name="l00083"></a>00083 <span class="comment"> * @ingroup Support</span>
105
106
  <a name="l00084"></a>00084 <span class="comment"> */</span>
106
- <a name="l00085"></a>00085 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
107
- <a name="l00086"></a><a class="code" href="structPassenger_1_1AnythingToString.html">00086</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a> {
108
- <a name="l00087"></a>00087 <span class="keywordtype">string</span> operator()(T something) {
109
- <a name="l00088"></a>00088 stringstream s;
110
- <a name="l00089"></a>00089 s &lt;&lt; something;
111
- <a name="l00090"></a>00090 <span class="keywordflow">return</span> s.str();
112
- <a name="l00091"></a>00091 }
113
- <a name="l00092"></a>00092 };
114
- <a name="l00093"></a>00093 <span class="comment"></span>
115
- <a name="l00094"></a>00094 <span class="comment">/**</span>
116
- <a name="l00095"></a>00095 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
117
- <a name="l00096"></a>00096 <span class="comment"> *</span>
118
- <a name="l00097"></a>00097 <span class="comment"> * @internal</span>
119
- <a name="l00098"></a>00098 <span class="comment"> */</span>
120
- <a name="l00099"></a>00099 <span class="keyword">template</span>&lt;&gt;
121
- <a name="l00100"></a><a class="code" href="structPassenger_1_1AnythingToString_3_01vector_3_01string_01_4_01_4.html">00100</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; {
122
- <a name="l00101"></a>00101 <span class="keywordtype">string</span> operator()(<span class="keyword">const</span> vector&lt;string&gt; &amp;v) {
123
- <a name="l00102"></a>00102 <span class="keywordtype">string</span> result(<span class="stringliteral">"["</span>);
124
- <a name="l00103"></a>00103 vector&lt;string&gt;::const_iterator it;
125
- <a name="l00104"></a>00104 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> i;
126
- <a name="l00105"></a>00105 <span class="keywordflow">for</span> (it = v.begin(), i = 0; it != v.end(); it++, i++) {
127
- <a name="l00106"></a>00106 result.append(<span class="stringliteral">"'"</span>);
128
- <a name="l00107"></a>00107 result.append(*it);
129
- <a name="l00108"></a>00108 <span class="keywordflow">if</span> (i == v.size() - 1) {
130
- <a name="l00109"></a>00109 result.append(<span class="stringliteral">"'"</span>);
131
- <a name="l00110"></a>00110 } <span class="keywordflow">else</span> {
132
- <a name="l00111"></a>00111 result.append(<span class="stringliteral">"', "</span>);
133
- <a name="l00112"></a>00112 }
134
- <a name="l00113"></a>00113 }
135
- <a name="l00114"></a>00114 result.append(<span class="stringliteral">"]"</span>);
136
- <a name="l00115"></a>00115 <span class="keywordflow">return</span> result;
137
- <a name="l00116"></a>00116 }
138
- <a name="l00117"></a>00117 };
139
- <a name="l00118"></a>00118 <span class="comment"></span>
140
- <a name="l00119"></a>00119 <span class="comment">/**</span>
141
- <a name="l00120"></a>00120 <span class="comment"> * Convert anything to a string.</span>
142
- <a name="l00121"></a>00121 <span class="comment"> *</span>
143
- <a name="l00122"></a>00122 <span class="comment"> * @param something The thing to convert.</span>
144
- <a name="l00123"></a>00123 <span class="comment"> * @ingroup Support</span>
145
- <a name="l00124"></a>00124 <span class="comment"> */</span>
146
- <a name="l00125"></a>00125 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; <span class="keywordtype">string</span>
147
- <a name="l00126"></a><a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407">00126</a> <a class="code" href="group__Support.html#gf6fab368d70c18fdf16bf5a24f630407" title="Convert anything to a string.">toString</a>(T something) {
148
- <a name="l00127"></a>00127 <span class="keywordflow">return</span> <a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString&lt;T&gt;</a>()(something);
149
- <a name="l00128"></a>00128 }
150
- <a name="l00129"></a>00129 <span class="comment"></span>
151
- <a name="l00130"></a>00130 <span class="comment">/**</span>
152
- <a name="l00131"></a>00131 <span class="comment"> * Converts the given string to an integer.</span>
153
- <a name="l00132"></a>00132 <span class="comment"> * @ingroup Support</span>
154
- <a name="l00133"></a>00133 <span class="comment"> */</span>
155
- <a name="l00134"></a>00134 <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);
156
- <a name="l00135"></a>00135 <span class="comment"></span>
157
- <a name="l00136"></a>00136 <span class="comment">/**</span>
158
- <a name="l00137"></a>00137 <span class="comment"> * Converts the given string to a long integer.</span>
159
- <a name="l00138"></a>00138 <span class="comment"> * @ingroup Support</span>
160
- <a name="l00139"></a>00139 <span class="comment"> */</span>
161
- <a name="l00140"></a>00140 <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);
162
- <a name="l00141"></a>00141 <span class="comment"></span>
163
- <a name="l00142"></a>00142 <span class="comment">/**</span>
164
- <a name="l00143"></a>00143 <span class="comment"> * Split the given string using the given separator.</span>
165
- <a name="l00144"></a>00144 <span class="comment"> *</span>
166
- <a name="l00145"></a>00145 <span class="comment"> * @param str The string to split.</span>
167
- <a name="l00146"></a>00146 <span class="comment"> * @param sep The separator to use.</span>
168
- <a name="l00147"></a>00147 <span class="comment"> * @param output The vector to write the output to.</span>
107
+ <a name="l00085"></a>00085 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt; shared_ptr&lt;T&gt;
108
+ <a name="l00086"></a><a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396">00086</a> <a class="code" href="group__Support.html#g41b6c4a82fed72531a147de0505a8396" title="Convenience shortcut for creating a shared_ptr.">ptr</a>(T *pointer) {
109
+ <a name="l00087"></a>00087 <span class="keywordflow">return</span> shared_ptr&lt;T&gt;(pointer);
110
+ <a name="l00088"></a>00088 }
111
+ <a name="l00089"></a>00089 <span class="comment"></span>
112
+ <a name="l00090"></a>00090 <span class="comment">/**</span>
113
+ <a name="l00091"></a>00091 <span class="comment"> * Used internally by toString(). Do not use directly.</span>
114
+ <a name="l00092"></a>00092 <span class="comment"> *</span>
115
+ <a name="l00093"></a>00093 <span class="comment"> * @internal</span>
116
+ <a name="l00094"></a>00094 <span class="comment"> */</span>
117
+ <a name="l00095"></a>00095 <span class="keyword">template</span>&lt;<span class="keyword">typename</span> T&gt;
118
+ <a name="l00096"></a><a class="code" href="structPassenger_1_1AnythingToString.html">00096</a> <span class="keyword">struct </span><a class="code" href="structPassenger_1_1AnythingToString.html" title="Used internally by toString().">AnythingToString</a> {
119
+ <a name="l00097"></a>00097 <span class="keywordtype">string</span> operator()(T something) {
120
+ <a name="l00098"></a>00098 stringstream s;
121
+ <a name="l00099"></a>00099 s &lt;&lt; something;
122
+ <a name="l00100"></a>00100 <span class="keywordflow">return</span> s.str();
123
+ <a name="l00101"></a>00101 }
124
+ <a name="l00102"></a>00102 };
125
+ <a name="l00103"></a>00103 <span class="comment"></span>
126
+ <a name="l00104"></a>00104 <span class="comment">/**</span>
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>
169
170
  <a name="l00148"></a>00148 <span class="comment"> * @ingroup Support</span>
170
171
  <a name="l00149"></a>00149 <span class="comment"> */</span>
171
- <a name="l00150"></a>00150 <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);
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);
172
173
  <a name="l00151"></a>00151 <span class="comment"></span>
173
- <a name="l00152"></a>00152 <span class="comment">/**</span>
174
- <a name="l00153"></a>00153 <span class="comment"> * Check whether the specified file exists.</span>
175
- <a name="l00154"></a>00154 <span class="comment"> *</span>
176
- <a name="l00155"></a>00155 <span class="comment"> * @param filename The filename to check.</span>
177
- <a name="l00156"></a>00156 <span class="comment"> * @param mstat A CachedMultiFileStat object, if you want to use cached statting.</span>
178
- <a name="l00157"></a>00157 <span class="comment"> * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.</span>
179
- <a name="l00158"></a>00158 <span class="comment"> * @return Whether the file exists.</span>
180
- <a name="l00159"></a>00159 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
181
- <a name="l00160"></a>00160 <span class="comment"> * @ingroup Support</span>
182
- <a name="l00161"></a>00161 <span class="comment"> */</span>
183
- <a name="l00162"></a>00162 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#gb752bfac392b20da99e34847070aaaea" title="Check whether the specified file exists.">fileExists</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, CachedMultiFileStat *mstat = 0,
184
- <a name="l00163"></a>00163 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
185
- <a name="l00164"></a>00164 <span class="comment"></span>
186
- <a name="l00165"></a>00165 <span class="comment">/**</span>
187
- <a name="l00166"></a>00166 <span class="comment"> * Check whether 'filename' exists and what kind of file it is.</span>
188
- <a name="l00167"></a>00167 <span class="comment"> *</span>
189
- <a name="l00168"></a>00168 <span class="comment"> * @param filename The filename to check.</span>
190
- <a name="l00169"></a>00169 <span class="comment"> * @param mstat A CachedMultiFileStat object, if you want to use cached statting.</span>
191
- <a name="l00170"></a>00170 <span class="comment"> * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.</span>
192
- <a name="l00171"></a>00171 <span class="comment"> * @return The file type.</span>
193
- <a name="l00172"></a>00172 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
194
- <a name="l00173"></a>00173 <span class="comment"> * @ingroup Support</span>
195
- <a name="l00174"></a>00174 <span class="comment"> */</span>
196
- <a name="l00175"></a>00175 FileType <a class="code" href="group__Support.html#g818326cfca681596cf6944c1b88ed9f4" title="Check whether &amp;#39;filename&amp;#39; exists and what kind of file it is.">getFileType</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *filename, CachedMultiFileStat *mstat = 0,
197
- <a name="l00176"></a>00176 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
198
- <a name="l00177"></a>00177 <span class="comment"></span>
199
- <a name="l00178"></a>00178 <span class="comment">/**</span>
200
- <a name="l00179"></a>00179 <span class="comment"> * Find the location of the Passenger spawn server script.</span>
201
- <a name="l00180"></a>00180 <span class="comment"> * If passengerRoot is given, t T</span>
202
- <a name="l00181"></a>00181 <span class="comment"> *</span>
203
- <a name="l00182"></a>00182 <span class="comment"> * @param passengerRoot The Passenger root folder. If NULL is given, then</span>
204
- <a name="l00183"></a>00183 <span class="comment"> * the spawn server is found by scanning $PATH. For security reasons,</span>
205
- <a name="l00184"></a>00184 <span class="comment"> * only absolute paths are scanned.</span>
206
- <a name="l00185"></a>00185 <span class="comment"> * @return An absolute path to the spawn server script, or</span>
207
- <a name="l00186"></a>00186 <span class="comment"> * an empty string on error.</span>
208
- <a name="l00187"></a>00187 <span class="comment"> * @throws FileSystemException Unable to access parts of the filesystem.</span>
209
- <a name="l00188"></a>00188 <span class="comment"> * @ingroup Support</span>
210
- <a name="l00189"></a>00189 <span class="comment"> */</span>
211
- <a name="l00190"></a>00190 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#g37e1a293fa574748b2393b4801e7b23f" title="Find the location of the Passenger spawn server script.">findSpawnServer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *passengerRoot = NULL);
212
- <a name="l00191"></a>00191 <span class="comment"></span>
213
- <a name="l00192"></a>00192 <span class="comment">/**</span>
214
- <a name="l00193"></a>00193 <span class="comment"> * Find the location of the Passenger ApplicationPool server</span>
215
- <a name="l00194"></a>00194 <span class="comment"> * executable.</span>
216
- <a name="l00195"></a>00195 <span class="comment"> *</span>
217
- <a name="l00196"></a>00196 <span class="comment"> * @param passengerRoot The Passenger root folder.</span>
218
- <a name="l00197"></a>00197 <span class="comment"> * @return An absolute path to the executable.</span>
219
- <a name="l00198"></a>00198 <span class="comment"> * @throws FileSystemException Unable to access parts of the filesystem.</span>
220
- <a name="l00199"></a>00199 <span class="comment"> * @pre passengerRoot != NULL</span>
221
- <a name="l00200"></a>00200 <span class="comment"> * @ingroup Support</span>
222
- <a name="l00201"></a>00201 <span class="comment"> */</span>
223
- <a name="l00202"></a>00202 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#g67c03fa133dbb5a4e0de78f51899568e" title="Find the location of the Passenger ApplicationPool server executable.">findApplicationPoolServer</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *passengerRoot);
224
- <a name="l00203"></a>00203 <span class="comment"></span>
225
- <a name="l00204"></a>00204 <span class="comment">/**</span>
226
- <a name="l00205"></a>00205 <span class="comment"> * Returns a canonical version of the specified path. All symbolic links</span>
227
- <a name="l00206"></a>00206 <span class="comment"> * and relative path elements are resolved.</span>
228
- <a name="l00207"></a>00207 <span class="comment"> *</span>
229
- <a name="l00208"></a>00208 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
230
- <a name="l00209"></a>00209 <span class="comment"> * @ingroup Support</span>
231
- <a name="l00210"></a>00210 <span class="comment"> */</span>
232
- <a name="l00211"></a>00211 <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);
233
- <a name="l00212"></a>00212 <span class="comment"></span>
234
- <a name="l00213"></a>00213 <span class="comment">/**</span>
235
- <a name="l00214"></a>00214 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; refers to a symlink, then this function resolves the</span>
236
- <a name="l00215"></a>00215 <span class="comment"> * symlink for 1 level. That is, if the symlink points to another symlink,</span>
237
- <a name="l00216"></a>00216 <span class="comment"> * then the other symlink will not be resolved. The resolved path is returned.</span>
238
- <a name="l00217"></a>00217 <span class="comment"> *</span>
239
- <a name="l00218"></a>00218 <span class="comment"> * If the symlink doesn't point to an absolute path, then this function will</span>
240
- <a name="l00219"></a>00219 <span class="comment"> * prepend &lt;em&gt;path&lt;/em&gt;'s directory to the result.</span>
241
- <a name="l00220"></a>00220 <span class="comment"> *</span>
242
- <a name="l00221"></a>00221 <span class="comment"> * If &lt;em&gt;path&lt;/em&gt; doesn't refer to a symlink then this method will return</span>
243
- <a name="l00222"></a>00222 <span class="comment"> * &lt;em&gt;path&lt;/em&gt;.</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>
244
245
  <a name="l00223"></a>00223 <span class="comment"> *</span>
245
246
  <a name="l00224"></a>00224 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
246
247
  <a name="l00225"></a>00225 <span class="comment"> * @ingroup Support</span>
247
248
  <a name="l00226"></a>00226 <span class="comment"> */</span>
248
- <a name="l00227"></a>00227 <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);
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);
249
250
  <a name="l00228"></a>00228 <span class="comment"></span>
250
251
  <a name="l00229"></a>00229 <span class="comment">/**</span>
251
- <a name="l00230"></a>00230 <span class="comment"> * Given a path, extracts its directory name.</span>
252
- <a name="l00231"></a>00231 <span class="comment"> *</span>
253
- <a name="l00232"></a>00232 <span class="comment"> * @ingroup Support</span>
254
- <a name="l00233"></a>00233 <span class="comment"> */</span>
255
- <a name="l00234"></a>00234 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#g744cb849cb47dbcf5f22a46ead48ae94" title="Given a path, extracts its directory name.">extractDirName</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;path);
256
- <a name="l00235"></a>00235 <span class="comment"></span>
257
- <a name="l00236"></a>00236 <span class="comment">/**</span>
258
- <a name="l00237"></a>00237 <span class="comment"> * Escape the given raw string into an XML value.</span>
259
- <a name="l00238"></a>00238 <span class="comment"> *</span>
260
- <a name="l00239"></a>00239 <span class="comment"> * @throws std::bad_alloc Something went wrong.</span>
261
- <a name="l00240"></a>00240 <span class="comment"> * @ingroup Support</span>
262
- <a name="l00241"></a>00241 <span class="comment"> */</span>
263
- <a name="l00242"></a>00242 <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);
264
- <a name="l00243"></a>00243 <span class="comment"></span>
265
- <a name="l00244"></a>00244 <span class="comment">/**</span>
266
- <a name="l00245"></a>00245 <span class="comment"> * Given a username that's supposed to be the "lowest user" in the user switching mechanism,</span>
267
- <a name="l00246"></a>00246 <span class="comment"> * checks whether this username exists. If so, this users's UID and GID will be stored into</span>
268
- <a name="l00247"></a>00247 <span class="comment"> * the arguments of the same names. If not, &lt;em&gt;uid&lt;/em&gt; and &lt;em&gt;gid&lt;/em&gt; will be set to</span>
269
- <a name="l00248"></a>00248 <span class="comment"> * the UID and GID of the "nobody" user. If that user doesn't exist either, then &lt;em&gt;uid&lt;/em&gt;</span>
270
- <a name="l00249"></a>00249 <span class="comment"> * and &lt;em&gt;gid&lt;/em&gt; will be set to -1.</span>
271
- <a name="l00250"></a>00250 <span class="comment"> */</span>
272
- <a name="l00251"></a>00251 <span class="keywordtype">void</span> determineLowestUserAndGroup(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;user, uid_t &amp;uid, gid_t &amp;gid);
273
- <a name="l00252"></a>00252 <span class="comment"></span>
274
- <a name="l00253"></a>00253 <span class="comment">/**</span>
275
- <a name="l00254"></a>00254 <span class="comment"> * Return the path name for the directory in which the system stores general</span>
276
- <a name="l00255"></a>00255 <span class="comment"> * temporary files. This is usually "/tmp", but might be something else depending</span>
277
- <a name="l00256"></a>00256 <span class="comment"> * on some environment variables.</span>
278
- <a name="l00257"></a>00257 <span class="comment"> *</span>
279
- <a name="l00258"></a>00258 <span class="comment"> * @ensure result != NULL</span>
280
- <a name="l00259"></a>00259 <span class="comment"> * @ingroup Support</span>
281
- <a name="l00260"></a>00260 <span class="comment"> */</span>
282
- <a name="l00261"></a>00261 <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>();
283
- <a name="l00262"></a>00262 <span class="comment"></span>
284
- <a name="l00263"></a>00263 <span class="comment">/**</span>
285
- <a name="l00264"></a>00264 <span class="comment"> * Return the path name for the directory in which Phusion Passenger-specific</span>
286
- <a name="l00265"></a>00265 <span class="comment"> * temporary files are to be stored. This directory is unique for this instance</span>
287
- <a name="l00266"></a>00266 <span class="comment"> * of the web server in which Phusion Passenger is running.</span>
288
- <a name="l00267"></a>00267 <span class="comment"> *</span>
289
- <a name="l00268"></a>00268 <span class="comment"> * If the environment variable PASSENGER_INSTANCE_TEMP_DIR is set, then that value</span>
290
- <a name="l00269"></a>00269 <span class="comment"> * will be returned. If this environment variable is not set, then it will be set</span>
291
- <a name="l00270"></a>00270 <span class="comment"> * with the return value.</span>
292
- <a name="l00271"></a>00271 <span class="comment"> *</span>
293
- <a name="l00272"></a>00272 <span class="comment"> * To bypass the usage of the PASSENGER_INSTANCE_TEMP_DIR environment variable,</span>
294
- <a name="l00273"></a>00273 <span class="comment"> * set 'bypassCache' to true.</span>
295
- <a name="l00274"></a>00274 <span class="comment"> *</span>
296
- <a name="l00275"></a>00275 <span class="comment"> * @param bypassCache Whether PASSENGER_INSTANCE_TEMP_DIR should be bypassed.</span>
297
- <a name="l00276"></a>00276 <span class="comment"> * @param systemTempDir The directory under which the Phusion Passenger-specific</span>
298
- <a name="l00277"></a>00277 <span class="comment"> * temp directory should be located. If set to the empty string,</span>
299
- <a name="l00278"></a>00278 <span class="comment"> * then the return value of getSystemTempDir() will be used.</span>
300
- <a name="l00279"></a>00279 <span class="comment"> * @ensure !result.empty()</span>
301
- <a name="l00280"></a>00280 <span class="comment"> * @ingroup Support</span>
302
- <a name="l00281"></a>00281 <span class="comment"> */</span>
303
- <a name="l00282"></a>00282 <span class="keywordtype">string</span> <a class="code" href="group__Support.html#g69deb6b299b45039dc24b60ad9175541" title="Return the path name for the directory in which Phusion Passenger-specific temporary...">getPassengerTempDir</a>(<span class="keywordtype">bool</span> bypassCache = <span class="keyword">false</span>, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;systemTempDir = <span class="stringliteral">""</span>);
304
- <a name="l00283"></a>00283
305
- <a name="l00284"></a>00284 <span class="comment">/* Create a temp directory under &lt;em&gt;systemTempDir&lt;/em&gt;, for storing Phusion</span>
306
- <a name="l00285"></a>00285 <span class="comment"> * Passenger-specific temp files, such as temporarily buffered uploads,</span>
307
- <a name="l00286"></a>00286 <span class="comment"> * sockets for backend processes, etc. This call also sets the</span>
308
- <a name="l00287"></a>00287 <span class="comment"> * PASSENGER_INSTANCE_TEMP_DIR environment variable, which allows subprocesses</span>
309
- <a name="l00288"></a>00288 <span class="comment"> * to find this temp directory.</span>
310
- <a name="l00289"></a>00289 <span class="comment"> *</span>
311
- <a name="l00290"></a>00290 <span class="comment"> * The created temp directory will have several subdirectories:</span>
312
- <a name="l00291"></a>00291 <span class="comment"> * - webserver_private - for storing the web server's buffered uploads.</span>
313
- <a name="l00292"></a>00292 <span class="comment"> * - info - for storing files that allow external tools to query information</span>
314
- <a name="l00293"></a>00293 <span class="comment"> * about a running Phusion Passenger instance.</span>
315
- <a name="l00294"></a>00294 <span class="comment"> * - backends - for storing Unix sockets created by backend processes.</span>
316
- <a name="l00295"></a>00295 <span class="comment"> * - var - for storing all other kinds of temp files that the backend processes</span>
317
- <a name="l00296"></a>00296 <span class="comment"> * create.</span>
318
- <a name="l00297"></a>00297 <span class="comment"> *</span>
319
- <a name="l00298"></a>00298 <span class="comment"> * If a (sub)directory already exists, then it will not result in an error.</span>
320
- <a name="l00299"></a>00299 <span class="comment"> *</span>
321
- <a name="l00300"></a>00300 <span class="comment"> * The &lt;em&gt;userSwitching&lt;/em&gt; and &lt;em&gt;lowestUser&lt;/em&gt; arguments passed to</span>
322
- <a name="l00301"></a>00301 <span class="comment"> * this method are used for determining the optimal permissions for the</span>
323
- <a name="l00302"></a>00302 <span class="comment"> * (sub)directories. The permissions will be set as tightly as possible based</span>
324
- <a name="l00303"></a>00303 <span class="comment"> * on the values. The &lt;em&gt;workerUid&lt;/em&gt; and &lt;em&gt;workerGid&lt;/em&gt; arguments</span>
325
- <a name="l00304"></a>00304 <span class="comment"> * will be used for determining the owner of certain subdirectories.</span>
326
- <a name="l00305"></a>00305 <span class="comment"> *</span>
327
- <a name="l00306"></a>00306 <span class="comment"> * @note You should only call this method inside the web server's master</span>
328
- <a name="l00307"></a>00307 <span class="comment"> * process. In case of Apache, this is the Apache control process,</span>
329
- <a name="l00308"></a>00308 <span class="comment"> * the one that tends to run as root. This is because this function</span>
330
- <a name="l00309"></a>00309 <span class="comment"> * will set directory permissions and owners/groups, which may require</span>
331
- <a name="l00310"></a>00310 <span class="comment"> * root privileges.</span>
332
- <a name="l00311"></a>00311 <span class="comment"> *</span>
333
- <a name="l00312"></a>00312 <span class="comment"> * @param systemTempDir The directory under which the Phusion Passenger-specific</span>
334
- <a name="l00313"></a>00313 <span class="comment"> * temp directory should be created. You should normally</span>
335
- <a name="l00314"></a>00314 <span class="comment"> * specify the return value of getSystemTempDir().</span>
336
- <a name="l00315"></a>00315 <span class="comment"> * @param userSwitching Whether user switching is turned on.</span>
337
- <a name="l00316"></a>00316 <span class="comment"> * @param lowestUser The user that the spawn manager and the pool server will</span>
338
- <a name="l00317"></a>00317 <span class="comment"> * run as, if user switching is turned off.</span>
339
- <a name="l00318"></a>00318 <span class="comment"> * @param workerUid The UID that the web server's worker processes are running</span>
340
- <a name="l00319"></a>00319 <span class="comment"> * as. On Apache, this is the UID that's associated with the</span>
341
- <a name="l00320"></a>00320 <span class="comment"> * 'User' directive.</span>
342
- <a name="l00321"></a>00321 <span class="comment"> * @param workerGid The GID that the web server's worker processes are running</span>
343
- <a name="l00322"></a>00322 <span class="comment"> * as. On Apache, this is the GID that's associated with the</span>
344
- <a name="l00323"></a>00323 <span class="comment"> * 'Group' directive.</span>
345
- <a name="l00324"></a>00324 <span class="comment"> * @throws IOException Something went wrong.</span>
346
- <a name="l00325"></a>00325 <span class="comment"> * @throws SystemException Something went wrong.</span>
347
- <a name="l00326"></a>00326 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
348
- <a name="l00327"></a>00327 <span class="comment"> */</span>
349
- <a name="l00328"></a>00328 <span class="keywordtype">void</span> createPassengerTempDir(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;systemTempDir, <span class="keywordtype">bool</span> userSwitching,
350
- <a name="l00329"></a>00329 <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;lowestUser,
351
- <a name="l00330"></a>00330 uid_t workerUid, gid_t workerGid);
352
- <a name="l00331"></a>00331 <span class="comment"></span>
353
- <a name="l00332"></a>00332 <span class="comment">/**</span>
354
- <a name="l00333"></a>00333 <span class="comment"> * Create the directory at the given path, creating intermediate directories</span>
355
- <a name="l00334"></a>00334 <span class="comment"> * if necessary. The created directories' permissions are as specified by the</span>
356
- <a name="l00335"></a>00335 <span class="comment"> * 'mode' parameter. You can specify this directory's owner and group through</span>
357
- <a name="l00336"></a>00336 <span class="comment"> * the 'owner' and 'group' parameters. A value of -1 for 'owner' or 'group'</span>
358
- <a name="l00337"></a>00337 <span class="comment"> * means that the owner/group should not be changed.</span>
359
- <a name="l00338"></a>00338 <span class="comment"> *</span>
360
- <a name="l00339"></a>00339 <span class="comment"> * If 'path' already exists, then nothing will happen.</span>
361
- <a name="l00340"></a>00340 <span class="comment"> *</span>
362
- <a name="l00341"></a>00341 <span class="comment"> * @throws IOException Something went wrong.</span>
363
- <a name="l00342"></a>00342 <span class="comment"> * @throws SystemException Something went wrong.</span>
364
- <a name="l00343"></a>00343 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
365
- <a name="l00344"></a>00344 <span class="comment"> */</span>
366
- <a name="l00345"></a>00345 <span class="keywordtype">void</span> makeDirTree(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;path, <span class="keyword">const</span> <span class="keywordtype">char</span> *mode = <span class="stringliteral">"u=rwx,g=,o="</span>, uid_t owner = -1, gid_t group = -1);
367
- <a name="l00346"></a>00346 <span class="comment"></span>
368
- <a name="l00347"></a>00347 <span class="comment">/**</span>
369
- <a name="l00348"></a>00348 <span class="comment"> * Remove an entire directory tree recursively.</span>
370
- <a name="l00349"></a>00349 <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>
270
+ <a name="l00248"></a>00248 <span class="comment"> * @ingroup Support</span>
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);
273
+ <a name="l00251"></a>00251 <span class="comment"></span>
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>
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>
371
372
  <a name="l00350"></a>00350 <span class="comment"> * @throws FileSystemException Something went wrong.</span>
372
373
  <a name="l00351"></a>00351 <span class="comment"> */</span>
373
- <a name="l00352"></a>00352 <span class="keywordtype">void</span> removeDirTree(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;path);
374
- <a name="l00353"></a>00353 <span class="comment"></span>
375
- <a name="l00354"></a>00354 <span class="comment">/**</span>
376
- <a name="l00355"></a>00355 <span class="comment"> * Check whether the specified directory is a valid Ruby on Rails</span>
377
- <a name="l00356"></a>00356 <span class="comment"> * application root directory.</span>
378
- <a name="l00357"></a>00357 <span class="comment"> *</span>
379
- <a name="l00358"></a>00358 <span class="comment"> * @param mstat A CachedMultiFileStat object, if you want to use cached statting.</span>
380
- <a name="l00359"></a>00359 <span class="comment"> * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.</span>
381
- <a name="l00360"></a>00360 <span class="comment"> * @throws FileSystemException Unable to check because of a system error.</span>
382
- <a name="l00361"></a>00361 <span class="comment"> * @ingroup Support</span>
383
- <a name="l00362"></a>00362 <span class="comment"> */</span>
384
- <a name="l00363"></a>00363 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g02c80bd02d38cea295f24250ca8e2502" 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, CachedMultiFileStat *mstat = 0,
385
- <a name="l00364"></a>00364 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
386
- <a name="l00365"></a>00365 <span class="comment"></span>
387
- <a name="l00366"></a>00366 <span class="comment">/**</span>
388
- <a name="l00367"></a>00367 <span class="comment"> * Check whether the specified directory is a valid Rack application</span>
389
- <a name="l00368"></a>00368 <span class="comment"> * root directory.</span>
390
- <a name="l00369"></a>00369 <span class="comment"> *</span>
391
- <a name="l00370"></a>00370 <span class="comment"> * @param mstat A CachedMultiFileStat object, if you want to use cached statting.</span>
392
- <a name="l00371"></a>00371 <span class="comment"> * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.</span>
393
- <a name="l00372"></a>00372 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
394
- <a name="l00373"></a>00373 <span class="comment"> * @ingroup Support</span>
395
- <a name="l00374"></a>00374 <span class="comment"> */</span>
396
- <a name="l00375"></a>00375 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g7bb22ba786fa3c88dbbd9f84aaaed59a" 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, CachedMultiFileStat *mstat = 0,
397
- <a name="l00376"></a>00376 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
398
- <a name="l00377"></a>00377 <span class="comment"></span>
399
- <a name="l00378"></a>00378 <span class="comment">/**</span>
400
- <a name="l00379"></a>00379 <span class="comment"> * Check whether the specified directory is a valid WSGI application</span>
401
- <a name="l00380"></a>00380 <span class="comment"> * root directory.</span>
402
- <a name="l00381"></a>00381 <span class="comment"> *</span>
403
- <a name="l00382"></a>00382 <span class="comment"> * @param mstat A CachedMultiFileStat object, if you want to use cached statting.</span>
404
- <a name="l00383"></a>00383 <span class="comment"> * @param throttleRate A throttle rate for mstat. Only applicable if mstat is not NULL.</span>
405
- <a name="l00384"></a>00384 <span class="comment"> * @throws FileSystemException Unable to check because of a filesystem error.</span>
406
- <a name="l00385"></a>00385 <span class="comment"> * @ingroup Support</span>
407
- <a name="l00386"></a>00386 <span class="comment"> */</span>
408
- <a name="l00387"></a>00387 <span class="keywordtype">bool</span> <a class="code" href="group__Support.html#g8bfea2692733dfd80703707a120bce86" 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, CachedMultiFileStat *mstat = 0,
409
- <a name="l00388"></a>00388 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> throttleRate = 0);
410
- <a name="l00389"></a>00389 <span class="comment"></span>
411
- <a name="l00390"></a>00390 <span class="comment">/**</span>
412
- <a name="l00391"></a>00391 <span class="comment"> * Represents a buffered upload file.</span>
413
- <a name="l00392"></a>00392 <span class="comment"> *</span>
414
- <a name="l00393"></a>00393 <span class="comment"> * @ingroup Support</span>
415
- <a name="l00394"></a>00394 <span class="comment"> */</span>
416
- <a name="l00395"></a><a class="code" href="classPassenger_1_1BufferedUpload.html">00395</a> <span class="keyword">class </span><a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a> {
417
- <a name="l00396"></a>00396 <span class="keyword">public</span>:<span class="comment"></span>
418
- <a name="l00397"></a>00397 <span class="comment"> /** The file handle. */</span>
419
- <a name="l00398"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac">00398</a> FILE *<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>;
420
- <a name="l00399"></a>00399 <span class="comment"></span>
421
- <a name="l00400"></a>00400 <span class="comment"> /**</span>
422
- <a name="l00401"></a>00401 <span class="comment"> * Create an empty upload bufer file, and open it for reading and writing.</span>
423
- <a name="l00402"></a>00402 <span class="comment"> *</span>
424
- <a name="l00403"></a>00403 <span class="comment"> * @throws SystemException Something went wrong.</span>
425
- <a name="l00404"></a>00404 <span class="comment"> */</span>
426
- <a name="l00405"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#b85f5986340242fd2389b81ce4304e6b">00405</a> <a class="code" href="classPassenger_1_1BufferedUpload.html#b85f5986340242fd2389b81ce4304e6b" title="Create an empty upload bufer file, and open it for reading and writing.">BufferedUpload</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *identifier = <span class="stringliteral">"temp"</span>) {
427
- <a name="l00406"></a>00406 <span class="keywordtype">char</span> templ[PATH_MAX];
428
- <a name="l00407"></a>00407 <span class="keywordtype">int</span> fd;
429
- <a name="l00408"></a>00408
430
- <a name="l00409"></a>00409 snprintf(templ, <span class="keyword">sizeof</span>(templ), <span class="stringliteral">"%s/%s.XXXXXX"</span>, <a class="code" href="classPassenger_1_1BufferedUpload.html#fab496fee959db6320d909069ca6c2b9" title="Returns the directory in which upload buffer files are stored.">getDir</a>().c_str(), identifier);
431
- <a name="l00410"></a>00410 templ[<span class="keyword">sizeof</span>(templ) - 1] = <span class="charliteral">'\0'</span>;
432
- <a name="l00411"></a>00411 fd = mkstemp(templ);
433
- <a name="l00412"></a>00412 <span class="keywordflow">if</span> (fd == -1) {
434
- <a name="l00413"></a>00413 <span class="keywordtype">char</span> message[1024];
435
- <a name="l00414"></a>00414 <span class="keywordtype">int</span> e = errno;
436
- <a name="l00415"></a>00415
437
- <a name="l00416"></a>00416 snprintf(message, <span class="keyword">sizeof</span>(message), <span class="stringliteral">"Cannot create a temporary file '%s'"</span>, templ);
438
- <a name="l00417"></a>00417 message[<span class="keyword">sizeof</span>(message) - 1] = <span class="charliteral">'\0'</span>;
439
- <a name="l00418"></a>00418 <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);
440
- <a name="l00419"></a>00419 }
441
- <a name="l00420"></a>00420
442
- <a name="l00421"></a>00421 <span class="comment">/* We use a POSIX trick here: the file's permissions are set to "u=,g=,o="</span>
443
- <a name="l00422"></a>00422 <span class="comment"> * and the file is deleted immediately from the filesystem, while we</span>
444
- <a name="l00423"></a>00423 <span class="comment"> * keep its file handle open. The result is that no other processes</span>
445
- <a name="l00424"></a>00424 <span class="comment"> * will be able to access this file's contents anymore, except us.</span>
446
- <a name="l00425"></a>00425 <span class="comment"> * We now have an anonymous disk-backed buffer.</span>
447
- <a name="l00426"></a>00426 <span class="comment"> */</span>
448
- <a name="l00427"></a>00427 fchmod(fd, 0000);
449
- <a name="l00428"></a>00428 unlink(templ);
450
- <a name="l00429"></a>00429
451
- <a name="l00430"></a>00430 <a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a> = fdopen(fd, <span class="stringliteral">"w+"</span>);
452
- <a name="l00431"></a>00431 }
453
- <a name="l00432"></a>00432
454
- <a name="l00433"></a>00433 ~<a class="code" href="classPassenger_1_1BufferedUpload.html" title="Represents a buffered upload file.">BufferedUpload</a>() {
455
- <a name="l00434"></a>00434 fclose(<a class="code" href="classPassenger_1_1BufferedUpload.html#0a340f2d972ae791f56f893901109dac" title="The file handle.">handle</a>);
456
- <a name="l00435"></a>00435 }
457
- <a name="l00436"></a>00436 <span class="comment"></span>
458
- <a name="l00437"></a>00437 <span class="comment"> /**</span>
459
- <a name="l00438"></a>00438 <span class="comment"> * Returns the directory in which upload buffer files are stored.</span>
460
- <a name="l00439"></a>00439 <span class="comment"> * This is a subdirectory of the directory returned by getPassengerTempDir(). </span>
461
- <a name="l00440"></a>00440 <span class="comment"> */</span>
462
- <a name="l00441"></a><a class="code" href="classPassenger_1_1BufferedUpload.html#fab496fee959db6320d909069ca6c2b9">00441</a> <span class="keyword">static</span> <span class="keywordtype">string</span> <a class="code" href="classPassenger_1_1BufferedUpload.html#fab496fee959db6320d909069ca6c2b9" title="Returns the directory in which upload buffer files are stored.">getDir</a>() {
463
- <a name="l00442"></a>00442 <span class="keywordflow">return</span> <a class="code" href="group__Support.html#g69deb6b299b45039dc24b60ad9175541" title="Return the path name for the directory in which Phusion Passenger-specific temporary...">getPassengerTempDir</a>() + <span class="stringliteral">"/webserver_private"</span>;
464
- <a name="l00443"></a>00443 }
465
- <a name="l00444"></a>00444 };
466
- <a name="l00445"></a>00445
467
- <a name="l00446"></a>00446 } <span class="comment">// namespace Passenger</span>
468
- <a name="l00447"></a>00447
469
- <a name="l00448"></a>00448 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_UTILS_H_ */</span>
470
- <a name="l00449"></a>00449
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>
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>
534
+ <a name="l00512"></a>00512 <span class="comment"> * @throws boost::thread_interrupted A system call has been interrupted.</span>
535
+ <a name="l00513"></a>00513 <span class="comment"> * @ingroup Support</span>
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;
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
471
658
  </pre></div></div>
472
- <hr size="1"><address style="text-align: right;"><small>Generated on Wed Apr 8 22:35:10 2009 for Passenger by&nbsp;
659
+ <hr size="1"><address style="text-align: right;"><small>Generated on Sun Feb 21 12:22:46 2010 for Passenger by&nbsp;
473
660
  <a href="http://www.doxygen.org/index.html">
474
661
  <img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
475
662
  </body>