passenger 3.0.7 → 3.0.8

data/doc/Doxyfile

@@ -1,241 +0,0 @@
-# Doxyfile 1.5.3
-
-#---------------------------------------------------------------------------
-# Project related configuration options
-#---------------------------------------------------------------------------
-DOXYFILE_ENCODING      = UTF-8
-PROJECT_NAME           = Passenger
-PROJECT_NUMBER         = 
-OUTPUT_DIRECTORY       = .
-CREATE_SUBDIRS         = NO
-OUTPUT_LANGUAGE        = English
-BRIEF_MEMBER_DESC      = YES
-REPEAT_BRIEF           = YES
-ABBREVIATE_BRIEF       = "The $name class" \
-                         "The $name widget" \
-                         "The $name file" \
-                         is \
-                         provides \
-                         specifies \
-                         contains \
-                         represents \
-                         a \
-                         an \
-                         the
-ALWAYS_DETAILED_SEC    = NO
-INLINE_INHERITED_MEMB  = NO
-FULL_PATH_NAMES        = NO
-STRIP_FROM_PATH        = 
-STRIP_FROM_INC_PATH    = 
-SHORT_NAMES            = NO
-JAVADOC_AUTOBRIEF      = YES
-QT_AUTOBRIEF           = NO
-MULTILINE_CPP_IS_BRIEF = NO
-DETAILS_AT_TOP         = YES
-INHERIT_DOCS           = YES
-SEPARATE_MEMBER_PAGES  = NO
-TAB_SIZE               = 8
-ALIASES                = 
-OPTIMIZE_OUTPUT_FOR_C  = NO
-OPTIMIZE_OUTPUT_JAVA   = NO
-BUILTIN_STL_SUPPORT    = YES
-CPP_CLI_SUPPORT        = NO
-DISTRIBUTE_GROUP_DOC   = NO
-SUBGROUPING            = YES
-#---------------------------------------------------------------------------
-# Build related configuration options
-#---------------------------------------------------------------------------
-EXTRACT_ALL            = NO
-EXTRACT_PRIVATE        = NO
-EXTRACT_STATIC         = NO
-EXTRACT_LOCAL_CLASSES  = YES
-EXTRACT_LOCAL_METHODS  = NO
-EXTRACT_ANON_NSPACES   = NO
-HIDE_UNDOC_MEMBERS     = YES
-HIDE_UNDOC_CLASSES     = YES
-HIDE_FRIEND_COMPOUNDS  = NO
-HIDE_IN_BODY_DOCS      = NO
-INTERNAL_DOCS          = NO
-CASE_SENSE_NAMES       = YES
-HIDE_SCOPE_NAMES       = NO
-SHOW_INCLUDE_FILES     = YES
-INLINE_INFO            = YES
-SORT_MEMBER_DOCS       = YES
-SORT_BRIEF_DOCS        = NO
-SORT_BY_SCOPE_NAME     = NO
-GENERATE_TODOLIST      = YES
-GENERATE_TESTLIST      = YES
-GENERATE_BUGLIST       = YES
-GENERATE_DEPRECATEDLIST= YES
-ENABLED_SECTIONS       = 
-MAX_INITIALIZER_LINES  = 30
-SHOW_USED_FILES        = YES
-SHOW_DIRECTORIES       = NO
-FILE_VERSION_FILTER    = 
-#---------------------------------------------------------------------------
-# configuration options related to warning and progress messages
-#---------------------------------------------------------------------------
-QUIET                  = YES
-WARNINGS               = YES
-WARN_IF_UNDOCUMENTED   = NO
-WARN_IF_DOC_ERROR      = YES
-WARN_NO_PARAMDOC       = NO
-WARN_FORMAT            = "$file:$line: $text"
-WARN_LOGFILE           = 
-#---------------------------------------------------------------------------
-# configuration options related to the input files
-#---------------------------------------------------------------------------
-INPUT                  = . ../ext/apache2 ../ext/common ../ext/nginx
-INPUT_ENCODING         = UTF-8
-FILE_PATTERNS          = *.c *.cpp *.h
-RECURSIVE              = NO
-EXCLUDE                = 
-EXCLUDE_SYMLINKS       = NO
-EXCLUDE_PATTERNS       = 
-EXCLUDE_SYMBOLS        = 
-EXAMPLE_PATH           = 
-EXAMPLE_PATTERNS       = *
-EXAMPLE_RECURSIVE      = NO
-IMAGE_PATH             = 
-INPUT_FILTER           = 
-FILTER_PATTERNS        = 
-FILTER_SOURCE_FILES    = NO
-#---------------------------------------------------------------------------
-# configuration options related to source browsing
-#---------------------------------------------------------------------------
-SOURCE_BROWSER         = NO
-INLINE_SOURCES         = NO
-STRIP_CODE_COMMENTS    = NO
-REFERENCED_BY_RELATION = NO
-REFERENCES_RELATION    = NO
-REFERENCES_LINK_SOURCE = NO
-USE_HTAGS              = NO
-VERBATIM_HEADERS       = YES
-#---------------------------------------------------------------------------
-# configuration options related to the alphabetical class index
-#---------------------------------------------------------------------------
-ALPHABETICAL_INDEX     = NO
-COLS_IN_ALPHA_INDEX    = 5
-IGNORE_PREFIX          = 
-#---------------------------------------------------------------------------
-# configuration options related to the HTML output
-#---------------------------------------------------------------------------
-GENERATE_HTML          = YES
-HTML_OUTPUT            = cxxapi
-HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = 
-HTML_FOOTER            = 
-HTML_STYLESHEET        = 
-HTML_ALIGN_MEMBERS     = YES
-GENERATE_HTMLHELP      = NO
-HTML_DYNAMIC_SECTIONS  = NO
-CHM_FILE               = 
-HHC_LOCATION           = 
-GENERATE_CHI           = NO
-BINARY_TOC             = NO
-TOC_EXPAND             = NO
-DISABLE_INDEX          = NO
-ENUM_VALUES_PER_LINE   = 4
-GENERATE_TREEVIEW      = YES
-TREEVIEW_WIDTH         = 250
-#---------------------------------------------------------------------------
-# configuration options related to the LaTeX output
-#---------------------------------------------------------------------------
-GENERATE_LATEX         = NO
-LATEX_OUTPUT           = latex
-LATEX_CMD_NAME         = latex
-MAKEINDEX_CMD_NAME     = makeindex
-COMPACT_LATEX          = NO
-PAPER_TYPE             = a4wide
-EXTRA_PACKAGES         = 
-LATEX_HEADER           = 
-PDF_HYPERLINKS         = NO
-USE_PDFLATEX           = NO
-LATEX_BATCHMODE        = NO
-LATEX_HIDE_INDICES     = NO
-#---------------------------------------------------------------------------
-# configuration options related to the RTF output
-#---------------------------------------------------------------------------
-GENERATE_RTF           = NO
-RTF_OUTPUT             = rtf
-COMPACT_RTF            = NO
-RTF_HYPERLINKS         = NO
-RTF_STYLESHEET_FILE    = 
-RTF_EXTENSIONS_FILE    = 
-#---------------------------------------------------------------------------
-# configuration options related to the man page output
-#---------------------------------------------------------------------------
-GENERATE_MAN           = NO
-MAN_OUTPUT             = man
-MAN_EXTENSION          = .3
-MAN_LINKS              = NO
-#---------------------------------------------------------------------------
-# configuration options related to the XML output
-#---------------------------------------------------------------------------
-GENERATE_XML           = NO
-XML_OUTPUT             = xml
-XML_SCHEMA             = 
-XML_DTD                = 
-XML_PROGRAMLISTING     = YES
-#---------------------------------------------------------------------------
-# configuration options for the AutoGen Definitions output
-#---------------------------------------------------------------------------
-GENERATE_AUTOGEN_DEF   = NO
-#---------------------------------------------------------------------------
-# configuration options related to the Perl module output
-#---------------------------------------------------------------------------
-GENERATE_PERLMOD       = NO
-PERLMOD_LATEX          = NO
-PERLMOD_PRETTY         = YES
-PERLMOD_MAKEVAR_PREFIX = 
-#---------------------------------------------------------------------------
-# Configuration options related to the preprocessor   
-#---------------------------------------------------------------------------
-ENABLE_PREPROCESSING   = YES
-MACRO_EXPANSION        = NO
-EXPAND_ONLY_PREDEF     = NO
-SEARCH_INCLUDES        = YES
-INCLUDE_PATH           = 
-INCLUDE_FILE_PATTERNS  = 
-PREDEFINED             = 
-EXPAND_AS_DEFINED      = 
-SKIP_FUNCTION_MACROS   = YES
-#---------------------------------------------------------------------------
-# Configuration::additions related to external references   
-#---------------------------------------------------------------------------
-TAGFILES               = 
-GENERATE_TAGFILE       = 
-ALLEXTERNALS           = NO
-EXTERNAL_GROUPS        = YES
-PERL_PATH              = /usr/bin/perl
-#---------------------------------------------------------------------------
-# Configuration options related to the dot tool   
-#---------------------------------------------------------------------------
-CLASS_DIAGRAMS         = YES
-MSCGEN_PATH            = 
-HIDE_UNDOC_RELATIONS   = YES
-HAVE_DOT               = YES
-CLASS_GRAPH            = YES
-COLLABORATION_GRAPH    = NO
-GROUP_GRAPHS           = YES
-UML_LOOK               = NO
-TEMPLATE_RELATIONS     = NO
-INCLUDE_GRAPH          = YES
-INCLUDED_BY_GRAPH      = YES
-CALL_GRAPH             = NO
-CALLER_GRAPH           = NO
-GRAPHICAL_HIERARCHY    = YES
-DIRECTORY_GRAPH        = YES
-DOT_IMAGE_FORMAT       = png
-DOT_PATH               = 
-DOTFILE_DIRS           = 
-DOT_GRAPH_MAX_NODES    = 50
-MAX_DOT_GRAPH_DEPTH    = 1000
-DOT_TRANSPARENT        = NO
-DOT_MULTI_TARGETS      = NO
-GENERATE_LEGEND        = YES
-DOT_CLEANUP            = YES
-#---------------------------------------------------------------------------
-# Configuration::additions related to the search engine   
-#---------------------------------------------------------------------------
-SEARCHENGINE           = NO

data/doc/cxxapi/AbstractSpawnManager_8h_source.html

@@ -1,141 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>Passenger: AbstractSpawnManager.h Source File</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="doxygen.css" rel="stylesheet" type="text/css"/>
-</head>
-<body>
-<!-- Generated by Doxygen 1.6.2 -->
-<div class="navigation" id="top">
-  <div class="tabs">
-    <ul>
-      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
-      <li><a href="annotated.html"><span>Classes</span></a></li>
-      <li class="current"><a href="files.html"><span>Files</span></a></li>
-    </ul>
-  </div>
-  <div class="tabs">
-    <ul>
-      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
-    </ul>
-  </div>
-<h1>AbstractSpawnManager.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
-<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
-<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
-<a name="l00004"></a>00004 <span class="comment"> *</span>
-<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
-<a name="l00006"></a>00006 <span class="comment"> *</span>
-<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
-<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
-<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
-<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
-<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
-<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
-<a name="l00013"></a>00013 <span class="comment"> *</span>
-<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
-<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
-<a name="l00016"></a>00016 <span class="comment"> *</span>
-<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
-<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
-<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
-<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
-<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
-<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
-<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
-<a name="l00024"></a>00024 <span class="comment"> */</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_</span>
-<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_</span>
-<a name="l00027"></a>00027 <span class="preprocessor"></span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
-<a name="l00029"></a>00029 
-<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
-<a name="l00031"></a>00031 
-<a name="l00032"></a>00032 <span class="preprocessor">#include &lt;unistd.h&gt;</span>
-<a name="l00033"></a>00033 
-<a name="l00034"></a>00034 <span class="preprocessor">#include &quot;Process.h&quot;</span>
-<a name="l00035"></a>00035 <span class="preprocessor">#include &quot;PoolOptions.h&quot;</span>
-<a name="l00036"></a>00036 
-<a name="l00037"></a>00037 <span class="keyword">namespace </span>Passenger {
-<a name="l00038"></a>00038 
-<a name="l00039"></a>00039 <span class="keyword">using namespace </span>std;
-<a name="l00040"></a>00040 <span class="keyword">using namespace </span>boost;
-<a name="l00041"></a>00041 <span class="comment"></span>
-<a name="l00042"></a>00042 <span class="comment">/**</span>
-<a name="l00043"></a>00043 <span class="comment"> * @brief Spawning of application processes.</span>
-<a name="l00044"></a>00044 <span class="comment"> *</span>
-<a name="l00045"></a>00045 <span class="comment"> * An AbstractSpawnManager is responsible for spawning new application processes.</span>
-<a name="l00046"></a>00046 <span class="comment"> * Use the spawn() method to do so. AbstractSpawnManager is guaranteed to be thread-safe.</span>
-<a name="l00047"></a>00047 <span class="comment"> *</span>
-<a name="l00048"></a>00048 <span class="comment"> * AbstractSpawnManager is just an interface. There are two concrete implementations,</span>
-<a name="l00049"></a>00049 <span class="comment"> * namely SpawnManager and StubSpawnManager. The former is the one that&#39;s usually used,</span>
-<a name="l00050"></a>00050 <span class="comment"> * while the latter exists for unit testing purposes.</span>
-<a name="l00051"></a>00051 <span class="comment"> *</span>
-<a name="l00052"></a>00052 <span class="comment"> * @ingroup Support</span>
-<a name="l00053"></a><a class="code" href="classPassenger_1_1AbstractSpawnManager.html">00053</a> <span class="comment"> */</span>
-<a name="l00054"></a>00054 <span class="keyword">class </span><a class="code" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a> {
-<a name="l00055"></a>00055 <span class="keyword">public</span>:
-<a name="l00056"></a>00056         <span class="keyword">virtual</span> ~<a class="code" href="classPassenger_1_1AbstractSpawnManager.html" title="Spawning of application processes.">AbstractSpawnManager</a>() { }
-<a name="l00057"></a>00057         <span class="comment"></span>
-<a name="l00058"></a>00058 <span class="comment">        /**</span>
-<a name="l00059"></a>00059 <span class="comment">         * Spawn a new application process. Spawning details are to be passed</span>
-<a name="l00060"></a>00060 <span class="comment">         * via the &lt;tt&gt;options&lt;/tt&gt; argument.</span>
-<a name="l00061"></a>00061 <span class="comment">         *</span>
-<a name="l00062"></a>00062 <span class="comment">         * If the spawn server died during the spawning process, then the server</span>
-<a name="l00063"></a>00063 <span class="comment">         * will be automatically restarted, and another spawn attempt will be made.</span>
-<a name="l00064"></a>00064 <span class="comment">         * If restarting the server fails, or if the second spawn attempt fails,</span>
-<a name="l00065"></a>00065 <span class="comment">         * then an exception will be thrown.</span>
-<a name="l00066"></a>00066 <span class="comment">         *</span>
-<a name="l00067"></a>00067 <span class="comment">         * @param options An object containing the details for this spawn operation,</span>
-<a name="l00068"></a>00068 <span class="comment">         *                such as which application to spawn. See PoolOptions for details.</span>
-<a name="l00069"></a>00069 <span class="comment">         * @return A smart pointer to a Process object, which represents the application</span>
-<a name="l00070"></a>00070 <span class="comment">         *         process that has been spawned. Use this object to communicate with the</span>
-<a name="l00071"></a>00071 <span class="comment">         *         spawned process.</span>
-<a name="l00072"></a>00072 <span class="comment">         * @throws SpawnException Something went wrong.</span>
-<a name="l00073"></a>00073 <span class="comment">         * @throws boost::thread_interrupted</span>
-<a name="l00074"></a>00074 <span class="comment">         * @throws Anything thrown by options.environmentVariables-&gt;getItems().</span>
-<a name="l00075"></a>00075 <span class="comment">         */</span>
-<a name="l00076"></a>00076         <span class="keyword">virtual</span> <a class="code" href="namespacePassenger.html#aced1f248465136b313c6dec5fe6ca492" title="Convenient alias for Process smart pointer.">ProcessPtr</a> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#a6ca7efc68595bf962f5cce5e6407f176" title="Spawn a new application process.">spawn</a>(<span class="keyword">const</span> <a class="code" href="structPassenger_1_1PoolOptions.html" title="This struct encapsulates information for ApplicationPool::get() and for SpawnManager::spawn()...">PoolOptions</a> &amp;options) = 0;
-<a name="l00077"></a>00077         <span class="comment"></span>
-<a name="l00078"></a>00078 <span class="comment">        /**</span>
-<a name="l00079"></a>00079 <span class="comment">         * Shutdown the ApplicationSpawner server that&#39;s running at the given</span>
-<a name="l00080"></a>00080 <span class="comment">         * application root. This method should be called when it&#39;s time to reload</span>
-<a name="l00081"></a>00081 <span class="comment">         * an application.</span>
-<a name="l00082"></a>00082 <span class="comment">         *</span>
-<a name="l00083"></a>00083 <span class="comment">         * @throws SystemException Unable to communicate with the spawn server,</span>
-<a name="l00084"></a>00084 <span class="comment">         *         even after a restart.</span>
-<a name="l00085"></a>00085 <span class="comment">         * @throws SpawnException The spawn server died unexpectedly, and a</span>
-<a name="l00086"></a>00086 <span class="comment">         *         restart was attempted, but it failed.</span>
-<a name="l00087"></a>00087 <span class="comment">         */</span>
-<a name="l00088"></a>00088         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#a5043681dbfb9b77fa0679c510ede853c" title="Shutdown the ApplicationSpawner server that&amp;#39;s running at the given application...">reload</a>(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;appRoot) = 0;
-<a name="l00089"></a>00089         <span class="comment"></span>
-<a name="l00090"></a>00090 <span class="comment">        /**</span>
-<a name="l00091"></a>00091 <span class="comment">         * Forcefully kill the spawn server. This AbstractSpawnManager&#39;s state will</span>
-<a name="l00092"></a>00092 <span class="comment">         * not be modified, so that it won&#39;t know that the spawn server is killed</span>
-<a name="l00093"></a>00093 <span class="comment">         * until next time it sends a command to it.</span>
-<a name="l00094"></a>00094 <span class="comment">         *</span>
-<a name="l00095"></a>00095 <span class="comment">         * Used within unit tests.</span>
-<a name="l00096"></a>00096 <span class="comment">         */</span>
-<a name="l00097"></a>00097         <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#a225574ef363847058554fde9d5704950" title="Forcefully kill the spawn server.">killSpawnServer</a>() <span class="keyword">const</span> = 0;
-<a name="l00098"></a>00098         <span class="comment"></span>
-<a name="l00099"></a>00099 <span class="comment">        /**</span>
-<a name="l00100"></a>00100 <span class="comment">         * Returns the spawn server&#39;s PID. Used within unit tests.</span>
-<a name="l00101"></a>00101 <span class="comment">         */</span>
-<a name="l00102"></a>00102         <span class="keyword">virtual</span> pid_t <a class="code" href="classPassenger_1_1AbstractSpawnManager.html#aa630e8c364f391b54c0bfb723326836a" title="Returns the spawn server&amp;#39;s PID.">getServerPid</a>() <span class="keyword">const</span> = 0;
-<a name="l00103"></a>00103 };
-<a name="l00104"></a>00104 <span class="comment"></span>
-<a name="l00105"></a><a class="code" href="namespacePassenger.html#afd60d942a89fbb7f306e330d75704570">00105</a> <span class="comment">/** Convenient alias for AbstractSpawnManager smart pointer. */</span>
-<a name="l00106"></a>00106 <span class="keyword">typedef</span> shared_ptr&lt;AbstractSpawnManager&gt; <a class="code" href="namespacePassenger.html#afd60d942a89fbb7f306e330d75704570" title="Convenient alias for AbstractSpawnManager smart pointer.">AbstractSpawnManagerPtr</a>;
-<a name="l00107"></a>00107 
-<a name="l00108"></a>00108 } <span class="comment">// namespace Passenger</span>
-<a name="l00109"></a>00109 
-<a name="l00110"></a>00110 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_ABSTRACT_SPAWN_MANAGER_H_ */</span>
-</pre></div></div>
-<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
-<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
-</body>
-</html>

data/doc/cxxapi/Account_8h_source.html

@@ -1,206 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<title>Passenger: Account.h Source File</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<link href="doxygen.css" rel="stylesheet" type="text/css"/>
-</head>
-<body>
-<!-- Generated by Doxygen 1.6.2 -->
-<div class="navigation" id="top">
-  <div class="tabs">
-    <ul>
-      <li><a href="main.html"><span>Main&nbsp;Page</span></a></li>
-      <li><a href="modules.html"><span>Modules</span></a></li>
-      <li><a href="namespaces.html"><span>Namespaces</span></a></li>
-      <li><a href="annotated.html"><span>Classes</span></a></li>
-      <li class="current"><a href="files.html"><span>Files</span></a></li>
-    </ul>
-  </div>
-  <div class="tabs">
-    <ul>
-      <li><a href="files.html"><span>File&nbsp;List</span></a></li>
-    </ul>
-  </div>
-<h1>Account.h</h1><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span>
-<a name="l00002"></a>00002 <span class="comment"> *  Phusion Passenger - http://www.modrails.com/</span>
-<a name="l00003"></a>00003 <span class="comment"> *  Copyright (c) 2010 Phusion</span>
-<a name="l00004"></a>00004 <span class="comment"> *</span>
-<a name="l00005"></a>00005 <span class="comment"> *  &quot;Phusion Passenger&quot; is a trademark of Hongli Lai &amp; Ninh Bui.</span>
-<a name="l00006"></a>00006 <span class="comment"> *</span>
-<a name="l00007"></a>00007 <span class="comment"> *  Permission is hereby granted, free of charge, to any person obtaining a copy</span>
-<a name="l00008"></a>00008 <span class="comment"> *  of this software and associated documentation files (the &quot;Software&quot;), to deal</span>
-<a name="l00009"></a>00009 <span class="comment"> *  in the Software without restriction, including without limitation the rights</span>
-<a name="l00010"></a>00010 <span class="comment"> *  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell</span>
-<a name="l00011"></a>00011 <span class="comment"> *  copies of the Software, and to permit persons to whom the Software is</span>
-<a name="l00012"></a>00012 <span class="comment"> *  furnished to do so, subject to the following conditions:</span>
-<a name="l00013"></a>00013 <span class="comment"> *</span>
-<a name="l00014"></a>00014 <span class="comment"> *  The above copyright notice and this permission notice shall be included in</span>
-<a name="l00015"></a>00015 <span class="comment"> *  all copies or substantial portions of the Software.</span>
-<a name="l00016"></a>00016 <span class="comment"> *</span>
-<a name="l00017"></a>00017 <span class="comment"> *  THE SOFTWARE IS PROVIDED &quot;AS IS&quot;, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR</span>
-<a name="l00018"></a>00018 <span class="comment"> *  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,</span>
-<a name="l00019"></a>00019 <span class="comment"> *  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE</span>
-<a name="l00020"></a>00020 <span class="comment"> *  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER</span>
-<a name="l00021"></a>00021 <span class="comment"> *  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,</span>
-<a name="l00022"></a>00022 <span class="comment"> *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN</span>
-<a name="l00023"></a>00023 <span class="comment"> *  THE SOFTWARE.</span>
-<a name="l00024"></a>00024 <span class="comment"> */</span>
-<a name="l00025"></a>00025 <span class="preprocessor">#ifndef _PASSENGER_ACCOUNT_H_</span>
-<a name="l00026"></a>00026 <span class="preprocessor"></span><span class="preprocessor">#define _PASSENGER_ACCOUNT_H_</span>
-<a name="l00027"></a>00027 <span class="preprocessor"></span>
-<a name="l00028"></a>00028 <span class="preprocessor">#include &lt;string&gt;</span>
-<a name="l00029"></a>00029 <span class="preprocessor">#include &lt;vector&gt;</span>
-<a name="l00030"></a>00030 <span class="preprocessor">#include &lt;boost/shared_ptr.hpp&gt;</span>
-<a name="l00031"></a>00031 <span class="preprocessor">#include &quot;StaticString.h&quot;</span>
-<a name="l00032"></a>00032 <span class="preprocessor">#include &quot;Exceptions.h&quot;</span>
-<a name="l00033"></a>00033 <span class="preprocessor">#include &quot;Utils/StrIntUtils.h&quot;</span>
-<a name="l00034"></a>00034 
-<a name="l00035"></a>00035 <span class="keyword">namespace </span>Passenger {
-<a name="l00036"></a>00036 
-<a name="l00037"></a>00037 <span class="keyword">using namespace </span>boost;
-<a name="l00038"></a>00038 <span class="keyword">using namespace </span>std;
-<a name="l00039"></a>00039 
-<a name="l00040"></a>00040 <span class="comment">/*</span>
-<a name="l00041"></a>00041 <span class="comment"> * SECURITY NOTES</span>
-<a name="l00042"></a>00042 <span class="comment"> *</span>
-<a name="l00043"></a>00043 <span class="comment"> * We want to avoid storing plain text passwords in memory, because attackers may be able</span>
-<a name="l00044"></a>00044 <span class="comment"> * to read this process&#39;s memory, e.g. through core dumps or debuggers. So in this source</span>
-<a name="l00045"></a>00045 <span class="comment"> * file, as well as in several others, we follow these guidelines:</span>
-<a name="l00046"></a>00046 <span class="comment"> *</span>
-<a name="l00047"></a>00047 <span class="comment"> * - Variables and arguments named userSuppliedPassword represent passwords</span>
-<a name="l00048"></a>00048 <span class="comment"> *   supplied by a human, i.e. user input. These variables and arguments have the type</span>
-<a name="l00049"></a>00049 <span class="comment"> *   &#39;StaticString&#39; instead of &#39;string&#39;, because we want to avoid accidentally copying</span>
-<a name="l00050"></a>00050 <span class="comment"> *   the password values.</span>
-<a name="l00051"></a>00051 <span class="comment"> * - Variables and arguments named passwordOrHash might also represent passwords. However,</span>
-<a name="l00052"></a>00052 <span class="comment"> *   if it is a password, then it is guaranteed NOT to be supplied by a human, e.g. it&#39;s</span>
-<a name="l00053"></a>00053 <span class="comment"> *   randomly generated. Therefore it&#39;s okay for passwordOrHash to be of type &#39;string&#39;.</span>
-<a name="l00054"></a>00054 <span class="comment"> * - If there is a need to copy the password for whatever reason, then it must be cleared</span>
-<a name="l00055"></a>00055 <span class="comment"> *   with ZeroMemoryGuard as soon as possible. Do not use memset(), the code</span>
-<a name="l00056"></a>00056 <span class="comment"> *   for ZeroMemoryGuard explains why.</span>
-<a name="l00057"></a>00057 <span class="comment"> */</span>
-<a name="l00058"></a>00058 
-<a name="l00059"></a>00059 <span class="keyword">class </span>Account {
-<a name="l00060"></a>00060 <span class="keyword">public</span>:
-<a name="l00061"></a>00061         <span class="keyword">enum</span> Rights {
-<a name="l00062"></a>00062                 ALL                       = ~0,
-<a name="l00063"></a>00063                 NONE                      = 0,
-<a name="l00064"></a>00064                 
-<a name="l00065"></a>00065                 <span class="comment">// ApplicationPool::Server rights.</span>
-<a name="l00066"></a>00066                 GET                       = 1 &lt;&lt; 0,
-<a name="l00067"></a>00067                 CLEAR                     = 1 &lt;&lt; 1,
-<a name="l00068"></a>00068                 DETACH                    = 1 &lt;&lt; 2,
-<a name="l00069"></a>00069                 GET_PARAMETERS            = 1 &lt;&lt; 3,
-<a name="l00070"></a>00070                 SET_PARAMETERS            = 1 &lt;&lt; 4,
-<a name="l00071"></a>00071                 INSPECT_BASIC_INFO        = 1 &lt;&lt; 5,
-<a name="l00072"></a>00072                 INSPECT_SENSITIVE_INFO    = 1 &lt;&lt; 6,
-<a name="l00073"></a>00073                 <span class="comment">//INSPECT_BACKEND_ADDRESSES = 1 &lt;&lt; 6,</span>
-<a name="l00074"></a>00074                 <span class="comment">//INSPECT_DETACH_KEYS       = 1 &lt;&lt; 7,</span>
-<a name="l00075"></a>00075                 
-<a name="l00076"></a>00076                 <span class="comment">// BacktracesServer rights.</span>
-<a name="l00077"></a>00077                 INSPECT_BACKTRACES        = 1 &lt;&lt; 8,
-<a name="l00078"></a>00078                 
-<a name="l00079"></a>00079                 <span class="comment">// Other rights.</span>
-<a name="l00080"></a>00080                 EXIT                      = 1 &lt;&lt; 31
-<a name="l00081"></a>00081         };
-<a name="l00082"></a>00082 
-<a name="l00083"></a>00083 <span class="keyword">private</span>:
-<a name="l00084"></a>00084         <span class="keywordtype">string</span> username;
-<a name="l00085"></a>00085         <span class="keywordtype">string</span> passwordOrHash;
-<a name="l00086"></a>00086         <span class="keywordtype">bool</span> hashGiven;
-<a name="l00087"></a>00087         Rights rights;
-<a name="l00088"></a>00088 
-<a name="l00089"></a>00089 <span class="keyword">public</span>:
-<a name="l00090"></a>00090         <span class="comment">// Urgh, I can&#39;t use &#39;Rights&#39; here as type because apparently bitwise</span>
-<a name="l00091"></a>00091         <span class="comment">// ORing two enums results in an int type.</span>
-<a name="l00092"></a>00092         
-<a name="l00093"></a>00093         <span class="keyword">static</span> Rights parseRightsString(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;str, <span class="keywordtype">int</span> defaultValue = NONE) {
-<a name="l00094"></a>00094                 vector&lt;string&gt; rights_vec;
-<a name="l00095"></a>00095                 vector&lt;string&gt;::const_iterator it;
-<a name="l00096"></a>00096                 <span class="keywordtype">int</span> result = defaultValue;
-<a name="l00097"></a>00097                 
-<a name="l00098"></a>00098                 split(str, <span class="charliteral">&#39;,&#39;</span>, rights_vec);
-<a name="l00099"></a>00099                 <span class="keywordflow">for</span> (it = rights_vec.begin(); it != rights_vec.end(); it++) {
-<a name="l00100"></a>00100                         <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;all&quot;</span>) {
-<a name="l00101"></a>00101                                 result = ALL;
-<a name="l00102"></a>00102                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;none&quot;</span>) {
-<a name="l00103"></a>00103                                 result = NONE;
-<a name="l00104"></a>00104                         
-<a name="l00105"></a>00105                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;get&quot;</span>) {
-<a name="l00106"></a>00106                                 result |= GET;
-<a name="l00107"></a>00107                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;clear&quot;</span>) {
-<a name="l00108"></a>00108                                 result |= CLEAR;
-<a name="l00109"></a>00109                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;detach&quot;</span>) {
-<a name="l00110"></a>00110                                 result |= DETACH;
-<a name="l00111"></a>00111                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;get_parameters&quot;</span>) {
-<a name="l00112"></a>00112                                 result |= GET_PARAMETERS;
-<a name="l00113"></a>00113                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;set_parameters&quot;</span>) {
-<a name="l00114"></a>00114                                 result |= SET_PARAMETERS;
-<a name="l00115"></a>00115                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;inspect_basic_info&quot;</span>) {
-<a name="l00116"></a>00116                                 result |= INSPECT_BASIC_INFO;
-<a name="l00117"></a>00117                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;inspect_sensitive_info&quot;</span>) {
-<a name="l00118"></a>00118                                 result |= INSPECT_SENSITIVE_INFO;
-<a name="l00119"></a>00119                         
-<a name="l00120"></a>00120                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;inspect_backtraces&quot;</span>) {
-<a name="l00121"></a>00121                                 result |= INSPECT_BACKTRACES;
-<a name="l00122"></a>00122                                 
-<a name="l00123"></a>00123                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it == <span class="stringliteral">&quot;exit&quot;</span>) {
-<a name="l00124"></a>00124                                 result |= EXIT;
-<a name="l00125"></a>00125                                 
-<a name="l00126"></a>00126                         } <span class="keywordflow">else</span> <span class="keywordflow">if</span> (*it != <span class="stringliteral">&quot;&quot;</span>) {
-<a name="l00127"></a>00127                                 <span class="keywordflow">throw</span> ArgumentException(<span class="stringliteral">&quot;Unknown right &#39;&quot;</span> + *it + <span class="stringliteral">&quot;&#39;.&quot;</span>);
-<a name="l00128"></a>00128                         }
-<a name="l00129"></a>00129                 }
-<a name="l00130"></a>00130                 
-<a name="l00131"></a>00131                 <span class="keywordflow">return</span> (Rights) result;
-<a name="l00132"></a>00132         }
-<a name="l00133"></a>00133         
-<a name="l00134"></a>00134         Account(<span class="keyword">const</span> <span class="keywordtype">string</span> &amp;username, <span class="keyword">const</span> <span class="keywordtype">string</span> &amp;passwordOrHash, <span class="keywordtype">bool</span> hashGiven, <span class="keywordtype">int</span> rights = ALL) {
-<a name="l00135"></a>00135                 this-&gt;username       = username;
-<a name="l00136"></a>00136                 this-&gt;passwordOrHash = passwordOrHash;
-<a name="l00137"></a>00137                 this-&gt;hashGiven      = hashGiven;
-<a name="l00138"></a>00138                 this-&gt;rights         = (Rights) rights;
-<a name="l00139"></a>00139         }
-<a name="l00140"></a>00140         
-<a name="l00141"></a>00141         <span class="keywordtype">bool</span> checkPasswordOrHash(<span class="keyword">const</span> StaticString &amp;userSuppliedPassword)<span class="keyword"> const </span>{
-<a name="l00142"></a>00142                 <span class="keywordflow">if</span> (hashGiven) {
-<a name="l00143"></a>00143                         <span class="keywordflow">return</span> passwordOrHash == createHash(userSuppliedPassword);
-<a name="l00144"></a>00144                 } <span class="keywordflow">else</span> {
-<a name="l00145"></a>00145                         <span class="keywordflow">return</span> userSuppliedPassword == passwordOrHash;
-<a name="l00146"></a>00146                 }
-<a name="l00147"></a>00147         }
-<a name="l00148"></a>00148         
-<a name="l00149"></a>00149         <span class="keywordtype">bool</span> hasRights(<span class="keywordtype">int</span> rights)<span class="keyword"> const </span>{
-<a name="l00150"></a>00150                 <span class="keywordflow">return</span> this-&gt;rights &amp; rights;
-<a name="l00151"></a>00151         }
-<a name="l00152"></a>00152         
-<a name="l00153"></a>00153         <span class="keywordtype">void</span> setRights(<span class="keywordtype">int</span> rights) {
-<a name="l00154"></a>00154                 this-&gt;rights = (Rights) rights;
-<a name="l00155"></a>00155         }
-<a name="l00156"></a>00156         
-<a name="l00157"></a>00157         <span class="keywordtype">string</span> getUsername()<span class="keyword"> const </span>{
-<a name="l00158"></a>00158                 <span class="keywordflow">return</span> username;
-<a name="l00159"></a>00159         }
-<a name="l00160"></a>00160         
-<a name="l00161"></a>00161         <span class="keywordtype">string</span> getRawPassword()<span class="keyword"> const </span>{
-<a name="l00162"></a>00162                 <span class="keywordflow">return</span> passwordOrHash;
-<a name="l00163"></a>00163         }
-<a name="l00164"></a>00164         
-<a name="l00165"></a>00165         <span class="keyword">static</span> <span class="keywordtype">string</span> createHash(<span class="keyword">const</span> StaticString &amp;userSuppliedPassword) {
-<a name="l00166"></a>00166                 <span class="comment">// TODO: use bcrypt or something</span>
-<a name="l00167"></a>00167                 <span class="keywordflow">return</span> userSuppliedPassword;
-<a name="l00168"></a>00168         }
-<a name="l00169"></a>00169 };
-<a name="l00170"></a>00170 
-<a name="l00171"></a>00171 <span class="keyword">typedef</span> shared_ptr&lt;Account&gt; AccountPtr;
-<a name="l00172"></a>00172 
-<a name="l00173"></a>00173 } <span class="comment">// namespace Passenger</span>
-<a name="l00174"></a>00174 
-<a name="l00175"></a>00175 <span class="preprocessor">#endif </span><span class="comment">/* _PASSENGER_ACCOUNT_H_ */</span>
-</pre></div></div>
-<hr size="1"/><address style="text-align: right;"><small>Generated by&nbsp;
-<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2 </small></address>
-</body>
-</html>