diff options
Diffstat (limited to 'vendor/Twisted-10.0.0/doc/web/howto/using-twistedweb.html')
| -rw-r--r-- | vendor/Twisted-10.0.0/doc/web/howto/using-twistedweb.html | 972 |
1 files changed, 972 insertions, 0 deletions
diff --git a/vendor/Twisted-10.0.0/doc/web/howto/using-twistedweb.html b/vendor/Twisted-10.0.0/doc/web/howto/using-twistedweb.html new file mode 100644 index 0000000000..c0577be0d1 --- /dev/null +++ b/vendor/Twisted-10.0.0/doc/web/howto/using-twistedweb.html @@ -0,0 +1,972 @@ +<?xml version="1.0" encoding="utf-8"?><!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Transitional//EN' 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd'><html lang="en" xmlns="http://www.w3.org/1999/xhtml"> + <head> +<title>Twisted Documentation: Configuring and Using the Twisted.Web Server</title> +<link href="stylesheet.css" rel="stylesheet" type="text/css"/> + </head> + + <body bgcolor="white"> + <h1 class="title">Configuring and Using the Twisted.Web Server</h1> + <div class="toc"><ol><li><a href="#auto0">Twisted Web Development</a></li><ul><li><a href="#auto1">Main Concepts</a></li><li><a href="#auto2">Site Objects</a></li><li><a href="#auto3">Resource objects</a></li><li><a href="#auto4">Resource Trees</a></li><li><a href="#auto5">.rpy scripts</a></li><li><a href="#auto6">Resource rendering</a></li><li><a href="#auto7">Session</a></li></ul><li><a href="#auto8">Advanced Configuration</a></li><ul><li><a href="#auto9">Adding Children</a></li><li><a href="#auto10">Modifying File Resources</a></li><li><a href="#auto11">Virtual Hosts</a></li><li><a href="#auto12">Advanced Techniques</a></li></ul><li><a href="#auto13">Running a Twisted Web Server</a></li><ul><li><a href="#auto14">Serving Flat HTML</a></li><li><a href="#auto15">Resource Scripts</a></li><li><a href="#auto16">Web UIs</a></li><li><a href="#auto17">Spreadable Web Servers</a></li><li><a href="#auto18">Serving PHP/Perl/CGI</a></li><li><a href="#auto19">Serving WSGI Applications</a></li><li><a href="#auto20">Using VHostMonster</a></li></ul><li><a href="#auto21">Rewriting URLs</a></li><li><a href="#auto22">Knowing When We're Not Wanted</a></li><li><a href="#auto23">As-Is Serving</a></li></ol></div> + <div class="content"> +<span/> + +<h2>Twisted Web Development<a name="auto0"/></h2><a name="development" shape="rect"/> + +<p>Twisted Web serves Python objects that implement the interface +IResource.</p> + +<br clear="none"/><img alt="Twisted Web process" src="../img/web-process.png"/> + +<h3>Main Concepts<a name="auto1"/></h3> + +<ul> + +<li><a href="#sites" shape="rect">Site Objects</a> are responsible for creating +<code>HTTPChannel</code> instances to parse the HTTP request, and begin the object lookup process. They contain the root Resource, the resource which represents the URL <code>/</code> on the site.</li> + +<li><a href="#resources" shape="rect">Resource</a> objects represent a single URL segment. The <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.IResource.html" title="twisted.web.resource.IResource">IResource</a></code> interface describes the methods a Resource object must implement in order to participate in the object publishing process.</li> + +<li><a href="#trees" shape="rect">Resource trees</a> are arrangements of Resource objects into a Resource tree. Starting at the root Resource object, the tree of Resource objects defines the URLs which will be valid.</li> + +<li><a href="#rpys" shape="rect">.rpy scripts</a> are python scripts which the twisted.web static file server will execute, much like a CGI. However, unlike CGI they must create a Resource object which will be rendered when the URL is visited.</li> + +<li><a href="#rendering" shape="rect">Resource rendering</a> occurs when Twisted Web locates a leaf Resource object. A Resource can either return an html string or write to the request object.</li> + +<li><a href="#sessions" shape="rect">Session</a> objects allow you to store information across multiple requests. Each individual browser using the system has a unique Session instance.</li> + +</ul> + +<p>The Twisted.Web server is started through the Twisted Daemonizer, as in:</p> + +<pre class="shell" xml:space="preserve"> +% twistd web +</pre> + +<h3>Site Objects<a name="auto2"/></h3> +<a name="sites" shape="rect"/> + +<p>Site objects serve as the glue between a port to listen for HTTP requests on, and a root Resource object.</p> + +<p>When using <code>twistd -n web --path /foo/bar/baz</code>, a Site object is created with a root Resource that serves files out of the given path.</p> + +<p>You can also create a <code>Site</code> instance by hand, passing it a +<code>Resource</code> object which will serve as the root of the site:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">server</span>, <span class="py-src-variable">resource</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">internet</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">reactor</span> + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">Simple</span>(<span class="py-src-parameter">resource</span>.<span class="py-src-parameter">Resource</span>): + <span class="py-src-variable">isLeaf</span> = <span class="py-src-variable">True</span> + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-keyword">return</span> <span class="py-src-string">"<html>Hello, world!</html>"</span> + +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">Simple</span>()) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">listenTCP</span>(<span class="py-src-number">8080</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">run</span>() +</pre> + +<h3>Resource objects<a name="auto3"/></h3> +<a name="resources" shape="rect"/> + +<p><code>Resource</code> objects represent a single URL segment of a site. During URL parsing, <code>getChild</code> is called on the current <code>Resource</code> to produce the next <code>Resource</code> object.</p> + +<p>When the leaf Resource is reached, either because there were no more URL segments or a Resource had isLeaf set to True, the leaf Resource is rendered by calling <code>render(request)</code>. See <q>Resource Rendering</q> below for more about this.</p> + +<p>During the Resource location process, the URL segments which have already been processed and those which have not yet been processed are available in <code>request.prepath</code> and <code>request.postpath</code>.</p> + +<p>A Resource can know where it is in the URL tree by looking at <code>request.prepath</code>, a list of URL segment strings.</p> + +<p>A Resource can know which path segments will be processed after it by looking at <code>request.postpath</code>.</p> + +<p>If the URL ends in a slash, for example <code>http://example.com/foo/bar/</code>, the final URL segment will be an empty string. Resources can thus know if they were requested with or without a final slash.</p> + +<p>Here is a simple Resource object:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span>.<span class="py-src-variable">resource</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">Resource</span> + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">Hello</span>(<span class="py-src-parameter">Resource</span>): + <span class="py-src-variable">isLeaf</span> = <span class="py-src-variable">True</span> + <span class="py-src-keyword">def</span> <span class="py-src-identifier">getChild</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">name</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-keyword">if</span> <span class="py-src-variable">name</span> == <span class="py-src-string">''</span>: + <span class="py-src-keyword">return</span> <span class="py-src-variable">self</span> + <span class="py-src-keyword">return</span> <span class="py-src-variable">Resource</span>.<span class="py-src-variable">getChild</span>(<span class="py-src-variable">self</span>, <span class="py-src-variable">name</span>, <span class="py-src-variable">request</span>) + + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-keyword">return</span> <span class="py-src-string">"Hello, world! I am located at %r."</span> % (<span class="py-src-variable">request</span>.<span class="py-src-variable">prepath</span>,) + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">Hello</span>() +</pre> + +<h3>Resource Trees<a name="auto4"/></h3> +<a name="trees" shape="rect"/> + +<p>Resources can be arranged in trees using <code>putChild</code>. <code>putChild</code> puts a Resource instance into another Resource instance, making it available at the given path segment name:</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +</p><span class="py-src-variable">root</span> = <span class="py-src-variable">Hello</span>() +<span class="py-src-variable">root</span>.<span class="py-src-variable">putChild</span>(<span class="py-src-string">'fred'</span>, <span class="py-src-variable">Hello</span>()) +<span class="py-src-variable">root</span>.<span class="py-src-variable">putChild</span>(<span class="py-src-string">'bob'</span>, <span class="py-src-variable">Hello</span>()) +</pre> + +<p>If this root resource is served as the root of a Site instance, the following URLs will all be valid:</p> + +<ul> +<li><code>http://example.com/</code></li> +<li><code>http://example.com/fred</code></li> +<li><code>http://example.com/bob</code></li> +<li><code>http://example.com/fred/</code></li> +<li><code>http://example.com/bob/</code></li> + +</ul> + +<h3>.rpy scripts<a name="auto5"/></h3> +<a name="rpys" shape="rect"/> + +<p>Files with the extension <code>.rpy</code> are python scripts which, when placed in a directory served by Twisted Web, will be executed when visited through the web.</p> + +<p>An <code>.rpy</code> script must define a variable, <code>resource</code>, which is the Resource object that will render the request.</p> + +<p><code>.rpy</code> files are very convenient for rapid development and prototyping. Since they are executed on every web request, defining a Resource subclass in an <code>.rpy</code> will make viewing the results of changes to your class visible simply by refreshing the page:</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +7 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span>.<span class="py-src-variable">resource</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">Resource</span> + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">MyResource</span>(<span class="py-src-parameter">Resource</span>): + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-keyword">return</span> <span class="py-src-string">"<html>Hello, world!</html>"</span> + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">MyResource</span>() +</pre> + +<p>However, it is often a better idea to define Resource subclasses in Python modules. In order for changes in modules to be visible, you must either restart the Python process, or reload the module:</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +</p><span class="py-src-keyword">import</span> <span class="py-src-variable">myresource</span> + +<span class="py-src-comment">## Comment out this line when finished debugging</span> +<span class="py-src-variable">reload</span>(<span class="py-src-variable">myresource</span>) + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">myresource</span>.<span class="py-src-variable">MyResource</span>() +</pre> + +<p>Creating a Twisted Web server which serves a directory is easy:</p> + +<pre class="shell" xml:space="preserve"> +% twistd -n web --path /Users/dsp/Sites +</pre> + +<h3>Resource rendering<a name="auto6"/></h3> +<a name="rendering" shape="rect"/> + +<p>Resource rendering occurs when Twisted Web locates a leaf Resource object to handle a web request. A Resource's <code>render</code> method may do various things to produce output which will be sent back to the browser:</p> + +<ul> +<li>Return a string</li> +<li>Call <code>request.write("stuff")</code> as many times as desired, then call <code>request.finish()</code> and return <code>server.NOT_DONE_YET</code> (This is deceptive, since you are in fact done with the request, but is the correct way to do this)</li> + +<li>Request a <code>Deferred</code>, return <code>server.NOT_DONE_YET</code>, and call <code>request.write("stuff")</code> and <code>request.finish()</code> later, in a callback on the <code>Deferred</code>.</li> +</ul> + +<p> + +The <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">Resource</a></code> +class, which is usually what one's Resource classes subclass, has a +convenient default implementation of <code class="python">render</code>. It will call a method named <code class="python">self.render_METHOD</code> where <q>METHOD</q> is +whatever HTTP method was used to request this resource. Examples: +request_GET, request_POST, request_HEAD, and so on. It is recommended +that you have your resource classes subclass <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">Resource</a></code> and implement <code class="python">render_METHOD</code> methods as opposed to <code class="python">render</code> itself. Note that for certain resources, +<code class="python">request_POST = request_GET</code> may be +desirable in case one wants to process arguments passed to the +resource regardless of whether they used GET +(<code>?foo=bar&baz=quux</code>, and so forth) or POST. + +</p> + +<h3>Session<a name="auto7"/></h3> +<a name="sessions" shape="rect"/> + +<p>HTTP is a stateless protocol; every request-response is treated as an individual unit, distinguishable from any other request only by the URL requested. With the advent of Cookies in the mid nineties, dynamic web servers gained the ability to distinguish between requests coming from different <em>browser sessions</em> by sending a Cookie to a browser. The browser then sends this cookie whenever it makes a request to a web server, allowing the server to track which requests come from which browser session.</p> + +<p>Twisted Web provides an abstraction of this browser-tracking behavior called the <em>Session object</em>. Calling <code>request.getSession()</code> checks to see if a session cookie has been set; if not, it creates a unique session id, creates a Session object, stores it in the Site, and returns it. If a session object already exists, the same session object is returned. In this way, you can store data specific to the session in the session object.</p> + +<img src="../img/web-session.png"/> + +<h2>Advanced Configuration<a name="auto8"/></h2> + +<p>Non-trivial configurations of Twisted Web are achieved with Python +configuration files. This is a Python snippet which builds up a variable +called application. Usually, a <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.application.internet.TCPServer.html" title="twisted.application.internet.TCPServer">twisted.application.internet.TCPServer</a></code> instance will +be used to make the application listen on a TCP port (80, in case direct +web serving is desired), with the listener being a +<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.server.Site.html" title="twisted.web.server.Site">twisted.web.server.Site</a></code>. The resulting file can then +be run with <code class="shell">twistd -y</code>. Alternatively a reactor +object can be used directly to make a runnable script.</p> + +<p>The <code>Site</code> will wrap a <code>Resource</code> object -- the +root.</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +7 +8 +9 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<p>Most advanced configurations will be in the form of tweaking the +root resource object.</p> + +<h3>Adding Children<a name="auto9"/></h3> + +<p>Usually, the root's children will be based on the filesystem's contents. +It is possible to override the filesystem by explicit <code>putChild</code> +methods.</p> + +<p>Here are two examples. The first one adds a <code>/doc</code> child +to serve the documentation of the installed packages, while the second +one adds a <code>cgi-bin</code> directory for CGI scripts.</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +7 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">internet</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">reactor</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">putChild</span>(<span class="py-src-string">"doc"</span>, <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/usr/share/doc"</span>)) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">listenTCP</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>)) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">run</span>() +</pre> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +7 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">internet</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">reactor</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span>, <span class="py-src-variable">twcgi</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">putChild</span>(<span class="py-src-string">"cgi-bin"</span>, <span class="py-src-variable">twcgi</span>.<span class="py-src-variable">CGIDirectory</span>(<span class="py-src-string">"/var/www/cgi-bin"</span>)) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">listenTCP</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>)) +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">run</span>() +</pre> + +<h3>Modifying File Resources<a name="auto10"/></h3> + +<p><code>File</code> resources, be they root object or children thereof, +have two important attributes that often need to be modified: +<code>indexNames</code> and <code>processors</code>. <code>indexNames</code> +determines which files are treated as <q>index files</q> -- served +up when a directory is rendered. <code>processors</code> determine how +certain file extensions are treated.</p> + +<p>Here is an example for both, creating a site where all <code>.rpy</code> +extensions are Resource Scripts, and which renders directories by +searching for a <code>index.rpy</code> file.</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span>, <span class="py-src-variable">script</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">indexNames</span>=[<span class="py-src-string">'index.rpy'</span>] +<span class="py-src-variable">root</span>.<span class="py-src-variable">processors</span> = {<span class="py-src-string">'.rpy'</span>: <span class="py-src-variable">script</span>.<span class="py-src-variable">ResourceScript</span>} +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<p><code>File</code> objects also have a method called <code>ignoreExt</code>. +This method can be used to give extension-less URLs to users, so that +implementation is hidden. Here is an example:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span>, <span class="py-src-variable">script</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">ignoreExt</span>(<span class="py-src-string">".rpy"</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">processors</span> = {<span class="py-src-string">'.rpy'</span>: <span class="py-src-variable">script</span>.<span class="py-src-variable">ResourceScript</span>} +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<p>Now, a URL such as <code>/foo</code> might be served from a Resource +Script called <code>foo.rpy</code>, if no file by the name of <code>foo</code> +exists.</p> + +<h3>Virtual Hosts<a name="auto11"/></h3> + +<p>Virtual hosting is done via a special resource, that should be +used as the root resource -- <code>NameVirtualHost</code>. +<code>NameVirtualHost</code> has an attribute named <code>default</code>, +which holds the default website. If a different root for some other +name is desired, the <code>addHost</code> method should be called.</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span>, <span class="py-src-variable">vhost</span>, <span class="py-src-variable">script</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">vhost</span>.<span class="py-src-variable">NameVirtualHost</span>() + +<span class="py-src-comment"># Add a default -- htdocs</span> +<span class="py-src-variable">root</span>.<span class="py-src-variable">default</span>=<span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) + +<span class="py-src-comment"># Add a simple virtual host -- foo.com</span> +<span class="py-src-variable">root</span>.<span class="py-src-variable">addHost</span>(<span class="py-src-string">"foo.com"</span>, <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/foo"</span>)) + +<span class="py-src-comment"># Add a simple virtual host -- bar.com</span> +<span class="py-src-variable">root</span>.<span class="py-src-variable">addHost</span>(<span class="py-src-string">"bar.com"</span>, <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/bar"</span>)) + +<span class="py-src-comment"># The "baz" people want to use Resource Scripts in their web site</span> +<span class="py-src-variable">baz</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/baz"</span>) +<span class="py-src-variable">baz</span>.<span class="py-src-variable">processors</span> = {<span class="py-src-string">'.rpy'</span>: <span class="py-src-variable">script</span>.<span class="py-src-variable">ResourceScript</span>} +<span class="py-src-variable">baz</span>.<span class="py-src-variable">ignoreExt</span>(<span class="py-src-string">'.rpy'</span>) +<span class="py-src-variable">root</span>.<span class="py-src-variable">addHost</span>(<span class="py-src-string">'baz'</span>, <span class="py-src-variable">baz</span>) + +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<h3>Advanced Techniques<a name="auto12"/></h3> + +<p>Since the configuration is a Python snippet, it is possible to +use the full power of Python. Here are some simple examples:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +</p><span class="py-src-comment"># No need for configuration of virtual hosts -- just make sure</span> +<span class="py-src-comment"># a directory /var/vhosts/<vhost name> exists:</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">vhost</span>, <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">vhost</span>.<span class="py-src-variable">NameVirtualHost</span>() +<span class="py-src-variable">root</span>.<span class="py-src-variable">default</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) +<span class="py-src-keyword">for</span> <span class="py-src-variable">dir</span> <span class="py-src-keyword">in</span> <span class="py-src-variable">os</span>.<span class="py-src-variable">listdir</span>(<span class="py-src-string">"/var/vhosts"</span>): + <span class="py-src-variable">root</span>.<span class="py-src-variable">addHost</span>(<span class="py-src-variable">dir</span>, <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-variable">os</span>.<span class="py-src-variable">path</span>.<span class="py-src-variable">join</span>(<span class="py-src-string">"/var/vhosts"</span>, <span class="py-src-variable">dir</span>))) + +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +</p><span class="py-src-comment"># Determine ports we listen on based on a file with numbers:</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">vhost</span>, <span class="py-src-variable">static</span>, <span class="py-src-variable">server</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> + +<span class="py-src-variable">root</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/var/www/htdocs"</span>) + +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web'</span>) +<span class="py-src-variable">serviceCollection</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) + +<span class="py-src-keyword">for</span> <span class="py-src-variable">num</span> <span class="py-src-keyword">in</span> <span class="py-src-variable">map</span>(<span class="py-src-variable">int</span>, <span class="py-src-variable">open</span>(<span class="py-src-string">"/etc/web/ports"</span>).<span class="py-src-variable">read</span>().<span class="py-src-variable">split</span>()): + <span class="py-src-variable">serviceCollection</span>.<span class="py-src-variable">addCollection</span>(<span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-variable">num</span>, <span class="py-src-variable">site</span>)) +</pre> + + +<h2>Running a Twisted Web Server<a name="auto13"/></h2> + +<p>In many cases, you'll end up repeating common usage patterns of +twisted.web. In those cases you'll probably want to use Twisted's +pre-configured web server setup.</p> + +<p>The easiest way to run a Twisted Web server is with the Twisted Daemonizer. +For example, this command will run a web server which serves static files from +a particular directory:</p> + +<pre class="shell" xml:space="preserve"> +% twistd web --path /path/to/web/content +</pre> + +<p>If you just want to serve content from your own home directory, the +following will do:</p> + +<pre class="shell" xml:space="preserve"> +% twistd web --path ~/public_html/ +</pre> + +<p>You can stop the server at any time by going back to the directory you +started it in and running the command:</p> + +<pre class="shell" xml:space="preserve"> +% kill `cat twistd.pid` +</pre> + +<p> Some other configuration options are available as well: </p> + +<ul> + <li> <code>--port</code>: Specify the port for the web + server to listen on. This defaults to 8080. </li> + <li> <code>--logfile</code>: Specify the path to the + log file. </li> +</ul> + +<p> The full set of options that are available can be seen with: </p> + +<pre class="shell" xml:space="preserve"> +% twistd web --help +</pre> + +<h3>Serving Flat HTML<a name="auto14"/></h3> + +<p> Twisted.Web serves flat HTML files just as it does any other flat file. </p> + +<a name="ResourceScripts" shape="rect"/> +<h3>Resource Scripts<a name="auto15"/></h3> + +<p> A Resource script is a Python file ending with the extension <code>.rpy</code>, which is required to create an instance of a (subclass of a) <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.resource.Resource.html" title="twisted.web.resource.Resource">twisted.web.resource.Resource</a></code>. </p> + +<p> Resource scripts have 3 special variables: </p> + +<ul> + <li> <code class="py-src-identifier">__file__</code>: The name of the .rpy file, including the full path. This variable is automatically defined and present within the namespace. </li> + <li> <code class="py-src-identifier">registry</code>: An object of class <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.static.Registry.html" title="twisted.web.static.Registry">static.Registry</a></code>. It can be used to access and set persistent data keyed by a class.</li> + <li> <code class="py-src-identifier">resource</code>: The variable which must be defined by the script and set to the resource instance that will be used to render the page. </li> +</ul> + +<p> A very simple Resource Script might look like: </p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">resource</span> +<span class="py-src-keyword">class</span> <span class="py-src-identifier">MyGreatResource</span>(<span class="py-src-parameter">resource</span>.<span class="py-src-parameter">Resource</span>): + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-keyword">return</span> <span class="py-src-string">"<html>foo</html>"</span> + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">MyGreatResource</span>() +</pre> + +<p> A slightly more complicated resource script, which accesses some +persistent data, might look like:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">resource</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">SillyWeb</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">Counter</span> + +<span class="py-src-variable">counter</span> = <span class="py-src-variable">registry</span>.<span class="py-src-variable">getComponent</span>(<span class="py-src-variable">Counter</span>) +<span class="py-src-keyword">if</span> <span class="py-src-keyword">not</span> <span class="py-src-variable">counter</span>: + <span class="py-src-variable">registry</span>.<span class="py-src-variable">setComponent</span>(<span class="py-src-variable">Counter</span>, <span class="py-src-variable">Counter</span>()) +<span class="py-src-variable">counter</span> = <span class="py-src-variable">registry</span>.<span class="py-src-variable">getComponent</span>(<span class="py-src-variable">Counter</span>) + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">MyResource</span>(<span class="py-src-parameter">resource</span>.<span class="py-src-parameter">Resource</span>): + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-variable">counter</span>.<span class="py-src-variable">increment</span>() + <span class="py-src-keyword">return</span> <span class="py-src-string">"you are visitor %d"</span> % <span class="py-src-variable">counter</span>.<span class="py-src-variable">getValue</span>() + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">MyResource</span>() +</pre> + +<p> This is assuming you have the <code>SillyWeb.Counter</code> module, +implemented something like the following:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +</p><span class="py-src-keyword">class</span> <span class="py-src-identifier">Counter</span>: + + <span class="py-src-keyword">def</span> <span class="py-src-identifier">__init__</span>(<span class="py-src-parameter">self</span>): + <span class="py-src-variable">self</span>.<span class="py-src-variable">value</span> = <span class="py-src-number">0</span> + + <span class="py-src-keyword">def</span> <span class="py-src-identifier">increment</span>(<span class="py-src-parameter">self</span>): + <span class="py-src-variable">self</span>.<span class="py-src-variable">value</span> += <span class="py-src-number">1</span> + + <span class="py-src-keyword">def</span> <span class="py-src-identifier">getValue</span>(<span class="py-src-parameter">self</span>): + <span class="py-src-keyword">return</span> <span class="py-src-variable">self</span>.<span class="py-src-variable">value</span> +</pre> + +<h3>Web UIs<a name="auto16"/></h3> + +<p> +The +<a href="http://www.divmod.org/projects/nevow" shape="rect">Nevow</a> framework, available as +part of the <a href="http://www.divmod.org/projects/quotient" shape="rect">Quotient</a> project, +is an advanced system for giving Web UIs to your application. Nevow uses Twisted Web but is +not itself part of Twisted. +</p> + +<a name="SpreadableWebServers" shape="rect"/> +<h3>Spreadable Web Servers<a name="auto17"/></h3> + +<p> One of the most interesting applications of Twisted.Web is the distributed webserver; multiple servers can all answer requests on the same port, using the <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.spread.html" title="twisted.spread">twisted.spread</a></code> package for <q>spreadable</q> computing. In two different directories, run the commands: </p> + +<pre class="shell" xml:space="preserve"> +% twistd web --user +% twistd web --personal [other options, if you desire] +</pre> + +<p> Once you're running both of these instances, go to <code>http://localhost:8080/your_username.twistd/</code> -- you will see the front page from the server you created with the <code>--personal</code> option. What's happening here is that the request you've sent is being relayed from the central (User) server to your own (Personal) server, over a PB connection. This technique can be highly useful for small <q>community</q> sites; using the code that makes this demo work, you can connect one HTTP port to multiple resources running with different permissions on the same machine, on different local machines, or even over the internet to a remote site. </p> + +<p> +By default, a personal server listens on a UNIX socket in the owner's home +directory. The <code class="shell">--port</code> option can be used to make +it listen on a different address, such as a TCP or SSL server or on a UNIX +server in a different location. If you use this option to make a personal +server listen on a different address, the central (User) server won't be +able to find it, but a custom server which uses the same APIs as the central +server might. Another use of the <code class="shell">--port</code> option +is to make the UNIX server robust against system crashes. If the server +crashes and the UNIX socket is left on the filesystem, the personal server +will not be able to restart until it is removed. However, if <code class="shell">--port unix:/home/username/.twistd-web-pb:wantPID=1</code> is +supplied when creating the personal server, then a lockfile will be used to +keep track of whether the server socket is in use and automatically delete +it when it is not. +</p> + +<h3>Serving PHP/Perl/CGI<a name="auto18"/></h3> + +<p>Everything related to CGI is located in the +<code>twisted.web.twcgi</code>, and it's here you'll find the classes that you +need to subclass in order to support the language of your (or somebody elses) +taste. You'll also need to create your own kind of resource if you are using a +non-unix operatingsystem (such as Windows), or if the default resources has +wrong pathnames to the parsers.</p> + +<p>The following snippet is a .rpy that serves perl-files. Look at <code>twisted.web.twcgi</code> +for more examples regarding twisted.web and CGI.</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +5 +6 +7 +8 +9 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">static</span>, <span class="py-src-variable">twcgi</span> + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">PerlScript</span>(<span class="py-src-parameter">twcgi</span>.<span class="py-src-parameter">FilteredScript</span>): + <span class="py-src-variable">filter</span> = <span class="py-src-string">'/usr/bin/perl'</span> <span class="py-src-comment"># Points to the perl parser</span> + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">static</span>.<span class="py-src-variable">File</span>(<span class="py-src-string">"/perlsite"</span>) <span class="py-src-comment"># Points to the perl website</span> +<span class="py-src-variable">resource</span>.<span class="py-src-variable">processors</span> = {<span class="py-src-string">".pl"</span>: <span class="py-src-variable">PerlScript</span>} <span class="py-src-comment"># Files that end with .pl will be</span> + <span class="py-src-comment"># processed by PerlScript</span> +<span class="py-src-variable">resource</span>.<span class="py-src-variable">indexNames</span> = [<span class="py-src-string">'index.pl'</span>] +</pre> + +<h3>Serving WSGI Applications<a name="auto19"/></h3> + +<p><a href="http://wsgi.org/wsgi/" shape="rect">WSGI</a> is the Web Server Gateway +Interface. It is a specification for web servers and application servers to +communicate with Python web applications. All modern Python web frameworks +support the WSGI interface.</p> + +<p>The easiest way to get started with WSGI application is to use the twistd +command:</p> + +<pre class="shell" xml:space="preserve"> +% twistd -n web --wsgi=helloworld.application +</pre> + +<p>This assumes that you have a WSGI application called application in +your helloworld module/package, which might look like this:</p> + +<pre class="python"><p class="py-linenumber">1 +2 +3 +4 +</p><span class="py-src-keyword">def</span> <span class="py-src-identifier">application</span>(<span class="py-src-parameter">environ</span>, <span class="py-src-parameter">start_response</span>): + <span class="py-src-string">"""Basic WSGI Application"""</span> + <span class="py-src-variable">start_response</span>(<span class="py-src-string">'200 OK'</span>, [(<span class="py-src-string">'Content-type'</span>,<span class="py-src-string">'text/plain'</span>)]) + <span class="py-src-keyword">return</span> [<span class="py-src-string">'Hello World!'</span>] +</pre> + +<p>The above setup will be suitable for many applications where all that is +needed is to server the WSGI application at the site's root. However, for +greater control, Twisted provides support for using WSGI applications as +resources <code class="api">twisted.web.wsgi.WSGIResource</code>.</p> + +<p>Here is an example of a WSGI application being served as the root resource +for a site, in the following tac file:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +18 +19 +20 +21 +22 +23 +24 +25 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">server</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span>.<span class="py-src-variable">wsgi</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">WSGIResource</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">python</span>.<span class="py-src-variable">threadpool</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">ThreadPool</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">internet</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">reactor</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">service</span>, <span class="py-src-variable">strports</span> + +<span class="py-src-comment"># Create and start a thread pool,</span> +<span class="py-src-variable">wsgiThreadPool</span> = <span class="py-src-variable">ThreadPool</span>() +<span class="py-src-variable">wsgiThreadPool</span>.<span class="py-src-variable">start</span>() + +<span class="py-src-comment"># ensuring that it will be stopped when the reactor shuts down</span> +<span class="py-src-variable">reactor</span>.<span class="py-src-variable">addSystemEventTrigger</span>(<span class="py-src-string">'after'</span>, <span class="py-src-string">'shutdown'</span>, <span class="py-src-variable">wsgiThreadPool</span>.<span class="py-src-variable">stop</span>) + +<span class="py-src-keyword">def</span> <span class="py-src-identifier">application</span>(<span class="py-src-parameter">environ</span>, <span class="py-src-parameter">start_response</span>): + <span class="py-src-string">"""A basic WSGI application"""</span> + <span class="py-src-variable">start_response</span>(<span class="py-src-string">'200 OK'</span>, [(<span class="py-src-string">'Content-type'</span>,<span class="py-src-string">'text/plain'</span>)]) + <span class="py-src-keyword">return</span> [<span class="py-src-string">'Hello World!'</span>] + +<span class="py-src-comment"># Create the WSGI resource</span> +<span class="py-src-variable">wsgiAppAsResource</span> = <span class="py-src-variable">WSGIResource</span>(<span class="py-src-variable">reactor</span>, <span class="py-src-variable">wsgiThreadPool</span>, <span class="py-src-variable">application</span>) + +<span class="py-src-comment"># Hooks for twistd</span> +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'Twisted.web.wsgi Hello World Example'</span>) +<span class="py-src-variable">server</span> = <span class="py-src-variable">strports</span>.<span class="py-src-variable">service</span>(<span class="py-src-string">'tcp:8080'</span>, <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">wsgiAppAsResource</span>)) +<span class="py-src-variable">server</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">application</span>) +</pre> + +<p>This can then be run like any other .tac file:</p> + +<pre class="shell" xml:space="preserve"> +% twistd -ny myapp.tac +</pre> + +<p>Because of the synchronous nature of WSGI, each application call (for +each request) is called within a thread, and the result is written back to the +web server. For this, a <code class="api">twisted.python.threadpool.ThreadPool</code> +instance is used.</p> + +<h3>Using VHostMonster<a name="auto20"/></h3> + +<p>It is common to use one server (for example, Apache) on a site with multiple +names which then uses reverse proxy (in Apache, via <code>mod_proxy</code>) to different +internal web servers, possibly on different machines. However, naive +configuration causes miscommunication: the internal server firmly believes it +is running on <q>internal-name:port</q>, and will generate URLs to that effect, +which will be completely wrong when received by the client.</p> + +<p>While Apache has the ProxyPassReverse directive, it is really a hack +and is nowhere near comprehensive enough. Instead, the recommended practice +in case the internal web server is Twisted.Web is to use VHostMonster.</p> + +<p>From the Twisted side, using VHostMonster is easy: just drop a file named +(for example) <code>vhost.rpy</code> containing the following:</p> + +<pre class="python"><p class="py-linenumber">1 +2 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">vhost</span> +<span class="py-src-variable">resource</span> = <span class="py-src-variable">vhost</span>.<span class="py-src-variable">VHostMonsterResource</span>() +</pre> + +<p>Of course, an equivalent <code>.trp</code> can also be used. Make sure +the web server is configured with the correct processors for the +<code>rpy</code> or <code>trp</code> extensions (the web server +<code>twistd web --path</code> generates by default is so configured).</p> + +<p>From the Apache side, instead of using the following ProxyPass directive:</p> + +<pre xml:space="preserve"> +<VirtualHost ip-addr> +ProxyPass / http://localhost:8538/ +ServerName example.com +</VirtualHost> +</pre> + +<p>Use the following directive:</p> + +<pre xml:space="preserve"> +<VirtualHost ip-addr> +ProxyPass / http://localhost:8538/vhost.rpy/http/example.com:80/ +ServerName example.com +</VirtualHost> +</pre> + +<p>Here is an example for Twisted.Web's reverse proxy:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">application</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">internet</span>, <span class="py-src-variable">service</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">proxy</span>, <span class="py-src-variable">server</span>, <span class="py-src-variable">vhost</span> +<span class="py-src-variable">vhostName</span> = <span class="py-src-string">'example.com'</span> +<span class="py-src-variable">reverseProxy</span> = <span class="py-src-variable">proxy</span>.<span class="py-src-variable">ReverseProxyResource</span>(<span class="py-src-string">'internal'</span>, <span class="py-src-number">8538</span>, + <span class="py-src-string">'/vhost.rpy/http/'</span>+<span class="py-src-variable">vhostName</span>+<span class="py-src-string">'/'</span>) +<span class="py-src-variable">root</span> = <span class="py-src-variable">vhost</span>.<span class="py-src-variable">NameVirtualHost</span>() +<span class="py-src-variable">root</span>.<span class="py-src-variable">addHost</span>(<span class="py-src-variable">vhostName</span>, <span class="py-src-variable">reverseProxy</span>) +<span class="py-src-variable">site</span> = <span class="py-src-variable">server</span>.<span class="py-src-variable">Site</span>(<span class="py-src-variable">root</span>) +<span class="py-src-variable">application</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">Application</span>(<span class="py-src-string">'web-proxy'</span>) +<span class="py-src-variable">sc</span> = <span class="py-src-variable">service</span>.<span class="py-src-variable">IServiceCollection</span>(<span class="py-src-variable">application</span>) +<span class="py-src-variable">i</span> = <span class="py-src-variable">internet</span>.<span class="py-src-variable">TCPServer</span>(<span class="py-src-number">80</span>, <span class="py-src-variable">site</span>) +<span class="py-src-variable">i</span>.<span class="py-src-variable">setServiceParent</span>(<span class="py-src-variable">sc</span>) +</pre> + +<h2>Rewriting URLs<a name="auto21"/></h2> + +<p>Sometimes it is convenient to modify the content of the +<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.server.Request.html" title="twisted.web.server.Request">Request</a></code> object +before passing it on. Because this is most often used to rewrite +either the URL, the similarity to Apache's <code>mod_rewrite</code> has +inspired the <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.rewrite.html" title="twisted.web.rewrite">twisted.web.rewrite</a></code> module. Using +this module is done via wrapping a resource with a +<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.rewrite.RewriterResource.html" title="twisted.web.rewrite.RewriterResource">twisted.web.rewrite.RewriterResource</a></code> which +then has rewrite rules. Rewrite rules are functions which accept a request +object, and possible modify it. After all rewrite rules run, the child +resolution chain continues as if the wrapped resource, rather than +the <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.rewrite.RewriterResource.html" title="twisted.web.rewrite.RewriterResource">RewriterResource</a></code>, +was the child.</p> + +<p>Here is an example, using the only rule currently supplied by Twisted +itself:</p> + +<pre class="python"><p class="py-linenumber">1 +</p><span class="py-src-variable">default_root</span> = <span class="py-src-variable">rewrite</span>.<span class="py-src-variable">RewriterResource</span>(<span class="py-src-variable">default</span>, <span class="py-src-variable">rewrite</span>.<span class="py-src-variable">tildeToUsers</span>) +</pre> + +<p>This causes the URL <code>/~foo/bar.html</code> to be treated like +<code>/users/foo/bar.html</code>. If done after setting default's +<code>users</code> child to a +<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.distrib.UserDirectory.html" title="twisted.web.distrib.UserDirectory">distrib.UserDirectory</a></code>, +it gives a configuration similar to the classical configuration of +web server, common since the first NCSA servers.</p> + +<h2>Knowing When We're Not Wanted<a name="auto22"/></h2> + +<p>Sometimes it is useful to know when the other side has broken the connection. +Here is an example which does that:</p> + +<pre class="python"><p class="py-linenumber"> 1 + 2 + 3 + 4 + 5 + 6 + 7 + 8 + 9 +10 +11 +12 +13 +14 +15 +16 +17 +</p><span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span>.<span class="py-src-variable">resource</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">Resource</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">web</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">server</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">internet</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">reactor</span> +<span class="py-src-keyword">from</span> <span class="py-src-variable">twisted</span>.<span class="py-src-variable">python</span>.<span class="py-src-variable">util</span> <span class="py-src-keyword">import</span> <span class="py-src-variable">println</span> + + +<span class="py-src-keyword">class</span> <span class="py-src-identifier">ExampleResource</span>(<span class="py-src-parameter">Resource</span>): + + <span class="py-src-keyword">def</span> <span class="py-src-identifier">render_GET</span>(<span class="py-src-parameter">self</span>, <span class="py-src-parameter">request</span>): + <span class="py-src-variable">request</span>.<span class="py-src-variable">write</span>(<span class="py-src-string">"hello world"</span>) + <span class="py-src-variable">d</span> = <span class="py-src-variable">request</span>.<span class="py-src-variable">notifyFinish</span>() + <span class="py-src-variable">d</span>.<span class="py-src-variable">addCallback</span>(<span class="py-src-keyword">lambda</span> <span class="py-src-variable">_</span>: <span class="py-src-variable">println</span>(<span class="py-src-string">"finished normally"</span>)) + <span class="py-src-variable">d</span>.<span class="py-src-variable">addErrback</span>(<span class="py-src-variable">println</span>, <span class="py-src-string">"error"</span>) + <span class="py-src-variable">reactor</span>.<span class="py-src-variable">callLater</span>(<span class="py-src-number">10</span>, <span class="py-src-variable">request</span>.<span class="py-src-variable">finish</span>) + <span class="py-src-keyword">return</span> <span class="py-src-variable">server</span>.<span class="py-src-variable">NOT_DONE_YET</span> + +<span class="py-src-variable">resource</span> = <span class="py-src-variable">ExampleResource</span>() +</pre> + +<p>This will allow us to run statistics on the log-file to see how many users +are frustrated after merely 10 seconds.</p> + +<h2>As-Is Serving<a name="auto23"/></h2> + +<p>Sometimes, you want to be able to send headers and status directly. While +you can do this with a +<code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.script.ResourceScript.html" title="twisted.web.script.ResourceScript">ResourceScript</a></code>, an easier +way is to use <code class="API"><a href="http://twistedmatrix.com/documents/10.0.0/api/twisted.web.static.AsIsProcessor.html" title="twisted.web.static.AsIsProcessor">AsIsProcessor</a></code>. +Use it by, for example, addding it as a processor for the <code>.asis</code> +extension. Here is a sample file:</p> + +<pre xml:space="preserve"> +HTTP/1.0 200 OK +Content-Type: text/html + +Hello world +</pre> + +</div> + + <p><a href="index.html">Index</a></p> + <span class="version">Version: 10.0.0</span> + </body> +</html>
\ No newline at end of file |