git.iko.soy/typeable/wai
on master help sign in
swap
e083f6e3263 ahead, 0 behind
.azure/azure-linux-template.ymlnew file+93
since splitsnapshots
unifiedsplit
@@ -0,0 +1,93 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-11:
9+ BUILD: stack
10+ STACK_YAML: stack-lts-11.yaml
11+ ARGS: "--resolver lts-11"
12+ stack-lts-12:
13+ BUILD: stack
14+ STACK_YAML: stack-lts-12.yaml
15+ ARGS: "--resolver lts-12"
16+ stack-lts-14:
17+ BUILD: stack
18+ ARGS: "--resolver lts-14"
19+ stack-nightly:
20+ BUILD: stack
21+ STACK_YAML: stack-nightly.yaml
22+ ARGS: "--resolver nightly"
23+ cabal-8.2.2:
24+ BUILD: cabal
25+ GHCVER: 8.4.4
26+ CABALVER: 2.0
27+ cabal-8.4.4:
28+ BUILD: cabal
29+ GHCVER: 8.4.4
30+ CABALVER: 2.2
31+ cabal-8.6.5:
32+ BUILD: cabal
33+ GHCVER: 8.6.5
34+ CABALVER: 2.4
35+ maxParallel: 6
36+ steps:
37+ - script: |
38+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
39+ mkdir -p ~/.local/bin
40+ curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
41+ case "$BUILD" in
42+ cabal)
43+ sudo add-apt-repository -y ppa:hvr/ghc
44+ sudo apt-get update
45+ sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER
46+ # See note here: https://github.com/haskell-CI/haskell-ci#alex--happy-with-ghc--78
47+ if [ "$GHCVER" = "head" ] || [ "${GHCVER%.*}" = "7.8" ] || [ "${GHCVER%.*}" = "7.10" ]; then
48+ sudo apt-get install happy-1.19.4 alex-3.1.3
49+ export PATH=/opt/alex/3.1.3/bin:/opt/happy/1.19.4/bin:$PATH
50+ else
51+ sudo apt-get install happy alex
52+ fi
53+ export PATH=$HOME/.local/bin:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
54+ cabal --version
55+ cabal update
56+ PACKAGES=$(stack --install-ghc query locals | grep '^ *path' | sed 's@^ *path:@@')
57+ cabal install --only-dependencies --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
58+ ;;
59+ *)
60+ export PATH=$HOME/.local/bin:$PATH
61+ stack --install-ghc $ARGS test --bench --only-dependencies
62+ ;;
63+ esac
64+ set -ex
65+ case "$BUILD" in
66+ cabal)
67+ cabal install --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
68+
69+ ORIGDIR=$(pwd)
70+ for dir in $PACKAGES
71+ do
72+ cd $dir
73+ cabal check || [ "$CABALVER" == "1.22" ] # https://github.com/yesodweb/wai/pull/754#issuecomment-504866279
74+ cabal sdist
75+ PKGVER=$(cabal info . | awk '{print $2;exit}')
76+ SRC_TGZ=$PKGVER.tar.gz
77+ cd dist
78+ tar zxfv "$SRC_TGZ"
79+ cd "$PKGVER"
80+ cabal configure --enable-tests --ghc-options -O0
81+ cabal build
82+ cabal test --show-details=streaming
83+ cd $ORIGDIR
84+ done
85+ ;;
86+ *)
87+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
88+ ;;
89+ esac
90+ set +ex
91+ env:
92+ OS_NAME: ${{ parameters.os }}
93+ displayName: 'Installation ${{parameters.os}} & Test'
.azure/azure-osx-template.ymlnew file+30
@@ -0,0 +1,30 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-11:
9+ BUILD: stack
10+ STACK_YAML: stack-lts-11.yaml
11+ ARGS: "--resolver lts-11"
12+ stack-lts-12:
13+ BUILD: stack
14+ STACK_YAML: stack-lts-12.yaml
15+ ARGS: "--resolver lts-12"
16+ stack-lts-14:
17+ BUILD: stack
18+ ARGS: "--resolver lts-14"
19+ maxParallel: 3
20+ steps:
21+ - script: |
22+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
23+ mkdir -p ~/.local/bin
24+ curl -skL https://get.haskellstack.org/stable/osx-x86_64.tar.gz | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin;
25+ export PATH=$HOME/.local/bin:$PATH
26+ stack --install-ghc $ARGS test --bench --only-dependencies
27+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
28+ env:
29+ OS_NAME: ${{ parameters.os }}
30+ displayName: 'Installation ${{parameters.os}} & Test'
.azure/azure-pipelines.ymlnew file+30
@@ -0,0 +1,30 @@
1+# This is the complex Azure configuration, which is intended for use
2+# on open source libraries which need compatibility across multiple GHC
3+# versions, must work with cabal-install, and should be
4+# cross-platform. For more information and other options, see:
5+#
6+# https://docs.haskellstack.org/en/stable/azure_ci/
7+#
8+# Copy these contents into the root directory of your Github project in a file
9+# named azure-pipelines.yml
10+#
11+# For better organization, you split various jobs into seprate parts
12+# and each of them are controlled via individual file.
13+jobs:
14+- template: azure-linux-template.yml
15+ parameters:
16+ name: Linux
17+ vmImage: ubuntu-16.04
18+ os: linux
19+
20+- template: azure-osx-template.yml
21+ parameters:
22+ name: macOS
23+ vmImage: macOS-10.13
24+ os: osx
25+
26+- template: azure-windows-template.yml
27+ parameters:
28+ name: Windows
29+ vmImage: vs2017-win2016
30+ os: windows
.azure/azure-windows-template.ymlnew file+23
@@ -0,0 +1,23 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-14:
9+ BUILD: stack
10+ ARGS: "--resolver lts-14"
11+ maxParallel: 3
12+ steps:
13+ - bash: |
14+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
15+ curl -sSkL http://www.stackage.org/stack/windows-x86_64 -o /usr/bin/stack.zip
16+ unzip -o /usr/bin/stack.zip -d /usr/bin/
17+ stack setup $ARGS > /dev/null
18+ stack --install-ghc $ARGS test --bench --only-dependencies
19+ stack $ARGS test --bench --no-run-benchmarks --no-run-tests
20+ stack $ARGS test --bench --no-run-benchmarks --jobs 1 # non-parallel test execution
21+ env:
22+ OS_NAME: ${{ parameters.os }}
23+ displayName: 'Installation ${{parameters.os}} & Test'
.github/ISSUE_TEMPLATE.mdnew file+28
@@ -0,0 +1,28 @@
1+<!---
2+
3+### Bug Reports
4+
5+Reporting a bug? If relevant, we recommend including:
6+
7+* Your OS name and version
8+* The versions of tools you're using (e.g. `stack`, `ghc`).
9+* The versions of dependencies you're using
10+
11+For your convenience, we recommend pasting this script into bash and uploading the output [as a gist](https://gist.github.com/).
12+
13+```
14+command -v sw_vers && sw_vers # OS X only
15+command -v uname && uname -a # Kernel version
16+command -v stack && stack --version
17+command -v stack && stack ghc -- --version
18+command -v stack && stack list-dependencies
19+```
20+
21+* Also, is there anything custom or unusual about your setup? i.e. new or prerelease versions of GHC, Stack, etc.
22+
23+* Finally, if possible, please reproduce the error in a small script, or if necessary create a new Github repo with the smallest possible reproducing case. [Stack's scripting support](https://docs.haskellstack.org/en/stable/GUIDE/#script-interpreter) might be useful for creating your reproduction example.
24+
25+### Support
26+
27+Please direct support questions to [Stack Overflow](https://stackoverflow.com/questions/tagged/yesod+haskell) or the [Yesod Google Group](https://groups.google.com/forum/#!forum/yesodweb). If you don't get a response there, or you suspect there may be a bug in Wai causing your problem, you're welcome to ask here.
28+-->
.github/PULL_REQUEST_TEMPLATE.mdnew file+14
@@ -0,0 +1,14 @@
1+Before submitting your PR, check that you've:
2+
3+- [ ] Bumped the version number
4+- [ ] Documented new APIs with [Haddock markup](https://www.haskell.org/haddock/doc/html/index.html)
5+- [ ] Added [`@since` declarations](http://haskell-haddock.readthedocs.io/en/latest/markup.html#since) to the Haddock
6+
7+After submitting your PR:
8+
9+- [ ] Update the Changelog.md file with a link to your PR
10+- [ ] Check that CI passes (or if it fails, for reasons unrelated to your change, like CI timeouts)
11+
12+<!---Thanks so much for contributing! :)
13+
14+_If these checkboxes don't apply to your PR, you can delete them_-->
.gitignore+11−1
@@ -1,2 +1,12 @@
1+dist/
1*.swp
2*.swp
2−dist
3+*.hi
4+*.o
5+tarballs/
6+/.hsenv
7+/.shelly
8+.cabal-sandbox/
9+cabal.sandbox.config
10+.stack-work/
11+*~
12+stack*.yaml.lock
CONTRIBUTING.mdnew file+94
@@ -0,0 +1,94 @@
1+# Contributing
2+
3+Thanks for your interest in contributing to Wai! This file has some tips for developing Wai and getting a pull request accepted.
4+
5+## Development
6+
7+Wai is a mega-repo that contains many Haskell packages, each in a different directory. All the subprojects can be developed with Stack, using `stack <command> <subproject>`, e.g.
8+
9+* `stack build mime-types`
10+* `stack test auto-update`
11+* `stack haddock warp`
12+
13+If you'd like to test your changes in a full-fledged Wai app, you can use Stack to build against it, e.g.:
14+
15+```
16+packages:
17+- '/path/to/this/repo/wai'
18+```
19+
20+## Coding Guidelines
21+
22+### Safety
23+
24+Avoid partial functions. Even if you know the partial function is safe in your instance, partial functions require more reasoning from the programmer and are not resilient to refactoring. For the rare cases where a partial function is appropriate, a custom `error` should be used.
25+
26+### Style
27+
28+Keep coding style consistent with the rest of the file, but don't worry about style too much otherwise. PRs changing code style are viewed skeptically.
29+
30+### Dependencies
31+
32+Avoid adding unnecessary dependencies. If a dependency provides only a minor convenience for your implementation, it's probably better to skip it.
33+
34+If you do add a new dependency, try to support a wide range of versions of it.
35+
36+### Backwards Compatibility
37+
38+Backwards incompatible changes are viewed skeptically—best to ask in an issue to see if a particular backwards incompatible change would be approved. If possible keep backwards compatibility by adding new APIs and deprecating old ones.
39+
40+Keep backwards compatibility with old versions of dependencies when possible.
41+
42+## PR Guidelines
43+
44+### PR Scope
45+
46+As much as possible, keep separate changes in separate PRs.
47+
48+### Testing
49+
50+Tests are recommended, but not required.
51+
52+### Documentation
53+
54+All public APIs must be documented. Documenting private functions is optional, but may be nice depending on their complexity. Example documentation:
55+
56+```
57+-- | Generate an action which will either read from an automatically
58+-- updated value, or run the update action in the current thread.
59+--
60+-- ==== __Examples__
61+--
62+-- > getTime <- mkAutoUpdate defaultUpdateSettings
63+--
64+-- @since 0.1.0
65+mkAutoUpdate :: UpdateSettings a -> IO (IO a)
66+```
67+
68+Examples are recommended, but not required, in documentation. Marking new APIs with `@since <version number>` is required.
69+
70+### Versioning
71+
72+Wai packages roughly follow the Haskell Package Versioning Policy style of A.B.C.[D] (MAJOR.MAJOR.MINOR.[PATCH])
73+
74+* A - Used for massive changes in the library. (Example: 1.2.3.4 becomes 2.0.0)
75+* B - Used for smaller breaking changes, like removing, renaming, or changing behavior of existing public API. (Example: 1.2.3.4 becomes 1.3.0)
76+* C - Used for new public APIs (Example: 1.2.3.4 becomes 1.2.4)
77+* D - Used for bug fixes (Example: 1.2.3.4 becomes 1.2.3.5).
78+ * D is optional in the version number, so 2.0.0 is a valid version.
79+
80+Documentation changes don't require a new version.
81+
82+If you feel there is ambiguity to a change (e.g. fixing a bug in a function, when people may be relying on the old broken behavior), you can ask in an issue or pull request.
83+
84+Unlike in the Package Versioning Policy, deprecations are not counted as MAJOR changes.
85+
86+In some cases, dropping compatibility with a major version of a dependency (e.g. changing from transformers >= 0.3 to transformers >= 0.4), is considered a breaking change.
87+
88+### Changelog
89+
90+After you submit a PR, update the subproject's Changelog.md file with the new version number and a link to your PR. If your PR does not need to bump the version number, include the change in an "Unreleased" section at the top.
91+
92+### Releases
93+
94+Releases should be done as soon as possible after a pull request is merged—don't be shy about reminding us to make a release if we forget.
LICENSE+17−22
@@ -1,25 +1,20 @@
1−The following license covers this documentation, and the source code, except
1+Copyright (c) 2012-2017 Michael Snoyman, http://www.yesodweb.com/
2−where otherwise indicated.
3
2
4−Copyright 2010, Michael Snoyman. All rights reserved.
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
5
10
6−Redistribution and use in source and binary forms, with or without
11+The above copyright notice and this permission notice shall be
7−modification, are permitted provided that the following conditions are met:
12+included in all copies or substantial portions of the Software.
8
13
9−* Redistributions of source code must retain the above copyright notice, this
10− list of conditions and the following disclaimer.
11−
12−* Redistributions in binary form must reproduce the above copyright notice,
13− this list of conditions and the following disclaimer in the documentation
14− and/or other materials provided with the distribution.
15−
16−THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS "AS IS" AND ANY EXPRESS OR
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
17−IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
18−MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19−EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY DIRECT, INDIRECT,
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20−INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21−NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA,
22−OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23−LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
24−OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
25−ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Network/Wai/Handler/CGI.hsdeleted−168
@@ -1,168 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
3−module Network.Wai.Handler.CGI
4− ( run
5− , run'
6− , run''
7− , runSendfile
8− ) where
9−
10−import Network.Wai
11−import System.Environment (getEnvironment)
12−import Data.Maybe (fromMaybe)
13−import qualified Data.ByteString.Char8 as B
14−import qualified Data.ByteString.Lazy as L
15−import Control.Arrow ((***))
16−import Data.Char (toLower)
17−import qualified System.IO
18−import qualified Data.String as String
19−import Data.Enumerator
20− ( Enumerator, Step (..), Stream (..), continue, yield
21− , enumList, ($$), joinI, returnI, (>>==), run_
22− )
23−import Data.Monoid (mconcat)
24−import Blaze.ByteString.Builder (fromByteString, toLazyByteString)
25−import Blaze.ByteString.Builder.Char8 (fromChar, fromString)
26−import Blaze.ByteString.Builder.Enumerator (builderToByteString)
27−import Control.Monad.IO.Class (liftIO)
28−import Data.ByteString.Lazy.Internal (defaultChunkSize)
29−import System.IO (Handle)
30−
31−safeRead :: Read a => a -> String -> a
32−safeRead d s =
33− case reads s of
34− ((x, _):_) -> x
35− [] -> d
36−
37−lookup' :: String -> [(String, String)] -> String
38−lookup' key pairs = fromMaybe "" $ lookup key pairs
39−
40−run :: Application -> IO ()
41−run app = do
42− vars <- getEnvironment
43− let input = requestBodyHandle System.IO.stdin
44− output = B.hPut System.IO.stdout
45− run'' vars input output Nothing app
46−
47−runSendfile :: B.ByteString -- ^ sendfile header
48− -> Application -> IO ()
49−runSendfile sf app = do
50− vars <- getEnvironment
51− let input = requestBodyHandle System.IO.stdin
52− output = B.hPut System.IO.stdout
53− run'' vars input output (Just sf) app
54−
55−run' :: [(String, String)] -- ^ all variables
56− -> System.IO.Handle -- ^ responseBody of input
57− -> System.IO.Handle -- ^ destination for output
58− -> Application
59− -> IO ()
60−run' vars inputH outputH app = do
61− let input = requestBodyHandle inputH
62− output = B.hPut outputH
63− run'' vars input output Nothing app
64−
65−run'' :: [(String, String)] -- ^ all variables
66− -> (forall a. Int -> Enumerator B.ByteString IO a) -- ^ responseBody of input
67− -> (B.ByteString -> IO ()) -- ^ destination for output FIXME use an iteratee
68− -> Maybe B.ByteString -- ^ does the server support the X-Sendfile header?
69− -> Application
70− -> IO ()
71−run'' vars inputH outputH xsendfile app = do
72− let rmethod = B.pack $ lookup' "REQUEST_METHOD" vars
73− pinfo = lookup' "PATH_INFO" vars
74− qstring = lookup' "QUERY_STRING" vars
75− servername = lookup' "SERVER_NAME" vars
76− serverport = safeRead 80 $ lookup' "SERVER_PORT" vars
77− contentLength = safeRead 0 $ lookup' "CONTENT_LENGTH" vars
78− remoteHost' =
79− case lookup "REMOTE_HOST" vars of
80− Just x -> x
81− Nothing ->
82− case lookup "REMOTE_ADDR" vars of
83− Just x -> x
84− Nothing -> ""
85− isSecure' =
86− case map toLower $ lookup' "SERVER_PROTOCOL" vars of
87− "https" -> True
88− _ -> False
89− let env = Request
90− { requestMethod = rmethod
91− , pathInfo = B.pack pinfo
92− , queryString = B.pack qstring
93− , serverName = B.pack servername
94− , serverPort = serverport
95− , requestHeaders = map (cleanupVarName *** B.pack) vars
96− , isSecure = isSecure'
97− , errorHandler = System.IO.hPutStr System.IO.stderr
98− , remoteHost = B.pack remoteHost'
99− , httpVersion = "1.1" -- FIXME
100− }
101− -- FIXME worry about exception?
102− res <- run_ $ inputH contentLength $$ app env
103− case (xsendfile, res) of
104− (Just sf, ResponseFile s hs fp) ->
105− mapM_ outputH $ L.toChunks $ toLazyByteString $ sfBuilder s hs sf fp
106− _ -> responseEnumerator res $ \s hs ->
107− joinI $ enumList 1 [headers s hs, fromChar '\n'] $$ builderIter
108− where
109− headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
110− status (Status i m) = (fromByteString "Status", mconcat
111− [ fromString $ show i
112− , fromChar ' '
113− , fromByteString m
114− ])
115− header' (x, y) = (fromByteString $ ciOriginal x, fromByteString y)
116− header (x, y) = mconcat
117− [ x
118− , fromByteString ": "
119− , y
120− , fromChar '\n'
121− ]
122− sfBuilder s hs sf fp = mconcat
123− [ headers s hs
124− , header $ (fromByteString sf, fromString fp)
125− , fromChar '\n'
126− , fromByteString sf
127− , fromByteString " not supported"
128− ]
129− bsStep = Continue bsStep'
130− bsStep' EOF = yield () EOF
131− bsStep' (Chunks []) = continue bsStep'
132− bsStep' (Chunks bss) = liftIO (mapM_ outputH bss) >> continue bsStep'
133− builderIter = builderToByteString bsStep
134− fixHeaders h =
135− case lookup "content-type" h of
136− Nothing -> ("Content-Type", "text/html; charset=utf-8") : h
137− Just _ -> h
138−
139−cleanupVarName :: String -> RequestHeader
140−cleanupVarName ('H':'T':'T':'P':'_':a:as) =
141− String.fromString $ a : helper' as
142− where
143− helper' ('_':x:rest) = '-' : x : helper' rest
144− helper' (x:rest) = toLower x : helper' rest
145− helper' [] = []
146−cleanupVarName "CONTENT_TYPE" = "Content-Type"
147−cleanupVarName "CONTENT_LENGTH" = "Content-Length"
148−cleanupVarName "SCRIPT_NAME" = "CGI-Script-Name"
149−cleanupVarName x = String.fromString x -- FIXME remove?
150−
151−requestBodyHandle :: Handle -> Int -> Enumerator B.ByteString IO a
152−requestBodyHandle h =
153− requestBodyFunc go
154− where
155− go i = Just `fmap` B.hGet h (min i defaultChunkSize)
156−
157−requestBodyFunc :: (Int -> IO (Maybe B.ByteString))
158− -> Int
159− -> Enumerator B.ByteString IO a
160−requestBodyFunc _ 0 step = returnI step
161−requestBodyFunc h len (Continue k) = do
162− mbs <- liftIO $ h len
163− case mbs of
164− Nothing -> continue k
165− Just bs -> do
166− let newLen = len - B.length bs
167− k (Chunks [bs]) >>== requestBodyFunc h newLen
168−requestBodyFunc _ _ step = returnI step
Network/Wai/Middleware/Autohead.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−-- | Automatically produce responses to HEAD requests based on the underlying
3−-- applications GET response.
4−module Network.Wai.Middleware.Autohead (autohead) where
5−
6−import Network.Wai
7−import Data.Monoid (mempty)
8−import Data.Enumerator (enumEOF, ($$))
9−
10−autohead :: Middleware
11−autohead app req
12− | requestMethod req == "HEAD" = do
13− res <- app req { requestMethod = "GET" }
14− case res of
15− ResponseFile s hs _ -> return $ responseBuilder s hs mempty
16− ResponseEnumerator e -> do
17− let helper f =
18− let helper' s hs = enumEOF $$ f s hs
19− in e helper'
20− return $ ResponseEnumerator helper
21− | otherwise = app req
22−
Network/Wai/Middleware/CleanPath.hsdeleted−28
@@ -1,28 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Network.Wai.Middleware.CleanPath
3− ( cleanPath
4− ) where
5−
6−import Network.Wai
7−import qualified Data.ByteString.Char8 as B
8−import qualified Data.ByteString.Lazy as L
9−
10−cleanPath :: (B.ByteString -> Either B.ByteString [String])
11− -> B.ByteString
12− -> ([String] -> Request -> IO Response)
13− -> Request
14− -> IO Response
15−cleanPath splitter prefix app env =
16− case splitter $ pathInfo env of
17− Right pieces -> app pieces env
18− Left p -> return
19− $ responseLBS status301
20− [("Location", B.concat [prefix, p, suffix])]
21− $ L.empty
22− where
23− -- include the query string if present
24− suffix =
25− case B.uncons $ queryString env of
26− Nothing -> B.empty
27− Just ('?', _) -> queryString env
28− _ -> B.cons '?' $ queryString env
Network/Wai/Middleware/Gzip.hsdeleted−64
@@ -1,64 +0,0 @@
1−{-# LANGUAGE Rank2Types #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−---------------------------------------------------------
5−-- |
6−-- Module : Network.Wai.Middleware.Gzip
7−-- Copyright : Michael Snoyman
8−-- License : BSD3
9−--
10−-- Maintainer : Michael Snoyman <michael@snoyman.com>
11−-- Stability : Unstable
12−-- Portability : portable
13−--
14−-- Automatic gzip compression of responses.
15−--
16−---------------------------------------------------------
17−module Network.Wai.Middleware.Gzip (gzip) where
18−
19−import Network.Wai
20−import Network.Wai.Zlib
21−import Data.Maybe (fromMaybe)
22−import qualified Data.ByteString.Char8 as B
23−import Data.Enumerator (($$), joinI)
24−
25−-- | Use gzip to compress the body of the response.
26−--
27−-- Analyzes the \"Accept-Encoding\" header from the client to determine
28−-- if gzip is supported.
29−--
30−-- Possible future enhancements:
31−--
32−-- * Only compress if the response is above a certain size.
33−--
34−-- * I've read that IE can\'t support compression for Javascript files.
35−gzip :: Bool -- ^ should we gzip files?
36− -> Middleware
37−gzip files app env = do
38− res <- app env
39− return $
40− case res of
41− ResponseFile{} | not files -> res
42− _ -> if "gzip" `elem` enc
43− then ResponseEnumerator $ compressE $ responseEnumerator res
44− else res
45− where
46− enc = fromMaybe [] $ (splitCommas . B.unpack)
47− `fmap` lookup "Accept-Encoding" (requestHeaders env)
48−
49−compressE :: (forall a. ResponseEnumerator a)
50− -> (forall a. ResponseEnumerator a)
51−compressE re f =
52− re f'
53− --e s hs'
54− where
55− f' s hs =
56− joinI $ compress $$ f s hs'
57− where
58− hs' = ("Content-Encoding", "gzip") : hs
59−
60−splitCommas :: String -> [String]
61−splitCommas [] = []
62−splitCommas x =
63− let (y, z) = break (== ',') x
64− in y : splitCommas (drop 1 z)
Network/Wai/Middleware/Jsonp.hsdeleted−108
@@ -1,108 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
3−---------------------------------------------------------
4−-- |
5−-- Module : Network.Wai.Middleware.Jsonp
6−-- Copyright : Michael Snoyman
7−-- License : BSD3
8−--
9−-- Maintainer : Michael Snoyman <michael@snoyman.com>
10−-- Stability : Unstable
11−-- Portability : portable
12−--
13−-- Automatic wrapping of JSON responses to convert into JSONP.
14−--
15−---------------------------------------------------------
16−module Network.Wai.Middleware.Jsonp (jsonp) where
17−
18−import Network.Wai
19−import qualified Data.ByteString.Char8 as B8
20−import Data.Maybe (fromMaybe)
21−import Data.Enumerator (($$), enumList, Step (..), Enumerator, Iteratee, Enumeratee, joinI, checkDone, continue, Stream (..), (>>==))
22−import Blaze.ByteString.Builder (fromByteString, Builder)
23−import Blaze.ByteString.Builder.Char8 (fromChar)
24−
25−takeCallback :: B8.ByteString -> Maybe B8.ByteString
26−takeCallback bs | B8.null bs = Nothing
27−takeCallback bs =
28− let (x, y) = B8.break (== '=') bs
29− (y', z) = B8.break (== '&') $ B8.drop 1 y
30− in if x == B8.pack "callback"
31− then Just y'
32− else takeCallback $ B8.drop 1 z
33−
34−dropQM :: B8.ByteString -> B8.ByteString
35−dropQM bs
36− | B8.null bs = bs
37− | B8.head bs == '?' = B8.tail bs
38− | otherwise = bs
39−
40−-- | Wrap json responses in a jsonp callback.
41−--
42−-- Basically, if the user requested a \"text\/javascript\" and supplied a
43−-- \"callback\" GET parameter, ask the application for an
44−-- \"application/json\" response, then convern that into a JSONP response,
45−-- having a content type of \"text\/javascript\" and calling the specified
46−-- callback function.
47−jsonp :: Middleware
48−jsonp app env = do
49− let accept = fromMaybe B8.empty $ lookup "Accept" $ requestHeaders env
50− let callback :: Maybe B8.ByteString
51− callback =
52− if B8.pack "text/javascript" `B8.isInfixOf` accept
53− then takeCallback $ dropQM $ queryString env
54− else Nothing
55− let env' =
56− case callback of
57− Nothing -> env
58− Just _ -> env
59− { requestHeaders = changeVal "Accept"
60− "application/json"
61− $ requestHeaders env
62− }
63− res <- app env'
64− case callback of
65− Nothing -> return res
66− Just c -> go c res
67− where
68− go c r@(ResponseFile _ hs _) = go' c r hs
69− go c (ResponseEnumerator e) = addCallback c e
70− go' c r hs =
71− case checkJSON hs of
72− Just _ -> addCallback c $ responseEnumerator r
73− Nothing -> return r
74− checkJSON hs =
75− case fmap B8.unpack $ lookup "Content-Type" hs of
76− Just "application/json" -> Just $ fixHeaders hs
77− _ -> Nothing
78− fixHeaders = changeVal "Content-Type" "text/javascript"
79− addCallback :: B8.ByteString -> (forall a. ResponseEnumerator a)
80− -> Iteratee B8.ByteString IO Response
81− addCallback cb e =
82− return $ ResponseEnumerator $ helper
83− where
84− helper f =
85− e helper'
86− where
87− helper' s hs =
88− case checkJSON hs of
89− Just hs' -> wrap $$ f s hs'
90− Nothing -> f s hs
91− wrap :: Step Builder IO b -> Iteratee Builder IO b
92− wrap step = joinI $ after (enumList 1 [fromChar ')'])
93− $$ enumList 1 [fromByteString cb, fromChar '('] step
94− after :: Enumerator Builder IO b -> Enumeratee Builder Builder IO b
95− after enum =
96− loop
97− where
98− loop = checkDone $ continue . step
99− step k EOF = enum (Continue k) >>== return
100− step k s = k s >>== loop
101−
102−changeVal :: Eq a
103− => a
104− -> String
105− -> [(a, B8.ByteString)]
106− -> [(a, B8.ByteString)]
107−changeVal key val old = (key, B8.pack val)
108− : filter (\(k, _) -> k /= key) old
Network/Wai/Middleware/Vhost.hsdeleted−9
@@ -1,9 +0,0 @@
1−module Network.Wai.Middleware.Vhost (vhost) where
2−
3−import Network.Wai
4−
5−vhost :: [(Request -> Bool, Application)] -> Application -> Application
6−vhost vhosts def req =
7− case filter (\(b, _) -> b req) vhosts of
8− [] -> def req
9− (_, app):_ -> app req
Network/Wai/Parse.hsdeleted−359
@@ -1,359 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−-- | Some helpers for parsing data out of a raw WAI 'Request'.
4−
5−module Network.Wai.Parse
6− ( parseQueryString
7− , parseHttpAccept
8− , parseRequestBody
9− , Sink (..)
10− , lbsSink
11− , tempFileSink
12− , FileInfo (..)
13−#if TEST
14− , Bound (..)
15− , findBound
16− , sinkTillBound
17− , killCR
18− , killCRLF
19− , takeLine
20−#endif
21− ) where
22−
23−import qualified Data.ByteString as S
24−import qualified Data.ByteString.Lazy as L
25−import qualified Data.ByteString.Char8 as S8
26−import Data.Word (Word8)
27−import Data.Bits
28−import Data.Maybe (fromMaybe)
29−import Data.List (sortBy)
30−import Data.Function (on)
31−import System.Directory (removeFile, getTemporaryDirectory)
32−import System.IO (hClose, openBinaryTempFile, Handle)
33−import Network.Wai
34−import Data.Enumerator (Iteratee, yield)
35−import qualified Data.Enumerator as E
36−import Control.Monad.IO.Class (liftIO)
37−
38−uncons :: S.ByteString -> Maybe (Word8, S.ByteString)
39−uncons s
40− | S.null s = Nothing
41− | otherwise = Just (S.head s, S.tail s)
42−
43−breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
44−breakDiscard w s =
45− let (x, y) = S.break (== w) s
46− in (x, S.drop 1 y)
47−
48−-- | Split out the query string into a list of keys and values. A few
49−-- importants points:
50−--
51−-- * There is no way to distinguish between a parameter with no value and a
52−-- parameter with an empty value. Eg, "foo=" and "foo" are the same.
53−--
54−-- * The result returned is still bytestrings, since we perform no character
55−-- decoding here. Most likely, you will want to use UTF-8 decoding, but this is
56−-- left to the user of the library.
57−--
58−-- * Percent decoding errors are ignored. In particular, "%Q" will be output as
59−-- "%Q".
60−parseQueryString :: S.ByteString -> [(S.ByteString, S.ByteString)]
61−parseQueryString = parseQueryString' . dropQuestion
62− where
63− dropQuestion q | S.null q || S.head q /= 63 = q
64− dropQuestion q | otherwise = S.tail q
65− parseQueryString' q | S.null q = []
66− parseQueryString' q =
67− let (x, xs) = breakDiscard 38 q -- ampersand
68− in parsePair x : parseQueryString' xs
69− where
70− parsePair x =
71− let (k, v) = breakDiscard 61 x -- equal sign
72− in (qsDecode k, qsDecode v)
73−
74−
75−qsDecode :: S.ByteString -> S.ByteString
76−qsDecode z = fst $ S.unfoldrN (S.length z) go z
77− where
78− go bs =
79− case uncons bs of
80− Nothing -> Nothing
81− Just (43, ws) -> Just (32, ws) -- plus to space
82− Just (37, ws) -> Just $ fromMaybe (37, ws) $ do -- percent
83− (x, xs) <- uncons ws
84− x' <- hexVal x
85− (y, ys) <- uncons xs
86− y' <- hexVal y
87− Just $ (combine x' y', ys)
88− Just (w, ws) -> Just (w, ws)
89− hexVal w
90− | 48 <= w && w <= 57 = Just $ w - 48 -- 0 - 9
91− | 65 <= w && w <= 70 = Just $ w - 55 -- A - F
92− | 97 <= w && w <= 102 = Just $ w - 87 -- a - f
93− | otherwise = Nothing
94− combine :: Word8 -> Word8 -> Word8
95− combine a b = shiftL a 4 .|. b
96−
97−-- | Parse the HTTP accept string to determine supported content types.
98−parseHttpAccept :: S.ByteString -> [S.ByteString]
99−parseHttpAccept = map fst
100− . sortBy (rcompare `on` snd)
101− . map grabQ
102− . S.split 44 -- comma
103− where
104− rcompare :: Double -> Double -> Ordering
105− rcompare = flip compare
106− grabQ s =
107− let (s', q) = breakDiscard 59 s -- semicolon
108− (_, q') = breakDiscard 61 q -- equals sign
109− in (trimWhite s', readQ $ trimWhite q')
110− readQ s = case reads $ S8.unpack s of
111− (x, _):_ -> x
112− _ -> 1.0
113− trimWhite = S.dropWhile (== 32) -- space
114−
115−-- | A destination for data, the opposite of a 'Source'.
116−data Sink x y = Sink
117− { sinkInit :: IO x
118− , sinkAppend :: x -> S.ByteString -> IO x
119− , sinkClose :: x -> IO y
120− , sinkFinalize :: y -> IO ()
121− }
122−
123−lbsSink :: Sink ([S.ByteString] -> [S.ByteString]) L.ByteString
124−lbsSink = Sink
125− { sinkInit = return id
126− , sinkAppend = \front bs -> return $ front . (:) bs
127− , sinkClose = \front -> return $ L.fromChunks $ front []
128− , sinkFinalize = \_ -> return ()
129− }
130−
131−tempFileSink :: Sink (FilePath, Handle) FilePath
132−tempFileSink = Sink
133− { sinkInit = do
134− tempDir <- getTemporaryDirectory
135− openBinaryTempFile tempDir "webenc.buf"
136− , sinkAppend = \(fp, h) bs -> S.hPut h bs >> return (fp, h)
137− , sinkClose = \(fp, h) -> do
138− hClose h
139− return fp
140− , sinkFinalize = \fp -> removeFile fp
141− }
142−
143−-- | Information on an uploaded file.
144−data FileInfo c = FileInfo
145− { fileName :: S.ByteString
146− , fileContentType :: S.ByteString
147− , fileContent :: c
148− }
149− deriving (Eq, Show)
150−
151−type Param = (S.ByteString, S.ByteString)
152−type File y = (S.ByteString, FileInfo y)
153−
154−parseRequestBody :: Sink x y
155− -> Request
156− -> Iteratee S.ByteString IO ([Param], [File y])
157−parseRequestBody sink req = do
158− case ctype of
159− Nothing -> return ([], [])
160− Just Nothing -> do -- url-encoded
161− -- NOTE: in general, url-encoded data will be in a single chunk.
162− -- Therefore, I'm optimizing for the usual case by sticking with
163− -- strict byte strings here.
164− bs <- E.consume
165− return (parseQueryString $ S.concat bs, [])
166− Just (Just bound) -> -- multi-part
167− let bound' = S8.pack "--" `S.append` bound
168− in parsePieces sink bound'
169− where
170− urlenc = S8.pack "application/x-www-form-urlencoded"
171− formBound = S8.pack "multipart/form-data; boundary="
172− ctype = do
173− ctype' <- lookup "Content-Type" $ requestHeaders req
174− if urlenc `S.isPrefixOf` ctype'
175− then Just Nothing
176− else if formBound `S.isPrefixOf` ctype'
177− then Just $ Just $ S.drop (S.length formBound) ctype'
178− else Nothing
179−
180−takeLine :: Iteratee S.ByteString IO (Maybe S.ByteString)
181−takeLine = do
182− mbs <- E.head
183− case mbs of
184− Nothing -> return Nothing
185− Just bs ->
186− let (x, y) = S.break (== 10) bs -- LF
187− in if S.null y
188− then do
189− x' <- takeLine
190− case x' of
191− Nothing -> return $ Just $ killCR x
192− Just x'' -> return $ Just $ killCR $ S.append x x''
193− else do
194− E.yield () $ E.Chunks [S.drop 1 y]
195− return $ Just $ killCR x
196−
197−takeLines :: Iteratee S.ByteString IO [S.ByteString]
198−takeLines = do
199− res <- takeLine
200− case res of
201− Nothing -> return []
202− Just l
203− | S.null l -> return []
204− | otherwise -> do
205− ls <- takeLines
206− return $ l : ls
207−
208−parsePieces :: Sink x y -> S.ByteString
209− -> Iteratee S.ByteString IO ([Param], [File y])
210−parsePieces sink bound = do
211− _boundLine <- takeLine
212− res' <- takeLines
213− case res' of
214− [] -> return ([], [])
215− _ -> do
216− let ls' = map parsePair res'
217− let x = do
218− cd <- lookup contDisp ls'
219− let ct = lookup contType ls'
220− let attrs = parseAttrs cd
221− name <- lookup "name" attrs
222− return (ct, name, lookup "filename" attrs)
223− case x of
224− Just (mct, name, Just filename) -> do
225− let ct = fromMaybe "application/octet-stream" mct
226− seed <- liftIO $ sinkInit sink
227− (seed', wasFound) <-
228− sinkTillBound bound (sinkAppend sink) seed
229− y <- liftIO $ sinkClose sink seed'
230− let fi = FileInfo filename ct y
231− let y' = (name, fi)
232− (xs, ys) <-
233− if wasFound
234− then parsePieces sink bound
235− else return ([], [])
236− return (xs, y' : ys)
237− Just (_ct, name, Nothing) -> do
238− let seed = id
239− let iter front bs = return $ front . (:) bs
240− (front, wasFound) <-
241− sinkTillBound bound iter seed
242− let bs = S.concat $ front []
243− let x' = (name, qsDecode bs)
244− (xs, ys) <-
245− if wasFound
246− then parsePieces sink bound
247− else return ([], [])
248− return (x' : xs, ys)
249− _ -> do
250− -- ignore this part
251− let seed = ()
252− iter () _ = return ()
253− ((), wasFound) <- sinkTillBound bound iter seed
254− if wasFound
255− then parsePieces sink bound
256− else return ([], [])
257− where
258− contDisp = S8.pack "Content-Disposition"
259− contType = S8.pack "Content-Type"
260− parsePair s =
261− let (x, y) = breakDiscard 58 s -- colon
262− in (x, S.dropWhile (== 32) y) -- space
263−
264−data Bound = FoundBound S.ByteString S.ByteString
265− | NoBound
266− | PartialBound
267− deriving (Eq, Show)
268−
269−findBound :: S.ByteString -> S.ByteString -> Bound
270−findBound b bs = go [0..S.length bs - 1]
271− where
272− go [] = NoBound
273− go (i:is)
274− | mismatch [0..S.length b - 1] [i..S.length bs - 1] = go is
275− | otherwise =
276− let endI = i + S.length b
277− in if endI > S.length bs
278− then PartialBound
279− else FoundBound (S.take i bs) (S.drop endI bs)
280− mismatch [] _ = False
281− mismatch _ [] = False
282− mismatch (x:xs) (y:ys)
283− | S.index b x == S.index bs y = mismatch xs ys
284− | otherwise = True
285−
286−sinkTillBound :: S.ByteString
287− -> (x -> S.ByteString -> IO x)
288− -> x
289− -> Iteratee S.ByteString IO (x, Bool)
290−sinkTillBound bound iter seed = do
291− mbs <- E.head
292− case mbs of
293− Nothing -> return (seed, False)
294− Just bs -> go bs
295− where
296− go bs =
297− case findBound bound bs of
298− FoundBound before after -> do
299− let before' = killCRLF before
300− seed' <- liftIO $ iter seed before'
301− yield () $ E.Chunks [after]
302− return (seed', True)
303− PartialBound -> do
304− mbs <- E.head
305− case mbs of
306− Nothing -> do
307− seed' <- liftIO $ iter seed bs
308− return (seed', False)
309− Just bs2 -> do
310− let bs' = bs `S.append` bs2
311− yield () $ E.Chunks [bs']
312− sinkTillBound bound iter seed
313− NoBound -> do
314− mbs <- E.head
315− case mbs of
316− Nothing -> do
317− seed' <- liftIO $ iter seed bs
318− sinkTillBound bound iter seed'
319− Just bs' -> do
320− -- this funny bit is to catch when there's a
321− -- newline at the end of the previous chunk
322− (seed', bs'') <-
323− if not (S8.null bs) && S8.last bs `elem` "\n\r"
324− then do
325− let (front, back) =
326− S.splitAt (S.length bs - 2) bs
327− seed' <- liftIO $ iter seed front
328− return (seed', back `S.append` bs')
329− else do
330− seed' <- liftIO $ iter seed bs
331− return (seed', bs')
332− yield () $ E.Chunks [bs'']
333− sinkTillBound bound iter seed'
334− {-
335− NoBound -> do
336− case msrc of
337− Just (bs', src') -> do
338− -}
339−
340−parseAttrs :: S.ByteString -> [(S.ByteString, S.ByteString)]
341−parseAttrs = map go . S.split 59 -- semicolon
342− where
343− tw = S.dropWhile (== 32) -- space
344− dq s = if S.length s > 2 && S.head s == 34 && S.last s == 34 -- quote
345− then S.tail $ S.init s
346− else s
347− go s =
348− let (x, y) = breakDiscard 61 s -- equals sign
349− in (tw x, dq $ tw y)
350−
351−killCRLF :: S.ByteString -> S.ByteString
352−killCRLF bs
353− | S.null bs || S.last bs /= 10 = bs -- line feed
354− | otherwise = killCR $ S.init bs
355−
356−killCR :: S.ByteString -> S.ByteString
357−killCR bs
358− | S.null bs || S.last bs /= 13 = bs -- carriage return
359− | otherwise = S.init bs
Network/Wai/Zlib.hsdeleted−40
@@ -1,40 +0,0 @@
1−module Network.Wai.Zlib (compress) where
2−
3−import Prelude hiding (head)
4−import Data.Enumerator
5− ( Enumeratee, checkDone, Stream (..)
6− , (>>==), head, ($$), joinI
7− )
8−import Blaze.ByteString.Builder (Builder, fromByteString)
9−import Blaze.ByteString.Builder.Enumerator (builderToByteString)
10−import Control.Monad.IO.Class (liftIO)
11−
12−import Codec.Zlib
13−
14−-- Note: this function really should return a stream of ByteStrings, but the
15−-- WAI protocol needs Builders anyway.
16−compress :: Enumeratee Builder Builder IO a
17−compress step0 = joinI $ builderToByteString $$ do
18− def <- liftIO $ initDeflate 7 $ WindowBits 31
19− loop def step0
20− where
21− loop def = checkDone $ step def
22− step def k = do
23− minput <- head
24− case minput of
25− Nothing -> do
26− bss <- liftIO $ finishDeflate def drain
27− k (Chunks bss) >>== return
28− Just input -> do
29− bss <- liftIO $ withDeflateInput def input drain
30− case bss of
31− [] -> step def k
32− _ -> k (Chunks bss) >>== loop def
33− drain =
34− go id
35− where
36− go front mbs' = do
37− mbs <- mbs'
38− case mbs of
39− Nothing -> return $ map fromByteString $ front []
40− Just bs -> go (front . (:) bs) mbs'
READMEdeleted−1
@@ -1 +0,0 @@
1−Provides some basic WAI handlers and middleware.
README.mdnew file+13
@@ -0,0 +1,13 @@
1+An interface between Haskell web frameworks and web servers.
2+
3+A Haskell web application targets WAI and then can be deployed to any backend with a WAI adaptor.
4+The premier WAI backend is the Warp web server.
5+
6+WAI also adds modularity and code-sharing through middleware and WAI applications.
7+Code can be written that works with any web framework targeting WAI.
8+
9+[Documentation](http://www.yesodweb.com/book/web-application-interface)
10+
11+[Haddock Documentation](http://hackage.haskell.org/package/wai)
12+
13+[![Build Status](https://dev.azure.com/yesodweb/wai/_apis/build/status/yesodweb.wai?branchName=master)](https://dev.azure.com/yesodweb/wai/_build/latest?definitionId=1&branchName=master)
auto-update/ChangeLog.mdnew file+34
@@ -0,0 +1,34 @@
1+# ChangeLog for auto-update
2+
3+## 0.1.6
4+
5+* Add control of activation on leading vs. trailing edges for Control.Debounce
6+ [#756](https://github.com/yesodweb/wai/pull/756)
7+
8+## 0.1.5
9+
10+* Using the Strict and StrictData language extensions for GHC >8.
11+ [#752](https://github.com/yesodweb/wai/pull/752)
12+
13+## 0.1.4.1
14+
15+* [#693](https://github.com/yesodweb/wai/pull/693):
16+ Improve documentation for `reaperAction` function.
17+* [#732](https://github.com/yesodweb/wai/pull/732):
18+ Fixed memory leak in `reaperAdd` function.
19+
20+## 0.1.4
21+
22+* Provide updateActionModify API in AutoUpdate [#547](https://github.com/yesodweb/wai/pull/547)
23+
24+## 0.1.3.1
25+
26+* Doc improvements
27+
28+## 0.1.3
29+
30+* Adding a new AIP - reaperKill
31+
32+## 0.1.2
33+
34+* Added Control.Debounce
auto-update/Control/AutoUpdate.hsnew file+201
@@ -0,0 +1,201 @@
1+{-# LANGUAGE CPP #-}
2+-- | In a multithreaded environment, running actions on a regularly scheduled
3+-- background thread can dramatically improve performance.
4+-- For example, web servers need to return the current time with each HTTP response.
5+-- For a high-volume server, it's much faster for a dedicated thread to run every
6+-- second, and write the current time to a shared 'IORef', than it is for each
7+-- request to make its own call to 'getCurrentTime'.
8+--
9+-- But for a low-volume server, whose request frequency is less than once per
10+-- second, that approach will result in /more/ calls to 'getCurrentTime' than
11+-- necessary, and worse, kills idle GC.
12+--
13+-- This library solves that problem by allowing you to define actions which will
14+-- either be performed by a dedicated thread, or, in times of low volume, will
15+-- be executed by the calling thread.
16+--
17+-- Example usage:
18+--
19+-- @
20+-- import "Data.Time"
21+-- import "Control.AutoUpdate"
22+--
23+-- getTime <- 'mkAutoUpdate' 'defaultUpdateSettings'
24+-- { 'updateAction' = 'Data.Time.Clock.getCurrentTime'
25+-- , 'updateFreq' = 1000000 -- The default frequency, once per second
26+-- }
27+-- currentTime <- getTime
28+-- @
29+--
30+-- For more examples, <http://www.yesodweb.com/blog/2014/08/announcing-auto-update see the blog post introducing this library>.
31+module Control.AutoUpdate (
32+ -- * Type
33+ UpdateSettings
34+ , defaultUpdateSettings
35+ -- * Accessors
36+ , updateAction
37+ , updateFreq
38+ , updateSpawnThreshold
39+ -- * Creation
40+ , mkAutoUpdate
41+ , mkAutoUpdateWithModify
42+ ) where
43+
44+#if __GLASGOW_HASKELL__ < 709
45+import Control.Applicative ((<*>))
46+#endif
47+import Control.Concurrent (forkIO, threadDelay)
48+import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar,
49+ takeMVar, tryPutMVar)
50+import Control.Exception (SomeException, catch, mask_, throw,
51+ try)
52+import Control.Monad (void)
53+import Data.IORef (newIORef, readIORef, writeIORef)
54+
55+-- | Default value for creating an 'UpdateSettings'.
56+--
57+-- @since 0.1.0
58+defaultUpdateSettings :: UpdateSettings ()
59+defaultUpdateSettings = UpdateSettings
60+ { updateFreq = 1000000
61+ , updateSpawnThreshold = 3
62+ , updateAction = return ()
63+ }
64+
65+-- | Settings to control how values are updated.
66+--
67+-- This should be constructed using 'defaultUpdateSettings' and record
68+-- update syntax, e.g.:
69+--
70+-- @
71+-- let settings = 'defaultUpdateSettings' { 'updateAction' = 'Data.Time.Clock.getCurrentTime' }
72+-- @
73+--
74+-- @since 0.1.0
75+data UpdateSettings a = UpdateSettings
76+ { updateFreq :: Int
77+ -- ^ Microseconds between update calls. Same considerations as
78+ -- 'threadDelay' apply.
79+ --
80+ -- Default: 1 second (1000000)
81+ --
82+ -- @since 0.1.0
83+ , updateSpawnThreshold :: Int
84+ -- ^ NOTE: This value no longer has any effect, since worker threads are
85+ -- dedicated instead of spawned on demand.
86+ --
87+ -- Previously, this determined how many times the data must be requested
88+ -- before we decide to spawn a dedicated thread.
89+ --
90+ -- Default: 3
91+ --
92+ -- @since 0.1.0
93+ , updateAction :: IO a
94+ -- ^ Action to be performed to get the current value.
95+ --
96+ -- Default: does nothing.
97+ --
98+ -- @since 0.1.0
99+ }
100+
101+-- | Generate an action which will either read from an automatically
102+-- updated value, or run the update action in the current thread.
103+--
104+-- @since 0.1.0
105+mkAutoUpdate :: UpdateSettings a -> IO (IO a)
106+mkAutoUpdate us = mkAutoUpdateHelper us Nothing
107+
108+-- | Generate an action which will either read from an automatically
109+-- updated value, or run the update action in the current thread if
110+-- the first time or the provided modify action after that.
111+--
112+-- @since 0.1.4
113+mkAutoUpdateWithModify :: UpdateSettings a -> (a -> IO a) -> IO (IO a)
114+mkAutoUpdateWithModify us f = mkAutoUpdateHelper us (Just f)
115+
116+mkAutoUpdateHelper :: UpdateSettings a -> Maybe (a -> IO a) -> IO (IO a)
117+mkAutoUpdateHelper us updateActionModify = do
118+ -- A baton to tell the worker thread to generate a new value.
119+ needsRunning <- newEmptyMVar
120+
121+ -- The initial response variable. Response variables allow the requesting
122+ -- thread to block until a value is generated by the worker thread.
123+ responseVar0 <- newEmptyMVar
124+
125+ -- The current value, if available. We start off with a Left value
126+ -- indicating no value is available, and the above-created responseVar0 to
127+ -- give a variable to block on.
128+ currRef <- newIORef $ Left responseVar0
129+
130+ -- This is used to set a value in the currRef variable when the worker
131+ -- thread exits. In reality, that value should never be used, since the
132+ -- worker thread exiting only occurs if an async exception is thrown, which
133+ -- should only occur if there are no references to needsRunning left.
134+ -- However, this handler will make error messages much clearer if there's a
135+ -- bug in the implementation.
136+ let fillRefOnExit f = do
137+ eres <- try f
138+ case eres of
139+ Left e -> writeIORef currRef $ error $
140+ "Control.AutoUpdate.mkAutoUpdate: worker thread exited with exception: "
141+ ++ show (e :: SomeException)
142+ Right () -> writeIORef currRef $ error $
143+ "Control.AutoUpdate.mkAutoUpdate: worker thread exited normally, "
144+ ++ "which should be impossible due to usage of infinite loop"
145+
146+ -- fork the worker thread immediately. Note that we mask async exceptions,
147+ -- but *not* in an uninterruptible manner. This will allow a
148+ -- BlockedIndefinitelyOnMVar exception to still be thrown, which will take
149+ -- down this thread when all references to the returned function are
150+ -- garbage collected, and therefore there is no thread that can fill the
151+ -- needsRunning MVar.
152+ --
153+ -- Note that since we throw away the ThreadId of this new thread and never
154+ -- calls myThreadId, normal async exceptions can never be thrown to it,
155+ -- only RTS exceptions.
156+ mask_ $ void $ forkIO $ fillRefOnExit $ do
157+ -- This infinite loop makes up out worker thread. It takes an a
158+ -- responseVar value where the next value should be putMVar'ed to for
159+ -- the benefit of any requesters currently blocked on it.
160+ let loop responseVar maybea = do
161+ -- block until a value is actually needed
162+ takeMVar needsRunning
163+
164+ -- new value requested, so run the updateAction
165+ a <- catchSome $ maybe (updateAction us) id (updateActionModify <*> maybea)
166+
167+ -- we got a new value, update currRef and lastValue
168+ writeIORef currRef $ Right a
169+ putMVar responseVar a
170+
171+ -- delay until we're needed again
172+ threadDelay $ updateFreq us
173+
174+ -- delay's over. create a new response variable and set currRef
175+ -- to use it, so that the next requester will block on that
176+ -- variable. Then loop again with the updated response
177+ -- variable.
178+ responseVar' <- newEmptyMVar
179+ writeIORef currRef $ Left responseVar'
180+ loop responseVar' (Just a)
181+
182+ -- Kick off the loop, with the initial responseVar0 variable.
183+ loop responseVar0 Nothing
184+
185+ return $ do
186+ mval <- readIORef currRef
187+ case mval of
188+ Left responseVar -> do
189+ -- no current value, force the worker thread to run...
190+ void $ tryPutMVar needsRunning ()
191+
192+ -- and block for the result from the worker
193+ readMVar responseVar
194+ -- we have a current value, use it
195+ Right val -> return val
196+
197+-- | Turn a runtime exception into an impure exception, so that all 'IO'
198+-- actions will complete successfully. This simply defers the exception until
199+-- the value is forced.
200+catchSome :: IO a -> IO a
201+catchSome act = Control.Exception.catch act $ \e -> return $ throw (e :: SomeException)
auto-update/Control/AutoUpdate/Util.hsnew file+23
@@ -0,0 +1,23 @@
1+{-# LANGUAGE CPP #-}
2+module Control.AutoUpdate.Util
3+ ( atomicModifyIORef'
4+ ) where
5+
6+#ifndef MIN_VERSION_base
7+#define MIN_VERSION_base(x,y,z) 1
8+#endif
9+
10+#if MIN_VERSION_base(4,6,0)
11+import Data.IORef (atomicModifyIORef')
12+#else
13+import Data.IORef (IORef, atomicModifyIORef)
14+-- | Strict version of 'atomicModifyIORef'. This forces both the value stored
15+-- in the 'IORef' as well as the value returned.
16+atomicModifyIORef' :: IORef a -> (a -> (a,b)) -> IO b
17+atomicModifyIORef' ref f = do
18+ c <- atomicModifyIORef ref
19+ (\x -> let (a, b) = f x -- Lazy application of "f"
20+ in (a, a `seq` b)) -- Lazy application of "seq"
21+ -- The following forces "a `seq` b", so it also forces "f x".
22+ c `seq` return c
23+#endif
auto-update/Control/Debounce.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+-- | Debounce an action, ensuring it doesn't occur more than once for a given
3+-- period of time.
4+--
5+-- This is useful as an optimization, for example to ensure that logs are only
6+-- flushed to disk at most once per second.
7+--
8+-- Example usage:
9+--
10+-- @
11+-- printString <- 'mkDebounce' 'defaultDebounceSettings'
12+-- { 'debounceAction' = putStrLn "Running action"
13+-- , 'debounceFreq' = 5000000 -- 5 seconds
14+-- , 'debounceEdge' = 'DI.trailingEdge' -- Trigger on the trailing edge
15+-- }
16+-- @
17+--
18+-- >>> printString
19+-- Running action
20+-- >>> printString
21+-- <Wait five seconds>
22+-- Running action
23+--
24+-- See the fast-logger package ("System.Log.FastLogger") for real-world usage.
25+--
26+-- @since 0.1.2
27+module Control.Debounce
28+ ( -- * Type
29+ DI.DebounceSettings
30+ , defaultDebounceSettings
31+ -- * Accessors
32+ , DI.debounceFreq
33+ , DI.debounceAction
34+ , DI.debounceEdge
35+ , DI.leadingEdge
36+ , DI.trailingEdge
37+ -- * Creation
38+ , mkDebounce
39+ ) where
40+
41+import Control.Concurrent (newEmptyMVar, threadDelay)
42+import qualified Control.Debounce.Internal as DI
43+
44+-- | Default value for creating a 'DebounceSettings'.
45+--
46+-- @since 0.1.2
47+defaultDebounceSettings :: DI.DebounceSettings
48+defaultDebounceSettings = DI.DebounceSettings
49+ { DI.debounceFreq = 1000000
50+ , DI.debounceAction = return ()
51+ , DI.debounceEdge = DI.leadingEdge
52+ }
53+
54+-- | Generate an action which will trigger the debounced action to be performed.
55+--
56+-- @since 0.1.2
57+mkDebounce :: DI.DebounceSettings -> IO (IO ())
58+mkDebounce settings = do
59+ baton <- newEmptyMVar
60+ DI.mkDebounceInternal baton threadDelay settings
auto-update/Control/Debounce/Internal.hsnew file+98
@@ -0,0 +1,98 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+
3+-- | Unstable API which exposes internals for testing.
4+module Control.Debounce.Internal (
5+ DebounceSettings(..)
6+ , DebounceEdge(..)
7+ , leadingEdge
8+ , trailingEdge
9+ , mkDebounceInternal
10+ ) where
11+
12+import Control.Concurrent (forkIO)
13+import Control.Concurrent.MVar (takeMVar, tryPutMVar, tryTakeMVar, MVar)
14+import Control.Exception (SomeException, handle, mask_)
15+import Control.Monad (forever, void)
16+
17+-- | Settings to control how debouncing should work.
18+--
19+-- This should be constructed using 'defaultDebounceSettings' and record
20+-- update syntax, e.g.:
21+--
22+-- @
23+-- let settings = 'defaultDebounceSettings' { 'debounceAction' = flushLog }
24+-- @
25+--
26+-- @since 0.1.2
27+data DebounceSettings = DebounceSettings
28+ { debounceFreq :: Int
29+ -- ^ Length of the debounce timeout period in microseconds.
30+ --
31+ -- Default: 1 second (1000000)
32+ --
33+ -- @since 0.1.2
34+ , debounceAction :: IO ()
35+ -- ^ Action to be performed.
36+ --
37+ -- Note: all exceptions thrown by this action will be silently discarded.
38+ --
39+ -- Default: does nothing.
40+ --
41+ -- @since 0.1.2
42+ , debounceEdge :: DebounceEdge
43+ -- ^ Whether to perform the action on the leading edge or trailing edge of
44+ -- the timeout.
45+ --
46+ -- Default: 'trailingEdge'.
47+ --
48+ -- @since 0.1.6
49+ }
50+
51+-- | Setting to control whether the action happens at the leading and/or trailing
52+-- edge of the timeout.
53+--
54+-- @since 0.1.6
55+data DebounceEdge =
56+ Leading
57+ -- ^ Perform the action immediately, and then begin a cooldown period.
58+ -- If the trigger happens again during the cooldown, wait until the end of the cooldown
59+ -- and then perform the action again, then enter a new cooldown period.
60+ | Trailing
61+ -- ^ Start a cooldown period and perform the action when the period ends. If another trigger
62+ -- happens during the cooldown, it has no effect.
63+ deriving (Show, Eq)
64+
65+
66+-- | Perform the action immediately, and then begin a cooldown period.
67+-- If the trigger happens again during the cooldown, wait until the end of the cooldown
68+-- and then perform the action again, then enter a new cooldown period.
69+--
70+-- @since 0.1.6
71+leadingEdge :: DebounceEdge
72+leadingEdge = Leading
73+
74+-- | Start a cooldown period and perform the action when the period ends. If another trigger
75+-- happens during the cooldown, it has no effect.
76+--
77+-- @since 0.1.6
78+trailingEdge :: DebounceEdge
79+trailingEdge = Trailing
80+
81+mkDebounceInternal :: MVar () -> (Int -> IO ()) -> DebounceSettings -> IO (IO ())
82+mkDebounceInternal baton delayFn (DebounceSettings freq action edge) = do
83+ mask_ $ void $ forkIO $ forever $ do
84+ takeMVar baton
85+ case edge of
86+ Leading -> do
87+ ignoreExc action
88+ delayFn freq
89+ Trailing -> do
90+ delayFn freq
91+ -- Empty the baton of any other activations during the interval
92+ void $ tryTakeMVar baton
93+ ignoreExc action
94+
95+ return $ void $ tryPutMVar baton ()
96+
97+ignoreExc :: IO () -> IO ()
98+ignoreExc = handle $ \(_ :: SomeException) -> return ()
auto-update/Control/Reaper.hsnew file+280
@@ -0,0 +1,280 @@
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
3+
4+-- | This module provides the ability to create reapers: dedicated cleanup
5+-- threads. These threads will automatically spawn and die based on the
6+-- presence of a workload to process on. Example uses include:
7+--
8+-- * Killing long-running jobs
9+-- * Closing unused connections in a connection pool
10+-- * Pruning a cache of old items (see example below)
11+--
12+-- For real-world usage, search the <https://github.com/yesodweb/wai WAI family of packages>
13+-- for imports of "Control.Reaper".
14+module Control.Reaper (
15+ -- * Example: Regularly cleaning a cache
16+ -- $example1
17+
18+ -- * Settings
19+ ReaperSettings
20+ , defaultReaperSettings
21+ -- * Accessors
22+ , reaperAction
23+ , reaperDelay
24+ , reaperCons
25+ , reaperNull
26+ , reaperEmpty
27+ -- * Type
28+ , Reaper(..)
29+ -- * Creation
30+ , mkReaper
31+ -- * Helper
32+ , mkListAction
33+ ) where
34+
35+import Control.AutoUpdate.Util (atomicModifyIORef')
36+import Control.Concurrent (forkIO, threadDelay, killThread, ThreadId)
37+import Control.Exception (mask_)
38+import Data.IORef (IORef, newIORef, readIORef, writeIORef)
39+
40+-- | Settings for creating a reaper. This type has two parameters:
41+-- @workload@ gives the entire workload, whereas @item@ gives an
42+-- individual piece of the queue. A common approach is to have @workload@
43+-- be a list of @item@s. This is encouraged by 'defaultReaperSettings' and
44+-- 'mkListAction'.
45+--
46+-- @since 0.1.1
47+data ReaperSettings workload item = ReaperSettings
48+ { reaperAction :: workload -> IO (workload -> workload)
49+ -- ^ The action to perform on a workload. The result of this is a
50+ -- \"workload modifying\" function. In the common case of using lists,
51+ -- the result should be a difference list that prepends the remaining
52+ -- workload to the temporary workload. The temporary workload here
53+ -- refers to items added to the workload while the reaper action is
54+ -- running. For help with setting up such an action, see 'mkListAction'.
55+ --
56+ -- Default: do nothing with the workload, and then prepend it to the
57+ -- temporary workload. This is incredibly useless; you should
58+ -- definitely override this default.
59+ --
60+ -- @since 0.1.1
61+ , reaperDelay :: {-# UNPACK #-} !Int
62+ -- ^ Number of microseconds to delay between calls of 'reaperAction'.
63+ --
64+ -- Default: 30 seconds.
65+ --
66+ -- @since 0.1.1
67+ , reaperCons :: item -> workload -> workload
68+ -- ^ Add an item onto a workload.
69+ --
70+ -- Default: list consing.
71+ --
72+ -- @since 0.1.1
73+ , reaperNull :: workload -> Bool
74+ -- ^ Check if a workload is empty, in which case the worker thread
75+ -- will shut down.
76+ --
77+ -- Default: 'null'.
78+ --
79+ -- @since 0.1.1
80+ , reaperEmpty :: workload
81+ -- ^ An empty workload.
82+ --
83+ -- Default: empty list.
84+ --
85+ -- @since 0.1.1
86+ }
87+
88+-- | Default @ReaperSettings@ value, biased towards having a list of work
89+-- items.
90+--
91+-- @since 0.1.1
92+defaultReaperSettings :: ReaperSettings [item] item
93+defaultReaperSettings = ReaperSettings
94+ { reaperAction = \wl -> return (wl ++)
95+ , reaperDelay = 30000000
96+ , reaperCons = (:)
97+ , reaperNull = null
98+ , reaperEmpty = []
99+ }
100+
101+-- | A data structure to hold reaper APIs.
102+data Reaper workload item = Reaper {
103+ -- | Adding an item to the workload
104+ reaperAdd :: item -> IO ()
105+ -- | Reading workload.
106+ , reaperRead :: IO workload
107+ -- | Stopping the reaper thread if exists.
108+ -- The current workload is returned.
109+ , reaperStop :: IO workload
110+ -- | Killing the reaper thread immediately if exists.
111+ , reaperKill :: IO ()
112+ }
113+
114+-- | State of reaper.
115+data State workload = NoReaper -- ^ No reaper thread
116+ | Workload !workload -- ^ The current jobs
117+
118+-- | Create a reaper addition function. This function can be used to add
119+-- new items to the workload. Spawning of reaper threads will be handled
120+-- for you automatically.
121+--
122+-- @since 0.1.1
123+mkReaper :: ReaperSettings workload item -> IO (Reaper workload item)
124+mkReaper settings@ReaperSettings{..} = do
125+ stateRef <- newIORef NoReaper
126+ tidRef <- newIORef Nothing
127+ return Reaper {
128+ reaperAdd = add settings stateRef tidRef
129+ , reaperRead = readRef stateRef
130+ , reaperStop = stop stateRef
131+ , reaperKill = kill tidRef
132+ }
133+ where
134+ readRef stateRef = do
135+ mx <- readIORef stateRef
136+ case mx of
137+ NoReaper -> return reaperEmpty
138+ Workload wl -> return wl
139+ stop stateRef = atomicModifyIORef' stateRef $ \mx ->
140+ case mx of
141+ NoReaper -> (NoReaper, reaperEmpty)
142+ Workload x -> (Workload reaperEmpty, x)
143+ kill tidRef = do
144+ mtid <- readIORef tidRef
145+ case mtid of
146+ Nothing -> return ()
147+ Just tid -> killThread tid
148+
149+add :: ReaperSettings workload item
150+ -> IORef (State workload) -> IORef (Maybe ThreadId)
151+ -> item -> IO ()
152+add settings@ReaperSettings{..} stateRef tidRef item =
153+ mask_ $ do
154+ next <- atomicModifyIORef' stateRef cons
155+ next
156+ where
157+ cons NoReaper = let wl = reaperCons item reaperEmpty
158+ in (Workload wl, spawn settings stateRef tidRef)
159+ cons (Workload wl) = let wl' = reaperCons item wl
160+ in (Workload wl', return ())
161+
162+spawn :: ReaperSettings workload item
163+ -> IORef (State workload) -> IORef (Maybe ThreadId)
164+ -> IO ()
165+spawn settings stateRef tidRef = do
166+ tid <- forkIO $ reaper settings stateRef tidRef
167+ writeIORef tidRef $ Just tid
168+
169+reaper :: ReaperSettings workload item
170+ -> IORef (State workload) -> IORef (Maybe ThreadId)
171+ -> IO ()
172+reaper settings@ReaperSettings{..} stateRef tidRef = do
173+ threadDelay reaperDelay
174+ -- Getting the current jobs. Push an empty job to the reference.
175+ wl <- atomicModifyIORef' stateRef swapWithEmpty
176+ -- Do the jobs. A function to merge the left jobs and
177+ -- new jobs is returned.
178+ !merge <- reaperAction wl
179+ -- Merging the left jobs and new jobs.
180+ -- If there is no jobs, this thread finishes.
181+ next <- atomicModifyIORef' stateRef (check merge)
182+ next
183+ where
184+ swapWithEmpty NoReaper = error "Control.Reaper.reaper: unexpected NoReaper (1)"
185+ swapWithEmpty (Workload wl) = (Workload reaperEmpty, wl)
186+
187+ check _ NoReaper = error "Control.Reaper.reaper: unexpected NoReaper (2)"
188+ check merge (Workload wl)
189+ -- If there is no job, reaper is terminated.
190+ | reaperNull wl' = (NoReaper, writeIORef tidRef Nothing)
191+ -- If there are jobs, carry them out.
192+ | otherwise = (Workload wl', reaper settings stateRef tidRef)
193+ where
194+ wl' = merge wl
195+
196+-- | A helper function for creating 'reaperAction' functions. You would
197+-- provide this function with a function to process a single work item and
198+-- return either a new work item, or @Nothing@ if the work item is
199+-- expired.
200+--
201+-- @since 0.1.1
202+mkListAction :: (item -> IO (Maybe item'))
203+ -> [item]
204+ -> IO ([item'] -> [item'])
205+mkListAction f =
206+ go id
207+ where
208+ go !front [] = return front
209+ go !front (x:xs) = do
210+ my <- f x
211+ let front' =
212+ case my of
213+ Nothing -> front
214+ Just y -> front . (y:)
215+ go front' xs
216+
217+-- $example1
218+-- In this example code, we use a 'Data.Map.Strict.Map' to cache fibonacci numbers, and a 'Reaper' to prune the cache.
219+--
220+-- The @main@ function first creates a 'Reaper', with fields to initialize the
221+-- cache ('reaperEmpty'), add items to it ('reaperCons'), and prune it ('reaperAction').
222+-- The reaper will run every two seconds ('reaperDelay'), but will stop running while
223+-- 'reaperNull' is true.
224+--
225+-- @main@ then loops infinitely ('Control.Monad.forever'). Each second it calculates the fibonacci number
226+-- for a value between 30 and 34, first trying the cache ('reaperRead' and 'Data.Map.Strict.lookup'),
227+-- then falling back to manually calculating it (@fib@)
228+-- and updating the cache with the result ('reaperAdd')
229+--
230+-- @clean@ simply removes items cached for more than 10 seconds.
231+-- This function is where you would perform IO-related cleanup,
232+-- like killing threads or closing connections, if that was the purpose of your reaper.
233+--
234+-- @
235+-- module Main where
236+--
237+-- import "Data.Time" (UTCTime, getCurrentTime, diffUTCTime)
238+-- import "Control.Reaper"
239+-- import "Control.Concurrent" (threadDelay)
240+-- import "Data.Map.Strict" (Map)
241+-- import qualified "Data.Map.Strict" as Map
242+-- import "Control.Monad" (forever)
243+-- import "System.Random" (getStdRandom, randomR)
244+--
245+-- fib :: 'Int' -> 'Int'
246+-- fib 0 = 0
247+-- fib 1 = 1
248+-- fib n = fib (n-1) + fib (n-2)
249+--
250+-- type Cache = 'Data.Map.Strict.Map' 'Int' ('Int', 'Data.Time.Clock.UTCTime')
251+--
252+-- main :: IO ()
253+-- main = do
254+-- reaper <- 'mkReaper' 'defaultReaperSettings'
255+-- { 'reaperEmpty' = Map.'Data.Map.Strict.empty'
256+-- , 'reaperCons' = \\(k, v, time) workload -> Map.'Data.Map.Strict.insert' k (v, time) workload
257+-- , 'reaperAction' = clean
258+-- , 'reaperDelay' = 1000000 * 2 -- Clean every 2 seconds
259+-- , 'reaperNull' = Map.'Data.Map.Strict.null'
260+-- }
261+-- forever $ do
262+-- fibArg <- 'System.Random.getStdRandom' ('System.Random.randomR' (30,34))
263+-- cache <- 'reaperRead' reaper
264+-- let cachedResult = Map.'Data.Map.Strict.lookup' fibArg cache
265+-- case cachedResult of
266+-- 'Just' (fibResult, _createdAt) -> 'putStrLn' $ "Found in cache: `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
267+-- 'Nothing' -> do
268+-- let fibResult = fib fibArg
269+-- 'putStrLn' $ "Calculating `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
270+-- time <- 'Data.Time.Clock.getCurrentTime'
271+-- ('reaperAdd' reaper) (fibArg, fibResult, time)
272+-- 'threadDelay' 1000000 -- 1 second
273+--
274+-- -- Remove items > 10 seconds old
275+-- clean :: Cache -> IO (Cache -> Cache)
276+-- clean oldMap = do
277+-- currentTime <- 'Data.Time.Clock.getCurrentTime'
278+-- let pruned = Map.'Data.Map.Strict.filter' (\\(_, createdAt) -> currentTime \`diffUTCTime\` createdAt < 10.0) oldMap
279+-- return (\\newData -> Map.'Data.Map.Strict.union' pruned newData)
280+-- @
auto-update/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2014 Michael Snoyman
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be included
12+in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
auto-update/README.mdnew file+13
@@ -0,0 +1,13 @@
1+## auto-update
2+
3+A common problem is the desire to have an action run at a scheduled interval,
4+but only if it is needed. For example, instead of having every web request
5+result in a new `getCurrentTime` call, we'd like to have a single worker thread
6+run every second, updating an `IORef`. However, if the request frequency is
7+less than once per second, this is a pessimization, and worse, kills idle GC.
8+
9+This library allows you to define actions which will either be performed by a
10+dedicated thread or, in times of low volume, will be executed by the calling
11+thread.
12+
13+For original use case, see [yesod-scaffold issue #15](https://github.com/yesodweb/yesod-scaffold/pull/15).
auto-update/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
auto-update/auto-update.cabalnew file+38
@@ -0,0 +1,38 @@
1+name: auto-update
2+version: 0.1.6
3+synopsis: Efficiently run periodic, on-demand actions
4+description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
5+homepage: https://github.com/yesodweb/wai
6+license: MIT
7+license-file: LICENSE
8+author: Michael Snoyman
9+maintainer: michael@snoyman.com
10+category: Control
11+build-type: Simple
12+extra-source-files: README.md
13+ ChangeLog.md
14+cabal-version: >=1.10
15+
16+library
17+ ghc-options: -Wall
18+ exposed-modules: Control.AutoUpdate
19+ Control.Debounce
20+ Control.Debounce.Internal
21+ Control.Reaper
22+ other-modules: Control.AutoUpdate.Util
23+ build-depends: base >= 4 && < 5
24+ default-language: Haskell2010
25+ if impl(ghc >= 8)
26+ default-extensions: Strict StrictData
27+
28+-- Test suite is currently not robust enough, gives too many false negatives.
29+
30+test-suite spec
31+ main-is: Spec.hs
32+ other-modules: Control.AutoUpdateSpec
33+ Control.DebounceSpec
34+ Control.ReaperSpec
35+ hs-source-dirs: test
36+ type: exitcode-stdio-1.0
37+ build-depends: base, auto-update, exceptions, hspec, retry, HUnit
38+ default-language: Haskell2010
auto-update/test/Control/AutoUpdateSpec.hsnew file+35
@@ -0,0 +1,35 @@
1+module Control.AutoUpdateSpec (spec) where
2+
3+import Control.AutoUpdate
4+import Control.Concurrent (threadDelay)
5+import Control.Monad (replicateM_, forM_)
6+import Data.IORef
7+import Test.Hspec
8+import Test.Hspec.QuickCheck
9+
10+spec :: Spec
11+spec = return ()
12+ -- do
13+ -- prop "incrementer" $ \st' -> do
14+ -- let st = abs st' `mod` 10000
15+ -- ref <- newIORef 0
16+ -- next <- mkAutoUpdate defaultUpdateSettings
17+ -- { updateAction = atomicModifyIORef ref $ \i ->
18+ -- let i' = succ i in i' `seq` (i', i')
19+ -- , updateSpawnThreshold = st
20+ -- , updateFreq = 10000
21+ -- }
22+
23+ -- forM_ [1..st + 1] $ \i -> do
24+ -- j <- next
25+ -- j `shouldBe` i
26+
27+ -- replicateM_ 50 $ do
28+ -- i <- next
29+ -- i `shouldBe` st + 2
30+
31+ -- threadDelay 60000
32+ -- last1 <- readIORef ref
33+ -- threadDelay 20000
34+ -- last2 <- readIORef ref
35+ -- last2 `shouldBe` last1
auto-update/test/Control/DebounceSpec.hsnew file+120
@@ -0,0 +1,120 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+module Control.DebounceSpec (spec) where
3+
4+import Control.Concurrent
5+import Control.Debounce
6+import qualified Control.Debounce.Internal as DI
7+import Control.Monad
8+import Control.Monad.Catch
9+import Control.Retry
10+import Data.IORef
11+import Test.HUnit.Lang
12+import Test.Hspec
13+
14+spec :: Spec
15+spec = describe "mkDebounce" $ do
16+ describe "Leading edge" $ do
17+ it "works for a single event" $ do
18+ (ref, debounced, baton, returnFromWait) <- getDebounce leadingEdge
19+
20+ debounced
21+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 1)
22+
23+ returnFromWait
24+ pause
25+ readIORef ref >>= (`shouldBe` 1)
26+
27+ -- Try another round
28+ debounced
29+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 2)
30+
31+ returnFromWait
32+ pause
33+ readIORef ref >>= (`shouldBe` 2)
34+
35+ it "works for multiple events" $ do
36+ (ref, debounced, baton, returnFromWait) <- getDebounce leadingEdge
37+
38+ debounced
39+ waitForBatonToBeTaken baton
40+ debounced
41+ pause
42+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 1)
43+
44+ returnFromWait
45+ pause
46+ readIORef ref >>= (`shouldBe` 2)
47+
48+ describe "Trailing edge" $ do
49+ it "works for a single event" $ do
50+ (ref, debounced, baton, returnFromWait) <- getDebounce trailingEdge
51+
52+ debounced
53+ pause
54+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 0)
55+
56+ returnFromWait
57+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 1)
58+
59+ -- Try another round
60+ debounced
61+ pause
62+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 1)
63+
64+ returnFromWait
65+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 2)
66+
67+ it "works for multiple events" $ do
68+ (ref, debounced, baton, returnFromWait) <- getDebounce trailingEdge
69+
70+ debounced
71+ waitForBatonToBeTaken baton
72+ debounced
73+ pause
74+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 0)
75+
76+ returnFromWait
77+ waitUntil 5 $ readIORef ref >>= (`shouldBe` 1)
78+
79+
80+-- | Make a controllable delay function
81+getWaitAction :: IO (p -> IO (), IO ())
82+getWaitAction = do
83+ waitVar <- newEmptyMVar
84+ let waitAction _ = takeMVar waitVar
85+ let returnFromWait = putMVar waitVar ()
86+ return (waitAction, returnFromWait)
87+
88+-- | Get a debounce system with access to the internals for testing
89+getDebounce :: DI.DebounceEdge -> IO (IORef Int, IO (), MVar (), IO ())
90+getDebounce edge = do
91+ ref :: IORef Int <- newIORef 0
92+ let action = modifyIORef ref (+ 1)
93+
94+ (waitAction, returnFromWait) <- getWaitAction
95+
96+ baton <- newEmptyMVar
97+
98+ debounced <- DI.mkDebounceInternal baton waitAction defaultDebounceSettings {
99+ debounceFreq = 5000000 -- unused
100+ , debounceAction = action
101+ , debounceEdge = edge
102+ }
103+
104+ return (ref, debounced, baton, returnFromWait)
105+
106+-- | Pause briefly (100ms)
107+pause :: IO ()
108+pause = threadDelay 100000
109+
110+waitForBatonToBeTaken :: MVar () -> IO ()
111+waitForBatonToBeTaken baton = waitUntil 5 $ tryReadMVar baton >>= (`shouldBe` Nothing)
112+
113+-- | Wait up to n seconds for an action to complete without throwing an HUnitFailure
114+waitUntil :: Int -> IO a -> IO ()
115+waitUntil n action = recovering policy [handler] (\_status -> void action)
116+ where policy = constantDelay 1000 `mappend` limitRetries (n * 1000) -- 1ms * n * 1000 tries = n seconds
117+ handler _status = Handler (\(HUnitFailure {}) -> return True)
118+
119+main :: IO ()
120+main = hspec spec
auto-update/test/Control/ReaperSpec.hsnew file+39
@@ -0,0 +1,39 @@
1+module Control.ReaperSpec (spec) where
2+
3+import Control.Concurrent
4+import Control.Reaper
5+import Data.IORef
6+import Test.Hspec
7+import Test.Hspec.QuickCheck
8+
9+
10+spec :: Spec
11+spec = return ()
12+-- prop "works" $ \is -> do
13+-- reaper <- mkReaper defaultReaperSettings
14+-- { reaperAction = action
15+-- , reaperDelay = 1000
16+-- }
17+
18+-- let mkTestCase i = do
19+-- ref <- newIORef 0
20+-- let expected = (abs i `mod` 10) + 1
21+-- reaperAdd reaper (expected, ref)
22+-- return (expected, ref)
23+-- testCases <- mapM mkTestCase is
24+
25+-- let test (expected, ref) = do
26+-- actual <- readIORef ref
27+-- actual `shouldBe` (expected :: Int)
28+-- threadDelay 100000
29+-- mapM_ test testCases
30+-- [] <- reaperRead reaper
31+-- return ()
32+
33+-- type Item = (Int, IORef Int)
34+
35+-- action = mkListAction $ \(i, ref) -> do
36+-- modifyIORef ref succ
37+-- return $ if i > 1
38+-- then Just (pred i, ref)
39+-- else Nothing
auto-update/test/Spec.hsnew file+1
@@ -0,0 +1 @@
1+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
mime-types/ChangeLog.mdnew file+15
@@ -0,0 +1,15 @@
1+## 0.1.0.9
2+
3+* Add mjs mime type
4+
5+## 0.1.0.8
6+
7+* Add wasm mime type
8+
9+## 0.1.0.7
10+
11+* Add support for .less files [#534](https://github.com/yesodweb/wai/pull/534)
12+
13+## 0.1.0.6
14+
15+* Add woff2 mime type [#350](https://github.com/yesodweb/wai/pull/350)
mime-types/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
mime-types/Network/Mime.hsnew file+1096
@@ -0,0 +1,1096 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Mime
3+ ( -- * Lookups
4+ mimeByExt
5+ , defaultMimeLookup
6+ -- * Defaults
7+ , defaultMimeType
8+ , defaultMimeMap
9+ -- * Utilities
10+ , fileNameExtensions
11+ -- * Types
12+ , FileName
13+ , MimeType
14+ , MimeMap
15+ , Extension
16+ ) where
17+
18+import Data.Text (Text)
19+import qualified Data.Text as T
20+import Data.ByteString (ByteString)
21+import Data.ByteString.Char8 ()
22+import qualified Data.Map as Map
23+
24+-- | Maps extensions to mime types.
25+type MimeMap = Map.Map Extension MimeType
26+
27+-- | The filename component of a filepath, leaving off the directory but
28+-- keeping all extensions.
29+type FileName = Text
30+
31+-- | Individual mime type for be served over the wire.
32+type MimeType = ByteString
33+
34+-- | Look up a mime type from the given mime map and default mime type.
35+mimeByExt :: MimeMap
36+ -> MimeType -- ^ default mime type
37+ -> FileName
38+ -> MimeType
39+mimeByExt mm def =
40+ go . fileNameExtensions
41+ where
42+ go [] = def
43+ go (e:es) =
44+ case Map.lookup e mm of
45+ Nothing -> go es
46+ Just mt -> mt
47+
48+-- | @mimeByExt@ applied to @defaultMimeType@ and @defaultMimeMap@.
49+defaultMimeLookup :: FileName -> MimeType
50+defaultMimeLookup = mimeByExt defaultMimeMap defaultMimeType
51+
52+-- | Get a list of all of the file name extensions.
53+--
54+-- > fileNameExtensions "foo.tar.gz" == ["tar.gz", "gz"]
55+fileNameExtensions :: FileName -> [Extension]
56+fileNameExtensions =
57+ go . T.toLower . dropToExt
58+ where
59+ dropToExt = T.drop 1 . T.dropWhile (/= '.')
60+
61+ go e
62+ | T.null e = []
63+ | otherwise = e : go next
64+ where
65+ next = dropToExt e
66+
67+-- | Path extension. May include multiple components, e.g. tar.gz
68+type Extension = Text
69+
70+-- | The default fallback mime type \"application/octet-stream\".
71+defaultMimeType :: MimeType
72+defaultMimeType = "application/octet-stream"
73+
74+-- | A default mapping from filename extension to mime type.
75+--
76+-- Generated from the Apache and nginx mime.types files.
77+defaultMimeMap :: MimeMap
78+defaultMimeMap = Map.fromAscList [
79+ ("123", "application/vnd.lotus-1-2-3")
80+ , ("3dml", "text/vnd.in3d.3dml")
81+ , ("3ds", "image/x-3ds")
82+ , ("3g2", "video/3gpp2")
83+ , ("3gp", "video/3gpp")
84+ , ("3gpp", "video/3gpp")
85+ , ("7z", "application/x-7z-compressed")
86+ , ("aab", "application/x-authorware-bin")
87+ , ("aac", "audio/x-aac")
88+ , ("aam", "application/x-authorware-map")
89+ , ("aas", "application/x-authorware-seg")
90+ , ("abw", "application/x-abiword")
91+ , ("ac", "application/pkix-attr-cert")
92+ , ("acc", "application/vnd.americandynamics.acc")
93+ , ("ace", "application/x-ace-compressed")
94+ , ("acu", "application/vnd.acucobol")
95+ , ("acutc", "application/vnd.acucorp")
96+ , ("adp", "audio/adpcm")
97+ , ("aep", "application/vnd.audiograph")
98+ , ("afm", "application/x-font-type1")
99+ , ("afp", "application/vnd.ibm.modcap")
100+ , ("ahead", "application/vnd.ahead.space")
101+ , ("ai", "application/postscript")
102+ , ("aif", "audio/x-aiff")
103+ , ("aifc", "audio/x-aiff")
104+ , ("aiff", "audio/x-aiff")
105+ , ("air", "application/vnd.adobe.air-application-installer-package+zip")
106+ , ("ait", "application/vnd.dvb.ait")
107+ , ("ami", "application/vnd.amiga.ami")
108+ , ("apk", "application/vnd.android.package-archive")
109+ , ("appcache", "text/cache-manifest")
110+ , ("application", "application/x-ms-application")
111+ , ("apr", "application/vnd.lotus-approach")
112+ , ("arc", "application/x-freearc")
113+ , ("asc", "text/plain")
114+ , ("asf", "video/x-ms-asf")
115+ , ("asm", "text/x-asm")
116+ , ("aso", "application/vnd.accpac.simply.aso")
117+ , ("asx", "video/x-ms-asf")
118+ , ("atc", "application/vnd.acucorp")
119+ , ("atom", "application/atom+xml")
120+ , ("atomcat", "application/atomcat+xml")
121+ , ("atomsvc", "application/atomsvc+xml")
122+ , ("atx", "application/vnd.antix.game-component")
123+ , ("au", "audio/basic")
124+ , ("avi", "video/x-msvideo")
125+ , ("aw", "application/applixware")
126+ , ("azf", "application/vnd.airzip.filesecure.azf")
127+ , ("azs", "application/vnd.airzip.filesecure.azs")
128+ , ("azw", "application/vnd.amazon.ebook")
129+ , ("bat", "application/x-msdownload")
130+ , ("bcpio", "application/x-bcpio")
131+ , ("bdf", "application/x-font-bdf")
132+ , ("bdm", "application/vnd.syncml.dm+wbxml")
133+ , ("bed", "application/vnd.realvnc.bed")
134+ , ("bh2", "application/vnd.fujitsu.oasysprs")
135+ , ("bin", "application/octet-stream")
136+ , ("blb", "application/x-blorb")
137+ , ("blorb", "application/x-blorb")
138+ , ("bmi", "application/vnd.bmi")
139+ , ("bmp", "image/bmp")
140+ , ("book", "application/vnd.framemaker")
141+ , ("box", "application/vnd.previewsystems.box")
142+ , ("boz", "application/x-bzip2")
143+ , ("bpk", "application/octet-stream")
144+ , ("btif", "image/prs.btif")
145+ , ("bz", "application/x-bzip")
146+ , ("bz2", "application/x-bzip")
147+ , ("c", "text/plain")
148+ , ("c11amc", "application/vnd.cluetrust.cartomobile-config")
149+ , ("c11amz", "application/vnd.cluetrust.cartomobile-config-pkg")
150+ , ("c4d", "application/vnd.clonk.c4group")
151+ , ("c4f", "application/vnd.clonk.c4group")
152+ , ("c4g", "application/vnd.clonk.c4group")
153+ , ("c4p", "application/vnd.clonk.c4group")
154+ , ("c4u", "application/vnd.clonk.c4group")
155+ , ("cab", "application/vnd.ms-cab-compressed")
156+ , ("caf", "audio/x-caf")
157+ , ("cap", "application/vnd.tcpdump.pcap")
158+ , ("car", "application/vnd.curl.car")
159+ , ("cat", "application/vnd.ms-pki.seccat")
160+ , ("cb7", "application/x-cbr")
161+ , ("cba", "application/x-cbr")
162+ , ("cbr", "application/x-cbr")
163+ , ("cbt", "application/x-cbr")
164+ , ("cbz", "application/x-cbr")
165+ , ("cc", "text/x-c")
166+ , ("cco", "application/x-cocoa")
167+ , ("cct", "application/x-director")
168+ , ("ccxml", "application/ccxml+xml")
169+ , ("cdbcmsg", "application/vnd.contact.cmsg")
170+ , ("cdf", "application/x-netcdf")
171+ , ("cdkey", "application/vnd.mediastation.cdkey")
172+ , ("cdmia", "application/cdmi-capability")
173+ , ("cdmic", "application/cdmi-container")
174+ , ("cdmid", "application/cdmi-domain")
175+ , ("cdmio", "application/cdmi-object")
176+ , ("cdmiq", "application/cdmi-queue")
177+ , ("cdx", "chemical/x-cdx")
178+ , ("cdxml", "application/vnd.chemdraw+xml")
179+ , ("cdy", "application/vnd.cinderella")
180+ , ("cer", "application/pkix-cert")
181+ , ("cfs", "application/x-cfs-compressed")
182+ , ("cgm", "image/cgm")
183+ , ("chat", "application/x-chat")
184+ , ("chm", "application/vnd.ms-htmlhelp")
185+ , ("chrt", "application/vnd.kde.kchart")
186+ , ("cif", "chemical/x-cif")
187+ , ("cii", "application/vnd.anser-web-certificate-issue-initiation")
188+ , ("cil", "application/vnd.ms-artgalry")
189+ , ("cla", "application/vnd.claymore")
190+ , ("class", "application/java-vm")
191+ , ("clkk", "application/vnd.crick.clicker.keyboard")
192+ , ("clkp", "application/vnd.crick.clicker.palette")
193+ , ("clkt", "application/vnd.crick.clicker.template")
194+ , ("clkw", "application/vnd.crick.clicker.wordbank")
195+ , ("clkx", "application/vnd.crick.clicker")
196+ , ("clp", "application/x-msclip")
197+ , ("cmc", "application/vnd.cosmocaller")
198+ , ("cmdf", "chemical/x-cmdf")
199+ , ("cml", "chemical/x-cml")
200+ , ("cmp", "application/vnd.yellowriver-custom-menu")
201+ , ("cmx", "image/x-cmx")
202+ , ("cod", "application/vnd.rim.cod")
203+ , ("com", "application/x-msdownload")
204+ , ("conf", "text/plain")
205+ , ("cpio", "application/x-cpio")
206+ , ("cpp", "text/plain")
207+ , ("cpt", "application/mac-compactpro")
208+ , ("crd", "application/x-mscardfile")
209+ , ("crl", "application/pkix-crl")
210+ , ("crt", "application/x-x509-ca-cert")
211+ , ("cryptonote", "application/vnd.rig.cryptonote")
212+ , ("csh", "application/x-csh")
213+ , ("csml", "chemical/x-csml")
214+ , ("csp", "application/vnd.commonspace")
215+ , ("css", "text/css")
216+ , ("cst", "application/x-director")
217+ , ("csv", "text/csv")
218+ , ("cu", "application/cu-seeme")
219+ , ("curl", "text/vnd.curl")
220+ , ("cww", "application/prs.cww")
221+ , ("cxt", "application/x-director")
222+ , ("cxx", "text/plain")
223+ , ("dae", "model/vnd.collada+xml")
224+ , ("daf", "application/vnd.mobius.daf")
225+ , ("dart", "application/vnd.dart")
226+ , ("dataless", "application/vnd.fdsn.seed")
227+ , ("davmount", "application/davmount+xml")
228+ , ("dbk", "application/docbook+xml")
229+ , ("dcr", "application/x-director")
230+ , ("dcurl", "text/vnd.curl.dcurl")
231+ , ("dd2", "application/vnd.oma.dd2+xml")
232+ , ("ddd", "application/vnd.fujixerox.ddd")
233+ , ("deb", "application/x-debian-package")
234+ , ("def", "text/plain")
235+ , ("deploy", "application/octet-stream")
236+ , ("der", "application/x-x509-ca-cert")
237+ , ("dfac", "application/vnd.dreamfactory")
238+ , ("dgc", "application/x-dgc-compressed")
239+ , ("dic", "text/x-c")
240+ , ("dir", "application/x-director")
241+ , ("dis", "application/vnd.mobius.dis")
242+ , ("dist", "application/octet-stream")
243+ , ("distz", "application/octet-stream")
244+ , ("djv", "image/vnd.djvu")
245+ , ("djvu", "image/vnd.djvu")
246+ , ("dll", "application/x-msdownload")
247+ , ("dmg", "application/x-apple-diskimage")
248+ , ("dmp", "application/vnd.tcpdump.pcap")
249+ , ("dms", "application/octet-stream")
250+ , ("dna", "application/vnd.dna")
251+ , ("doc", "application/msword")
252+ , ("docm", "application/vnd.ms-word.document.macroenabled.12")
253+ , ("docx", "application/vnd.openxmlformats-officedocument.wordprocessingml.document")
254+ , ("dot", "application/msword")
255+ , ("dotm", "application/vnd.ms-word.template.macroenabled.12")
256+ , ("dotx", "application/vnd.openxmlformats-officedocument.wordprocessingml.template")
257+ , ("dp", "application/vnd.osgi.dp")
258+ , ("dpg", "application/vnd.dpgraph")
259+ , ("dra", "audio/vnd.dra")
260+ , ("dsc", "text/prs.lines.tag")
261+ , ("dssc", "application/dssc+der")
262+ , ("dtb", "application/x-dtbook+xml")
263+ , ("dtd", "application/xml-dtd")
264+ , ("dts", "audio/vnd.dts")
265+ , ("dtshd", "audio/vnd.dts.hd")
266+ , ("dump", "application/octet-stream")
267+ , ("dvb", "video/vnd.dvb.file")
268+ , ("dvi", "application/x-dvi")
269+ , ("dwf", "model/vnd.dwf")
270+ , ("dwg", "image/vnd.dwg")
271+ , ("dxf", "image/vnd.dxf")
272+ , ("dxp", "application/vnd.spotfire.dxp")
273+ , ("dxr", "application/x-director")
274+ , ("ear", "application/java-archive")
275+ , ("ecelp4800", "audio/vnd.nuera.ecelp4800")
276+ , ("ecelp7470", "audio/vnd.nuera.ecelp7470")
277+ , ("ecelp9600", "audio/vnd.nuera.ecelp9600")
278+ , ("ecma", "application/ecmascript")
279+ , ("edm", "application/vnd.novadigm.edm")
280+ , ("edx", "application/vnd.novadigm.edx")
281+ , ("efif", "application/vnd.picsel")
282+ , ("ei6", "application/vnd.pg.osasli")
283+ , ("elc", "application/octet-stream")
284+ , ("emf", "application/x-msmetafile")
285+ , ("eml", "message/rfc822")
286+ , ("emma", "application/emma+xml")
287+ , ("emz", "application/x-msmetafile")
288+ , ("eol", "audio/vnd.digital-winds")
289+ , ("eot", "application/vnd.ms-fontobject")
290+ , ("eps", "application/postscript")
291+ , ("epub", "application/epub+zip")
292+ , ("es3", "application/vnd.eszigno3+xml")
293+ , ("esa", "application/vnd.osgi.subsystem")
294+ , ("esf", "application/vnd.epson.esf")
295+ , ("et3", "application/vnd.eszigno3+xml")
296+ , ("etx", "text/x-setext")
297+ , ("eva", "application/x-eva")
298+ , ("evy", "application/x-envoy")
299+ , ("exe", "application/x-msdownload")
300+ , ("exi", "application/exi")
301+ , ("ext", "application/vnd.novadigm.ext")
302+ , ("ez", "application/andrew-inset")
303+ , ("ez2", "application/vnd.ezpix-album")
304+ , ("ez3", "application/vnd.ezpix-package")
305+ , ("f", "text/x-fortran")
306+ , ("f4v", "video/x-f4v")
307+ , ("f77", "text/x-fortran")
308+ , ("f90", "text/x-fortran")
309+ , ("fbs", "image/vnd.fastbidsheet")
310+ , ("fcdt", "application/vnd.adobe.formscentral.fcdt")
311+ , ("fcs", "application/vnd.isac.fcs")
312+ , ("fdf", "application/vnd.fdf")
313+ , ("fe_launch", "application/vnd.denovo.fcselayout-link")
314+ , ("fg5", "application/vnd.fujitsu.oasysgp")
315+ , ("fgd", "application/x-director")
316+ , ("fh", "image/x-freehand")
317+ , ("fh4", "image/x-freehand")
318+ , ("fh5", "image/x-freehand")
319+ , ("fh7", "image/x-freehand")
320+ , ("fhc", "image/x-freehand")
321+ , ("fig", "application/x-xfig")
322+ , ("flac", "audio/x-flac")
323+ , ("fli", "video/x-fli")
324+ , ("flo", "application/vnd.micrografx.flo")
325+ , ("flv", "video/x-flv")
326+ , ("flw", "application/vnd.kde.kivio")
327+ , ("flx", "text/vnd.fmi.flexstor")
328+ , ("fly", "text/vnd.fly")
329+ , ("fm", "application/vnd.framemaker")
330+ , ("fnc", "application/vnd.frogans.fnc")
331+ , ("for", "text/x-fortran")
332+ , ("fpx", "image/vnd.fpx")
333+ , ("frame", "application/vnd.framemaker")
334+ , ("fsc", "application/vnd.fsc.weblaunch")
335+ , ("fst", "image/vnd.fst")
336+ , ("ftc", "application/vnd.fluxtime.clip")
337+ , ("fti", "application/vnd.anser-web-funds-transfer-initiation")
338+ , ("fvt", "video/vnd.fvt")
339+ , ("fxp", "application/vnd.adobe.fxp")
340+ , ("fxpl", "application/vnd.adobe.fxp")
341+ , ("fzs", "application/vnd.fuzzysheet")
342+ , ("g2w", "application/vnd.geoplan")
343+ , ("g3", "image/g3fax")
344+ , ("g3w", "application/vnd.geospace")
345+ , ("gac", "application/vnd.groove-account")
346+ , ("gam", "application/x-tads")
347+ , ("gbr", "application/rpki-ghostbusters")
348+ , ("gca", "application/x-gca-compressed")
349+ , ("gdl", "model/vnd.gdl")
350+ , ("geo", "application/vnd.dynageo")
351+ , ("gex", "application/vnd.geometry-explorer")
352+ , ("ggb", "application/vnd.geogebra.file")
353+ , ("ggt", "application/vnd.geogebra.tool")
354+ , ("ghf", "application/vnd.groove-help")
355+ , ("gif", "image/gif")
356+ , ("gim", "application/vnd.groove-identity-message")
357+ , ("gml", "application/gml+xml")
358+ , ("gmx", "application/vnd.gmx")
359+ , ("gnumeric", "application/x-gnumeric")
360+ , ("gph", "application/vnd.flographit")
361+ , ("gpx", "application/gpx+xml")
362+ , ("gqf", "application/vnd.grafeq")
363+ , ("gqs", "application/vnd.grafeq")
364+ , ("gram", "application/srgs")
365+ , ("gramps", "application/x-gramps-xml")
366+ , ("gre", "application/vnd.geometry-explorer")
367+ , ("grv", "application/vnd.groove-injector")
368+ , ("grxml", "application/srgs+xml")
369+ , ("gsf", "application/x-font-ghostscript")
370+ , ("gtar", "application/x-gtar")
371+ , ("gtm", "application/vnd.groove-tool-message")
372+ , ("gtw", "model/vnd.gtw")
373+ , ("gv", "text/vnd.graphviz")
374+ , ("gxf", "application/gxf")
375+ , ("gxt", "application/vnd.geonext")
376+ , ("gz", "application/x-gzip")
377+ , ("h", "text/x-c")
378+ , ("h261", "video/h261")
379+ , ("h263", "video/h263")
380+ , ("h264", "video/h264")
381+ , ("hal", "application/vnd.hal+xml")
382+ , ("hbci", "application/vnd.hbci")
383+ , ("hdf", "application/x-hdf")
384+ , ("hh", "text/x-c")
385+ , ("hlp", "application/winhlp")
386+ , ("hpgl", "application/vnd.hp-hpgl")
387+ , ("hpid", "application/vnd.hp-hpid")
388+ , ("hps", "application/vnd.hp-hps")
389+ , ("hqx", "application/mac-binhex40")
390+ , ("hs", "text/plain")
391+ , ("htc", "text/x-component")
392+ , ("htke", "application/vnd.kenameaapp")
393+ , ("htm", "text/html")
394+ , ("html", "text/html")
395+ , ("hvd", "application/vnd.yamaha.hv-dic")
396+ , ("hvp", "application/vnd.yamaha.hv-voice")
397+ , ("hvs", "application/vnd.yamaha.hv-script")
398+ , ("i2g", "application/vnd.intergeo")
399+ , ("icc", "application/vnd.iccprofile")
400+ , ("ice", "x-conference/x-cooltalk")
401+ , ("icm", "application/vnd.iccprofile")
402+ , ("ico", "image/vnd.microsoft.icon")
403+ , ("ics", "text/calendar")
404+ , ("ief", "image/ief")
405+ , ("ifb", "text/calendar")
406+ , ("ifm", "application/vnd.shana.informed.formdata")
407+ , ("iges", "model/iges")
408+ , ("igl", "application/vnd.igloader")
409+ , ("igm", "application/vnd.insors.igm")
410+ , ("igs", "model/iges")
411+ , ("igx", "application/vnd.micrografx.igx")
412+ , ("iif", "application/vnd.shana.informed.interchange")
413+ , ("img", "application/octet-stream")
414+ , ("imp", "application/vnd.accpac.simply.imp")
415+ , ("ims", "application/vnd.ms-ims")
416+ , ("in", "text/plain")
417+ , ("ink", "application/inkml+xml")
418+ , ("inkml", "application/inkml+xml")
419+ , ("install", "application/x-install-instructions")
420+ , ("iota", "application/vnd.astraea-software.iota")
421+ , ("ipfix", "application/ipfix")
422+ , ("ipk", "application/vnd.shana.informed.package")
423+ , ("irm", "application/vnd.ibm.rights-management")
424+ , ("irp", "application/vnd.irepository.package+xml")
425+ , ("iso", "application/x-iso9660-image")
426+ , ("itp", "application/vnd.shana.informed.formtemplate")
427+ , ("ivp", "application/vnd.immervision-ivp")
428+ , ("ivu", "application/vnd.immervision-ivu")
429+ , ("jad", "text/vnd.sun.j2me.app-descriptor")
430+ , ("jam", "application/vnd.jam")
431+ , ("jar", "application/java-archive")
432+ , ("jardiff", "application/x-java-archive-diff")
433+ , ("java", "text/x-java-source")
434+ , ("jisp", "application/vnd.jisp")
435+ , ("jlt", "application/vnd.hp-jlyt")
436+ , ("jng", "image/x-jng")
437+ , ("jnlp", "application/x-java-jnlp-file")
438+ , ("joda", "application/vnd.joost.joda-archive")
439+ , ("jpe", "image/jpeg")
440+ , ("jpeg", "image/jpeg")
441+ , ("jpg", "image/jpeg")
442+ , ("jpgm", "video/jpm")
443+ , ("jpgv", "video/jpeg")
444+ , ("jpm", "video/jpm")
445+ , ("js", "application/javascript")
446+ , ("json", "application/json")
447+ , ("jsonml", "application/jsonml+json")
448+ , ("kar", "audio/midi")
449+ , ("karbon", "application/vnd.kde.karbon")
450+ , ("kfo", "application/vnd.kde.kformula")
451+ , ("kia", "application/vnd.kidspiration")
452+ , ("kml", "application/vnd.google-earth.kml+xml")
453+ , ("kmz", "application/vnd.google-earth.kmz")
454+ , ("kne", "application/vnd.kinar")
455+ , ("knp", "application/vnd.kinar")
456+ , ("kon", "application/vnd.kde.kontour")
457+ , ("kpr", "application/vnd.kde.kpresenter")
458+ , ("kpt", "application/vnd.kde.kpresenter")
459+ , ("kpxx", "application/vnd.ds-keypoint")
460+ , ("ksp", "application/vnd.kde.kspread")
461+ , ("ktr", "application/vnd.kahootz")
462+ , ("ktx", "image/ktx")
463+ , ("ktz", "application/vnd.kahootz")
464+ , ("kwd", "application/vnd.kde.kword")
465+ , ("kwt", "application/vnd.kde.kword")
466+ , ("lasxml", "application/vnd.las.las+xml")
467+ , ("latex", "application/x-latex")
468+ , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
469+ , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
470+ , ("les", "application/vnd.hhe.lesson-player")
471+
472+ -- Added after deliberation in PR (https://github.com/yesodweb/wai/pull/534)
473+ -- Accepted mainly because of StackOverflow (http://stackoverflow.com/questions/7319555/how-to-add-less-to-iis-7-0)
474+ , ("less", "text/css")
475+
476+ , ("lha", "application/x-lzh-compressed")
477+ , ("link66", "application/vnd.route66.link66+xml")
478+ , ("list", "text/plain")
479+ , ("list3820", "application/vnd.ibm.modcap")
480+ , ("listafp", "application/vnd.ibm.modcap")
481+ , ("lnk", "application/x-ms-shortcut")
482+ , ("log", "text/plain")
483+ , ("lostxml", "application/lost+xml")
484+ , ("lrf", "application/octet-stream")
485+ , ("lrm", "application/vnd.ms-lrm")
486+ , ("ltf", "application/vnd.frogans.ltf")
487+ , ("lvp", "audio/vnd.lucent.voice")
488+ , ("lwp", "application/vnd.lotus-wordpro")
489+ , ("lzh", "application/x-lzh-compressed")
490+ , ("m13", "application/x-msmediaview")
491+ , ("m14", "application/x-msmediaview")
492+ , ("m1v", "video/mpeg")
493+ , ("m21", "application/mp21")
494+ , ("m2a", "audio/mpeg")
495+ , ("m2v", "video/mpeg")
496+ , ("m3a", "audio/mpeg")
497+ , ("m3u", "audio/x-mpegurl")
498+ , ("m3u8", "application/vnd.apple.mpegurl")
499+ , ("m4a", "audio/x-m4a")
500+ , ("m4u", "video/vnd.mpegurl")
501+ , ("m4v", "video/x-m4v")
502+ , ("ma", "application/mathematica")
503+ , ("mads", "application/mads+xml")
504+ , ("mag", "application/vnd.ecowin.chart")
505+ , ("maker", "application/vnd.framemaker")
506+ , ("man", "text/troff")
507+ , ("manifest", "text/cache-manifest")
508+ , ("mar", "application/octet-stream")
509+ , ("mathml", "application/mathml+xml")
510+ , ("mb", "application/mathematica")
511+ , ("mbk", "application/vnd.mobius.mbk")
512+ , ("mbox", "application/mbox")
513+ , ("mc1", "application/vnd.medcalcdata")
514+ , ("mcd", "application/vnd.mcd")
515+ , ("mcurl", "text/vnd.curl.mcurl")
516+ , ("mdb", "application/x-msaccess")
517+ , ("mdi", "image/vnd.ms-modi")
518+ , ("me", "text/troff")
519+ , ("mesh", "model/mesh")
520+ , ("meta4", "application/metalink4+xml")
521+ , ("metalink", "application/metalink+xml")
522+ , ("mets", "application/mets+xml")
523+ , ("mfm", "application/vnd.mfmp")
524+ , ("mft", "application/rpki-manifest")
525+ , ("mgp", "application/vnd.osgeo.mapguide.package")
526+ , ("mgz", "application/vnd.proteus.magazine")
527+ , ("mid", "audio/midi")
528+ , ("midi", "audio/midi")
529+ , ("mie", "application/x-mie")
530+ , ("mif", "application/vnd.mif")
531+ , ("mime", "message/rfc822")
532+ , ("mj2", "video/mj2")
533+ , ("mjp2", "video/mj2")
534+ , ("mjs", "application/javascript")
535+ , ("mk3d", "video/x-matroska")
536+ , ("mka", "audio/x-matroska")
537+ , ("mks", "video/x-matroska")
538+ , ("mkv", "video/x-matroska")
539+ , ("mlp", "application/vnd.dolby.mlp")
540+ , ("mmd", "application/vnd.chipnuts.karaoke-mmd")
541+ , ("mmf", "application/vnd.smaf")
542+ , ("mml", "text/mathml")
543+ , ("mmr", "image/vnd.fujixerox.edmics-mmr")
544+ , ("mng", "video/x-mng")
545+ , ("mny", "application/x-msmoney")
546+ , ("mobi", "application/x-mobipocket-ebook")
547+ , ("mods", "application/mods+xml")
548+ , ("mov", "video/quicktime")
549+ , ("movie", "video/x-sgi-movie")
550+ , ("mp2", "audio/mpeg")
551+ , ("mp21", "application/mp21")
552+ , ("mp2a", "audio/mpeg")
553+ , ("mp3", "audio/mpeg")
554+ , ("mp4", "video/mp4")
555+ , ("mp4a", "audio/mp4")
556+ , ("mp4s", "application/mp4")
557+ , ("mp4v", "video/mp4")
558+ , ("mpc", "application/vnd.mophun.certificate")
559+ , ("mpe", "video/mpeg")
560+ , ("mpeg", "video/mpeg")
561+ , ("mpg", "video/mpeg")
562+ , ("mpg4", "video/mp4")
563+ , ("mpga", "audio/mpeg")
564+ , ("mpkg", "application/vnd.apple.installer+xml")
565+ , ("mpm", "application/vnd.blueice.multipass")
566+ , ("mpn", "application/vnd.mophun.application")
567+ , ("mpp", "application/vnd.ms-project")
568+ , ("mpt", "application/vnd.ms-project")
569+ , ("mpy", "application/vnd.ibm.minipay")
570+ , ("mqy", "application/vnd.mobius.mqy")
571+ , ("mrc", "application/marc")
572+ , ("mrcx", "application/marcxml+xml")
573+ , ("ms", "text/troff")
574+ , ("mscml", "application/mediaservercontrol+xml")
575+ , ("mseed", "application/vnd.fdsn.mseed")
576+ , ("mseq", "application/vnd.mseq")
577+ , ("msf", "application/vnd.epson.msf")
578+ , ("msh", "model/mesh")
579+ , ("msi", "application/x-msdownload")
580+ , ("msl", "application/vnd.mobius.msl")
581+ , ("msm", "application/octet-stream")
582+ , ("msp", "application/octet-stream")
583+ , ("msty", "application/vnd.muvee.style")
584+ , ("mts", "model/vnd.mts")
585+ , ("mus", "application/vnd.musician")
586+ , ("musicxml", "application/vnd.recordare.musicxml+xml")
587+ , ("mvb", "application/x-msmediaview")
588+ , ("mwf", "application/vnd.mfer")
589+ , ("mxf", "application/mxf")
590+ , ("mxl", "application/vnd.recordare.musicxml")
591+ , ("mxml", "application/xv+xml")
592+ , ("mxs", "application/vnd.triscape.mxs")
593+ , ("mxu", "video/vnd.mpegurl")
594+ , ("n-gage", "application/vnd.nokia.n-gage.symbian.install")
595+ , ("n3", "text/n3")
596+ , ("nb", "application/mathematica")
597+ , ("nbp", "application/vnd.wolfram.player")
598+ , ("nc", "application/x-netcdf")
599+ , ("ncx", "application/x-dtbncx+xml")
600+ , ("nfo", "text/x-nfo")
601+ , ("ngdat", "application/vnd.nokia.n-gage.data")
602+ , ("nitf", "application/vnd.nitf")
603+ , ("nlu", "application/vnd.neurolanguage.nlu")
604+ , ("nml", "application/vnd.enliven")
605+ , ("nnd", "application/vnd.noblenet-directory")
606+ , ("nns", "application/vnd.noblenet-sealer")
607+ , ("nnw", "application/vnd.noblenet-web")
608+ , ("npx", "image/vnd.net-fpx")
609+ , ("nsc", "application/x-conference")
610+ , ("nsf", "application/vnd.lotus-notes")
611+ , ("ntf", "application/vnd.nitf")
612+ , ("nzb", "application/x-nzb")
613+ , ("oa2", "application/vnd.fujitsu.oasys2")
614+ , ("oa3", "application/vnd.fujitsu.oasys3")
615+ , ("oas", "application/vnd.fujitsu.oasys")
616+ , ("obd", "application/x-msbinder")
617+ , ("obj", "application/x-tgif")
618+ , ("oda", "application/oda")
619+ , ("odb", "application/vnd.oasis.opendocument.database")
620+ , ("odc", "application/vnd.oasis.opendocument.chart")
621+ , ("odf", "application/vnd.oasis.opendocument.formula")
622+ , ("odft", "application/vnd.oasis.opendocument.formula-template")
623+ , ("odg", "application/vnd.oasis.opendocument.graphics")
624+ , ("odi", "application/vnd.oasis.opendocument.image")
625+ , ("odm", "application/vnd.oasis.opendocument.text-master")
626+ , ("odp", "application/vnd.oasis.opendocument.presentation")
627+ , ("ods", "application/vnd.oasis.opendocument.spreadsheet")
628+ , ("odt", "application/vnd.oasis.opendocument.text")
629+ , ("oga", "audio/ogg")
630+ , ("ogg", "audio/ogg")
631+ , ("ogv", "video/ogg")
632+ , ("ogx", "application/ogg")
633+ , ("omdoc", "application/omdoc+xml")
634+ , ("onepkg", "application/onenote")
635+ , ("onetmp", "application/onenote")
636+ , ("onetoc", "application/onenote")
637+ , ("onetoc2", "application/onenote")
638+ , ("opf", "application/oebps-package+xml")
639+ , ("opml", "text/x-opml")
640+ , ("oprc", "application/vnd.palm")
641+ , ("org", "application/vnd.lotus-organizer")
642+ , ("osf", "application/vnd.yamaha.openscoreformat")
643+ , ("osfpvg", "application/vnd.yamaha.openscoreformat.osfpvg+xml")
644+ , ("otc", "application/vnd.oasis.opendocument.chart-template")
645+ , ("otf", "application/x-font-otf")
646+ , ("otg", "application/vnd.oasis.opendocument.graphics-template")
647+ , ("oth", "application/vnd.oasis.opendocument.text-web")
648+ , ("oti", "application/vnd.oasis.opendocument.image-template")
649+ , ("otp", "application/vnd.oasis.opendocument.presentation-template")
650+ , ("ots", "application/vnd.oasis.opendocument.spreadsheet-template")
651+ , ("ott", "application/vnd.oasis.opendocument.text-template")
652+ , ("oxps", "application/oxps")
653+ , ("oxt", "application/vnd.openofficeorg.extension")
654+ , ("p", "text/x-pascal")
655+ , ("p10", "application/pkcs10")
656+ , ("p12", "application/x-pkcs12")
657+ , ("p7b", "application/x-pkcs7-certificates")
658+ , ("p7c", "application/pkcs7-mime")
659+ , ("p7m", "application/pkcs7-mime")
660+ , ("p7r", "application/x-pkcs7-certreqresp")
661+ , ("p7s", "application/pkcs7-signature")
662+ , ("p8", "application/pkcs8")
663+ , ("pac", "application/x-ns-proxy-autoconfig")
664+ , ("pas", "text/x-pascal")
665+ , ("paw", "application/vnd.pawaafile")
666+ , ("pbd", "application/vnd.powerbuilder6")
667+ , ("pbm", "image/x-portable-bitmap")
668+ , ("pcap", "application/vnd.tcpdump.pcap")
669+ , ("pcf", "application/x-font-pcf")
670+ , ("pcl", "application/vnd.hp-pcl")
671+ , ("pclxl", "application/vnd.hp-pclxl")
672+ , ("pct", "image/x-pict")
673+ , ("pcurl", "application/vnd.curl.pcurl")
674+ , ("pcx", "image/x-pcx")
675+ , ("pdb", "application/vnd.palm")
676+ , ("pdf", "application/pdf")
677+ , ("pem", "application/x-x509-ca-cert")
678+ , ("pfa", "application/x-font-type1")
679+ , ("pfb", "application/x-font-type1")
680+ , ("pfm", "application/x-font-type1")
681+ , ("pfr", "application/font-tdpfr")
682+ , ("pfx", "application/x-pkcs12")
683+ , ("pgm", "image/x-portable-graymap")
684+ , ("pgn", "application/x-chess-pgn")
685+ , ("pgp", "application/pgp-encrypted")
686+ , ("pic", "image/x-pict")
687+ , ("pkg", "application/octet-stream")
688+ , ("pki", "application/pkixcmp")
689+ , ("pkipath", "application/pkix-pkipath")
690+ , ("pl", "application/x-perl")
691+ , ("plb", "application/vnd.3gpp.pic-bw-large")
692+ , ("plc", "application/vnd.mobius.plc")
693+ , ("plf", "application/vnd.pocketlearn")
694+ , ("pls", "application/pls+xml")
695+ , ("pm", "application/x-perl")
696+ , ("pml", "application/vnd.ctc-posml")
697+ , ("png", "image/png")
698+ , ("pnm", "image/x-portable-anymap")
699+ , ("portpkg", "application/vnd.macports.portpkg")
700+ , ("pot", "application/vnd.ms-powerpoint")
701+ , ("potm", "application/vnd.ms-powerpoint.template.macroenabled.12")
702+ , ("potx", "application/vnd.openxmlformats-officedocument.presentationml.template")
703+ , ("ppam", "application/vnd.ms-powerpoint.addin.macroenabled.12")
704+ , ("ppd", "application/vnd.cups-ppd")
705+ , ("ppm", "image/x-portable-pixmap")
706+ , ("pps", "application/vnd.ms-powerpoint")
707+ , ("ppsm", "application/vnd.ms-powerpoint.slideshow.macroenabled.12")
708+ , ("ppsx", "application/vnd.openxmlformats-officedocument.presentationml.slideshow")
709+ , ("ppt", "application/vnd.ms-powerpoint")
710+ , ("pptm", "application/vnd.ms-powerpoint.presentation.macroenabled.12")
711+ , ("pptx", "application/vnd.openxmlformats-officedocument.presentationml.presentation")
712+ , ("pqa", "application/vnd.palm")
713+ , ("prc", "application/x-mobipocket-ebook")
714+ , ("pre", "application/vnd.lotus-freelance")
715+ , ("prf", "application/pics-rules")
716+ , ("ps", "application/postscript")
717+ , ("psb", "application/vnd.3gpp.pic-bw-small")
718+ , ("psd", "image/vnd.adobe.photoshop")
719+ , ("psf", "application/x-font-linux-psf")
720+ , ("pskcxml", "application/pskc+xml")
721+ , ("ptid", "application/vnd.pvi.ptid1")
722+ , ("pub", "application/x-mspublisher")
723+ , ("pvb", "application/vnd.3gpp.pic-bw-var")
724+ , ("pwn", "application/vnd.3m.post-it-notes")
725+ , ("pya", "audio/vnd.ms-playready.media.pya")
726+ , ("pyv", "video/vnd.ms-playready.media.pyv")
727+ , ("qam", "application/vnd.epson.quickanime")
728+ , ("qbo", "application/vnd.intu.qbo")
729+ , ("qfx", "application/vnd.intu.qfx")
730+ , ("qps", "application/vnd.publishare-delta-tree")
731+ , ("qt", "video/quicktime")
732+ , ("qwd", "application/vnd.quark.quarkxpress")
733+ , ("qwt", "application/vnd.quark.quarkxpress")
734+ , ("qxb", "application/vnd.quark.quarkxpress")
735+ , ("qxd", "application/vnd.quark.quarkxpress")
736+ , ("qxl", "application/vnd.quark.quarkxpress")
737+ , ("qxt", "application/vnd.quark.quarkxpress")
738+ , ("ra", "audio/x-pn-realaudio")
739+ , ("ram", "audio/x-pn-realaudio")
740+ , ("rar", "application/x-rar-compressed")
741+ , ("ras", "image/x-cmu-raster")
742+ , ("rcprofile", "application/vnd.ipunplugged.rcprofile")
743+ , ("rdf", "application/rdf+xml")
744+ , ("rdz", "application/vnd.data-vision.rdz")
745+ , ("rep", "application/vnd.businessobjects")
746+ , ("res", "application/x-dtbresource+xml")
747+ , ("rgb", "image/x-rgb")
748+ , ("rif", "application/reginfo+xml")
749+ , ("rip", "audio/vnd.rip")
750+ , ("ris", "application/x-research-info-systems")
751+ , ("rl", "application/resource-lists+xml")
752+ , ("rlc", "image/vnd.fujixerox.edmics-rlc")
753+ , ("rld", "application/resource-lists-diff+xml")
754+ , ("rm", "application/vnd.rn-realmedia")
755+ , ("rmi", "audio/midi")
756+ , ("rmp", "audio/x-pn-realaudio-plugin")
757+ , ("rms", "application/vnd.jcp.javame.midlet-rms")
758+ , ("rmvb", "application/vnd.rn-realmedia-vbr")
759+ , ("rnc", "application/relax-ng-compact-syntax")
760+ , ("roa", "application/rpki-roa")
761+ , ("roff", "text/troff")
762+ , ("rp9", "application/vnd.cloanto.rp9")
763+ , ("rpm", "application/x-redhat-package-manager")
764+ , ("rpss", "application/vnd.nokia.radio-presets")
765+ , ("rpst", "application/vnd.nokia.radio-preset")
766+ , ("rq", "application/sparql-query")
767+ , ("rs", "application/rls-services+xml")
768+ , ("rsd", "application/rsd+xml")
769+ , ("rss", "application/rss+xml")
770+ , ("rtf", "application/rtf")
771+ , ("rtx", "text/richtext")
772+ , ("run", "application/x-makeself")
773+ , ("s", "text/x-asm")
774+ , ("s3m", "audio/s3m")
775+ , ("saf", "application/vnd.yamaha.smaf-audio")
776+ , ("sbml", "application/sbml+xml")
777+ , ("sc", "application/vnd.ibm.secure-container")
778+ , ("scd", "application/x-msschedule")
779+ , ("scm", "application/vnd.lotus-screencam")
780+ , ("scq", "application/scvp-cv-request")
781+ , ("scs", "application/scvp-cv-response")
782+ , ("scurl", "text/vnd.curl.scurl")
783+ , ("sda", "application/vnd.stardivision.draw")
784+ , ("sdc", "application/vnd.stardivision.calc")
785+ , ("sdd", "application/vnd.stardivision.impress")
786+ , ("sdkd", "application/vnd.solent.sdkm+xml")
787+ , ("sdkm", "application/vnd.solent.sdkm+xml")
788+ , ("sdp", "application/sdp")
789+ , ("sdw", "application/vnd.stardivision.writer")
790+ , ("sea", "application/x-sea")
791+ , ("see", "application/vnd.seemail")
792+ , ("seed", "application/vnd.fdsn.seed")
793+ , ("sema", "application/vnd.sema")
794+ , ("semd", "application/vnd.semd")
795+ , ("semf", "application/vnd.semf")
796+ , ("ser", "application/java-serialized-object")
797+ , ("setpay", "application/set-payment-initiation")
798+ , ("setreg", "application/set-registration-initiation")
799+ , ("sfd-hdstx", "application/vnd.hydrostatix.sof-data")
800+ , ("sfs", "application/vnd.spotfire.sfs")
801+ , ("sfv", "text/x-sfv")
802+ , ("sgi", "image/sgi")
803+ , ("sgl", "application/vnd.stardivision.writer-global")
804+ , ("sgm", "text/sgml")
805+ , ("sgml", "text/sgml")
806+ , ("sh", "application/x-sh")
807+ , ("shar", "application/x-shar")
808+ , ("shf", "application/shf+xml")
809+ , ("shtml", "text/html")
810+ , ("sid", "image/x-mrsid-image")
811+ , ("sig", "application/pgp-signature")
812+ , ("sil", "audio/silk")
813+ , ("silo", "model/mesh")
814+ , ("sis", "application/vnd.symbian.install")
815+ , ("sisx", "application/vnd.symbian.install")
816+ , ("sit", "application/x-stuffit")
817+ , ("sitx", "application/x-stuffitx")
818+ , ("skd", "application/vnd.koan")
819+ , ("skm", "application/vnd.koan")
820+ , ("skp", "application/vnd.koan")
821+ , ("skt", "application/vnd.koan")
822+ , ("sldm", "application/vnd.ms-powerpoint.slide.macroenabled.12")
823+ , ("sldx", "application/vnd.openxmlformats-officedocument.presentationml.slide")
824+ , ("slt", "application/vnd.epson.salt")
825+ , ("sm", "application/vnd.stepmania.stepchart")
826+ , ("smf", "application/vnd.stardivision.math")
827+ , ("smi", "application/smil+xml")
828+ , ("smil", "application/smil+xml")
829+ , ("smv", "video/x-smv")
830+ , ("smzip", "application/vnd.stepmania.package")
831+ , ("snd", "audio/basic")
832+ , ("snf", "application/x-font-snf")
833+ , ("so", "application/octet-stream")
834+ , ("spc", "application/x-pkcs7-certificates")
835+ , ("spf", "application/vnd.yamaha.smaf-phrase")
836+ , ("spl", "application/futuresplash")
837+ , ("spot", "text/vnd.in3d.spot")
838+ , ("spp", "application/scvp-vp-response")
839+ , ("spq", "application/scvp-vp-request")
840+ , ("spx", "audio/ogg")
841+ , ("sql", "application/x-sql")
842+ , ("src", "application/x-wais-source")
843+ , ("srt", "application/x-subrip")
844+ , ("sru", "application/sru+xml")
845+ , ("srx", "application/sparql-results+xml")
846+ , ("ssdl", "application/ssdl+xml")
847+ , ("sse", "application/vnd.kodak-descriptor")
848+ , ("ssf", "application/vnd.epson.ssf")
849+ , ("ssml", "application/ssml+xml")
850+ , ("st", "application/vnd.sailingtracker.track")
851+ , ("stc", "application/vnd.sun.xml.calc.template")
852+ , ("std", "application/vnd.sun.xml.draw.template")
853+ , ("stf", "application/vnd.wt.stf")
854+ , ("sti", "application/vnd.sun.xml.impress.template")
855+ , ("stk", "application/hyperstudio")
856+ , ("stl", "application/vnd.ms-pki.stl")
857+ , ("str", "application/vnd.pg.format")
858+ , ("stw", "application/vnd.sun.xml.writer.template")
859+ , ("sub", "text/vnd.dvb.subtitle")
860+ , ("sus", "application/vnd.sus-calendar")
861+ , ("susp", "application/vnd.sus-calendar")
862+ , ("sv4cpio", "application/x-sv4cpio")
863+ , ("sv4crc", "application/x-sv4crc")
864+ , ("svc", "application/vnd.dvb.service")
865+ , ("svd", "application/vnd.svd")
866+ , ("svg", "image/svg+xml")
867+ , ("svgz", "image/svg+xml")
868+ , ("swa", "application/x-director")
869+ , ("swf", "application/x-shockwave-flash")
870+ , ("swi", "application/vnd.aristanetworks.swi")
871+ , ("sxc", "application/vnd.sun.xml.calc")
872+ , ("sxd", "application/vnd.sun.xml.draw")
873+ , ("sxg", "application/vnd.sun.xml.writer.global")
874+ , ("sxi", "application/vnd.sun.xml.impress")
875+ , ("sxm", "application/vnd.sun.xml.math")
876+ , ("sxw", "application/vnd.sun.xml.writer")
877+ , ("t", "text/troff")
878+ , ("t3", "application/x-t3vm-image")
879+ , ("taglet", "application/vnd.mynfc")
880+ , ("tao", "application/vnd.tao.intent-module-archive")
881+ , ("tar", "application/x-tar")
882+ , ("tar.bz2", "application/x-bzip-compressed-tar")
883+ , ("tar.gz", "application/x-tgz")
884+ , ("tbz", "application/x-bzip-compressed-tar")
885+ , ("tcap", "application/vnd.3gpp2.tcap")
886+ , ("tcl", "application/x-tcl")
887+ , ("teacher", "application/vnd.smart.teacher")
888+ , ("tei", "application/tei+xml")
889+ , ("teicorpus", "application/tei+xml")
890+ , ("tex", "application/x-tex")
891+ , ("texi", "application/x-texinfo")
892+ , ("texinfo", "application/x-texinfo")
893+ , ("text", "text/plain")
894+ , ("tfi", "application/thraud+xml")
895+ , ("tfm", "application/x-tex-tfm")
896+ , ("tga", "image/x-tga")
897+ , ("tgz", "application/x-tgz")
898+ , ("thmx", "application/vnd.ms-officetheme")
899+ , ("tif", "image/tiff")
900+ , ("tiff", "image/tiff")
901+ , ("tk", "application/x-tcl")
902+ , ("tmo", "application/vnd.tmobile-livetv")
903+ , ("torrent", "application/x-bittorrent")
904+ , ("tpl", "application/vnd.groove-tool-template")
905+ , ("tpt", "application/vnd.trid.tpt")
906+ , ("tr", "text/troff")
907+ , ("tra", "application/vnd.trueapp")
908+ , ("trm", "application/x-msterminal")
909+ , ("tsd", "application/timestamped-data")
910+ , ("tsv", "text/tab-separated-values")
911+ , ("ttc", "application/x-font-ttf")
912+ , ("ttf", "application/x-font-ttf")
913+ , ("ttl", "text/turtle")
914+ , ("twd", "application/vnd.simtech-mindmapper")
915+ , ("twds", "application/vnd.simtech-mindmapper")
916+ , ("txd", "application/vnd.genomatix.tuxedo")
917+ , ("txf", "application/vnd.mobius.txf")
918+ , ("txt", "text/plain")
919+ , ("u32", "application/x-authorware-bin")
920+ , ("udeb", "application/x-debian-package")
921+ , ("ufd", "application/vnd.ufdl")
922+ , ("ufdl", "application/vnd.ufdl")
923+ , ("ulx", "application/x-glulx")
924+ , ("umj", "application/vnd.umajin")
925+ , ("unityweb", "application/vnd.unity")
926+ , ("uoml", "application/vnd.uoml+xml")
927+ , ("uri", "text/uri-list")
928+ , ("uris", "text/uri-list")
929+ , ("urls", "text/uri-list")
930+ , ("ustar", "application/x-ustar")
931+ , ("utz", "application/vnd.uiq.theme")
932+ , ("uu", "text/x-uuencode")
933+ , ("uva", "audio/vnd.dece.audio")
934+ , ("uvd", "application/vnd.dece.data")
935+ , ("uvf", "application/vnd.dece.data")
936+ , ("uvg", "image/vnd.dece.graphic")
937+ , ("uvh", "video/vnd.dece.hd")
938+ , ("uvi", "image/vnd.dece.graphic")
939+ , ("uvm", "video/vnd.dece.mobile")
940+ , ("uvp", "video/vnd.dece.pd")
941+ , ("uvs", "video/vnd.dece.sd")
942+ , ("uvt", "application/vnd.dece.ttml+xml")
943+ , ("uvu", "video/vnd.uvvu.mp4")
944+ , ("uvv", "video/vnd.dece.video")
945+ , ("uvva", "audio/vnd.dece.audio")
946+ , ("uvvd", "application/vnd.dece.data")
947+ , ("uvvf", "application/vnd.dece.data")
948+ , ("uvvg", "image/vnd.dece.graphic")
949+ , ("uvvh", "video/vnd.dece.hd")
950+ , ("uvvi", "image/vnd.dece.graphic")
951+ , ("uvvm", "video/vnd.dece.mobile")
952+ , ("uvvp", "video/vnd.dece.pd")
953+ , ("uvvs", "video/vnd.dece.sd")
954+ , ("uvvt", "application/vnd.dece.ttml+xml")
955+ , ("uvvu", "video/vnd.uvvu.mp4")
956+ , ("uvvv", "video/vnd.dece.video")
957+ , ("uvvx", "application/vnd.dece.unspecified")
958+ , ("uvvz", "application/vnd.dece.zip")
959+ , ("uvx", "application/vnd.dece.unspecified")
960+ , ("uvz", "application/vnd.dece.zip")
961+ , ("vcard", "text/vcard")
962+ , ("vcd", "application/x-cdlink")
963+ , ("vcf", "text/x-vcard")
964+ , ("vcg", "application/vnd.groove-vcard")
965+ , ("vcs", "text/x-vcalendar")
966+ , ("vcx", "application/vnd.vcx")
967+ , ("vis", "application/vnd.visionary")
968+ , ("viv", "video/vnd.vivo")
969+ , ("vob", "video/x-ms-vob")
970+ , ("vor", "application/vnd.stardivision.writer")
971+ , ("vox", "application/x-authorware-bin")
972+ , ("vrml", "model/vrml")
973+ , ("vsd", "application/vnd.visio")
974+ , ("vsf", "application/vnd.vsf")
975+ , ("vss", "application/vnd.visio")
976+ , ("vst", "application/vnd.visio")
977+ , ("vsw", "application/vnd.visio")
978+ , ("vtu", "model/vnd.vtu")
979+ , ("vxml", "application/voicexml+xml")
980+ , ("w3d", "application/x-director")
981+ , ("wad", "application/x-doom")
982+ , ("war", "application/java-archive")
983+ , ("wasm", "application/wasm")
984+ , ("wav", "audio/x-wav")
985+ , ("wax", "audio/x-ms-wax")
986+ , ("wbmp", "image/vnd.wap.wbmp")
987+ , ("wbs", "application/vnd.criticaltools.wbs+xml")
988+ , ("wbxml", "application/vnd.wap.wbxml")
989+ , ("wcm", "application/vnd.ms-works")
990+ , ("wdb", "application/vnd.ms-works")
991+ , ("wdp", "image/vnd.ms-photo")
992+ , ("weba", "audio/webm")
993+ , ("webm", "video/webm")
994+ , ("webp", "image/webp")
995+ , ("wg", "application/vnd.pmi.widget")
996+ , ("wgt", "application/widget")
997+ , ("wks", "application/vnd.ms-works")
998+ , ("wm", "video/x-ms-wm")
999+ , ("wma", "audio/x-ms-wma")
1000+ , ("wmd", "application/x-ms-wmd")
1001+ , ("wmf", "application/x-msmetafile")
1002+ , ("wml", "text/vnd.wap.wml")
1003+ , ("wmlc", "application/vnd.wap.wmlc")
1004+ , ("wmls", "text/vnd.wap.wmlscript")
1005+ , ("wmlsc", "application/vnd.wap.wmlscriptc")
1006+ , ("wmv", "video/x-ms-wmv")
1007+ , ("wmx", "video/x-ms-wmx")
1008+ , ("wmz", "application/x-msmetafile")
1009+ , ("woff", "application/font-woff")
1010+ , ("woff2", "application/font-woff2")
1011+ , ("wpd", "application/vnd.wordperfect")
1012+ , ("wpl", "application/vnd.ms-wpl")
1013+ , ("wps", "application/vnd.ms-works")
1014+ , ("wqd", "application/vnd.wqd")
1015+ , ("wri", "application/x-mswrite")
1016+ , ("wrl", "model/vrml")
1017+ , ("wsdl", "application/wsdl+xml")
1018+ , ("wspolicy", "application/wspolicy+xml")
1019+ , ("wtb", "application/vnd.webturbo")
1020+ , ("wvx", "video/x-ms-wvx")
1021+ , ("x32", "application/x-authorware-bin")
1022+ , ("x3d", "model/x3d+xml")
1023+ , ("x3db", "model/x3d+binary")
1024+ , ("x3dbz", "model/x3d+binary")
1025+ , ("x3dv", "model/x3d+vrml")
1026+ , ("x3dvz", "model/x3d+vrml")
1027+ , ("x3dz", "model/x3d+xml")
1028+ , ("xaml", "application/xaml+xml")
1029+ , ("xap", "application/x-silverlight-app")
1030+ , ("xar", "application/vnd.xara")
1031+ , ("xbap", "application/x-ms-xbap")
1032+ , ("xbd", "application/vnd.fujixerox.docuworks.binder")
1033+ , ("xbm", "image/x-xbitmap")
1034+ , ("xdf", "application/xcap-diff+xml")
1035+ , ("xdm", "application/vnd.syncml.dm+xml")
1036+ , ("xdp", "application/vnd.adobe.xdp+xml")
1037+ , ("xdssc", "application/dssc+xml")
1038+ , ("xdw", "application/vnd.fujixerox.docuworks")
1039+ , ("xenc", "application/xenc+xml")
1040+ , ("xer", "application/patch-ops-error+xml")
1041+ , ("xfdf", "application/vnd.adobe.xfdf")
1042+ , ("xfdl", "application/vnd.xfdl")
1043+ , ("xht", "application/xhtml+xml")
1044+ , ("xhtml", "application/xhtml+xml")
1045+ , ("xhvml", "application/xv+xml")
1046+ , ("xif", "image/vnd.xiff")
1047+ , ("xla", "application/vnd.ms-excel")
1048+ , ("xlam", "application/vnd.ms-excel.addin.macroenabled.12")
1049+ , ("xlc", "application/vnd.ms-excel")
1050+ , ("xlf", "application/x-xliff+xml")
1051+ , ("xlm", "application/vnd.ms-excel")
1052+ , ("xls", "application/vnd.ms-excel")
1053+ , ("xlsb", "application/vnd.ms-excel.sheet.binary.macroenabled.12")
1054+ , ("xlsm", "application/vnd.ms-excel.sheet.macroenabled.12")
1055+ , ("xlsx", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
1056+ , ("xlt", "application/vnd.ms-excel")
1057+ , ("xltm", "application/vnd.ms-excel.template.macroenabled.12")
1058+ , ("xltx", "application/vnd.openxmlformats-officedocument.spreadsheetml.template")
1059+ , ("xlw", "application/vnd.ms-excel")
1060+ , ("xm", "audio/xm")
1061+ , ("xml", "text/xml")
1062+ , ("xo", "application/vnd.olpc-sugar")
1063+ , ("xop", "application/xop+xml")
1064+ , ("xpi", "application/x-xpinstall")
1065+ , ("xpl", "application/xproc+xml")
1066+ , ("xpm", "image/x-xpixmap")
1067+ , ("xpr", "application/vnd.is-xpr")
1068+ , ("xps", "application/vnd.ms-xpsdocument")
1069+ , ("xpw", "application/vnd.intercon.formnet")
1070+ , ("xpx", "application/vnd.intercon.formnet")
1071+ , ("xsl", "application/xml")
1072+ , ("xslt", "application/xslt+xml")
1073+ , ("xsm", "application/vnd.syncml+xml")
1074+ , ("xspf", "application/xspf+xml")
1075+ , ("xul", "application/vnd.mozilla.xul+xml")
1076+ , ("xvm", "application/xv+xml")
1077+ , ("xvml", "application/xv+xml")
1078+ , ("xwd", "image/x-xwindowdump")
1079+ , ("xyz", "chemical/x-xyz")
1080+ , ("xz", "application/x-xz")
1081+ , ("yang", "application/yang")
1082+ , ("yin", "application/yin+xml")
1083+ , ("z1", "application/x-zmachine")
1084+ , ("z2", "application/x-zmachine")
1085+ , ("z3", "application/x-zmachine")
1086+ , ("z4", "application/x-zmachine")
1087+ , ("z5", "application/x-zmachine")
1088+ , ("z6", "application/x-zmachine")
1089+ , ("z7", "application/x-zmachine")
1090+ , ("z8", "application/x-zmachine")
1091+ , ("zaz", "application/vnd.zzazz.deck+xml")
1092+ , ("zip", "application/zip")
1093+ , ("zir", "application/vnd.zul")
1094+ , ("zirz", "application/vnd.zul")
1095+ , ("zmm", "application/vnd.handheld-entertainment+xml")
1096+ ]
mime-types/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## mime-types
2+
3+Basic mime-type handling types and functions
Setup.lhs → mime-types/Setup.lhsrenamed

The content is the same.

mime-types/mime-types.cabalnew file+24
@@ -0,0 +1,24 @@
1+name: mime-types
2+version: 0.1.0.9
3+synopsis: Basic mime-type handling types and functions
4+description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
5+homepage: https://github.com/yesodweb/wai
6+license: MIT
7+license-file: LICENSE
8+author: Michael Snoyman
9+maintainer: michael@snoyman.com
10+category: Web
11+build-type: Simple
12+cabal-version: >=1.8
13+extra-source-files: README.md ChangeLog.md
14+
15+library
16+ exposed-modules: Network.Mime
17+ build-depends: base >= 4 && < 5
18+ , containers
19+ , text
20+ , bytestring
21+
22+source-repository head
23+ type: git
24+ location: git://github.com/yesodweb/wai.git
runtests.hsdeleted−282
@@ -1,282 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Test.Framework (defaultMain, testGroup, Test)
3−import Test.Framework.Providers.HUnit
4−import Test.HUnit hiding (Test)
5−
6−import Network.Wai
7−import Network.Wai.Test
8−import Network.Wai.Parse
9−import qualified Data.ByteString as S
10−import qualified Data.ByteString.Char8 as S8
11−import qualified Data.ByteString.Lazy.Char8 as L8
12−import Control.Arrow
13−
14−import Network.Wai.Middleware.Jsonp
15−import Network.Wai.Middleware.Gzip
16−import Network.Wai.Middleware.Vhost
17−import Network.Wai.Middleware.Autohead
18−import Codec.Compression.GZip (decompress)
19−
20−import Data.Enumerator (run_, enumList, ($$))
21−import Control.Monad.IO.Class (liftIO)
22−
23−main :: IO ()
24−main = defaultMain [testSuite]
25−
26−testSuite :: Test
27−testSuite = testGroup "Network.Wai.Parse"
28− [ testCase "parseQueryString" caseParseQueryString
29− , testCase "parseQueryString with question mark" caseParseQueryStringQM
30− , testCase "parseHttpAccept" caseParseHttpAccept
31− , testCase "parseRequestBody" caseParseRequestBody
32− , testCase "findBound" caseFindBound
33− , testCase "sinkTillBound" caseSinkTillBound
34− , testCase "killCR" caseKillCR
35− , testCase "killCRLF" caseKillCRLF
36− , testCase "takeLine" caseTakeLine
37− , testCase "jsonp" caseJsonp
38− , testCase "gzip" caseGzip
39− , testCase "vhost" caseVhost
40− , testCase "autohead" caseAutohead
41− ]
42−
43−caseParseQueryString :: Assertion
44−caseParseQueryString = do
45− let go l r =
46− map (S8.pack *** S8.pack) l @=? parseQueryString (S8.pack r)
47−
48− go [] ""
49− go [("foo", "")] "foo"
50− go [("foo", "bar")] "foo=bar"
51− go [("foo", "bar"), ("baz", "bin")] "foo=bar&baz=bin"
52− go [("%Q", "")] "%Q"
53− go [("%1Q", "")] "%1Q"
54− go [("%1", "")] "%1"
55− go [("/", "")] "%2F"
56− go [("/", "")] "%2f"
57− go [("foo bar", "")] "foo+bar"
58−
59−caseParseQueryStringQM :: Assertion
60−caseParseQueryStringQM = do
61− let go l r =
62− map (S8.pack *** S8.pack) l
63− @=? parseQueryString (S8.pack $ '?' : r)
64−
65− go [] ""
66− go [("foo", "")] "foo"
67− go [("foo", "bar")] "foo=bar"
68− go [("foo", "bar"), ("baz", "bin")] "foo=bar&baz=bin"
69− go [("%Q", "")] "%Q"
70− go [("%1Q", "")] "%1Q"
71− go [("%1", "")] "%1"
72− go [("/", "")] "%2F"
73− go [("/", "")] "%2f"
74− go [("foo bar", "")] "foo+bar"
75−
76−caseParseHttpAccept :: Assertion
77−caseParseHttpAccept = do
78− let input =
79− S8.pack "text/plain; q=0.5, text/html, text/x-dvi; q=0.8, text/x-c"
80− expected = ["text/html", "text/x-c", "text/x-dvi", "text/plain"]
81− map S8.pack expected @=? parseHttpAccept input
82−
83−caseParseRequestBody :: Assertion
84−caseParseRequestBody = run_ t where
85− content2 = S8.pack $
86− "--AaB03x\n" ++
87− "Content-Disposition: form-data; name=\"document\"; filename=\"b.txt\"\n" ++
88− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
89− "This is a file.\n" ++
90− "It has two lines.\n" ++
91− "--AaB03x\n" ++
92− "Content-Disposition: form-data; name=\"title\"\n" ++
93− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
94− "A File\n" ++
95− "--AaB03x\n" ++
96− "Content-Disposition: form-data; name=\"summary\"\n" ++
97− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
98− "This is my file\n" ++
99− "file test\n" ++
100− "--AaB03x--"
101− content3 = S8.pack "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\nContent-Disposition: form-data; name=\"yaml\"; filename=\"README\"\r\nContent-Type: application/octet-stream\r\n\r\nPhoto blog using Hack.\n\r\n------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
102− t = do
103− let content1 = S8.pack "foo=bar&baz=bin"
104− let ctype1 = S8.pack "application/x-www-form-urlencoded"
105− result1 <- parseRequestBody lbsSink $ toRequest ctype1 content1
106− liftIO $ assertEqual "parsing post x-www-form-urlencoded"
107− (map (S8.pack *** S8.pack) [("foo", "bar"), ("baz", "bin")], [])
108− result1
109−
110− let ctype2 = S8.pack "multipart/form-data; boundary=AaB03x"
111− result2 <- parseRequestBody lbsSink $ toRequest ctype2 content2
112− let expectedsmap2 =
113− [ ("title", "A File")
114− , ("summary", "This is my file\nfile test")
115− ]
116− let textPlain = S8.pack $ "text/plain; charset=iso-8859-1"
117− let expectedfile2 =
118− [(S8.pack "document", FileInfo (S8.pack "b.txt") textPlain $ L8.pack
119− "This is a file.\nIt has two lines.")]
120− let expected2 = (map (S8.pack *** S8.pack) expectedsmap2, expectedfile2)
121− liftIO $ assertEqual "parsing post multipart/form-data"
122− expected2
123− result2
124−
125− let ctype3 = S8.pack "multipart/form-data; boundary=----WebKitFormBoundaryB1pWXPZ6lNr8RiLh"
126− result3 <- parseRequestBody lbsSink $ toRequest ctype3 content3
127− let expectedsmap3 = []
128− let expectedfile3 = [(S8.pack "yaml", FileInfo (S8.pack "README") (S8.pack "application/octet-stream") $
129− L8.pack "Photo blog using Hack.\n")]
130− let expected3 = (expectedsmap3, expectedfile3)
131− liftIO $ assertEqual "parsing actual post multipart/form-data"
132− expected3
133− result3
134−
135− result2' <- parseRequestBody lbsSink $ toRequest' ctype2 content2
136− liftIO $ assertEqual "parsing post multipart/form-data 2"
137− expected2
138− result2'
139−
140− result3' <- parseRequestBody lbsSink $ toRequest' ctype3 content3
141− liftIO $ assertEqual "parsing actual post multipart/form-data 2"
142− expected3
143− result3'
144−
145−toRequest :: S8.ByteString -> S8.ByteString -> Request
146−toRequest ctype content = Request
147− { requestHeaders = [("Content-Type", ctype)]
148− , requestBody = enumList 1 [content]
149− }
150−
151−toRequest' :: S8.ByteString -> S8.ByteString -> Request
152−toRequest' ctype content = Request
153− { requestHeaders = [("Content-Type", ctype)]
154− , requestBody = enumList 1 $ map S.singleton $ S.unpack content
155− }
156−
157−caseFindBound :: Assertion
158−caseFindBound = do
159− findBound (S8.pack "def") (S8.pack "abcdefghi") @?=
160− FoundBound (S8.pack "abc") (S8.pack "ghi")
161− findBound (S8.pack "def") (S8.pack "ABC") @?= NoBound
162− findBound (S8.pack "def") (S8.pack "abcd") @?= PartialBound
163− findBound (S8.pack "def") (S8.pack "abcdE") @?= NoBound
164− findBound (S8.pack "def") (S8.pack "abcdEdef") @?=
165− FoundBound (S8.pack "abcdE") (S8.pack "")
166−
167−caseSinkTillBound :: Assertion
168−caseSinkTillBound = do
169− let iter () _ = return ()
170− let src = S8.pack "this is some text"
171− bound1 = S8.pack "some"
172− bound2 = S8.pack "some!"
173− let enum = enumList 1 [src]
174− let helper _ _ = return ()
175− (_, res1) <- run_ $ enum $$ sinkTillBound bound1 helper ()
176− res1 @?= True
177− (_, res2) <- run_ $ enum $$ sinkTillBound bound2 helper ()
178− res2 @?= False
179−
180−caseKillCR :: Assertion
181−caseKillCR = do
182− "foo" @=? killCR "foo"
183− "foo" @=? killCR "foo\r"
184− "foo\r\n" @=? killCR "foo\r\n"
185− "foo\r'" @=? killCR "foo\r'"
186−
187−caseKillCRLF :: Assertion
188−caseKillCRLF = do
189− "foo" @=? killCRLF "foo"
190− "foo\r" @=? killCRLF "foo\r"
191− "foo" @=? killCRLF "foo\r\n"
192− "foo\r'" @=? killCRLF "foo\r'"
193− "foo" @=? killCRLF "foo\n"
194−
195−caseTakeLine :: Assertion
196−caseTakeLine = do
197− helper "foo\nbar\nbaz" "foo"
198− helper "foo\r\nbar\nbaz" "foo"
199− helper "foo\nbar\r\nbaz" "foo"
200− helper "foo\rbar\r\nbaz" "foo\rbar"
201− where
202− helper haystack needle = do
203− x <- run_ $ enumList 1 [haystack] $$ takeLine
204− Just needle @=? x
205−
206−jsonpApp = jsonp $ const $ return $ responseLBS
207− status200
208− [("Content-Type", "application/json")]
209− "{\"foo\":\"bar\"}"
210−
211−caseJsonp :: Assertion
212−caseJsonp = flip runSession jsonpApp $ do
213− sres1 <- request Request
214− { queryString = "callback=test"
215− , requestHeaders = [("Accept", "text/javascript")]
216− }
217− assertContentType "text/javascript" sres1
218− assertBody "test({\"foo\":\"bar\"})" sres1
219−
220− sres2 <- request Request
221− { queryString = "call_back=test"
222− , requestHeaders = [("Accept", "text/javascript")]
223− }
224− assertContentType "application/json" sres2
225− assertBody "{\"foo\":\"bar\"}" sres2
226−
227− sres3 <- request Request
228− { queryString = "callback=test"
229− , requestHeaders = [("Accept", "text/html")]
230− }
231− assertContentType "application/json" sres3
232− assertBody "{\"foo\":\"bar\"}" sres3
233−
234−gzipApp = gzip True $ const $ return $ responseLBS status200 [] "test"
235−
236−caseGzip :: Assertion
237−caseGzip = flip runSession gzipApp $ do
238− sres1 <- request Request
239− { requestHeaders = [("Accept-Encoding", "gzip")]
240− }
241− assertHeader "Content-Encoding" "gzip" sres1
242− liftIO $ decompress (simpleBody sres1) @?= "test"
243−
244− sres2 <- request Request
245− { requestHeaders = []
246− }
247− assertNoHeader "Content-Encoding" sres2
248− assertBody "test" sres2
249−
250−vhostApp1 = const $ return $ responseLBS status200 [] "app1"
251−vhostApp2 = const $ return $ responseLBS status200 [] "app2"
252−vhostApp = vhost
253− [ ((== "foo.com") . serverName, vhostApp1)
254− ]
255− vhostApp2
256−
257−caseVhost = flip runSession vhostApp $ do
258− sres1 <- request Request
259− { serverName = "foo.com"
260− }
261− assertBody "app1" sres1
262−
263− sres2 <- request Request
264− { serverName = "bar.com"
265− }
266− assertBody "app2" sres2
267−
268−autoheadApp = autohead $ const $ return $ responseLBS status200
269− [("Foo", "Bar")] "body"
270−
271−caseAutohead = flip runSession autoheadApp $ do
272− sres1 <- request Request
273− { requestMethod = "GET"
274− }
275− assertHeader "Foo" "Bar" sres1
276− assertBody "body" sres1
277−
278− sres1 <- request Request
279− { requestMethod = "HEAD"
280− }
281− assertHeader "Foo" "Bar" sres1
282− assertBody "" sres1
stack-lts-11.yamlnew file+27
@@ -0,0 +1,27 @@
1+resolver: lts-11.21
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+extra-deps:
17+- streaming-commons-0.2.1.0@sha256:163af02944f374f316e35257c1afbffefd2c2852a85a151d1ea0ad22152cf28d,4990
18+- http2-2.0.0
19+- network-byte-order-0.1.1.0
20+- tls-1.5.3
21+- tls-session-manager-0.0.4
22+- x509-1.7.5
23+nix:
24+ enable: false
25+ packages:
26+ - fcgi
27+ - zlib
stack-lts-12.yamlnew file+26
@@ -0,0 +1,26 @@
1+resolver: lts-12.6
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
21+extra-deps:
22+- http2-2.0.0
23+- network-byte-order-0.1.1.0
24+- tls-1.5.3
25+- tls-session-manager-0.0.4
26+- x509-1.7.5
stack-nightly.yamlnew file+20
@@ -0,0 +1,20 @@
1+resolver: nightly-2020-01-08
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
stack.yamlnew file+25
@@ -0,0 +1,25 @@
1+resolver: lts-14.22
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
21+extra-deps:
22+- http2-2.0.0
23+- network-byte-order-0.1.1.0
24+- tls-1.5.3
25+- tls-session-manager-0.0.4
test/sample.hsdeleted−25
@@ -1,25 +0,0 @@
1−import Data.ByteString.Char8 (unpack, pack)
2−import Data.ByteString.Lazy (fromChunks)
3−import Network.Wai
4−import Network.Wai.Enumerator
5−import Network.Wai.Middleware.Gzip
6−import Network.Wai.Middleware.Jsonp
7−import Network.Wai.Middleware.CleanPath
8−import Network.Wai.Handler.SimpleServer
9−
10−app :: [String] -> Application
11−app [] _ = return $ Response Status200 [] $ Right $ fromLBS
12− $ fromChunks $ flip map [1..10000] $ \i -> pack $
13− concat
14− [ "<p>Just this same paragraph again. "
15− , show i
16− , "</p>"
17− ]
18−app ["test.html"] _ = return $ Response Status200 [] $ Left "test.html"
19−app ["json"] _ =return $ Response Status200
20− [(ContentType, pack "application/json")]
21− $ Left "json"
22−app _ _ = return $ Response Status404 [] $ Left "../LICENSE"
23−
24−main :: IO ()
25−main = run 3000 $ jsonp $ gzip $ cleanPath app
time-manager/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
time-manager/System/TimeManager.hsnew file+152
@@ -0,0 +1,152 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+
3+module System.TimeManager (
4+ -- ** Types
5+ Manager
6+ , TimeoutAction
7+ , Handle
8+ -- ** Manager
9+ , initialize
10+ , stopManager
11+ , killManager
12+ , withManager
13+ -- ** Registration
14+ , register
15+ , registerKillThread
16+ -- ** Control
17+ , tickle
18+ , cancel
19+ , pause
20+ , resume
21+ -- ** Exceptions
22+ , TimeoutThread (..)
23+ ) where
24+
25+import Control.Concurrent (myThreadId)
26+import qualified Control.Exception as E
27+import Control.Reaper
28+import Data.Typeable (Typeable)
29+import Data.IORef (IORef)
30+import qualified Data.IORef as I
31+
32+----------------------------------------------------------------
33+
34+-- | A timeout manager
35+type Manager = Reaper [Handle] Handle
36+
37+-- | An action to be performed on timeout.
38+type TimeoutAction = IO ()
39+
40+-- | A handle used by 'Manager'
41+data Handle = Handle !(IORef TimeoutAction) !(IORef State)
42+
43+data State = Active -- Manager turns it to Inactive.
44+ | Inactive -- Manager removes it with timeout action.
45+ | Paused -- Manager does not change it.
46+ | Canceled -- Manager removes it without timeout action.
47+
48+----------------------------------------------------------------
49+
50+-- | Creating timeout manager which works every N micro seconds
51+-- where N is the first argument.
52+initialize :: Int -> IO Manager
53+initialize timeout = mkReaper defaultReaperSettings
54+ { reaperAction = mkListAction prune
55+ , reaperDelay = timeout
56+ }
57+ where
58+ prune m@(Handle actionRef stateRef) = do
59+ state <- I.atomicModifyIORef' stateRef (\x -> (inactivate x, x))
60+ case state of
61+ Inactive -> do
62+ onTimeout <- I.readIORef actionRef
63+ onTimeout `E.catch` ignoreAll
64+ return Nothing
65+ Canceled -> return Nothing
66+ _ -> return $ Just m
67+
68+ inactivate Active = Inactive
69+ inactivate x = x
70+
71+----------------------------------------------------------------
72+
73+-- | Stopping timeout manager with onTimeout fired.
74+stopManager :: Manager -> IO ()
75+stopManager mgr = E.mask_ (reaperStop mgr >>= mapM_ fire)
76+ where
77+ fire (Handle actionRef _) = do
78+ onTimeout <- I.readIORef actionRef
79+ onTimeout `E.catch` ignoreAll
80+
81+ignoreAll :: E.SomeException -> IO ()
82+ignoreAll _ = return ()
83+
84+-- | Killing timeout manager immediately without firing onTimeout.
85+killManager :: Manager -> IO ()
86+killManager = reaperKill
87+
88+----------------------------------------------------------------
89+
90+-- | Registering a timeout action.
91+register :: Manager -> TimeoutAction -> IO Handle
92+register mgr onTimeout = do
93+ actionRef <- I.newIORef onTimeout
94+ stateRef <- I.newIORef Active
95+ let h = Handle actionRef stateRef
96+ reaperAdd mgr h
97+ return h
98+
99+-- | Registering a timeout action of killing this thread.
100+registerKillThread :: Manager -> TimeoutAction -> IO Handle
101+registerKillThread m onTimeout = do
102+ -- If we hold ThreadId, the stack and data of the thread is leaked.
103+ -- If we hold Weak ThreadId, the stack is released. However, its
104+ -- data is still leaked probably because of a bug of GHC.
105+ -- So, let's just use ThreadId and release ThreadId by
106+ -- overriding the timeout action by "cancel".
107+ tid <- myThreadId
108+ -- First run the timeout action in case the child thread is masked.
109+ register m $ onTimeout `E.finally` E.throwTo tid TimeoutThread
110+
111+data TimeoutThread = TimeoutThread
112+ deriving Typeable
113+instance E.Exception TimeoutThread where
114+ toException = E.asyncExceptionToException
115+ fromException = E.asyncExceptionFromException
116+instance Show TimeoutThread where
117+ show TimeoutThread = "Thread killed by timeout manager"
118+
119+----------------------------------------------------------------
120+
121+-- | Setting the state to active.
122+-- 'Manager' turns active to inactive repeatedly.
123+tickle :: Handle -> IO ()
124+tickle (Handle _ stateRef) = I.writeIORef stateRef Active
125+
126+-- | Setting the state to canceled.
127+-- 'Manager' eventually removes this without timeout action.
128+cancel :: Handle -> IO ()
129+cancel (Handle actionRef stateRef) = do
130+ I.writeIORef actionRef (return ()) -- ensuring to release ThreadId
131+ I.writeIORef stateRef Canceled
132+
133+-- | Setting the state to paused.
134+-- 'Manager' does not change the value.
135+pause :: Handle -> IO ()
136+pause (Handle _ stateRef) = I.writeIORef stateRef Paused
137+
138+-- | Setting the paused state to active.
139+-- This is an alias to 'tickle'.
140+resume :: Handle -> IO ()
141+resume = tickle
142+
143+----------------------------------------------------------------
144+
145+-- | Call the inner function with a timeout manager.
146+withManager :: Int -- ^ timeout in microseconds
147+ -> (Manager -> IO a)
148+ -> IO a
149+withManager timeout f = do
150+ -- FIXME when stopManager is available, use it
151+ man <- initialize timeout
152+ f man
time-manager/time-manager.cabalnew file+19
@@ -0,0 +1,19 @@
1+Name: time-manager
2+Version: 0.0.0
3+Synopsis: Scalable timer
4+License: MIT
5+License-file: LICENSE
6+Author: Michael Snoyman and Kazu Yamamoto
7+Maintainer: kazu@iij.ad.jp
8+Homepage: http://github.com/yesodweb/wai
9+Category: System
10+Build-Type: Simple
11+Cabal-Version: >=1.8
12+Stability: Stable
13+Description: Scalable timer functions provided by a timer manager.
14+
15+Library
16+ Build-Depends: base >= 4.8 && < 5
17+ , auto-update
18+ Exposed-modules: System.TimeManager
19+ Ghc-Options: -Wall
wai-app-static/.ghcinew file+1
@@ -0,0 +1 @@
1+:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h -XCPP
wai-app-static/.gitignorenew file+2
@@ -0,0 +1,2 @@
1+dist/
2+cabal-dev
wai-app-static/ChangeLog.mdnew file+76
@@ -0,0 +1,76 @@
1+# wai-app-static changelog
2+
3+## 3.1.7.1
4+
5+* Update the test suite too
6+
7+## 3.1.7
8+
9+* Use 302 instead of 301 redirect, to avoid caching the presence of an index.html file
10+
11+## 3.1.6.3
12+
13+* The executable warp obeys `-h` option properly for host
14+now. Previously this used to invoke the help option. That can be
15+reached via `--help` as before.
16+
17+## 3.1.6.2
18+
19+* Drop dependency on blaze-builder
20+
21+## 3.1.6.1
22+
23+* Add `<>` import
24+
25+## 3.1.6
26+
27+* Make ssAddTrailingSlash work in combination with ssIndices [#569](https://github.com/yesodweb/wai/pull/569)
28+* Make ssIndices work with ssLookupFile and trailing slashes [#570](https://github.com/yesodweb/wai/pull/570)
29+
30+## 3.1.5
31+
32+* Switch to cryponite
33+
34+## 3.1.4.1
35+
36+* Support wai/warp 3.2
37+
38+## 3.1.4
39+
40+* Reinstate redirectToIndex
41+
42+## 3.1.3
43+
44+* Add 404 handler [#467](https://github.com/yesodweb/wai/pull/467)
45+
46+## 3.1.2
47+
48+* Honor ssIndices when used with defaultWebAppSettings [#460](https://github.com/yesodweb/wai/pull/460)
49+
50+## 3.1.1
51+
52+* Make adding a trailing slash optional [#327](https://github.com/yesodweb/wai/issues/327) [yesod#988](https://github.com/yesodweb/yesod/issues/988)
53+
54+## 3.1.0
55+
56+* Drop system-filepath
57+
58+## 3.0.1.1
59+
60+* Fix root links
61+
62+## 3.0.1
63+
64+* Better HEAD support [#354](https://github.com/yesodweb/wai/issues/354)
65+
66+## 3.0.0.6
67+
68+Fix trailing slashes for `UrlMap` and other non-root setups [#325](https://github.com/yesodweb/wai/issues/325)
69+
70+## 3.0.0.4
71+
72+Add missing trailing slashes [#312](https://github.com/yesodweb/wai/issues/312)
73+
74+## 3.0.0.3
75+
76+Support for time 1.5
wai-app-static/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-app-static/Network/Wai/Application/Static.hsnew file+289
@@ -0,0 +1,289 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+{-# LANGUAGE TemplateHaskell, CPP #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE PatternGuards #-}
6+-- | Static file serving for WAI.
7+module Network.Wai.Application.Static
8+ ( -- * WAI application
9+ staticApp
10+ -- ** Default Settings
11+ , defaultWebAppSettings
12+ , webAppSettingsWithLookup
13+ , defaultFileServerSettings
14+ , embeddedSettings
15+ -- ** Settings
16+ , StaticSettings
17+ , ssLookupFile
18+ , ssMkRedirect
19+ , ssGetMimeType
20+ , ssListing
21+ , ssIndices
22+ , ssMaxAge
23+ , ssRedirectToIndex
24+ , ssAddTrailingSlash
25+ , ss404Handler
26+ ) where
27+
28+import Prelude hiding (FilePath)
29+import qualified Network.Wai as W
30+import qualified Network.HTTP.Types as H
31+import Data.ByteString (ByteString)
32+import qualified Data.ByteString.Char8 as S8
33+import qualified Data.ByteString.Lazy as L
34+import Data.ByteString.Lazy.Char8 ()
35+import Control.Monad.IO.Class (liftIO)
36+
37+import Data.ByteString.Builder (toLazyByteString)
38+
39+import Data.FileEmbed (embedFile)
40+
41+import Data.Text (Text)
42+import qualified Data.Text as T
43+import qualified Data.Text.Encoding as TE
44+
45+import Network.HTTP.Date (parseHTTPDate, epochTimeToHTTPDate, formatHTTPDate)
46+
47+import WaiAppStatic.Types
48+import Util
49+import WaiAppStatic.Storage.Filesystem
50+import WaiAppStatic.Storage.Embedded
51+import Network.Mime (MimeType)
52+
53+data StaticResponse =
54+ -- | Just the etag hash or Nothing for no etag hash
55+ Redirect Pieces (Maybe ByteString)
56+ | RawRedirect ByteString
57+ | NotFound
58+ | FileResponse File H.ResponseHeaders
59+ | NotModified
60+ -- TODO: add file size
61+ | SendContent MimeType L.ByteString
62+ | WaiResponse W.Response
63+
64+safeInit :: [a] -> [a]
65+safeInit [] = []
66+safeInit xs = init xs
67+
68+filterButLast :: (a -> Bool) -> [a] -> [a]
69+filterButLast _ [] = []
70+filterButLast _ [x] = [x]
71+filterButLast f (x:xs)
72+ | f x = x : filterButLast f xs
73+ | otherwise = filterButLast f xs
74+
75+-- | Serve an appropriate response for a folder request.
76+serveFolder :: StaticSettings -> Pieces -> W.Request -> Folder -> IO StaticResponse
77+serveFolder StaticSettings {..} pieces req folder@Folder {..} =
78+ case ssListing of
79+ Just _ | Just path <- addTrailingSlash req, ssAddTrailingSlash ->
80+ return $ RawRedirect path
81+ Just listing -> do
82+ -- directory listings turned on, display it
83+ builder <- listing pieces folder
84+ return $ WaiResponse $ W.responseBuilder H.status200
85+ [ ("Content-Type", "text/html; charset=utf-8")
86+ ] builder
87+ Nothing -> return $ WaiResponse $ W.responseLBS H.status403
88+ [ ("Content-Type", "text/plain")
89+ ] "Directory listings disabled"
90+
91+addTrailingSlash :: W.Request -> Maybe ByteString
92+addTrailingSlash req
93+ | S8.null rp = Just "/"
94+ | S8.last rp == '/' = Nothing
95+ | otherwise = Just $ S8.snoc rp '/'
96+ where
97+ rp = W.rawPathInfo req
98+
99+checkPieces :: StaticSettings
100+ -> Pieces -- ^ parsed request
101+ -> W.Request
102+ -> IO StaticResponse
103+-- If we have any empty pieces in the middle of the requested path, generate a
104+-- redirect to get rid of them.
105+checkPieces _ pieces _ | any (T.null . fromPiece) $ safeInit pieces =
106+ return $ Redirect (filterButLast (not . T.null . fromPiece) pieces) Nothing
107+
108+checkPieces ss@StaticSettings {..} pieces req = do
109+ res <- lookupResult
110+ case res of
111+ Left location -> return $ RawRedirect location
112+ Right LRNotFound -> return NotFound
113+ Right (LRFile file) -> serveFile ss req file
114+ Right (LRFolder folder) -> serveFolder ss pieces req folder
115+ where
116+ lookupResult :: IO (Either ByteString LookupResult)
117+ lookupResult = do
118+ nonIndexResult <- ssLookupFile pieces
119+ case nonIndexResult of
120+ LRFile{} -> return $ Right nonIndexResult
121+ _ -> do
122+ eIndexResult <- lookupIndices (map (\ index -> dropLastIfNull pieces ++ [index]) ssIndices)
123+ return $ case eIndexResult of
124+ Left redirect -> Left redirect
125+ Right indexResult -> case indexResult of
126+ LRNotFound -> Right nonIndexResult
127+ LRFile file | ssRedirectToIndex ->
128+ let relPath =
129+ case reverse pieces of
130+ -- Served at root
131+ [] -> fromPiece $ fileName file
132+ lastSegment:_ ->
133+ case fromPiece lastSegment of
134+ -- Ends with a trailing slash
135+ "" -> fromPiece $ fileName file
136+ -- Lacks a trailing slash
137+ lastSegment' -> T.concat
138+ [ lastSegment'
139+ , "/"
140+ , fromPiece $ fileName file
141+ ]
142+ in Left $ TE.encodeUtf8 relPath
143+ _ -> Right indexResult
144+
145+ lookupIndices :: [Pieces] -> IO (Either ByteString LookupResult)
146+ lookupIndices (x : xs) = do
147+ res <- ssLookupFile x
148+ case res of
149+ LRNotFound -> lookupIndices xs
150+ _ -> return $ case (ssAddTrailingSlash, addTrailingSlash req) of
151+ (True, Just redirect) -> Left redirect
152+ _ -> Right res
153+ lookupIndices [] = return $ Right LRNotFound
154+
155+serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
156+serveFile StaticSettings {..} req file
157+ -- First check etag values, if turned on
158+ | ssUseHash = do
159+ mHash <- fileGetHash file
160+ case (mHash, lookup "if-none-match" $ W.requestHeaders req) of
161+ -- if-none-match matches the actual hash, return a 304
162+ (Just hash, Just lastHash) | hash == lastHash -> return NotModified
163+
164+ -- Didn't match, but we have a hash value. Send the file contents
165+ -- with an ETag header.
166+ --
167+ -- RFC7232 (HTTP 1.1):
168+ -- > A recipient MUST ignore If-Modified-Since if the request contains an
169+ -- > If-None-Match header field; the condition in If-None-Match is
170+ -- > considered to be a more accurate replacement for the condition in
171+ -- > If-Modified-Since, and the two are only combined for the sake of
172+ -- > interoperating with older intermediaries that might not implement
173+ -- > If-None-Match.
174+ (Just hash, _) -> respond [("ETag", hash)]
175+
176+ -- No hash value available, fall back to last modified support.
177+ (Nothing, _) -> lastMod
178+ -- etag turned off, so jump straight to last modified
179+ | otherwise = lastMod
180+ where
181+ mLastSent = lookup "if-modified-since" (W.requestHeaders req) >>= parseHTTPDate
182+ lastMod =
183+ case (fmap epochTimeToHTTPDate $ fileGetModified file, mLastSent) of
184+ -- File modified time is equal to the if-modified-since header,
185+ -- return a 304.
186+ --
187+ -- Question: should the comparison be, date <= lastSent?
188+ (Just mdate, Just lastSent)
189+ | mdate == lastSent -> return NotModified
190+
191+ -- Did not match, but we have a new last-modified header
192+ (Just mdate, _) -> respond [("last-modified", formatHTTPDate mdate)]
193+
194+ -- No modification time available
195+ (Nothing, _) -> respond []
196+
197+ -- Send a file response with the additional weak headers provided.
198+ respond headers = return $ FileResponse file $ cacheControl ssMaxAge headers
199+
200+-- | Return a difference list of headers based on the specified MaxAge.
201+--
202+-- This function will return both Cache-Control and Expires headers, as
203+-- relevant.
204+cacheControl :: MaxAge -> (H.ResponseHeaders -> H.ResponseHeaders)
205+cacheControl maxage =
206+ headerCacheControl . headerExpires
207+ where
208+ ccInt =
209+ case maxage of
210+ NoMaxAge -> Nothing
211+ MaxAgeSeconds i -> Just i
212+ MaxAgeForever -> Just oneYear
213+ oneYear :: Int
214+ oneYear = 60 * 60 * 24 * 365
215+
216+ headerCacheControl =
217+ case ccInt of
218+ Nothing -> id
219+ Just i -> (:) ("Cache-Control", S8.append "public, max-age=" $ S8.pack $ show i)
220+ headerExpires =
221+ case maxage of
222+ NoMaxAge -> id
223+ MaxAgeSeconds _ -> id -- FIXME
224+ MaxAgeForever -> (:) ("Expires", "Thu, 31 Dec 2037 23:55:55 GMT")
225+
226+-- | Turn a @StaticSettings@ into a WAI application.
227+staticApp :: StaticSettings -> W.Application
228+staticApp set req = staticAppPieces set (W.pathInfo req) req
229+
230+staticAppPieces :: StaticSettings -> [Text] -> W.Application
231+staticAppPieces _ _ req sendResponse
232+ | notElem (W.requestMethod req) ["GET", "HEAD"] = sendResponse $ W.responseLBS
233+ H.status405
234+ [("Content-Type", "text/plain")]
235+ "Only GET or HEAD is supported"
236+staticAppPieces _ [".hidden", "folder.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/folder.png")]
237+staticAppPieces _ [".hidden", "haskell.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/haskell.png")]
238+staticAppPieces ss rawPieces req sendResponse = liftIO $ do
239+ case toPieces rawPieces of
240+ Just pieces -> checkPieces ss pieces req >>= response
241+ Nothing -> sendResponse $ W.responseLBS H.status403
242+ [ ("Content-Type", "text/plain")
243+ ] "Forbidden"
244+ where
245+ response :: StaticResponse -> IO W.ResponseReceived
246+ response (FileResponse file ch) = do
247+ mimetype <- ssGetMimeType ss file
248+ -- let filesize = fileGetSize file
249+ let headers = ("Content-Type", mimetype)
250+ -- Let Warp provide the content-length, since it takes
251+ -- range requests into account
252+ -- : ("Content-Length", S8.pack $ show filesize)
253+ : ch
254+ sendResponse $ fileToResponse file H.status200 headers
255+
256+ response NotModified =
257+ sendResponse $ W.responseLBS H.status304 [] ""
258+
259+ response (SendContent mt lbs) = do
260+ -- TODO: set caching headers
261+ sendResponse $ W.responseLBS H.status200
262+ [ ("Content-Type", mt)
263+ -- TODO: set Content-Length
264+ ] lbs
265+
266+ response (Redirect pieces' mHash) = do
267+ let loc = ssMkRedirect ss pieces' $ L.toStrict $ toLazyByteString (H.encodePathSegments $ map fromPiece pieces')
268+ let qString = case mHash of
269+ Just hash -> replace "etag" (Just hash) (W.queryString req)
270+ Nothing -> remove "etag" (W.queryString req)
271+
272+ sendResponse $ W.responseLBS H.status302
273+ [ ("Content-Type", "text/plain")
274+ , ("Location", S8.append loc $ H.renderQuery True qString)
275+ ] "Redirect"
276+
277+ response (RawRedirect path) =
278+ sendResponse $ W.responseLBS H.status302
279+ [ ("Content-Type", "text/plain")
280+ , ("Location", path)
281+ ] "Redirect"
282+
283+ response NotFound = case (ss404Handler ss) of
284+ Just app -> app req sendResponse
285+ Nothing -> sendResponse $ W.responseLBS H.status404
286+ [ ("Content-Type", "text/plain")
287+ ] "File not found"
288+
289+ response (WaiResponse r) = sendResponse r
wai-app-static/READMEnew file

No changes to the content.

wai-app-static/README.mdnew file+5
@@ -0,0 +1,5 @@
1+## wai-app-static
2+
3+WAI application for static serving
4+
5+Also provides some helper functions and datatypes for use outside of WAI.
wai-app-static/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
wai-app-static/Util.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE OverloadedStrings, ViewPatterns #-}
2+module Util
3+ ( relativeDirFromPieces
4+ , defaultMkRedirect
5+ , replace
6+ , remove
7+ , dropLastIfNull
8+ ) where
9+
10+import WaiAppStatic.Types
11+import qualified Data.Text as T
12+import Data.ByteString (ByteString)
13+import qualified Data.ByteString.Char8 as S8
14+import qualified Data.Text.Encoding as TE
15+
16+-- alist helper functions
17+replace :: Eq a => a -> b -> [(a, b)] -> [(a, b)]
18+replace k v [] = [(k,v)]
19+replace k v (x:xs) | fst x == k = (k,v):xs
20+ | otherwise = x:replace k v xs
21+
22+remove :: Eq a => a -> [(a, b)] -> [(a, b)]
23+remove _ [] = []
24+remove k (x:xs) | fst x == k = xs
25+ | otherwise = x:remove k xs
26+
27+-- | Turn a list of pieces into a relative path to the root folder.
28+relativeDirFromPieces :: Pieces -> T.Text
29+relativeDirFromPieces pieces = T.concat $ map (const "../") (drop 1 pieces) -- last piece is not a dir
30+
31+-- | Construct redirects with relative paths.
32+defaultMkRedirect :: Pieces -> ByteString -> S8.ByteString
33+defaultMkRedirect pieces newPath
34+ | S8.null newPath || S8.null relDir ||
35+ S8.last relDir /= '/' || S8.head newPath /= '/' =
36+ relDir `S8.append` newPath
37+ | otherwise = relDir `S8.append` S8.tail newPath
38+ where
39+ relDir = TE.encodeUtf8 (relativeDirFromPieces pieces)
40+
41+dropLastIfNull :: [Piece] -> [Piece]
42+dropLastIfNull pieces = case pieces of
43+ [fromPiece -> ""] -> []
44+ (a : r) -> a : dropLastIfNull r
45+ [] -> []
wai-app-static/WaiAppStatic/CmdLine.hsnew file+118
@@ -0,0 +1,118 @@
1+{-# LANGUAGE DeriveDataTypeable, RecordWildCards #-}
2+-- | Command line version of wai-app-static, used for the warp-static server.
3+module WaiAppStatic.CmdLine
4+ ( runCommandLine
5+ , Args (..)
6+ ) where
7+
8+import Network.Wai (Middleware)
9+import Network.Wai.Application.Static (staticApp, defaultFileServerSettings)
10+import Network.Wai.Handler.Warp
11+ ( runSettings, defaultSettings, setHost, setPort
12+ )
13+import Options.Applicative
14+import Text.Printf (printf)
15+import System.Directory (canonicalizePath)
16+import Control.Monad (unless)
17+import Network.Wai.Middleware.RequestLogger (logStdout)
18+import Network.Wai.Middleware.Gzip
19+import qualified Data.Map as Map
20+import qualified Data.ByteString.Char8 as S8
21+import Control.Arrow ((***))
22+import Data.Text (pack)
23+import Data.String (fromString)
24+import Network.Mime (defaultMimeMap, mimeByExt, defaultMimeType)
25+import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
26+import Data.Maybe (mapMaybe)
27+import Control.Arrow (second)
28+import Data.Monoid ((<>))
29+
30+data Args = Args
31+ { docroot :: FilePath
32+ , index :: [FilePath]
33+ , port :: Int
34+ , noindex :: Bool
35+ , quiet :: Bool
36+ , verbose :: Bool
37+ , mime :: [(String, String)]
38+ , host :: String
39+ }
40+
41+#if MIN_VERSION_optparse_applicative(0, 10, 0)
42+option' :: Mod OptionFields Int -> Parser Int
43+option' = option auto
44+#else
45+option' = option
46+#endif
47+
48+args :: Parser Args
49+args = Args
50+ <$> strOption
51+ ( long "docroot"
52+ <> short 'd'
53+ <> metavar "DOCROOT"
54+ <> value "."
55+ <> help "directory containing files to serve")
56+ <*> (defIndex <$> many (strOption
57+ ( long "index"
58+ <> short 'i'
59+ <> metavar "INDEX"
60+ <> help "index files to serve when a directory is required"
61+ )))
62+ <*> option'
63+ ( long "port"
64+ <> short 'p'
65+ <> metavar "PORT"
66+ <> value 3000)
67+ <*> switch
68+ ( long "noindex"
69+ <> short 'n')
70+ <*> switch
71+ ( long "quiet"
72+ <> short 'q')
73+ <*> switch
74+ ( long "verbose"
75+ <> short 'v')
76+ <*> many (toPair <$> strOption
77+ ( long "mime"
78+ <> short 'm'
79+ <> metavar "MIME"
80+ <> help "extra file extension/mime type mappings"))
81+ <*> strOption
82+ ( long "host"
83+ <> short 'h'
84+ <> metavar "HOST"
85+ <> value "*"
86+ <> help "interface to bind to, special values: *, *4, *6")
87+ where
88+ toPair = second (drop 1) . break (== '=')
89+ defIndex [] = ["index.html", "index.htm"]
90+ defIndex x = x
91+
92+-- | Run with the given middleware and parsing options from the command line.
93+--
94+-- Since 2.0.1
95+runCommandLine :: (Args -> Middleware) -> IO ()
96+runCommandLine middleware = do
97+ args@Args {..} <- execParser $ info (helperOption <*> args) fullDesc
98+ let mime' = map (pack *** S8.pack) mime
99+ let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
100+ docroot' <- canonicalizePath docroot
101+ unless quiet $ printf "Serving directory %s on port %d with %s index files.\n" docroot' port (if noindex then "no" else show index)
102+ let middle = gzip def { gzipFiles = GzipCompress }
103+ . (if verbose then logStdout else id)
104+ . (middleware args)
105+ runSettings
106+ ( setPort port
107+ $ setHost (fromString host)
108+ defaultSettings
109+ )
110+ $ middle $ staticApp (defaultFileServerSettings $ fromString docroot)
111+ { ssIndices = if noindex then [] else mapMaybe (toPiece . pack) index
112+ , ssGetMimeType = return . mimeByExt mimeMap defaultMimeType . fromPiece . fileName
113+ }
114+ where
115+ helperOption :: Parser (a -> a)
116+ helperOption =
117+ abortOption ShowHelpText $
118+ mconcat [long "help", help "Show this help text", hidden]
wai-app-static/WaiAppStatic/Listing.hsnew file+150
@@ -0,0 +1,150 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ViewPatterns #-}
4+module WaiAppStatic.Listing
5+ ( defaultListing
6+ ) where
7+
8+import qualified Text.Blaze.Html5.Attributes as A
9+import qualified Text.Blaze.Html5 as H
10+import Text.Blaze ((!))
11+import qualified Data.Text as T
12+import Data.Time
13+import Data.Time.Clock.POSIX
14+import WaiAppStatic.Types
15+#if !MIN_VERSION_time(1,5,0)
16+import System.Locale (defaultTimeLocale)
17+#endif
18+import Data.List (sortBy)
19+import Util
20+
21+import qualified Text.Blaze.Html.Renderer.Utf8 as HU
22+
23+-- | Provides a default directory listing, suitable for most apps.
24+--
25+-- Code below taken from Happstack: <https://github.com/Happstack/happstack-server/blob/87e6c01a65c687d06c61345430a112fc9a444a95/src/Happstack/Server/FileServe/BuildingBlocks.hs>
26+defaultListing :: Listing
27+defaultListing pieces (Folder contents) = do
28+ let isTop = null pieces || map Just pieces == [toPiece ""]
29+ let fps'' :: [Either FolderName File]
30+ fps'' = (if isTop then id else (Left (unsafeToPiece "") :)) contents -- FIXME emptyParentFolder feels like a bit of a hack
31+ return $ HU.renderHtmlBuilder
32+ $ H.html $ do
33+ H.head $ do
34+ let title = T.intercalate "/" $ map fromPiece pieces
35+ let title' = if T.null title then "root folder" else title
36+ H.title $ H.toHtml title'
37+ H.style $ H.toHtml $ unlines [ "table { margin: 0 auto; width: 760px; border-collapse: collapse; font-family: 'sans-serif'; }"
38+ , "table, th, td { border: 1px solid #353948; }"
39+ , "td.size { text-align: right; font-size: 0.7em; width: 50px }"
40+ , "td.date { text-align: right; font-size: 0.7em; width: 130px }"
41+ , "td { padding-right: 1em; padding-left: 1em; }"
42+ , "th.first { background-color: white; width: 24px }"
43+ , "td.first { padding-right: 0; padding-left: 0; text-align: center }"
44+ , "tr { background-color: white; }"
45+ , "tr.alt { background-color: #A3B5BA}"
46+ , "th { background-color: #3C4569; color: white; font-size: 1.125em; }"
47+ , "h1 { width: 760px; margin: 1em auto; font-size: 1em; font-family: sans-serif }"
48+ , "img { width: 20px }"
49+ , "a { text-decoration: none }"
50+ ]
51+ H.body $ do
52+ let hasTrailingSlash =
53+ case map fromPiece $ reverse $ pieces of
54+ "":_ -> True
55+ _ -> False
56+ H.h1 $ showFolder' hasTrailingSlash $ filter (not . T.null . fromPiece) pieces
57+ renderDirectoryContentsTable (map fromPiece pieces) haskellSrc folderSrc fps''
58+ where
59+ image x = T.unpack $ T.concat [(relativeDirFromPieces pieces), ".hidden/", x, ".png"]
60+ folderSrc = image "folder"
61+ haskellSrc = image "haskell"
62+ showName "" = "root"
63+ showName x = x
64+
65+ -- Add a link to the root of the tree
66+ showFolder' :: Bool -> Pieces -> H.Html
67+ showFolder' hasTrailingSlash pieces' = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces')
68+
69+ showFolder :: Bool -> Pieces -> H.Html
70+ showFolder _ [] = "/" -- won't happen
71+ showFolder _ [x] = H.toHtml $ showName $ fromPiece x
72+ showFolder hasTrailingSlash (x:xs) = do
73+ let len = length xs - (if hasTrailingSlash then 0 else 1)
74+ href
75+ | len == 0 = "."
76+ | otherwise = concat $ replicate len "../" :: String
77+ H.a ! A.href (H.toValue href) $ H.toHtml $ showName $ fromPiece x
78+ " / " :: H.Html
79+ showFolder hasTrailingSlash xs
80+
81+-- | a function to generate an HTML table showing the contents of a directory on the disk
82+--
83+-- This function generates most of the content of the
84+-- 'renderDirectoryContents' page. If you want to style the page
85+-- differently, or add google analytics code, etc, you can just create
86+-- a new page template to wrap around this HTML.
87+--
88+-- see also: 'getMetaData', 'renderDirectoryContents'
89+renderDirectoryContentsTable :: [T.Text] -- ^ requested path info
90+ -> String
91+ -> String
92+ -> [Either FolderName File]
93+ -> H.Html
94+renderDirectoryContentsTable pathInfo' haskellSrc folderSrc fps =
95+ H.table $ do H.thead $ do H.th ! (A.class_ "first") $ H.img ! (A.src $ H.toValue haskellSrc)
96+ H.th "Name"
97+ H.th "Modified"
98+ H.th "Size"
99+ H.tbody $ mapM_ mkRow (zip (sortBy sortMD fps) $ cycle [False, True])
100+ where
101+ sortMD :: Either FolderName File -> Either FolderName File -> Ordering
102+ sortMD Left{} Right{} = LT
103+ sortMD Right{} Left{} = GT
104+ sortMD (Left a) (Left b) = compare a b
105+ sortMD (Right a) (Right b) = compare (fileName a) (fileName b)
106+
107+ mkRow :: (Either FolderName File, Bool) -> H.Html
108+ mkRow (md, alt) =
109+ (if alt then (! A.class_ "alt") else id) $
110+ H.tr $ do
111+ H.td ! A.class_ "first"
112+ $ case md of
113+ Left{} -> H.img ! A.src (H.toValue folderSrc)
114+ ! A.alt "Folder"
115+ Right{} -> return ()
116+ let name =
117+ case either id fileName md of
118+ (fromPiece -> "") -> unsafeToPiece ".."
119+ x -> x
120+ let isFile = either (const False) (const True) md
121+ href = addCurrentDir $ fromPiece name
122+ addCurrentDir x =
123+ case reverse pathInfo' of
124+ "":_ -> x -- has a trailing slash
125+ [] -> x -- at the root
126+ currentDir:_ -> T.concat [currentDir, "/", x]
127+ H.td (H.a ! A.href (H.toValue href) $ H.toHtml $ fromPiece name)
128+ H.td ! A.class_ "date" $ H.toHtml $
129+ case md of
130+ Right File { fileGetModified = Just t } ->
131+ formatCalendarTime defaultTimeLocale "%d-%b-%Y %X" t
132+ _ -> ""
133+ H.td ! A.class_ "size" $ H.toHtml $
134+ case md of
135+ Right File { fileGetSize = s } -> prettyShow s
136+ Left{} -> ""
137+ formatCalendarTime a b c = formatTime a b $ posixSecondsToUTCTime (realToFrac c :: POSIXTime)
138+ prettyShow x
139+ | x > 1024 = prettyShowK $ x `div` 1024
140+ | otherwise = addCommas "B" x
141+ prettyShowK x
142+ | x > 1024 = prettyShowM $ x `div` 1024
143+ | otherwise = addCommas "KB" x
144+ prettyShowM x
145+ | x > 1024 = prettyShowG $ x `div` 1024
146+ | otherwise = addCommas "MB" x
147+ prettyShowG x = addCommas "GB" x
148+ addCommas s = (++ (' ' : s)) . reverse . addCommas' . reverse . show
149+ addCommas' (a:b:c:d:e) = a : b : c : ',' : addCommas' (d : e)
150+ addCommas' x = x
wai-app-static/WaiAppStatic/Storage/Embedded.hsnew file+12
@@ -0,0 +1,12 @@
1+module WaiAppStatic.Storage.Embedded(
2+ -- * Basic
3+ embeddedSettings
4+
5+ -- * Template Haskell
6+ , Etag
7+ , EmbeddableEntry(..)
8+ , mkSettings
9+ ) where
10+
11+import WaiAppStatic.Storage.Embedded.Runtime
12+import WaiAppStatic.Storage.Embedded.TH
wai-app-static/WaiAppStatic/Storage/Embedded/Runtime.hsnew file+97
@@ -0,0 +1,97 @@
1+-- | Lookup files stored in memory instead of from the filesystem.
2+module WaiAppStatic.Storage.Embedded.Runtime
3+ ( -- * Settings
4+ embeddedSettings
5+ ) where
6+
7+import WaiAppStatic.Types
8+import Data.ByteString (ByteString)
9+import Control.Arrow ((&&&), second)
10+import Data.List
11+import Data.ByteString.Builder (byteString)
12+import qualified Network.Wai as W
13+import qualified Data.Map as Map
14+import Data.Function (on)
15+import qualified Data.Text as T
16+import Data.Ord
17+import qualified Data.ByteString as S
18+import Crypto.Hash (hash, MD5, Digest)
19+import Data.ByteArray.Encoding
20+import WaiAppStatic.Storage.Filesystem (defaultFileServerSettings)
21+import System.FilePath (isPathSeparator)
22+
23+-- | Serve the list of path/content pairs directly from memory.
24+embeddedSettings :: [(Prelude.FilePath, ByteString)] -> StaticSettings
25+embeddedSettings files = (defaultFileServerSettings $ error "unused")
26+ { ssLookupFile = embeddedLookup $ toEmbedded files
27+ }
28+
29+type Embedded = Map.Map Piece EmbeddedEntry
30+
31+data EmbeddedEntry = EEFile ByteString | EEFolder Embedded
32+
33+embeddedLookup :: Embedded -> Pieces -> IO LookupResult
34+embeddedLookup root pieces =
35+ return $ elookup pieces root
36+ where
37+ elookup :: Pieces -> Embedded -> LookupResult
38+ elookup [] x = LRFolder $ Folder $ map toEntry $ Map.toList x
39+ elookup [p] x | T.null (fromPiece p) = elookup [] x
40+ elookup (p:ps) x =
41+ case Map.lookup p x of
42+ Nothing -> LRNotFound
43+ Just (EEFile f) ->
44+ case ps of
45+ [] -> LRFile $ bsToFile p f
46+ _ -> LRNotFound
47+ Just (EEFolder y) -> elookup ps y
48+
49+toEntry :: (Piece, EmbeddedEntry) -> Either FolderName File
50+toEntry (name, EEFolder{}) = Left name
51+toEntry (name, EEFile bs) = Right File
52+ { fileGetSize = fromIntegral $ S.length bs
53+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
54+ , fileName = name
55+ , fileGetHash = return $ Just $ runHash bs
56+ , fileGetModified = Nothing
57+ }
58+
59+toEmbedded :: [(Prelude.FilePath, ByteString)] -> Embedded
60+toEmbedded fps =
61+ go texts
62+ where
63+ texts = map (\(x, y) -> (filter (not . T.null . fromPiece) $ toPieces' x, y)) fps
64+ toPieces' "" = []
65+ toPieces' x =
66+ -- See https://github.com/yesodweb/yesod/issues/626
67+ --
68+ -- We want to separate on the forward slash on *all* OSes, and on
69+ -- Windows, also separate on a backslash.
70+ let (y, z) = break isPathSeparator x
71+ in unsafeToPiece (T.pack y) : toPieces' (drop 1 z)
72+
73+ go :: [(Pieces, ByteString)] -> Embedded
74+ go orig =
75+ Map.fromList $ map (second go') hoisted
76+ where
77+ next = map (\(x, y) -> (head x, (tail x, y))) orig
78+ grouped :: [[(Piece, ([Piece], ByteString))]]
79+ grouped = groupBy ((==) `on` fst) $ sortBy (comparing fst) next
80+ hoisted :: [(Piece, [([Piece], ByteString)])]
81+ hoisted = map (fst . head &&& map snd) grouped
82+
83+ go' :: [(Pieces, ByteString)] -> EmbeddedEntry
84+ go' [([], content)] = EEFile content
85+ go' x = EEFolder $ go $ filter (\y -> not $ null $ fst y) x
86+
87+bsToFile :: Piece -> ByteString -> File
88+bsToFile name bs = File
89+ { fileGetSize = fromIntegral $ S.length bs
90+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
91+ , fileName = name
92+ , fileGetHash = return $ Just $ runHash bs
93+ , fileGetModified = Nothing
94+ }
95+
96+runHash :: ByteString -> ByteString
97+runHash = convertToBase Base64 . (hash :: S.ByteString -> Digest MD5)
wai-app-static/WaiAppStatic/Storage/Embedded/TH.hsnew file+277
@@ -0,0 +1,277 @@
1+{-# LANGUAGE TemplateHaskell, QuasiQuotes, OverloadedStrings, MagicHash #-}
2+module WaiAppStatic.Storage.Embedded.TH(
3+ Etag
4+ , EmbeddableEntry(..)
5+ , mkSettings
6+) where
7+
8+import Data.ByteString.Builder.Extra (byteStringInsert)
9+import Codec.Compression.GZip (compress)
10+import Data.ByteString.Unsafe (unsafePackAddressLen)
11+import Data.Either (lefts, rights)
12+import GHC.Exts (Int(..))
13+import Language.Haskell.TH
14+import Network.Mime (MimeType, defaultMimeLookup)
15+import System.IO.Unsafe (unsafeDupablePerformIO)
16+import WaiAppStatic.Types
17+import WaiAppStatic.Storage.Filesystem (defaultWebAppSettings)
18+import qualified Data.ByteString as B
19+import qualified Data.ByteString.Lazy as BL
20+#if !MIN_VERSION_template_haskell(2, 8, 0)
21+import qualified Data.ByteString.Char8 as B8
22+import qualified Data.ByteString.Lazy.Char8 as BL8
23+#endif
24+import qualified Data.HashMap.Strict as M
25+import qualified Data.Text as T
26+import qualified Data.Text.Encoding as T
27+import qualified Network.Wai as W
28+
29+-- | An Etag is used to return 304 Not Modified responses so the client does not need
30+-- to download resources a second time. Usually the etag is built from a hash of
31+-- the content. To disable Etags, you can pass the empty string. This will cause the
32+-- content to be redownloaded on every request.
33+type Etag = T.Text
34+
35+-- | Used at compile time to hold data about an entry to embed into the compiled executable.
36+data EmbeddableEntry = EmbeddableEntry {
37+ eLocation :: T.Text -- ^ The location where this resource should be served from. The
38+ -- location can contain forward slashes (/) to simulate directories,
39+ -- but must not end with a forward slash.
40+ , eMimeType :: MimeType -- ^ The mime type.
41+ , eContent :: Either (Etag, BL.ByteString) ExpQ
42+ -- ^ The content itself. The content can be given as a tag and bytestring,
43+ -- in which case the content will be embedded directly into the execuatble.
44+ -- Alternatively, the content can be given as a template haskell expression
45+ -- returning @IO ('Etag', 'BL.ByteString')@ in which case this action will
46+ -- be executed on every request to reload the content (this is useful
47+ -- for a debugging mode).
48+}
49+
50+-- | This structure is used at runtime to hold the entry.
51+data EmbeddedEntry = EmbeddedEntry {
52+ embLocation :: !T.Text
53+ , embMime :: !MimeType
54+ , embEtag :: !B.ByteString
55+ , embCompressed :: !Bool
56+ , embContent :: !B.ByteString
57+}
58+
59+-- | This structure is used at runtime to hold the reload entries.
60+data ReloadEntry = ReloadEntry {
61+ reloadLocation :: !T.Text
62+ , reloadMime :: !MimeType
63+ , reloadContent :: IO (T.Text, BL.ByteString)
64+}
65+
66+-- The use of unsafePackAddressLen is safe here because the length
67+-- is correct and we will only be reading from the bytestring, never
68+-- modifying it.
69+--
70+-- The only IO within unsafePackAddressLen is within newForeignPtr_ where
71+-- a new IORef is created as newIORef (NoFinalizers, []) to hold the finalizer
72+-- for the pointer. Since the pointer for the content will never have a finalizer
73+-- added, we do not care if this finalizer IORef gets created more than once since
74+-- the IORef will always be holding (NoFinalizers, []). Therefore
75+-- unsafeDupablePerformIO is safe.
76+bytestringE :: B.ByteString -> ExpQ
77+#if MIN_VERSION_template_haskell(2, 8, 0)
78+bytestringE b = [| unsafeDupablePerformIO (unsafePackAddressLen (I# $lenE) $ctE) |]
79+ where
80+ lenE = litE $ intPrimL $ toInteger $ B.length b
81+ ctE = litE $ stringPrimL $ B.unpack b
82+#else
83+bytestringE b =
84+ [| B8.pack $s |]
85+ where
86+ s = litE $ stringL $ B8.unpack b
87+#endif
88+
89+bytestringLazyE :: BL.ByteString -> ExpQ
90+#if MIN_VERSION_template_haskell(2, 8, 0)
91+bytestringLazyE b = [| unsafeDupablePerformIO (unsafePackAddressLen (I# $lenE) $ctE) |]
92+ where
93+ lenE = litE $ intPrimL $ toInteger $ BL.length b
94+ ctE = litE $ stringPrimL $ BL.unpack b
95+#else
96+bytestringLazyE b =
97+ [| B8.pack $s |]
98+ where
99+ s = litE $ stringL $ BL8.unpack b
100+#endif
101+
102+-- | A template haskell expression which creates either an EmbeddedEntry or ReloadEntry.
103+mkEntry :: EmbeddableEntry -> ExpQ
104+mkEntry (EmbeddableEntry loc mime (Left (etag, ct))) =
105+ [| Left $ EmbeddedEntry (T.pack $locE)
106+ $(bytestringE mime)
107+ $(bytestringE $ T.encodeUtf8 etag)
108+ (1 == I# $compressedE)
109+ $(bytestringLazyE ct')
110+ |]
111+ where
112+ locE = litE $ stringL $ T.unpack loc
113+ (compressed, ct') = tryCompress mime ct
114+ compressedE = litE $ intPrimL $ if compressed then 1 else 0
115+
116+mkEntry (EmbeddableEntry loc mime (Right expr)) =
117+ [| Right $ ReloadEntry (T.pack $locE)
118+ $(bytestringE mime)
119+ $expr
120+ |]
121+ where
122+ locE = litE $ stringL $ T.unpack loc
123+
124+-- | Converts an embedded entry to a file
125+embeddedToFile :: EmbeddedEntry -> File
126+embeddedToFile entry = File
127+ { fileGetSize = fromIntegral $ B.length $ embContent entry
128+ , fileToResponse = \s h ->
129+ let h' = if embCompressed entry
130+ then h ++ [("Content-Encoding", "gzip")]
131+ else h
132+ in W.responseBuilder s h' $ byteStringInsert $ embContent entry
133+
134+ -- Usually the fileName should just be the filename not the entire path,
135+ -- but we need the whole path to make the lookup within lookupMime
136+ -- possible. lookupMime is provided only with the File and from that
137+ -- we must find the mime type. Putting the path here is OK since
138+ -- within staticApp the fileName is used for directory listings which
139+ -- we have disabled.
140+ , fileName = unsafeToPiece $ embLocation entry
141+ , fileGetHash = return $ if B.null (embEtag entry)
142+ then Nothing
143+ else Just $ embEtag entry
144+ , fileGetModified = Nothing
145+ }
146+
147+-- | Converts a reload entry to a file
148+reloadToFile :: ReloadEntry -> IO File
149+reloadToFile entry = do
150+ (etag, ct) <- reloadContent entry
151+ let etag' = T.encodeUtf8 etag
152+ return $ File
153+ { fileGetSize = fromIntegral $ BL.length ct
154+ , fileToResponse = \s h -> W.responseLBS s h ct
155+ -- Similar to above the entire path needs to be in the fileName.
156+ , fileName = unsafeToPiece $ reloadLocation entry
157+ , fileGetHash = return $ if T.null etag then Nothing else Just etag'
158+ , fileGetModified = Nothing
159+ }
160+
161+
162+-- | Build a static settings based on a filemap.
163+filemapToSettings :: M.HashMap T.Text (MimeType, IO File) -> StaticSettings
164+filemapToSettings mfiles = (defaultWebAppSettings "")
165+ { ssLookupFile = lookupFile
166+ , ssGetMimeType = lookupMime
167+ }
168+ where
169+ piecesToFile p = T.intercalate "/" $ map fromPiece p
170+
171+ lookupFile [] = return LRNotFound
172+ lookupFile p =
173+ case M.lookup (piecesToFile p) mfiles of
174+ Nothing -> return LRNotFound
175+ Just (_,act) -> LRFile <$> act
176+
177+ lookupMime (File { fileName = p }) =
178+ case M.lookup (fromPiece p) mfiles of
179+ Just (mime,_) -> return mime
180+ Nothing -> return $ defaultMimeLookup $ fromPiece p
181+
182+-- | Create a 'StaticSettings' from a list of entries. Executed at run time.
183+entriesToSt :: [Either EmbeddedEntry ReloadEntry] -> StaticSettings
184+entriesToSt entries = hmap `seq` filemapToSettings hmap
185+ where
186+ embFiles = [ (embLocation e, (embMime e, return $ embeddedToFile e)) | e <- lefts entries]
187+ reloadFiles = [ (reloadLocation r, (reloadMime r, reloadToFile r)) | r <- rights entries]
188+ hmap = M.fromList $ embFiles ++ reloadFiles
189+
190+-- | Create a 'StaticSettings' at compile time that embeds resources directly into the compiled
191+-- executable. The embedded resources are precompressed (depending on mime type)
192+-- so that during runtime the resource can be served very quickly.
193+--
194+-- Because of GHC Template Haskell stage restrictions, you must define
195+-- the entries in a different module than where you create the 'StaticSettings'.
196+-- For example,
197+--
198+-- > {-# LANGUAGE TemplateHaskell, QuasiQuotes, OverloadedStrings #-}
199+-- > module A (mkEmbedded) where
200+-- >
201+-- > import WaiAppStatic.Storage.Embedded
202+-- > import Crypto.Hash.MD5 (hashlazy)
203+-- > import qualified Data.ByteString.Lazy as BL
204+-- > import qualified Data.ByteString.Base64 as B64
205+-- > import qualified Data.Text as T
206+-- > import qualified Data.Text.Encoding as T
207+-- >
208+-- > hash :: BL.ByteString -> T.Text
209+-- > hash = T.take 8 . T.decodeUtf8 . B64.encode . hashlazy
210+-- >
211+-- > mkEmbedded :: IO [EmbeddableEntry]
212+-- > mkEmbedded = do
213+-- > file <- BL.readFile "test.css"
214+-- > let emb = EmbeddableEntry {
215+-- > eLocation = "somedir/test.css"
216+-- > , eMimeType = "text/css"
217+-- > , eContent = Left (hash file, file)
218+-- > }
219+-- >
220+-- > let reload = EmbeddableEntry {
221+-- > eLocation = "anotherdir/test2.txt"
222+-- > , eMimeType = "text/plain"
223+-- > , eContent = Right [| BL.readFile "test2.txt" >>= \c -> return (hash c, c) |]
224+-- > }
225+-- >
226+-- > return [emb, reload]
227+--
228+-- The above @mkEmbedded@ will be executed at compile time. It loads the contents of test.css and
229+-- computes the hash of test.css for the etag. The content will be available at the URL somedir/test.css.
230+-- Internally, 'embedApp' below will attempt to compress the content at compile time. The compression will
231+-- only happen if the compressed content is shorter than the original and the mime type is either text or
232+-- javascript. If the content is compressed, at runtime the precomputed compressed content will be served
233+-- with the appropriate HTTP header. If 'embedApp' decides not to compress the content, it will be
234+-- served directly.
235+--
236+-- Secondly, @mkEmbedded@ creates a reloadable entry. This will be available at the URL anotherdir/test2.txt.
237+-- Whenver a request comes in for anotherdir/test2.txt, the action inside the quasiquote in eContent will
238+-- be executed. This will re-read the test2.txt file and recompute its hash.
239+--
240+-- Finally, here is a module which uses the above action to create a 'W.Application'.
241+--
242+-- > {-# LANGUAGE TemplateHaskell #-}
243+-- > module B where
244+-- >
245+-- > import A
246+-- > import Network.Wai (Application)
247+-- > import Network.Wai.Application.Static (staticApp)
248+-- > import WaiAppStatic.Storage.Embedded
249+-- > import Network.Wai.Handler.Warp (run)
250+-- >
251+-- > myApp :: Application
252+-- > myApp = staticApp $(mkSettings mkEmbedded)
253+-- >
254+-- > main :: IO ()
255+-- > main = run 3000 myApp
256+mkSettings :: IO [EmbeddableEntry] -> ExpQ
257+mkSettings action = do
258+ entries <- runIO action
259+ [| entriesToSt $(listE $ map mkEntry entries) |]
260+
261+shouldCompress :: MimeType -> Bool
262+shouldCompress m = "text/" `B.isPrefixOf` m || m `elem` extra
263+ where
264+ extra = [ "application/json"
265+ , "application/javascript"
266+ , "application/ecmascript"
267+ ]
268+
269+-- | Only compress if the mime type is correct and the compressed text is actually shorter.
270+tryCompress :: MimeType -> BL.ByteString -> (Bool, BL.ByteString)
271+tryCompress mime ct
272+ | shouldCompress mime = (c, ct')
273+ | otherwise = (False, ct)
274+ where
275+ compressed = compress ct
276+ c = BL.length compressed < BL.length ct
277+ ct' = if c then compressed else ct
wai-app-static/WaiAppStatic/Storage/Filesystem.hsnew file+170
@@ -0,0 +1,170 @@
1+{-# LANGUAGE ScopedTypeVariables #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
4+-- | Access files on the filesystem.
5+module WaiAppStatic.Storage.Filesystem
6+ ( -- * Types
7+ ETagLookup
8+ -- * Settings
9+ , defaultWebAppSettings
10+ , defaultFileServerSettings
11+ , webAppSettingsWithLookup
12+ ) where
13+
14+import WaiAppStatic.Types
15+import System.FilePath ((</>))
16+import System.IO (withBinaryFile, IOMode(..))
17+import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
18+import Data.List (foldl')
19+import Control.Monad (forM)
20+import Util
21+import Data.ByteString (ByteString)
22+import Control.Exception (SomeException, try)
23+import qualified Network.Wai as W
24+import WaiAppStatic.Listing
25+import Network.Mime
26+import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
27+import Data.Maybe (catMaybes)
28+import Data.ByteArray.Encoding
29+import Crypto.Hash (hashlazy, MD5, Digest)
30+import qualified Data.ByteString.Lazy as BL (hGetContents)
31+import qualified Data.Text as T
32+
33+-- | Construct a new path from a root and some @Pieces@.
34+pathFromPieces :: FilePath -> Pieces -> FilePath
35+pathFromPieces = foldl' (\fp p -> fp </> T.unpack (fromPiece p))
36+
37+-- | Settings optimized for a web application. Files will have aggressive
38+-- caching applied and hashes calculated, and indices and listings are disabled.
39+defaultWebAppSettings :: FilePath -- ^ root folder to serve from
40+ -> StaticSettings
41+defaultWebAppSettings root = StaticSettings
42+ { ssLookupFile = webAppLookup hashFileIfExists root
43+ , ssMkRedirect = defaultMkRedirect
44+ , ssGetMimeType = return . defaultMimeLookup . fromPiece . fileName
45+ , ssMaxAge = MaxAgeForever
46+ , ssListing = Nothing
47+ , ssIndices = []
48+ , ssRedirectToIndex = False
49+ , ssUseHash = True
50+ , ssAddTrailingSlash = False
51+ , ss404Handler = Nothing
52+ }
53+
54+-- | Settings optimized for a file server. More conservative caching will be
55+-- applied, and indices and listings are enabled.
56+defaultFileServerSettings :: FilePath -- ^ root folder to serve from
57+ -> StaticSettings
58+defaultFileServerSettings root = StaticSettings
59+ { ssLookupFile = fileSystemLookup (fmap Just . hashFile) root
60+ , ssMkRedirect = defaultMkRedirect
61+ , ssGetMimeType = return . defaultMimeLookup . fromPiece . fileName
62+ , ssMaxAge = NoMaxAge
63+ , ssListing = Just defaultListing
64+ , ssIndices = map unsafeToPiece ["index.html", "index.htm"]
65+ , ssRedirectToIndex = False
66+ , ssUseHash = False
67+ , ssAddTrailingSlash = False
68+ , ss404Handler = Nothing
69+ }
70+
71+-- | Same as @defaultWebAppSettings@, but additionally uses a specialized
72+-- @ETagLookup@ in place of the standard one. This can allow you to cache your
73+-- hash values, or even precompute them.
74+webAppSettingsWithLookup :: FilePath -- ^ root folder to serve from
75+ -> ETagLookup
76+ -> StaticSettings
77+webAppSettingsWithLookup dir etagLookup =
78+ (defaultWebAppSettings dir) { ssLookupFile = webAppLookup etagLookup dir}
79+
80+-- | Convenience wrapper for @fileHelper@.
81+fileHelperLR :: ETagLookup
82+ -> FilePath -- ^ file location
83+ -> Piece -- ^ file name
84+ -> IO LookupResult
85+fileHelperLR a b c = fmap (maybe LRNotFound LRFile) $ fileHelper a b c
86+
87+-- | Attempt to load up a @File@ from the given path.
88+fileHelper :: ETagLookup
89+ -> FilePath -- ^ file location
90+ -> Piece -- ^ file name
91+ -> IO (Maybe File)
92+fileHelper hashFunc fp name = do
93+ efs <- try $ getFileStatus fp
94+ case efs of
95+ Left (_ :: SomeException) -> return Nothing
96+ Right fs | isRegularFile fs -> return $ Just File
97+ { fileGetSize = fromIntegral $ fileSize fs
98+ , fileToResponse = \s h -> W.responseFile s h fp Nothing
99+ , fileName = name
100+ , fileGetHash = hashFunc fp
101+ , fileGetModified = Just $ modificationTime fs
102+ }
103+ Right _ -> return Nothing
104+
105+-- | How to calculate etags. Can perform filesystem reads on each call, or use
106+-- some caching mechanism.
107+type ETagLookup = FilePath -> IO (Maybe ByteString)
108+
109+-- | More efficient than @fileSystemLookup@ as it only concerns itself with
110+-- finding files, not folders.
111+webAppLookup :: ETagLookup -> FilePath -> Pieces -> IO LookupResult
112+webAppLookup hashFunc prefix pieces =
113+ fileHelperLR hashFunc fp lastPiece
114+ where
115+ fp = pathFromPieces prefix pieces
116+ lastPiece
117+ | null pieces = unsafeToPiece ""
118+ | otherwise = last pieces
119+
120+-- | MD5 hash and base64-encode the file contents. Does not check if the file
121+-- exists.
122+hashFile :: FilePath -> IO ByteString
123+hashFile fp = withBinaryFile fp ReadMode $ \h -> do
124+ f <- BL.hGetContents h
125+ let !hash = hashlazy f :: Digest MD5
126+ return $ convertToBase Base64 hash
127+
128+hashFileIfExists :: ETagLookup
129+hashFileIfExists fp = do
130+ res <- try $ hashFile fp
131+ return $ case res of
132+ Left (_ :: SomeException) -> Nothing
133+ Right x -> Just x
134+
135+isVisible :: FilePath -> Bool
136+isVisible ('.':_) = False
137+isVisible "" = False
138+isVisible _ = True
139+
140+-- | Get a proper @LookupResult@, checking if the path is a file or folder.
141+-- Compare with @webAppLookup@, which only deals with files.
142+fileSystemLookup :: ETagLookup
143+ -> FilePath -> Pieces -> IO LookupResult
144+fileSystemLookup hashFunc prefix pieces = do
145+ let fp = pathFromPieces prefix pieces
146+ fe <- doesFileExist fp
147+ if fe
148+ then fileHelperLR hashFunc fp lastPiece
149+ else do
150+ de <- doesDirectoryExist fp
151+ if de
152+ then do
153+ entries' <- fmap (filter isVisible) $ getDirectoryContents fp
154+ entries <- forM entries' $ \fpRel' -> do
155+ let name = unsafeToPiece $ T.pack fpRel'
156+ fp' = fp </> fpRel'
157+ de' <- doesDirectoryExist fp'
158+ if de'
159+ then return $ Just $ Left name
160+ else do
161+ mfile <- fileHelper hashFunc fp' name
162+ case mfile of
163+ Nothing -> return Nothing
164+ Just file -> return $ Just $ Right file
165+ return $ LRFolder $ Folder $ catMaybes entries
166+ else return LRNotFound
167+ where
168+ lastPiece
169+ | null pieces = unsafeToPiece ""
170+ | otherwise = last pieces
wai-app-static/WaiAppStatic/Types.hsnew file+153
@@ -0,0 +1,153 @@
1+module WaiAppStatic.Types
2+ ( -- * Pieces
3+ Piece
4+ , toPiece
5+ , fromPiece
6+ , unsafeToPiece
7+ , Pieces
8+ , toPieces
9+ -- * Caching
10+ , MaxAge (..)
11+ -- * File\/folder serving
12+ , FolderName
13+ , Folder (..)
14+ , File (..)
15+ , LookupResult (..)
16+ , Listing
17+ -- * Settings
18+ , StaticSettings (..)
19+ ) where
20+
21+import Data.Text (Text)
22+import qualified Network.HTTP.Types as H
23+import qualified Network.Wai as W
24+import Data.ByteString (ByteString)
25+import System.Posix.Types (EpochTime)
26+import qualified Data.Text as T
27+import Data.ByteString.Builder (Builder)
28+import Network.Mime (MimeType)
29+
30+-- | An individual component of a path, or of a filepath.
31+--
32+-- This is the core type used by wai-app-static for doing lookups. It provides
33+-- a smart constructor to avoid the possibility of constructing unsafe path
34+-- segments (though @unsafeToPiece@ can get around that as necessary).
35+--
36+-- Individual file lookup backends must know how to convert from a @Piece@ to
37+-- their storage system.
38+newtype Piece = Piece { fromPiece :: Text }
39+ deriving (Show, Eq, Ord)
40+
41+-- | Smart constructor for a @Piece@. Won\'t allow unsafe components, such as
42+-- pieces beginning with a period or containing a slash. This /will/, however,
43+-- allow null pieces.
44+toPiece :: Text -> Maybe Piece
45+toPiece t
46+ | T.null t = Just $ Piece t
47+ | T.head t == '.' = Nothing
48+ | T.any (== '/') t = Nothing
49+ | otherwise = Just $ Piece t
50+
51+-- | Construct a @Piece@ without input validation.
52+unsafeToPiece :: Text -> Piece
53+unsafeToPiece = Piece
54+
55+-- | Call @toPiece@ on a list.
56+--
57+-- > toPieces = mapM toPiece
58+toPieces :: [Text] -> Maybe Pieces
59+toPieces = mapM toPiece
60+
61+-- | Request coming from a user. Corresponds to @pathInfo@.
62+--
63+-- The root path is the empty list.
64+type Pieces = [Piece]
65+
66+-- | Values for the max-age component of the cache-control response header.
67+data MaxAge = NoMaxAge -- ^ no cache-control set
68+ | MaxAgeSeconds Int -- ^ set to the given number of seconds
69+ | MaxAgeForever -- ^ essentially infinite caching; in reality, probably one year
70+
71+-- | Just the name of a folder.
72+type FolderName = Piece
73+
74+-- | Represent contents of a single folder, which can be itself either a file
75+-- or a folder.
76+data Folder = Folder
77+ { folderContents :: [Either FolderName File]
78+ }
79+
80+-- | Information on an individual file.
81+data File = File
82+ { -- | Size of file in bytes
83+ fileGetSize :: Integer
84+ -- | How to construct a WAI response for this file. Some files are stored
85+ -- on the filesystem and can use @ResponseFile@, while others are stored
86+ -- in memory and should use @ResponseBuilder@.
87+ , fileToResponse :: H.Status -> H.ResponseHeaders -> W.Response
88+ -- | Last component of the filename.
89+ , fileName :: Piece
90+ -- | Calculate a hash of the contents of this file, such as for etag.
91+ , fileGetHash :: IO (Maybe ByteString)
92+ -- | Last modified time, used for both display in listings and if-modified-since.
93+ , fileGetModified :: Maybe EpochTime
94+ }
95+
96+-- | Result of looking up a file in some storage backend.
97+--
98+-- The lookup is either a file or folder, or does not exist.
99+data LookupResult = LRFile File
100+ | LRFolder Folder
101+ | LRNotFound
102+
103+-- | How to construct a directory listing page for the given request path and
104+-- the resulting folder.
105+type Listing = Pieces -> Folder -> IO Builder
106+
107+-- | All of the settings available to users for tweaking wai-app-static.
108+--
109+-- Note that you should use the settings type approach for modifying values.
110+-- See <http://www.yesodweb.com/book/settings-types> for more information.
111+data StaticSettings = StaticSettings
112+ {
113+ -- | Lookup a single file or folder. This is how you can control storage
114+ -- backend (filesystem, embedded, etc) and where to lookup.
115+ ssLookupFile :: Pieces -> IO LookupResult
116+
117+ -- | Determine the mime type of the given file. Note that this function
118+ -- lives in @IO@ in case you want to perform more complicated mimetype
119+ -- analysis, such as via the @file@ utility.
120+ , ssGetMimeType :: File -> IO MimeType
121+
122+ -- | Ordered list of filenames to be used for indices. If the user
123+ -- requests a folder, and a file with the given name is found in that
124+ -- folder, that file is served. This supercedes any directory listing.
125+ , ssIndices :: [Piece]
126+
127+ -- | How to perform a directory listing. Optional. Will be used when the
128+ -- user requested a folder.
129+ , ssListing :: Maybe Listing
130+
131+ -- | Value to provide for max age in the cache-control.
132+ , ssMaxAge :: MaxAge
133+
134+ -- | Given a requested path and a new destination, construct a string
135+ -- that will go there. Default implementation will use relative paths.
136+ , ssMkRedirect :: Pieces -> ByteString -> ByteString
137+
138+ -- | If @True@, send a redirect to the user when a folder is requested
139+ -- and an index page should be displayed. When @False@, display the
140+ -- content immediately.
141+ , ssRedirectToIndex :: Bool
142+
143+ -- | Prefer usage of etag caching to last-modified caching.
144+ , ssUseHash :: Bool
145+
146+ -- | Force a trailing slash at the end of directories
147+ , ssAddTrailingSlash :: Bool
148+
149+ -- | Optional `W.Application` to be used in case of 404 errors
150+ --
151+ -- Since 3.1.3
152+ , ss404Handler :: Maybe W.Application
153+ }
wai-app-static/app/warp-static.hsnew file+7
@@ -0,0 +1,7 @@
1+{-# LANGUAGE DeriveDataTypeable, RecordWildCards #-}
2+module Main (main) where
3+
4+import WaiAppStatic.CmdLine (runCommandLine)
5+
6+main :: IO ()
7+main = runCommandLine (const id)
wai-app-static/embedded-sample.hsnew file+13
@@ -0,0 +1,13 @@
1+{-# LANGUAGE TemplateHaskell #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+import Network.Wai.Application.Static
4+import Network.Wai.Handler.Warp (run)
5+import Data.FileEmbed
6+import WaiAppStatic.Types
7+import WaiAppStatic.Storage.Embedded
8+
9+main :: IO ()
10+main = run 3000 $ staticApp (embeddedSettings $(embedDir "test"))
11+ { ssIndices = []
12+ , ssMaxAge = NoMaxAge
13+ }
wai-app-static/folder.svgnew file+424
@@ -0,0 +1,424 @@
1+<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+<!-- Created with Inkscape (http://www.inkscape.org/) -->
3+<svg
4+ xmlns:dc="http://purl.org/dc/elements/1.1/"
5+ xmlns:cc="http://creativecommons.org/ns#"
6+ xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
7+ xmlns:svg="http://www.w3.org/2000/svg"
8+ xmlns="http://www.w3.org/2000/svg"
9+ xmlns:xlink="http://www.w3.org/1999/xlink"
10+ xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
11+ xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
12+ width="48.000000px"
13+ height="48.000000px"
14+ id="svg97"
15+ sodipodi:version="0.32"
16+ inkscape:version="0.46"
17+ sodipodi:docbase="/home/jimmac/src/cvs/tango-icon-theme/scalable/places"
18+ sodipodi:docname="folder.svg"
19+ inkscape:export-filename="/home/jimmac/Desktop/horlander-style3.png"
20+ inkscape:export-xdpi="90.000000"
21+ inkscape:export-ydpi="90.000000"
22+ inkscape:output_extension="org.inkscape.output.svg.inkscape">
23+ <defs
24+ id="defs3">
25+ <inkscape:perspective
26+ sodipodi:type="inkscape:persp3d"
27+ inkscape:vp_x="0 : 24 : 1"
28+ inkscape:vp_y="0 : 1000 : 0"
29+ inkscape:vp_z="48 : 24 : 1"
30+ inkscape:persp3d-origin="24 : 16 : 1"
31+ id="perspective68" />
32+ <radialGradient
33+ inkscape:collect="always"
34+ xlink:href="#linearGradient5060"
35+ id="radialGradient6719"
36+ gradientUnits="userSpaceOnUse"
37+ gradientTransform="matrix(-2.774389,0,0,1.969706,112.7623,-872.8854)"
38+ cx="605.71429"
39+ cy="486.64789"
40+ fx="605.71429"
41+ fy="486.64789"
42+ r="117.14286" />
43+ <linearGradient
44+ inkscape:collect="always"
45+ id="linearGradient5060">
46+ <stop
47+ style="stop-color:black;stop-opacity:1;"
48+ offset="0"
49+ id="stop5062" />
50+ <stop
51+ style="stop-color:black;stop-opacity:0;"
52+ offset="1"
53+ id="stop5064" />
54+ </linearGradient>
55+ <radialGradient
56+ inkscape:collect="always"
57+ xlink:href="#linearGradient5060"
58+ id="radialGradient6717"
59+ gradientUnits="userSpaceOnUse"
60+ gradientTransform="matrix(2.774389,0,0,1.969706,-1891.633,-872.8854)"
61+ cx="605.71429"
62+ cy="486.64789"
63+ fx="605.71429"
64+ fy="486.64789"
65+ r="117.14286" />
66+ <linearGradient
67+ id="linearGradient5048">
68+ <stop
69+ style="stop-color:black;stop-opacity:0;"
70+ offset="0"
71+ id="stop5050" />
72+ <stop
73+ id="stop5056"
74+ offset="0.5"
75+ style="stop-color:black;stop-opacity:1;" />
76+ <stop
77+ style="stop-color:black;stop-opacity:0;"
78+ offset="1"
79+ id="stop5052" />
80+ </linearGradient>
81+ <linearGradient
82+ inkscape:collect="always"
83+ xlink:href="#linearGradient5048"
84+ id="linearGradient6715"
85+ gradientUnits="userSpaceOnUse"
86+ gradientTransform="matrix(2.774389,0,0,1.969706,-1892.179,-872.8854)"
87+ x1="302.85715"
88+ y1="366.64789"
89+ x2="302.85715"
90+ y2="609.50507" />
91+ <linearGradient
92+ inkscape:collect="always"
93+ id="linearGradient9806">
94+ <stop
95+ style="stop-color:#000000;stop-opacity:1;"
96+ offset="0"
97+ id="stop9808" />
98+ <stop
99+ style="stop-color:#000000;stop-opacity:0;"
100+ offset="1"
101+ id="stop9810" />
102+ </linearGradient>
103+ <linearGradient
104+ id="linearGradient9766">
105+ <stop
106+ style="stop-color:#6194cb;stop-opacity:1;"
107+ offset="0"
108+ id="stop9768" />
109+ <stop
110+ style="stop-color:#729fcf;stop-opacity:1;"
111+ offset="1"
112+ id="stop9770" />
113+ </linearGradient>
114+ <linearGradient
115+ id="linearGradient3096">
116+ <stop
117+ id="stop3098"
118+ offset="0"
119+ style="stop-color:#424242;stop-opacity:1;" />
120+ <stop
121+ id="stop3100"
122+ offset="1.0000000"
123+ style="stop-color:#777777;stop-opacity:1.0000000;" />
124+ </linearGradient>
125+ <linearGradient
126+ id="linearGradient319"
127+ inkscape:collect="always">
128+ <stop
129+ id="stop320"
130+ offset="0"
131+ style="stop-color:#ffffff;stop-opacity:1;" />
132+ <stop
133+ id="stop321"
134+ offset="1"
135+ style="stop-color:#ffffff;stop-opacity:0;" />
136+ </linearGradient>
137+ <linearGradient
138+ id="linearGradient1789">
139+ <stop
140+ style="stop-color:#202020;stop-opacity:1.0000000;"
141+ offset="0.0000000"
142+ id="stop1790" />
143+ <stop
144+ style="stop-color:#b9b9b9;stop-opacity:1.0000000;"
145+ offset="1.0000000"
146+ id="stop1791" />
147+ </linearGradient>
148+ <radialGradient
149+ inkscape:collect="always"
150+ xlink:href="#linearGradient1789"
151+ id="radialGradient238"
152+ gradientUnits="userSpaceOnUse"
153+ gradientTransform="matrix(1.055022,-2.734504e-2,0.177703,1.190929,-3.572177,-7.125301)"
154+ cx="20.706017"
155+ cy="37.517986"
156+ fx="20.706017"
157+ fy="37.517986"
158+ r="30.905205" />
159+ <linearGradient
160+ id="linearGradient3983">
161+ <stop
162+ style="stop-color:#ffffff;stop-opacity:0.87628865;"
163+ offset="0.0000000"
164+ id="stop3984" />
165+ <stop
166+ style="stop-color:#fffffe;stop-opacity:0.0000000;"
167+ offset="1.0000000"
168+ id="stop3985" />
169+ </linearGradient>
170+ <linearGradient
171+ inkscape:collect="always"
172+ xlink:href="#linearGradient3983"
173+ id="linearGradient491"
174+ gradientUnits="userSpaceOnUse"
175+ gradientTransform="matrix(1.516844,0.000000,0.000000,0.708978,-0.879573,-1.318166)"
176+ x1="6.2297964"
177+ y1="13.773066"
178+ x2="9.8980894"
179+ y2="66.834053" />
180+ <linearGradient
181+ gradientUnits="userSpaceOnUse"
182+ y2="46.689312"
183+ x2="12.853771"
184+ y1="32.567184"
185+ x1="13.035696"
186+ gradientTransform="matrix(1.317489,0.000000,0.000000,0.816256,-0.879573,-1.318166)"
187+ id="linearGradient322"
188+ xlink:href="#linearGradient319"
189+ inkscape:collect="always" />
190+ <linearGradient
191+ gradientUnits="userSpaceOnUse"
192+ y2="6.1802502"
193+ x2="15.514889"
194+ y1="31.367750"
195+ x1="18.112709"
196+ id="linearGradient3104"
197+ xlink:href="#linearGradient3096"
198+ inkscape:collect="always" />
199+ <linearGradient
200+ inkscape:collect="always"
201+ xlink:href="#linearGradient9766"
202+ id="linearGradient9772"
203+ x1="22.175976"
204+ y1="36.987999"
205+ x2="22.065331"
206+ y2="32.050499"
207+ gradientUnits="userSpaceOnUse" />
208+ <radialGradient
209+ inkscape:collect="always"
210+ xlink:href="#linearGradient9806"
211+ id="radialGradient9812"
212+ cx="24.35099"
213+ cy="41.591846"
214+ fx="24.35099"
215+ fy="41.591846"
216+ r="19.136078"
217+ gradientTransform="matrix(1.000000,0.000000,0.000000,0.242494,1.565588e-16,31.50606)"
218+ gradientUnits="userSpaceOnUse" />
219+ </defs>
220+ <sodipodi:namedview
221+ fill="#729fcf"
222+ id="base"
223+ pagecolor="#ffffff"
224+ bordercolor="#666666"
225+ borderopacity="0.10196078"
226+ inkscape:pageopacity="0.0"
227+ inkscape:pageshadow="2"
228+ inkscape:zoom="4"
229+ inkscape:cx="54.359127"
230+ inkscape:cy="-13.803699"
231+ inkscape:current-layer="layer1"
232+ showgrid="false"
233+ inkscape:grid-bbox="true"
234+ inkscape:document-units="px"
235+ inkscape:window-width="1026"
236+ inkscape:window-height="818"
237+ inkscape:window-x="169"
238+ inkscape:window-y="30"
239+ inkscape:showpageshadow="false"
240+ stroke="#3465a4" />
241+ <metadata
242+ id="metadata4">
243+ <rdf:RDF>
244+ <cc:Work
245+ rdf:about="">
246+ <dc:format>image/svg+xml</dc:format>
247+ <dc:type
248+ rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
249+ <dc:title>Folder Icon</dc:title>
250+ <dc:date />
251+ <dc:creator>
252+ <cc:Agent>
253+ <dc:title>Jakub Steiner</dc:title>
254+ </cc:Agent>
255+ </dc:creator>
256+ <cc:license
257+ rdf:resource="http://creativecommons.org/licenses/publicdomain/" />
258+ <dc:source>http://jimmac.musichall.cz</dc:source>
259+ <dc:subject>
260+ <rdf:Bag>
261+ <rdf:li>folder</rdf:li>
262+ <rdf:li>directory</rdf:li>
263+ </rdf:Bag>
264+ </dc:subject>
265+ </cc:Work>
266+ <cc:License
267+ rdf:about="http://creativecommons.org/licenses/publicdomain/">
268+ <cc:permits
269+ rdf:resource="http://creativecommons.org/ns#Reproduction" />
270+ <cc:permits
271+ rdf:resource="http://creativecommons.org/ns#Distribution" />
272+ <cc:permits
273+ rdf:resource="http://creativecommons.org/ns#DerivativeWorks" />
274+ </cc:License>
275+ </rdf:RDF>
276+ </metadata>
277+ <g
278+ id="layer1"
279+ inkscape:label="Folder"
280+ inkscape:groupmode="layer">
281+ <g
282+ style="display:inline"
283+ transform="matrix(2.262383e-2,0,0,2.086758e-2,43.38343,36.36962)"
284+ id="g6707">
285+ <rect
286+ style="opacity:0.40206185;color:black;fill:url(#linearGradient6715);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
287+ id="rect6709"
288+ width="1339.6335"
289+ height="478.35718"
290+ x="-1559.2523"
291+ y="-150.69685" />
292+ <path
293+ style="opacity:0.40206185;color:black;fill:url(#radialGradient6717);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
294+ d="M -219.61876,-150.68038 C -219.61876,-150.68038 -219.61876,327.65041 -219.61876,327.65041 C -76.744594,328.55086 125.78146,220.48075 125.78138,88.454235 C 125.78138,-43.572302 -33.655436,-150.68036 -219.61876,-150.68038 z "
295+ id="path6711"
296+ sodipodi:nodetypes="cccc" />
297+ <path
298+ sodipodi:nodetypes="cccc"
299+ id="path6713"
300+ d="M -1559.2523,-150.68038 C -1559.2523,-150.68038 -1559.2523,327.65041 -1559.2523,327.65041 C -1702.1265,328.55086 -1904.6525,220.48075 -1904.6525,88.454235 C -1904.6525,-43.572302 -1745.2157,-150.68036 -1559.2523,-150.68038 z "
301+ style="opacity:0.40206185;color:black;fill:url(#radialGradient6719);fill-opacity:1;fill-rule:nonzero;stroke:none;stroke-width:1;stroke-linecap:round;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
302+ </g>
303+ <path
304+ d="M 4.5217805,38.687417 C 4.5435766,39.103721 4.9816854,39.520026 5.3979900,39.520026 L 36.725011,39.520026 C 37.141313,39.520026 37.535823,39.103721 37.514027,38.687417 L 36.577584,11.460682 C 36.555788,11.044379 36.117687,10.628066 35.701383,10.628066 L 22.430510,10.628066 C 21.945453,10.628066 21.196037,10.312477 21.028866,9.5214338 L 20.417475,6.6283628 C 20.262006,5.8926895 19.535261,5.5904766 19.118957,5.5904766 L 4.3400975,5.5904766 C 3.9237847,5.5904766 3.5292767,6.0067807 3.5510726,6.4230849 L 4.5217805,38.687417 z "
305+ id="path216"
306+ style="fill:url(#radialGradient238);fill-opacity:1.0000000;fill-rule:nonzero;stroke:url(#linearGradient3104);stroke-width:1.0000000;stroke-linecap:round;stroke-linejoin:round;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-opacity:1.0000000"
307+ sodipodi:nodetypes="ccccccssssccc" />
308+ <path
309+ sodipodi:nodetypes="cc"
310+ id="path9788"
311+ d="M 5.2265927,22.5625 L 35.492173,22.5625"
312+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
313+ <path
314+ sodipodi:nodetypes="cc"
315+ id="path9784"
316+ d="M 5.0421736,18.5625 L 35.489104,18.5625"
317+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000036;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
318+ <path
319+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
320+ d="M 4.9806965,12.5625 L 35.488057,12.5625"
321+ id="path9778"
322+ sodipodi:nodetypes="cc" />
323+ <path
324+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000036;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
325+ d="M 5.3861577,32.5625 L 35.494881,32.5625"
326+ id="path9798"
327+ sodipodi:nodetypes="cc" />
328+ <path
329+ sodipodi:nodetypes="cc"
330+ id="path9800"
331+ d="M 5.5091398,34.5625 L 35.496893,34.5625"
332+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
333+ <path
334+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000036;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
335+ d="M 5.0421736,16.5625 L 35.489104,16.5625"
336+ id="path9782"
337+ sodipodi:nodetypes="cc" />
338+ <path
339+ sodipodi:nodetypes="cc"
340+ id="path9780"
341+ d="M 5.0114345,14.5625 L 35.48858,14.5625"
342+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
343+ <path
344+ sodipodi:nodetypes="cc"
345+ id="path9776"
346+ d="M 4.9220969,10.5625 L 20.202912,10.5625"
347+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
348+ <path
349+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:0.99999982;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
350+ d="M 4.8737534,8.5624999 L 19.657487,8.5624999"
351+ id="path9774"
352+ sodipodi:nodetypes="cc" />
353+ <path
354+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000036;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
355+ d="M 5.3246666,28.5625 L 35.493876,28.5625"
356+ id="path9794"
357+ sodipodi:nodetypes="cc" />
358+ <path
359+ sodipodi:nodetypes="cc"
360+ id="path9792"
361+ d="M 5.2880638,26.5625 L 35.493184,26.5625"
362+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
363+ <path
364+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
365+ d="M 5.2265927,24.5625 L 35.492173,24.5625"
366+ id="path9790"
367+ sodipodi:nodetypes="cc" />
368+ <path
369+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000012;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
370+ d="M 5.1958537,20.5625 L 35.491649,20.5625"
371+ id="path9786"
372+ sodipodi:nodetypes="cc" />
373+ <path
374+ sodipodi:nodetypes="cc"
375+ id="path9796"
376+ d="M 5.3246666,30.5625 L 35.493876,30.5625"
377+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000036;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible" />
378+ <path
379+ style="opacity:0.11363633;color:#000000;fill:#729fcf;fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:1.00000024;stroke-linecap:round;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4;stroke-dasharray:none;stroke-dashoffset:0;stroke-opacity:1;visibility:visible;display:inline;overflow:visible"
380+ d="M 5.5091398,36.5625 L 35.496893,36.5625"
381+ id="path9802"
382+ sodipodi:nodetypes="cc" />
383+ <path
384+ style="color:#000000;fill:url(#linearGradient491);fill-opacity:1.0000000;fill-rule:nonzero;stroke:none;stroke-width:1.2138050;stroke-linecap:butt;stroke-linejoin:miter;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4.0000000;stroke-dashoffset:0.0000000;stroke-opacity:1.0000000;visibility:visible;display:block;overflow:visible;opacity:0.45142857"
385+ d="M 6.0683430,38.864023 C 6.0846856,39.176251 5.8874317,39.384402 5.5697582,39.280326 L 5.5697582,39.280326 C 5.2520766,39.176251 5.0330270,38.968099 5.0166756,38.655870 L 4.0689560,6.5913839 C 4.0526131,6.2791558 4.2341418,6.0906134 4.5463699,6.0906134 L 18.968420,6.0429196 C 19.280648,6.0429196 19.900363,6.3433923 20.101356,7.3651014 L 20.674845,10.180636 C 20.247791,9.7153790 20.255652,9.7010175 20.037287,9.0239299 L 19.631192,7.7647478 C 19.412142,7.0371009 18.932991,6.9328477 18.620763,6.9328477 L 5.7329889,6.9328477 C 5.4207613,6.9328477 5.2235075,7.1409999 5.2398583,7.4532364 L 6.1778636,38.968099 L 6.0683430,38.864023 z "
386+ id="path219"
387+ sodipodi:nodetypes="cccccccccscccccc" />
388+ <g
389+ style="stroke-miterlimit:4.0000000;stroke-width:0.99946535;stroke:none;fill-rule:nonzero;fill-opacity:0.75706214;fill:#ffffff"
390+ id="g220"
391+ transform="matrix(1.040764,0.000000,5.449252e-2,1.040764,-8.670199,2.670594)"
392+ inkscape:export-filename="/home/jimmac/ximian_art/icons/nautilus/suse93/gnome-fs-directory.png"
393+ inkscape:export-xdpi="74.800003"
394+ inkscape:export-ydpi="74.800003">
395+ <path
396+ style="fill-opacity:0.50847459;fill:#ffffff"
397+ d="M 42.417183,8.5151772 C 42.422267,8.4180642 42.289022,8.2681890 42.182066,8.2681716 L 29.150665,8.2660527 C 29.150665,8.2660527 30.062379,8.8540072 31.352477,8.8622963 L 42.405974,8.9333167 C 42.417060,8.7215889 42.408695,8.6772845 42.417183,8.5151772 z "
398+ id="path221"
399+ sodipodi:nodetypes="cscscs" />
400+ </g>
401+ <path
402+ style="color:#000000;fill:url(#linearGradient9772);fill-opacity:1.0;fill-rule:nonzero;stroke:#3465a4;stroke-width:1.0000000;stroke-linecap:butt;stroke-linejoin:round;marker:none;marker-start:none;marker-mid:none;marker-end:none;stroke-miterlimit:4.0000000;stroke-dasharray:none;stroke-dashoffset:0.0000000;stroke-opacity:1;visibility:visible;display:block"
403+ d="M 39.783532,39.510620 C 40.927426,39.466556 41.746608,38.414321 41.830567,37.189615 C 42.622354,25.640928 43.489927,15.957666 43.489927,15.957666 C 43.562082,15.710182 43.322016,15.462699 43.009787,15.462699 L 8.6386304,15.462699 C 8.6386304,15.462699 6.7883113,37.329591 6.7883113,37.329591 C 6.6737562,38.311657 6.3223038,39.134309 5.2384755,39.513304 L 39.783532,39.510620 z "
404+ id="path233"
405+ sodipodi:nodetypes="cscccscc"
406+ inkscape:export-filename="/home/jimmac/ximian_art/icons/nautilus/suse93/gnome-fs-directory.png"
407+ inkscape:export-xdpi="74.800003"
408+ inkscape:export-ydpi="74.800003" />
409+ <path
410+ sodipodi:nodetypes="ccsscsc"
411+ id="path304"
412+ d="M 9.6202444,16.463921 L 42.411343,16.528735 L 40.837297,36.530714 C 40.752975,37.602225 40.386619,37.958929 38.964641,37.958929 C 37.093139,37.958929 10.286673,37.926522 7.569899,37.926522 C 7.8034973,37.605711 7.9036547,36.937899 7.9049953,36.92191 L 9.6202444,16.463921 z "
413+ style="opacity:0.46590909;fill:none;fill-opacity:1.0000000;fill-rule:evenodd;stroke:url(#linearGradient322);stroke-width:0.99999970px;stroke-linecap:round;stroke-linejoin:miter;stroke-opacity:1.0000000" />
414+ <path
415+ sodipodi:nodetypes="ccccc"
416+ id="path323"
417+ d="M 9.6202481,16.223182 L 8.4536014,31.866453 C 8.4536014,31.866453 16.749756,27.718375 27.119949,27.718375 C 37.490142,27.718375 42.675239,16.223182 42.675239,16.223182 L 9.6202481,16.223182 z "
418+ style="fill:#ffffff;fill-opacity:0.089285679;fill-rule:evenodd;stroke:none;stroke-width:1.0000000px;stroke-linecap:butt;stroke-linejoin:miter;stroke-opacity:1.0000000" />
419+ </g>
420+ <g
421+ inkscape:groupmode="layer"
422+ id="layer2"
423+ inkscape:label="pattern" />
424+</svg>
wai-app-static/images/folder.pngnew file

Binary file not shown.

wai-app-static/images/haskell.pngnew file

Binary file not shown.

wai-app-static/sample.hsnew file+17
@@ -0,0 +1,17 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+import Data.String
4+import Data.Text (pack)
5+import Data.Maybe (mapMaybe)
6+import WaiAppStatic.Types (ssIndices, toPiece)
7+import Network.Wai.Application.Static (staticApp,defaultFileServerSettings)
8+import Network.Wai.Handler.Warp (runSettings, settingsPort, defaultSettings)
9+
10+main :: IO ()
11+main = runSettings defaultSettings
12+ {
13+ settingsPort = 3000
14+ } $ staticApp (defaultFileServerSettings $ fromString ".")
15+ {
16+ ssIndices = mapMaybe (toPiece . pack) ["index.html"]
17+ }
wai-app-static/test/EmbeddedTestEntries.hsnew file+55
@@ -0,0 +1,55 @@
1+{-# LANGUAGE TemplateHaskell, QuasiQuotes, OverloadedStrings #-}
2+
3+module EmbeddedTestEntries where
4+
5+import WaiAppStatic.Storage.Embedded
6+import qualified Data.Text as T
7+import qualified Data.Text.Lazy as TL
8+import qualified Data.Text.Lazy.Encoding as TL
9+import qualified Data.ByteString.Lazy as BL
10+
11+body :: Int -> Char -> BL.ByteString
12+body i c = TL.encodeUtf8 $ TL.pack $ take i $ repeat c
13+
14+mkEntries :: IO [EmbeddableEntry]
15+mkEntries = return
16+ -- An entry that should be compressed
17+ [ EmbeddableEntry "e1.txt"
18+ "text/plain"
19+ (Left ("Etag 1", body 1000 'A'))
20+
21+ -- An entry so short that the compressed text is longer
22+ , EmbeddableEntry "e2.txt"
23+ "text/plain"
24+ (Left ("Etag 2", "ABC"))
25+
26+ -- An entry that is not compressed because of the mime
27+ , EmbeddableEntry "somedir/e3.txt"
28+ "xxx"
29+ (Left ("Etag 3", body 1000 'A'))
30+
31+ -- A reloadable entry
32+ , EmbeddableEntry "e4.css"
33+ "text/css"
34+ (Right [| return ("Etag 4" :: T.Text, body 2000 'Q') |])
35+
36+ -- An entry without etag
37+ , EmbeddableEntry "e5.txt"
38+ "text/plain"
39+ (Left ("", body 1000 'Z'))
40+
41+ -- A reloadable entry without etag
42+ , EmbeddableEntry "e6.txt"
43+ "text/plain"
44+ (Right [| return ("" :: T.Text, body 1000 'W') |] )
45+
46+ -- An index file
47+ , EmbeddableEntry "index.html"
48+ "text/html"
49+ (Right [| return ("" :: T.Text, "index file") |] )
50+
51+ -- An index file in a subdir
52+ , EmbeddableEntry "foo/index.html"
53+ "text/html"
54+ (Right [| return ("" :: T.Text, "index file in subdir") |] )
55+ ]
wai-app-static/test/WaiAppEmbeddedTest.hsnew file+94
@@ -0,0 +1,94 @@
1+{-# LANGUAGE TemplateHaskell, OverloadedStrings #-}
2+module WaiAppEmbeddedTest (embSpec) where
3+
4+import Codec.Compression.GZip (compress)
5+import EmbeddedTestEntries
6+import Network.Wai
7+import Network.Wai.Application.Static (staticApp)
8+import Network.Wai.Test
9+import Test.Hspec
10+import WaiAppStatic.Storage.Embedded
11+import WaiAppStatic.Types
12+
13+defRequest :: Request
14+defRequest = defaultRequest
15+
16+embSpec :: Spec
17+embSpec = do
18+ let embedSettings settings = flip runSession (staticApp settings)
19+ let embed = embedSettings $(mkSettings mkEntries)
20+ describe "embedded, compressed entry" $ do
21+ it "served correctly" $ embed $ do
22+ req <- request (setRawPathInfo defRequest "e1.txt")
23+ assertStatus 200 req
24+ assertHeader "Content-Type" "text/plain" req
25+ assertHeader "Content-Encoding" "gzip" req
26+ assertHeader "ETag" "Etag 1" req
27+ assertNoHeader "Last-Modified req" req
28+ assertBody (compress $ body 1000 'A') req
29+
30+ it "304 when valid if-none-match sent" $ embed $ do
31+ req <- request (setRawPathInfo defRequest "e1.txt")
32+ { requestHeaders = [("If-None-Match", "Etag 1")] }
33+ assertStatus 304 req
34+
35+ it "ssIndices works" $ do
36+ let testSettings = $(mkSettings mkEntries){
37+ ssIndices = [unsafeToPiece "index.html"]
38+ }
39+ embedSettings testSettings $ do
40+ req <- request defRequest
41+ assertStatus 200 req
42+ assertBody "index file" req
43+
44+ it "ssIndices works with trailing slashes" $ do
45+ let testSettings = $(mkSettings mkEntries){
46+ ssIndices = [unsafeToPiece "index.html"]
47+ }
48+ embedSettings testSettings $ do
49+ req <- request (setRawPathInfo defRequest "/foo/")
50+ assertStatus 200 req
51+ assertBody "index file in subdir" req
52+
53+ describe "embedded, uncompressed entry" $ do
54+ it "too short" $ embed $ do
55+ req <- request (setRawPathInfo defRequest "e2.txt")
56+ assertStatus 200 req
57+ assertHeader "Content-Type" "text/plain" req
58+ assertNoHeader "Content-Encoding" req
59+ assertHeader "ETag" "Etag 2" req
60+ assertBody "ABC" req
61+
62+ it "wrong mime" $ embed $ do
63+ req <- request (setRawPathInfo defRequest "somedir/e3.txt")
64+ assertStatus 200 req
65+ assertHeader "Content-Type" "xxx" req
66+ assertNoHeader "Content-Encoding" req
67+ assertHeader "ETag" "Etag 3" req
68+ assertBody (body 1000 'A') req
69+
70+ describe "reloadable entry" $
71+ it "served correctly" $ embed $ do
72+ req <- request (setRawPathInfo defRequest "e4.css")
73+ assertStatus 200 req
74+ assertHeader "Content-Type" "text/css" req
75+ assertNoHeader "Content-Encoding" req
76+ assertHeader "ETag" "Etag 4" req
77+ assertBody (body 2000 'Q') req
78+
79+ describe "entries without etags" $ do
80+ it "embedded entry" $ embed $ do
81+ req <- request (setRawPathInfo defRequest "e5.txt")
82+ assertStatus 200 req
83+ assertHeader "Content-Type" "text/plain" req
84+ assertHeader "Content-Encoding" "gzip" req
85+ assertNoHeader "ETag" req
86+ assertBody (compress $ body 1000 'Z') req
87+
88+ it "reload entry" $ embed $ do
89+ req <- request (setRawPathInfo defRequest "e6.txt")
90+ assertStatus 200 req
91+ assertHeader "Content-Type" "text/plain" req
92+ assertNoHeader "Content-Encoding" req
93+ assertNoHeader "ETag" req
94+ assertBody (body 1000 'W') req
wai-app-static/test/WaiAppStaticTest.hsnew file+184
@@ -0,0 +1,184 @@
1+{-# LANGUAGE OverloadedStrings, NoMonomorphismRestriction #-}
2+module WaiAppStaticTest (spec) where
3+
4+import Network.Wai.Application.Static
5+import WaiAppStatic.Types
6+
7+import Test.Hspec
8+import Test.Mockery.Directory
9+import qualified Data.ByteString.Char8 as S8
10+-- import qualified Data.ByteString.Lazy.Char8 as L8
11+import System.PosixCompat.Files (getFileStatus, modificationTime)
12+import System.FilePath
13+import System.IO.Temp
14+
15+import Network.HTTP.Date
16+import Network.HTTP.Types (status500)
17+{-import System.Locale (defaultTimeLocale)-}
18+{-import Data.Time.Format (formatTime)-}
19+
20+import Network.Wai
21+import Network.Wai.Test
22+
23+import Control.Monad.IO.Class (liftIO)
24+import Network.Mime
25+
26+defRequest :: Request
27+defRequest = defaultRequest
28+
29+spec :: Spec
30+spec = do
31+ let webApp = flip runSession $ staticApp $ defaultWebAppSettings "test"
32+ let fileServerAppWithSettings settings = flip runSession $ staticApp settings
33+ let fileServerApp = fileServerAppWithSettings (defaultFileServerSettings "test")
34+ { ssAddTrailingSlash = True
35+ }
36+
37+ let etag = "1B2M2Y8AsgTpgAmY7PhCfg=="
38+ let file = "a/b"
39+ let statFile = setRawPathInfo defRequest file
40+
41+ describe "mime types" $ do
42+ it "fileNameExtensions" $
43+ fileNameExtensions "foo.tar.gz" `shouldBe` ["tar.gz", "gz"]
44+ it "handles multi-extensions" $
45+ defaultMimeLookup "foo.tar.gz" `shouldBe` "application/x-tgz"
46+ it "defaults correctly" $
47+ defaultMimeLookup "foo.unknown" `shouldBe` "application/octet-stream"
48+
49+ describe "webApp" $ do
50+ it "403 for unsafe paths" $ webApp $
51+ flip mapM_ ["..", "."] $ \path ->
52+ assertStatus 403 =<<
53+ request (setRawPathInfo defRequest path)
54+
55+ it "200 for hidden paths" $ webApp $
56+ flip mapM_ [".hidden/folder.png", ".hidden/haskell.png"] $ \path ->
57+ assertStatus 200 =<<
58+ request (setRawPathInfo defRequest path)
59+
60+ it "404 for non-existent files" $ webApp $
61+ assertStatus 404 =<<
62+ request (setRawPathInfo defRequest "doesNotExist")
63+
64+ it "302 redirect when multiple slashes" $ webApp $ do
65+ req <- request (setRawPathInfo defRequest "a//b/c")
66+ assertStatus 302 req
67+ assertHeader "Location" "../../a/b/c" req
68+
69+ let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
70+ ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
71+ }
72+ it "302 redirect when multiple slashes" $ absoluteApp $
73+ flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
74+ req <- request (setRawPathInfo defRequest path)
75+ assertStatus 302 req
76+ assertHeader "Location" "http://www.example.com/a/b/c" req
77+
78+ describe "webApp when requesting a static asset" $ do
79+ it "200 and etag when no etag query parameters" $ webApp $ do
80+ req <- request statFile
81+ assertStatus 200 req
82+ assertHeader "ETag" etag req
83+ assertNoHeader "Last-Modified" req
84+
85+ it "Cache-Control set when etag parameter is correct" $ webApp $ do
86+ req <- request statFile { queryString = [("etag", Just etag)] }
87+ assertStatus 200 req
88+ assertHeader "Cache-Control" "public, max-age=31536000" req
89+ assertNoHeader "Last-Modified" req
90+
91+ it "200 when invalid in-none-match sent" $ webApp $
92+ flip mapM_ ["cached", ""] $ \badETag -> do
93+ req <- request statFile { requestHeaders = [("If-None-Match", badETag)] }
94+ assertStatus 200 req
95+ assertHeader "ETag" etag req
96+ assertNoHeader "Last-Modified" req
97+
98+ it "304 when valid if-none-match sent" $ webApp $ do
99+ req <- request statFile { requestHeaders = [("If-None-Match", etag)] }
100+ assertStatus 304 req
101+ assertNoHeader "Etag" req
102+ assertNoHeader "Last-Modified" req
103+
104+ describe "fileServerApp" $ do
105+ let fileDate = do
106+ stat <- liftIO $ getFileStatus $ "test/" ++ file
107+ return $ formatHTTPDate . epochTimeToHTTPDate $ modificationTime stat
108+
109+ it "directory listing for index" $ fileServerApp $ do
110+ resp <- request (setRawPathInfo defRequest "a/")
111+ assertStatus 200 resp
112+ -- note the unclosed img tags so both /> and > will pass
113+ assertBodyContains "<img src=\"../.hidden/haskell.png\"" resp
114+ assertBodyContains "<img src=\"../.hidden/folder.png\" alt=\"Folder\"" resp
115+ assertBodyContains "<a href=\"b\">b</a>" resp
116+
117+ it "200 when invalid if-modified-since header" $ fileServerApp $ do
118+ flip mapM_ ["123", ""] $ \badDate -> do
119+ req <- request statFile {
120+ requestHeaders = [("If-Modified-Since", badDate)]
121+ }
122+ assertStatus 200 req
123+ fdate <- fileDate
124+ assertHeader "Last-Modified" fdate req
125+
126+ it "304 when if-modified-since matches" $ fileServerApp $ do
127+ fdate <- fileDate
128+ req <- request statFile {
129+ requestHeaders = [("If-Modified-Since", fdate)]
130+ }
131+ assertStatus 304 req
132+ assertNoHeader "Cache-Control" req
133+
134+ context "302 redirect to add a trailing slash on directories if missing" $ do
135+ it "works at the root" $ fileServerApp $ do
136+ req <- request (setRawPathInfo defRequest "/a")
137+ assertStatus 302 req
138+ assertHeader "Location" "/a/" req
139+
140+ it "works when an index.html is delivered" $ do
141+ let settings = (defaultFileServerSettings "."){
142+ ssAddTrailingSlash = True
143+ }
144+ inTempDirectory $ fileServerAppWithSettings settings $ do
145+ liftIO $ touch "foo/index.html"
146+ req <- request (setRawPathInfo defRequest "/foo")
147+ assertStatus 302 req
148+ assertHeader "Location" "/foo/" req
149+
150+ let urlMapApp = flip runSession $ \req send ->
151+ case pathInfo req of
152+ "subPath":rest ->
153+ let req' = req { pathInfo = rest }
154+ in (staticApp (defaultFileServerSettings "test")
155+ { ssAddTrailingSlash = True
156+ }) req' send
157+ _ -> send $ responseLBS status500 []
158+ "urlMapApp: only works at subPath"
159+ it "works with subpath at the root of the file server" $ urlMapApp $ do
160+ req <- request (setRawPathInfo defRequest "/subPath")
161+ assertStatus 302 req
162+ assertHeader "Location" "/subPath/" req
163+
164+ context "with defaultWebAppSettings" $ do
165+ it "ssIndices works" $ do
166+ withSystemTempDirectory "wai-app-static-test" $ \ dir -> do
167+ writeFile (dir </> "index.html") "foo"
168+ let testSettings = (defaultWebAppSettings dir) {
169+ ssIndices = [unsafeToPiece "index.html"]
170+ }
171+ fileServerAppWithSettings testSettings $ do
172+ resp <- request (setRawPathInfo defRequest "/")
173+ assertStatus 200 resp
174+ assertBody "foo" resp
175+
176+ context "with defaultFileServerSettings" $ do
177+ it "prefers ssIndices over ssListing" $ do
178+ withSystemTempDirectory "wai-app-static-test" $ \ dir -> do
179+ writeFile (dir </> "index.html") "foo"
180+ let testSettings = defaultFileServerSettings dir
181+ fileServerAppWithSettings testSettings $ do
182+ resp <- request (setRawPathInfo defRequest "/")
183+ assertStatus 200 resp
184+ assertBody "foo" resp
wai-app-static/test/a/bnew file

No changes to the content.

wai-app-static/tests.hsnew file+6
@@ -0,0 +1,6 @@
1+import WaiAppStaticTest (spec)
2+import WaiAppEmbeddedTest (embSpec)
3+import Test.Hspec
4+
5+main :: IO ()
6+main = hspec $ spec >> embSpec
wai-app-static/wai-app-static.cabalnew file+109
@@ -0,0 +1,109 @@
1+name: wai-app-static
2+version: 3.1.7.1
3+license: MIT
4+license-file: LICENSE
5+author: Michael Snoyman <michael@snoyman.com>
6+maintainer: Michael Snoyman <michael@snoyman.com>, Greg Weber <greg@gregweber.info>
7+synopsis: WAI application for static serving
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-app-static>.
9+category: Web, Yesod
10+stability: Stable
11+cabal-version: >= 1.8
12+build-type: Simple
13+homepage: http://www.yesodweb.com/book/web-application-interface
14+Extra-source-files:
15+ images/folder.png
16+ images/haskell.png
17+ test/*.hs
18+ test/a/b
19+ tests.hs
20+ README.md
21+ ChangeLog.md
22+
23+Flag print
24+ Description: print debug info
25+ Default: False
26+
27+library
28+ build-depends: base >= 4 && < 5
29+ , wai >= 3.0 && < 3.3
30+ , bytestring >= 0.10.4
31+ , http-types >= 0.7
32+ , transformers >= 0.2.2
33+ , unix-compat >= 0.2
34+ , directory >= 1.0.1
35+ , containers >= 0.2
36+ , time >= 1.1.4
37+ , old-locale >= 1.0.0.2
38+ , file-embed >= 0.0.3.1
39+ , text >= 0.7
40+ , cryptonite >= 0.6
41+ , memory >= 0.7
42+ , http-date
43+ , blaze-html >= 0.5
44+ , blaze-markup >= 0.5.1
45+ , mime-types >= 0.1 && < 0.2
46+ , unordered-containers >= 0.2
47+ , template-haskell >= 2.7
48+ , zlib >= 0.5
49+ , filepath
50+ , wai-extra >= 3.0 && < 3.1
51+ , optparse-applicative >= 0.7
52+ , warp >= 3.0.11 && < 3.4
53+
54+ exposed-modules: Network.Wai.Application.Static
55+ WaiAppStatic.Storage.Filesystem
56+ WaiAppStatic.Storage.Embedded
57+ WaiAppStatic.Listing
58+ WaiAppStatic.Types
59+ WaiAppStatic.CmdLine
60+ other-modules: Util
61+ WaiAppStatic.Storage.Embedded.Runtime
62+ WaiAppStatic.Storage.Embedded.TH
63+ ghc-options: -Wall
64+ extensions: CPP
65+
66+ if flag(print)
67+ cpp-options: -DPRINT
68+
69+Executable warp
70+ Main-is: warp-static.hs
71+ hs-source-dirs: app
72+ Build-depends: base >= 4 && < 5
73+ , wai-app-static
74+ , directory >= 1.0
75+ , containers >= 0.2
76+ , bytestring >= 0.10.4
77+ , text >= 0.7
78+ , mime-types >= 0.1 && < 0.2
79+
80+test-suite runtests
81+ hs-source-dirs: test
82+ main-is: ../tests.hs
83+ type: exitcode-stdio-1.0
84+
85+ build-depends: base >= 4 && < 5
86+ , hspec >= 1.3
87+ , unix-compat
88+ , time
89+ , old-locale
90+ , http-date
91+ , wai-app-static
92+ , wai-extra
93+ , wai
94+ , http-types
95+ , network
96+ , bytestring
97+ , text
98+ , transformers
99+ , mime-types
100+ , zlib
101+ , filepath
102+ , temporary
103+ , mockery
104+ -- , containers
105+ ghc-options: -Wall
106+
107+source-repository head
108+ type: git
109+ location: git://github.com/yesodweb/wai.git
wai-app-static/קרררר.htmlnew file+1
@@ -0,0 +1 @@
1+<h1>HELLO WORLD</h1>
wai-conduit/ChangeLog.mdnew file+7
@@ -0,0 +1,7 @@
1+## 3.0.0.4
2+
3+* Drop dependency on blaze-builder
4+
5+## 3.0.0.3
6+
7+* Support wai 3.2
wai-conduit/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2014 Michael Snoyman
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be included
12+in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-conduit/Network/Wai/Conduit.hsnew file+66
@@ -0,0 +1,66 @@
1+-- | A light-weight wrapper around @Network.Wai@ to provide easy conduit support.
2+module Network.Wai.Conduit
3+ ( -- * Request body
4+ sourceRequestBody
5+ -- * Response body
6+ , responseSource
7+ , responseRawSource
8+ -- * Re-export
9+ , module Network.Wai
10+ ) where
11+
12+import Network.Wai
13+import Data.Conduit
14+import Control.Monad.IO.Class (MonadIO, liftIO)
15+import Data.ByteString (ByteString)
16+import qualified Data.ByteString as S
17+import Control.Monad (unless)
18+import Network.HTTP.Types
19+import Data.ByteString.Builder (Builder)
20+import qualified Data.Conduit.List as CL
21+
22+-- | Stream the request body.
23+--
24+-- Since 3.0.0
25+sourceRequestBody :: MonadIO m => Request -> ConduitT () ByteString m ()
26+sourceRequestBody req =
27+ loop
28+ where
29+ go = liftIO (getRequestBodyChunk req)
30+
31+ loop = do
32+ bs <- go
33+ unless (S.null bs) $ do
34+ yield bs
35+ loop
36+
37+-- | Create an HTTP response out of a @Source@.
38+--
39+-- Since 3.0.0
40+responseSource :: Status -> ResponseHeaders -> ConduitT () (Flush Builder) IO () -> Response
41+responseSource s hs src = responseStream s hs $ \send flush ->
42+ runConduit $ src .| CL.mapM_ (\mbuilder ->
43+ case mbuilder of
44+ Chunk b -> send b
45+ Flush -> flush)
46+
47+-- | Create a raw response using a @Source@ and @Sink@ to represent the input
48+-- and output, respectively.
49+--
50+-- Since 3.0.0
51+responseRawSource :: (MonadIO m, MonadIO n)
52+ => (ConduitT () ByteString m () -> ConduitT ByteString Void n () -> IO ())
53+ -> Response
54+ -> Response
55+responseRawSource app =
56+ responseRaw app'
57+ where
58+ app' recv send =
59+ app src sink
60+ where
61+ src = do
62+ bs <- liftIO recv
63+ unless (S.null bs) $ do
64+ yield bs
65+ src
66+ sink = CL.mapM_ $ liftIO . send
wai-conduit/README.mdnew file+4
@@ -0,0 +1,4 @@
1+## wai-conduit
2+
3+Since version 3.0.0, WAI has no built-in streaming data abstraction. This
4+library provides similar functionality to what existed in WAI 2.x.
wai-conduit/Setup.hsnew file+2
@@ -0,0 +1,2 @@
1+import Distribution.Simple
2+main = defaultMain
wai-conduit/example/Main.hsnew file+19
@@ -0,0 +1,19 @@
1+#!/usr/bin/env stack
2+-- stack --resolver lts-11.10 script
3+import Network.Wai
4+import Network.Wai.Handler.Warp
5+import Network.Wai.Conduit
6+import Network.HTTP.Types
7+import Conduit
8+import Data.ByteString.Builder (byteString)
9+import Control.Monad.Trans.Resource
10+
11+main :: IO ()
12+main = run 3000 app
13+
14+app :: Application
15+app _req respond =
16+ runResourceT $ withInternalState $ \is ->
17+ respond $ responseSource status200 [] $
18+ transPipe (`runInternalState` is) (sourceFile "Main.hs") .|
19+ mapC (Chunk . byteString)
wai-conduit/wai-conduit.cabalnew file+23
@@ -0,0 +1,23 @@
1+name: wai-conduit
2+version: 3.0.0.4
3+synopsis: conduit wrappers for WAI
4+description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
5+homepage: https://github.com/yesodweb/wai
6+license: MIT
7+license-file: LICENSE
8+author: Michael Snoyman
9+maintainer: michael@snoyman.com
10+category: Web, Conduit
11+build-type: Simple
12+cabal-version: >=1.10
13+extra-source-files: README.md ChangeLog.md
14+
15+library
16+ exposed-modules: Network.Wai.Conduit
17+ build-depends: base >= 4 && < 5
18+ , wai >= 3.0 && < 3.3
19+ , conduit
20+ , transformers
21+ , bytestring >= 0.10.4
22+ , http-types
23+ default-language: Haskell2010
wai-extra.cabaldeleted−41
@@ -1,41 +0,0 @@
1−Name: wai-extra
2−Version: 0.3.0
3−Synopsis: Provides some basic WAI handlers and middleware.
4−Description: The goal here is to provide common features without many dependencies.
5−License: BSD3
6−License-file: LICENSE
7−Author: Michael Snoyman
8−Maintainer: michael@snoyman.com
9−Homepage: http://github.com/snoyberg/wai-extra
10−Category: Web
11−Build-Type: Simple
12−Cabal-Version: >=1.6
13−Stability: Stable
14−
15−Library
16− Build-Depends: base >= 3 && < 5,
17− bytestring >= 0.9 && < 0.10,
18− wai >= 0.3.0 && < 0.4,
19− old-locale >= 1.0 && < 1.1,
20− time >= 1.1.4 && < 1.3,
21− network >= 2.2.1.5 && < 2.4,
22− directory >= 1.0.1 && < 1.2,
23− zlib-bindings >= 0.0 && < 0.1,
24− blaze-builder-enumerator >= 0.2 && < 0.3,
25− transformers >= 0.2 && < 0.3,
26− enumerator >= 0.4 && < 0.5,
27− blaze-builder >= 0.2.1.3 && < 0.3
28− Exposed-modules: Network.Wai.Handler.CGI
29− Network.Wai.Middleware.Autohead
30− Network.Wai.Middleware.CleanPath
31− Network.Wai.Middleware.Debug
32− Network.Wai.Middleware.Gzip
33− Network.Wai.Middleware.Jsonp
34− Network.Wai.Middleware.Vhost
35− Network.Wai.Zlib
36− Network.Wai.Parse
37− ghc-options: -Wall
38−
39−source-repository head
40− type: git
41− location: git://github.com/snoyberg/wai-extra.git
wai-extra/.ghcinew file+1
@@ -0,0 +1 @@
1+:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h
wai-extra/.gitignorenew file+2
@@ -0,0 +1,2 @@
1+*.swp
2+dist
wai-extra/ChangeLog.mdnew file+209
@@ -0,0 +1,209 @@
1+# Changelog for wai-extra
2+
3+## 3.0.29.1
4+
5+* Fix `Network.Wai.Test.request` always sending an empty request body [#794](https://github.com/yesodweb/wai/pull/794)
6+
7+## 3.0.29
8+
9+* Export `Network.Wai.EventSource.eventStreamAppRaw` [#786](https://github.com/yesodweb/wai/pull/786)
10+
11+## 3.0.28
12+
13+* Add `Network.Wai.EventSource.eventStreamAppRaw` [#767](https://github.com/yesodweb/wai/pull/767)
14+
15+## 3.0.27
16+
17+* Add custom request log formatter which includes response headers [#762](https://github.com/yesodweb/wai/pull/762)
18+
19+## 3.0.26.1
20+
21+* When available, supply the response size to custom loggers
22+ [#757](https://github.com/yesodweb/wai/pull/757)
23+
24+## 3.0.26
25+
26+* Throw 413 for too large payload
27+* Throw 431 for too large headers
28+ [#741](https://github.com/yesodweb/wai/pull/741)
29+
30+## 3.0.25
31+
32+* Supporting `network` version 3.0.
33+
34+## 3.0.24.3
35+
36+* Drop unnecessary `lifted-base` dependency
37+* Drop unnecessary `stringsearch` dependency [#714](https://github.com/yesodweb/wai/pull/714)
38+
39+## 3.0.24.2
40+
41+* Consider quoted multipart form boundary markers [#700](https://github.com/yesodweb/wai/pull/700).
42+* Don't raise exceptions in `formatAsJSON` [#709](https://github.com/yesodweb/wai/pull/709)
43+
44+## 3.0.24.1
45+
46+* Fix a "file not found" exception in wai-extra [#705](https://github.com/yesodweb/wai/pull/706)
47+
48+## 3.0.24.0
49+
50+* Add timeout middleware [#702](https://github.com/yesodweb/wai/pull/702).
51+
52+## 3.0.23.0
53+
54+* Add rewriteRoot middleware [#697](https://github.com/yesodweb/wai/pull/697).
55+
56+## 3.0.22.1
57+
58+* Drop dependency on blaze-builder, requiring streaming-commons >= 0.2
59+
60+## 3.0.22.0
61+
62+* Support for streaming-commons 0.2
63+* Support for resourcet 1.2
64+
65+## 3.0.21.0
66+
67+* Export `Network.Wai.Parse.noLimitParseRequestBodyOptions` [#662](https://github.com/yesodweb/wai/pull/662).
68+
69+## 3.0.20.2
70+
71+* Revert previous change to `srequest`, which caused breakage
72+
73+## 3.0.20.1
74+
75+* Set `requestBodyLength` for `srequest` [#654](https://github.com/yesodweb/wai/pull/654)
76+
77+## 3.0.20.0
78+
79+* runSessionWith (runSession variant that gives access to ClientState) [#629](https://github.com/yesodweb/wai/pull/629)
80+
81+## 3.0.19.1
82+
83+* All loggers follow the autoFlush setting [#604](https://github.com/yesodweb/wai/pull/604)
84+
85+## 3.0.19
86+
87+* Add a new function basicAuth', which passes request to the CheckCreds argument.
88+
89+## 3.0.18
90+
91+* ForceSSL: preserve port number when redirecting to https. [#582](https://github.com/yesodweb/wai/pull/582)
92+
93+## 3.0.17
94+
95+* Gzip pre compressed [#580](https://github.com/yesodweb/wai/pull/580)
96+
97+## 3.0.16.1
98+
99+* Fix the way the header length is checked (for limiting the max header length)
100+
101+## 3.0.16.0
102+
103+* Add a new function "parseRequestBodyEx" that allows various size limits to be set.
104+
105+## 3.0.15.3
106+
107+* Allow wai-logger 2.3
108+
109+## 3.0.15.2
110+
111+* Doc improvements
112+
113+## 3.0.15.1
114+
115+* don't use deprecated CRT functions on Windows [#544](https://github.com/yesodweb/wai/pull/544)
116+
117+## 3.0.15
118+
119+* add requestSizeCheck [#525](https://github.com/yesodweb/wai/pull/525)
120+
121+## 3.0.14.3
122+
123+* Add missing `requestHeaderReferer` and `requestHeaderUserAgent` fields to CGI [yesod#1186](https://github.com/yesodweb/yesod/issues/1186)
124+
125+## 3.0.14.2
126+
127+* Case insensitive multipart request header lookup [#518](https://github.com/yesodweb/wai/pull/518)
128+
129+## 3.0.14.1
130+
131+* Doc update for logStdout and logStdoutDev [#515](https://github.com/yesodweb/wai/issues/515)
132+
133+## 3.0.14
134+
135+* Middleware to force domain names. [#506](https://github.com/yesodweb/wai/issues/506) [#507](https://github.com/yesodweb/wai/pull/507)
136+
137+## 3.0.13.1
138+
139+* Support wai 3.2
140+
141+## 3.0.13
142+
143+* Autoflush handle [#466](https://github.com/yesodweb/wai/pull/466)
144+
145+## 3.0.12
146+
147+* Add Network.Wai.Header.contentLength to read the Content-Length header of a response
148+* The gzip middleware no longer zips responses smaller than 860 bytes
149+
150+## 3.0.11
151+
152+* Add constructor for more detailed custom output formats for RequestLogger
153+* Add JSON output formatter for RequestLogger
154+
155+## 3.0.10
156+
157+* Adding Request Body to RequestLogger [#401](https://github.com/yesodweb/wai/pull/401)
158+
159+## 3.0.9
160+
161+* Network.Wai.Middleware.Routed module added
162+
163+## 3.0.7
164+
165+* Add appearsSecure: check if a request appears to be using SSL even in the
166+ presence of reverse proxies [#362](https://github.com/yesodweb/wai/pull/362)
167+* Add ForceSSL middleware [#363](https://github.com/yesodweb/wai/pull/363)
168+* Add Approot middleware
169+
170+## 3.0.6.1
171+
172+* Test code: only include a Cookie header if there are cookies. Without this
173+ patch, yesod-test cookie handling is broken.
174+
175+## 3.0.6
176+
177+* Add Cookie Handling to Network.Wai.Test [#356](https://github.com/yesodweb/wai/pull/356)
178+
179+## 3.0.5
180+
181+* add functions to extract authentication data from Authorization header [#352](add functions to extract authentication data from Authorization header #352)
182+
183+## 3.0.4.6
184+
185+* Access log sequence not valid [#336](https://github.com/yesodweb/wai/issues/336)
186+
187+## 3.0.4.5
188+
189+* Allow fast-logger 2.3
190+
191+## 3.0.4.3
192+
193+Test suite warning cleanup
194+
195+## 3.0.4.2
196+
197+Allow blaze-builder 0.4
198+
199+## 3.0.4.1
200+
201+Fix compilation failure on Windows [#321](https://github.com/yesodweb/wai/issues/321)
202+
203+## 3.0.4
204+
205+Add the `StreamFile` middleware.
206+
207+## 3.0.3
208+
209+Add the `AddHeaders` middleware.
wai-extra/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-extra/Network/Wai/EventSource.hsnew file+59
@@ -0,0 +1,59 @@
1+{-|
2+ A WAI adapter to the HTML5 Server-Sent Events API.
3+
4+ If running through a proxy like Nginx you might need to add the
5+ headers:
6+
7+ > [ ("X-Accel-Buffering", "no"), ("Cache-Control", "no-cache")]
8+
9+ There is a small example using these functions in the @example@ directory.
10+-}
11+module Network.Wai.EventSource (
12+ ServerEvent(..),
13+ eventSourceAppChan,
14+ eventSourceAppIO,
15+ eventStreamAppRaw
16+ ) where
17+
18+import Data.Function (fix)
19+import Control.Concurrent.Chan (Chan, dupChan, readChan)
20+import Control.Monad.IO.Class (liftIO)
21+import Network.HTTP.Types (status200, hContentType)
22+import Network.Wai (Application, responseStream)
23+
24+import Network.Wai.EventSource.EventStream
25+
26+-- | Make a new WAI EventSource application reading events from
27+-- the given channel.
28+eventSourceAppChan :: Chan ServerEvent -> Application
29+eventSourceAppChan chan req sendResponse = do
30+ chan' <- liftIO $ dupChan chan
31+ eventSourceAppIO (readChan chan') req sendResponse
32+
33+-- | Make a new WAI EventSource application reading events from
34+-- the given IO action.
35+eventSourceAppIO :: IO ServerEvent -> Application
36+eventSourceAppIO src _ sendResponse =
37+ sendResponse $ responseStream
38+ status200
39+ [(hContentType, "text/event-stream")]
40+ $ \sendChunk flush -> fix $ \loop -> do
41+ se <- src
42+ case eventToBuilder se of
43+ Nothing -> return ()
44+ Just b -> sendChunk b >> flush >> loop
45+
46+-- | Make a new WAI EventSource application with a handler that emits events.
47+--
48+-- @since 3.0.28
49+eventStreamAppRaw :: ((ServerEvent -> IO()) -> IO () -> IO ()) -> Application
50+eventStreamAppRaw handler _ sendResponse =
51+ sendResponse $ responseStream
52+ status200
53+ [(hContentType, "text/event-stream")]
54+ $ \sendChunk flush -> handler (sendEvent sendChunk) flush
55+ where
56+ sendEvent sendChunk event =
57+ case eventToBuilder event of
58+ Nothing -> return ()
59+ Just b -> sendChunk b
wai-extra/Network/Wai/EventSource/EventStream.hsnew file+76
@@ -0,0 +1,76 @@
1+{-# LANGUAGE CPP #-}
2+{- code adapted by Mathias Billman originally from Chris Smith https://github.com/cdsmith/gloss-web -}
3+
4+{-|
5+ Internal module, usually you don't need to use it.
6+-}
7+module Network.Wai.EventSource.EventStream (
8+ ServerEvent(..),
9+ eventToBuilder
10+ ) where
11+
12+import Data.ByteString.Builder
13+#if __GLASGOW_HASKELL__ < 710
14+import Data.Monoid
15+#endif
16+
17+{-|
18+ Type representing a communication over an event stream. This can be an
19+ actual event, a comment, a modification to the retry timer, or a special
20+ "close" event indicating the server should close the connection.
21+-}
22+data ServerEvent
23+ = ServerEvent {
24+ eventName :: Maybe Builder,
25+ eventId :: Maybe Builder,
26+ eventData :: [Builder]
27+ }
28+ | CommentEvent {
29+ eventComment :: Builder
30+ }
31+ | RetryEvent {
32+ eventRetry :: Int
33+ }
34+ | CloseEvent
35+
36+
37+{-|
38+ Newline as a Builder.
39+-}
40+nl :: Builder
41+nl = char7 '\n'
42+
43+
44+{-|
45+ Field names as Builder
46+-}
47+nameField, idField, dataField, retryField, commentField :: Builder
48+nameField = string7 "event:"
49+idField = string7 "id:"
50+dataField = string7 "data:"
51+retryField = string7 "retry:"
52+commentField = char7 ':'
53+
54+
55+{-|
56+ Wraps the text as a labeled field of an event stream.
57+-}
58+field :: Builder -> Builder -> Builder
59+field l b = l `mappend` b `mappend` nl
60+
61+
62+{-|
63+ Converts a 'ServerEvent' to its wire representation as specified by the
64+ @text/event-stream@ content type.
65+-}
66+eventToBuilder :: ServerEvent -> Maybe Builder
67+eventToBuilder (CommentEvent txt) = Just $ field commentField txt
68+eventToBuilder (RetryEvent n) = Just $ field retryField (string8 . show $ n)
69+eventToBuilder (CloseEvent) = Nothing
70+eventToBuilder (ServerEvent n i d)= Just $
71+ (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
72+ where
73+ name Nothing = id
74+ name (Just n') = mappend (field nameField n')
75+ evid Nothing = id
76+ evid (Just i') = mappend (field idField i')
wai-extra/Network/Wai/Handler/CGI.hsnew file+201
@@ -0,0 +1,201 @@
1+{-# LANGUAGE RankNTypes, CPP #-}
2+-- | Backend for Common Gateway Interface. Almost all users should use the
3+-- 'run' function.
4+module Network.Wai.Handler.CGI
5+ ( run
6+ , runSendfile
7+ , runGeneric
8+ , requestBodyFunc
9+ ) where
10+
11+import Network.Wai
12+import Network.Wai.Internal
13+import Network.Socket (getAddrInfo, addrAddress)
14+import Data.IORef
15+import Data.Maybe (fromMaybe)
16+import qualified Data.ByteString.Char8 as B
17+import qualified Data.ByteString.Lazy as L
18+import Control.Arrow ((***))
19+import Data.Char (toLower)
20+import qualified System.IO
21+import qualified Data.String as String
22+import Data.ByteString.Builder (byteString, toLazyByteString, char7, string8)
23+import Data.ByteString.Builder.Extra (flush)
24+import Data.ByteString.Lazy.Internal (defaultChunkSize)
25+import System.IO (Handle)
26+import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
27+import qualified Network.HTTP.Types as H
28+import qualified Data.CaseInsensitive as CI
29+#if __GLASGOW_HASKELL__ < 710
30+import Data.Monoid (mconcat, mempty, mappend)
31+#endif
32+
33+import qualified Data.Streaming.ByteString.Builder as Builder
34+import Data.Function (fix)
35+import Control.Monad (unless, void)
36+
37+#if WINDOWS
38+import System.Environment (getEnvironment)
39+#else
40+import qualified System.Posix.Env.ByteString as Env
41+
42+getEnvironment :: IO [(String, String)]
43+getEnvironment = map (B.unpack *** B.unpack) `fmap` Env.getEnvironment
44+#endif
45+
46+safeRead :: Read a => a -> String -> a
47+safeRead d s =
48+ case reads s of
49+ ((x, _):_) -> x
50+ [] -> d
51+
52+lookup' :: String -> [(String, String)] -> String
53+lookup' key pairs = fromMaybe "" $ lookup key pairs
54+
55+-- | Run an application using CGI.
56+run :: Application -> IO ()
57+run app = do
58+ vars <- getEnvironment
59+ let input = requestBodyHandle System.IO.stdin
60+ output = B.hPut System.IO.stdout
61+ runGeneric vars input output Nothing app
62+
63+-- | Some web servers provide an optimization for sending files via a sendfile
64+-- system call via a special header. To use this feature, provide that header
65+-- name here.
66+runSendfile :: B.ByteString -- ^ sendfile header
67+ -> Application -> IO ()
68+runSendfile sf app = do
69+ vars <- getEnvironment
70+ let input = requestBodyHandle System.IO.stdin
71+ output = B.hPut System.IO.stdout
72+ runGeneric vars input output (Just sf) app
73+
74+-- | A generic CGI helper, which allows other backends (FastCGI and SCGI) to
75+-- use the same code as CGI. Most users will not need this function, and can
76+-- stick with 'run' or 'runSendfile'.
77+runGeneric
78+ :: [(String, String)] -- ^ all variables
79+ -> (Int -> IO (IO B.ByteString)) -- ^ responseBody of input
80+ -> (B.ByteString -> IO ()) -- ^ destination for output
81+ -> Maybe B.ByteString -- ^ does the server support the X-Sendfile header?
82+ -> Application
83+ -> IO ()
84+runGeneric vars inputH outputH xsendfile app = do
85+ let rmethod = B.pack $ lookup' "REQUEST_METHOD" vars
86+ pinfo = lookup' "PATH_INFO" vars
87+ qstring = lookup' "QUERY_STRING" vars
88+ contentLength = safeRead 0 $ lookup' "CONTENT_LENGTH" vars
89+ remoteHost' =
90+ case lookup "REMOTE_ADDR" vars of
91+ Just x -> x
92+ Nothing ->
93+ case lookup "REMOTE_HOST" vars of
94+ Just x -> x
95+ Nothing -> ""
96+ isSecure' =
97+ case map toLower $ lookup' "SERVER_PROTOCOL" vars of
98+ "https" -> True
99+ _ -> False
100+ addrs <- getAddrInfo Nothing (Just remoteHost') Nothing
101+ requestBody' <- inputH contentLength
102+ let addr =
103+ case addrs of
104+ a:_ -> addrAddress a
105+ [] -> error $ "Invalid REMOTE_ADDR or REMOTE_HOST: " ++ remoteHost'
106+ reqHeaders = map (cleanupVarName *** B.pack) vars
107+ env = Request
108+ { requestMethod = rmethod
109+ , rawPathInfo = B.pack pinfo
110+ , pathInfo = H.decodePathSegments $ B.pack pinfo
111+ , rawQueryString = B.pack qstring
112+ , queryString = H.parseQuery $ B.pack qstring
113+ , requestHeaders = reqHeaders
114+ , isSecure = isSecure'
115+ , remoteHost = addr
116+ , httpVersion = H.http11 -- FIXME
117+ , requestBody = requestBody'
118+ , vault = mempty
119+ , requestBodyLength = KnownLength $ fromIntegral contentLength
120+ , requestHeaderHost = lookup "host" reqHeaders
121+ , requestHeaderRange = lookup hRange reqHeaders
122+#if MIN_VERSION_wai(3,2,0)
123+ , requestHeaderReferer = lookup "referer" reqHeaders
124+ , requestHeaderUserAgent = lookup "user-agent" reqHeaders
125+#endif
126+ }
127+ void $ app env $ \res ->
128+ case (xsendfile, res) of
129+ (Just sf, ResponseFile s hs fp Nothing) -> do
130+ mapM_ outputH $ L.toChunks $ toLazyByteString $ sfBuilder s hs sf fp
131+ return ResponseReceived
132+ _ -> do
133+ let (s, hs, wb) = responseToStream res
134+ (blazeRecv, blazeFinish) <- Builder.newBuilderRecv Builder.defaultStrategy
135+ wb $ \b -> do
136+ let sendBuilder builder = do
137+ popper <- blazeRecv builder
138+ fix $ \loop -> do
139+ bs <- popper
140+ unless (B.null bs) $ do
141+ outputH bs
142+ loop
143+ sendBuilder $ headers s hs `mappend` char7 '\n'
144+ b sendBuilder (sendBuilder flush)
145+ blazeFinish >>= maybe (return ()) outputH
146+ return ResponseReceived
147+ where
148+ headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
149+ status (Status i m) = (byteString "Status", mconcat
150+ [ string8 $ show i
151+ , char7 ' '
152+ , byteString m
153+ ])
154+ header' (x, y) = (byteString $ CI.original x, byteString y)
155+ header (x, y) = mconcat
156+ [ x
157+ , byteString ": "
158+ , y
159+ , char7 '\n'
160+ ]
161+ sfBuilder s hs sf fp = mconcat
162+ [ headers s hs
163+ , header $ (byteString sf, string8 fp)
164+ , char7 '\n'
165+ , byteString sf
166+ , byteString " not supported"
167+ ]
168+ fixHeaders h =
169+ case lookup hContentType h of
170+ Nothing -> (hContentType, "text/html; charset=utf-8") : h
171+ Just _ -> h
172+
173+cleanupVarName :: String -> CI.CI B.ByteString
174+cleanupVarName "CONTENT_TYPE" = hContentType
175+cleanupVarName "CONTENT_LENGTH" = hContentLength
176+cleanupVarName "SCRIPT_NAME" = "CGI-Script-Name"
177+cleanupVarName s =
178+ case s of
179+ 'H':'T':'T':'P':'_':a:as -> String.fromString $ a : helper' as
180+ _ -> String.fromString s -- FIXME remove?
181+ where
182+ helper' ('_':x:rest) = '-' : x : helper' rest
183+ helper' (x:rest) = toLower x : helper' rest
184+ helper' [] = []
185+
186+requestBodyHandle :: Handle -> Int -> IO (IO B.ByteString)
187+requestBodyHandle h = requestBodyFunc $ \i -> do
188+ bs <- B.hGet h i
189+ return $ if B.null bs then Nothing else Just bs
190+
191+requestBodyFunc :: (Int -> IO (Maybe B.ByteString)) -> Int -> IO (IO B.ByteString)
192+requestBodyFunc get count0 = do
193+ ref <- newIORef count0
194+ return $ do
195+ count <- readIORef ref
196+ if count <= 0
197+ then return B.empty
198+ else do
199+ mbs <- get $ min count defaultChunkSize
200+ writeIORef ref $ count - maybe 0 B.length mbs
201+ return $ fromMaybe B.empty mbs
wai-extra/Network/Wai/Handler/SCGI.hsnew file+107
@@ -0,0 +1,107 @@
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
2+module Network.Wai.Handler.SCGI
3+ ( run
4+ , runSendfile
5+ ) where
6+
7+import Network.Wai
8+import Network.Wai.Handler.CGI (runGeneric, requestBodyFunc)
9+import Foreign.Ptr
10+import Foreign.Marshal.Alloc
11+import Foreign.C
12+import Data.ByteString (ByteString)
13+import qualified Data.ByteString as S
14+import qualified Data.ByteString.Unsafe as S
15+import qualified Data.ByteString.Char8 as S8
16+import Data.IORef
17+import Data.ByteString.Lazy.Internal (defaultChunkSize)
18+
19+run :: Application -> IO ()
20+run app = runOne Nothing app >> run app
21+
22+runSendfile :: ByteString -> Application -> IO ()
23+runSendfile sf app = runOne (Just sf) app >> runSendfile sf app
24+
25+runOne :: Maybe ByteString -> Application -> IO ()
26+runOne sf app = do
27+ socket <- c'accept 0 nullPtr nullPtr
28+ headersBS <- readNetstring socket
29+ let headers@((_, conLenS):_) = parseHeaders $ S.split 0 headersBS
30+ let conLen = case reads conLenS of
31+ (i, _):_ -> i
32+ [] -> 0
33+ conLenI <- newIORef conLen
34+ runGeneric headers (requestBodyFunc $ input socket conLenI)
35+ (write socket) sf app
36+ drain socket conLenI
37+ _ <- c'close socket
38+ return ()
39+
40+write :: CInt -> S.ByteString -> IO ()
41+write socket bs = S.unsafeUseAsCStringLen bs $ \(s, l) -> do
42+ _ <- c'write socket s (fromIntegral l)
43+ return ()
44+
45+input :: CInt -> IORef Int -> Int -> IO (Maybe S.ByteString)
46+input socket ilen rlen = do
47+ len <- readIORef ilen
48+ case len of
49+ 0 -> return Nothing
50+ _ -> do
51+ bs <- readByteString socket
52+ $ minimum [defaultChunkSize, len, rlen]
53+ writeIORef ilen $ len - S.length bs
54+ return $ Just bs
55+
56+drain :: CInt -> IORef Int -> IO () -- FIXME do it in chunks
57+drain socket ilen = do
58+ len <- readIORef ilen
59+ _ <- readByteString socket len
60+ return ()
61+
62+parseHeaders :: [S.ByteString] -> [(String, String)]
63+parseHeaders (x:y:z) = (S8.unpack x, S8.unpack y) : parseHeaders z
64+parseHeaders _ = []
65+
66+readNetstring :: CInt -> IO S.ByteString
67+readNetstring socket = do
68+ len <- readLen 0
69+ bs <- readByteString socket len
70+ _ <- readByteString socket 1 -- the comma
71+ return bs
72+ where
73+ readLen l = do
74+ bs <- readByteString socket 1
75+ let [c] = S8.unpack bs
76+ if c == ':'
77+ then return l
78+ else readLen $ l * 10 + (fromEnum c - fromEnum '0')
79+
80+readByteString :: CInt -> Int -> IO S.ByteString
81+readByteString socket len = do
82+ buf <- mallocBytes len
83+ _ <- c'read socket buf $ fromIntegral len
84+ S.unsafePackCStringFinalizer (castPtr buf) len $ free buf
85+
86+foreign import ccall unsafe "accept"
87+ c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
88+
89+#if WINDOWS
90+foreign import ccall unsafe "_close"
91+ c'close :: CInt -> IO CInt
92+
93+foreign import ccall unsafe "_write"
94+ c'write :: CInt -> Ptr CChar -> CInt -> IO CInt
95+
96+foreign import ccall unsafe "_read"
97+ c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
98+#else
99+foreign import ccall unsafe "close"
100+ c'close :: CInt -> IO CInt
101+
102+foreign import ccall unsafe "write"
103+ c'write :: CInt -> Ptr CChar -> CInt -> IO CInt
104+
105+foreign import ccall unsafe "read"
106+ c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
107+#endif
wai-extra/Network/Wai/Header.hsnew file+18
@@ -0,0 +1,18 @@
1+-- | Some helpers for dealing with WAI 'Header's.
2+
3+module Network.Wai.Header
4+ ( contentLength
5+ ) where
6+
7+import qualified Data.ByteString.Char8 as S8
8+import Network.HTTP.Types as H
9+
10+-- | More useful for a response. A Wai Request already has a requestBodyLength
11+contentLength :: [(HeaderName, S8.ByteString)] -> Maybe Integer
12+contentLength hdrs = lookup H.hContentLength hdrs >>= readInt
13+
14+readInt :: S8.ByteString -> Maybe Integer
15+readInt bs =
16+ case S8.readInteger bs of
17+ Just (i, rest) | S8.null rest -> Just i
18+ _ -> Nothing
wai-extra/Network/Wai/Middleware/AcceptOverride.hsnew file+24
@@ -0,0 +1,24 @@
1+module Network.Wai.Middleware.AcceptOverride
2+ ( acceptOverride
3+ ) where
4+
5+import Network.Wai
6+import Control.Monad (join)
7+import Data.ByteString (ByteString)
8+
9+acceptOverride :: Middleware
10+acceptOverride app req =
11+ app req'
12+ where
13+ req' =
14+ case join $ lookup "_accept" $ queryString req of
15+ Nothing -> req
16+ Just a -> req { requestHeaders = changeVal "Accept" a $ requestHeaders req}
17+
18+changeVal :: Eq a
19+ => a
20+ -> ByteString
21+ -> [(a, ByteString)]
22+ -> [(a, ByteString)]
23+changeVal key val old = (key, val)
24+ : filter (\(k, _) -> k /= key) old
wai-extra/Network/Wai/Middleware/AddHeaders.hsnew file+24
@@ -0,0 +1,24 @@
1+-- |
2+--
3+-- Since 3.0.3
4+module Network.Wai.Middleware.AddHeaders
5+ ( addHeaders
6+ ) where
7+
8+import Network.HTTP.Types (Header)
9+import Network.Wai (Middleware, modifyResponse, mapResponseHeaders)
10+import Network.Wai.Internal (Response(..))
11+import Data.ByteString (ByteString)
12+
13+import qualified Data.CaseInsensitive as CI
14+import Control.Arrow (first)
15+
16+addHeaders :: [(ByteString, ByteString)] -> Middleware
17+-- ^ Prepend a list of headers without any checks
18+--
19+-- Since 3.0.3
20+
21+addHeaders h = modifyResponse $ addHeaders' (map (first CI.mk) h)
22+
23+addHeaders' :: [Header] -> Response -> Response
24+addHeaders' h = mapResponseHeaders (\hs -> h ++ hs)
wai-extra/Network/Wai/Middleware/Approot.hsnew file+121
@@ -0,0 +1,121 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+-- | Middleware for establishing the root of the application.
3+--
4+-- Many application need the ability to create URLs referring back to the
5+-- application itself. For example: generate RSS feeds or sitemaps, giving
6+-- users copy-paste links, or sending emails. In many cases, the approot can be
7+-- determined correctly from the request headers. However, some things can
8+-- prevent this, especially reverse proxies. This module provides multiple ways
9+-- of configuring approot discovery, and functions for applications to get that
10+-- approot.
11+--
12+-- Approots are structured such that they can be prepended to a string such as
13+-- @/foo/bar?baz=bin@. For example, if your application is hosted on
14+-- example.com using HTTPS, the approot would be @https://example.com@. Note
15+-- the lack of a trailing slash.
16+module Network.Wai.Middleware.Approot
17+ ( -- * Middleware
18+ approotMiddleware
19+ -- * Common providers
20+ , envFallback
21+ , envFallbackNamed
22+ , hardcoded
23+ , fromRequest
24+ -- * Functions for applications
25+ , getApproot
26+ , getApprootMay
27+ ) where
28+
29+import Control.Exception (Exception, throw)
30+import Data.ByteString (ByteString)
31+import qualified Data.ByteString.Char8 as S8
32+import Data.Maybe (fromMaybe)
33+import Data.Typeable (Typeable)
34+import qualified Data.Vault.Lazy as V
35+import Network.Wai (Request, vault, Middleware)
36+import Network.Wai.Request (guessApproot)
37+import System.Environment (getEnvironment)
38+import System.IO.Unsafe (unsafePerformIO)
39+
40+approotKey :: V.Key ByteString
41+approotKey = unsafePerformIO V.newKey
42+{-# NOINLINE approotKey #-}
43+
44+-- | The most generic version of the middleware, allowing you to provide a
45+-- function to get the approot for each request. For many use cases, one of the
46+-- helper functions provided by this module will give the necessary
47+-- functionality more conveniently.
48+--
49+-- Since 3.0.7
50+approotMiddleware :: (Request -> IO ByteString) -- ^ get the approot
51+ -> Middleware
52+approotMiddleware getRoot app req respond = do
53+ ar <- getRoot req
54+ let req' = req { vault = V.insert approotKey ar $ vault req }
55+ app req' respond
56+
57+-- | Same as @'envFallbackNamed' "APPROOT"@.
58+--
59+-- The environment variable @APPROOT@ is used by Keter, School of Haskell, and yesod-devel.
60+--
61+-- Since 3.0.7
62+envFallback :: IO Middleware
63+envFallback = envFallbackNamed "APPROOT"
64+
65+-- | Produce a middleware that takes the approot from the given environment
66+-- variable, falling back to the behavior of 'fromRequest' if the variable is
67+-- not set.
68+--
69+-- Since 3.0.7
70+envFallbackNamed :: String -> IO Middleware
71+envFallbackNamed name = do
72+ env <- getEnvironment
73+ case lookup name env of
74+ Just s -> return $ hardcoded $ S8.pack s
75+ Nothing -> return fromRequest
76+
77+-- | Hard-code the given value as the approot.
78+--
79+-- Since 3.0.7
80+hardcoded :: ByteString -> Middleware
81+hardcoded ar = approotMiddleware (const $ return ar)
82+
83+-- | Get the approot by analyzing the request. This is not a full-proof
84+-- approach, but in many common cases will work. Situations that can break this
85+-- are:
86+--
87+-- * Requests which spoof headers and imply the connection is over HTTPS
88+--
89+-- * Reverse proxies that change ports in surprising ways
90+--
91+-- * Invalid Host headers
92+--
93+-- * Reverse proxies which modify the path info
94+--
95+-- Normally trusting headers in this way is insecure, however in the case of
96+-- approot, the worst that can happen is that the client will get an incorrect
97+-- URL. If you are relying on the approot for some security-sensitive purpose,
98+-- it is highly recommended to use @hardcoded@, which cannot be spoofed.
99+--
100+-- Since 3.0.7
101+fromRequest :: Middleware
102+fromRequest = approotMiddleware (return . guessApproot)
103+
104+data ApprootMiddlewareNotSetup = ApprootMiddlewareNotSetup
105+ deriving (Show, Typeable)
106+instance Exception ApprootMiddlewareNotSetup
107+
108+-- | Get the approot set by the middleware. If the middleware is not in use,
109+-- then this function will return an exception. For a total version of the
110+-- function, see 'getApprootMay'.
111+--
112+-- Since 3.0.7
113+getApproot :: Request -> ByteString
114+getApproot = fromMaybe (throw ApprootMiddlewareNotSetup) . getApprootMay
115+
116+-- | A total version of 'getApproot', which returns 'Nothing' if the middleware
117+-- is not in use.
118+--
119+-- Since 3.0.7
120+getApprootMay :: Request -> Maybe ByteString
121+getApprootMay req = V.lookup approotKey $ vault req
wai-extra/Network/Wai/Middleware/Autohead.hsnew file+17
@@ -0,0 +1,17 @@
1+{-# LANGUAGE CPP #-}
2+-- | Automatically produce responses to HEAD requests based on the underlying
3+-- applications GET response.
4+module Network.Wai.Middleware.Autohead (autohead) where
5+
6+import Network.Wai
7+#if __GLASGOW_HASKELL__ < 710
8+import Data.Monoid (mempty)
9+#endif
10+
11+autohead :: Middleware
12+autohead app req sendResponse
13+ | requestMethod req == "HEAD" = app req { requestMethod = "GET" } $ \res -> do
14+ let (s, hs, _) = responseToStream res
15+ sendResponse $ responseBuilder s hs mempty
16+ | otherwise = app req sendResponse
17+
wai-extra/Network/Wai/Middleware/CleanPath.hsnew file+32
@@ -0,0 +1,32 @@
1+{-# LANGUAGE CPP #-}
2+module Network.Wai.Middleware.CleanPath
3+ ( cleanPath
4+ ) where
5+
6+import Network.Wai
7+import qualified Data.ByteString.Char8 as B
8+import qualified Data.ByteString.Lazy as L
9+import Network.HTTP.Types (status301, hLocation)
10+import Data.Text (Text)
11+#if __GLASGOW_HASKELL__ < 710
12+import Data.Monoid (mconcat)
13+#endif
14+
15+cleanPath :: ([Text] -> Either B.ByteString [Text])
16+ -> B.ByteString
17+ -> ([Text] -> Application)
18+ -> Application
19+cleanPath splitter prefix app env sendResponse =
20+ case splitter $ pathInfo env of
21+ Right pieces -> app pieces env sendResponse
22+ Left p -> sendResponse
23+ $ responseLBS status301
24+ [(hLocation, mconcat [prefix, p, suffix])]
25+ $ L.empty
26+ where
27+ -- include the query string if present
28+ suffix =
29+ case B.uncons $ rawQueryString env of
30+ Nothing -> B.empty
31+ Just ('?', _) -> rawQueryString env
32+ _ -> B.cons '?' $ rawQueryString env
wai-extra/Network/Wai/Middleware/ForceDomain.hsnew file+38
@@ -0,0 +1,38 @@
1+-- |
2+--
3+-- @since 3.0.14
4+module Network.Wai.Middleware.ForceDomain where
5+
6+import Data.ByteString (ByteString)
7+import Data.Monoid ((<>), mempty)
8+import Network.HTTP.Types (hLocation, methodGet, status301, status307)
9+import Prelude
10+
11+import Network.Wai
12+import Network.Wai.Request
13+
14+-- | Force a domain by redirecting.
15+-- The `checkDomain` function takes the current domain and checks whether it is correct.
16+-- It should return `Nothing` if the domain is correct, or `Just "domain.com"` if it is incorrect.
17+--
18+-- @since 3.0.14
19+forceDomain :: (ByteString -> Maybe ByteString) -> Middleware
20+forceDomain checkDomain app req sendResponse =
21+ case requestHeaderHost req >>= checkDomain of
22+ Nothing ->
23+ app req sendResponse
24+ Just domain ->
25+ sendResponse $ redirectResponse domain
26+
27+ where
28+ -- From: Network.Wai.Middleware.ForceSSL
29+ redirectResponse domain =
30+ responseBuilder status [(hLocation, location domain)] mempty
31+
32+ location h =
33+ let p = if appearsSecure req then "https://" else "http://" in
34+ p <> h <> rawPathInfo req <> rawQueryString req
35+
36+ status
37+ | requestMethod req == methodGet = status301
38+ | otherwise = status307
wai-extra/Network/Wai/Middleware/ForceSSL.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE CPP #-}
2+-- | Redirect non-SSL requests to https
3+--
4+-- Since 3.0.7
5+module Network.Wai.Middleware.ForceSSL
6+ ( forceSSL
7+ ) where
8+
9+import Network.Wai
10+import Network.Wai.Request
11+
12+#if __GLASGOW_HASKELL__ < 710
13+import Control.Applicative ((<$>))
14+import Data.Monoid (mempty)
15+#endif
16+
17+import Data.Monoid ((<>))
18+import Network.HTTP.Types (hLocation, methodGet, status301, status307)
19+
20+-- | For requests that don't appear secure, redirect to https
21+--
22+-- Since 3.0.7
23+forceSSL :: Middleware
24+forceSSL app req sendResponse =
25+ case (appearsSecure req, redirectResponse req) of
26+ (False, Just resp) -> sendResponse resp
27+ _ -> app req sendResponse
28+
29+redirectResponse :: Request -> Maybe Response
30+redirectResponse req = do
31+ host <- requestHeaderHost req
32+ return $ responseBuilder status [(hLocation, location host)] mempty
33+ where
34+ location h = "https://" <> h <> rawPathInfo req <> rawQueryString req
35+ status
36+ | requestMethod req == methodGet = status301
37+ | otherwise = status307
wai-extra/Network/Wai/Middleware/Gzip.hsnew file+230
@@ -0,0 +1,230 @@
1+{-# LANGUAGE Rank2Types, ScopedTypeVariables #-}
2+---------------------------------------------------------
3+-- |
4+-- Module : Network.Wai.Middleware.Gzip
5+-- Copyright : Michael Snoyman
6+-- License : BSD3
7+--
8+-- Maintainer : Michael Snoyman <michael@snoyman.com>
9+-- Stability : Unstable
10+-- Portability : portable
11+--
12+-- Automatic gzip compression of responses.
13+--
14+---------------------------------------------------------
15+module Network.Wai.Middleware.Gzip
16+ ( gzip
17+ , GzipSettings
18+ , gzipFiles
19+ , GzipFiles (..)
20+ , gzipCheckMime
21+ , def
22+ , defaultCheckMime
23+ ) where
24+
25+import Network.Wai
26+import Data.Maybe (fromMaybe, isJust)
27+import qualified Data.ByteString.Char8 as S8
28+import qualified Data.ByteString as S
29+import Data.Default.Class
30+import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
31+ , hContentType, hContentLength)
32+import System.Directory (doesFileExist, createDirectoryIfMissing)
33+import Data.ByteString.Builder (byteString)
34+import qualified Data.ByteString.Builder.Extra as Blaze (flush)
35+import Control.Exception (try, SomeException)
36+import qualified Data.Set as Set
37+import Network.Wai.Header
38+import Network.Wai.Internal
39+import qualified Data.Streaming.ByteString.Builder as B
40+import qualified Data.Streaming.Zlib as Z
41+import Control.Monad (unless)
42+import Data.Function (fix)
43+import Control.Exception (throwIO)
44+import qualified System.IO as IO
45+import Data.ByteString.Lazy.Internal (defaultChunkSize)
46+import Data.Word8 (_semicolon)
47+
48+data GzipSettings = GzipSettings
49+ { gzipFiles :: GzipFiles
50+ , gzipCheckMime :: S.ByteString -> Bool
51+ }
52+
53+-- | Gzip behavior for files.
54+data GzipFiles
55+ = GzipIgnore -- ^ Do not compress file responses.
56+ | GzipCompress -- ^ Compress files. Note that this may counteract
57+ -- zero-copy response optimizations on some
58+ -- platforms.
59+ | GzipCacheFolder FilePath -- ^ Compress files, caching them in
60+ -- some directory.
61+ | GzipPreCompressed GzipFiles -- ^ If we use compression then try to use the filename with ".gz"
62+ -- appended to it, if the file is missing then try next action
63+ --
64+ -- @since 3.0.17
65+ deriving (Show, Eq, Read)
66+
67+-- | Use default MIME settings; /do not/ compress files.
68+instance Default GzipSettings where
69+ def = GzipSettings GzipIgnore defaultCheckMime
70+
71+-- | MIME types that will be compressed by default:
72+-- @text/@ @*@, @application/json@, @application/javascript@,
73+-- @application/ecmascript@, @image/x-icon@.
74+defaultCheckMime :: S.ByteString -> Bool
75+defaultCheckMime bs =
76+ S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
77+ where
78+ bs' = fst $ S.break (== _semicolon) bs
79+ toCompress = Set.fromList
80+ [ "application/json"
81+ , "application/javascript"
82+ , "application/ecmascript"
83+ , "image/x-icon"
84+ ]
85+
86+-- | Use gzip to compress the body of the response.
87+--
88+-- Analyzes the \"Accept-Encoding\" header from the client to determine
89+-- if gzip is supported.
90+--
91+-- File responses will be compressed according to the 'GzipFiles' setting.
92+--
93+-- Will only be applied based on the 'gzipCheckMime' setting. For default
94+-- behavior, see 'defaultCheckMime'.
95+gzip :: GzipSettings -> Middleware
96+gzip set app env sendResponse = app env $ \res ->
97+ case res of
98+ ResponseRaw{} -> sendResponse res
99+ ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
100+ _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
101+ then
102+ let runAction x = case x of
103+ (ResponseFile s hs file Nothing, GzipPreCompressed nextAction) ->
104+ let
105+ compressedVersion = file ++ ".gz"
106+ in
107+ doesFileExist compressedVersion >>= \y ->
108+ if y
109+ then (sendResponse $ ResponseFile s (fixHeaders hs) compressedVersion Nothing)
110+ else (runAction (ResponseFile s hs file Nothing, nextAction))
111+ (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
112+ case lookup hContentType hs of
113+ Just m
114+ | gzipCheckMime set m -> compressFile s hs file cache sendResponse
115+ _ -> sendResponse res
116+ (ResponseFile {}, GzipIgnore) -> sendResponse res
117+ _ -> compressE set res sendResponse
118+ in runAction (res, gzipFiles set)
119+ else sendResponse res
120+ where
121+ enc = fromMaybe [] $ (splitCommas . S8.unpack)
122+ `fmap` lookup "Accept-Encoding" (requestHeaders env)
123+ ua = fromMaybe "" $ lookup hUserAgent $ requestHeaders env
124+ isMSIE6 = "MSIE 6" `S.isInfixOf` ua
125+ isEncoded res = isJust $ lookup hContentEncoding $ responseHeaders res
126+
127+ bigEnough rsp = case contentLength (responseHeaders rsp) of
128+ Nothing -> True -- This could be a streaming case
129+ Just len -> len >= minimumLength
130+
131+ -- For a small enough response, gzipping will actually increase the size
132+ -- Potentially for anything less than 860 bytes gzipping could be a net loss
133+ -- The actual number is application specific though and may need to be adjusted
134+ -- http://webmasters.stackexchange.com/questions/31750/what-is-recommended-minimum-object-size-for-gzip-performance-benefits
135+ minimumLength = 860
136+
137+compressFile :: Status -> [Header] -> FilePath -> FilePath -> (Response -> IO a) -> IO a
138+compressFile s hs file cache sendResponse = do
139+ e <- doesFileExist tmpfile
140+ if e
141+ then onSucc
142+ else do
143+ createDirectoryIfMissing True cache
144+ x <- try $
145+ IO.withBinaryFile file IO.ReadMode $ \inH ->
146+ IO.withBinaryFile tmpfile IO.WriteMode $ \outH -> do
147+ deflate <- Z.initDeflate 7 $ Z.WindowBits 31
148+ -- FIXME this code should write to a temporary file, then
149+ -- rename to the final file
150+ let goPopper popper = fix $ \loop -> do
151+ res <- popper
152+ case res of
153+ Z.PRDone -> return ()
154+ Z.PRNext bs -> do
155+ S.hPut outH bs
156+ loop
157+ Z.PRError ex -> throwIO ex
158+ fix $ \loop -> do
159+ bs <- S.hGetSome inH defaultChunkSize
160+ unless (S.null bs) $ do
161+ Z.feedDeflate deflate bs >>= goPopper
162+ loop
163+ goPopper $ Z.finishDeflate deflate
164+ either onErr (const onSucc) (x :: Either SomeException ()) -- FIXME bad! don't catch all exceptions like that!
165+ where
166+ onSucc = sendResponse $ responseFile s (fixHeaders hs) tmpfile Nothing
167+
168+ onErr _ = sendResponse $ responseFile s hs file Nothing -- FIXME log the error message
169+
170+ tmpfile = cache ++ '/' : map safe file
171+ safe c
172+ | 'A' <= c && c <= 'Z' = c
173+ | 'a' <= c && c <= 'z' = c
174+ | '0' <= c && c <= '9' = c
175+ safe '-' = '-'
176+ safe '_' = '_'
177+ safe _ = '_'
178+
179+compressE :: GzipSettings
180+ -> Response
181+ -> (Response -> IO a)
182+ -> IO a
183+compressE set res sendResponse =
184+ case lookup hContentType hs of
185+ Just m | gzipCheckMime set m ->
186+ let hs' = fixHeaders hs
187+ in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
188+ (blazeRecv, _) <- B.newBuilderRecv B.defaultStrategy
189+ deflate <- Z.initDeflate 1 (Z.WindowBits 31)
190+ let sendBuilder builder = do
191+ popper <- blazeRecv builder
192+ fix $ \loop -> do
193+ bs <- popper
194+ unless (S.null bs) $ do
195+ sendBS bs
196+ loop
197+ sendBS bs = Z.feedDeflate deflate bs >>= deflatePopper
198+ flushBuilder = do
199+ sendBuilder Blaze.flush
200+ deflatePopper $ Z.flushDeflate deflate
201+ flush
202+ deflatePopper popper = fix $ \loop -> do
203+ result <- popper
204+ case result of
205+ Z.PRDone -> return ()
206+ Z.PRNext bs' -> do
207+ sendChunk $ byteString bs'
208+ loop
209+ Z.PRError e -> throwIO e
210+
211+ body sendBuilder flushBuilder
212+ sendBuilder Blaze.flush
213+ deflatePopper $ Z.finishDeflate deflate
214+ _ -> sendResponse res
215+ where
216+ (s, hs, wb) = responseToStream res
217+
218+-- Remove Content-Length header, since we will certainly have a
219+-- different length after gzip compression.
220+fixHeaders :: [Header] -> [Header]
221+fixHeaders =
222+ ((hContentEncoding, "gzip") :) . filter notLength
223+ where
224+ notLength (x, _) = x /= hContentLength
225+
226+splitCommas :: String -> [String]
227+splitCommas [] = []
228+splitCommas x =
229+ let (y, z) = break (== ',') x
230+ in y : splitCommas (dropWhile (== ' ') $ drop 1 z)
wai-extra/Network/Wai/Middleware/HttpAuth.hsnew file+132
@@ -0,0 +1,132 @@
1+{-# LANGUAGE RecordWildCards, TupleSections, CPP #-}
2+-- | Implements HTTP Basic Authentication.
3+--
4+-- This module may add digest authentication in the future.
5+module Network.Wai.Middleware.HttpAuth
6+ ( -- * Middleware
7+ basicAuth
8+ , basicAuth'
9+ , CheckCreds
10+ , AuthSettings
11+ , authRealm
12+ , authOnNoAuth
13+ , authIsProtected
14+ -- * Helping functions
15+ , extractBasicAuth
16+ , extractBearerAuth
17+ ) where
18+#if __GLASGOW_HASKELL__ < 710
19+import Control.Applicative
20+#endif
21+import Data.ByteString (ByteString)
22+import Data.ByteString.Base64 (decodeLenient)
23+import Data.String (IsString (..))
24+import Data.Word8 (isSpace, _colon, toLower)
25+import Network.HTTP.Types (status401, hContentType, hAuthorization)
26+import Network.Wai
27+
28+import qualified Data.ByteString as S
29+
30+
31+-- | Check if a given username and password is valid.
32+type CheckCreds = ByteString
33+ -> ByteString
34+ -> IO Bool
35+
36+-- | Perform basic authentication.
37+--
38+-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
39+--
40+-- @since 1.3.4
41+basicAuth :: CheckCreds
42+ -> AuthSettings
43+ -> Middleware
44+basicAuth checkCreds = basicAuth' (\_ -> checkCreds)
45+
46+-- | Like 'basicAuth', but also passes a request to the authentication function.
47+--
48+-- @since 3.0.19
49+basicAuth' :: (Request -> CheckCreds)
50+ -> AuthSettings
51+ -> Middleware
52+basicAuth' checkCreds AuthSettings {..} app req sendResponse = do
53+ isProtected <- authIsProtected req
54+ allowed <- if isProtected then check else return True
55+ if allowed
56+ then app req sendResponse
57+ else authOnNoAuth authRealm req sendResponse
58+ where
59+ check =
60+ case (lookup hAuthorization $ requestHeaders req)
61+ >>= extractBasicAuth of
62+ Nothing -> return False
63+ Just (username, password) -> checkCreds req username password
64+
65+-- | Basic authentication settings. This value is an instance of
66+-- @IsString@, so the recommended approach to create a value is to
67+-- provide a string literal (which will be the realm) and then
68+-- overriding individual fields.
69+--
70+-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
71+--
72+-- @since 1.3.4
73+data AuthSettings = AuthSettings
74+ { authRealm :: !ByteString
75+ -- ^
76+ --
77+ -- @since 1.3.4
78+ , authOnNoAuth :: !(ByteString -> Application)
79+ -- ^ Takes the realm and returns an appropriate 401 response when
80+ -- authentication is not provided.
81+ --
82+ -- @since 1.3.4
83+ , authIsProtected :: !(Request -> IO Bool)
84+ -- ^ Determine if access to the requested resource is restricted.
85+ --
86+ -- Default: always returns @True@.
87+ --
88+ -- @since 1.3.4
89+ }
90+
91+instance IsString AuthSettings where
92+ fromString s = AuthSettings
93+ { authRealm = fromString s
94+ , authOnNoAuth = \realm _req f -> f $ responseLBS
95+ status401
96+ [ (hContentType, "text/plain")
97+ , ("WWW-Authenticate", S.concat
98+ [ "Basic realm=\""
99+ , realm
100+ , "\""
101+ ])
102+ ]
103+ "Basic authentication is required"
104+ , authIsProtected = const $ return True
105+ }
106+
107+-- | Extract basic authentication data from usually __Authorization__
108+-- header value. Returns username and password
109+--
110+-- @since 3.0.5
111+extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
112+extractBasicAuth bs =
113+ let (x, y) = S.break isSpace bs
114+ in if S.map toLower x == "basic"
115+ then extract $ S.dropWhile isSpace y
116+ else Nothing
117+ where
118+ extract encoded =
119+ let raw = decodeLenient encoded
120+ (username, password') = S.break (== _colon) raw
121+ in ((username,) . snd) <$> S.uncons password'
122+
123+-- | Extract bearer authentication data from __Authorization__ header
124+-- value. Returns bearer token
125+--
126+-- @since 3.0.5
127+extractBearerAuth :: ByteString -> Maybe ByteString
128+extractBearerAuth bs =
129+ let (x, y) = S.break isSpace bs
130+ in if S.map toLower x == "bearer"
131+ then Just $ S.dropWhile isSpace y
132+ else Nothing
wai-extra/Network/Wai/Middleware/Jsonp.hsnew file+94
@@ -0,0 +1,94 @@
1+{-# LANGUAGE RankNTypes, CPP #-}
2+---------------------------------------------------------
3+-- |
4+-- Module : Network.Wai.Middleware.Jsonp
5+-- Copyright : Michael Snoyman
6+-- License : BSD3
7+--
8+-- Maintainer : Michael Snoyman <michael@snoyman.com>
9+-- Stability : Unstable
10+-- Portability : portable
11+--
12+-- Automatic wrapping of JSON responses to convert into JSONP.
13+--
14+---------------------------------------------------------
15+module Network.Wai.Middleware.Jsonp (jsonp) where
16+
17+import Network.Wai
18+import Network.Wai.Internal
19+import Data.ByteString (ByteString)
20+import qualified Data.ByteString.Char8 as B8
21+import Data.ByteString.Builder.Extra (byteStringCopy)
22+import Data.ByteString.Builder (char7)
23+#if __GLASGOW_HASKELL__ < 710
24+import Data.Monoid (mappend)
25+#endif
26+import Control.Monad (join)
27+import Data.Maybe (fromMaybe)
28+import qualified Data.ByteString as S
29+import Network.HTTP.Types (hAccept, hContentType)
30+
31+-- | Wrap json responses in a jsonp callback.
32+--
33+-- Basically, if the user requested a \"text\/javascript\" and supplied a
34+-- \"callback\" GET parameter, ask the application for an
35+-- \"application/json\" response, then convert that into a JSONP response,
36+-- having a content type of \"text\/javascript\" and calling the specified
37+-- callback function.
38+jsonp :: Middleware
39+jsonp app env sendResponse = do
40+ let accept = fromMaybe B8.empty $ lookup hAccept $ requestHeaders env
41+ let callback :: Maybe B8.ByteString
42+ callback =
43+ if B8.pack "text/javascript" `B8.isInfixOf` accept
44+ then join $ lookup "callback" $ queryString env
45+ else Nothing
46+ let env' =
47+ case callback of
48+ Nothing -> env
49+ Just _ -> env
50+ { requestHeaders = changeVal hAccept
51+ "application/json"
52+ $ requestHeaders env
53+ }
54+ app env' $ \res ->
55+ case callback of
56+ Nothing -> sendResponse res
57+ Just c -> go c res
58+ where
59+ go c r@(ResponseBuilder s hs b) =
60+ sendResponse $ case checkJSON hs of
61+ Nothing -> r
62+ Just hs' -> responseBuilder s hs' $
63+ byteStringCopy c
64+ `mappend` char7 '('
65+ `mappend` b
66+ `mappend` char7 ')'
67+ go c r =
68+ case checkJSON hs of
69+ Just hs' -> addCallback c s hs' wb
70+ Nothing -> sendResponse r
71+ where
72+ (s, hs, wb) = responseToStream r
73+
74+ checkJSON hs =
75+ case lookup hContentType hs of
76+ Just x
77+ | B8.pack "application/json" `S.isPrefixOf` x ->
78+ Just $ fixHeaders hs
79+ _ -> Nothing
80+ fixHeaders = changeVal hContentType "text/javascript"
81+
82+ addCallback cb s hs wb =
83+ wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
84+ sendChunk $ byteStringCopy cb `mappend` char7 '('
85+ _ <- body sendChunk flush
86+ sendChunk $ char7 ')'
87+
88+changeVal :: Eq a
89+ => a
90+ -> ByteString
91+ -> [(a, ByteString)]
92+ -> [(a, ByteString)]
93+changeVal key val old = (key, val)
94+ : filter (\(k, _) -> k /= key) old
wai-extra/Network/Wai/Middleware/Local.hsnew file+26
@@ -0,0 +1,26 @@
1+{-# LANGUAGE CPP #-}
2+-- | Only allow local connections.
3+--
4+module Network.Wai.Middleware.Local
5+ ( local
6+ ) where
7+
8+import Network.Wai (Middleware,remoteHost, Response)
9+import Network.Socket (SockAddr(..))
10+
11+-- | This middleware rejects non-local connections with a specific response.
12+-- It is useful when supporting web-based local applications, which would
13+-- typically want to reject external connections.
14+
15+local :: Response -> Middleware
16+local resp f r k = case remoteHost r of
17+ SockAddrInet _ h | h == fromIntegral home
18+ -> f r k
19+#if !defined(mingw32_HOST_OS) && !defined(_WIN32)
20+ SockAddrUnix _ -> f r k
21+#endif
22+ _ -> k $ resp
23+ where
24+ home :: Integer
25+ home = 127 + (256 * 256 * 256) * 1
26+
wai-extra/Network/Wai/Middleware/MethodOverride.hsnew file+20
@@ -0,0 +1,20 @@
1+module Network.Wai.Middleware.MethodOverride
2+ ( methodOverride
3+ ) where
4+
5+import Network.Wai
6+import Control.Monad (join)
7+
8+-- | Overriding of HTTP request method via `_method` query string parameter.
9+--
10+-- This middleware only applies when the initial request method is POST.
11+-- Allows submitting of normal HTML forms, without worries of semantic
12+-- mismatches with the HTTP spec.
13+methodOverride :: Middleware
14+methodOverride app req =
15+ app req'
16+ where
17+ req' =
18+ case (requestMethod req, join $ lookup "_method" $ queryString req) of
19+ ("POST", Just m) -> req { requestMethod = m }
20+ _ -> req
wai-extra/Network/Wai/Middleware/MethodOverridePost.hsnew file+44
@@ -0,0 +1,44 @@
1+{-# LANGUAGE CPP #-}
2+-----------------------------------------------------------------
3+-- | Module : Network.Wai.Middleware.MethodOverridePost
4+--
5+-- Changes the request-method via first post-parameter _method.
6+-----------------------------------------------------------------
7+module Network.Wai.Middleware.MethodOverridePost
8+ ( methodOverridePost
9+ ) where
10+
11+import Network.Wai
12+import Network.HTTP.Types (parseQuery, hContentType)
13+
14+#if __GLASGOW_HASKELL__ < 710
15+import Data.Monoid (mconcat, mempty)
16+#endif
17+import Data.IORef
18+import Data.ByteString.Lazy (toChunks)
19+
20+-- | Allows overriding of the HTTP request method via the _method post string parameter.
21+--
22+-- * Looks for the Content-Type requestHeader.
23+--
24+-- * If the header is set to application/x-www-form-urlencoded
25+-- and the first POST parameter is _method
26+-- then it changes the request-method to the value of that
27+-- parameter.
28+--
29+-- * This middleware only applies when the initial request method is POST.
30+--
31+methodOverridePost :: Middleware
32+methodOverridePost app req send =
33+ case (requestMethod req, lookup hContentType (requestHeaders req)) of
34+ ("POST", Just "application/x-www-form-urlencoded") -> setPost req >>= flip app send
35+ _ -> app req send
36+
37+setPost :: Request -> IO Request
38+setPost req = do
39+ body <- (mconcat . toChunks) `fmap` lazyRequestBody req
40+ ref <- newIORef body
41+ let rb = atomicModifyIORef ref $ \bs -> (mempty, bs)
42+ case parseQuery body of
43+ (("_method", Just newmethod):_) -> return $ req {requestBody = rb, requestMethod = newmethod}
44+ _ -> return $ req {requestBody = rb}
wai-extra/Network/Wai/Middleware/RequestLogger.hsnew file+371
@@ -0,0 +1,371 @@
1+{-# LANGUAGE RecordWildCards #-}
2+-- NOTE: Due to https://github.com/yesodweb/wai/issues/192, this module should
3+-- not use CPP.
4+module Network.Wai.Middleware.RequestLogger
5+ ( -- * Basic stdout logging
6+ logStdout
7+ , logStdoutDev
8+ -- * Create more versions
9+ , mkRequestLogger
10+ , RequestLoggerSettings
11+ , outputFormat
12+ , autoFlush
13+ , destination
14+ , OutputFormat (..)
15+ , OutputFormatter
16+ , OutputFormatterWithDetails
17+ , OutputFormatterWithDetailsAndHeaders
18+ , Destination (..)
19+ , Callback
20+ , IPAddrSource (..)
21+ ) where
22+
23+import System.IO (Handle, hFlush, stdout)
24+import qualified Data.ByteString.Builder as B (Builder, byteString)
25+import qualified Data.ByteString as BS
26+import Data.ByteString.Char8 (pack)
27+import Control.Monad (when)
28+import Control.Monad.IO.Class (liftIO)
29+import Network.Wai
30+ ( Request(..), requestBodyLength, RequestBodyLength(..)
31+ , Middleware
32+ , Response, responseStatus, responseHeaders
33+ )
34+import System.Log.FastLogger
35+import Network.HTTP.Types as H
36+import Data.Maybe (fromMaybe)
37+import Data.Monoid (mconcat, (<>))
38+import Data.Time (getCurrentTime, diffUTCTime, NominalDiffTime)
39+import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File
40+ , getRequestBodyType)
41+import qualified Data.ByteString.Lazy as LBS
42+import qualified Data.ByteString.Char8 as S8
43+import System.Console.ANSI
44+import Data.IORef
45+import System.IO.Unsafe
46+import Network.Wai.Internal (Response (..))
47+import Data.Default.Class (Default (def))
48+import Network.Wai.Logger
49+import Network.Wai.Middleware.RequestLogger.Internal
50+import Network.Wai.Header (contentLength)
51+import Data.Text.Encoding (decodeUtf8')
52+
53+data OutputFormat
54+ = Apache IPAddrSource
55+ | Detailed Bool -- ^ use colors?
56+ | CustomOutputFormat OutputFormatter
57+ | CustomOutputFormatWithDetails OutputFormatterWithDetails
58+ | CustomOutputFormatWithDetailsAndHeaders OutputFormatterWithDetailsAndHeaders
59+
60+type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> LogStr
61+
62+type OutputFormatterWithDetails
63+ = ZonedDate
64+ -> Request
65+ -> Status
66+ -> Maybe Integer
67+ -> NominalDiffTime
68+ -> [S8.ByteString]
69+ -> B.Builder
70+ -> LogStr
71+
72+-- | Same as @OutputFormatterWithDetails@ but with response headers included
73+--
74+-- This is useful if you wish to include arbitrary application data in your
75+-- logs, e.g., an authenticated user ID, which you would set in a response
76+-- header in your application and retrieve in the log formatter.
77+--
78+-- @since 3.0.27
79+type OutputFormatterWithDetailsAndHeaders
80+ = ZonedDate -- ^ When the log message was generated
81+ -> Request -- ^ The WAI request
82+ -> Status -- ^ HTTP status code
83+ -> Maybe Integer -- ^ Response size
84+ -> NominalDiffTime -- ^ Duration of the request
85+ -> [S8.ByteString] -- ^ The request body
86+ -> B.Builder -- ^ Raw response
87+ -> [Header] -- ^ The response headers
88+ -> LogStr
89+
90+data Destination = Handle Handle
91+ | Logger LoggerSet
92+ | Callback Callback
93+
94+type Callback = LogStr -> IO ()
95+
96+-- | @RequestLoggerSettings@ is an instance of Default. See <https://hackage.haskell.org/package/data-default Data.Default> for more information.
97+--
98+-- @outputFormat@, @autoFlush@, and @destination@ are record fields
99+-- for the record type @RequestLoggerSettings@, so they can be used to
100+-- modify settings values using record syntax.
101+data RequestLoggerSettings = RequestLoggerSettings
102+ {
103+ -- | Default value: @Detailed@ @True@.
104+ outputFormat :: OutputFormat
105+ -- | Only applies when using the @Handle@ constructor for @destination@.
106+ --
107+ -- Default value: @True@.
108+ , autoFlush :: Bool
109+ -- | Default: @Handle@ @stdout@.
110+ , destination :: Destination
111+ }
112+
113+instance Default RequestLoggerSettings where
114+ def = RequestLoggerSettings
115+ { outputFormat = Detailed True
116+ , autoFlush = True
117+ , destination = Handle stdout
118+ }
119+
120+mkRequestLogger :: RequestLoggerSettings -> IO Middleware
121+mkRequestLogger RequestLoggerSettings{..} = do
122+ let (callback, flusher) =
123+ case destination of
124+ Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
125+ Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
126+ Callback c -> (c, return ())
127+ callbackAndFlush str = callback str >> flusher
128+ case outputFormat of
129+ Apache ipsrc -> do
130+ getdate <- getDateGetter flusher
131+ apache <- initLogger ipsrc (LogCallback callback flusher) getdate
132+ return $ apacheMiddleware apache
133+ Detailed useColors -> detailedMiddleware callbackAndFlush useColors
134+ CustomOutputFormat formatter -> do
135+ getDate <- getDateGetter flusher
136+ return $ customMiddleware callbackAndFlush getDate formatter
137+ CustomOutputFormatWithDetails formatter -> do
138+ getdate <- getDateGetter flusher
139+ return $ customMiddlewareWithDetails callbackAndFlush getdate formatter
140+ CustomOutputFormatWithDetailsAndHeaders formatter -> do
141+ getdate <- getDateGetter flusher
142+ return $ customMiddlewareWithDetailsAndHeaders callbackAndFlush getdate formatter
143+
144+apacheMiddleware :: ApacheLoggerActions -> Middleware
145+apacheMiddleware ala app req sendResponse = app req $ \res -> do
146+ let msize = contentLength (responseHeaders res)
147+ apacheLogger ala req (responseStatus res) msize
148+ sendResponse res
149+
150+customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
151+customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
152+ date <- liftIO getdate
153+ let msize = contentLength (responseHeaders res)
154+ liftIO $ cb $ formatter date req (responseStatus res) msize
155+ sendResponse res
156+
157+customMiddlewareWithDetails :: Callback -> IO ZonedDate -> OutputFormatterWithDetails -> Middleware
158+customMiddlewareWithDetails cb getdate formatter app req sendResponse = do
159+ (req', reqBody) <- getRequestBody req
160+ t0 <- getCurrentTime
161+ app req' $ \res -> do
162+ t1 <- getCurrentTime
163+ date <- liftIO getdate
164+ let msize = contentLength (responseHeaders res)
165+ builderIO <- newIORef $ B.byteString ""
166+ res' <- recordChunks builderIO res
167+ rspRcv <- sendResponse res'
168+ _ <- liftIO . cb .
169+ formatter date req' (responseStatus res') msize (t1 `diffUTCTime` t0) reqBody =<<
170+ readIORef builderIO
171+ return rspRcv
172+
173+customMiddlewareWithDetailsAndHeaders :: Callback -> IO ZonedDate -> OutputFormatterWithDetailsAndHeaders -> Middleware
174+customMiddlewareWithDetailsAndHeaders cb getdate formatter app req sendResponse = do
175+ (req', reqBody) <- getRequestBody req
176+ t0 <- getCurrentTime
177+ app req' $ \res -> do
178+ t1 <- getCurrentTime
179+ date <- liftIO getdate
180+ let msize = contentLength (responseHeaders res)
181+ builderIO <- newIORef $ B.byteString ""
182+ res' <- recordChunks builderIO res
183+ rspRcv <- sendResponse res'
184+ _ <- do
185+ rawResponse <- readIORef builderIO
186+ let status = responseStatus res'
187+ duration = t1 `diffUTCTime` t0
188+ resHeaders = responseHeaders res'
189+ liftIO . cb $ formatter date req' status msize duration reqBody rawResponse resHeaders
190+ return rspRcv
191+-- | Production request logger middleware.
192+--
193+-- This uses the 'Apache' logging format, and takes IP addresses for clients from
194+-- the socket (see 'IPAddrSource' for more information). It logs to 'stdout'.
195+{-# NOINLINE logStdout #-}
196+logStdout :: Middleware
197+logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
198+
199+-- | Development request logger middleware.
200+--
201+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
202+{-# NOINLINE logStdoutDev #-}
203+logStdoutDev :: Middleware
204+logStdoutDev = unsafePerformIO $ mkRequestLogger def
205+
206+-- | Prints a message using the given callback function for each request.
207+-- This is not for serious production use- it is inefficient.
208+-- It immediately consumes a POST body and fills it back in and is otherwise inefficient
209+--
210+-- Note that it logs the request immediately when it is received.
211+-- This meanst that you can accurately see the interleaving of requests.
212+-- And if the app crashes you have still logged the request.
213+-- However, if you are simulating 10 simultaneous users you may find this confusing.
214+--
215+-- This is lower-level - use 'logStdoutDev' unless you need greater control.
216+--
217+-- Example ouput:
218+--
219+-- > GET search
220+-- > Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
221+-- > Status: 200 OK 0.010555s
222+-- >
223+-- > GET static/css/normalize.css
224+-- > Params: [("LXwioiBG","")]
225+-- > Accept: text/css,*/*;q=0.1
226+-- > Status: 304 Not Modified 0.010555s
227+
228+detailedMiddleware :: Callback -> Bool -> IO Middleware
229+detailedMiddleware cb useColors =
230+ let (ansiColor, ansiMethod, ansiStatusCode) =
231+ if useColors
232+ then (ansiColor', ansiMethod', ansiStatusCode')
233+ else (\_ t -> [t], (:[]), \_ t -> [t])
234+
235+ in return $ detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode
236+
237+ansiColor' :: Color -> BS.ByteString -> [BS.ByteString]
238+ansiColor' color bs =
239+ [ pack $ setSGRCode [SetColor Foreground Dull color]
240+ , bs
241+ , pack $ setSGRCode [Reset]
242+ ]
243+
244+-- | Tags http method with a unique color.
245+ansiMethod' :: BS.ByteString -> [BS.ByteString]
246+ansiMethod' m = case m of
247+ "GET" -> ansiColor' Cyan m
248+ "HEAD" -> ansiColor' Cyan m
249+ "PUT" -> ansiColor' Green m
250+ "POST" -> ansiColor' Yellow m
251+ "DELETE" -> ansiColor' Red m
252+ _ -> ansiColor' Magenta m
253+
254+ansiStatusCode' :: BS.ByteString -> BS.ByteString -> [BS.ByteString]
255+ansiStatusCode' c t = case S8.take 1 c of
256+ "2" -> ansiColor' Green t
257+ "3" -> ansiColor' Yellow t
258+ "4" -> ansiColor' Red t
259+ "5" -> ansiColor' Magenta t
260+ _ -> ansiColor' Blue t
261+
262+recordChunks :: IORef B.Builder -> Response -> IO Response
263+recordChunks i (ResponseStream s h sb) =
264+ return . ResponseStream s h $ (\send flush -> sb (\b -> modifyIORef i (<> b) >> send b) flush)
265+recordChunks i (ResponseBuilder s h b) =
266+ modifyIORef i (<> b) >> (return $ ResponseBuilder s h b)
267+recordChunks _ r =
268+ return r
269+
270+getRequestBody :: Request -> IO (Request, [S8.ByteString])
271+getRequestBody req = do
272+ let loop front = do
273+ bs <- requestBody req
274+ if S8.null bs
275+ then return $ front []
276+ else loop $ front . (bs:)
277+ body <- loop id
278+ -- logging the body here consumes it, so fill it back up
279+ -- obviously not efficient, but this is the development logger
280+ --
281+ -- Note: previously, we simply used CL.sourceList. However,
282+ -- that meant that you could read the request body in twice.
283+ -- While that in itself is not a problem, the issue is that,
284+ -- in production, you wouldn't be able to do this, and
285+ -- therefore some bugs wouldn't show up during testing. This
286+ -- implementation ensures that each chunk is only returned
287+ -- once.
288+ ichunks <- newIORef body
289+ let rbody = atomicModifyIORef ichunks $ \chunks ->
290+ case chunks of
291+ [] -> ([], S8.empty)
292+ x:y -> (y, x)
293+ let req' = req { requestBody = rbody }
294+ return (req', body)
295+
296+detailedMiddleware' :: Callback
297+ -> (Color -> BS.ByteString -> [BS.ByteString])
298+ -> (BS.ByteString -> [BS.ByteString])
299+ -> (BS.ByteString -> BS.ByteString -> [BS.ByteString])
300+ -> Middleware
301+detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode app req sendResponse = do
302+ (req', body) <-
303+ -- second tuple item should not be necessary, but a test runner might mess it up
304+ case (requestBodyLength req, contentLength (requestHeaders req)) of
305+ -- log the request body if it is small
306+ (KnownLength len, _) | len <= 2048 -> getRequestBody req
307+ (_, Just len) | len <= 2048 -> getRequestBody req
308+ _ -> return (req, [])
309+
310+ let reqbodylog _ = if null body then [""] else ansiColor White " Request Body: " <> body <> ["\n"]
311+ reqbody = concatMap (either (const [""]) reqbodylog . decodeUtf8') body
312+ postParams <- if requestMethod req `elem` ["GET", "HEAD"]
313+ then return []
314+ else do postParams <- liftIO $ allPostParams body
315+ return $ collectPostParams postParams
316+
317+ let getParams = map emptyGetParam $ queryString req
318+ accept = fromMaybe "" $ lookup H.hAccept $ requestHeaders req
319+ params = let par | not $ null postParams = [pack (show postParams)]
320+ | not $ null getParams = [pack (show getParams)]
321+ | otherwise = []
322+ in if null par then [""] else ansiColor White " Params: " <> par <> ["\n"]
323+
324+ t0 <- getCurrentTime
325+ app req' $ \rsp -> do
326+ let isRaw =
327+ case rsp of
328+ ResponseRaw{} -> True
329+ _ -> False
330+ stCode = statusBS rsp
331+ stMsg = msgBS rsp
332+ t1 <- getCurrentTime
333+
334+ -- log the status of the response
335+ cb $ mconcat $ map toLogStr $
336+ ansiMethod (requestMethod req) ++ [" ", rawPathInfo req, "\n"] ++
337+ params ++ reqbody ++
338+ ansiColor White " Accept: " ++ [accept, "\n"] ++
339+ if isRaw then [] else
340+ ansiColor White " Status: " ++
341+ ansiStatusCode stCode (stCode <> " " <> stMsg) ++
342+ [" ", pack $ show $ diffUTCTime t1 t0, "\n"]
343+
344+ sendResponse rsp
345+ where
346+ allPostParams body =
347+ case getRequestBodyType req of
348+ Nothing -> return ([], [])
349+ Just rbt -> do
350+ ichunks <- newIORef body
351+ let rbody = atomicModifyIORef ichunks $ \chunks ->
352+ case chunks of
353+ [] -> ([], S8.empty)
354+ x:y -> (y, x)
355+ sinkRequestBody lbsBackEnd rbt rbody
356+
357+ emptyGetParam :: (BS.ByteString, Maybe BS.ByteString) -> (BS.ByteString, BS.ByteString)
358+ emptyGetParam (k, Just v) = (k,v)
359+ emptyGetParam (k, Nothing) = (k,"")
360+
361+ collectPostParams :: ([Param], [File LBS.ByteString]) -> [Param]
362+ collectPostParams (postParams, files) = postParams ++
363+ map (\(k,v) -> (k, "FILE: " <> fileName v)) files
364+
365+
366+
367+statusBS :: Response -> BS.ByteString
368+statusBS = pack . show . statusCode . responseStatus
369+
370+msgBS :: Response -> BS.ByteString
371+msgBS = statusMessage . responseStatus
wai-extra/Network/Wai/Middleware/RequestLogger/Internal.hsnew file+33
@@ -0,0 +1,33 @@
1+{-# LANGUAGE CPP #-}
2+-- | A module for containing some CPPed code, due to:
3+--
4+-- https://github.com/yesodweb/wai/issues/192
5+module Network.Wai.Middleware.RequestLogger.Internal
6+ ( module Network.Wai.Middleware.RequestLogger.Internal
7+ ) where
8+
9+import Data.ByteString (ByteString)
10+import Network.Wai.Logger (clockDateCacher)
11+#if !MIN_VERSION_wai_logger(2, 2, 0)
12+import Control.Concurrent (forkIO, threadDelay)
13+import Control.Monad (forever)
14+#endif
15+import System.Log.FastLogger (LogStr, fromLogStr)
16+
17+logToByteString :: LogStr -> ByteString
18+logToByteString = fromLogStr
19+
20+getDateGetter :: IO () -- ^ flusher
21+ -> IO (IO ByteString)
22+#if !MIN_VERSION_wai_logger(2, 2, 0)
23+getDateGetter flusher = do
24+ (getter, updater) <- clockDateCacher
25+ _ <- forkIO $ forever $ do
26+ threadDelay 1000000
27+ updater
28+ flusher
29+#else
30+getDateGetter _ = do
31+ (getter, _) <- clockDateCacher
32+#endif
33+ return getter
wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hsnew file+137
@@ -0,0 +1,137 @@
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Network.Wai.Middleware.RequestLogger.JSON
5+ ( formatAsJSON
6+ , formatAsJSONWithHeaders
7+ ) where
8+
9+import qualified Data.ByteString.Builder as BB (toLazyByteString)
10+import Data.ByteString.Lazy (toStrict)
11+import Data.Aeson
12+import Data.CaseInsensitive (original)
13+import Data.Monoid ((<>))
14+import qualified Data.ByteString.Char8 as S8
15+import Data.IP
16+import qualified Data.Text as T
17+import Data.Text (Text)
18+import Data.Text.Encoding (decodeUtf8With)
19+import Data.Text.Encoding.Error (lenientDecode)
20+import Data.Time (NominalDiffTime)
21+import Data.Word (Word32)
22+import Network.HTTP.Types as H
23+import Network.Socket (SockAddr (..), PortNumber)
24+import Network.Wai
25+import Network.Wai.Middleware.RequestLogger
26+import System.Log.FastLogger (toLogStr)
27+import Text.Printf (printf)
28+
29+formatAsJSON :: OutputFormatterWithDetails
30+formatAsJSON date req status responseSize duration reqBody response =
31+ toLogStr (encode $
32+ object
33+ [ "request" .= requestToJSON duration req reqBody
34+ , "response" .=
35+ object
36+ [ "status" .= statusCode status
37+ , "size" .= responseSize
38+ , "body" .=
39+ if statusCode status >= 400
40+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ response
41+ else Nothing
42+ ]
43+ , "time" .= decodeUtf8With lenientDecode date
44+ ]) <> "\n"
45+
46+-- | Same as @formatAsJSON@ but with response headers included
47+--
48+-- This is useful for passing arbitrary data from your application out to the
49+-- WAI layer for it to be logged, but you may need to be careful to
50+-- subsequently redact any headers which may contain sensitive data.
51+--
52+-- @since 3.0.27
53+formatAsJSONWithHeaders :: OutputFormatterWithDetailsAndHeaders
54+formatAsJSONWithHeaders date req status resSize duration reqBody res resHeaders =
55+ toLogStr (encode $
56+ object
57+ [ "request" .= requestToJSON duration req reqBody
58+ , "response" .= object
59+ [ "status" .= statusCode status
60+ , "size" .= resSize
61+ , "headers" .= responseHeadersToJSON resHeaders
62+ , "body" .=
63+ if statusCode status >= 400
64+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ res
65+ else Nothing
66+ ]
67+ , "time" .= decodeUtf8With lenientDecode date
68+ ]) <> "\n"
69+
70+word32ToHostAddress :: Word32 -> Text
71+word32ToHostAddress = T.intercalate "." . map (T.pack . show) . fromIPv4 . fromHostAddress
72+
73+readAsDouble :: String -> Double
74+readAsDouble = read
75+
76+requestToJSON :: NominalDiffTime -> Request -> [S8.ByteString] -> Value
77+requestToJSON duration req reqBody =
78+ object
79+ [ "method" .= decodeUtf8With lenientDecode (requestMethod req)
80+ , "path" .= decodeUtf8With lenientDecode (rawPathInfo req)
81+ , "queryString" .= map queryItemToJSON (queryString req)
82+ , "durationMs" .= (readAsDouble . printf "%.2f" . rationalToDouble $ toRational duration * 1000)
83+ , "size" .= requestBodyLengthToJSON (requestBodyLength req)
84+ , "body" .= decodeUtf8With lenientDecode (S8.concat reqBody)
85+ , "remoteHost" .= sockToJSON (remoteHost req)
86+ , "httpVersion" .= httpVersionToJSON (httpVersion req)
87+ , "headers" .= requestHeadersToJSON (requestHeaders req)
88+ ]
89+ where
90+ rationalToDouble :: Rational -> Double
91+ rationalToDouble = fromRational
92+
93+sockToJSON :: SockAddr -> Value
94+sockToJSON (SockAddrInet pn ha) =
95+ object
96+ [ "port" .= portToJSON pn
97+ , "hostAddress" .= word32ToHostAddress ha
98+ ]
99+sockToJSON (SockAddrInet6 pn _ ha _) =
100+ object
101+ [ "port" .= portToJSON pn
102+ , "hostAddress" .= ha
103+ ]
104+sockToJSON (SockAddrUnix sock) =
105+ object [ "unix" .= sock ]
106+#if !MIN_VERSION_network(3,0,0)
107+sockToJSON (SockAddrCan i) =
108+ object [ "can" .= i ]
109+#endif
110+
111+queryItemToJSON :: QueryItem -> Value
112+queryItemToJSON (name, mValue) = toJSON (decodeUtf8With lenientDecode name, fmap (decodeUtf8With lenientDecode) mValue)
113+
114+requestHeadersToJSON :: RequestHeaders -> Value
115+requestHeadersToJSON = toJSON . map hToJ where
116+ -- Redact cookies
117+ hToJ ("Cookie", _) = toJSON ("Cookie" :: Text, "-RDCT-" :: Text)
118+ hToJ hd = headerToJSON hd
119+
120+responseHeadersToJSON :: [Header] -> Value
121+responseHeadersToJSON = toJSON . map hToJ where
122+ -- Redact cookies
123+ hToJ ("Set-Cookie", _) = toJSON ("Set-Cookie" :: Text, "-RDCT-" :: Text)
124+ hToJ hd = headerToJSON hd
125+
126+headerToJSON :: Header -> Value
127+headerToJSON (headerName, header) = toJSON (decodeUtf8With lenientDecode . original $ headerName, decodeUtf8With lenientDecode header)
128+
129+portToJSON :: PortNumber -> Value
130+portToJSON = toJSON . toInteger
131+
132+httpVersionToJSON :: HttpVersion -> Value
133+httpVersionToJSON (HttpVersion major minor) = String $ T.pack (show major) <> "." <> T.pack (show minor)
134+
135+requestBodyLengthToJSON :: RequestBodyLength -> Value
136+requestBodyLengthToJSON ChunkedBody = String "Unknown"
137+requestBodyLengthToJSON (KnownLength l) = toJSON l
wai-extra/Network/Wai/Middleware/Rewrite.hsnew file+339
@@ -0,0 +1,339 @@
1+{-# LANGUAGE TupleSections #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Network.Wai.Middleware.Rewrite
5+ ( -- * How to use this module
6+ -- $howto
7+
8+ -- ** A note on semantics
9+
10+ -- $semantics
11+
12+ -- ** Paths and Queries
13+
14+ -- $pathsandqueries
15+ PathsAndQueries
16+
17+ -- ** An example rewriting paths with queries
18+
19+ -- $takeover
20+
21+ -- ** Upgrading from wai-extra ≤ 3.0.16.1
22+
23+ -- $upgrading
24+
25+ -- * 'Middleware'
26+
27+ -- ** Recommended functions
28+ , rewriteWithQueries
29+ , rewritePureWithQueries
30+ , rewriteRoot
31+
32+ -- ** Deprecated
33+ , rewrite
34+ , rewritePure
35+
36+ -- * Operating on 'Request's
37+
38+ , rewriteRequest
39+ , rewriteRequestPure
40+ ) where
41+
42+import Network.Wai
43+import Control.Monad.IO.Class (liftIO)
44+import Data.Text (Text)
45+import Data.Functor.Identity (Identity(..))
46+import qualified Data.Text.Encoding as TE
47+import qualified Data.Text as T
48+import Network.HTTP.Types as H
49+
50+-- GHC ≤ 7.10 does not export Applicative functions from the prelude.
51+#if __GLASGOW_HASKELL__ <= 710
52+import Control.Applicative
53+#endif
54+
55+-- $howto
56+-- This module provides 'Middleware' to rewrite URL paths. It also provides
57+-- functions that will convert a 'Request' to a modified 'Request'.
58+-- Both operations require a function that takes URL parameters and
59+-- headers, and returns new URL parameters. Parameters are pieces of URL
60+-- paths and query parameters.
61+--
62+-- If you are a new user of the library, use 'rewriteWithQueries' or
63+-- 'rewritePureWithQueries' for middleware. For modifying 'Request's
64+-- directly, use 'rewriteRequest' or 'rewriteRequestPure'.
65+
66+-- $semantics
67+--
68+-- Versions of this library in wai-extra ≤ 3.0.16.1 exported only
69+-- 'rewrite' and 'rewritePure' and both modified 'rawPathInfo' of the
70+-- underlying requests. Such modification has been proscribed. The
71+-- semantics of these functions have not changed; instead the recommended
72+-- approach is to use 'rewriteWithQueries' and 'rewritePureWithQueries'.
73+-- The new functions are slightly different, as described in the section
74+-- on upgrading; code for previous library versions can be upgraded with
75+-- a single change, and as the type of the new function is different the
76+-- compiler will indicate where this change must be made.
77+--
78+-- The 'rewriteRequest' and 'rewriteRequestPure' functions use the new
79+-- semantics, too.
80+
81+-- $pathsandqueries
82+--
83+-- This library defines the type synonym `PathsAndQueries` to make code
84+-- handling paths and queries easier to read.
85+--
86+-- /e.g./ /\/foo\/bar/ would look like
87+--
88+-- > ["foo", "bar"] :: Text
89+--
90+-- /?bar=baz/ would look like
91+--
92+-- > [("bar", Just "baz")] :: QueryText
93+--
94+-- Together,
95+--
96+-- /\/foo?bar=baz/ would look like
97+--
98+-- > (["foo"],[("bar", Just "baz")]) :: PathsAndQueries
99+
100+-- $takeover
101+-- Let’s say we want to replace a website written in PHP with one written
102+-- using WAI. We’ll use the
103+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
104+-- package to serve the old
105+-- site from the new site, but there’s a problem. The old site uses pages like
106+--
107+-- @
108+-- index.php?page=/page/
109+-- @
110+--
111+-- whereas the new site would look like
112+--
113+-- @
114+-- index\//page/
115+-- @
116+--
117+-- In doing this, we want to separate the migration code from our new
118+-- website. So we’d like to handle links internally using the path
119+-- formulation, but externally have the old links still work.
120+--
121+-- Therefore, we will use middleware ('rewritePureWithQueries') from this
122+-- module to rewrite incoming requests from the query formulation to the
123+-- paths formulation.
124+--
125+-- > {-# LANGUAGE ViewPatterns #-}
126+-- >
127+-- > rewritePathFromPhp :: Middleware
128+-- > rewritePathFromPhp = rewritePureWithQueries pathFromPhp
129+-- >
130+-- > pathFromPhp :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
131+-- > pathFromPhp (pieces, queries) _ = piecesConvert pieces queries
132+-- > where
133+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
134+-- > piecesConvert ["index.php"] qs@(join . lookup "page" -> Just page) =
135+-- > ( ["index", TE.decodeUtf8With TE.lenientDecode page]
136+-- > , delete ("page", pure page) qs
137+-- > )
138+-- > piecesConvert ps qs = (ps, qs)
139+--
140+-- On the other side, we will use 'rewriteRequestPure' to rewrite outgoing
141+-- requests to the original website from the reverse proxy code (using the
142+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequest' or
143+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequestSecure' constructors. Note,
144+-- these links will only work if the haddock documentation for
145+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
146+-- is installed).
147+--
148+-- > rewritePhpFromPath :: Request -> Request
149+-- > rewritePhpFromPath = rewriteRequestPure phpFromPath
150+-- >
151+-- > phpFromPath :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
152+-- > phpFromPath (pieces, queries) _ = piecesConvert pieces queries
153+-- > where
154+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
155+-- > piecesConvert ["index", page] qs = ( ["index.php"], ("page", pure . TE.encodeUtf8 $ page) : qs )
156+-- > piecesConvert ps qs = (ps, qs)
157+--
158+-- For the whole example, see
159+-- <https://gist.github.com/dbaynard/c844d0df124f68ec8b6da152c581ce6d>.
160+
161+-- $upgrading
162+-- It is quite simple to upgrade from 'rewrite' and 'rewritePure', to
163+-- 'rewriteWithQueries' and 'rewritePureWithQueries'.
164+-- Insert 'Data.Bifunctor.first', which specialises to
165+--
166+-- @
167+-- 'Data.Bifunctor.first' :: (['Text'] -> ['Text']) -> 'PathsAndQueries' -> 'PathsAndQueries'
168+-- @
169+--
170+-- as the following example demonstrates.
171+--
172+-- Old versions of the library could only handle path pieces, not queries.
173+-- This could have been supplied to 'rewritePure'.
174+--
175+-- @
176+-- staticConvert' :: [Text] -> H.RequestHeaders -> [Text]
177+-- staticConvert' pieces _ = piecesConvert pieces
178+-- where
179+-- piecesConvert [] = ["static", "html", "pages.html"]
180+-- piecesConvert route@("pages":_) = "static":"html":route
181+-- @
182+--
183+-- Instead, use this function, supplied to 'rewritePureWithQueries'.
184+--
185+-- @
186+-- staticConvert :: 'PathsAndQueries' -> H.RequestHeaders -> 'PathsAndQueries'
187+-- staticConvert pathsAndQueries _ = 'Data.Bifunctor.first' piecesConvert pathsAndQueries
188+-- where
189+-- piecesConvert [] = ["static", "html", "pages.html"]
190+-- piecesConvert route@("pages":_) = "static":"html":route
191+-- @
192+--
193+-- The former formulation is deprecated for two reasons:
194+--
195+-- 1. The original formulation of 'rewrite' modified 'rawPathInfo', which
196+-- is deprecated behaviour.
197+--
198+-- 2. The original formulation did not allow query parameters to
199+-- influence the path.
200+--
201+-- Concerning the first point, take care with semantics of your program when
202+-- upgrading as the upgraded functions no longer modify 'rawPathInfo'.
203+
204+--------------------------------------------------
205+-- * Types
206+--------------------------------------------------
207+
208+-- | A tuple of the path sections as ['Text'] and query parameters as
209+-- 'H.Query'. This makes writing type signatures for the conversion
210+-- function far more pleasant.
211+--
212+-- Note that this uses 'H.Query' not 'H.QueryText' to more accurately
213+-- reflect the paramaters that can be supplied in URLs. It may be safe to
214+-- treat parameters as text; use the 'H.queryToQueryText' and
215+-- 'H.queryTextToQuery' functions to interconvert.
216+type PathsAndQueries = ([Text], H.Query)
217+
218+--------------------------------------------------
219+-- * Rewriting 'Middleware'
220+--------------------------------------------------
221+
222+-- | Rewrite based on your own conversion function for paths only, to be
223+-- supplied by users of this library (with the conversion operating in 'IO').
224+--
225+-- For new code, use 'rewriteWithQueries' instead.
226+rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
227+rewrite convert app req sendResponse = do
228+ let convertIO = pathsOnly . curry $ liftIO . uncurry convert
229+ newReq <- rewriteRequestRawM convertIO req
230+ app newReq sendResponse
231+{-# WARNING rewrite [
232+ "This modifies the 'rawPathInfo' field of a 'Request'."
233+ , " This is not recommended behaviour; it is however how"
234+ , " this function has worked in the past."
235+ , " Use 'rewriteWithQueries' instead"] #-}
236+
237+-- | Rewrite based on pure conversion function for paths only, to be
238+-- supplied by users of this library.
239+--
240+-- For new code, use 'rewritePureWithQueries' instead.
241+rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
242+rewritePure convert app req =
243+ let convertPure = pathsOnly . curry $ Identity . uncurry convert
244+ newReq = runIdentity $ rewriteRequestRawM convertPure req
245+ in app newReq
246+{-# WARNING rewritePure [
247+ "This modifies the 'rawPathInfo' field of a 'Request'."
248+ , " This is not recommended behaviour; it is however how"
249+ , " this function has worked in the past."
250+ , " Use 'rewritePureWithQueries' instead"] #-}
251+
252+-- | Rewrite based on your own conversion function for paths and queries.
253+-- This function is to be supplied by users of this library, and operates
254+-- in 'IO'.
255+rewriteWithQueries :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
256+ -> Middleware
257+rewriteWithQueries convert app req sendResponse = do
258+ newReq <- rewriteRequestM convert req
259+ app newReq sendResponse
260+
261+-- | Rewrite based on pure conversion function for paths and queries. This
262+-- function is to be supplied by users of this library.
263+rewritePureWithQueries :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
264+ -> Middleware
265+rewritePureWithQueries convert app req = app $ rewriteRequestPure convert req
266+
267+-- | Rewrite root requests (/) to a specified path
268+--
269+-- Note that /index.html/ in example below should already be a valid route.
270+--
271+-- @
272+-- rewriteRoot "index.html" :: Middleware
273+-- @
274+--
275+-- @since 3.0.23.0
276+rewriteRoot :: Text -> Middleware
277+rewriteRoot root = rewritePureWithQueries onlyRoot
278+ where
279+ onlyRoot ([], q) _ = ([root], q)
280+ onlyRoot paths _ = paths
281+
282+--------------------------------------------------
283+-- * Modifying 'Request's directly
284+--------------------------------------------------
285+
286+-- | Modify a 'Request' using the supplied function in 'IO'. This is suitable for
287+-- the reverse proxy example.
288+rewriteRequest :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
289+ -> Request -> IO Request
290+rewriteRequest convert req =
291+ let convertIO = curry $ liftIO . uncurry convert
292+ in rewriteRequestRawM convertIO req
293+
294+-- | Modify a 'Request' using the pure supplied function. This is suitable for
295+-- the reverse proxy example.
296+rewriteRequestPure :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
297+ -> Request -> Request
298+rewriteRequestPure convert req =
299+ let convertPure = curry $ Identity . uncurry convert
300+ in runIdentity $ rewriteRequestRawM convertPure req
301+
302+--------------------------------------------------
303+-- * Helper functions
304+--------------------------------------------------
305+
306+-- | This helper function factors out the common behaviour of rewriting requests.
307+rewriteRequestM :: (Applicative m, Monad m)
308+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
309+ -> Request -> m Request
310+rewriteRequestM convert req = do
311+ (pInfo, qByteStrings) <- curry convert (pathInfo req) (queryString req) (requestHeaders req)
312+ pure req {pathInfo = pInfo, queryString = qByteStrings}
313+
314+-- | This helper function preserves the semantics of wai-extra ≤ 3.0, in
315+-- which the rewrite functions modify the 'rawPathInfo' parameter. Note
316+-- that this has not been extended to modify the 'rawQueryInfo' as
317+-- modifying either of these values has been deprecated.
318+rewriteRequestRawM :: (Applicative m, Monad m)
319+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
320+ -> Request -> m Request
321+rewriteRequestRawM convert req = do
322+ newReq <- rewriteRequestM convert req
323+ let rawPInfo = TE.encodeUtf8 . T.intercalate "/" . pathInfo $ newReq
324+ pure newReq { rawPathInfo = rawPInfo }
325+{-# WARNING rewriteRequestRawM [
326+ "This modifies the 'rawPathInfo' field of a 'Request'."
327+ , " This is not recommended behaviour; it is however how"
328+ , " this function has worked in the past."
329+ , " Use 'rewriteRequestM' instead"] #-}
330+
331+-- | Produce a function that works on 'PathsAndQueries' from one working
332+-- only on paths. This is not exported, as it is only needed to handle
333+-- code written for versions ≤ 3.0 of the library; see the
334+-- example above using 'Data.Bifunctor.first' to do something similar.
335+pathsOnly :: (Applicative m, Monad m)
336+ => ([Text] -> H.RequestHeaders -> m [Text])
337+ -> PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries
338+pathsOnly convert psAndQs headers = (,[]) <$> convert (fst psAndQs) headers
339+{-# INLINE pathsOnly #-}
wai-extra/Network/Wai/Middleware/Routed.hsnew file+39
@@ -0,0 +1,39 @@
1+-- |
2+--
3+-- Since 3.0.9
4+module Network.Wai.Middleware.Routed
5+ ( routedMiddleware
6+ , hostedMiddleware
7+ ) where
8+
9+import Network.Wai
10+import Data.ByteString (ByteString)
11+import Data.Text (Text)
12+
13+-- | Apply a middleware based on a test of pathInfo
14+--
15+-- example:
16+--
17+-- > let corsify = routedMiddleWare ("static" `elem`) addCorsHeaders
18+--
19+-- Since 3.0.9
20+routedMiddleware :: ([Text] -> Bool) -- ^ Only use middleware if this pathInfo test returns True
21+ -> Middleware -- ^ middleware to apply the path prefix guard to
22+ -> Middleware -- ^ modified middleware
23+routedMiddleware pathCheck middle app req
24+ | pathCheck (pathInfo req) = middle app req
25+ | otherwise = app req
26+
27+-- | Only apply the middleware to certain hosts
28+--
29+-- Since 3.0.9
30+hostedMiddleware :: ByteString -- ^ Domain the middleware applies to
31+ -> Middleware -- ^ middleware to apply the path prefix guard to
32+ -> Middleware -- ^ modified middleware
33+hostedMiddleware domain middle app req
34+ | hasDomain domain req = middle app req
35+ | otherwise = app req
36+
37+hasDomain :: ByteString -> Request -> Bool
38+hasDomain domain req = maybe False (== domain) mHost
39+ where mHost = requestHeaderHost req
wai-extra/Network/Wai/Middleware/StreamFile.hsnew file+43
@@ -0,0 +1,43 @@
1+-- |
2+--
3+-- Since 3.0.4
4+module Network.Wai.Middleware.StreamFile
5+ (streamFile) where
6+
7+import Network.Wai (responseStream)
8+import Network.Wai.Internal
9+import Network.Wai (Middleware, responseToStream)
10+import qualified Data.ByteString.Char8 as S8
11+import System.PosixCompat (getFileStatus, fileSize, FileOffset)
12+import Network.HTTP.Types (hContentLength)
13+
14+-- |Convert ResponseFile type responses into ResponseStream type
15+--
16+-- Checks the response type, and if it's a ResponseFile, converts it
17+-- into a ResponseStream. Other response types are passed through
18+-- unchanged.
19+--
20+-- Converted responses get a Content-Length header.
21+--
22+-- Streaming a file will bypass a sendfile system call, and may be
23+-- useful to work around systems without working sendfile
24+-- implementations.
25+--
26+-- Since 3.0.4
27+streamFile :: Middleware
28+streamFile app env sendResponse = app env $ \res ->
29+ case res of
30+ ResponseFile _ _ fp _ -> withBody sendBody
31+ where
32+ (s, hs, withBody) = responseToStream res
33+ sendBody :: StreamingBody -> IO ResponseReceived
34+ sendBody body = do
35+ len <- getFileSize fp
36+ let hs' = (hContentLength, (S8.pack (show len))) : hs
37+ sendResponse $ responseStream s hs' body
38+ _ -> sendResponse res
39+
40+getFileSize :: FilePath -> IO FileOffset
41+getFileSize path = do
42+ stat <- getFileStatus path
43+ return (fileSize stat)
wai-extra/Network/Wai/Middleware/StripHeaders.hsnew file+45
@@ -0,0 +1,45 @@
1+-- This was written for one specific use case and then generalized.
2+
3+-- The specific use case was a JSON API with a consumer that would choke on the
4+-- "Set-Cookie" response header. The solution was to test for the API's
5+-- `pathInfo` in the Request and if it matched, filter the response headers.
6+
7+-- When using this, care should be taken not to strip out headers that are
8+-- required for correct operation of the client (eg Content-Type).
9+
10+module Network.Wai.Middleware.StripHeaders
11+ ( stripHeader
12+ , stripHeaders
13+ , stripHeaderIf
14+ , stripHeadersIf
15+ ) where
16+
17+import Network.Wai (Middleware, Request, modifyResponse, mapResponseHeaders, ifRequest)
18+import Network.Wai.Internal (Response)
19+import Data.ByteString (ByteString)
20+
21+import qualified Data.CaseInsensitive as CI
22+
23+stripHeader :: ByteString -> (Response -> Response)
24+stripHeader h = mapResponseHeaders (filter (\ hdr -> fst hdr /= CI.mk h))
25+
26+stripHeaders :: [ByteString] -> (Response -> Response)
27+stripHeaders hs =
28+ let hnames = map CI.mk hs
29+ in mapResponseHeaders (filter (\ hdr -> fst hdr `notElem` hnames))
30+
31+-- | If the request satisifes the provided predicate, strip headers matching
32+-- the provided header name.
33+--
34+-- Since 3.0.8
35+stripHeaderIf :: ByteString -> (Request -> Bool) -> Middleware
36+stripHeaderIf h rpred =
37+ ifRequest rpred (modifyResponse $ stripHeader h)
38+
39+-- | If the request satisifes the provided predicate, strip all headers whose
40+-- header name is in the list of provided header names.
41+--
42+-- Since 3.0.8
43+stripHeadersIf :: [ByteString] -> (Request -> Bool) -> Middleware
44+stripHeadersIf hs rpred
45+ = ifRequest rpred (modifyResponse $ stripHeaders hs)
wai-extra/Network/Wai/Middleware/Timeout.hsnew file+33
@@ -0,0 +1,33 @@
1+-- | Timeout requests
2+module Network.Wai.Middleware.Timeout
3+ ( timeout
4+ , timeoutStatus
5+ , timeoutAs
6+ ) where
7+
8+import Network.HTTP.Types (Status, status503)
9+import Network.Wai
10+import qualified System.Timeout as Timeout
11+
12+-- | Time out the request after the given number of seconds
13+--
14+-- Timeouts respond with @'status503'@. See @'timeoutStatus'@ or @'timeoutAs'@
15+-- to customize the behavior of the timed-out case.
16+--
17+-- @since 3.0.24.0@
18+timeout :: Int -> Middleware
19+timeout = timeoutStatus status503
20+
21+-- | Time out with the given @'Status'@
22+--
23+-- @since 3.0.24.0@
24+timeoutStatus :: Status -> Int -> Middleware
25+timeoutStatus status = timeoutAs $ responseLBS status [] ""
26+
27+-- | Time out with the given @'Response'@
28+--
29+-- @since 3.0.24.0@
30+timeoutAs :: Response -> Int -> Middleware
31+timeoutAs timeoutReponse seconds app req respond =
32+ maybe (respond timeoutReponse) pure
33+ =<< Timeout.timeout (seconds * 1000000) (app req respond)
wai-extra/Network/Wai/Middleware/Vhost.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE CPP #-}
2+ module Network.Wai.Middleware.Vhost (vhost, redirectWWW, redirectTo, redirectToLogged) where
3+
4+import Network.Wai
5+
6+import Network.HTTP.Types as H
7+import qualified Data.Text.Encoding as TE
8+import Data.Text (Text)
9+import qualified Data.ByteString as BS
10+#if __GLASGOW_HASKELL__ < 710
11+import Data.Monoid (mappend)
12+#endif
13+
14+vhost :: [(Request -> Bool, Application)] -> Application -> Application
15+vhost vhosts def req =
16+ case filter (\(b, _) -> b req) vhosts of
17+ [] -> def req
18+ (_, app):_ -> app req
19+
20+redirectWWW :: Text -> Application -> Application -- W.MiddleWare
21+redirectWWW home =
22+ redirectIf home (maybe True (BS.isPrefixOf "www") . lookup "host" . requestHeaders)
23+
24+redirectIf :: Text -> (Request -> Bool) -> Application -> Application
25+redirectIf home cond app req sendResponse =
26+ if cond req
27+ then sendResponse $ redirectTo $ TE.encodeUtf8 home
28+ else app req sendResponse
29+
30+redirectTo :: BS.ByteString -> Response
31+redirectTo location = responseLBS H.status301
32+ [ (H.hContentType, "text/plain") , (H.hLocation, location) ] "Redirect"
33+
34+redirectToLogged :: (Text -> IO ()) -> BS.ByteString -> IO Response
35+redirectToLogged logger loc = do
36+ logger $ "redirecting to: " `mappend` TE.decodeUtf8 loc
37+ return $ redirectTo loc
wai-extra/Network/Wai/Parse.hsnew file+715
@@ -0,0 +1,715 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+{-# LANGUAGE PatternGuards #-}
4+{-# LANGUAGE TypeFamilies #-}
5+{-# LANGUAGE RankNTypes #-}
6+-- | Some helpers for parsing data out of a raw WAI 'Request'.
7+
8+module Network.Wai.Parse
9+ ( parseHttpAccept
10+ , parseRequestBody
11+ , RequestBodyType (..)
12+ , getRequestBodyType
13+ , sinkRequestBody
14+ , sinkRequestBodyEx
15+ , BackEnd
16+ , lbsBackEnd
17+ , tempFileBackEnd
18+ , tempFileBackEndOpts
19+ , Param
20+ , File
21+ , FileInfo (..)
22+ , parseContentType
23+ , ParseRequestBodyOptions
24+ , defaultParseRequestBodyOptions
25+ , noLimitParseRequestBodyOptions
26+ , parseRequestBodyEx
27+ , setMaxRequestKeyLength
28+ , clearMaxRequestKeyLength
29+ , setMaxRequestNumFiles
30+ , clearMaxRequestNumFiles
31+ , setMaxRequestFileSize
32+ , clearMaxRequestFileSize
33+ , setMaxRequestFilesSize
34+ , clearMaxRequestFilesSize
35+ , setMaxRequestParmsSize
36+ , clearMaxRequestParmsSize
37+ , setMaxHeaderLines
38+ , clearMaxHeaderLines
39+ , setMaxHeaderLineLength
40+ , clearMaxHeaderLineLength
41+#if TEST
42+ , Bound (..)
43+ , findBound
44+ , sinkTillBound
45+ , killCR
46+ , killCRLF
47+ , takeLine
48+#endif
49+ ) where
50+
51+import qualified Control.Exception as E
52+import qualified Data.ByteString as S
53+import qualified Data.ByteString.Lazy as L
54+import qualified Data.ByteString.Char8 as S8
55+import Data.Word (Word8)
56+import Data.Int (Int64)
57+import Data.Maybe (catMaybes, fromMaybe)
58+import Data.List (sortBy)
59+import Data.Function (on, fix)
60+import System.Directory (removeFile, getTemporaryDirectory)
61+import System.IO (hClose, openBinaryTempFile)
62+import System.IO.Error (isDoesNotExistError)
63+import Network.Wai
64+import qualified Network.HTTP.Types as H
65+import Control.Applicative ((<$>))
66+import Control.Exception (catchJust)
67+import Control.Monad (when, unless, guard)
68+import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
69+import Data.IORef
70+import Network.HTTP.Types (hContentType)
71+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
72+import Data.CaseInsensitive (mk)
73+
74+import Prelude hiding (lines)
75+
76+breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
77+breakDiscard w s =
78+ let (x, y) = S.break (== w) s
79+ in (x, S.drop 1 y)
80+
81+-- | Parse the HTTP accept string to determine supported content types.
82+parseHttpAccept :: S.ByteString -> [S.ByteString]
83+parseHttpAccept = map fst
84+ . sortBy (rcompare `on` snd)
85+ . map (addSpecificity . grabQ)
86+ . S.split 44 -- comma
87+ where
88+ rcompare :: (Double,Int) -> (Double,Int) -> Ordering
89+ rcompare = flip compare
90+ addSpecificity (s, q) =
91+ -- Prefer higher-specificity types
92+ let semicolons = S.count 0x3B s
93+ stars = S.count 0x2A s
94+ in (s, (q, semicolons - stars))
95+ grabQ s =
96+ -- Stripping all spaces may be too harsh.
97+ -- Maybe just strip either side of semicolon?
98+ let (s', q) = S.breakSubstring ";q=" (S.filter (/=0x20) s) -- 0x20 is space
99+ q' = S.takeWhile (/=0x3B) (S.drop 3 q) -- 0x3B is semicolon
100+ in (s', readQ q')
101+ readQ s = case reads $ S8.unpack s of
102+ (x, _):_ -> x
103+ _ -> 1.0
104+
105+-- | Store uploaded files in memory
106+lbsBackEnd :: Monad m => ignored1 -> ignored2 -> m S.ByteString -> m L.ByteString
107+lbsBackEnd _ _ popper =
108+ loop id
109+ where
110+ loop front = do
111+ bs <- popper
112+ if S.null bs
113+ then return $ L.fromChunks $ front []
114+ else loop $ front . (bs:)
115+
116+-- | Save uploaded files on disk as temporary files
117+--
118+-- Note: starting with version 2.0, removal of temp files is registered with
119+-- the provided @InternalState@. It is the responsibility of the caller to
120+-- ensure that this @InternalState@ gets cleaned up.
121+tempFileBackEnd :: InternalState -> ignored1 -> ignored2 -> IO S.ByteString -> IO FilePath
122+tempFileBackEnd = tempFileBackEndOpts getTemporaryDirectory "webenc.buf"
123+
124+-- | Same as 'tempFileBackEnd', but use configurable temp folders and patterns.
125+tempFileBackEndOpts :: IO FilePath -- ^ get temporary directory
126+ -> String -- ^ filename pattern
127+ -> InternalState
128+ -> ignored1
129+ -> ignored2
130+ -> IO S.ByteString
131+ -> IO FilePath
132+tempFileBackEndOpts getTmpDir pattrn internalState _ _ popper = do
133+ (key, (fp, h)) <- flip runInternalState internalState $ allocate it (hClose . snd)
134+ _ <- runInternalState (register $ removeFileQuiet fp) internalState
135+ fix $ \loop -> do
136+ bs <- popper
137+ unless (S.null bs) $ do
138+ S.hPut h bs
139+ loop
140+ release key
141+ return fp
142+ where
143+ it = do
144+ tempDir <- getTmpDir
145+ openBinaryTempFile tempDir pattrn
146+ removeFileQuiet fp = catchJust (guard . isDoesNotExistError)
147+ (removeFile fp)
148+ (const $ return ())
149+
150+-- | A data structure that describes the behavior of
151+-- the parseRequestBodyEx function.
152+--
153+-- @since 3.0.16.0
154+data ParseRequestBodyOptions = ParseRequestBodyOptions
155+ { -- | The maximum length of a filename
156+ prboKeyLength :: Maybe Int
157+ , -- | The maximum number of files.
158+ prboMaxNumFiles :: Maybe Int
159+ , -- | The maximum filesize per file.
160+ prboMaxFileSize :: Maybe Int64
161+ , -- | The maximum total filesize.
162+ prboMaxFilesSize :: Maybe Int64
163+ , -- | The maximum size of the sum of all parameters
164+ prboMaxParmsSize :: Maybe Int
165+ , -- | The maximum header lines per mime/multipart entry
166+ prboMaxHeaderLines :: Maybe Int
167+ , -- | The maximum header line length per mime/multipart entry
168+ prboMaxHeaderLineLength :: Maybe Int }
169+
170+-- | Set the maximum length of a filename.
171+--
172+-- @since 3.0.16.0
173+setMaxRequestKeyLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
174+setMaxRequestKeyLength l p = p { prboKeyLength=Just l }
175+
176+-- | Do not limit the length of filenames.
177+--
178+-- @since 3.0.16.0
179+clearMaxRequestKeyLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
180+clearMaxRequestKeyLength p = p { prboKeyLength=Nothing }
181+
182+-- | Set the maximum number of files per request.
183+--
184+-- @since 3.0.16.0
185+setMaxRequestNumFiles :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
186+setMaxRequestNumFiles l p = p { prboMaxNumFiles=Just l }
187+
188+-- | Do not limit the maximum number of files per request.
189+--
190+-- @since 3.0.16.0
191+clearMaxRequestNumFiles :: ParseRequestBodyOptions -> ParseRequestBodyOptions
192+clearMaxRequestNumFiles p = p { prboMaxNumFiles=Nothing }
193+
194+-- | Set the maximum filesize per file (in bytes).
195+--
196+-- @since 3.0.16.0
197+setMaxRequestFileSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
198+setMaxRequestFileSize l p = p { prboMaxFileSize=Just l }
199+
200+-- | Do not limit the maximum filesize per file.
201+--
202+-- @since 3.0.16.0
203+clearMaxRequestFileSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
204+clearMaxRequestFileSize p = p { prboMaxFileSize=Nothing }
205+
206+-- | Set the maximum size of all files per request.
207+--
208+-- @since 3.0.16.0
209+setMaxRequestFilesSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
210+setMaxRequestFilesSize l p = p { prboMaxFilesSize=Just l }
211+
212+-- | Do not limit the maximum size of all files per request.
213+--
214+-- @since 3.0.16.0
215+clearMaxRequestFilesSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
216+clearMaxRequestFilesSize p = p { prboMaxFilesSize=Nothing }
217+
218+-- | Set the maximum size of the sum of all parameters.
219+--
220+-- @since 3.0.16.0
221+setMaxRequestParmsSize :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
222+setMaxRequestParmsSize l p = p { prboMaxParmsSize=Just l }
223+
224+-- | Do not limit the maximum size of the sum of all parameters.
225+--
226+-- @since 3.0.16.0
227+clearMaxRequestParmsSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
228+clearMaxRequestParmsSize p = p { prboMaxParmsSize=Nothing }
229+
230+-- | Set the maximum header lines per mime/multipart entry.
231+--
232+-- @since 3.0.16.0
233+setMaxHeaderLines :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
234+setMaxHeaderLines l p = p { prboMaxHeaderLines=Just l }
235+
236+-- | Do not limit the maximum header lines per mime/multipart entry.
237+--
238+-- @since 3.0.16.0
239+clearMaxHeaderLines:: ParseRequestBodyOptions -> ParseRequestBodyOptions
240+clearMaxHeaderLines p = p { prboMaxHeaderLines=Nothing }
241+
242+-- | Set the maximum header line length per mime/multipart entry.
243+--
244+-- @since 3.0.16.0
245+setMaxHeaderLineLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
246+setMaxHeaderLineLength l p = p { prboMaxHeaderLineLength=Just l }
247+
248+-- | Do not limit the maximum header lines per mime/multipart entry.
249+--
250+-- @since 3.0.16.0
251+clearMaxHeaderLineLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
252+clearMaxHeaderLineLength p = p { prboMaxHeaderLineLength=Nothing }
253+
254+-- | A reasonable default set of parsing options.
255+-- Maximum key/filename length: 32 bytes;
256+-- maximum files: 10; filesize unlimited; maximum
257+-- size for parameters: 64kbytes; maximum number of header
258+-- lines: 32 bytes (applies only to headers of a mime/multipart message);
259+-- maximum header line length: Apache's default for that is 8190 bytes
260+-- (http://httpd.apache.org/docs/2.2/mod/core.html#limitrequestline)
261+-- so we're using that here as well.
262+--
263+-- @since 3.0.16.0
264+defaultParseRequestBodyOptions :: ParseRequestBodyOptions
265+defaultParseRequestBodyOptions = ParseRequestBodyOptions
266+ { prboKeyLength=Just 32
267+ , prboMaxNumFiles=Just 10
268+ , prboMaxFileSize=Nothing
269+ , prboMaxFilesSize=Nothing
270+ , prboMaxParmsSize=Just 65336
271+ , prboMaxHeaderLines=Just 32
272+ , prboMaxHeaderLineLength=Just 8190 }
273+
274+-- | Do not impose any memory limits.
275+--
276+-- @since 3.0.21.0
277+noLimitParseRequestBodyOptions :: ParseRequestBodyOptions
278+noLimitParseRequestBodyOptions = ParseRequestBodyOptions
279+ { prboKeyLength=Nothing
280+ , prboMaxNumFiles=Nothing
281+ , prboMaxFileSize=Nothing
282+ , prboMaxFilesSize=Nothing
283+ , prboMaxParmsSize=Nothing
284+ , prboMaxHeaderLines=Nothing
285+ , prboMaxHeaderLineLength=Nothing }
286+
287+-- | Information on an uploaded file.
288+data FileInfo c = FileInfo
289+ { fileName :: S.ByteString
290+ , fileContentType :: S.ByteString
291+ , fileContent :: c
292+ }
293+ deriving (Eq, Show)
294+
295+-- | Post parameter name and value.
296+type Param = (S.ByteString, S.ByteString)
297+
298+-- | Post parameter name and associated file information.
299+type File y = (S.ByteString, FileInfo y)
300+
301+-- | A file uploading backend. Takes the parameter name, file name, and a
302+-- stream of data.
303+type BackEnd a = S.ByteString -- ^ parameter name
304+ -> FileInfo ()
305+ -> IO S.ByteString
306+ -> IO a
307+
308+-- | The mimetype of the http body.
309+-- Depending on whether just parameters or parameters and files
310+-- are passed, one or the other mimetype should be used.
311+data RequestBodyType
312+ = -- | application/x-www-form-urlencoded (parameters only)
313+ UrlEncoded
314+ | -- | multipart/form-data (parameters and files)
315+ Multipart S.ByteString
316+
317+-- | Get the mimetype of the body of an http request.
318+getRequestBodyType :: Request -> Maybe RequestBodyType
319+getRequestBodyType req = do
320+ ctype' <- lookup hContentType $ requestHeaders req
321+ let (ctype, attrs) = parseContentType ctype'
322+ case ctype of
323+ "application/x-www-form-urlencoded" -> return UrlEncoded
324+ "multipart/form-data" | Just bound <- lookup "boundary" attrs -> return $ Multipart bound
325+ _ -> Nothing
326+
327+-- | Parse a content type value, turning a single @ByteString@ into the actual
328+-- content type and a list of pairs of attributes.
329+--
330+-- @since 1.3.2
331+parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
332+parseContentType a = do
333+ let (ctype, b) = S.break (== semicolon) a
334+ attrs = goAttrs id $ S.drop 1 b
335+ in (ctype, attrs)
336+ where
337+ semicolon = 59
338+ equals = 61
339+ space = 32
340+ dq s = if S.length s > 2 && S.head s == 34 && S.last s == 34 -- quote
341+ then S.tail $ S.init s
342+ else s
343+ goAttrs front bs
344+ | S.null bs = front []
345+ | otherwise =
346+ let (x, rest) = S.break (== semicolon) bs
347+ in goAttrs (front . (goAttr x:)) $ S.drop 1 rest
348+ goAttr bs =
349+ let (k, v') = S.break (== equals) bs
350+ v = S.drop 1 v'
351+ in (strip k, dq $ strip v)
352+ strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
353+
354+-- | Parse the body of an HTTP request.
355+-- See parseRequestBodyEx for details.
356+-- Note: This function does not limit the memory it allocates.
357+-- When dealing with untrusted data (as is usually the case when
358+-- receiving input from the internet), it is recommended to
359+-- use the 'parseRequestBodyEx' function instead.
360+parseRequestBody :: BackEnd y
361+ -> Request
362+ -> IO ([Param], [File y])
363+parseRequestBody = parseRequestBodyEx noLimitParseRequestBodyOptions
364+
365+-- | Parse the body of an HTTP request, limit resource usage.
366+-- The HTTP body can contain both parameters and files.
367+-- This function will return a list of key,value pairs
368+-- for all parameters, and a list of key,a pairs
369+-- for filenames. The a depends on the used backend that
370+-- is responsible for storing the received files.
371+parseRequestBodyEx :: ParseRequestBodyOptions
372+ -> BackEnd y
373+ -> Request
374+ -> IO ([Param], [File y])
375+parseRequestBodyEx o s r =
376+ case getRequestBodyType r of
377+ Nothing -> return ([], [])
378+ Just rbt -> sinkRequestBodyEx o s rbt (requestBody r)
379+
380+sinkRequestBody :: BackEnd y
381+ -> RequestBodyType
382+ -> IO S.ByteString
383+ -> IO ([Param], [File y])
384+sinkRequestBody = sinkRequestBodyEx noLimitParseRequestBodyOptions
385+
386+-- |
387+--
388+-- @since 3.0.16.0
389+sinkRequestBodyEx :: ParseRequestBodyOptions
390+ -> BackEnd y
391+ -> RequestBodyType
392+ -> IO S.ByteString
393+ -> IO ([Param], [File y])
394+sinkRequestBodyEx o s r body = do
395+ ref <- newIORef ([], [])
396+ let add x = atomicModifyIORef ref $ \(y, z) ->
397+ case x of
398+ Left y' -> ((y':y, z), ())
399+ Right z' -> ((y, z':z), ())
400+ conduitRequestBodyEx o s r body add
401+ (\(a, b) -> (reverse a, reverse b)) <$> readIORef ref
402+
403+conduitRequestBodyEx :: ParseRequestBodyOptions
404+ -> BackEnd y
405+ -> RequestBodyType
406+ -> IO S.ByteString
407+ -> (Either Param (File y) -> IO ())
408+ -> IO ()
409+conduitRequestBodyEx o _ UrlEncoded rbody add = do
410+ -- NOTE: in general, url-encoded data will be in a single chunk.
411+ -- Therefore, I'm optimizing for the usual case by sticking with
412+ -- strict byte strings here.
413+ let loop size front = do
414+ bs <- rbody
415+ if S.null bs
416+ then return $ S.concat $ front []
417+ else do
418+ let newsize = size + S.length bs
419+ case prboMaxParmsSize o of
420+ Just maxSize -> when (newsize > maxSize) $
421+ error "Maximum size of parameters exceeded"
422+ Nothing -> return ()
423+ loop newsize $ front . (bs:)
424+ bs <- loop 0 id
425+ mapM_ (add . Left) $ H.parseSimpleQuery bs
426+conduitRequestBodyEx o backend (Multipart bound) rbody add =
427+ parsePiecesEx o backend (S8.pack "--" `S.append` bound) rbody add
428+
429+
430+-- | Take one header or subheader line.
431+-- Since: 3.0.26
432+-- Throw 431 if headers too large.
433+takeLine :: Maybe Int -> Source -> IO (Maybe S.ByteString)
434+takeLine maxlen src =
435+ go ""
436+ where
437+ go front = do
438+ bs <- readSource src
439+ case maxlen of
440+ Just maxlen' -> when (S.length front > maxlen') $
441+ E.throwIO $ ConnectionError (UnknownErrorCode 431)
442+ "Request Header Fields Too Large"
443+ Nothing -> return ()
444+ if S.null bs
445+ then close front
446+ else push front bs
447+
448+ close front = leftover src front >> return Nothing
449+ push front bs = do
450+ let (x, y) = S.break (== 10) bs -- LF
451+ in if S.null y
452+ then go $ front `S.append` x
453+ else do
454+ when (S.length y > 1) $ leftover src $ S.drop 1 y
455+ let res = front `S.append` x
456+ case maxlen of
457+ Just maxlen' -> when (S.length res > maxlen') $
458+ E.throwIO $ ConnectionError (UnknownErrorCode 431)
459+ "Request Header Fields Too Large"
460+ Nothing -> return ()
461+ return $ Just $ killCR $ res
462+
463+takeLines' :: Maybe Int -> Maybe Int -> Source -> IO [S.ByteString]
464+takeLines' lineLength maxLines source =
465+ reverse <$> takeLines'' [] lineLength maxLines source
466+
467+takeLines''
468+ :: [S.ByteString]
469+ -> Maybe Int
470+ -> Maybe Int
471+ -> Source
472+ -> IO [S.ByteString]
473+takeLines'' lines lineLength maxLines src = do
474+ case maxLines of
475+ Just maxLines' ->
476+ when (length lines > maxLines') $
477+ error "Too many lines in mime/multipart header"
478+ Nothing -> return ()
479+ res <- takeLine lineLength src
480+ case res of
481+ Nothing -> return lines
482+ Just l
483+ | S.null l -> return lines
484+ | otherwise -> takeLines'' (l:lines) lineLength maxLines src
485+
486+data Source = Source (IO S.ByteString) (IORef S.ByteString)
487+
488+mkSource :: IO S.ByteString -> IO Source
489+mkSource f = do
490+ ref <- newIORef S.empty
491+ return $ Source f ref
492+
493+readSource :: Source -> IO S.ByteString
494+readSource (Source f ref) = do
495+ bs <- atomicModifyIORef ref $ \bs -> (S.empty, bs)
496+ if S.null bs
497+ then f
498+ else return bs
499+
500+leftover :: Source -> S.ByteString -> IO ()
501+leftover (Source _ ref) bs = writeIORef ref bs
502+
503+parsePiecesEx :: ParseRequestBodyOptions
504+ -> BackEnd y
505+ -> S.ByteString
506+ -> IO S.ByteString
507+ -> (Either Param (File y) -> IO ())
508+ -> IO ()
509+parsePiecesEx o sink bound rbody add =
510+ mkSource rbody >>= loop 0 0 0 0
511+ where
512+ loop :: Int -> Int -> Int -> Int64 -> Source -> IO ()
513+ loop numParms numFiles parmSize filesSize src = do
514+ _boundLine <- takeLine (prboMaxHeaderLineLength o) src
515+ res' <- takeLines' (prboMaxHeaderLineLength o)
516+ (prboMaxHeaderLines o) src
517+ unless (null res') $ do
518+ let ls' = map parsePair res'
519+ let x = do
520+ cd <- lookup contDisp ls'
521+ let ct = lookup contType ls'
522+ let attrs = parseAttrs cd
523+ name <- lookup "name" attrs
524+ return (ct, name, lookup "filename" attrs)
525+ case x of
526+ Just (mct, name, Just filename) -> do
527+ case prboKeyLength o of
528+ Just maxKeyLength ->
529+ when (S.length name > maxKeyLength) $
530+ error "Filename is too long"
531+ Nothing -> return ()
532+ case prboMaxNumFiles o of
533+ Just maxFiles -> when (numFiles >= maxFiles) $
534+ error "Maximum number of files exceeded"
535+ Nothing -> return ()
536+ let ct = fromMaybe "application/octet-stream" mct
537+ fi0 = FileInfo filename ct ()
538+ fs = catMaybes [ prboMaxFileSize o
539+ , subtract filesSize <$> prboMaxFilesSize o ]
540+ mfs = if fs == [] then Nothing else Just $ minimum fs
541+ ((wasFound, fileSize), y) <- sinkTillBound' bound name fi0 sink src mfs
542+ let newFilesSize = filesSize + fileSize
543+ add $ Right (name, fi0 { fileContent = y })
544+ when wasFound $ loop numParms (numFiles + 1) parmSize newFilesSize src
545+ Just (_ct, name, Nothing) -> do
546+ case prboKeyLength o of
547+ Just maxKeyLength ->
548+ when (S.length name > maxKeyLength) $
549+ error "Parameter name is too long"
550+ Nothing -> return ()
551+ let seed = id
552+ let iter front bs = return $ front . (:) bs
553+ ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src
554+ (fromIntegral <$> prboMaxParmsSize o)
555+ let bs = S.concat $ front []
556+ let x' = (name, bs)
557+ let newParmSize = parmSize + S.length name + S.length bs
558+ case prboMaxParmsSize o of
559+ Just maxParmSize -> when (newParmSize > maxParmSize) $
560+ error "Maximum size of parameters exceeded"
561+ Nothing -> return ()
562+ add $ Left x'
563+ when wasFound $ loop (numParms + 1) numFiles
564+ newParmSize filesSize src
565+ _ -> do
566+ -- ignore this part
567+ let seed = ()
568+ iter () _ = return ()
569+ ((wasFound, _fileSize), ()) <- sinkTillBound bound iter seed src Nothing
570+ when wasFound $ loop numParms numFiles parmSize filesSize src
571+ where
572+ contDisp = mk $ S8.pack "Content-Disposition"
573+ contType = mk $ S8.pack "Content-Type"
574+ parsePair s =
575+ let (x, y) = breakDiscard 58 s -- colon
576+ in (mk $ x, S.dropWhile (== 32) y) -- space
577+
578+
579+data Bound = FoundBound S.ByteString S.ByteString
580+ | NoBound
581+ | PartialBound
582+ deriving (Eq, Show)
583+
584+findBound :: S.ByteString -> S.ByteString -> Bound
585+findBound b bs = handleBreak $ S.breakSubstring b bs
586+ where
587+ handleBreak (h, t)
588+ | S.null t = go [lowBound..S.length bs - 1]
589+ | otherwise = FoundBound h $ S.drop (S.length b) t
590+
591+ lowBound = max 0 $ S.length bs - S.length b
592+
593+ go [] = NoBound
594+ go (i:is)
595+ | mismatch [0..S.length b - 1] [i..S.length bs - 1] = go is
596+ | otherwise =
597+ let endI = i + S.length b
598+ in if endI > S.length bs
599+ then PartialBound
600+ else FoundBound (S.take i bs) (S.drop endI bs)
601+ mismatch [] _ = False
602+ mismatch _ [] = False
603+ mismatch (x:xs) (y:ys)
604+ | S.index b x == S.index bs y = mismatch xs ys
605+ | otherwise = True
606+
607+sinkTillBound' :: S.ByteString
608+ -> S.ByteString
609+ -> FileInfo ()
610+ -> BackEnd y
611+ -> Source
612+ -> Maybe Int64
613+ -> IO ((Bool, Int64), y)
614+sinkTillBound' bound name fi sink src max' = do
615+ (next, final) <- wrapTillBound bound src max'
616+ y <- sink name fi next
617+ b <- final
618+ return (b, y)
619+
620+data WTB = WTBWorking (S.ByteString -> S.ByteString)
621+ | WTBDone Bool
622+wrapTillBound :: S.ByteString -- ^ bound
623+ -> Source
624+ -> Maybe Int64
625+ -> IO (IO S.ByteString, IO (Bool, Int64)) -- ^ Bool indicates if the bound was found
626+wrapTillBound bound src max' = do
627+ ref <- newIORef $ WTBWorking id
628+ sref <- newIORef (0 :: Int64)
629+ return (go ref sref, final ref sref)
630+ where
631+ final ref sref = do
632+ x <- readIORef ref
633+ case x of
634+ WTBWorking _ -> error "wrapTillBound did not finish"
635+ WTBDone y -> do
636+ siz <- readIORef sref
637+ return (y, siz)
638+
639+ go ref sref = do
640+ state <- readIORef ref
641+ case state of
642+ WTBDone _ -> return S.empty
643+ WTBWorking front -> do
644+ bs <- readSource src
645+ cur <- atomicModifyIORef' sref $ \ cur ->
646+ let new = cur + fromIntegral (S.length bs) in (new, new)
647+ case max' of
648+ Just max'' | cur > max'' ->
649+ E.throwIO $ ConnectionError (UnknownErrorCode 413) "Payload Too Large"
650+ _ -> return ()
651+ if S.null bs
652+ then do
653+ writeIORef ref $ WTBDone False
654+ return $ front bs
655+ else push $ front bs
656+ where
657+ push bs = do
658+ case findBound bound bs of
659+ FoundBound before after -> do
660+ let before' = killCRLF before
661+ leftover src after
662+ writeIORef ref $ WTBDone True
663+ return before'
664+ NoBound -> do
665+ -- don't emit newlines, in case it's part of a bound
666+ let (toEmit, front') =
667+ if not (S8.null bs) && S8.last bs `elem` ['\r','\n']
668+ then let (x, y) = S.splitAt (S.length bs - 2) bs
669+ in (x, S.append y)
670+ else (bs, id)
671+ writeIORef ref $ WTBWorking front'
672+ if S.null toEmit
673+ then go ref sref
674+ else return toEmit
675+ PartialBound -> do
676+ writeIORef ref $ WTBWorking $ S.append bs
677+ go ref sref
678+
679+sinkTillBound :: S.ByteString
680+ -> (x -> S.ByteString -> IO x)
681+ -> x
682+ -> Source
683+ -> Maybe Int64
684+ -> IO ((Bool, Int64), x)
685+sinkTillBound bound iter seed0 src max' = do
686+ (next, final) <- wrapTillBound bound src max'
687+ let loop seed = do
688+ bs <- next
689+ if S.null bs
690+ then return seed
691+ else iter seed bs >>= loop
692+ seed <- loop seed0
693+ b <- final
694+ return (b, seed)
695+
696+parseAttrs :: S.ByteString -> [(S.ByteString, S.ByteString)]
697+parseAttrs = map go . S.split 59 -- semicolon
698+ where
699+ tw = S.dropWhile (== 32) -- space
700+ dq s = if S.length s > 2 && S.head s == 34 && S.last s == 34 -- quote
701+ then S.tail $ S.init s
702+ else s
703+ go s =
704+ let (x, y) = breakDiscard 61 s -- equals sign
705+ in (tw x, dq $ tw y)
706+
707+killCRLF :: S.ByteString -> S.ByteString
708+killCRLF bs
709+ | S.null bs || S.last bs /= 10 = bs -- line feed
710+ | otherwise = killCR $ S.init bs
711+
712+killCR :: S.ByteString -> S.ByteString
713+killCR bs
714+ | S.null bs || S.last bs /= 13 = bs -- carriage return
715+ | otherwise = S.init bs
wai-extra/Network/Wai/Request.hsnew file+101
@@ -0,0 +1,101 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+-- | Some helpers for interrogating a WAI 'Request'.
3+
4+module Network.Wai.Request
5+ ( appearsSecure
6+ , guessApproot
7+ , RequestSizeException(..)
8+ , requestSizeCheck
9+ ) where
10+
11+import Data.ByteString (ByteString)
12+import Data.Maybe (fromMaybe)
13+import Network.HTTP.Types (HeaderName)
14+import Network.Wai
15+
16+import qualified Data.ByteString as S
17+import qualified Data.ByteString.Char8 as C
18+import Control.Exception (Exception, throwIO)
19+import Data.Typeable (Typeable)
20+import Data.Word (Word64)
21+import Data.IORef (atomicModifyIORef', newIORef)
22+
23+
24+-- | Does this request appear to have been made over an SSL connection?
25+--
26+-- This function first checks @'isSecure'@, but also checks for headers that may
27+-- indicate a secure connection even in the presence of reverse proxies.
28+--
29+-- Note: these headers can be easily spoofed, so decisions which require a true
30+-- SSL connection (i.e. sending sensitive information) should only use
31+-- @'isSecure'@. This is not always the case though: for example, deciding to
32+-- force a non-SSL request to SSL by redirect. One can safely choose not to
33+-- redirect when the request /appears/ secure, even if it's actually not.
34+--
35+-- @since 3.0.7
36+appearsSecure :: Request -> Bool
37+appearsSecure request = isSecure request || any (uncurry matchHeader)
38+ [ ("HTTPS" , (== "on"))
39+ , ("HTTP_X_FORWARDED_SSL" , (== "on"))
40+ , ("HTTP_X_FORWARDED_SCHEME", (== "https"))
41+ , ("HTTP_X_FORWARDED_PROTO" , ((== ["https"]) . take 1 . C.split ','))
42+ , ("X-Forwarded-Proto" , (== "https")) -- Used by Nginx and AWS ELB.
43+ ]
44+
45+ where
46+ matchHeader :: HeaderName -> (ByteString -> Bool) -> Bool
47+ matchHeader h f = maybe False f $ lookup h $ requestHeaders request
48+
49+-- | Guess the \"application root\" based on the given request.
50+--
51+-- The application root is the basis for forming URLs pointing at the current
52+-- application. For more information and relevant caveats, please see
53+-- "Network.Wai.Middleware.Approot".
54+--
55+-- @since 3.0.7
56+guessApproot :: Request -> ByteString
57+guessApproot req =
58+ (if appearsSecure req then "https://" else "http://") `S.append`
59+ (fromMaybe "localhost" $ requestHeaderHost req)
60+
61+-- | see 'requestSizeCheck'
62+--
63+-- @since 3.0.15
64+data RequestSizeException
65+ = RequestSizeException Word64
66+ deriving (Eq, Ord, Typeable)
67+
68+instance Exception RequestSizeException
69+
70+instance Show RequestSizeException where
71+ showsPrec p (RequestSizeException limit) =
72+ showString ("Request Body is larger than ") . showsPrec p limit . showString " bytes."
73+
74+-- | Check request body size to avoid server crash when request is too large.
75+--
76+-- This function first checks @'requestBodyLength'@, if content-length is known
77+-- but larger than limit, or it's unknown but we have received too many chunks,
78+-- a 'RequestSizeException' are thrown when user use @'requestBody'@ to extract
79+-- request body inside IO.
80+--
81+-- @since 3.0.15
82+requestSizeCheck :: Word64 -> Request -> IO Request
83+requestSizeCheck maxSize req =
84+ case requestBodyLength req of
85+ KnownLength len ->
86+ if len > maxSize
87+ then return $ req { requestBody = throwIO (RequestSizeException maxSize) }
88+ else return req
89+ ChunkedBody -> do
90+ currentSize <- newIORef 0
91+ return $ req
92+ { requestBody = do
93+ bs <- requestBody req
94+ total <-
95+ atomicModifyIORef' currentSize $ \sz ->
96+ let nextSize = sz + fromIntegral (S.length bs)
97+ in (nextSize, nextSize)
98+ if total > maxSize
99+ then throwIO (RequestSizeException maxSize)
100+ else return bs
101+ }
wai-extra/Network/Wai/Test.hsnew file+333
@@ -0,0 +1,333 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE DeriveDataTypeable #-}
4+module Network.Wai.Test
5+ ( -- * Session
6+ Session
7+ , runSession
8+ -- * Client Cookies
9+ , ClientCookies
10+ , getClientCookies
11+ , modifyClientCookies
12+ , setClientCookie
13+ , deleteClientCookie
14+ -- * Requests
15+ , request
16+ , srequest
17+ , SRequest (..)
18+ , SResponse (..)
19+ , defaultRequest
20+ , setPath
21+ , setRawPathInfo
22+ -- * Assertions
23+ , assertStatus
24+ , assertContentType
25+ , assertBody
26+ , assertBodyContains
27+ , assertHeader
28+ , assertNoHeader
29+ , assertClientCookieExists
30+ , assertNoClientCookieExists
31+ , assertClientCookieValue
32+ , WaiTestFailure (..)
33+ ) where
34+
35+#if __GLASGOW_HASKELL__ < 710
36+import Control.Applicative ((<$>))
37+import Data.Monoid (mempty, mappend)
38+#endif
39+
40+import Network.Wai
41+import Network.Wai.Internal (ResponseReceived (ResponseReceived))
42+import Network.Wai.Test.Internal
43+import Control.Monad.IO.Class (liftIO)
44+import Control.Monad.Trans.Class (lift)
45+import qualified Control.Monad.Trans.State as ST
46+import Control.Monad.Trans.Reader (runReaderT, ask)
47+import Control.Monad (unless)
48+import Control.DeepSeq (deepseq)
49+import Control.Exception (throwIO, Exception)
50+import Data.Typeable (Typeable)
51+import qualified Data.Map as Map
52+import qualified Web.Cookie as Cookie
53+import Data.ByteString (ByteString)
54+import qualified Data.ByteString.Char8 as S8
55+import Data.ByteString.Builder (toLazyByteString)
56+import qualified Data.ByteString.Lazy as L
57+import qualified Data.ByteString.Lazy.Char8 as L8
58+import qualified Network.HTTP.Types as H
59+import Data.CaseInsensitive (CI)
60+import qualified Data.ByteString as S
61+import qualified Data.Text as T
62+import qualified Data.Text.Encoding as TE
63+import Data.IORef
64+import Data.Time.Clock (getCurrentTime)
65+
66+-- |
67+--
68+-- Since 3.0.6
69+getClientCookies :: Session ClientCookies
70+getClientCookies = clientCookies <$> lift ST.get
71+
72+-- |
73+--
74+-- Since 3.0.6
75+modifyClientCookies :: (ClientCookies -> ClientCookies) -> Session ()
76+modifyClientCookies f =
77+ lift (ST.modify (\cs -> cs { clientCookies = f $ clientCookies cs }))
78+
79+-- |
80+--
81+-- Since 3.0.6
82+setClientCookie :: Cookie.SetCookie -> Session ()
83+setClientCookie c =
84+ modifyClientCookies
85+ (Map.insert (Cookie.setCookieName c) c)
86+
87+-- |
88+--
89+-- Since 3.0.6
90+deleteClientCookie :: ByteString -> Session ()
91+deleteClientCookie cookieName =
92+ modifyClientCookies
93+ (Map.delete cookieName)
94+
95+-- | See also: 'runSessionWith'.
96+runSession :: Session a -> Application -> IO a
97+runSession session app = ST.evalStateT (runReaderT session app) initState
98+
99+data SRequest = SRequest
100+ { simpleRequest :: Request
101+ , simpleRequestBody :: L.ByteString
102+ -- ^ Request body that will override the one set in 'simpleRequest'.
103+ --
104+ -- This is usually simpler than setting the body as a stateful IO-action
105+ -- in 'simpleRequest'.
106+ }
107+data SResponse = SResponse
108+ { simpleStatus :: H.Status
109+ , simpleHeaders :: H.ResponseHeaders
110+ , simpleBody :: L.ByteString
111+ }
112+ deriving (Show, Eq)
113+
114+request :: Request -> Session SResponse
115+request req = do
116+ app <- ask
117+ req' <- addCookiesToRequest req
118+ response <- liftIO $ do
119+ ref <- newIORef $ error "runResponse gave no result"
120+ ResponseReceived <- app req' (runResponse ref)
121+ readIORef ref
122+ extractSetCookieFromSResponse response
123+
124+-- | Set whole path (request path + query string).
125+setPath :: Request -> S8.ByteString -> Request
126+setPath req path = req {
127+ pathInfo = segments
128+ , rawPathInfo = (L8.toStrict . toLazyByteString) (H.encodePathSegments segments)
129+ , queryString = query
130+ , rawQueryString = (H.renderQuery True query)
131+ }
132+ where
133+ (segments, query) = H.decodePath path
134+
135+setRawPathInfo :: Request -> S8.ByteString -> Request
136+setRawPathInfo r rawPinfo =
137+ let pInfo = dropFrontSlash $ T.split (== '/') $ TE.decodeUtf8 rawPinfo
138+ in r { rawPathInfo = rawPinfo, pathInfo = pInfo }
139+ where
140+ dropFrontSlash ("":"":[]) = [] -- homepage, a single slash
141+ dropFrontSlash ("":path) = path
142+ dropFrontSlash path = path
143+
144+addCookiesToRequest :: Request -> Session Request
145+addCookiesToRequest req = do
146+ oldClientCookies <- getClientCookies
147+ let requestPath = "/" `T.append` T.intercalate "/" (pathInfo req)
148+ currentUTCTime <- liftIO getCurrentTime
149+ let cookiesForRequest =
150+ Map.filter
151+ (\c -> checkCookieTime currentUTCTime c
152+ && checkCookiePath requestPath c)
153+ oldClientCookies
154+ let cookiePairs = [ (Cookie.setCookieName c, Cookie.setCookieValue c)
155+ | c <- map snd $ Map.toList cookiesForRequest
156+ ]
157+ let cookieValue = L8.toStrict . toLazyByteString $ Cookie.renderCookies cookiePairs
158+ addCookieHeader rest
159+ | null cookiePairs = rest
160+ | otherwise = ("Cookie", cookieValue) : rest
161+ return $ req { requestHeaders = addCookieHeader $ requestHeaders req }
162+ where checkCookieTime t c =
163+ case Cookie.setCookieExpires c of
164+ Nothing -> True
165+ Just t' -> t < t'
166+ checkCookiePath p c =
167+ case Cookie.setCookiePath c of
168+ Nothing -> True
169+ Just p' -> p' `S8.isPrefixOf` TE.encodeUtf8 p
170+
171+extractSetCookieFromSResponse :: SResponse -> Session SResponse
172+extractSetCookieFromSResponse response = do
173+ let setCookieHeaders =
174+ filter (("Set-Cookie"==) . fst) $ simpleHeaders response
175+ let newClientCookies = map (Cookie.parseSetCookie . snd) setCookieHeaders
176+ modifyClientCookies
177+ (Map.union
178+ (Map.fromList [(Cookie.setCookieName c, c) | c <- newClientCookies ]))
179+ return response
180+
181+-- | Similar to 'request', but allows setting the request body as a plain
182+-- 'L.ByteString'.
183+srequest :: SRequest -> Session SResponse
184+srequest (SRequest req bod) = do
185+ refChunks <- liftIO $ newIORef $ L.toChunks bod
186+ request $
187+ req
188+ { requestBody = atomicModifyIORef refChunks $ \bss ->
189+ case bss of
190+ [] -> ([], S.empty)
191+ x:y -> (y, x)
192+ }
193+
194+runResponse :: IORef SResponse -> Response -> IO ResponseReceived
195+runResponse ref res = do
196+ refBuilder <- newIORef mempty
197+ let add y = atomicModifyIORef refBuilder $ \x -> (x `mappend` y, ())
198+ withBody $ \body -> body add (return ())
199+ builder <- readIORef refBuilder
200+ let lbs = toLazyByteString builder
201+ len = L.length lbs
202+ -- Force evaluation of the body to have exceptions thrown at the right
203+ -- time.
204+ seq len $ writeIORef ref $ SResponse s h $ toLazyByteString builder
205+ return ResponseReceived
206+ where
207+ (s, h, withBody) = responseToStream res
208+
209+assertBool :: String -> Bool -> Session ()
210+assertBool s b = unless b $ assertFailure s
211+
212+assertString :: String -> Session ()
213+assertString s = unless (null s) $ assertFailure s
214+
215+assertFailure :: String -> Session ()
216+assertFailure msg = msg `deepseq` liftIO (throwIO (WaiTestFailure msg))
217+
218+data WaiTestFailure = WaiTestFailure String
219+ deriving (Show, Eq, Typeable)
220+instance Exception WaiTestFailure
221+
222+assertContentType :: ByteString -> SResponse -> Session ()
223+assertContentType ct SResponse{simpleHeaders = h} =
224+ case lookup "content-type" h of
225+ Nothing -> assertString $ concat
226+ [ "Expected content type "
227+ , show ct
228+ , ", but no content type provided"
229+ ]
230+ Just ct' -> assertBool (concat
231+ [ "Expected content type "
232+ , show ct
233+ , ", but received "
234+ , show ct'
235+ ]) (go ct == go ct')
236+ where
237+ go = S8.takeWhile (/= ';')
238+
239+assertStatus :: Int -> SResponse -> Session ()
240+assertStatus i SResponse{simpleStatus = s} = assertBool (concat
241+ [ "Expected status code "
242+ , show i
243+ , ", but received "
244+ , show sc
245+ ]) $ i == sc
246+ where
247+ sc = H.statusCode s
248+
249+assertBody :: L.ByteString -> SResponse -> Session ()
250+assertBody lbs SResponse{simpleBody = lbs'} = assertBool (concat
251+ [ "Expected response body "
252+ , show $ L8.unpack lbs
253+ , ", but received "
254+ , show $ L8.unpack lbs'
255+ ]) $ lbs == lbs'
256+
257+assertBodyContains :: L.ByteString -> SResponse -> Session ()
258+assertBodyContains lbs SResponse{simpleBody = lbs'} = assertBool (concat
259+ [ "Expected response body to contain "
260+ , show $ L8.unpack lbs
261+ , ", but received "
262+ , show $ L8.unpack lbs'
263+ ]) $ strict lbs `S.isInfixOf` strict lbs'
264+ where
265+ strict = S.concat . L.toChunks
266+
267+assertHeader :: CI ByteString -> ByteString -> SResponse -> Session ()
268+assertHeader header value SResponse{simpleHeaders = h} =
269+ case lookup header h of
270+ Nothing -> assertString $ concat
271+ [ "Expected header "
272+ , show header
273+ , " to be "
274+ , show value
275+ , ", but it was not present"
276+ ]
277+ Just value' -> assertBool (concat
278+ [ "Expected header "
279+ , show header
280+ , " to be "
281+ , show value
282+ , ", but received "
283+ , show value'
284+ ]) (value == value')
285+
286+assertNoHeader :: CI ByteString -> SResponse -> Session ()
287+assertNoHeader header SResponse{simpleHeaders = h} =
288+ case lookup header h of
289+ Nothing -> return ()
290+ Just s -> assertString $ concat
291+ [ "Unexpected header "
292+ , show header
293+ , " containing "
294+ , show s
295+ ]
296+
297+-- |
298+--
299+-- Since 3.0.6
300+assertClientCookieExists :: String -> ByteString -> Session ()
301+assertClientCookieExists s cookieName = do
302+ cookies <- getClientCookies
303+ assertBool s $ Map.member cookieName cookies
304+
305+-- |
306+--
307+-- Since 3.0.6
308+assertNoClientCookieExists :: String -> ByteString -> Session ()
309+assertNoClientCookieExists s cookieName = do
310+ cookies <- getClientCookies
311+ assertBool s $ not $ Map.member cookieName cookies
312+
313+-- |
314+--
315+-- Since 3.0.6
316+assertClientCookieValue :: String -> ByteString -> ByteString -> Session ()
317+assertClientCookieValue s cookieName cookieValue = do
318+ cookies <- getClientCookies
319+ case Map.lookup cookieName cookies of
320+ Nothing ->
321+ assertFailure (s ++ " (cookie does not exist)")
322+ Just c ->
323+ assertBool
324+ (concat
325+ [ s
326+ , " (actual value "
327+ , show $ Cookie.setCookieValue c
328+ , " expected value "
329+ , show cookieValue
330+ , ")"
331+ ]
332+ )
333+ (Cookie.setCookieValue c == cookieValue)
wai-extra/Network/Wai/Test/Internal.hsnew file+35
@@ -0,0 +1,35 @@
1+module Network.Wai.Test.Internal where
2+
3+import Network.Wai
4+import qualified Control.Monad.Trans.State as ST
5+import Control.Monad.Trans.Reader (ReaderT, runReaderT)
6+import Data.Map (Map)
7+import qualified Data.Map as Map
8+import qualified Web.Cookie as Cookie
9+import Data.ByteString (ByteString)
10+
11+type Session = ReaderT Application (ST.StateT ClientState IO)
12+
13+-- |
14+--
15+-- Since 3.0.6
16+type ClientCookies = Map ByteString Cookie.SetCookie
17+
18+data ClientState = ClientState
19+ { clientCookies :: ClientCookies
20+ }
21+
22+-- |
23+--
24+-- Since 3.0.20.0
25+initState :: ClientState
26+initState = ClientState Map.empty
27+
28+-- | Like 'runSession', but if allows you to hand in cookies and get
29+-- the updated cookies back. One use case for this is writing tests
30+-- that address the application under test alternatingly through rest
31+-- api and through db handle.
32+--
33+-- Since 3.0.20.0
34+runSessionWith :: ClientState -> Session a -> Application -> IO (a, ClientState)
35+runSessionWith st session app = ST.runStateT (runReaderT session app) st
wai-extra/Network/Wai/UrlMap.hsnew file+104
@@ -0,0 +1,104 @@
1+{-# LANGUAGE TypeSynonymInstances, FlexibleInstances #-}
2+{-# LANGUAGE ExistentialQuantification #-}
3+{- | This module gives you a way to mount applications under sub-URIs.
4+For example:
5+
6+> bugsApp, helpdeskApp, apiV1, apiV2, mainApp :: Application
7+>
8+> myApp :: Application
9+> myApp = mapUrls $
10+> mount "bugs" bugsApp
11+> <|> mount "helpdesk" helpdeskApp
12+> <|> mount "api"
13+> ( mount "v1" apiV1
14+> <|> mount "v2" apiV2
15+> )
16+> <|> mountRoot mainApp
17+
18+-}
19+module Network.Wai.UrlMap (
20+ UrlMap',
21+ UrlMap,
22+ mount',
23+ mount,
24+ mountRoot,
25+ mapUrls
26+) where
27+
28+import Control.Applicative
29+import Data.List
30+import Data.Text (Text)
31+import qualified Data.Text as T
32+import qualified Data.Text.Encoding as T
33+import qualified Data.ByteString as B
34+import Network.HTTP.Types
35+import Network.Wai
36+
37+type Path = [Text]
38+newtype UrlMap' a = UrlMap' { unUrlMap :: [(Path, a)] }
39+
40+instance Functor UrlMap' where
41+ fmap f (UrlMap' xs) = UrlMap' (fmap (\(p, a) -> (p, f a)) xs)
42+
43+instance Applicative UrlMap' where
44+ pure x = UrlMap' [([], x)]
45+ (UrlMap' xs) <*> (UrlMap' ys) = UrlMap' [ (p, f y) |
46+ (p, y) <- ys,
47+ f <- map snd xs ]
48+
49+instance Alternative UrlMap' where
50+ empty = UrlMap' empty
51+ (UrlMap' xs) <|> (UrlMap' ys) = UrlMap' (xs <|> ys)
52+
53+type UrlMap = UrlMap' Application
54+
55+-- | Mount an application under a given path. The ToApplication typeclass gives
56+-- you the option to pass either an 'Network.Wai.Application' or an 'UrlMap'
57+-- as the second argument.
58+mount' :: ToApplication a => Path -> a -> UrlMap
59+mount' prefix thing = UrlMap' [(prefix, toApplication thing)]
60+
61+-- | A convenience function like mount', but for mounting things under a single
62+-- path segment.
63+mount :: ToApplication a => Text -> a -> UrlMap
64+mount prefix thing = mount' [prefix] thing
65+
66+-- | Mount something at the root. Use this for the last application in the
67+-- block, to avoid 500 errors from none of the applications matching.
68+mountRoot :: ToApplication a => a -> UrlMap
69+mountRoot = mount' []
70+
71+try :: Eq a
72+ => [a] -- ^ Path info of request
73+ -> [([a], b)] -- ^ List of applications to match
74+ -> Maybe ([a], b)
75+try xs tuples = foldl go Nothing tuples
76+ where
77+ go (Just x) _ = Just x
78+ go _ (prefix, y) = stripPrefix prefix xs >>= \xs' -> return (xs', y)
79+
80+class ToApplication a where
81+ toApplication :: a -> Application
82+
83+instance ToApplication Application where
84+ toApplication = id
85+
86+instance ToApplication UrlMap where
87+ toApplication urlMap req sendResponse =
88+ case try (pathInfo req) (unUrlMap urlMap) of
89+ Just (newPath, app) ->
90+ app (req { pathInfo = newPath
91+ , rawPathInfo = makeRaw newPath
92+ }) sendResponse
93+ Nothing ->
94+ sendResponse $ responseLBS
95+ status404
96+ [(hContentType, "text/plain")]
97+ "Not found\n"
98+
99+ where
100+ makeRaw :: [Text] -> B.ByteString
101+ makeRaw = ("/" `B.append`) . T.encodeUtf8 . T.intercalate "/"
102+
103+mapUrls :: UrlMap -> Application
104+mapUrls = toApplication
wai-extra/README.mdnew file+16
@@ -0,0 +1,16 @@
1+# wai-extra
2+
3+The goal here is to provide common features without many dependencies.
4+
5+
6+## Example using Server-Sent Events ##
7+
8+There is a small example using Server-Sent Events (SSE) in the
9+`./example` directory.
10+
11+Run the commands below to start the server on http://localhost:8080
12+
13+```
14+$ stack build .
15+$ stack exec example
16+```
wai-extra/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
wai-extra/example/Main.hsnew file+62
@@ -0,0 +1,62 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Main where
3+
4+import Data.ByteString.Builder (string8)
5+import Control.Concurrent (forkIO, threadDelay)
6+import Control.Concurrent.Chan
7+import Control.Monad
8+import Data.Time.Clock.POSIX (getPOSIXTime)
9+import Network.HTTP.Types (status200)
10+import Network.Wai (Application, Middleware, pathInfo, responseFile)
11+import Network.Wai.EventSource (ServerEvent(..), eventSourceAppChan, eventSourceAppIO)
12+import Network.Wai.Handler.Warp (run)
13+import Network.Wai.Middleware.AddHeaders (addHeaders)
14+import Network.Wai.Middleware.Gzip (gzip, def)
15+
16+
17+app :: Chan ServerEvent -> Application
18+app chan req respond =
19+ case pathInfo req of
20+ [] -> respond $ responseFile status200 [("Content-Type", "text/html")] "example/index.html" Nothing
21+ ["esold"] -> eventSourceAppChan chan req respond
22+ ["eschan"] -> eventSourceAppChan chan req respond
23+ ["esio"] -> eventSourceAppIO eventIO req respond
24+ _ -> error "unexpected pathInfo"
25+
26+eventChan :: Chan ServerEvent -> IO ()
27+eventChan chan = forever $ do
28+ threadDelay 1000000
29+ time <- getPOSIXTime
30+ writeChan chan (ServerEvent Nothing Nothing [string8 . show $ time])
31+
32+eventIO :: IO ServerEvent
33+eventIO = do
34+ threadDelay 1000000
35+ time <- getPOSIXTime
36+ return $ ServerEvent (Just $ string8 "io")
37+ Nothing
38+ [string8 . show $ time]
39+
40+eventRaw :: (ServerEvent -> IO ()) -> IO () -> IO ()
41+eventRaw = handle 0
42+ where
43+ handle counter emit flush = do
44+ threadDelay 1000000
45+ _ <- emit $ ServerEvent (Just $ string8 "raw")
46+ Nothing
47+ [string8 . show $ counter]
48+ _ <- flush
49+ handle (counter + 1) emit flush
50+
51+main :: IO ()
52+main = do
53+ chan <- newChan
54+ _ <- forkIO . eventChan $ chan
55+ run 8080 (gzip def $ headers $ app chan)
56+ where
57+ -- headers required for SSE to work through nginx
58+ -- not required if using warp directly
59+ headers :: Middleware
60+ headers = addHeaders [ ("X-Accel-Buffering", "no")
61+ , ("Cache-Control", "no-cache")
62+ ]
wai-extra/example/index.htmlnew file+20
@@ -0,0 +1,20 @@
1+<!doctype html>
2+<head>
3+ <title>Example</title>
4+ <link rel="icon" href="data:;base64,=">
5+</head>
6+<h1>Testing Server-Sent Events</h1>
7+
8+<div id="output"></div>
9+
10+<script>
11+ var output = document.getElementById("output");
12+
13+ var src = new EventSource("/eschan");
14+
15+ src.onmessage = function(msg) {
16+ var p = document.createElement("p");
17+ p.appendChild(document.createTextNode(msg.data));
18+ output.appendChild(p);
19+ }
20+</script>
proxy.hs → wai-extra/proxy.hsrenamed

The content is the same.

wai-extra/test/Network/Wai/Middleware/ApprootSpec.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.ApprootSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.Approot
10+import Network.Wai.Test
11+import Network.Wai
12+import Network.HTTP.Types
13+import Data.ByteString (ByteString)
14+
15+main :: IO ()
16+main = hspec spec
17+
18+spec :: Spec
19+spec = do
20+ let test name host secure headers expected = it name $ do
21+ resp <- runApp host secure headers
22+ simpleHeaders resp `shouldBe` [("Approot", expected)]
23+ test "respects host header" "foobar" False [] "http://foobar"
24+ test "respects isSecure" "foobar" True [] "https://foobar"
25+ test "respects SSL headers" "foobar" False
26+ [("HTTP_X_FORWARDED_SSL", "on")] "https://foobar"
27+
28+runApp :: ByteString -> Bool -> RequestHeaders -> IO SResponse
29+runApp host secure headers = runSession
30+ (request defaultRequest
31+ { requestHeaderHost = Just host
32+ , isSecure = secure
33+ , requestHeaders = headers
34+ }) $ fromRequest app
35+
36+ where
37+ app req respond = respond $ responseLBS status200 [("Approot", getApproot req)] ""
wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.ForceSSLSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.ForceSSL
10+
11+import Control.Monad
12+import Data.ByteString (ByteString)
13+import Data.Monoid ((<>))
14+import Network.HTTP.Types (methodPost, status200, status301, status307)
15+import Network.Wai
16+import Network.Wai.Test
17+
18+main :: IO ()
19+main = hspec spec
20+
21+spec :: Spec
22+spec = describe "forceSSL" (forM_ hosts $ \host -> hostSpec host)
23+ where
24+ hosts = ["example.com", "example.com:80", "example.com:8080"]
25+
26+hostSpec :: ByteString -> Spec
27+hostSpec host = describe ("forceSSL on host " <> show host <> "") $ do
28+
29+ it "redirects non-https requests to https" $ do
30+ resp <- runApp host forceSSL defaultRequest
31+
32+ simpleStatus resp `shouldBe` status301
33+ simpleHeaders resp `shouldBe` [("Location", "https://" <> host)]
34+
35+ it "redirects with 307 in the case of a non-GET request" $ do
36+ resp <- runApp host forceSSL defaultRequest
37+ { requestMethod = methodPost }
38+
39+ simpleStatus resp `shouldBe` status307
40+ simpleHeaders resp `shouldBe` [("Location", "https://" <> host)]
41+
42+ it "does not redirect already-secure requests" $ do
43+ resp <- runApp host forceSSL defaultRequest { isSecure = True }
44+
45+ simpleStatus resp `shouldBe` status200
46+
47+ it "preserves the original host, path, and query string" $ do
48+ resp <- runApp host forceSSL defaultRequest
49+ { rawPathInfo = "/foo/bar"
50+ , rawQueryString = "?baz=bat"
51+ }
52+
53+ simpleHeaders resp `shouldBe`
54+ [("Location", "https://" <> host <> "/foo/bar?baz=bat")]
55+
56+runApp :: ByteString -> Middleware -> Request -> IO SResponse
57+runApp host mw req = runSession
58+ (request req { requestHeaderHost = Just host }) $ mw app
59+ where
60+ app _ respond = respond $ responseLBS status200 [] ""
wai-extra/test/Network/Wai/Middleware/RoutedSpec.hsnew file+53
@@ -0,0 +1,53 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.RoutedSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.Routed
10+import Network.Wai.Middleware.ForceSSL (forceSSL)
11+
12+import Network.HTTP.Types (hContentType, status200)
13+import Network.Wai
14+import Network.Wai.Test
15+import Data.ByteString (ByteString)
16+import Data.String (IsString)
17+
18+main :: IO ()
19+main = hspec spec
20+
21+spec :: Spec
22+spec = describe "forceSSL" $ do
23+ it "routed middleware" $ do
24+ let destination = "https://example.com/d/"
25+ let routedSslJsonApp prefix = routedMiddleware (checkPrefix prefix) forceSSL jsonApp
26+ checkPrefix p (p1:_) = p == p1
27+ checkPrefix _ _ = False
28+
29+ flip runSession (routedSslJsonApp "r") $ do
30+ res <- testDPath "http"
31+ assertNoHeader location res
32+ assertStatus 200 res
33+ assertBody "{\"foo\":\"bar\"}" res
34+
35+ flip runSession (routedSslJsonApp "d") $ do
36+ res2 <- testDPath "http"
37+ assertHeader location destination res2
38+ assertStatus 301 res2
39+
40+jsonApp :: Application
41+jsonApp _req cps = cps $ responseLBS status200
42+ [(hContentType, "application/json")]
43+ "{\"foo\":\"bar\"}"
44+
45+testDPath :: ByteString -> Session SResponse
46+testDPath proto =
47+ request $ flip setRawPathInfo "/d/" defaultRequest
48+ { requestHeaders = [("X-Forwarded-Proto", proto)]
49+ , requestHeaderHost = Just "example.com"
50+ }
51+
52+location :: IsString ci => ci
53+location = "Location"
wai-extra/test/Network/Wai/Middleware/StripHeadersSpec.hsnew file+58
@@ -0,0 +1,58 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.StripHeadersSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.AddHeaders
10+import Network.Wai.Middleware.StripHeaders
11+
12+import Control.Arrow (first)
13+import Data.ByteString (ByteString)
14+import Data.Monoid ((<>))
15+import Network.HTTP.Types (status200)
16+import Network.Wai
17+import Network.Wai.Test
18+
19+import qualified Data.CaseInsensitive as CI
20+
21+
22+main :: IO ()
23+main = hspec spec
24+
25+
26+spec :: Spec
27+spec = describe "stripHeader" $ do
28+ let host = "example.com"
29+ let ciTestHeaders = map (first CI.mk) testHeaders
30+
31+ it "strips a specific header" $ do
32+ resp1 <- runApp host (addHeaders testHeaders) defaultRequest
33+ resp2 <- runApp host (stripHeaderIf "Foo" (const False) . addHeaders testHeaders) defaultRequest
34+ resp3 <- runApp host (stripHeaderIf "Foo" (const True) . addHeaders testHeaders) defaultRequest
35+
36+ simpleHeaders resp1 `shouldBe` ciTestHeaders
37+ simpleHeaders resp2 `shouldBe` ciTestHeaders
38+ simpleHeaders resp3 `shouldBe` tail ciTestHeaders
39+
40+ it "strips specific set of headers" $ do
41+ resp1 <- runApp host (addHeaders testHeaders) defaultRequest
42+ resp2 <- runApp host (stripHeadersIf ["Bar", "Foo"] (const False) . addHeaders testHeaders) defaultRequest
43+ resp3 <- runApp host (stripHeadersIf ["Bar", "Foo"] (const True) . addHeaders testHeaders) defaultRequest
44+
45+ simpleHeaders resp1 `shouldBe` ciTestHeaders
46+ simpleHeaders resp2 `shouldBe` ciTestHeaders
47+ simpleHeaders resp3 `shouldBe` [last ciTestHeaders]
48+
49+
50+testHeaders :: [(ByteString, ByteString)]
51+testHeaders = [("Foo", "fooey"), ("Bar", "barbican"), ("Baz", "bazooka")]
52+
53+
54+runApp :: ByteString -> Middleware -> Request -> IO SResponse
55+runApp host mw req = runSession
56+ (request req { requestHeaderHost = Just $ host <> ":80" }) $ mw app
57+ where
58+ app _ respond = respond $ responseLBS status200 [] ""
wai-extra/test/Network/Wai/Middleware/TimeoutSpec.hsnew file+57
@@ -0,0 +1,57 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module Network.Wai.Middleware.TimeoutSpec
4+ ( spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Control.Concurrent (threadDelay)
10+import Network.HTTP.Types (status200, status503, status504)
11+import Network.Wai
12+import Network.Wai.Middleware.Timeout
13+import Network.Wai.Test
14+
15+spec :: Spec
16+spec = do
17+ describe "timeout" $ do
18+ it "times out slow requests with 503" $ do
19+ let app _req respond = do
20+ threadDelay $ 2 * 1000000
21+ respond $ responseLBS status200 [] ""
22+
23+ resp <- runApp $ timeout 1 app
24+
25+ simpleStatus resp `shouldBe` status503
26+
27+ it "does not time out fast requests" $ do
28+ let app _req respond = respond $ responseLBS status200 [] ""
29+
30+ resp <- runApp $ timeout 3 app
31+
32+ simpleStatus resp `shouldBe` status200
33+
34+ describe "timeoutStatus" $ do
35+ it "allows customizing the timeout response status" $ do
36+ let app _req respond = do
37+ threadDelay $ 2 * 1000000
38+ respond $ responseLBS status200 [] ""
39+
40+ resp <- runApp $ timeoutStatus status504 1 app
41+
42+ simpleStatus resp `shouldBe` status504
43+
44+ describe "timeoutAs" $ do
45+ it "allows customizing the timeout response" $ do
46+ let app _req respond = do
47+ threadDelay $ 2 * 1000000
48+ respond $ responseLBS status200 [] ""
49+ timeoutResponse = responseLBS status503 [("X-Timeout", "1")] ""
50+
51+ resp <- runApp $ timeoutAs timeoutResponse 1 app
52+
53+ simpleStatus resp `shouldBe` status503
54+ simpleHeaders resp `shouldBe` [("X-Timeout", "1")]
55+
56+runApp :: Application -> IO SResponse
57+runApp = runSession $ request defaultRequest
wai-extra/test/Network/Wai/ParseSpec.hsnew file+294
@@ -0,0 +1,294 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.ParseSpec (main, spec) where
3+
4+import Test.Hspec
5+import Test.HUnit
6+
7+import System.IO
8+import Data.Monoid
9+import qualified Data.IORef as I
10+import qualified Data.ByteString as S
11+import qualified Data.ByteString.Char8 as S8
12+import qualified Data.ByteString.Lazy as L
13+import qualified Data.Text as TS
14+import qualified Data.Text.Encoding as TE
15+import Control.Monad.Trans.Resource (withInternalState, runResourceT)
16+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
17+
18+import Network.Wai
19+import Network.Wai.Test
20+import Network.Wai.Parse
21+import WaiExtraSpec (toRequest)
22+
23+main :: IO ()
24+main = hspec spec
25+
26+spec :: Spec
27+spec = do
28+ describe "parseContentType" $ do
29+ let go (x, y, z) = it (TS.unpack $ TE.decodeUtf8 x) $ parseContentType x `shouldBe` (y, z)
30+ mapM_ go
31+ [ ("text/plain", "text/plain", [])
32+ , ("text/plain; charset=UTF-8 ", "text/plain", [("charset", "UTF-8")])
33+ , ("text/plain; charset=UTF-8 ; boundary = foo", "text/plain", [("charset", "UTF-8"), ("boundary", "foo")])
34+ , ("text/plain; charset=UTF-8 ; boundary = \"quoted\"", "text/plain", [("charset", "UTF-8"), ("boundary", "quoted")])
35+ ]
36+ it "parseHttpAccept" caseParseHttpAccept
37+ describe "parseRequestBody" $ do
38+ caseParseRequestBody
39+ it "multipart with plus" caseMultipartPlus
40+ it "multipart with multiple attributes" caseMultipartAttrs
41+ it "urlencoded with plus" caseUrlEncPlus
42+ describe "dalvik multipart" $ do
43+ it "non-chunked" $ dalvikHelper True
44+ it "chunked" $ dalvikHelper False
45+
46+caseParseHttpAccept :: Assertion
47+caseParseHttpAccept = do
48+ let input = "text/plain; q=0.5, text/html;charset=utf-8, text/*;q=0.8;ext=blah, text/x-dvi; q=0.8, text/x-c"
49+ expected = ["text/html;charset=utf-8", "text/x-c", "text/x-dvi", "text/*", "text/plain"]
50+ expected @=? parseHttpAccept input
51+
52+parseRequestBody' :: BackEnd file
53+ -> SRequest
54+ -> IO ([(S.ByteString, S.ByteString)], [(S.ByteString, FileInfo file)])
55+parseRequestBody' sink (SRequest req bod) =
56+ case getRequestBodyType req of
57+ Nothing -> return ([], [])
58+ Just rbt -> do
59+ ref <- I.newIORef $ L.toChunks bod
60+ let rb = I.atomicModifyIORef ref $ \chunks ->
61+ case chunks of
62+ [] -> ([], S.empty)
63+ x:y -> (y, x)
64+ sinkRequestBody sink rbt rb
65+
66+caseParseRequestBody :: Spec
67+caseParseRequestBody = do
68+ it "parsing post x-www-form-urlencoded" $ do
69+ let content1 = "foo=bar&baz=bin"
70+ let ctype1 = "application/x-www-form-urlencoded"
71+ result1 <- parseRequestBody' lbsBackEnd $ toRequest ctype1 content1
72+ result1 `shouldBe` ([("foo", "bar"), ("baz", "bin")], [])
73+
74+ let ctype2 = "multipart/form-data; boundary=AaB03x"
75+ let expectedsmap2 =
76+ [ ("title", "A File")
77+ , ("summary", "This is my file\nfile test")
78+ ]
79+ let textPlain = "text/plain; charset=iso-8859-1"
80+ let expectedfile2 =
81+ [("document", FileInfo "b.txt" textPlain "This is a file.\nIt has two lines.")]
82+ let expected2 = (expectedsmap2, expectedfile2)
83+
84+ it "parsing post multipart/form-data" $ do
85+ result2 <- parseRequestBody' lbsBackEnd $ toRequest ctype2 content2
86+ result2 `shouldBe` expected2
87+
88+ it "parsing post multipart/form-data 2" $ do
89+ result2' <- parseRequestBody' lbsBackEnd $ toRequest' ctype2 content2
90+ result2' `shouldBe` expected2
91+
92+
93+ let ctype3 = "multipart/form-data; boundary=----WebKitFormBoundaryB1pWXPZ6lNr8RiLh"
94+ let expectedsmap3 = []
95+ let expectedfile3 = [("yaml", FileInfo "README" "application/octet-stream" "Photo blog using Hack.\n")]
96+ let expected3 = (expectedsmap3, expectedfile3)
97+
98+ let unknownErrorException c (ConnectionError (UnknownErrorCode code) _) = c == code
99+ unknownErrorException _ _ = False
100+
101+
102+ let def = defaultParseRequestBodyOptions
103+ it "parsing actual post multipart/form-data" $ do
104+ result3 <- parseRequestBody' lbsBackEnd $ toRequest ctype3 content3
105+ result3 `shouldBe` expected3
106+
107+ it "parsing actual post multipart/form-data 2" $ do
108+ result3' <- parseRequestBody' lbsBackEnd $ toRequest' ctype3 content3
109+ result3' `shouldBe` expected3
110+
111+ it "parsing with memory limit" $ do
112+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
113+ result4' <- parseRequestBodyEx ( setMaxRequestNumFiles 1 $ setMaxRequestKeyLength 14 def ) lbsBackEnd req4
114+ result4' `shouldBe` expected3
115+
116+ it "exceeding number of files" $ do
117+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
118+ (parseRequestBodyEx ( setMaxRequestNumFiles 0 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
119+
120+ it "exceeding parameter length" $ do
121+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
122+ (parseRequestBodyEx ( setMaxRequestKeyLength 2 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
123+
124+ it "exceeding file size" $ do
125+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
126+ (parseRequestBodyEx ( setMaxRequestFileSize 2 def ) lbsBackEnd req4)
127+ `shouldThrow` unknownErrorException 413
128+
129+ it "exceeding total file size" $ do
130+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
131+ (parseRequestBodyEx ( setMaxRequestFilesSize 20 def ) lbsBackEnd req4)
132+ `shouldThrow` unknownErrorException 413
133+ SRequest req5 _bod5 <- toRequest'' ctype3 content5
134+ (parseRequestBodyEx ( setMaxRequestFilesSize 20 def ) lbsBackEnd req5)
135+ `shouldThrow` unknownErrorException 413
136+
137+ it "exceeding max parm value size" $ do
138+ SRequest req4 _bod4 <- toRequest'' ctype2 content2
139+ (parseRequestBodyEx ( setMaxRequestParmsSize 10 def ) lbsBackEnd req4)
140+ `shouldThrow` unknownErrorException 413
141+
142+ it "exceeding max header lines" $ do
143+ SRequest req4 _bod4 <- toRequest'' ctype2 content2
144+ (parseRequestBodyEx ( setMaxHeaderLines 1 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
145+
146+ it "exceeding header line size" $ do
147+ SRequest req4 _bod4 <- toRequest'' ctype3 content4
148+ (parseRequestBodyEx ( setMaxHeaderLineLength 8190 def ) lbsBackEnd req4)
149+ `shouldThrow` unknownErrorException 431
150+
151+ it "Testing parseRequestBodyEx with application/x-www-form-urlencoded" $ do
152+ let content = "thisisalongparameterkey=andthisbeanevenlongerparametervaluehelloworldhowareyou"
153+ let ctype = "application/x-www-form-urlencoded"
154+ SRequest req _bod <- toRequest'' ctype content
155+ result <- parseRequestBodyEx def lbsBackEnd req
156+ result `shouldBe` ([( "thisisalongparameterkey"
157+ , "andthisbeanevenlongerparametervaluehelloworldhowareyou" )], [])
158+
159+ it "exceeding max parm value size with x-www-form-urlencoded mimetype" $ do
160+ let content = "thisisalongparameterkey=andthisbeanevenlongerparametervaluehelloworldhowareyou"
161+ let ctype = "application/x-www-form-urlencoded"
162+ SRequest req _bod <- toRequest'' ctype content
163+ (parseRequestBodyEx ( setMaxRequestParmsSize 10 def ) lbsBackEnd req) `shouldThrow` anyErrorCall
164+
165+ where
166+ content2 =
167+ "--AaB03x\n"
168+ <> "Content-Disposition: form-data; name=\"document\"; filename=\"b.txt\"\n"
169+ <> "Content-Type: text/plain; charset=iso-8859-1\n\n"
170+ <> "This is a file.\n"
171+ <> "It has two lines.\n"
172+ <> "--AaB03x\n"
173+ <> "Content-Disposition: form-data; name=\"title\"\n"
174+ <> "Content-Type: text/plain; charset=iso-8859-1\n\n"
175+ <> "A File\n"
176+ <> "--AaB03x\n"
177+ <> "Content-Disposition: form-data; name=\"summary\"\n"
178+ <> "Content-Type: text/plain; charset=iso-8859-1\n\n"
179+ <> "This is my file\n"
180+ <> "file test\n"
181+ <> "--AaB03x--"
182+ content3 =
183+ "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
184+ <> "Content-Disposition: form-data; name=\"yaml\"; filename=\"README\"\r\n"
185+ <> "Content-Type: application/octet-stream\r\n\r\n"
186+ <> "Photo blog using Hack.\n\r\n"
187+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
188+ content4 =
189+ "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
190+ <> "Content-Disposition: form-data; name=\"alb\"; filename=\"README\"\r\n"
191+ <> "Content-Type: application/octet-stream\r\n\r\n"
192+ <> "Photo blog using Hack.\r\n\r\n"
193+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
194+ <> "Content-Disposition: form-data; name=\"bla\"; filename=\"riedmi"
195+ <> S8.replicate 8190 'e' <> "\"\r\n"
196+ <> "Content-Type: application/octet-stream\r\n\r\n"
197+ <> "Photo blog using Hack.\r\n\r\n"
198+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
199+ content5 =
200+ "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
201+ <> "Content-Disposition: form-data; name=\"yaml\"; filename=\"README\"\r\n"
202+ <> "Content-Type: application/octet-stream\r\n\r\n"
203+ <> "Photo blog using Hack.\n\r\n"
204+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
205+ <> "Content-Disposition: form-data; name=\"yaml2\"; filename=\"MEADRE\"\r\n"
206+ <> "Content-Type: application/octet-stream\r\n\r\n"
207+ <> "Photo blog using Hack.\n\r\n"
208+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
209+
210+caseMultipartPlus :: Assertion
211+caseMultipartPlus = do
212+ result <- parseRequestBody' lbsBackEnd $ toRequest ctype content
213+ result @?= ([("email", "has+plus")], [])
214+ where
215+ content =
216+ "--AaB03x\n" <>
217+ "Content-Disposition: form-data; name=\"email\"\n" <>
218+ "Content-Type: text/plain; charset=iso-8859-1\n\n" <>
219+ "has+plus\n" <>
220+ "--AaB03x--"
221+ ctype = "multipart/form-data; boundary=AaB03x"
222+
223+caseMultipartAttrs :: Assertion
224+caseMultipartAttrs = do
225+ result <- parseRequestBody' lbsBackEnd $ toRequest ctype content
226+ result @?= ([("email", "has+plus")], [])
227+ where
228+ content =
229+ "--AaB03x\n" <>
230+ "Content-Disposition: form-data; name=\"email\"\n" <>
231+ "Content-Type: text/plain; charset=iso-8859-1\n\n" <>
232+ "has+plus\n" <>
233+ "--AaB03x--"
234+ ctype = "multipart/form-data; charset=UTF-8; boundary=AaB03x"
235+
236+caseUrlEncPlus :: Assertion
237+caseUrlEncPlus = do
238+ result <- runResourceT $ withInternalState $ \state ->
239+ parseRequestBody' (tempFileBackEnd state) $ toRequest ctype content
240+ result @?= ([("email", "has+plus")], [])
241+ where
242+ content = "email=has%2Bplus"
243+ ctype = "application/x-www-form-urlencoded"
244+
245+dalvikHelper :: Bool -> Assertion
246+dalvikHelper includeLength = do
247+ let headers' =
248+ [ ("content-type", "multipart/form-data;boundary=*****")
249+ , ("GATEWAY_INTERFACE", "CGI/1.1")
250+ , ("PATH_INFO", "/")
251+ , ("QUERY_STRING", "")
252+ , ("REMOTE_ADDR", "192.168.1.115")
253+ , ("REMOTE_HOST", "ganjizza")
254+ , ("REQUEST_URI", "http://192.168.1.115:3000/")
255+ , ("REQUEST_METHOD", "POST")
256+ , ("HTTP_CONNECTION", "Keep-Alive")
257+ , ("HTTP_COOKIE", "_SESSION=fgUGM5J/k6mGAAW+MMXIJZCJHobw/oEbb6T17KQN0p9yNqiXn/m/ACrsnRjiCEgqtG4fogMUDI+jikoFGcwmPjvuD5d+MDz32iXvDdDJsFdsFMfivuey2H+n6IF6yFGD")
258+ , ("HTTP_USER_AGENT", "Dalvik/1.1.0 (Linux; U; Android 2.1-update1; sdk Build/ECLAIR)")
259+ , ("HTTP_HOST", "192.168.1.115:3000")
260+ , ("HTTP_ACCEPT", "*, */*")
261+ , ("HTTP_VERSION", "HTTP/1.1")
262+ , ("REQUEST_PATH", "/")
263+ ]
264+ headers
265+ | includeLength = ("content-length", "12098") : headers'
266+ | otherwise = headers'
267+ let request' = defaultRequest
268+ { requestHeaders = headers
269+ }
270+ (params, files) <-
271+ case getRequestBodyType request' of
272+ Nothing -> return ([], [])
273+ Just rbt -> withFile "test/requests/dalvik-request" ReadMode $ \h ->
274+ sinkRequestBody lbsBackEnd rbt $ S.hGetSome h 2048
275+ lookup "scannedTime" params @?= Just "1.298590056748E9"
276+ lookup "geoLong" params @?= Just "0"
277+ lookup "geoLat" params @?= Just "0"
278+ length files @?= 1
279+
280+toRequest' :: S8.ByteString -> S8.ByteString -> SRequest
281+toRequest' ctype content = SRequest defaultRequest
282+ { requestHeaders = [("Content-Type", ctype)]
283+ } (L.fromChunks $ map S.singleton $ S.unpack content)
284+
285+toRequest'' :: S8.ByteString -> S8.ByteString -> IO SRequest
286+toRequest'' ctype content = mkRB content >>= \b -> return $ SRequest defaultRequest
287+ { requestHeaders = [("Content-Type", ctype)], requestBody = b
288+ } (L.fromChunks $ map S.singleton $ S.unpack content)
289+
290+mkRB :: S8.ByteString -> IO (IO S8.ByteString)
291+mkRB content = do
292+ r <- I.newIORef content
293+ return $
294+ I.atomicModifyIORef r $ \a -> (S8.empty, a)
wai-extra/test/Network/Wai/RequestSpec.hsnew file+93
@@ -0,0 +1,93 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.RequestSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Data.ByteString (ByteString)
10+import Network.HTTP.Types (HeaderName)
11+import Network.Wai (Request(..), defaultRequest, RequestBodyLength(..))
12+
13+import Network.Wai.Request
14+import Control.Exception (try)
15+import Control.Monad (forever)
16+
17+main :: IO ()
18+main = hspec spec
19+
20+spec :: Spec
21+spec = do
22+ describe "requestSizeCheck" $ do
23+ it "too large content length should throw RequestSizeException" $ do
24+ let limit = 1024
25+ largeRequest = defaultRequest
26+ { isSecure = False
27+ , requestBodyLength = KnownLength (limit + 1)
28+ , requestBody = return "repeat this chunk"
29+ }
30+ checkedRequest <- requestSizeCheck limit largeRequest
31+ body <- try (requestBody checkedRequest)
32+ case body of
33+ Left (RequestSizeException l) -> l `shouldBe` limit
34+ Right _ -> expectationFailure "request size check failed"
35+
36+ it "too many chunks should throw RequestSizeException" $ do
37+ let limit = 1024
38+ largeRequest = defaultRequest
39+ { isSecure = False
40+ , requestBodyLength = ChunkedBody
41+ , requestBody = return "repeat this chunk"
42+ }
43+ checkedRequest <- requestSizeCheck limit largeRequest
44+ body <- try (forever $ requestBody checkedRequest)
45+ case body of
46+ Left (RequestSizeException l) -> l `shouldBe` limit
47+ Right _ -> expectationFailure "request size check failed"
48+
49+ describe "appearsSecure" $ do
50+ let insecureRequest = defaultRequest
51+ { isSecure = False
52+ , requestHeaders =
53+ [ ("HTTPS", "off")
54+ , ("HTTP_X_FORWARDED_SSL", "off")
55+ , ("HTTP_X_FORWARDED_SCHEME", "http")
56+ , ("HTTP_X_FORWARDED_PROTO", "http,xyz")
57+ ]
58+ }
59+
60+ it "returns False for an insecure request" $
61+ insecureRequest `shouldSatisfy` not . appearsSecure
62+
63+ it "checks if the Request is actually secure" $ do
64+ let req = insecureRequest { isSecure = True }
65+
66+ req `shouldSatisfy` appearsSecure
67+
68+ it "checks for HTTP: on" $ do
69+ let req = addHeader "HTTPS" "on" insecureRequest
70+
71+ req `shouldSatisfy` appearsSecure
72+
73+ it "checks for HTTP_X_FORWARDED_SSL: on" $ do
74+ let req = addHeader "HTTP_X_FORWARDED_SSL" "on" insecureRequest
75+
76+ req `shouldSatisfy` appearsSecure
77+
78+ it "checks for HTTP_X_FORWARDED_SCHEME: https" $ do
79+ let req = addHeader "HTTP_X_FORWARDED_SCHEME" "https" insecureRequest
80+
81+ req `shouldSatisfy` appearsSecure
82+
83+ it "checks for HTTP_X_FORWARDED_PROTO: https,..." $ do
84+ let req = addHeader "HTTP_X_FORWARDED_PROTO" "https,xyz" insecureRequest
85+
86+ req `shouldSatisfy` appearsSecure
87+
88+addHeader :: HeaderName -> ByteString -> Request -> Request
89+addHeader name value req = req
90+ { requestHeaders = (name, value) : otherHeaders }
91+
92+ where
93+ otherHeaders = filter ((/= name) . fst) $ requestHeaders req
wai-extra/test/Network/Wai/TestSpec.hsnew file+227
@@ -0,0 +1,227 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.TestSpec (main, spec) where
3+
4+import Control.Monad (void)
5+
6+import qualified Data.IORef as IORef
7+
8+import qualified Data.Text.Encoding as TE
9+
10+import Data.Time.Calendar (fromGregorian)
11+import Data.Time.Clock (UTCTime(..))
12+
13+import Test.Hspec
14+
15+import Network.Wai
16+import Network.Wai.Test
17+
18+import Network.HTTP.Types (status200)
19+
20+import qualified Data.ByteString.Lazy.Char8 as L8
21+import Data.ByteString.Builder (Builder, toLazyByteString)
22+import Data.ByteString (ByteString)
23+
24+import qualified Web.Cookie as Cookie
25+
26+main :: IO ()
27+main = hspec spec
28+
29+toByteString :: Builder -> ByteString
30+toByteString = L8.toStrict . toLazyByteString
31+
32+spec :: Spec
33+spec = do
34+ describe "setPath" $ do
35+
36+ let req = setPath defaultRequest "/foo/bar/baz?foo=23&bar=42&baz"
37+
38+ it "sets pathInfo" $ do
39+ pathInfo req `shouldBe` ["foo", "bar", "baz"]
40+
41+ it "utf8 path" $
42+ pathInfo (setPath defaultRequest "/foo/%D7%A9%D7%9C%D7%95%D7%9D/bar") `shouldBe`
43+ ["foo", "שלום", "bar"]
44+
45+ it "sets rawPathInfo" $ do
46+ rawPathInfo req `shouldBe` "/foo/bar/baz"
47+
48+ it "sets queryString" $ do
49+ queryString req `shouldBe` [("foo", Just "23"), ("bar", Just "42"), ("baz", Nothing)]
50+
51+ it "sets rawQueryString" $ do
52+ rawQueryString req `shouldBe` "?foo=23&bar=42&baz"
53+
54+ context "when path has no query string" $ do
55+ it "sets rawQueryString to empty string" $ do
56+ rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
57+
58+ describe "srequest" $ do
59+
60+ let echoApp req respond = do
61+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
62+ let reqHeaders = requestHeaders req
63+ respond $
64+ responseLBS
65+ status200
66+ reqHeaders
67+ reqBody
68+
69+ it "returns the response body of an echo app" $ do
70+ sresp <- flip runSession echoApp $
71+ srequest $ SRequest defaultRequest "request body"
72+ simpleBody sresp `shouldBe` "request body"
73+
74+ describe "request" $ do
75+
76+ let echoApp req respond = do
77+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
78+ let reqHeaders = requestHeaders req
79+ respond $
80+ responseLBS
81+ status200
82+ reqHeaders
83+ reqBody
84+
85+ it "returns the status code of an echo app on default request" $ do
86+ sresp <- runSession (request defaultRequest) echoApp
87+ simpleStatus sresp `shouldBe` status200
88+
89+ it "returns the response body of an echo app" $ do
90+ bodyRef <- IORef.newIORef "request body"
91+ let getBodyChunk = IORef.atomicModifyIORef bodyRef $ \leftover -> ("", leftover)
92+ sresp <- flip runSession echoApp $
93+ request $
94+ defaultRequest
95+ { requestBody = getBodyChunk
96+ }
97+ simpleBody sresp `shouldBe` "request body"
98+
99+ it "returns the response headers of an echo app" $ do
100+ sresp <- flip runSession echoApp $
101+ request $
102+ defaultRequest
103+ { requestHeaders = [("foo", "bar")]
104+ }
105+ simpleHeaders sresp `shouldBe` [("foo", "bar")]
106+
107+ let cookieApp req respond =
108+ case pathInfo req of
109+ ["set", name, val] ->
110+ respond $
111+ responseLBS
112+ status200
113+ [( "Set-Cookie"
114+ , toByteString $ Cookie.renderSetCookie $
115+ Cookie.def { Cookie.setCookieName = TE.encodeUtf8 name
116+ , Cookie.setCookieValue = TE.encodeUtf8 val
117+ }
118+ )
119+ ]
120+ "set_cookie_body"
121+ ["delete", name] ->
122+ respond $
123+ responseLBS
124+ status200
125+ [( "Set-Cookie"
126+ , toByteString $ Cookie.renderSetCookie $
127+ Cookie.def { Cookie.setCookieName =
128+ TE.encodeUtf8 name
129+ , Cookie.setCookieExpires =
130+ Just $ UTCTime (fromGregorian 1970 1 1) 0
131+ }
132+ )
133+ ]
134+ "set_cookie_body"
135+ _ ->
136+ respond $
137+ responseLBS
138+ status200
139+ []
140+ ( L8.pack
141+ $ show
142+ $ map snd
143+ $ filter ((=="Cookie") . fst)
144+ $ requestHeaders req
145+ )
146+
147+ it "sends a Cookie header with correct value after receiving a Set-Cookie header" $ do
148+ sresp <- flip runSession cookieApp $ do
149+ void $ request $
150+ setPath defaultRequest "/set/cookie_name/cookie_value"
151+ request $
152+ setPath defaultRequest "/get"
153+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
154+
155+ it "sends a Cookie header with updated value after receiving a Set-Cookie header update" $ do
156+ sresp <- flip runSession cookieApp $ do
157+ void $ request $
158+ setPath defaultRequest "/set/cookie_name/cookie_value"
159+ void $ request $
160+ setPath defaultRequest "/set/cookie_name/cookie_value2"
161+ request $
162+ setPath defaultRequest "/get"
163+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value2\"]"
164+
165+ it "handles multiple cookies" $ do
166+ sresp <- flip runSession cookieApp $ do
167+ void $ request $
168+ setPath defaultRequest "/set/cookie_name/cookie_value"
169+ void $ request $
170+ setPath defaultRequest "/set/cookie_name2/cookie_value2"
171+ request $
172+ setPath defaultRequest "/get"
173+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value;cookie_name2=cookie_value2\"]"
174+
175+ it "removes a deleted cookie" $ do
176+ sresp <- flip runSession cookieApp $ do
177+ void $ request $
178+ setPath defaultRequest "/set/cookie_name/cookie_value"
179+ void $ request $
180+ setPath defaultRequest "/set/cookie_name2/cookie_value2"
181+ void $ request $
182+ setPath defaultRequest "/delete/cookie_name2"
183+ request $
184+ setPath defaultRequest "/get"
185+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
186+
187+ it "sends a cookie set with setClientCookie to server" $ do
188+ sresp <- flip runSession cookieApp $ do
189+ setClientCookie
190+ (Cookie.def { Cookie.setCookieName = "cookie_name"
191+ , Cookie.setCookieValue = "cookie_value"
192+ }
193+ )
194+ request $
195+ setPath defaultRequest "/get"
196+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
197+
198+ it "sends a cookie updated with setClientCookie to server" $ do
199+ sresp <- flip runSession cookieApp $ do
200+ setClientCookie
201+ (Cookie.def { Cookie.setCookieName = "cookie_name"
202+ , Cookie.setCookieValue = "cookie_value"
203+ }
204+ )
205+ setClientCookie
206+ (Cookie.def { Cookie.setCookieName = "cookie_name"
207+ , Cookie.setCookieValue = "cookie_value2"
208+ }
209+ )
210+ request $
211+ setPath defaultRequest "/get"
212+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value2\"]"
213+
214+ it "does not send a cookie deleted with deleteClientCookie to server" $ do
215+ sresp <- flip runSession cookieApp $ do
216+ setClientCookie
217+ (Cookie.def { Cookie.setCookieName = "cookie_name"
218+ , Cookie.setCookieValue = "cookie_value"
219+ }
220+ )
221+ deleteClientCookie "cookie_name"
222+ request $
223+ setPath defaultRequest "/get"
224+ simpleBody sresp `shouldBe` "[]"
225+
226+
227+
wai-extra/test/Spec.hsnew file+1
@@ -0,0 +1 @@
1+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
wai-extra/test/WaiExtraSpec.hsnew file+451
@@ -0,0 +1,451 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+module WaiExtraSpec (spec, toRequest) where
4+
5+import Test.Hspec
6+import Test.HUnit hiding (Test)
7+#if MIN_VERSION_base(4,8,0)
8+import Data.Monoid ((<>))
9+#else
10+import Data.Monoid (mempty, mappend, (<>))
11+#endif
12+
13+import Network.Wai
14+import Network.Wai.Test
15+import Network.Wai.UrlMap
16+import qualified Data.ByteString as S
17+import qualified Data.ByteString.Char8 as S8
18+import qualified Data.ByteString.Lazy as L
19+import qualified Data.Text.Lazy as T
20+import qualified Data.Text as TS
21+import qualified Data.Text.Encoding as TE
22+import Control.Applicative
23+
24+import Network.Wai.Middleware.Jsonp
25+import Network.Wai.Middleware.Gzip
26+import Network.Wai.Middleware.Vhost
27+import Network.Wai.Middleware.Autohead
28+import Network.Wai.Middleware.MethodOverride
29+import Network.Wai.Middleware.MethodOverridePost
30+import Network.Wai.Middleware.AcceptOverride
31+import Network.Wai.Middleware.RequestLogger
32+import Codec.Compression.GZip (decompress)
33+import Network.Wai.Middleware.StreamFile
34+
35+import Control.Monad.IO.Class (liftIO)
36+import Data.Maybe (fromMaybe)
37+import Network.HTTP.Types (status200)
38+import System.Log.FastLogger
39+
40+import qualified Data.IORef as I
41+
42+spec :: Spec
43+spec = do
44+ describe "Network.Wai.UrlMap" $ do
45+ mapM_ (uncurry it) casesUrlMap
46+
47+ describe "Network.Wai" $ do
48+ {-
49+ , it "findBound" caseFindBound
50+ , it "sinkTillBound" caseSinkTillBound
51+ , it "killCR" caseKillCR
52+ , it "killCRLF" caseKillCRLF
53+ , it "takeLine" caseTakeLine
54+ -}
55+ it "jsonp" caseJsonp
56+ it "gzip" caseGzip
57+ it "gzip not for MSIE" caseGzipMSIE
58+ it "gzip bypass when precompressed" caseGzipBypassPre
59+ it "defaultCheckMime" caseDefaultCheckMime
60+ it "vhost" caseVhost
61+ it "autohead" caseAutohead
62+ it "method override" caseMethodOverride
63+ it "method override post" caseMethodOverridePost
64+ it "accept override" caseAcceptOverride
65+ it "debug request body" caseDebugRequestBody
66+ it "stream file" caseStreamFile
67+ it "stream LBS" caseStreamLBS
68+
69+toRequest :: S8.ByteString -> S8.ByteString -> SRequest
70+toRequest ctype content = SRequest defaultRequest
71+ { requestHeaders = [("Content-Type", ctype)]
72+ , requestMethod = "POST"
73+ , rawPathInfo = "/"
74+ , rawQueryString = ""
75+ , queryString = []
76+ } (L.fromChunks [content])
77+
78+{-
79+caseFindBound :: Assertion
80+caseFindBound = do
81+ findBound "def" "abcdefghi" @?=
82+ FoundBound "abc" "ghi"
83+ findBound "def" "ABC" @?= NoBound
84+ findBound "def" "abcd" @?= PartialBound
85+ findBound "def" "abcdE" @?= NoBound
86+ findBound "def" "abcdEdef" @?=
87+ FoundBound "abcdE" ""
88+
89+caseSinkTillBound :: Assertion
90+caseSinkTillBound = do
91+ let iter () _ = return ()
92+ let src = "this is some text"
93+ bound1 = "some"
94+ bound2 = "some!"
95+ let enum = enumList 1 [src]
96+ let helper _ _ = return ()
97+ (_, res1) <- run_ $ enum $$ sinkTillBound bound1 helper ()
98+ res1 @?= True
99+ (_, res2) <- run_ $ enum $$ sinkTillBound bound2 helper ()
100+ res2 @?= False
101+
102+caseKillCR :: Assertion
103+caseKillCR = do
104+ "foo" @=? killCR "foo"
105+ "foo" @=? killCR "foo\r"
106+ "foo\r\n" @=? killCR "foo\r\n"
107+ "foo\r'" @=? killCR "foo\r'"
108+
109+caseKillCRLF :: Assertion
110+caseKillCRLF = do
111+ "foo" @=? killCRLF "foo"
112+ "foo\r" @=? killCRLF "foo\r"
113+ "foo" @=? killCRLF "foo\r\n"
114+ "foo\r'" @=? killCRLF "foo\r'"
115+ "foo" @=? killCRLF "foo\n"
116+
117+caseTakeLine :: Assertion
118+caseTakeLine = do
119+ helper "foo\nbar\nbaz" "foo"
120+ helper "foo\r\nbar\nbaz" "foo"
121+ helper "foo\nbar\r\nbaz" "foo"
122+ helper "foo\rbar\r\nbaz" "foo\rbar"
123+ where
124+ helper haystack needle = do
125+ x <- run_ $ enumList 1 [haystack] $$ takeLine
126+ Just needle @=? x
127+-}
128+
129+jsonpApp :: Application
130+jsonpApp = jsonp $ \_ f -> f $ responseLBS
131+ status200
132+ [("Content-Type", "application/json")]
133+ "{\"foo\":\"bar\"}"
134+
135+caseJsonp :: Assertion
136+caseJsonp = flip runSession jsonpApp $ do
137+ sres1 <- request defaultRequest
138+ { queryString = [("callback", Just "test")]
139+ , requestHeaders = [("Accept", "text/javascript")]
140+ }
141+ assertContentType "text/javascript" sres1
142+ assertBody "test({\"foo\":\"bar\"})" sres1
143+
144+ sres2 <- request defaultRequest
145+ { queryString = [("call_back", Just "test")]
146+ , requestHeaders = [("Accept", "text/javascript")]
147+ }
148+ assertContentType "application/json" sres2
149+ assertBody "{\"foo\":\"bar\"}" sres2
150+
151+ sres3 <- request defaultRequest
152+ { queryString = [("callback", Just "test")]
153+ , requestHeaders = [("Accept", "text/html")]
154+ }
155+ assertContentType "application/json" sres3
156+ assertBody "{\"foo\":\"bar\"}" sres3
157+
158+gzipApp :: Application
159+gzipApp = gzip def $ \_ f -> f $ responseLBS status200
160+ [("Content-Type", "text/plain")]
161+ "test"
162+
163+-- Lie a little and don't compress the body. This way we test
164+-- that the compression is skipped based on the presence of
165+-- the Content-Encoding header.
166+gzipPrecompressedApp :: Application
167+gzipPrecompressedApp = gzip def $ \_ f -> f $ responseLBS status200
168+ [("Content-Type", "text/plain"), ("Content-Encoding", "gzip")]
169+ "test"
170+
171+caseGzip :: Assertion
172+caseGzip = flip runSession gzipApp $ do
173+ sres1 <- request defaultRequest
174+ { requestHeaders = [("Accept-Encoding", "gzip")]
175+ }
176+ assertHeader "Content-Encoding" "gzip" sres1
177+ liftIO $ decompress (simpleBody sres1) @?= "test"
178+
179+ sres2 <- request defaultRequest
180+ { requestHeaders = []
181+ }
182+ assertNoHeader "Content-Encoding" sres2
183+ assertBody "test" sres2
184+
185+caseDefaultCheckMime :: Assertion
186+caseDefaultCheckMime = do
187+ let go x y = (x, defaultCheckMime x) `shouldBe` (x, y)
188+ go "application/json" True
189+ go "application/javascript" True
190+ go "application/something" False
191+ go "text/something" True
192+ go "foo/bar" False
193+ go "application/json; charset=utf-8" True
194+
195+caseGzipMSIE :: Assertion
196+caseGzipMSIE = flip runSession gzipApp $ do
197+ sres1 <- request defaultRequest
198+ { requestHeaders =
199+ [ ("Accept-Encoding", "gzip")
200+ , ("User-Agent", "Mozilla/4.0 (Windows; MSIE 6.0; Windows NT 6.0)")
201+ ]
202+ }
203+ assertNoHeader "Content-Encoding" sres1
204+ liftIO $ simpleBody sres1 @?= "test"
205+
206+caseGzipBypassPre :: Assertion
207+caseGzipBypassPre = flip runSession gzipPrecompressedApp $ do
208+ sres1 <- request defaultRequest
209+ { requestHeaders = [("Accept-Encoding", "gzip")]
210+ }
211+ assertHeader "Content-Encoding" "gzip" sres1
212+ assertBody "test" sres1 -- the body is not actually compressed
213+
214+vhostApp1, vhostApp2, vhostApp :: Application
215+vhostApp1 _ f = f $ responseLBS status200 [] "app1"
216+vhostApp2 _ f = f $ responseLBS status200 [] "app2"
217+vhostApp = vhost
218+ [ ((== Just "foo.com") . lookup "host" . requestHeaders, vhostApp1)
219+ ]
220+ vhostApp2
221+
222+caseVhost :: Assertion
223+caseVhost = flip runSession vhostApp $ do
224+ sres1 <- request defaultRequest
225+ { requestHeaders = [("Host", "foo.com")]
226+ }
227+ assertBody "app1" sres1
228+
229+ sres2 <- request defaultRequest
230+ { requestHeaders = [("Host", "bar.com")]
231+ }
232+ assertBody "app2" sres2
233+
234+autoheadApp :: Application
235+autoheadApp = autohead $ \_ f -> f $ responseLBS status200
236+ [("Foo", "Bar")] "body"
237+
238+caseAutohead :: Assertion
239+caseAutohead = flip runSession autoheadApp $ do
240+ sres1 <- request defaultRequest
241+ { requestMethod = "GET"
242+ }
243+ assertHeader "Foo" "Bar" sres1
244+ assertBody "body" sres1
245+
246+ sres2 <- request defaultRequest
247+ { requestMethod = "HEAD"
248+ }
249+ assertHeader "Foo" "Bar" sres2
250+ assertBody "" sres2
251+
252+moApp :: Application
253+moApp = methodOverride $ \req f -> f $ responseLBS status200
254+ [("Method", requestMethod req)] ""
255+
256+caseMethodOverride :: Assertion
257+caseMethodOverride = flip runSession moApp $ do
258+ sres1 <- request defaultRequest
259+ { requestMethod = "GET"
260+ , queryString = []
261+ }
262+ assertHeader "Method" "GET" sres1
263+
264+ sres2 <- request defaultRequest
265+ { requestMethod = "POST"
266+ , queryString = []
267+ }
268+ assertHeader "Method" "POST" sres2
269+
270+ sres3 <- request defaultRequest
271+ { requestMethod = "POST"
272+ , queryString = [("_method", Just "PUT")]
273+ }
274+ assertHeader "Method" "PUT" sres3
275+
276+mopApp :: Application
277+mopApp = methodOverridePost $ \req f -> f $ responseLBS status200 [("Method", requestMethod req)] ""
278+
279+caseMethodOverridePost :: Assertion
280+caseMethodOverridePost = flip runSession mopApp $ do
281+
282+ -- Get Request are unmodified
283+ sres1 <- let r = toRequest "application/x-www-form-urlencoded" "_method=PUT&foo=bar&baz=bin"
284+ s = simpleRequest r
285+ m = s { requestMethod = "GET" }
286+ b = r { simpleRequest = m }
287+ in srequest b
288+ assertHeader "Method" "GET" sres1
289+
290+ -- Post requests are modified if _method comes first
291+ sres2 <- srequest $ toRequest "application/x-www-form-urlencoded" "_method=PUT&foo=bar&baz=bin"
292+ assertHeader "Method" "PUT" sres2
293+
294+ -- Post requests are unmodified if _method doesn't come first
295+ sres3 <- srequest $ toRequest "application/x-www-form-urlencoded" "foo=bar&_method=PUT&baz=bin"
296+ assertHeader "Method" "POST" sres3
297+
298+ -- Post requests are unmodified if Content-Type header isn't set to "application/x-www-form-urlencoded"
299+ sres4 <- srequest $ toRequest "text/html; charset=utf-8" "foo=bar&_method=PUT&baz=bin"
300+ assertHeader "Method" "POST" sres4
301+
302+aoApp :: Application
303+aoApp = acceptOverride $ \req f -> f $ responseLBS status200
304+ [("Accept", fromMaybe "" $ lookup "Accept" $ requestHeaders req)] ""
305+
306+caseAcceptOverride :: Assertion
307+caseAcceptOverride = flip runSession aoApp $ do
308+ sres1 <- request defaultRequest
309+ { queryString = []
310+ , requestHeaders = [("Accept", "foo")]
311+ }
312+ assertHeader "Accept" "foo" sres1
313+
314+ sres2 <- request defaultRequest
315+ { queryString = []
316+ , requestHeaders = [("Accept", "bar")]
317+ }
318+ assertHeader "Accept" "bar" sres2
319+
320+ sres3 <- request defaultRequest
321+ { queryString = [("_accept", Just "baz")]
322+ , requestHeaders = [("Accept", "bar")]
323+ }
324+ assertHeader "Accept" "baz" sres3
325+
326+caseDebugRequestBody :: Assertion
327+caseDebugRequestBody = do
328+ flip runSession (debugApp postOutput) $ do
329+ let req = toRequest "application/x-www-form-urlencoded" "foo=bar&baz=bin"
330+ res <- srequest req
331+ assertStatus 200 res
332+
333+ let qs = "?foo=bar&baz=bin"
334+ flip runSession (debugApp $ getOutput params) $ do
335+ assertStatus 200 =<< request defaultRequest
336+ { requestMethod = "GET"
337+ , queryString = map (\(k,v) -> (k, Just v)) params
338+ , rawQueryString = qs
339+ , requestHeaders = []
340+ , rawPathInfo = "/location"
341+ }
342+ where
343+ params = [("foo", "bar"), ("baz", "bin")]
344+ -- the time cannot be known, so match around it
345+ postOutput = (T.pack $ "POST /\n Params: " ++ (show params), "s\n")
346+ getOutput params' = ("GET /location\n Params: " <> T.pack (show params') <> "\n Accept: \n Status: 200 OK 0", "s\n")
347+
348+ debugApp (beginning, ending) req send = do
349+ iactual <- I.newIORef mempty
350+ middleware <- mkRequestLogger def
351+ { destination = Callback $ \strs -> I.modifyIORef iactual $ (`mappend` strs)
352+ , outputFormat = Detailed False
353+ }
354+ res <- middleware (\_req f -> f $ responseLBS status200 [ ] "") req send
355+ actual <- logToBs <$> I.readIORef iactual
356+ actual `shouldSatisfy` S.isPrefixOf begin
357+ actual `shouldSatisfy` S.isSuffixOf end
358+
359+ return res
360+ where
361+ begin = TE.encodeUtf8 $ T.toStrict beginning
362+ end = TE.encodeUtf8 $ T.toStrict ending
363+
364+ logToBs = fromLogStr
365+
366+ {-debugApp = debug $ \req -> do-}
367+ {-return $ responseLBS status200 [ ] ""-}
368+
369+urlMapTestApp :: Application
370+urlMapTestApp = mapUrls $
371+ mount "bugs" bugsApp
372+ <|> mount "helpdesk" helpdeskApp
373+ <|> mount "api"
374+ ( mount "v1" apiV1
375+ <|> mount "v2" apiV2
376+ )
377+ <|> mountRoot mainApp
378+
379+ where
380+ trivialApp :: S.ByteString -> Application
381+ trivialApp name req f =
382+ f $
383+ responseLBS
384+ status200
385+ [ ("content-type", "text/plain")
386+ , ("X-pathInfo", S8.pack . show . pathInfo $ req)
387+ , ("X-rawPathInfo", rawPathInfo req)
388+ , ("X-appName", name)
389+ ]
390+ ""
391+
392+ bugsApp = trivialApp "bugs"
393+ helpdeskApp = trivialApp "helpdesk"
394+ apiV1 = trivialApp "apiv1"
395+ apiV2 = trivialApp "apiv2"
396+ mainApp = trivialApp "main"
397+
398+casesUrlMap :: [(String, Assertion)]
399+casesUrlMap = [pair1, pair2, pair3, pair4]
400+ where
401+ makePair name session = (name, runSession session urlMapTestApp)
402+ get reqPath = request $ setPath defaultRequest reqPath
403+ s = S8.pack . show :: [TS.Text] -> S.ByteString
404+
405+ pair1 = makePair "should mount root" $ do
406+ res1 <- get "/"
407+ assertStatus 200 res1
408+ assertHeader "X-rawPathInfo" "/" res1
409+ assertHeader "X-pathInfo" (s []) res1
410+ assertHeader "X-appName" "main" res1
411+
412+ pair2 = makePair "should mount apps" $ do
413+ res2 <- get "/bugs"
414+ assertStatus 200 res2
415+ assertHeader "X-rawPathInfo" "/" res2
416+ assertHeader "X-pathInfo" (s []) res2
417+ assertHeader "X-appName" "bugs" res2
418+
419+ pair3 = makePair "should preserve extra path info" $ do
420+ res3 <- get "/helpdesk/issues/11"
421+ assertStatus 200 res3
422+ assertHeader "X-rawPathInfo" "/issues/11" res3
423+ assertHeader "X-pathInfo" (s ["issues", "11"]) res3
424+
425+ pair4 = makePair "should 404 if none match" $ do
426+ res4 <- get "/api/v3"
427+ assertStatus 404 res4
428+
429+testFile :: FilePath
430+testFile = "test/WaiExtraSpec.hs"
431+
432+streamFileApp :: Application
433+streamFileApp = streamFile $ \_ f -> f $ responseFile status200 [] testFile Nothing
434+
435+caseStreamFile :: Assertion
436+caseStreamFile = flip runSession streamFileApp $ do
437+ sres <- request defaultRequest
438+ assertStatus 200 sres
439+ assertBodyContains "caseStreamFile" sres
440+ assertNoHeader "Transfer-Encoding" sres
441+
442+streamLBSApp :: Application
443+streamLBSApp = streamFile $ \_ f -> f $ responseLBS status200
444+ [("Content-Type", "text/plain")]
445+ "test"
446+
447+caseStreamLBS :: Assertion
448+caseStreamLBS = flip runSession streamLBSApp $ do
449+ sres <- request defaultRequest
450+ assertStatus 200 sres
451+ assertBody "test" sres
test/json → wai-extra/test/jsonrenamed

The content is the same.

wai-extra/test/requests/dalvik-requestnew file

Binary file not shown.

wai-extra/test/sample.hsnew file+26
@@ -0,0 +1,26 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+import Data.ByteString.Char8 (pack)
4+import Data.ByteString.Lazy (fromChunks)
5+import Data.Text ()
6+import Network.HTTP.Types
7+import Network.Wai
8+import Network.Wai.Middleware.Gzip
9+import Network.Wai.Middleware.Jsonp
10+import Network.Wai.Handler.Warp
11+
12+app :: Application
13+app request = return $ case pathInfo request of
14+ [] -> responseLBS status200 []
15+ $ fromChunks $ flip map [1..10000] $ \i -> pack $ concat
16+ [ "<p>Just this same paragraph again. "
17+ , show (i :: Int)
18+ , "</p>"
19+ ]
20+ ["test.html"] -> ResponseFile status200 [] "test.html" Nothing
21+ ["json"] -> ResponseFile status200 [(hContentType, "application/json")]
22+ "json" Nothing
23+ _ -> ResponseFile status404 [] "../LICENSE" Nothing
24+
25+main :: IO ()
26+main = run 3000 $ gzip def $ jsonp app
test/test.html → wai-extra/test/test.htmlrenamed

The content is the same.

wai-extra/wai-extra.cabalnew file+212
@@ -0,0 +1,212 @@
1+Name: wai-extra
2+Version: 3.0.29.1
3+Synopsis: Provides some basic WAI handlers and middleware.
4+description:
5+ Provides basic WAI handler and middleware functionality:
6+ .
7+ * WAI Testing Framework
8+ .
9+ Hspec testing facilities and helpers for WAI.
10+ .
11+ * Event Source/Event Stream
12+ .
13+ Send server events to the client. Compatible with the JavaScript
14+ EventSource API.
15+ .
16+ * Accept Override
17+ .
18+ Override the Accept header in a request. Special handling for the
19+ _accept query parameter (which is used throughout WAI override the
20+ Accept header).
21+ .
22+ * Add Headers
23+ .
24+ WAI Middleware for adding arbitrary headers to an HTTP request.
25+ .
26+ * Clean Path
27+ .
28+ Clean a request path to a canonical form.
29+ .
30+ * GZip Compression
31+ .
32+ Negotiate HTTP payload gzip compression.
33+ .
34+ * HTTP Basic Authentication
35+ .
36+ WAI Basic Authentication Middleware which uses Authorization header.
37+ .
38+ * JSONP
39+ .
40+ \"JSON with Padding\" middleware. Automatic wrapping of JSON
41+ responses to convert into JSONP.
42+ .
43+ * Method Override / Post
44+ .
45+ Allows overriding of the HTTP request method via the _method query string
46+ parameter.
47+ .
48+ * Request Logging
49+ .
50+ Request logging middleware for development and production environments
51+ .
52+ * Request Rewrite
53+ .
54+ Rewrite request path info based on a custom conversion rules.
55+ .
56+ * Stream Files
57+ .
58+ Convert ResponseFile type responses into ResponseStream type.
59+ .
60+ * Virtual Host
61+ .
62+ Redirect incoming requests to a new host based on custom rules.
63+ .
64+ .
65+ API docs and the README are available at <http://www.stackage.org/package/wai-extra>.
66+
67+License: MIT
68+License-file: LICENSE
69+Author: Michael Snoyman
70+Maintainer: michael@snoyman.com
71+Homepage: http://github.com/yesodweb/wai
72+Category: Web
73+Build-Type: Simple
74+Cabal-Version: >=1.10
75+Stability: Stable
76+extra-source-files:
77+ test/requests/dalvik-request
78+ test/json
79+ test/test.html
80+ test/sample.hs
81+ ChangeLog.md
82+ README.md
83+
84+flag build-example
85+ description: Build example executable.
86+ manual: True
87+ default: False
88+
89+Library
90+ Build-Depends: base >= 4.8 && < 5
91+ , bytestring >= 0.10.4
92+ , wai >= 3.0.3.0 && < 3.3
93+ , old-locale >= 1.0.0.2 && < 1.1
94+ , time >= 1.1.4
95+ , network >= 2.6.1.0
96+ , directory >= 1.0.1
97+ , transformers >= 0.2.2
98+ , http-types >= 0.7
99+ , text >= 0.7
100+ , case-insensitive >= 0.2
101+ , data-default-class
102+ , fast-logger >= 2.4.5
103+ , wai-logger >= 2.3.2
104+ , ansi-terminal
105+ , resourcet >= 0.4.6 && < 1.3
106+ , void >= 0.5
107+ , containers
108+ , base64-bytestring
109+ , word8
110+ , deepseq
111+ , streaming-commons >= 0.2
112+ , unix-compat
113+ , cookie
114+ , vault
115+ , zlib
116+ , aeson
117+ , iproute
118+ , http2
119+
120+ if os(windows)
121+ cpp-options: -DWINDOWS
122+ else
123+ build-depends: unix
124+
125+ default-extensions: OverloadedStrings
126+
127+ Exposed-modules: Network.Wai.Handler.CGI
128+ Network.Wai.Handler.SCGI
129+ Network.Wai.Header
130+ Network.Wai.Middleware.AcceptOverride
131+ Network.Wai.Middleware.AddHeaders
132+ Network.Wai.Middleware.Approot
133+ Network.Wai.Middleware.Autohead
134+ Network.Wai.Middleware.CleanPath
135+ Network.Wai.Middleware.Local
136+ Network.Wai.Middleware.RequestLogger
137+ Network.Wai.Middleware.RequestLogger.JSON
138+ Network.Wai.Middleware.Gzip
139+ Network.Wai.Middleware.Jsonp
140+ Network.Wai.Middleware.MethodOverride
141+ Network.Wai.Middleware.MethodOverridePost
142+ Network.Wai.Middleware.Rewrite
143+ Network.Wai.Middleware.StripHeaders
144+ Network.Wai.Middleware.Vhost
145+ Network.Wai.Middleware.HttpAuth
146+ Network.Wai.Middleware.StreamFile
147+ Network.Wai.Middleware.ForceDomain
148+ Network.Wai.Middleware.ForceSSL
149+ Network.Wai.Middleware.Routed
150+ Network.Wai.Middleware.Timeout
151+ Network.Wai.Parse
152+ Network.Wai.Request
153+ Network.Wai.UrlMap
154+ Network.Wai.Test
155+ Network.Wai.Test.Internal
156+ Network.Wai.EventSource
157+ Network.Wai.EventSource.EventStream
158+ other-modules: Network.Wai.Middleware.RequestLogger.Internal
159+ default-language: Haskell2010
160+ ghc-options: -Wall
161+
162+executable example
163+ hs-source-dirs: example
164+ main-is: Main.hs
165+ ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall
166+ if flag(build-example)
167+ build-depends: base
168+ , wai-extra
169+ , warp
170+ , wai
171+ , time
172+ , http-types
173+ , bytestring
174+ else
175+ buildable: False
176+ default-language: Haskell2010
177+
178+test-suite spec
179+ type: exitcode-stdio-1.0
180+ hs-source-dirs: test
181+ main-is: Spec.hs
182+ other-modules: Network.Wai.TestSpec
183+ Network.Wai.ParseSpec
184+ Network.Wai.RequestSpec
185+ Network.Wai.Middleware.ApprootSpec
186+ Network.Wai.Middleware.ForceSSLSpec
187+ Network.Wai.Middleware.RoutedSpec
188+ Network.Wai.Middleware.StripHeadersSpec
189+ Network.Wai.Middleware.TimeoutSpec
190+ WaiExtraSpec
191+ build-depends: base >= 4 && < 5
192+ , wai-extra
193+ , wai
194+ , hspec >= 1.3
195+ , transformers
196+ , fast-logger
197+ , http-types
198+ , zlib
199+ , text
200+ , resourcet
201+ , bytestring
202+ , HUnit
203+ , cookie
204+ , time
205+ , case-insensitive
206+ , http2
207+ ghc-options: -Wall
208+ default-language: Haskell2010
209+
210+source-repository head
211+ type: git
212+ location: git://github.com/yesodweb/wai.git
wai-frontend-monadcgi/.gitignorenew file+2
@@ -0,0 +1,2 @@
1+dist
2+*.swp
wai-frontend-monadcgi/ChangeLog.mdnew file+7
@@ -0,0 +1,7 @@
1+## 3.0.0.3
2+
3+* wai-frontend-monadcgi does not drop '?' in query string [#590](https://github.com/yesodweb/wai/issues/590)
4+
5+## 3.0.0.2
6+
7+* Support for wai 3.2
wai-frontend-monadcgi/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-frontend-monadcgi/Network/Wai/Frontend/MonadCGI.hsnew file+71
@@ -0,0 +1,71 @@
1+module Network.Wai.Frontend.MonadCGI
2+ ( cgiToApp
3+ , cgiToAppGeneric
4+ ) where
5+
6+import Network.Wai
7+import Network.CGI.Monad
8+import Network.CGI.Protocol
9+import Network.HTTP.Types (Status (..))
10+import Control.Monad.IO.Class (liftIO)
11+import Data.CaseInsensitive (original)
12+
13+import qualified Data.Map as Map
14+import qualified Data.ByteString.Lazy as BS
15+import qualified Data.ByteString.Char8 as S8
16+
17+import Control.Arrow (first)
18+import Data.Char (toUpper)
19+import Data.String (fromString)
20+
21+safeRead :: Read a => a -> String -> a
22+safeRead d s = case reads s of
23+ ((x, _):_) -> x
24+ _ -> d
25+
26+cgiToApp :: CGI CGIResult -> Application
27+cgiToApp = cgiToAppGeneric id
28+
29+cgiToAppGeneric :: Monad m
30+ => (m (Headers, CGIResult) -> IO (Headers, CGIResult))
31+ -> CGIT m CGIResult
32+ -> Application
33+cgiToAppGeneric toIO cgi env sendResponse = do
34+ input <- lazyRequestBody env
35+ let vars = map (first fixVarName . go) (requestHeaders env)
36+ ++ getCgiVars env
37+ (inputs, body') = decodeInput vars input
38+ req = CGIRequest
39+ { cgiVars = Map.fromList $ vars
40+ , cgiInputs = inputs
41+ , cgiRequestBody = body'
42+ }
43+ (headers'', output') <- liftIO $ toIO $ runCGIT cgi req
44+ let output = case output' of
45+ CGIOutput bs -> bs
46+ CGINothing -> BS.empty
47+ let headers' = map (\(HeaderName x, y) ->
48+ (fromString x, S8.pack y)) headers''
49+ let status' = case lookup (fromString "Status") headers' of
50+ Nothing -> 200
51+ Just s -> safeRead 200 $ S8.unpack s
52+ sendResponse $ responseLBS (Status status' S8.empty) headers' output
53+ where
54+ go (x, y) = (S8.unpack $ original x, S8.unpack y)
55+
56+fixVarName :: String -> String
57+fixVarName = ((++) $ "HTTP_") . map fixVarNameChar
58+
59+fixVarNameChar :: Char -> Char
60+fixVarNameChar '-' = '_'
61+fixVarNameChar c = toUpper c
62+
63+getCgiVars :: Request -> [(String, String)]
64+getCgiVars e =
65+ [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
66+ , ("REQUEST_METHOD", show $ requestMethod e)
67+ , ("QUERY_STRING",
68+ case S8.unpack $ rawQueryString e of
69+ '?':rest -> rest
70+ x -> x)
71+ ]
wai-frontend-monadcgi/README.mdnew file+5
@@ -0,0 +1,5 @@
1+## wai-frontend-monadcgi
2+
3+Allows programs written against MonadCGI to run with any WAI handler. This is
4+most useful for running your existing CGI apps on Warp. For true "yo
5+dawg"-ness, try running this through the WAI CGI backend.
wai-frontend-monadcgi/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
wai-frontend-monadcgi/samples/.htaccessnew file+5
@@ -0,0 +1,5 @@
1+Options +ExecCGI
2+AddHandler cgi-script .cgi
3+AddHandler fastcgi-script .fcgi
4+
5+Options +FollowSymlinks
wai-frontend-monadcgi/samples/plain_cgi.hsnew file+5
@@ -0,0 +1,5 @@
1+import Network.CGI
2+
3+main = runCGI mainCGI
4+
5+mainCGI = output "This is a test"
wai-frontend-monadcgi/samples/wai_cgi.hsnew file+8
@@ -0,0 +1,8 @@
1+import qualified Network.CGI
2+import qualified Network.Wai.Handler.SimpleServer
3+import qualified Network.Wai.Frontend.MonadCGI
4+
5+main = Network.Wai.Handler.SimpleServer.run 3000
6+ $ Network.Wai.Frontend.MonadCGI.cgiToApp mainCGI
7+
8+mainCGI = Network.CGI.output "This is a test"
wai-frontend-monadcgi/samples/wai_cgi_generic.hsnew file+19
@@ -0,0 +1,19 @@
1+{-# LANGUAGE PackageImports #-}
2+import qualified Network.CGI
3+import qualified Network.Wai.Handler.SimpleServer
4+import qualified Network.Wai.Frontend.MonadCGI
5+import "mtl" Control.Monad.Reader
6+
7+main :: IO ()
8+main = Network.Wai.Handler.SimpleServer.run 3000
9+ $ Network.Wai.Frontend.MonadCGI.cgiToAppGeneric
10+ monadToIO
11+ mainCGI
12+
13+mainCGI :: Network.CGI.CGIT (Reader String) Network.CGI.CGIResult
14+mainCGI = do
15+ s <- lift ask
16+ Network.CGI.output s
17+
18+monadToIO :: Reader String a -> IO a
19+monadToIO = return . (flip runReader) "This is a generic test"
wai-frontend-monadcgi/samples/wai_fastcgi.hsnew file+8
@@ -0,0 +1,8 @@
1+import qualified Network.CGI
2+import qualified Network.Wai.Handler.FastCGI
3+import qualified Network.Wai.Frontend.MonadCGI
4+
5+main = Network.Wai.Handler.FastCGI.run
6+ $ Network.Wai.Frontend.MonadCGI.cgiToApp mainCGI
7+
8+mainCGI = Network.CGI.output "This is a test"
wai-frontend-monadcgi/wai-frontend-monadcgi.cabalnew file+29
@@ -0,0 +1,29 @@
1+name: wai-frontend-monadcgi
2+version: 3.0.0.3
3+license: MIT
4+license-file: LICENSE
5+author: Michael Snoyman <michael@snoyman.com>
6+maintainer: Michael Snoyman <michael@snoyman.com>
7+synopsis: Run CGI apps on WAI.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-frontend-monadcgi>.
9+category: Web
10+stability: stable
11+cabal-version: >= 1.6
12+build-type: Simple
13+extra-source-files: README.md ChangeLog.md
14+
15+library
16+ build-depends: base >= 4 && < 5
17+ , bytestring
18+ , containers >= 0.2
19+ , cgi
20+ , http-types
21+ , transformers
22+ , case-insensitive
23+ , wai >= 3.0 && < 3.3
24+ exposed-modules: Network.Wai.Frontend.MonadCGI
25+ ghc-options: -Wall
26+
27+Source-repository head
28+ type: git
29+ location: git://github.com/yesodweb/wai.git
wai-http2-extra/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2016 Kazu Yamamoto, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-http2-extra/Network/Wai/Middleware/Push/Referer.hsnew file+236
@@ -0,0 +1,236 @@
1+{-# LANGUAGE BangPatterns, OverloadedStrings, RecordWildCards #-}
2+
3+-- | Middleware for server push learning dependency based on Referer:.
4+module Network.Wai.Middleware.Push.Referer (
5+ -- * Middleware
6+ pushOnReferer
7+ -- * Making push promise
8+ , URLPath
9+ , MakePushPromise
10+ , defaultMakePushPromise
11+ -- * Settings
12+ , Settings
13+ , defaultSettings
14+ , makePushPromise
15+ , duration
16+ , keyLimit
17+ , valueLimit
18+ ) where
19+
20+import Control.Monad (when, unless)
21+import Control.Reaper
22+import Data.ByteString (ByteString)
23+import qualified Data.ByteString as BS
24+import Data.ByteString.Internal (ByteString(..), memchr)
25+import Data.IORef
26+import Data.Maybe (isNothing)
27+import Data.Word (Word8)
28+import Data.Word8
29+import Foreign.ForeignPtr (withForeignPtr, ForeignPtr)
30+import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
31+import Foreign.Storable (peek)
32+import Network.HTTP.Types (Status(..))
33+import Network.Wai
34+import Network.Wai.Handler.Warp hiding (Settings, defaultSettings)
35+import Network.Wai.Internal (Response(..))
36+import System.IO.Unsafe (unsafePerformIO)
37+
38+import qualified Network.Wai.Middleware.Push.Referer.LimitMultiMap as M
39+
40+-- $setup
41+-- >>> :set -XOverloadedStrings
42+
43+-- | Making a push promise based on Referer:,
44+-- path to be pushed and file to be pushed.
45+-- If the middleware should push this file in the next time when
46+-- the page of Referer: is accessed,
47+-- this function should return 'Just'.
48+-- If 'Nothing' is returned,
49+-- the middleware learns nothing.
50+type MakePushPromise = URLPath -- ^ path in referer (key: /index.html)
51+ -> URLPath -- ^ path to be pushed (value: /style.css)
52+ -> FilePath -- ^ file to be pushed (file_path/style.css)
53+ -> IO (Maybe PushPromise)
54+
55+-- | Type for URL path.
56+type URLPath = ByteString
57+
58+type Cache = M.LimitMultiMap URLPath PushPromise
59+
60+initialized :: IORef Bool
61+initialized = unsafePerformIO $ newIORef False
62+{-# NOINLINE initialized #-}
63+
64+cacheReaper :: IORef (Maybe (Reaper Cache (URLPath,PushPromise)))
65+cacheReaper = unsafePerformIO $ newIORef Nothing
66+{-# NOINLINE cacheReaper #-}
67+
68+-- | Settings for server push based on Referer:.
69+data Settings = Settings {
70+ makePushPromise :: MakePushPromise -- ^ Default: 'defaultMakePushPromise'
71+ , duration :: Int -- ^ Duration (in micro seconds) to keep the learning information. The information completely cleared every this duration. Default: 30000000
72+ , keyLimit :: Int -- ^ Max number of keys (e.g. index.html) in the learning information. Default: 20
73+ , valueLimit :: Int -- ^ Max number of values (e.g. style.css) in the learning information. Default: 20
74+ }
75+
76+-- | Default settings.
77+defaultSettings :: Settings
78+defaultSettings = Settings {
79+ makePushPromise = defaultMakePushPromise
80+ , duration = 30000000
81+ , keyLimit = 20
82+ , valueLimit = 20
83+ }
84+
85+tryInitialize :: Settings -> IO ()
86+tryInitialize Settings{..} = do
87+ isInitialized <- atomicModifyIORef' initialized $ \x -> (True, x)
88+ unless isInitialized $ do
89+ reaper <- mkReaper settings
90+ writeIORef cacheReaper (Just reaper)
91+ where
92+ emptyCache = M.empty keyLimit valueLimit
93+ settings :: ReaperSettings Cache (URLPath,PushPromise)
94+ settings = defaultReaperSettings {
95+ reaperAction = \_ -> return (\_ -> emptyCache)
96+ , reaperCons = M.insert
97+ , reaperNull = M.isEmpty
98+ , reaperEmpty = emptyCache
99+ , reaperDelay = duration
100+ }
101+
102+-- | The middleware to push files based on Referer:.
103+-- Learning strategy is implemented in the first argument.
104+pushOnReferer :: Settings -> Middleware
105+pushOnReferer settings@Settings{..} app req sendResponse = do
106+ tryInitialize settings
107+ mreaper <- readIORef cacheReaper
108+ case mreaper of
109+ Nothing -> app req sendResponse
110+ Just reaper -> app req (push reaper)
111+ where
112+ push reaper res@(ResponseFile (Status 200 "OK") _ file Nothing) = do
113+ let !path = rawPathInfo req
114+ m <- reaperRead reaper
115+ case M.lookup path m of
116+ [] -> case requestHeaderReferer req of
117+ Nothing -> return ()
118+ Just referer -> do
119+ (mauth,refPath) <- parseUrl referer
120+ when (isNothing mauth
121+ || requestHeaderHost req == mauth) $ do
122+ when (path /= refPath) $ do -- just in case
123+ let !path' = BS.copy path
124+ !refPath' = BS.copy refPath
125+ mpp <- makePushPromise refPath' path' file
126+ case mpp of
127+ Nothing -> return ()
128+ Just pp -> reaperAdd reaper (refPath',pp)
129+ ps -> do
130+ let !h2d = defaultHTTP2Data { http2dataPushPromise = ps}
131+ setHTTP2Data req (Just h2d)
132+ sendResponse res
133+ push _ res = sendResponse res
134+
135+
136+-- | Learn if the file to be pushed is CSS (.css) or JavaScript (.js) file
137+-- AND the Referer: ends with \"/\" or \".html\" or \".htm\".
138+defaultMakePushPromise :: MakePushPromise
139+defaultMakePushPromise refPath path file
140+ | isHTML refPath = case getCT path of
141+ Nothing -> return Nothing
142+ Just ct -> do
143+ let pp = defaultPushPromise {
144+ promisedPath = path
145+ , promisedFile = file
146+ , promisedResponseHeaders = [("content-type", ct)
147+ ,("x-http2-push", refPath)]
148+ }
149+ return $ Just pp
150+ | otherwise = return Nothing
151+
152+getCT :: URLPath -> Maybe ByteString
153+getCT p
154+ | ".js" `BS.isSuffixOf` p = Just "application/javascript"
155+ | ".css" `BS.isSuffixOf` p = Just "text/css"
156+ | otherwise = Nothing
157+
158+isHTML :: URLPath -> Bool
159+isHTML p = ("/" `BS.isSuffixOf` p)
160+ || (".html" `BS.isSuffixOf` p)
161+ || (".htm" `BS.isSuffixOf` p)
162+
163+-- |
164+--
165+-- >>> parseUrl ""
166+-- (Nothing,"")
167+-- >>> parseUrl "/"
168+-- (Nothing,"/")
169+-- >>> parseUrl "ht"
170+-- (Nothing,"")
171+-- >>> parseUrl "http://example.com/foo/bar/"
172+-- (Just "example.com","/foo/bar/")
173+-- >>> parseUrl "https://www.example.com/path/to/dir/"
174+-- (Just "www.example.com","/path/to/dir/")
175+-- >>> parseUrl "http://www.example.com:8080/path/to/dir/"
176+-- (Just "www.example.com:8080","/path/to/dir/")
177+-- >>> parseUrl "//www.example.com:8080/path/to/dir/"
178+-- (Just "www.example.com:8080","/path/to/dir/")
179+-- >>> parseUrl "/path/to/dir/"
180+-- (Nothing,"/path/to/dir/")
181+
182+parseUrl :: ByteString -> IO (Maybe ByteString, URLPath)
183+parseUrl bs@(PS fptr0 off len)
184+ | len == 0 = return (Nothing, "")
185+ | len == 1 = return (Nothing, bs)
186+ | otherwise = withForeignPtr fptr0 $ \ptr0 -> do
187+ let begptr = ptr0 `plusPtr` off
188+ limptr = begptr `plusPtr` len
189+ parseUrl' fptr0 ptr0 begptr limptr len
190+
191+parseUrl' :: ForeignPtr Word8 -> Ptr Word8 -> Ptr Word8 -> Ptr Word8 -> Int
192+ -> IO (Maybe ByteString, URLPath)
193+parseUrl' fptr0 ptr0 begptr limptr len0 = do
194+ w0 <- peek begptr
195+ if w0 == _slash then do
196+ w1 <- peek $ begptr `plusPtr` 1
197+ if w1 == _slash then
198+ doubleSlashed begptr len0
199+ else
200+ slashed begptr len0 Nothing
201+ else do
202+ colonptr <- memchr begptr _colon $ fromIntegral len0
203+ if colonptr == nullPtr then
204+ return (Nothing, "")
205+ else do
206+ let !authptr = colonptr `plusPtr` 1
207+ doubleSlashed authptr (limptr `minusPtr` authptr)
208+ where
209+ -- // / ?
210+ doubleSlashed :: Ptr Word8 -> Int -> IO (Maybe ByteString, URLPath)
211+ doubleSlashed ptr len
212+ | len < 2 = return (Nothing, "")
213+ | otherwise = do
214+ let ptr1 = ptr `plusPtr` 2
215+ pathptr <- memchr ptr1 _slash $ fromIntegral len
216+ if pathptr == nullPtr then
217+ return (Nothing, "")
218+ else do
219+ let !auth = bs ptr0 ptr1 pathptr
220+ slashed pathptr (limptr `minusPtr` pathptr) (Just auth)
221+
222+ -- / ?
223+ slashed :: Ptr Word8 -> Int -> Maybe ByteString -> IO (Maybe ByteString, URLPath)
224+ slashed ptr len mauth = do
225+ questionptr <- memchr ptr _question $ fromIntegral len
226+ if questionptr == nullPtr then do
227+ let !path = bs ptr0 ptr limptr
228+ return (mauth, path)
229+ else do
230+ let !path = bs ptr0 ptr questionptr
231+ return (mauth, path)
232+ bs p0 p1 p2 = path
233+ where
234+ !off = p1 `minusPtr` p0
235+ !siz = p2 `minusPtr` p1
236+ !path = PS fptr0 off siz
wai-http2-extra/Network/Wai/Middleware/Push/Referer/LimitMultiMap.hsnew file+40
@@ -0,0 +1,40 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Middleware.Push.Referer.LimitMultiMap where
4+
5+import Data.Map (Map)
6+import qualified Data.Map.Strict as M
7+import Data.Set (Set)
8+import qualified Data.Set as S
9+
10+data LimitMultiMap k v = LimitMultiMap {
11+ limitKey :: !Int
12+ , limitVal :: !Int
13+ , multiMap :: !(Map k (Set v))
14+ } deriving (Eq, Show)
15+
16+isEmpty :: LimitMultiMap k t -> Bool
17+isEmpty (LimitMultiMap _ _ m) = M.null m
18+
19+empty :: Int -> Int -> LimitMultiMap k v
20+empty lk lv = LimitMultiMap lk lv M.empty
21+
22+insert :: (Ord k, Ord v) => (k,v) -> LimitMultiMap k v -> LimitMultiMap k v
23+insert (k,v) (LimitMultiMap lk lv m)
24+ | siz < lk = let !m' = M.alter alt k m in LimitMultiMap lk lv m'
25+ | siz == lk = let !m' = M.adjust adj k m in LimitMultiMap lk lv m'
26+ | otherwise = error "insert"
27+ where
28+ siz = M.size m
29+ alt Nothing = Just $ S.singleton v
30+ alt s@(Just set)
31+ | S.size set == lv = s
32+ | otherwise = Just $ S.insert v set
33+ adj set
34+ | S.size set == lv = set
35+ | otherwise = S.insert v set
36+
37+lookup :: Ord k => k -> LimitMultiMap k v -> [v]
38+lookup k (LimitMultiMap _ _ m) = case M.lookup k m of
39+ Nothing -> []
40+ Just set -> S.toList set
wai-http2-extra/test/doctests.hsnew file+4
@@ -0,0 +1,4 @@
1+import Test.DocTest
2+
3+main :: IO ()
4+main = doctest ["Network"]
wai-http2-extra/wai-http2-extra.cabalnew file+44
@@ -0,0 +1,44 @@
1+Name: wai-http2-extra
2+Version: 0.1.2
3+Synopsis: WAI utilities for HTTP/2
4+License: MIT
5+License-file: LICENSE
6+Author: Kazu Yamamoto
7+Maintainer: kazu@iij.ad.jp
8+Homepage: http://github.com/yesodweb/wai
9+Category: Web
10+Build-Type: Simple
11+Cabal-Version: >=1.10
12+Stability: Stable
13+Description: WAI utilities for HTTP/2
14+
15+Library
16+ Build-Depends: base >= 3 && < 5
17+ , auto-update >= 0.1.3 && < 0.2
18+ , bytestring
19+ , containers
20+ , http-types
21+ , wai
22+ , warp
23+ , word8
24+ Exposed-modules: Network.Wai.Middleware.Push.Referer
25+ Other-modules: Network.Wai.Middleware.Push.Referer.LimitMultiMap
26+ Ghc-Options: -Wall
27+ if impl(ghc >= 8)
28+ default-extensions: Strict StrictData
29+ default-language: Haskell2010
30+
31+Test-Suite doctest
32+ Type: exitcode-stdio-1.0
33+ HS-Source-Dirs: test
34+ Ghc-Options: -threaded -Wall
35+ Main-Is: doctests.hs
36+ Build-Depends: base
37+ , doctest >= 0.10.1
38+ if impl(ghc >= 8)
39+ default-extensions: Strict StrictData
40+ default-language: Haskell2010
41+
42+Source-Repository head
43+ Type: git
44+ Location: git://github.com/yesodweb/wai.git
wai-websockets/ChangeLog.mdnew file+27
@@ -0,0 +1,27 @@
1+## 3.0.1.2
2+
3+* Drop unused dependency on blaze-builder
4+
5+## 3.0.1.1
6+
7+* Doc improvement
8+
9+## 3.0.1
10+
11+* Improved connection close logic
12+
13+## 3.0.0.9
14+
15+* Clean up stream resources when websockets completes [#549](https://github.com/yesodweb/wai/pull/549)
16+
17+## 3.0.0.8
18+
19+* Support wai 3.2
20+
21+## 3.0.0.7
22+
23+* Improved documentation [#471](https://github.com/yesodweb/wai/pull/471)
24+
25+## 3.0.0.5
26+
27+Allow blaze-builder 0.4
wai-websockets/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-websockets/Network/Wai/Handler/WebSockets.hsnew file+118
@@ -0,0 +1,118 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Handler.WebSockets
3+ ( websocketsOr
4+ , websocketsApp
5+ , isWebSocketsReq
6+ , getRequestHead
7+ , runWebSockets
8+ ) where
9+
10+import Control.Exception (bracket, tryJust)
11+import Data.ByteString (ByteString)
12+import qualified Data.ByteString.Char8 as BC
13+import qualified Data.ByteString.Lazy as BL
14+import qualified Data.CaseInsensitive as CI
15+import Network.HTTP.Types (status500)
16+import qualified Network.Wai as Wai
17+import qualified Network.WebSockets as WS
18+import qualified Network.WebSockets.Connection as WS
19+import qualified Network.WebSockets.Stream as WS
20+
21+--------------------------------------------------------------------------------
22+-- | Returns whether or not the given 'Wai.Request' is a WebSocket request.
23+isWebSocketsReq :: Wai.Request -> Bool
24+isWebSocketsReq req =
25+ fmap CI.mk (lookup "upgrade" $ Wai.requestHeaders req) == Just "websocket"
26+
27+--------------------------------------------------------------------------------
28+-- | Upgrade a @websockets@ 'WS.ServerApp' to a @wai@ 'Wai.Application'. Uses
29+-- the given backup 'Wai.Application' to handle 'Wai.Request's that are not
30+-- WebSocket requests.
31+--
32+-- @
33+-- websocketsOr opts ws_app backup_app = \\req respond ->
34+-- __case__ 'websocketsApp' opts ws_app req __of__
35+-- 'Nothing' -> backup_app req send_response
36+-- 'Just' res -> respond res
37+-- @
38+--
39+-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
40+-- each connected client.
41+--
42+-- @
43+-- app :: 'Wai.Application'
44+-- app = 'websocketsOr' 'WS.defaultConnectionOptions' wsApp backupApp
45+-- __where__
46+-- wsApp :: 'WS.ServerApp'
47+-- wsApp pending_conn = do
48+-- conn <- 'WS.acceptRequest' pending_conn
49+-- 'WS.sendTextData' conn ("Hello, client!" :: 'Data.Text.Text')
50+--
51+-- backupApp :: 'Wai.Application'
52+-- backupApp _ respond = respond $ 'Wai.responseLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
53+-- @
54+websocketsOr :: WS.ConnectionOptions
55+ -> WS.ServerApp
56+ -> Wai.Application
57+ -> Wai.Application
58+websocketsOr opts app backup req sendResponse =
59+ case websocketsApp opts app req of
60+ Nothing -> backup req sendResponse
61+ Just res -> sendResponse res
62+
63+--------------------------------------------------------------------------------
64+-- | Handle a single @wai@ 'Wai.Request' with the given @websockets@
65+-- 'WS.ServerApp'. Returns 'Nothing' if the 'Wai.Request' is not a WebSocket
66+-- request, 'Just' otherwise.
67+--
68+-- Usually, 'websocketsOr' is more convenient.
69+websocketsApp :: WS.ConnectionOptions
70+ -> WS.ServerApp
71+ -> Wai.Request
72+ -> Maybe Wai.Response
73+websocketsApp opts app req
74+ | isWebSocketsReq req =
75+ Just $ flip Wai.responseRaw backup $ \src sink ->
76+ runWebSockets opts req' app src sink
77+ | otherwise = Nothing
78+ where
79+ req' = getRequestHead req
80+ backup = Wai.responseLBS status500 [("Content-Type", "text/plain")]
81+ "The web application attempted to send a WebSockets response, but WebSockets are not supported by your WAI handler."
82+
83+--------------------------------------------------------------------------------
84+getRequestHead :: Wai.Request -> WS.RequestHead
85+getRequestHead req = WS.RequestHead
86+ (Wai.rawPathInfo req `BC.append` Wai.rawQueryString req)
87+ (Wai.requestHeaders req)
88+ (Wai.isSecure req)
89+
90+--------------------------------------------------------------------------------
91+-- | Internal function to run the WebSocket io-streams using the conduit library.
92+runWebSockets :: WS.ConnectionOptions
93+ -> WS.RequestHead
94+ -> (WS.PendingConnection -> IO a)
95+ -> IO ByteString
96+ -> (ByteString -> IO ())
97+ -> IO a
98+runWebSockets opts req app src sink = bracket mkStream ensureClose (app . pc)
99+ where
100+ ensureClose = tryJust onConnectionException . WS.close
101+ onConnectionException :: WS.ConnectionException -> Maybe ()
102+ onConnectionException WS.ConnectionClosed = Just ()
103+ onConnectionException _ = Nothing
104+ mkStream =
105+ WS.makeStream
106+ (do
107+ bs <- src
108+ return $ if BC.null bs then Nothing else Just bs)
109+ (\mbBl -> case mbBl of
110+ Nothing -> return ()
111+ Just bl -> mapM_ sink (BL.toChunks bl))
112+
113+ pc stream = WS.PendingConnection
114+ { WS.pendingOptions = opts
115+ , WS.pendingRequest = req
116+ , WS.pendingOnAccept = \_ -> return ()
117+ , WS.pendingStream = stream
118+ }
wai-websockets/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## wai-websockets
2+
3+Use websockets with WAI applications, primarily those hosted via Warp.
wai-websockets/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
wai-websockets/server.lhsnew file+168
@@ -0,0 +1,168 @@
1+websockets example
2+==================
3+
4+This is the Haskell implementation of the example for the WebSockets library. We
5+implement a simple multi-user chat program. A live demo of the example is
6+available [here](http://jaspervdj.be/websockets-example). In order to understand
7+this example, keep the [reference](http://jaspervdj.be/websockets/reference)
8+nearby to check out the functions we use.
9+
10+> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
11+> {-# LANGUAGE CPP #-}
12+> {-# OPTIONS_GHC -Wno-unused-top-binds #-} -- for numClients
13+> import Data.Char (isPunctuation, isSpace)
14+> import Data.Monoid (mappend)
15+> import Data.Text (Text)
16+> import Control.Exception (finally)
17+> import Control.Monad (forM_, forever)
18+> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, modifyMVar)
19+> import Control.Monad.IO.Class (liftIO)
20+> import qualified Data.Text as T
21+> import qualified Data.Text.IO as T
22+> import qualified Network.WebSockets as WS
23+> import qualified Network.Wai
24+> import qualified Network.Wai.Handler.Warp as Warp
25+> import qualified Network.Wai.Handler.WebSockets as WaiWS
26+> import qualified Network.Wai.Application.Static as Static
27+> import Data.FileEmbed (embedDir)
28+
29+
30+We represent a client by their username and a `WS.Connection`. We will see how we
31+obtain this `WS.Connection` later on.
32+
33+> type Client = (Text, WS.Connection)
34+
35+The state kept on the server is simply a list of connected clients. We've added
36+an alias and some utility functions, so it will be easier to extend this state
37+later on.
38+
39+> type ServerState = [Client]
40+
41+Create a new, initial state:
42+
43+> newServerState :: ServerState
44+> newServerState = []
45+
46+Get the number of active clients:
47+
48+> numClients :: ServerState -> Int
49+> numClients = length
50+
51+Check if a user already exists (based on username):
52+
53+> clientExists :: Client -> ServerState -> Bool
54+> clientExists client = any ((== fst client) . fst)
55+
56+Add a client (this does not check if the client already exists, you should do
57+this yourself using `clientExists`):
58+
59+> addClient :: Client -> ServerState -> ServerState
60+> addClient client clients = client : clients
61+
62+Remove a client:
63+
64+> removeClient :: Client -> ServerState -> ServerState
65+> removeClient client = filter ((/= fst client) . fst)
66+
67+Send a message to all clients, and log it on stdout:
68+
69+> broadcast :: Text -> ServerState -> IO ()
70+> broadcast message clients = do
71+> T.putStrLn message
72+> forM_ clients $ \(_, conn) -> WS.sendTextData conn message
73+
74+The main function first creates a new state for the server, then spawns the
75+actual server.
76+
77+> main :: IO ()
78+> main = do
79+> putStrLn "http://localhost:9160/client.html"
80+> state <- newMVar newServerState
81+> Warp.runSettings
82+> (Warp.setPort 9160 Warp.defaultSettings)
83+> $ WaiWS.websocketsOr WS.defaultConnectionOptions (application state) staticApp
84+
85+> staticApp :: Network.Wai.Application
86+> staticApp = Static.staticApp $ Static.embeddedSettings $(embedDir "static")
87+
88+Our main application has the type:
89+
90+> application :: MVar ServerState -> WS.ServerApp
91+
92+Note that `WS.ServerApp` is nothing but a type synonym for
93+`WS.PendingConnection -> IO ()`.
94+
95+Our application starts by accepting the connection. In a more realistic
96+application, you probably want to check the path and headers provided by the
97+pending request.
98+
99+We also fork a pinging thread in the background. This will ensure the connection
100+stays alive on some browsers.
101+
102+> application state pending = do
103+> conn <- WS.acceptRequest pending
104+#if __GLASGOW_HASKELL__ >= 806
105+> WS.withPingThread conn 30 (return ()) $ do
106+#else
107+> WS.forkPingThread conn 30
108+#endif
109+
110+When a client is successfully connected, we read the first message. This should
111+be in the format of "Hi! I am Jasper", where Jasper is the requested username.
112+
113+> msg <- WS.receiveData conn
114+> clients <- liftIO $ readMVar state
115+> case msg of
116+
117+Check that the first message has the right format:
118+
119+> _ | not (prefix `T.isPrefixOf` msg) ->
120+> WS.sendTextData conn ("Wrong announcement" :: Text)
121+
122+Check the validity of the username:
123+
124+> | any ($ fst client)
125+> [T.null, T.any isPunctuation, T.any isSpace] ->
126+> WS.sendTextData conn ("Name cannot " `mappend`
127+> "contain punctuation or whitespace, and " `mappend`
128+> "cannot be empty" :: Text)
129+
130+Check that the given username is not already taken:
131+
132+> | clientExists client clients ->
133+> WS.sendTextData conn ("User already exists" :: Text)
134+
135+All is right! We're going to allow the client, but for safety reasons we *first*
136+setup a `disconnect` function that will be run when the exception is closed.
137+
138+> | otherwise -> flip finally disconnect $ do
139+
140+We send a "Welcome!", according to our own little protocol. We add the client to
141+the list and broadcast the fact that he has joined. Then, we give control to the
142+'talk' function.
143+
144+> liftIO $ modifyMVar_ state $ \s -> do
145+> let s' = addClient client s
146+> WS.sendTextData conn $
147+> "Welcome! Users: " `mappend`
148+> T.intercalate ", " (map fst s)
149+> broadcast (fst client `mappend` " joined") s'
150+> return s'
151+> talk conn state client
152+> where
153+> prefix = "Hi! I am "
154+> client = (T.drop (T.length prefix) msg, conn)
155+> disconnect = do
156+> -- Remove client and return new state
157+> s <- modifyMVar state $ \s ->
158+> let s' = removeClient client s in return (s', s')
159+> broadcast (fst client `mappend` " disconnected") s
160+
161+The talk function continues to read messages from a single client until he
162+disconnects. All messages are broadcasted to the other clients.
163+
164+> talk :: WS.Connection -> MVar ServerState -> Client -> IO ()
165+> talk conn state (user, _) = forever $ do
166+> msg <- WS.receiveData conn
167+> liftIO $ readMVar state >>= broadcast
168+> (user `mappend` ": " `mappend` msg)
wai-websockets/static/client.htmlnew file+41
@@ -0,0 +1,41 @@
1+<html>
2+ <head>
3+ <title>Haskell WebSockets example</title>
4+ <script src="//ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
5+ <script type="text/JavaScript" src="client.js"></script>
6+ <link rel="stylesheet" type="text/css" href="screen.css"></script>
7+ </head>
8+ <body>
9+ <h1>Haskell WebSockets example</h1>
10+ <div id="main">
11+ <div id="warnings">
12+ </div>
13+ <div id="join-section">
14+ <h2>Join</h2>
15+ <form id="join-form" action="">
16+ <label for="user">Username: </label>
17+ <input id="user" type="text" size="12" />
18+ <input id="send" type="submit" value="Join" />
19+ </form>
20+ </div>
21+ <div id="users-section" style="display: none">
22+ <h2>Users</h2>
23+ <ul id="users">
24+ </ul>
25+ </div>
26+ <div id="chat-section" style="display: none">
27+ <h2>Chat</h2>
28+ <div id="messages">
29+ </div>
30+ <br />
31+ <form id="message-form" action="">
32+ <input id="text" type="text" size="40" />
33+ <input id="send" type="submit" value="Send" />
34+ </form>
35+ </div>
36+ </div>
37+ <div id="footer">
38+ Source code available <a href="http://github.com/jaspervdj/websockets/tree/master/example">here</a>
39+ </div>
40+ </body>
41+</html>
wai-websockets/static/client.jsnew file+80
@@ -0,0 +1,80 @@
1+function createWebSocket(path) {
2+ var host = window.location.hostname;
3+ if(host == '') host = 'localhost';
4+ var uri = 'ws://' + host + ':9160' + path;
5+
6+ var Socket = "MozWebSocket" in window ? MozWebSocket : WebSocket;
7+ return new Socket(uri);
8+}
9+
10+var users = [];
11+
12+function refreshUsers() {
13+ $('#users').html('');
14+ for(i in users) {
15+ $('#users').append($(document.createElement('li')).text(users[i]));
16+ }
17+}
18+
19+function onMessage(event) {
20+ var p = $(document.createElement('p')).text(event.data);
21+
22+ $('#messages').append(p);
23+ $('#messages').animate({scrollTop: $('#messages')[0].scrollHeight});
24+
25+ if(event.data.match(/^[^:]* joined/)) {
26+ var user = event.data.replace(/ .*/, '');
27+ users.push(user);
28+ refreshUsers();
29+ }
30+
31+ if(event.data.match(/^[^:]* disconnected/)) {
32+ var user = event.data.replace(/ .*/, '');
33+ var idx = users.indexOf(user);
34+ users = users.slice(0, idx).concat(users.slice(idx + 1));
35+ refreshUsers();
36+ }
37+}
38+
39+$(document).ready(function () {
40+ $('#join-form').submit(function () {
41+ $('#warnings').html('');
42+ var user = $('#user').val();
43+ var ws = createWebSocket('/');
44+
45+ ws.onopen = function() {
46+ ws.send('Hi! I am ' + user);
47+ };
48+
49+ ws.onmessage = function(event) {
50+ if(event.data.match('^Welcome! Users: ')) {
51+ /* Calculate the list of initial users */
52+ var str = event.data.replace(/^Welcome! Users: /, '');
53+ if(str != "") {
54+ users = str.split(", ");
55+ refreshUsers();
56+ }
57+
58+ $('#join-section').hide();
59+ $('#chat-section').show();
60+ $('#users-section').show();
61+
62+ ws.onmessage = onMessage;
63+
64+ $('#message-form').submit(function () {
65+ var text = $('#text').val();
66+ ws.send(text);
67+ $('#text').val('');
68+ return false;
69+ });
70+ } else {
71+ $('#warnings').append(event.data);
72+ ws.close();
73+ }
74+ };
75+
76+ $('#join').append('Connecting...');
77+
78+ return false;
79+ });
80+});
wai-websockets/static/screen.cssnew file+86
@@ -0,0 +1,86 @@
1+html {
2+ font-family: sans-serif;
3+ background-color: #335;
4+ font-size: 16px;
5+}
6+
7+body {
8+}
9+
10+h1 {
11+ text-align: center;
12+ font-size: 20px;
13+ color: #fff;
14+ padding: 10px 10px 20px 10px;
15+}
16+
17+h2 {
18+ border-bottom: 1px solid black;
19+ display: block;
20+ font-size: 18px;
21+}
22+
23+div#main {
24+ width: 600px;
25+ margin: 0px auto 0px auto;
26+ padding: 0px;
27+ background-color: #fff;
28+ height: 460px;
29+}
30+
31+div#warnings {
32+ color: red;
33+ font-weight: bold;
34+ margin: 10px;
35+}
36+
37+div#join-section {
38+ float: left;
39+ margin: 10px;
40+}
41+
42+div#users-section {
43+ width: 170px;
44+ float: right;
45+ padding: 0px;
46+ margin: 10px;
47+}
48+
49+ul#users {
50+ list-style-type: none;
51+ padding-left: 0px;
52+ height: 300px;
53+ overflow: auto;
54+}
55+
56+div#chat-section {
57+ width: 390px;
58+ float: left;
59+ margin: 10px;
60+}
61+
62+div#messages {
63+ margin: 0px;
64+ height: 300px;
65+ overflow: auto;
66+}
67+
68+div#messages p {
69+ margin: 0px;
70+ padding: 0px;
71+}
72+
73+div#footer {
74+ text-align: center;
75+ font-size: 12px;
76+ color: #fff;
77+ margin: 10px 0px 30px 0px;
78+}
79+
80+div#footer a {
81+ color: #fff;
82+}
83+
84+div.clear {
85+ clear: both;
86+}
wai-websockets/wai-websockets.cabalnew file+57
@@ -0,0 +1,57 @@
1+Name: wai-websockets
2+Version: 3.0.1.2
3+Synopsis: Provide a bridge between WAI and the websockets package.
4+License: MIT
5+License-file: LICENSE
6+Author: Michael Snoyman, Jasper Van der Jeugt, Ting-Yen Lai
7+Maintainer: michael@snoyman.com
8+Homepage: http://github.com/yesodweb/wai
9+Category: Web, Yesod
10+Build-Type: Simple
11+Cabal-Version: >=1.8
12+Stability: Stable
13+description: API docs and the README are available at <http://www.stackage.org/package/wai-websockets>.
14+
15+extra-source-files: static/client.js, static/client.html, static/screen.css
16+ README.md ChangeLog.md
17+
18+flag example
19+
20+Library
21+ Build-Depends: base >= 3 && < 5
22+ , bytestring >= 0.9.1.4
23+ , wai >= 3.0 && < 3.3
24+ , case-insensitive >= 0.2
25+ , network >= 2.2.1.5
26+ , transformers >= 0.2
27+ , websockets >= 0.9
28+ , http-types
29+ Exposed-modules: Network.Wai.Handler.WebSockets
30+ ghc-options: -Wall
31+
32+Executable wai-websockets-example
33+ if flag(example)
34+ buildable: True
35+ Build-Depends: base >= 3 && < 5
36+ , wai-websockets
37+ , websockets
38+ , warp
39+ , wai
40+ , wai-app-static
41+ , bytestring
42+ , case-insensitive
43+ , transformers
44+ , network
45+ , text
46+ , file-embed
47+ , http-types
48+ other-modules: Network.Wai.Handler.WebSockets
49+ else
50+ buildable: False
51+
52+ ghc-options: -Wall -threaded
53+ main-is: server.lhs
54+
55+source-repository head
56+ type: git
57+ location: git://github.com/yesodweb/wai.git
wai/.ghcinew file+2
@@ -0,0 +1,2 @@
1+:set -optP-include -optPdist/build/autogen/cabal_macros.h -pgmL markdown-unlit
2+:set -i../warp -i../warp/dist/build/autogen/ -optP-include -optP../warp/dist/build/autogen/cabal_macros.h
wai/ChangeLog.mdnew file+56
@@ -0,0 +1,56 @@
1+# ChangeLog for wai
2+
3+## 3.2.2.1
4+
5+* Fix missing reexport of `getRequestBodyChunk` [#753](https://github.com/yesodweb/wai/issues/753)
6+
7+## 3.2.2
8+
9+* Deprecate `requestBody` in favor of the more clearly named `getRequestBodyChunk`. [#726](https://github.com/yesodweb/wai/pull/726)
10+
11+## 3.2.1.2
12+
13+* Remove dependency on blaze-builder [#683](https://github.com/yesodweb/wai/pull/683)
14+
15+## 3.2.1.1
16+
17+* Relax upper bound on bytestring-builder
18+
19+## 3.2.1
20+
21+* add mapResponseStatus [#532](https://github.com/yesodweb/wai/pull/532)
22+
23+## 3.2.0.1
24+
25+* Add missing changelog entry
26+
27+## 3.2.0
28+
29+* Major version up due to breaking changes. We chose 3.2.0, not 3.1.0
30+ for consistency with Warp 3.2.0.
31+* The Network.Wai.HTTP2 module was removed.
32+* tryGetFileSize, hContentRange, hAcceptRanges, contentRangeHeader and
33+ chooseFilePart, adjustForFilePart and parseByteRanges were removed
34+ from the Network.Wai.Internal module.
35+* New fields for Request: requestHeaderReferer and requestHeaderUserAgent.
36+
37+## 3.0.5.0
38+
39+* Avoid using the IsString Builder instance
40+
41+## 3.0.4.0
42+
43+* A new module Network.Wai.HTTP2 is exported.
44+
45+## 3.0.3.0
46+
47+* mapResponseHeaders, ifRequest and modifyResponse are exported.
48+
49+## 3.0.2.3
50+
51+* Allow blaze-builder 0.4
52+
53+## 3.0.2.2
54+
55+* Clarify some documentation on `rawPathInfo`. [Relevant Github
56+ discussion](https://github.com/yesodweb/wai/issues/325#issuecomment-69896780).
wai/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai/Network/Wai.hsnew file+348
@@ -0,0 +1,348 @@
1+{-|
2+
3+This module defines a generic web application interface. It is a common
4+protocol between web servers and web applications.
5+
6+The overriding design principles here are performance and generality. To
7+address performance, this library uses a streaming interface for request and
8+response bodies, paired with bytestring's 'Builder' type. The advantages of a
9+streaming API over lazy IO have been debated elsewhere and so will not be
10+addressed here. However, helper functions like 'responseLBS' allow you to
11+continue using lazy IO if you so desire.
12+
13+Generality is achieved by removing many variables commonly found in similar
14+projects that are not universal to all servers. The goal is that the 'Request'
15+object contains only data which is meaningful in all circumstances.
16+
17+Please remember when using this package that, while your application may
18+compile without a hitch against many different servers, there are other
19+considerations to be taken when moving to a new backend. For example, if you
20+transfer from a CGI application to a FastCGI one, you might suddenly find you
21+have a memory leak. Conversely, a FastCGI application would be well served to
22+preload all templates from disk when first starting; this would kill the
23+performance of a CGI application.
24+
25+This package purposely provides very little functionality. You can find various
26+middlewares, backends and utilities on Hackage. Some of the most commonly used
27+include:
28+
29+[warp] <http://hackage.haskell.org/package/warp>
30+
31+[wai-extra] <http://hackage.haskell.org/package/wai-extra>
32+
33+-}
34+-- Ignore deprecations, because this module needs to use the deprecated requestBody to construct a response.
35+{-# OPTIONS_GHC -fno-warn-deprecations #-}
36+module Network.Wai
37+ (
38+ -- * Types
39+ Application
40+ , Middleware
41+ , ResponseReceived
42+ -- * Request
43+ , Request
44+ , defaultRequest
45+ , RequestBodyLength (..)
46+ -- ** Request accessors
47+ , requestMethod
48+ , httpVersion
49+ , rawPathInfo
50+ , rawQueryString
51+ , requestHeaders
52+ , isSecure
53+ , remoteHost
54+ , pathInfo
55+ , queryString
56+ , getRequestBodyChunk
57+ , requestBody
58+ , vault
59+ , requestBodyLength
60+ , requestHeaderHost
61+ , requestHeaderRange
62+ , requestHeaderReferer
63+ , requestHeaderUserAgent
64+ , strictRequestBody
65+ , lazyRequestBody
66+ -- * Response
67+ , Response
68+ , StreamingBody
69+ , FilePart (..)
70+ -- ** Response composers
71+ , responseFile
72+ , responseBuilder
73+ , responseLBS
74+ , responseStream
75+ , responseRaw
76+ -- ** Response accessors
77+ , responseStatus
78+ , responseHeaders
79+ -- ** Response modifiers
80+ , responseToStream
81+ , mapResponseHeaders
82+ , mapResponseStatus
83+ -- * Middleware composition
84+ , ifRequest
85+ , modifyResponse
86+ ) where
87+
88+import Data.ByteString.Builder (Builder, lazyByteString)
89+import Data.ByteString.Builder (byteString)
90+import Control.Monad (unless)
91+import qualified Data.ByteString as B
92+import qualified Data.ByteString.Lazy as L
93+import qualified Data.ByteString.Lazy.Internal as LI
94+import Data.ByteString.Lazy.Internal (defaultChunkSize)
95+import Data.ByteString.Lazy.Char8 ()
96+import Data.Function (fix)
97+import qualified Network.HTTP.Types as H
98+import Network.Socket (SockAddr (SockAddrInet))
99+import Network.Wai.Internal
100+import qualified System.IO as IO
101+import System.IO.Unsafe (unsafeInterleaveIO)
102+
103+----------------------------------------------------------------
104+
105+-- | Creating 'Response' from a file.
106+responseFile :: H.Status -> H.ResponseHeaders -> FilePath -> Maybe FilePart -> Response
107+responseFile = ResponseFile
108+
109+-- | Creating 'Response' from 'Builder'.
110+--
111+-- Some questions and answers about the usage of 'Builder' here:
112+--
113+-- Q1. Shouldn't it be at the user's discretion to use Builders internally and
114+-- then create a stream of ByteStrings?
115+--
116+-- A1. That would be less efficient, as we wouldn't get cheap concatenation
117+-- with the response headers.
118+--
119+-- Q2. Isn't it really inefficient to convert from ByteString to Builder, and
120+-- then right back to ByteString?
121+--
122+-- A2. No. If the ByteStrings are small, then they will be copied into a larger
123+-- buffer, which should be a performance gain overall (less system calls). If
124+-- they are already large, then an insert operation is used
125+-- to avoid copying.
126+--
127+-- Q3. Doesn't this prevent us from creating comet-style servers, since data
128+-- will be cached?
129+--
130+-- A3. You can force a Builder to output a ByteString before it is an
131+-- optimal size by sending a flush command.
132+responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
133+responseBuilder = ResponseBuilder
134+
135+-- | Creating 'Response' from 'L.ByteString'. This is a wrapper for
136+-- 'responseBuilder'.
137+responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
138+responseLBS s h = ResponseBuilder s h . lazyByteString
139+
140+-- | Creating 'Response' from a stream of values.
141+--
142+-- In order to allocate resources in an exception-safe manner, you can use the
143+-- @bracket@ pattern outside of the call to @responseStream@. As a trivial
144+-- example:
145+--
146+-- @
147+-- app :: Application
148+-- app req respond = bracket_
149+-- (putStrLn \"Allocating scarce resource\")
150+-- (putStrLn \"Cleaning up\")
151+-- $ respond $ responseStream status200 [] $ \\write flush -> do
152+-- write $ byteString \"Hello\\n\"
153+-- flush
154+-- write $ byteString \"World\\n\"
155+-- @
156+--
157+-- Note that in some cases you can use @bracket@ from inside @responseStream@
158+-- as well. However, placing the call on the outside allows your status value
159+-- and response headers to depend on the scarce resource.
160+--
161+-- Since 3.0.0
162+responseStream :: H.Status
163+ -> H.ResponseHeaders
164+ -> StreamingBody
165+ -> Response
166+responseStream = ResponseStream
167+
168+-- | Create a response for a raw application. This is useful for \"upgrade\"
169+-- situations such as WebSockets, where an application requests for the server
170+-- to grant it raw network access.
171+--
172+-- This function requires a backup response to be provided, for the case where
173+-- the handler in question does not support such upgrading (e.g., CGI apps).
174+--
175+-- In the event that you read from the request body before returning a
176+-- @responseRaw@, behavior is undefined.
177+--
178+-- Since 2.1.0
179+responseRaw :: (IO B.ByteString -> (B.ByteString -> IO ()) -> IO ())
180+ -> Response
181+ -> Response
182+responseRaw = ResponseRaw
183+
184+----------------------------------------------------------------
185+
186+-- | Accessing 'H.Status' in 'Response'.
187+responseStatus :: Response -> H.Status
188+responseStatus (ResponseFile s _ _ _) = s
189+responseStatus (ResponseBuilder s _ _ ) = s
190+responseStatus (ResponseStream s _ _ ) = s
191+responseStatus (ResponseRaw _ res ) = responseStatus res
192+
193+-- | Accessing 'H.ResponseHeaders' in 'Response'.
194+responseHeaders :: Response -> H.ResponseHeaders
195+responseHeaders (ResponseFile _ hs _ _) = hs
196+responseHeaders (ResponseBuilder _ hs _ ) = hs
197+responseHeaders (ResponseStream _ hs _ ) = hs
198+responseHeaders (ResponseRaw _ res) = responseHeaders res
199+
200+-- | Converting the body information in 'Response' to a 'StreamingBody'.
201+responseToStream :: Response
202+ -> ( H.Status
203+ , H.ResponseHeaders
204+ , (StreamingBody -> IO a) -> IO a
205+ )
206+responseToStream (ResponseStream s h b) = (s, h, ($ b))
207+responseToStream (ResponseFile s h fp (Just part)) =
208+ ( s
209+ , h
210+ , \withBody -> IO.withBinaryFile fp IO.ReadMode $ \handle -> withBody $ \sendChunk _flush -> do
211+ IO.hSeek handle IO.AbsoluteSeek $ filePartOffset part
212+ let loop remaining | remaining <= 0 = return ()
213+ loop remaining = do
214+ bs <- B.hGetSome handle defaultChunkSize
215+ unless (B.null bs) $ do
216+ let x = B.take remaining bs
217+ sendChunk $ byteString x
218+ loop $ remaining - B.length x
219+ loop $ fromIntegral $ filePartByteCount part
220+ )
221+responseToStream (ResponseFile s h fp Nothing) =
222+ ( s
223+ , h
224+ , \withBody -> IO.withBinaryFile fp IO.ReadMode $ \handle ->
225+ withBody $ \sendChunk _flush -> fix $ \loop -> do
226+ bs <- B.hGetSome handle defaultChunkSize
227+ unless (B.null bs) $ do
228+ sendChunk $ byteString bs
229+ loop
230+ )
231+responseToStream (ResponseBuilder s h b) =
232+ (s, h, \withBody -> withBody $ \sendChunk _flush -> sendChunk b)
233+responseToStream (ResponseRaw _ res) = responseToStream res
234+
235+-- | Apply the provided function to the response header list of the Response.
236+mapResponseHeaders :: (H.ResponseHeaders -> H.ResponseHeaders) -> Response -> Response
237+mapResponseHeaders f (ResponseFile s h b1 b2) = ResponseFile s (f h) b1 b2
238+mapResponseHeaders f (ResponseBuilder s h b) = ResponseBuilder s (f h) b
239+mapResponseHeaders f (ResponseStream s h b) = ResponseStream s (f h) b
240+mapResponseHeaders _ r@(ResponseRaw _ _) = r
241+
242+-- | Apply the provided function to the response status of the Response.
243+mapResponseStatus :: (H.Status -> H.Status) -> Response -> Response
244+mapResponseStatus f (ResponseFile s h b1 b2) = ResponseFile (f s) h b1 b2
245+mapResponseStatus f (ResponseBuilder s h b) = ResponseBuilder (f s) h b
246+mapResponseStatus f (ResponseStream s h b) = ResponseStream (f s) h b
247+mapResponseStatus _ r@(ResponseRaw _ _) = r
248+
249+----------------------------------------------------------------
250+
251+-- | The WAI application.
252+--
253+-- Note that, since WAI 3.0, this type is structured in continuation passing
254+-- style to allow for proper safe resource handling. This was handled in the
255+-- past via other means (e.g., @ResourceT@). As a demonstration:
256+--
257+-- @
258+-- app :: Application
259+-- app req respond = bracket_
260+-- (putStrLn \"Allocating scarce resource\")
261+-- (putStrLn \"Cleaning up\")
262+-- (respond $ responseLBS status200 [] \"Hello World\")
263+-- @
264+type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
265+
266+
267+-- | A default, blank request.
268+--
269+-- Since 2.0.0
270+defaultRequest :: Request
271+defaultRequest = Request
272+ { requestMethod = H.methodGet
273+ , httpVersion = H.http10
274+ , rawPathInfo = B.empty
275+ , rawQueryString = B.empty
276+ , requestHeaders = []
277+ , isSecure = False
278+ , remoteHost = SockAddrInet 0 0
279+ , pathInfo = []
280+ , queryString = []
281+ , requestBody = return B.empty
282+ , vault = mempty
283+ , requestBodyLength = KnownLength 0
284+ , requestHeaderHost = Nothing
285+ , requestHeaderRange = Nothing
286+ , requestHeaderReferer = Nothing
287+ , requestHeaderUserAgent = Nothing
288+ }
289+
290+
291+-- | Middleware is a component that sits between the server and application. It
292+-- can do such tasks as GZIP encoding or response caching. What follows is the
293+-- general definition of middleware, though a middleware author should feel
294+-- free to modify this.
295+--
296+-- As an example of an alternate type for middleware, suppose you write a
297+-- function to load up session information. The session information is simply a
298+-- string map \[(String, String)\]. A logical type signature for this middleware
299+-- might be:
300+--
301+-- @ loadSession :: ([(String, String)] -> Application) -> Application @
302+--
303+-- Here, instead of taking a standard 'Application' as its first argument, the
304+-- middleware takes a function which consumes the session information as well.
305+type Middleware = Application -> Application
306+
307+
308+-- | apply a function that modifies a response as a 'Middleware'
309+modifyResponse :: (Response -> Response) -> Middleware
310+modifyResponse f app req respond = app req $ respond . f
311+
312+
313+-- | conditionally apply a 'Middleware'
314+ifRequest :: (Request -> Bool) -> Middleware -> Middleware
315+ifRequest rpred middle app req | rpred req = middle app req
316+ | otherwise = app req
317+
318+
319+
320+-- | Get the request body as a lazy ByteString. However, do /not/ use any lazy
321+-- I\/O, instead reading the entire body into memory strictly.
322+--
323+-- Since 3.0.1
324+strictRequestBody :: Request -> IO L.ByteString
325+strictRequestBody req =
326+ loop id
327+ where
328+ loop front = do
329+ bs <- getRequestBodyChunk req
330+ if B.null bs
331+ then return $ front LI.Empty
332+ else loop (front . LI.Chunk bs)
333+
334+-- | Get the request body as a lazy ByteString. This uses lazy I\/O under the
335+-- surface, and therefore all typical warnings regarding lazy I/O apply.
336+--
337+-- Since 1.4.1
338+lazyRequestBody :: Request -> IO L.ByteString
339+lazyRequestBody req =
340+ loop
341+ where
342+ loop = unsafeInterleaveIO $ do
343+ bs <- getRequestBodyChunk req
344+ if B.null bs
345+ then return LI.Empty
346+ else do
347+ bss <- loop
348+ return $ LI.Chunk bs bss
wai/Network/Wai/Internal.hsnew file+161
@@ -0,0 +1,161 @@
1+{-# OPTIONS_HADDOCK not-home #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE RecordWildCards #-}
4+-- | Internal constructors and helper functions. Note that no guarantees are
5+-- given for stability of these interfaces.
6+module Network.Wai.Internal where
7+
8+import Data.ByteString.Builder (Builder)
9+import qualified Data.ByteString as B hiding (pack)
10+import Data.Text (Text)
11+import Data.Typeable (Typeable)
12+import Data.Vault.Lazy (Vault)
13+import Data.Word (Word64)
14+import qualified Network.HTTP.Types as H
15+import Network.Socket (SockAddr)
16+import Data.List (intercalate)
17+
18+-- | Information on the request sent by the client. This abstracts away the
19+-- details of the underlying implementation.
20+{-# DEPRECATED requestBody "requestBody's name is misleading because it only gets a partial chunk of the body. Use getRequestBodyChunk instead." #-}
21+data Request = Request {
22+ -- | Request method such as GET.
23+ requestMethod :: H.Method
24+ -- | HTTP version such as 1.1.
25+ , httpVersion :: H.HttpVersion
26+ -- | Extra path information sent by the client. The meaning varies slightly
27+ -- depending on backend; in a standalone server setting, this is most likely
28+ -- all information after the domain name. In a CGI application, this would be
29+ -- the information following the path to the CGI executable itself.
30+ --
31+ -- Middlewares and routing tools should not modify this raw value, as it may
32+ -- be used for such things as creating redirect destinations by applications.
33+ -- Instead, if you are writing a middleware or routing framework, modify the
34+ -- @pathInfo@ instead. This is the approach taken by systems like Yesod
35+ -- subsites.
36+ --
37+ -- /Note/: At the time of writing this documentation, there is at least one
38+ -- system (@Network.Wai.UrlMap@ from @wai-extra@) that does not follow the
39+ -- above recommendation. Therefore, it is recommended that you test the
40+ -- behavior of your application when using @rawPathInfo@ and any form of
41+ -- library that might modify the @Request@.
42+ , rawPathInfo :: B.ByteString
43+ -- | If no query string was specified, this should be empty. This value
44+ -- /will/ include the leading question mark.
45+ -- Do not modify this raw value - modify queryString instead.
46+ , rawQueryString :: B.ByteString
47+ -- | A list of headers (a pair of key and value) in an HTTP request.
48+ , requestHeaders :: H.RequestHeaders
49+ -- | Was this request made over an SSL connection?
50+ --
51+ -- Note that this value will /not/ tell you if the client originally made
52+ -- this request over SSL, but rather whether the current connection is SSL.
53+ -- The distinction lies with reverse proxies. In many cases, the client will
54+ -- connect to a load balancer over SSL, but connect to the WAI handler
55+ -- without SSL. In such a case, 'isSecure' will be 'False', but from a user
56+ -- perspective, there is a secure connection.
57+ , isSecure :: Bool
58+ -- | The client\'s host information.
59+ , remoteHost :: SockAddr
60+ -- | Path info in individual pieces - the URL without a hostname/port and
61+ -- without a query string, split on forward slashes.
62+ , pathInfo :: [Text]
63+ -- | Parsed query string information.
64+ , queryString :: H.Query
65+ -- | Get the next chunk of the body. Returns 'B.empty' when the
66+ -- body is fully consumed. Since 3.2.2, this is deprecated in favor of 'getRequestBodyChunk'.
67+ , requestBody :: IO B.ByteString
68+ -- | A location for arbitrary data to be shared by applications and middleware.
69+ , vault :: Vault
70+ -- | The size of the request body. In the case of a chunked request body,
71+ -- this may be unknown.
72+ --
73+ -- Since 1.4.0
74+ , requestBodyLength :: RequestBodyLength
75+ -- | The value of the Host header in a HTTP request.
76+ --
77+ -- Since 2.0.0
78+ , requestHeaderHost :: Maybe B.ByteString
79+ -- | The value of the Range header in a HTTP request.
80+ --
81+ -- Since 2.0.0
82+ , requestHeaderRange :: Maybe B.ByteString
83+ -- | The value of the Referer header in a HTTP request.
84+ --
85+ -- Since 3.2.0
86+ , requestHeaderReferer :: Maybe B.ByteString
87+ -- | The value of the User-Agent header in a HTTP request.
88+ --
89+ -- Since 3.2.0
90+ , requestHeaderUserAgent :: Maybe B.ByteString
91+ }
92+ deriving (Typeable)
93+
94+-- | Get the next chunk of the body. Returns 'B.empty' when the
95+-- body is fully consumed.
96+--
97+-- @since 3.2.2
98+getRequestBodyChunk :: Request -> IO B.ByteString
99+getRequestBodyChunk = requestBody
100+
101+instance Show Request where
102+ show Request{..} = "Request {" ++ intercalate ", " [a ++ " = " ++ b | (a,b) <- fields] ++ "}"
103+ where
104+ fields =
105+ [("requestMethod",show requestMethod)
106+ ,("httpVersion",show httpVersion)
107+ ,("rawPathInfo",show rawPathInfo)
108+ ,("rawQueryString",show rawQueryString)
109+ ,("requestHeaders",show requestHeaders)
110+ ,("isSecure",show isSecure)
111+ ,("remoteHost",show remoteHost)
112+ ,("pathInfo",show pathInfo)
113+ ,("queryString",show queryString)
114+ ,("requestBody","<IO ByteString>")
115+ ,("vault","<Vault>")
116+ ,("requestBodyLength",show requestBodyLength)
117+ ,("requestHeaderHost",show requestHeaderHost)
118+ ,("requestHeaderRange",show requestHeaderRange)
119+ ]
120+
121+
122+data Response
123+ = ResponseFile H.Status H.ResponseHeaders FilePath (Maybe FilePart)
124+ | ResponseBuilder H.Status H.ResponseHeaders Builder
125+ | ResponseStream H.Status H.ResponseHeaders StreamingBody
126+ | ResponseRaw (IO B.ByteString -> (B.ByteString -> IO ()) -> IO ()) Response
127+ deriving Typeable
128+
129+-- | Represents a streaming HTTP response body. It's a function of two
130+-- parameters; the first parameter provides a means of sending another chunk of
131+-- data, and the second parameter provides a means of flushing the data to the
132+-- client.
133+--
134+-- Since 3.0.0
135+type StreamingBody = (Builder -> IO ()) -> IO () -> IO ()
136+
137+-- | The size of the request body. In the case of chunked bodies, the size will
138+-- not be known.
139+--
140+-- Since 1.4.0
141+data RequestBodyLength = ChunkedBody | KnownLength Word64 deriving Show
142+
143+-- | Information on which part to be sent.
144+-- Sophisticated application handles Range (and If-Range) then
145+-- create 'FilePart'.
146+data FilePart = FilePart
147+ { filePartOffset :: Integer
148+ , filePartByteCount :: Integer
149+ , filePartFileSize :: Integer
150+ } deriving Show
151+
152+-- | A special datatype to indicate that the WAI handler has received the
153+-- response. This is to avoid the need for Rank2Types in the definition of
154+-- Application.
155+--
156+-- It is /highly/ advised that only WAI handlers import and use the data
157+-- constructor for this data type.
158+--
159+-- Since 3.0.0
160+data ResponseReceived = ResponseReceived
161+ deriving Typeable
wai/README.lhsnew file+1
@@ -0,0 +1 @@
1+README.md
wai/README.mdnew file+116
@@ -0,0 +1,116 @@
1+WAI: Web Application Interface
2+==============================
3+
4+Getting started
5+---------------
6+
7+You want a minimal example? Here it is!
8+
9+~~~ {.haskell}
10+{-# LANGUAGE OverloadedStrings #-}
11+import Network.Wai
12+import Network.HTTP.Types
13+import Network.Wai.Handler.Warp (run)
14+
15+app :: Application
16+app _ respond = do
17+ putStrLn "I've done some IO here"
18+ respond $ responseLBS
19+ status200
20+ [("Content-Type", "text/plain")]
21+ "Hello, Web!"
22+
23+main :: IO ()
24+main = do
25+ putStrLn $ "http://localhost:8080/"
26+ run 8080 app
27+~~~
28+
29+Put that code into a file named _hello.hs_ and install [wai] and [warp] from Hackage:
30+
31+ cabal install wai warp
32+
33+Run it:
34+
35+ runhaskell hello.hs
36+
37+Point your browser to:
38+
39+ http://localhost:8080/
40+
41+
42+Serving static content
43+----------------------
44+
45+We can modify our previous example to serve static content. For this create a file named _index.html_:
46+
47+ <p>Hello, Web!</p>
48+
49+Now we redefine `responseBody` to refer to that file:
50+
51+~~~ {.haskell}
52+app2 :: Application
53+app2 _ respond = respond index
54+
55+index :: Response
56+index = responseFile
57+ status200
58+ [("Content-Type", "text/html")]
59+ "index.html"
60+ Nothing
61+~~~
62+
63+
64+Basic dispatching
65+-----------------
66+
67+An `Application` maps `Request`s to `Response`s:
68+
69+ ghci> :info Application
70+ type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
71+
72+Depending on the path info provided with each `Request` we can serve different `Response`s:
73+
74+~~~ {.haskell}
75+app3 :: Application
76+app3 request respond = respond $ case rawPathInfo request of
77+ "/" -> index
78+ "/raw/" -> plainIndex
79+ _ -> notFound
80+
81+plainIndex :: Response
82+plainIndex = responseFile
83+ status200
84+ [("Content-Type", "text/plain")]
85+ "index.html"
86+ Nothing
87+
88+notFound :: Response
89+notFound = responseLBS
90+ status404
91+ [("Content-Type", "text/plain")]
92+ "404 - Not Found"
93+~~~
94+
95+
96+Doing without overloaded strings
97+--------------------------------
98+
99+For the sake of efficiency, WAI uses the [bytestring] package. We used GHCs [overloaded strings] to almost hide this fact. But we can easily do without. What follows is a more verbose definition of `notFound`, that works without GHC extensions:
100+
101+~~~ {.haskell .ignore}
102+import qualified Data.ByteString.Char8 as B8
103+import qualified Data.ByteString.Lazy.Char8 as LB8
104+import Data.CaseInsensitive (mk)
105+
106+notFound = responseLBS
107+ status404
108+ [(mk $ B8.pack "Content-Type", B8.pack "text/plain")]
109+ (LB8.pack "404 - Not Found")
110+~~~
111+
112+
113+ [wai]: http://hackage.haskell.org/package/wai
114+ [warp]: http://hackage.haskell.org/package/warp
115+ [overloaded strings]: http://www.haskell.org/ghc/docs/latest/html/users_guide/type-class-extensions.html#overloaded-strings
116+ [bytestring]: http://hackage.haskell.org/package/bytestring
wai/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
wai/test/Network/WaiSpec.hsnew file+82
@@ -0,0 +1,82 @@
1+module Network.WaiSpec (spec) where
2+
3+import Test.Hspec
4+import Test.Hspec.QuickCheck (prop)
5+import Network.Wai
6+import Data.IORef
7+import qualified Data.ByteString as S
8+import qualified Data.ByteString.Lazy as L
9+import Data.ByteString.Builder (Builder, toLazyByteString, word8)
10+import Control.Monad (forM_)
11+
12+spec :: Spec
13+spec = do
14+ describe "responseToStream" $ do
15+ let getBody res = do
16+ let (_, _, f) = responseToStream res
17+ f $ \streamingBody -> do
18+ builderRef <- newIORef mempty
19+ let add :: Builder -> IO ()
20+ add b = atomicModifyIORef builderRef $ \builder ->
21+ (builder `mappend` b, ())
22+ flush :: IO ()
23+ flush = return ()
24+ streamingBody add flush
25+ fmap (L.toStrict . toLazyByteString) $ readIORef builderRef
26+ prop "responseLBS" $ \bytes -> do
27+ body <- getBody $ responseLBS undefined undefined $ L.pack bytes
28+ body `shouldBe` S.pack bytes
29+ prop "responseBuilder" $ \bytes -> do
30+ body <- getBody $ responseBuilder undefined undefined
31+ $ mconcat $ map word8 bytes
32+ body `shouldBe` S.pack bytes
33+ prop "responseStream" $ \chunks -> do
34+ body <- getBody $ responseStream undefined undefined $ \sendChunk _ ->
35+ forM_ chunks $ \chunk -> sendChunk $ mconcat $ map word8 chunk
36+ body `shouldBe` S.concat (map S.pack chunks)
37+ it "responseFile total" $ do
38+ let fp = "wai.cabal"
39+ body <- getBody $ responseFile undefined undefined fp Nothing
40+ expected <- S.readFile fp
41+ body `shouldBe` expected
42+ prop "responseFile partial" $ \offset' count' -> do
43+ let fp = "wai.cabal"
44+ totalBS <- S.readFile fp
45+ let total = S.length totalBS
46+ offset = abs offset' `mod` total
47+ count = abs count' `mod` (total - offset)
48+ body <- getBody $ responseFile undefined undefined fp $ Just FilePart
49+ { filePartOffset = fromIntegral offset
50+ , filePartByteCount = fromIntegral count
51+ , filePartFileSize = fromIntegral total
52+ }
53+ let expected = S.take count $ S.drop offset totalBS
54+ body `shouldBe` expected
55+ describe "lazyRequestBody" $ do
56+ prop "works" $ \chunks -> do
57+ ref <- newIORef $ map S.pack $ filter (not . null) chunks
58+ let req = defaultRequest
59+ { requestBody = atomicModifyIORef ref $ \bss ->
60+ case bss of
61+ [] -> ([], S.empty)
62+ x:y -> (y, x)
63+ }
64+ body <- lazyRequestBody req
65+ body `shouldBe` L.fromChunks (map S.pack chunks)
66+ it "is lazy" $ do
67+ let req = defaultRequest
68+ { requestBody = error "requestBody"
69+ }
70+ _ <- lazyRequestBody req
71+ return ()
72+ describe "strictRequestBody" $ do
73+ prop "works" $ \chunks -> do
74+ ref <- newIORef $ map S.pack $ filter (not . null) chunks
75+ let req = defaultRequest
76+ { requestBody = atomicModifyIORef ref $ \bss ->
77+ case bss of
78+ [] -> ([], S.empty)
79+ x:y -> (y, x)
80+ }
81+ body <- strictRequestBody req
82+ body `shouldBe` L.fromChunks (map S.pack chunks)
wai/test/Spec.hsnew file+1
@@ -0,0 +1 @@
1+{-# OPTIONS_GHC -F -pgmF hspec-discover #-}
wai/wai.cabalnew file+48
@@ -0,0 +1,48 @@
1+Name: wai
2+Version: 3.2.2.1
3+Synopsis: Web Application Interface.
4+Description: Provides a common protocol for communication between web applications and web servers.
5+ .
6+ API docs and the README are available at <http://www.stackage.org/package/wai>.
7+License: MIT
8+License-file: LICENSE
9+Author: Michael Snoyman
10+Maintainer: michael@snoyman.com
11+Homepage: https://github.com/yesodweb/wai
12+Category: Web
13+Build-Type: Simple
14+Cabal-Version: >=1.8
15+Stability: Stable
16+extra-source-files: README.md ChangeLog.md
17+
18+Source-repository head
19+ type: git
20+ location: git://github.com/yesodweb/wai.git
21+
22+Library
23+ Build-Depends: base >= 4.8 && < 5
24+ , bytestring >= 0.10.4
25+ , network >= 2.2.1.5
26+ , http-types >= 0.7
27+ , text >= 0.7
28+ , vault >= 0.3 && < 0.4
29+ Exposed-modules: Network.Wai
30+ Network.Wai.Internal
31+ ghc-options: -Wall
32+
33+test-suite test
34+ hs-source-dirs: test
35+ main-is: Spec.hs
36+ type: exitcode-stdio-1.0
37+ ghc-options: -threaded -Wall
38+ cpp-options: -DTEST
39+ build-depends: base >= 4.8 && < 5
40+ , wai
41+ , hspec
42+ , bytestring
43+ other-modules: Network.WaiSpec
44+ build-tool-depends: hspec-discover:hspec-discover
45+
46+source-repository head
47+ type: git
48+ location: git://github.com/yesodweb/wai.git
wai/webkit-sample/index.htmlnew file+17
@@ -0,0 +1,17 @@
1+<!DOCTYPE html>
2+<html>
3+ <head>
4+ <title>WAI Test Page!</title>
5+ <meta charset="utf-8">
6+ </head>
7+ <body>
8+ <p>It works</p>
9+ <p>Here's some Unicode stuff: שלום</p>
10+ <form method="POST" action="/post/" enctype="multipart/form-data">
11+ <p>Name: <input type="text" name="name"></p>
12+ <textarea name="textarea"></textarea>
13+ <p>Some file: <input type="file" name="file"></p>
14+ <p><input type="submit"></p>
15+ </form>
16+ </body>
17+</html>
wai/webkit-sample/webkit-sample.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE Rank2Types #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+import Network.Wai
4+import Network.Wai.Handler.Webkit
5+import Data.ByteString (ByteString)
6+import qualified Data.ByteString.Lazy as L
7+import Data.Enumerator (consume, Iteratee)
8+import Data.ByteString.Builder (lazyByteString)
9+
10+main :: IO ()
11+main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
12+
13+app :: Application
14+app req = case pathInfo req of
15+ "/post/" -> do
16+ bss <- consume
17+ postResponse $ L.fromChunks bss
18+ _ -> indexResponse
19+
20+indexResponse :: Iteratee ByteString IO Response
21+indexResponse = return $ ResponseFile
22+ status200
23+ [("Content-Type" , "text/html")]
24+ "index.html"
25+
26+postResponse :: L.ByteString -> Iteratee ByteString IO Response
27+postResponse lbs = return $ ResponseBuilder
28+ status200
29+ [("Content-Type", "text/plain")]
30+ (lazyByteString lbs)
warp-tls/ChangeLog.mdnew file+117
@@ -0,0 +1,117 @@
1+## 3.2.11
2+
3+* Ignoring an exception from shutdown (gracefulClose).
4+
5+## 3.2.10
6+
7+* Passing client certificate, if any, to Warp
8+ [#783](https://github.com/yesodweb/wai/pull/783)
9+
10+## 3.2.9
11+
12+* Cooperating setGracefulCloseTimeout1 and setGracefulCloseTimeout2 of Warp.
13+ [#782](https://github.com/yesodweb/wai/pull/782)
14+
15+## 3.2.8
16+
17+* Using gracefullClose of network 3.1.1 or later if available.
18+
19+## 3.2.7
20+
21+* Relaxing version constraint.
22+
23+## 3.2.6
24+
25+* Using the Strict and StrictData language extensions for GHC >8.
26+ [#752](https://github.com/yesodweb/wai/pull/752)
27+
28+## 3.2.5
29+
30+* When tls 1.5.0 is available, TLS 1.3 is automatically supported.
31+
32+## 3.2.4.3
33+
34+* Using warp >= 3.2.17.
35+
36+## 3.2.4.2
37+
38+* Ignore socket errors while sending `close_notify` [#640](https://github.com/yesodweb/wai/issues/640)
39+
40+## 3.2.4
41+
42+* Using tls-session-manager.
43+
44+## 3.2.3
45+
46+* Stop using obsoleted APIs of network.
47+
48+## 3.2.2
49+
50+* New settting parameter: tlsServerDHEParams [#556](https://github.com/yesodweb/wai/pull/556)
51+* Preventing socket leakage [#559](https://github.com/yesodweb/wai/pull/559)
52+
53+## 3.2.1
54+
55+* Removing dependency to cprng-aes.
56+
57+## 3.2.0
58+
59+* Major version up due to breaking changes.
60+* runHTTP2TLS and runHTTP2TLSSocket were removed.
61+
62+## 3.1.4
63+
64+* Add an option to disable HTTP2 [#450](https://github.com/yesodweb/wai/pull/450)
65+
66+## 3.1.3
67+
68+* Removing SHA 512 and SHA 384 from supportedCiphers to rescue Safari and golang. [#429](https://github.com/yesodweb/wai/issues/429)
69+
70+## 3.1.2
71+
72+* [Getting Rating A from the SSL Server Test](http://www.yesodweb.com/blog/2015/08/ssl-server-test)
73+
74+## 3.1.1
75+
76+* Converting "send: resource vanished (Broken pipe)" to ConnectionClosedByPeer. [#421](https://github.com/yesodweb/wai/issues/421)
77+
78+## 3.1.0
79+
80+* Supporting HTTP/2 [#399](https://github.com/yesodweb/wai/pull/399)
81+* Removing RC4 [#400](https://github.com/yesodweb/wai/issues/400)
82+
83+## 3.0.4.2
84+
85+* tls 1.3 support [#390](https://github.com/yesodweb/wai/issues/390)
86+
87+## 3.0.4.1
88+
89+* Fix for leaked FDs [#378](https://github.com/yesodweb/wai/issues/378)
90+
91+## 3.0.4
92+
93+* Replace `acceptSafe` with `accept`, see [#361](https://github.com/yesodweb/wai/issues/361)
94+
95+## 3.0.3
96+
97+* Support chain certs [#349](https://github.com/yesodweb/wai/pull/349)
98+
99+## 3.0.2
100+
101+* Allow warp-tls to request client certificates. [#337](https://github.com/yesodweb/wai/pull/337)
102+
103+## 3.0.1.4
104+
105+Add additional Diffie-Hellman RSA and DSA ciphers to warp-tls.
106+
107+## 3.0.1.3
108+
109+[Unable to allow insecure connections with warp-tls #324](https://github.com/yesodweb/wai/issues/324)
110+
111+## 3.0.1.2
112+
113+[Make sure Timer is tickled in sendfile. #323](https://github.com/yesodweb/wai/pull/323)
114+
115+## 3.0.1
116+
117+[Support for in-memory certificates and keys](https://github.com/yesodweb/wai/issues/301)
warp-tls/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
warp-tls/Network/Wai/Handler/WarpTLS.hsnew file+531
@@ -0,0 +1,531 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE DeriveDataTypeable #-}
6+{-# LANGUAGE PatternGuards #-}
7+
8+-- | HTTP over TLS support for Warp via the TLS package.
9+--
10+-- If HTTP\/2 is negotiated by ALPN, HTTP\/2 over TLS is used.
11+-- Otherwise HTTP\/1.1 over TLS is used.
12+--
13+-- Support for SSL is now obsoleted.
14+
15+module Network.Wai.Handler.WarpTLS (
16+ -- * Settings
17+ TLSSettings
18+ , defaultTlsSettings
19+ -- * Smart constructors
20+ , tlsSettings
21+ , tlsSettingsMemory
22+ , tlsSettingsChain
23+ , tlsSettingsChainMemory
24+ -- * Accessors
25+ , certFile
26+ , keyFile
27+ , tlsLogging
28+ , tlsAllowedVersions
29+ , tlsCiphers
30+ , tlsWantClientCert
31+ , tlsServerHooks
32+ , tlsServerDHEParams
33+ , tlsSessionManagerConfig
34+ , onInsecure
35+ , OnInsecure (..)
36+ -- * Runner
37+ , runTLS
38+ , runTLSSocket
39+ -- * Exception
40+ , WarpTLSException (..)
41+ , DH.Params
42+ , DH.generateParams
43+ ) where
44+
45+import Control.Applicative ((<|>))
46+import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..), handleJust)
47+import qualified Control.Exception as E
48+import Control.Monad (void, guard)
49+import qualified Data.ByteString as S
50+import qualified Data.ByteString.Lazy as L
51+import Data.Default.Class (def)
52+import qualified Data.IORef as I
53+import Data.Streaming.Network (bindPortTCP, safeRecv)
54+import Data.Typeable (Typeable)
55+import Network.Socket (Socket, close, withSocketsDo, SockAddr, accept)
56+#if MIN_VERSION_network(3,1,1)
57+import Network.Socket (gracefulClose)
58+#endif
59+import Network.Socket.ByteString (sendAll)
60+import qualified Network.TLS as TLS
61+import qualified Crypto.PubKey.DH as DH
62+import qualified Network.TLS.Extra as TLSExtra
63+import qualified Network.TLS.SessionManager as SM
64+import Network.Wai (Application)
65+import Network.Wai.Handler.Warp
66+import Network.Wai.Handler.Warp.Internal
67+import System.IO.Error (isEOFError)
68+
69+----------------------------------------------------------------
70+
71+-- | Settings for WarpTLS.
72+data TLSSettings = TLSSettings {
73+ certFile :: FilePath
74+ -- ^ File containing the certificate.
75+ , chainCertFiles :: [FilePath]
76+ -- ^ Files containing chain certificates.
77+ , keyFile :: FilePath
78+ -- ^ File containing the key
79+ , certMemory :: Maybe S.ByteString
80+ , chainCertsMemory :: [S.ByteString]
81+ , keyMemory :: Maybe S.ByteString
82+ , onInsecure :: OnInsecure
83+ -- ^ Do we allow insecure connections with this server as well?
84+ --
85+ -- >>> onInsecure defaultTlsSettings
86+ -- DenyInsecure "This server only accepts secure HTTPS connections."
87+ --
88+ -- Since 1.4.0
89+ , tlsLogging :: TLS.Logging
90+ -- ^ The level of logging to turn on.
91+ --
92+ -- Default: 'TLS.defaultLogging'.
93+ --
94+ -- Since 1.4.0
95+ , tlsAllowedVersions :: [TLS.Version]
96+#if MIN_VERSION_tls(1,5,0)
97+ -- ^ The TLS versions this server accepts.
98+ --
99+ -- >>> tlsAllowedVersions defaultTlsSettings
100+ -- [TLS13,TLS12,TLS11,TLS10]
101+ --
102+ -- Since 1.4.2
103+#else
104+ -- ^ The TLS versions this server accepts.
105+ --
106+ -- >>> tlsAllowedVersions defaultTlsSettings
107+ -- [TLS12,TLS11,TLS10]
108+ --
109+ -- Since 1.4.2
110+#endif
111+ , tlsCiphers :: [TLS.Cipher]
112+#if MIN_VERSION_tls(1,5,0)
113+ -- ^ The TLS ciphers this server accepts.
114+ --
115+ -- >>> tlsCiphers defaultTlsSettings
116+ -- [ECDHE-ECDSA-AES256GCM-SHA384,ECDHE-ECDSA-AES128GCM-SHA256,ECDHE-RSA-AES256GCM-SHA384,ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256GCM-SHA384,DHE-RSA-AES128GCM-SHA256,ECDHE-ECDSA-AES256CBC-SHA384,ECDHE-RSA-AES256CBC-SHA384,DHE-RSA-AES256-SHA256,ECDHE-ECDSA-AES256CBC-SHA,ECDHE-RSA-AES256CBC-SHA,DHE-RSA-AES256-SHA1,RSA-AES256GCM-SHA384,RSA-AES256-SHA256,RSA-AES256-SHA1,AES128GCM-SHA256,AES256GCM-SHA384]
117+ --
118+ -- Since 1.4.2
119+#else
120+ -- ^ The TLS ciphers this server accepts.
121+ --
122+ -- >>> tlsCiphers defaultTlsSettings
123+ -- [ECDHE-ECDSA-AES256GCM-SHA384,ECDHE-ECDSA-AES128GCM-SHA256,ECDHE-RSA-AES256GCM-SHA384,ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256GCM-SHA384,DHE-RSA-AES128GCM-SHA256,ECDHE-ECDSA-AES256CBC-SHA384,ECDHE-RSA-AES256CBC-SHA384,DHE-RSA-AES256-SHA256,ECDHE-ECDSA-AES256CBC-SHA,ECDHE-RSA-AES256CBC-SHA,DHE-RSA-AES256-SHA1,RSA-AES256GCM-SHA384,RSA-AES256-SHA256,RSA-AES256-SHA1]
124+ --
125+ -- Since 1.4.2
126+#endif
127+ , tlsWantClientCert :: Bool
128+ -- ^ Whether or not to demand a certificate from the client. If this
129+ -- is set to True, you must handle received certificates in a server hook
130+ -- or all connections will fail.
131+ --
132+ -- >>> tlsWantClientCert defaultTlsSettings
133+ -- False
134+ --
135+ -- Since 3.0.2
136+ , tlsServerHooks :: TLS.ServerHooks
137+ -- ^ The server-side hooks called by the tls package, including actions
138+ -- to take when a client certificate is received. See the "Network.TLS"
139+ -- module for details.
140+ --
141+ -- Default: def
142+ --
143+ -- Since 3.0.2
144+ , tlsServerDHEParams :: Maybe DH.Params
145+ -- ^ Configuration for ServerDHEParams
146+ -- more function lives in `cryptonite` package
147+ --
148+ -- Default: Nothing
149+ --
150+ -- Since 3.2.2
151+ , tlsSessionManagerConfig :: Maybe SM.Config
152+ -- ^ Configuration for in-memory TLS session manager.
153+ -- If Nothing, 'TLS.noSessionManager' is used.
154+ -- Otherwise, an in-memory TLS session manager is created
155+ -- according to 'Config'.
156+ --
157+ -- Default: Nothing
158+ --
159+ -- Since 3.2.4
160+ }
161+
162+-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name (aka accessors).
163+defaultTlsSettings :: TLSSettings
164+defaultTlsSettings = TLSSettings {
165+ certFile = "certificate.pem"
166+ , chainCertFiles = []
167+ , keyFile = "key.pem"
168+ , certMemory = Nothing
169+ , chainCertsMemory = []
170+ , keyMemory = Nothing
171+ , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
172+ , tlsLogging = def
173+#if MIN_VERSION_tls(1,5,0)
174+ , tlsAllowedVersions = [TLS.TLS13,TLS.TLS12,TLS.TLS11,TLS.TLS10]
175+#else
176+ , tlsAllowedVersions = [TLS.TLS12,TLS.TLS11,TLS.TLS10]
177+#endif
178+ , tlsCiphers = ciphers
179+ , tlsWantClientCert = False
180+ , tlsServerHooks = def
181+ , tlsServerDHEParams = Nothing
182+ , tlsSessionManagerConfig = Nothing
183+ }
184+
185+-- taken from stunnel example in tls-extra
186+ciphers :: [TLS.Cipher]
187+ciphers = TLSExtra.ciphersuite_strong
188+
189+----------------------------------------------------------------
190+
191+-- | An action when a plain HTTP comes to HTTP over TLS/SSL port.
192+data OnInsecure = DenyInsecure L.ByteString
193+ | AllowInsecure
194+ deriving (Show)
195+
196+----------------------------------------------------------------
197+
198+-- | A smart constructor for 'TLSSettings' based on 'defaultTlsSettings'.
199+tlsSettings :: FilePath -- ^ Certificate file
200+ -> FilePath -- ^ Key file
201+ -> TLSSettings
202+tlsSettings cert key = defaultTlsSettings {
203+ certFile = cert
204+ , keyFile = key
205+ }
206+
207+-- | A smart constructor for 'TLSSettings' that allows specifying
208+-- chain certificates based on 'defaultTlsSettings'.
209+--
210+-- Since 3.0.3
211+tlsSettingsChain
212+ :: FilePath -- ^ Certificate file
213+ -> [FilePath] -- ^ Chain certificate files
214+ -> FilePath -- ^ Key file
215+ -> TLSSettings
216+tlsSettingsChain cert chainCerts key = defaultTlsSettings {
217+ certFile = cert
218+ , chainCertFiles = chainCerts
219+ , keyFile = key
220+ }
221+
222+-- | A smart constructor for 'TLSSettings', but uses in-memory representations
223+-- of the certificate and key based on 'defaultTlsSettings'.
224+--
225+-- Since 3.0.1
226+tlsSettingsMemory
227+ :: S.ByteString -- ^ Certificate bytes
228+ -> S.ByteString -- ^ Key bytes
229+ -> TLSSettings
230+tlsSettingsMemory cert key = defaultTlsSettings
231+ { certMemory = Just cert
232+ , keyMemory = Just key
233+ }
234+
235+-- | A smart constructor for 'TLSSettings', but uses in-memory representations
236+-- of the certificate and key based on 'defaultTlsSettings'.
237+--
238+-- Since 3.0.3
239+tlsSettingsChainMemory
240+ :: S.ByteString -- ^ Certificate bytes
241+ -> [S.ByteString] -- ^ Chain certificate bytes
242+ -> S.ByteString -- ^ Key bytes
243+ -> TLSSettings
244+tlsSettingsChainMemory cert chainCerts key = defaultTlsSettings
245+ { certMemory = Just cert
246+ , chainCertsMemory = chainCerts
247+ , keyMemory = Just key
248+ }
249+
250+----------------------------------------------------------------
251+
252+-- | Running 'Application' with 'TLSSettings' and 'Settings'.
253+runTLS :: TLSSettings -> Settings -> Application -> IO ()
254+runTLS tset set app = withSocketsDo $
255+ bracket
256+ (bindPortTCP (getPort set) (getHost set))
257+ close
258+ (\sock -> runTLSSocket tset set sock app)
259+
260+----------------------------------------------------------------
261+
262+-- | Running 'Application' with 'TLSSettings' and 'Settings' using
263+-- specified 'Socket'.
264+runTLSSocket :: TLSSettings -> Settings -> Socket -> Application -> IO ()
265+runTLSSocket tlsset@TLSSettings{..} set sock app = do
266+ credential <- case (certMemory, keyMemory) of
267+ (Nothing, Nothing) ->
268+ either error id <$>
269+ TLS.credentialLoadX509Chain certFile chainCertFiles keyFile
270+ (mcert, mkey) -> do
271+ cert <- maybe (S.readFile certFile) return mcert
272+ key <- maybe (S.readFile keyFile) return mkey
273+ either error return $
274+ TLS.credentialLoadX509ChainFromMemory cert chainCertsMemory key
275+ mgr <- case tlsSessionManagerConfig of
276+ Nothing -> return TLS.noSessionManager
277+ Just config -> SM.newSessionManager config
278+ runTLSSocket' tlsset set credential mgr sock app
279+
280+runTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> TLS.SessionManager -> Socket -> Application -> IO ()
281+runTLSSocket' tlsset@TLSSettings{..} set credential mgr sock app =
282+ runSettingsConnectionMakerSecure set get app
283+ where
284+ get = getter tlsset set sock params
285+ params = def { -- TLS.ServerParams
286+ TLS.serverWantClientCert = tlsWantClientCert
287+ , TLS.serverCACertificates = []
288+ , TLS.serverDHEParams = tlsServerDHEParams
289+ , TLS.serverHooks = hooks
290+ , TLS.serverShared = shared
291+ , TLS.serverSupported = supported
292+#if MIN_VERSION_tls(1,5,0)
293+ , TLS.serverEarlyDataSize = 2018
294+#endif
295+ }
296+ -- Adding alpn to user's tlsServerHooks.
297+ hooks = tlsServerHooks {
298+ TLS.onALPNClientSuggest = TLS.onALPNClientSuggest tlsServerHooks <|>
299+ (if settingsHTTP2Enabled set then Just alpn else Nothing)
300+ }
301+ shared = def {
302+ TLS.sharedCredentials = TLS.Credentials [credential]
303+ , TLS.sharedSessionManager = mgr
304+ }
305+ supported = def { -- TLS.Supported
306+ TLS.supportedVersions = tlsAllowedVersions
307+ , TLS.supportedCiphers = tlsCiphers
308+ , TLS.supportedCompressions = [TLS.nullCompression]
309+ , TLS.supportedSecureRenegotiation = True
310+ , TLS.supportedClientInitiatedRenegotiation = False
311+ , TLS.supportedSession = True
312+ , TLS.supportedFallbackScsv = True
313+#if MIN_VERSION_tls(1,5,0)
314+ , TLS.supportedGroups = [TLS.X25519,TLS.P256,TLS.P384]
315+#endif
316+ }
317+
318+alpn :: [S.ByteString] -> IO S.ByteString
319+alpn xs
320+ | "h2" `elem` xs = return "h2"
321+ | otherwise = return "http/1.1"
322+
323+----------------------------------------------------------------
324+
325+getter :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (IO (Connection, Transport), SockAddr)
326+getter tlsset@TLSSettings{..} set sock params = do
327+#if WINDOWS
328+ (s, sa) <- windowsThreadBlockHack $ accept sock
329+#else
330+ (s, sa) <- accept sock
331+#endif
332+ setSocketCloseOnExec s
333+ return (mkConn tlsset set s params, sa)
334+
335+mkConn :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (Connection, Transport)
336+mkConn tlsset set s params = switch `onException` close s
337+ where
338+ switch = do
339+ firstBS <- safeRecv s 4096
340+ if not (S.null firstBS) && S.head firstBS == 0x16 then
341+ httpOverTls tlsset set s firstBS params
342+ else
343+ plainHTTP tlsset set s firstBS
344+
345+----------------------------------------------------------------
346+
347+httpOverTls :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
348+httpOverTls TLSSettings{..} _set s bs0 params = do
349+ recvN <- makePlainReceiveN s bs0
350+ ctx <- TLS.contextNew (backend recvN) params
351+ TLS.contextHookSetLogging ctx tlsLogging
352+ TLS.handshake ctx
353+ h2 <- (== Just "h2") <$> TLS.getNegotiatedProtocol ctx
354+ isH2 <- I.newIORef h2
355+ writeBuf <- allocateBuffer bufferSize
356+ -- Creating a cache for leftover input data.
357+ ref <- I.newIORef ""
358+ tls <- getTLSinfo ctx
359+ return (conn ctx writeBuf ref isH2, tls)
360+ where
361+ backend recvN = TLS.Backend {
362+ TLS.backendFlush = return ()
363+#if MIN_VERSION_network(3,1,1)
364+ , TLS.backendClose = gracefulClose s 5000 `E.catch` \(SomeException _) -> return ()
365+#else
366+ , TLS.backendClose = close s
367+#endif
368+ , TLS.backendSend = sendAll' s
369+ , TLS.backendRecv = recvN
370+ }
371+ sendAll' sock bs = sendAll sock bs `E.catch` \(SomeException _) ->
372+ throwIO ConnectionClosedByPeer
373+ conn ctx writeBuf ref isH2 = Connection {
374+ connSendMany = TLS.sendData ctx . L.fromChunks
375+ , connSendAll = sendall
376+ , connSendFile = sendfile
377+ , connClose = close'
378+ , connFree = freeBuffer writeBuf
379+ , connRecv = recv ref
380+ , connRecvBuf = recvBuf ref
381+ , connWriteBuffer = writeBuf
382+ , connBufferSize = bufferSize
383+ , connHTTP2 = isH2
384+ }
385+ where
386+ sendall = TLS.sendData ctx . L.fromChunks . return
387+ sendfile fid offset len hook headers =
388+ readSendFile writeBuf bufferSize sendall fid offset len hook headers
389+
390+ close' = void (tryIO sendBye) `finally`
391+ TLS.contextClose ctx
392+
393+ sendBye =
394+ -- It's fine if the connection was closed by the other side before
395+ -- receiving close_notify, see RFC 5246 section 7.2.1.
396+ handleJust
397+ (\e -> guard (e == ConnectionClosedByPeer) >> return e)
398+ (const (return ()))
399+ (TLS.bye ctx)
400+
401+ -- TLS version of recv with a cache for leftover input data.
402+ -- The cache is shared with recvBuf.
403+ recv cref = do
404+ cached <- I.readIORef cref
405+ if cached /= "" then do
406+ I.writeIORef cref ""
407+ return cached
408+ else
409+ recv'
410+
411+ -- TLS version of recv (decrypting) without a cache.
412+ recv' = handle onEOF go
413+ where
414+ onEOF e
415+ | Just TLS.Error_EOF <- fromException e = return S.empty
416+ | Just ioe <- fromException e, isEOFError ioe = return S.empty | otherwise = throwIO e
417+ go = do
418+ x <- TLS.recvData ctx
419+ if S.null x then
420+ go
421+ else
422+ return x
423+
424+ -- TLS version of recvBuf with a cache for leftover input data.
425+ recvBuf cref buf siz = do
426+ cached <- I.readIORef cref
427+ (ret, leftover) <- fill cached buf siz recv'
428+ I.writeIORef cref leftover
429+ return ret
430+
431+fill :: S.ByteString -> Buffer -> BufSize -> Recv -> IO (Bool,S.ByteString)
432+fill bs0 buf0 siz0 recv
433+ | siz0 <= len0 = do
434+ let (bs, leftover) = S.splitAt siz0 bs0
435+ void $ copy buf0 bs
436+ return (True, leftover)
437+ | otherwise = do
438+ buf <- copy buf0 bs0
439+ loop buf (siz0 - len0)
440+ where
441+ len0 = S.length bs0
442+ loop _ 0 = return (True, "")
443+ loop buf siz = do
444+ bs <- recv
445+ let len = S.length bs
446+ if len == 0 then return (False, "")
447+ else if (len <= siz) then do
448+ buf' <- copy buf bs
449+ loop buf' (siz - len)
450+ else do
451+ let (bs1,bs2) = S.splitAt siz bs
452+ void $ copy buf bs1
453+ return (True, bs2)
454+
455+getTLSinfo :: TLS.Context -> IO Transport
456+getTLSinfo ctx = do
457+ proto <- TLS.getNegotiatedProtocol ctx
458+ minfo <- TLS.contextGetInformation ctx
459+ case minfo of
460+ Nothing -> return TCP
461+ Just TLS.Information{..} -> do
462+ let (major, minor) = case infoVersion of
463+ TLS.SSL2 -> (2,0)
464+ TLS.SSL3 -> (3,0)
465+ TLS.TLS10 -> (3,1)
466+ TLS.TLS11 -> (3,2)
467+ TLS.TLS12 -> (3,3)
468+#if MIN_VERSION_tls(1,5,0)
469+ TLS.TLS13 -> (3,4)
470+#endif
471+ clientCert <- TLS.getClientCertificateChain ctx
472+ return TLS {
473+ tlsMajorVersion = major
474+ , tlsMinorVersion = minor
475+ , tlsNegotiatedProtocol = proto
476+ , tlsChiperID = TLS.cipherID infoCipher
477+ , tlsClientCertificate = clientCert
478+ }
479+
480+tryIO :: IO a -> IO (Either IOException a)
481+tryIO = try
482+
483+----------------------------------------------------------------
484+
485+plainHTTP :: TLSSettings -> Settings -> Socket -> S.ByteString -> IO (Connection, Transport)
486+plainHTTP TLSSettings{..} set s bs0 = case onInsecure of
487+ AllowInsecure -> do
488+ conn' <- socketConnection set s
489+ cachedRef <- I.newIORef bs0
490+ let conn'' = conn'
491+ { connRecv = recvPlain cachedRef (connRecv conn')
492+ }
493+ return (conn'', TCP)
494+ DenyInsecure lbs -> do
495+ -- Listening port 443 but TLS records do not arrive.
496+ -- We want to let the browser know that TLS is required.
497+ -- So, we use 426.
498+ -- http://tools.ietf.org/html/rfc2817#section-4.2
499+ -- https://tools.ietf.org/html/rfc7231#section-6.5.15
500+ -- FIXME: should we distinguish HTTP/1.1 and HTTP/2?
501+ -- In the case of HTTP/2, should we send
502+ -- GOAWAY + INADEQUATE_SECURITY?
503+ -- FIXME: Content-Length:
504+ -- FIXME: TLS/<version>
505+ sendAll s "HTTP/1.1 426 Upgrade Required\
506+ \r\nUpgrade: TLS/1.0, HTTP/1.1\
507+ \r\nConnection: Upgrade\
508+ \r\nContent-Type: text/plain\r\n\r\n"
509+ mapM_ (sendAll s) $ L.toChunks lbs
510+ close s
511+ throwIO InsecureConnectionDenied
512+
513+----------------------------------------------------------------
514+
515+-- | Modify the given receive function to first check the given @IORef@ for a
516+-- chunk of data. If present, takes the chunk of data from the @IORef@ and
517+-- empties out the @IORef@. Otherwise, calls the supplied receive function.
518+recvPlain :: I.IORef S.ByteString -> IO S.ByteString -> IO S.ByteString
519+recvPlain ref fallback = do
520+ bs <- I.readIORef ref
521+ if S.null bs
522+ then fallback
523+ else do
524+ I.writeIORef ref S.empty
525+ return bs
526+
527+----------------------------------------------------------------
528+
529+data WarpTLSException = InsecureConnectionDenied
530+ deriving (Show, Typeable)
531+instance Exception WarpTLSException
warp-tls/README.mdnew file+9
@@ -0,0 +1,9 @@
1+## warp-tls
2+
3+Serve WAI applications using the Warp webserver and the Haskell TLS library.
4+
5+In order to generate a self-signed certificate for testing, try the following:
6+
7+ openssl genrsa -out key.pem 2048
8+ openssl req -new -key key.pem -out certificate.csr
9+ openssl x509 -req -in certificate.csr -signkey key.pem -out certificate.pem
warp-tls/Setup.lhsnew file+7
@@ -0,0 +1,7 @@
1+#!/usr/bin/env runhaskell
2+
3+> module Main where
4+> import Distribution.Simple
5+
6+> main :: IO ()
7+> main = defaultMain
warp-tls/certificate.pemnew file+15
@@ -0,0 +1,15 @@
1+-----BEGIN CERTIFICATE-----
2+MIICWDCCAcGgAwIBAgIJAJG1ZMlcMDW6MA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV
3+BAYTAkFVMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBX
4+aWRnaXRzIFB0eSBMdGQwHhcNMTExMDIyMTk0MjU3WhcNMTExMTIxMTk0MjU3WjBF
5+MQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50
6+ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKB
7+gQCfYZx7kV6ybogMyAf9MINm7Rwin5LKh+TpD1ZkbLgmqFVotQCdthgTK66SPXkx
8+EXGI27biNzacJhX7Ml7/4o8sp2GslYKUO46DYvgi/nnNX/bzA5cDJSSGK11eQEVs
9++p0GEZ/6Juhpx/oQwMDMgo0UHkiH8QtKI8ojXnFF2MsLNwIDAQABo1AwTjAdBgNV
10+HQ4EFgQUaA6FbOj/0VJMb4egNyIDZ/ZNV/YwHwYDVR0jBBgwFoAUaA6FbOj/0VJM
11+b4egNyIDZ/ZNV/YwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQCTQyOk
12+D86Z+yzedXjTLI6FT8QugmQne1YQ8P0w37P76z2reagSvNee2e9B1oTHoPeKZMs0
13+k99oS9yJ/NOQ1Ms90P+q0yBVGxAs/gF65qKgE27YGXzNtNobj/D4OoxcFG+BsORw
14+VvYSBV4FiVy9RwJsr7AMqkUBcOEPCuJHgTx58w==
15+-----END CERTIFICATE-----
warp-tls/graceful-pong.hsnew file+125
@@ -0,0 +1,125 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+import Control.Concurrent
3+import Control.Concurrent.Async
4+import Network
5+import Network.Wai
6+import Network.Wai.Handler.Warp (defaultSettings)
7+import Network.Wai.Handler.WarpTLS
8+import Network.HTTP.Types (status200)
9+import Network.Socket (Socket(..), mkSocket, SocketStatus(..))
10+import Blaze.ByteString.Builder (copyByteString)
11+import Data.Monoid
12+import qualified Data.Conduit as C
13+import qualified Data.Conduit.List as CL
14+import System.Environment (getEnv)
15+import System.Posix.Process
16+import System.Posix.Signals
17+
18+envSocketName = "GRACEFUL_PONG_SOCKET"
19+
20+fromSocket2Env sock = [(envSocketName, show (fd, addrFamily, socketType, protocolNumber))]
21+ where
22+ MkSocket fd addrFamily socketType protocolNumber _socketStatus = sock
23+
24+handleSIGHUP proc spawn =
25+ modifyMVar_ proc $ \oldpid -> do
26+ pid <- spawn
27+ signalProcess lostConnection oldpid
28+ status <- waitpid oldpid
29+ print (oldpid, status)
30+ return pid
31+
32+waitpid pid = do
33+ mstatus <- getProcessStatus False True pid
34+ case mstatus of
35+ Nothing -> waitpid pid
36+ Just status -> return status
37+
38+handleSIGTERM proc finish =
39+ takeMVar proc >>=
40+ signalProcess softwareTermination >>
41+ putMVar finish ()
42+
43+child (fd, addrFamily, socketType, protocolNumber) = do
44+ sock <- mkSocket fd addrFamily socketType protocolNumber Listening
45+ putStrLn "https://localhost:3000/"
46+ finish <- newEmptyMVar
47+ let sighup = Catch $ putMVar finish ()
48+ _handler <- installHandler lostConnection sighup Nothing
49+ runTLSSocket (TLSSettings "certificate.pem" "key.pem") defaultSettings sock app `race_` takeMVar finish
50+
51+parent = do
52+ sock <- listenOn $ PortNumber $ toEnum 3000
53+ let env = Just $ fromSocket2Env sock
54+ spawn = forkProcess $ executeFile "./graceful-pong" False [] env
55+ proc <- spawn >>= newMVar
56+ finish <- newEmptyMVar
57+ let sighup = Catch $ handleSIGHUP proc spawn
58+ sigterm = Catch $ handleSIGTERM proc finish
59+ _handler <- installHandler lostConnection sighup Nothing
60+ _handler <- installHandler softwareTermination sigterm Nothing
61+ takeMVar finish
62+
63+main = do
64+ (getEnv envSocketName >>= child . read) `catch` const parent
65+
66+app req = return $
67+ case rawPathInfo req of
68+ "/builder/withlen" -> builderWithLen
69+ "/builder/nolen" -> builderNoLen
70+ "/file/withlen" -> fileWithLen
71+ "/file/nolen" -> fileNoLen
72+ "/source/withlen" -> sourceWithLen
73+ "/source/nolen" -> sourceNoLen
74+ x -> index x
75+
76+builderWithLen = ResponseBuilder
77+ status200
78+ [ ("Content-Type", "text/plain")
79+ , ("Content-Length", "4")
80+ ]
81+ $ copyByteString "PONG"
82+
83+builderNoLen = ResponseBuilder
84+ status200
85+ [ ("Content-Type", "text/plain")
86+ ]
87+ $ copyByteString "PONG"
88+
89+sourceWithLen = ResponseSource
90+ status200
91+ [ ("Content-Type", "text/plain")
92+ , ("Content-Length", "4")
93+ ]
94+ $ CL.sourceList [C.Chunk $ copyByteString "PONG"]
95+
96+sourceNoLen = ResponseSource
97+ status200
98+ [ ("Content-Type", "text/plain")
99+ ]
100+ $ CL.sourceList [C.Chunk $ copyByteString "PONG"]
101+
102+fileWithLen = ResponseFile
103+ status200
104+ [ ("Content-Type", "text/plain")
105+ , ("Content-Length", "4")
106+ ]
107+ "pong.txt"
108+ Nothing
109+
110+fileNoLen = ResponseFile
111+ status200
112+ [ ("Content-Type", "text/plain")
113+ ]
114+ "pong.txt"
115+ Nothing
116+
117+index p = ResponseBuilder status200 [("Content-Type", "text/html")] $ mconcat $ map copyByteString
118+ [ "<p><a href='/builder/withlen'>builder withlen</a></p>\n"
119+ , "<p><a href='/builder/nolen'>builder nolen</a></p>\n"
120+ , "<p><a href='/file/withlen'>file withlen</a></p>\n"
121+ , "<p><a href='/file/nolen'>file nolen</a></p>\n"
122+ , "<p><a href='/source/withlen'>source withlen</a></p>\n"
123+ , "<p><a href='/source/nolen'>source nolen</a></p>\n"
124+ , p
125+ ]
warp-tls/key.pemnew file+15
@@ -0,0 +1,15 @@
1+-----BEGIN RSA PRIVATE KEY-----
2+MIICXAIBAAKBgQCfYZx7kV6ybogMyAf9MINm7Rwin5LKh+TpD1ZkbLgmqFVotQCd
3+thgTK66SPXkxEXGI27biNzacJhX7Ml7/4o8sp2GslYKUO46DYvgi/nnNX/bzA5cD
4+JSSGK11eQEVs+p0GEZ/6Juhpx/oQwMDMgo0UHkiH8QtKI8ojXnFF2MsLNwIDAQAB
5+AoGAR8pgAgjo7tZ60ccIUjOX/LSxB6d5J2Eu6wvNjk6qZD9OuWtOa7up/HigmZ63
6+CDMjQNI2/o6AOrWtEQkPYZNbibuifzg5V517nHGSqkqjoIgesAiwEsoKpeOgGTtM
7+MM08oHbJ9uOnDnEEnDBiE0iE3jCTDfmwjqDMpUhu9dZ1EAECQQDKVpzSSV3pzMOp
8+ixNxMpYxzcE+4K9jgM+MlxPBJSQhVrg/cRQWb26cKBi8LdSxF23hQTsFr+8qLwid
9+Ah2AgUOBAkEAyaaCjrNRCiHRpd6YzWZ6GKkxbUvxSuOKX3N7hDaE2OFzQTv2Li8B
10+5mrCsXnSZtOG+MBFdHU66UYie1OzDSDKtwJAKMsvkOID0ihbZmpIwDC/wUjHZkLs
11+eXY14hVvgShY0XPnb7r/nspWlZsr6Xyf/hhIKfr5yFrBMFMNPIJ5qjflgQJAWsyV
12+YTgxN4S+6BdxapvIQq58ySA3CGeo+Q4BAimibB4oTal4UpdsHZrZDB00toRs9Dlv
13+jN70pfGkuS+ZIkIvxQJBAKSf5qpXWp4oZcThkieAiMeAhG96xqRPXhPUxq6QF+YG
14+T4PF1sjlpZwqy7C+2oF3BqLP09mCW7YkH9Jgnl1zDF8=
15+-----END RSA PRIVATE KEY-----
warp-tls/pong.hsnew file+80
@@ -0,0 +1,80 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+import Network.Wai
3+import Network.Wai.Handler.Warp (defaultSettings, setPort)
4+import Network.Wai.Handler.WarpTLS
5+import Network.HTTP.Types (status200)
6+import Blaze.ByteString.Builder (copyByteString)
7+import Data.Monoid
8+import qualified Data.Conduit as C
9+import qualified Data.Conduit.List as CL
10+import Network.HTTP.ReverseProxy
11+import Network.HTTP.Conduit
12+
13+main = do
14+ putStrLn "https://localhost:3009/"
15+ --manager <- newManager def
16+ runTLS (tlsSettings "certificate.pem" "key.pem")
17+ { onInsecure = AllowInsecure
18+ } (setPort 3009 defaultSettings) app
19+
20+app req f = f $
21+ case rawPathInfo req of
22+ "/builder/withlen" -> builderWithLen
23+ "/builder/nolen" -> builderNoLen
24+ "/file/withlen" -> fileWithLen
25+ "/file/nolen" -> fileNoLen
26+ "/source/withlen" -> sourceWithLen
27+ "/source/nolen" -> sourceNoLen
28+ "/secure" -> responseLBS status200 [] $ if isSecure req then "secure" else "insecure"
29+ x -> index x
30+
31+builderWithLen = responseBuilder
32+ status200
33+ [ ("Content-Type", "text/plain")
34+ , ("Content-Length", "4")
35+ ]
36+ $ copyByteString "PONG"
37+
38+builderNoLen = responseBuilder
39+ status200
40+ [ ("Content-Type", "text/plain")
41+ ]
42+ $ copyByteString "PONG"
43+
44+sourceWithLen = responseStream
45+ status200
46+ [ ("Content-Type", "text/plain")
47+ , ("Content-Length", "4")
48+ ]
49+ $ \sendChunk _flush -> sendChunk $ copyByteString "PONG"
50+
51+sourceNoLen = responseStream
52+ status200
53+ [ ("Content-Type", "text/plain")
54+ ]
55+ $ \sendChunk _flush -> sendChunk $ copyByteString "PONG"
56+
57+fileWithLen = responseFile
58+ status200
59+ [ ("Content-Type", "text/plain")
60+ , ("Content-Length", "4")
61+ ]
62+ "pong.txt"
63+ Nothing
64+
65+fileNoLen = responseFile
66+ status200
67+ [ ("Content-Type", "text/plain")
68+ ]
69+ "pong.txt"
70+ Nothing
71+
72+index p = responseBuilder status200 [("Content-Type", "text/html")] $ mconcat $ map copyByteString
73+ [ "<p><a href='/builder/withlen'>builder withlen</a></p>\n"
74+ , "<p><a href='/builder/nolen'>builder nolen</a></p>\n"
75+ , "<p><a href='/file/withlen'>file withlen</a></p>\n"
76+ , "<p><a href='/file/nolen'>file nolen</a></p>\n"
77+ , "<p><a href='/source/withlen'>source withlen</a></p>\n"
78+ , "<p><a href='/source/nolen'>source nolen</a></p>\n"
79+ , p
80+ ]
warp-tls/pong.txtnew file+1
@@ -0,0 +1 @@
1+PONG
warp-tls/warp-tls.cabalnew file+42
@@ -0,0 +1,42 @@
1+Name: warp-tls
2+Version: 3.2.11
3+Synopsis: HTTP over TLS support for Warp via the TLS package
4+License: MIT
5+License-file: LICENSE
6+Author: Michael Snoyman
7+Maintainer: michael@snoyman.com
8+Homepage: http://github.com/yesodweb/wai
9+Category: Web, Yesod
10+Build-Type: Simple
11+Cabal-Version: >= 1.10
12+Stability: Stable
13+description: SSLv1 and SSLv2 are obsoleted by IETF.
14+ We should use TLS 1.2 (or TLS 1.1 or TLS 1.0 if necessary).
15+ HTTP/2 can be negotiated by ALPN.
16+ API docs and the README are available at
17+ <http://www.stackage.org/package/warp-tls>.
18+extra-source-files: ChangeLog.md README.md
19+
20+Library
21+ Build-Depends: base >= 4.10 && < 5
22+ , bytestring >= 0.9
23+ , wai >= 3.2 && < 3.3
24+ , warp >= 3.3.6 && < 3.4
25+ , data-default-class >= 0.0.1
26+ , tls >= 1.5.3
27+ , cryptonite >= 0.12
28+ , network >= 2.2.1
29+ , streaming-commons
30+ , tls-session-manager >= 0.0.4
31+ Exposed-modules: Network.Wai.Handler.WarpTLS
32+ ghc-options: -Wall
33+ if os(windows)
34+ Cpp-Options: -DWINDOWS
35+ if impl(ghc >= 8)
36+ Default-Extensions: Strict StrictData
37+ Default-Language: Haskell2010
38+
39+
40+source-repository head
41+ type: git
42+ location: git://github.com/yesodweb/wai.git
warp/.ghcinew file+1
@@ -0,0 +1 @@
1+:set -itest -idist/build/autogen -i.stack-work/dist/x86_64-linux/Cabal-1.22.5.0/build/autogen
warp/ChangeLog.mdnew file+404
@@ -0,0 +1,404 @@
1+## 3.3.9
2+
3+* Don't insert Last-Modified: if exists.
4+ [#791](https://github.com/yesodweb/wai/pull/791)
5+
6+## 3.3.8
7+
8+* Maximum header size is configurable.
9+ [#781](https://github.com/yesodweb/wai/pull/781)
10+* Ignoring an exception from shutdown (gracefulClose).
11+
12+## 3.3.7
13+
14+* InvalidArgument (Bad file descriptor) is ignored in `receive`.
15+ [#787](https://github.com/yesodweb/wai/pull/787)
16+
17+## 3.3.6
18+
19+* Fixing a bug of thread killed in the case of event source with
20+ HTTP/2 (fixing #692 and #785)
21+* New APIs: clientCertificate to get client's certificate
22+ [#783](https://github.com/yesodweb/wai/pull/783)
23+
24+## 3.3.5
25+
26+* New APIs: setGracefulCloseTimeout1 and setGracefulCloseTimeout2.
27+ For HTTP/1.x, connections are closed immediately by default.
28+ gracefullClose is used for HTTP/2 by default.
29+ [#782](https://github.com/yesodweb/wai/pull/782)
30+
31+## 3.3.4
32+
33+* Setting isSecure of HTTP/2 correctly.
34+
35+## 3.3.3
36+
37+* Calling setOnException in HTTP/2.
38+ [#771](https://github.com/yesodweb/wai/pull/771)
39+
40+## 3.3.2
41+
42+* Fixing a bug of HTTP/2 without fd cache.
43+
44+## 3.3.1
45+
46+* Using gracefullClose of network 3.1.1 or later if available.
47+* If the first line of an HTTP request is really invalid,
48+ don't send an error response
49+
50+## 3.3.0
51+
52+* Switching from the original implementation to HTTP/2 server library.
53+ [#754](https://github.com/yesodweb/wai/pull/754)
54+* Breaking change: The type of `http2dataTrailers` is now
55+ `HTTP2Data -> TrailersMaker`.
56+
57+## 3.2.28
58+
59+* Using the Strict and StrictData language extensions for GHC >8.
60+ [#752](https://github.com/yesodweb/wai/pull/752)
61+* System.TimeManager is now in a separate package: time-manager.
62+ [#750](https://github.com/yesodweb/wai/pull/750)
63+* Fixing a bug of ALPN.
64+* Introducing the half closed state for HTTP/2.
65+ [#717](https://github.com/yesodweb/wai/pull/717)
66+
67+## 3.2.27
68+
69+* Internally, use `lookupEnv` instead of `getEnvironment` to get the
70+ value of the `PORT` environment variable
71+ [#736](https://github.com/yesodweb/wai/pull/736)
72+* Throw 413 for too large payload
73+* Throw 431 for too large headers
74+ [#741](https://github.com/yesodweb/wai/pull/741)
75+* Use exception response handler in HTTP/2 & improve connection preservation
76+ in HTTP/1.x if uncaught exceptions are thrown in an `Application`.
77+ [#738](https://github.com/yesodweb/wai/pull/738)
78+
79+## 3.2.26
80+
81+* Support network package version 3
82+
83+## 3.2.25
84+
85+* Removing Connection: and Transfer-Encoding: from HTTP/2
86+ response header
87+ [#707](https://github.com/yesodweb/wai/pull/707)
88+
89+## 3.2.24
90+
91+* Fix HTTP2 unwanted GoAways on late WindowUpdate frames.
92+ [#711](https://github.com/yesodweb/wai/pull/711)
93+
94+## 3.2.23
95+
96+* Log real requsts when an app throws an error.
97+ [#698](https://github.com/yesodweb/wai/pull/698)
98+
99+## 3.2.22
100+
101+* Fixing large request body in HTTP/2.
102+
103+## 3.2.21
104+
105+* Fixing HTTP/2's timeout handler in request's vault.
106+
107+## 3.2.20
108+
109+* Fixing large request body in HTTP/2
110+ [#593](https://github.com/yesodweb/wai/issues/593)
111+
112+## 3.2.19
113+
114+* Fixing 0-byte request body in HTTP/2
115+ [#597](https://github.com/yesodweb/wai/issues/597)
116+ [#679](https://github.com/yesodweb/wai/issues/679)
117+
118+## 3.2.18.2
119+
120+* Replace dependency on `blaze-builder` with `bsb-http-chunked`
121+
122+## 3.2.18.1
123+
124+* Fix benchmark compilation [#681](https://github.com/yesodweb/wai/issues/681)
125+
126+## 3.2.18
127+
128+* Make `testWithApplicationSettings` actually use the settings passed.
129+ [#677](https://github.com/yesodweb/wai/pull/677).
130+
131+## 3.2.17
132+* Add support for windows thread block hack and closeOnExec to TLS.
133+ [#674](https://github.com/yesodweb/wai/pull/674).
134+
135+## 3.2.16
136+
137+* In `testWithApplication`, don't `throwTo` ignorable exceptions
138+ [#671](https://github.com/yesodweb/wai/issues/671), and
139+ reuse `bindRandomPortTCP`
140+
141+## 3.2.15
142+
143+* Address space leak from exception handlers
144+ [#649](https://github.com/yesodweb/wai/issues/649)
145+
146+## 3.2.14
147+
148+* Support streaming-commons 0.2
149+* Warnings cleanup
150+
151+## 3.2.13
152+
153+* Tickling HTTP/2 timer. [624](https://github.com/yesodweb/wai/pull/624)
154+* Guarantee atomicity of WINDOW_UPDATE increments [622](https://github.com/yesodweb/wai/pull/622)
155+* Relax HTTP2 headers check [621](https://github.com/yesodweb/wai/pull/621)
156+
157+## 3.2.12
158+
159+* If an empty string is set by setServerName, the Server header is not included in response headers [#619](https://github.com/yesodweb/wai/issues/619)
160+
161+## 3.2.11.2
162+
163+* Don't throw exceptions when closing a keep-alive connection
164+ [#618](https://github.com/yesodweb/wai/issues/618)
165+
166+## 3.2.11.1
167+
168+* Move exception handling to top of thread (fixes
169+ [#613](https://github.com/yesodweb/wai/issues/613))
170+
171+## 3.2.11
172+
173+* Fixing 10 HTTP2 bugs pointed out by h2spec v2.
174+
175+## 3.2.10
176+
177+* Add `connFree` to `Connection`. Close socket connections on timeout triggered. Timeout exceptions extend from `SomeAsyncException`. [#602](https://github.com/yesodweb/wai/pull/602) [#605](https://github.com/yesodweb/wai/pull/605)
178+
179+## 3.2.9
180+
181+* Fixing a space leak. [#586](https://github.com/yesodweb/wai/pull/586)
182+
183+## 3.2.8
184+
185+* Fixing HTTP2 requestBodyLength. [#573](https://github.com/yesodweb/wai/pull/573)
186+* Making HTTP/2 :path optional for the CONNECT method. [#572](https://github.com/yesodweb/wai/pull/572)
187+* Adding new APIs for HTTP/2 trailers: http2dataTrailers and modifyHTTP2Data [#566](https://github.com/yesodweb/wai/pull/566)
188+
189+## 3.2.7
190+
191+* Adding new APIs for HTTP/2 server push: getHTTP2Data and setHTTP2Data [#510](https://github.com/yesodweb/wai/pull/510)
192+* Better accept(2) error handling [#553](https://github.com/yesodweb/wai/pull/553)
193+* Adding getGracefulShutdownTimeout.
194+* Add {test,}withApplicationSettings [#531](https://github.com/yesodweb/wai/pull/531)
195+
196+## 3.2.6
197+
198+* Using token based APIs of http2 1.6.
199+
200+## 3.2.5
201+
202+* Ignoring errors from setSocketOption. [#526](https://github.com/yesodweb/wai/issues/526).
203+
204+## 3.2.4
205+
206+* Added `withApplication`, `testWithApplication`, and `openFreePort`
207+* Fixing reaper delay value of file info cache.
208+
209+## 3.2.3
210+
211+* Using http2 v1.5.x which much improves the performance of HTTP/2.
212+* To get rid of the bottleneck of ByteString's (==), a new logic to
213+ compare header names is introduced.
214+
215+## 3.2.2
216+
217+* Throwing errno for pread [#499](https://github.com/yesodweb/wai/issues/499).
218+* Makeing compilable on Windows [#505](https://github.com/yesodweb/wai/issues/505).
219+
220+## 3.2.1
221+
222+* Add back `warpVersion`
223+
224+## 3.2.0
225+
226+* Major version up due to breaking changes. This is because the HTTP/2 code
227+ was started over with Warp 3.1.3 due to performance issue [#470](https://github.com/yesodweb/wai/issues/470).
228+* runHTTP2, runHTTP2Env, runHTTP2Settings and runHTTP2SettingsSocket were removed from the Network.Wai.Handler.Warp module.
229+* The performance of HTTP/2 was drastically improved. Now the performance of HTTP/2 is almost the same as that of HTTP/1.1.
230+* The logic to handle files in HTTP/2 is now identical to that in HTTP/1.1.
231+* Internal stuff was removed from the Network.Wai.Handler.Warp module according to [the plan](http://www.yesodweb.com/blog/2015/06/cleaning-up-warp-apis).
232+
233+## 3.1.12
234+
235+* Setting lower bound for auto-update [#495](https://github.com/yesodweb/wai/issues/495)
236+
237+## 3.1.11
238+
239+* Providing a new API: killManager.
240+* Preventing space leaks due to Weak ThreadId [#488](https://github.com/yesodweb/wai/issues/488)
241+* Setting upper bound for http2.
242+
243+## 3.1.10
244+
245+* `setFileInfoCacheDuration`
246+* `setLogger`
247+* `FileInfo`/`getFileInfo`
248+* Fix: warp-tls strips out the Host request header [#478](https://github.com/yesodweb/wai/issues/478)
249+
250+## 3.1.9
251+
252+* Using the new priority queue based on PSQ provided by http2 lib again.
253+
254+## 3.1.8
255+
256+* Using the new priority queue based on PSQ provided by http2 lib.
257+
258+## 3.1.7
259+
260+* A concatenated Cookie header is prepended to the headers to ensure that it flows pseudo headers. [#454](https://github.com/yesodweb/wai/pull/454)
261+* Providing a new settings: `setHTTP2Disabled` [#450](https://github.com/yesodweb/wai/pull/450)
262+
263+## 3.1.6
264+
265+* Adding back http-types 0.8 support [#449](https://github.com/yesodweb/wai/pull/449)
266+
267+## 3.1.5
268+
269+* Using http-types v0.9.
270+* Fixing build on OpenBSD. [#428](https://github.com/yesodweb/wai/pull/428) [#440](https://github.com/yesodweb/wai/pull/440)
271+* Fixing build on Windows. [#438](https://github.com/yesodweb/wai/pull/438)
272+
273+## 3.1.4
274+
275+* Using newer http2 library to prevent change table size attacks.
276+* API for HTTP/2 server push and trailers. [#426](https://github.com/yesodweb/wai/pull/426)
277+* Preventing response splitting attacks. [#435](https://github.com/yesodweb/wai/pull/435)
278+* Concatenating multiple Cookie: headers in HTTP/2.
279+
280+## 3.1.3
281+
282+* Warp now supports blaze-builder v0.4 or later only.
283+* HTTP/2 code was improved: dynamic priority change, efficient queuing and sender loop continuation. [#423](https://github.com/yesodweb/wai/pull/423) [#424](https://github.com/yesodweb/wai/pull/424)
284+
285+## 3.1.2
286+
287+* Configurable Slowloris size [#418](https://github.com/yesodweb/wai/pull/418)
288+
289+## 3.1.1
290+
291+* Fixing a bug of HTTP/2 when no FD cache is used [#411](https://github.com/yesodweb/wai/pull/411)
292+* Fixing a buffer-pool bug [#406](https://github.com/yesodweb/wai/pull/406) [#407](https://github.com/yesodweb/wai/pull/407)
293+
294+## 3.1.0
295+
296+* Supporting HTTP/2 [#399](https://github.com/yesodweb/wai/pull/399)
297+* Cleaning up APIs [#387](https://github.com/yesodweb/wai/issues/387)
298+
299+## 3.0.13.1
300+
301+* Remove dependency on the void package [#375](https://github.com/yesodweb/wai/pull/375)
302+
303+## 3.0.13
304+
305+* Turn off file descriptor cache by default [#371](https://github.com/yesodweb/wai/issues/371)
306+
307+## 3.0.12.1
308+
309+* Fix for: HEAD requests returning non-empty entity body [#369](https://github.com/yesodweb/wai/issues/369)
310+
311+## 3.0.12
312+
313+* Only conditionally produce HTTP 100 Continue
314+
315+## 3.0.11
316+
317+* Better HEAD support for files [#357](https://github.com/yesodweb/wai/pull/357)
318+
319+## 3.0.10
320+
321+* Fix [missing `IORef` tweak](https://github.com/yesodweb/wai/issues/351)
322+* Disable timeouts as soon as request body is fully consumed. This addresses
323+ the common case of a non-chunked request body. Previously, we would wait
324+ until a zero-length `ByteString` is returned, but that is suboptimal for some
325+ cases. For more information, see [issue
326+ 351](https://github.com/yesodweb/wai/issues/351).
327+* Add `pauseTimeout` function
328+
329+## 3.0.9.3
330+
331+* Don't serve a 416 status code for 0-length files [keter issue #75](https://github.com/snoyberg/keter/issues/75)
332+* Don't serve content-length for 416 responses [#346](https://github.com/yesodweb/wai/issues/346)
333+
334+## 3.0.9.2
335+
336+Fix support for old versions of bytestring
337+
338+## 3.0.9.1
339+
340+Add support for blaze-builder 0.4
341+
342+## 3.0.9
343+
344+* Add runEnv: like run but uses $PORT [#334](https://github.com/yesodweb/wai/pull/334)
345+
346+## 3.0.5.2
347+
348+* [Pass the Request to settingsOnException handlers when available. #326](https://github.com/yesodweb/wai/pull/326)
349+
350+## 3.0.5
351+
352+Support for PROXY protocol, such as used by Amazon ELB TCP. This is useful
353+since, for example, Amazon ELB HTTP does *not* have support for Websockets.
354+More information on the protocol [is available from
355+Amazon](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol).
356+
357+## 3.0.4
358+
359+Added `setFork`.
360+
361+## 3.0.3
362+
363+Modify flushing of request bodies. Previously, regardless of the size of the
364+request body, the entire body would be flushed. When uploading large files to a
365+web app that does not accept such files (e.g., returns a 413 too large status),
366+browsers would still send the entire request body and the servers will still
367+receive it.
368+
369+The new behavior is to detect if there is a large amount of data still to be
370+consumed and, if so, immediately terminate the connection. In the case of
371+chunked request bodies, up to a maximum number of bytes is consumed before the
372+connection is terminated.
373+
374+This is controlled by the new setting `setMaximumBodyFlush`. A value of
375+@Nothing@ will return the original behavior of flushing the entire body.
376+
377+## 3.0.0
378+
379+WAI no longer uses conduit for its streaming interface.
380+
381+## 2.1.0
382+
383+The `onOpen` and `onClose` settings now provide the `SockAddr` of the client,
384+and `onOpen` can return a `Bool` which will close the connection. The
385+`responseRaw` response has been added, which provides a more elegant way to
386+handle WebSockets than the previous `settingsIntercept`. The old settings
387+accessors have been deprecated in favor of new setters, which will allow
388+settings changes to be made in the future without breaking backwards
389+compatibility.
390+
391+## 2.0.0
392+
393+ResourceT is not used anymore. Request and Response is now abstract data types.
394+To use their constructors, Internal module should be imported.
395+
396+## 1.3.9
397+
398+Support for byte range requests.
399+
400+## 1.3.7
401+
402+Sockets now have `FD_CLOEXEC` set on them. This behavior is more secure, and
403+the change should not affect the vast majority of use cases. However, it
404+appeared that this is buggy and is fixed in 2.0.0.
warp/LICENSEnew file+20
@@ -0,0 +1,20 @@
1+Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2+
3+Permission is hereby granted, free of charge, to any person obtaining
4+a copy of this software and associated documentation files (the
5+"Software"), to deal in the Software without restriction, including
6+without limitation the rights to use, copy, modify, merge, publish,
7+distribute, sublicense, and/or sell copies of the Software, and to
8+permit persons to whom the Software is furnished to do so, subject to
9+the following conditions:
10+
11+The above copyright notice and this permission notice shall be
12+included in all copies or substantial portions of the Software.
13+
14+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
warp/Network/Wai/Handler/Warp.hsnew file+509
@@ -0,0 +1,509 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE PatternGuards #-}
4+{-# OPTIONS_GHC -fno-warn-deprecations #-}
5+
6+---------------------------------------------------------
7+--
8+-- Module : Network.Wai.Handler.Warp
9+-- Copyright : Michael Snoyman
10+-- License : BSD3
11+--
12+-- Maintainer : Michael Snoyman <michael@snoyman.com>
13+-- Stability : Stable
14+-- Portability : portable
15+--
16+-- A fast, light-weight HTTP server handler for WAI.
17+--
18+---------------------------------------------------------
19+
20+-- | A fast, light-weight HTTP server handler for WAI.
21+--
22+-- HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported. For HTTP\/2,
23+-- Warp supports direct and ALPN (in TLS) but not upgrade.
24+--
25+-- Note on slowloris timeouts: to prevent slowloris attacks, timeouts are used
26+-- at various points in request receiving and response sending. One interesting
27+-- corner case is partial request body consumption; in that case, Warp's
28+-- timeout handling is still in effect, and the timeout will not be triggered
29+-- again. Therefore, it is recommended that once you start consuming the
30+-- request body, you either:
31+--
32+-- * consume the entire body promptly
33+--
34+-- * call the 'pauseTimeout' function
35+--
36+-- For more information, see <https://github.com/yesodweb/wai/issues/351>.
37+--
38+--
39+module Network.Wai.Handler.Warp (
40+ -- * Run a Warp server
41+ -- | All of these automatically serve the same 'Application' over HTTP\/1,
42+ -- HTTP\/1.1, and HTTP\/2.
43+ run
44+ , runEnv
45+ , runSettings
46+ , runSettingsSocket
47+ -- * Settings
48+ , Settings
49+ , defaultSettings
50+ -- ** Setters
51+ , setPort
52+ , setHost
53+ , setOnException
54+ , setOnExceptionResponse
55+ , setOnOpen
56+ , setOnClose
57+ , setTimeout
58+ , setManager
59+ , setFdCacheDuration
60+ , setFileInfoCacheDuration
61+ , setBeforeMainLoop
62+ , setNoParsePath
63+ , setInstallShutdownHandler
64+ , setServerName
65+ , setMaximumBodyFlush
66+ , setFork
67+ , setProxyProtocolNone
68+ , setProxyProtocolRequired
69+ , setProxyProtocolOptional
70+ , setSlowlorisSize
71+ , setHTTP2Disabled
72+ , setLogger
73+ , setServerPushLogger
74+ , setGracefulShutdownTimeout
75+ , setGracefulCloseTimeout1
76+ , setGracefulCloseTimeout2
77+ , setMaxTotalHeaderLength
78+ -- ** Getters
79+ , getPort
80+ , getHost
81+ , getOnOpen
82+ , getOnClose
83+ , getOnException
84+ , getGracefulShutdownTimeout
85+ , getGracefulCloseTimeout1
86+ , getGracefulCloseTimeout2
87+ -- ** Exception handler
88+ , defaultOnException
89+ , defaultShouldDisplayException
90+ -- ** Exception response handler
91+ , defaultOnExceptionResponse
92+ , exceptionResponseForDebug
93+ -- * Data types
94+ , HostPreference
95+ , Port
96+ , InvalidRequest (..)
97+ -- * Utilities
98+ , pauseTimeout
99+ , FileInfo(..)
100+ , getFileInfo
101+ , clientCertificate
102+ , withApplication
103+ , withApplicationSettings
104+ , testWithApplication
105+ , testWithApplicationSettings
106+ , openFreePort
107+ -- * Version
108+ , warpVersion
109+ -- * HTTP/2
110+ -- ** HTTP2 data
111+ , HTTP2Data
112+ , http2dataPushPromise
113+ , http2dataTrailers
114+ , defaultHTTP2Data
115+ , getHTTP2Data
116+ , setHTTP2Data
117+ , modifyHTTP2Data
118+ -- ** Push promise
119+ , PushPromise
120+ , promisedPath
121+ , promisedFile
122+ , promisedResponseHeaders
123+ , promisedWeight
124+ , defaultPushPromise
125+ ) where
126+
127+import Control.Exception (SomeException, throwIO)
128+import Data.Streaming.Network (HostPreference)
129+import qualified Data.Vault.Lazy as Vault
130+import Data.X509
131+import qualified Network.HTTP.Types as H
132+import Network.Socket (SockAddr)
133+import Network.Wai (Request, Response, vault)
134+import System.TimeManager
135+
136+import Network.Wai.Handler.Warp.FileInfoCache
137+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data, setHTTP2Data, modifyHTTP2Data)
138+import Network.Wai.Handler.Warp.HTTP2.Types
139+import Network.Wai.Handler.Warp.Imports
140+import Network.Wai.Handler.Warp.Request
141+import Network.Wai.Handler.Warp.Response (warpVersion)
142+import Network.Wai.Handler.Warp.Run
143+import Network.Wai.Handler.Warp.Settings
144+import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
145+import Network.Wai.Handler.Warp.WithApplication
146+
147+-- | Port to listen on. Default value: 3000
148+--
149+-- Since 2.1.0
150+setPort :: Port -> Settings -> Settings
151+setPort x y = y { settingsPort = x }
152+
153+-- | Interface to bind to. Default value: HostIPv4
154+--
155+-- Since 2.1.0
156+setHost :: HostPreference -> Settings -> Settings
157+setHost x y = y { settingsHost = x }
158+
159+-- | What to do with exceptions thrown by either the application or server.
160+-- Default: 'defaultOnException'
161+--
162+-- Since 2.1.0
163+setOnException :: (Maybe Request -> SomeException -> IO ()) -> Settings -> Settings
164+setOnException x y = y { settingsOnException = x }
165+
166+-- | A function to create a `Response` when an exception occurs.
167+-- Default: 'defaultOnExceptionResponse'
168+--
169+-- Note that an application can handle its own exceptions without interfering with Warp:
170+--
171+-- > myApp :: Application
172+-- > myApp request respond = innerApp `catch` onError
173+-- > where
174+-- > onError = respond . response500 request
175+-- >
176+-- > response500 :: Request -> SomeException -> Response
177+-- > response500 req someEx = responseLBS status500 -- ...
178+--
179+-- Since 2.1.0
180+setOnExceptionResponse :: (SomeException -> Response) -> Settings -> Settings
181+setOnExceptionResponse x y = y { settingsOnExceptionResponse = x }
182+
183+-- | What to do when a connection is opened. When 'False' is returned, the
184+-- connection is closed immediately. Otherwise, the connection is going on.
185+-- Default: always returns 'True'.
186+--
187+-- Since 2.1.0
188+setOnOpen :: (SockAddr -> IO Bool) -> Settings -> Settings
189+setOnOpen x y = y { settingsOnOpen = x }
190+
191+-- | What to do when a connection is closed. Default: do nothing.
192+--
193+-- Since 2.1.0
194+setOnClose :: (SockAddr -> IO ()) -> Settings -> Settings
195+setOnClose x y = y { settingsOnClose = x }
196+
197+-- | Timeout value in seconds. Default value: 30
198+--
199+-- Since 2.1.0
200+setTimeout :: Int -> Settings -> Settings
201+setTimeout x y = y { settingsTimeout = x }
202+
203+-- | Use an existing timeout manager instead of spawning a new one. If used,
204+-- 'settingsTimeout' is ignored.
205+--
206+-- Since 2.1.0
207+setManager :: Manager -> Settings -> Settings
208+setManager x y = y { settingsManager = Just x }
209+
210+-- | Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used.
211+--
212+-- The FD cache is an optimization that is useful for servers dealing with
213+-- static files. However, if files are being modified, it can cause incorrect
214+-- results in some cases. Therefore, we disable it by default. If you know that
215+-- your files will be static or you prefer performance to file consistency,
216+-- it's recommended to turn this on; a reasonable value for those cases is 10.
217+-- Enabling this cache results in drastic performance improvement for file
218+-- transfers.
219+--
220+-- Default value: 0, was previously 10
221+--
222+-- Since 3.0.13
223+setFdCacheDuration :: Int -> Settings -> Settings
224+setFdCacheDuration x y = y { settingsFdCacheDuration = x }
225+
226+-- | Cache duration time of file information in seconds. 0 means that the cache mechanism is not used.
227+--
228+-- The file information cache is an optimization that is useful for servers dealing with
229+-- static files. However, if files are being modified, it can cause incorrect
230+-- results in some cases. Therefore, we disable it by default. If you know that
231+-- your files will be static or you prefer performance to file consistency,
232+-- it's recommended to turn this on; a reasonable value for those cases is 10.
233+-- Enabling this cache results in drastic performance improvement for file
234+-- transfers.
235+--
236+-- Default value: 0
237+setFileInfoCacheDuration :: Int -> Settings -> Settings
238+setFileInfoCacheDuration x y = y { settingsFileInfoCacheDuration = x }
239+
240+-- | Code to run after the listening socket is ready but before entering
241+-- the main event loop. Useful for signaling to tests that they can start
242+-- running, or to drop permissions after binding to a restricted port.
243+--
244+-- Default: do nothing.
245+--
246+-- Since 2.1.0
247+setBeforeMainLoop :: IO () -> Settings -> Settings
248+setBeforeMainLoop x y = y { settingsBeforeMainLoop = x }
249+
250+-- | Perform no parsing on the rawPathInfo.
251+--
252+-- This is useful for writing HTTP proxies.
253+--
254+-- Default: False
255+--
256+-- Since 2.1.0
257+setNoParsePath :: Bool -> Settings -> Settings
258+setNoParsePath x y = y { settingsNoParsePath = x }
259+
260+-- | Get the listening port.
261+--
262+-- Since 2.1.1
263+getPort :: Settings -> Port
264+getPort = settingsPort
265+
266+-- | Get the interface to bind to.
267+--
268+-- Since 2.1.1
269+getHost :: Settings -> HostPreference
270+getHost = settingsHost
271+
272+-- | Get the action on opening connection.
273+getOnOpen :: Settings -> SockAddr -> IO Bool
274+getOnOpen = settingsOnOpen
275+
276+-- | Get the action on closeing connection.
277+getOnClose :: Settings -> SockAddr -> IO ()
278+getOnClose = settingsOnClose
279+
280+-- | Get the exception handler.
281+getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
282+getOnException = settingsOnException
283+
284+-- | Get the graceful shutdown timeout
285+--
286+-- Since 3.2.8
287+getGracefulShutdownTimeout :: Settings -> Maybe Int
288+getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
289+
290+-- | A code to install shutdown handler.
291+--
292+-- For instance, this code should set up a UNIX signal
293+-- handler. The handler should call the first argument,
294+-- which closes the listen socket, at shutdown.
295+--
296+-- Example usage:
297+--
298+-- @
299+-- settings :: IO () -> 'Settings'
300+-- settings shutdownAction = 'setInstallShutdownHandler' shutdownHandler 'defaultSettings'
301+-- __where__
302+-- shutdownHandler closeSocket =
303+-- void $ 'System.Posix.Signals.installHandler' 'System.Posix.Signals.sigTERM' ('System.Posix.Signals.Catch' $ shutdownAction >> closeSocket) 'Nothing'
304+-- @
305+--
306+-- Note that by default, the graceful shutdown mode lasts indefinitely
307+-- (see 'setGracefulShutdownTimeout'). If you install a signal handler as above,
308+-- upon receiving that signal, the custon shutdown action will run /and/ all
309+-- outstanding requests will be handled.
310+--
311+-- You may instead prefer to do one or both of the following:
312+--
313+-- * Only wait a finite amount of time for outstanding requests to complete,
314+-- using 'setGracefulShutdownTimeout'.
315+-- * Only catch one signal, so the second hard-kills the Warp server, using
316+-- 'System.Posix.Signals.CatchOnce'.
317+--
318+-- Default: does not install any code.
319+--
320+-- Since 3.0.1
321+setInstallShutdownHandler :: (IO () -> IO ()) -> Settings -> Settings
322+setInstallShutdownHandler x y = y { settingsInstallShutdownHandler = x }
323+
324+-- | Default server name to be sent as the \"Server:\" header
325+-- if an application does not set one.
326+-- If an empty string is set, the \"Server:\" header is not sent.
327+-- This is true even if an application set one.
328+--
329+-- Since 3.0.2
330+setServerName :: ByteString -> Settings -> Settings
331+setServerName x y = y { settingsServerName = x }
332+
333+-- | The maximum number of bytes to flush from an unconsumed request body.
334+--
335+-- By default, Warp does not flush the request body so that, if a large body is
336+-- present, the connection is simply terminated instead of wasting time and
337+-- bandwidth on transmitting it. However, some clients do not deal with that
338+-- situation well. You can either change this setting to @Nothing@ to flush the
339+-- entire body in all cases, or in your application ensure that you always
340+-- consume the entire request body.
341+--
342+-- Default: 8192 bytes.
343+--
344+-- Since 3.0.3
345+setMaximumBodyFlush :: Maybe Int -> Settings -> Settings
346+setMaximumBodyFlush x y
347+ | Just x' <- x, x' < 0 = error "setMaximumBodyFlush: must be positive"
348+ | otherwise = y { settingsMaximumBodyFlush = x }
349+
350+-- | Code to fork a new thread to accept a connection.
351+--
352+-- This may be useful if you need OS bound threads, or if
353+-- you wish to develop an alternative threading model.
354+--
355+-- Default: void . forkIOWithUnmask
356+--
357+-- Since 3.0.4
358+setFork :: (((forall a. IO a -> IO a) -> IO ()) -> IO ()) -> Settings -> Settings
359+setFork fork' s = s { settingsFork = fork' }
360+
361+-- | Do not use the PROXY protocol.
362+--
363+-- Since 3.0.5
364+setProxyProtocolNone :: Settings -> Settings
365+setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
366+
367+-- | Require PROXY header.
368+--
369+-- This is for cases where a "dumb" TCP/SSL proxy is being used, which cannot
370+-- add an @X-Forwarded-For@ HTTP header field but has enabled support for the
371+-- PROXY protocol.
372+--
373+-- See <http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt> and
374+-- <http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol>.
375+--
376+-- Only the human-readable header format (version 1) is supported. The binary
377+-- header format (version 2) is /not/ supported.
378+--
379+-- Since 3.0.5
380+setProxyProtocolRequired :: Settings -> Settings
381+setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
382+
383+-- | Use the PROXY header if it exists, but also accept
384+-- connections without the header. See 'setProxyProtocolRequired'.
385+--
386+-- WARNING: This is contrary to the PROXY protocol specification and
387+-- using it can indicate a security problem with your
388+-- architecture if the web server is directly accessible
389+-- to the public, since it would allow easy IP address
390+-- spoofing. However, it can be useful in some cases,
391+-- such as if a load balancer health check uses regular
392+-- HTTP without the PROXY header, but proxied
393+-- connections /do/ include the PROXY header.
394+--
395+-- Since 3.0.5
396+setProxyProtocolOptional :: Settings -> Settings
397+setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
398+
399+-- | Size in bytes read to prevent Slowloris attacks. Default value: 2048
400+--
401+-- Since 3.1.2
402+setSlowlorisSize :: Int -> Settings -> Settings
403+setSlowlorisSize x y = y { settingsSlowlorisSize = x }
404+
405+-- | Disable HTTP2.
406+--
407+-- Since 3.1.7
408+setHTTP2Disabled :: Settings -> Settings
409+setHTTP2Disabled y = y { settingsHTTP2Enabled = False }
410+
411+-- | Setting a log function.
412+--
413+-- Since 3.X.X
414+setLogger :: (Request -> H.Status -> Maybe Integer -> IO ()) -- ^ request, status, maybe file-size
415+ -> Settings
416+ -> Settings
417+setLogger lgr y = y { settingsLogger = lgr }
418+
419+-- | Setting a log function for HTTP/2 server push.
420+--
421+-- Since: 3.2.7
422+setServerPushLogger :: (Request -> ByteString -> Integer -> IO ()) -- ^ request, path, file-size
423+ -> Settings
424+ -> Settings
425+setServerPushLogger lgr y = y { settingsServerPushLogger = lgr }
426+
427+-- | Set the graceful shutdown timeout. A timeout of `Nothing' will
428+-- wait indefinitely, and a number, if provided, will be treated as seconds
429+-- to wait for requests to finish, before shutting down the server entirely.
430+--
431+-- Graceful shutdown mode is entered when the server socket is closed; see
432+-- 'setInstallShutdownHandler' for an example of how this could be done in
433+-- response to a UNIX signal.
434+--
435+-- Since 3.2.8
436+setGracefulShutdownTimeout :: Maybe Int
437+ -> Settings -> Settings
438+setGracefulShutdownTimeout time y = y { settingsGracefulShutdownTimeout = time }
439+
440+-- | Set the maximum header size that Warp will tolerate when using HTTP/1.x.
441+--
442+-- Since 3.3.8
443+setMaxTotalHeaderLength :: Int -> Settings -> Settings
444+setMaxTotalHeaderLength maxTotalHeaderLength settings = settings
445+ { settingsMaxTotalHeaderLength = maxTotalHeaderLength }
446+
447+-- | Explicitly pause the slowloris timeout.
448+--
449+-- This is useful for cases where you partially consume a request body. For
450+-- more information, see <https://github.com/yesodweb/wai/issues/351>
451+--
452+-- Since 3.0.10
453+pauseTimeout :: Request -> IO ()
454+pauseTimeout = fromMaybe (return ()) . Vault.lookup pauseTimeoutKey . vault
455+
456+-- | Getting file information of the target file.
457+--
458+-- This function first uses a stat(2) or similar system call
459+-- to obtain information of the target file, then registers
460+-- it into the internal cache.
461+-- From the next time, the information is obtained
462+-- from the cache. This reduces the overhead to call the system call.
463+-- The internal cache is refreshed every duration specified by
464+-- 'setFileInfoCacheDuration'.
465+--
466+-- This function throws an 'IO' exception if the information is not
467+-- available. For instance, the target file does not exist.
468+-- If this function is used an a Request generated by a WAI
469+-- backend besides Warp, it also throws an 'IO' exception.
470+--
471+-- Since 3.1.10
472+getFileInfo :: Request -> FilePath -> IO FileInfo
473+getFileInfo = fromMaybe (\_ -> throwIO (userError "getFileInfo")) . Vault.lookup getFileInfoKey . vault
474+
475+-- | A timeout to limit the time (in milliseconds) waiting for
476+-- FIN for HTTP/1.x. 0 means uses immediate close.
477+-- Default: 0.
478+--
479+-- Since 3.3.5
480+setGracefulCloseTimeout1 :: Int -> Settings -> Settings
481+setGracefulCloseTimeout1 x y = y { settingsGracefulCloseTimeout1 = x }
482+
483+-- | A timeout to limit the time (in milliseconds) waiting for
484+-- FIN for HTTP/1.x. 0 means uses immediate close.
485+--
486+-- Since 3.3.5
487+getGracefulCloseTimeout1 :: Settings -> Int
488+getGracefulCloseTimeout1 = settingsGracefulCloseTimeout1
489+
490+-- | A timeout to limit the time (in milliseconds) waiting for
491+-- FIN for HTTP/2. 0 means uses immediate close.
492+-- Default: 2000.
493+--
494+-- Since 3.3.5
495+setGracefulCloseTimeout2 :: Int -> Settings -> Settings
496+setGracefulCloseTimeout2 x y = y { settingsGracefulCloseTimeout2 = x }
497+
498+-- | A timeout to limit the time (in milliseconds) waiting for
499+-- FIN for HTTP/2. 0 means uses immediate close.
500+--
501+-- Since 3.3.5
502+getGracefulCloseTimeout2 :: Settings -> Int
503+getGracefulCloseTimeout2 = settingsGracefulCloseTimeout2
504+
505+-- | Getting information of client certificate.
506+--
507+-- Since 3.3.5
508+clientCertificate :: Request -> Maybe CertificateChain
509+clientCertificate = join . Vault.lookup getClientCertificateKey . vault
warp/Network/Wai/Handler/Warp/Buffer.hsnew file+109
@@ -0,0 +1,109 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.Buffer (
4+ bufferSize
5+ , allocateBuffer
6+ , freeBuffer
7+ , mallocBS
8+ , newBufferPool
9+ , withBufferPool
10+ , toBuilderBuffer
11+ , copy
12+ , bufferIO
13+ ) where
14+
15+import qualified Data.ByteString as BS
16+import Data.ByteString.Internal (memcpy)
17+import Data.ByteString.Unsafe (unsafeTake, unsafeDrop)
18+import Data.IORef (newIORef, readIORef, writeIORef)
19+import qualified Data.Streaming.ByteString.Builder.Buffer as B (Buffer (..))
20+import Foreign.ForeignPtr
21+import Foreign.Marshal.Alloc (mallocBytes, free, finalizerFree)
22+import Foreign.Ptr (castPtr, plusPtr)
23+
24+import Network.Wai.Handler.Warp.Imports
25+import Network.Wai.Handler.Warp.Types
26+
27+----------------------------------------------------------------
28+
29+-- | The default size of the write buffer: 16384 (2^14 = 1024 * 16).
30+-- This is the maximum size of TLS record.
31+-- This is also the maximum size of HTTP/2 frame payload
32+-- (excluding frame header).
33+bufferSize :: BufSize
34+bufferSize = 16384
35+
36+-- | Allocating a buffer with malloc().
37+allocateBuffer :: Int -> IO Buffer
38+allocateBuffer = mallocBytes
39+
40+-- | Releasing a buffer with free().
41+freeBuffer :: Buffer -> IO ()
42+freeBuffer = free
43+
44+----------------------------------------------------------------
45+
46+largeBufferSize :: Int
47+largeBufferSize = 16384
48+
49+minBufferSize :: Int
50+minBufferSize = 2048
51+
52+newBufferPool :: IO BufferPool
53+newBufferPool = newIORef BS.empty
54+
55+mallocBS :: Int -> IO ByteString
56+mallocBS size = do
57+ ptr <- allocateBuffer size
58+ fptr <- newForeignPtr finalizerFree ptr
59+ return $! PS fptr 0 size
60+{-# INLINE mallocBS #-}
61+
62+usefulBuffer :: ByteString -> Bool
63+usefulBuffer buffer = BS.length buffer >= minBufferSize
64+{-# INLINE usefulBuffer #-}
65+
66+getBuffer :: BufferPool -> IO ByteString
67+getBuffer pool = do
68+ buffer <- readIORef pool
69+ if usefulBuffer buffer then return buffer else mallocBS largeBufferSize
70+{-# INLINE getBuffer #-}
71+
72+putBuffer :: BufferPool -> ByteString -> IO ()
73+putBuffer pool buffer = writeIORef pool buffer
74+{-# INLINE putBuffer #-}
75+
76+withForeignBuffer :: ByteString -> ((Buffer, BufSize) -> IO Int) -> IO Int
77+withForeignBuffer (PS ps s l) f = withForeignPtr ps $ \p -> f (castPtr p `plusPtr` s, l)
78+{-# INLINE withForeignBuffer #-}
79+
80+withBufferPool :: BufferPool -> ((Buffer, BufSize) -> IO Int) -> IO ByteString
81+withBufferPool pool f = do
82+ buffer <- getBuffer pool
83+ consumed <- withForeignBuffer buffer f
84+ putBuffer pool $! unsafeDrop consumed buffer
85+ return $! unsafeTake consumed buffer
86+{-# INLINE withBufferPool #-}
87+
88+----------------------------------------------------------------
89+--
90+-- Utilities
91+--
92+
93+toBuilderBuffer :: Buffer -> BufSize -> IO B.Buffer
94+toBuilderBuffer ptr size = do
95+ fptr <- newForeignPtr_ ptr
96+ return $ B.Buffer fptr ptr ptr (ptr `plusPtr` size)
97+
98+-- | Copying the bytestring to the buffer.
99+-- This function returns the point where the next copy should start.
100+copy :: Buffer -> ByteString -> IO Buffer
101+copy !ptr (PS fp o l) = withForeignPtr fp $ \p -> do
102+ memcpy ptr (p `plusPtr` o) (fromIntegral l)
103+ return $! ptr `plusPtr` l
104+{-# INLINE copy #-}
105+
106+bufferIO :: Buffer -> Int -> (ByteString -> IO ()) -> IO ()
107+bufferIO ptr siz io = do
108+ fptr <- newForeignPtr_ ptr
109+ io $ PS fptr 0 siz
warp/Network/Wai/Handler/Warp/Conduit.hsnew file+169
@@ -0,0 +1,169 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.Conduit where
4+
5+import Control.Exception
6+import qualified Data.ByteString as S
7+import qualified Data.IORef as I
8+
9+import Network.Wai.Handler.Warp.Imports
10+import Network.Wai.Handler.Warp.Types
11+
12+----------------------------------------------------------------
13+
14+-- | Contains a @Source@ and a byte count that is still to be read in.
15+data ISource = ISource !Source !(I.IORef Int)
16+
17+mkISource :: Source -> Int -> IO ISource
18+mkISource src cnt = do
19+ ref <- I.newIORef cnt
20+ return $! ISource src ref
21+
22+-- | Given an @IsolatedBSSource@ provide a @Source@ that only allows up to the
23+-- specified number of bytes to be passed downstream. All leftovers should be
24+-- retained within the @Source@. If there are not enough bytes available,
25+-- throws a @ConnectionClosedByPeer@ exception.
26+readISource :: ISource -> IO ByteString
27+readISource (ISource src ref) = do
28+ count <- I.readIORef ref
29+ if count == 0
30+ then return S.empty
31+ else do
32+
33+ bs <- readSource src
34+
35+ -- If no chunk available, then there aren't enough bytes in the
36+ -- stream. Throw a ConnectionClosedByPeer
37+ when (S.null bs) $ throwIO ConnectionClosedByPeer
38+
39+ let -- How many of the bytes in this chunk to send downstream
40+ toSend = min count (S.length bs)
41+ -- How many bytes will still remain to be sent downstream
42+ count' = count - toSend
43+ case () of
44+ ()
45+ -- The expected count is greater than the size of the
46+ -- chunk we just read. Send the entire chunk
47+ -- downstream, and then loop on this function for the
48+ -- next chunk.
49+ | count' > 0 -> do
50+ I.writeIORef ref count'
51+ return bs
52+
53+ -- Some of the bytes in this chunk should not be sent
54+ -- downstream. Split up the chunk into the sent and
55+ -- not-sent parts, add the not-sent parts onto the new
56+ -- source, and send the rest of the chunk downstream.
57+ | otherwise -> do
58+ let (x, y) = S.splitAt toSend bs
59+ leftoverSource src y
60+ assert (count' == 0) $ I.writeIORef ref count'
61+ return x
62+
63+----------------------------------------------------------------
64+
65+data CSource = CSource !Source !(I.IORef ChunkState)
66+
67+data ChunkState = NeedLen
68+ | NeedLenNewline
69+ | HaveLen Word
70+ | DoneChunking
71+ deriving Show
72+
73+mkCSource :: Source -> IO CSource
74+mkCSource src = do
75+ ref <- I.newIORef NeedLen
76+ return $! CSource src ref
77+
78+readCSource :: CSource -> IO ByteString
79+readCSource (CSource src ref) = do
80+ mlen <- I.readIORef ref
81+ go mlen
82+ where
83+ withLen 0 bs = do
84+ leftoverSource src bs
85+ dropCRLF
86+ yield' S.empty DoneChunking
87+ withLen len bs
88+ | S.null bs = do
89+ -- FIXME should this throw an exception if len > 0?
90+ I.writeIORef ref DoneChunking
91+ return S.empty
92+ | otherwise =
93+ case S.length bs `compare` fromIntegral len of
94+ EQ -> yield' bs NeedLenNewline
95+ LT -> yield' bs $ HaveLen $ len - fromIntegral (S.length bs)
96+ GT -> do
97+ let (x, y) = S.splitAt (fromIntegral len) bs
98+ leftoverSource src y
99+ yield' x NeedLenNewline
100+
101+ yield' bs mlen = do
102+ I.writeIORef ref mlen
103+ return bs
104+
105+ dropCRLF = do
106+ bs <- readSource src
107+ case S.uncons bs of
108+ Nothing -> return ()
109+ Just (13, bs') -> dropLF bs'
110+ Just (10, bs') -> leftoverSource src bs'
111+ Just _ -> leftoverSource src bs
112+
113+ dropLF bs =
114+ case S.uncons bs of
115+ Nothing -> do
116+ bs2 <- readSource' src
117+ unless (S.null bs2) $ dropLF bs2
118+ Just (10, bs') -> leftoverSource src bs'
119+ Just _ -> leftoverSource src bs
120+
121+ go NeedLen = getLen
122+ go NeedLenNewline = dropCRLF >> getLen
123+ go (HaveLen 0) = do
124+ -- Drop the final CRLF
125+ dropCRLF
126+ I.writeIORef ref DoneChunking
127+ return S.empty
128+ go (HaveLen len) = do
129+ bs <- readSource src
130+ withLen len bs
131+ go DoneChunking = return S.empty
132+
133+ -- Get the length from the source, and then pass off control to withLen
134+ getLen = do
135+ bs <- readSource src
136+ if S.null bs
137+ then do
138+ I.writeIORef ref $ assert False $ HaveLen 0
139+ return S.empty
140+ else do
141+ (x, y) <-
142+ case S.break (== 10) bs of
143+ (x, y)
144+ | S.null y -> do
145+ bs2 <- readSource' src
146+ return $ if S.null bs2
147+ then (x, y)
148+ else S.break (== 10) $ bs `S.append` bs2
149+ | otherwise -> return (x, y)
150+ let w =
151+ S.foldl' (\i c -> i * 16 + fromIntegral (hexToWord c)) 0
152+ $ S.takeWhile isHexDigit x
153+
154+ let y' = S.drop 1 y
155+ y'' <-
156+ if S.null y'
157+ then readSource src
158+ else return y'
159+ withLen w y''
160+
161+ hexToWord w
162+ | w < 58 = w - 48
163+ | w < 71 = w - 55
164+ | otherwise = w - 87
165+
166+isHexDigit :: Word8 -> Bool
167+isHexDigit w = w >= 48 && w <= 57
168+ || w >= 65 && w <= 70
169+ || w >= 97 && w <= 102
warp/Network/Wai/Handler/Warp/Counter.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.Counter (
4+ Counter
5+ , newCounter
6+ , waitForZero
7+ , increase
8+ , decrease
9+ ) where
10+
11+import Control.Concurrent.STM
12+
13+import Network.Wai.Handler.Warp.Imports
14+
15+
16+newtype Counter = Counter (TVar Int)
17+
18+newCounter :: IO Counter
19+newCounter = Counter <$> newTVarIO 0
20+
21+waitForZero :: Counter -> IO ()
22+waitForZero (Counter ref) = atomically $ do
23+ x <- readTVar ref
24+ unless (x == 0) retry
25+
26+increase :: Counter -> IO ()
27+increase (Counter ref) = atomically $ modifyTVar' ref $ \x -> x + 1
28+
29+decrease :: Counter -> IO ()
30+decrease (Counter ref) = atomically $ modifyTVar' ref $ \x -> x - 1
warp/Network/Wai/Handler/Warp/Date.hsnew file+41
@@ -0,0 +1,41 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.Date (
4+ withDateCache
5+ , GMTDate
6+ ) where
7+
8+import Control.AutoUpdate (defaultUpdateSettings, updateAction, mkAutoUpdate)
9+import Data.ByteString
10+import Network.HTTP.Date
11+
12+#if WINDOWS
13+import Data.Time (UTCTime, getCurrentTime)
14+import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
15+import Foreign.C.Types (CTime(..))
16+#else
17+import System.Posix (epochTime)
18+#endif
19+
20+-- | The type of the Date header value.
21+type GMTDate = ByteString
22+
23+-- | Creating 'DateCache' and executing the action.
24+withDateCache :: (IO GMTDate -> IO a) -> IO a
25+withDateCache action = initialize >>= action
26+
27+initialize :: IO (IO GMTDate)
28+initialize = mkAutoUpdate defaultUpdateSettings {
29+ updateAction = formatHTTPDate <$> getCurrentHTTPDate
30+ }
31+
32+#ifdef WINDOWS
33+uToH :: UTCTime -> HTTPDate
34+uToH = epochTimeToHTTPDate . CTime . truncate . utcTimeToPOSIXSeconds
35+
36+getCurrentHTTPDate :: IO HTTPDate
37+getCurrentHTTPDate = uToH <$> getCurrentTime
38+#else
39+getCurrentHTTPDate :: IO HTTPDate
40+getCurrentHTTPDate = epochTimeToHTTPDate <$> epochTime
41+#endif
warp/Network/Wai/Handler/Warp/FdCache.hsnew file+142
@@ -0,0 +1,142 @@
1+{-# LANGUAGE BangPatterns, CPP #-}
2+
3+-- | File descriptor cache to avoid locks in kernel.
4+
5+module Network.Wai.Handler.Warp.FdCache (
6+ withFdCache
7+ , Fd
8+ , Refresh
9+#ifndef WINDOWS
10+ , openFile
11+ , closeFile
12+ , setFileCloseOnExec
13+#endif
14+ ) where
15+
16+#ifndef WINDOWS
17+import Control.Exception (bracket)
18+import Control.Reaper
19+import Data.IORef
20+import Network.Wai.Handler.Warp.MultiMap as MM
21+import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd, FdOption(CloseOnExec), setFdOption)
22+#endif
23+import System.Posix.Types (Fd)
24+
25+----------------------------------------------------------------
26+
27+-- | An action to activate a Fd cache entry.
28+type Refresh = IO ()
29+
30+getFdNothing :: FilePath -> IO (Maybe Fd, Refresh)
31+getFdNothing _ = return (Nothing, return ())
32+
33+----------------------------------------------------------------
34+
35+-- | Creating 'MutableFdCache' and executing the action in the second
36+-- argument. The first argument is a cache duration in second.
37+withFdCache :: Int -> ((FilePath -> IO (Maybe Fd, Refresh)) -> IO a) -> IO a
38+#ifdef WINDOWS
39+withFdCache _ action = action getFdNothing
40+#else
41+withFdCache 0 action = action getFdNothing
42+withFdCache duration action = bracket (initialize duration)
43+ terminate
44+ (action . getFd)
45+
46+----------------------------------------------------------------
47+
48+data Status = Active | Inactive
49+
50+newtype MutableStatus = MutableStatus (IORef Status)
51+
52+status :: MutableStatus -> IO Status
53+status (MutableStatus ref) = readIORef ref
54+
55+newActiveStatus :: IO MutableStatus
56+newActiveStatus = MutableStatus <$> newIORef Active
57+
58+refresh :: MutableStatus -> Refresh
59+refresh (MutableStatus ref) = writeIORef ref Active
60+
61+inactive :: MutableStatus -> IO ()
62+inactive (MutableStatus ref) = writeIORef ref Inactive
63+
64+----------------------------------------------------------------
65+
66+data FdEntry = FdEntry !Fd !MutableStatus
67+
68+openFile :: FilePath -> IO Fd
69+openFile path = do
70+ fd <- openFd path ReadOnly Nothing defaultFileFlags{nonBlock=False}
71+ setFileCloseOnExec fd
72+ return fd
73+
74+closeFile :: Fd -> IO ()
75+closeFile = closeFd
76+
77+newFdEntry :: FilePath -> IO FdEntry
78+newFdEntry path = FdEntry <$> openFile path <*> newActiveStatus
79+
80+setFileCloseOnExec :: Fd -> IO ()
81+setFileCloseOnExec fd = setFdOption fd CloseOnExec True
82+
83+----------------------------------------------------------------
84+
85+type FdCache = MultiMap FdEntry
86+
87+-- | Mutable Fd cacher.
88+newtype MutableFdCache = MutableFdCache (Reaper FdCache (FilePath,FdEntry))
89+
90+fdCache :: MutableFdCache -> IO FdCache
91+fdCache (MutableFdCache reaper) = reaperRead reaper
92+
93+look :: MutableFdCache -> FilePath -> IO (Maybe FdEntry)
94+look mfc path = MM.lookup path <$> fdCache mfc
95+
96+----------------------------------------------------------------
97+
98+-- The first argument is a cache duration in second.
99+initialize :: Int -> IO MutableFdCache
100+initialize duration = MutableFdCache <$> mkReaper settings
101+ where
102+ settings = defaultReaperSettings {
103+ reaperAction = clean
104+ , reaperDelay = duration
105+ , reaperCons = uncurry insert
106+ , reaperNull = isEmpty
107+ , reaperEmpty = empty
108+ }
109+
110+clean :: FdCache -> IO (FdCache -> FdCache)
111+clean old = do
112+ new <- pruneWith old prune
113+ return $ merge new
114+ where
115+ prune (_,FdEntry fd mst) = status mst >>= act
116+ where
117+ act Active = inactive mst >> return True
118+ act Inactive = closeFd fd >> return False
119+
120+----------------------------------------------------------------
121+
122+terminate :: MutableFdCache -> IO ()
123+terminate (MutableFdCache reaper) = do
124+ !t <- reaperStop reaper
125+ mapM_ (closeIt . snd) $ toList t
126+ where
127+ closeIt (FdEntry fd _) = closeFd fd
128+
129+----------------------------------------------------------------
130+
131+-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
132+getFd :: MutableFdCache -> FilePath -> IO (Maybe Fd, Refresh)
133+getFd mfc@(MutableFdCache reaper) path = look mfc path >>= get
134+ where
135+ get Nothing = do
136+ ent@(FdEntry fd mst) <- newFdEntry path
137+ reaperAdd reaper (path,ent)
138+ return (Just fd, refresh mst)
139+ get (Just (FdEntry fd mst)) = do
140+ refresh mst
141+ return (Just fd, refresh mst)
142+#endif
warp/Network/Wai/Handler/Warp/File.hsnew file+152
@@ -0,0 +1,152 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
4+
5+module Network.Wai.Handler.Warp.File (
6+ RspFileInfo(..)
7+ , conditionalRequest
8+ , addContentHeadersForFilePart
9+ , H.parseByteRanges
10+ ) where
11+
12+import Data.Array ((!))
13+import qualified Data.ByteString.Char8 as C8 (pack)
14+import Network.HTTP.Date
15+import qualified Network.HTTP.Types as H
16+import qualified Network.HTTP.Types.Header as H
17+import Network.Wai
18+
19+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
20+import Network.Wai.Handler.Warp.Header
21+import Network.Wai.Handler.Warp.Imports
22+import Network.Wai.Handler.Warp.PackInt
23+
24+
25+-- $setup
26+-- >>> import Test.QuickCheck
27+
28+----------------------------------------------------------------
29+
30+data RspFileInfo = WithoutBody H.Status
31+ | WithBody H.Status H.ResponseHeaders Integer Integer
32+ deriving (Eq,Show)
33+
34+----------------------------------------------------------------
35+
36+conditionalRequest :: I.FileInfo
37+ -> H.ResponseHeaders
38+ -> IndexedHeader -- ^ Response
39+ -> IndexedHeader -- ^ Request
40+ -> RspFileInfo
41+conditionalRequest finfo hs0 rspidx reqidx = case condition of
42+ nobody@(WithoutBody _) -> nobody
43+ WithBody s _ off len -> let !hs1 = addContentHeaders hs0 off len size
44+ !hasLM = isJust $ rspidx ! fromEnum ResLastModified
45+ !hs = [ (H.hLastModified,date) | not hasLM ] ++ hs1
46+ in WithBody s hs off len
47+ where
48+ !mtime = I.fileInfoTime finfo
49+ !size = I.fileInfoSize finfo
50+ !date = I.fileInfoDate finfo
51+ !mcondition = ifmodified reqidx size mtime
52+ <|> ifunmodified reqidx size mtime
53+ <|> ifrange reqidx size mtime
54+ !condition = fromMaybe (unconditional reqidx size) mcondition
55+
56+----------------------------------------------------------------
57+
58+ifModifiedSince :: IndexedHeader -> Maybe HTTPDate
59+ifModifiedSince reqidx = reqidx ! fromEnum ReqIfModifiedSince >>= parseHTTPDate
60+
61+ifUnmodifiedSince :: IndexedHeader -> Maybe HTTPDate
62+ifUnmodifiedSince reqidx = reqidx ! fromEnum ReqIfUnmodifiedSince >>= parseHTTPDate
63+
64+ifRange :: IndexedHeader -> Maybe HTTPDate
65+ifRange reqidx = reqidx ! fromEnum ReqIfRange >>= parseHTTPDate
66+
67+----------------------------------------------------------------
68+
69+ifmodified :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
70+ifmodified reqidx size mtime = do
71+ date <- ifModifiedSince reqidx
72+ return $ if date /= mtime
73+ then unconditional reqidx size
74+ else WithoutBody H.notModified304
75+
76+ifunmodified :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
77+ifunmodified reqidx size mtime = do
78+ date <- ifUnmodifiedSince reqidx
79+ return $ if date == mtime
80+ then unconditional reqidx size
81+ else WithoutBody H.preconditionFailed412
82+
83+ifrange :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
84+ifrange reqidx size mtime = do
85+ date <- ifRange reqidx
86+ rng <- reqidx ! fromEnum ReqRange
87+ return $ if date == mtime
88+ then parseRange rng size
89+ else WithBody H.ok200 [] 0 size
90+
91+unconditional :: IndexedHeader -> Integer -> RspFileInfo
92+unconditional reqidx size = case reqidx ! fromEnum ReqRange of
93+ Nothing -> WithBody H.ok200 [] 0 size
94+ Just rng -> parseRange rng size
95+
96+----------------------------------------------------------------
97+
98+parseRange :: ByteString -> Integer -> RspFileInfo
99+parseRange rng size = case H.parseByteRanges rng of
100+ Nothing -> WithoutBody H.requestedRangeNotSatisfiable416
101+ Just [] -> WithoutBody H.requestedRangeNotSatisfiable416
102+ Just (r:_) -> let (!beg, !end) = checkRange r size
103+ !len = end - beg + 1
104+ s = if beg == 0 && end == size - 1 then
105+ H.ok200
106+ else
107+ H.partialContent206
108+ in WithBody s [] beg len
109+
110+checkRange :: H.ByteRange -> Integer -> (Integer, Integer)
111+checkRange (H.ByteRangeFrom beg) size = (beg, size - 1)
112+checkRange (H.ByteRangeFromTo beg end) size = (beg, min (size - 1) end)
113+checkRange (H.ByteRangeSuffix count) size = (max 0 (size - count), size - 1)
114+
115+----------------------------------------------------------------
116+
117+-- | @contentRangeHeader beg end total@ constructs a Content-Range 'H.Header'
118+-- for the range specified.
119+contentRangeHeader :: Integer -> Integer -> Integer -> H.Header
120+contentRangeHeader beg end total = (H.hContentRange, range)
121+ where
122+ range = C8.pack
123+ -- building with ShowS
124+ $ 'b' : 'y': 't' : 'e' : 's' : ' '
125+ : (if beg > end then ('*':) else
126+ showInt beg
127+ . ('-' :)
128+ . showInt end)
129+ ( '/'
130+ : showInt total "")
131+
132+addContentHeaders :: H.ResponseHeaders -> Integer -> Integer -> Integer -> H.ResponseHeaders
133+addContentHeaders hs off len size
134+ | len == size = hs'
135+ | otherwise = let !ctrng = contentRangeHeader off (off + len - 1) size
136+ in ctrng:hs'
137+ where
138+ !lengthBS = packIntegral len
139+ !hs' = (H.hContentLength, lengthBS) : (H.hAcceptRanges,"bytes") : hs
140+
141+-- |
142+--
143+-- >>> addContentHeadersForFilePart [] (FilePart 2 10 16)
144+-- [("Content-Range","bytes 2-11/16"),("Content-Length","10"),("Accept-Ranges","bytes")]
145+-- >>> addContentHeadersForFilePart [] (FilePart 0 16 16)
146+-- [("Content-Length","16"),("Accept-Ranges","bytes")]
147+addContentHeadersForFilePart :: H.ResponseHeaders -> FilePart -> H.ResponseHeaders
148+addContentHeadersForFilePart hs part = addContentHeaders hs off len size
149+ where
150+ off = filePartOffset part
151+ len = filePartByteCount part
152+ size = filePartFileSize part
warp/Network/Wai/Handler/Warp/FileInfoCache.hsnew file+108
@@ -0,0 +1,108 @@
1+{-# LANGUAGE RecordWildCards, CPP #-}
2+
3+module Network.Wai.Handler.Warp.FileInfoCache (
4+ FileInfo(..)
5+ , withFileInfoCache
6+ , getInfo -- test purpose only
7+ ) where
8+
9+import Control.Exception as E
10+import Control.Reaper
11+import Network.HTTP.Date
12+import System.PosixCompat.Files
13+
14+import Network.Wai.Handler.Warp.HashMap (HashMap)
15+import qualified Network.Wai.Handler.Warp.HashMap as M
16+import Network.Wai.Handler.Warp.Imports
17+
18+----------------------------------------------------------------
19+
20+-- | File information.
21+data FileInfo = FileInfo {
22+ fileInfoName :: !FilePath
23+ , fileInfoSize :: !Integer
24+ , fileInfoTime :: HTTPDate -- ^ Modification time
25+ , fileInfoDate :: ByteString -- ^ Modification time in the GMT format
26+ } deriving (Eq, Show)
27+
28+data Entry = Negative | Positive FileInfo
29+type Cache = HashMap Entry
30+type FileInfoCache = Reaper Cache (FilePath,Entry)
31+
32+----------------------------------------------------------------
33+
34+-- | Getting the file information corresponding to the file.
35+getInfo :: FilePath -> IO FileInfo
36+getInfo path = do
37+ fs <- getFileStatus path -- file access
38+ let regular = not (isDirectory fs)
39+ readable = fileMode fs `intersectFileModes` ownerReadMode /= 0
40+ if regular && readable then do
41+ let time = epochTimeToHTTPDate $ modificationTime fs
42+ date = formatHTTPDate time
43+ size = fromIntegral $ fileSize fs
44+ info = FileInfo {
45+ fileInfoName = path
46+ , fileInfoSize = size
47+ , fileInfoTime = time
48+ , fileInfoDate = date
49+ }
50+ return info
51+ else
52+ throwIO (userError "FileInfoCache:getInfo")
53+
54+getInfoNaive :: FilePath -> IO FileInfo
55+getInfoNaive = getInfo
56+
57+----------------------------------------------------------------
58+
59+getAndRegisterInfo :: FileInfoCache -> FilePath -> IO FileInfo
60+getAndRegisterInfo reaper@Reaper{..} path = do
61+ cache <- reaperRead
62+ case M.lookup path cache of
63+ Just Negative -> throwIO (userError "FileInfoCache:getAndRegisterInfo")
64+ Just (Positive x) -> return x
65+ Nothing -> positive reaper path
66+ `E.onException` negative reaper path
67+
68+positive :: FileInfoCache -> FilePath -> IO FileInfo
69+positive Reaper{..} path = do
70+ info <- getInfo path
71+ reaperAdd (path, Positive info)
72+ return info
73+
74+negative :: FileInfoCache -> FilePath -> IO FileInfo
75+negative Reaper{..} path = do
76+ reaperAdd (path, Negative)
77+ throwIO (userError "FileInfoCache:negative")
78+
79+----------------------------------------------------------------
80+
81+-- | Creating a file information cache
82+-- and executing the action in the second argument.
83+-- The first argument is a cache duration in second.
84+withFileInfoCache :: Int
85+ -> ((FilePath -> IO FileInfo) -> IO a)
86+ -> IO a
87+withFileInfoCache 0 action = action getInfoNaive
88+withFileInfoCache duration action =
89+ E.bracket (initialize duration)
90+ terminate
91+ (action . getAndRegisterInfo)
92+
93+initialize :: Int -> IO FileInfoCache
94+initialize duration = mkReaper settings
95+ where
96+ settings = defaultReaperSettings {
97+ reaperAction = override
98+ , reaperDelay = duration
99+ , reaperCons = \(path,v) -> M.insert path v
100+ , reaperNull = M.isEmpty
101+ , reaperEmpty = M.empty
102+ }
103+
104+override :: Cache -> IO (Cache -> Cache)
105+override _ = return $ const M.empty
106+
107+terminate :: FileInfoCache -> IO ()
108+terminate x = void $ reaperStop x
warp/Network/Wai/Handler/Warp/HTTP2.hsnew file+85
@@ -0,0 +1,85 @@
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+
7+module Network.Wai.Handler.Warp.HTTP2 (http2) where
8+
9+import qualified Data.IORef as I
10+import qualified Control.Exception as E
11+import qualified Network.HTTP2.Server as H2
12+import Network.Socket (SockAddr)
13+import Network.Wai
14+import Network.Wai.Internal (ResponseReceived(..))
15+import qualified System.TimeManager as T
16+
17+import Network.Wai.Handler.Warp.HTTP2.File
18+import Network.Wai.Handler.Warp.HTTP2.PushPromise
19+import Network.Wai.Handler.Warp.HTTP2.Request
20+import Network.Wai.Handler.Warp.HTTP2.Response
21+import Network.Wai.Handler.Warp.Imports
22+import qualified Network.Wai.Handler.Warp.Settings as S
23+import Network.Wai.Handler.Warp.Types
24+
25+----------------------------------------------------------------
26+
27+http2 :: Connection -> Transport -> InternalInfo -> SockAddr -> S.Settings -> (BufSize -> IO ByteString) -> (ByteString -> IO ()) -> Application -> IO ()
28+http2 conn transport ii addr settings readN send app =
29+ H2.run conf http2server
30+ where
31+ conf = H2.Config {
32+ confWriteBuffer = connWriteBuffer conn
33+ , confBufferSize = connBufferSize conn
34+ , confSendAll = send
35+ , confReadN = readN
36+ , confPositionReadMaker = pReadMaker ii
37+ }
38+
39+ http2server h2req aux response = do
40+ req <- toWAIRequest h2req aux
41+ ref <- I.newIORef Nothing
42+ eResponseReceived <- E.try $ app req $ \rsp -> do
43+ h2rsp <- fromResponse settings ii req rsp
44+ pps <- fromPushPromises ii req
45+ I.writeIORef ref $ Just (h2rsp, pps)
46+ _ <- response h2rsp pps
47+ return ResponseReceived
48+ case eResponseReceived of
49+ Right ResponseReceived -> do
50+ Just (h2rsp, pps) <- I.readIORef ref
51+ logResponse h2rsp req
52+ mapM_ (logPushPromise req) pps
53+ Left e@(E.SomeException _)
54+ -- killed by the local worker manager
55+ | Just E.ThreadKilled <- E.fromException e -> return ()
56+ -- killed by the local timeout manager
57+ | Just T.TimeoutThread <- E.fromException e -> return ()
58+ | otherwise -> do
59+ S.settingsOnException settings (Just req) e
60+ let ersp = S.settingsOnExceptionResponse settings e
61+ h2rsp' <- fromResponse settings ii req ersp
62+ _ <- response h2rsp' []
63+ logResponse h2rsp' req
64+ return ()
65+
66+ toWAIRequest h2req aux = toRequest ii settings addr hdr bdylen bdy th transport
67+ where
68+ !hdr = H2.requestHeaders h2req
69+ !bdy = H2.getRequestBodyChunk h2req
70+ !bdylen = H2.requestBodySize h2req
71+ !th = H2.auxTimeHandle aux
72+
73+ logResponse h2rsp req = logger req st msiz
74+ where
75+ !logger = S.settingsLogger settings
76+ !st = H2.responseStatus h2rsp
77+ !msiz = fromIntegral <$> H2.responseBodySize h2rsp
78+
79+ logPushPromise req pp = logger req path siz
80+ where
81+ !logger = S.settingsServerPushLogger settings
82+ !path = H2.promiseRequestPath pp
83+ !siz = case H2.responseBodySize $ H2.promiseResponse pp of
84+ Nothing -> 0
85+ Just s -> fromIntegral s
warp/Network/Wai/Handler/Warp/HTTP2/File.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.HTTP2.File where
4+
5+import Network.HTTP2.Server
6+
7+import Network.Wai.Handler.Warp.Types
8+
9+#ifdef WINDOWS
10+pReadMaker :: InternalInfo -> PositionReadMaker
11+pReadMaker _ = defaultPositionReadMaker
12+#else
13+import Network.Wai.Handler.Warp.FdCache
14+import Network.Wai.Handler.Warp.SendFile (positionRead)
15+
16+pReadMaker :: InternalInfo -> PositionReadMaker
17+pReadMaker ii path = do
18+ (mfd, refresh) <- getFd ii path
19+ case mfd of
20+ Just fd -> return (pread fd, Refresher refresh)
21+ Nothing -> do
22+ fd <- openFile path
23+ return (pread fd, Closer $ closeFile fd)
24+ where
25+ pread :: Fd -> PositionRead
26+ pread fd off bytes buf = fromIntegral <$> positionRead fd buf bytes' off'
27+ where
28+ bytes' = fromIntegral bytes
29+ off' = fromIntegral off
30+#endif
warp/Network/Wai/Handler/Warp/HTTP2/PushPromise.hsnew file+36
@@ -0,0 +1,36 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+module Network.Wai.Handler.Warp.HTTP2.PushPromise where
6+
7+import qualified Control.Exception as E
8+import qualified Network.HTTP.Types as H
9+import qualified Network.HTTP2.Server as H2
10+
11+import Network.Wai
12+import Network.Wai.Handler.Warp.FileInfoCache
13+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
14+import Network.Wai.Handler.Warp.HTTP2.Types
15+import Network.Wai.Handler.Warp.Imports
16+import Network.Wai.Handler.Warp.Types
17+
18+fromPushPromises :: InternalInfo -> Request -> IO [H2.PushPromise]
19+fromPushPromises ii req = do
20+ mh2data <- getHTTP2Data req
21+ let pp = case mh2data of
22+ Nothing -> []
23+ Just h2data -> http2dataPushPromise h2data
24+ catMaybes <$> mapM (fromPushPromise ii) pp
25+
26+fromPushPromise :: InternalInfo -> PushPromise -> IO (Maybe H2.PushPromise)
27+fromPushPromise ii (PushPromise path file rsphdr w) = do
28+ efinfo <- E.try $ getFileInfo ii file
29+ case efinfo of
30+ Left (_ex :: E.IOException) -> return Nothing
31+ Right finfo -> do
32+ let !siz = fromIntegral $ fileInfoSize finfo
33+ !fileSpec = H2.FileSpec file 0 siz
34+ !rsp = H2.responseFile H.ok200 rsphdr fileSpec
35+ !pp = H2.pushPromise path rsp w
36+ return $ Just pp
warp/Network/Wai/Handler/Warp/HTTP2/Request.hsnew file+126
@@ -0,0 +1,126 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.HTTP2.Request (
4+ toRequest
5+ , getHTTP2Data
6+ , setHTTP2Data
7+ , modifyHTTP2Data
8+ ) where
9+
10+import Control.Arrow (first)
11+import qualified Data.ByteString.Char8 as C8
12+import Data.IORef
13+import qualified Data.Vault.Lazy as Vault
14+import Network.HPACK
15+import Network.HPACK.Token
16+import qualified Network.HTTP.Types as H
17+import Network.Socket (SockAddr)
18+import Network.Wai
19+import Network.Wai.Internal (Request(..))
20+import System.IO.Unsafe (unsafePerformIO)
21+import qualified System.TimeManager as T
22+
23+import Network.Wai.Handler.Warp.HTTP2.Types
24+import Network.Wai.Handler.Warp.Imports
25+import Network.Wai.Handler.Warp.Request (getFileInfoKey, pauseTimeoutKey, getClientCertificateKey)
26+import qualified Network.Wai.Handler.Warp.Settings as S (Settings, settingsNoParsePath)
27+import Network.Wai.Handler.Warp.Types
28+
29+type ToReq = (TokenHeaderList,ValueTable) -> Maybe Int -> IO ByteString -> T.Handle -> Transport -> IO Request
30+
31+----------------------------------------------------------------
32+
33+toRequest :: InternalInfo -> S.Settings -> SockAddr -> ToReq
34+toRequest ii settings addr ht bodylen body th transport = do
35+ ref <- newIORef Nothing
36+ toRequest' ii settings addr ref ht bodylen body th transport
37+
38+toRequest' :: InternalInfo -> S.Settings -> SockAddr
39+ -> IORef (Maybe HTTP2Data)
40+ -> ToReq
41+toRequest' ii settings addr ref (reqths,reqvt) bodylen body th transport = return req
42+ where
43+ !req = Request {
44+ requestMethod = colonMethod
45+ , httpVersion = H.http20
46+ , rawPathInfo = rawPath
47+ , pathInfo = H.decodePathSegments path
48+ , rawQueryString = query
49+ , queryString = H.parseQuery query
50+ , requestHeaders = headers
51+ , isSecure = isTransportSecure transport
52+ , remoteHost = addr
53+ , requestBody = body
54+ , vault = vaultValue
55+ , requestBodyLength = maybe ChunkedBody (KnownLength . fromIntegral) bodylen
56+ , requestHeaderHost = mHost <|> mAuth
57+ , requestHeaderRange = mRange
58+ , requestHeaderReferer = mReferer
59+ , requestHeaderUserAgent = mUserAgent
60+ }
61+ headers = map (first tokenKey) ths
62+ where
63+ ths = case mHost of
64+ Just _ -> reqths
65+ Nothing -> case mAuth of
66+ Just auth -> (tokenHost, auth) : reqths
67+ _ -> reqths
68+ !mPath = getHeaderValue tokenPath reqvt -- SHOULD
69+ !colonMethod = fromJust $ getHeaderValue tokenMethod reqvt -- MUST
70+ !mAuth = getHeaderValue tokenAuthority reqvt -- SHOULD
71+ !mHost = getHeaderValue tokenHost reqvt
72+ !mRange = getHeaderValue tokenRange reqvt
73+ !mReferer = getHeaderValue tokenReferer reqvt
74+ !mUserAgent = getHeaderValue tokenUserAgent reqvt
75+ -- CONNECT request will have ":path" omitted, use ":authority" as unparsed
76+ -- path instead so that it will have consistent behavior compare to HTTP 1.0
77+ (unparsedPath,query) = C8.break (=='?') $ fromJust (mPath <|> mAuth)
78+ !path = H.extractPath unparsedPath
79+ !rawPath = if S.settingsNoParsePath settings then unparsedPath else path
80+ -- fixme: pauseTimeout. th is not available here.
81+ !vaultValue = Vault.insert getFileInfoKey (getFileInfo ii)
82+ $ Vault.insert getHTTP2DataKey (readIORef ref)
83+ $ Vault.insert setHTTP2DataKey (writeIORef ref)
84+ $ Vault.insert modifyHTTP2DataKey (modifyIORef' ref)
85+ $ Vault.insert pauseTimeoutKey (T.pause th)
86+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
87+ Vault.empty
88+
89+getHTTP2DataKey :: Vault.Key (IO (Maybe HTTP2Data))
90+getHTTP2DataKey = unsafePerformIO Vault.newKey
91+{-# NOINLINE getHTTP2DataKey #-}
92+
93+-- | Getting 'HTTP2Data' through vault of the request.
94+-- Warp uses this to receive 'HTTP2Data' from 'Middleware'.
95+--
96+-- Since: 3.2.7
97+getHTTP2Data :: Request -> IO (Maybe HTTP2Data)
98+getHTTP2Data req = case Vault.lookup getHTTP2DataKey (vault req) of
99+ Nothing -> return Nothing
100+ Just getter -> getter
101+
102+setHTTP2DataKey :: Vault.Key (Maybe HTTP2Data -> IO ())
103+setHTTP2DataKey = unsafePerformIO Vault.newKey
104+{-# NOINLINE setHTTP2DataKey #-}
105+
106+-- | Setting 'HTTP2Data' through vault of the request.
107+-- 'Application' or 'Middleware' should use this.
108+--
109+-- Since: 3.2.7
110+setHTTP2Data :: Request -> Maybe HTTP2Data -> IO ()
111+setHTTP2Data req mh2d = case Vault.lookup setHTTP2DataKey (vault req) of
112+ Nothing -> return ()
113+ Just setter -> setter mh2d
114+
115+modifyHTTP2DataKey :: Vault.Key ((Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ())
116+modifyHTTP2DataKey = unsafePerformIO Vault.newKey
117+{-# NOINLINE modifyHTTP2DataKey #-}
118+
119+-- | Modifying 'HTTP2Data' through vault of the request.
120+-- 'Application' or 'Middleware' should use this.
121+--
122+-- Since: 3.2.8
123+modifyHTTP2Data :: Request -> (Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ()
124+modifyHTTP2Data req func = case Vault.lookup modifyHTTP2DataKey (vault req) of
125+ Nothing -> return ()
126+ Just modify -> modify func
warp/Network/Wai/Handler/Warp/HTTP2/Response.hsnew file+127
@@ -0,0 +1,127 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+
6+module Network.Wai.Handler.Warp.HTTP2.Response (
7+ fromResponse
8+ ) where
9+
10+import qualified Control.Exception as E
11+import qualified Data.ByteString.Builder as BB
12+import qualified Network.HTTP.Types as H
13+import qualified Network.HTTP2.Server as H2
14+import Network.Wai hiding (responseFile, responseBuilder, responseStream)
15+import Network.Wai.Internal (Response(..))
16+
17+import Network.Wai.Handler.Warp.File
18+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
19+import Network.Wai.Handler.Warp.HTTP2.Types
20+import Network.Wai.Handler.Warp.Header
21+import qualified Network.Wai.Handler.Warp.Response as R
22+import qualified Network.Wai.Handler.Warp.Settings as S
23+import Network.Wai.Handler.Warp.Types
24+
25+----------------------------------------------------------------
26+
27+fromResponse :: S.Settings -> InternalInfo -> Request -> Response -> IO H2.Response
28+fromResponse settings ii req rsp = do
29+ date <- getDate ii
30+ h2rsp <- case rsp of
31+ ResponseFile st rsphdr path mpart -> do
32+ let rsphdr' = add date svr rsphdr
33+ responseFile st rsphdr' isHead path mpart ii reqhdr
34+ ResponseBuilder st rsphdr builder -> do
35+ let rsphdr' = add date svr rsphdr
36+ return $ responseBuilder st rsphdr' isHead builder
37+ ResponseStream st rsphdr strmbdy -> do
38+ let rsphdr' = add date svr rsphdr
39+ return $ responseStream st rsphdr' isHead strmbdy
40+ _ -> error "ResponseRaw is not supported in HTTP/2"
41+ mh2data <- getHTTP2Data req
42+ case mh2data of
43+ Nothing -> return h2rsp
44+ Just h2data -> do
45+ let !trailers = http2dataTrailers h2data
46+ return $ H2.setResponseTrailersMaker h2rsp trailers
47+ where
48+ !isHead = requestMethod req == H.methodHead
49+ !reqhdr = requestHeaders req
50+ !svr = S.settingsServerName settings
51+ add date server rsphdr = (H.hDate, date) : (H.hServer, server) : rsphdr
52+ -- fixme: not adding svr if already exists
53+
54+----------------------------------------------------------------
55+
56+responseFile :: H.Status -> H.ResponseHeaders -> Bool
57+ -> FilePath -> Maybe FilePart -> InternalInfo -> H.RequestHeaders
58+ -> IO H2.Response
59+responseFile st rsphdr _ _ _ _ _
60+ | noBody st = return $ responseNoBody st rsphdr
61+
62+responseFile st rsphdr isHead path (Just fp) _ _ =
63+ return $ responseFile2XX st rsphdr isHead fileSpec
64+ where
65+ !off' = fromIntegral $ filePartOffset fp
66+ !bytes' = fromIntegral $ filePartByteCount fp
67+ !fileSpec = H2.FileSpec path off' bytes'
68+
69+responseFile _ rsphdr isHead path Nothing ii reqhdr = do
70+ efinfo <- E.try $ getFileInfo ii path
71+ case efinfo of
72+ Left (_ex :: E.IOException) -> return $ response404 rsphdr
73+ Right finfo -> do
74+ let reqidx = indexRequestHeader reqhdr
75+ rspidx = indexResponseHeader rsphdr
76+ case conditionalRequest finfo rsphdr rspidx reqidx of
77+ WithoutBody s -> return $ responseNoBody s rsphdr
78+ WithBody s rsphdr' off bytes -> do
79+ let !off' = fromIntegral off
80+ !bytes' = fromIntegral bytes
81+ !fileSpec = H2.FileSpec path off' bytes'
82+ return $ responseFile2XX s rsphdr' isHead fileSpec
83+
84+----------------------------------------------------------------
85+
86+responseFile2XX :: H.Status -> H.ResponseHeaders -> Bool -> H2.FileSpec -> H2.Response
87+responseFile2XX st rsphdr isHead fileSpec
88+ | isHead = responseNoBody st rsphdr
89+ | otherwise = H2.responseFile st rsphdr fileSpec
90+
91+----------------------------------------------------------------
92+
93+responseBuilder :: H.Status -> H.ResponseHeaders -> Bool
94+ -> BB.Builder
95+ -> H2.Response
96+responseBuilder st rsphdr isHead builder
97+ | noBody st = responseNoBody st rsphdr
98+ | isHead = responseNoBody st rsphdr
99+ | otherwise = H2.responseBuilder st rsphdr builder
100+
101+----------------------------------------------------------------
102+
103+responseStream :: H.Status -> H.ResponseHeaders -> Bool
104+ -> StreamingBody
105+ -> H2.Response
106+responseStream st rsphdr isHead strmbdy
107+ | noBody st = responseNoBody st rsphdr
108+ | isHead = responseNoBody st rsphdr
109+ | otherwise = H2.responseStreaming st rsphdr strmbdy
110+
111+----------------------------------------------------------------
112+
113+responseNoBody :: H.Status -> H.ResponseHeaders -> H2.Response
114+responseNoBody st rsphdr = H2.responseNoBody st rsphdr
115+
116+----------------------------------------------------------------
117+
118+response404 :: H.ResponseHeaders -> H2.Response
119+response404 rsphdr = H2.responseBuilder H.notFound404 rsphdr' body
120+ where
121+ !rsphdr' = R.replaceHeader H.hContentType "text/plain; charset=utf-8" rsphdr
122+ !body = BB.byteString "File not found"
123+
124+----------------------------------------------------------------
125+
126+noBody :: H.Status -> Bool
127+noBody = not . R.hasBody
warp/Network/Wai/Handler/Warp/HTTP2/Types.hsnew file+81
@@ -0,0 +1,81 @@
1+{-# LANGUAGE NamedFieldPuns #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
4+
5+module Network.Wai.Handler.Warp.HTTP2.Types where
6+
7+import qualified Data.ByteString as BS
8+import qualified Network.HTTP.Types as H
9+import Network.HTTP2
10+import qualified Network.HTTP2.Server as H2
11+
12+import Network.Wai.Handler.Warp.Imports
13+import Network.Wai.Handler.Warp.Types
14+
15+----------------------------------------------------------------
16+
17+isHTTP2 :: Transport -> Bool
18+isHTTP2 TCP = False
19+isHTTP2 tls = useHTTP2
20+ where
21+ useHTTP2 = case tlsNegotiatedProtocol tls of
22+ Nothing -> False
23+ Just proto -> "h2" `BS.isPrefixOf` proto
24+
25+----------------------------------------------------------------
26+
27+-- | HTTP/2 specific data.
28+--
29+-- Since: 3.2.7
30+data HTTP2Data = HTTP2Data {
31+ -- | Accessor for 'PushPromise' in 'HTTP2Data'.
32+ --
33+ -- Since: 3.2.7
34+ http2dataPushPromise :: [PushPromise]
35+ -- | Accessor for 'H2.TrailersMaker' in 'HTTP2Data'.
36+ --
37+ -- Since: 3.2.8 but the type changed in 3.3.0
38+ , http2dataTrailers :: H2.TrailersMaker
39+ }
40+
41+-- | Default HTTP/2 specific data.
42+--
43+-- Since: 3.2.7
44+defaultHTTP2Data :: HTTP2Data
45+defaultHTTP2Data = HTTP2Data [] H2.defaultTrailersMaker
46+
47+-- | HTTP/2 push promise or sever push.
48+-- This allows files only for backward-compatibility
49+-- while the HTTP/2 library supports other types.
50+--
51+-- Since: 3.2.7
52+data PushPromise = PushPromise {
53+ -- | Accessor for a URL path in 'PushPromise'.
54+ -- E.g. \"\/style\/default.css\".
55+ --
56+ -- Since: 3.2.7
57+ promisedPath :: ByteString
58+ -- | Accessor for 'FilePath' in 'PushPromise'.
59+ -- E.g. \"FILE_PATH/default.css\".
60+ --
61+ -- Since: 3.2.7
62+ , promisedFile :: FilePath
63+ -- | Accessor for 'H.ResponseHeaders' in 'PushPromise'
64+ -- \"content-type\" must be specified.
65+ -- Default value: [].
66+ --
67+ --
68+ -- Since: 3.2.7
69+ , promisedResponseHeaders :: H.ResponseHeaders
70+ -- | Accessor for 'Weight' in 'PushPromise'.
71+ -- Default value: 16.
72+ --
73+ -- Since: 3.2.7
74+ , promisedWeight :: Weight
75+ } deriving (Eq,Ord,Show)
76+
77+-- | Default push promise.
78+--
79+-- Since: 3.2.7
80+defaultPushPromise :: PushPromise
81+defaultPushPromise = PushPromise "" "" [] 16
warp/Network/Wai/Handler/Warp/HashMap.hsnew file+42
@@ -0,0 +1,42 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.HashMap where
4+
5+import Data.Hashable (hash)
6+import Data.IntMap.Strict (IntMap)
7+import qualified Data.IntMap.Strict as I
8+import Data.Map.Strict (Map)
9+import qualified Data.Map.Strict as M
10+import Prelude hiding (lookup)
11+
12+----------------------------------------------------------------
13+
14+-- | 'HashMap' is used for cache of file information.
15+-- Hash values of file pathes are used as outer keys.
16+-- Because negative entries are also contained,
17+-- a bad guy can intentionally cause the hash collison.
18+-- So, 'Map' is used internally to prevent
19+-- the hash collision attack.
20+newtype HashMap v = HashMap (IntMap (Map FilePath v))
21+
22+----------------------------------------------------------------
23+
24+empty :: HashMap v
25+empty = HashMap I.empty
26+
27+isEmpty :: HashMap v -> Bool
28+isEmpty (HashMap hm) = I.null hm
29+
30+----------------------------------------------------------------
31+
32+insert :: FilePath -> v -> HashMap v -> HashMap v
33+insert path v (HashMap hm) = HashMap $ I.insertWith f h m hm
34+ where
35+ !h = hash path
36+ !m = M.singleton path v
37+ f = M.union -- fimxe
38+
39+lookup :: FilePath -> HashMap v -> Maybe v
40+lookup path (HashMap hm) = I.lookup h hm >>= M.lookup path
41+ where
42+ !h = hash path
warp/Network/Wai/Handler/Warp/Header.hsnew file+101
@@ -0,0 +1,101 @@
1+{-# LANGUAGE OverloadedStrings, FlexibleContexts #-}
2+
3+module Network.Wai.Handler.Warp.Header where
4+
5+import Data.Array
6+import Data.Array.ST
7+import qualified Data.ByteString as BS
8+import Data.CaseInsensitive (foldedCase)
9+import Network.HTTP.Types
10+
11+import Network.Wai.Handler.Warp.Types
12+
13+----------------------------------------------------------------
14+
15+-- | Array for a set of HTTP headers.
16+type IndexedHeader = Array Int (Maybe HeaderValue)
17+
18+----------------------------------------------------------------
19+
20+indexRequestHeader :: RequestHeaders -> IndexedHeader
21+indexRequestHeader hdr = traverseHeader hdr requestMaxIndex requestKeyIndex
22+
23+data RequestHeaderIndex = ReqContentLength
24+ | ReqTransferEncoding
25+ | ReqExpect
26+ | ReqConnection
27+ | ReqRange
28+ | ReqHost
29+ | ReqIfModifiedSince
30+ | ReqIfUnmodifiedSince
31+ | ReqIfRange
32+ | ReqReferer
33+ | ReqUserAgent
34+ deriving (Enum,Bounded)
35+
36+-- | The size for 'IndexedHeader' for HTTP Request.
37+-- From 0 to this corresponds to \"Content-Length\", \"Transfer-Encoding\",
38+-- \"Expect\", \"Connection\", \"Range\", \"Host\",
39+-- \"If-Modified-Since\", \"If-Unmodified-Since\" and \"If-Range\".
40+requestMaxIndex :: Int
41+requestMaxIndex = fromEnum (maxBound :: RequestHeaderIndex)
42+
43+requestKeyIndex :: HeaderName -> Int
44+requestKeyIndex hn = case BS.length bs of
45+ 4 -> if bs == "host" then fromEnum ReqHost else -1
46+ 5 -> if bs == "range" then fromEnum ReqRange else -1
47+ 6 -> if bs == "expect" then fromEnum ReqExpect else -1
48+ 7 -> if bs == "referer" then fromEnum ReqReferer else -1
49+ 8 -> if bs == "if-range" then fromEnum ReqIfRange else -1
50+ 10 -> if bs == "user-agent" then fromEnum ReqUserAgent else
51+ if bs == "connection" then fromEnum ReqConnection else -1
52+ 14 -> if bs == "content-length" then fromEnum ReqContentLength else -1
53+ 17 -> if bs == "transfer-encoding" then fromEnum ReqTransferEncoding else
54+ if bs == "if-modified-since" then fromEnum ReqIfModifiedSince
55+ else -1
56+ 19 -> if bs == "if-unmodified-since" then fromEnum ReqIfUnmodifiedSince else -1
57+ _ -> -1
58+ where
59+ bs = foldedCase hn
60+
61+defaultIndexRequestHeader :: IndexedHeader
62+defaultIndexRequestHeader = array (0,requestMaxIndex) [(i,Nothing)|i<-[0..requestMaxIndex]]
63+
64+----------------------------------------------------------------
65+
66+indexResponseHeader :: ResponseHeaders -> IndexedHeader
67+indexResponseHeader hdr = traverseHeader hdr responseMaxIndex responseKeyIndex
68+
69+data ResponseHeaderIndex = ResContentLength
70+ | ResServer
71+ | ResDate
72+ | ResLastModified
73+ deriving (Enum,Bounded)
74+
75+-- | The size for 'IndexedHeader' for HTTP Response.
76+responseMaxIndex :: Int
77+responseMaxIndex = fromEnum (maxBound :: ResponseHeaderIndex)
78+
79+responseKeyIndex :: HeaderName -> Int
80+responseKeyIndex hn = case BS.length bs of
81+ 4 -> if bs == "date" then fromEnum ResDate else -1
82+ 6 -> if bs == "server" then fromEnum ResServer else -1
83+ 13 -> if bs == "last-modified" then fromEnum ResLastModified else -1
84+ 14 -> if bs == "content-length" then fromEnum ResContentLength else -1
85+ _ -> -1
86+ where
87+ bs = foldedCase hn
88+
89+----------------------------------------------------------------
90+
91+traverseHeader :: [Header] -> Int -> (HeaderName -> Int) -> IndexedHeader
92+traverseHeader hdr maxidx getIndex = runSTArray $ do
93+ arr <- newArray (0,maxidx) Nothing
94+ mapM_ (insert arr) hdr
95+ return arr
96+ where
97+ insert arr (key,val)
98+ | idx == -1 = return ()
99+ | otherwise = writeArray arr idx (Just val)
100+ where
101+ idx = getIndex key
warp/Network/Wai/Handler/Warp/IO.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Network.Wai.Handler.Warp.IO where
5+
6+import Data.ByteString.Builder (Builder)
7+import Data.ByteString.Builder.Extra (runBuilder, Next(Done, More, Chunk))
8+
9+import Network.Wai.Handler.Warp.Buffer
10+import Network.Wai.Handler.Warp.Imports
11+import Network.Wai.Handler.Warp.Types
12+
13+toBufIOWith :: Buffer -> BufSize -> (ByteString -> IO ()) -> Builder -> IO ()
14+toBufIOWith buf !size io builder = loop firstWriter
15+ where
16+ firstWriter = runBuilder builder
17+ runIO len = bufferIO buf len io
18+ loop writer = do
19+ (len, signal) <- writer buf size
20+ case signal of
21+ Done -> runIO len
22+ More minSize next
23+ | size < minSize -> error "toBufIOWith: BufferFull: minSize"
24+ | otherwise -> do
25+ runIO len
26+ loop next
27+ Chunk bs next -> do
28+ runIO len
29+ io bs
30+ loop next
warp/Network/Wai/Handler/Warp/Imports.hsnew file+27
@@ -0,0 +1,27 @@
1+module Network.Wai.Handler.Warp.Imports (
2+ ByteString(..)
3+ , NonEmpty(..)
4+ , module Control.Applicative
5+ , module Control.Monad
6+ , module Data.Bits
7+ , module Data.List
8+ , module Data.Int
9+ , module Data.Monoid
10+ , module Data.Ord
11+ , module Data.Word
12+ , module Data.Maybe
13+ , module Numeric
14+ ) where
15+
16+import Control.Applicative
17+import Control.Monad
18+import Data.Bits
19+import Data.ByteString.Internal (ByteString(..))
20+import Data.Int
21+import Data.List
22+import Data.List.NonEmpty (NonEmpty(..))
23+import Data.Maybe
24+import Data.Monoid
25+import Data.Ord
26+import Data.Word
27+import Numeric
warp/Network/Wai/Handler/Warp/Internal.hsnew file+86
@@ -0,0 +1,86 @@
1+{-# OPTIONS_GHC -fno-warn-deprecations #-}
2+
3+module Network.Wai.Handler.Warp.Internal (
4+ -- * Settings
5+ Settings (..)
6+ , ProxyProtocol(..)
7+ -- * Low level run functions
8+ , runSettingsConnection
9+ , runSettingsConnectionMaker
10+ , runSettingsConnectionMakerSecure
11+ , Transport (..)
12+ -- * Connection
13+ , Connection (..)
14+ , socketConnection
15+ -- ** Receive
16+ , Recv
17+ , RecvBuf
18+ , makePlainReceiveN
19+ -- ** Buffer
20+ , Buffer
21+ , BufSize
22+ , bufferSize
23+ , allocateBuffer
24+ , freeBuffer
25+ , copy
26+ -- ** Sendfile
27+ , FileId (..)
28+ , SendFile
29+ , sendFile
30+ , readSendFile
31+ -- * Version
32+ , warpVersion
33+ -- * Data types
34+ , InternalInfo (..)
35+ , HeaderValue
36+ , IndexedHeader
37+ , requestMaxIndex
38+ -- * Time out manager
39+ -- |
40+ --
41+ -- In order to provide slowloris protection, Warp provides timeout handlers. We
42+ -- follow these rules:
43+ --
44+ -- * A timeout is created when a connection is opened.
45+ --
46+ -- * When all request headers are read, the timeout is tickled.
47+ --
48+ -- * Every time at least the slowloris size settings number of bytes of the request
49+ -- body are read, the timeout is tickled.
50+ --
51+ -- * The timeout is paused while executing user code. This will apply to both
52+ -- the application itself, and a ResponseSource response. The timeout is
53+ -- resumed as soon as we return from user code.
54+ --
55+ -- * Every time data is successfully sent to the client, the timeout is tickled.
56+ , module System.TimeManager
57+ -- * File descriptor cache
58+ , module Network.Wai.Handler.Warp.FdCache
59+ -- * File information cache
60+ , module Network.Wai.Handler.Warp.FileInfoCache
61+ -- * Date
62+ , module Network.Wai.Handler.Warp.Date
63+ -- * Request and response
64+ , Source
65+ , recvRequest
66+ , sendResponse
67+ -- * Platform dependent helper functions
68+ , setSocketCloseOnExec
69+ , windowsThreadBlockHack
70+ ) where
71+
72+import System.TimeManager
73+
74+import Network.Wai.Handler.Warp.Buffer
75+import Network.Wai.Handler.Warp.Date
76+import Network.Wai.Handler.Warp.FdCache
77+import Network.Wai.Handler.Warp.FileInfoCache
78+import Network.Wai.Handler.Warp.Header
79+import Network.Wai.Handler.Warp.Recv
80+import Network.Wai.Handler.Warp.Request
81+import Network.Wai.Handler.Warp.Response
82+import Network.Wai.Handler.Warp.Run
83+import Network.Wai.Handler.Warp.SendFile
84+import Network.Wai.Handler.Warp.Settings
85+import Network.Wai.Handler.Warp.Types
86+import Network.Wai.Handler.Warp.Windows
warp/Network/Wai/Handler/Warp/MultiMap.hsnew file+111
@@ -0,0 +1,111 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.MultiMap (
4+ MultiMap
5+ , isEmpty
6+ , empty
7+ , singleton
8+ , insert
9+ , Network.Wai.Handler.Warp.MultiMap.lookup
10+ , pruneWith
11+ , toList
12+ , merge
13+ ) where
14+
15+import Data.Hashable (hash)
16+import Data.IntMap.Strict (IntMap)
17+import qualified Data.IntMap.Strict as I
18+import Data.Semigroup
19+import Prelude -- Silence redundant import warnings
20+
21+----------------------------------------------------------------
22+
23+-- | 'MultiMap' is used for cache of file descriptors.
24+-- Since multiple threads would open file descriptors for
25+-- the same file simultaneously, multiple entries must
26+-- be contained for the file.
27+-- Since hash values of file pathes are used as outer keys,
28+-- collison would happen for multiple file pathes.
29+-- Becase only positive entries are contained,
30+-- a bad guy cannot be cause the hash collision intentinally.
31+-- So, lists are good enough.
32+newtype MultiMap v = MultiMap (IntMap [(FilePath,v)])
33+
34+----------------------------------------------------------------
35+
36+-- | O(1)
37+empty :: MultiMap v
38+empty = MultiMap $ I.empty
39+
40+-- | O(1)
41+isEmpty :: MultiMap v -> Bool
42+isEmpty (MultiMap mm) = I.null mm
43+
44+----------------------------------------------------------------
45+
46+-- | O(1)
47+singleton :: FilePath -> v -> MultiMap v
48+singleton path v = MultiMap mm
49+ where
50+ !h = hash path
51+ !mm = I.singleton h [(path,v)]
52+
53+----------------------------------------------------------------
54+
55+-- | O(N)
56+lookup :: FilePath -> MultiMap v -> Maybe v
57+lookup path (MultiMap mm) = case I.lookup h mm of
58+ Nothing -> Nothing
59+ Just s -> Prelude.lookup path s
60+ where
61+ !h = hash path
62+
63+----------------------------------------------------------------
64+
65+-- | O(log n)
66+insert :: FilePath -> v -> MultiMap v -> MultiMap v
67+insert path v (MultiMap mm) = MultiMap mm'
68+ where
69+ !h = hash path
70+ !mm' = I.insertWith (<>) h [(path,v)] mm
71+
72+----------------------------------------------------------------
73+
74+-- | O(n)
75+toList :: MultiMap v -> [(FilePath,v)]
76+toList (MultiMap mm) = concatMap snd $ I.toAscList mm
77+
78+----------------------------------------------------------------
79+
80+-- | O(n)
81+pruneWith :: MultiMap v
82+ -> ((FilePath,v) -> IO Bool)
83+ -> IO (MultiMap v)
84+pruneWith (MultiMap mm) action = MultiMap <$> mm'
85+ where
86+ !mm' = I.fromAscList <$> go (I.toDescList mm) []
87+ go [] !acc = return acc
88+ go ((h,s):kss) !acc = do
89+ rs <- prune action s
90+ case rs of
91+ [] -> go kss acc
92+ _ -> go kss ((h,rs) : acc)
93+
94+----------------------------------------------------------------
95+
96+-- O(n + m) where N is the size of the second argument
97+merge :: MultiMap v -> MultiMap v -> MultiMap v
98+merge (MultiMap m1) (MultiMap m2) = MultiMap mm
99+ where
100+ !mm = I.unionWith (<>) m1 m2
101+
102+----------------------------------------------------------------
103+
104+prune :: ((FilePath,v) -> IO Bool) -> [(FilePath,v)] -> IO [(FilePath,v)]
105+prune action xs0 = go xs0
106+ where
107+ go [] = return []
108+ go (x:xs) = do
109+ keep <- action x
110+ rs <- go xs
111+ return $ if keep then x:rs else rs
warp/Network/Wai/Handler/Warp/PackInt.hsnew file+56
@@ -0,0 +1,56 @@
1+{-# LANGUAGE OverloadedStrings, BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.PackInt where
4+
5+import Data.ByteString.Internal (unsafeCreate)
6+import Foreign.Ptr (Ptr, plusPtr)
7+import Foreign.Storable (poke)
8+import qualified Network.HTTP.Types as H
9+
10+import Network.Wai.Handler.Warp.Imports
11+
12+-- $setup
13+-- >>> import Data.ByteString.Char8 as C8
14+-- >>> import Test.QuickCheck (Large(..))
15+
16+-- |
17+--
18+-- prop> packIntegral (abs n) == C8.pack (show (abs n))
19+-- prop> \(Large n) -> let n' = fromIntegral (abs n :: Int) in packIntegral n' == C8.pack (show n')
20+
21+packIntegral :: Integral a => a -> ByteString
22+packIntegral 0 = "0"
23+packIntegral n | n < 0 = error "packIntegral"
24+packIntegral n = unsafeCreate len go0
25+ where
26+ n' = fromIntegral n + 1 :: Double
27+ len = ceiling $ logBase 10 n'
28+ go0 p = go n $ p `plusPtr` (len - 1)
29+ go :: Integral a => a -> Ptr Word8 -> IO ()
30+ go i p = do
31+ let (d,r) = i `divMod` 10
32+ poke p (48 + fromIntegral r)
33+ when (d /= 0) $ go d (p `plusPtr` (-1))
34+
35+{-# SPECIALIZE packIntegral :: Int -> ByteString #-}
36+{-# SPECIALIZE packIntegral :: Integer -> ByteString #-}
37+
38+-- |
39+--
40+-- >>> packStatus H.status200
41+-- "200"
42+-- >>> packStatus H.preconditionFailed412
43+-- "412"
44+
45+packStatus :: H.Status -> ByteString
46+packStatus status = unsafeCreate 3 $ \p -> do
47+ poke p (toW8 r2)
48+ poke (p `plusPtr` 1) (toW8 r1)
49+ poke (p `plusPtr` 2) (toW8 r0)
50+ where
51+ toW8 :: Int -> Word8
52+ toW8 n = 48 + fromIntegral n
53+ !s = fromIntegral $ H.statusCode status
54+ (!q0,!r0) = s `divMod` 10
55+ (!q1,!r1) = q0 `divMod` 10
56+ !r2 = q1 `mod` 10
warp/Network/Wai/Handler/Warp/ReadInt.hsnew file+67
@@ -0,0 +1,67 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE MagicHash #-}
3+{-# LANGUAGE BangPatterns #-}
4+
5+-- Copyright : Erik de Castro Lopo <erikd@mega-nerd.com>
6+-- License : BSD3
7+
8+module Network.Wai.Handler.Warp.ReadInt (
9+ readInt
10+ , readInt64
11+ ) where
12+
13+-- This function lives in its own file because the MagicHash pragma interacts
14+-- poorly with the CPP pragma.
15+
16+import qualified Data.ByteString as S
17+import GHC.Prim
18+import GHC.Types
19+import GHC.Word
20+
21+import Network.Wai.Handler.Warp.Imports hiding (readInt)
22+
23+{-# INLINE readInt #-}
24+readInt :: Integral a => ByteString -> a
25+readInt bs = fromIntegral $ readInt64 bs
26+
27+-- This function is used to parse the Content-Length field of HTTP headers and
28+-- is a performance hot spot. It should only be replaced with something
29+-- significantly and provably faster.
30+--
31+-- It needs to be able work correctly on 32 bit CPUs for file sizes > 2G so we
32+-- use Int64 here and then make a generic 'readInt' that allows conversion to
33+-- Int and Integer.
34+
35+{-# NOINLINE readInt64 #-}
36+readInt64 :: ByteString -> Int64
37+readInt64 bs = S.foldl' (\ !i !c -> i * 10 + fromIntegral (mhDigitToInt c)) 0
38+ $ S.takeWhile isDigit bs
39+
40+data Table = Table !Addr#
41+
42+{-# NOINLINE mhDigitToInt #-}
43+mhDigitToInt :: Word8 -> Int
44+mhDigitToInt (W8# i) = I# (word2Int# (indexWord8OffAddr# addr (word2Int# i)))
45+ where
46+ !(Table addr) = table
47+ table :: Table
48+ table = Table
49+ "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
50+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
51+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
52+ \\x00\x01\x02\x03\x04\x05\x06\x07\x08\x09\x00\x00\x00\x00\x00\x00\
53+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
54+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
55+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
56+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
57+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
58+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
59+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
60+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
61+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
62+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
63+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\
64+ \\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00"#
65+
66+isDigit :: Word8 -> Bool
67+isDigit w = w >= 48 && w <= 57
warp/Network/Wai/Handler/Warp/Recv.hsnew file+160
@@ -0,0 +1,160 @@
1+{-# LANGUAGE ForeignFunctionInterface, OverloadedStrings #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Network.Wai.Handler.Warp.Recv (
5+ receive
6+ , receiveBuf
7+ , makeReceiveN
8+ , makePlainReceiveN
9+ , spell
10+ ) where
11+
12+import qualified Control.Exception as E
13+import qualified Data.ByteString as BS
14+import Data.IORef
15+import Foreign.C.Error (eAGAIN, getErrno, throwErrno)
16+import Foreign.C.Types
17+import Foreign.ForeignPtr (withForeignPtr)
18+import Foreign.Ptr (Ptr, castPtr, plusPtr)
19+import GHC.Conc (threadWaitRead)
20+import qualified GHC.IO.Exception as E
21+import Network.Socket (Socket)
22+import qualified System.IO.Error as E
23+#if MIN_VERSION_network(3,1,0)
24+import Network.Socket (withFdSocket)
25+#else
26+import Network.Socket (fdSocket)
27+#endif
28+import System.Posix.Types (Fd(..))
29+
30+import Network.Wai.Handler.Warp.Buffer
31+import Network.Wai.Handler.Warp.Imports
32+import Network.Wai.Handler.Warp.Types
33+
34+#ifdef mingw32_HOST_OS
35+import GHC.IO.FD (FD(..), readRawBufferPtr)
36+import Network.Wai.Handler.Warp.Windows
37+#endif
38+
39+----------------------------------------------------------------
40+
41+makeReceiveN :: ByteString -> Recv -> RecvBuf -> IO (BufSize -> IO ByteString)
42+makeReceiveN bs0 recv recvBuf = do
43+ ref <- newIORef bs0
44+ return $ receiveN ref recv recvBuf
45+
46+-- | This function returns a receiving function
47+-- based on two receiving functions.
48+-- The returned function efficiently manages received data
49+-- which is initialized by the first argument.
50+-- The returned function may allocate a byte string with malloc().
51+makePlainReceiveN :: Socket -> ByteString -> IO (BufSize -> IO ByteString)
52+makePlainReceiveN s bs0 = do
53+ ref <- newIORef bs0
54+ pool <- newBufferPool
55+ return $ receiveN ref (receive s pool) (receiveBuf s)
56+
57+receiveN :: IORef ByteString -> Recv -> RecvBuf -> BufSize -> IO ByteString
58+receiveN ref recv recvBuf size = E.handle handler $ do
59+ cached <- readIORef ref
60+ (bs, leftover) <- spell cached size recv recvBuf
61+ writeIORef ref leftover
62+ return bs
63+ where
64+ handler :: E.SomeException -> IO ByteString
65+ handler _ = return ""
66+
67+----------------------------------------------------------------
68+
69+spell :: ByteString -> BufSize -> IO ByteString -> RecvBuf -> IO (ByteString, ByteString)
70+spell init0 siz0 recv recvBuf
71+ | siz0 <= len0 = return $ BS.splitAt siz0 init0
72+ -- fixme: hard coding 4096
73+ | siz0 <= 4096 = loop [init0] (siz0 - len0)
74+ | otherwise = do
75+ bs@(PS fptr _ _) <- mallocBS siz0
76+ withForeignPtr fptr $ \ptr -> do
77+ ptr' <- copy ptr init0
78+ full <- recvBuf ptr' (siz0 - len0)
79+ if full then
80+ return (bs, "")
81+ else
82+ return ("", "") -- fixme
83+ where
84+ len0 = BS.length init0
85+ loop bss siz = do
86+ bs <- recv
87+ let len = BS.length bs
88+ if len == 0 then
89+ return ("", "")
90+ else if len >= siz then do
91+ let (consume, leftover) = BS.splitAt siz bs
92+ ret = BS.concat $ reverse (consume : bss)
93+ return (ret, leftover)
94+ else do
95+ let bss' = bs : bss
96+ siz' = siz - len
97+ loop bss' siz'
98+
99+-- The timeout manager may close the socket.
100+-- In that case, an error of "Bad file descriptor" occurs.
101+-- We ignores it because we expect TimeoutThread.
102+receive :: Socket -> BufferPool -> Recv
103+receive sock pool = E.handle handler $ withBufferPool pool $ \ (ptr, size) -> do
104+#if MIN_VERSION_network(3,1,0)
105+ withFdSocket sock $ \fd -> do
106+#elif MIN_VERSION_network(3,0,0)
107+ fd <- fdSocket sock
108+#else
109+ let fd = fdSocket sock
110+#endif
111+ let size' = fromIntegral size
112+ fromIntegral <$> receiveloop fd ptr size'
113+ where
114+ handler :: E.IOException -> IO ByteString
115+ handler e
116+ | E.ioeGetErrorType e == E.InvalidArgument = return ""
117+ | otherwise = E.throwIO e
118+
119+receiveBuf :: Socket -> RecvBuf
120+receiveBuf sock buf0 siz0 = do
121+#if MIN_VERSION_network(3,1,0)
122+ withFdSocket sock $ \fd -> do
123+#elif MIN_VERSION_network(3,0,0)
124+ fd <- fdSocket sock
125+#else
126+ let fd = fdSocket sock
127+#endif
128+ loop fd buf0 siz0
129+ where
130+ loop _ _ 0 = return True
131+ loop fd buf siz = do
132+ n <- fromIntegral <$> receiveloop fd buf (fromIntegral siz)
133+ -- fixme: what should we do in the case of n == 0
134+ if n == 0 then
135+ return False
136+ else
137+ loop fd (buf `plusPtr` n) (siz - n)
138+
139+receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
140+receiveloop sock ptr size = do
141+#ifdef mingw32_HOST_OS
142+ bytes <- windowsThreadBlockHack $ fromIntegral <$> readRawBufferPtr "recv" (FD sock 1) (castPtr ptr) 0 size
143+#else
144+ bytes <- c_recv sock (castPtr ptr) size 0
145+#endif
146+ if bytes == -1 then do
147+ errno <- getErrno
148+ if errno == eAGAIN then do
149+ threadWaitRead (Fd sock)
150+ receiveloop sock ptr size
151+ else
152+ throwErrno "receiveloop"
153+ else
154+ return bytes
155+
156+#ifndef mingw32_HOST_OS
157+-- fixme: the type of the return value
158+foreign import ccall unsafe "recv"
159+ c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt
160+#endif
warp/Network/Wai/Handler/Warp/Request.hsnew file+303
@@ -0,0 +1,303 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE CPP #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
5+{-# OPTIONS_GHC -fno-warn-deprecations #-}
6+
7+module Network.Wai.Handler.Warp.Request (
8+ recvRequest
9+ , headerLines
10+ , pauseTimeoutKey
11+ , getFileInfoKey
12+ , getClientCertificateKey
13+ , NoKeepAliveRequest (..)
14+ ) where
15+
16+import qualified Control.Concurrent as Conc (yield)
17+import Control.Exception (throwIO, Exception)
18+import Data.Array ((!))
19+import qualified Data.ByteString as S
20+import qualified Data.ByteString.Unsafe as SU
21+import qualified Data.CaseInsensitive as CI
22+import qualified Data.IORef as I
23+import Data.Typeable (Typeable)
24+import qualified Data.Vault.Lazy as Vault
25+import Data.X509
26+import qualified Network.HTTP.Types as H
27+import Network.Socket (SockAddr)
28+import Network.Wai
29+import Network.Wai.Handler.Warp.Types
30+import Network.Wai.Internal
31+import Prelude hiding (lines)
32+import System.IO.Unsafe (unsafePerformIO)
33+import qualified System.TimeManager as Timeout
34+
35+import Network.Wai.Handler.Warp.Conduit
36+import Network.Wai.Handler.Warp.FileInfoCache
37+import Network.Wai.Handler.Warp.Header
38+import Network.Wai.Handler.Warp.Imports hiding (readInt, lines)
39+import Network.Wai.Handler.Warp.ReadInt
40+import Network.Wai.Handler.Warp.RequestHeader
41+import Network.Wai.Handler.Warp.Settings (Settings, settingsNoParsePath, settingsMaxTotalHeaderLength)
42+
43+----------------------------------------------------------------
44+
45+-- | Receiving a HTTP request from 'Connection' and parsing its header
46+-- to create 'Request'.
47+recvRequest :: Bool -- ^ first request on this connection?
48+ -> Settings
49+ -> Connection
50+ -> InternalInfo
51+ -> Timeout.Handle
52+ -> SockAddr -- ^ Peer's address.
53+ -> Source -- ^ Where HTTP request comes from.
54+ -> Transport
55+ -> IO (Request
56+ ,Maybe (I.IORef Int)
57+ ,IndexedHeader
58+ ,IO ByteString) -- ^
59+ -- 'Request' passed to 'Application',
60+ -- how many bytes remain to be consumed, if known
61+ -- 'IndexedHeader' of HTTP request for internal use,
62+ -- Body producing action used for flushing the request body
63+
64+recvRequest firstRequest settings conn ii th addr src transport = do
65+ hdrlines <- headerLines (settingsMaxTotalHeaderLength settings) firstRequest src
66+ (method, unparsedPath, path, query, httpversion, hdr) <- parseHeaderLines hdrlines
67+ let idxhdr = indexRequestHeader hdr
68+ expect = idxhdr ! fromEnum ReqExpect
69+ cl = idxhdr ! fromEnum ReqContentLength
70+ te = idxhdr ! fromEnum ReqTransferEncoding
71+ handle100Continue = handleExpect conn httpversion expect
72+ rawPath = if settingsNoParsePath settings then unparsedPath else path
73+ vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
74+ $ Vault.insert getFileInfoKey (getFileInfo ii)
75+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
76+ Vault.empty
77+ (rbody, remainingRef, bodyLength) <- bodyAndSource src cl te
78+ -- body producing function which will produce '100-continue', if needed
79+ rbody' <- timeoutBody remainingRef th rbody handle100Continue
80+ -- body producing function which will never produce 100-continue
81+ rbodyFlush <- timeoutBody remainingRef th rbody (return ())
82+ let req = Request {
83+ requestMethod = method
84+ , httpVersion = httpversion
85+ , pathInfo = H.decodePathSegments path
86+ , rawPathInfo = rawPath
87+ , rawQueryString = query
88+ , queryString = H.parseQuery query
89+ , requestHeaders = hdr
90+ , isSecure = isTransportSecure transport
91+ , remoteHost = addr
92+ , requestBody = rbody'
93+ , vault = vaultValue
94+ , requestBodyLength = bodyLength
95+ , requestHeaderHost = idxhdr ! fromEnum ReqHost
96+ , requestHeaderRange = idxhdr ! fromEnum ReqRange
97+ , requestHeaderReferer = idxhdr ! fromEnum ReqReferer
98+ , requestHeaderUserAgent = idxhdr ! fromEnum ReqUserAgent
99+ }
100+ return (req, remainingRef, idxhdr, rbodyFlush)
101+
102+----------------------------------------------------------------
103+
104+headerLines :: Int -> Bool -> Source -> IO [ByteString]
105+headerLines maxTotalHeaderLength firstRequest src = do
106+ bs <- readSource src
107+ if S.null bs
108+ -- When we're working on a keep-alive connection and trying to
109+ -- get the second or later request, we don't want to treat the
110+ -- lack of data as a real exception. See the http1 function in
111+ -- the Run module for more details.
112+ then if firstRequest then throwIO ConnectionClosedByPeer else throwIO NoKeepAliveRequest
113+ else push maxTotalHeaderLength src (THStatus 0 id id) bs
114+
115+data NoKeepAliveRequest = NoKeepAliveRequest
116+ deriving (Show, Typeable)
117+instance Exception NoKeepAliveRequest
118+
119+----------------------------------------------------------------
120+
121+handleExpect :: Connection
122+ -> H.HttpVersion
123+ -> Maybe HeaderValue
124+ -> IO ()
125+handleExpect conn ver (Just "100-continue") = do
126+ connSendAll conn continue
127+ Conc.yield
128+ where
129+ continue
130+ | ver == H.http11 = "HTTP/1.1 100 Continue\r\n\r\n"
131+ | otherwise = "HTTP/1.0 100 Continue\r\n\r\n"
132+handleExpect _ _ _ = return ()
133+
134+----------------------------------------------------------------
135+
136+bodyAndSource :: Source
137+ -> Maybe HeaderValue -- ^ content length
138+ -> Maybe HeaderValue -- ^ transfer-encoding
139+ -> IO (IO ByteString
140+ ,Maybe (I.IORef Int)
141+ ,RequestBodyLength
142+ )
143+bodyAndSource src cl te
144+ | chunked = do
145+ csrc <- mkCSource src
146+ return (readCSource csrc, Nothing, ChunkedBody)
147+ | otherwise = do
148+ isrc@(ISource _ remaining) <- mkISource src len
149+ return (readISource isrc, Just remaining, bodyLen)
150+ where
151+ len = toLength cl
152+ bodyLen = KnownLength $ fromIntegral len
153+ chunked = isChunked te
154+
155+toLength :: Maybe HeaderValue -> Int
156+toLength Nothing = 0
157+toLength (Just bs) = readInt bs
158+
159+isChunked :: Maybe HeaderValue -> Bool
160+isChunked (Just bs) = CI.foldCase bs == "chunked"
161+isChunked _ = False
162+
163+----------------------------------------------------------------
164+
165+timeoutBody :: Maybe (I.IORef Int) -- ^ remaining
166+ -> Timeout.Handle
167+ -> IO ByteString
168+ -> IO ()
169+ -> IO (IO ByteString)
170+timeoutBody remainingRef timeoutHandle rbody handle100Continue = do
171+ isFirstRef <- I.newIORef True
172+
173+ let checkEmpty =
174+ case remainingRef of
175+ Nothing -> return . S.null
176+ Just ref -> \bs -> if S.null bs
177+ then return True
178+ else do
179+ x <- I.readIORef ref
180+ return $! x <= 0
181+
182+ return $ do
183+ isFirst <- I.readIORef isFirstRef
184+
185+ when isFirst $ do
186+ -- Only check if we need to produce the 100 Continue status
187+ -- when asking for the first chunk of the body
188+ handle100Continue
189+ -- Timeout handling was paused after receiving the full request
190+ -- headers. Now we need to resume it to avoid a slowloris
191+ -- attack during request body sending.
192+ Timeout.resume timeoutHandle
193+ I.writeIORef isFirstRef False
194+
195+ bs <- rbody
196+
197+ -- As soon as we finish receiving the request body, whether
198+ -- because the application is not interested in more bytes, or
199+ -- because there is no more data available, pause the timeout
200+ -- handler again.
201+ isEmpty <- checkEmpty bs
202+ when isEmpty (Timeout.pause timeoutHandle)
203+
204+ return bs
205+
206+----------------------------------------------------------------
207+
208+type BSEndo = ByteString -> ByteString
209+type BSEndoList = [ByteString] -> [ByteString]
210+
211+data THStatus = THStatus
212+ {-# UNPACK #-} !Int -- running total byte count
213+ BSEndoList -- previously parsed lines
214+ BSEndo -- bytestrings to be prepended
215+
216+----------------------------------------------------------------
217+
218+{- FIXME
219+close :: Sink ByteString IO a
220+close = throwIO IncompleteHeaders
221+-}
222+
223+push :: Int -> Source -> THStatus -> ByteString -> IO [ByteString]
224+push maxTotalHeaderLength src (THStatus len lines prepend) bs'
225+ -- Too many bytes
226+ | len > maxTotalHeaderLength = throwIO OverLargeHeader
227+ | otherwise = push' mnl
228+ where
229+ bs = prepend bs'
230+ bsLen = S.length bs
231+ mnl = do
232+ nl <- S.elemIndex 10 bs
233+ -- check if there are two more bytes in the bs
234+ -- if so, see if the second of those is a horizontal space
235+ if bsLen > nl + 1 then
236+ let c = S.index bs (nl + 1)
237+ b = case nl of
238+ 0 -> True
239+ 1 -> S.index bs 0 == 13
240+ _ -> False
241+ in Just (nl, not b && (c == 32 || c == 9))
242+ else
243+ Just (nl, False)
244+
245+ {-# INLINE push' #-}
246+ push' :: Maybe (Int, Bool) -> IO [ByteString]
247+ -- No newline find in this chunk. Add it to the prepend,
248+ -- update the length, and continue processing.
249+ push' Nothing = do
250+ bst <- readSource' src
251+ when (S.null bst) $ throwIO IncompleteHeaders
252+ push maxTotalHeaderLength src status bst
253+ where
254+ len' = len + bsLen
255+ prepend' = S.append bs
256+ status = THStatus len' lines prepend'
257+ -- Found a newline, but next line continues as a multiline header
258+ push' (Just (end, True)) = push maxTotalHeaderLength src status rest
259+ where
260+ rest = S.drop (end + 1) bs
261+ prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
262+ len' = len + end
263+ status = THStatus len' lines prepend'
264+ -- Found a newline at position end.
265+ push' (Just (end, False))
266+ -- leftover
267+ | S.null line = do
268+ when (start < bsLen) $ leftoverSource src (SU.unsafeDrop start bs)
269+ return (lines [])
270+ -- more headers
271+ | otherwise = let len' = len + start
272+ lines' = lines . (line:)
273+ status = THStatus len' lines' id
274+ in if start < bsLen then
275+ -- more bytes in this chunk, push again
276+ let bs'' = SU.unsafeDrop start bs
277+ in push maxTotalHeaderLength src status bs''
278+ else do
279+ -- no more bytes in this chunk, ask for more
280+ bst <- readSource' src
281+ when (S.null bs) $ throwIO IncompleteHeaders
282+ push maxTotalHeaderLength src status bst
283+ where
284+ start = end + 1 -- start of next chunk
285+ line = SU.unsafeTake (checkCR bs end) bs
286+
287+{-# INLINE checkCR #-}
288+checkCR :: ByteString -> Int -> Int
289+checkCR bs pos = if pos > 0 && 13 == S.index bs p then p else pos -- 13 is CR
290+ where
291+ !p = pos - 1
292+
293+pauseTimeoutKey :: Vault.Key (IO ())
294+pauseTimeoutKey = unsafePerformIO Vault.newKey
295+{-# NOINLINE pauseTimeoutKey #-}
296+
297+getFileInfoKey :: Vault.Key (FilePath -> IO FileInfo)
298+getFileInfoKey = unsafePerformIO Vault.newKey
299+{-# NOINLINE getFileInfoKey #-}
300+
301+getClientCertificateKey :: Vault.Key (Maybe CertificateChain)
302+getClientCertificateKey = unsafePerformIO Vault.newKey
303+{-# NOINLINE getClientCertificateKey #-}
warp/Network/Wai/Handler/Warp/RequestHeader.hsnew file+133
@@ -0,0 +1,133 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.RequestHeader (
4+ parseHeaderLines
5+ ) where
6+
7+import Control.Exception (throwIO)
8+import qualified Data.ByteString as S
9+import qualified Data.ByteString.Char8 as C8 (unpack)
10+import Data.ByteString.Internal (memchr)
11+import qualified Data.CaseInsensitive as CI
12+import Foreign.ForeignPtr (withForeignPtr)
13+import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
14+import Foreign.Storable (peek)
15+import qualified Network.HTTP.Types as H
16+
17+import Network.Wai.Handler.Warp.Imports
18+import Network.Wai.Handler.Warp.Types
19+
20+-- $setup
21+-- >>> :set -XOverloadedStrings
22+
23+----------------------------------------------------------------
24+
25+parseHeaderLines :: [ByteString]
26+ -> IO (H.Method
27+ ,ByteString -- Path
28+ ,ByteString -- Path, parsed
29+ ,ByteString -- Query
30+ ,H.HttpVersion
31+ ,H.RequestHeaders
32+ )
33+parseHeaderLines [] = throwIO $ NotEnoughLines []
34+parseHeaderLines (firstLine:otherLines) = do
35+ (method, path', query, httpversion) <- parseRequestLine firstLine
36+ let path = H.extractPath path'
37+ hdr = map parseHeader otherLines
38+ return (method, path', path, query, httpversion, hdr)
39+
40+----------------------------------------------------------------
41+
42+-- |
43+--
44+-- >>> parseRequestLine "GET / HTTP/1.1"
45+-- ("GET","/","",HTTP/1.1)
46+-- >>> parseRequestLine "POST /cgi/search.cgi?key=foo HTTP/1.0"
47+-- ("POST","/cgi/search.cgi","?key=foo",HTTP/1.0)
48+-- >>> parseRequestLine "GET "
49+-- *** Exception: Warp: Invalid first line of request: "GET "
50+-- >>> parseRequestLine "GET /NotHTTP UNKNOWN/1.1"
51+-- *** Exception: Warp: Request line specified a non-HTTP request
52+-- >>> parseRequestLine "PRI * HTTP/2.0"
53+-- ("PRI","*","",HTTP/2.0)
54+parseRequestLine :: ByteString
55+ -> IO (H.Method
56+ ,ByteString -- Path
57+ ,ByteString -- Query
58+ ,H.HttpVersion)
59+parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> do
60+ when (len < 14) $ throwIO baderr
61+ let methodptr = ptr `plusPtr` off
62+ limptr = methodptr `plusPtr` len
63+ lim0 = fromIntegral len
64+
65+ pathptr0 <- memchr methodptr 32 lim0 -- ' '
66+ when (pathptr0 == nullPtr || (limptr `minusPtr` pathptr0) < 11) $
67+ throwIO baderr
68+ let pathptr = pathptr0 `plusPtr` 1
69+ lim1 = fromIntegral (limptr `minusPtr` pathptr0)
70+
71+ httpptr0 <- memchr pathptr 32 lim1 -- ' '
72+ when (httpptr0 == nullPtr || (limptr `minusPtr` httpptr0) < 9) $
73+ throwIO baderr
74+ let httpptr = httpptr0 `plusPtr` 1
75+ lim2 = fromIntegral (httpptr0 `minusPtr` pathptr)
76+
77+ checkHTTP httpptr
78+ !hv <- httpVersion httpptr
79+ queryptr <- memchr pathptr 63 lim2 -- '?'
80+
81+ let !method = bs ptr methodptr pathptr0
82+ !path
83+ | queryptr == nullPtr = bs ptr pathptr httpptr0
84+ | otherwise = bs ptr pathptr queryptr
85+ !query
86+ | queryptr == nullPtr = S.empty
87+ | otherwise = bs ptr queryptr httpptr0
88+
89+ return (method,path,query,hv)
90+ where
91+ baderr = BadFirstLine $ C8.unpack requestLine
92+ check :: Ptr Word8 -> Int -> Word8 -> IO ()
93+ check p n w = do
94+ w0 <- peek $ p `plusPtr` n
95+ when (w0 /= w) $ throwIO NonHttp
96+ checkHTTP httpptr = do
97+ check httpptr 0 72 -- 'H'
98+ check httpptr 1 84 -- 'T'
99+ check httpptr 2 84 -- 'T'
100+ check httpptr 3 80 -- 'P'
101+ check httpptr 4 47 -- '/'
102+ check httpptr 6 46 -- '.'
103+ httpVersion httpptr = do
104+ major <- peek (httpptr `plusPtr` 5) :: IO Word8
105+ minor <- peek (httpptr `plusPtr` 7) :: IO Word8
106+ let version
107+ | major == 49 = if minor == 49 then H.http11 else H.http10
108+ | major == 50 && minor == 48 = H.HttpVersion 2 0
109+ | otherwise = H.http10
110+ return version
111+ bs ptr p0 p1 = PS fptr o l
112+ where
113+ o = p0 `minusPtr` ptr
114+ l = p1 `minusPtr` p0
115+
116+----------------------------------------------------------------
117+
118+-- |
119+--
120+-- >>> parseHeader "Content-Length:47"
121+-- ("Content-Length","47")
122+-- >>> parseHeader "Accept-Ranges: bytes"
123+-- ("Accept-Ranges","bytes")
124+-- >>> parseHeader "Host: example.com:8080"
125+-- ("Host","example.com:8080")
126+-- >>> parseHeader "NoSemiColon"
127+-- ("NoSemiColon","")
128+
129+parseHeader :: ByteString -> H.Header
130+parseHeader s =
131+ let (k, rest) = S.break (== 58) s -- ':'
132+ rest' = S.dropWhile (\c -> c == 32 || c == 9) $ S.drop 1 rest
133+ in (CI.mk k, rest')
warp/Network/Wai/Handler/Warp/Response.hsnew file+427
@@ -0,0 +1,427 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE ScopedTypeVariables #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE CPP #-}
5+{-# LANGUAGE BangPatterns #-}
6+
7+module Network.Wai.Handler.Warp.Response (
8+ sendResponse
9+ , sanitizeHeaderValue -- for testing
10+ , warpVersion
11+ , hasBody
12+ , replaceHeader
13+ , addServer -- testing
14+ ) where
15+
16+import Data.ByteString.Builder.HTTP.Chunked (chunkedTransferEncoding, chunkedTransferTerminator)
17+import qualified Control.Exception as E
18+import Data.Array ((!))
19+import qualified Data.ByteString as S
20+import Data.ByteString.Builder (byteString, Builder)
21+import Data.ByteString.Builder.Extra (flush)
22+import qualified Data.ByteString.Char8 as C8
23+import qualified Data.CaseInsensitive as CI
24+import Data.Function (on)
25+import Data.Streaming.ByteString.Builder (newByteStringBuilderRecv, reuseBufferStrategy)
26+import Data.Version (showVersion)
27+import Data.Word8 (_cr, _lf)
28+import qualified Network.HTTP.Types as H
29+import qualified Network.HTTP.Types.Header as H
30+import Network.Wai
31+import Network.Wai.Internal
32+import qualified Paths_warp
33+import qualified System.TimeManager as T
34+
35+import Network.Wai.Handler.Warp.Buffer (toBuilderBuffer)
36+import qualified Network.Wai.Handler.Warp.Date as D
37+import Network.Wai.Handler.Warp.File
38+import Network.Wai.Handler.Warp.Header
39+import Network.Wai.Handler.Warp.IO (toBufIOWith)
40+import Network.Wai.Handler.Warp.Imports
41+import Network.Wai.Handler.Warp.ResponseHeader
42+import Network.Wai.Handler.Warp.Settings
43+import Network.Wai.Handler.Warp.Types
44+
45+-- $setup
46+-- >>> :set -XOverloadedStrings
47+
48+----------------------------------------------------------------
49+
50+-- | Sending a HTTP response to 'Connection' according to 'Response'.
51+--
52+-- Applications/middlewares MUST provide a proper 'H.ResponseHeaders'.
53+-- so that inconsistency does not happen.
54+-- No header is deleted by this function.
55+--
56+-- Especially, Applications/middlewares MUST provide a proper
57+-- Content-Type. They MUST NOT provide
58+-- Content-Length, Content-Range, and Transfer-Encoding
59+-- because they are inserted, when necessary,
60+-- regardless they already exist.
61+-- This function does not insert Content-Encoding. It's middleware's
62+-- responsibility.
63+--
64+-- The Date and Server header is added if not exist
65+-- in HTTP response header.
66+--
67+-- There are three basic APIs to create 'Response':
68+--
69+-- ['responseBuilder' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Builder' -> 'Response']
70+-- HTTP response body is created from 'Builder'.
71+-- Transfer-Encoding: chunked is used in HTTP/1.1.
72+--
73+-- ['responseStream' :: 'H.Status' -> 'H.ResponseHeaders' -> 'StreamingBody' -> 'Response']
74+-- HTTP response body is created from 'Builder'.
75+-- Transfer-Encoding: chunked is used in HTTP/1.1.
76+--
77+-- ['responseRaw' :: ('IO' 'ByteString' -> ('ByteString' -> 'IO' ()) -> 'IO' ()) -> 'Response' -> 'Response']
78+-- No header is added and no Transfer-Encoding: is applied.
79+--
80+-- ['responseFile' :: 'H.Status' -> 'H.ResponseHeaders' -> 'FilePath' -> 'Maybe' 'FilePart' -> 'Response']
81+-- HTTP response body is sent (by sendfile(), if possible) for GET method.
82+-- HTTP response body is not sent by HEAD method.
83+-- Content-Length and Content-Range are automatically
84+-- added into the HTTP response header if necessary.
85+-- If Content-Length and Content-Range exist in the HTTP response header,
86+-- they would cause inconsistency.
87+-- \"Accept-Ranges: bytes\" is also inserted.
88+--
89+-- Applications are categorized into simple and sophisticated.
90+-- Sophisticated applications should specify 'Just' to
91+-- 'Maybe' 'FilePart'. They should treat the conditional request
92+-- by themselves. A proper 'Status' (200 or 206) must be provided.
93+--
94+-- Simple applications should specify 'Nothing' to
95+-- 'Maybe' 'FilePart'. The size of the specified file is obtained
96+-- by disk access or from the file infor cache.
97+-- If-Modified-Since, If-Unmodified-Since, If-Range and Range
98+-- are processed. Since a proper status is chosen, 'Status' is
99+-- ignored. Last-Modified is inserted.
100+
101+sendResponse :: Settings
102+ -> Connection
103+ -> InternalInfo
104+ -> T.Handle
105+ -> Request -- ^ HTTP request.
106+ -> IndexedHeader -- ^ Indexed header of HTTP request.
107+ -> IO ByteString -- ^ source from client, for raw response
108+ -> Response -- ^ HTTP response including status code and response header.
109+ -> IO Bool -- ^ Returing True if the connection is persistent.
110+sendResponse settings conn ii th req reqidxhdr src response = do
111+ hs <- addServerAndDate hs0
112+ if hasBody s then do
113+ -- The response to HEAD does not have body.
114+ -- But to handle the conditional requests defined RFC 7232 and
115+ -- to generate appropriate content-length, content-range,
116+ -- and status, the response to HEAD is processed here.
117+ --
118+ -- See definition of rsp below for proper body stripping.
119+ (ms, mlen) <- sendRsp conn ii ver s hs rspidxhdr rsp
120+ case ms of
121+ Nothing -> return ()
122+ Just realStatus -> logger req realStatus mlen
123+ T.tickle th
124+ return ret
125+ else do
126+ _ <- sendRsp conn ii ver s hs rspidxhdr RspNoBody
127+ logger req s Nothing
128+ T.tickle th
129+ return isPersist
130+ where
131+ defServer = settingsServerName settings
132+ logger = settingsLogger settings
133+ ver = httpVersion req
134+ s = responseStatus response
135+ hs0 = sanitizeHeaders $ responseHeaders response
136+ rspidxhdr = indexResponseHeader hs0
137+ getdate = getDate ii
138+ addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
139+ (isPersist,isChunked0) = infoFromRequest req reqidxhdr
140+ isChunked = not isHead && isChunked0
141+ (isKeepAlive, needsChunked) = infoFromResponse rspidxhdr (isPersist,isChunked)
142+ isHead = requestMethod req == H.methodHead
143+ rsp = case response of
144+ ResponseFile _ _ path mPart -> RspFile path mPart reqidxhdr isHead (T.tickle th)
145+ ResponseBuilder _ _ b
146+ | isHead -> RspNoBody
147+ | otherwise -> RspBuilder b needsChunked
148+ ResponseStream _ _ fb
149+ | isHead -> RspNoBody
150+ | otherwise -> RspStream fb needsChunked th
151+ ResponseRaw raw _ -> RspRaw raw src (T.tickle th)
152+ -- Make sure we don't hang on to 'response' (avoid space leak)
153+ !ret = case response of
154+ ResponseFile {} -> isPersist
155+ ResponseBuilder {} -> isKeepAlive
156+ ResponseStream {} -> isKeepAlive
157+ ResponseRaw {} -> False
158+
159+----------------------------------------------------------------
160+
161+sanitizeHeaders :: H.ResponseHeaders -> H.ResponseHeaders
162+sanitizeHeaders = map (sanitize <$>)
163+ where
164+ sanitize v
165+ | containsNewlines v = sanitizeHeaderValue v -- slow path
166+ | otherwise = v -- fast path
167+
168+{-# INLINE containsNewlines #-}
169+containsNewlines :: ByteString -> Bool
170+containsNewlines = S.any (\w -> w == _cr || w == _lf)
171+
172+{-# INLINE sanitizeHeaderValue #-}
173+sanitizeHeaderValue :: ByteString -> ByteString
174+sanitizeHeaderValue v = case C8.lines $ S.filter (/= _cr) v of
175+ [] -> ""
176+ x : xs -> C8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
177+ where
178+ addSpaceIfMissing line = case C8.uncons line of
179+ Nothing -> Nothing
180+ Just (first, _)
181+ | first == ' ' || first == '\t' -> Just line
182+ | otherwise -> Just $ " " <> line
183+
184+----------------------------------------------------------------
185+
186+data Rsp = RspNoBody
187+ | RspFile FilePath (Maybe FilePart) IndexedHeader Bool (IO ())
188+ | RspBuilder Builder Bool
189+ | RspStream StreamingBody Bool T.Handle
190+ | RspRaw (IO ByteString -> (ByteString -> IO ()) -> IO ()) (IO ByteString) (IO ())
191+
192+----------------------------------------------------------------
193+
194+sendRsp :: Connection
195+ -> InternalInfo
196+ -> H.HttpVersion
197+ -> H.Status
198+ -> H.ResponseHeaders
199+ -> IndexedHeader -- Response
200+ -> Rsp
201+ -> IO (Maybe H.Status, Maybe Integer)
202+
203+----------------------------------------------------------------
204+
205+sendRsp conn _ ver s hs _ RspNoBody = do
206+ -- Not adding Content-Length.
207+ -- User agents treats it as Content-Length: 0.
208+ composeHeader ver s hs >>= connSendAll conn
209+ return (Just s, Nothing)
210+
211+----------------------------------------------------------------
212+
213+sendRsp conn _ ver s hs _ (RspBuilder body needsChunked) = do
214+ header <- composeHeaderBuilder ver s hs needsChunked
215+ let hdrBdy
216+ | needsChunked = header <> chunkedTransferEncoding body
217+ <> chunkedTransferTerminator
218+ | otherwise = header <> body
219+ buffer = connWriteBuffer conn
220+ size = connBufferSize conn
221+ toBufIOWith buffer size (connSendAll conn) hdrBdy
222+ return (Just s, Nothing) -- fixme: can we tell the actual sent bytes?
223+
224+----------------------------------------------------------------
225+
226+sendRsp conn _ ver s hs _ (RspStream streamingBody needsChunked th) = do
227+ header <- composeHeaderBuilder ver s hs needsChunked
228+ (recv, finish) <- newByteStringBuilderRecv $ reuseBufferStrategy
229+ $ toBuilderBuffer (connWriteBuffer conn) (connBufferSize conn)
230+ let send builder = do
231+ popper <- recv builder
232+ let loop = do
233+ bs <- popper
234+ unless (S.null bs) $ do
235+ sendFragment conn th bs
236+ loop
237+ loop
238+ sendChunk
239+ | needsChunked = send . chunkedTransferEncoding
240+ | otherwise = send
241+ send header
242+ streamingBody sendChunk (sendChunk flush)
243+ when needsChunked $ send chunkedTransferTerminator
244+ mbs <- finish
245+ maybe (return ()) (sendFragment conn th) mbs
246+ return (Just s, Nothing) -- fixme: can we tell the actual sent bytes?
247+
248+----------------------------------------------------------------
249+
250+sendRsp conn _ _ _ _ _ (RspRaw withApp src tickle) = do
251+ withApp recv send
252+ return (Nothing, Nothing)
253+ where
254+ recv = do
255+ bs <- src
256+ unless (S.null bs) tickle
257+ return bs
258+ send bs = connSendAll conn bs >> tickle
259+
260+----------------------------------------------------------------
261+
262+-- Sophisticated WAI applications.
263+-- We respect s0. s0 MUST be a proper value.
264+sendRsp conn ii ver s0 hs0 rspidxhdr (RspFile path (Just part) _ isHead hook) =
265+ sendRspFile2XX conn ii ver s0 hs rspidxhdr path beg len isHead hook
266+ where
267+ beg = filePartOffset part
268+ len = filePartByteCount part
269+ hs = addContentHeadersForFilePart hs0 part
270+
271+----------------------------------------------------------------
272+
273+-- Simple WAI applications.
274+-- Status is ignored
275+sendRsp conn ii ver _ hs0 rspidxhdr (RspFile path Nothing reqidxhdr isHead hook) = do
276+ efinfo <- E.try $ getFileInfo ii path
277+ case efinfo of
278+ Left (_ex :: E.IOException) ->
279+#ifdef WARP_DEBUG
280+ print _ex >>
281+#endif
282+ sendRspFile404 conn ii ver hs0 rspidxhdr
283+ Right finfo -> case conditionalRequest finfo hs0 rspidxhdr reqidxhdr of
284+ WithoutBody s -> sendRsp conn ii ver s hs0 rspidxhdr RspNoBody
285+ WithBody s hs beg len -> sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
286+
287+----------------------------------------------------------------
288+
289+sendRspFile2XX :: Connection
290+ -> InternalInfo
291+ -> H.HttpVersion
292+ -> H.Status
293+ -> H.ResponseHeaders
294+ -> IndexedHeader
295+ -> FilePath
296+ -> Integer
297+ -> Integer
298+ -> Bool
299+ -> IO ()
300+ -> IO (Maybe H.Status, Maybe Integer)
301+sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
302+ | isHead = sendRsp conn ii ver s hs rspidxhdr RspNoBody
303+ | otherwise = do
304+ lheader <- composeHeader ver s hs
305+ (mfd, fresher) <- getFd ii path
306+ let fid = FileId path mfd
307+ hook' = hook >> fresher
308+ connSendFile conn fid beg len hook' [lheader]
309+ return (Just s, Just len)
310+
311+sendRspFile404 :: Connection
312+ -> InternalInfo
313+ -> H.HttpVersion
314+ -> H.ResponseHeaders
315+ -> IndexedHeader
316+ -> IO (Maybe H.Status, Maybe Integer)
317+sendRspFile404 conn ii ver hs0 rspidxhdr = sendRsp conn ii ver s hs rspidxhdr (RspBuilder body True)
318+ where
319+ s = H.notFound404
320+ hs = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
321+ body = byteString "File not found"
322+
323+----------------------------------------------------------------
324+----------------------------------------------------------------
325+
326+-- | Use 'connSendAll' to send this data while respecting timeout rules.
327+sendFragment :: Connection -> T.Handle -> ByteString -> IO ()
328+sendFragment Connection { connSendAll = send } th bs = do
329+ T.resume th
330+ send bs
331+ T.pause th
332+ -- We pause timeouts before passing control back to user code. This ensures
333+ -- that a timeout will only ever be executed when Warp is in control. We
334+ -- also make sure to resume the timeout after the completion of user code
335+ -- so that we can kill idle connections.
336+
337+----------------------------------------------------------------
338+
339+infoFromRequest :: Request -> IndexedHeader -> (Bool -- isPersist
340+ ,Bool) -- isChunked
341+infoFromRequest req reqidxhdr = (checkPersist req reqidxhdr, checkChunk req)
342+
343+checkPersist :: Request -> IndexedHeader -> Bool
344+checkPersist req reqidxhdr
345+ | ver == H.http11 = checkPersist11 conn
346+ | otherwise = checkPersist10 conn
347+ where
348+ ver = httpVersion req
349+ conn = reqidxhdr ! fromEnum ReqConnection
350+ checkPersist11 (Just x)
351+ | CI.foldCase x == "close" = False
352+ checkPersist11 _ = True
353+ checkPersist10 (Just x)
354+ | CI.foldCase x == "keep-alive" = True
355+ checkPersist10 _ = False
356+
357+checkChunk :: Request -> Bool
358+checkChunk req = httpVersion req == H.http11
359+
360+----------------------------------------------------------------
361+
362+-- Used for ResponseBuilder and ResponseSource.
363+-- Don't use this for ResponseFile since this logic does not fit
364+-- for ResponseFile. For instance, isKeepAlive should be True in some cases
365+-- even if the response header does not have Content-Length.
366+--
367+-- Content-Length is specified by a reverse proxy.
368+-- Note that CGI does not specify Content-Length.
369+infoFromResponse :: IndexedHeader -> (Bool,Bool) -> (Bool,Bool)
370+infoFromResponse rspidxhdr (isPersist,isChunked) = (isKeepAlive, needsChunked)
371+ where
372+ needsChunked = isChunked && not hasLength
373+ isKeepAlive = isPersist && (isChunked || hasLength)
374+ hasLength = isJust $ rspidxhdr ! fromEnum ResContentLength
375+
376+----------------------------------------------------------------
377+
378+hasBody :: H.Status -> Bool
379+hasBody s = sc /= 204
380+ && sc /= 304
381+ && sc >= 200
382+ where
383+ sc = H.statusCode s
384+
385+----------------------------------------------------------------
386+
387+addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
388+addTransferEncoding hdrs = (H.hTransferEncoding, "chunked") : hdrs
389+
390+addDate :: IO D.GMTDate -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
391+addDate getdate rspidxhdr hdrs = case rspidxhdr ! fromEnum ResDate of
392+ Nothing -> do
393+ gmtdate <- getdate
394+ return $ (H.hDate, gmtdate) : hdrs
395+ Just _ -> return hdrs
396+
397+----------------------------------------------------------------
398+
399+-- | The version of Warp.
400+warpVersion :: String
401+warpVersion = showVersion Paths_warp.version
402+
403+{-# INLINE addServer #-}
404+addServer :: HeaderValue -> IndexedHeader -> H.ResponseHeaders -> H.ResponseHeaders
405+addServer "" rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
406+ Nothing -> hdrs
407+ _ -> filter ((/= H.hServer) . fst) hdrs
408+addServer serverName rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
409+ Nothing -> (H.hServer, serverName) : hdrs
410+ _ -> hdrs
411+
412+----------------------------------------------------------------
413+
414+-- |
415+--
416+-- >>> replaceHeader "Content-Type" "new" [("content-type","old")]
417+-- [("Content-Type","new")]
418+replaceHeader :: H.HeaderName -> HeaderValue -> H.ResponseHeaders -> H.ResponseHeaders
419+replaceHeader k v hdrs = (k,v) : deleteBy ((==) `on` fst) (k,v) hdrs
420+
421+----------------------------------------------------------------
422+
423+composeHeaderBuilder :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> Bool -> IO Builder
424+composeHeaderBuilder ver s hs True =
425+ byteString <$> composeHeader ver s (addTransferEncoding hs)
426+composeHeaderBuilder ver s hs False =
427+ byteString <$> composeHeader ver s hs
warp/Network/Wai/Handler/Warp/ResponseHeader.hsnew file+84
@@ -0,0 +1,84 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE BangPatterns #-}
3+
4+module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
5+
6+import qualified Data.ByteString as S
7+import Data.ByteString.Internal (create)
8+import qualified Data.CaseInsensitive as CI
9+import Foreign.Ptr
10+import GHC.Storable
11+import qualified Network.HTTP.Types as H
12+
13+import Network.Wai.Handler.Warp.Buffer (copy)
14+import Network.Wai.Handler.Warp.Imports
15+
16+----------------------------------------------------------------
17+
18+composeHeader :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> IO ByteString
19+composeHeader !httpversion !status !responseHeaders = create len $ \ptr -> do
20+ ptr1 <- copyStatus ptr httpversion status
21+ ptr2 <- copyHeaders ptr1 responseHeaders
22+ void $ copyCRLF ptr2
23+ where
24+ !len = 17 + slen + foldl' fieldLength 0 responseHeaders
25+ fieldLength !l (!k,!v) = l + S.length (CI.original k) + S.length v + 4
26+ !slen = S.length $ H.statusMessage status
27+
28+httpVer11 :: ByteString
29+httpVer11 = "HTTP/1.1 "
30+
31+httpVer10 :: ByteString
32+httpVer10 = "HTTP/1.0 "
33+
34+{-# INLINE copyStatus #-}
35+copyStatus :: Ptr Word8 -> H.HttpVersion -> H.Status -> IO (Ptr Word8)
36+copyStatus !ptr !httpversion !status = do
37+ ptr1 <- copy ptr httpVer
38+ writeWord8OffPtr ptr1 0 (zero + fromIntegral r2)
39+ writeWord8OffPtr ptr1 1 (zero + fromIntegral r1)
40+ writeWord8OffPtr ptr1 2 (zero + fromIntegral r0)
41+ writeWord8OffPtr ptr1 3 spc
42+ ptr2 <- copy (ptr1 `plusPtr` 4) (H.statusMessage status)
43+ copyCRLF ptr2
44+ where
45+ httpVer
46+ | httpversion == H.HttpVersion 1 1 = httpVer11
47+ | otherwise = httpVer10
48+ (q0,r0) = H.statusCode status `divMod` 10
49+ (q1,r1) = q0 `divMod` 10
50+ r2 = q1 `mod` 10
51+
52+{-# INLINE copyHeaders #-}
53+copyHeaders :: Ptr Word8 -> [H.Header] -> IO (Ptr Word8)
54+copyHeaders !ptr [] = return ptr
55+copyHeaders !ptr (h:hs) = do
56+ ptr1 <- copyHeader ptr h
57+ copyHeaders ptr1 hs
58+
59+{-# INLINE copyHeader #-}
60+copyHeader :: Ptr Word8 -> H.Header -> IO (Ptr Word8)
61+copyHeader !ptr (k,v) = do
62+ ptr1 <- copy ptr (CI.original k)
63+ writeWord8OffPtr ptr1 0 colon
64+ writeWord8OffPtr ptr1 1 spc
65+ ptr2 <- copy (ptr1 `plusPtr` 2) v
66+ copyCRLF ptr2
67+
68+{-# INLINE copyCRLF #-}
69+copyCRLF :: Ptr Word8 -> IO (Ptr Word8)
70+copyCRLF !ptr = do
71+ writeWord8OffPtr ptr 0 cr
72+ writeWord8OffPtr ptr 1 lf
73+ return $! ptr `plusPtr` 2
74+
75+zero :: Word8
76+zero = 48
77+spc :: Word8
78+spc = 32
79+colon :: Word8
80+colon = 58
81+cr :: Word8
82+cr = 13
83+lf :: Word8
84+lf = 10
warp/Network/Wai/Handler/Warp/Run.hsnew file+599
@@ -0,0 +1,599 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PackageImports #-}
5+{-# LANGUAGE PatternGuards #-}
6+{-# LANGUAGE RecordWildCards #-}
7+{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TupleSections #-}
9+{-# LANGUAGE ViewPatterns #-}
10+{-# OPTIONS_GHC -fno-warn-deprecations #-}
11+
12+module Network.Wai.Handler.Warp.Run where
13+
14+import "iproute" Data.IP (toHostAddress, toHostAddress6)
15+import Control.Arrow (first)
16+import qualified Control.Concurrent as Conc (yield)
17+import Control.Exception as E
18+import qualified Data.ByteString as S
19+import Data.Char (chr)
20+import Data.IORef (IORef, newIORef, readIORef, writeIORef)
21+import Data.Streaming.Network (bindPortTCP)
22+import Foreign.C.Error (Errno(..), eCONNABORTED)
23+import GHC.IO.Exception (IOException(..))
24+import qualified Network.HTTP2 as H2
25+import Network.Socket (Socket, close, accept, withSocketsDo, SockAddr(SockAddrInet, SockAddrInet6), setSocketOption, SocketOption(..))
26+#if MIN_VERSION_network(3,1,1)
27+import Network.Socket (gracefulClose)
28+#endif
29+import qualified Network.Socket.ByteString as Sock
30+import Network.Wai
31+import Network.Wai.Internal (ResponseReceived (ResponseReceived))
32+import System.Environment (lookupEnv)
33+import qualified System.TimeManager as T
34+import System.Timeout (timeout)
35+
36+import Network.Wai.Handler.Warp.Buffer
37+import Network.Wai.Handler.Warp.Counter
38+import qualified Network.Wai.Handler.Warp.Date as D
39+import qualified Network.Wai.Handler.Warp.FdCache as F
40+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
41+import Network.Wai.Handler.Warp.HTTP2 (http2)
42+import Network.Wai.Handler.Warp.HTTP2.Types (isHTTP2)
43+import Network.Wai.Handler.Warp.Header
44+import Network.Wai.Handler.Warp.Imports hiding (readInt)
45+import Network.Wai.Handler.Warp.ReadInt
46+import Network.Wai.Handler.Warp.Recv
47+import Network.Wai.Handler.Warp.Request
48+import Network.Wai.Handler.Warp.Response
49+import Network.Wai.Handler.Warp.SendFile
50+import Network.Wai.Handler.Warp.Settings
51+import Network.Wai.Handler.Warp.Types
52+
53+
54+#if WINDOWS
55+import Network.Wai.Handler.Warp.Windows
56+#else
57+import Network.Socket (fdSocket)
58+#endif
59+
60+-- | Creating 'Connection' for plain HTTP based on a given socket.
61+socketConnection :: Settings -> Socket -> IO Connection
62+#if MIN_VERSION_network(3,1,1)
63+socketConnection set s = do
64+#else
65+socketConnection _ s = do
66+#endif
67+ bufferPool <- newBufferPool
68+ writeBuf <- allocateBuffer bufferSize
69+ let sendall = Sock.sendAll s
70+ isH2 <- newIORef False -- HTTP/1.x
71+ return Connection {
72+ connSendMany = Sock.sendMany s
73+ , connSendAll = sendall
74+ , connSendFile = sendFile s writeBuf bufferSize sendall
75+#if MIN_VERSION_network(3,1,1)
76+ , connClose = do
77+ h2 <- readIORef isH2
78+ let tm = if h2 then settingsGracefulCloseTimeout2 set
79+ else settingsGracefulCloseTimeout1 set
80+ if tm == 0 then
81+ close s
82+ else
83+ gracefulClose s tm `E.catch` \(E.SomeException _) -> return ()
84+#else
85+ , connClose = close s
86+#endif
87+ , connFree = freeBuffer writeBuf
88+ , connRecv = receive s bufferPool
89+ , connRecvBuf = receiveBuf s
90+ , connWriteBuffer = writeBuf
91+ , connBufferSize = bufferSize
92+ , connHTTP2 = isH2
93+ }
94+
95+-- | Run an 'Application' on the given port.
96+-- This calls 'runSettings' with 'defaultSettings'.
97+run :: Port -> Application -> IO ()
98+run p = runSettings defaultSettings { settingsPort = p }
99+
100+-- | Run an 'Application' on the port present in the @PORT@
101+-- environment variable. Uses the 'Port' given when the variable is unset.
102+-- This calls 'runSettings' with 'defaultSettings'.
103+--
104+-- Since 3.0.9
105+runEnv :: Port -> Application -> IO ()
106+runEnv p app = do
107+ mp <- lookupEnv "PORT"
108+
109+ maybe (run p app) runReadPort mp
110+
111+ where
112+ runReadPort :: String -> IO ()
113+ runReadPort sp = case reads sp of
114+ ((p', _):_) -> run p' app
115+ _ -> fail $ "Invalid value in $PORT: " ++ sp
116+
117+-- | Run an 'Application' with the given 'Settings'.
118+-- This opens a listen socket on the port defined in 'Settings' and
119+-- calls 'runSettingsSocket'.
120+runSettings :: Settings -> Application -> IO ()
121+runSettings set app = withSocketsDo $
122+ bracket
123+ (bindPortTCP (settingsPort set) (settingsHost set))
124+ close
125+ (\socket -> do
126+ setSocketCloseOnExec socket
127+ runSettingsSocket set socket app)
128+
129+-- | This installs a shutdown handler for the given socket and
130+-- calls 'runSettingsConnection' with the default connection setup action
131+-- which handles plain (non-cipher) HTTP.
132+-- When the listen socket in the second argument is closed, all live
133+-- connections are gracefully shut down.
134+--
135+-- The supplied socket can be a Unix named socket, which
136+-- can be used when reverse HTTP proxying into your application.
137+--
138+-- Note that the 'settingsPort' will still be passed to 'Application's via the
139+-- 'serverPort' record.
140+runSettingsSocket :: Settings -> Socket -> Application -> IO ()
141+runSettingsSocket set socket app = do
142+ settingsInstallShutdownHandler set closeListenSocket
143+ runSettingsConnection set getConn app
144+ where
145+ getConn = do
146+#if WINDOWS
147+ (s, sa) <- windowsThreadBlockHack $ accept socket
148+#else
149+ (s, sa) <- accept socket
150+#endif
151+ setSocketCloseOnExec s
152+ -- NoDelay causes an error for AF_UNIX.
153+ setSocketOption s NoDelay 1 `E.catch` \(E.SomeException _) -> return ()
154+ conn <- socketConnection set s
155+ return (conn, sa)
156+
157+ closeListenSocket = close socket
158+
159+-- | The connection setup action would be expensive. A good example
160+-- is initialization of TLS.
161+-- So, this converts the connection setup action to the connection maker
162+-- which will be executed after forking a new worker thread.
163+-- Then this calls 'runSettingsConnectionMaker' with the connection maker.
164+-- This allows the expensive computations to be performed
165+-- in a separate worker thread instead of the main server loop.
166+--
167+-- Since 1.3.5
168+runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
169+runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMaker app
170+ where
171+ getConnMaker = do
172+ (conn, sa) <- getConn
173+ return (return conn, sa)
174+
175+-- | This modifies the connection maker so that it returns 'TCP' for 'Transport'
176+-- (i.e. plain HTTP) then calls 'runSettingsConnectionMakerSecure'.
177+runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
178+runSettingsConnectionMaker x y =
179+ runSettingsConnectionMakerSecure x (toTCP <$> y)
180+ where
181+ toTCP = first ((, TCP) <$>)
182+
183+----------------------------------------------------------------
184+
185+-- | The core run function which takes 'Settings',
186+-- a connection maker and 'Application'.
187+-- The connection maker can return a connection of either plain HTTP
188+-- or HTTP over TLS.
189+--
190+-- Since 2.1.4
191+runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO ()
192+runSettingsConnectionMakerSecure set getConnMaker app = do
193+ settingsBeforeMainLoop set
194+ counter <- newCounter
195+ withII $ acceptConnection set getConnMaker app counter
196+ where
197+ withII action =
198+ withTimeoutManager $ \tm ->
199+ D.withDateCache $ \dc ->
200+ F.withFdCache fdCacheDurationInSeconds $ \fdc ->
201+ I.withFileInfoCache fdFileInfoDurationInSeconds $ \fic -> do
202+ let ii = InternalInfo tm dc fdc fic
203+ action ii
204+
205+ !fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
206+ !fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
207+ !timeoutInSeconds = settingsTimeout set * 1000000
208+ withTimeoutManager f = case settingsManager set of
209+ Just tm -> f tm
210+ Nothing -> bracket
211+ (T.initialize timeoutInSeconds)
212+ T.stopManager
213+ f
214+
215+-- Note that there is a thorough discussion of the exception safety of the
216+-- following code at: https://github.com/yesodweb/wai/issues/146
217+--
218+-- We need to make sure of two things:
219+--
220+-- 1. Asynchronous exceptions are not blocked entirely in the main loop.
221+-- Doing so would make it impossible to kill the Warp thread.
222+--
223+-- 2. Once a connection maker is received via acceptNewConnection, the
224+-- connection is guaranteed to be closed, even in the presence of
225+-- async exceptions.
226+--
227+-- Our approach is explained in the comments below.
228+acceptConnection :: Settings
229+ -> IO (IO (Connection, Transport), SockAddr)
230+ -> Application
231+ -> Counter
232+ -> InternalInfo
233+ -> IO ()
234+acceptConnection set getConnMaker app counter ii = do
235+ -- First mask all exceptions in acceptLoop. This is necessary to
236+ -- ensure that no async exception is throw between the call to
237+ -- acceptNewConnection and the registering of connClose.
238+ --
239+ -- acceptLoop can be broken by closing the listing socket.
240+ void $ mask_ acceptLoop
241+ -- In some cases, we want to stop Warp here without graceful shutdown.
242+ -- So, async exceptions are allowed here.
243+ -- That's why `finally` is not used.
244+ gracefulShutdown set counter
245+ where
246+ acceptLoop = do
247+ -- Allow async exceptions before receiving the next connection maker.
248+ allowInterrupt
249+
250+ -- acceptNewConnection will try to receive the next incoming
251+ -- request. It returns a /connection maker/, not a connection,
252+ -- since in some circumstances creating a working connection
253+ -- from a raw socket may be an expensive operation, and this
254+ -- expensive work should not be performed in the main event
255+ -- loop. An example of something expensive would be TLS
256+ -- negotiation.
257+ mx <- acceptNewConnection
258+ case mx of
259+ Nothing -> return ()
260+ Just (mkConn, addr) -> do
261+ fork set mkConn addr app counter ii
262+ acceptLoop
263+
264+ acceptNewConnection = do
265+ ex <- try getConnMaker
266+ case ex of
267+ Right x -> return $ Just x
268+ Left e -> do
269+ let eConnAborted = getErrno eCONNABORTED
270+ getErrno (Errno cInt) = cInt
271+ if ioe_errno e == Just eConnAborted
272+ then acceptNewConnection
273+ else do
274+ settingsOnException set Nothing $ toException e
275+ return Nothing
276+
277+-- Fork a new worker thread for this connection maker, and ask for a
278+-- function to unmask (i.e., allow async exceptions to be thrown).
279+fork :: Settings
280+ -> IO (Connection, Transport)
281+ -> SockAddr
282+ -> Application
283+ -> Counter
284+ -> InternalInfo
285+ -> IO ()
286+fork set mkConn addr app counter ii = settingsFork set $ \unmask ->
287+ -- Call the user-supplied on exception code if any
288+ -- exceptions are thrown.
289+ handle (settingsOnException set Nothing) $
290+ -- Run the connection maker to get a new connection, and ensure
291+ -- that the connection is closed. If the mkConn call throws an
292+ -- exception, we will leak the connection. If the mkConn call is
293+ -- vulnerable to attacks (e.g., Slowloris), we do nothing to
294+ -- protect the server. It is therefore vital that mkConn is well
295+ -- vetted.
296+ --
297+ -- We grab the connection before registering timeouts since the
298+ -- timeouts will be useless during connection creation, due to the
299+ -- fact that async exceptions are still masked.
300+ bracket mkConn cleanUp (serve unmask)
301+ where
302+ cleanUp (conn, _) = connClose conn `finally` connFree conn
303+
304+ -- We need to register a timeout handler for this thread, and
305+ -- cancel that handler as soon as we exit.
306+ serve unmask (conn, transport) = bracket register cancel $ \th -> do
307+ -- We now have fully registered a connection close handler in
308+ -- the case of all exceptions, so it is safe to once again
309+ -- allow async exceptions.
310+ unmask .
311+ -- Call the user-supplied code for connection open and
312+ -- close events
313+ bracket (onOpen addr) (onClose addr) $ \goingon ->
314+ -- Actually serve this connection. bracket with closeConn
315+ -- above ensures the connection is closed.
316+ when goingon $ serveConnection conn ii th addr transport set app
317+ where
318+ register = T.registerKillThread (timeoutManager ii) (connClose conn)
319+ cancel = T.cancel
320+
321+ onOpen adr = increase counter >> settingsOnOpen set adr
322+ onClose adr _ = decrease counter >> settingsOnClose set adr
323+
324+serveConnection :: Connection
325+ -> InternalInfo
326+ -> T.Handle
327+ -> SockAddr
328+ -> Transport
329+ -> Settings
330+ -> Application
331+ -> IO ()
332+serveConnection conn ii th origAddr transport settings app = do
333+ -- fixme: Upgrading to HTTP/2 should be supported.
334+ (h2,bs) <- if isHTTP2 transport then
335+ return (True, "")
336+ else do
337+ bs0 <- connRecv conn
338+ if S.length bs0 >= 4 && "PRI " `S.isPrefixOf` bs0 then
339+ return (True, bs0)
340+ else
341+ return (False, bs0)
342+ istatus <- newIORef False
343+ if settingsHTTP2Enabled settings && h2 then do
344+ rawRecvN <- makeReceiveN bs (connRecv conn) (connRecvBuf conn)
345+ -- This thread becomes the sender in http2 library.
346+ -- In the case of event source, one request comes and one
347+ -- worker gets busy. But it is likely that the receiver does
348+ -- not receive any data at all while the sender is sending
349+ -- output data from the worker. It's not good enough to tickle
350+ -- the time handler in the receiver only. So, we should tickle
351+ -- the time handler in both the receiver and the sender.
352+ let recvN = wrappedRecvN th istatus (settingsSlowlorisSize settings) rawRecvN
353+ sendBS x = connSendAll conn x >> T.tickle th
354+ -- fixme: origAddr
355+ checkTLS
356+ setConnHTTP2 conn True
357+ http2 conn transport ii origAddr settings recvN sendBS app
358+ else do
359+ src <- mkSource (wrappedRecv conn th istatus (settingsSlowlorisSize settings))
360+ writeIORef istatus True
361+ leftoverSource src bs
362+ addr <- getProxyProtocolAddr src
363+ http1 True addr istatus src `E.catch` \e ->
364+ case () of
365+ ()
366+ -- See comment below referencing
367+ -- https://github.com/yesodweb/wai/issues/618
368+ | Just NoKeepAliveRequest <- fromException e -> return ()
369+ -- No valid request
370+ | Just (BadFirstLine _) <- fromException e -> return ()
371+ | otherwise -> do
372+ _ <- sendErrorResponse (dummyreq addr) istatus e
373+ throwIO e
374+
375+ where
376+ getProxyProtocolAddr src =
377+ case settingsProxyProtocol settings of
378+ ProxyProtocolNone ->
379+ return origAddr
380+ ProxyProtocolRequired -> do
381+ seg <- readSource src
382+ parseProxyProtocolHeader src seg
383+ ProxyProtocolOptional -> do
384+ seg <- readSource src
385+ if S.isPrefixOf "PROXY " seg
386+ then parseProxyProtocolHeader src seg
387+ else do leftoverSource src seg
388+ return origAddr
389+
390+ parseProxyProtocolHeader src seg = do
391+ let (header,seg') = S.break (== 0x0d) seg -- 0x0d == CR
392+ maybeAddr = case S.split 0x20 header of -- 0x20 == space
393+ ["PROXY","TCP4",clientAddr,_,clientPort,_] ->
394+ case [x | (x, t) <- reads (decodeAscii clientAddr), null t] of
395+ [a] -> Just (SockAddrInet (readInt clientPort)
396+ (toHostAddress a))
397+ _ -> Nothing
398+ ["PROXY","TCP6",clientAddr,_,clientPort,_] ->
399+ case [x | (x, t) <- reads (decodeAscii clientAddr), null t] of
400+ [a] -> Just (SockAddrInet6 (readInt clientPort)
401+ 0
402+ (toHostAddress6 a)
403+ 0)
404+ _ -> Nothing
405+ ("PROXY":"UNKNOWN":_) ->
406+ Just origAddr
407+ _ ->
408+ Nothing
409+ case maybeAddr of
410+ Nothing -> throwIO (BadProxyHeader (decodeAscii header))
411+ Just a -> do leftoverSource src (S.drop 2 seg') -- drop CRLF
412+ return a
413+
414+ decodeAscii = map (chr . fromEnum) . S.unpack
415+
416+ shouldSendErrorResponse se
417+ | Just ConnectionClosedByPeer <- fromException se = False
418+ | otherwise = True
419+
420+ sendErrorResponse req istatus e = do
421+ status <- readIORef istatus
422+ if shouldSendErrorResponse e && status
423+ then do
424+ sendResponse settings conn ii th req defaultIndexRequestHeader (return S.empty) (errorResponse e)
425+ else return False
426+
427+ dummyreq addr = defaultRequest { remoteHost = addr }
428+
429+ errorResponse e = settingsOnExceptionResponse settings e
430+
431+ http1 firstRequest addr istatus src = do
432+ (req, mremainingRef, idxhdr, nextBodyFlush) <- recvRequest firstRequest settings conn ii th addr src transport
433+ keepAlive <- processRequest istatus src req mremainingRef idxhdr nextBodyFlush
434+ `E.catch` \e -> do
435+ settingsOnException settings (Just req) e
436+ -- Don't throw the error again to prevent calling settingsOnException twice.
437+ return False
438+
439+ -- When doing a keep-alive connection, the other side may just
440+ -- close the connection. We don't want to treat that as an
441+ -- exceptional situation, so we pass in False to http1 (which
442+ -- in turn passes in False to recvRequest), indicating that
443+ -- this is not the first request. If, when trying to read the
444+ -- request headers, no data is available, recvRequest will
445+ -- throw a NoKeepAliveRequest exception, which we catch here
446+ -- and ignore. See: https://github.com/yesodweb/wai/issues/618
447+ when keepAlive $ http1 False addr istatus src
448+
449+ processRequest istatus src req mremainingRef idxhdr nextBodyFlush = do
450+ -- Let the application run for as long as it wants
451+ T.pause th
452+
453+ -- In the event that some scarce resource was acquired during
454+ -- creating the request, we need to make sure that we don't get
455+ -- an async exception before calling the ResponseSource.
456+ keepAliveRef <- newIORef $ error "keepAliveRef not filled"
457+ r <- E.try $ app req $ \res -> do
458+ T.resume th
459+ -- FIXME consider forcing evaluation of the res here to
460+ -- send more meaningful error messages to the user.
461+ -- However, it may affect performance.
462+ writeIORef istatus False
463+ keepAlive <- sendResponse settings conn ii th req idxhdr (readSource src) res
464+ writeIORef keepAliveRef keepAlive
465+ return ResponseReceived
466+ case r of
467+ Right ResponseReceived -> return ()
468+ Left e@(SomeException _)
469+ | Just (ExceptionInsideResponseBody e') <- fromException e -> throwIO e'
470+ | otherwise -> do
471+ keepAlive <- sendErrorResponse req istatus e
472+ settingsOnException settings (Just req) e
473+ writeIORef keepAliveRef keepAlive
474+
475+ keepAlive <- readIORef keepAliveRef
476+
477+ -- We just send a Response and it takes a time to
478+ -- receive a Request again. If we immediately call recv,
479+ -- it is likely to fail and cause the IO manager to do some work.
480+ -- It is very costly, so we yield to another Haskell
481+ -- thread hoping that the next Request will arrive
482+ -- when this Haskell thread will be re-scheduled.
483+ -- This improves performance at least when
484+ -- the number of cores is small.
485+ Conc.yield
486+
487+ if keepAlive
488+ then
489+ -- If there is an unknown or large amount of data to still be read
490+ -- from the request body, simple drop this connection instead of
491+ -- reading it all in to satisfy a keep-alive request.
492+ case settingsMaximumBodyFlush settings of
493+ Nothing -> do
494+ flushEntireBody nextBodyFlush
495+ T.resume th
496+ return True
497+ Just maxToRead -> do
498+ let tryKeepAlive = do
499+ -- flush the rest of the request body
500+ isComplete <- flushBody nextBodyFlush maxToRead
501+ if isComplete then do
502+ T.resume th
503+ return True
504+ else
505+ return False
506+ case mremainingRef of
507+ Just ref -> do
508+ remaining <- readIORef ref
509+ if remaining <= maxToRead then
510+ tryKeepAlive
511+ else
512+ return False
513+ Nothing -> tryKeepAlive
514+ else
515+ return False
516+
517+ checkTLS = case transport of
518+ TCP -> return () -- direct
519+ tls -> unless (tls12orLater tls) $ goaway conn H2.InadequateSecurity "Weak TLS"
520+ tls12orLater tls = tlsMajorVersion tls == 3 && tlsMinorVersion tls >= 3
521+
522+-- connClose must not be called here since Run:fork calls it
523+goaway :: Connection -> H2.ErrorCodeId -> ByteString -> IO ()
524+goaway Connection{..} etype debugmsg = connSendAll bytestream
525+ where
526+ einfo = H2.encodeInfo id 0
527+ frame = H2.GoAwayFrame 0 etype debugmsg
528+ bytestream = H2.encodeFrame einfo frame
529+
530+flushEntireBody :: IO ByteString -> IO ()
531+flushEntireBody src =
532+ loop
533+ where
534+ loop = do
535+ bs <- src
536+ unless (S.null bs) loop
537+
538+flushBody :: IO ByteString -- ^ get next chunk
539+ -> Int -- ^ maximum to flush
540+ -> IO Bool -- ^ True == flushed the entire body, False == we didn't
541+flushBody src =
542+ loop
543+ where
544+ loop toRead = do
545+ bs <- src
546+ let toRead' = toRead - S.length bs
547+ case () of
548+ ()
549+ | S.null bs -> return True
550+ | toRead' >= 0 -> loop toRead'
551+ | otherwise -> return False
552+
553+wrappedRecv :: Connection -> T.Handle -> IORef Bool -> Int -> IO ByteString
554+wrappedRecv Connection { connRecv = recv } th istatus slowlorisSize = do
555+ bs <- recv
556+ unless (S.null bs) $ do
557+ writeIORef istatus True
558+ when (S.length bs >= slowlorisSize) $ T.tickle th
559+ return bs
560+
561+wrappedRecvN :: T.Handle -> IORef Bool -> Int -> (BufSize -> IO ByteString) -> (BufSize -> IO ByteString)
562+wrappedRecvN th istatus slowlorisSize readN bufsize = do
563+ bs <- readN bufsize
564+ unless (S.null bs) $ do
565+ writeIORef istatus True
566+ -- TODO: think about the slowloris protection in HTTP2: current code
567+ -- might open a slow-loris attack vector. Rather than timing we should
568+ -- consider limiting the per-client connections assuming that in HTTP2
569+ -- we should allow only few connections per host (real-world
570+ -- deployments with large NATs may be trickier).
571+ when (S.length bs >= slowlorisSize || bufsize <= slowlorisSize) $ T.tickle th
572+ return bs
573+
574+-- | Set flag FileCloseOnExec flag on a socket (on Unix)
575+--
576+-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
577+--
578+-- @since 3.2.17
579+setSocketCloseOnExec :: Socket -> IO ()
580+#if WINDOWS
581+setSocketCloseOnExec _ = return ()
582+#else
583+setSocketCloseOnExec socket = do
584+#if MIN_VERSION_network(3,0,0)
585+ fd <- fdSocket socket
586+#else
587+ let fd = fdSocket socket
588+#endif
589+ F.setFileCloseOnExec $ fromIntegral fd
590+#endif
591+
592+gracefulShutdown :: Settings -> Counter -> IO ()
593+gracefulShutdown set counter =
594+ case settingsGracefulShutdownTimeout set of
595+ Nothing ->
596+ waitForZero counter
597+ (Just seconds) ->
598+ void (timeout (seconds * microsPerSecond) (waitForZero counter))
599+ where microsPerSecond = 1000000
warp/Network/Wai/Handler/Warp/SendFile.hsnew file+149
@@ -0,0 +1,149 @@
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
2+
3+module Network.Wai.Handler.Warp.SendFile (
4+ sendFile
5+ , readSendFile
6+ , packHeader -- for testing
7+#ifndef WINDOWS
8+ , positionRead
9+#endif
10+ ) where
11+
12+import qualified Data.ByteString as BS
13+import Network.Socket (Socket)
14+
15+#ifdef WINDOWS
16+import Foreign.ForeignPtr (newForeignPtr_)
17+import Foreign.Ptr (plusPtr)
18+import qualified System.IO as IO
19+#else
20+import Control.Exception
21+import Foreign.C.Error (throwErrno)
22+import Foreign.C.Types
23+import Foreign.Ptr (Ptr, castPtr, plusPtr)
24+import Network.Sendfile
25+import Network.Wai.Handler.Warp.FdCache (openFile, closeFile)
26+import System.Posix.Types
27+#endif
28+
29+import Network.Wai.Handler.Warp.Buffer
30+import Network.Wai.Handler.Warp.Imports
31+import Network.Wai.Handler.Warp.Types
32+
33+----------------------------------------------------------------
34+
35+-- | Function to send a file based on sendfile() for Linux\/Mac\/FreeBSD.
36+-- This makes use of the file descriptor cache.
37+-- For other OSes, this is identical to 'readSendFile'.
38+--
39+-- Since: 3.1.0
40+sendFile :: Socket -> Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
41+#ifdef SENDFILEFD
42+sendFile s _ _ _ fid off len act hdr = case mfid of
43+ -- settingsFdCacheDuration is 0
44+ Nothing -> sendfileWithHeader s path (PartOfFile off len) act hdr
45+ Just fd -> sendfileFdWithHeader s fd (PartOfFile off len) act hdr
46+ where
47+ mfid = fileIdFd fid
48+ path = fileIdPath fid
49+#else
50+sendFile _ = readSendFile
51+#endif
52+
53+----------------------------------------------------------------
54+
55+packHeader :: Buffer -> BufSize -> (ByteString -> IO ())
56+ -> IO () -> [ByteString]
57+ -> Int
58+ -> IO Int
59+packHeader _ _ _ _ [] n = return n
60+packHeader buf siz send hook (bs:bss) n
61+ | len < room = do
62+ let dst = buf `plusPtr` n
63+ void $ copy dst bs
64+ packHeader buf siz send hook bss (n + len)
65+ | otherwise = do
66+ let dst = buf `plusPtr` n
67+ (bs1, bs2) = BS.splitAt room bs
68+ void $ copy dst bs1
69+ bufferIO buf siz send
70+ hook
71+ packHeader buf siz send hook (bs2:bss) 0
72+ where
73+ len = BS.length bs
74+ room = siz - n
75+
76+mini :: Int -> Integer -> Int
77+mini i n
78+ | fromIntegral i < n = i
79+ | otherwise = fromIntegral n
80+
81+-- | Function to send a file based on pread()\/send() for Unix.
82+-- This makes use of the file descriptor cache.
83+-- For Windows, this is emulated by 'Handle'.
84+--
85+-- Since: 3.1.0
86+#ifdef WINDOWS
87+readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
88+readSendFile buf siz send fid off0 len0 hook headers = do
89+ hn <- packHeader buf siz send hook headers 0
90+ let room = siz - hn
91+ buf' = buf `plusPtr` hn
92+ IO.withBinaryFile path IO.ReadMode $ \h -> do
93+ IO.hSeek h IO.AbsoluteSeek off0
94+ n <- IO.hGetBufSome h buf' (mini room len0)
95+ bufferIO buf (hn + n) send
96+ hook
97+ let n' = fromIntegral n
98+ fptr <- newForeignPtr_ buf
99+ loop h fptr (len0 - n')
100+ where
101+ path = fileIdPath fid
102+ loop h fptr len
103+ | len <= 0 = return ()
104+ | otherwise = do
105+ n <- IO.hGetBufSome h buf (mini siz len)
106+ when (n /= 0) $ do
107+ let bs = PS fptr 0 n
108+ n' = fromIntegral n
109+ send bs
110+ hook
111+ loop h fptr (len - n')
112+#else
113+readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
114+readSendFile buf siz send fid off0 len0 hook headers =
115+ bracket setup teardown $ \fd -> do
116+ hn <- packHeader buf siz send hook headers 0
117+ let room = siz - hn
118+ buf' = buf `plusPtr` hn
119+ n <- positionRead fd buf' (mini room len0) off0
120+ bufferIO buf (hn + n) send
121+ hook
122+ let n' = fromIntegral n
123+ loop fd (len0 - n') (off0 + n')
124+ where
125+ path = fileIdPath fid
126+ setup = case fileIdFd fid of
127+ Just fd -> return fd
128+ Nothing -> openFile path
129+ teardown fd = case fileIdFd fid of
130+ Just _ -> return ()
131+ Nothing -> closeFile fd
132+ loop fd len off
133+ | len <= 0 = return ()
134+ | otherwise = do
135+ n <- positionRead fd buf (mini siz len) off
136+ bufferIO buf n send
137+ let n' = fromIntegral n
138+ hook
139+ loop fd (len - n') (off + n')
140+
141+positionRead :: Fd -> Buffer -> BufSize -> Integer -> IO Int
142+positionRead fd buf siz off = do
143+ bytes <- fromIntegral <$> c_pread fd (castPtr buf) (fromIntegral siz) (fromIntegral off)
144+ when (bytes < 0) $ throwErrno "positionRead"
145+ return bytes
146+
147+foreign import ccall unsafe "pread"
148+ c_pread :: Fd -> Ptr CChar -> ByteCount -> FileOffset -> IO CSsize
149+#endif
warp/Network/Wai/Handler/Warp/Settings.hsnew file+231
@@ -0,0 +1,231 @@
1+{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, ViewPatterns #-}
2+{-# LANGUAGE PatternGuards, RankNTypes #-}
3+{-# LANGUAGE ImpredicativeTypes, CPP #-}
4+
5+module Network.Wai.Handler.Warp.Settings where
6+
7+import Control.Concurrent (forkIOWithUnmask)
8+import Control.Exception
9+import Data.ByteString.Builder (byteString)
10+import qualified Data.ByteString.Char8 as C8
11+import Data.ByteString.Lazy (fromStrict)
12+import Data.Streaming.Network (HostPreference)
13+import qualified Data.Text as T
14+import qualified Data.Text.IO as TIO
15+import Data.Version (showVersion)
16+import GHC.IO.Exception (IOErrorType(..))
17+import qualified Network.HTTP.Types as H
18+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
19+import Network.Socket (SockAddr)
20+import Network.Wai
21+import qualified Paths_warp
22+import System.IO (stderr)
23+import System.IO.Error (ioeGetErrorType)
24+import System.TimeManager
25+
26+import Network.Wai.Handler.Warp.Imports
27+import Network.Wai.Handler.Warp.Types
28+
29+-- | Various Warp server settings. This is purposely kept as an abstract data
30+-- type so that new settings can be added without breaking backwards
31+-- compatibility. In order to create a 'Settings' value, use 'defaultSettings'
32+-- and the various \'set\' functions to modify individual fields. For example:
33+--
34+-- > setTimeout 20 defaultSettings
35+data Settings = Settings
36+ { settingsPort :: Port -- ^ Port to listen on. Default value: 3000
37+ , settingsHost :: HostPreference -- ^ Default value: HostIPv4
38+ , settingsOnException :: Maybe Request -> SomeException -> IO () -- ^ What to do with exceptions thrown by either the application or server. Default: ignore server-generated exceptions (see 'InvalidRequest') and print application-generated applications to stderr.
39+ , settingsOnExceptionResponse :: SomeException -> Response
40+ -- ^ A function to create `Response` when an exception occurs.
41+ --
42+ -- Default: 500, text/plain, \"Something went wrong\"
43+ --
44+ -- Since 2.0.3
45+ , settingsOnOpen :: SockAddr -> IO Bool -- ^ What to do when a connection is open. When 'False' is returned, the connection is closed immediately. Otherwise, the connection is going on. Default: always returns 'True'.
46+ , settingsOnClose :: SockAddr -> IO () -- ^ What to do when a connection is close. Default: do nothing.
47+ , settingsTimeout :: Int -- ^ Timeout value in seconds. Default value: 30
48+ , settingsManager :: Maybe Manager -- ^ Use an existing timeout manager instead of spawning a new one. If used, 'settingsTimeout' is ignored. Default is 'Nothing'
49+ , settingsFdCacheDuration :: Int -- ^ Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 0
50+ , settingsFileInfoCacheDuration :: Int -- ^ Cache duration time of file information in seconds. 0 means that the cache mechanism is not used. Default value: 0
51+ , settingsBeforeMainLoop :: IO ()
52+ -- ^ Code to run after the listening socket is ready but before entering
53+ -- the main event loop. Useful for signaling to tests that they can start
54+ -- running, or to drop permissions after binding to a restricted port.
55+ --
56+ -- Default: do nothing.
57+ --
58+ -- Since 1.3.6
59+
60+ , settingsFork :: ((forall a. IO a -> IO a) -> IO ()) -> IO ()
61+ -- ^ Code to fork a new thread to accept a connection.
62+ --
63+ -- This may be useful if you need OS bound threads, or if
64+ -- you wish to develop an alternative threading model.
65+ --
66+ -- Default: void . forkIOWithUnmask
67+ --
68+ -- Since 3.0.4
69+
70+ , settingsNoParsePath :: Bool
71+ -- ^ Perform no parsing on the rawPathInfo.
72+ --
73+ -- This is useful for writing HTTP proxies.
74+ --
75+ -- Default: False
76+ --
77+ -- Since 2.0.3
78+ , settingsInstallShutdownHandler :: IO () -> IO ()
79+ -- ^ An action to install a handler (e.g. Unix signal handler)
80+ -- to close a listen socket.
81+ -- The first argument is an action to close the listen socket.
82+ --
83+ -- Default: no action
84+ --
85+ -- Since 3.0.1
86+ , settingsServerName :: ByteString
87+ -- ^ Default server name if application does not set one.
88+ --
89+ -- Since 3.0.2
90+ , settingsMaximumBodyFlush :: Maybe Int
91+ -- ^ See @setMaximumBodyFlush@.
92+ --
93+ -- Since 3.0.3
94+ , settingsProxyProtocol :: ProxyProtocol
95+ -- ^ Specify usage of the PROXY protocol.
96+ --
97+ -- Since 3.0.5
98+ , settingsSlowlorisSize :: Int
99+ -- ^ Size of bytes read to prevent Slowloris protection. Default value: 2048
100+ --
101+ -- Since 3.1.2
102+ , settingsHTTP2Enabled :: Bool
103+ -- ^ Whether to enable HTTP2 ALPN/upgrades. Default: True
104+ --
105+ -- Since 3.1.7
106+ , settingsLogger :: Request -> H.Status -> Maybe Integer -> IO ()
107+ -- ^ A log function. Default: no action.
108+ --
109+ -- Since 3.1.10
110+ , settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
111+ -- ^ A HTTP/2 server push log function. Default: no action.
112+ --
113+ -- Since 3.2.7
114+ , settingsGracefulShutdownTimeout :: Maybe Int
115+ -- ^ An optional timeout to limit the time (in seconds) waiting for
116+ -- a graceful shutdown of the web server.
117+ --
118+ -- Since 3.2.8
119+ , settingsGracefulCloseTimeout1 :: Int
120+ -- ^ A timeout to limit the time (in milliseconds) waiting for
121+ -- FIN for HTTP/1.x. 0 means uses immediate close.
122+ -- Default: 0.
123+ --
124+ -- Since 3.3.5
125+ , settingsGracefulCloseTimeout2 :: Int
126+ -- ^ A timeout to limit the time (in milliseconds) waiting for
127+ -- FIN for HTTP/2. 0 means uses immediate close.
128+ -- Default: 2000.
129+ --
130+ -- Since 3.3.5
131+ , settingsMaxTotalHeaderLength :: Int
132+ -- ^ Determines the maximum header size that Warp will tolerate when using HTTP/1.x.
133+ --
134+ -- Since 3.3.8
135+ }
136+
137+-- | Specify usage of the PROXY protocol.
138+data ProxyProtocol = ProxyProtocolNone
139+ -- ^ See @setProxyProtocolNone@.
140+ | ProxyProtocolRequired
141+ -- ^ See @setProxyProtocolRequired@.
142+ | ProxyProtocolOptional
143+ -- ^ See @setProxyProtocolOptional@.
144+
145+-- | The default settings for the Warp server. See the individual settings for
146+-- the default value.
147+defaultSettings :: Settings
148+defaultSettings = Settings
149+ { settingsPort = 3000
150+ , settingsHost = "*4"
151+ , settingsOnException = defaultOnException
152+ , settingsOnExceptionResponse = defaultOnExceptionResponse
153+ , settingsOnOpen = const $ return True
154+ , settingsOnClose = const $ return ()
155+ , settingsTimeout = 30
156+ , settingsManager = Nothing
157+ , settingsFdCacheDuration = 0
158+ , settingsFileInfoCacheDuration = 0
159+ , settingsBeforeMainLoop = return ()
160+ , settingsFork = void . forkIOWithUnmask
161+ , settingsNoParsePath = False
162+ , settingsInstallShutdownHandler = const $ return ()
163+ , settingsServerName = C8.pack $ "Warp/" ++ showVersion Paths_warp.version
164+ , settingsMaximumBodyFlush = Just 8192
165+ , settingsProxyProtocol = ProxyProtocolNone
166+ , settingsSlowlorisSize = 2048
167+ , settingsHTTP2Enabled = True
168+ , settingsLogger = \_ _ _ -> return ()
169+ , settingsServerPushLogger = \_ _ _ -> return ()
170+ , settingsGracefulShutdownTimeout = Nothing
171+ , settingsGracefulCloseTimeout1 = 0
172+ , settingsGracefulCloseTimeout2 = 2000
173+ , settingsMaxTotalHeaderLength = 50 * 1024
174+ }
175+
176+-- | Apply the logic provided by 'defaultOnException' to determine if an
177+-- exception should be shown or not. The goal is to hide exceptions which occur
178+-- under the normal course of the web server running.
179+--
180+-- Since 2.1.3
181+defaultShouldDisplayException :: SomeException -> Bool
182+defaultShouldDisplayException se
183+ | Just ThreadKilled <- fromException se = False
184+ | Just (_ :: InvalidRequest) <- fromException se = False
185+ | Just (ioeGetErrorType -> et) <- fromException se
186+ , et == ResourceVanished || et == InvalidArgument = False
187+ | Just TimeoutThread <- fromException se = False
188+ | otherwise = True
189+
190+-- | Printing an exception to standard error
191+-- if `defaultShouldDisplayException` returns `True`.
192+--
193+-- Since: 3.1.0
194+defaultOnException :: Maybe Request -> SomeException -> IO ()
195+defaultOnException _ e =
196+ when (defaultShouldDisplayException e)
197+ $ TIO.hPutStrLn stderr $ T.pack $ show e
198+
199+-- | Sending 400 for bad requests.
200+-- Sending 500 for internal server errors.
201+-- Since: 3.1.0
202+-- Sending 413 for too large payload.
203+-- Sending 431 for too large headers.
204+-- Since 3.2.27
205+defaultOnExceptionResponse :: SomeException -> Response
206+defaultOnExceptionResponse e
207+ | Just (_ :: InvalidRequest) <-
208+ fromException e = responseLBS H.badRequest400
209+ [(H.hContentType, "text/plain; charset=utf-8")]
210+ "Bad Request"
211+ | Just (ConnectionError (UnknownErrorCode 413) t) <-
212+ fromException e = responseLBS H.status413
213+ [(H.hContentType, "text/plain; charset=utf-8")]
214+ (fromStrict t)
215+ | Just (ConnectionError (UnknownErrorCode 431) t) <-
216+ fromException e = responseLBS H.status431
217+ [(H.hContentType, "text/plain; charset=utf-8")]
218+ (fromStrict t)
219+ | otherwise = responseLBS H.internalServerError500
220+ [(H.hContentType, "text/plain; charset=utf-8")]
221+ "Something went wrong"
222+
223+-- | Exception handler for the debugging purpose.
224+-- 500, text/plain, a showed exception.
225+--
226+-- Since: 2.0.3.2
227+exceptionResponseForDebug :: SomeException -> Response
228+exceptionResponseForDebug e =
229+ responseBuilder H.internalServerError500
230+ [(H.hContentType, "text/plain; charset=utf-8")]
231+ $ byteString . C8.pack $ "Exception: " ++ show e
warp/Network/Wai/Handler/Warp/Types.hsnew file+188
@@ -0,0 +1,188 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE CPP #-}
4+
5+module Network.Wai.Handler.Warp.Types where
6+
7+import Control.Exception
8+import qualified Data.ByteString as S
9+import Data.IORef (IORef, readIORef, writeIORef, newIORef)
10+import Data.Typeable (Typeable)
11+import Data.X509
12+import Foreign.Ptr (Ptr)
13+import System.Posix.Types (Fd)
14+import qualified System.TimeManager as T
15+
16+import qualified Network.Wai.Handler.Warp.Date as D
17+import qualified Network.Wai.Handler.Warp.FdCache as F
18+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
19+import Network.Wai.Handler.Warp.Imports
20+
21+----------------------------------------------------------------
22+
23+-- | TCP port number.
24+type Port = Int
25+
26+----------------------------------------------------------------
27+
28+-- | The type for header value used with 'HeaderName'.
29+type HeaderValue = ByteString
30+
31+----------------------------------------------------------------
32+
33+-- | Error types for bad 'Request'.
34+data InvalidRequest = NotEnoughLines [String]
35+ | BadFirstLine String
36+ | NonHttp
37+ | IncompleteHeaders
38+ | ConnectionClosedByPeer
39+ | OverLargeHeader
40+ | BadProxyHeader String
41+ deriving (Eq, Typeable)
42+
43+instance Show InvalidRequest where
44+ show (NotEnoughLines xs) = "Warp: Incomplete request headers, received: " ++ show xs
45+ show (BadFirstLine s) = "Warp: Invalid first line of request: " ++ show s
46+ show NonHttp = "Warp: Request line specified a non-HTTP request"
47+ show IncompleteHeaders = "Warp: Request headers did not finish transmission"
48+ show ConnectionClosedByPeer = "Warp: Client closed connection prematurely"
49+ show OverLargeHeader = "Warp: Request headers too large, possible memory attack detected. Closing connection."
50+ show (BadProxyHeader s) = "Warp: Invalid PROXY protocol header: " ++ show s
51+
52+instance Exception InvalidRequest
53+
54+----------------------------------------------------------------
55+
56+-- | Exception thrown if something goes wrong while in the midst of
57+-- sending a response, since the status code can't be altered at that
58+-- point.
59+--
60+-- Used to determine whether keeping the HTTP1.1 connection / HTTP2 stream alive is safe
61+-- or irrecoverable.
62+
63+newtype ExceptionInsideResponseBody = ExceptionInsideResponseBody SomeException
64+ deriving (Show, Typeable)
65+
66+instance Exception ExceptionInsideResponseBody
67+
68+----------------------------------------------------------------
69+
70+-- | Data type to abstract file identifiers.
71+-- On Unix, a file descriptor would be specified to make use of
72+-- the file descriptor cache.
73+--
74+-- Since: 3.1.0
75+data FileId = FileId {
76+ fileIdPath :: FilePath
77+ , fileIdFd :: Maybe Fd
78+ }
79+
80+-- | fileid, offset, length, hook action, HTTP headers
81+--
82+-- Since: 3.1.0
83+type SendFile = FileId -> Integer -> Integer -> IO () -> [ByteString] -> IO ()
84+
85+-- | Type for read buffer pool
86+type BufferPool = IORef ByteString
87+
88+-- | Type for buffer
89+type Buffer = Ptr Word8
90+
91+-- | Type for buffer size
92+type BufSize = Int
93+
94+-- | Type for the action to receive input data
95+type Recv = IO ByteString
96+
97+-- | Type for the action to receive input data with a buffer.
98+-- The result boolean indicates whether or not the buffer is fully filled.
99+type RecvBuf = Buffer -> BufSize -> IO Bool
100+
101+-- | Data type to manipulate IO actions for connections.
102+-- This is used to abstract IO actions for plain HTTP and HTTP over TLS.
103+data Connection = Connection {
104+ -- | This is not used at this moment.
105+ connSendMany :: [ByteString] -> IO ()
106+ -- | The sending function.
107+ , connSendAll :: ByteString -> IO ()
108+ -- | The sending function for files in HTTP/1.1.
109+ , connSendFile :: SendFile
110+ -- | The connection closing function. Warp guarantees it will only be
111+ -- called once. Other functions (like 'connRecv') may be called after
112+ -- 'connClose' is called.
113+ , connClose :: IO ()
114+ -- | Free any buffers allocated. Warp guarantees it will only be
115+ -- called once, and no other functions will be called after it.
116+ , connFree :: IO ()
117+ -- | The connection receiving function. This returns "" for EOF.
118+ , connRecv :: Recv
119+ -- | The connection receiving function. This tries to fill the buffer.
120+ -- This returns when the buffer is filled or reaches EOF.
121+ , connRecvBuf :: RecvBuf
122+ -- | The write buffer.
123+ , connWriteBuffer :: Buffer
124+ -- | The size of the write buffer.
125+ , connBufferSize :: BufSize
126+ -- | Is this connection HTTP/2?
127+ , connHTTP2 :: IORef Bool
128+ }
129+
130+getConnHTTP2 :: Connection -> IO Bool
131+getConnHTTP2 conn = readIORef (connHTTP2 conn)
132+
133+setConnHTTP2 :: Connection -> Bool -> IO ()
134+setConnHTTP2 conn b = writeIORef (connHTTP2 conn) b
135+
136+----------------------------------------------------------------
137+
138+data InternalInfo = InternalInfo {
139+ timeoutManager :: T.Manager
140+ , getDate :: IO D.GMTDate
141+ , getFd :: FilePath -> IO (Maybe F.Fd, F.Refresh)
142+ , getFileInfo :: FilePath -> IO I.FileInfo
143+ }
144+
145+----------------------------------------------------------------
146+
147+-- | Type for input streaming.
148+data Source = Source !(IORef ByteString) !(IO ByteString)
149+
150+mkSource :: IO ByteString -> IO Source
151+mkSource func = do
152+ ref <- newIORef S.empty
153+ return $! Source ref func
154+
155+readSource :: Source -> IO ByteString
156+readSource (Source ref func) = do
157+ bs <- readIORef ref
158+ if S.null bs
159+ then func
160+ else do
161+ writeIORef ref S.empty
162+ return bs
163+
164+-- | Read from a Source, ignoring any leftovers.
165+readSource' :: Source -> IO ByteString
166+readSource' (Source _ func) = func
167+
168+leftoverSource :: Source -> ByteString -> IO ()
169+leftoverSource (Source ref _) bs = writeIORef ref bs
170+
171+readLeftoverSource :: Source -> IO ByteString
172+readLeftoverSource (Source ref _) = readIORef ref
173+
174+----------------------------------------------------------------
175+
176+-- | What kind of transport is used for this connection?
177+data Transport = TCP -- ^ Plain channel: TCP
178+ | TLS {
179+ tlsMajorVersion :: Int
180+ , tlsMinorVersion :: Int
181+ , tlsNegotiatedProtocol :: Maybe ByteString -- ^ The result of Application Layer Protocol Negociation in RFC 7301
182+ , tlsChiperID :: Word16
183+ , tlsClientCertificate :: Maybe CertificateChain
184+ } -- ^ Encrypted channel: TLS or SSL
185+
186+isTransportSecure :: Transport -> Bool
187+isTransportSecure TCP = False
188+isTransportSecure _ = True
warp/Network/Wai/Handler/Warp/Windows.hsnew file+27
@@ -0,0 +1,27 @@
1+{-# LANGUAGE CPP #-}
2+module Network.Wai.Handler.Warp.Windows
3+ ( windowsThreadBlockHack
4+ ) where
5+
6+#if WINDOWS
7+import Control.Exception
8+import Control.Concurrent.MVar
9+import Control.Concurrent
10+
11+import Network.Wai.Handler.Warp.Imports
12+
13+-- | Allow main socket listening thread to be interrupted on Windows platform
14+--
15+-- @since 3.2.17
16+windowsThreadBlockHack :: IO a -> IO a
17+windowsThreadBlockHack act = do
18+ var <- newEmptyMVar :: IO (MVar (Either SomeException a))
19+ void . forkIO $ try act >>= putMVar var
20+ res <- takeMVar var
21+ case res of
22+ Left e -> throwIO e
23+ Right r -> return r
24+#else
25+windowsThreadBlockHack :: IO a -> IO a
26+windowsThreadBlockHack = id
27+#endif
warp/Network/Wai/Handler/Warp/WithApplication.hsnew file+104

This diff is too big to show here.

warp/README.mdnew file+3

This diff is too big to show here.

warp/Setup.lhsnew file+7

This diff is too big to show here.

warp/attic/bigtable-single.hsnew file+22

This diff is too big to show here.

warp/attic/bigtable-stream.hsnew file+24

This diff is too big to show here.

warp/attic/file-nolen.hsnew file+6

This diff is too big to show here.

warp/attic/file.hsnew file+6

This diff is too big to show here.

warp/attic/hexnew file+1

This diff is too big to show here.

warp/attic/pong.hsnew file+72

This diff is too big to show here.

warp/attic/pong.txtnew file+1

This diff is too big to show here.

warp/attic/print-post.hsnew file+18

This diff is too big to show here.

warp/attic/readInt.hsnew file+162

This diff is too big to show here.

warp/attic/runtests.hsnew file+43

This diff is too big to show here.

warp/attic/server-no-keepalive.hsnew file+34

This diff is too big to show here.

warp/attic/statuses.hsnew file+18

This diff is too big to show here.

warp/attic/test.txtnew file+1

This diff is too big to show here.

warp/attic/undrained.hsnew file+9

This diff is too big to show here.

warp/bench/Parser.hsnew file+220

This diff is too big to show here.

warp/test/BufferPoolSpec.hsnew file+47

This diff is too big to show here.

warp/test/ConduitSpec.hsnew file+67

This diff is too big to show here.

warp/test/ExceptionSpec.hsnew file+66

This diff is too big to show here.

warp/test/FdCacheSpec.hsnew file+27

This diff is too big to show here.

warp/test/FileSpec.hsnew file+45

This diff is too big to show here.

warp/test/HTTP.hsnew file+41

This diff is too big to show here.

warp/test/ReadIntSpec.hsnew file+26

This diff is too big to show here.

warp/test/RequestSpec.hsnew file+149

This diff is too big to show here.

warp/test/ResponseHeaderSpec.hsnew file+48

This diff is too big to show here.

warp/test/ResponseSpec.hsnew file+107

This diff is too big to show here.

warp/test/RunSpec.hsnew file+463

This diff is too big to show here.

warp/test/SendFileSpec.hsnew file+116

This diff is too big to show here.

warp/test/Spec.hsnew file+1

This diff is too big to show here.

warp/test/WithApplicationSpec.hsnew file+45

This diff is too big to show here.

warp/test/doctests.hsnew file+4

This diff is too big to show here.

warp/test/head-responsenew file+1

This diff is too big to show here.

warp/test/inputFilenew file+100

This diff is too big to show here.

warp/warp.cabalnew file+270

This diff is too big to show here.