docs/api.html

<html>
	<head>
		<title>Connect</title>
		<script src="http://ajax.googleapis.com/ajax/libs/jquery/1/jquery.min.js"></script>
		<style>body {
    margin: 0;
    padding: 0;
    font: 14px/1.5 'Palatino Linotype', 'Book Antiqua', Palatino, FreeSerif, serif;
    color: #252519;
}
a {
    color: #252519;
}
a:hover {
    text-decoration: underline;
    color: #19469D;
}
p {
    margin: 12px 0;
}
h1, h2, h3 {
    margin: 0;
    padding: 0;
}
table#source {
    width: 100%;
    border-collapse: collapse;
}
table#source td:first-child {
    padding: 30px 40px 30px 40px;
    vertical-align: top;
}
table#source td:first-child,
table#source td:first-child pre {
    width: 450px;
}
table#source td:last-child {
    padding: 30px 0 30px 40px;
    border-left: 1px solid #E5E5EE;
    background: #F5F5FF;
}
table#source tr {
    border-bottom: 1px solid #E5E5EE;
}
table#source tr.filename {
    padding-top: 40px;
    border-top: 1px solid #E5E5EE;
}
table#source tr.filename td:first-child {
    text-transform: capitalize;
}
table#source tr.filename td:last-child {
    font-size: 12px;
}
table#source tr.filename h2 {
    margin: 0;
    padding: 0;
    cursor: pointer;
}
table#source tr.code h1,
table#source tr.code h2,
table#source tr.code h3 {
    margin-top: 30px;
    font-family: "Lucida Grande", "Helvetica Nueue", Arial, sans-serif;
    font-size: 18px;
}
table#source tr.code h2 {
    font-size: 16px;
}
table#source tr.code h3 {
    font-size: 14px;
}
table#source tr.code ul {
    margin: 15px 0 15px 35px;
    padding: 0;
}
table#source tr.code ul li {
    margin: 0;
    padding: 1px 0;
}
table#source tr.code ul li p {
    margin: 0;
    padding: 0;
}
table#source tr.code td:first-child pre {
    padding: 20px;
}
#ribbon {
    position: fixed;
    top: 0;
    right: 0;
}
code .string { color: #219161; }
code .regexp { color: #219161; }
code .keyword { color: #954121; }
code .number { color: #19469D; }
code .comment { color: #bbb; }
code .this { color: #19469D; }</style>
		<script>
			$(function(){
				$('tr.code').hide();
				$('tr.filename').toggle(function(){
					$(this).nextUntil('.filename').fadeIn();
				}, function(){
					$(this).nextUntil('.filename').fadeOut();
				});
			});
		</script>
	</head>
	<body>
<table id="source"><tbody><tr><td><h1>Connect</h1><p>High performance middleware for <a href="http://nodejs.org">node</a>.</p></td><td></td></tr><tr class="filename"><td><h2 id="lib/connect/middleware/bodyDecoder.js"><a href="#">bodyDecoder</a></h2></td><td>lib/connect/middleware/bodyDecoder.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">queryString</span> = <span class="variable">require</span>(<span class="string">'querystring'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Decode request bodies.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span> = <span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">bodyDecoder</span>(){
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">bodyDecoder</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">decoder</span> = <span class="variable">exports</span>.<span class="variable">decode</span>[<span class="variable">mime</span>(<span class="variable">req</span>)];
        <span class="keyword">if</span> (<span class="variable">decoder</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; !<span class="variable">req</span>.<span class="variable">body</span>) {
            <span class="keyword">var</span> <span class="variable">data</span> = <span class="string">''</span>;
            <span class="variable">req</span>.<span class="variable">setEncoding</span>(<span class="string">'utf8'</span>);
            <span class="variable">req</span>.<span class="variable">addListener</span>(<span class="string">'data'</span>, <span class="keyword">function</span>(<span class="variable">chunk</span>) { <span class="variable">data</span> += <span class="variable">chunk</span>; });
            <span class="variable">req</span>.<span class="variable">addListener</span>(<span class="string">'end'</span>, <span class="keyword">function</span>() {
                <span class="variable">req</span>.<span class="variable">rawBody</span> = <span class="variable">data</span>;
                <span class="keyword">try</span> {
                    <span class="variable">req</span>.<span class="variable">body</span> = <span class="variable">data</span>
                        ? <span class="variable">decoder</span>(<span class="variable">data</span>)
                        : {};
                } <span class="keyword">catch</span> (<span class="variable">err</span>) {
                    <span class="keyword">return</span> <span class="variable">next</span>(<span class="variable">err</span>);
                }
                <span class="variable">next</span>();
            });
        } <span class="keyword">else</span> {
            <span class="variable">next</span>();
        }
    }
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Supported decoders.</p>

<ul><li>application/x-www-form-urlencoded</li><li>application/json</li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">decode</span> = {
    <span class="string">'application/x-www-form-urlencoded'</span>: <span class="variable">queryString</span>.<span class="variable">parse</span>,
    <span class="string">'application/json'</span>: <span class="class">JSON</span>.<span class="variable">parse</span>
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/cache.js"><a href="#">cache</a></h2></td><td>lib/connect/middleware/cache.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="class">Buffer</span> = <span class="variable">require</span>(<span class="string">'buffer'</span>).<span class="class">Buffer</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Cache in memory for the given <code>cacheDuration</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Number</em>  cacheDuration</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">cache</span>(<span class="variable">cacheDuration</span>){
    <span class="keyword">var</span> <span class="variable">cache</span> = {},
        <span class="variable">queue</span> = {};

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">cache</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {

        <span class="comment">// Skip all requests that are not GET method</span>
        <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">method</span> !== &<span class="variable">quot</span>;<span class="class">GET</span>&<span class="variable">quot</span>;) {
            <span class="variable">next</span>();
            <span class="keyword">return</span>;
        }

        <span class="keyword">var</span> <span class="variable">key</span> = <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="variable">accept</span>-<span class="variable">encoding</span>&<span class="variable">quot</span>;] + <span class="variable">req</span>.<span class="variable">url</span>,
            <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>,
            <span class="variable">write</span> = <span class="variable">res</span>.<span class="variable">write</span>,
            <span class="variable">end</span> = <span class="variable">res</span>.<span class="variable">end</span>,
            <span class="variable">code</span>,
            <span class="variable">headers</span>,
            <span class="variable">chunks</span> = [],
            <span class="variable">totalSize</span> = <span class="number integer">0</span>;

        <span class="keyword">function</span> <span class="variable">serve</span>() {
            <span class="keyword">var</span> <span class="variable">resp</span> = <span class="variable">cache</span>[<span class="variable">key</span>];
            <span class="keyword">var</span> <span class="variable">headers</span> = <span class="variable">resp</span>.<span class="variable">headers</span>;
            <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Length</span>&<span class="variable">quot</span>;] = <span class="variable">resp</span>.<span class="variable">body</span>.<span class="variable">length</span>;
            <span class="keyword">if</span> (!<span class="variable">resp</span>.<span class="variable">body</span>.<span class="variable">length</span>) <span class="variable">resp</span>.<span class="variable">body</span> = <span class="variable">undefined</span>;

            <span class="keyword">if</span> (<span class="variable">localQueue</span>) {
                <span class="comment">// Send everyone in the wait queue the response.</span>
                <span class="keyword">for</span> (<span class="keyword">var</span> <span class="variable">i</span> = <span class="number integer">0</span>, <span class="variable">l</span> = <span class="variable">localQueue</span>.<span class="variable">length</span>; <span class="variable">i</span> &<span class="variable">lt</span>; <span class="variable">l</span>; <span class="variable">i</span>++) {
                    <span class="keyword">var</span> <span class="variable">localRes</span> = <span class="variable">localQueue</span>[<span class="variable">i</span>];
                    <span class="variable">localRes</span>.<span class="variable">writeHead</span>(<span class="variable">resp</span>.<span class="variable">code</span>, <span class="variable">headers</span>);
                    <span class="variable">localRes</span>.<span class="variable">end</span>(<span class="variable">resp</span>.<span class="variable">body</span>);
                }
                <span class="comment">// Kill the wait queue</span>
                <span class="keyword">delete</span> <span class="variable">queue</span>[<span class="variable">key</span>];
            } <span class="keyword">else</span> {
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">resp</span>.<span class="variable">code</span>, <span class="variable">headers</span>);
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">resp</span>.<span class="variable">body</span>);
            }

        }

        <span class="comment">// If there is a cache-hit, serve it right away!</span>
        <span class="keyword">if</span> (<span class="variable">cache</span>[<span class="variable">key</span>]) {
            <span class="variable">serve</span>();
            <span class="keyword">return</span>;
        }

        <span class="keyword">var</span> <span class="variable">localQueue</span> = <span class="variable">queue</span>[<span class="variable">key</span>];
        <span class="keyword">if</span> (<span class="variable">localQueue</span>) {
            <span class="variable">localQueue</span>[<span class="variable">localQueue</span>.<span class="variable">length</span>] = <span class="variable">res</span>;
            <span class="keyword">return</span>;
        }
        <span class="variable">localQueue</span> = <span class="variable">queue</span>[<span class="variable">key</span>] = [<span class="variable">res</span>];

        <span class="comment">// Defer the call to writeHead</span>
        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span> (<span class="variable">setCode</span>, <span class="variable">setHeaders</span>) {
            <span class="variable">code</span> = <span class="variable">setCode</span>;
            <span class="variable">headers</span> = <span class="variable">setHeaders</span>;
        };

        <span class="comment">// Buffer the response body as an array of Buffer objects</span>
        <span class="variable">res</span>.<span class="variable">write</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
            <span class="keyword">if</span> (<span class="keyword">typeof</span> <span class="variable">chunk</span> === <span class="string">'string'</span>) {
                <span class="keyword">var</span> <span class="variable">length</span>;
                <span class="keyword">if</span> (!<span class="variable">encoding</span> || <span class="variable">encoding</span> === <span class="string">'utf8'</span>) {
                    <span class="variable">length</span> = <span class="class">Buffer</span>.<span class="variable">byteLength</span>(<span class="variable">chunk</span>);
                }
                <span class="keyword">var</span> <span class="variable">buffer</span> = <span class="keyword">new</span> <span class="class">Buffer</span>(<span class="variable">length</span>);
                <span class="variable">buffer</span>.<span class="variable">write</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
                <span class="variable">chunks</span>.<span class="variable">push</span>(<span class="variable">buffer</span>);
            } <span class="keyword">else</span> {
                <span class="variable">chunks</span>.<span class="variable">push</span>(<span class="variable">chunk</span>);
            }
            <span class="variable">totalSize</span> += <span class="variable">chunk</span>.<span class="variable">length</span>;
        };

        <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
            <span class="keyword">if</span> (<span class="variable">chunk</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">chunk</span>.<span class="variable">length</span>) {
                <span class="variable">res</span>.<span class="variable">write</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
            }

            <span class="comment">// Combine the buffer array into a single buffer</span>
            <span class="keyword">var</span> <span class="variable">body</span> = <span class="keyword">new</span> <span class="class">Buffer</span>(<span class="variable">totalSize</span>);
            <span class="keyword">var</span> <span class="variable">offset</span> = <span class="number integer">0</span>;
            <span class="variable">chunks</span>.<span class="variable">forEach</span>(<span class="keyword">function</span> (<span class="variable">chunk</span>) {
                <span class="variable">chunk</span>.<span class="variable">copy</span>(<span class="variable">body</span>, <span class="variable">offset</span>);
                <span class="variable">offset</span> += <span class="variable">chunk</span>.<span class="variable">length</span>;
            });

            <span class="comment">// Store the result in the cache</span>
            <span class="variable">cache</span>[<span class="variable">key</span>] = {
                <span class="variable">body</span>: <span class="variable">body</span>,
                <span class="variable">code</span>: <span class="variable">code</span>,
                <span class="variable">headers</span>: <span class="variable">headers</span>
            };

            <span class="comment">// Put the original methods back in place</span>
            <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
            <span class="variable">res</span>.<span class="variable">write</span> = <span class="variable">write</span>;
            <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;

            <span class="comment">// Serve the response from the cache</span>
            <span class="variable">serve</span>();

            <span class="keyword">if</span> (<span class="variable">cacheDuration</span>) {
                <span class="comment">// Expire the ram cache after 100ms or the specified length</span>
                <span class="variable">setTimeout</span>(<span class="keyword">function</span>(){
                    <span class="keyword">delete</span> <span class="variable">cache</span>[<span class="variable">key</span>];
                }, <span class="variable">cacheDuration</span>);
            } <span class="keyword">else</span> {
                <span class="comment">// When the timeout is zero, just kill it right away</span>
                <span class="keyword">delete</span> <span class="variable">cache</span>[<span class="variable">key</span>];
            }

        };

        <span class="variable">next</span>();
    };
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/cacheManifest.js"><a href="#">cacheManifest</a></h2></td><td>lib/connect/middleware/cacheManifest.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>),
    <span class="class">Utils</span> = <span class="variable">require</span>(<span class="string">'../utils'</span>),
    <span class="class">Url</span> = <span class="variable">require</span>(<span class="string">'url'</span>),
    <span class="class">Path</span> = <span class="variable">require</span>(<span class="string">'path'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Generate cache manifest for the given <code>root</code>, <code>networks</code>,
and <code>fallbacks</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  root</p></li><li><p><strong>param</strong>: <em>Array</em>  networks</p></li><li><p><strong>param</strong>: <em>Array</em>  fallbacks</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">cacheManifest</span>(<span class="variable">root</span>, <span class="variable">networks</span>, <span class="variable">fallbacks</span>) {
    <span class="variable">root</span> = <span class="variable">root</span> || <span class="variable">process</span>.<span class="variable">cwd</span>();
    <span class="keyword">var</span> <span class="variable">suffix</span> = &<span class="variable">quot</span>;&<span class="variable">quot</span>;;

    <span class="comment">// List of networks as an array of strings</span>
    <span class="keyword">if</span> (<span class="variable">networks</span>) {
        <span class="variable">suffix</span> += &<span class="variable">quot</span>;\<span class="variable">n</span>\<span class="variable">nNETWORK</span>:\<span class="variable">n</span>&<span class="variable">quot</span>; + <span class="variable">networks</span>.<span class="variable">join</span>(&<span class="variable">quot</span>;\<span class="variable">n</span>&<span class="variable">quot</span>;);
    }

    <span class="comment">// List of fallbacks as key/value pairs</span>
    <span class="keyword">if</span> (<span class="variable">fallbacks</span>) {
        <span class="variable">suffix</span> += &<span class="variable">quot</span>;\<span class="variable">n</span>\<span class="variable">nFALLBACK</span>:\<span class="variable">n</span>&<span class="variable">quot</span>; +
            <span class="variable">fallbacks</span>.<span class="variable">map</span>(<span class="keyword">function</span> (<span class="variable">second</span>, <span class="variable">first</span>) {
                <span class="keyword">return</span> <span class="variable">first</span> + &<span class="variable">quot</span>; &<span class="variable">quot</span>; + <span class="variable">second</span>;
            }).<span class="variable">join</span>(&<span class="variable">quot</span>;\<span class="variable">n</span>&<span class="variable">quot</span>;);
    }

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">cacheManifest</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">if</span> (<span class="class">Url</span>.<span class="variable">parse</span>(<span class="variable">req</span>.<span class="variable">url</span>).<span class="variable">pathname</span> === &<span class="variable">quot</span>;/<span class="variable">cache</span>.<span class="variable">manifest</span>&<span class="variable">quot</span>;) {
            <span class="class">Utils</span>.<span class="variable">find</span>(<span class="variable">root</span>, (<span class="regexp">/./</span>), <span class="keyword">function</span> (<span class="variable">err</span>, <span class="variable">files</span>) {
                <span class="keyword">var</span> <span class="variable">latestMtime</span> = <span class="number integer">0</span>;
                <span class="variable">files</span> = <span class="variable">files</span>.<span class="variable">map</span>(<span class="keyword">function</span> (<span class="variable">entry</span>) {
                    <span class="keyword">if</span> (<span class="variable">entry</span>.<span class="variable">mtime</span> &<span class="variable">gt</span>; <span class="variable">latestMtime</span>) {
                        <span class="variable">latestMtime</span> = <span class="variable">entry</span>.<span class="variable">mtime</span>;
                    }
                    <span class="keyword">return</span> <span class="variable">entry</span>.<span class="variable">path</span>.<span class="variable">substr</span>(<span class="number integer">1</span>);
                });
                <span class="keyword">var</span> <span class="variable">manifest</span> = &<span class="variable">quot</span>;<span class="class">CACHE</span> <span class="class">MANIFEST</span>\<span class="variable">n</span>&<span class="variable">quot</span>;
                    + &<span class="variable">quot</span>;# &<span class="variable">quot</span>; + <span class="variable">latestMtime</span>.<span class="variable">toUTCString</span>() + &<span class="variable">quot</span>;\<span class="variable">n</span>&<span class="variable">quot</span>;
                    + <span class="variable">files</span>.<span class="variable">join</span>(&<span class="variable">quot</span>;\<span class="variable">n</span>&<span class="variable">quot</span>;)
                    + <span class="variable">suffix</span>;

                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">200</span>, {
                    &<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Type</span>&<span class="variable">quot</span>;: &<span class="variable">quot</span>;<span class="variable">text</span>/<span class="variable">cache</span>-<span class="variable">manifest</span>&<span class="variable">quot</span>;,
                    &<span class="variable">quot</span>;<span class="class">Last</span>-<span class="class">Modified</span>&<span class="variable">quot</span>;: <span class="variable">latestMtime</span>.<span class="variable">toUTCString</span>(),
                    &<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Length</span>&<span class="variable">quot</span>;: <span class="variable">manifest</span>.<span class="variable">length</span>
                });
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">manifest</span>);
            });
            <span class="keyword">return</span>;
        }
        <span class="variable">next</span>();
    };
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/compiler.js"><a href="#">compiler</a></h2></td><td>lib/connect/middleware/compiler.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>),
    <span class="variable">path</span> = <span class="variable">require</span>(<span class="string">'path'</span>),
    <span class="variable">url</span> = <span class="variable">require</span>(<span class="string">'url'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Require cache.</p>

<ul><li><p><strong>type</strong>: <em>Object</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">cache</span> = {};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Setup compiler.</p>

<h2>Options</h2>

<ul><li><code>src</code>     Source directory, defaults to <strong>CWD</strong>.</li><li><code>dest</code>    Destination directory, defaults <code>src</code>.</li><li><code>enable</code>  Array of enabled compilers.</li></ul>

<h2>Compilers</h2>

<ul><li><code>sass</code>   Compiles cass to css</li><li><code>less</code>   Compiles less to css</li><li><code>coffeescript</code>   Compiles coffee to js</li></ul>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span> = <span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">compiler</span>(<span class="variable">options</span>){
    <span class="variable">options</span> = <span class="variable">options</span> || {};

    <span class="keyword">var</span> <span class="variable">srcDir</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">compilerSrc</span> || <span class="variable">options</span>.<span class="variable">src</span> || <span class="variable">process</span>.<span class="variable">cwd</span>(),
        <span class="variable">destDir</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">compilerDest</span> || <span class="variable">options</span>.<span class="variable">dest</span> || <span class="variable">srcDir</span>,
        <span class="variable">enable</span> = <span class="variable">options</span>.<span class="variable">enable</span>;

    <span class="keyword">if</span> (!<span class="variable">enable</span> || <span class="variable">enable</span>.<span class="variable">length</span> === <span class="number integer">0</span>) {
        <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="variable">s</span> &<span class="variable">quot</span>;<span class="variable">enable</span>&<span class="variable">quot</span>; <span class="variable">option</span> <span class="variable">is</span> <span class="variable">not</span> <span class="variable">set</span>, <span class="variable">nothing</span> <span class="variable">will</span> <span class="variable">be</span> <span class="variable">compiled</span>.');
    }

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">compiler</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">method</span> !== <span class="string">'GET'</span>) <span class="keyword">return</span> <span class="variable">next</span>();
        <span class="keyword">var</span> <span class="variable">pathname</span> = <span class="variable">url</span>.<span class="variable">parse</span>(<span class="variable">req</span>.<span class="variable">url</span>).<span class="variable">pathname</span>;
        <span class="keyword">for</span> (<span class="keyword">var</span> <span class="variable">i</span> = <span class="number integer">0</span>, <span class="variable">len</span> = <span class="variable">enable</span>.<span class="variable">length</span>; <span class="variable">i</span> &<span class="variable">lt</span>; <span class="variable">len</span>; ++<span class="variable">i</span>) {
            <span class="keyword">var</span> <span class="variable">name</span> = <span class="variable">enable</span>[<span class="variable">i</span>],
                <span class="variable">compiler</span> = <span class="variable">compilers</span>[<span class="variable">name</span>];
            <span class="keyword">if</span> (<span class="variable">compiler</span>.<span class="variable">match</span>.<span class="variable">test</span>(<span class="variable">pathname</span>)) {
                <span class="keyword">var</span> <span class="variable">src</span> = (<span class="variable">srcDir</span> + <span class="variable">pathname</span>).<span class="variable">replace</span>(<span class="variable">compiler</span>.<span class="variable">match</span>, <span class="variable">compiler</span>.<span class="variable">ext</span>),
                    <span class="variable">dest</span> = <span class="variable">destDir</span> + <span class="variable">pathname</span>;

                <span class="comment">// Compare mtimes</span>
                <span class="variable">fs</span>.<span class="variable">stat</span>(<span class="variable">src</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">srcStats</span>){
                    <span class="keyword">if</span> (<span class="variable">err</span>) {
                        <span class="keyword">if</span> (<span class="variable">err</span>.<span class="variable">errno</span> === <span class="variable">process</span>.<span class="class">ENOENT</span>) {
                            <span class="variable">next</span>();
                        } <span class="keyword">else</span> {
                            <span class="variable">next</span>(<span class="variable">err</span>);
                        }
                    } <span class="keyword">else</span> {
                        <span class="variable">fs</span>.<span class="variable">stat</span>(<span class="variable">dest</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">destStats</span>){
                            <span class="keyword">if</span> (<span class="variable">err</span>) {
                                <span class="comment">// Oh snap! it does not exist, compile it</span>
                                <span class="keyword">if</span> (<span class="variable">err</span>.<span class="variable">errno</span> === <span class="variable">process</span>.<span class="class">ENOENT</span>) {
                                    <span class="variable">compile</span>();
                                } <span class="keyword">else</span> {
                                    <span class="variable">next</span>(<span class="variable">err</span>);
                                }
                            } <span class="keyword">else</span> {
                                <span class="comment">// Source has changed, compile it</span>
                                <span class="keyword">if</span> (<span class="variable">srcStats</span>.<span class="variable">mtime</span> &<span class="variable">gt</span>; <span class="variable">destStats</span>.<span class="variable">mtime</span>) {
                                    <span class="variable">compile</span>();
                                } <span class="keyword">else</span> {
                                    <span class="comment">// Defer file serving</span>
                                    <span class="variable">next</span>();
                                }
                            }
                        });
                    }
                });

                <span class="comment">// Compile to the destination</span>
                <span class="keyword">function</span> <span class="variable">compile</span>() {
                    <span class="variable">fs</span>.<span class="variable">readFile</span>(<span class="variable">src</span>, <span class="string">'utf8'</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">str</span>){
                        <span class="keyword">if</span> (<span class="variable">err</span>) {
                            <span class="variable">next</span>(<span class="variable">err</span>);
                        } <span class="keyword">else</span> {
                            <span class="variable">compiler</span>.<span class="variable">compile</span>(<span class="variable">str</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">str</span>){
                                <span class="keyword">if</span> (<span class="variable">err</span>) {
                                    <span class="variable">next</span>(<span class="variable">err</span>);
                                } <span class="keyword">else</span> {
                                    <span class="variable">fs</span>.<span class="variable">writeFile</span>(<span class="variable">dest</span>, <span class="variable">str</span>, <span class="string">'utf8'</span>, <span class="keyword">function</span>(<span class="variable">err</span>){
                                        <span class="variable">next</span>(<span class="variable">err</span>);
                                    });
                                }
                            });
                        }
                    });
                }
                <span class="keyword">return</span>;
            }
        }
        <span class="variable">next</span>();
    };
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Bundled compilers:</p>

<ul><li><a href="http://github.com/visionmedia/sass.js">sass</a> to <em>css</em></li><li><a href="http://github.com/cloudhead/less.js">less</a> to <em>css</em></li><li><a href="http://github.com/jashkenas/coffee-script">coffee</a> to <em>js</em></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">compilers</span> = <span class="variable">exports</span>.<span class="variable">compilers</span> = {
    <span class="variable">sass</span>: {
        <span class="variable">match</span>: <span class="regexp">/\.css$/</span>,
        <span class="variable">ext</span>: <span class="string">'.sass'</span>,
        <span class="variable">compile</span>: <span class="keyword">function</span>(<span class="variable">str</span>, <span class="variable">fn</span>){
            <span class="keyword">var</span> <span class="variable">sass</span> = <span class="variable">cache</span>.<span class="variable">sass</span> || (<span class="variable">cache</span>.<span class="variable">sass</span> = <span class="variable">require</span>(<span class="string">'sass'</span>));
            <span class="keyword">try</span> {
                <span class="variable">fn</span>(<span class="keyword">null</span>, <span class="variable">sass</span>.<span class="variable">render</span>(<span class="variable">str</span>));
            } <span class="keyword">catch</span> (<span class="variable">err</span>) {
                <span class="variable">fn</span>(<span class="variable">err</span>);
            }
        }
    },
    <span class="variable">less</span>: {
        <span class="variable">match</span>: <span class="regexp">/\.css$/</span>,
        <span class="variable">ext</span>: <span class="string">'.less'</span>,
        <span class="variable">compile</span>: <span class="keyword">function</span>(<span class="variable">str</span>, <span class="variable">fn</span>){
            <span class="keyword">var</span> <span class="variable">less</span> = <span class="variable">cache</span>.<span class="variable">less</span> || (<span class="variable">cache</span>.<span class="variable">less</span> = <span class="variable">require</span>(<span class="string">'less'</span>));
            <span class="keyword">try</span> {
                <span class="variable">less</span>.<span class="variable">render</span>(<span class="variable">str</span>, <span class="variable">fn</span>);
            } <span class="keyword">catch</span> (<span class="variable">err</span>) {
                <span class="variable">fn</span>(<span class="variable">err</span>);
            }
        }
    },
    <span class="variable">coffeescript</span>: {
      <span class="variable">match</span>: <span class="regexp">/\.js$/</span>,
      <span class="variable">ext</span>: <span class="string">'.coffee'</span>,
      <span class="variable">compile</span>: <span class="keyword">function</span>(<span class="variable">str</span>, <span class="variable">fn</span>){
          <span class="keyword">var</span> <span class="variable">coffee</span> = <span class="variable">cache</span>.<span class="variable">coffee</span> || (<span class="variable">cache</span>.<span class="variable">coffee</span> = <span class="variable">require</span>(<span class="string">'coffee-script'</span>));
          <span class="keyword">try</span> {
              <span class="variable">fn</span>(<span class="keyword">null</span>, <span class="variable">coffee</span>.<span class="variable">compile</span>(<span class="variable">str</span>));
          } <span class="keyword">catch</span> (<span class="variable">err</span>) {
              <span class="variable">fn</span>(<span class="variable">err</span>);
          }
      }
    }
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/conditionalGet.js"><a href="#">conditionalGet</a></h2></td><td>lib/connect/middleware/conditionalGet.js</td></tr><tr class="code">
<td class="docs">
<p>Conditional GET request support.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">conditionalGet</span>(){
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">conditionalGet</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="comment">// Skip all requests that are not conditional gets.</span>
        <span class="keyword">if</span> (!(<span class="variable">req</span>.<span class="variable">method</span> === &<span class="variable">quot</span>;<span class="class">GET</span>&<span class="variable">quot</span>; &<span class="variable">amp</span>;&<span class="variable">amp</span>;
             (<span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="keyword">if</span>-<span class="variable">modified</span>-<span class="variable">since</span>&<span class="variable">quot</span>;] || <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="keyword">if</span>-<span class="variable">none</span>-<span class="variable">match</span>&<span class="variable">quot</span>;])
           )) {
            <span class="variable">next</span>();
            <span class="keyword">return</span>;
        }

        <span class="keyword">var</span> <span class="variable">since</span> = <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="keyword">if</span>-<span class="variable">modified</span>-<span class="variable">since</span>&<span class="variable">quot</span>;],
            <span class="variable">oldEtag</span> = <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="keyword">if</span>-<span class="variable">none</span>-<span class="variable">match</span>&<span class="variable">quot</span>;],
            <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>,
            <span class="variable">write</span> = <span class="variable">res</span>.<span class="variable">write</span>,
            <span class="variable">end</span> = <span class="variable">res</span>.<span class="variable">end</span>;

        <span class="variable">since</span> = <span class="variable">since</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="class">Date</span>.<span class="variable">parse</span>(<span class="variable">since</span>).<span class="variable">valueOf</span>();

        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span> (<span class="variable">code</span>, <span class="variable">headers</span>) {
            <span class="keyword">var</span> <span class="variable">lastModified</span> = <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Last</span>-<span class="class">Modified</span>&<span class="variable">quot</span>;],
                <span class="variable">etag</span> = <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">ETag</span>&<span class="variable">quot</span>;];
            <span class="variable">lastModified</span> = <span class="variable">lastModified</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="class">Date</span>.<span class="variable">parse</span>(<span class="variable">lastModified</span>).<span class="variable">valueOf</span>();

            <span class="comment">// If there is no match, then move on.</span>
            <span class="keyword">if</span> (!(<span class="variable">code</span> === <span class="number integer">200</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>;
                  ((<span class="variable">since</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">lastModified</span> === <span class="variable">since</span>) || (<span class="variable">etag</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">oldEtag</span> === <span class="variable">etag</span>))
               )) {
                <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);
                <span class="keyword">return</span>;
            }

            <span class="comment">// Ignore writes</span>
            <span class="variable">res</span>.<span class="variable">write</span> = <span class="keyword">function</span> () {};

            <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span> () {
                <span class="comment">// Put the original functions back on.</span>
                <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
                <span class="variable">res</span>.<span class="variable">write</span> = <span class="variable">write</span>;
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;

                <span class="comment">// Filter out any Content based headers since there is no</span>
                <span class="comment">// content.</span>
                <span class="keyword">var</span> <span class="variable">newHeaders</span> = {};
                <span class="class">Object</span>.<span class="variable">keys</span>(<span class="variable">headers</span>).<span class="variable">forEach</span>(<span class="keyword">function</span> (<span class="variable">key</span>) {
                    <span class="keyword">if</span> (<span class="variable">key</span>.<span class="variable">indexOf</span>(&<span class="variable">quot</span>;<span class="class">Content</span>&<span class="variable">quot</span>;) &<span class="variable">lt</span>; <span class="number integer">0</span>) {
                        <span class="variable">newHeaders</span>[<span class="variable">key</span>] = <span class="variable">headers</span>[<span class="variable">key</span>];
                    }
                });
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">304</span>, <span class="variable">newHeaders</span>);
                <span class="variable">res</span>.<span class="variable">end</span>();
            };
        };

        <span class="variable">next</span>();
    };
};
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/cookieDecoder.js"><a href="#">cookieDecoder</a></h2></td><td>lib/connect/middleware/cookieDecoder.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../utils'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Parse <em>Cookie</em> header and populate <code>req.cookies</code>.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">cookieDecoder</span>(){
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">cookieDecoder</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">cookie</span> = <span class="variable">req</span>.<span class="variable">headers</span>.<span class="variable">cookie</span>;
        <span class="variable">req</span>.<span class="variable">cookies</span> = {};
        <span class="keyword">if</span> (<span class="variable">cookie</span>) {
            <span class="keyword">try</span> {
                <span class="variable">req</span>.<span class="variable">cookies</span> = <span class="variable">utils</span>.<span class="variable">parseCookie</span>(<span class="variable">cookie</span>);
                <span class="keyword">delete</span> <span class="variable">req</span>.<span class="variable">headers</span>.<span class="variable">cookie</span>;
            } <span class="keyword">catch</span> (<span class="variable">err</span>) {
                <span class="comment">// Ignore</span>
            }
            <span class="variable">next</span>();
        } <span class="keyword">else</span> {
            <span class="variable">next</span>();
        }
    };
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/errorHandler.js"><a href="#">errorHandler</a></h2></td><td>lib/connect/middleware/errorHandler.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../utils'</span>),
    <span class="variable">sys</span> = <span class="variable">require</span>(<span class="string">'sys'</span>),
    <span class="variable">url</span> = <span class="variable">require</span>(<span class="string">'url'</span>),
    <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Setup error handler with the given <code>options</code>.</p>

<h2>Options</h2>

<ul><li><code>showStack</code>       respond with both the error message and stack trace. Defaults to <code>false</code></li><li><code>showMessage</code>     respond with the exception message only. Defaults to <code>false</code></li><li><code>dumpExceptions</code>  dump exceptions to stderr (without terminating the process). Defaults to <code>false</code></li></ul>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">errorHandler</span>(<span class="variable">options</span>){
    <span class="variable">options</span> = <span class="variable">options</span> || {};

    <span class="comment">// Defaults</span>
    <span class="keyword">var</span> <span class="variable">showStack</span> = <span class="variable">options</span>.<span class="variable">showStack</span>,
        <span class="variable">showMessage</span> = <span class="variable">options</span>.<span class="variable">showMessage</span>,
        <span class="variable">dumpExceptions</span> = <span class="variable">options</span>.<span class="variable">dumpExceptions</span>,
        <span class="variable">formatUrl</span> = <span class="variable">options</span>.<span class="variable">formatUrl</span>;

    <span class="comment">// --showErrorStack</span>
    <span class="keyword">if</span> (<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">showErrorStack</span> !== <span class="variable">undefined</span>) {
        <span class="variable">showStack</span> = <span class="variable">utils</span>.<span class="variable">toBoolean</span>(<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">showErrorStack</span>);
    }
    <span class="comment">// --showErrorMessage</span>
    <span class="keyword">if</span> (<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">showErrorMessage</span> !== <span class="variable">undefined</span>) {
        <span class="variable">showMessage</span> = <span class="variable">utils</span>.<span class="variable">toBoolean</span>(<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">showErrorMessage</span>);
    }

    <span class="comment">// --dumpExceptions</span>
    <span class="keyword">if</span> (<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">dumpExceptions</span> !== <span class="variable">undefined</span>) {
        <span class="variable">dumpExceptions</span> = <span class="variable">utils</span>.<span class="variable">toBoolean</span>(<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">dumpExceptions</span>);
    }
    
    <span class="comment">// --decorate stack trace file URLs</span>
    <span class="keyword">var</span> <span class="variable">formatLine</span> = <span class="keyword">function</span>(<span class="variable">v</span>){ <span class="keyword">return</span> <span class="string">'&lt;li&gt;'</span> + <span class="variable">v</span> + <span class="string">'&lt;/li&gt;'</span>; }; <span class="comment">// pass straight by default</span>
    <span class="keyword">if</span> (<span class="variable">formatUrl</span>) {
        <span class="keyword">var</span> <span class="variable">parts</span>, <span class="variable">re</span> = <span class="regexp">/(\/</span>[^\(\)]+):(\<span class="variable">d</span>+):(\<span class="variable">d</span>+)/;
        <span class="keyword">var</span> <span class="variable">formatters</span> = {
            <span class="string">'file'</span>: <span class="keyword">function</span>(<span class="variable">parts</span>) { <span class="keyword">return</span> {<span class="string">'protocol'</span>:<span class="string">'file'</span>, <span class="string">'hostname'</span>:<span class="string">''</span>+<span class="variable">parts</span>[<span class="number integer">1</span>]}; }, <span class="comment">// file: URL (will probably be blocked by the browser)</span>
            <span class="string">'txmt'</span>: <span class="keyword">function</span>(<span class="variable">parts</span>) { <span class="keyword">return</span> {      <span class="comment">// TextMate formatter</span>
                <span class="string">'protocol'</span>:<span class="string">'txmt'</span>, <span class="string">'hostname'</span>:<span class="string">'//open'</span>,
                <span class="string">'query'</span>:{<span class="string">'url'</span>:<span class="string">'file://'</span>+<span class="variable">parts</span>[<span class="number integer">1</span>],<span class="string">'line'</span>:<span class="variable">parts</span>[<span class="number integer">2</span>],<span class="string">'column'</span>:<span class="variable">parts</span>[<span class="number integer">3</span>]}};
            }
        };
        <span class="variable">formatLine</span> = <span class="keyword">function</span>(<span class="variable">v</span>) {
            <span class="variable">parts</span> = <span class="variable">v</span>.<span class="variable">match</span>(<span class="variable">re</span>);
            <span class="keyword">if</span> (<span class="variable">parts</span>) <span class="variable">v</span> = <span class="variable">v</span>.<span class="variable">replace</span>(<span class="variable">parts</span>[<span class="number integer">0</span>],<span class="string">'&lt;a href=&quot;'</span>+<span class="variable">url</span>.<span class="variable">format</span>( <span class="variable">formatters</span>[<span class="variable">formatUrl</span>](<span class="variable">parts</span>) )+<span class="string">'&quot;&gt;'</span>+<span class="variable">parts</span>[<span class="number integer">0</span>]+<span class="string">'&lt;/a&gt;'</span>);
            <span class="keyword">return</span> <span class="string">'&lt;li&gt;'</span> + <span class="variable">v</span> + <span class="string">'&lt;/li&gt;'</span>;
        };
    }


    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">errorHandler</span>(<span class="variable">err</span>, <span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">if</span> (<span class="variable">dumpExceptions</span>) {
            <span class="variable">sys</span>.<span class="variable">error</span>(<span class="variable">err</span>.<span class="variable">stack</span>);
        }
        <span class="keyword">if</span> (<span class="variable">showStack</span>) {
            <span class="keyword">var</span> <span class="variable">accept</span> = <span class="variable">req</span>.<span class="variable">headers</span>.<span class="variable">accept</span> || <span class="string">''</span>;
            <span class="keyword">if</span> (<span class="variable">accept</span>.<span class="variable">indexOf</span>(<span class="string">'html'</span>) !== -<span class="number integer">1</span>) {
                <span class="variable">fs</span>.<span class="variable">readFile</span>(<span class="variable">__dirname</span> + <span class="string">'/../public/style.css'</span>, <span class="keyword">function</span>(<span class="variable">e</span>, <span class="variable">style</span>){
                    <span class="variable">style</span> = <span class="variable">style</span>.<span class="variable">toString</span>(<span class="string">'ascii'</span>);
                    <span class="variable">fs</span>.<span class="variable">readFile</span>(<span class="variable">__dirname</span> + <span class="string">'/../public/error.html'</span>, <span class="keyword">function</span>(<span class="variable">e</span>, <span class="variable">html</span>){
                        <span class="keyword">var</span> <span class="variable">stack</span> = <span class="variable">err</span>.<span class="variable">stack</span>
                            .<span class="variable">split</span>(<span class="string">'\n'</span>).<span class="variable">slice</span>(<span class="number integer">1</span>)
                            .<span class="variable">map</span>(<span class="variable">formatLine</span>).<span class="variable">join</span>(<span class="string">''</span>);
                        <span class="variable">html</span> = <span class="variable">html</span>
                            .<span class="variable">toString</span>(<span class="string">'utf8'</span>)
                            .<span class="variable">replace</span>(<span class="string">'{style}'</span>, <span class="variable">style</span>)
                            .<span class="variable">replace</span>(<span class="string">'{stack}'</span>, <span class="variable">stack</span>)
                            .<span class="variable">replace</span>(<span class="regexp">/\{error\}/g</span>, <span class="variable">err</span>.<span class="variable">toString</span>());
                        <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">500</span>, { <span class="string">'Content-Type'</span>: <span class="string">'text/html'</span> });
                        <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">html</span>);
                    });
                });
            } <span class="keyword">else</span> <span class="keyword">if</span> (<span class="variable">accept</span>.<span class="variable">indexOf</span>(<span class="string">'json'</span>) !== -<span class="number integer">1</span>) {
                <span class="keyword">var</span> <span class="variable">json</span> = <span class="class">JSON</span>.<span class="variable">stringify</span>({ <span class="variable">error</span>: <span class="variable">err</span> });
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">500</span>, { <span class="string">'Content-Type'</span>: <span class="string">'application/json'</span> });
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">json</span>);
            } <span class="keyword">else</span> {
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">500</span>, { <span class="string">'Content-Type'</span>: <span class="string">'text/plain'</span> });
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">err</span>.<span class="variable">stack</span>);
            }
        } <span class="keyword">else</span> {
            <span class="keyword">var</span> <span class="variable">body</span> = <span class="variable">showMessage</span>
                ? <span class="variable">err</span>.<span class="variable">toString</span>()
                : <span class="string">'Internal Server Error'</span>;
            <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">500</span>, { <span class="string">'Content-Type'</span>: <span class="string">'text/plain'</span> });
            <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">body</span>);
        }
    };
};
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/favicon.js"><a href="#">favicon</a></h2></td><td>lib/connect/middleware/favicon.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>),
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'../utils'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Favicon cache.</p>

<ul><li><p><strong>type</strong>: <em>Object</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">icon</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>By default serves the connect favicon, or the favicon
located by the given path.</p>

<h2>Examples</h2>

<pre><code>connect.createServer(
    connect.favicon()    
);

connect.createServer(
    connect.favicon(__dirname + '/public/favicon.ico')    
);</code></pre>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  path</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">favicon</span>(<span class="variable">path</span>){
    <span class="variable">path</span> = <span class="variable">path</span> || <span class="variable">__dirname</span> + <span class="string">'/../public/favicon.ico'</span>;
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">favicon</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">url</span> === <span class="string">'/favicon.ico'</span>) {
            <span class="keyword">if</span> (<span class="variable">icon</span>) {
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">200</span>, <span class="variable">icon</span>.<span class="variable">headers</span>);
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">icon</span>.<span class="variable">body</span>);
            } <span class="keyword">else</span> {
                <span class="variable">fs</span>.<span class="variable">readFile</span>(<span class="variable">path</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">buf</span>){
                    <span class="keyword">if</span> (<span class="variable">err</span>) <span class="keyword">return</span> <span class="variable">next</span>(<span class="variable">err</span>);
                    <span class="variable">icon</span> = {
                        <span class="variable">headers</span>: {
                            <span class="string">'Content-Type'</span>: <span class="string">'image/x-icon'</span>,
                            <span class="string">'Content-Length'</span>: <span class="variable">buf</span>.<span class="variable">length</span>,
                            <span class="string">'ETag'</span>: <span class="variable">utils</span>.<span class="variable">md5</span>(<span class="variable">buf</span>),
                            <span class="string">'Cache-Control'</span>: <span class="string">'public max-age=3600'</span>
                        },
                        <span class="variable">body</span>: <span class="variable">buf</span>
                    }
                    <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">200</span>, <span class="variable">icon</span>.<span class="variable">headers</span>);
                    <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">icon</span>.<span class="variable">body</span>);
                });
            }
        } <span class="keyword">else</span> {
            <span class="variable">next</span>();
        }
    };
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/gzip-compress.js"><a href="#">gzip-compress</a></h2></td><td>lib/connect/middleware/gzip-compress.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">compress</span> = <span class="variable">require</span>(<span class="string">'compress'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Provides gzip compression via the node-compress library.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">gzip</span>(){
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">gzip</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>,
            <span class="variable">write</span> = <span class="variable">res</span>.<span class="variable">write</span>,
            <span class="variable">end</span> = <span class="variable">res</span>.<span class="variable">end</span>;

        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span> (<span class="variable">code</span>, <span class="variable">headers</span>) {
            <span class="keyword">var</span> <span class="variable">type</span> = <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Type</span>&<span class="variable">quot</span>;],
                <span class="variable">accept</span> = <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="variable">accept</span>-<span class="variable">encoding</span>&<span class="variable">quot</span>;];

            <span class="keyword">if</span> (!(<span class="variable">code</span> === <span class="number integer">200</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">accept</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">accept</span>.<span class="variable">indexOf</span>(<span class="string">'gzip'</span>) &<span class="variable">gt</span>;= <span class="number integer">0</span>
                  &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">type</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; (<span class="regexp">/(text|javascript|json)/</span>).<span class="variable">test</span>(<span class="variable">type</span>)
                  &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Encoding</span>&<span class="variable">quot</span>;] === <span class="variable">undefined</span>)) {
                <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);
                <span class="keyword">return</span>;
            }

            <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Encoding</span>&<span class="variable">quot</span>;] = &<span class="variable">quot</span>;<span class="variable">gzip</span>&<span class="variable">quot</span>;;
            <span class="keyword">delete</span> <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Length</span>&<span class="variable">quot</span>;];

            <span class="keyword">var</span> <span class="variable">gzip</span> = <span class="keyword">new</span> <span class="variable">compress</span>.<span class="class">GzipStream</span>();

            <span class="variable">res</span>.<span class="variable">write</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="variable">gzip</span>.<span class="variable">setInputEncoding</span>(<span class="variable">encoding</span>);
                <span class="variable">gzip</span>.<span class="variable">write</span>(<span class="variable">chunk</span>);
            };

            <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="keyword">if</span> (<span class="variable">chunk</span>) {
                    <span class="variable">res</span>.<span class="variable">write</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
                }
                <span class="variable">gzip</span>.<span class="variable">close</span>();
            };

            <span class="variable">gzip</span>.<span class="variable">addListener</span>(<span class="string">'data'</span>, <span class="keyword">function</span> (<span class="variable">chunk</span>) {
                <span class="variable">write</span>.<span class="variable">call</span>(<span class="variable">res</span>, <span class="variable">chunk</span>);
            });
            <span class="variable">gzip</span>.<span class="variable">addListener</span>(<span class="string">'error'</span>, <span class="keyword">function</span>(<span class="variable">err</span>) {
                <span class="variable">res</span>.<span class="variable">write</span> = <span class="variable">write</span>;
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;
                <span class="variable">next</span>(<span class="variable">err</span>);
            });
            <span class="variable">gzip</span>.<span class="variable">addListener</span>(<span class="string">'end'</span>, <span class="keyword">function</span> (<span class="variable">code</span>) {
                <span class="variable">res</span>.<span class="variable">write</span> = <span class="variable">write</span>;
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;
                <span class="variable">res</span>.<span class="variable">end</span>();
            });

            <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
            <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);

        };

        <span class="variable">next</span>();
    };
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/gzip-proc.js"><a href="#">gzip-proc</a></h2></td><td>lib/connect/middleware/gzip-proc.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">child_process</span> = <span class="variable">require</span>(<span class="string">'child_process'</span>),
    <span class="variable">sys</span> = <span class="variable">require</span>(<span class="string">'sys'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Provides gzip compression via the <code>gzip</code> executable.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">gzip</span>(){
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">gzip</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>,
            <span class="variable">write</span> = <span class="variable">res</span>.<span class="variable">write</span>,
            <span class="variable">end</span> = <span class="variable">res</span>.<span class="variable">end</span>;

        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span> (<span class="variable">code</span>, <span class="variable">headers</span>) {
            <span class="keyword">var</span> <span class="variable">type</span> = <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Type</span>&<span class="variable">quot</span>;],
                <span class="variable">accept</span> = <span class="variable">req</span>.<span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="variable">accept</span>-<span class="variable">encoding</span>&<span class="variable">quot</span>;];

            <span class="keyword">if</span> (!(<span class="variable">code</span> === <span class="number integer">200</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">accept</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">accept</span>.<span class="variable">indexOf</span>(<span class="string">'gzip'</span>) &<span class="variable">gt</span>;= <span class="number integer">0</span>
                  &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">type</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; (<span class="regexp">/(text|javascript|json)/</span>).<span class="variable">test</span>(<span class="variable">type</span>)
                  &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Encoding</span>&<span class="variable">quot</span>;] === <span class="variable">undefined</span>)) {
                <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);
                <span class="keyword">return</span>;
            }

            <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Encoding</span>&<span class="variable">quot</span>;] = &<span class="variable">quot</span>;<span class="variable">gzip</span>&<span class="variable">quot</span>;;
            <span class="keyword">delete</span> <span class="variable">headers</span>[&<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Length</span>&<span class="variable">quot</span>;];

            <span class="keyword">var</span> <span class="variable">gzip</span> = <span class="variable">child_process</span>.<span class="variable">spawn</span>(&<span class="variable">quot</span>;<span class="variable">gzip</span>&<span class="variable">quot</span>;, [&<span class="variable">quot</span>;-<span class="number integer">9</span>&<span class="variable">quot</span>;]);

            <span class="variable">res</span>.<span class="variable">write</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="variable">gzip</span>.<span class="variable">stdin</span>.<span class="variable">write</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
            };

            <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span> (<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="keyword">if</span> (<span class="variable">chunk</span>) {
                    <span class="variable">res</span>.<span class="variable">write</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
                }
                <span class="variable">gzip</span>.<span class="variable">stdin</span>.<span class="variable">end</span>();
            };

            <span class="variable">gzip</span>.<span class="variable">stdout</span>.<span class="variable">addListener</span>(<span class="string">'data'</span>, <span class="keyword">function</span> (<span class="variable">chunk</span>) {
                <span class="variable">write</span>.<span class="variable">call</span>(<span class="variable">res</span>, <span class="variable">chunk</span>);
            });

            <span class="variable">gzip</span>.<span class="variable">addListener</span>(&<span class="variable">quot</span>;<span class="variable">exit</span>&<span class="variable">quot</span>;, <span class="keyword">function</span> (<span class="variable">code</span>) {
                <span class="variable">res</span>.<span class="variable">write</span> = <span class="variable">write</span>;
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;
                <span class="variable">res</span>.<span class="variable">end</span>();
            });

            <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
            <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);

        };

        <span class="variable">next</span>();
    };
};
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/gzip.js"><a href="#">gzip</a></h2></td><td>lib/connect/middleware/gzip.js</td></tr><tr class="code">
<td class="docs">
<p>try {
    module.exports = require('./gzip-compress');
} catch (e) {
    if (/^Cannot find module /.test(e.message))
        module.exports = require('./gzip-proc');
    else
        throw e;
}</p>
</td>
<td class="code">

</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/lint.js"><a href="#">lint</a></h2></td><td>lib/connect/middleware/lint.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">connect</span> = <span class="variable">require</span>(<span class="string">'./../index'</span>),
    <span class="variable">sys</span> = <span class="variable">require</span>(<span class="string">'sys'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Setup lint for the given <code>server</code>.</p>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">lint</span>(<span class="variable">server</span>){

    <span class="comment">// Ensure a server is passed</span>
    <span class="keyword">if</span> (!<span class="variable">server</span>) {
        <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'lint &quot;server&quot; must be passed.'</span>);
    }

    <span class="comment">// Warn unless in development mode</span>
    <span class="keyword">if</span> (<span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">name</span> !== <span class="string">'development'</span>) {
        <span class="variable">warn</span>(<span class="string">'&quot;lint&quot; middleware should never be enabled outside of the development environment'</span>);
    }

    <span class="comment">// Check the stack</span>
    <span class="variable">checkStack</span>(<span class="variable">server</span>.<span class="variable">stack</span>);

    <span class="comment">// Do nothing</span>
    <span class="keyword">return</span> <span class="keyword">function</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="variable">next</span>();
    }
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/logger.js"><a href="#">logger</a></h2></td><td>lib/connect/middleware/logger.js</td></tr><tr class="code">
<td class="docs">
<p>Log buffer.</p>

<ul><li><p><strong>type</strong>: <em>Array</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">buf</span> = [];</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Default log buffer duration.</p>

<ul><li><p><strong>type</strong>: <em>Number</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">defaultBufferDuration</span> = <span class="number integer">1000</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Log requests with the given <code>options</code>.</p>

<h2>Options</h2>

<ul><li><code>format</code>  Format string, see below for tokens</li><li><code>stream</code>  Output stream, defaults to <em>stdout</em></li><li><code>buffer</code>  Buffer duration, defaults to 1000ms when <em>true</em></li></ul>

<h2>Tokens</h2>

<ul><li><code>:req[header]</code> ex: <code>:req[Accept]</code></li><li><code>:res[header]</code> ex: <code>:res[Content-Length]</code></li><li><code>:http-version</code></li><li><code>:response-time</code></li><li><code>:remote-addr</code></li><li><code>:date</code></li><li><code>:method</code></li><li><code>:url</code></li><li><code>:referrer</code></li><li><code>:user-agent</code></li><li><code>:status</code></li></ul>

<h2></h2>

<ul><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">logger</span>(<span class="variable">options</span>) {
    <span class="variable">options</span> = <span class="variable">options</span> || {};

    <span class="keyword">var</span> <span class="variable">fmt</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">logFormat</span> || <span class="variable">options</span>.<span class="variable">format</span>,
        <span class="variable">stream</span> = <span class="variable">options</span>.<span class="variable">stream</span> || <span class="variable">process</span>.<span class="variable">stdout</span>,
        <span class="variable">buffer</span> = <span class="variable">options</span>.<span class="variable">buffer</span>;

    <span class="comment">// Buffering support</span>
    <span class="keyword">if</span> (<span class="variable">buffer</span>) {
        <span class="keyword">var</span> <span class="variable">realStream</span> = <span class="variable">stream</span>;
        <span class="variable">setInterval</span>(<span class="keyword">function</span>(){
            <span class="keyword">if</span> (<span class="variable">buf</span>.<span class="variable">length</span>) {
                <span class="variable">realStream</span>.<span class="variable">write</span>(<span class="variable">buf</span>.<span class="variable">join</span>(<span class="string">''</span>), <span class="string">'ascii'</span>);
                <span class="variable">buf</span>.<span class="variable">length</span> = <span class="number integer">0</span>;
            }
        }, <span class="keyword">typeof</span> <span class="variable">buffer</span> === <span class="string">'number'</span> ? <span class="variable">buffer</span> : <span class="variable">defaultBufferDuration</span>); 
        <span class="variable">stream</span> = {
            <span class="variable">write</span>: <span class="keyword">function</span>(<span class="variable">str</span>){
                <span class="variable">buf</span>.<span class="variable">push</span>(<span class="variable">str</span>);
            }
        };
    }

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">logger</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">start</span> = +<span class="keyword">new</span> <span class="class">Date</span>,
            <span class="variable">statusCode</span>,
            <span class="variable">resHeaders</span>,
            <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>,
            <span class="variable">end</span> = <span class="variable">res</span>.<span class="variable">end</span>,
            <span class="variable">url</span> = <span class="variable">req</span>.<span class="variable">url</span>;

        <span class="comment">// Proxy for statusCode.</span>
        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span>(<span class="variable">code</span>, <span class="variable">headers</span>){
            <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
            <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">code</span>, <span class="variable">headers</span>);
            <span class="variable">res</span>.<span class="variable">statusCode</span> = <span class="variable">statusCode</span> = <span class="variable">code</span>;
            <span class="variable">res</span>.<span class="variable">headers</span> = <span class="variable">resHeaders</span> = <span class="variable">headers</span> || {};
        };

        <span class="comment">// Proxy end to output a line to the provided logger.</span>
        <span class="keyword">if</span> (<span class="variable">fmt</span>) {
            <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);
                <span class="variable">res</span>.<span class="variable">responseTime</span> = +<span class="keyword">new</span> <span class="class">Date</span> - <span class="variable">start</span>;
                <span class="variable">stream</span>.<span class="variable">write</span>(<span class="variable">format</span>(<span class="variable">fmt</span>, <span class="variable">req</span>, <span class="variable">res</span>) + <span class="string">'\n'</span>, <span class="string">'ascii'</span>);
            };
        } <span class="keyword">else</span> {
            <span class="variable">res</span>.<span class="variable">end</span> = <span class="keyword">function</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>) {
                <span class="variable">res</span>.<span class="variable">end</span> = <span class="variable">end</span>;
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">chunk</span>, <span class="variable">encoding</span>);

                <span class="variable">stream</span>.<span class="variable">write</span>((<span class="variable">req</span>.<span class="variable">socket</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">req</span>.<span class="variable">socket</span>.<span class="variable">remoteAddress</span>)
                 + <span class="string">' - - ['</span> + (<span class="keyword">new</span> <span class="class">Date</span>).<span class="variable">toUTCString</span>() + <span class="string">']'</span>
                 + <span class="string">' &quot;'</span> + <span class="variable">req</span>.<span class="variable">method</span> + <span class="string">' '</span> + <span class="variable">url</span>
                 + <span class="string">' HTTP/'</span> + <span class="variable">req</span>.<span class="variable">httpVersionMajor</span> + <span class="string">'.'</span> + <span class="variable">req</span>.<span class="variable">httpVersionMinor</span> + <span class="string">'&quot; '</span>
                 + <span class="variable">statusCode</span> + <span class="string">' '</span> + (<span class="variable">resHeaders</span>[<span class="string">'Content-Length'</span>] || <span class="string">'-'</span>)
                 + <span class="string">' &quot;'</span> + (<span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'referer'</span>] || <span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'referrer'</span>] || <span class="string">''</span>)
                 + <span class="string">'&quot; &quot;'</span> + (<span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'user-agent'</span>] || <span class="string">''</span>) + <span class="string">'&quot;\n'</span>, <span class="string">'ascii'</span>);
            };
        }

        <span class="comment">// Fall through to the next layer.</span>
        <span class="variable">next</span>();
    };

};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/methodOverride.js"><a href="#">methodOverride</a></h2></td><td>lib/connect/middleware/methodOverride.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">queryString</span> = <span class="variable">require</span>(<span class="string">'querystring'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Valid http methods.</p>

<ul><li><p><strong>type</strong>: <em>Array</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">methods</span> = [<span class="string">'GET'</span>, <span class="string">'POST'</span>, <span class="string">'PUT'</span>, <span class="string">'HEAD'</span>, <span class="string">'DELETE'</span>, <span class="string">'OPTIONS'</span>];</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Pass an optional <code>key</code> to use when checking for
a method override, othewise defaults to __method_.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  key</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">methodOverride</span>(<span class="variable">key</span>){
    <span class="variable">key</span> = <span class="variable">key</span> || &<span class="variable">quot</span>;<span class="variable">_method</span>&<span class="variable">quot</span>;;
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">methodOverride</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">var</span> <span class="variable">method</span> = <span class="variable">req</span>.<span class="variable">method</span>;

        <span class="comment">// Check req.body (bodyDecoder)</span>
        <span class="keyword">if</span> (<span class="keyword">typeof</span> <span class="variable">req</span>.<span class="variable">body</span> === <span class="string">'object'</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">key</span> <span class="keyword">in</span> <span class="variable">req</span>.<span class="variable">body</span>) {
            <span class="variable">method</span> = <span class="variable">req</span>.<span class="variable">body</span>[<span class="variable">key</span>];
            <span class="keyword">delete</span> <span class="variable">req</span>.<span class="variable">body</span>[<span class="variable">key</span>];
        <span class="comment">// Check X-HTTP-Method-Override</span>
        } <span class="keyword">else</span> <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'x-http-method-override'</span>]) {
            <span class="variable">method</span> = <span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'x-http-method-override'</span>];
        }

        <span class="comment">// Ensure method is valid, and normalize</span>
        <span class="variable">method</span> = <span class="variable">method</span>.<span class="variable">toUpperCase</span>();
        <span class="keyword">if</span> (<span class="variable">methods</span>.<span class="variable">indexOf</span>(<span class="variable">method</span>) &<span class="variable">gt</span>;= <span class="number integer">0</span>) {
            <span class="variable">req</span>.<span class="variable">method</span> = <span class="variable">method</span>;
        }
        
        <span class="variable">next</span>();
    };
};

</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/repl.js"><a href="#">repl</a></h2></td><td>lib/connect/middleware/repl.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">net</span> = <span class="variable">require</span>(<span class="string">'net'</span>),
    <span class="variable">_repl</span> = <span class="variable">require</span>(<span class="string">'repl'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Start a <strong>REPL</strong> on the given unix domain <code>socket</code> path.</p>

<h2>Options</h2>

<ul><li><code>sockect</code>     Unix domain socket path. Defaults to "/tmp/connect.sock"</li><li><code>prompt</code>      <strong>REPL</strong> prompt string. Defaults to "node&gt; "</li></ul>

<h2>Example</h2>

<pre><code>$ rlwrap telnet /tmp/connect.sock</code></pre>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  prompt</p></li><li><p><strong>param</strong>: <em>String</em>  socket path</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">repl</span>(<span class="variable">prompt</span>, <span class="variable">socket</span>){
    <span class="variable">prompt</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">replPrompt</span> || <span class="variable">prompt</span> || <span class="string">'node&gt; '</span>;
    <span class="variable">socket</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">replSocket</span> || <span class="variable">socket</span> || <span class="string">'/tmp/connect.sock'</span>;
    <span class="variable">net</span>.<span class="variable">createServer</span>(<span class="keyword">function</span>(<span class="variable">stream</span>){
        <span class="variable">_repl</span>.<span class="variable">start</span>(<span class="variable">prompt</span>, <span class="variable">stream</span>);
    }).<span class="variable">listen</span>(<span class="variable">socket</span>);
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">repl</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="comment">// Pass through for now</span>
        <span class="variable">next</span>();
    }
};
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/router.js"><a href="#">router</a></h2></td><td>lib/connect/middleware/router.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">parse</span> = <span class="variable">require</span>(<span class="string">'url'</span>).<span class="variable">parse</span>,
    <span class="variable">querystring</span> = <span class="variable">require</span>(<span class="string">'querystring'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Provides Sinatra and Express like routing capabilities.</p>

<h2>Examples</h2>

<pre><code>connect.router(function(app){
    app.get('/user/:id', function(req, res, next){
        // populates req.params.id
    });
})</code></pre>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">router</span>(<span class="variable">fn</span>){
    <span class="keyword">var</span> <span class="variable">routes</span>;

    <span class="keyword">if</span> (<span class="variable">fn</span>) {
        <span class="variable">routes</span> = {};
        <span class="variable">fn</span>.<span class="variable">call</span>(<span class="this">this</span>, {
            <span class="variable">post</span>: <span class="variable">method</span>.<span class="variable">call</span>(<span class="this">this</span>, <span class="string">'post'</span>),
            <span class="variable">get</span>: <span class="variable">method</span>.<span class="variable">call</span>(<span class="this">this</span>, <span class="string">'get'</span>),
            <span class="variable">put</span>: <span class="variable">method</span>.<span class="variable">call</span>(<span class="this">this</span>, <span class="string">'put'</span>),
            <span class="variable">del</span>: <span class="variable">method</span>.<span class="variable">call</span>(<span class="this">this</span>, <span class="string">'del'</span>)
        });
    } <span class="keyword">else</span> {
        <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'router provider requires a callback function'</span>);
    }

    <span class="keyword">function</span> <span class="variable">method</span>(<span class="variable">name</span>) {
        <span class="keyword">var</span> <span class="variable">self</span> = <span class="this">this</span>,
            <span class="variable">localRoutes</span> = <span class="variable">routes</span>[<span class="variable">name</span>] = <span class="variable">routes</span>[<span class="variable">name</span>] || [];
        <span class="keyword">return</span> <span class="keyword">function</span>(<span class="variable">path</span>, <span class="variable">fn</span>){
            <span class="keyword">var</span> <span class="variable">keys</span> = [];
            <span class="variable">path</span> = <span class="variable">path</span> <span class="variable">instanceof</span> <span class="class">RegExp</span>
                ? <span class="variable">path</span>
                : <span class="variable">normalizePath</span>(<span class="variable">path</span>, <span class="variable">keys</span>);
            <span class="variable">localRoutes</span>.<span class="variable">push</span>({
                <span class="variable">fn</span>: <span class="variable">fn</span>,
                <span class="variable">path</span>: <span class="variable">path</span>,
                <span class="variable">keys</span>: <span class="variable">keys</span>
            });
            <span class="keyword">return</span> <span class="variable">self</span>;
        };
    }

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">router</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">var</span> <span class="variable">route</span>,
            <span class="variable">self</span> = <span class="this">this</span>;
        (<span class="keyword">function</span> <span class="variable">pass</span>(<span class="variable">i</span>){
            <span class="keyword">if</span> (<span class="variable">route</span> = <span class="variable">match</span>(<span class="variable">req</span>, <span class="variable">routes</span>, <span class="variable">i</span>)) {
                <span class="variable">req</span>.<span class="variable">params</span> = <span class="variable">route</span>.<span class="variable">_params</span>;
                <span class="keyword">try</span> { 
                    <span class="variable">route</span>.<span class="variable">call</span>(<span class="variable">self</span>, <span class="variable">req</span>, <span class="variable">res</span>, <span class="keyword">function</span>(<span class="variable">err</span>){
                        <span class="keyword">if</span> (<span class="variable">err</span> === <span class="variable">true</span>) {
                            <span class="variable">next</span>();
                        } <span class="keyword">else</span> <span class="keyword">if</span> (<span class="variable">err</span>) {
                            <span class="variable">next</span>(<span class="variable">err</span>);
                        } <span class="keyword">else</span> {
                            <span class="variable">pass</span>(<span class="variable">route</span>.<span class="variable">_index</span>+<span class="number integer">1</span>);
                        }
                    });
                } <span class="keyword">catch</span> (<span class="variable">err</span>) {
                    <span class="variable">next</span>(<span class="variable">err</span>);
                }
            } <span class="keyword">else</span> {
                <span class="variable">next</span>();
            }
        })();
    };
}</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/session/memory.js"><a href="#">memory</a></h2></td><td>lib/connect/middleware/session/memory.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">sys</span> = <span class="variable">require</span>(<span class="string">'sys'</span>),
    <span class="class">Store</span> = <span class="variable">require</span>(<span class="string">'./store'</span>),
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../../utils'</span>),
    <span class="class">Session</span> = <span class="variable">require</span>(<span class="string">'./session'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Initialize MemoryStore with the given options.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="class">MemoryStore</span> = <span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="class">MemoryStore</span>(<span class="variable">options</span>) {
    <span class="variable">options</span> = <span class="variable">options</span> || {};
    <span class="class">Store</span>.<span class="variable">call</span>(<span class="this">this</span>, <span class="variable">options</span>);
    <span class="this">this</span>.<span class="variable">sessions</span> = {};

    <span class="comment">// Default reapInterval to 10 minutes</span>
    <span class="this">this</span>.<span class="variable">reapInterval</span> = <span class="variable">options</span>.<span class="variable">reapInterval</span> || <span class="number integer">600000</span>;

    <span class="comment">// Reap stale sessions</span>
    <span class="keyword">if</span> (<span class="this">this</span>.<span class="variable">reapInterval</span> !== -<span class="number integer">1</span>) {
        <span class="variable">setInterval</span>(<span class="keyword">function</span>(<span class="variable">self</span>){
            <span class="variable">self</span>.<span class="variable">reap</span>(<span class="variable">self</span>.<span class="variable">maxAge</span>);
        }, <span class="this">this</span>.<span class="variable">reapInterval</span>, <span class="this">this</span>);
    }
};

<span class="variable">sys</span>.<span class="variable">inherits</span>(<span class="class">MemoryStore</span>, <span class="class">Store</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Attempt to fetch session by the given <code>sid</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  sid</p></li><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">get</span> = <span class="keyword">function</span>(<span class="variable">sid</span>, <span class="variable">fn</span>){
    <span class="keyword">if</span> (<span class="variable">sid</span> <span class="keyword">in</span> <span class="this">this</span>.<span class="variable">sessions</span>) {
        <span class="variable">fn</span>(<span class="keyword">null</span>, <span class="this">this</span>.<span class="variable">sessions</span>[<span class="variable">sid</span>]);
    } <span class="keyword">else</span> {
        <span class="variable">fn</span>();
    }
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Commit the given <code>sess</code> object associated with the given <code>sid</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  sid</p></li><li><p><strong>param</strong>: <em>Session</em>  sess</p></li><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">set</span> = <span class="keyword">function</span>(<span class="variable">sid</span>, <span class="variable">sess</span>, <span class="variable">fn</span>){
    <span class="this">this</span>.<span class="variable">sessions</span>[<span class="variable">sid</span>] = <span class="variable">sess</span>;
    <span class="variable">fn</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">fn</span>();
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Destroy the session associated with the given <code>sid</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  sid</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">destroy</span> = <span class="keyword">function</span>(<span class="variable">sid</span>, <span class="variable">fn</span>){
    <span class="keyword">delete</span> <span class="this">this</span>.<span class="variable">sessions</span>[<span class="variable">sid</span>];
    <span class="variable">fn</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">fn</span>();
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Invoke the given callback <code>fn</code> with all active sessions.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">all</span> = <span class="keyword">function</span>(<span class="variable">fn</span>){
    <span class="keyword">var</span> <span class="variable">arr</span> = [],
        <span class="variable">keys</span> = <span class="class">Object</span>.<span class="variable">keys</span>(<span class="this">this</span>.<span class="variable">sessions</span>);
    <span class="keyword">for</span> (<span class="keyword">var</span> <span class="variable">i</span> = <span class="number integer">0</span>, <span class="variable">len</span> = <span class="variable">keys</span>.<span class="variable">length</span>; <span class="variable">i</span> &<span class="variable">lt</span>; <span class="variable">len</span>; ++<span class="variable">i</span>) {
        <span class="variable">arr</span>.<span class="variable">push</span>(<span class="this">this</span>.<span class="variable">sessions</span>[<span class="variable">keys</span>[<span class="variable">i</span>]]);
    }
    <span class="variable">fn</span>(<span class="keyword">null</span>, <span class="variable">arr</span>);
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Clear all sessions.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">clear</span> = <span class="keyword">function</span>(<span class="variable">fn</span>){
    <span class="this">this</span>.<span class="variable">sessions</span> = {};
    <span class="variable">fn</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">fn</span>();
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Fetch number of sessions.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">MemoryStore</span>.<span class="variable">prototype</span>.<span class="variable">length</span> = <span class="keyword">function</span>(<span class="variable">fn</span>){
    <span class="variable">fn</span>(<span class="keyword">null</span>, <span class="class">Object</span>.<span class="variable">keys</span>(<span class="this">this</span>.<span class="variable">sessions</span>).<span class="variable">length</span>);
};
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/session/session.js"><a href="#">session</a></h2></td><td>lib/connect/middleware/session/session.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../../utils'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Update lastAccess timestamp.</p>

<ul><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">Session</span>.<span class="variable">prototype</span>.<span class="variable">touch</span> = <span class="keyword">function</span>(){
    <span class="this">this</span>.<span class="variable">lastAccess</span> = +<span class="keyword">new</span> <span class="class">Date</span>;
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Destroy <code>this</code> session.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">Session</span>.<span class="variable">prototype</span>.<span class="variable">destroy</span> = <span class="keyword">function</span>(<span class="variable">fn</span>){
    <span class="keyword">delete</span> <span class="this">this</span>.<span class="variable">req</span>.<span class="variable">session</span>;
    <span class="this">this</span>.<span class="variable">req</span>.<span class="variable">sessionStore</span>.<span class="variable">destroy</span>(<span class="this">this</span>.<span class="variable">req</span>.<span class="variable">sessionID</span>, <span class="variable">fn</span>);
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Regenerate this request's session.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">Session</span>.<span class="variable">prototype</span>.<span class="variable">regenerate</span> = <span class="keyword">function</span>(<span class="variable">fn</span>){
    <span class="this">this</span>.<span class="variable">req</span>.<span class="variable">sessionStore</span>.<span class="variable">regenerate</span>(<span class="this">this</span>.<span class="variable">req</span>, <span class="variable">fn</span>);
};

</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/session/store.js"><a href="#">store</a></h2></td><td>lib/connect/middleware/session/store.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="class">Session</span> = <span class="variable">require</span>(<span class="string">'./session'</span>),
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../../utils'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Destroy session associated with the given <code>sid</code>
by passing <code>null</code> to <code>Store#get()</code>.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  sid</p></li><li><p><strong>param</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">Store</span>.<span class="variable">prototype</span>.<span class="variable">destroy</span> = <span class="keyword">function</span>(<span class="variable">sid</span>, <span class="variable">fn</span>){
    <span class="this">this</span>.<span class="variable">set</span>(<span class="variable">sid</span>, <span class="keyword">null</span>, <span class="variable">fn</span>);
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Re-generate the given requests's session.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>IncomingRequest</em>  req</p></li><li><p><strong>return</strong>: <em>Function</em>  fn</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="class">Store</span>.<span class="variable">prototype</span>.<span class="variable">regenerate</span> = <span class="keyword">function</span>(<span class="variable">req</span>, <span class="variable">fn</span>){
    <span class="keyword">var</span> <span class="variable">self</span> = <span class="this">this</span>;
    <span class="this">this</span>.<span class="variable">destroy</span>(<span class="variable">req</span>.<span class="variable">sessionID</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">destroyed</span>){
        <span class="variable">self</span>.<span class="variable">generate</span>();
        <span class="variable">fn</span>(<span class="variable">err</span>, <span class="variable">destroyed</span>);
    });
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/session.js"><a href="#">session</a></h2></td><td>lib/connect/middleware/session.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="class">Session</span> = <span class="variable">require</span>(<span class="string">'./session/session'</span>),
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'./../utils'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Setup session store with the given <code>options</code>.</p>

<h2>Options</h2>

<ul><li><code>store</code>         Session store instance</li><li><code>fingerprint</code>   Custom fingerprint generating function</li></ul>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span> = <span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">sessionSetup</span>(<span class="variable">options</span>){
    <span class="variable">options</span> = <span class="variable">options</span> || {};

    <span class="comment">// The cookie key to store the session id in.</span>
    <span class="keyword">var</span> <span class="variable">key</span> = <span class="variable">options</span>.<span class="variable">key</span> || <span class="string">'connect.sid'</span>;

    <span class="comment">// Default memory store</span>
    <span class="keyword">var</span> <span class="variable">store</span> = <span class="variable">options</span>.<span class="variable">store</span> || <span class="keyword">new</span> (<span class="variable">require</span>(<span class="string">'./session/memory'</span>));

    <span class="comment">// Used to verify session ids / defaults to user agent</span>
    <span class="keyword">var</span> <span class="variable">fingerprint</span> = <span class="variable">options</span>.<span class="variable">fingerprint</span> || <span class="keyword">function</span> <span class="variable">fingerprint</span>(<span class="variable">req</span>) {
        <span class="keyword">return</span> <span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'user-agent'</span>] || <span class="string">''</span>;
    };

    <span class="comment">// This should be set by the app to make the session key tamper proof</span>
    <span class="keyword">var</span> <span class="variable">secret</span> = <span class="variable">options</span>.<span class="variable">secret</span> || &<span class="variable">quot</span>;<span class="variable">hackme</span>&<span class="variable">quot</span>;;

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">sessionHandle</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {

        <span class="keyword">if</span> (!<span class="variable">req</span>.<span class="variable">cookies</span>) {
            <span class="variable">next</span>(<span class="keyword">new</span> <span class="class">Error</span>(&<span class="variable">quot</span>;<span class="variable">session</span> <span class="variable">requires</span> <span class="variable">cookieDecoder</span> <span class="variable">to</span> <span class="variable">work</span> <span class="variable">properly</span>&<span class="variable">quot</span>;));
            <span class="keyword">return</span>;
        }

        <span class="comment">// Wrap writeHead as a hook to save the session and send the cookie</span>
        <span class="keyword">var</span> <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>;
        <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span>(<span class="variable">status</span>, <span class="variable">headers</span>){

            <span class="comment">// Update the session in the store if there is one</span>
            <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">session</span>) {
                <span class="variable">req</span>.<span class="variable">session</span>.<span class="variable">touch</span>();
                <span class="variable">store</span>.<span class="variable">set</span>(<span class="variable">req</span>.<span class="variable">sessionID</span>, <span class="variable">req</span>.<span class="variable">session</span>);
            }

            <span class="comment">// Send an updated cookie to the browser</span>
            <span class="variable">store</span>.<span class="variable">cookie</span>.<span class="variable">expires</span> = <span class="keyword">new</span> <span class="class">Date</span>(<span class="class">Date</span>.<span class="variable">now</span>() + <span class="variable">store</span>.<span class="variable">maxAge</span>);

            <span class="comment">// Multiple Set-Cookie headers</span>
            <span class="variable">headers</span> = <span class="variable">headers</span> || {};
            <span class="keyword">var</span> <span class="variable">cookie</span> = <span class="variable">utils</span>.<span class="variable">serializeCookie</span>(<span class="variable">key</span>, <span class="variable">req</span>.<span class="variable">sessionID</span>, <span class="variable">store</span>.<span class="variable">cookie</span>);
            <span class="keyword">if</span> (<span class="variable">headers</span>[<span class="string">'Set-Cookie'</span>]) {
                <span class="variable">headers</span>[<span class="string">'Set-Cookie'</span>] += <span class="string">'\r\nSet-Cookie: '</span> + <span class="variable">cookie</span>;
            } <span class="keyword">else</span> {
                <span class="variable">headers</span>[<span class="string">'Set-Cookie'</span>] = <span class="variable">cookie</span>;
            }

            <span class="comment">// Pass through the writeHead call</span>
            <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
            <span class="keyword">return</span> <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">status</span>, <span class="variable">headers</span>);
        };

        <span class="comment">// Calculates the security hash to prevent session hijacking</span>
        <span class="comment">// Uses information on the user-agent that created the session as it's fingerprint</span>
        <span class="keyword">function</span> <span class="variable">hash</span>(<span class="variable">base</span>) {
          <span class="keyword">return</span> <span class="variable">utils</span>.<span class="variable">md5</span>(<span class="variable">base</span> + <span class="variable">fingerprint</span>(<span class="variable">req</span>) + <span class="variable">secret</span>, <span class="string">'base64'</span>).<span class="variable">replace</span>(<span class="regexp">/=*$/</span>, <span class="string">''</span>);
        }

        <span class="comment">// Generates the new session</span>
        <span class="keyword">var</span> <span class="variable">generate</span> = <span class="variable">store</span>.<span class="variable">generate</span> = <span class="keyword">function</span>(){
            <span class="keyword">var</span> <span class="variable">base</span> = <span class="variable">utils</span>.<span class="variable">uid</span>();
            <span class="keyword">var</span> <span class="variable">sessionID</span> = <span class="variable">base</span> + &<span class="variable">quot</span>;.&<span class="variable">quot</span>; + <span class="variable">hash</span>(<span class="variable">base</span>);
            <span class="variable">req</span>.<span class="variable">session</span> = <span class="keyword">new</span> <span class="class">Session</span>(<span class="variable">req</span>, <span class="variable">sessionID</span>);
            <span class="variable">req</span>.<span class="variable">sessionID</span> = <span class="variable">sessionID</span>;
        };

        <span class="comment">// Expose store</span>
        <span class="variable">req</span>.<span class="variable">sessionStore</span> = <span class="variable">store</span>;

        <span class="comment">// Get the sessionID from the cookie</span>
        <span class="variable">req</span>.<span class="variable">sessionID</span> = <span class="variable">req</span>.<span class="variable">cookies</span>[<span class="variable">key</span>];

        <span class="comment">// Make a new session if the browser doesn't send a sessionID</span>
        <span class="keyword">if</span> (!<span class="variable">req</span>.<span class="variable">sessionID</span>) {
            <span class="variable">generate</span>();
            <span class="variable">next</span>();
            <span class="keyword">return</span>;
        }

        <span class="comment">// Check the fingerprint</span>
        <span class="keyword">var</span> <span class="variable">parts</span> = <span class="variable">req</span>.<span class="variable">sessionID</span>.<span class="variable">split</span>(<span class="string">'.'</span>);
        <span class="keyword">if</span> (<span class="variable">parts</span>[<span class="number integer">1</span>] !== <span class="variable">hash</span>(<span class="variable">parts</span>[<span class="number integer">0</span>])) {
            <span class="comment">// Make a new session if it doesn't check out</span>
            <span class="variable">generate</span>();
            <span class="variable">next</span>();
            <span class="keyword">return</span>;
        }

        <span class="comment">// Generate the session object</span>
        <span class="variable">store</span>.<span class="variable">get</span>(<span class="variable">req</span>.<span class="variable">sessionID</span>, <span class="keyword">function</span> (<span class="variable">err</span>, <span class="variable">sess</span>) {
            <span class="comment">// Error/missing handling</span>
            <span class="keyword">if</span> (<span class="variable">err</span>) {
                <span class="keyword">if</span> (<span class="variable">err</span>.<span class="variable">errno</span> === <span class="variable">process</span>.<span class="class">ENOENT</span>) {
                    <span class="comment">// If the session ID is invalid, generate a new session</span>
                    <span class="variable">generate</span>();
                    <span class="variable">next</span>();
                } <span class="keyword">else</span> {
                    <span class="comment">// Otherwise pass the exception along</span>
                    <span class="variable">next</span>(<span class="variable">err</span>);
                }
                <span class="keyword">return</span>;
            }
            <span class="keyword">if</span> (!<span class="variable">sess</span>) {
              <span class="comment">// Some stores use a falsy result to signify no result</span>
              <span class="variable">generate</span>();
              <span class="variable">next</span>();
              <span class="keyword">return</span>;
            }

            <span class="comment">// Load the session into the request</span>
            <span class="variable">req</span>.<span class="variable">session</span> = <span class="keyword">new</span> <span class="class">Session</span>(<span class="variable">req</span>, <span class="variable">sess</span>);
            <span class="variable">next</span>();
        });
    };
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Expose constructors.
 </p>
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="class">Session</span> = <span class="class">Session</span>;
<span class="variable">exports</span>.<span class="class">Store</span> = <span class="variable">require</span>(<span class="string">'./session/store'</span>);
<span class="variable">exports</span>.<span class="class">MemoryStore</span> = <span class="variable">require</span>(<span class="string">'./session/memory'</span>);
</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/staticGzip.js"><a href="#">staticGzip</a></h2></td><td>lib/connect/middleware/staticGzip.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>),
    <span class="variable">parse</span> = <span class="variable">require</span>(<span class="string">'url'</span>).<span class="variable">parse</span>
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'../utils'</span>),
    <span class="variable">path</span> = <span class="variable">require</span>(<span class="string">'path'</span>),
    <span class="variable">exec</span> = <span class="variable">require</span>(<span class="string">'child_process'</span>).<span class="variable">exec</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Expose staticGzip as the module.
 </p>
</td>
<td class="code">
<pre><code><span class="variable">exports</span> = <span class="variable">module</span>.<span class="variable">exports</span> = <span class="variable">staticGzip</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Gzip binary.</p>

<ul><li><p><strong>type</strong>: <em>String</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">bin</span> = <span class="string">'gzip'</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Flags passed to gzip.</p>

<ul><li><p><strong>type</strong>: <em>String</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">flags</span> = <span class="string">'--best'</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>staticGzip gzips statics via whitelist of mime types specified
by the <code>compress</code> option. Once created <code>staticProvider</code> can continue
on to serve the gzipped version of the file.</p>

<h2>Options</h2>

<ul><li><code>root</code>      Root direction from which to generate gzipped statics</li><li><code>compress</code>  Array of mime types serving as a whitelist</li><li><code>flags</code>     String of flags passed to the binary</li><li><code>bin</code>       Binary executable defaulting to "gzip"</li></ul>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="keyword">function</span> <span class="variable">staticGzip</span>(<span class="variable">options</span>){
    <span class="keyword">var</span> <span class="variable">options</span> = <span class="variable">options</span> || {},
        <span class="variable">root</span> = <span class="variable">options</span>.<span class="variable">root</span>,
        <span class="variable">compress</span> = <span class="variable">options</span>.<span class="variable">compress</span>,
        <span class="variable">flags</span> = <span class="variable">options</span>.<span class="variable">flags</span> || <span class="variable">exports</span>.<span class="variable">flags</span>,
        <span class="variable">bin</span> = <span class="variable">options</span>.<span class="variable">bin</span> || <span class="variable">exports</span>.<span class="variable">bin</span>;

    <span class="keyword">if</span> (!<span class="variable">root</span>) <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'staticGzip root must be set'</span>);
    <span class="keyword">if</span> (!<span class="variable">compress</span>) <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'staticGzip compress array must be passed'</span>);

    <span class="keyword">return</span> <span class="keyword">function</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">method</span> !== <span class="string">'GET'</span>) <span class="keyword">return</span> <span class="variable">next</span>();

        <span class="keyword">var</span> <span class="variable">acceptEncoding</span> = <span class="variable">req</span>.<span class="variable">headers</span>[<span class="string">'accept-encoding'</span>] || <span class="string">''</span>;

        <span class="comment">// Ignore when Accept-Encoding does not allow gzip</span>
        <span class="keyword">if</span> (<span class="variable">acceptEncoding</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; !~<span class="variable">acceptEncoding</span>.<span class="variable">indexOf</span>(<span class="string">'gzip'</span>)) <span class="keyword">return</span> <span class="variable">next</span>();

        <span class="comment">// Parse the url</span>
        <span class="keyword">var</span> <span class="variable">url</span> = <span class="variable">parse</span>(<span class="variable">req</span>.<span class="variable">url</span>),
            <span class="variable">filename</span> = <span class="variable">path</span>.<span class="variable">join</span>(<span class="variable">root</span>, <span class="variable">url</span>.<span class="variable">pathname</span>),
            <span class="variable">mime</span> = <span class="variable">utils</span>.<span class="variable">mime</span>.<span class="variable">type</span>(<span class="variable">filename</span>).<span class="variable">split</span>(<span class="string">';'</span>)[<span class="number integer">0</span>];

        <span class="comment">// MIME type not white-listed</span>
        <span class="keyword">if</span> (!~<span class="variable">compress</span>.<span class="variable">indexOf</span>(<span class="variable">mime</span>)) <span class="keyword">return</span> <span class="variable">next</span>();

        <span class="comment">// Check if gzipped static is available</span>
        <span class="variable">gzipped</span>(<span class="variable">filename</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">path</span>, <span class="variable">ext</span>){
            <span class="keyword">if</span> (<span class="variable">err</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">err</span>.<span class="variable">errno</span> === <span class="variable">process</span>.<span class="class">ENOENT</span>) {
                <span class="variable">next</span>();
                <span class="comment">// We were looking for a gzipped static,</span>
                <span class="comment">// so lets gzip it!</span>
                <span class="keyword">if</span> (<span class="variable">err</span>.<span class="variable">path</span>.<span class="variable">indexOf</span>(<span class="string">'.gz'</span>) === <span class="variable">err</span>.<span class="variable">path</span>.<span class="variable">length</span> - <span class="number integer">3</span>) {
                    <span class="variable">gzip</span>(<span class="variable">filename</span>, <span class="variable">path</span>, <span class="variable">flags</span>, <span class="variable">bin</span>);
                }
            } <span class="keyword">else</span> <span class="keyword">if</span> (<span class="variable">err</span>) {
                <span class="variable">next</span>(<span class="variable">err</span>);
            } <span class="keyword">else</span> {
                <span class="comment">// Re-write the url to serve the gzipped static</span>
                <span class="variable">req</span>.<span class="variable">url</span> = <span class="variable">url</span>.<span class="variable">pathname</span> + <span class="variable">ext</span>;
                <span class="keyword">var</span> <span class="variable">writeHead</span> = <span class="variable">res</span>.<span class="variable">writeHead</span>;
                <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="keyword">function</span>(<span class="variable">status</span>, <span class="variable">headers</span>){
                    <span class="variable">headers</span> = <span class="variable">headers</span> || {};
                    <span class="variable">res</span>.<span class="variable">writeHead</span> = <span class="variable">writeHead</span>;
                    <span class="variable">headers</span>[<span class="string">'Content-Type'</span>] = <span class="variable">mime</span>;
                    <span class="variable">headers</span>[<span class="string">'Content-Encoding'</span>] = <span class="string">'gzip'</span>;
                    <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="variable">status</span>, <span class="variable">headers</span>);
                };
                <span class="variable">next</span>();
            }
        });
    }
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/staticProvider.js"><a href="#">staticProvider</a></h2></td><td>lib/connect/middleware/staticProvider.js</td></tr><tr class="code">
<td class="docs">
<p>Module dependencies.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">fs</span> = <span class="variable">require</span>(<span class="string">'fs'</span>),
    <span class="class">Path</span> = <span class="variable">require</span>(<span class="string">'path'</span>),
    <span class="variable">utils</span> = <span class="variable">require</span>(<span class="string">'../utils'</span>),
    <span class="class">Buffer</span> = <span class="variable">require</span>(<span class="string">'buffer'</span>).<span class="class">Buffer</span>,
    <span class="variable">parseUrl</span> = <span class="variable">require</span>(<span class="string">'url'</span>).<span class="variable">parse</span>,
    <span class="variable">queryString</span> = <span class="variable">require</span>(<span class="string">'querystring'</span>);</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Default browser cache maxAge of one year.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">const</span> <span class="class">MAX_AGE</span> = <span class="number integer">31557600000</span>;</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>File buffer cache.
 </p>
</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">_cache</span> = {};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Static file server.</p>

<h2>Options</h2>

<ul><li><code>root</code>     Root path from which to serve static files.</li><li><code>maxAge</code>   Browser cache maxAge in milliseconds</li><li><code>cache</code>    When true cache files in memory indefinitely,
           until invalidated by a conditional GET request.
           When given, maxAge will be derived from this value.</li></ul>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>Object</em>  options</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">staticProvider</span>(<span class="variable">options</span>){
    <span class="keyword">var</span> <span class="variable">cache</span>, <span class="variable">maxAge</span>, <span class="variable">root</span>;

    <span class="comment">// Support options object and root string</span>
    <span class="keyword">if</span> (<span class="keyword">typeof</span> <span class="variable">options</span> == <span class="string">'string'</span>) {
        <span class="variable">root</span> = <span class="variable">options</span>;
        <span class="variable">maxAge</span> = <span class="class">MAX_AGE</span>;
    } <span class="keyword">else</span> {
        <span class="variable">options</span> = <span class="variable">options</span> || {};
        <span class="variable">maxAge</span> = <span class="variable">options</span>.<span class="variable">maxAge</span>;
        <span class="variable">root</span> = <span class="variable">process</span>.<span class="variable">connectEnv</span>.<span class="variable">staticRoot</span> || <span class="variable">options</span>.<span class="variable">root</span> || <span class="variable">process</span>.<span class="variable">cwd</span>();
        <span class="variable">cache</span> = <span class="variable">options</span>.<span class="variable">cache</span>;
        <span class="keyword">if</span> (<span class="variable">cache</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; !<span class="variable">maxAge</span>) <span class="variable">maxAge</span> = <span class="variable">cache</span>;
        <span class="variable">maxAge</span> = <span class="variable">maxAge</span> || <span class="class">MAX_AGE</span>;
    }

    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">staticProvider</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>) {
        <span class="keyword">if</span> (<span class="variable">req</span>.<span class="variable">method</span> != <span class="string">'GET'</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; <span class="variable">req</span>.<span class="variable">method</span> != <span class="string">'HEAD'</span>) <span class="keyword">return</span> <span class="variable">next</span>();

        <span class="keyword">var</span> <span class="variable">hit</span>, 
            <span class="variable">head</span> = <span class="variable">req</span>.<span class="variable">method</span> == <span class="string">'HEAD'</span>,
            <span class="variable">filename</span>, <span class="variable">url</span> = <span class="variable">parseUrl</span>(<span class="variable">req</span>.<span class="variable">url</span>);

        <span class="comment">// Potentially malicious path</span>
        <span class="keyword">if</span> (~<span class="variable">url</span>.<span class="variable">pathname</span>.<span class="variable">indexOf</span>(<span class="string">'..'</span>)) {
            <span class="keyword">return</span> <span class="variable">forbidden</span>(<span class="variable">res</span>);
        }

        <span class="comment">// Absolute path</span>
        <span class="variable">filename</span> = <span class="class">Path</span>.<span class="variable">join</span>(<span class="variable">root</span>, <span class="variable">queryString</span>.<span class="variable">unescape</span>(<span class="variable">url</span>.<span class="variable">pathname</span>));

        <span class="comment">// Index.html support</span>
        <span class="keyword">if</span> (<span class="variable">filename</span>[<span class="variable">filename</span>.<span class="variable">length</span> - <span class="number integer">1</span>] === <span class="string">'/'</span>) {
            <span class="variable">filename</span> += &<span class="variable">quot</span>;<span class="variable">index</span>.<span class="variable">html</span>&<span class="variable">quot</span>;;
        }
        
        <span class="comment">// Cache hit</span>
        <span class="keyword">if</span> (<span class="variable">cache</span> &<span class="variable">amp</span>;&<span class="variable">amp</span>; !<span class="variable">conditionalGET</span>(<span class="variable">req</span>) &<span class="variable">amp</span>;&<span class="variable">amp</span>; (<span class="variable">hit</span> = <span class="variable">_cache</span>[<span class="variable">req</span>.<span class="variable">url</span>])) {
            <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">200</span>, <span class="variable">hit</span>.<span class="variable">headers</span>);
            <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">head</span> ? <span class="variable">undefined</span> : <span class="variable">hit</span>.<span class="variable">body</span>);
            <span class="keyword">return</span>;
        }

        <span class="variable">fs</span>.<span class="variable">stat</span>(<span class="variable">filename</span>, <span class="keyword">function</span>(<span class="variable">err</span>, <span class="variable">stat</span>){

            <span class="comment">// Pass through for missing files, thow error for other problems</span>
            <span class="keyword">if</span> (<span class="variable">err</span>) {
                <span class="keyword">return</span> <span class="variable">err</span>.<span class="variable">errno</span> === <span class="variable">process</span>.<span class="class">ENOENT</span>
                    ? <span class="variable">next</span>()
                    : <span class="variable">next</span>(<span class="variable">err</span>);
            } <span class="keyword">else</span> <span class="keyword">if</span> (<span class="variable">stat</span>.<span class="variable">isDirectory</span>()) {
                <span class="keyword">return</span> <span class="variable">next</span>();
            }

            <span class="comment">// Serve the file directly using buffers</span>
            <span class="keyword">function</span> <span class="variable">onRead</span>(<span class="variable">err</span>, <span class="variable">data</span>) {
                <span class="keyword">if</span> (<span class="variable">err</span>) <span class="keyword">return</span> <span class="variable">next</span>(<span class="variable">err</span>);

                <span class="comment">// Response headers</span>
                <span class="keyword">var</span> <span class="variable">headers</span> = {
                    &<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Type</span>&<span class="variable">quot</span>;: <span class="variable">utils</span>.<span class="variable">mime</span>.<span class="variable">type</span>(<span class="variable">filename</span>),
                    &<span class="variable">quot</span>;<span class="class">Content</span>-<span class="class">Length</span>&<span class="variable">quot</span>;: <span class="variable">stat</span>.<span class="variable">size</span>,
                    &<span class="variable">quot</span>;<span class="class">Last</span>-<span class="class">Modified</span>&<span class="variable">quot</span>;: <span class="variable">stat</span>.<span class="variable">mtime</span>.<span class="variable">toUTCString</span>(),
                    &<span class="variable">quot</span>;<span class="class">Cache</span>-<span class="class">Control</span>&<span class="variable">quot</span>;: &<span class="variable">quot</span>;<span class="variable">public</span> <span class="variable">max</span>-<span class="variable">age</span>=&<span class="variable">quot</span>; + (<span class="variable">maxAge</span> / <span class="number integer">1000</span>),
                    &<span class="variable">quot</span>;<span class="class">ETag</span>&<span class="variable">quot</span>;: <span class="variable">etag</span>(<span class="variable">stat</span>)
                };

                <span class="comment">// Conditional GET</span>
                <span class="keyword">if</span> (!<span class="variable">modified</span>(<span class="variable">req</span>, <span class="variable">headers</span>)) {
                    <span class="keyword">return</span> <span class="variable">notModified</span>(<span class="variable">res</span>, <span class="variable">headers</span>);
                }
                
                <span class="variable">res</span>.<span class="variable">writeHead</span>(<span class="number integer">200</span>, <span class="variable">headers</span>);
                <span class="variable">res</span>.<span class="variable">end</span>(<span class="variable">head</span> ? <span class="variable">undefined</span> : <span class="variable">data</span>);

                <span class="comment">// Cache support</span>
                <span class="keyword">if</span> (<span class="variable">cache</span>) {
                    <span class="variable">_cache</span>[<span class="variable">req</span>.<span class="variable">url</span>] = {
                        <span class="variable">headers</span>: <span class="variable">headers</span>,
                        <span class="variable">body</span>: <span class="variable">data</span>
                    };
                }
            }

            <span class="variable">fs</span>.<span class="variable">readFile</span>(<span class="variable">filename</span>, <span class="variable">onRead</span>);
        });
    };
};</code></pre>
</td>
</tr>
<tr class="code">
<td class="docs">
<p>Clear the memory cache for <code>key</code> or the entire store.</p>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  key</p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">clearCache</span> = <span class="keyword">function</span>(<span class="variable">key</span>){
    <span class="keyword">if</span> (<span class="variable">key</span>) {
        <span class="keyword">delete</span> <span class="variable">_cache</span>[<span class="variable">key</span>];
    } <span class="keyword">else</span> {
        <span class="variable">_cache</span> = {};
    }
};</code></pre>
</td>
</tr><tr class="filename"><td><h2 id="lib/connect/middleware/vhost.js"><a href="#">vhost</a></h2></td><td>lib/connect/middleware/vhost.js</td></tr><tr class="code">
<td class="docs">
<p>Setup vhost for the given <code>hostname</code> and <code>server</code>.</p>

<h2>Examples</h2>

<pre><code>connect.createServer(
  connect.vhost('foo.com',
     connect.createServer(...middleware...)
 ),
  connect.vhost('bar.com',
      connect.createServer(...middleware...)
  )
);</code></pre>

<h2></h2>

<ul><li><p><strong>param</strong>: <em>String</em>  hostname</p></li><li><p><strong>param</strong>: <em>Server</em>  server</p></li><li><p><strong>return</strong>: <em>Function</em> </p></li><li><p><strong>api</strong>: <em>public</em></p></li></ul>
</td>
<td class="code">
<pre><code><span class="variable">module</span>.<span class="variable">exports</span> = <span class="keyword">function</span> <span class="variable">vhost</span>(<span class="variable">hostname</span>, <span class="variable">server</span>){
    <span class="keyword">if</span> (!<span class="variable">hostname</span>) {
        <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'vhost hostname required'</span>);
    }
    <span class="keyword">if</span> (!<span class="variable">server</span>) {
        <span class="keyword">throw</span> <span class="keyword">new</span> <span class="class">Error</span>(<span class="string">'vhost server required'</span>);
    }
    <span class="keyword">return</span> <span class="keyword">function</span> <span class="variable">vhost</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>){
        <span class="keyword">if</span> (!<span class="variable">req</span>.<span class="variable">headers</span>.<span class="variable">host</span>) <span class="variable">next</span>();
        <span class="keyword">var</span> <span class="variable">host</span> = <span class="variable">req</span>.<span class="variable">headers</span>.<span class="variable">host</span>.<span class="variable">split</span>(<span class="string">':'</span>)[<span class="number integer">0</span>];
        <span class="keyword">if</span> (<span class="variable">host</span> === <span class="variable">hostname</span>) {
            <span class="variable">server</span>.<span class="variable">handle</span>(<span class="variable">req</span>, <span class="variable">res</span>, <span class="variable">next</span>);
        } <span class="keyword">else</span> {
            <span class="variable">next</span>();
        }
    };
};</code></pre>
</td>
</tr>	</body>
</html></tbody></table>