/usr/share/doc/libghc-happstack-server-doc/html/src/Happstack-Server-Routing.html is in libghc-happstack-server-doc 6.6.3-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 | <?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<!-- Generated by HsColour, http://code.haskell.org/~malcolm/hscolour/ -->
<title>src/Happstack/Server/Routing.hs</title>
<link type='text/css' rel='stylesheet' href='hscolour.css' />
</head>
<body>
<pre><a name="line-1"></a><span class='hs-comment'>{-# LANGUAGE FlexibleInstances, PatternGuards, ScopedTypeVariables, TypeSynonymInstances #-}</span>
<a name="line-2"></a><span class='hs-comment'>-- | Route an incoming 'Request' to a handler. For more in-depth documentation see this section of the Happstack Crash Course: <<a href="http://happstack.com/docs/crashcourse/RouteFilters.html">http://happstack.com/docs/crashcourse/RouteFilters.html</a>></span>
<a name="line-3"></a><span class='hs-keyword'>module</span> <span class='hs-conid'>Happstack</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Routing</span>
<a name="line-4"></a> <span class='hs-layout'>(</span> <span class='hs-comment'>-- * Route by scheme</span>
<a name="line-5"></a> <span class='hs-varid'>http</span>
<a name="line-6"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>https</span>
<a name="line-7"></a> <span class='hs-comment'>-- * Route by request method</span>
<a name="line-8"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>methodM</span>
<a name="line-9"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>methodOnly</span>
<a name="line-10"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>methodSP</span>
<a name="line-11"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>method</span>
<a name="line-12"></a> <span class='hs-layout'>,</span> <span class='hs-conid'>MatchMethod</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span>
<a name="line-13"></a> <span class='hs-comment'>-- * Route by pathInfo</span>
<a name="line-14"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>dir</span>
<a name="line-15"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>dirs</span>
<a name="line-16"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>nullDir</span>
<a name="line-17"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>trailingSlash</span>
<a name="line-18"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>anyPath</span>
<a name="line-19"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>path</span>
<a name="line-20"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>uriRest</span>
<a name="line-21"></a> <span class='hs-comment'>-- * Route by host</span>
<a name="line-22"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>host</span>
<a name="line-23"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>withHost</span>
<a name="line-24"></a> <span class='hs-comment'>-- * Route by (Request -> Bool)</span>
<a name="line-25"></a> <span class='hs-layout'>,</span> <span class='hs-varid'>guardRq</span>
<a name="line-26"></a> <span class='hs-layout'>)</span> <span class='hs-keyword'>where</span>
<a name="line-27"></a>
<a name="line-28"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Control</span><span class='hs-varop'>.</span><span class='hs-conid'>Monad</span> <span class='hs-layout'>(</span><span class='hs-conid'>MonadPlus</span><span class='hs-layout'>(</span><span class='hs-varid'>mzero</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>unless</span><span class='hs-layout'>)</span>
<a name="line-29"></a><span class='hs-keyword'>import</span> <span class='hs-keyword'>qualified</span> <span class='hs-conid'>Data</span><span class='hs-varop'>.</span><span class='hs-conid'>ByteString</span><span class='hs-varop'>.</span><span class='hs-conid'>Char8</span> <span class='hs-keyword'>as</span> <span class='hs-conid'>B</span>
<a name="line-30"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Happstack</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Monads</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span>
<a name="line-31"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>Happstack</span><span class='hs-varop'>.</span><span class='hs-conid'>Server</span><span class='hs-varop'>.</span><span class='hs-conid'>Types</span> <span class='hs-layout'>(</span><span class='hs-conid'>Request</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>Method</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-conid'>FromReqURI</span><span class='hs-layout'>(</span><span class='hs-keyglyph'>..</span><span class='hs-layout'>)</span><span class='hs-layout'>,</span> <span class='hs-varid'>getHeader</span><span class='hs-layout'>,</span> <span class='hs-varid'>rqURL</span><span class='hs-layout'>)</span>
<a name="line-32"></a><span class='hs-keyword'>import</span> <span class='hs-conid'>System</span><span class='hs-varop'>.</span><span class='hs-conid'>FilePath</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeRelative</span><span class='hs-layout'>,</span> <span class='hs-varid'>splitDirectories</span><span class='hs-layout'>)</span>
<a name="line-33"></a>
<a name="line-34"></a><a name="MatchMethod"></a><span class='hs-comment'>-- | instances of this class provide a variety of ways to match on the 'Request' method.</span>
<a name="line-35"></a><a name="MatchMethod"></a><span class='hs-comment'>--</span>
<a name="line-36"></a><a name="MatchMethod"></a><span class='hs-comment'>-- Examples</span>
<a name="line-37"></a><a name="MatchMethod"></a><span class='hs-comment'>-- </span>
<a name="line-38"></a><a name="MatchMethod"></a><span class='hs-comment'>-- > method GET -- match GET</span>
<a name="line-39"></a><a name="MatchMethod"></a><span class='hs-comment'>-- > method [HEAD, GET] -- match HEAD or GET</span>
<a name="line-40"></a><a name="MatchMethod"></a><span class='hs-comment'>-- > method (not . (==) DELETE) -- match any method except DELETE</span>
<a name="line-41"></a><a name="MatchMethod"></a><span class='hs-comment'>-- > method () -- match any method</span>
<a name="line-42"></a><a name="MatchMethod"></a><span class='hs-keyword'>class</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-varid'>m</span> <span class='hs-keyword'>where</span> <span class='hs-varid'>matchMethod</span> <span class='hs-keyglyph'>::</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Method</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span>
<a name="line-43"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-conid'>Method</span> <span class='hs-keyword'>where</span> <span class='hs-varid'>matchMethod</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>==</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span>
<a name="line-44"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-keyglyph'>[</span><span class='hs-conid'>Method</span><span class='hs-keyglyph'>]</span> <span class='hs-keyword'>where</span> <span class='hs-varid'>matchMethod</span> <span class='hs-varid'>methods</span> <span class='hs-keyglyph'>=</span> <span class='hs-layout'>(</span><span class='hs-varop'>`elem`</span> <span class='hs-varid'>methods</span><span class='hs-layout'>)</span>
<a name="line-45"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-layout'>(</span><span class='hs-conid'>Method</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span> <span class='hs-keyword'>where</span> <span class='hs-varid'>matchMethod</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>f</span>
<a name="line-46"></a><span class='hs-keyword'>instance</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-conid'>()</span> <span class='hs-keyword'>where</span> <span class='hs-varid'>matchMethod</span> <span class='hs-conid'>()</span> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>=</span> <span class='hs-conid'>True</span>
<a name="line-47"></a>
<a name="line-48"></a><span class='hs-comment'>-------------------------------------</span>
<a name="line-49"></a><span class='hs-comment'>-- guards</span>
<a name="line-50"></a>
<a name="line-51"></a><a name="guardRq"></a><span class='hs-comment'>-- | Guard using an arbitrary function on the 'Request'.</span>
<a name="line-52"></a><span class='hs-definition'>guardRq</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-conid'>Request</span> <span class='hs-keyglyph'>-></span> <span class='hs-conid'>Bool</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-53"></a><span class='hs-definition'>guardRq</span> <span class='hs-varid'>f</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-54"></a> <span class='hs-varid'>rq</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>askRq</span>
<a name="line-55"></a> <span class='hs-varid'>unless</span> <span class='hs-layout'>(</span><span class='hs-varid'>f</span> <span class='hs-varid'>rq</span><span class='hs-layout'>)</span> <span class='hs-varid'>mzero</span>
<a name="line-56"></a>
<a name="line-57"></a>
<a name="line-58"></a><a name="http"></a><span class='hs-comment'>-- | guard which checks that an insecure connection was made via http:\/\/</span>
<a name="line-59"></a><span class='hs-comment'>--</span>
<a name="line-60"></a><span class='hs-comment'>-- Example:</span>
<a name="line-61"></a><span class='hs-comment'>--</span>
<a name="line-62"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-63"></a><span class='hs-comment'>-- > handler =</span>
<a name="line-64"></a><span class='hs-comment'>-- > do https</span>
<a name="line-65"></a><span class='hs-comment'>-- > ...</span>
<a name="line-66"></a><span class='hs-definition'>http</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-67"></a><span class='hs-definition'>http</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>guardRq</span> <span class='hs-layout'>(</span><span class='hs-varid'>not</span> <span class='hs-varop'>.</span> <span class='hs-varid'>rqSecure</span><span class='hs-layout'>)</span>
<a name="line-68"></a>
<a name="line-69"></a>
<a name="line-70"></a><a name="https"></a><span class='hs-comment'>-- | guard which checks that a secure connection was made via https:\/\/</span>
<a name="line-71"></a><span class='hs-comment'>--</span>
<a name="line-72"></a><span class='hs-comment'>-- Example:</span>
<a name="line-73"></a><span class='hs-comment'>--</span>
<a name="line-74"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-75"></a><span class='hs-comment'>-- > handler =</span>
<a name="line-76"></a><span class='hs-comment'>-- > do https</span>
<a name="line-77"></a><span class='hs-comment'>-- > ...</span>
<a name="line-78"></a><span class='hs-definition'>https</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-79"></a><span class='hs-definition'>https</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>guardRq</span> <span class='hs-varid'>rqSecure</span>
<a name="line-80"></a>
<a name="line-81"></a>
<a name="line-82"></a><a name="method"></a><span class='hs-comment'>-- | Guard against the method only (as opposed to 'methodM').</span>
<a name="line-83"></a><span class='hs-comment'>--</span>
<a name="line-84"></a><span class='hs-comment'>-- Example:</span>
<a name="line-85"></a><span class='hs-comment'>--</span>
<a name="line-86"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-87"></a><span class='hs-comment'>-- > handler =</span>
<a name="line-88"></a><span class='hs-comment'>-- > do methodOnly [GET, HEAD]</span>
<a name="line-89"></a><span class='hs-comment'>-- > ...</span>
<a name="line-90"></a><span class='hs-definition'>method</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-varid'>method</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>method</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-91"></a><span class='hs-definition'>method</span> <span class='hs-varid'>meth</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>guardRq</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>rq</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>matchMethod</span> <span class='hs-varid'>meth</span> <span class='hs-layout'>(</span><span class='hs-varid'>rqMethod</span> <span class='hs-varid'>rq</span><span class='hs-layout'>)</span>
<a name="line-92"></a>
<a name="line-93"></a><a name="methodM"></a><span class='hs-comment'>-- | Guard against the method. This function also guards against</span>
<a name="line-94"></a><span class='hs-comment'>-- *any remaining path segments*. See 'method' for the version</span>
<a name="line-95"></a><span class='hs-comment'>-- that guards only by method.</span>
<a name="line-96"></a><span class='hs-comment'>--</span>
<a name="line-97"></a><span class='hs-comment'>-- Example:</span>
<a name="line-98"></a><span class='hs-comment'>--</span>
<a name="line-99"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-100"></a><span class='hs-comment'>-- > handler =</span>
<a name="line-101"></a><span class='hs-comment'>-- > do methodM [GET, HEAD]</span>
<a name="line-102"></a><span class='hs-comment'>-- > ...</span>
<a name="line-103"></a><span class='hs-comment'>-- </span>
<a name="line-104"></a><span class='hs-comment'>-- NOTE: This function is largely retained for backwards</span>
<a name="line-105"></a><span class='hs-comment'>-- compatibility. The fact that implicitly calls 'nullDir' is often</span>
<a name="line-106"></a><span class='hs-comment'>-- forgotten and leads to confusion. It is probably better to just use</span>
<a name="line-107"></a><span class='hs-comment'>-- 'method' and call 'nullDir' explicitly.</span>
<a name="line-108"></a><span class='hs-comment'>-- </span>
<a name="line-109"></a><span class='hs-comment'>-- This function will likely be deprecated in the future.</span>
<a name="line-110"></a><span class='hs-definition'>methodM</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-varid'>method</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>method</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-111"></a><span class='hs-definition'>methodM</span> <span class='hs-varid'>meth</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>methodOnly</span> <span class='hs-varid'>meth</span> <span class='hs-varop'>>></span> <span class='hs-varid'>nullDir</span>
<a name="line-112"></a>
<a name="line-113"></a><a name="methodOnly"></a><span class='hs-comment'>-- | Guard against the method only (as opposed to 'methodM').</span>
<a name="line-114"></a><span class='hs-comment'>--</span>
<a name="line-115"></a><span class='hs-comment'>-- Example:</span>
<a name="line-116"></a><span class='hs-comment'>--</span>
<a name="line-117"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-118"></a><span class='hs-comment'>-- > handler =</span>
<a name="line-119"></a><span class='hs-comment'>-- > do methodOnly [GET, HEAD]</span>
<a name="line-120"></a><span class='hs-comment'>-- > ...</span>
<a name="line-121"></a><span class='hs-definition'>methodOnly</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-varid'>method</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>method</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-122"></a><span class='hs-definition'>methodOnly</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>method</span>
<a name="line-123"></a><span class='hs-comment'>{-# DEPRECATED methodOnly "this function is just an alias for method now" #-}</span>
<a name="line-124"></a>
<a name="line-125"></a><a name="methodSP"></a><span class='hs-comment'>-- | Guard against the method. Note, this function also guards against</span>
<a name="line-126"></a><span class='hs-comment'>-- any remaining path segments. Similar to 'methodM' but with a different type signature.</span>
<a name="line-127"></a><span class='hs-comment'>--</span>
<a name="line-128"></a><span class='hs-comment'>-- Example:</span>
<a name="line-129"></a><span class='hs-comment'>--</span>
<a name="line-130"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-131"></a><span class='hs-comment'>-- > handler = methodSP [GET, HEAD] $ subHandler</span>
<a name="line-132"></a><span class='hs-comment'>-- </span>
<a name="line-133"></a><span class='hs-comment'>-- NOTE: This style of combinator is going to be deprecated in the</span>
<a name="line-134"></a><span class='hs-comment'>-- future. It is better to just use 'method'.</span>
<a name="line-135"></a><span class='hs-comment'>--</span>
<a name="line-136"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-137"></a><span class='hs-comment'>-- > handler = method [GET, HEAD] >> nullDir >> subHandler</span>
<a name="line-138"></a><span class='hs-comment'>{-# DEPRECATED methodSP "use method instead." #-}</span>
<a name="line-139"></a><span class='hs-definition'>methodSP</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MatchMethod</span> <span class='hs-varid'>method</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>method</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span><span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span>
<a name="line-140"></a><span class='hs-definition'>methodSP</span> <span class='hs-varid'>m</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>methodM</span> <span class='hs-varid'>m</span> <span class='hs-varop'>>></span> <span class='hs-varid'>handle</span>
<a name="line-141"></a>
<a name="line-142"></a><a name="nullDir"></a><span class='hs-comment'>-- | guard which only succeeds if there are no remaining path segments</span>
<a name="line-143"></a><span class='hs-comment'>--</span>
<a name="line-144"></a><span class='hs-comment'>-- Often used if you want to explicitly assign a route for '/'</span>
<a name="line-145"></a><span class='hs-comment'>-- </span>
<a name="line-146"></a><span class='hs-definition'>nullDir</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-147"></a><span class='hs-definition'>nullDir</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>guardRq</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>rq</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>null</span> <span class='hs-layout'>(</span><span class='hs-varid'>rqPaths</span> <span class='hs-varid'>rq</span><span class='hs-layout'>)</span>
<a name="line-148"></a>
<a name="line-149"></a><a name="dir"></a><span class='hs-comment'>-- | Pop a path element and run the supplied handler if it matches the</span>
<a name="line-150"></a><span class='hs-comment'>-- given string.</span>
<a name="line-151"></a><span class='hs-comment'>-- </span>
<a name="line-152"></a><span class='hs-comment'>-- > handler :: ServerPart Response</span>
<a name="line-153"></a><span class='hs-comment'>-- > handler = dir "foo" $ dir "bar" $ subHandler</span>
<a name="line-154"></a><span class='hs-comment'>-- </span>
<a name="line-155"></a><span class='hs-comment'>-- The path element can not contain \'/\'. See also 'dirs'.</span>
<a name="line-156"></a><span class='hs-definition'>dir</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-157"></a><span class='hs-definition'>dir</span> <span class='hs-varid'>staticPath</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span>
<a name="line-158"></a> <span class='hs-keyword'>do</span>
<a name="line-159"></a> <span class='hs-varid'>rq</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>askRq</span>
<a name="line-160"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>rqPaths</span> <span class='hs-varid'>rq</span> <span class='hs-keyword'>of</span>
<a name="line-161"></a> <span class='hs-layout'>(</span><span class='hs-varid'>p</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>p</span> <span class='hs-varop'>==</span> <span class='hs-varid'>staticPath</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>localRq</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>newRq</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>newRq</span><span class='hs-layout'>{</span><span class='hs-varid'>rqPaths</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>xs</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-varid'>handle</span>
<a name="line-162"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>mzero</span>
<a name="line-163"></a>
<a name="line-164"></a><a name="dirs"></a><span class='hs-comment'>-- | Guard against a 'FilePath'. Unlike 'dir' the 'FilePath' may</span>
<a name="line-165"></a><span class='hs-comment'>-- contain \'/\'. If the guard succeeds, the matched elements will be</span>
<a name="line-166"></a><span class='hs-comment'>-- popped from the directory stack.</span>
<a name="line-167"></a><span class='hs-comment'>--</span>
<a name="line-168"></a><span class='hs-comment'>-- > dirs "foo/bar" $ ...</span>
<a name="line-169"></a><span class='hs-comment'>-- </span>
<a name="line-170"></a><span class='hs-comment'>-- See also: 'dir'.</span>
<a name="line-171"></a><span class='hs-definition'>dirs</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>FilePath</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-172"></a><span class='hs-definition'>dirs</span> <span class='hs-varid'>fp</span> <span class='hs-varid'>m</span> <span class='hs-keyglyph'>=</span>
<a name="line-173"></a> <span class='hs-keyword'>do</span> <span class='hs-keyword'>let</span> <span class='hs-varid'>parts</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>splitDirectories</span> <span class='hs-layout'>(</span><span class='hs-varid'>makeRelative</span> <span class='hs-str'>"/"</span> <span class='hs-varid'>fp</span><span class='hs-layout'>)</span>
<a name="line-174"></a> <span class='hs-varid'>foldr</span> <span class='hs-varid'>dir</span> <span class='hs-varid'>m</span> <span class='hs-varid'>parts</span>
<a name="line-175"></a>
<a name="line-176"></a><a name="host"></a><span class='hs-comment'>-- | Guard against the host.</span>
<a name="line-177"></a><span class='hs-comment'>--</span>
<a name="line-178"></a><span class='hs-comment'>-- This matches against the @host@ header specified in the incoming 'Request'.</span>
<a name="line-179"></a><span class='hs-comment'>--</span>
<a name="line-180"></a><span class='hs-comment'>-- Can be used to support virtual hosting, <<a href="http://en.wikipedia.org/wiki/Virtual_hosting">http://en.wikipedia.org/wiki/Virtual_hosting</a>></span>
<a name="line-181"></a><span class='hs-comment'>-- </span>
<a name="line-182"></a><span class='hs-comment'>-- see also: 'withHost'</span>
<a name="line-183"></a><span class='hs-definition'>host</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-184"></a><span class='hs-definition'>host</span> <span class='hs-varid'>desiredHost</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span>
<a name="line-185"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>rq</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>askRq</span>
<a name="line-186"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>getHeader</span> <span class='hs-str'>"host"</span> <span class='hs-varid'>rq</span> <span class='hs-keyword'>of</span>
<a name="line-187"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>hostBS</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-varid'>desiredHost</span> <span class='hs-varop'>==</span> <span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span> <span class='hs-varid'>hostBS</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>handle</span>
<a name="line-188"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>mzero</span>
<a name="line-189"></a>
<a name="line-190"></a><a name="withHost"></a><span class='hs-comment'>-- | Lookup the @host@ header in the incoming request and pass it to the handler.</span>
<a name="line-191"></a><span class='hs-comment'>--</span>
<a name="line-192"></a><span class='hs-comment'>-- see also: 'host'</span>
<a name="line-193"></a><span class='hs-definition'>withHost</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-194"></a><span class='hs-definition'>withHost</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span>
<a name="line-195"></a> <span class='hs-keyword'>do</span> <span class='hs-varid'>rq</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>askRq</span>
<a name="line-196"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>getHeader</span> <span class='hs-str'>"host"</span> <span class='hs-varid'>rq</span> <span class='hs-keyword'>of</span>
<a name="line-197"></a> <span class='hs-layout'>(</span><span class='hs-conid'>Just</span> <span class='hs-varid'>hostBS</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>handle</span> <span class='hs-layout'>(</span><span class='hs-conid'>B</span><span class='hs-varop'>.</span><span class='hs-varid'>unpack</span> <span class='hs-varid'>hostBS</span><span class='hs-layout'>)</span>
<a name="line-198"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>mzero</span>
<a name="line-199"></a>
<a name="line-200"></a>
<a name="line-201"></a><a name="path"></a><span class='hs-comment'>-- | Pop a path element and parse it using the 'fromReqURI' in the</span>
<a name="line-202"></a><span class='hs-comment'>-- 'FromReqURI' class.</span>
<a name="line-203"></a><span class='hs-definition'>path</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>FromReqURI</span> <span class='hs-varid'>a</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-varid'>a</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>b</span>
<a name="line-204"></a><span class='hs-definition'>path</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span> <span class='hs-keyword'>do</span>
<a name="line-205"></a> <span class='hs-varid'>rq</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>askRq</span>
<a name="line-206"></a> <span class='hs-keyword'>case</span> <span class='hs-varid'>rqPaths</span> <span class='hs-varid'>rq</span> <span class='hs-keyword'>of</span>
<a name="line-207"></a> <span class='hs-layout'>(</span><span class='hs-varid'>p</span><span class='hs-conop'>:</span><span class='hs-varid'>xs</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>|</span> <span class='hs-conid'>Just</span> <span class='hs-varid'>a</span> <span class='hs-keyglyph'><-</span> <span class='hs-varid'>fromReqURI</span> <span class='hs-varid'>p</span>
<a name="line-208"></a> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>localRq</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-varid'>newRq</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>newRq</span><span class='hs-layout'>{</span><span class='hs-varid'>rqPaths</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>xs</span><span class='hs-layout'>}</span><span class='hs-layout'>)</span> <span class='hs-layout'>(</span><span class='hs-varid'>handle</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span>
<a name="line-209"></a> <span class='hs-keyword'>_</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>mzero</span>
<a name="line-210"></a>
<a name="line-211"></a><a name="uriRest"></a><span class='hs-comment'>-- | Grab the rest of the URL (dirs + query) and passes it to your</span>
<a name="line-212"></a><span class='hs-comment'>-- handler.</span>
<a name="line-213"></a><span class='hs-definition'>uriRest</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-layout'>(</span><span class='hs-conid'>String</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>a</span>
<a name="line-214"></a><span class='hs-definition'>uriRest</span> <span class='hs-varid'>handle</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>askRq</span> <span class='hs-varop'>>>=</span> <span class='hs-varid'>handle</span> <span class='hs-varop'>.</span> <span class='hs-varid'>rqURL</span>
<a name="line-215"></a>
<a name="line-216"></a><a name="anyPath"></a><span class='hs-comment'>-- | Pop any path element and run the handler.</span>
<a name="line-217"></a><span class='hs-comment'>-- </span>
<a name="line-218"></a><span class='hs-comment'>-- Succeeds if a path component was popped. Fails is the remaining path was empty.</span>
<a name="line-219"></a><span class='hs-definition'>anyPath</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>m</span> <span class='hs-varid'>r</span>
<a name="line-220"></a><span class='hs-definition'>anyPath</span> <span class='hs-varid'>x</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>path</span> <span class='hs-varop'>$</span> <span class='hs-layout'>(</span><span class='hs-keyglyph'>\</span><span class='hs-layout'>(</span><span class='hs-keyword'>_</span><span class='hs-keyglyph'>::</span><span class='hs-conid'>String</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>-></span> <span class='hs-varid'>x</span><span class='hs-layout'>)</span>
<a name="line-221"></a>
<a name="line-222"></a><a name="trailingSlash"></a><span class='hs-comment'>-- | Guard which checks that the Request URI ends in @\'\/\'@. Useful</span>
<a name="line-223"></a><span class='hs-comment'>-- for distinguishing between @foo@ and @foo/@</span>
<a name="line-224"></a><span class='hs-definition'>trailingSlash</span> <span class='hs-keyglyph'>::</span> <span class='hs-layout'>(</span><span class='hs-conid'>ServerMonad</span> <span class='hs-varid'>m</span><span class='hs-layout'>,</span> <span class='hs-conid'>MonadPlus</span> <span class='hs-varid'>m</span><span class='hs-layout'>)</span> <span class='hs-keyglyph'>=></span> <span class='hs-varid'>m</span> <span class='hs-conid'>()</span>
<a name="line-225"></a><span class='hs-definition'>trailingSlash</span> <span class='hs-keyglyph'>=</span> <span class='hs-varid'>guardRq</span> <span class='hs-varop'>$</span> <span class='hs-keyglyph'>\</span><span class='hs-varid'>rq</span> <span class='hs-keyglyph'>-></span> <span class='hs-layout'>(</span><span class='hs-varid'>last</span> <span class='hs-layout'>(</span><span class='hs-varid'>rqUri</span> <span class='hs-varid'>rq</span><span class='hs-layout'>)</span><span class='hs-layout'>)</span> <span class='hs-varop'>==</span> <span class='hs-chr'>'/'</span>
</pre></body>
</html>
|