on master help sign in
.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+10−2
@@ -1,4 +1,12 @@
1dist/
1dist/
2*.swp
2*.swp
3+*.hi
4+*.o
5+tarballs/
6+/.hsenv
7+/.shelly
3−cabal-dev
8+.cabal-sandbox/
4−.virthualenv
9+cabal.sandbox.config
10+.stack-work/
11+*~
12+stack*.yaml.lock
.gitmodulesdeleted−3
@@ -1,3 +0,0 @@
1−[submodule "scripts"]
2− path = scripts
3− url = git://github.com/yesodweb/scripts.git
.travis.ymldeleted−9
@@ -1,9 +0,0 @@
1−language: haskell
2−
3−install:
4− - cabal unpack wai-logger-0.3.0
5− - cp sources-travis.txt sources.txt
6− - cabal install mega-sdist hspec cabal-meta cabal-src
7− - cabal-meta install --force-reinstalls
8−
9−script: mega-sdist --test
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+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2012-2017 Michael Snoyman, http://www.yesodweb.com/
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
README.md+2
@@ -9,3 +9,5 @@ Code can be written that works with any web framework targeting WAI.
9[Documentation](http://www.yesodweb.com/book/web-application-interface)
9[Documentation](http://www.yesodweb.com/book/web-application-interface)
10
10
11[Haddock Documentation](http://hackage.haskell.org/package/wai)
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+-- @
wai-handler-scgi/LICENSE → auto-update/LICENSErenamed+8−8
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2014 Michael Snoyman
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
@@ -8,13 +8,13 @@ distribute, sublicense, and/or sell copies of the Software, and to
8permit persons to whom the Software is furnished to do so, subject to
8permit persons to whom the Software is furnished to do so, subject to
9the following conditions:
9the following conditions:
10
10
11−The above copyright notice and this permission notice shall be
11+The above copyright notice and this permission notice shall be included
12−included in all copies or substantial portions of the Software.
12+in all copies or substantial portions of the Software.
13
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16−MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17−NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
17+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18−LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
18+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19−OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
19+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20−WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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
wai-test/test/Spec.hs → auto-update/test/Spec.hsrenamed

The content is the same.

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/Network/Mime.hs+10−2
@@ -49,9 +49,9 @@ mimeByExt mm def =
49defaultMimeLookup :: FileName -> MimeType
49defaultMimeLookup :: FileName -> MimeType
50defaultMimeLookup = mimeByExt defaultMimeMap defaultMimeType
50defaultMimeLookup = mimeByExt defaultMimeMap defaultMimeType
51
51
52−-- | Get a list of all of the file name extensions from a piece.
52+-- | Get a list of all of the file name extensions.
53--
53--
54−-- > pieceExtensions "foo.tar.gz" == ["tar.gz", "gz"]
54+-- > fileNameExtensions "foo.tar.gz" == ["tar.gz", "gz"]
55fileNameExtensions :: FileName -> [Extension]
55fileNameExtensions :: FileName -> [Extension]
56fileNameExtensions =
56fileNameExtensions =
57 go . T.toLower . dropToExt
57 go . T.toLower . dropToExt
@@ -468,6 +468,11 @@ defaultMimeMap = Map.fromAscList [
468 , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
468 , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
469 , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
469 , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
470 , ("les", "application/vnd.hhe.lesson-player")
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+
471 , ("lha", "application/x-lzh-compressed")
476 , ("lha", "application/x-lzh-compressed")
472 , ("link66", "application/vnd.route66.link66+xml")
477 , ("link66", "application/vnd.route66.link66+xml")
473 , ("list", "text/plain")
478 , ("list", "text/plain")
@@ -526,6 +531,7 @@ defaultMimeMap = Map.fromAscList [
526 , ("mime", "message/rfc822")
531 , ("mime", "message/rfc822")
527 , ("mj2", "video/mj2")
532 , ("mj2", "video/mj2")
528 , ("mjp2", "video/mj2")
533 , ("mjp2", "video/mj2")
534+ , ("mjs", "application/javascript")
529 , ("mk3d", "video/x-matroska")
535 , ("mk3d", "video/x-matroska")
530 , ("mka", "audio/x-matroska")
536 , ("mka", "audio/x-matroska")
531 , ("mks", "video/x-matroska")
537 , ("mks", "video/x-matroska")
@@ -974,6 +980,7 @@ defaultMimeMap = Map.fromAscList [
974 , ("w3d", "application/x-director")
980 , ("w3d", "application/x-director")
975 , ("wad", "application/x-doom")
981 , ("wad", "application/x-doom")
976 , ("war", "application/java-archive")
982 , ("war", "application/java-archive")
983+ , ("wasm", "application/wasm")
977 , ("wav", "audio/x-wav")
984 , ("wav", "audio/x-wav")
978 , ("wax", "audio/x-ms-wax")
985 , ("wax", "audio/x-ms-wax")
979 , ("wbmp", "image/vnd.wap.wbmp")
986 , ("wbmp", "image/vnd.wap.wbmp")
@@ -1000,6 +1007,7 @@ defaultMimeMap = Map.fromAscList [
1000 , ("wmx", "video/x-ms-wmx")
1007 , ("wmx", "video/x-ms-wmx")
1001 , ("wmz", "application/x-msmetafile")
1008 , ("wmz", "application/x-msmetafile")
1002 , ("woff", "application/font-woff")
1009 , ("woff", "application/font-woff")
1010+ , ("woff2", "application/font-woff2")
1003 , ("wpd", "application/vnd.wordperfect")
1011 , ("wpd", "application/vnd.wordperfect")
1004 , ("wpl", "application/vnd.ms-wpl")
1012 , ("wpl", "application/vnd.ms-wpl")
1005 , ("wps", "application/vnd.ms-works")
1013 , ("wps", "application/vnd.ms-works")
mime-types/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## mime-types
2+
3+Basic mime-type handling types and functions
mime-types/mime-types.cabal+3−2
@@ -1,7 +1,7 @@
1name: mime-types
1name: mime-types
2−version: 0.1.0.3
2+version: 0.1.0.9
3synopsis: Basic mime-type handling types and functions
3synopsis: Basic mime-type handling types and functions
4−description: Basic mime-type handling types and functions
4+description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
5homepage: https://github.com/yesodweb/wai
5homepage: https://github.com/yesodweb/wai
6license: MIT
6license: MIT
7license-file: LICENSE
7license-file: LICENSE
@@ -10,6 +10,7 @@ maintainer: michael@snoyman.com
10category: Web
10category: Web
11build-type: Simple
11build-type: Simple
12cabal-version: >=1.8
12cabal-version: >=1.8
13+extra-source-files: README.md ChangeLog.md
13
14
14library
15library
15 exposed-modules: Network.Mime
16 exposed-modules: Network.Mime
package-list.shdeleted−16
@@ -1,16 +0,0 @@
1−#!/bin/bash
2−
3−pkgs=( ./wai
4− ./wai-test
5− ./wai-extra
6− ./warp
7− ./warp-tls
8− ./wai-app-static
9− ./wai-handler-fastcgi
10− ./wai-handler-launch
11− ./wai-handler-scgi
12− ./wai-frontend-monadcgi
13− ./warp-static
14− ./wai-websockets
15− ./wai-eventsource
16− )
scriptsdeleted−1

Submodule changed.

sources-travis.txtdeleted−14
@@ -1,14 +0,0 @@
1−./wai
2−./wai-test
3−./wai-extra
4−./warp
5−./warp-tls
6−./wai-app-static
7−./wai-handler-launch
8−./wai-handler-scgi
9−./wai-frontend-monadcgi
10−./warp-static
11−./wai-websockets
12−./wai-eventsource
13−./mime-types
14−./wai-logger-0.3.0
sources.txtdeleted−14
@@ -1,14 +0,0 @@
1−./wai
2−./wai-test
3−./wai-extra
4−./warp
5−./warp-tls
6−./wai-app-static
7−./wai-handler-fastcgi
8−./wai-handler-launch
9−./wai-handler-scgi
10−./wai-frontend-monadcgi
11−./warp-static
12−./wai-websockets
13−./wai-eventsource
14−./mime-types
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
wai-eventsource/LICENSE → time-manager/LICENSErenamed

The content is the same.

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/.ghci+1−1
@@ -1 +1 @@
1−:set -itest
1+:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h -XCPP
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/Network/Wai/Application/Static.hs+104−59
@@ -2,6 +2,7 @@
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3{-# LANGUAGE TemplateHaskell, CPP #-}
3{-# LANGUAGE TemplateHaskell, CPP #-}
4{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
5+{-# LANGUAGE PatternGuards #-}
5-- | Static file serving for WAI.
6-- | Static file serving for WAI.
6module Network.Wai.Application.Static
7module Network.Wai.Application.Static
7 ( -- * WAI application
8 ( -- * WAI application
@@ -20,6 +21,8 @@ module Network.Wai.Application.Static
20 , ssIndices
21 , ssIndices
21 , ssMaxAge
22 , ssMaxAge
22 , ssRedirectToIndex
23 , ssRedirectToIndex
24+ , ssAddTrailingSlash
25+ , ss404Handler
23 ) where
26 ) where
24
27
25import Prelude hiding (FilePath)
28import Prelude hiding (FilePath)
@@ -31,16 +34,15 @@ import qualified Data.ByteString.Lazy as L
31import Data.ByteString.Lazy.Char8 ()
34import Data.ByteString.Lazy.Char8 ()
32import Control.Monad.IO.Class (liftIO)
35import Control.Monad.IO.Class (liftIO)
33
36
34−import Blaze.ByteString.Builder (toByteString)
37+import Data.ByteString.Builder (toLazyByteString)
35
38
36import Data.FileEmbed (embedFile)
39import Data.FileEmbed (embedFile)
37
40
38import Data.Text (Text)
41import Data.Text (Text)
39import qualified Data.Text as T
42import qualified Data.Text as T
43+import qualified Data.Text.Encoding as TE
40
44
41−import Data.Either (rights)
42import Network.HTTP.Date (parseHTTPDate, epochTimeToHTTPDate, formatHTTPDate)
45import Network.HTTP.Date (parseHTTPDate, epochTimeToHTTPDate, formatHTTPDate)
43−import Data.Monoid (First (First, getFirst), mconcat)
44
46
45import WaiAppStatic.Types
47import WaiAppStatic.Types
46import Util
48import Util
@@ -51,6 +53,7 @@ import Network.Mime (MimeType)
51data StaticResponse =
53data StaticResponse =
52 -- | Just the etag hash or Nothing for no etag hash
54 -- | Just the etag hash or Nothing for no etag hash
53 Redirect Pieces (Maybe ByteString)
55 Redirect Pieces (Maybe ByteString)
56+ | RawRedirect ByteString
54 | NotFound
57 | NotFound
55 | FileResponse File H.ResponseHeaders
58 | FileResponse File H.ResponseHeaders
56 | NotModified
59 | NotModified
@@ -71,37 +74,27 @@ filterButLast f (x:xs)
71
74
72-- | Serve an appropriate response for a folder request.
75-- | Serve an appropriate response for a folder request.
73serveFolder :: StaticSettings -> Pieces -> W.Request -> Folder -> IO StaticResponse
76serveFolder :: StaticSettings -> Pieces -> W.Request -> Folder -> IO StaticResponse
74−serveFolder ss@StaticSettings {..} pieces req folder@Folder {..} =
77+serveFolder StaticSettings {..} pieces req folder@Folder {..} =
75− -- first check if there is an index file in this folder
76− case getFirst $ mconcat $ map (findIndex $ rights folderContents) ssIndices of
77− Just index -> do
78− let pieces' = setLast pieces index
79− in if ssRedirectToIndex
80− then return $ Redirect pieces' Nothing
81− -- start the checking process over, with a new set
82− else checkPieces ss pieces' req
83− Nothing ->
84− case ssListing of
78+ case ssListing of
79+ Just _ | Just path <- addTrailingSlash req, ssAddTrailingSlash ->
80+ return $ RawRedirect path
85− Just listing -> do
81+ Just listing -> do
86− -- directory listings turned on, display it
82+ -- directory listings turned on, display it
87− builder <- listing pieces folder
83+ builder <- listing pieces folder
88− return $ WaiResponse $ W.ResponseBuilder H.status200
84+ return $ WaiResponse $ W.responseBuilder H.status200
89− [ ("Content-Type", "text/html; charset=utf-8")
85+ [ ("Content-Type", "text/html; charset=utf-8")
90− ] builder
86+ ] builder
91− Nothing -> return $ WaiResponse $ W.responseLBS H.status403
87+ Nothing -> return $ WaiResponse $ W.responseLBS H.status403
92− [ ("Content-Type", "text/plain")
88+ [ ("Content-Type", "text/plain")
93− ] "Directory listings disabled"
89+ ] "Directory listings disabled"
94− where
95− setLast :: Pieces -> Piece -> Pieces
96− setLast [] x = [x]
97− setLast [t] x
98− | fromPiece t == "" = [x]
99− setLast (a:b) x = a : setLast b x
100
90
101− findIndex :: [File] -> Piece -> First Piece
91+addTrailingSlash :: W.Request -> Maybe ByteString
102− findIndex files index
92+addTrailingSlash req
103− | index `elem` map fileName files = First $ Just index
93+ | S8.null rp = Just "/"
104− | otherwise = First Nothing
94+ | S8.last rp == '/' = Nothing
95+ | otherwise = Just $ S8.snoc rp '/'
96+ where
97+ rp = W.rawPathInfo req
105
98
106checkPieces :: StaticSettings
99checkPieces :: StaticSettings
107 -> Pieces -- ^ parsed request
100 -> Pieces -- ^ parsed request
@@ -113,11 +106,51 @@ checkPieces _ pieces _ | any (T.null . fromPiece) $ safeInit pieces =
113 return $ Redirect (filterButLast (not . T.null . fromPiece) pieces) Nothing
106 return $ Redirect (filterButLast (not . T.null . fromPiece) pieces) Nothing
114
107
115checkPieces ss@StaticSettings {..} pieces req = do
108checkPieces ss@StaticSettings {..} pieces req = do
116− res <- ssLookupFile pieces
109+ res <- lookupResult
117 case res of
110 case res of
111+ Left location -> return $ RawRedirect location
118− LRNotFound -> return NotFound
112+ Right LRNotFound -> return NotFound
119− LRFile file -> serveFile ss req file
113+ Right (LRFile file) -> serveFile ss req file
120− LRFolder folder -> serveFolder ss pieces req folder
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
121
154
122serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
155serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
123serveFile StaticSettings {..} req file
156serveFile StaticSettings {..} req file
@@ -131,11 +164,13 @@ serveFile StaticSettings {..} req file
131 -- Didn't match, but we have a hash value. Send the file contents
164 -- Didn't match, but we have a hash value. Send the file contents
132 -- with an ETag header.
165 -- with an ETag header.
133 --
166 --
134− -- Note: It would be arguably better to next check
167+ -- RFC7232 (HTTP 1.1):
135− -- if-modified-since and return a 304 if that indicates a match as
168+ -- > A recipient MUST ignore If-Modified-Since if the request contains an
136− -- well. However, the circumstances under which such a situation
169+ -- > If-None-Match header field; the condition in If-None-Match is
137− -- could arise would be very anomolous, and should likely warrant a
170+ -- > considered to be a more accurate replacement for the condition in
138− -- new file being sent anyway.
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.
139 (Just hash, _) -> respond [("ETag", hash)]
174 (Just hash, _) -> respond [("ETag", hash)]
140
175
141 -- No hash value available, fall back to last modified support.
176 -- No hash value available, fall back to last modified support.
@@ -193,52 +228,62 @@ staticApp :: StaticSettings -> W.Application
193staticApp set req = staticAppPieces set (W.pathInfo req) req
228staticApp set req = staticAppPieces set (W.pathInfo req) req
194
229
195staticAppPieces :: StaticSettings -> [Text] -> W.Application
230staticAppPieces :: StaticSettings -> [Text] -> W.Application
196−staticAppPieces _ _ req
231+staticAppPieces _ _ req sendResponse
197− | W.requestMethod req /= "GET" = return $ W.responseLBS
232+ | notElem (W.requestMethod req) ["GET", "HEAD"] = sendResponse $ W.responseLBS
198 H.status405
233 H.status405
199 [("Content-Type", "text/plain")]
234 [("Content-Type", "text/plain")]
200− "Only GET is supported"
235+ "Only GET or HEAD is supported"
201−staticAppPieces _ [".hidden", "folder.png"] _ = return $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/folder.png")]
236+staticAppPieces _ [".hidden", "folder.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/folder.png")]
202−staticAppPieces _ [".hidden", "haskell.png"] _ = return $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/haskell.png")]
237+staticAppPieces _ [".hidden", "haskell.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/haskell.png")]
203−staticAppPieces ss rawPieces req = liftIO $ do
238+staticAppPieces ss rawPieces req sendResponse = liftIO $ do
204 case toPieces rawPieces of
239 case toPieces rawPieces of
205 Just pieces -> checkPieces ss pieces req >>= response
240 Just pieces -> checkPieces ss pieces req >>= response
206− Nothing -> return $ W.responseLBS H.status403
241+ Nothing -> sendResponse $ W.responseLBS H.status403
207 [ ("Content-Type", "text/plain")
242 [ ("Content-Type", "text/plain")
208 ] "Forbidden"
243 ] "Forbidden"
209 where
244 where
210− response :: StaticResponse -> IO W.Response
245+ response :: StaticResponse -> IO W.ResponseReceived
211 response (FileResponse file ch) = do
246 response (FileResponse file ch) = do
212 mimetype <- ssGetMimeType ss file
247 mimetype <- ssGetMimeType ss file
213− let filesize = fileGetSize file
248+ -- let filesize = fileGetSize file
214 let headers = ("Content-Type", mimetype)
249 let headers = ("Content-Type", mimetype)
250+ -- Let Warp provide the content-length, since it takes
251+ -- range requests into account
215− : ("Content-Length", S8.pack $ show filesize)
252+ -- : ("Content-Length", S8.pack $ show filesize)
216 : ch
253 : ch
217− return $ fileToResponse file H.status200 headers
254+ sendResponse $ fileToResponse file H.status200 headers
218
255
219 response NotModified =
256 response NotModified =
220− return $ W.responseLBS H.status304 [] ""
257+ sendResponse $ W.responseLBS H.status304 [] ""
221
258
222 response (SendContent mt lbs) = do
259 response (SendContent mt lbs) = do
223 -- TODO: set caching headers
260 -- TODO: set caching headers
224− return $ W.responseLBS H.status200
261+ sendResponse $ W.responseLBS H.status200
225 [ ("Content-Type", mt)
262 [ ("Content-Type", mt)
226 -- TODO: set Content-Length
263 -- TODO: set Content-Length
227 ] lbs
264 ] lbs
228
265
229 response (Redirect pieces' mHash) = do
266 response (Redirect pieces' mHash) = do
230− let loc = (ssMkRedirect ss) pieces' $ toByteString (H.encodePathSegments $ map fromPiece pieces')
267+ let loc = ssMkRedirect ss pieces' $ L.toStrict $ toLazyByteString (H.encodePathSegments $ map fromPiece pieces')
231 let qString = case mHash of
268 let qString = case mHash of
232 Just hash -> replace "etag" (Just hash) (W.queryString req)
269 Just hash -> replace "etag" (Just hash) (W.queryString req)
233 Nothing -> remove "etag" (W.queryString req)
270 Nothing -> remove "etag" (W.queryString req)
234
271
235− return $ W.responseLBS H.status301
272+ sendResponse $ W.responseLBS H.status302
236 [ ("Content-Type", "text/plain")
273 [ ("Content-Type", "text/plain")
237 , ("Location", S8.append loc $ H.renderQuery True qString)
274 , ("Location", S8.append loc $ H.renderQuery True qString)
238 ] "Redirect"
275 ] "Redirect"
239
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
240− response NotFound = return $ W.responseLBS H.status404
285+ Nothing -> sendResponse $ W.responseLBS H.status404
241 [ ("Content-Type", "text/plain")
286 [ ("Content-Type", "text/plain")
242 ] "File not found"
287 ] "File not found"
243
288
244− response (WaiResponse r) = return r
289+ response (WaiResponse r) = sendResponse r
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/Util.hs+8−1
@@ -1,9 +1,10 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE OverloadedStrings, ViewPatterns #-}
2module Util
2module Util
3 ( relativeDirFromPieces
3 ( relativeDirFromPieces
4 , defaultMkRedirect
4 , defaultMkRedirect
5 , replace
5 , replace
6 , remove
6 , remove
7+ , dropLastIfNull
7 ) where
8 ) where
8
9
9import WaiAppStatic.Types
10import WaiAppStatic.Types
@@ -36,3 +37,9 @@ defaultMkRedirect pieces newPath
36 | otherwise = relDir `S8.append` S8.tail newPath
37 | otherwise = relDir `S8.append` S8.tail newPath
37 where
38 where
38 relDir = TE.encodeUtf8 (relativeDirFromPieces pieces)
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.hs+37−13
@@ -1,5 +1,6 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ViewPatterns #-}
3module WaiAppStatic.Listing
4module WaiAppStatic.Listing
4 ( defaultListing
5 ( defaultListing
5 ) where
6 ) where
@@ -11,7 +12,9 @@ import qualified Data.Text as T
11import Data.Time
12import Data.Time
12import Data.Time.Clock.POSIX
13import Data.Time.Clock.POSIX
13import WaiAppStatic.Types
14import WaiAppStatic.Types
15+#if !MIN_VERSION_time(1,5,0)
14import System.Locale (defaultTimeLocale)
16import System.Locale (defaultTimeLocale)
17+#endif
15import Data.List (sortBy)
18import Data.List (sortBy)
16import Util
19import Util
17
20
@@ -19,7 +22,7 @@ import qualified Text.Blaze.Html.Renderer.Utf8 as HU
19
22
20-- | Provides a default directory listing, suitable for most apps.
23-- | Provides a default directory listing, suitable for most apps.
21--
24--
22−-- Code below taken from Happstack: <http://patch-tag.com/r/mae/happstack/snapshot/current/content/pretty/happstack-server/src/Happstack/Server/FileServe/BuildingBlocks.hs>
25+-- Code below taken from Happstack: <https://github.com/Happstack/happstack-server/blob/87e6c01a65c687d06c61345430a112fc9a444a95/src/Happstack/Server/FileServe/BuildingBlocks.hs>
23defaultListing :: Listing
26defaultListing :: Listing
24defaultListing pieces (Folder contents) = do
27defaultListing pieces (Folder contents) = do
25 let isTop = null pieces || map Just pieces == [toPiece ""]
28 let isTop = null pieces || map Just pieces == [toPiece ""]
@@ -46,8 +49,12 @@ defaultListing pieces (Folder contents) = do
46 , "a { text-decoration: none }"
49 , "a { text-decoration: none }"
47 ]
50 ]
48 H.body $ do
51 H.body $ do
52+ let hasTrailingSlash =
53+ case map fromPiece $ reverse $ pieces of
54+ "":_ -> True
55+ _ -> False
49− H.h1 $ showFolder $ filter (not . T.null . fromPiece) pieces
56+ H.h1 $ showFolder' hasTrailingSlash $ filter (not . T.null . fromPiece) pieces
50− renderDirectoryContentsTable haskellSrc folderSrc fps''
57+ renderDirectoryContentsTable (map fromPiece pieces) haskellSrc folderSrc fps''
51 where
58 where
52 image x = T.unpack $ T.concat [(relativeDirFromPieces pieces), ".hidden/", x, ".png"]
59 image x = T.unpack $ T.concat [(relativeDirFromPieces pieces), ".hidden/", x, ".png"]
53 folderSrc = image "folder"
60 folderSrc = image "folder"
@@ -55,14 +62,21 @@ defaultListing pieces (Folder contents) = do
55 showName "" = "root"
62 showName "" = "root"
56 showName x = x
63 showName x = x
57
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+
58− showFolder :: Pieces -> H.Html
69+ showFolder :: Bool -> Pieces -> H.Html
59− showFolder [] = "/"
70+ showFolder _ [] = "/" -- won't happen
60− showFolder [x] = H.toHtml $ showName $ fromPiece x
71+ showFolder _ [x] = H.toHtml $ showName $ fromPiece x
61− showFolder (x:xs) = do
72+ showFolder hasTrailingSlash (x:xs) = do
73+ let len = length xs - (if hasTrailingSlash then 0 else 1)
74+ href
75+ | len == 0 = "."
62− let href = concat $ replicate (length xs) "../" :: String
76+ | otherwise = concat $ replicate len "../" :: String
63 H.a ! A.href (H.toValue href) $ H.toHtml $ showName $ fromPiece x
77 H.a ! A.href (H.toValue href) $ H.toHtml $ showName $ fromPiece x
64 " / " :: H.Html
78 " / " :: H.Html
65− showFolder xs
79+ showFolder hasTrailingSlash xs
66
80
67-- | a function to generate an HTML table showing the contents of a directory on the disk
81-- | a function to generate an HTML table showing the contents of a directory on the disk
68--
82--
@@ -72,11 +86,12 @@ defaultListing pieces (Folder contents) = do
72-- a new page template to wrap around this HTML.
86-- a new page template to wrap around this HTML.
73--
87--
74-- see also: 'getMetaData', 'renderDirectoryContents'
88-- see also: 'getMetaData', 'renderDirectoryContents'
75−renderDirectoryContentsTable :: String
89+renderDirectoryContentsTable :: [T.Text] -- ^ requested path info
90+ -> String
76 -> String
91 -> String
77 -> [Either FolderName File]
92 -> [Either FolderName File]
78 -> H.Html
93 -> H.Html
79−renderDirectoryContentsTable haskellSrc folderSrc fps =
94+renderDirectoryContentsTable pathInfo' haskellSrc folderSrc fps =
80 H.table $ do H.thead $ do H.th ! (A.class_ "first") $ H.img ! (A.src $ H.toValue haskellSrc)
95 H.table $ do H.thead $ do H.th ! (A.class_ "first") $ H.img ! (A.src $ H.toValue haskellSrc)
81 H.th "Name"
96 H.th "Name"
82 H.th "Modified"
97 H.th "Modified"
@@ -98,9 +113,18 @@ renderDirectoryContentsTable haskellSrc folderSrc fps =
98 Left{} -> H.img ! A.src (H.toValue folderSrc)
113 Left{} -> H.img ! A.src (H.toValue folderSrc)
99 ! A.alt "Folder"
114 ! A.alt "Folder"
100 Right{} -> return ()
115 Right{} -> return ()
116+ let name =
101− let name = either id fileName md
117+ case either id fileName md of
118+ (fromPiece -> "") -> unsafeToPiece ".."
119+ x -> x
102 let isFile = either (const False) (const True) md
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]
103− H.td (H.a ! A.href (H.toValue $ fromPiece name `T.append` if isFile then "" else "/") $ H.toHtml $ fromPiece name)
127+ H.td (H.a ! A.href (H.toValue href) $ H.toHtml $ fromPiece name)
104 H.td ! A.class_ "date" $ H.toHtml $
128 H.td ! A.class_ "date" $ H.toHtml $
105 case md of
129 case md of
106 Right File { fileGetModified = Just t } ->
130 Right File { fileGetModified = Just t } ->
wai-app-static/WaiAppStatic/Storage/Embedded.hs+9−89
@@ -1,92 +1,12 @@
1−-- | Lookup files stored in memory instead of from the filesystem.
2−module WaiAppStatic.Storage.Embedded
1+module WaiAppStatic.Storage.Embedded(
3− ( -- * Settings
2+ -- * Basic
4 embeddedSettings
3 embeddedSettings
5− ) where
6−
7−import WaiAppStatic.Types
8−import Data.ByteString (ByteString)
9−import Control.Arrow ((&&&), second)
10−import Data.List
11−import Blaze.ByteString.Builder (fromByteString)
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 qualified Crypto.Hash.MD5 as MD5
19−import qualified Data.ByteString.Base64 as B64
20−import WaiAppStatic.Storage.Filesystem (defaultFileServerSettings)
21−
22−-- | Serve the list of path/content pairs directly from memory.
23−embeddedSettings :: [(Prelude.FilePath, ByteString)] -> StaticSettings
24−embeddedSettings files = (defaultFileServerSettings $ error "unused")
25− { ssLookupFile = embeddedLookup $ toEmbedded files
26− }
27−
28−type Embedded = Map.Map Piece EmbeddedEntry
29−
30−data EmbeddedEntry = EEFile ByteString | EEFolder Embedded
31−
32−embeddedLookup :: Embedded -> Pieces -> IO LookupResult
33−embeddedLookup root pieces =
34− return $ elookup pieces root
35− where
36− elookup :: Pieces -> Embedded -> LookupResult
37− elookup [] x = LRFolder $ Folder $ map toEntry $ Map.toList x
38− elookup [p] x | T.null (fromPiece p) = elookup [] x
39− elookup (p:ps) x =
40− case Map.lookup p x of
41− Nothing -> LRNotFound
42− Just (EEFile f) ->
43− case ps of
44− [] -> LRFile $ bsToFile p f
45− _ -> LRNotFound
46− Just (EEFolder y) -> elookup ps y
47
4
48−toEntry :: (Piece, EmbeddedEntry) -> Either FolderName File
5+ -- * Template Haskell
49−toEntry (name, EEFolder{}) = Left name
6+ , Etag
50−toEntry (name, EEFile bs) = Right File
7+ , EmbeddableEntry(..)
51− { fileGetSize = S.length bs
8+ , mkSettings
52− , fileToResponse = \s h -> W.ResponseBuilder s h $ fromByteString bs
53− , fileName = name
54− , fileGetHash = return $ Just $ runHash bs
55− , fileGetModified = Nothing
56− }
57−
58−toEmbedded :: [(Prelude.FilePath, ByteString)] -> Embedded
59−toEmbedded fps =
60− go texts
61− where
62− texts = map (\(x, y) -> (filter (not . T.null . fromPiece) $ toPieces' x, y)) fps
63− toPieces' "" = []
64− toPieces' x =
65− let (y, z) = break (== '/') x
66− in unsafeToPiece (T.pack y) : toPieces' (drop 1 z)
67−
68− go :: [(Pieces, ByteString)] -> Embedded
69− go orig =
70− Map.fromList $ map (second go') hoisted
71− where
9+ ) where
72− next = map (\(x, y) -> (head x, (tail x, y))) orig
73− grouped :: [[(Piece, ([Piece], ByteString))]]
74− grouped = groupBy ((==) `on` fst) $ sortBy (comparing fst) next
75− hoisted :: [(Piece, [([Piece], ByteString)])]
76− hoisted = map (fst . head &&& map snd) grouped
77−
78− go' :: [(Pieces, ByteString)] -> EmbeddedEntry
79− go' [([], content)] = EEFile content
80− go' x = EEFolder $ go $ filter (\y -> not $ null $ fst y) x
81−
82−bsToFile :: Piece -> ByteString -> File
83−bsToFile name bs = File
84− { fileGetSize = S.length bs
85− , fileToResponse = \s h -> W.ResponseBuilder s h $ fromByteString bs
86− , fileName = name
87− , fileGetHash = return $ Just $ runHash bs
88− , fileGetModified = Nothing
89− }
90
10
91−runHash :: ByteString -> ByteString
11+import WaiAppStatic.Storage.Embedded.Runtime
92−runHash = B64.encode . MD5.hash
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.hs+29−26
@@ -1,5 +1,6 @@
1{-# LANGUAGE ScopedTypeVariables #-}
1{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
3-- | Access files on the filesystem.
4-- | Access files on the filesystem.
4module WaiAppStatic.Storage.Filesystem
5module WaiAppStatic.Storage.Filesystem
5 ( -- * Types
6 ( -- * Types
@@ -11,10 +12,9 @@ module WaiAppStatic.Storage.Filesystem
11 ) where
12 ) where
12
13
13import WaiAppStatic.Types
14import WaiAppStatic.Types
14−import Prelude hiding (FilePath)
15+import System.FilePath ((</>))
15−import Filesystem.Path.CurrentOS (FilePath, (</>))
16+import System.IO (withBinaryFile, IOMode(..))
16−import qualified Filesystem.Path.CurrentOS as F
17+import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
17−import qualified Filesystem as F
18import Data.List (foldl')
18import Data.List (foldl')
19import Control.Monad (forM)
19import Control.Monad (forM)
20import Util
20import Util
@@ -25,14 +25,14 @@ import WaiAppStatic.Listing
25import Network.Mime
25import Network.Mime
26import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
26import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
27import Data.Maybe (catMaybes)
27import Data.Maybe (catMaybes)
28−import qualified Crypto.Conduit
28+import Data.ByteArray.Encoding
29−import Data.Serialize (encode)
30−import Crypto.Hash.MD5 (MD5)
29+import Crypto.Hash (hashlazy, MD5, Digest)
31−import qualified Data.ByteString.Base64 as B64
30+import qualified Data.ByteString.Lazy as BL (hGetContents)
31+import qualified Data.Text as T
32
32
33-- | Construct a new path from a root and some @Pieces@.
33-- | Construct a new path from a root and some @Pieces@.
34pathFromPieces :: FilePath -> Pieces -> FilePath
34pathFromPieces :: FilePath -> Pieces -> FilePath
35−pathFromPieces = foldl' (\fp p -> fp </> F.fromText (fromPiece p))
35+pathFromPieces = foldl' (\fp p -> fp </> T.unpack (fromPiece p))
36
36
37-- | Settings optimized for a web application. Files will have aggressive
37-- | Settings optimized for a web application. Files will have aggressive
38-- caching applied and hashes calculated, and indices and listings are disabled.
38-- caching applied and hashes calculated, and indices and listings are disabled.
@@ -47,6 +47,8 @@ defaultWebAppSettings root = StaticSettings
47 , ssIndices = []
47 , ssIndices = []
48 , ssRedirectToIndex = False
48 , ssRedirectToIndex = False
49 , ssUseHash = True
49 , ssUseHash = True
50+ , ssAddTrailingSlash = False
51+ , ss404Handler = Nothing
50 }
52 }
51
53
52-- | Settings optimized for a file server. More conservative caching will be
54-- | Settings optimized for a file server. More conservative caching will be
@@ -62,6 +64,8 @@ defaultFileServerSettings root = StaticSettings
62 , ssIndices = map unsafeToPiece ["index.html", "index.htm"]
64 , ssIndices = map unsafeToPiece ["index.html", "index.htm"]
63 , ssRedirectToIndex = False
65 , ssRedirectToIndex = False
64 , ssUseHash = False
66 , ssUseHash = False
67+ , ssAddTrailingSlash = False
68+ , ss404Handler = Nothing
65 }
69 }
66
70
67-- | Same as @defaultWebAppSettings@, but additionally uses a specialized
71-- | Same as @defaultWebAppSettings@, but additionally uses a specialized
@@ -86,12 +90,12 @@ fileHelper :: ETagLookup
86 -> Piece -- ^ file name
90 -> Piece -- ^ file name
87 -> IO (Maybe File)
91 -> IO (Maybe File)
88fileHelper hashFunc fp name = do
92fileHelper hashFunc fp name = do
89− efs <- try $ getFileStatus $ F.encodeString fp
93+ efs <- try $ getFileStatus fp
90 case efs of
94 case efs of
91 Left (_ :: SomeException) -> return Nothing
95 Left (_ :: SomeException) -> return Nothing
92 Right fs | isRegularFile fs -> return $ Just File
96 Right fs | isRegularFile fs -> return $ Just File
93 { fileGetSize = fromIntegral $ fileSize fs
97 { fileGetSize = fromIntegral $ fileSize fs
94− , fileToResponse = \s h -> W.ResponseFile s h (F.encodeString fp) Nothing
98+ , fileToResponse = \s h -> W.responseFile s h fp Nothing
95 , fileName = name
99 , fileName = name
96 , fileGetHash = hashFunc fp
100 , fileGetHash = hashFunc fp
97 , fileGetModified = Just $ modificationTime fs
101 , fileGetModified = Just $ modificationTime fs
@@ -116,9 +120,10 @@ webAppLookup hashFunc prefix pieces =
116-- | MD5 hash and base64-encode the file contents. Does not check if the file
120-- | MD5 hash and base64-encode the file contents. Does not check if the file
117-- exists.
121-- exists.
118hashFile :: FilePath -> IO ByteString
122hashFile :: FilePath -> IO ByteString
119−hashFile fp = do
123+hashFile fp = withBinaryFile fp ReadMode $ \h -> do
120− h <- Crypto.Conduit.hashFile (F.encodeString fp)
124+ f <- BL.hGetContents h
121− return $ B64.encode $ encode (h :: MD5)
125+ let !hash = hashlazy f :: Digest MD5
126+ return $ convertToBase Base64 hash
122
127
123hashFileIfExists :: ETagLookup
128hashFileIfExists :: ETagLookup
124hashFileIfExists fp = do
129hashFileIfExists fp = do
@@ -128,12 +133,9 @@ hashFileIfExists fp = do
128 Right x -> Just x
133 Right x -> Just x
129
134
130isVisible :: FilePath -> Bool
135isVisible :: FilePath -> Bool
131−isVisible =
136+isVisible ('.':_) = False
132− go . F.encodeString . F.filename
133− where
134− go ('.':_) = False
135− go "" = False
137+isVisible "" = False
136− go _ = True
138+isVisible _ = True
137
139
138-- | Get a proper @LookupResult@, checking if the path is a file or folder.
140-- | Get a proper @LookupResult@, checking if the path is a file or folder.
139-- Compare with @webAppLookup@, which only deals with files.
141-- Compare with @webAppLookup@, which only deals with files.
@@ -141,17 +143,18 @@ fileSystemLookup :: ETagLookup
141 -> FilePath -> Pieces -> IO LookupResult
143 -> FilePath -> Pieces -> IO LookupResult
142fileSystemLookup hashFunc prefix pieces = do
144fileSystemLookup hashFunc prefix pieces = do
143 let fp = pathFromPieces prefix pieces
145 let fp = pathFromPieces prefix pieces
144− fe <- F.isFile fp
146+ fe <- doesFileExist fp
145 if fe
147 if fe
146 then fileHelperLR hashFunc fp lastPiece
148 then fileHelperLR hashFunc fp lastPiece
147 else do
149 else do
148− de <- F.isDirectory fp
150+ de <- doesDirectoryExist fp
149 if de
151 if de
150 then do
152 then do
151− entries' <- fmap (filter isVisible) $ F.listDirectory fp
153+ entries' <- fmap (filter isVisible) $ getDirectoryContents fp
152− entries <- forM entries' $ \fp' -> do
154+ entries <- forM entries' $ \fpRel' -> do
153− let name = unsafeToPiece $ either id id $ F.toText $ F.filename fp'
155+ let name = unsafeToPiece $ T.pack fpRel'
154− de' <- F.isDirectory fp'
156+ fp' = fp </> fpRel'
157+ de' <- doesDirectoryExist fp'
155 if de'
158 if de'
156 then return $ Just $ Left name
159 then return $ Just $ Left name
157 else do
160 else do
wai-app-static/WaiAppStatic/Types.hs+12−3
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2module WaiAppStatic.Types
1module WaiAppStatic.Types
3 ( -- * Pieces
2 ( -- * Pieces
4 Piece
3 Piece
@@ -25,7 +24,7 @@ import qualified Network.Wai as W
25import Data.ByteString (ByteString)
24import Data.ByteString (ByteString)
26import System.Posix.Types (EpochTime)
25import System.Posix.Types (EpochTime)
27import qualified Data.Text as T
26import qualified Data.Text as T
28−import Blaze.ByteString.Builder (Builder)
27+import Data.ByteString.Builder (Builder)
29import Network.Mime (MimeType)
28import Network.Mime (MimeType)
30
29
31-- | An individual component of a path, or of a filepath.
30-- | An individual component of a path, or of a filepath.
@@ -60,6 +59,8 @@ toPieces :: [Text] -> Maybe Pieces
60toPieces = mapM toPiece
59toPieces = mapM toPiece
61
60
62-- | Request coming from a user. Corresponds to @pathInfo@.
61-- | Request coming from a user. Corresponds to @pathInfo@.
62+--
63+-- The root path is the empty list.
63type Pieces = [Piece]
64type Pieces = [Piece]
64
65
65-- | Values for the max-age component of the cache-control response header.
66-- | Values for the max-age component of the cache-control response header.
@@ -79,7 +80,7 @@ data Folder = Folder
79-- | Information on an individual file.
80-- | Information on an individual file.
80data File = File
81data File = File
81 { -- | Size of file in bytes
82 { -- | Size of file in bytes
82− fileGetSize :: Int
83+ fileGetSize :: Integer
83 -- | How to construct a WAI response for this file. Some files are stored
84 -- | How to construct a WAI response for this file. Some files are stored
84 -- on the filesystem and can use @ResponseFile@, while others are stored
85 -- on the filesystem and can use @ResponseFile@, while others are stored
85 -- in memory and should use @ResponseBuilder@.
86 -- in memory and should use @ResponseBuilder@.
@@ -141,4 +142,12 @@ data StaticSettings = StaticSettings
141
142
142 -- | Prefer usage of etag caching to last-modified caching.
143 -- | Prefer usage of etag caching to last-modified caching.
143 , ssUseHash :: Bool
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
144 }
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/sample.hs+13−7
@@ -1,11 +1,17 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai.Application.Static
3−import Network.Wai.Handler.Warp (run)
4
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+
5main :: IO ()
10main :: IO ()
6−main = run 3000 $ staticApp defaultWebAppSettings
11+main = runSettings defaultSettings
7− { ssLookupFile = fileSystemLookup "."
12+ {
8− , ssMaxAge = MaxAgeForever
13+ settingsPort = 3000
9− , ssIndices = []
14+ } $ staticApp (defaultFileServerSettings $ fromString ".")
10− , ssListing = Just defaultListing
15+ {
16+ ssIndices = mapMaybe (toPiece . pack) ["index.html"]
11 }
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.hs+65−6
@@ -2,13 +2,18 @@
2module WaiAppStaticTest (spec) where
2module WaiAppStaticTest (spec) where
3
3
4import Network.Wai.Application.Static
4import Network.Wai.Application.Static
5+import WaiAppStatic.Types
5
6
6import Test.Hspec
7import Test.Hspec
8+import Test.Mockery.Directory
7import qualified Data.ByteString.Char8 as S8
9import qualified Data.ByteString.Char8 as S8
8-- import qualified Data.ByteString.Lazy.Char8 as L8
10-- import qualified Data.ByteString.Lazy.Char8 as L8
9import System.PosixCompat.Files (getFileStatus, modificationTime)
11import System.PosixCompat.Files (getFileStatus, modificationTime)
12+import System.FilePath
13+import System.IO.Temp
10
14
11import Network.HTTP.Date
15import Network.HTTP.Date
16+import Network.HTTP.Types (status500)
12{-import System.Locale (defaultTimeLocale)-}
17{-import System.Locale (defaultTimeLocale)-}
13{-import Data.Time.Format (formatTime)-}
18{-import Data.Time.Format (formatTime)-}
14
19
@@ -24,7 +29,10 @@ defRequest = defaultRequest
24spec :: Spec
29spec :: Spec
25spec = do
30spec = do
26 let webApp = flip runSession $ staticApp $ defaultWebAppSettings "test"
31 let webApp = flip runSession $ staticApp $ defaultWebAppSettings "test"
32+ let fileServerAppWithSettings settings = flip runSession $ staticApp settings
27− let fileServerApp = flip runSession $ staticApp $ defaultFileServerSettings "test"
33+ let fileServerApp = fileServerAppWithSettings (defaultFileServerSettings "test")
34+ { ssAddTrailingSlash = True
35+ }
28
36
29 let etag = "1B2M2Y8AsgTpgAmY7PhCfg=="
37 let etag = "1B2M2Y8AsgTpgAmY7PhCfg=="
30 let file = "a/b"
38 let file = "a/b"
@@ -49,22 +57,22 @@ spec = do
49 assertStatus 200 =<<
57 assertStatus 200 =<<
50 request (setRawPathInfo defRequest path)
58 request (setRawPathInfo defRequest path)
51
59
52− it "404 for non-existant files" $ webApp $
60+ it "404 for non-existent files" $ webApp $
53 assertStatus 404 =<<
61 assertStatus 404 =<<
54 request (setRawPathInfo defRequest "doesNotExist")
62 request (setRawPathInfo defRequest "doesNotExist")
55
63
56− it "301 redirect when multiple slashes" $ webApp $ do
64+ it "302 redirect when multiple slashes" $ webApp $ do
57 req <- request (setRawPathInfo defRequest "a//b/c")
65 req <- request (setRawPathInfo defRequest "a//b/c")
58− assertStatus 301 req
66+ assertStatus 302 req
59 assertHeader "Location" "../../a/b/c" req
67 assertHeader "Location" "../../a/b/c" req
60
68
61 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
69 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
62 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
70 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
63 }
71 }
64− it "301 redirect when multiple slashes" $ absoluteApp $
72+ it "302 redirect when multiple slashes" $ absoluteApp $
65 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
73 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
66 req <- request (setRawPathInfo defRequest path)
74 req <- request (setRawPathInfo defRequest path)
67− assertStatus 301 req
75+ assertStatus 302 req
68 assertHeader "Location" "http://www.example.com/a/b/c" req
76 assertHeader "Location" "http://www.example.com/a/b/c" req
69
77
70 describe "webApp when requesting a static asset" $ do
78 describe "webApp when requesting a static asset" $ do
@@ -123,3 +131,54 @@ spec = do
123 assertStatus 304 req
131 assertStatus 304 req
124 assertNoHeader "Cache-Control" req
132 assertNoHeader "Cache-Control" req
125
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/tests.hs+3−2
@@ -1,5 +1,6 @@
1import WaiAppStaticTest (spec)
1import WaiAppStaticTest (spec)
2+import WaiAppEmbeddedTest (embSpec)
2−import Test.Hspec.Monadic
3+import Test.Hspec
3
4
4main :: IO ()
5main :: IO ()
5−main = hspec spec
6+main = hspec $ spec >> embSpec
wai-app-static/wai-app-static.cabal+38−16
@@ -1,11 +1,11 @@
1name: wai-app-static
1name: wai-app-static
2−version: 1.3.1.3
2+version: 3.1.7.1
3license: MIT
3license: MIT
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>
5author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
6+maintainer: Michael Snoyman <michael@snoyman.com>, Greg Weber <greg@gregweber.info>
7synopsis: WAI application for static serving
7synopsis: WAI application for static serving
8−description: Also provides some helper functions and datatypes for use outside of WAI.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-app-static>.
9category: Web, Yesod
9category: Web, Yesod
10stability: Stable
10stability: Stable
11cabal-version: >= 1.8
11cabal-version: >= 1.8
@@ -14,9 +14,11 @@ homepage: http://www.yesodweb.com/book/web-application-interface
14Extra-source-files:
14Extra-source-files:
15 images/folder.png
15 images/folder.png
16 images/haskell.png
16 images/haskell.png
17− test/WaiAppStaticTest.hs
17+ test/*.hs
18 test/a/b
18 test/a/b
19 tests.hs
19 tests.hs
20+ README.md
21+ ChangeLog.md
20
22
21Flag print
23Flag print
22 Description: print debug info
24 Description: print debug info
@@ -24,8 +26,8 @@ Flag print
24
26
25library
27library
26 build-depends: base >= 4 && < 5
28 build-depends: base >= 4 && < 5
27− , wai >= 1.3 && < 1.5
29+ , wai >= 3.0 && < 3.3
28− , bytestring >= 0.9.1.4
30+ , bytestring >= 0.10.4
29 , http-types >= 0.7
31 , http-types >= 0.7
30 , transformers >= 0.2.2
32 , transformers >= 0.2.2
31 , unix-compat >= 0.2
33 , unix-compat >= 0.2
@@ -35,30 +37,46 @@ library
35 , old-locale >= 1.0.0.2
37 , old-locale >= 1.0.0.2
36 , file-embed >= 0.0.3.1
38 , file-embed >= 0.0.3.1
37 , text >= 0.7
39 , text >= 0.7
38− , blaze-builder >= 0.2.1.4
40+ , cryptonite >= 0.6
39− , base64-bytestring >= 0.1
41+ , memory >= 0.7
40− , cryptohash >= 0.7
41− , system-filepath >= 0.4
42− , system-fileio >= 0.3
43 , http-date
42 , http-date
44 , blaze-html >= 0.5
43 , blaze-html >= 0.5
45 , blaze-markup >= 0.5.1
44 , blaze-markup >= 0.5.1
46− , crypto-conduit >= 0.4
47− , cereal >= 0.3.5
48 , mime-types >= 0.1 && < 0.2
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
49
53
50 exposed-modules: Network.Wai.Application.Static
54 exposed-modules: Network.Wai.Application.Static
51 WaiAppStatic.Storage.Filesystem
55 WaiAppStatic.Storage.Filesystem
52 WaiAppStatic.Storage.Embedded
56 WaiAppStatic.Storage.Embedded
53 WaiAppStatic.Listing
57 WaiAppStatic.Listing
54 WaiAppStatic.Types
58 WaiAppStatic.Types
59+ WaiAppStatic.CmdLine
55 other-modules: Util
60 other-modules: Util
61+ WaiAppStatic.Storage.Embedded.Runtime
62+ WaiAppStatic.Storage.Embedded.TH
56 ghc-options: -Wall
63 ghc-options: -Wall
57 extensions: CPP
64 extensions: CPP
58
65
59 if flag(print)
66 if flag(print)
60 cpp-options: -DPRINT
67 cpp-options: -DPRINT
61
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+
62test-suite runtests
80test-suite runtests
63 hs-source-dirs: test
81 hs-source-dirs: test
64 main-is: ../tests.hs
82 main-is: ../tests.hs
@@ -70,8 +88,8 @@ test-suite runtests
70 , time
88 , time
71 , old-locale
89 , old-locale
72 , http-date
90 , http-date
73− , wai-app-static >= 1.3
91+ , wai-app-static
74− , wai-test
92+ , wai-extra
75 , wai
93 , wai
76 , http-types
94 , http-types
77 , network
95 , network
@@ -79,8 +97,12 @@ test-suite runtests
79 , text
97 , text
80 , transformers
98 , transformers
81 , mime-types
99 , mime-types
100+ , zlib
101+ , filepath
102+ , temporary
103+ , mockery
82 -- , containers
104 -- , containers
83− ghc-options: -Wall
105+ ghc-options: -Wall
84
106
85source-repository head
107source-repository head
86 type: git
108 type: git
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-handler-fastcgi/LICENSE → wai-conduit/LICENSErenamed+8−8
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2014 Michael Snoyman
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
@@ -8,13 +8,13 @@ distribute, sublicense, and/or sell copies of the Software, and to
8permit persons to whom the Software is furnished to do so, subject to
8permit persons to whom the Software is furnished to do so, subject to
9the following conditions:
9the following conditions:
10
10
11−The above copyright notice and this permission notice shall be
11+The above copyright notice and this permission notice shall be included
12−included in all copies or substantial portions of the Software.
12+in all copies or substantial portions of the Software.
13
13
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
14THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
15EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16−MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
16+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
17−NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
17+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
18−LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
18+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
19−OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
19+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
20−WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
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-eventsource/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-eventsource/src/Main.hsdeleted−56
@@ -1,56 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Main where
3−
4−import Control.Monad
5−import Control.Concurrent (forkIO, threadDelay)
6−import Control.Monad.Trans (liftIO)
7−import Control.Concurrent.Chan
8−import Network.Wai.Handler.Warp (run)
9−import Network.Wai.Middleware.Gzip (gzip, def)
10−import Network.Wai
11−import Network.HTTP.Types (statusOK)
12−import Data.Time.Clock.POSIX
13−import Blaze.ByteString.Builder.Char.Utf8 (fromString)
14−import qualified Data.Conduit as C
15−
16−import Network.Wai.EventSource
17−
18−app :: Chan ServerEvent -> Application
19−app chan req =
20− case pathInfo req of
21− [] -> return $ ResponseFile statusOK [("Content-Type", "text/html")] "static/index.html" Nothing
22− ["esold"] -> eventSourceApp chan req
23− ["eschan"] -> eventSourceAppChan chan req
24− ["esio"] -> eventSourceAppIO eventIO req
25− ["essrc"] -> eventSourceAppSource eventSource req
26− _ -> error "unexpected pathInfo"
27−
28−eventChan :: Chan ServerEvent -> IO ()
29−eventChan chan = forever $ do
30− threadDelay 1000000
31− time <- getPOSIXTime
32− writeChan chan (ServerEvent Nothing Nothing [fromString . show $ time])
33−
34−eventIO :: IO ServerEvent
35−eventIO = do
36− threadDelay 1000000
37− time <- getPOSIXTime
38− return $ ServerEvent (Just $ fromString "io")
39− Nothing
40− [fromString . show $ time]
41−
42−eventSource :: C.Source IO ServerEvent
43−eventSource = C.sourceState () (const pull)
44− where
45− pull = do
46− time <- liftIO $ do
47− threadDelay 1000000
48− getPOSIXTime
49− return $ C.StateOpen () $ ServerEvent (Just $ fromString "source")
50− Nothing
51− [fromString . show $ time]
52−
53−main = do
54− chan <- newChan
55− _ <- forkIO . eventChan $ chan
56− run 8000 (gzip def $ app chan)
wai-eventsource/src/Network/Wai/EventSource.hsdeleted−67
@@ -1,67 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-|
3− A WAI adapter to the HTML5 Server-Sent Events API.
4−-}
5−module Network.Wai.EventSource (
6− ServerEvent(..),
7− eventSourceAppChan,
8− eventSourceAppSource,
9− eventSourceAppIO,
10− sourceToSource
11− ) where
12−
13−import Blaze.ByteString.Builder (Builder)
14−import Control.Concurrent.Chan (Chan, dupChan, readChan)
15−import Control.Monad.IO.Class (liftIO)
16−import Data.Conduit
17−import qualified Data.Conduit.List as CL
18−import Network.HTTP.Types (status200)
19−import Network.Wai (Application, Response(..))
20−
21−import Network.Wai.EventSource.EventStream
22−
23−-- | Make a new WAI EventSource application reading events from
24−-- the given channel.
25−eventSourceAppChan :: Chan ServerEvent -> Application
26−eventSourceAppChan chan _ = do
27− chan' <- liftIO $ dupChan chan
28− return $ response chanToSource chan'
29−
30−-- | Make a new WAI EventSource application reading events from
31−-- the given source.
32−eventSourceAppSource :: Source (ResourceT IO) ServerEvent -> Application
33−eventSourceAppSource src _ = return $ response sourceToSource src
34−
35−-- | Make a new WAI EventSource application reading events from
36−-- the given IO action.
37−eventSourceAppIO :: IO ServerEvent -> Application
38−eventSourceAppIO act _ = return $ response ioToSource act
39−
40−response :: (a -> Source (ResourceT IO) (Flush Builder)) -> a -> Response
41−response f a = ResponseSource status200 [("Content-Type", "text/event-stream")] $ f a
42−
43−chanToSource :: Chan ServerEvent -> Source (ResourceT IO) (Flush Builder)
44−chanToSource = ioToSource . readChan
45−
46−ioToSource :: IO ServerEvent -> Source (ResourceT IO) (Flush Builder)
47−ioToSource act =
48− loop
49− where
50− loop = do
51− x <- liftIO act
52− case eventToBuilder x of
53− Nothing -> return ()
54− Just y -> do
55− yield $ Chunk y
56− yield Flush
57− loop
58−
59−-- | Convert a ServerEvent source into a Builder source of serialized
60−-- events.
61−sourceToSource :: Monad m => Source m ServerEvent -> Source m (Flush Builder)
62−sourceToSource src = src $= CL.concatMap eventToFlushBuilder
63− where
64− eventToFlushBuilder event =
65− case eventToBuilder event of
66− Nothing -> []
67− Just x -> [Chunk x, Flush]
wai-eventsource/wai-eventsource.cabaldeleted−34
@@ -1,34 +0,0 @@
1−Name: wai-eventsource
2−Version: 1.3.0.4
3−Synopsis: WAI support for server-sent events
4−Description: WAI support for server-sent events
5−License: MIT
6−Author: Chris Smith, Mathias Biilmann Christensen
7−Maintainer: greg@gregweber.info
8−Stability: Experimental
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.8
12−homepage: http://www.yesodweb.com/book/web-application-interface
13−license-file: LICENSE
14−
15−Library
16− Build-depends:
17− base >= 4.3 && < 5
18− , bytestring >= 0.9.1.4
19− , blaze-builder >= 0.3 && < 0.4
20− , conduit >= 0.5 && < 1.1
21− , http-types >= 0.7
22− , wai >= 1.3 && < 1.5
23− , warp >= 1.3 && < 1.4
24− , transformers
25−
26− ghc-options: -Wall
27− hs-source-dirs: src
28− exposed-modules:
29− Network.Wai.EventSource
30− Network.Wai.EventSource.EventStream
31−
32−source-repository head
33− type: git
34− location: git://github.com/yesodweb/wai.git
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/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-eventsource/src/Network/Wai/EventSource/EventStream.hs → wai-extra/Network/Wai/EventSource/EventStream.hsrenamed+12−11
@@ -1,5 +1,5 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
2−{- code adapted by Mathias Billman originaly from Chris Smith https://github.com/cdsmith/gloss-web -}
2+{- code adapted by Mathias Billman originally from Chris Smith https://github.com/cdsmith/gloss-web -}
3
3
4{-|
4{-|
5 Internal module, usually you don't need to use it.
5 Internal module, usually you don't need to use it.
@@ -9,9 +9,10 @@ module Network.Wai.EventSource.EventStream (
9 eventToBuilder
9 eventToBuilder
10 ) where
10 ) where
11
11
12−import Blaze.ByteString.Builder
12+import Data.ByteString.Builder
13−import Blaze.ByteString.Builder.Char8
13+#if __GLASGOW_HASKELL__ < 710
14import Data.Monoid
14import Data.Monoid
15+#endif
15
16
16{-|
17{-|
17 Type representing a communication over an event stream. This can be an
18 Type representing a communication over an event stream. This can be an
@@ -37,18 +38,18 @@ data ServerEvent
37 Newline as a Builder.
38 Newline as a Builder.
38-}
39-}
39nl :: Builder
40nl :: Builder
40−nl = fromChar '\n'
41+nl = char7 '\n'
41
42
42
43
43{-|
44{-|
44 Field names as Builder
45 Field names as Builder
45-}
46-}
46nameField, idField, dataField, retryField, commentField :: Builder
47nameField, idField, dataField, retryField, commentField :: Builder
47−nameField = fromString "event:"
48+nameField = string7 "event:"
48−idField = fromString "id:"
49+idField = string7 "id:"
49−dataField = fromString "data:"
50+dataField = string7 "data:"
50−retryField = fromString "retry:"
51+retryField = string7 "retry:"
51−commentField = fromChar ':'
52+commentField = char7 ':'
52
53
53
54
54{-|
55{-|
@@ -64,7 +65,7 @@ field l b = l `mappend` b `mappend` nl
64-}
65-}
65eventToBuilder :: ServerEvent -> Maybe Builder
66eventToBuilder :: ServerEvent -> Maybe Builder
66eventToBuilder (CommentEvent txt) = Just $ field commentField txt
67eventToBuilder (CommentEvent txt) = Just $ field commentField txt
67−eventToBuilder (RetryEvent n) = Just $ field retryField (fromShow n)
68+eventToBuilder (RetryEvent n) = Just $ field retryField (string8 . show $ n)
68eventToBuilder (CloseEvent) = Nothing
69eventToBuilder (CloseEvent) = Nothing
69eventToBuilder (ServerEvent n i d)= Just $
70eventToBuilder (ServerEvent n i d)= Just $
70 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
71 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
wai-extra/Network/Wai/Handler/CGI.hs+89−76
@@ -1,6 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE RankNTypes, CPP #-}
3−{-# LANGUAGE CPP #-}
4-- | Backend for Common Gateway Interface. Almost all users should use the
2-- | Backend for Common Gateway Interface. Almost all users should use the
5-- 'run' function.
3-- 'run' function.
6module Network.Wai.Handler.CGI
4module Network.Wai.Handler.CGI
@@ -11,8 +9,9 @@ module Network.Wai.Handler.CGI
11 ) where
9 ) where
12
10
13import Network.Wai
11import Network.Wai
12+import Network.Wai.Internal
14import Network.Socket (getAddrInfo, addrAddress)
13import Network.Socket (getAddrInfo, addrAddress)
15−import System.Environment (getEnvironment)
14+import Data.IORef
16import Data.Maybe (fromMaybe)
15import Data.Maybe (fromMaybe)
17import qualified Data.ByteString.Char8 as B
16import qualified Data.ByteString.Char8 as B
18import qualified Data.ByteString.Lazy as L
17import qualified Data.ByteString.Lazy as L
@@ -20,19 +19,29 @@ import Control.Arrow ((***))
20import Data.Char (toLower)
19import Data.Char (toLower)
21import qualified System.IO
20import qualified System.IO
22import qualified Data.String as String
21import qualified Data.String as String
23−import Data.Monoid (mconcat, mempty)
24−import Blaze.ByteString.Builder (fromByteString, toLazyByteString)
22+import Data.ByteString.Builder (byteString, toLazyByteString, char7, string8)
25−import Blaze.ByteString.Builder.Char8 (fromChar, fromString)
23+import Data.ByteString.Builder.Extra (flush)
26−import Data.Conduit.Blaze (builderToByteStringFlush)
27−import Control.Monad.IO.Class (liftIO)
28import Data.ByteString.Lazy.Internal (defaultChunkSize)
24import Data.ByteString.Lazy.Internal (defaultChunkSize)
29import System.IO (Handle)
25import System.IO (Handle)
30−import Network.HTTP.Types (Status (..))
26+import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
31import qualified Network.HTTP.Types as H
27import qualified Network.HTTP.Types as H
32import qualified Data.CaseInsensitive as CI
28import qualified Data.CaseInsensitive as CI
29+#if __GLASGOW_HASKELL__ < 710
33−import Data.Monoid (mappend)
30+import Data.Monoid (mconcat, mempty, mappend)
34−import Data.Conduit
31+#endif
35−import qualified Data.Conduit.List as CL
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
36
45
37safeRead :: Read a => a -> String -> a
46safeRead :: Read a => a -> String -> a
38safeRead d s =
47safeRead d s =
@@ -67,7 +76,7 @@ runSendfile sf app = do
67-- stick with 'run' or 'runSendfile'.
76-- stick with 'run' or 'runSendfile'.
68runGeneric
77runGeneric
69 :: [(String, String)] -- ^ all variables
78 :: [(String, String)] -- ^ all variables
70− -> (Int -> Source (ResourceT IO) B.ByteString) -- ^ responseBody of input
79+ -> (Int -> IO (IO B.ByteString)) -- ^ responseBody of input
71 -> (B.ByteString -> IO ()) -- ^ destination for output
80 -> (B.ByteString -> IO ()) -- ^ destination for output
72 -> Maybe B.ByteString -- ^ does the server support the X-Sendfile header?
81 -> Maybe B.ByteString -- ^ does the server support the X-Sendfile header?
73 -> Application
82 -> Application
@@ -76,8 +85,6 @@ runGeneric vars inputH outputH xsendfile app = do
76 let rmethod = B.pack $ lookup' "REQUEST_METHOD" vars
85 let rmethod = B.pack $ lookup' "REQUEST_METHOD" vars
77 pinfo = lookup' "PATH_INFO" vars
86 pinfo = lookup' "PATH_INFO" vars
78 qstring = lookup' "QUERY_STRING" vars
87 qstring = lookup' "QUERY_STRING" vars
79− servername = lookup' "SERVER_NAME" vars
80− serverport = safeRead 80 $ lookup' "SERVER_PORT" vars
81 contentLength = safeRead 0 $ lookup' "CONTENT_LENGTH" vars
88 contentLength = safeRead 0 $ lookup' "CONTENT_LENGTH" vars
82 remoteHost' =
89 remoteHost' =
83 case lookup "REMOTE_ADDR" vars of
90 case lookup "REMOTE_ADDR" vars of
@@ -91,75 +98,81 @@ runGeneric vars inputH outputH xsendfile app = do
91 "https" -> True
98 "https" -> True
92 _ -> False
99 _ -> False
93 addrs <- getAddrInfo Nothing (Just remoteHost') Nothing
100 addrs <- getAddrInfo Nothing (Just remoteHost') Nothing
101+ requestBody' <- inputH contentLength
94 let addr =
102 let addr =
95 case addrs of
103 case addrs of
96 a:_ -> addrAddress a
104 a:_ -> addrAddress a
97 [] -> error $ "Invalid REMOTE_ADDR or REMOTE_HOST: " ++ remoteHost'
105 [] -> error $ "Invalid REMOTE_ADDR or REMOTE_HOST: " ++ remoteHost'
98− runResourceT $ do
106+ reqHeaders = map (cleanupVarName *** B.pack) vars
99− let env = Request
107+ env = Request
100− { requestMethod = rmethod
108+ { requestMethod = rmethod
101− , rawPathInfo = B.pack pinfo
109+ , rawPathInfo = B.pack pinfo
102− , pathInfo = H.decodePathSegments $ B.pack pinfo
110+ , pathInfo = H.decodePathSegments $ B.pack pinfo
103− , rawQueryString = B.pack qstring
111+ , rawQueryString = B.pack qstring
104− , queryString = H.parseQuery $ B.pack qstring
112+ , queryString = H.parseQuery $ B.pack qstring
105− , serverName = B.pack servername
106− , serverPort = serverport
107− , requestHeaders = map (cleanupVarName *** B.pack) vars
113+ , requestHeaders = reqHeaders
108− , isSecure = isSecure'
114+ , isSecure = isSecure'
109− , remoteHost = addr
115+ , remoteHost = addr
110− , httpVersion = H.http11 -- FIXME
116+ , httpVersion = H.http11 -- FIXME
111− , requestBody = inputH contentLength
117+ , requestBody = requestBody'
112− , vault = mempty
118+ , vault = mempty
119+ , requestBodyLength = KnownLength $ fromIntegral contentLength
120+ , requestHeaderHost = lookup "host" reqHeaders
121+ , requestHeaderRange = lookup hRange reqHeaders
113−#if MIN_VERSION_wai(1, 4, 0)
122+#if MIN_VERSION_wai(3,2,0)
114− , requestBodyLength = KnownLength $ fromIntegral contentLength
123+ , requestHeaderReferer = lookup "referer" reqHeaders
124+ , requestHeaderUserAgent = lookup "user-agent" reqHeaders
115#endif
125#endif
116− }
126+ }
117− -- FIXME worry about exception?
118− res <- app env
127+ void $ app env $ \res ->
119 case (xsendfile, res) of
128 case (xsendfile, res) of
120− (Just sf, ResponseFile s hs fp Nothing) ->
129+ (Just sf, ResponseFile s hs fp Nothing) -> do
121− liftIO $ mapM_ outputH $ L.toChunks $ toLazyByteString $ sfBuilder s hs sf fp
130+ mapM_ outputH $ L.toChunks $ toLazyByteString $ sfBuilder s hs sf fp
131+ return ResponseReceived
122 _ -> do
132 _ -> do
123− let (s, hs, b) = responseSource res
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
124− src = CL.sourceList [Chunk $ headers s hs `mappend` fromChar '\n']
143+ sendBuilder $ headers s hs `mappend` char7 '\n'
125− `mappend` b
144+ b sendBuilder (sendBuilder flush)
126− src $$ builderSink
145+ blazeFinish >>= maybe (return ()) outputH
146+ return ResponseReceived
127 where
147 where
128 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
148 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
129− status (Status i m) = (fromByteString "Status", mconcat
149+ status (Status i m) = (byteString "Status", mconcat
130− [ fromString $ show i
150+ [ string8 $ show i
131− , fromChar ' '
151+ , char7 ' '
132− , fromByteString m
152+ , byteString m
133 ])
153 ])
134− header' (x, y) = (fromByteString $ CI.original x, fromByteString y)
154+ header' (x, y) = (byteString $ CI.original x, byteString y)
135 header (x, y) = mconcat
155 header (x, y) = mconcat
136 [ x
156 [ x
137− , fromByteString ": "
157+ , byteString ": "
138 , y
158 , y
139− , fromChar '\n'
159+ , char7 '\n'
140 ]
160 ]
141 sfBuilder s hs sf fp = mconcat
161 sfBuilder s hs sf fp = mconcat
142 [ headers s hs
162 [ headers s hs
143− , header $ (fromByteString sf, fromString fp)
163+ , header $ (byteString sf, string8 fp)
144− , fromChar '\n'
164+ , char7 '\n'
145− , fromByteString sf
165+ , byteString sf
146− , fromByteString " not supported"
166+ , byteString " not supported"
147 ]
167 ]
148− bsSink = await >>= maybe (return ()) push
149− push (Chunk bs) = do
150− liftIO $ outputH bs
151− bsSink
152− -- FIXME actually flush?
153− push Flush = bsSink
154− builderSink = builderToByteStringFlush =$ bsSink
155 fixHeaders h =
168 fixHeaders h =
156− case lookup "content-type" h of
169+ case lookup hContentType h of
157− Nothing -> ("Content-Type", "text/html; charset=utf-8") : h
170+ Nothing -> (hContentType, "text/html; charset=utf-8") : h
158 Just _ -> h
171 Just _ -> h
159
172
160cleanupVarName :: String -> CI.CI B.ByteString
173cleanupVarName :: String -> CI.CI B.ByteString
161−cleanupVarName "CONTENT_TYPE" = "Content-Type"
174+cleanupVarName "CONTENT_TYPE" = hContentType
162−cleanupVarName "CONTENT_LENGTH" = "Content-Length"
175+cleanupVarName "CONTENT_LENGTH" = hContentLength
163cleanupVarName "SCRIPT_NAME" = "CGI-Script-Name"
176cleanupVarName "SCRIPT_NAME" = "CGI-Script-Name"
164cleanupVarName s =
177cleanupVarName s =
165 case s of
178 case s of
@@ -170,19 +183,19 @@ cleanupVarName s =
170 helper' (x:rest) = toLower x : helper' rest
183 helper' (x:rest) = toLower x : helper' rest
171 helper' [] = []
184 helper' [] = []
172
185
173−requestBodyHandle :: Handle -> Int -> Source (ResourceT IO) B.ByteString
186+requestBodyHandle :: Handle -> Int -> IO (IO B.ByteString)
174requestBodyHandle h = requestBodyFunc $ \i -> do
187requestBodyHandle h = requestBodyFunc $ \i -> do
175 bs <- B.hGet h i
188 bs <- B.hGet h i
176 return $ if B.null bs then Nothing else Just bs
189 return $ if B.null bs then Nothing else Just bs
177
190
178−requestBodyFunc :: (Int -> IO (Maybe B.ByteString)) -> Int -> Source (ResourceT IO) B.ByteString
191+requestBodyFunc :: (Int -> IO (Maybe B.ByteString)) -> Int -> IO (IO B.ByteString)
179−requestBodyFunc get =
192+requestBodyFunc get count0 = do
180− loop
193+ ref <- newIORef count0
181− where
194+ return $ do
182− loop 0 = return ()
195+ count <- readIORef ref
183− loop count = do
196+ if count <= 0
197+ then return B.empty
198+ else do
184− mbs <- liftIO $ get $ min count defaultChunkSize
199+ mbs <- get $ min count defaultChunkSize
185− let count' = count - maybe 0 B.length mbs
200+ writeIORef ref $ count - maybe 0 B.length mbs
186− case mbs of
201+ return $ fromMaybe B.empty mbs
187− Nothing -> return ()
188− Just bs -> yield bs >> loop count'
wai-handler-scgi/Network/Wai/Handler/SCGI.hs → wai-extra/Network/Wai/Handler/SCGI.hsrenamed+12−1
@@ -1,4 +1,4 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
2module Network.Wai.Handler.SCGI
2module Network.Wai.Handler.SCGI
3 ( run
3 ( run
4 , runSendfile
4 , runSendfile
@@ -86,6 +86,16 @@ readByteString socket len = do
86foreign import ccall unsafe "accept"
86foreign import ccall unsafe "accept"
87 c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
87 c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
88
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
89foreign import ccall unsafe "close"
99foreign import ccall unsafe "close"
90 c'close :: CInt -> IO CInt
100 c'close :: CInt -> IO CInt
91
101
@@ -94,3 +104,4 @@ foreign import ccall unsafe "write"
94
104
95foreign import ccall unsafe "read"
105foreign import ccall unsafe "read"
96 c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
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.hs−2
@@ -1,5 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3module Network.Wai.Middleware.AcceptOverride
1module Network.Wai.Middleware.AcceptOverride
4 ( acceptOverride
2 ( acceptOverride
5 ) where
3 ) where
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.hs+8−9
@@ -1,18 +1,17 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
2-- | Automatically produce responses to HEAD requests based on the underlying
2-- | Automatically produce responses to HEAD requests based on the underlying
3-- applications GET response.
3-- applications GET response.
4module Network.Wai.Middleware.Autohead (autohead) where
4module Network.Wai.Middleware.Autohead (autohead) where
5
5
6import Network.Wai
6import Network.Wai
7+#if __GLASGOW_HASKELL__ < 710
7import Data.Monoid (mempty)
8import Data.Monoid (mempty)
9+#endif
8
10
9autohead :: Middleware
11autohead :: Middleware
10−autohead app req
12+autohead app req sendResponse
11− | requestMethod req == "HEAD" = do
12− res <- app req { requestMethod = "GET" }
13+ | requestMethod req == "HEAD" = app req { requestMethod = "GET" } $ \res -> do
13− case res of
14+ let (s, hs, _) = responseToStream res
14− ResponseFile s hs _ _ -> return $ ResponseBuilder s hs mempty
15+ sendResponse $ responseBuilder s hs mempty
15− ResponseBuilder s hs _ -> return $ ResponseBuilder s hs mempty
16− ResponseSource s hs _ -> return $ ResponseBuilder s hs mempty
17− | otherwise = app req
16+ | otherwise = app req sendResponse
18
17
wai-extra/Network/Wai/Middleware/CleanPath.hs+8−6
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
2module Network.Wai.Middleware.CleanPath
2module Network.Wai.Middleware.CleanPath
3 ( cleanPath
3 ( cleanPath
4 ) where
4 ) where
@@ -6,20 +6,22 @@ module Network.Wai.Middleware.CleanPath
6import Network.Wai
6import Network.Wai
7import qualified Data.ByteString.Char8 as B
7import qualified Data.ByteString.Char8 as B
8import qualified Data.ByteString.Lazy as L
8import qualified Data.ByteString.Lazy as L
9−import Network.HTTP.Types (status301)
9+import Network.HTTP.Types (status301, hLocation)
10import Data.Text (Text)
10import Data.Text (Text)
11+#if __GLASGOW_HASKELL__ < 710
11import Data.Monoid (mconcat)
12import Data.Monoid (mconcat)
13+#endif
12
14
13cleanPath :: ([Text] -> Either B.ByteString [Text])
15cleanPath :: ([Text] -> Either B.ByteString [Text])
14 -> B.ByteString
16 -> B.ByteString
15 -> ([Text] -> Application)
17 -> ([Text] -> Application)
16 -> Application
18 -> Application
17−cleanPath splitter prefix app env =
19+cleanPath splitter prefix app env sendResponse =
18 case splitter $ pathInfo env of
20 case splitter $ pathInfo env of
19− Right pieces -> app pieces env
21+ Right pieces -> app pieces env sendResponse
20− Left p -> return
22+ Left p -> sendResponse
21 $ responseLBS status301
23 $ responseLBS status301
22− [("Location", mconcat [prefix, p, suffix])]
24+ [(hLocation, mconcat [prefix, p, suffix])]
23 $ L.empty
25 $ L.empty
24 where
26 where
25 -- include the query string if present
27 -- include the query string if present
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.hs+132−49
@@ -1,6 +1,4 @@
1−{-# LANGUAGE Rank2Types #-}
1+{-# LANGUAGE Rank2Types, ScopedTypeVariables #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE OverloadedStrings #-}
4---------------------------------------------------------
2---------------------------------------------------------
5-- |
3-- |
6-- Module : Network.Wai.Middleware.Gzip
4-- Module : Network.Wai.Middleware.Gzip
@@ -25,42 +23,64 @@ module Network.Wai.Middleware.Gzip
25 ) where
23 ) where
26
24
27import Network.Wai
25import Network.Wai
28−import Data.Maybe (fromMaybe)
26+import Data.Maybe (fromMaybe, isJust)
29import qualified Data.ByteString.Char8 as S8
27import qualified Data.ByteString.Char8 as S8
30import qualified Data.ByteString as S
28import qualified Data.ByteString as S
31−import Data.Default
29+import Data.Default.Class
32−import Network.HTTP.Types (Status, Header)
30+import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
33−import Control.Monad.IO.Class (liftIO)
31+ , hContentType, hContentLength)
34import System.Directory (doesFileExist, createDirectoryIfMissing)
32import System.Directory (doesFileExist, createDirectoryIfMissing)
35−import qualified Data.Conduit as C
33+import Data.ByteString.Builder (byteString)
36−import qualified Data.Conduit.Zlib as CZ
37−import qualified Data.Conduit.Binary as CB
34+import qualified Data.ByteString.Builder.Extra as Blaze (flush)
38−import qualified Data.Conduit.List as CL
39−import Data.Conduit.Blaze (builderToByteStringFlush)
40−import Blaze.ByteString.Builder (fromByteString)
41import Control.Exception (try, SomeException)
35import Control.Exception (try, SomeException)
42import qualified Data.Set as Set
36import 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)
43
47
44data GzipSettings = GzipSettings
48data GzipSettings = GzipSettings
45 { gzipFiles :: GzipFiles
49 { gzipFiles :: GzipFiles
46 , gzipCheckMime :: S.ByteString -> Bool
50 , gzipCheckMime :: S.ByteString -> Bool
47 }
51 }
48
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.
49−data GzipFiles = GzipIgnore | GzipCompress | GzipCacheFolder FilePath
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
50 deriving (Show, Eq, Read)
65 deriving (Show, Eq, Read)
51
66
67+-- | Use default MIME settings; /do not/ compress files.
52instance Default GzipSettings where
68instance Default GzipSettings where
53 def = GzipSettings GzipIgnore defaultCheckMime
69 def = GzipSettings GzipIgnore defaultCheckMime
54
70
71+-- | MIME types that will be compressed by default:
72+-- @text/@ @*@, @application/json@, @application/javascript@,
73+-- @application/ecmascript@, @image/x-icon@.
55defaultCheckMime :: S.ByteString -> Bool
74defaultCheckMime :: S.ByteString -> Bool
56defaultCheckMime bs =
75defaultCheckMime bs =
57 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
76 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
58 where
77 where
59− bs' = fst $ S.breakByte 59 bs -- semicolon
78+ bs' = fst $ S.break (== _semicolon) bs
60 toCompress = Set.fromList
79 toCompress = Set.fromList
61 [ "application/json"
80 [ "application/json"
62 , "application/javascript"
81 , "application/javascript"
63 , "application/ecmascript"
82 , "application/ecmascript"
83+ , "image/x-icon"
64 ]
84 ]
65
85
66-- | Use gzip to compress the body of the response.
86-- | Use gzip to compress the body of the response.
@@ -68,46 +88,84 @@ defaultCheckMime bs =
68-- Analyzes the \"Accept-Encoding\" header from the client to determine
88-- Analyzes the \"Accept-Encoding\" header from the client to determine
69-- if gzip is supported.
89-- if gzip is supported.
70--
90--
71−-- Possible future enhancements:
91+-- File responses will be compressed according to the 'GzipFiles' setting.
72--
92--
73−-- * Only compress if the response is above a certain size.
93+-- Will only be applied based on the 'gzipCheckMime' setting. For default
94+-- behavior, see 'defaultCheckMime'.
74gzip :: GzipSettings -> Middleware
95gzip :: GzipSettings -> Middleware
75−gzip set app env = do
96+gzip set app env sendResponse = app env $ \res ->
76− res <- app env
77 case res of
97 case res of
98+ ResponseRaw{} -> sendResponse res
78− ResponseFile{} | gzipFiles set == GzipIgnore -> return res
99+ ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
79− _ -> if "gzip" `elem` enc && not isMSIE6
100+ _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
80 then
101 then
81− case (res, gzipFiles set) of
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))
82− (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
111+ (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
83− case lookup "content-type" hs of
112+ case lookup hContentType hs of
84− Just m
113+ Just m
85− | gzipCheckMime set m -> liftIO $ compressFile s hs file cache
114+ | gzipCheckMime set m -> compressFile s hs file cache sendResponse
86− _ -> return res
115+ _ -> sendResponse res
116+ (ResponseFile {}, GzipIgnore) -> sendResponse res
87− _ -> return $ compressE set res
117+ _ -> compressE set res sendResponse
118+ in runAction (res, gzipFiles set)
88− else return res
119+ else sendResponse res
89 where
120 where
90 enc = fromMaybe [] $ (splitCommas . S8.unpack)
121 enc = fromMaybe [] $ (splitCommas . S8.unpack)
91 `fmap` lookup "Accept-Encoding" (requestHeaders env)
122 `fmap` lookup "Accept-Encoding" (requestHeaders env)
92− ua = fromMaybe "" $ lookup "user-agent" $ requestHeaders env
123+ ua = fromMaybe "" $ lookup hUserAgent $ requestHeaders env
93 isMSIE6 = "MSIE 6" `S.isInfixOf` ua
124 isMSIE6 = "MSIE 6" `S.isInfixOf` ua
125+ isEncoded res = isJust $ lookup hContentEncoding $ responseHeaders res
94
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+
95−compressFile :: Status -> [Header] -> FilePath -> FilePath -> IO Response
137+compressFile :: Status -> [Header] -> FilePath -> FilePath -> (Response -> IO a) -> IO a
96−compressFile s hs file cache = do
138+compressFile s hs file cache sendResponse = do
97 e <- doesFileExist tmpfile
139 e <- doesFileExist tmpfile
98 if e
140 if e
99 then onSucc
141 then onSucc
100 else do
142 else do
101 createDirectoryIfMissing True cache
143 createDirectoryIfMissing True cache
102− x <-
144+ x <- try $
103− try $ C.runResourceT $ CB.sourceFile file
145+ IO.withBinaryFile file IO.ReadMode $ \inH ->
104− C.$$ CZ.gzip C.=$ CB.sinkFile tmpfile
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
105− either onErr (const onSucc) x
164+ either onErr (const onSucc) (x :: Either SomeException ()) -- FIXME bad! don't catch all exceptions like that!
106 where
165 where
107− onSucc = return $ ResponseFile s (fixHeaders hs) tmpfile Nothing
166+ onSucc = sendResponse $ responseFile s (fixHeaders hs) tmpfile Nothing
108
167
109− onErr :: SomeException -> IO Response
110− onErr = const $ return $ ResponseFile s hs file Nothing -- FIXME log the error message
168+ onErr _ = sendResponse $ responseFile s hs file Nothing -- FIXME log the error message
111
169
112 tmpfile = cache ++ '/' : map safe file
170 tmpfile = cache ++ '/' : map safe file
113 safe c
171 safe c
@@ -120,25 +178,50 @@ compressFile s hs file cache = do
120
178
121compressE :: GzipSettings
179compressE :: GzipSettings
122 -> Response
180 -> Response
123− -> Response
181+ -> (Response -> IO a)
182+ -> IO a
124−compressE set res =
183+compressE set res sendResponse =
125− case lookup "content-type" hs of
184+ case lookup hContentType hs of
126 Just m | gzipCheckMime set m ->
185 Just m | gzipCheckMime set m ->
127 let hs' = fixHeaders hs
186 let hs' = fixHeaders hs
128− in ResponseSource s hs' $ b C.$= builderToByteStringFlush
187+ in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
188+ (blazeRecv, _) <- B.newBuilderRecv B.defaultStrategy
129− C.$= CZ.compressFlush 1 (CZ.WindowBits 31)
189+ deflate <- Z.initDeflate 1 (Z.WindowBits 31)
130− C.$= CL.map (fmap fromByteString)
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
131− _ -> res
214+ _ -> sendResponse res
132 where
215 where
133− (s, hs, b) = responseSource res
216+ (s, hs, wb) = responseToStream res
134
217
135-- Remove Content-Length header, since we will certainly have a
218-- Remove Content-Length header, since we will certainly have a
136-- different length after gzip compression.
219-- different length after gzip compression.
137fixHeaders :: [Header] -> [Header]
220fixHeaders :: [Header] -> [Header]
138fixHeaders =
221fixHeaders =
139− (("Content-Encoding", "gzip") :) . filter notLength
222+ ((hContentEncoding, "gzip") :) . filter notLength
140 where
223 where
141− notLength (x, _) = x /= "content-length"
224+ notLength (x, _) = x /= hContentLength
142
225
143splitCommas :: String -> [String]
226splitCommas :: String -> [String]
144splitCommas [] = []
227splitCommas [] = []
wai-extra/Network/Wai/Middleware/HttpAuth.hs+70−36
@@ -1,92 +1,99 @@
1−{-# LANGUAGE RecordWildCards, OverloadedStrings #-}
1+{-# LANGUAGE RecordWildCards, TupleSections, CPP #-}
2-- | Implements HTTP Basic Authentication.
2-- | Implements HTTP Basic Authentication.
3--
3--
4-- This module may add digest authentication in the future.
4-- This module may add digest authentication in the future.
5module Network.Wai.Middleware.HttpAuth
5module Network.Wai.Middleware.HttpAuth
6+ ( -- * Middleware
6− ( basicAuth
7+ basicAuth
8+ , basicAuth'
7 , CheckCreds
9 , CheckCreds
8 , AuthSettings
10 , AuthSettings
9 , authRealm
11 , authRealm
10 , authOnNoAuth
12 , authOnNoAuth
11 , authIsProtected
13 , authIsProtected
14+ -- * Helping functions
15+ , extractBasicAuth
16+ , extractBearerAuth
12 ) where
17 ) where
13−
18+#if __GLASGOW_HASKELL__ < 710
14−import Network.Wai
19+import Control.Applicative
15−import Network.HTTP.Types (status401)
20+#endif
16import Data.ByteString (ByteString)
21import Data.ByteString (ByteString)
17−import qualified Data.ByteString as S
22+import Data.ByteString.Base64 (decodeLenient)
18import Data.String (IsString (..))
23import Data.String (IsString (..))
19−import Control.Monad.Trans.Resource (ResourceT)
20import Data.Word8 (isSpace, _colon, toLower)
24import Data.Word8 (isSpace, _colon, toLower)
21−import Data.ByteString.Base64 (decodeLenient)
25+import Network.HTTP.Types (status401, hContentType, hAuthorization)
26+import Network.Wai
27+
28+import qualified Data.ByteString as S
29+
22
30
23-- | Check if a given username and password is valid.
31-- | Check if a given username and password is valid.
24type CheckCreds = ByteString
32type CheckCreds = ByteString
25 -> ByteString
33 -> ByteString
26− -> ResourceT IO Bool
34+ -> IO Bool
27
35
28-- | Perform basic authentication.
36-- | Perform basic authentication.
29--
37--
30-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
38-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
31--
39--
32−-- Since 1.3.4
40+-- @since 1.3.4
33basicAuth :: CheckCreds
41basicAuth :: CheckCreds
34 -> AuthSettings
42 -> AuthSettings
35 -> Middleware
43 -> Middleware
36−basicAuth checkCreds AuthSettings {..} app req = do
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
37 isProtected <- authIsProtected req
53 isProtected <- authIsProtected req
38 allowed <- if isProtected then check else return True
54 allowed <- if isProtected then check else return True
39 if allowed
55 if allowed
40− then app req
56+ then app req sendResponse
41− else authOnNoAuth authRealm req
57+ else authOnNoAuth authRealm req sendResponse
42 where
58 where
43 check =
59 check =
44− case lookup "Authorization" $ requestHeaders req of
60+ case (lookup hAuthorization $ requestHeaders req)
61+ >>= extractBasicAuth of
45 Nothing -> return False
62 Nothing -> return False
46− Just bs ->
47− let (x, y) = S.break isSpace bs
48− in if S.map toLower x == "basic"
49− then checkB64 $ S.dropWhile isSpace y
50− else return False
51− checkB64 encoded =
52− case S.uncons password' of
53− Just (_, password) -> checkCreds username password
63+ Just (username, password) -> checkCreds req username password
54− Nothing -> return False
55− where
56− raw = decodeLenient encoded
57− (username, password') = S.breakByte _colon raw
58
64
59−-- | Authentication settings. This value is an instance of @IsString@, so the
65+-- | Basic authentication settings. This value is an instance of
60−-- recommended approach to create a value is to provide a string literal (which
66+-- @IsString@, so the recommended approach to create a value is to
67+-- provide a string literal (which will be the realm) and then
61−-- will be the realm) and then overriding individual fields.
68+-- overriding individual fields.
62--
69--
63-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
70-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
64--
71--
65−-- Since 1.3.4
72+-- @since 1.3.4
66data AuthSettings = AuthSettings
73data AuthSettings = AuthSettings
67 { authRealm :: !ByteString
74 { authRealm :: !ByteString
68 -- ^
75 -- ^
69 --
76 --
70− -- Since 1.3.4
77+ -- @since 1.3.4
71 , authOnNoAuth :: !(ByteString -> Application)
78 , authOnNoAuth :: !(ByteString -> Application)
72 -- ^ Takes the realm and returns an appropriate 401 response when
79 -- ^ Takes the realm and returns an appropriate 401 response when
73 -- authentication is not provided.
80 -- authentication is not provided.
74 --
81 --
75− -- Since 1.3.4
82+ -- @since 1.3.4
76− , authIsProtected :: !(Request -> ResourceT IO Bool)
83+ , authIsProtected :: !(Request -> IO Bool)
77 -- ^ Determine if access to the requested resource is restricted.
84 -- ^ Determine if access to the requested resource is restricted.
78 --
85 --
79 -- Default: always returns @True@.
86 -- Default: always returns @True@.
80 --
87 --
81− -- Since 1.3.4
88+ -- @since 1.3.4
82 }
89 }
83
90
84instance IsString AuthSettings where
91instance IsString AuthSettings where
85 fromString s = AuthSettings
92 fromString s = AuthSettings
86 { authRealm = fromString s
93 { authRealm = fromString s
87− , authOnNoAuth = \realm _req -> return $ responseLBS
94+ , authOnNoAuth = \realm _req f -> f $ responseLBS
88 status401
95 status401
89− [ ("Content-Type", "text/plain")
96+ [ (hContentType, "text/plain")
90 , ("WWW-Authenticate", S.concat
97 , ("WWW-Authenticate", S.concat
91 [ "Basic realm=\""
98 [ "Basic realm=\""
92 , realm
99 , realm
@@ -96,3 +103,30 @@ instance IsString AuthSettings where
96 "Basic authentication is required"
103 "Basic authentication is required"
97 , authIsProtected = const $ return True
104 , authIsProtected = const $ return True
98 }
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.hs+31−30
@@ -1,5 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE RankNTypes, CPP #-}
3---------------------------------------------------------
2---------------------------------------------------------
4-- |
3-- |
5-- Module : Network.Wai.Middleware.Jsonp
4-- Module : Network.Wai.Middleware.Jsonp
@@ -16,27 +15,29 @@
16module Network.Wai.Middleware.Jsonp (jsonp) where
15module Network.Wai.Middleware.Jsonp (jsonp) where
17
16
18import Network.Wai
17import Network.Wai
18+import Network.Wai.Internal
19import Data.ByteString (ByteString)
19import Data.ByteString (ByteString)
20import qualified Data.ByteString.Char8 as B8
20import qualified Data.ByteString.Char8 as B8
21−import Blaze.ByteString.Builder (copyByteString)
21+import Data.ByteString.Builder.Extra (byteStringCopy)
22−import Blaze.ByteString.Builder.Char8 (fromChar)
22+import Data.ByteString.Builder (char7)
23+#if __GLASGOW_HASKELL__ < 710
23import Data.Monoid (mappend)
24import Data.Monoid (mappend)
25+#endif
24import Control.Monad (join)
26import Control.Monad (join)
25import Data.Maybe (fromMaybe)
27import Data.Maybe (fromMaybe)
26import qualified Data.ByteString as S
28import qualified Data.ByteString as S
27−import qualified Data.Conduit as C
29+import Network.HTTP.Types (hAccept, hContentType)
28−import qualified Data.Conduit.List as CL
29
30
30-- | Wrap json responses in a jsonp callback.
31-- | Wrap json responses in a jsonp callback.
31--
32--
32-- Basically, if the user requested a \"text\/javascript\" and supplied a
33-- Basically, if the user requested a \"text\/javascript\" and supplied a
33-- \"callback\" GET parameter, ask the application for an
34-- \"callback\" GET parameter, ask the application for an
34−-- \"application/json\" response, then convern that into a JSONP response,
35+-- \"application/json\" response, then convert that into a JSONP response,
35-- having a content type of \"text\/javascript\" and calling the specified
36-- having a content type of \"text\/javascript\" and calling the specified
36-- callback function.
37-- callback function.
37jsonp :: Middleware
38jsonp :: Middleware
38−jsonp app env = do
39+jsonp app env sendResponse = do
39− let accept = fromMaybe B8.empty $ lookup "Accept" $ requestHeaders env
40+ let accept = fromMaybe B8.empty $ lookup hAccept $ requestHeaders env
40 let callback :: Maybe B8.ByteString
41 let callback :: Maybe B8.ByteString
41 callback =
42 callback =
42 if B8.pack "text/javascript" `B8.isInfixOf` accept
43 if B8.pack "text/javascript" `B8.isInfixOf` accept
@@ -46,43 +47,43 @@ jsonp app env = do
46 case callback of
47 case callback of
47 Nothing -> env
48 Nothing -> env
48 Just _ -> env
49 Just _ -> env
49− { requestHeaders = changeVal "Accept"
50+ { requestHeaders = changeVal hAccept
50 "application/json"
51 "application/json"
51 $ requestHeaders env
52 $ requestHeaders env
52 }
53 }
53− res <- app env'
54+ app env' $ \res ->
54− case callback of
55+ case callback of
55− Nothing -> return res
56+ Nothing -> sendResponse res
56− Just c -> go c res
57+ Just c -> go c res
57 where
58 where
58 go c r@(ResponseBuilder s hs b) =
59 go c r@(ResponseBuilder s hs b) =
59− case checkJSON hs of
60+ sendResponse $ case checkJSON hs of
60− Nothing -> return r
61+ Nothing -> r
61− Just hs' -> return $ ResponseBuilder s hs' $
62+ Just hs' -> responseBuilder s hs' $
62− copyByteString c
63+ byteStringCopy c
63− `mappend` fromChar '('
64+ `mappend` char7 '('
64 `mappend` b
65 `mappend` b
65− `mappend` fromChar ')'
66+ `mappend` char7 ')'
66 go c r =
67 go c r =
67 case checkJSON hs of
68 case checkJSON hs of
68− Just hs' -> addCallback c s hs' b
69+ Just hs' -> addCallback c s hs' wb
69− Nothing -> return r
70+ Nothing -> sendResponse r
70 where
71 where
71− (s, hs, b) = responseSource r
72+ (s, hs, wb) = responseToStream r
72
73
73 checkJSON hs =
74 checkJSON hs =
74− case lookup "Content-Type" hs of
75+ case lookup hContentType hs of
75 Just x
76 Just x
76 | B8.pack "application/json" `S.isPrefixOf` x ->
77 | B8.pack "application/json" `S.isPrefixOf` x ->
77 Just $ fixHeaders hs
78 Just $ fixHeaders hs
78 _ -> Nothing
79 _ -> Nothing
79− fixHeaders = changeVal "Content-Type" "text/javascript"
80+ fixHeaders = changeVal hContentType "text/javascript"
80
81
81− addCallback cb s hs b =
82+ addCallback cb s hs wb =
82− return $ ResponseSource s hs $
83+ wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
83− CL.sourceList [C.Chunk $ copyByteString cb `mappend` fromChar '(']
84+ sendChunk $ byteStringCopy cb `mappend` char7 '('
84− `mappend` b
85+ _ <- body sendChunk flush
85− `mappend` CL.sourceList [C.Chunk $ fromChar ')']
86+ sendChunk $ char7 ')'
86
87
87changeVal :: Eq a
88changeVal :: Eq a
88 => a
89 => a
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.hs+4−6
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2module Network.Wai.Middleware.MethodOverride
1module Network.Wai.Middleware.MethodOverride
3 ( methodOverride
2 ( methodOverride
4 ) where
3 ) where
@@ -6,12 +5,11 @@ module Network.Wai.Middleware.MethodOverride
6import Network.Wai
5import Network.Wai
7import Control.Monad (join)
6import Control.Monad (join)
8
7
9−-- | Allows overriding of the HTTP request method via the _method query string
8+-- | Overriding of HTTP request method via `_method` query string parameter.
10−-- parameter.
11--
9--
12−-- This middlware only applies when the initial request method is POST. This
10+-- This middleware only applies when the initial request method is POST.
13−-- allow submitting of normal HTML forms, without worries of semantics
11+-- Allows submitting of normal HTML forms, without worries of semantic
14−-- mismatches in the HTTP spec.
12+-- mismatches with the HTTP spec.
15methodOverride :: Middleware
13methodOverride :: Middleware
16methodOverride app req =
14methodOverride app req =
17 app req'
15 app req'
wai-extra/Network/Wai/Middleware/MethodOverridePost.hs+20−15
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
2-----------------------------------------------------------------
2-----------------------------------------------------------------
3-- | Module : Network.Wai.Middleware.MethodOverridePost
3-- | Module : Network.Wai.Middleware.MethodOverridePost
4--
4--
@@ -9,11 +9,13 @@ module Network.Wai.Middleware.MethodOverridePost
9 ) where
9 ) where
10
10
11import Network.Wai
11import Network.Wai
12−import Network.HTTP.Types (parseQuery)
12+import Network.HTTP.Types (parseQuery, hContentType)
13+
14+#if __GLASGOW_HASKELL__ < 710
13−import Data.Monoid (mconcat)
15+import Data.Monoid (mconcat, mempty)
16+#endif
17+import Data.IORef
14−import Data.Conduit.Lazy (lazyConsume)
18+import Data.ByteString.Lazy (toChunks)
15−import Control.Monad.Trans.Resource (ResourceT)
16−import Data.Conduit.List (sourceList)
17
19
18-- | Allows overriding of the HTTP request method via the _method post string parameter.
20-- | Allows overriding of the HTTP request method via the _method post string parameter.
19--
21--
@@ -24,16 +26,19 @@ import Data.Conduit.List (sourceList)
24-- then it changes the request-method to the value of that
26-- then it changes the request-method to the value of that
25-- parameter.
27-- parameter.
26--
28--
27−-- * This middlware only applies when the initial request method is POST.
29+-- * This middleware only applies when the initial request method is POST.
28--
30--
29methodOverridePost :: Middleware
31methodOverridePost :: Middleware
32+methodOverridePost app req send =
30−methodOverridePost app req = case (requestMethod req, lookup "Content-Type" (requestHeaders req)) of
33+ case (requestMethod req, lookup hContentType (requestHeaders req)) of
31− ("POST", Just "application/x-www-form-urlencoded") -> setPost req >>= app
34+ ("POST", Just "application/x-www-form-urlencoded") -> setPost req >>= flip app send
32− _ -> app req
35+ _ -> app req send
33
36
34−setPost :: Request -> ResourceT IO Request
37+setPost :: Request -> IO Request
35setPost req = do
38setPost req = do
36− body <- lazyConsume (requestBody req)
39+ body <- (mconcat . toChunks) `fmap` lazyRequestBody req
40+ ref <- newIORef body
41+ let rb = atomicModifyIORef ref $ \bs -> (mempty, bs)
37− case parseQuery (mconcat body) of
42+ case parseQuery body of
38− (("_method", Just newmethod):_) -> return $ req {requestBody = sourceList body, requestMethod = newmethod}
43+ (("_method", Just newmethod):_) -> return $ req {requestBody = rb, requestMethod = newmethod}
39− _ -> return $ req {requestBody = sourceList body}
44+ _ -> return $ req {requestBody = rb}
wai-extra/Network/Wai/Middleware/RequestLogger.hs+257−153
@@ -1,6 +1,6 @@
1−{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
3−{-# LANGUAGE CPP #-}
2+-- NOTE: Due to https://github.com/yesodweb/wai/issues/192, this module should
3+-- not use CPP.
4module Network.Wai.Middleware.RequestLogger
4module Network.Wai.Middleware.RequestLogger
5 ( -- * Basic stdout logging
5 ( -- * Basic stdout logging
6 logStdout
6 logStdout
@@ -13,50 +13,91 @@ module Network.Wai.Middleware.RequestLogger
13 , destination
13 , destination
14 , OutputFormat (..)
14 , OutputFormat (..)
15 , OutputFormatter
15 , OutputFormatter
16+ , OutputFormatterWithDetails
17+ , OutputFormatterWithDetailsAndHeaders
16 , Destination (..)
18 , Destination (..)
17 , Callback
19 , Callback
18 , IPAddrSource (..)
20 , IPAddrSource (..)
19 ) where
21 ) where
20
22
21−import System.IO (Handle, stdout)
23+import System.IO (Handle, hFlush, stdout)
24+import qualified Data.ByteString.Builder as B (Builder, byteString)
22import qualified Data.ByteString as BS
25import qualified Data.ByteString as BS
23−import Data.ByteString.Char8 (pack, unpack)
26+import Data.ByteString.Char8 (pack)
27+import Control.Monad (when)
24import Control.Monad.IO.Class (liftIO)
28import Control.Monad.IO.Class (liftIO)
25−import Network.Wai (Request(..), Middleware, responseStatus, Response)
29+import Network.Wai
30+ ( Request(..), requestBodyLength, RequestBodyLength(..)
31+ , Middleware
32+ , Response, responseStatus, responseHeaders
33+ )
26import System.Log.FastLogger
34import System.Log.FastLogger
27import Network.HTTP.Types as H
35import Network.HTTP.Types as H
28import Data.Maybe (fromMaybe)
36import Data.Maybe (fromMaybe)
29−
37+import Data.Monoid (mconcat, (<>))
38+import Data.Time (getCurrentTime, diffUTCTime, NominalDiffTime)
30−import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File, getRequestBodyType)
39+import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File
40+ , getRequestBodyType)
31import qualified Data.ByteString.Lazy as LBS
41import qualified Data.ByteString.Lazy as LBS
32−
33−import qualified Data.Conduit as C
42+import qualified Data.ByteString.Char8 as S8
34−import qualified Data.Conduit.List as CL
35−
36import System.Console.ANSI
43import System.Console.ANSI
37import Data.IORef
44import Data.IORef
38import System.IO.Unsafe
45import System.IO.Unsafe
39−
46+import Network.Wai.Internal (Response (..))
40−import Data.Default (Default (def))
47+import Data.Default.Class (Default (def))
41−import Network.Wai.Logger.Format (apacheFormat, IPAddrSource (..))
48+import Network.Wai.Logger
42−#if MIN_VERSION_fast_logger(0,3,0)
49+import Network.Wai.Middleware.RequestLogger.Internal
43−import System.Date.Cache (ondemandDateCacher)
50+import Network.Wai.Header (contentLength)
44−#else
51+import Data.Text.Encoding (decodeUtf8')
45−import System.Log.FastLogger.Date (getDate, dateInit, ZonedDate)
52+
46−#endif
53+data OutputFormat
47−
48−data OutputFormat = Apache IPAddrSource
54+ = Apache IPAddrSource
49− | Detailed Bool -- ^ use colors?
55+ | Detailed Bool -- ^ use colors?
50− | CustomOutputFormat OutputFormatter
56+ | CustomOutputFormat OutputFormatter
51−
57+ | CustomOutputFormatWithDetails OutputFormatterWithDetails
58+ | CustomOutputFormatWithDetailsAndHeaders OutputFormatterWithDetailsAndHeaders
59+
52−type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> [LogStr]
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
53
89
54data Destination = Handle Handle
90data Destination = Handle Handle
55− | Logger Logger
91+ | Logger LoggerSet
56 | Callback Callback
92 | Callback Callback
57
93
58−type Callback = [LogStr] -> IO ()
94+type Callback = LogStr -> IO ()
59
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.
60data RequestLoggerSettings = RequestLoggerSettings
101data RequestLoggerSettings = RequestLoggerSettings
61 {
102 {
62 -- | Default value: @Detailed@ @True@.
103 -- | Default value: @Detailed@ @True@.
@@ -78,71 +119,90 @@ instance Default RequestLoggerSettings where
78
119
79mkRequestLogger :: RequestLoggerSettings -> IO Middleware
120mkRequestLogger :: RequestLoggerSettings -> IO Middleware
80mkRequestLogger RequestLoggerSettings{..} = do
121mkRequestLogger RequestLoggerSettings{..} = do
81− (callback, mgetdate) <-
122+ let (callback, flusher) =
82− case destination of
123+ case destination of
83− Handle h -> fmap fromLogger $ mkLogger autoFlush h
124+ Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
84− Logger l -> return $ fromLogger l
125+ Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
85− Callback c -> return (c, Nothing)
126+ Callback c -> (c, return ())
127+ callbackAndFlush str = callback str >> flusher
86 case outputFormat of
128 case outputFormat of
87 Apache ipsrc -> do
129 Apache ipsrc -> do
88− getdate <- dateHelper mgetdate
130+ getdate <- getDateGetter flusher
131+ apache <- initLogger ipsrc (LogCallback callback flusher) getdate
89− return $ apacheMiddleware callback ipsrc getdate
132+ return $ apacheMiddleware apache
90− Detailed useColors -> detailedMiddleware callback useColors
133+ Detailed useColors -> detailedMiddleware callbackAndFlush useColors
91 CustomOutputFormat formatter -> do
134 CustomOutputFormat formatter -> do
92− getdate <- dateHelper mgetdate
135+ getDate <- getDateGetter flusher
93− return $ customMiddleware callback getdate formatter
136+ return $ customMiddleware callbackAndFlush getDate formatter
94− where
137+ CustomOutputFormatWithDetails formatter -> do
95− fromLogger l = (loggerPutStr l, Just $ loggerDate l)
138+ getdate <- getDateGetter flusher
96− dateHelper mgetdate = do
139+ return $ customMiddlewareWithDetails callbackAndFlush getdate formatter
97− case mgetdate of
140+ CustomOutputFormatWithDetailsAndHeaders formatter -> do
98− Just x -> return x
141+ getdate <- getDateGetter flusher
99−#if MIN_VERSION_fast_logger(0, 3, 0)
142+ return $ customMiddlewareWithDetailsAndHeaders callbackAndFlush getdate formatter
100− Nothing -> do
143+
101− (getter,_) <- ondemandDateCacher zonedDateCacheConf
102− return getter
103−#else
104− Nothing -> fmap getDate dateInit
105−#endif
106−
107−apacheMiddleware :: Callback -> IPAddrSource -> IO ZonedDate -> Middleware
144+apacheMiddleware :: ApacheLoggerActions -> Middleware
108−apacheMiddleware cb ipsrc getdate = customMiddleware cb getdate $ apacheFormat ipsrc
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
109
149
110customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
150customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
111−customMiddleware cb getdate formatter app req = do
151+customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
112− res <- app req
113 date <- liftIO getdate
152 date <- liftIO getdate
114− -- We use Nothing for the response size since we generally don't know it
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 .
115− liftIO $ cb $ formatter date req (responseStatus res) Nothing
169+ formatter date req' (responseStatus res') msize (t1 `diffUTCTime` t0) reqBody =<<
170+ readIORef builderIO
116− return res
171+ return rspRcv
117−
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
118-- | Production request logger middleware.
191-- | Production request logger middleware.
119−-- Implemented on top of "logCallback", but prints to 'stdout'
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 #-}
120logStdout :: Middleware
196logStdout :: Middleware
121logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
197logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
122
198
123-- | Development request logger middleware.
199-- | Development request logger middleware.
124−-- Implemented on top of "logCallbackDev", but prints to 'stdout'
125--
200--
126−-- Flushes 'stdout' on each request, which would be inefficient in production use.
201+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
127−-- Use "logStdout" in production.
202+{-# NOINLINE logStdoutDev #-}
128logStdoutDev :: Middleware
203logStdoutDev :: Middleware
129logStdoutDev = unsafePerformIO $ mkRequestLogger def
204logStdoutDev = unsafePerformIO $ mkRequestLogger def
130
205
131−-- no black or white which are expected to be existing terminal colors.
132−colors0 :: [Color]
133−colors0 = [
134− Red
135− , Green
136− , Yellow
137− , Blue
138− , Magenta
139− , Cyan
140− ]
141−
142−rotateColors :: [Color] -> ([Color], Color)
143−rotateColors [] = error "Impossible! There must be colors!"
144−rotateColors (c:cs) = (cs ++ [c], c)
145−
146-- | Prints a message using the given callback function for each request.
206-- | Prints a message using the given callback function for each request.
147-- This is not for serious production use- it is inefficient.
207-- This is not for serious production use- it is inefficient.
148-- It immediately consumes a POST body and fills it back in and is otherwise inefficient
208-- It immediately consumes a POST body and fills it back in and is otherwise inefficient
@@ -151,101 +211,148 @@ rotateColors (c:cs) = (cs ++ [c], c)
151-- This meanst that you can accurately see the interleaving of requests.
211-- This meanst that you can accurately see the interleaving of requests.
152-- And if the app crashes you have still logged the request.
212-- And if the app crashes you have still logged the request.
153-- However, if you are simulating 10 simultaneous users you may find this confusing.
213-- However, if you are simulating 10 simultaneous users you may find this confusing.
154−-- The request and response are connected by color on Unix and also by the request path.
155--
214--
156-- This is lower-level - use 'logStdoutDev' unless you need greater control.
215-- This is lower-level - use 'logStdoutDev' unless you need greater control.
157--
216--
158-- Example ouput:
217-- Example ouput:
159--
218--
160-- > GET search
219-- > GET search
161−-- > Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
220+-- > Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8
162−-- >
163−-- > Status: 200 OK. search
221+-- > Status: 200 OK 0.010555s
164-- >
222-- >
165-- > GET static/css/normalize.css
223-- > GET static/css/normalize.css
224+-- > Params: [("LXwioiBG","")]
166−-- > Accept: text/css,*/*;q=0.1
225+-- > Accept: text/css,*/*;q=0.1
167−-- > GET [("LXwioiBG","")]
168−-- >
169−-- > Status: 304 Not Modified. static/css/normalize.css
226+-- > Status: 304 Not Modified 0.010555s
170
227
171detailedMiddleware :: Callback -> Bool -> IO Middleware
228detailedMiddleware :: Callback -> Bool -> IO Middleware
172−detailedMiddleware cb useColors = do
229+detailedMiddleware cb useColors =
173− getAddColor <-
230+ let (ansiColor, ansiMethod, ansiStatusCode) =
174− if useColors
231+ if useColors
175− then do
232+ then (ansiColor', ansiMethod', ansiStatusCode')
176− icolors <- newIORef colors0
233+ else (\_ t -> [t], (:[]), \_ t -> [t])
177− return $ do
234+
178− color <- liftIO $ atomicModifyIORef icolors rotateColors
179− return $ ansiColor color
180− else return (return return)
181− return $ detailedMiddleware' cb getAddColor
235+ in return $ detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode
182− where
236+
237+ansiColor' :: Color -> BS.ByteString -> [BS.ByteString]
183− ansiColor color bs = [
238+ansiColor' color bs =
184− pack $ setSGRCode [SetColor Foreground Vivid color]
239+ [ pack $ setSGRCode [SetColor Foreground Dull color]
185− , bs
240+ , bs
186− , pack $ setSGRCode [Reset]
241+ , pack $ setSGRCode [Reset]
187− ]
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)
188
295
189detailedMiddleware' :: Callback
296detailedMiddleware' :: Callback
297+ -> (Color -> BS.ByteString -> [BS.ByteString])
190− -> (C.ResourceT IO (BS.ByteString -> [BS.ByteString]))
298+ -> (BS.ByteString -> [BS.ByteString])
299+ -> (BS.ByteString -> BS.ByteString -> [BS.ByteString])
191 -> Middleware
300 -> Middleware
192−detailedMiddleware' cb getAddColor app req = do
301+detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode app req sendResponse = do
193− let mlen = lookup "content-length" (requestHeaders req) >>= readInt
194 (req', body) <-
302 (req', body) <-
195− case mlen of
303+ -- second tuple item should not be necessary, but a test runner might mess it up
304+ case (requestBodyLength req, contentLength (requestHeaders req)) of
196 -- log the request body if it is small
305 -- log the request body if it is small
306+ (KnownLength len, _) | len <= 2048 -> getRequestBody req
197− Just len | len <= 2048 -> do
307+ (_, Just len) | len <= 2048 -> getRequestBody req
198− body <- requestBody req C.$$ CL.consume
199− -- logging the body here consumes it, so fill it back up
200− -- obviously not efficient, but this is the development logger
201− let req' = req { requestBody = CL.sourceList body }
202− return (req', body)
203 _ -> return (req, [])
308 _ -> return (req, [])
204
309
310+ let reqbodylog _ = if null body then [""] else ansiColor White " Request Body: " <> body <> ["\n"]
311+ reqbody = concatMap (either (const [""]) reqbodylog . decodeUtf8') body
205 postParams <- if requestMethod req `elem` ["GET", "HEAD"]
312 postParams <- if requestMethod req `elem` ["GET", "HEAD"]
206− then return []
313+ then return []
207− else do postParams <- liftIO $ allPostParams body
314+ else do postParams <- liftIO $ allPostParams body
208− return $ collectPostParams postParams
315+ return $ collectPostParams postParams
209
316
210 let getParams = map emptyGetParam $ queryString req
317 let getParams = map emptyGetParam $ queryString req
211−
212− addColor <- getAddColor
213−
214− -- log the request immediately.
215− liftIO $ cb $ map LB $ addColor (requestMethod req) ++
216− [ " "
217− , rawPathInfo req
218− , "\n"
219− , "Accept: "
220− , fromMaybe "" $ lookup "Accept" $ requestHeaders req
318+ accept = fromMaybe "" $ lookup H.hAccept $ requestHeaders req
221− , paramsToBS "GET " getParams
319+ params = let par | not $ null postParams = [pack (show postParams)]
222− , paramsToBS "POST " postParams
320+ | not $ null getParams = [pack (show getParams)]
223− , "\n"
321+ | otherwise = []
224− ]
322+ in if null par then [""] else ansiColor White " Params: " <> par <> ["\n"]
225−
323+
324+ t0 <- getCurrentTime
226− rsp <- app req'
325+ app req' $ \rsp -> do
227−
326+ let isRaw =
327+ case rsp of
328+ ResponseRaw{} -> True
329+ _ -> False
330+ stCode = statusBS rsp
331+ stMsg = msgBS rsp
332+ t1 <- getCurrentTime
333+
228− -- log the status of the response
334+ -- log the status of the response
229− -- this is color coordinated with the request logging
335+ cb $ mconcat $ map toLogStr $
230− -- also includes the request path to connect it to the request
336+ ansiMethod (requestMethod req) ++ [" ", rawPathInfo req, "\n"] ++
231− liftIO $ cb $ map LB $ addColor "Status: " ++ [
337+ params ++ reqbody ++
232− statusBS rsp
338+ ansiColor White " Accept: " ++ [accept, "\n"] ++
233− , " "
339+ if isRaw then [] else
234− , msgBS rsp
340+ ansiColor White " Status: " ++
235− , ". "
341+ ansiStatusCode stCode (stCode <> " " <> stMsg) ++
236− , rawPathInfo req -- if you need help matching the 2 logging statements
342+ [" ", pack $ show $ diffUTCTime t1 t0, "\n"]
237− , "\n"
343+
238− ]
344+ sendResponse rsp
239− return rsp
240 where
345 where
241− paramsToBS prefix params =
242− if null params then ""
243− else BS.concat ["\n", prefix, pack (show params)]
244−
245 allPostParams body =
346 allPostParams body =
246 case getRequestBodyType req of
347 case getRequestBodyType req of
247 Nothing -> return ([], [])
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)
248− Just rbt -> C.runResourceT $ CL.sourceList body C.$$ sinkRequestBody lbsBackEnd rbt
355+ sinkRequestBody lbsBackEnd rbt rbody
249
356
250 emptyGetParam :: (BS.ByteString, Maybe BS.ByteString) -> (BS.ByteString, BS.ByteString)
357 emptyGetParam :: (BS.ByteString, Maybe BS.ByteString) -> (BS.ByteString, BS.ByteString)
251 emptyGetParam (k, Just v) = (k,v)
358 emptyGetParam (k, Just v) = (k,v)
@@ -253,12 +360,9 @@ detailedMiddleware' cb getAddColor app req = do
253
360
254 collectPostParams :: ([Param], [File LBS.ByteString]) -> [Param]
361 collectPostParams :: ([Param], [File LBS.ByteString]) -> [Param]
255 collectPostParams (postParams, files) = postParams ++
362 collectPostParams (postParams, files) = postParams ++
256− map (\(k,v) -> (k, BS.append "FILE: " (fileName v))) files
363+ map (\(k,v) -> (k, "FILE: " <> fileName v)) files
364+
257
365
258− readInt bs =
259− case reads $ unpack bs of
260− (i, _):_ -> Just (i :: Int)
261− [] -> Nothing
262
366
263statusBS :: Response -> BS.ByteString
367statusBS :: Response -> BS.ByteString
264statusBS = pack . show . statusCode . responseStatus
368statusBS = pack . show . statusCode . 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.hs+321−15
@@ -1,33 +1,339 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE TupleSections #-}
2+{-# LANGUAGE CPP #-}
3+
2module Network.Wai.Middleware.Rewrite
4module 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
3− ( rewrite, rewritePure
34+ , rewritePure
35+
36+ -- * Operating on 'Request's
37+
38+ , rewriteRequest
39+ , rewriteRequestPure
4 ) where
40 ) where
5
41
6import Network.Wai
42import Network.Wai
7import Control.Monad.IO.Class (liftIO)
43import Control.Monad.IO.Class (liftIO)
8import Data.Text (Text)
44import Data.Text (Text)
45+import Data.Functor.Identity (Identity(..))
9import qualified Data.Text.Encoding as TE
46import qualified Data.Text.Encoding as TE
10import qualified Data.Text as T
47import qualified Data.Text as T
11import Network.HTTP.Types as H
48import Network.HTTP.Types as H
12
49
50+-- GHC ≤ 7.10 does not export Applicative functions from the prelude.
51+#if __GLASGOW_HASKELL__ <= 710
52+import Control.Applicative
53+#endif
13
54
14−-- | rewrite based on your own conversion rules
55+-- $howto
15−rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
56+-- This module provides 'Middleware' to rewrite URL paths. It also provides
16−rewrite convert app req = do
57+-- functions that will convert a 'Request' to a modified 'Request'.
17− newPathInfo <- liftIO $ convert (pathInfo req) (requestHeaders req)
58+-- Both operations require a function that takes URL parameters and
18− let rawPInfo = TE.encodeUtf8 $ T.intercalate "/" newPathInfo
59+-- headers, and returns new URL parameters. Parameters are pieces of URL
19− app req { pathInfo = newPathInfo, rawPathInfo = rawPInfo }
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.
20
80
21−-- | rewrite based on your own conversion rules
81+-- $pathsandqueries
22−-- Example convert function:
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
23
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+-- @
24−-- staticConvert :: [Text] -> H.RequestHeaders -> [Text]
176+-- staticConvert' :: [Text] -> H.RequestHeaders -> [Text]
25−-- staticConvert pieces _ = piecesConvert pieces
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
26-- where
188-- where
27-- piecesConvert [] = ["static", "html", "pages.html"]
189-- piecesConvert [] = ["static", "html", "pages.html"]
28-- piecesConvert route@("pages":_) = "static":"html":route
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.
29rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
241rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
30rewritePure convert app req =
242rewritePure 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
31− let pInfo = convert (pathInfo req) (requestHeaders req)
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
32− rawPInfo = TE.encodeUtf8 $ T.intercalate "/" pInfo
323+ let rawPInfo = TE.encodeUtf8 . T.intercalate "/" . pathInfo $ newReq
33− in app req { pathInfo = pInfo, rawPathInfo = rawPInfo }
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.hs+21−7
@@ -1,5 +1,5 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
2−module Network.Wai.Middleware.Vhost (vhost, redirectWWW) where
2+ module Network.Wai.Middleware.Vhost (vhost, redirectWWW, redirectTo, redirectToLogged) where
3
3
4import Network.Wai
4import Network.Wai
5
5
@@ -7,6 +7,9 @@ import Network.HTTP.Types as H
7import qualified Data.Text.Encoding as TE
7import qualified Data.Text.Encoding as TE
8import Data.Text (Text)
8import Data.Text (Text)
9import qualified Data.ByteString as BS
9import qualified Data.ByteString as BS
10+#if __GLASGOW_HASKELL__ < 710
11+import Data.Monoid (mappend)
12+#endif
10
13
11vhost :: [(Request -> Bool, Application)] -> Application -> Application
14vhost :: [(Request -> Bool, Application)] -> Application -> Application
12vhost vhosts def req =
15vhost vhosts def req =
@@ -15,9 +18,20 @@ vhost vhosts def req =
15 (_, app):_ -> app req
18 (_, app):_ -> app req
16
19
17redirectWWW :: Text -> Application -> Application -- W.MiddleWare
20redirectWWW :: Text -> Application -> Application -- W.MiddleWare
18−redirectWWW home app req =
21+redirectWWW home =
19− if BS.isPrefixOf "www" $ serverName req
22+ redirectIf home (maybe True (BS.isPrefixOf "www") . lookup "host" . requestHeaders)
20− then return $ responseLBS H.status301
21− [ ("Content-Type", "text/plain") , ("Location", TE.encodeUtf8 home) ] "Redirect"
22− else app req
23
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.hs+489−186
@@ -1,5 +1,4 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2−{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE ExistentialQuantification #-}
2{-# LANGUAGE ExistentialQuantification #-}
4{-# LANGUAGE PatternGuards #-}
3{-# LANGUAGE PatternGuards #-}
5{-# LANGUAGE TypeFamilies #-}
4{-# LANGUAGE TypeFamilies #-}
@@ -12,7 +11,7 @@ module Network.Wai.Parse
12 , RequestBodyType (..)
11 , RequestBodyType (..)
13 , getRequestBodyType
12 , getRequestBodyType
14 , sinkRequestBody
13 , sinkRequestBody
15− , conduitRequestBody
14+ , sinkRequestBodyEx
16 , BackEnd
15 , BackEnd
17 , lbsBackEnd
16 , lbsBackEnd
18 , tempFileBackEnd
17 , tempFileBackEnd
@@ -21,6 +20,24 @@ module Network.Wai.Parse
21 , File
20 , File
22 , FileInfo (..)
21 , FileInfo (..)
23 , parseContentType
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
24#if TEST
41#if TEST
25 , Bound (..)
42 , Bound (..)
26 , findBound
43 , findBound
@@ -31,31 +48,30 @@ module Network.Wai.Parse
31#endif
48#endif
32 ) where
49 ) where
33
50
34−import qualified Data.ByteString.Search as Search
51+import qualified Control.Exception as E
35import qualified Data.ByteString as S
52import qualified Data.ByteString as S
36import qualified Data.ByteString.Lazy as L
53import qualified Data.ByteString.Lazy as L
37import qualified Data.ByteString.Char8 as S8
54import qualified Data.ByteString.Char8 as S8
38import Data.Word (Word8)
55import Data.Word (Word8)
56+import Data.Int (Int64)
39−import Data.Maybe (fromMaybe)
57+import Data.Maybe (catMaybes, fromMaybe)
40import Data.List (sortBy)
58import Data.List (sortBy)
41−import Data.Function (on)
59+import Data.Function (on, fix)
42import System.Directory (removeFile, getTemporaryDirectory)
60import System.Directory (removeFile, getTemporaryDirectory)
43import System.IO (hClose, openBinaryTempFile)
61import System.IO (hClose, openBinaryTempFile)
62+import System.IO.Error (isDoesNotExistError)
44import Network.Wai
63import Network.Wai
45−import Data.Conduit
46−import Data.Conduit.Internal ()
47−import qualified Data.Conduit.List as CL
48−import qualified Data.Conduit.Binary as CB
49−import Control.Monad.IO.Class (liftIO)
50import qualified Network.HTTP.Types as H
64import qualified Network.HTTP.Types as H
51−import Data.Either (partitionEithers)
65+import Control.Applicative ((<$>))
66+import Control.Exception (catchJust)
52−import Control.Monad (when, unless)
67+import Control.Monad (when, unless, guard)
53−import Control.Monad.Trans.Class (lift)
54−import Control.Monad.Trans.Resource (allocate, release, register)
68+import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
55−#if MIN_VERSION_conduit(1, 0, 0)
69+import Data.IORef
56−import Data.Conduit.Internal (Pipe (NeedInput, HaveOutput), (>+>), withUpstream, injectLeftovers, ConduitM (..))
70+import Network.HTTP.Types (hContentType)
71+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
57−import Data.Void (Void)
72+import Data.CaseInsensitive (mk)
58−#endif
73+
74+import Prelude hiding (lines)
59
75
60breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
76breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
61breakDiscard w s =
77breakDiscard w s =
@@ -87,28 +103,186 @@ parseHttpAccept = map fst
87 _ -> 1.0
103 _ -> 1.0
88
104
89-- | Store uploaded files in memory
105-- | Store uploaded files in memory
90−lbsBackEnd :: Monad m => ignored1 -> ignored2 -> Sink S.ByteString m L.ByteString
106+lbsBackEnd :: Monad m => ignored1 -> ignored2 -> m S.ByteString -> m L.ByteString
91−lbsBackEnd _ _ = fmap L.fromChunks CL.consume
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:)
92
115
93-- | Save uploaded files on disk as temporary files
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.
94−tempFileBackEnd :: MonadResource m => ignored1 -> ignored2 -> Sink S.ByteString m FilePath
121+tempFileBackEnd :: InternalState -> ignored1 -> ignored2 -> IO S.ByteString -> IO FilePath
95tempFileBackEnd = tempFileBackEndOpts getTemporaryDirectory "webenc.buf"
122tempFileBackEnd = tempFileBackEndOpts getTemporaryDirectory "webenc.buf"
96
123
97−-- | Same as 'tempFileSink', but use configurable temp folders and patterns.
124+-- | Same as 'tempFileBackEnd', but use configurable temp folders and patterns.
98−tempFileBackEndOpts :: MonadResource m
99− => IO FilePath -- ^ get temporary directory
125+tempFileBackEndOpts :: IO FilePath -- ^ get temporary directory
100 -> String -- ^ filename pattern
126 -> String -- ^ filename pattern
127+ -> InternalState
101 -> ignored1
128 -> ignored1
102 -> ignored2
129 -> ignored2
103− -> Sink S.ByteString m FilePath
130+ -> IO S.ByteString
131+ -> IO FilePath
104−tempFileBackEndOpts getTmpDir pattern _ _ = do
132+tempFileBackEndOpts getTmpDir pattrn internalState _ _ popper = do
105− (key, (fp, h)) <- lift $ allocate (do
133+ (key, (fp, h)) <- flip runInternalState internalState $ allocate it (hClose . snd)
106− tempDir <- getTmpDir
134+ _ <- runInternalState (register $ removeFileQuiet fp) internalState
107− openBinaryTempFile tempDir pattern) (\(_, h) -> hClose h)
135+ fix $ \loop -> do
108− _ <- lift $ register $ removeFile fp
136+ bs <- popper
109− CB.sinkHandle h
137+ unless (S.null bs) $ do
138+ S.hPut h bs
139+ loop
110− lift $ release key
140+ release key
111 return fp
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 }
112
286
113-- | Information on an uploaded file.
287-- | Information on an uploaded file.
114data FileInfo c = FileInfo
288data FileInfo c = FileInfo
@@ -124,17 +298,26 @@ type Param = (S.ByteString, S.ByteString)
124-- | Post parameter name and associated file information.
298-- | Post parameter name and associated file information.
125type File y = (S.ByteString, FileInfo y)
299type File y = (S.ByteString, FileInfo y)
126
300
127−-- | A file uploading backend. Takes the parameter name, file name, and content
301+-- | A file uploading backend. Takes the parameter name, file name, and a
128−-- type, and returns a `Sink` for storing the contents.
302+-- stream of data.
129type BackEnd a = S.ByteString -- ^ parameter name
303type BackEnd a = S.ByteString -- ^ parameter name
130 -> FileInfo ()
304 -> FileInfo ()
131− -> Sink S.ByteString (ResourceT IO) a
305+ -> IO S.ByteString
132−
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)
133−data RequestBodyType = UrlEncoded | Multipart S.ByteString
315+ Multipart S.ByteString
134−
316+
317+-- | Get the mimetype of the body of an http request.
135getRequestBodyType :: Request -> Maybe RequestBodyType
318getRequestBodyType :: Request -> Maybe RequestBodyType
136getRequestBodyType req = do
319getRequestBodyType req = do
137− ctype' <- lookup "Content-Type" $ requestHeaders req
320+ ctype' <- lookup hContentType $ requestHeaders req
138 let (ctype, attrs) = parseContentType ctype'
321 let (ctype, attrs) = parseContentType ctype'
139 case ctype of
322 case ctype of
140 "application/x-www-form-urlencoded" -> return UrlEncoded
323 "application/x-www-form-urlencoded" -> return UrlEncoded
@@ -144,7 +327,7 @@ getRequestBodyType req = do
144-- | Parse a content type value, turning a single @ByteString@ into the actual
327-- | Parse a content type value, turning a single @ByteString@ into the actual
145-- content type and a list of pairs of attributes.
328-- content type and a list of pairs of attributes.
146--
329--
147−-- Since 1.3.2
330+-- @since 1.3.2
148parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
331parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
149parseContentType a = do
332parseContentType a = do
150 let (ctype, b) = S.break (== semicolon) a
333 let (ctype, b) = S.break (== semicolon) a
@@ -154,6 +337,9 @@ parseContentType a = do
154 semicolon = 59
337 semicolon = 59
155 equals = 61
338 equals = 61
156 space = 32
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
157 goAttrs front bs
343 goAttrs front bs
158 | S.null bs = front []
344 | S.null bs = front []
159 | otherwise =
345 | otherwise =
@@ -162,81 +348,172 @@ parseContentType a = do
162 goAttr bs =
348 goAttr bs =
163 let (k, v') = S.break (== equals) bs
349 let (k, v') = S.break (== equals) bs
164 v = S.drop 1 v'
350 v = S.drop 1 v'
165− in (strip k, strip v)
351+ in (strip k, dq $ strip v)
166 strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
352 strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
167
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.
168parseRequestBody :: BackEnd y
360parseRequestBody :: BackEnd y
169 -> Request
361 -> Request
170− -> ResourceT IO ([Param], [File y])
362+ -> IO ([Param], [File y])
171−parseRequestBody s r =
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 =
172 case getRequestBodyType r of
376 case getRequestBodyType r of
173 Nothing -> return ([], [])
377 Nothing -> return ([], [])
174− Just rbt -> fmap partitionEithers $ requestBody r $$ conduitRequestBody s rbt =$ CL.consume
378+ Just rbt -> sinkRequestBodyEx o s rbt (requestBody r)
175
379
176sinkRequestBody :: BackEnd y
380sinkRequestBody :: BackEnd y
177 -> RequestBodyType
381 -> RequestBodyType
382+ -> IO S.ByteString
178− -> Sink S.ByteString (ResourceT IO) ([Param], [File y])
383+ -> IO ([Param], [File y])
179−sinkRequestBody s r = fmap partitionEithers $ conduitRequestBody s r =$ CL.consume
384+sinkRequestBody = sinkRequestBodyEx noLimitParseRequestBodyOptions
180
385
386+-- |
387+--
388+-- @since 3.0.16.0
389+sinkRequestBodyEx :: ParseRequestBodyOptions
181−conduitRequestBody :: BackEnd y
390+ -> BackEnd y
182− -> RequestBodyType
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
183− -> Conduit S.ByteString (ResourceT IO) (Either Param (File y))
407+ -> (Either Param (File y) -> IO ())
184−conduitRequestBody _ UrlEncoded = do
408+ -> IO ()
409+conduitRequestBodyEx o _ UrlEncoded rbody add = do
185 -- NOTE: in general, url-encoded data will be in a single chunk.
410 -- NOTE: in general, url-encoded data will be in a single chunk.
186 -- Therefore, I'm optimizing for the usual case by sticking with
411 -- Therefore, I'm optimizing for the usual case by sticking with
187 -- strict byte strings here.
412 -- strict byte strings here.
188− bs <- CL.consume
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
189− mapM_ yield $ map Left $ H.parseSimpleQuery $ S.concat bs
425+ mapM_ (add . Left) $ H.parseSimpleQuery bs
190−conduitRequestBody backend (Multipart bound) =
426+conduitRequestBodyEx o backend (Multipart bound) rbody add =
191− parsePieces backend $ S8.pack "--" `S.append` bound
427+ parsePiecesEx o backend (S8.pack "--" `S.append` bound) rbody add
192−
428+
193−#if MIN_VERSION_conduit(1, 0, 0)
429+
194−takeLine :: Monad m => Consumer S.ByteString m (Maybe S.ByteString)
430+-- | Take one header or subheader line.
195−#else
431+-- Since: 3.0.26
432+-- Throw 431 if headers too large.
196−takeLine :: Monad m => Pipe S.ByteString S.ByteString o u m (Maybe S.ByteString)
433+takeLine :: Maybe Int -> Source -> IO (Maybe S.ByteString)
197−#endif
198−takeLine =
434+takeLine maxlen src =
199− go id
435+ go ""
200 where
436 where
201− go front = await >>= maybe (close front) (push front)
437+ go front = do
202−
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+
203− close front = leftover (front S.empty) >> return Nothing
448+ close front = leftover src front >> return Nothing
204 push front bs = do
449 push front bs = do
205− let (x, y) = S.break (== 10) $ front bs -- LF
450+ let (x, y) = S.break (== 10) bs -- LF
206 in if S.null y
451 in if S.null y
207− then go $ S.append x
452+ then go $ front `S.append` x
208 else do
453 else do
209− when (S.length y > 1) $ leftover $ S.drop 1 y
454+ when (S.length y > 1) $ leftover src $ S.drop 1 y
210− return $ Just $ killCR x
455+ let res = front `S.append` x
211−
456+ case maxlen of
212−#if MIN_VERSION_conduit(1, 0, 0)
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+
213−takeLines :: Consumer S.ByteString (ResourceT IO) [S.ByteString]
463+takeLines' :: Maybe Int -> Maybe Int -> Source -> IO [S.ByteString]
214−#else
464+takeLines' lineLength maxLines source =
215−takeLines :: Pipe S.ByteString S.ByteString o u (ResourceT IO) [S.ByteString]
465+ reverse <$> takeLines'' [] lineLength maxLines source
216−#endif
466+
467+takeLines''
468+ :: [S.ByteString]
469+ -> Maybe Int
470+ -> Maybe Int
471+ -> Source
472+ -> IO [S.ByteString]
217−takeLines = do
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 ()
218− res <- takeLine
479+ res <- takeLine lineLength src
219 case res of
480 case res of
220− Nothing -> return []
481+ Nothing -> return lines
221 Just l
482 Just l
222− | S.null l -> return []
483+ | S.null l -> return lines
223− | otherwise -> do
484+ | otherwise -> takeLines'' (l:lines) lineLength maxLines src
224− ls <- takeLines
485+
225− return $ l : ls
486+data Source = Source (IO S.ByteString) (IORef S.ByteString)
226−
487+
227−parsePieces :: BackEnd y
488+mkSource :: IO S.ByteString -> IO Source
489+mkSource f = do
490+ ref <- newIORef S.empty
491+ return $ Source f ref
492+
228− -> S.ByteString
493+readSource :: Source -> IO S.ByteString
229−#if MIN_VERSION_conduit(1, 0, 0)
494+readSource (Source f ref) = do
230− -> ConduitM S.ByteString (Either Param (File y)) (ResourceT IO) ()
495+ bs <- atomicModifyIORef ref $ \bs -> (S.empty, bs)
496+ if S.null bs
497+ then f
231−#else
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
232− -> Pipe S.ByteString S.ByteString (Either Param (File y)) u (ResourceT IO) ()
507+ -> (Either Param (File y) -> IO ())
233−#endif
508+ -> IO ()
234−parsePieces sink bound =
509+parsePiecesEx o sink bound rbody add =
235− loop
510+ mkSource rbody >>= loop 0 0 0 0
236 where
511 where
237− loop = do
512+ loop :: Int -> Int -> Int -> Int64 -> Source -> IO ()
513+ loop numParms numFiles parmSize filesSize src = do
238− _boundLine <- takeLine
514+ _boundLine <- takeLine (prboMaxHeaderLineLength o) src
239− res' <- takeLines
515+ res' <- takeLines' (prboMaxHeaderLineLength o)
516+ (prboMaxHeaderLines o) src
240 unless (null res') $ do
517 unless (null res') $ do
241 let ls' = map parsePair res'
518 let ls' = map parsePair res'
242 let x = do
519 let x = do
@@ -247,31 +524,57 @@ parsePieces sink bound =
247 return (ct, name, lookup "filename" attrs)
524 return (ct, name, lookup "filename" attrs)
248 case x of
525 case x of
249 Just (mct, name, Just filename) -> do
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 ()
250 let ct = fromMaybe "application/octet-stream" mct
536 let ct = fromMaybe "application/octet-stream" mct
251 fi0 = FileInfo filename ct ()
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
252− (wasFound, y) <- sinkTillBound' bound name fi0 sink
541+ ((wasFound, fileSize), y) <- sinkTillBound' bound name fi0 sink src mfs
542+ let newFilesSize = filesSize + fileSize
253− yield $ Right (name, fi0 { fileContent = y })
543+ add $ Right (name, fi0 { fileContent = y })
254− when wasFound loop
544+ when wasFound $ loop numParms (numFiles + 1) parmSize newFilesSize src
255 Just (_ct, name, Nothing) -> do
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 ()
256 let seed = id
551 let seed = id
257 let iter front bs = return $ front . (:) bs
552 let iter front bs = return $ front . (:) bs
258− (wasFound, front) <- sinkTillBound bound iter seed
553+ ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src
554+ (fromIntegral <$> prboMaxParmsSize o)
259 let bs = S.concat $ front []
555 let bs = S.concat $ front []
260 let x' = (name, bs)
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 ()
261− yield $ Left x'
562+ add $ Left x'
262− when wasFound loop
563+ when wasFound $ loop (numParms + 1) numFiles
564+ newParmSize filesSize src
263 _ -> do
565 _ -> do
264 -- ignore this part
566 -- ignore this part
265 let seed = ()
567 let seed = ()
266 iter () _ = return ()
568 iter () _ = return ()
267− (wasFound, ()) <- sinkTillBound bound iter seed
569+ ((wasFound, _fileSize), ()) <- sinkTillBound bound iter seed src Nothing
268− when wasFound loop
570+ when wasFound $ loop numParms numFiles parmSize filesSize src
269 where
571 where
270− contDisp = S8.pack "Content-Disposition"
572+ contDisp = mk $ S8.pack "Content-Disposition"
271− contType = S8.pack "Content-Type"
573+ contType = mk $ S8.pack "Content-Type"
272 parsePair s =
574 parsePair s =
273 let (x, y) = breakDiscard 58 s -- colon
575 let (x, y) = breakDiscard 58 s -- colon
274− in (x, S.dropWhile (== 32) y) -- space
576+ in (mk $ x, S.dropWhile (== 32) y) -- space
577+
275
578
276data Bound = FoundBound S.ByteString S.ByteString
579data Bound = FoundBound S.ByteString S.ByteString
277 | NoBound
580 | NoBound
@@ -279,7 +582,7 @@ data Bound = FoundBound S.ByteString S.ByteString
279 deriving (Eq, Show)
582 deriving (Eq, Show)
280
583
281findBound :: S.ByteString -> S.ByteString -> Bound
584findBound :: S.ByteString -> S.ByteString -> Bound
282−findBound b bs = handleBreak $ Search.breakOn b bs
585+findBound b bs = handleBreak $ S.breakSubstring b bs
283 where
586 where
284 handleBreak (h, t)
587 handleBreak (h, t)
285 | S.null t = go [lowBound..S.length bs - 1]
588 | S.null t = go [lowBound..S.length bs - 1]
@@ -305,90 +608,90 @@ sinkTillBound' :: S.ByteString
305 -> S.ByteString
608 -> S.ByteString
306 -> FileInfo ()
609 -> FileInfo ()
307 -> BackEnd y
610 -> BackEnd y
308−#if MIN_VERSION_conduit(1, 0, 0)
611+ -> Source
309− -> ConduitM S.ByteString o (ResourceT IO) (Bool, y)
612+ -> Maybe Int64
310−#else
613+ -> IO ((Bool, Int64), y)
311− -> Pipe S.ByteString S.ByteString o u (ResourceT IO) (Bool, y)
312−#endif
313−sinkTillBound' bound name fi sink =
614+sinkTillBound' bound name fi sink src max' = do
314−#if MIN_VERSION_conduit(1, 0, 0)
615+ (next, final) <- wrapTillBound bound src max'
315− ConduitM $ anyOutput $
616+ y <- sink name fi next
316−#endif
617+ b <- final
317− conduitTillBound bound >+> withUpstream (fix $ sink name fi)
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)
318 where
630 where
319−#if MIN_VERSION_conduit(1, 0, 0)
631+ final ref sref = do
320− fix :: Sink S8.ByteString (ResourceT IO) y -> Pipe Void S8.ByteString Void Bool (ResourceT IO) y
632+ x <- readIORef ref
321− fix (ConduitM p) = ignoreTerm >+> injectLeftovers p
633+ case x of
322− ignoreTerm = await' >>= maybe (return ()) (\x -> yield' x >> ignoreTerm)
634+ WTBWorking _ -> error "wrapTillBound did not finish"
323− await' = NeedInput (return . Just) (const $ return Nothing)
635+ WTBDone y -> do
324− yield' = HaveOutput (return ()) (return ())
636+ siz <- readIORef sref
325−
637+ return (y, siz)
326− anyOutput p = p >+> dropInput
638+
327− dropInput = NeedInput (const dropInput) return
639+ go ref sref = do
328−#else
640+ state <- readIORef ref
329− fix = sinkToPipe
641+ case state of
330−#endif
642+ WTBDone _ -> return S.empty
331−
643+ WTBWorking front -> do
332−conduitTillBound :: Monad m
644+ bs <- readSource src
333− => S.ByteString -- bound
645+ cur <- atomicModifyIORef' sref $ \ cur ->
334−#if MIN_VERSION_conduit(1, 0, 0)
646+ let new = cur + fromIntegral (S.length bs) in (new, new)
335− -> Pipe S.ByteString S.ByteString S.ByteString () m Bool
647+ case max' of
336−#else
648+ Just max'' | cur > max'' ->
337− -> Pipe S.ByteString S.ByteString S.ByteString u m Bool
649+ E.throwIO $ ConnectionError (UnknownErrorCode 413) "Payload Too Large"
338−#endif
650+ _ -> return ()
339−conduitTillBound bound =
651+ if S.null bs
340−#if MIN_VERSION_conduit(1, 0, 0)
652+ then do
341− unConduitM $
653+ writeIORef ref $ WTBDone False
342−#endif
343− go id
344− where
345− go front = await >>= maybe (close front) (push front)
346− close front = do
347− let bs = front S.empty
348− unless (S.null bs) $ yield bs
349− return False
350− push front bs' = do
654+ return $ front bs
351− let bs = front bs'
655+ else push $ front bs
656+ where
657+ push bs = do
352− case findBound bound bs of
658+ case findBound bound bs of
353− FoundBound before after -> do
659+ FoundBound before after -> do
354− let before' = killCRLF before
660+ let before' = killCRLF before
355− yield before'
356− leftover after
661+ leftover src after
357− return True
662+ writeIORef ref $ WTBDone True
663+ return before'
358− NoBound -> do
664+ NoBound -> do
359− -- don't emit newlines, in case it's part of a bound
665+ -- don't emit newlines, in case it's part of a bound
360− let (toEmit, front') =
666+ let (toEmit, front') =
361− if not (S8.null bs) && S8.last bs `elem` "\r\n"
667+ if not (S8.null bs) && S8.last bs `elem` ['\r','\n']
362− then let (x, y) = S.splitAt (S.length bs - 2) bs
668+ then let (x, y) = S.splitAt (S.length bs - 2) bs
363− in (x, S.append y)
669+ in (x, S.append y)
364− else (bs, id)
670+ else (bs, id)
671+ writeIORef ref $ WTBWorking front'
365− yield toEmit
672+ if S.null toEmit
366− go front'
673+ then go ref sref
674+ else return toEmit
367− PartialBound -> go $ S.append bs
675+ PartialBound -> do
676+ writeIORef ref $ WTBWorking $ S.append bs
677+ go ref sref
368
678
369sinkTillBound :: S.ByteString
679sinkTillBound :: S.ByteString
370 -> (x -> S.ByteString -> IO x)
680 -> (x -> S.ByteString -> IO x)
371 -> x
681 -> x
372−#if MIN_VERSION_conduit(1, 0, 0)
682+ -> Source
373− -> Consumer S.ByteString (ResourceT IO) (Bool, x)
683+ -> Maybe Int64
374−#else
684+ -> IO ((Bool, Int64), x)
375− -> Pipe S.ByteString S.ByteString o u (ResourceT IO) (Bool, x)
376−#endif
377−sinkTillBound bound iter seed0 =
685+sinkTillBound bound iter seed0 src max' = do
378−#if MIN_VERSION_conduit(1, 0, 0)
686+ (next, final) <- wrapTillBound bound src max'
379− ConduitM $
687+ let loop seed = do
380−#endif
688+ bs <- next
381− (conduitTillBound bound >+> (withUpstream $ ij $ CL.foldM iter' seed0))
689+ if S.null bs
382− where
690+ then return seed
383− iter' a b = liftIO $ iter a b
691+ else iter seed bs >>= loop
384−#if MIN_VERSION_conduit(1, 0, 0)
692+ seed <- loop seed0
385− ij (ConduitM p) = ignoreTerm >+> injectLeftovers p
693+ b <- final
386− ignoreTerm = await' >>= maybe (return ()) (\x -> yield' x >> ignoreTerm)
694+ return (b, seed)
387− await' = NeedInput (return . Just) (const $ return Nothing)
388− yield' = HaveOutput (return ()) (return ())
389−#else
390− ij = id
391−#endif
392
695
393parseAttrs :: S.ByteString -> [(S.ByteString, S.ByteString)]
696parseAttrs :: S.ByteString -> [(S.ByteString, S.ByteString)]
394parseAttrs = map go . S.split 59 -- semicolon
697parseAttrs = map go . S.split 59 -- semicolon
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/READMEdeleted−1
@@ -1 +0,0 @@
1−Provides some basic WAI handlers and middleware.
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/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-eventsource/static/index.html → wai-extra/example/index.htmlrenamed+3−2
@@ -1,8 +1,9 @@
1<!doctype html>
1<!doctype html>
2<head>
2<head>
3− <title>Hello</title>
3+ <title>Example</title>
4+ <link rel="icon" href="data:;base64,=">
4</head>
5</head>
5−<h1>Testing</h1>
6+<h1>Testing Server-Sent Events</h1>
6
7
7<div id="output"></div>
8<div id="output"></div>
8
9
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
wai-extra/test/WaiExtraTest.hsdeleted−543
@@ -1,543 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module WaiExtraTest (specs) where
3−
4−import Test.Hspec
5−import Test.HUnit hiding (Test)
6−
7−import Network.Wai
8−import Network.Wai.Test
9−import Network.Wai.Parse
10−import qualified Data.ByteString as S
11−import qualified Data.ByteString.Char8 as S8
12−import qualified Data.ByteString.Lazy.Char8 as L8
13−import qualified Data.ByteString.Lazy as L
14−import qualified Data.Text.Lazy as T
15−import qualified Data.Text as TS
16−import qualified Data.Text.Encoding as TE
17−import Control.Arrow
18−
19−import Network.Wai.Middleware.Jsonp
20−import Network.Wai.Middleware.Gzip
21−import Network.Wai.Middleware.Vhost
22−import Network.Wai.Middleware.Autohead
23−import Network.Wai.Middleware.MethodOverride
24−import Network.Wai.Middleware.MethodOverridePost
25−import Network.Wai.Middleware.AcceptOverride
26−import Network.Wai.Middleware.RequestLogger
27−import Codec.Compression.GZip (decompress)
28−
29−import qualified Data.Conduit as C
30−import qualified Data.Conduit.List as CL
31−import Data.Conduit.Binary (sourceFile)
32−import Control.Monad.IO.Class (liftIO)
33−import Data.Maybe (fromMaybe)
34−import Network.HTTP.Types (parseSimpleQuery, status200)
35−import System.Log.FastLogger
36−
37−import qualified Data.IORef as I
38−
39−specs :: Spec
40−specs = do
41− describe "Network.Wai.Parse" $ do
42− describe "parseContentType" $ do
43− let go (x, y, z) = it (TS.unpack $ TE.decodeUtf8 x) $ parseContentType x `shouldBe` (y, z)
44− mapM_ go
45− [ ("text/plain", "text/plain", [])
46− , ("text/plain; charset=UTF-8 ", "text/plain", [("charset", "UTF-8")])
47− , ("text/plain; charset=UTF-8 ; boundary = foo", "text/plain", [("charset", "UTF-8"), ("boundary", "foo")])
48− ]
49− it "parseQueryString" caseParseQueryString
50− it "parseQueryString with question mark" caseParseQueryStringQM
51− it "parseHttpAccept" caseParseHttpAccept
52− it "parseRequestBody" caseParseRequestBody
53− it "multipart with plus" caseMultipartPlus
54− it "multipart with multiple attributes" caseMultipartAttrs
55− it "urlencoded with plus" caseUrlEncPlus
56− {-
57− , it "findBound" caseFindBound
58− , it "sinkTillBound" caseSinkTillBound
59− , it "killCR" caseKillCR
60− , it "killCRLF" caseKillCRLF
61− , it "takeLine" caseTakeLine
62− -}
63− it "jsonp" caseJsonp
64− it "gzip" caseGzip
65− it "gzip not for MSIE" caseGzipMSIE
66− it "defaultCheckMime" caseDefaultCheckMime
67− it "vhost" caseVhost
68− it "autohead" caseAutohead
69− it "method override" caseMethodOverride
70− it "method override post" caseMethodOverridePost
71− it "accept override" caseAcceptOverride
72− describe "dalvik multipart" $ do
73− it "non-chunked" $ dalvikHelper True
74− it "chunked" $ dalvikHelper False
75− it "debug request body" caseDebugRequestBody
76−
77−caseParseQueryString :: Assertion
78−caseParseQueryString = do
79− let go l r =
80− map (S8.pack *** S8.pack) l @=? parseSimpleQuery (S8.pack r)
81−
82− go [] ""
83− go [("foo", "")] "foo"
84− go [("foo", "bar")] "foo=bar"
85− go [("foo", "bar"), ("baz", "bin")] "foo=bar&baz=bin"
86− go [("%Q", "")] "%Q"
87− go [("%1Q", "")] "%1Q"
88− go [("%1", "")] "%1"
89− go [("/", "")] "%2F"
90− go [("/", "")] "%2f"
91− go [("foo bar", "")] "foo+bar"
92−
93−caseParseQueryStringQM :: Assertion
94−caseParseQueryStringQM = do
95− let go l r =
96− map (S8.pack *** S8.pack) l
97− @=? parseSimpleQuery (S8.pack $ '?' : r)
98−
99− go [] ""
100− go [("foo", "")] "foo"
101− go [("foo", "bar")] "foo=bar"
102− go [("foo", "bar"), ("baz", "bin")] "foo=bar&baz=bin"
103− go [("%Q", "")] "%Q"
104− go [("%1Q", "")] "%1Q"
105− go [("%1", "")] "%1"
106− go [("/", "")] "%2F"
107− go [("/", "")] "%2f"
108− go [("foo bar", "")] "foo+bar"
109−
110−caseParseHttpAccept :: Assertion
111−caseParseHttpAccept = do
112− 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"
113− expected = ["text/html;charset=utf-8", "text/x-c", "text/x-dvi", "text/*", "text/plain"]
114− expected @=? parseHttpAccept input
115−
116−parseRequestBody' :: BackEnd L.ByteString
117− -> SRequest
118− -> C.ResourceT IO ([(S.ByteString, S.ByteString)], [(S.ByteString, FileInfo L.ByteString)])
119−parseRequestBody' sink (SRequest req bod) =
120− case getRequestBodyType req of
121− Nothing -> return ([], [])
122− Just rbt -> CL.sourceList (L.toChunks bod) C.$$ sinkRequestBody sink rbt
123−
124−caseParseRequestBody :: Assertion
125−caseParseRequestBody =
126− C.runResourceT t
127− where
128− content2 = S8.pack $
129− "--AaB03x\n" ++
130− "Content-Disposition: form-data; name=\"document\"; filename=\"b.txt\"\n" ++
131− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
132− "This is a file.\n" ++
133− "It has two lines.\n" ++
134− "--AaB03x\n" ++
135− "Content-Disposition: form-data; name=\"title\"\n" ++
136− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
137− "A File\n" ++
138− "--AaB03x\n" ++
139− "Content-Disposition: form-data; name=\"summary\"\n" ++
140− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
141− "This is my file\n" ++
142− "file test\n" ++
143− "--AaB03x--"
144− 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"
145− t = do
146− let content1 = "foo=bar&baz=bin"
147− let ctype1 = "application/x-www-form-urlencoded"
148− result1 <- parseRequestBody' lbsBackEnd $ toRequest ctype1 content1
149− liftIO $ assertEqual "parsing post x-www-form-urlencoded"
150− (map (S8.pack *** S8.pack) [("foo", "bar"), ("baz", "bin")], [])
151− result1
152−
153− let ctype2 = "multipart/form-data; boundary=AaB03x"
154− result2 <- parseRequestBody' lbsBackEnd $ toRequest ctype2 content2
155− let expectedsmap2 =
156− [ ("title", "A File")
157− , ("summary", "This is my file\nfile test")
158− ]
159− let textPlain = S8.pack $ "text/plain; charset=iso-8859-1"
160− let expectedfile2 =
161− [(S8.pack "document", FileInfo (S8.pack "b.txt") textPlain $ L8.pack
162− "This is a file.\nIt has two lines.")]
163− let expected2 = (map (S8.pack *** S8.pack) expectedsmap2, expectedfile2)
164− liftIO $ assertEqual "parsing post multipart/form-data"
165− expected2
166− result2
167−
168− let ctype3 = "multipart/form-data; boundary=----WebKitFormBoundaryB1pWXPZ6lNr8RiLh"
169− result3 <- parseRequestBody' lbsBackEnd $ toRequest ctype3 content3
170− let expectedsmap3 = []
171− let expectedfile3 = [(S8.pack "yaml", FileInfo (S8.pack "README") (S8.pack "application/octet-stream") $
172− L8.pack "Photo blog using Hack.\n")]
173− let expected3 = (expectedsmap3, expectedfile3)
174− liftIO $ assertEqual "parsing actual post multipart/form-data"
175− expected3
176− result3
177−
178− result2' <- parseRequestBody' lbsBackEnd $ toRequest' ctype2 content2
179− liftIO $ assertEqual "parsing post multipart/form-data 2"
180− expected2
181− result2'
182−
183− result3' <- parseRequestBody' lbsBackEnd $ toRequest' ctype3 content3
184− liftIO $ assertEqual "parsing actual post multipart/form-data 2"
185− expected3
186− result3'
187−
188−caseMultipartPlus :: Assertion
189−caseMultipartPlus = do
190− result <- C.runResourceT $ parseRequestBody' lbsBackEnd $ toRequest ctype content
191− liftIO $ result @?= ([("email", "has+plus")], [])
192− where
193− content = S8.pack $
194− "--AaB03x\n" ++
195− "Content-Disposition: form-data; name=\"email\"\n" ++
196− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
197− "has+plus\n" ++
198− "--AaB03x--"
199− ctype = "multipart/form-data; boundary=AaB03x"
200−
201−caseMultipartAttrs :: Assertion
202−caseMultipartAttrs = do
203− result <- C.runResourceT $ parseRequestBody' lbsBackEnd $ toRequest ctype content
204− liftIO $ result @?= ([("email", "has+plus")], [])
205− where
206− content = S8.pack $
207− "--AaB03x\n" ++
208− "Content-Disposition: form-data; name=\"email\"\n" ++
209− "Content-Type: text/plain; charset=iso-8859-1\n\n" ++
210− "has+plus\n" ++
211− "--AaB03x--"
212− ctype = "multipart/form-data; charset=UTF-8; boundary=AaB03x"
213−
214−caseUrlEncPlus :: Assertion
215−caseUrlEncPlus = do
216− result <- C.runResourceT $ parseRequestBody' lbsBackEnd $ toRequest ctype content
217− liftIO $ result @?= ([("email", "has+plus")], [])
218− where
219− content = S8.pack $ "email=has%2Bplus"
220− ctype = "application/x-www-form-urlencoded"
221−
222−toRequest :: S8.ByteString -> S8.ByteString -> SRequest
223−toRequest ctype content = SRequest defaultRequest
224− { requestHeaders = [("Content-Type", ctype)]
225− , requestMethod = "POST"
226− , rawPathInfo = "/"
227− , rawQueryString = ""
228− , queryString = []
229− } (L.fromChunks [content])
230−
231−toRequest' :: S8.ByteString -> S8.ByteString -> SRequest
232−toRequest' ctype content = SRequest defaultRequest
233− { requestHeaders = [("Content-Type", ctype)]
234− } (L.fromChunks $ map S.singleton $ S.unpack content)
235−
236−{-
237−caseFindBound :: Assertion
238−caseFindBound = do
239− findBound (S8.pack "def") (S8.pack "abcdefghi") @?=
240− FoundBound (S8.pack "abc") (S8.pack "ghi")
241− findBound (S8.pack "def") (S8.pack "ABC") @?= NoBound
242− findBound (S8.pack "def") (S8.pack "abcd") @?= PartialBound
243− findBound (S8.pack "def") (S8.pack "abcdE") @?= NoBound
244− findBound (S8.pack "def") (S8.pack "abcdEdef") @?=
245− FoundBound (S8.pack "abcdE") (S8.pack "")
246−
247−caseSinkTillBound :: Assertion
248−caseSinkTillBound = do
249− let iter () _ = return ()
250− let src = S8.pack "this is some text"
251− bound1 = S8.pack "some"
252− bound2 = S8.pack "some!"
253− let enum = enumList 1 [src]
254− let helper _ _ = return ()
255− (_, res1) <- run_ $ enum $$ sinkTillBound bound1 helper ()
256− res1 @?= True
257− (_, res2) <- run_ $ enum $$ sinkTillBound bound2 helper ()
258− res2 @?= False
259−
260−caseKillCR :: Assertion
261−caseKillCR = do
262− "foo" @=? killCR "foo"
263− "foo" @=? killCR "foo\r"
264− "foo\r\n" @=? killCR "foo\r\n"
265− "foo\r'" @=? killCR "foo\r'"
266−
267−caseKillCRLF :: Assertion
268−caseKillCRLF = do
269− "foo" @=? killCRLF "foo"
270− "foo\r" @=? killCRLF "foo\r"
271− "foo" @=? killCRLF "foo\r\n"
272− "foo\r'" @=? killCRLF "foo\r'"
273− "foo" @=? killCRLF "foo\n"
274−
275−caseTakeLine :: Assertion
276−caseTakeLine = do
277− helper "foo\nbar\nbaz" "foo"
278− helper "foo\r\nbar\nbaz" "foo"
279− helper "foo\nbar\r\nbaz" "foo"
280− helper "foo\rbar\r\nbaz" "foo\rbar"
281− where
282− helper haystack needle = do
283− x <- run_ $ enumList 1 [haystack] $$ takeLine
284− Just needle @=? x
285−-}
286−
287−jsonpApp :: Application
288−jsonpApp = jsonp $ const $ return $ responseLBS
289− status200
290− [("Content-Type", "application/json")]
291− "{\"foo\":\"bar\"}"
292−
293−caseJsonp :: Assertion
294−caseJsonp = flip runSession jsonpApp $ do
295− sres1 <- request defaultRequest
296− { queryString = [("callback", Just "test")]
297− , requestHeaders = [("Accept", "text/javascript")]
298− }
299− assertContentType "text/javascript" sres1
300− assertBody "test({\"foo\":\"bar\"})" sres1
301−
302− sres2 <- request defaultRequest
303− { queryString = [("call_back", Just "test")]
304− , requestHeaders = [("Accept", "text/javascript")]
305− }
306− assertContentType "application/json" sres2
307− assertBody "{\"foo\":\"bar\"}" sres2
308−
309− sres3 <- request defaultRequest
310− { queryString = [("callback", Just "test")]
311− , requestHeaders = [("Accept", "text/html")]
312− }
313− assertContentType "application/json" sres3
314− assertBody "{\"foo\":\"bar\"}" sres3
315−
316−gzipApp :: Application
317−gzipApp = gzip def $ const $ return $ responseLBS status200
318− [("Content-Type", "text/plain")]
319− "test"
320−
321−caseGzip :: Assertion
322−caseGzip = flip runSession gzipApp $ do
323− sres1 <- request defaultRequest
324− { requestHeaders = [("Accept-Encoding", "gzip")]
325− }
326− assertHeader "Content-Encoding" "gzip" sres1
327− liftIO $ decompress (simpleBody sres1) @?= "test"
328−
329− sres2 <- request defaultRequest
330− { requestHeaders = []
331− }
332− assertNoHeader "Content-Encoding" sres2
333− assertBody "test" sres2
334−
335−caseDefaultCheckMime :: Assertion
336−caseDefaultCheckMime = do
337− let go x y = (x, defaultCheckMime x) `shouldBe` (x, y)
338− go "application/json" True
339− go "application/javascript" True
340− go "application/something" False
341− go "text/something" True
342− go "foo/bar" False
343− go "application/json; charset=utf-8" True
344−
345−caseGzipMSIE :: Assertion
346−caseGzipMSIE = flip runSession gzipApp $ do
347− sres1 <- request defaultRequest
348− { requestHeaders =
349− [ ("Accept-Encoding", "gzip")
350− , ("User-Agent", "Mozilla/4.0 (Windows; MSIE 6.0; Windows NT 6.0)")
351− ]
352− }
353− assertNoHeader "Content-Encoding" sres1
354− liftIO $ simpleBody sres1 @?= "test"
355−
356−vhostApp1, vhostApp2, vhostApp :: Application
357−vhostApp1 = const $ return $ responseLBS status200 [] "app1"
358−vhostApp2 = const $ return $ responseLBS status200 [] "app2"
359−vhostApp = vhost
360− [ ((== "foo.com") . serverName, vhostApp1)
361− ]
362− vhostApp2
363−
364−caseVhost :: Assertion
365−caseVhost = flip runSession vhostApp $ do
366− sres1 <- request defaultRequest
367− { serverName = "foo.com"
368− }
369− assertBody "app1" sres1
370−
371− sres2 <- request defaultRequest
372− { serverName = "bar.com"
373− }
374− assertBody "app2" sres2
375−
376−autoheadApp :: Application
377−autoheadApp = autohead $ const $ return $ responseLBS status200
378− [("Foo", "Bar")] "body"
379−
380−caseAutohead :: Assertion
381−caseAutohead = flip runSession autoheadApp $ do
382− sres1 <- request defaultRequest
383− { requestMethod = "GET"
384− }
385− assertHeader "Foo" "Bar" sres1
386− assertBody "body" sres1
387−
388− sres2 <- request defaultRequest
389− { requestMethod = "HEAD"
390− }
391− assertHeader "Foo" "Bar" sres2
392− assertBody "" sres2
393−
394−moApp :: Application
395−moApp = methodOverride $ \req -> return $ responseLBS status200
396− [("Method", requestMethod req)] ""
397−
398−caseMethodOverride :: Assertion
399−caseMethodOverride = flip runSession moApp $ do
400− sres1 <- request defaultRequest
401− { requestMethod = "GET"
402− , queryString = []
403− }
404− assertHeader "Method" "GET" sres1
405−
406− sres2 <- request defaultRequest
407− { requestMethod = "POST"
408− , queryString = []
409− }
410− assertHeader "Method" "POST" sres2
411−
412− sres3 <- request defaultRequest
413− { requestMethod = "POST"
414− , queryString = [("_method", Just "PUT")]
415− }
416− assertHeader "Method" "PUT" sres3
417−
418−mopApp :: Application
419−mopApp = methodOverridePost $ \req -> return $ responseLBS status200 [("Method", requestMethod req)] ""
420−
421−caseMethodOverridePost :: Assertion
422−caseMethodOverridePost = flip runSession mopApp $ do
423−
424− -- Get Request are unmodified
425− sres1 <- let r = toRequest "application/x-www-form-urlencoded" "_method=PUT&foo=bar&baz=bin"
426− s = simpleRequest r
427− m = s { requestMethod = "GET" }
428− b = r { simpleRequest = m }
429− in srequest b
430− assertHeader "Method" "GET" sres1
431−
432− -- Post requests are modified if _method comes first
433− sres2 <- srequest $ toRequest "application/x-www-form-urlencoded" "_method=PUT&foo=bar&baz=bin"
434− assertHeader "Method" "PUT" sres2
435−
436− -- Post requests are unmodified if _method doesn't come first
437− sres3 <- srequest $ toRequest "application/x-www-form-urlencoded" "foo=bar&_method=PUT&baz=bin"
438− assertHeader "Method" "POST" sres3
439−
440− -- Post requests are unmodified if Content-Type header isn't set to "application/x-www-form-urlencoded"
441− sres4 <- srequest $ toRequest "text/html; charset=utf-8" "foo=bar&_method=PUT&baz=bin"
442− assertHeader "Method" "POST" sres4
443−
444−aoApp :: Application
445−aoApp = acceptOverride $ \req -> return $ responseLBS status200
446− [("Accept", fromMaybe "" $ lookup "Accept" $ requestHeaders req)] ""
447−
448−caseAcceptOverride :: Assertion
449−caseAcceptOverride = flip runSession aoApp $ do
450− sres1 <- request defaultRequest
451− { queryString = []
452− , requestHeaders = [("Accept", "foo")]
453− }
454− assertHeader "Accept" "foo" sres1
455−
456− sres2 <- request defaultRequest
457− { queryString = []
458− , requestHeaders = [("Accept", "bar")]
459− }
460− assertHeader "Accept" "bar" sres2
461−
462− sres3 <- request defaultRequest
463− { queryString = [("_accept", Just "baz")]
464− , requestHeaders = [("Accept", "bar")]
465− }
466− assertHeader "Accept" "baz" sres3
467−
468−dalvikHelper :: Bool -> Assertion
469−dalvikHelper includeLength = do
470− let headers' =
471− [ ("content-type", "multipart/form-data;boundary=*****")
472− , ("GATEWAY_INTERFACE", "CGI/1.1")
473− , ("PATH_INFO", "/")
474− , ("QUERY_STRING", "")
475− , ("REMOTE_ADDR", "192.168.1.115")
476− , ("REMOTE_HOST", "ganjizza")
477− , ("REQUEST_URI", "http://192.168.1.115:3000/")
478− , ("REQUEST_METHOD", "POST")
479− , ("HTTP_CONNECTION", "Keep-Alive")
480− , ("HTTP_COOKIE", "_SESSION=fgUGM5J/k6mGAAW+MMXIJZCJHobw/oEbb6T17KQN0p9yNqiXn/m/ACrsnRjiCEgqtG4fogMUDI+jikoFGcwmPjvuD5d+MDz32iXvDdDJsFdsFMfivuey2H+n6IF6yFGD")
481− , ("HTTP_USER_AGENT", "Dalvik/1.1.0 (Linux; U; Android 2.1-update1; sdk Build/ECLAIR)")
482− , ("HTTP_HOST", "192.168.1.115:3000")
483− , ("HTTP_ACCEPT", "*, */*")
484− , ("HTTP_VERSION", "HTTP/1.1")
485− , ("REQUEST_PATH", "/")
486− ]
487− headers
488− | includeLength = ("content-length", "12098") : headers'
489− | otherwise = headers'
490− let request' = defaultRequest
491− { requestHeaders = headers
492− }
493− (params, files) <-
494− case getRequestBodyType request' of
495− Nothing -> return ([], [])
496− Just rbt -> C.runResourceT $ sourceFile "test/requests/dalvik-request"
497− C.$$ sinkRequestBody lbsBackEnd rbt
498− lookup "scannedTime" params @?= Just "1.298590056748E9"
499− lookup "geoLong" params @?= Just "0"
500− lookup "geoLat" params @?= Just "0"
501− length files @?= 1
502−
503−caseDebugRequestBody :: Assertion
504−caseDebugRequestBody = do
505− flip runSession (debugApp postOutput) $ do
506− let req = toRequest "application/x-www-form-urlencoded" "foo=bar&baz=bin"
507− res <- srequest req
508− assertStatus 200 res
509−
510− let qs = "?foo=bar&baz=bin"
511− flip runSession (debugApp $ getOutput params) $ do
512− assertStatus 200 =<< request defaultRequest
513− { requestMethod = "GET"
514− , queryString = map (\(k,v) -> (k, Just v)) params
515− , rawQueryString = qs
516− , requestHeaders = []
517− , rawPathInfo = "/location"
518− }
519− where
520− params = [("foo", "bar"), ("baz", "bin")]
521− -- FIXME change back once we include post parameter output in logging postOutput = T.pack $ "POST \nAccept: \nPOST " ++ (show params)
522− postOutput = T.pack $ "POST /\nAccept: \nStatus: 200 OK. /\n"
523− getOutput params' = T.pack $ "GET /location\nAccept: \nGET " ++ show params' ++ "\nStatus: 200 OK. /location\n"
524−
525− debugApp output' req = do
526− iactual <- liftIO $ I.newIORef []
527− middleware <- liftIO $ mkRequestLogger def
528− { destination = Callback $ \strs -> I.modifyIORef iactual $ (++ strs)
529− , outputFormat = Detailed False
530− }
531− res <- middleware (\_req -> return $ responseLBS status200 [ ] "") req
532− actual <- liftIO $ I.readIORef iactual
533− liftIO $ assertEqual "debug" output $ logsToBs actual
534− return res
535− where
536− output = TE.encodeUtf8 $ T.toStrict output'
537− logsToBs = S.concat . map logToBs
538−
539− logToBs (LB bs) = bs
540− logToBs (LS s) = S8.pack s
541−
542− {-debugApp = debug $ \req -> do-}
543− {-return $ responseLBS status200 [ ] ""-}
wai-extra/test/sample.hs+16−15
@@ -1,25 +1,26 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
1−import Data.ByteString.Char8 (unpack, pack)
3+import Data.ByteString.Char8 (pack)
2import Data.ByteString.Lazy (fromChunks)
4import Data.ByteString.Lazy (fromChunks)
5+import Data.Text ()
6+import Network.HTTP.Types
3import Network.Wai
7import Network.Wai
4−import Network.Wai.Enumerator
5import Network.Wai.Middleware.Gzip
8import Network.Wai.Middleware.Gzip
6import Network.Wai.Middleware.Jsonp
9import Network.Wai.Middleware.Jsonp
7−import Network.Wai.Middleware.CleanPath
10+import Network.Wai.Handler.Warp
8−import Network.Wai.Handler.SimpleServer
9
11
10−app :: [String] -> Application
12+app :: Application
11−app [] _ = return $ Response Status200 [] $ Right $ fromLBS
13+app request = return $ case pathInfo request of
14+ [] -> responseLBS status200 []
12− $ fromChunks $ flip map [1..10000] $ \i -> pack $
15+ $ fromChunks $ flip map [1..10000] $ \i -> pack $ concat
13− concat
14 [ "<p>Just this same paragraph again. "
16 [ "<p>Just this same paragraph again. "
15− , show i
17+ , show (i :: Int)
16 , "</p>"
18 , "</p>"
17 ]
19 ]
18−app ["test.html"] _ = return $ Response Status200 [] $ Left "test.html"
20+ ["test.html"] -> ResponseFile status200 [] "test.html" Nothing
19−app ["json"] _ =return $ Response Status200
21+ ["json"] -> ResponseFile status200 [(hContentType, "application/json")]
20− [(ContentType, pack "application/json")]
21− $ Left "json"
22+ "json" Nothing
22−app _ _ = return $ Response Status404 [] $ Left "../LICENSE"
23+ _ -> ResponseFile status404 [] "../LICENSE" Nothing
23
24
24main :: IO ()
25main :: IO ()
25−main = run 3000 $ jsonp $ gzip $ cleanPath app
26+main = run 3000 $ gzip def $ jsonp app
wai-extra/tests.hsdeleted−5
@@ -1,5 +0,0 @@
1−import Test.Hspec.Monadic
2−import qualified WaiExtraTest
3−
4−main :: IO ()
5−main = hspec WaiExtraTest.specs
wai-extra/wai-extra.cabal+157−38
@@ -1,7 +1,69 @@
1Name: wai-extra
1Name: wai-extra
2−Version: 1.3.4.1
2+Version: 3.0.29.1
3Synopsis: Provides some basic WAI handlers and middleware.
3Synopsis: Provides some basic WAI handlers and middleware.
4−Description: The goal here is to provide common features without many dependencies.
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+
5License: MIT
67License: MIT
6License-file: LICENSE
68License-file: LICENSE
7Author: Michael Snoyman
69Author: Michael Snoyman
@@ -9,84 +71,141 @@ Maintainer: michael@snoyman.com
9Homepage: http://github.com/yesodweb/wai
71Homepage: http://github.com/yesodweb/wai
10Category: Web
72Category: Web
11Build-Type: Simple
73Build-Type: Simple
12−Cabal-Version: >=1.8
74+Cabal-Version: >=1.10
13Stability: Stable
75Stability: Stable
14extra-source-files:
76extra-source-files:
15− tests.hs
16 test/requests/dalvik-request
77 test/requests/dalvik-request
17 test/json
78 test/json
18 test/test.html
79 test/test.html
19 test/sample.hs
80 test/sample.hs
20− test/WaiExtraTest.hs
81+ ChangeLog.md
82+ README.md
83+
84+flag build-example
85+ description: Build example executable.
86+ manual: True
87+ default: False
21
88
22Library
89Library
23− Build-Depends: base >= 4 && < 5
90+ Build-Depends: base >= 4.8 && < 5
24− , bytestring >= 0.9.1.4
91+ , bytestring >= 0.10.4
25− , wai >= 1.3 && < 1.5
92+ , wai >= 3.0.3.0 && < 3.3
26 , old-locale >= 1.0.0.2 && < 1.1
93 , old-locale >= 1.0.0.2 && < 1.1
27 , time >= 1.1.4
94 , time >= 1.1.4
28− , network >= 2.2.1.5
95+ , network >= 2.6.1.0
29 , directory >= 1.0.1
96 , directory >= 1.0.1
30− , transformers >= 0.2.2 && < 0.4
97+ , transformers >= 0.2.2
31− , blaze-builder >= 0.2.1.4 && < 0.4
32 , http-types >= 0.7
98 , http-types >= 0.7
33− , text >= 0.7 && < 0.12
99+ , text >= 0.7
34 , case-insensitive >= 0.2
100 , case-insensitive >= 0.2
35− , data-default
101+ , data-default-class
36− , date-cache >= 0.3 && < 0.4
37− , fast-logger >= 0.2 && < 0.4
102+ , fast-logger >= 2.4.5
38− , wai-logger >= 0.2 && < 0.4
103+ , wai-logger >= 2.3.2
39− , conduit >= 0.5 && < 1.1
40− , zlib-conduit >= 0.5 && < 1.1
41− , blaze-builder-conduit >= 0.5 && < 1.1
42 , ansi-terminal
104 , ansi-terminal
43− , resourcet >= 0.3 && < 0.5
105+ , resourcet >= 0.4.6 && < 1.3
44 , void >= 0.5
106 , void >= 0.5
45− , stringsearch >= 0.3 && < 0.4
46 , containers
107 , containers
47 , base64-bytestring
108 , base64-bytestring
48 , word8
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
49
126
50 Exposed-modules: Network.Wai.Handler.CGI
127 Exposed-modules: Network.Wai.Handler.CGI
128+ Network.Wai.Handler.SCGI
129+ Network.Wai.Header
51 Network.Wai.Middleware.AcceptOverride
130 Network.Wai.Middleware.AcceptOverride
131+ Network.Wai.Middleware.AddHeaders
132+ Network.Wai.Middleware.Approot
52 Network.Wai.Middleware.Autohead
133 Network.Wai.Middleware.Autohead
53 Network.Wai.Middleware.CleanPath
134 Network.Wai.Middleware.CleanPath
135+ Network.Wai.Middleware.Local
54 Network.Wai.Middleware.RequestLogger
136 Network.Wai.Middleware.RequestLogger
137+ Network.Wai.Middleware.RequestLogger.JSON
55 Network.Wai.Middleware.Gzip
138 Network.Wai.Middleware.Gzip
56 Network.Wai.Middleware.Jsonp
139 Network.Wai.Middleware.Jsonp
57 Network.Wai.Middleware.MethodOverride
140 Network.Wai.Middleware.MethodOverride
58 Network.Wai.Middleware.MethodOverridePost
141 Network.Wai.Middleware.MethodOverridePost
59 Network.Wai.Middleware.Rewrite
142 Network.Wai.Middleware.Rewrite
143+ Network.Wai.Middleware.StripHeaders
60 Network.Wai.Middleware.Vhost
144 Network.Wai.Middleware.Vhost
61 Network.Wai.Middleware.HttpAuth
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
62 Network.Wai.Parse
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
63 ghc-options: -Wall
160 ghc-options: -Wall
64
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
65
177
66−test-suite tests
178+test-suite spec
67− hs-source-dirs: test
68− main-is: ../tests.hs
69− type: exitcode-stdio-1.0
179+ type: exitcode-stdio-1.0
70−
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
71 build-depends: base >= 4 && < 5
191 build-depends: base >= 4 && < 5
72 , wai-extra
192 , wai-extra
73− , wai-test >= 1.3
74− , hspec >= 1.3
75− , HUnit
76−
77 , wai
193 , wai
78− , http-types
194+ , hspec >= 1.3
79 , transformers
195 , transformers
196+ , fast-logger
197+ , http-types
80 , zlib
198 , zlib
81 , text
199 , text
200+ , resourcet
82 , bytestring
201 , bytestring
83− , directory
202+ , HUnit
84− , zlib-bindings
203+ , cookie
85− , blaze-builder >= 0.2.1.4 && < 0.4
204+ , time
86− , data-default
205+ , case-insensitive
87− , conduit
206+ , http2
88− , fast-logger
89− ghc-options: -Wall
207+ ghc-options: -Wall
208+ default-language: Haskell2010
90
209
91source-repository head
210source-repository head
92 type: git
211 type: git
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/Network/Wai/Frontend/MonadCGI.hs+7−8
@@ -10,8 +10,6 @@ import Network.HTTP.Types (Status (..))
10import Control.Monad.IO.Class (liftIO)
10import Control.Monad.IO.Class (liftIO)
11import Data.CaseInsensitive (original)
11import Data.CaseInsensitive (original)
12
12
13−import Data.Conduit.Lazy (lazyConsume)
14−
15import qualified Data.Map as Map
13import qualified Data.Map as Map
16import qualified Data.ByteString.Lazy as BS
14import qualified Data.ByteString.Lazy as BS
17import qualified Data.ByteString.Char8 as S8
15import qualified Data.ByteString.Char8 as S8
@@ -32,8 +30,8 @@ cgiToAppGeneric :: Monad m
32 => (m (Headers, CGIResult) -> IO (Headers, CGIResult))
30 => (m (Headers, CGIResult) -> IO (Headers, CGIResult))
33 -> CGIT m CGIResult
31 -> CGIT m CGIResult
34 -> Application
32 -> Application
35−cgiToAppGeneric toIO cgi env = do
33+cgiToAppGeneric toIO cgi env sendResponse = do
36− input <- fmap BS.fromChunks $ lazyConsume $ requestBody env
34+ input <- lazyRequestBody env
37 let vars = map (first fixVarName . go) (requestHeaders env)
35 let vars = map (first fixVarName . go) (requestHeaders env)
38 ++ getCgiVars env
36 ++ getCgiVars env
39 (inputs, body') = decodeInput vars input
37 (inputs, body') = decodeInput vars input
@@ -51,7 +49,7 @@ cgiToAppGeneric toIO cgi env = do
51 let status' = case lookup (fromString "Status") headers' of
49 let status' = case lookup (fromString "Status") headers' of
52 Nothing -> 200
50 Nothing -> 200
53 Just s -> safeRead 200 $ S8.unpack s
51 Just s -> safeRead 200 $ S8.unpack s
54− return $ responseLBS (Status status' S8.empty) headers' output
52+ sendResponse $ responseLBS (Status status' S8.empty) headers' output
55 where
53 where
56 go (x, y) = (S8.unpack $ original x, S8.unpack y)
54 go (x, y) = (S8.unpack $ original x, S8.unpack y)
57
55
@@ -66,7 +64,8 @@ getCgiVars :: Request -> [(String, String)]
66getCgiVars e =
64getCgiVars e =
67 [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
65 [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
68 , ("REQUEST_METHOD", show $ requestMethod e)
66 , ("REQUEST_METHOD", show $ requestMethod e)
67+ , ("QUERY_STRING",
69− , ("QUERY_STRING", S8.unpack $ rawQueryString e)
68+ case S8.unpack $ rawQueryString e of
70− , ("SERVER_NAME", S8.unpack $ serverName e)
69+ '?':rest -> rest
71− , ("SERVER_PORT", show $ serverPort e)
70+ x -> x)
72 ]
71 ]
wai-frontend-monadcgi/READMEdeleted−1
@@ -1 +0,0 @@
1−Run CGI apps on WAI handlers.
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/wai-frontend-monadcgi.cabal+4−4
@@ -1,26 +1,26 @@
1name: wai-frontend-monadcgi
1name: wai-frontend-monadcgi
2−version: 1.3.0.2
2+version: 3.0.0.3
3license: MIT
3license: MIT
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>
5author: Michael Snoyman <michael@snoyman.com>
6maintainer: Michael Snoyman <michael@snoyman.com>
6maintainer: Michael Snoyman <michael@snoyman.com>
7synopsis: Run CGI apps on WAI.
7synopsis: Run CGI apps on WAI.
8−description: Allows programs written against MonadCGI to run with any WAI handler. This is most useful for running your existing CGI apps on Warp. For true "yo dawg"-ness, try running this through the WAI CGI backend.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-frontend-monadcgi>.
9category: Web
9category: Web
10stability: stable
10stability: stable
11cabal-version: >= 1.6
11cabal-version: >= 1.6
12build-type: Simple
12build-type: Simple
13+extra-source-files: README.md ChangeLog.md
13
14
14library
15library
15 build-depends: base >= 4 && < 5
16 build-depends: base >= 4 && < 5
16 , bytestring
17 , bytestring
17 , containers >= 0.2
18 , containers >= 0.2
18 , cgi
19 , cgi
19− , conduit >= 0.5 && < 1.1
20 , http-types
20 , http-types
21 , transformers
21 , transformers
22 , case-insensitive
22 , case-insensitive
23− , wai >= 1.3 && < 1.5
23+ , wai >= 3.0 && < 3.3
24 exposed-modules: Network.Wai.Frontend.MonadCGI
24 exposed-modules: Network.Wai.Frontend.MonadCGI
25 ghc-options: -Wall
25 ghc-options: -Wall
26
26
wai-handler-devel/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -optP-include -optPdist/build/autogen/cabal_macros.h
wai-handler-devel/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−*.swp
2−/dist/
wai-handler-devel/FullApp.hsdeleted−47
@@ -1,47 +0,0 @@
1−{-# LANGUAGE QuasiQuotes, TypeFamilies, GeneralizedNewtypeDeriving, GADTs #-}
2−{-# LANGUAGE TemplateHaskell #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−module FullApp (fullApp) where
6−
7−import Network.Wai
8−import Network.HTTP.Types
9−import Data.ByteString.Lazy.Char8 (pack)
10−import Database.Persist.TH
11−import Database.Persist.Sqlite
12−import System.Directory
13−import Control.Monad (when)
14−import Text.Hamlet
15−import Text.Blaze.Html.Renderer.Utf8 (renderHtml)
16−import Data.Text.Lazy.Encoding (encodeUtf16LE)
17−import Control.Monad.Trans.Resource (runResourceT)
18−import Control.Monad.IO.Class (liftIO)
19−
20−share [mkPersist sqlSettings, mkMigrate "migrateAll"] [persist|
21−Dummy
22− dummy String
23−|]
24−
25−fullApp :: (Application -> IO ()) -> IO ()
26−fullApp handler = do
27− putStrLn "testApp called, this should happen only once per reload"
28− -- Swap between the following two lines as necessary to generate errors
29− exi <- doesFileExist "db"
30− --let exi = True
31− when exi $ removeFile "db"
32− withSqlitePool "db" 10 $ \pool -> do
33− flip runSqlPool pool $ runMigration migrateAll
34− handler $ \req -> do
35− if pathInfo req == ["favicon.ico"]
36− then return $ responseLBS status301 [("Location", "http://www.yesodweb.com/favicon.ico")]
37− $ pack ""
38− else do
39− liftIO $ print (pathInfo req)
40− x <- runResourceT $ flip runSqlPool pool $ do
41− _ <- insert (Dummy "")
42− count ([] :: [Filter Dummy])
43− return $ responseLBS status200
44− [("Content-Type", "text/html; charset=utf-8")] $
45− renderHtml
46− $(shamletFile "hamlet/testapp.hamlet")
47− putStrLn "handler completed, this should only happen at the beginning of a reload"
wai-handler-devel/LICENSEdeleted−20
@@ -1,20 +0,0 @@
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-handler-devel/Network/Wai/Application/Devel.hsdeleted−59
@@ -1,59 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Network.Wai.Application.Devel
3− ( -- * Types
4− AppHolder
5− , AppRunner
6− , WithAppRunner
7− -- * Functions
8− , initAppHolder
9− , swapApp
10− , swapAppSimple
11− , toApp
12− ) where
13−
14−import Control.Concurrent (forkIO)
15−import Control.Concurrent.MVar
16− ( MVar, newEmptyMVar, newMVar
17− , takeMVar, putMVar, readMVar
18− )
19−import Network.Wai (Application, responseLBS)
20−import Network.HTTP.Types (status500)
21−import Data.ByteString.Lazy.Char8 ()
22−import Control.Monad.IO.Class (liftIO)
23−
24−type AppHolder = MVar (Application, MVar ())
25−type AppRunner = Application -> IO ()
26−type WithAppRunner = AppRunner -> IO ()
27−
28−initAppHolder :: IO AppHolder
29−initAppHolder = do
30− flag <- newEmptyMVar
31− newMVar (initApp, flag)
32− where
33− initApp _ = return
34− $ responseLBS status500 [("Content-Type", "text/plain")]
35− $ "No app has yet been loaded"
36−
37−swapAppSimple :: Application -> AppHolder -> IO ()
38−swapAppSimple app =
39− swapApp war
40− where
41− war f = f app
42−
43−swapApp :: WithAppRunner -> AppHolder -> IO ()
44−swapApp war ah = void $ forkIO $ war $ \app -> do
45− (_, oldFlag) <- takeMVar ah
46− -- allow the old app to cleanup
47− putMVar oldFlag ()
48− -- now place the new app into the AppHolder, waiting for a termination
49− -- signal
50− flag <- newEmptyMVar
51− putMVar ah (app, flag)
52− takeMVar flag -- this causes execution to hang until we are terminated
53− where
54− void x = x >> return ()
55−
56−toApp :: AppHolder -> Application
57−toApp ah req = do
58− (app, _) <- liftIO $ readMVar ah
59− app req
wai-handler-devel/Network/Wai/Handler/DevelServer.hsdeleted−215
@@ -1,215 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE FlexibleContexts #-}
3−{-# LANGUAGE OverloadedStrings #-}
4−{-# LANGUAGE FlexibleInstances #-}
5−module Network.Wai.Handler.DevelServer
6− ( run
7− , runQuit
8− , runNoWatch
9− , runWithReloadActions
10− , runQuitWithReloadActions
11− ) where
12−
13−import Language.Haskell.Interpreter hiding (typeOf)
14−import Network.Wai
15−import Network.HTTP.Types (status200)
16−
17−import Data.Text.Lazy (pack)
18−import Data.Text.Lazy.Encoding (encodeUtf8)
19−import qualified Data.ByteString.Lazy.Char8 as L8
20−import Control.Exception (Exception, SomeException, toException, fromException, finally, mask)
21−import qualified Control.Exception as E
22−import Control.Concurrent (ThreadId, myThreadId, threadDelay, killThread)
23−import qualified Control.Concurrent as Concurrent
24−
25−import Data.Maybe
26−import Control.Monad
27−import Control.Concurrent.MVar
28−
29−import qualified Network.Wai.Handler.Warp as Warp
30−import Network.Wai.Application.Devel
31−import Network.Wai.Middleware.RequestLogger (logStdoutDev)
32−
33−import Data.List (nub, group, sort)
34−
35−import Network.Wai.Handler.DevelServer.Compat
36−
37−type FunctionName = String
38−
39−runNoWatch :: Int -> ModuleName -> FunctionName
40− -> (FilePath -> IO [FilePath]) -> IO ()
41−runNoWatch port modu func extras = do
42− ah <- initAppHolder
43− _ <- reload modu func extras Nothing ah []
44− Warp.run port $ toApp ah
45−
46−runQuit :: Int -> ModuleName -> FunctionName -> (FilePath -> IO [FilePath])
47− -> IO ()
48−runQuit port modu func extras = runQuitWithReloadActions port modu func extras []
49−
50−-- |
51−-- A version of `Concurrent.forkIO` that re-throws any uncaught
52−-- `E.UserInterrupt` from the child thread in the parent thread.
53−--
54−-- We need this because using hint (or the GHC API) causes @UserInterrupt@ to
55−-- occur in the thread that runs `runInterpreter` instead of the main thread.
56−forkIO :: IO () -> IO ThreadId
57−forkIO action = do
58− threadId <- myThreadId
59− Concurrent.forkIO (action `E.catch` \e -> case e of
60− E.UserInterrupt -> E.throwTo threadId e
61− _ -> E.throwIO e
62− )
63−
64−runQuitWithReloadActions :: Int -> ModuleName -> FunctionName -> (FilePath -> IO [FilePath])
65− -> [IO (IO ())] -> IO ()
66−runQuitWithReloadActions port modu func extras actions = do
67− sig <- newEmptyMVar
68− mask $ \unmask -> do
69− threadId <- forkIO $ runWithReloadActions port modu func extras (Just sig) actions
70− unmask (go sig) `finally` killThread threadId
71− where
72− go sig = do
73− x <- getLine
74− case x of
75− 'q':_ -> putStrLn "Quitting, goodbye!"
76− 'r':_ -> do
77− putStrLn "Forcing reinterpretation"
78− _ <- tryPutMVar sig ()
79− go sig
80− _ -> go sig
81−
82−runWithReloadActions :: Int -> ModuleName -> FunctionName -> (FilePath -> IO [FilePath])
83− -> Maybe (MVar ()) -> [IO (IO ())] -> IO ()
84−runWithReloadActions port modu func extras msig initActions = do
85− actions <- mapM id initActions
86− ah <- initAppHolder
87− mask $ \unmask -> do
88− threadId <- forkIO $ fillApp modu func extras ah msig actions
89− unmask (Warp.run port $ toApp ah) `finally` killThread threadId
90−
91−run :: Int -> ModuleName -> FunctionName -> (FilePath -> IO [FilePath]) -> Maybe (MVar ())
92− -> IO ()
93−run port modu func extras msig = runWithReloadActions port modu func extras msig []
94−
95−{-
96−startApp :: Queue -> Handler -> IO ()
97−startApp queue withApp = do
98− forkIO (withApp go) >> return ()
99− where
100− go app = do
101− msession <- C.readChan queue
102− case msession of
103− Nothing -> return ()
104− Just (req, onRes) -> do
105− void $ forkIO $ (E.handle onErr $ app req) >>= onRes
106− go app
107− onErr :: SomeException -> IO Response
108− onErr e = return
109− $ responseLBS
110− status500
111− [("Content-Type", "text/plain; charset=utf-8")]
112− $ charsToLBS
113− $ "Exception thrown while running application\n\n" ++ show e
114− void x = x >> return ()
115−-}
116−
117−getTimes :: [FilePath] -> IO [TimeStamp]
118−getTimes = E.handle (constSE $ return []) . mapM getTimeStamp
119−
120−constSE :: x -> SomeException -> x
121−constSE = const
122−
123−fillApp :: String -> String
124− -> (FilePath -> IO [FilePath]) -> AppHolder -> Maybe (MVar ()) -> [IO ()] -> IO ()
125−fillApp modu func dirs ah msig actions =
126− go Nothing []
127− where
128− go prevError prevFiles = do
129− forceReload <- maybe (return False) (fmap isJust . tryTakeMVar) msig
130− toReload <-
131− if forceReload || null prevFiles
132− then return True
133− else do
134− times <- getTimes $ map fst prevFiles
135− return $ times /= map snd prevFiles
136− (newError, newFiles) <-
137− if toReload
138− then reload modu func dirs prevError ah actions
139− else return (prevError, prevFiles)
140− threadDelay 1000000
141− go newError newFiles
142−
143−reload :: String -> String
144− -> (FilePath -> IO [FilePath])
145− -> Maybe SomeException
146− -> AppHolder
147− -> [IO ()]
148− -> IO (Maybe SomeException, [(FilePath, TimeStamp)])
149−reload modu func extras prevError ah actions = do
150− case prevError of
151− Nothing -> putStrLn "Attempting to interpret your app..."
152− _ -> return ()
153− loadingApp' prevError ah
154− res <- theapp modu func
155− case res of
156− Left err -> do
157− when (show (Just err) /= show prevError) $
158− putStrLn $ "Compile failed: " ++ showInterpError err
159− loadingApp' (Just $ toException err) ah
160− return (Just $ toException err, [])
161− Right (app, files') -> E.handle onInitErr $ do
162− files'' <- mapM extras files'
163− let files = map head $ group $ sort $ concat $ files' : files''
164− putStrLn "Interpreting success, new app loaded"
165− E.handle onInitErr $ do
166− swapApp (\f -> app $ f . logStdoutDev) ah
167− times <- getTimes files
168− sequence_ actions
169− return (Nothing, zip files times)
170− where
171− onInitErr e = do
172− putStrLn $ "Error initializing application: " ++ show e
173− loadingApp' (Just e) ah
174− return (Just e, [])
175−
176−showInterpError :: InterpreterError -> String
177−showInterpError (WontCompile errs) =
178− concat . nub $ map (\(GhcError msg) -> '\n':'\n':msg) errs
179−showInterpError err = show err
180−
181−loadingApp' :: Maybe SomeException -> AppHolder -> IO ()
182−loadingApp' err = swapApp (loadingApp err)
183−
184−loadingApp :: Maybe SomeException -> Handler
185−loadingApp err f =
186− f $ const $ return $ responseLBS status200
187− ( ("Content-Type", "text/plain")
188− : case err of
189− Nothing -> [("Refresh", "1")]
190− Just _ -> []
191− ) $ toMessage err
192− where
193− toMessage Nothing = "Loading code changes, please wait"
194− toMessage (Just err') = charsToLBS $ "Error loading code: " ++
195− (case fromException err' of
196− Just e -> showInterpError e
197− Nothing -> show err')
198−
199−charsToLBS :: String -> L8.ByteString
200−charsToLBS = encodeUtf8 . pack
201−
202−type Handler = (Application -> IO ()) -> IO ()
203−
204−theapp :: String -> String -> IO (Either InterpreterError (Handler, [FilePath]))
205−theapp modu func =
206− runInterpreter $ do
207− loadModules [modu]
208− mods <- getLoadedModules
209− setImports ["Prelude", "Network.Wai", "Data.ByteString.Internal", "Control.Monad.Trans.Resource", modu]
210− app <- interpret func infer
211− return (app, map toFile mods)
212− where
213− toFile s = map toSlash s ++ ".hs"
214− toSlash '.' = '/'
215− toSlash c = c
wai-handler-devel/Network/Wai/Handler/DevelServer/Compat.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−module Network.Wai.Handler.DevelServer.Compat (
3− TimeStamp
4−, getTimeStamp
5−) where
6−
7−import System.Directory (getModificationTime)
8−
9−#if MIN_VERSION_directory(1,2,0)
10−import Data.Time.Clock (UTCTime)
11−newtype TimeStamp = TimeStamp UTCTime
12−#else
13−import System.Time (ClockTime)
14−newtype TimeStamp = TimeStamp ClockTime
15−#endif
16− deriving Eq
17−
18−getTimeStamp :: FilePath -> IO TimeStamp
19−getTimeStamp = fmap TimeStamp . getModificationTime
wai-handler-devel/READMEdeleted

No changes to the content.

wai-handler-devel/Setup.lhsdeleted−11
@@ -1,11 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−> import System.Cmd (system)
6−
7−> main :: IO ()
8−> main = defaultMainWithHooks (simpleUserHooks { runTests = runTests' })
9−
10−> runTests' :: a -> b -> c -> d -> IO ()
11−> runTests' _ _ _ _ = system "runhaskell -DTEST runtests.hs" >> return ()
wai-handler-devel/SmallApp.hsdeleted−12
@@ -1,12 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module SmallApp where
3−
4−import Network.Wai
5−import Network.HTTP.Types
6−import Data.ByteString.Lazy.Char8 ()
7−
8−testapp' :: Application
9−testapp' _ = return $ responseLBS status200 [("Content-Type", "text/html")] "test"
10−
11−smallApp :: (Application -> IO ()) -> IO ()
12−smallApp f = f testapp'
wai-handler-devel/hamlet/testapp.hamletdeleted−9
@@ -1,9 +0,0 @@
1−$doctype 5
2−<html>
3− <head>
4− <meta charset=utf-8>
5− <title>Full App
6− <body>
7− <h1>Hello World
8− <p>Counter: #{show x}
9− <p>שלום
wai-handler-devel/run-fullapp.hsdeleted−4
@@ -1,4 +0,0 @@
1−import Network.Wai.Handler.DevelServer (runQuit)
2−
3−main :: IO ()
4−main = runQuit 3000 "FullApp" "fullApp" (const $ return ["hamlet/testapp.hamlet"])
wai-handler-devel/run-onreloadapp.hsdeleted−23
@@ -1,23 +0,0 @@
1−
2−import Network.Wai.Handler.DevelServer (runQuitWithReloadActions)
3−import System.Directory(findExecutable)
4−import System.Process(readProcess)
5−
6−main :: IO ()
7−main = runQuitWithReloadActions 4000 "SmallApp" "smallApp" (const $ return []) [browserRefresh]
8−
9−browserRefresh :: IO (IO ())
10−browserRefresh = do
11− exe <- findExecutable "xdotool"
12− case exe of
13− Nothing -> do
14− putStrLn "Install xdotool for automatic browser refresh"
15− return $ return ()
16− Just xdotool -> do
17− putStrLn "Please click on the browser window..."
18− pid <- readProcess xdotool ["selectwindow"] ""
19− return $ do
20− current <- readProcess xdotool ["getwindowfocus"] ""
21− let cmds = ["windowfocus", pid, "key", "F5", "windowfocus", current]
22− _ <- readProcess xdotool cmds ""
23− return ()
wai-handler-devel/run-smallapp.hsdeleted−6
@@ -1,6 +0,0 @@
1−import Network.Wai.Handler.DevelServer (runQuit)
2−
3−main :: IO ()
4−main = do
5− putStrLn "http://localhost:3000"
6− runQuit 3000 "SmallApp" "smallApp" (const $ return [])
wai-handler-devel/wai-handler-devel-unwatched.hsdeleted−27
@@ -1,27 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−import Network.Wai.Handler.DevelServer (runNoWatch)
3−import System.Console.CmdArgs
4−import Control.Concurrent (forkIO)
5−
6−data Devel = Devel
7− { port :: Int
8− , moduleName :: String
9− , function :: String
10− }
11− deriving (Show, Data, Typeable)
12−
13−main :: IO ()
14−main = do
15− Devel p m f <- cmdArgs Devel
16− { port = 3000 &= argPos 0 &= typ "PORT"
17− , moduleName = "" &= argPos 1 &= typ "MODULE"
18− , function = "" &= argPos 2 &= typ "FUNCTION"
19− } &= summary "WAI development web server"
20− _ <- forkIO $ runNoWatch p m f $ const $ return []
21− go
22− where
23− go = do
24− x <- getLine
25− case x of
26− 'q':_ -> putStrLn "Quitting, goodbye!"
27− _ -> go
wai-handler-devel/wai-handler-devel.cabaldeleted−51
@@ -1,51 +0,0 @@
1−Name: wai-handler-devel
2−Version: 1.3.0.6
3−Synopsis: WAI server that automatically reloads code after modification.
4−Description: This handler automatically reloads your source code upon any changes. It works by using the hint package, essentially embedding GHC inside the handler. The handler (both the executable and library) takes three arguments: the port to listen on, the module name containing the application function, and the name of the function.
5− .
6− One major note: the type of the application is most likely not what you expect. A common case for WAI applications is having a withApplication function, and this library assumes this is the case. Therefore, the type signature of your application function must be:
7− .
8− > withYourApp :: (Application -> IO ()) -> IO ()
9−License: MIT
10−License-file: LICENSE
11−Author: Michael Snoyman
12−Maintainer: michael@snoyman.com
13−Homepage: http://github.com/yesodweb/wai
14−Category: Web
15−Build-Type: Simple
16−Cabal-Version: >=1.6
17−Stability: Stable
18−
19−Source-repository head
20− type: git
21− location: git://github.com/yesodweb/wai.git
22−
23−Library
24− Build-Depends: base >= 4 && < 5
25− , wai >= 1.3 && < 1.5
26− , wai-extra >= 1.3 && < 1.4
27− , http-types >= 0.7
28− , warp >= 1.3 && < 1.4
29− , directory >= 1.0.1
30− , network >= 2.2.1.5
31− , bytestring >= 0.9.1.4
32− , hint >= 0.3.2.3 && < 0.4
33− , text >= 0.7
34− , old-time
35− , time
36− , transformers >= 0.2.2
37− , attoparsec >= 0.10
38− Exposed-modules: Network.Wai.Handler.DevelServer
39− Network.Wai.Application.Devel
40− Other-modules: Network.Wai.Handler.DevelServer.Compat
41− ghc-options: -Wall
42−
43−Executable wai-handler-devel
44− Build-Depends: cmdargs >= 0.4
45− ghc-options: -Wall -threaded
46− main-is: wai-handler-devel.hs
47−
48−Executable wai-handler-devel-unwatched
49− Build-Depends: cmdargs >= 0.4
50− ghc-options: -Wall -threaded
51− main-is: wai-handler-devel-unwatched.hs
wai-handler-devel/wai-handler-devel.hsdeleted−63
@@ -1,63 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE OverloadedStrings #-}
3−import Network.Wai.Handler.DevelServer (runQuit)
4−import System.Console.CmdArgs
5−import qualified Data.Attoparsec.Text.Lazy as A
6−import qualified Data.Text.Lazy.IO as TIO
7−import Control.Applicative ((<|>), many)
8−import Data.Char (isSpace)
9−import Data.Maybe (mapMaybe)
10−
11−data Devel = Devel
12− { port :: Int
13− , moduleName :: String
14− , function :: String
15− , yesod :: Bool
16− }
17− deriving (Show, Data, Typeable)
18−
19−main :: IO ()
20−main = do
21− Devel p m f y <- cmdArgs Devel
22− { port = 3000 &= argPos 0 &= typ "PORT"
23− , moduleName = "" &= argPos 1 &= typ "MODULE"
24− , function = "" &= argPos 2 &= typ "FUNCTION"
25− , yesod = False
26− } &= summary "WAI development web server"
27− runQuit p m f $ if y then determineHamletDeps else (const $ return [])
28−
29−data TempType = Hamlet | Cassius | Lucius | Julius | Widget | Verbatim
30− deriving Show
31−
32−determineHamletDeps :: FilePath -> IO [FilePath]
33−determineHamletDeps x = do
34− y <- TIO.readFile x
35− let z = A.parse (many $ (parser <|> (A.anyChar >> return Nothing))) y
36− case z of
37− A.Fail{} -> return []
38− A.Done _ r -> return $ mapMaybe go r
39− where
40− go (Just (Hamlet, f)) = Just $ "hamlet/" ++ f ++ ".hamlet"
41− go (Just (Widget, f)) = Just $ "hamlet/" ++ f ++ ".hamlet"
42− go (Just (Verbatim, f)) = Just f
43− go _ = Nothing
44− parser = do
45− ty <- (A.string "$(hamletFile " >> return Hamlet)
46− <|> (A.string "$(cassiusFile " >> return Cassius)
47− <|> (A.string "$(luciusFile " >> return Lucius)
48− <|> (A.string "$(juliusFile " >> return Julius)
49− <|> (A.string "$(widgetFile " >> return Widget)
50− <|> (A.string "$(Settings.hamletFile " >> return Hamlet)
51− <|> (A.string "$(Settings.cassiusFile " >> return Cassius)
52− <|> (A.string "$(Settings.luciusFile " >> return Lucius)
53− <|> (A.string "$(Settings.juliusFile " >> return Julius)
54− <|> (A.string "$(Settings.widgetFile " >> return Widget)
55− <|> (A.string "$(persistFile " >> return Verbatim)
56− <|> (A.string "$(parseRoutesFile " >> return Verbatim)
57− A.skipWhile isSpace
58− _ <- A.char '"'
59− y <- A.many1 $ A.satisfy (/= '"')
60− _ <- A.char '"'
61− A.skipWhile isSpace
62− _ <- A.char ')'
63− return $ Just (ty, y)
wai-handler-fastcgi/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−/dist/
2−*.swp
3−*.hi
4−*.o
wai-handler-fastcgi/Network/Wai/Handler/FastCGI.hscdeleted−192
@@ -1,192 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−{-# LANGUAGE EmptyDataDecls #-}
3−{-# LANGUAGE CPP #-}
4−-----------------------------------------------------------------------------
5−-- |
6−-- Module : Network.Wai.Handler.FastCGI
7−-- Copyright : (c) Bjorn Bringert 2004-2005, (c) Lemmih 2006, (c) Michael Snoyman 2010
8−-- License : BSD-style (see the file libraries/network/LICENSE)
9−--
10−-- Maintainer : michael@snoyman.com
11−-- Stability : experimental
12−-- Portability : non-portable (uses FFI)
13−--
14−-- Interface for FastCGI <http://fastcgi.com/>, using the fcgiapp API.
15−-- Totally ripped off by Michael Snoyman to work with Hack, then WAI.
16−--
17−-----------------------------------------------------------------------------
18−module Network.Wai.Handler.FastCGI
19− ( run
20− , runSendfile
21− , runFork
22− ) where
23−
24−import Control.Monad ( liftM, forever )
25−import Data.Word (Word8)
26−import Foreign ( Ptr, castPtr, nullPtr, peekArray0
27− , throwIfNeg_, mallocBytes, free )
28−#ifdef GHC_7_4
29−import Foreign.C (CInt(..), CString, CStringLen)
30−#else
31−import Foreign.C (CInt, CString, CStringLen)
32−#endif
33−import Control.Exception (finally)
34−import Foreign.Storable ( Storable (..) )
35−
36−import qualified Network.Wai as W
37−import qualified Network.Wai.Handler.CGI as CGI
38−
39−import qualified Data.ByteString as S
40−import qualified Data.ByteString.Char8 as S8
41−import qualified Data.ByteString as BS
42−import qualified Data.ByteString.Internal as BSB
43−import qualified Data.ByteString.Unsafe as BSB
44−
45−import Control.Arrow ((***))
46−
47−#include <fcgiapp.h>
48−
49−------------------------------------------------------------------------
50−
51−data FCGX_Stream
52−type StreamPtr = Ptr FCGX_Stream
53−type Environ = Ptr CString
54−
55−------------------------------------------------------------------------
56−
57−foreign import ccall unsafe "fcgiapp.h FCGX_GetStr" fcgx_getStr
58− :: CString -> CInt -> StreamPtr -> IO CInt
59−
60−foreign import ccall unsafe "fcgiapp.h FCGX_PutStr" fcgx_putStr
61− :: CString -> CInt -> StreamPtr -> IO CInt
62−
63−
64−------------------------------------------------------------------------
65−
66−foreign import ccall unsafe "fcgiapp.h FCGX_Init" fcgx_init
67− :: IO CInt
68−
69−runFork :: Maybe S.ByteString -> (IO () -> IO a) -> Int -> W.Application -> IO ()
70−runFork sf fork threads app = do
71− testReturn "FCGX_Init" $ fcgx_init
72− let oneThread = forever $ oneRequest app sf
73− mapM_ fork $ replicate (threads - 1) oneThread
74− oneThread
75−
76−-- | Handle FastCGI requests in an infinite loop.
77−run :: W.Application -> IO ()
78−run = runFork Nothing id 1
79−
80−-- | Handle FastCGI requests in an infinite loop. For a server which supports
81−-- the X-Sendfile header.
82−runSendfile :: S.ByteString -> W.Application -> IO ()
83−runSendfile sf = runFork (Just sf) id 1
84−
85−oneRequest :: W.Application
86− -> Maybe S.ByteString -- X-Sendfile
87− -> IO ()
88−oneRequest app xsendfile = withRequest $ \r -> do
89− putStrLn "Received 1 request"
90− env <- peekEnvp r
91− ins <- peekIn r
92− outs <- peekOut r
93− handleRequest app ins outs env xsendfile
94−
95−peekIn, peekOut :: Ptr FCGX_Request -> IO (Ptr FCGX_Stream)
96−peekIn = (#peek FCGX_Request, in)
97−peekOut = (#peek FCGX_Request, out)
98−
99−peekEnvp :: Ptr FCGX_Request -> IO Environ
100−peekEnvp = (#peek FCGX_Request, envp)
101−
102−foreign import ccall unsafe "fcgiapp.h FCGX_InitRequest" fcgx_initrequest
103− :: Ptr FCGX_Request -> CInt -> CInt -> IO CInt
104−
105−foreign import ccall safe "fcgiapp.h FCGX_Accept_r" fcgx_accept_r
106− :: Ptr FCGX_Request -> IO CInt
107−
108−acceptRequest :: IO (Ptr FCGX_Request)
109−acceptRequest = do
110− reqp <- mallocBytes (#size FCGX_Request)
111− initAndAccept reqp
112− return reqp
113− where initAndAccept reqp = do
114− testReturn "FCGX_InitRequest" $ fcgx_initrequest reqp 0 0
115− testReturn "FCGX_Accept_r" $ fcgx_accept_r reqp
116−
117−withRequest :: (Ptr FCGX_Request -> IO ()) -> IO ()
118−withRequest f = do
119− req <- acceptRequest
120− f req `finally` finishRequest req
121−
122−foreign import ccall unsafe "fcgiapp.h FCGX_Finish_r" fcgx_finish_r
123− :: Ptr FCGX_Request -> IO ()
124−
125−finishRequest :: Ptr FCGX_Request -> IO ()
126−finishRequest reqp = do
127− fcgx_finish_r reqp
128− free reqp
129−
130−handleRequest :: W.Application
131− -> StreamPtr
132− -> StreamPtr
133− -> Environ
134− -> Maybe S.ByteString -- sendfile
135− -> IO ()
136−handleRequest f ins outs env xsendfile = do
137− vars <- environToTable env
138− let vars' = map (S8.unpack *** S8.unpack) vars
139− let input = const $ sRead ins
140− let hPut = sPutStr' outs
141− CGI.runGeneric vars' (CGI.requestBodyFunc input) hPut xsendfile f
142−
143−data FCGX_Request
144−
145−--
146−-- * Stream IO
147−--
148−
149−sPutStr' :: StreamPtr -> BS.ByteString -> IO ()
150−sPutStr' h str =
151− BSB.unsafeUseAsCStringLen str $ fcgxPutCStringLen h
152−
153−fcgxPutCStringLen :: StreamPtr -> CStringLen -> IO ()
154−fcgxPutCStringLen h (cs,len) =
155− testReturn "FCGX_PutStr" $ fcgx_putStr cs (fromIntegral len) h
156−
157−sRead :: StreamPtr -> IO (Maybe BS.ByteString)
158−sRead h = buildByteString (fcgxGetBuf h) 4096
159−
160−fcgxGetBuf :: StreamPtr -> Ptr a -> Int -> IO Int
161−fcgxGetBuf h p c =
162− liftM fromIntegral $ fcgx_getStr (castPtr p) (fromIntegral c) h
163−
164−--
165−-- * ByteString utilities
166−--
167−
168−-- | Data.ByteString.Lazy.hGetContentsN generalized to arbitrary
169−-- reading functions.
170−buildByteString :: (Ptr Word8 -> Int -> IO Int) -> Int -> IO (Maybe BS.ByteString)
171−buildByteString f k = do
172− ps <- BSB.createAndTrim k $ \p -> f p k
173− case BS.length ps of
174− 0 -> return Nothing
175− _ -> return $ Just ps
176−
177−--
178−-- * Utilities
179−--
180−
181−testReturn :: String -> IO CInt -> IO ()
182−testReturn e = throwIfNeg_ (\n -> e ++ " failed with error code: "++ show n)
183−
184−environToTable :: Environ -> IO [(S.ByteString, S.ByteString)]
185−environToTable arr = do
186− css <- peekArray0 nullPtr arr
187− ss <- mapM S.packCString css
188− return $ map splitEq ss
189− where
190− splitEq s =
191− let (a, b) = S.breakByte 61 s
192− in (a, S.drop 1 b)
wai-handler-fastcgi/READMEdeleted

No changes to the content.

wai-handler-fastcgi/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-fastcgi/configuredeleted−9
@@ -1,9 +0,0 @@
1−#!/bin/sh
2−#
3−
4−# subst standard header path variables
5−if test -n "$CPPFLAGS" ; then
6− echo "Found CPPFLAGS in environment: '$CPPFLAGS'"
7− sed 's,@CPPFLAGS@,'"$CPPFLAGS"',g;s,@LDFLAGS@,'"$LDFLAGS"',g' \
8− < fastcgi.buildinfo.in > fastcgi.buildinfo
9−fi
wai-handler-fastcgi/fastcgi.buildinfo.indeleted−3
@@ -1,3 +0,0 @@
1−ghc-options: -optc@CPPFLAGS@
2−cc-options: @CPPFLAGS@
3−ld-options: @LDFLAGS@
wai-handler-fastcgi/lighttpd.confdeleted−19
@@ -1,19 +0,0 @@
1−# Run with lighttpd -D -f lighttpd.conf
2−server.port = 3000
3−server.document-root = "."
4−server.modules = ("mod_fastcgi", "mod_rewrite")
5−
6−url.rewrite-once = (
7− "(.*)" => "/app/$1"
8−)
9−
10−fastcgi.server = (
11− "/app" => ((
12− "socket" => "/tmp/test.fastcgi.socket",
13− "check-local" => "disable",
14− "bin-path" => "./test",
15− "min-procs" => 1,
16− "max-procs" => 12,
17− "idle-timeout" => 30
18− ))
19−)
wai-handler-fastcgi/test.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.FastCGI
4−import Control.Monad.IO.Class
5−import qualified Data.ByteString.Lazy as L
6−import qualified Data.ByteString.Lazy.Char8 as L8
7−import qualified Data.Enumerator as E
8−
9−main = run app
10−
11−app req
12− | pathInfo req == "/" = return $ responseLBS status200 [("Content-Type", "text/html")] "<form method='post' action='/post'><input type='text' name='name'><input type='submit'></form>"
13−app req = do
14− bss <- E.consume
15− return $ responseLBS status200 [("Content-Type", "text/plain")] $ L.concat
16− [ L8.pack $ show $ requestHeaders req
17− , "\n"
18− , L.fromChunks bss
19− ]
wai-handler-fastcgi/wai-handler-fastcgi.cabaldeleted−31
@@ -1,31 +0,0 @@
1−name: wai-handler-fastcgi
2−version: 1.3.0.2
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Wai handler to fastcgi
8−category: Web
9−stability: stable
10−cabal-version: >= 1.6
11−build-type: Configure
12−extra-source-files: configure fastcgi.buildinfo.in
13−homepage: http://www.yesodweb.com/book/web-application-interface
14−description: Calls out to the libfcgi C library.
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 1.3 && < 1.5
19− , wai-extra >= 1.3 && < 1.4
20− , bytestring >= 0.9.1.4
21− exposed-modules: Network.Wai.Handler.FastCGI
22− ghc-options: -Wall
23− includes: fcgiapp.h
24− extra-libraries: fcgi
25−
26− if impl(ghc >= 7.4)
27− cpp-options: -DGHC_7_4
28−
29−source-repository head
30− type: git
31− location: git://github.com/yesodweb/wai.git
wai-handler-launch/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−dist/
2−*.swp
wai-handler-launch/Network/Wai/Handler/Launch.hsdeleted−155
@@ -1,155 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ForeignFunctionInterface #-}
3−{-# LANGUAGE CPP #-}
4−module Network.Wai.Handler.Launch
5− ( run
6− , runUrl
7− , runUrlPort
8− ) where
9−
10−import Network.Wai
11−import Network.HTTP.Types
12−import qualified Network.Wai.Handler.Warp as Warp
13−import Data.IORef
14−import Control.Concurrent (forkIO, threadDelay)
15−import Control.Monad.IO.Class (liftIO)
16−import qualified Data.ByteString as S
17−import Blaze.ByteString.Builder (fromByteString)
18−#if WINDOWS
19−import Foreign
20−import Foreign.C.String
21−#else
22−import System.Cmd (rawSystem)
23−#endif
24−import Data.Conduit.Zlib (decompressFlush, WindowBits (WindowBits))
25−import Data.Conduit.Blaze (builderToByteStringFlush)
26−import Data.Conduit
27−import qualified Data.Conduit.List as CL
28−
29−ping :: IORef Bool -> Middleware
30−ping var app req
31− | pathInfo req == ["_ping"] = do
32− liftIO $ writeIORef var True
33− return $ responseLBS status200 [] ""
34− | otherwise = do
35− res <- app req
36− let isHtml hs =
37− case lookup "content-type" hs of
38− Just ct -> "text/html" `S.isPrefixOf` ct
39− Nothing -> False
40− case res of
41− ResponseFile _ hs _ _
42− | not $ isHtml hs -> return res
43− ResponseBuilder _ hs _
44− | not $ isHtml hs -> return res
45− ResponseSource _ hs _
46− | not $ isHtml hs -> return res
47− _ -> do
48− let (s, hs, body) = responseSource res
49− let (isEnc, headers') = fixHeaders id hs
50− let headers'' = filter (\(x, _) -> x /= "content-length") headers'
51− let fixEnc src =
52− if isEnc then
53− src $= decompressFlush (WindowBits 31)
54− else src
55− return $ ResponseSource s headers''
56− $ fixEnc (body $= builderToByteStringFlush)
57− $= insideHead
58− $= CL.map (fmap fromByteString)
59−
60−toInsert :: S.ByteString
61−toInsert = "<script>setInterval(function(){var x;if(window.XMLHttpRequest){x=new XMLHttpRequest();}else{x=new ActiveXObject(\"Microsoft.XMLHTTP\");}x.open(\"GET\",\"/_ping\",false);x.send();},60000)</script>"
62−
63−insideHead :: Conduit (Flush S.ByteString) (ResourceT IO) (Flush S.ByteString)
64−insideHead =
65− loop' (S.empty, whole)
66− where
67− loop' state = await >>= maybe (close state) (push' state)
68− whole = "<head>"
69− push' state (Chunk x) = push state x
70− push' state Flush = yield Flush >> loop' state
71−
72− push (held, atFront) x
73− | atFront `S.isPrefixOf` x = do
74− let y = S.drop (S.length atFront) x
75− mapM_ (yield . Chunk) [held, atFront, toInsert, y]
76− CL.map id
77− | whole `S.isInfixOf` x = do
78− let (before, rest) = S.breakSubstring whole x
79− let after = S.drop (S.length whole) rest
80− mapM_ (yield . Chunk) [held, before, whole, toInsert, after]
81− CL.map id
82− | x `S.isPrefixOf` atFront = do
83− let held' = held `S.append` x
84− atFront' = S.drop (S.length x) atFront
85− loop' (held', atFront')
86− | otherwise = do
87− let (held', atFront', x') = getOverlap whole x
88− mapM_ (yield . Chunk) [held, x']
89− loop' (held', atFront')
90−
91− close (held, _) = mapM_ yield [Chunk held, Chunk toInsert]
92−
93−getOverlap :: S.ByteString -> S.ByteString -> (S.ByteString, S.ByteString, S.ByteString)
94−getOverlap whole x =
95− go whole
96− where
97− go piece
98− | S.null piece = ("", whole, x)
99− | piece `S.isSuffixOf` x =
100− let x' = S.take (S.length x - S.length piece) x
101− atFront = S.drop (S.length piece) whole
102− in (piece, atFront, x')
103− | otherwise = go $ S.init piece
104−
105−fixHeaders :: ([Header] -> [Header])
106− -> [Header]
107− -> (Bool, [Header])
108−fixHeaders front [] = (False, front [])
109−fixHeaders front (("content-encoding", "gzip"):rest) = (True, front rest)
110−fixHeaders front (x:xs) = fixHeaders (front . (:) x) xs
111−
112−#if WINDOWS
113−foreign import ccall "launch"
114− launch' :: Int -> CString -> IO ()
115−#endif
116−
117−launch :: Int -> String -> IO ()
118−
119−#if WINDOWS
120−launch port s = withCString s $ launch' port
121−#else
122−launch port s = forkIO (rawSystem
123−#if MAC
124− "open"
125−#else
126− "xdg-open"
127−#endif
128− ["http://127.0.0.1:" ++ show port ++ "/" ++ s] >> return ()) >> return ()
129−#endif
130−
131−run :: Application -> IO ()
132−run = runUrl ""
133−
134−runUrl :: String -> Application -> IO ()
135−runUrl = runUrlPort 4587
136−
137−runUrlPort :: Int -> String -> Application -> IO ()
138−runUrlPort port url app = do
139− x <- newIORef True
140− _ <- forkIO $ Warp.runSettings Warp.defaultSettings
141− { Warp.settingsPort = port
142− , Warp.settingsOnException = const $ return ()
143− , Warp.settingsHost = "*4"
144− } $ ping x app
145− launch port url
146− loop x
147−
148−loop :: IORef Bool -> IO ()
149−loop x = do
150− let seconds = 120
151− threadDelay $ 1000000 * seconds
152− b <- readIORef x
153− if b
154− then writeIORef x False >> loop x
155− else return ()
wai-handler-launch/READMEdeleted

No changes to the content.

wai-handler-launch/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-launch/runtests.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai.Handler.Launch (insideHead)
3−import Test.Hspec
4−import Test.Hspec.HUnit
5−import Data.Enumerator hiding (map)
6−import Test.HUnit
7−import qualified Data.ByteString as S
8−
9−main :: IO ()
10−main = hspec $ describe "insideHead"
11− [ it "handles single chunks" $ helper "bar<head>foobaz" ["bar<head>baz"]
12− , it "handles single chunks, no <head>" $ helper "barfoo" ["bar"]
13− , it "handles whole chunks" $ helper "bar<head>foobaz" ["bar", "<head>", "baz"]
14− , it "handles split chunks" $ helper "bar<head>foobaz" ["bar", "<he", "ad>", "baz"]
15− , it "handles many chunks" $ helper "bar<head>foobaz1234567890" ["bar", "<he", "ad>", "baz", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"]
16− , it "handles many pieces" $ helper "bar<head>foobaz" $ map S.singleton $ S.unpack "bar<head>baz"
17− ]
18−
19−helper :: S.ByteString -> [S.ByteString] -> Assertion
20−helper res pieces = do
21− x <- run_ $ enumList 1 pieces $$ joinI $ insideHead "foo" $$ consume
22− S.concat x @?= res
wai-handler-launch/test.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.HTTP.Types
4−import Network.Wai.Handler.Launch
5−import Network.Wai.Middleware.Gzip
6−
7−main = runUrl "FIXME" $ gzip True $ \_ -> return $ responseLBS status200 [("Content-Type", "text/html; charset=utf8")] "<html><head></head><body>HELLO THERE"
wai-handler-launch/wai-handler-launch.cabaldeleted−37
@@ -1,37 +0,0 @@
1−Name: wai-handler-launch
2−Version: 1.3.1.4
3−Synopsis: Launch a web app in the default browser.
4−Description: This handles cross-platform launching and inserts Javascript code to ping the server. When the server no longer receives pings, it shuts down.
5−License: MIT
6−License-file: LICENSE
7−Author: Michael Snoyman
8−Maintainer: michael@snoyman.com
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.6
12−
13−Library
14− Exposed-modules: Network.Wai.Handler.Launch
15− build-depends: base >= 4 && < 5
16− , wai >= 1.3 && < 1.5
17− , warp >= 1.3 && < 1.4
18− , http-types >= 0.7
19− , transformers >= 0.2.2 && < 0.4
20− , bytestring >= 0.9.1.4
21− , blaze-builder >= 0.2.1.4 && < 0.4
22− , conduit >= 0.5 && < 1.1
23− , blaze-builder-conduit >= 0.5 && < 1.1
24− , zlib-conduit >= 0.5 && < 1.1
25−
26− if os(windows)
27− c-sources: windows.c
28− cpp-options: -DWINDOWS
29− extra-libraries: Shell32
30− else
31− build-depends: process >= 1.0 && < 1.2
32− if os(darwin)
33− cpp-options: -DMAC
34−
35−source-repository head
36− type: git
37− location: git://github.com/yesodweb/wai.git
wai-handler-launch/windows.cdeleted−12
@@ -1,12 +0,0 @@
1−#include <windows.h>
2−#include <shellapi.h>
3−#include <stdio.h>
4−
5−void launch(int port, char *s)
6−{
7− int len = 8 + strlen("http://127.0.0.1:") + strlen(s);
8− char *buff = malloc(len);
9− snprintf(buff, len, "http://127.0.0.1:%d/%s", port, s);
10− ShellExecute(NULL, "open", buff, NULL, NULL, SW_SHOWNORMAL);
11− free(buff);
12−}
wai-handler-scgi/READMEdeleted

No changes to the content.

wai-handler-scgi/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-scgi/lighttpd.confdeleted−19
@@ -1,19 +0,0 @@
1−# Run with lighttpd -D -f lighttpd.conf
2−server.port = 3000
3−server.document-root = "."
4−server.modules = ("mod_scgi", "mod_rewrite")
5−
6−url.rewrite-once = (
7− "(.*)" => "/app/$1"
8−)
9−
10−scgi.server = (
11− "/app" => ((
12− "socket" => "/tmp/test.scgi.socket",
13− "check-local" => "disable",
14− "bin-path" => "./test",
15− "min-procs" => 1,
16− "max-procs" => 12,
17− "idle-timeout" => 30
18− ))
19−)
wai-handler-scgi/test.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.SCGI (run)
4−import qualified Data.ByteString.Lazy as L
5−import qualified Data.ByteString.Lazy.Char8 as L8
6−import qualified Data.Enumerator.List as E
7−import Network.HTTP.Types (status200)
8−
9−main = run app
10−
11−app req
12− | rawPathInfo req == "/" = return $ responseLBS status200 [("Content-Type", "text/html")] "<form method='post' action='/post'><input type='text' name='name'><input type='submit'></form>"
13−app req = do
14− bss <- E.consume
15− return $ responseLBS status200 [("Content-Type", "text/plain")] $ L.concat
16− [ L8.pack $ show $ requestHeaders req
17− , "\n"
18− , L.fromChunks bss
19− ]
wai-handler-scgi/wai-handler-scgi.cabaldeleted−25
@@ -1,25 +0,0 @@
1−name: wai-handler-scgi
2−version: 1.3.0.2
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Wai handler to SCGI
8−category: Web
9−stability: stable
10−cabal-version: >= 1.6
11−build-type: Simple
12−homepage: http://www.yesodweb.com/book/web-application-interface
13−description: Wai handler to SCGI
14−
15−library
16− build-depends: base >= 4 && < 5
17− , wai >= 1.3 && < 1.5
18− , wai-extra >= 1.3 && < 1.4
19− , bytestring >= 0.9.1.4
20− exposed-modules: Network.Wai.Handler.SCGI
21− ghc-options: -Wall
22−
23−source-repository head
24− type: git
25− location: git://github.com/yesodweb/wai.git
wai-handler-webkit/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−dist
2−*.swp
wai-handler-webkit/LICENSEdeleted−20
@@ -1,20 +0,0 @@
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-handler-webkit/Network/Wai/Handler/Webkit.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−module Network.Wai.Handler.Webkit (run) where
3−
4−import Network.Wai (Application)
5−import qualified Network.Wai.Handler.Warp as S
6−import Control.Concurrent (forkOS)
7−import Control.Concurrent.MVar
8−import Foreign.C.String (CString, withCString)
9−import Control.Exception (finally)
10−
11−run :: String -- ^ Title to show in titlebar
12− -> Application -> IO ()
13−run title app = do
14− mvar <- newEmptyMVar
15− _ <- forkOS $ finally (S.run 3000 app) (putMVar mvar ())
16− _ <- forkOS $ finally (withCString title startBrowser) (putMVar mvar ())
17− _ <- takeMVar mvar
18− return ()
19−
20−foreign import ccall "start_browser"
21− startBrowser :: CString -> IO ()
wai-handler-webkit/README.mddeleted−53
@@ -1,53 +0,0 @@
1−wai-handler-webkit
2−==================
3−
4−Turn WAI applications into standalone GUIs using Qt WebKit.
5−
6−
7−Linux
8−-----
9−
10−You'll need the appropriate system libraries, on Ubuntu:
11−
12− apt-get install libqtwebkit-dev
13−
14−On Lucid, this required adding a PPA:
15−
16− sudo add-apt-repository ppa:kubuntu-ppa/backports
17−
18−
19−Windows
20−-------
21−
22−Install the Qt SDK from <http://qt.nokia.com/downloads/>
23−
24−Your application's Cabal file will require certain options for Windows,
25−shown below. In particular, we need to link with `g++`, so make sure
26−it's in your `PATH`. The option `-optl-mwindows` ensures that the
27−application does not open a terminal.
28−
29− if os(windows)
30− ghc-options: -Wall -threaded -pgml g++ -optl-static -optl-mwindows
31− else
32− ghc-options: -Wall
33−
34−Run `cabal-install` with the Qt `include` and `lib` directories.
35−
36− export QT_PATH=c:/QtSDK/Desktop/Qt/4.7.3/mingw
37−
38− cabal-dev install \
39− --extra-include-dirs=$QT_PATH/include \
40− --extra-include-dirs=$QT_PATH/include/QtCore \
41− --extra-include-dirs=$QT_PATH/include/QtNetwork \
42− --extra-include-dirs=$QT_PATH/include/QtGui \
43− --extra-include-dirs=$QT_PATH/include/QtWebKit \
44− --extra-lib-dirs=$QT_PATH/lib
45−
46−You'll need to include these DLLs with your application:
47−
48− phonon4.dll
49− libgcc_s_dw2-1.dll
50− QtCore4.dll
51− QtGui4.dll
52− QtNetwork4.dll
53− QtWebKit4.dll
wai-handler-webkit/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-webkit/sample.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.Webkit
4−import Network.HTTP.Types
5−
6−main :: IO ()
7−main = run "Sample App" app
8−
9−app :: Application
10−app _ = return $ responseLBS status200 [("Content-Type", "text/html")] "<h1>Hello World!</h1>"
wai-handler-webkit/wai-handler-webkit.cabaldeleted−31
@@ -1,31 +0,0 @@
1−name: wai-handler-webkit
2−version: 1.3.0.1
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Turn WAI applications into standalone GUIs using QtWebkit.
8−description: Runs any WAI application using
9− the simpleserver handler and then pops up a Webkit browser
10− to view it.
11−category: Web
12−stability: unstable
13−cabal-version: >= 1.6
14−build-type: Simple
15−homepage: http://www.yesodweb.com/book/web-application-interface
16−
17−library
18− build-depends: base >= 4 && < 5
19− , wai >= 1.3 && < 1.5
20− , warp >= 1.3 && < 1.5
21− ghc-options: -Wall
22− exposed-modules: Network.Wai.Handler.Webkit
23− c-sources: webkit.cpp
24− if os(windows)
25− extra-libraries: QtCore4, QtGui4, QtNetwork4, QtWebKit4
26− else
27− pkgconfig-depends: QtWebKit
28−
29−source-repository head
30− type: git
31− location: git://github.com/yesodweb/wai.git
wai-handler-webkit/webkit.cppdeleted−19
@@ -1,19 +0,0 @@
1−#include <QApplication>
2−#include <QPushButton>
3−#include <QtWebKit>
4−
5−extern "C" {
6− int start_browser(char *title)
7− {
8− char *argv[1];
9− argv[0] = title;
10− int argc = 1;
11−
12− QApplication app(argc, argv);
13− QWebView *view = new QWebView();
14− view->load(QUrl("http://localhost:3000/"));
15− view->show();
16−
17− return app.exec();
18− }
19−}
wai-handler-launch/LICENSE → wai-http2-extra/LICENSErenamed+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2016 Kazu Yamamoto, http://www.yesodweb.com/
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
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-test/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h
wai-test/LICENSEdeleted−20
@@ -1,20 +0,0 @@
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-test/Network/Wai/Test.hsdeleted−206
@@ -1,206 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE CPP #-}
3−module Network.Wai.Test
4− ( -- * Session
5− Session
6− , runSession
7− -- * Requests
8− , request
9− , srequest
10− , SRequest (..)
11− , SResponse (..)
12− , defaultRequest
13− , setPath
14− , setRawPathInfo
15− -- * Assertions
16− , assertStatus
17− , assertContentType
18− , assertBody
19− , assertBodyContains
20− , assertHeader
21− , assertNoHeader
22− ) where
23−import Network.Wai
24−import qualified Test.HUnit.Base as H
25−import Control.Monad.IO.Class (liftIO)
26−import Control.Monad.Trans.State (StateT, evalStateT)
27−import Control.Monad.Trans.Reader (ReaderT, runReaderT, ask)
28−import Data.Map (Map)
29−import qualified Data.Map as Map
30−import Data.ByteString (ByteString)
31−import qualified Data.ByteString.Char8 as S8
32−import Data.Conduit.Blaze (builderToByteString)
33−import Blaze.ByteString.Builder (flush)
34−import qualified Blaze.ByteString.Builder as B
35−import qualified Data.ByteString.Lazy as L
36−import qualified Data.ByteString.Lazy.Char8 as L8
37−import qualified Network.HTTP.Types as H
38−import Data.CaseInsensitive (CI)
39−import qualified Data.ByteString as S
40−import qualified Data.Text as T
41−import qualified Data.Text.Encoding as TE
42−import qualified Data.Conduit as C
43−import qualified Data.Conduit.List as CL
44−import Data.Monoid (mempty)
45−import Network.Socket.Internal (SockAddr (SockAddrInet))
46−
47−type Session = ReaderT Application (StateT ClientState IO)
48−
49−data ClientState = ClientState
50− { _clientCookies :: Map ByteString ByteString
51− }
52−
53−initState :: ClientState
54−initState = ClientState Map.empty
55−
56−runSession :: Session a -> Application -> IO a
57−runSession session app = evalStateT (runReaderT session app) initState
58−
59−data SRequest = SRequest
60− { simpleRequest :: Request
61− , simpleRequestBody :: L.ByteString
62− }
63−data SResponse = SResponse
64− { simpleStatus :: H.Status
65− , simpleHeaders :: H.ResponseHeaders
66− , simpleBody :: L.ByteString
67− }
68− deriving (Show, Eq)
69−request :: Request -> Session SResponse
70−request = srequest . flip SRequest L.empty
71−
72−defaultRequest :: Request
73−defaultRequest = Request
74− { requestMethod = "GET"
75− , httpVersion = H.http11
76− , rawPathInfo = "/"
77− , rawQueryString = ""
78− , serverName = "localhost"
79− , serverPort = 80
80− , requestHeaders = []
81− , isSecure = False
82− , remoteHost = SockAddrInet 0 0
83− , pathInfo = []
84− , queryString = []
85− , requestBody = mempty
86− , vault = mempty
87−#if MIN_VERSION_wai(1, 4, 0)
88− , requestBodyLength = KnownLength 0
89−#endif
90− }
91−
92−-- | Set whole path (request path + query string).
93−setPath :: Request -> S8.ByteString -> Request
94−setPath req path = req {
95− pathInfo = segments
96− , rawPathInfo = B.toByteString (H.encodePathSegments segments)
97− , queryString = query
98− , rawQueryString = (H.renderQuery True query)
99− }
100− where
101− (segments, query) = H.decodePath path
102−
103−setRawPathInfo :: Request -> S8.ByteString -> Request
104−setRawPathInfo r rawPinfo =
105− let pInfo = T.split (== '/') $ TE.decodeUtf8 rawPinfo
106− in r { rawPathInfo = rawPinfo, pathInfo = pInfo }
107−
108−srequest :: SRequest -> Session SResponse
109−srequest (SRequest req bod) = do
110− app <- ask
111− liftIO $ C.runResourceT $ do
112− let req' = req { requestBody = CL.sourceList $ L.toChunks bod }
113− res <- app req'
114− sres <- runResponse res
115− -- FIXME cookie processing
116− return sres
117−
118−runResponse :: Response -> C.ResourceT IO SResponse
119−runResponse res = do
120− bss <- body C.$= CL.map toBuilder C.$= builderToByteString C.$$ CL.consume
121− return $ SResponse s h $ L.fromChunks bss
122− where
123− (s, h, body) = responseSource res
124− toBuilder (C.Chunk builder) = builder
125− toBuilder C.Flush = flush
126−
127−assertBool :: String -> Bool -> Session ()
128−assertBool s b = liftIO $ H.assertBool s b
129−
130−assertString :: String -> Session ()
131−assertString s = liftIO $ H.assertString s
132−
133−assertContentType :: ByteString -> SResponse -> Session ()
134−assertContentType ct SResponse{simpleHeaders = h} =
135− case lookup "content-type" h of
136− Nothing -> assertString $ concat
137− [ "Expected content type "
138− , show ct
139− , ", but no content type provided"
140− ]
141− Just ct' -> assertBool (concat
142− [ "Expected content type "
143− , show ct
144− , ", but received "
145− , show ct'
146− ]) (go ct == go ct')
147− where
148− go = S8.takeWhile (/= ';')
149−
150−assertStatus :: Int -> SResponse -> Session ()
151−assertStatus i SResponse{simpleStatus = s} = assertBool (concat
152− [ "Expected status code "
153− , show i
154− , ", but received "
155− , show sc
156− ]) $ i == sc
157− where
158− sc = H.statusCode s
159−
160−assertBody :: L.ByteString -> SResponse -> Session ()
161−assertBody lbs SResponse{simpleBody = lbs'} = assertBool (concat
162− [ "Expected response body "
163− , show $ L8.unpack lbs
164− , ", but received "
165− , show $ L8.unpack lbs'
166− ]) $ lbs == lbs'
167−
168−assertBodyContains :: L.ByteString -> SResponse -> Session ()
169−assertBodyContains lbs SResponse{simpleBody = lbs'} = assertBool (concat
170− [ "Expected response body to contain "
171− , show $ L8.unpack lbs
172− , ", but received "
173− , show $ L8.unpack lbs'
174− ]) $ strict lbs `S.isInfixOf` strict lbs'
175− where
176− strict = S.concat . L.toChunks
177−
178−assertHeader :: CI ByteString -> ByteString -> SResponse -> Session ()
179−assertHeader header value SResponse{simpleHeaders = h} =
180− case lookup header h of
181− Nothing -> assertString $ concat
182− [ "Expected header "
183− , show header
184− , " to be "
185− , show value
186− , ", but it was not present"
187− ]
188− Just value' -> assertBool (concat
189− [ "Expected header "
190− , show header
191− , " to be "
192− , show value
193− , ", but received "
194− , show value'
195− ]) (value == value')
196−
197−assertNoHeader :: CI ByteString -> SResponse -> Session ()
198−assertNoHeader header SResponse{simpleHeaders = h} =
199− case lookup header h of
200− Nothing -> return ()
201− Just s -> assertString $ concat
202− [ "Unexpected header "
203− , show header
204− , " containing "
205− , show s
206− ]
wai-test/READMEdeleted

No changes to the content.

wai-test/Setup.lhsdeleted−8
@@ -1,8 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−> import System.Cmd (system)
6−
7−> main :: IO ()
8−> main = defaultMain
wai-test/test/Network/Wai/TestSpec.hsdeleted−32
@@ -1,32 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Network.Wai.TestSpec (main, spec) where
3−
4−import Test.Hspec
5−
6−import Network.Wai
7−import Network.Wai.Test
8−
9−main :: IO ()
10−main = hspec spec
11−
12−spec :: Spec
13−spec = do
14− describe "setPath" $ do
15−
16− let req = setPath defaultRequest "/foo/bar/baz?foo=23&bar=42&baz"
17−
18− it "sets pathInfo" $ do
19− pathInfo req `shouldBe` ["foo", "bar", "baz"]
20−
21− it "sets rawPathInfo" $ do
22− rawPathInfo req `shouldBe` "/foo/bar/baz"
23−
24− it "sets queryString" $ do
25− queryString req `shouldBe` [("foo", Just "23"), ("bar", Just "42"), ("baz", Nothing)]
26−
27− it "sets rawQueryString" $ do
28− rawQueryString req `shouldBe` "?foo=23&bar=42&baz"
29−
30− context "when path has no query string" $ do
31− it "sets rawQueryString to empty string" $ do
32− rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
wai-test/wai-test.cabaldeleted−46
@@ -1,46 +0,0 @@
1−name: wai-test
2−version: 1.3.1
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Unit test framework (built on HUnit) for WAI applications.
8−category: Testing, Web, Yesod
9−stability: Stable
10−cabal-version: >= 1.8
11−build-type: Simple
12−homepage: http://www.yesodweb.com/book/web-application-interface
13−description: Unit test framework (built on HUnit) for WAI applications.
14−
15−library
16− build-depends: base >= 4 && < 5
17− , wai >= 1.3 && < 1.5
18− , bytestring >= 0.9.1.4
19− , text >= 0.7 && < 0.12
20− , blaze-builder >= 0.2.1.4 && < 0.4
21− , transformers >= 0.2.2 && < 0.4
22− , containers >= 0.2
23− , conduit >= 0.5 && < 1.1
24− , blaze-builder-conduit >= 0.5 && < 1.1
25− , cookie >= 0.2 && < 0.5
26− , HUnit >= 1.2 && < 1.3
27− , http-types >= 0.7
28− , case-insensitive >= 0.2
29− , network
30− exposed-modules: Network.Wai.Test
31− ghc-options: -Wall
32−
33−test-suite spec
34− type: exitcode-stdio-1.0
35− hs-source-dirs: test
36− main-is: Spec.hs
37− other-modules: Network.Wai.TestSpec
38− build-depends: base >= 4 && < 5
39− , wai-test
40− , wai
41− , hspec >= 1.3
42− ghc-options: -Wall -Werror
43−
44−source-repository head
45− type: git
46− 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/Network/Wai/Handler/WebSockets.hs+106−62
@@ -1,74 +1,118 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2module Network.Wai.Handler.WebSockets
2module Network.Wai.Handler.WebSockets
3− ( intercept
3+ ( websocketsOr
4− , interceptWith
4+ , websocketsApp
5+ , isWebSocketsReq
6+ , getRequestHead
7+ , runWebSockets
5 ) where
8 ) where
6
9
7−import Control.Monad.IO.Class (liftIO)
10+import Control.Exception (bracket, tryJust)
8−import Data.ByteString (ByteString)
11+import Data.ByteString (ByteString)
9−import Data.Char (toLower)
10−import qualified Data.ByteString.Char8 as S
12+import qualified Data.ByteString.Char8 as BC
11−import Data.Conduit
13+import qualified Data.ByteString.Lazy as BL
12−import qualified Data.Enumerator as E
14+import qualified Data.CaseInsensitive as CI
15+import Network.HTTP.Types (status500)
13−import qualified Network.Wai as Wai
16+import qualified Network.Wai as Wai
14−import qualified Network.Wai.Handler.Warp as Warp
17+import qualified Network.WebSockets as WS
18+import qualified Network.WebSockets.Connection as WS
15−import qualified Network.WebSockets as WS
19+import qualified Network.WebSockets.Stream as WS
16
20
17−-- | For use with 'settingsIntercept' from the Warp web server.
21+--------------------------------------------------------------------------------
18−intercept :: WS.Protocol p
22+-- | Returns whether or not the given 'Wai.Request' is a WebSocket request.
19− => (WS.Request -> WS.WebSockets p ())
20− -> Wai.Request
23+isWebSocketsReq :: Wai.Request -> Bool
21− -> Maybe (Source (ResourceT IO) ByteString -> Warp.Connection -> ResourceT IO ())
24+isWebSocketsReq req =
22−intercept = interceptWith WS.defaultWebSocketsOptions
25+ fmap CI.mk (lookup "upgrade" $ Wai.requestHeaders req) == Just "websocket"
23
26
24−-- | Variation of 'intercept' which allows custom options.
27+--------------------------------------------------------------------------------
25−interceptWith :: WS.Protocol p
28+-- | Upgrade a @websockets@ 'WS.ServerApp' to a @wai@ 'Wai.Application'. Uses
26− => WS.WebSocketsOptions
29+-- the given backup 'Wai.Application' to handle 'Wai.Request's that are not
27− -> (WS.Request -> WS.WebSockets p ())
30+-- WebSocket requests.
28− -> Wai.Request
31+--
29− -> Maybe (Source (ResourceT IO) ByteString -> Warp.Connection -> ResourceT IO ())
32+-- @
30−interceptWith opts app req = case lookup "upgrade" $ Wai.requestHeaders req of
33+-- websocketsOr opts ws_app backup_app = \\req respond ->
31− Just s
34+-- __case__ 'websocketsApp' opts ws_app req __of__
32− | S.map toLower s == "websocket" -> Just $ runWebSockets opts req' app
35+-- 'Nothing' -> backup_app req send_response
33− | otherwise -> Nothing
36+-- 'Just' res -> respond res
34− _ -> Nothing
37+-- @
35− where
38+--
36− req' = WS.RequestHttpPart (Wai.rawPathInfo req) (Wai.requestHeaders req)
39+-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
37− (Wai.isSecure req)
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
38
62
39−-- | Internal function to run the WebSocket iteratee using the conduit library
63+--------------------------------------------------------------------------------
40−runWebSockets :: WS.Protocol p
64+-- | Handle a single @wai@ 'Wai.Request' with the given @websockets@
41− => WS.WebSocketsOptions
65+-- 'WS.ServerApp'. Returns 'Nothing' if the 'Wai.Request' is not a WebSocket
42− -> WS.RequestHttpPart
66+-- request, 'Just' otherwise.
67+--
68+-- Usually, 'websocketsOr' is more convenient.
69+websocketsApp :: WS.ConnectionOptions
70+ -> WS.ServerApp
43− -> (WS.Request -> WS.WebSockets p ())
71+ -> Wai.Request
44− -> Source (ResourceT IO) ByteString
72+ -> Maybe Wai.Response
45− -> Warp.Connection
73+websocketsApp opts app req
46− -> ResourceT IO ()
74+ | isWebSocketsReq req =
47−runWebSockets opts req app source conn = do
75+ Just $ flip Wai.responseRaw backup $ \src sink ->
48− step <- liftIO $ E.runIteratee $ WS.runWebSocketsWith opts req app send
76+ runWebSockets opts req' app src sink
49− source $$ sink (E.returnI step)
77+ | otherwise = Nothing
50 where
78 where
51− send = iterConnection conn
79+ req' = getRequestHead req
52−
80+ backup = Wai.responseLBS status500 [("Content-Type", "text/plain")]
53− sink iter = await >>= maybe (close iter) (push iter)
81+ "The web application attempted to send a WebSockets response, but WebSockets are not supported by your WAI handler."
54
82
55− push iter bs = do
83+--------------------------------------------------------------------------------
56− step <- liftIO $ E.runIteratee $ E.enumList 1 [bs] E.$$ iter
84+getRequestHead :: Wai.Request -> WS.RequestHead
57− case step of
85+getRequestHead req = WS.RequestHead
58− E.Continue _ -> sink $ E.returnI step
86+ (Wai.rawPathInfo req `BC.append` Wai.rawQueryString req)
59− E.Yield out inp -> maybe (return ()) leftover (streamToMaybe inp) >> return out
87+ (Wai.requestHeaders req)
60− E.Error e -> liftIO $ monadThrow e
88+ (Wai.isSecure req)
61− close iter = do
62− _ <- liftIO $ E.runIteratee $ E.enumEOF E.$$ iter
63− return ()
64
89
65−iterConnection :: Warp.Connection -> E.Iteratee ByteString IO ()
90+--------------------------------------------------------------------------------
66−iterConnection c = E.continue go
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)
67 where
99 where
68− go (E.Chunks []) = E.continue go
100+ ensureClose = tryJust onConnectionException . WS.close
69− go (E.Chunks cs) = E.tryIO (Warp.connSendMany c cs) >> E.continue go
101+ onConnectionException :: WS.ConnectionException -> Maybe ()
70− go E.EOF = E.continue go
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))
71
112
72−streamToMaybe :: E.Stream S.ByteString -> Maybe S.ByteString
113+ pc stream = WS.PendingConnection
73−streamToMaybe E.EOF = Nothing
114+ { WS.pendingOptions = opts
74−streamToMaybe (E.Chunks bs) = Just $ S.concat bs
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/server.lhs+61−61
@@ -8,16 +8,17 @@ this example, keep the [reference](http://jaspervdj.be/websockets/reference)
8nearby to check out the functions we use.
8nearby to check out the functions we use.
9
9
10> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
10> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
11+> {-# LANGUAGE CPP #-}
12+> {-# OPTIONS_GHC -Wno-unused-top-binds #-} -- for numClients
11> import Data.Char (isPunctuation, isSpace)
13> import Data.Char (isPunctuation, isSpace)
12> import Data.Monoid (mappend)
14> import Data.Monoid (mappend)
13> import Data.Text (Text)
15> import Data.Text (Text)
14−> import Control.Exception (fromException)
16+> import Control.Exception (finally)
15−> import Control.Monad (forM_)
17+> import Control.Monad (forM_, forever)
16−> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar)
18+> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, modifyMVar)
17> import Control.Monad.IO.Class (liftIO)
19> import Control.Monad.IO.Class (liftIO)
18> import qualified Data.Text as T
20> import qualified Data.Text as T
19> import qualified Data.Text.IO as T
21> import qualified Data.Text.IO as T
20−
21> import qualified Network.WebSockets as WS
22> import qualified Network.WebSockets as WS
22> import qualified Network.Wai
23> import qualified Network.Wai
23> import qualified Network.Wai.Handler.Warp as Warp
24> import qualified Network.Wai.Handler.Warp as Warp
@@ -25,14 +26,11 @@ nearby to check out the functions we use.
25> import qualified Network.Wai.Application.Static as Static
26> import qualified Network.Wai.Application.Static as Static
26> import Data.FileEmbed (embedDir)
27> import Data.FileEmbed (embedDir)
27
28
28−We represent a client by his username and a 'WS.Sender'. We can use this sender
29−to asynchronously send 'Text' to the client later. Note that using `WS.Hybi00`
30−here does not imply that our server is only compatible with the `hybi-00`
31−version of the protocol, for more details on this, see the
32−[Network.WebSockets](http://jaspervdj.be/websockets/reference/Network-WebSockets.html)
33−reference.
34
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+
35−> type Client = (Text, WS.Sink WS.Hybi00)
33+> type Client = (Text, WS.Connection)
36
34
37The state kept on the server is simply a list of connected clients. We've added
35The state kept on the server is simply a list of connected clients. We've added
38an alias and some utility functions, so it will be easier to extend this state
36an alias and some utility functions, so it will be easier to extend this state
@@ -40,99 +38,104 @@ later on.
40
38
41> type ServerState = [Client]
39> type ServerState = [Client]
42
40
43−Create a new, initial state
41+Create a new, initial state:
44
42
45> newServerState :: ServerState
43> newServerState :: ServerState
46> newServerState = []
44> newServerState = []
47
45
48−Get the number of active clients
46+Get the number of active clients:
49
47
50> numClients :: ServerState -> Int
48> numClients :: ServerState -> Int
51> numClients = length
49> numClients = length
52
50
53−Check if a user already exists (based on username)
51+Check if a user already exists (based on username):
54
52
55> clientExists :: Client -> ServerState -> Bool
53> clientExists :: Client -> ServerState -> Bool
56> clientExists client = any ((== fst client) . fst)
54> clientExists client = any ((== fst client) . fst)
57
55
58−Add a client (first, you should verify the client is not already connected using
56+Add a client (this does not check if the client already exists, you should do
59−'clientExists')
57+this yourself using `clientExists`):
60
58
61> addClient :: Client -> ServerState -> ServerState
59> addClient :: Client -> ServerState -> ServerState
62> addClient client clients = client : clients
60> addClient client clients = client : clients
63
61
64−Remove a client
62+Remove a client:
65
63
66> removeClient :: Client -> ServerState -> ServerState
64> removeClient :: Client -> ServerState -> ServerState
67> removeClient client = filter ((/= fst client) . fst)
65> removeClient client = filter ((/= fst client) . fst)
68
66
69−Send a message to all clients, and log it on stdout.
67+Send a message to all clients, and log it on stdout:
70
68
71> broadcast :: Text -> ServerState -> IO ()
69> broadcast :: Text -> ServerState -> IO ()
72> broadcast message clients = do
70> broadcast message clients = do
73> T.putStrLn message
71> T.putStrLn message
74−> forM_ clients $ \(_, sink) -> WS.sendSink sink $ WS.textData message
72+> forM_ clients $ \(_, conn) -> WS.sendTextData conn message
75
73
76The main function first creates a new state for the server, then spawns the
74The main function first creates a new state for the server, then spawns the
77−actual server. For this purpose, we use the simple server provided by
75+actual server.
78−'WS.runServer'.
79
76
80> main :: IO ()
77> main :: IO ()
81> main = do
78> main = do
82> putStrLn "http://localhost:9160/client.html"
79> putStrLn "http://localhost:9160/client.html"
83> state <- newMVar newServerState
80> state <- newMVar newServerState
84−> Warp.runSettings Warp.defaultSettings
81+> Warp.runSettings
85−> { Warp.settingsPort = 9160
82+> (Warp.setPort 9160 Warp.defaultSettings)
86−> , Warp.settingsIntercept = WaiWS.intercept (application state)
83+> $ WaiWS.websocketsOr WS.defaultConnectionOptions (application state) staticApp
87−> } staticApp
88
84
89> staticApp :: Network.Wai.Application
85> staticApp :: Network.Wai.Application
90> staticApp = Static.staticApp $ Static.embeddedSettings $(embedDir "static")
86> staticApp = Static.staticApp $ Static.embeddedSettings $(embedDir "static")
91
87
92−When a client connects, we accept the connection, regardless of the path.
88+Our main application has the type:
93
89
94−> application :: MVar ServerState -> WS.Request -> WS.WebSockets WS.Hybi00 ()
90+> application :: MVar ServerState -> WS.ServerApp
95−> application state rq = do
96−> WS.acceptRequest rq
97
91
98−We log some information here: in particular, we are interested in the protocol
92+Note that `WS.ServerApp` is nothing but a type synonym for
99−version our client is using (for debugging purposes).
93+`WS.PendingConnection -> IO ()`.
100
94
101−> WS.getVersion >>= liftIO . putStrLn . ("Client version: " ++)
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.
102
98
103−If we want to be able to send data to this client later, from another thread, we
99+We also fork a pinging thread in the background. This will ensure the connection
104−obtain a sink. We will add this to the server state later.
100+stays alive on some browsers.
105
101
106−> sink <- WS.getSink
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
107
109
108−When a client is succesfully connected, we read the first message. This should
110+When a client is successfully connected, we read the first message. This should
109−be in the format of "Hi, I am Jasper", where Jasper is the requested username.
111+be in the format of "Hi! I am Jasper", where Jasper is the requested username.
110
112
111−> msg <- WS.receiveData
113+> msg <- WS.receiveData conn
112> clients <- liftIO $ readMVar state
114> clients <- liftIO $ readMVar state
113> case msg of
115> case msg of
114
116
115−Check that the first message has the right format
117+Check that the first message has the right format:
116
118
117> _ | not (prefix `T.isPrefixOf` msg) ->
119> _ | not (prefix `T.isPrefixOf` msg) ->
118−> WS.sendTextData ("Wrong announcement" :: Text)
120+> WS.sendTextData conn ("Wrong announcement" :: Text)
119
121
120−Check the validity of the username
122+Check the validity of the username:
121
123
122> | any ($ fst client)
124> | any ($ fst client)
123> [T.null, T.any isPunctuation, T.any isSpace] ->
125> [T.null, T.any isPunctuation, T.any isSpace] ->
124−> WS.sendTextData ("Name cannot " `mappend`
126+> WS.sendTextData conn ("Name cannot " `mappend`
125> "contain punctuation or whitespace, and " `mappend`
127> "contain punctuation or whitespace, and " `mappend`
126> "cannot be empty" :: Text)
128> "cannot be empty" :: Text)
127
129
128−Check that the given username is not already taken
130+Check that the given username is not already taken:
129
131
130> | clientExists client clients ->
132> | clientExists client clients ->
131−> WS.sendTextData ("User already exists" :: Text)
133+> WS.sendTextData conn ("User already exists" :: Text)
132
134
133−All is right!
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.
134
137
135−> | otherwise -> do
138+> | otherwise -> flip finally disconnect $ do
136
139
137We send a "Welcome!", according to our own little protocol. We add the client to
140We send a "Welcome!", according to our own little protocol. We add the client to
138the list and broadcast the fact that he has joined. Then, we give control to the
141the list and broadcast the fact that he has joined. Then, we give control to the
@@ -140,29 +143,26 @@ the list and broadcast the fact that he has joined. Then, we give control to the
140
143
141> liftIO $ modifyMVar_ state $ \s -> do
144> liftIO $ modifyMVar_ state $ \s -> do
142> let s' = addClient client s
145> let s' = addClient client s
143−> WS.sendSink sink $ WS.textData $
146+> WS.sendTextData conn $
144> "Welcome! Users: " `mappend`
147> "Welcome! Users: " `mappend`
145> T.intercalate ", " (map fst s)
148> T.intercalate ", " (map fst s)
146> broadcast (fst client `mappend` " joined") s'
149> broadcast (fst client `mappend` " joined") s'
147> return s'
150> return s'
148−> talk state client
151+> talk conn state client
149> where
152> where
150−> prefix = "Hi! I am "
153+> prefix = "Hi! I am "
151−> client = (T.drop (T.length prefix) msg, sink)
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
152
160
153The talk function continues to read messages from a single client until he
161The talk function continues to read messages from a single client until he
154disconnects. All messages are broadcasted to the other clients.
162disconnects. All messages are broadcasted to the other clients.
155
163
156−> talk :: WS.Protocol p => MVar ServerState -> Client -> WS.WebSockets p ()
164+> talk :: WS.Connection -> MVar ServerState -> Client -> IO ()
157−> talk state client@(user, _) = flip WS.catchWsError catchDisconnect $ do
165+> talk conn state (user, _) = forever $ do
158−> msg <- WS.receiveData
166+> msg <- WS.receiveData conn
159> liftIO $ readMVar state >>= broadcast
167> liftIO $ readMVar state >>= broadcast
160> (user `mappend` ": " `mappend` msg)
168> (user `mappend` ": " `mappend` msg)
161−> talk state client
162−> where
163−> catchDisconnect e = case fromException e of
164−> Just WS.ConnectionClosed -> liftIO $ modifyMVar_ state $ \s -> do
165−> let s' = removeClient client s
166−> broadcast (user `mappend` " disconnected") s'
167−> return s'
168−> _ -> return ()
wai-websockets/wai-websockets.cabal+14−19
@@ -1,58 +1,53 @@
1Name: wai-websockets
1Name: wai-websockets
2−Version: 1.3.1.2
2+Version: 3.0.1.2
3−Synopsis: Provide a bridge betweeen WAI and the websockets package.
3+Synopsis: Provide a bridge between WAI and the websockets package.
4License: MIT
4License: MIT
5License-file: LICENSE
5License-file: LICENSE
6−Author: Michael Snoyman, Jasper Van der Jeugt
6+Author: Michael Snoyman, Jasper Van der Jeugt, Ting-Yen Lai
7Maintainer: michael@snoyman.com
7Maintainer: michael@snoyman.com
8Homepage: http://github.com/yesodweb/wai
8Homepage: http://github.com/yesodweb/wai
9Category: Web, Yesod
9Category: Web, Yesod
10Build-Type: Simple
10Build-Type: Simple
11Cabal-Version: >=1.8
11Cabal-Version: >=1.8
12Stability: Stable
12Stability: Stable
13−Description: This is primarily intended for use with Warp and its settingsIntercept.
13+description: API docs and the README are available at <http://www.stackage.org/package/wai-websockets>.
14
14
15extra-source-files: static/client.js, static/client.html, static/screen.css
15extra-source-files: static/client.js, static/client.html, static/screen.css
16+ README.md ChangeLog.md
16
17
17flag example
18flag example
18
19
19Library
20Library
20 Build-Depends: base >= 3 && < 5
21 Build-Depends: base >= 3 && < 5
21 , bytestring >= 0.9.1.4
22 , bytestring >= 0.9.1.4
22− , conduit >= 0.5 && < 1.1
23− , wai >= 1.3 && < 1.5
23+ , wai >= 3.0 && < 3.3
24− , enumerator >= 0.4.8 && < 0.5
25− , network-enumerator >= 0.1.2 && < 0.2
26− , blaze-builder >= 0.2.1.4 && < 0.4
27 , case-insensitive >= 0.2
24 , case-insensitive >= 0.2
28 , network >= 2.2.1.5
25 , network >= 2.2.1.5
29− , transformers >= 0.2 && < 0.4
26+ , transformers >= 0.2
30− , websockets >= 0.6 && < 0.8
27+ , websockets >= 0.9
31− , warp >= 1.3 && < 1.4
28+ , http-types
32 Exposed-modules: Network.Wai.Handler.WebSockets
29 Exposed-modules: Network.Wai.Handler.WebSockets
33 ghc-options: -Wall
30 ghc-options: -Wall
34
31
35Executable wai-websockets-example
32Executable wai-websockets-example
36 if flag(example)
33 if flag(example)
37 buildable: True
34 buildable: True
38− else
39− buildable: False
40− Build-Depends: base >= 3 && < 5
35+ Build-Depends: base >= 3 && < 5
41− , conduit
42 , wai-websockets
36 , wai-websockets
43 , websockets
37 , websockets
44− , network-enumerator
45 , warp
38 , warp
46 , wai
39 , wai
47 , wai-app-static
40 , wai-app-static
48 , bytestring
41 , bytestring
49 , case-insensitive
42 , case-insensitive
50− , blaze-builder
51− , enumerator
52 , transformers
43 , transformers
53 , network
44 , network
54 , text
45 , text
55 , file-embed
46 , file-embed
47+ , http-types
48+ other-modules: Network.Wai.Handler.WebSockets
49+ else
50+ buildable: False
56
51
57 ghc-options: -Wall -threaded
52 ghc-options: -Wall -threaded
58 main-is: server.lhs
53 main-is: server.lhs
wai/.ghci+2−1
@@ -1 +1,2 @@
1−:set -i../warp -i../warp/dist/build/autogen/ -pgmL markdown-unlit
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/Network/Wai.hs+274−120
@@ -1,16 +1,14 @@
1−{-# LANGUAGE Rank2Types #-}
2−{-# LANGUAGE ExistentialQuantification #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4{-|
1{-|
5
2
6This module defines a generic web application interface. It is a common
3This module defines a generic web application interface. It is a common
7protocol between web servers and web applications.
4protocol between web servers and web applications.
8
5
9−The overriding design principles here are performance and generality . To
6+The overriding design principles here are performance and generality. To
10−address performance, this library is built on top of the conduit and
7+address performance, this library uses a streaming interface for request and
11−blaze-builder packages. The advantages of conduits over lazy IO have been
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
12−debated elsewhere and so will not be addressed here. However, helper functions
10+addressed here. However, helper functions like 'responseLBS' allow you to
13−like 'responseLBS' allow you to continue using lazy IO if you so desire.
11+continue using lazy IO if you so desire.
14
12
15Generality is achieved by removing many variables commonly found in similar
13Generality is achieved by removing many variables commonly found in similar
16projects that are not universal to all servers. The goal is that the 'Request'
14projects that are not universal to all servers. The goal is that the 'Request'
@@ -32,87 +30,83 @@ include:
32
30
33[wai-extra] <http://hackage.haskell.org/package/wai-extra>
31[wai-extra] <http://hackage.haskell.org/package/wai-extra>
34
32
35−[wai-test] <http://hackage.haskell.org/package/wai-test>
36−
37-}
33-}
34+-- Ignore deprecations, because this module needs to use the deprecated requestBody to construct a response.
35+{-# OPTIONS_GHC -fno-warn-deprecations #-}
38module Network.Wai
36module Network.Wai
39− ( -- * WAI interface
37+ (
40− Request (..)
38+ -- * Types
41− , Response (..)
42− , responseSource
43− , Application
39+ Application
44 , Middleware
40 , Middleware
45− , FilePart (..)
41+ , ResponseReceived
42+ -- * Request
43+ , Request
44+ , defaultRequest
46 , RequestBodyLength (..)
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
47− -- * Response body smart constructors
66+ -- * Response
67+ , Response
68+ , StreamingBody
69+ , FilePart (..)
70+ -- ** Response composers
71+ , responseFile
72+ , responseBuilder
48 , responseLBS
73 , responseLBS
74+ , responseStream
75+ , responseRaw
76+ -- ** Response accessors
49 , responseStatus
77 , responseStatus
78+ , responseHeaders
79+ -- ** Response modifiers
80+ , responseToStream
81+ , mapResponseHeaders
82+ , mapResponseStatus
83+ -- * Middleware composition
84+ , ifRequest
85+ , modifyResponse
50 ) where
86 ) where
51
87
88+import Data.ByteString.Builder (Builder, lazyByteString)
89+import Data.ByteString.Builder (byteString)
90+import Control.Monad (unless)
52−import qualified Data.ByteString as B
91+import qualified Data.ByteString as B
53−import qualified Data.ByteString.Lazy as L
92+import qualified Data.ByteString.Lazy as L
54−import Data.Typeable (Typeable)
93+import qualified Data.ByteString.Lazy.Internal as LI
55−import qualified Data.Conduit as C
94+import Data.ByteString.Lazy.Internal (defaultChunkSize)
56−import qualified Data.Conduit.List as CL
95+import Data.ByteString.Lazy.Char8 ()
57−import qualified Data.Conduit.Binary as CB
96+import Data.Function (fix)
58−import Blaze.ByteString.Builder (Builder, fromLazyByteString)
59−import Network.Socket (SockAddr)
60−import qualified Network.HTTP.Types as H
97+import qualified Network.HTTP.Types as H
61−import Data.Text (Text)
98+import Network.Socket (SockAddr (SockAddrInet))
62−import Data.ByteString.Lazy.Char8 () -- makes it easier to use responseLBS
99+import Network.Wai.Internal
63−import Blaze.ByteString.Builder (fromByteString)
100+import qualified System.IO as IO
64−import Data.Vault (Vault)
101+import System.IO.Unsafe (unsafeInterleaveIO)
65−import Data.Word (Word64)
102+
66−
103+----------------------------------------------------------------
67−-- | Information on the request sent by the client. This abstracts away the
104+
68−-- details of the underlying implementation.
105+-- | Creating 'Response' from a file.
69−data Request = Request
106+responseFile :: H.Status -> H.ResponseHeaders -> FilePath -> Maybe FilePart -> Response
70− { requestMethod :: H.Method
107+responseFile = ResponseFile
71− , httpVersion :: H.HttpVersion
108+
72− -- | Extra path information sent by the client. The meaning varies slightly
109+-- | Creating 'Response' from 'Builder'.
73− -- depending on backend; in a standalone server setting, this is most likely
74− -- all information after the domain name. In a CGI application, this would be
75− -- the information following the path to the CGI executable itself.
76− -- Do not modify this raw value- modify pathInfo instead.
77− , rawPathInfo :: B.ByteString
78− -- | If no query string was specified, this should be empty. This value
79− -- /will/ include the leading question mark.
80− -- Do not modify this raw value- modify queryString instead.
81− , rawQueryString :: B.ByteString
82− -- | Generally the host requested by the user via the Host request header.
83− -- Backends are free to provide alternative values as necessary. This value
84− -- should not be used to construct URLs.
85− , serverName :: B.ByteString
86− -- | The listening port that the server received this request on. It is
87− -- possible for a server to listen on a non-numeric port (i.e., Unix named
88− -- socket), in which case this value will be arbitrary. Like 'serverName',
89− -- this value should not be used in URL construction.
90− , serverPort :: Int
91− , requestHeaders :: H.RequestHeaders
92− -- | Was this request made over an SSL connection?
93− --
94− -- This value should /not/ be used, and will be removed in future revisions
95− -- of WAI. There is no meaningful way that a backend can indicate whether the
96− -- request is actually over a secure channel, due to issues of reverse
97− -- proxying.
98− , isSecure :: Bool
99− -- | The client\'s host information.
100− , remoteHost :: SockAddr
101− -- | Path info in individual pieces- the url without a hostname/port and without a query string, split on forward slashes,
102− , pathInfo :: [Text]
103− -- | Parsed query string information
104− , queryString :: H.Query
105− , requestBody :: C.Source (C.ResourceT IO) B.ByteString
106− -- | A location for arbitrary data to be shared by applications and middleware.
107− , vault :: Vault
108− -- | The size of the request body. In the case of a chunked request body, this may be unknown.
109− --
110− -- Since 1.4.0
111− , requestBodyLength :: RequestBodyLength
112− }
113− deriving (Typeable)
114−
115−-- |
116--
110--
117-- Some questions and answers about the usage of 'Builder' here:
111-- Some questions and answers about the usage of 'Builder' here:
118--
112--
@@ -127,49 +121,172 @@ data Request = Request
127--
121--
128-- A2. No. If the ByteStrings are small, then they will be copied into a larger
122-- A2. No. If the ByteStrings are small, then they will be copied into a larger
129-- buffer, which should be a performance gain overall (less system calls). If
123-- buffer, which should be a performance gain overall (less system calls). If
130−-- they are already large, then blaze-builder uses an InsertByteString
124+-- they are already large, then an insert operation is used
131−-- instruction to avoid copying.
125+-- to avoid copying.
132--
126--
133-- Q3. Doesn't this prevent us from creating comet-style servers, since data
127-- Q3. Doesn't this prevent us from creating comet-style servers, since data
134-- will be cached?
128-- will be cached?
135--
129--
136−-- A3. You can force blaze-builder to output a ByteString before it is an
130+-- A3. You can force a Builder to output a ByteString before it is an
137-- optimal size by sending a flush command.
131-- optimal size by sending a flush command.
138−data Response
139− = ResponseFile H.Status H.ResponseHeaders FilePath (Maybe FilePart)
132+responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
140− | ResponseBuilder H.Status H.ResponseHeaders Builder
133+responseBuilder = ResponseBuilder
141− | ResponseSource H.Status H.ResponseHeaders (C.Source (C.ResourceT IO) (C.Flush Builder))
134+
142− deriving Typeable
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
143
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'.
144responseStatus :: Response -> H.Status
187responseStatus :: Response -> H.Status
145−responseStatus rsp =
146− case rsp of
147− ResponseFile s _ _ _ -> s
188+responseStatus (ResponseFile s _ _ _) = s
148− ResponseBuilder s _ _ -> s
189+responseStatus (ResponseBuilder s _ _ ) = s
149− ResponseSource s _ _ -> s
190+responseStatus (ResponseStream s _ _ ) = s
150−
191+responseStatus (ResponseRaw _ res ) = responseStatus res
151−data FilePart = FilePart
152− { filePartOffset :: Integer
153− , filePartByteCount :: Integer
154− } deriving Show
155−
156−responseSource :: Response -> (H.Status, H.ResponseHeaders, C.Source (C.ResourceT IO) (C.Flush Builder))
157−responseSource (ResponseSource s h b) = (s, h, b)
158−responseSource (ResponseFile s h fp (Just part)) =
159− (s, h, sourceFilePart part fp C.$= CL.map (C.Chunk . fromByteString))
160−responseSource (ResponseFile s h fp Nothing) =
161− (s, h, CB.sourceFile fp C.$= CL.map (C.Chunk . fromByteString))
162−responseSource (ResponseBuilder s h b) =
163− (s, h, CL.sourceList [C.Chunk b])
164−
165−sourceFilePart :: C.MonadResource m => FilePart -> FilePath -> C.Source m B.ByteString
166−sourceFilePart (FilePart offset count) fp =
167− CB.sourceFileRange fp (Just offset) (Just count)
168
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.
169−responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
236+mapResponseHeaders :: (H.ResponseHeaders -> H.ResponseHeaders) -> Response -> Response
170−responseLBS s h = ResponseBuilder s h . fromLazyByteString
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+ }
171
289
172−type Application = Request -> C.ResourceT IO Response
173
290
174-- | Middleware is a component that sits between the server and application. It
291-- | Middleware is a component that sits between the server and application. It
175-- can do such tasks as GZIP encoding or response caching. What follows is the
292-- can do such tasks as GZIP encoding or response caching. What follows is the
@@ -178,7 +295,7 @@ type Application = Request -> C.ResourceT IO Response
178--
295--
179-- As an example of an alternate type for middleware, suppose you write a
296-- As an example of an alternate type for middleware, suppose you write a
180-- function to load up session information. The session information is simply a
297-- function to load up session information. The session information is simply a
181−-- string map \[(String, String)\]. A logical type signatures for this middleware
298+-- string map \[(String, String)\]. A logical type signature for this middleware
182-- might be:
299-- might be:
183--
300--
184-- @ loadSession :: ([(String, String)] -> Application) -> Application @
301-- @ loadSession :: ([(String, String)] -> Application) -> Application @
@@ -187,8 +304,45 @@ type Application = Request -> C.ResourceT IO Response
187-- middleware takes a function which consumes the session information as well.
304-- middleware takes a function which consumes the session information as well.
188type Middleware = Application -> Application
305type Middleware = Application -> Application
189
306
190−-- | The size of the request body. In the case of chunked bodies, the size will
307+
191−-- not be known.
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.
192--
336--
193−-- Since 1.4.0
337+-- Since 1.4.1
194−data RequestBodyLength = ChunkedBody | KnownLength Word64
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.md+17−16
@@ -11,16 +11,14 @@ You want a minimal example? Here it is!
11import Network.Wai
11import Network.Wai
12import Network.HTTP.Types
12import Network.HTTP.Types
13import Network.Wai.Handler.Warp (run)
13import Network.Wai.Handler.Warp (run)
14−import Data.ByteString.Lazy.Char8 () -- Just for an orphan instance
15−import Control.Monad.IO.Class (liftIO)
16
14
17app :: Application
15app :: Application
18−app _ = do
16+app _ respond = do
19− liftIO $ putStrLn "I've done some IO here"
17+ putStrLn "I've done some IO here"
20− return $ responseLBS
18+ respond $ responseLBS
21− status200
19+ status200
22− [("Content-Type", "text/plain")]
20+ [("Content-Type", "text/plain")]
23− "Hello, Web!"
21+ "Hello, Web!"
24
22
25main :: IO ()
23main :: IO ()
26main = do
24main = do
@@ -52,9 +50,10 @@ Now we redefine `responseBody` to refer to that file:
52
50
53~~~ {.haskell}
51~~~ {.haskell}
54app2 :: Application
52app2 :: Application
55−app2 _ = return index
53+app2 _ respond = respond index
56
54
57−index = ResponseFile
55+index :: Response
56+index = responseFile
58 status200
57 status200
59 [("Content-Type", "text/html")]
58 [("Content-Type", "text/html")]
60 "index.html"
59 "index.html"
@@ -68,23 +67,25 @@ Basic dispatching
68An `Application` maps `Request`s to `Response`s:
67An `Application` maps `Request`s to `Response`s:
69
68
70 ghci> :info Application
69 ghci> :info Application
71− type Application = Request -> IO Response
70+ type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
72
71
73Depending on the path info provided with each `Request` we can serve different `Response`s:
72Depending on the path info provided with each `Request` we can serve different `Response`s:
74
73
75~~~ {.haskell}
74~~~ {.haskell}
76app3 :: Application
75app3 :: Application
77−app3 request = case rawPathInfo request of
76+app3 request respond = respond $ case rawPathInfo request of
78− "/" -> return index
77+ "/" -> index
79− "/raw/" -> return plainIndex
78+ "/raw/" -> plainIndex
80− _ -> return notFound
79+ _ -> notFound
81
80
82−plainIndex = ResponseFile
81+plainIndex :: Response
82+plainIndex = responseFile
83 status200
83 status200
84 [("Content-Type", "text/plain")]
84 [("Content-Type", "text/plain")]
85 "index.html"
85 "index.html"
86 Nothing
86 Nothing
87
87
88+notFound :: Response
88notFound = responseLBS
89notFound = responseLBS
89 status404
90 status404
90 [("Content-Type", "text/plain")]
91 [("Content-Type", "text/plain")]
wai/test.hsdeleted−9
@@ -1,9 +0,0 @@
1−import Network.Wai
2−import Data.Enumerator.List (consume)
3−import Blaze.ByteString.Builder (toByteString)
4−import Data.Monoid (mconcat)
5−import Data.ByteString.Char8 (pack)
6−
7−main = do
8− b <- responseEnumerator (ResponseFile undefined undefined "test.hs" (Just $ FilePart 7 7)) (const $ const consume)
9− print $ toByteString (mconcat b) == pack "Network"
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.cabal+26−8
@@ -1,7 +1,9 @@
1Name: wai
1Name: wai
2−Version: 1.4.0.1
2+Version: 3.2.2.1
3Synopsis: Web Application Interface.
3Synopsis: Web Application Interface.
4Description: Provides a common protocol for communication between web applications and web servers.
4Description: 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>.
5License: MIT
7License: MIT
6License-file: LICENSE
8License-file: LICENSE
7Author: Michael Snoyman
9Author: Michael Snoyman
@@ -9,22 +11,38 @@ Maintainer: michael@snoyman.com
9Homepage: https://github.com/yesodweb/wai
11Homepage: https://github.com/yesodweb/wai
10Category: Web
12Category: Web
11Build-Type: Simple
13Build-Type: Simple
12−Cabal-Version: >=1.6
14+Cabal-Version: >=1.8
13Stability: Stable
15Stability: Stable
16+extra-source-files: README.md ChangeLog.md
14
17
15Source-repository head
18Source-repository head
16 type: git
19 type: git
17 location: git://github.com/yesodweb/wai.git
20 location: git://github.com/yesodweb/wai.git
18
21
19Library
22Library
20− Build-Depends: base >= 4 && < 5
23+ Build-Depends: base >= 4.8 && < 5
21− , bytestring >= 0.9.1.4
24+ , bytestring >= 0.10.4
22− , blaze-builder >= 0.2.1.4 && < 0.4
23− , conduit >= 0.5 && < 1.1
24 , network >= 2.2.1.5
25 , network >= 2.2.1.5
25 , http-types >= 0.7
26 , http-types >= 0.7
26 , text >= 0.7
27 , text >= 0.7
27− , transformers >= 0.2.2
28− , vault >= 0.1 && < 0.3
28+ , vault >= 0.3 && < 0.4
29 Exposed-modules: Network.Wai
29 Exposed-modules: Network.Wai
30+ Network.Wai.Internal
30 ghc-options: -Wall
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/webkit-sample.hs+2−2
@@ -5,7 +5,7 @@ import Network.Wai.Handler.Webkit
5import Data.ByteString (ByteString)
5import Data.ByteString (ByteString)
6import qualified Data.ByteString.Lazy as L
6import qualified Data.ByteString.Lazy as L
7import Data.Enumerator (consume, Iteratee)
7import Data.Enumerator (consume, Iteratee)
8−import Blaze.ByteString.Builder (fromLazyByteString)
8+import Data.ByteString.Builder (lazyByteString)
9
9
10main :: IO ()
10main :: IO ()
11main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
11main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
@@ -27,4 +27,4 @@ postResponse :: L.ByteString -> Iteratee ByteString IO Response
27postResponse lbs = return $ ResponseBuilder
27postResponse lbs = return $ ResponseBuilder
28 status200
28 status200
29 [("Content-Type", "text/plain")]
29 [("Content-Type", "text/plain")]
30− (fromLazyByteString lbs)
30+ (lazyByteString lbs)
warp-static/LICENSEdeleted−20
@@ -1,20 +0,0 @@
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-static/READMEdeleted

No changes to the content.

warp-static/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
warp-static/warp-static.cabaldeleted−30
@@ -1,30 +0,0 @@
1−Name: warp-static
2−Version: 1.3.0.1
3−Synopsis: Static file server based on Warp and wai-app-static
4−Homepage: http://github.com/yesodweb/wai
5−License: MIT
6−License-file: LICENSE
7−Author: Michael Snoyman
8−Maintainer: michael@snoyman.com
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.6
12−Description: Serve up static files by running the warp executable. Based on Warp and wai-app-static.
13−
14−
15−Executable warp
16− Main-is: warp.hs
17− Build-depends: base >= 4 && < 5
18− , warp >= 1.3 && < 1.4
19− , wai-app-static >= 1.3 && < 1.4
20− , wai-extra >= 1.3 && < 1.4
21− , cmdargs >= 0.6.7
22− , directory >= 1.0
23− , containers >= 0.2
24− , bytestring >= 0.9.1.4
25− , text >= 0.7 && < 0.12
26− , mime-types >= 0.1 && < 0.2
27−
28−source-repository head
29− type: git
30− location: git://github.com/yesodweb/wai.git
warp-static/warp.hsdeleted−53
@@ -1,53 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable, RecordWildCards #-}
2−import Network.Wai.Application.Static (staticApp, defaultFileServerSettings)
3−import Network.Wai.Handler.Warp
4− ( runSettings, defaultSettings, settingsHost, settingsPort
5− )
6−import System.Console.CmdArgs hiding (def)
7−import Text.Printf (printf)
8−import System.Directory (canonicalizePath)
9−import Control.Monad (unless)
10−import Network.Wai.Middleware.Autohead
11−import Network.Wai.Middleware.RequestLogger (logStdout)
12−import Network.Wai.Middleware.Gzip
13−import qualified Data.Map as Map
14−import qualified Data.ByteString.Char8 as S8
15−import Control.Arrow ((***))
16−import Data.Text (pack)
17−import Data.String (fromString)
18−import Network.Mime (defaultMimeMap, mimeByExt, defaultMimeType)
19−import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
20−import Data.Maybe (mapMaybe)
21−
22−data Args = Args
23− { docroot :: FilePath
24− , index :: [FilePath]
25− , port :: Int
26− , noindex :: Bool
27− , quiet :: Bool
28− , verbose :: Bool
29− , mime :: [(String, String)]
30− , host :: String
31− }
32− deriving (Show, Data, Typeable)
33−
34−defaultArgs :: Args
35−defaultArgs = Args "." ["index.html", "index.htm"] 3000 False False False [] "*"
36−
37−main :: IO ()
38−main = do
39− Args {..} <- cmdArgs defaultArgs
40− let mime' = map (pack *** S8.pack) mime
41− let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
42− docroot' <- canonicalizePath docroot
43− unless quiet $ printf "Serving directory %s on port %d with %s index files.\n" docroot' port (if noindex then "no" else show index)
44− let middle = gzip def { gzipFiles = GzipCompress }
45− . (if verbose then logStdout else id)
46− . autohead
47− runSettings defaultSettings
48− { settingsPort = port
49− , settingsHost = fromString host
50− } $ middle $ staticApp (defaultFileServerSettings $ fromString docroot)
51− { ssIndices = if noindex then [] else mapMaybe (toPiece . pack) index
52− , ssGetMimeType = return . mimeByExt mimeMap defaultMimeType . fromPiece . fileName
53− }
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/Network/Wai/Handler/WarpTLS.hs+488−156
@@ -1,199 +1,531 @@
1+{-# LANGUAGE CPP #-}
1{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE RankNTypes #-}
3{-# LANGUAGE RankNTypes #-}
3{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE DeriveDataTypeable #-}
5{-# LANGUAGE DeriveDataTypeable #-}
6+{-# LANGUAGE PatternGuards #-}
5
7
6−-- | HTTP over SSL/TLS support for Warp via the TLS package.
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.
7
14
8module Network.Wai.Handler.WarpTLS (
15module Network.Wai.Handler.WarpTLS (
9 -- * Settings
16 -- * Settings
10 TLSSettings
17 TLSSettings
18+ , defaultTlsSettings
19+ -- * Smart constructors
20+ , tlsSettings
21+ , tlsSettingsMemory
22+ , tlsSettingsChain
23+ , tlsSettingsChainMemory
24+ -- * Accessors
11 , certFile
25 , certFile
12 , keyFile
26 , keyFile
13− , onInsecure
14 , tlsLogging
27 , tlsLogging
15− , defaultTlsSettings
28+ , tlsAllowedVersions
16− , tlsSettings
29+ , tlsCiphers
30+ , tlsWantClientCert
31+ , tlsServerHooks
32+ , tlsServerDHEParams
33+ , tlsSessionManagerConfig
34+ , onInsecure
17 , OnInsecure (..)
35 , OnInsecure (..)
18 -- * Runner
36 -- * Runner
19 , runTLS
37 , runTLS
20 , runTLSSocket
38 , runTLSSocket
21 -- * Exception
39 -- * Exception
22 , WarpTLSException (..)
40 , WarpTLSException (..)
41+ , DH.Params
42+ , DH.generateParams
23 ) where
43 ) where
24
44
25−import qualified Network.TLS as TLS
45+import Control.Applicative ((<|>))
26−import Network.Wai.Handler.Warp
46+import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..), handleJust)
27−import Network.Wai
47+import qualified Control.Exception as E
28−import Network.Socket
48+import Control.Monad (void, guard)
49+import qualified Data.ByteString as S
29import qualified Data.ByteString.Lazy as L
50import qualified Data.ByteString.Lazy as L
30−import Data.Conduit.Binary (sourceFileRange)
51+import Data.Default.Class (def)
31−import qualified Data.Conduit as C
32−import qualified Data.Conduit.List as CL
33−import Control.Exception (bracket)
34−import qualified Network.TLS.Extra as TLSExtra
35−import qualified Data.Certificate.X509 as X509
36−import qualified Data.ByteString as B
37−import qualified Data.Certificate.KeyRSA as KeyRSA
38−import Data.Conduit.Network (bindPort)
39−import Data.Either (rights)
40−import Control.Applicative ((<$>))
41−import qualified Data.PEM as PEM
42−import Data.Conduit.Network (sourceSocket, sinkSocket, acceptSafe)
43−import Data.Maybe (fromMaybe)
44import qualified Data.IORef as I
52import qualified Data.IORef as I
45−import Crypto.Random.API (getSystemRandomGen)
53+import Data.Streaming.Network (bindPortTCP, safeRecv)
46−import Control.Exception (Exception, throwIO)
47import Data.Typeable (Typeable)
54import Data.Typeable (Typeable)
48−import qualified Data.Conduit.Binary as CB
55+import Network.Socket (Socket, close, withSocketsDo, SockAddr, accept)
49−
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.
50−data TLSSettings = TLSSettings
72+data TLSSettings = TLSSettings {
51− { certFile :: FilePath
73+ certFile :: FilePath
52− -- ^ File containing the certificate.
74+ -- ^ File containing the certificate.
75+ , chainCertFiles :: [FilePath]
76+ -- ^ Files containing chain certificates.
53− , keyFile :: FilePath
77+ , keyFile :: FilePath
54− -- ^ File containing the key
78+ -- ^ File containing the key
79+ , certMemory :: Maybe S.ByteString
80+ , chainCertsMemory :: [S.ByteString]
81+ , keyMemory :: Maybe S.ByteString
55− , onInsecure :: OnInsecure
82+ , onInsecure :: OnInsecure
56− -- ^ Do we allow insecure connections with this server as well? Default
83+ -- ^ Do we allow insecure connections with this server as well?
57− -- is a simple text response stating that a secure connection is required.
84+ --
85+ -- >>> onInsecure defaultTlsSettings
86+ -- DenyInsecure "This server only accepts secure HTTPS connections."
58− --
87+ --
59− -- Since 1.4.0
88+ -- Since 1.4.0
60− , tlsLogging :: TLS.Logging
89+ , tlsLogging :: TLS.Logging
61− -- ^ The level of logging to turn on.
90+ -- ^ The level of logging to turn on.
62− --
91+ --
63− -- Default: 'TLS.defaultLogging'.
92+ -- Default: 'TLS.defaultLogging'.
64− --
93+ --
65− -- Since 1.4.0
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
66− }
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+----------------------------------------------------------------
67
190
68-- | An action when a plain HTTP comes to HTTP over TLS/SSL port.
191-- | An action when a plain HTTP comes to HTTP over TLS/SSL port.
69data OnInsecure = DenyInsecure L.ByteString
192data OnInsecure = DenyInsecure L.ByteString
70 | AllowInsecure
193 | AllowInsecure
194+ deriving (Show)
71
195
196+----------------------------------------------------------------
197+
72−-- | A smart constructor for 'TLSSettings'.
198+-- | A smart constructor for 'TLSSettings' based on 'defaultTlsSettings'.
73tlsSettings :: FilePath -- ^ Certificate file
199tlsSettings :: FilePath -- ^ Certificate file
74 -> FilePath -- ^ Key file
200 -> FilePath -- ^ Key file
75 -> TLSSettings
201 -> TLSSettings
76−tlsSettings cert key = defaultTlsSettings
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 {
77− { certFile = cert
217+ certFile = cert
218+ , chainCertFiles = chainCerts
78− , keyFile = key
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
79 }
233 }
80
234
81−-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name.
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
82−defaultTlsSettings :: TLSSettings
243+ -> TLSSettings
83−defaultTlsSettings = TLSSettings
244+tlsSettingsChainMemory cert chainCerts key = defaultTlsSettings
84− { certFile = "certificate.pem"
245+ { certMemory = Just cert
85− , keyFile = "key.pem"
246+ , chainCertsMemory = chainCerts
86− , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
247+ , keyMemory = Just key
87− , tlsLogging = TLS.defaultLogging
88 }
248 }
89
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+
90-- | Running 'Application' with 'TLSSettings' and 'Settings' using
262-- | Running 'Application' with 'TLSSettings' and 'Settings' using
91-- specified 'Socket'.
263-- specified 'Socket'.
92runTLSSocket :: TLSSettings -> Settings -> Socket -> Application -> IO ()
264runTLSSocket :: TLSSettings -> Settings -> Socket -> Application -> IO ()
93−runTLSSocket TLSSettings {..} set sock app = do
265+runTLSSocket tlsset@TLSSettings{..} set sock app = do
94− certs <- readCertificates certFile
266+ credential <- case (certMemory, keyMemory) of
95− pk <- readPrivateKey keyFile
267+ (Nothing, Nothing) ->
96− let params =
268+ either error id <$>
97− TLS.updateServerParams
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
98− (\sp -> sp { TLS.serverWantClientCert = False }) $
286+ TLS.serverWantClientCert = tlsWantClientCert
99− TLS.defaultParamsServer
287+ , TLS.serverCACertificates = []
100− { TLS.pAllowedVersions = [TLS.SSL3,TLS.TLS10,TLS.TLS11,TLS.TLS12]
288+ , TLS.serverDHEParams = tlsServerDHEParams
101− , TLS.pCiphers = ciphers
289+ , TLS.serverHooks = hooks
102− , TLS.pCertificates = zip certs $ (Just pk):repeat Nothing
290+ , TLS.serverShared = shared
103− , TLS.pLogging = tlsLogging
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
104− }
370+ }
105− runSettingsConnectionMaker set (getter params) app
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)
106 where
440 where
107− getter params = do
441+ len0 = S.length bs0
108− (s, sa) <- acceptSafe sock
442+ loop _ 0 = return (True, "")
109− let mkConn = do
443+ loop buf siz = do
110− (fromClient, firstBS) <- sourceSocket s C.$$+ CL.peek
444+ bs <- recv
111− let toClient = sinkSocket s
445+ let len = S.length bs
112− ifromClient <- I.newIORef fromClient
113− let getNext sink = do
114− fromClient' <- I.readIORef ifromClient
115− (fromClient'', bs) <- fromClient' C.$$++ sink
116− I.writeIORef ifromClient fromClient''
117− return bs
446+ if len == 0 then return (False, "")
118− if maybe False ((== 0x16) . fst) (firstBS >>= B.uncons)
447+ else if (len <= siz) then do
119− then do
448+ buf' <- copy buf bs
120− gen <- getSystemRandomGen
449+ loop buf' (siz - len)
121− ctx <- TLS.contextNew
450+ else do
122− TLS.Backend
451+ let (bs1,bs2) = S.splitAt siz bs
123− { TLS.backendFlush = return ()
452+ void $ copy buf bs1
124− , TLS.backendClose = return ()
453+ return (True, bs2)
125− , TLS.backendSend = \bs -> C.yield bs C.$$ toClient
454+
126− , TLS.backendRecv = getNext . fmap (B.concat . L.toChunks) . CB.take
455+getTLSinfo :: TLS.Context -> IO Transport
127− }
456+getTLSinfo ctx = do
128− params
457+ proto <- TLS.getNegotiatedProtocol ctx
129− gen
458+ minfo <- TLS.contextGetInformation ctx
130− TLS.handshake ctx
459+ case minfo of
131− let conn = Connection
460+ Nothing -> return TCP
132− { connSendMany = TLS.sendData ctx . L.fromChunks
461+ Just TLS.Information{..} -> do
133− , connSendAll = TLS.sendData ctx . L.fromChunks . return
462+ let (major, minor) = case infoVersion of
134− , connSendFile = \fp offset len _th headers _cleaner -> do
463+ TLS.SSL2 -> (2,0)
135− TLS.sendData ctx $ L.fromChunks headers
464+ TLS.SSL3 -> (3,0)
136− C.runResourceT $ sourceFileRange fp (Just offset) (Just len) C.$$ CL.mapM_ (TLS.sendData ctx . L.fromChunks . return)
465+ TLS.TLS10 -> (3,1)
137− , connClose = do
466+ TLS.TLS11 -> (3,2)
138− TLS.bye ctx
467+ TLS.TLS12 -> (3,3)
139− sClose s
468+#if MIN_VERSION_tls(1,5,0)
140− , connRecv = TLS.recvData ctx
469+ TLS.TLS13 -> (3,4)
141− }
470+#endif
142− return conn
471+ clientCert <- TLS.getClientCertificateChain ctx
143− else
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)
144− case onInsecure of
486+plainHTTP TLSSettings{..} set s bs0 = case onInsecure of
145− AllowInsecure ->
487+ AllowInsecure -> do
146− let conn = (socketConnection s)
488+ conn' <- socketConnection set s
147− { connRecv = getNext $ fmap (fromMaybe B.empty) C.await
489+ cachedRef <- I.newIORef bs0
490+ let conn'' = conn'
491+ { connRecv = recvPlain cachedRef (connRecv conn')
148− }
492+ }
149− in return conn
493+ return (conn'', TCP)
150− DenyInsecure lbs -> do
494+ DenyInsecure lbs -> do
151− let src = 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\
152− C.yield "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\n\r\n"
508+ \r\nContent-Type: text/plain\r\n\r\n"
153− mapM_ C.yield $ L.toChunks lbs
509+ mapM_ (sendAll s) $ L.toChunks lbs
154− src C.$$ sinkSocket s
510+ close s
155− sClose s
156− throwIO InsecureConnectionDenied
511+ throwIO InsecureConnectionDenied
157− return (mkConn, sa)
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+----------------------------------------------------------------
158
528
159data WarpTLSException = InsecureConnectionDenied
529data WarpTLSException = InsecureConnectionDenied
160 deriving (Show, Typeable)
530 deriving (Show, Typeable)
161instance Exception WarpTLSException
531instance Exception WarpTLSException
162−
163−-- | Running 'Application' with 'TLSSettings' and 'Settings'.
164−runTLS :: TLSSettings -> Settings -> Application -> IO ()
165−runTLS tset set app =
166− bracket
167− (bindPort (settingsPort set) (settingsHost set))
168− sClose
169− (\sock -> runTLSSocket tset set sock app)
170−
171−-- taken from stunnel example in tls-extra
172−ciphers :: [TLS.Cipher]
173−ciphers =
174− [ TLSExtra.cipher_AES128_SHA1
175− , TLSExtra.cipher_AES256_SHA1
176− , TLSExtra.cipher_RC4_128_MD5
177− , TLSExtra.cipher_RC4_128_SHA1
178− ]
179−
180−readCertificates :: FilePath -> IO [X509.X509]
181−readCertificates filepath = do
182− certs <- rights . parseCerts . PEM.pemParseBS <$> B.readFile filepath
183− case certs of
184− []-> error "no valid certificate found"
185− x -> return x
186− where parseCerts (Right pems) = map (X509.decodeCertificate . L.fromChunks . (:[]) . PEM.pemContent)
187− $ filter (flip elem ["CERTIFICATE", "TRUSTED CERTIFICATE"] . PEM.pemName) pems
188− parseCerts (Left err) = error $ "cannot parse PEM file: " ++ err
189−
190−readPrivateKey :: FilePath -> IO TLS.PrivateKey
191−readPrivateKey filepath = do
192− pk <- rights . parseKey . PEM.pemParseBS <$> B.readFile filepath
193− case pk of
194− [] -> error "no valid RSA key found"
195− (x:_) -> return x
196−
197− where parseKey (Right pems) = map (fmap (TLS.PrivRSA . snd) . KeyRSA.decodePrivate . L.fromChunks . (:[]) . PEM.pemContent)
198− $ filter ((== "RSA PRIVATE KEY") . PEM.pemName) pems
199− parseKey (Left err) = error $ "Cannot parse PEM file: " ++ err
warp-tls/README.md+4
@@ -1,3 +1,7 @@
1+## warp-tls
2+
3+Serve WAI applications using the Warp webserver and the Haskell TLS library.
4+
1In order to generate a self-signed certificate for testing, try the following:
5In order to generate a self-signed certificate for testing, try the following:
2
6
3 openssl genrsa -out key.pem 2048
7 openssl genrsa -out key.pem 2048
warp-tls/pong.hs+16−13
@@ -1,6 +1,6 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2import Network.Wai
2import Network.Wai
3−import Network.Wai.Handler.Warp (defaultSettings, settingsPort)
3+import Network.Wai.Handler.Warp (defaultSettings, setPort)
4import Network.Wai.Handler.WarpTLS
4import Network.Wai.Handler.WarpTLS
5import Network.HTTP.Types (status200)
5import Network.HTTP.Types (status200)
6import Blaze.ByteString.Builder (copyByteString)
6import Blaze.ByteString.Builder (copyByteString)
@@ -12,10 +12,12 @@ import Network.HTTP.Conduit
12
12
13main = do
13main = do
14 putStrLn "https://localhost:3009/"
14 putStrLn "https://localhost:3009/"
15− manager <- newManager def
15+ --manager <- newManager def
16− runTLS (tlsSettings "config/tls-cert" "config/tls-key") defaultSettings { settingsPort = 3009 } app
16+ runTLS (tlsSettings "certificate.pem" "key.pem")
17+ { onInsecure = AllowInsecure
18+ } (setPort 3009 defaultSettings) app
17
19
18−app req = return $
20+app req f = f $
19 case rawPathInfo req of
21 case rawPathInfo req of
20 "/builder/withlen" -> builderWithLen
22 "/builder/withlen" -> builderWithLen
21 "/builder/nolen" -> builderNoLen
23 "/builder/nolen" -> builderNoLen
@@ -23,35 +25,36 @@ app req = return $
23 "/file/nolen" -> fileNoLen
25 "/file/nolen" -> fileNoLen
24 "/source/withlen" -> sourceWithLen
26 "/source/withlen" -> sourceWithLen
25 "/source/nolen" -> sourceNoLen
27 "/source/nolen" -> sourceNoLen
28+ "/secure" -> responseLBS status200 [] $ if isSecure req then "secure" else "insecure"
26 x -> index x
29 x -> index x
27
30
28−builderWithLen = ResponseBuilder
31+builderWithLen = responseBuilder
29 status200
32 status200
30 [ ("Content-Type", "text/plain")
33 [ ("Content-Type", "text/plain")
31 , ("Content-Length", "4")
34 , ("Content-Length", "4")
32 ]
35 ]
33 $ copyByteString "PONG"
36 $ copyByteString "PONG"
34
37
35−builderNoLen = ResponseBuilder
38+builderNoLen = responseBuilder
36 status200
39 status200
37 [ ("Content-Type", "text/plain")
40 [ ("Content-Type", "text/plain")
38 ]
41 ]
39 $ copyByteString "PONG"
42 $ copyByteString "PONG"
40
43
41−sourceWithLen = ResponseSource
44+sourceWithLen = responseStream
42 status200
45 status200
43 [ ("Content-Type", "text/plain")
46 [ ("Content-Type", "text/plain")
44 , ("Content-Length", "4")
47 , ("Content-Length", "4")
45 ]
48 ]
46− $ CL.sourceList [C.Chunk $ copyByteString "PONG"]
49+ $ \sendChunk _flush -> sendChunk $ copyByteString "PONG"
47
50
48−sourceNoLen = ResponseSource
51+sourceNoLen = responseStream
49 status200
52 status200
50 [ ("Content-Type", "text/plain")
53 [ ("Content-Type", "text/plain")
51 ]
54 ]
52− $ CL.sourceList [C.Chunk $ copyByteString "PONG"]
55+ $ \sendChunk _flush -> sendChunk $ copyByteString "PONG"
53
56
54−fileWithLen = ResponseFile
57+fileWithLen = responseFile
55 status200
58 status200
56 [ ("Content-Type", "text/plain")
59 [ ("Content-Type", "text/plain")
57 , ("Content-Length", "4")
60 , ("Content-Length", "4")
@@ -59,14 +62,14 @@ fileWithLen = ResponseFile
59 "pong.txt"
62 "pong.txt"
60 Nothing
63 Nothing
61
64
62−fileNoLen = ResponseFile
65+fileNoLen = responseFile
63 status200
66 status200
64 [ ("Content-Type", "text/plain")
67 [ ("Content-Type", "text/plain")
65 ]
68 ]
66 "pong.txt"
69 "pong.txt"
67 Nothing
70 Nothing
68
71
69−index p = ResponseBuilder status200 [("Content-Type", "text/html")] $ mconcat $ map copyByteString
72+index p = responseBuilder status200 [("Content-Type", "text/html")] $ mconcat $ map copyByteString
70 [ "<p><a href='/builder/withlen'>builder withlen</a></p>\n"
73 [ "<p><a href='/builder/withlen'>builder withlen</a></p>\n"
71 , "<p><a href='/builder/nolen'>builder nolen</a></p>\n"
74 , "<p><a href='/builder/nolen'>builder nolen</a></p>\n"
72 , "<p><a href='/file/withlen'>file withlen</a></p>\n"
75 , "<p><a href='/file/withlen'>file withlen</a></p>\n"
warp-tls/pong.txt+1−1
@@ -1 +1 @@
1−PONG
1+PONG
warp-tls/warp-tls.cabal+23−16
@@ -1,6 +1,6 @@
1Name: warp-tls
1Name: warp-tls
2−Version: 1.4.1
2+Version: 3.2.11
3−Synopsis: HTTP over SSL/TLS support for Warp via the TLS package
3+Synopsis: HTTP over TLS support for Warp via the TLS package
4License: MIT
4License: MIT
5License-file: LICENSE
5License-file: LICENSE
6Author: Michael Snoyman
6Author: Michael Snoyman
@@ -8,27 +8,34 @@ Maintainer: michael@snoyman.com
8Homepage: http://github.com/yesodweb/wai
8Homepage: http://github.com/yesodweb/wai
9Category: Web, Yesod
9Category: Web, Yesod
10Build-Type: Simple
10Build-Type: Simple
11−Cabal-Version: >=1.6
11+Cabal-Version: >= 1.10
12Stability: Stable
12Stability: Stable
13−Description: HTTP over SSL/TLS support for Warp via the TLS package.
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
14
19
15Library
20Library
16− Build-Depends: base >= 4 && < 5
21+ Build-Depends: base >= 4.10 && < 5
17 , bytestring >= 0.9
22 , bytestring >= 0.9
18− , wai >= 1.3 && < 1.5
23+ , wai >= 3.2 && < 3.3
19− , warp >= 1.3.5 && < 1.4
24+ , warp >= 3.3.6 && < 3.4
20− , transformers >= 0.2
25+ , data-default-class >= 0.0.1
21− , conduit >= 0.5 && < 1.1
22− , network-conduit >= 0.6 && < 1.1
23− , certificate >= 1.2
24− , pem >= 0.1
25− , cryptocipher >= 0.3
26− , tls-extra >= 0.6
27− , tls >= 1.1
26+ , tls >= 1.5.3
28− , crypto-random-api >= 0.2
27+ , cryptonite >= 0.12
29 , network >= 2.2.1
28 , network >= 2.2.1
29+ , streaming-commons
30+ , tls-session-manager >= 0.0.4
30 Exposed-modules: Network.Wai.Handler.WarpTLS
31 Exposed-modules: Network.Wai.Handler.WarpTLS
31 ghc-options: -Wall
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+
32
39
33source-repository head
40source-repository head
34 type: git
41 type: git
warp/.ghci+1−1
@@ -1 +1 @@
1−:set -itest -idist/build/autogen -optP-include -optPdist/build/autogen/cabal_macros.h
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/Network/Wai/Handler/Warp.hs+476−44
@@ -1,4 +1,7 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2+{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE PatternGuards #-}
4+{-# OPTIONS_GHC -fno-warn-deprecations #-}
2
5
3---------------------------------------------------------
6---------------------------------------------------------
4--
7--
@@ -15,63 +18,492 @@
15---------------------------------------------------------
18---------------------------------------------------------
16
19
17-- | A fast, light-weight HTTP server handler for WAI.
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+--
18module Network.Wai.Handler.Warp (
39module Network.Wai.Handler.Warp (
19 -- * Run a Warp server
40 -- * Run a Warp server
41+ -- | All of these automatically serve the same 'Application' over HTTP\/1,
42+ -- HTTP\/1.1, and HTTP\/2.
20 run
43 run
44+ , runEnv
21 , runSettings
45 , runSettings
22 , runSettingsSocket
46 , runSettingsSocket
23 -- * Settings
47 -- * Settings
24 , Settings
48 , Settings
25 , defaultSettings
49 , defaultSettings
26− , settingsPort
50+ -- ** Setters
27− , settingsHost
51+ , setPort
28− , settingsOnException
52+ , setHost
29− , settingsOnOpen
53+ , setOnException
30− , settingsOnClose
54+ , setOnExceptionResponse
31− , settingsTimeout
55+ , setOnOpen
32− , settingsIntercept
56+ , setOnClose
33− , settingsManager
57+ , setTimeout
34− , settingsFdCacheDuration
58+ , setManager
35− , settingsResourceTPerRequest
59+ , setFdCacheDuration
36− , settingsBeforeMainLoop
60+ , setFileInfoCacheDuration
37− , settingsServerName
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
38− -- ** Data types
93+ -- * Data types
39− , HostPreference (..)
94+ , HostPreference
40− -- * Connection
41− , Connection (..)
42− , runSettingsConnection
43− , runSettingsConnectionMaker
44− -- * Datatypes
45 , Port
95 , Port
46 , InvalidRequest (..)
96 , InvalidRequest (..)
47− -- * Internal (Manager)
97+ -- * Utilities
48− , Manager
98+ , pauseTimeout
49− , Handle
99+ , FileInfo(..)
50− , initialize
100+ , getFileInfo
51− , withManager
101+ , clientCertificate
52− , register
102+ , withApplication
53− , registerKillThread
103+ , withApplicationSettings
54− , pause
104+ , testWithApplication
55− , resume
105+ , testWithApplicationSettings
56− , cancel
106+ , openFreePort
57− -- * Internal
107+ -- * Version
58− , parseRequest
59− , sendResponse
60− , dummyCleaner
61− , socketConnection
62−#if TEST
63− , takeHeaders
64− , parseFirst
65− , readInt
66−#endif
67− -- * Misc
68 , warpVersion
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
69 ) where
125 ) where
70
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
71import Network.Wai.Handler.Warp.Request
140import Network.Wai.Handler.Warp.Request
72−import Network.Wai.Handler.Warp.Response
141+import Network.Wai.Handler.Warp.Response (warpVersion)
73import Network.Wai.Handler.Warp.Run
142import Network.Wai.Handler.Warp.Run
74import Network.Wai.Handler.Warp.Settings
143import Network.Wai.Handler.Warp.Settings
75−import Network.Wai.Handler.Warp.Types
144+import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
76−import Network.Wai.Handler.Warp.Timeout
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
77−import Data.Conduit.Network (HostPreference(..))
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.hs+106−97
@@ -1,41 +1,40 @@
1+{-# LANGUAGE CPP #-}
2+
1module Network.Wai.Handler.Warp.Conduit where
3module Network.Wai.Handler.Warp.Conduit where
2
4
3−import Control.Applicative
4import Control.Exception
5import Control.Exception
5−import Control.Monad (unless)
6−import Control.Monad.IO.Class (MonadIO, liftIO)
7−import Control.Monad.Trans.Class (lift)
8−import Data.ByteString (ByteString)
9−import Data.ByteString.Lazy.Char8 (pack)
10import qualified Data.ByteString as S
6import qualified Data.ByteString as S
11−import qualified Data.ByteString.Lazy as L
12−import Data.Conduit
13−import qualified Data.Conduit.Binary as CB
14−import Data.Conduit.Internal (ResumableSource (..))
15−import qualified Data.Conduit.List as CL
16import qualified Data.IORef as I
7import qualified Data.IORef as I
17−import Data.Word (Word, Word8)
8+
9+import Network.Wai.Handler.Warp.Imports
18import Network.Wai.Handler.Warp.Types
10import Network.Wai.Handler.Warp.Types
19
11
20----------------------------------------------------------------
12----------------------------------------------------------------
21
13
22-- | Contains a @Source@ and a byte count that is still to be read in.
14-- | Contains a @Source@ and a byte count that is still to be read in.
23−newtype IsolatedBSSource = IsolatedBSSource (I.IORef (Int, ResumableSource (ResourceT IO) ByteString))
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
24
21
25-- | Given an @IsolatedBSSource@ provide a @Source@ that only allows up to the
22-- | Given an @IsolatedBSSource@ provide a @Source@ that only allows up to the
26-- specified number of bytes to be passed downstream. All leftovers should be
23-- specified number of bytes to be passed downstream. All leftovers should be
27-- retained within the @Source@. If there are not enough bytes available,
24-- retained within the @Source@. If there are not enough bytes available,
28-- throws a @ConnectionClosedByPeer@ exception.
25-- throws a @ConnectionClosedByPeer@ exception.
29−ibsIsolate :: IsolatedBSSource -> Source (ResourceT IO) ByteString
26+readISource :: ISource -> IO ByteString
30−ibsIsolate ibs@(IsolatedBSSource ref) = do
27+readISource (ISource src ref) = do
31− (count, src) <- liftIO $ I.readIORef ref
28+ count <- I.readIORef ref
32− unless (count == 0) $ do
29+ if count == 0
33− -- Get the next chunk (if available) and the updated source
30+ then return S.empty
34− (src', mbs) <- lift $ src $$++ CL.head
31+ else do
32+
33+ bs <- readSource src
35
34
36 -- If no chunk available, then there aren't enough bytes in the
35 -- If no chunk available, then there aren't enough bytes in the
37 -- stream. Throw a ConnectionClosedByPeer
36 -- stream. Throw a ConnectionClosedByPeer
38− bs <- maybe (liftIO $ throwIO ConnectionClosedByPeer) return mbs
37+ when (S.null bs) $ throwIO ConnectionClosedByPeer
39
38
40 let -- How many of the bytes in this chunk to send downstream
39 let -- How many of the bytes in this chunk to send downstream
41 toSend = min count (S.length bs)
40 toSend = min count (S.length bs)
@@ -48,16 +47,8 @@ ibsIsolate ibs@(IsolatedBSSource ref) = do
48 -- downstream, and then loop on this function for the
47 -- downstream, and then loop on this function for the
49 -- next chunk.
48 -- next chunk.
50 | count' > 0 -> do
49 | count' > 0 -> do
51− liftIO $ I.writeIORef ref (count', src')
50+ I.writeIORef ref count'
52− yield bs
51+ return bs
53− ibsIsolate ibs
54−
55− -- The expected count is the total size of the chunk we
56− -- just read. Send this chunk downstream, and then
57− -- terminate the stream.
58− | count == S.length bs -> do
59− liftIO $ I.writeIORef ref (count', src')
60− yield bs
61
52
62 -- Some of the bytes in this chunk should not be sent
53 -- Some of the bytes in this chunk should not be sent
63 -- downstream. Split up the chunk into the sent and
54 -- downstream. Split up the chunk into the sent and
@@ -65,84 +56,107 @@ ibsIsolate ibs@(IsolatedBSSource ref) = do
65 -- source, and send the rest of the chunk downstream.
56 -- source, and send the rest of the chunk downstream.
66 | otherwise -> do
57 | otherwise -> do
67 let (x, y) = S.splitAt toSend bs
58 let (x, y) = S.splitAt toSend bs
59+ leftoverSource src y
68− liftIO $ I.writeIORef ref (count', fmapResume (yield y >>) src')
60+ assert (count' == 0) $ I.writeIORef ref count'
69− yield x
61+ return x
70−
71−-- | Extract the underlying @Source@ from an @IsolatedBSSource@, which will not
72−-- perform any more isolation.
73−ibsDone :: IsolatedBSSource -> IO (ResumableSource (ResourceT IO) ByteString)
74−ibsDone (IsolatedBSSource ref) = snd <$> I.readIORef ref
75
62
76----------------------------------------------------------------
63----------------------------------------------------------------
77
64
65+data CSource = CSource !Source !(I.IORef ChunkState)
66+
78data ChunkState = NeedLen
67data ChunkState = NeedLen
79 | NeedLenNewline
68 | NeedLenNewline
80 | HaveLen Word
69 | HaveLen Word
81−
70+ | DoneChunking
82−bsCRLF :: L.ByteString
71+ deriving Show
83−bsCRLF = pack "\r\n"
72+
84−
73+mkCSource :: Source -> IO CSource
85−chunkedSource :: MonadIO m
74+mkCSource src = do
86− => I.IORef (ResumableSource m ByteString, ChunkState)
75+ ref <- I.newIORef NeedLen
87− -> Source m ByteString
76+ return $! CSource src ref
88−chunkedSource ipair = do
77+
78+readCSource :: CSource -> IO ByteString
79+readCSource (CSource src ref) = do
89− (src, mlen) <- liftIO $ I.readIORef ipair
80+ mlen <- I.readIORef ref
90− go src mlen
81+ go mlen
91 where
82 where
92− go' src front = do
83+ withLen 0 bs = do
93− (src', (len, bs)) <- lift $ src $$++ front getLen
84+ leftoverSource src bs
94− let src''
85+ dropCRLF
95− | S.null bs = src'
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
96− | otherwise = fmapResume (yield bs >>) src'
92+ | otherwise =
97− go src'' $ HaveLen len
93+ case S.length bs `compare` fromIntegral len of
98−
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+
99− go src NeedLen = go' src id
121+ go NeedLen = getLen
100− go src NeedLenNewline = go' src (CB.take 2 >>)
122+ go NeedLenNewline = dropCRLF >> getLen
101− go src (HaveLen 0) = do
123+ go (HaveLen 0) = do
102 -- Drop the final CRLF
124 -- Drop the final CRLF
103− (src', ()) <- lift $ src $$++ do
125+ dropCRLF
104− crlf <- CB.take 2
126+ I.writeIORef ref DoneChunking
105− unless (crlf == bsCRLF) $ leftover $ S.concat $ L.toChunks crlf
127+ return S.empty
106− liftIO $ I.writeIORef ipair (src', HaveLen 0)
107− go src (HaveLen len) = do
128+ go (HaveLen len) = do
108− (src', mbs) <- lift $ src $$++ CL.head
129+ bs <- readSource src
109− case mbs of
130+ withLen len bs
110− Nothing -> liftIO $ I.writeIORef ipair (src', HaveLen 0)
131+ go DoneChunking = return S.empty
111− Just bs ->
132+
112− case S.length bs `compare` fromIntegral len of
133+ -- Get the length from the source, and then pass off control to withLen
113− EQ -> yield' src' NeedLenNewline bs
114− LT -> do
115− let mlen = HaveLen $ len - fromIntegral (S.length bs)
116− yield' src' mlen bs
117− GT -> do
118− let (x, y) = S.splitAt (fromIntegral len) bs
119− let src'' = fmapResume (yield y >>) src'
120− yield' src'' NeedLenNewline x
121−
122− yield' src mlen bs = do
123− liftIO $ I.writeIORef ipair (src, mlen)
124− yield bs
125− go src mlen
126−
127− getLen :: Monad m => Sink ByteString m (Word, ByteString)
128 getLen = do
134 getLen = do
129− mbs <- CL.head
135+ bs <- readSource src
130− case mbs of
136+ if S.null bs
137+ then do
138+ I.writeIORef ref $ assert False $ HaveLen 0
131− Nothing -> return (0, S.empty)
139+ return S.empty
132− Just bs -> do
140+ else do
133 (x, y) <-
141 (x, y) <-
134− case S.breakByte 10 bs of
142+ case S.break (== 10) bs of
135 (x, y)
143 (x, y)
136 | S.null y -> do
144 | S.null y -> do
137− mbs2 <- CL.head
145+ bs2 <- readSource' src
138− case mbs2 of
146+ return $ if S.null bs2
139− Nothing -> return (x, y)
147+ then (x, y)
140− Just bs2 -> return $ S.breakByte 10 $ bs `S.append` bs2
148+ else S.break (== 10) $ bs `S.append` bs2
141 | otherwise -> return (x, y)
149 | otherwise -> return (x, y)
142 let w =
150 let w =
143 S.foldl' (\i c -> i * 16 + fromIntegral (hexToWord c)) 0
151 S.foldl' (\i c -> i * 16 + fromIntegral (hexToWord c)) 0
144 $ S.takeWhile isHexDigit x
152 $ S.takeWhile isHexDigit x
153+
154+ let y' = S.drop 1 y
155+ y'' <-
156+ if S.null y'
157+ then readSource src
145− return (w, S.drop 1 y)
158+ else return y'
159+ withLen w y''
146
160
147 hexToWord w
161 hexToWord w
148 | w < 58 = w - 48
162 | w < 58 = w - 48
@@ -153,8 +167,3 @@ isHexDigit :: Word8 -> Bool
153isHexDigit w = w >= 48 && w <= 57
167isHexDigit w = w >= 48 && w <= 57
154 || w >= 65 && w <= 70
168 || w >= 65 && w <= 70
155 || w >= 97 && w <= 102
169 || w >= 97 && w <= 102
156−
157−----------------------------------------------------------------
158−
159−fmapResume :: (Source m o1 -> Source m o2) -> ResumableSource m o1 -> ResumableSource m o2
160−fmapResume f (ResumableSource src m) = ResumableSource (f src) m
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.hs+95−73
@@ -1,19 +1,47 @@
1−{-# LANGUAGE BangPatterns, FlexibleInstances #-}
1+{-# LANGUAGE BangPatterns, CPP #-}
2+
3+-- | File descriptor cache to avoid locks in kernel.
2
4
3module Network.Wai.Handler.Warp.FdCache (
5module Network.Wai.Handler.Warp.FdCache (
4− initialize
6+ withFdCache
5− , getFd
7+ , Fd
6− , MutableFdCache
8+ , Refresh
9+#ifndef WINDOWS
10+ , openFile
11+ , closeFile
12+ , setFileCloseOnExec
13+#endif
7 ) where
14 ) where
8
15
16+#ifndef WINDOWS
9−import Control.Applicative ((<$>), (<*>))
17+import Control.Exception (bracket)
10−import Control.Concurrent
18+import Control.Reaper
11−import Control.Monad
12−import Data.Hashable
13import Data.IORef
19import Data.IORef
14−import Network.Wai.Handler.Warp.MultiMap
20+import Network.Wai.Handler.Warp.MultiMap as MM
15−import System.Posix.IO
21+import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd, FdOption(CloseOnExec), setFdOption)
22+#endif
16−import System.Posix.Types
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)
17
45
18----------------------------------------------------------------
46----------------------------------------------------------------
19
47
@@ -21,8 +49,6 @@ data Status = Active | Inactive
21
49
22newtype MutableStatus = MutableStatus (IORef Status)
50newtype MutableStatus = MutableStatus (IORef Status)
23
51
24−type Refresh = IO ()
25−
26status :: MutableStatus -> IO Status
52status :: MutableStatus -> IO Status
27status (MutableStatus ref) = readIORef ref
53status (MutableStatus ref) = readIORef ref
28
54
@@ -37,84 +63,80 @@ inactive (MutableStatus ref) = writeIORef ref Inactive
37
63
38----------------------------------------------------------------
64----------------------------------------------------------------
39
65
40−data FdEntry = FdEntry !FilePath !Fd !MutableStatus
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
41
76
42newFdEntry :: FilePath -> IO FdEntry
77newFdEntry :: FilePath -> IO FdEntry
43−newFdEntry path = FdEntry path
78+newFdEntry path = FdEntry <$> openFile path <*> newActiveStatus
44− <$> openFd path ReadOnly Nothing defaultFileFlags
79+
45− <*> newActiveStatus
80+setFileCloseOnExec :: Fd -> IO ()
81+setFileCloseOnExec fd = setFdOption fd CloseOnExec True
46
82
47----------------------------------------------------------------
83----------------------------------------------------------------
48
84
49−type Hash = Int
50−type FdCache = MMap Hash FdEntry
85+type FdCache = MultiMap FdEntry
51−newtype MutableFdCache = MutableFdCache (IORef FdCache)
52
86
53−newMutableFdCache :: IO MutableFdCache
87+-- | Mutable Fd cacher.
54−newMutableFdCache = MutableFdCache <$> newIORef empty
88+newtype MutableFdCache = MutableFdCache (Reaper FdCache (FilePath,FdEntry))
55
89
56fdCache :: MutableFdCache -> IO FdCache
90fdCache :: MutableFdCache -> IO FdCache
57−fdCache (MutableFdCache ref) = readIORef ref
91+fdCache (MutableFdCache reaper) = reaperRead reaper
58−
59−swapWithNew :: MutableFdCache -> IO FdCache
60−swapWithNew (MutableFdCache ref) = atomicModifyIORef ref (\t -> (empty, t))
61
92
62−update :: MutableFdCache -> (FdCache -> FdCache) -> IO ()
63−update (MutableFdCache ref) f = do
64− !_ <- atomicModifyIORef ref $ \t -> let !new = f t in (new, ())
65− return ()
66−
67−look :: MutableFdCache -> FilePath -> Hash -> IO (Maybe FdEntry)
93+look :: MutableFdCache -> FilePath -> IO (Maybe FdEntry)
68−look mfc path key = searchWith key check <$> fdCache mfc
94+look mfc path = MM.lookup path <$> fdCache mfc
69− where
70− check (One ent@(FdEntry path' _ _))
71− | path == path' = Just ent
72− | otherwise = Nothing
73− check (Tom ent@(FdEntry path' _ _) vs)
74− | path == path' = Just ent
75− | otherwise = check vs
76
95
77----------------------------------------------------------------
96----------------------------------------------------------------
78
97
98+-- The first argument is a cache duration in second.
79initialize :: Int -> IO MutableFdCache
99initialize :: Int -> IO MutableFdCache
80−initialize duration = do
100+initialize duration = MutableFdCache <$> mkReaper settings
81− mfc <- newMutableFdCache
82− void . forkIO $ loop mfc
83− return mfc
84 where
101 where
85− loop mfc = do
102+ settings = defaultReaperSettings {
86− old <- swapWithNew mfc
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
87− new <- pruneWith old prune
112+ new <- pruneWith old prune
88− update mfc (merge new)
113+ return $ merge new
89− threadDelay duration
90− loop mfc
91−
92−prune :: t -> Some FdEntry -> IO [(t, Some FdEntry)]
93−prune k v@(One (FdEntry _ fd mst)) = status mst >>= prune'
94 where
114 where
115+ prune (_,FdEntry fd mst) = status mst >>= act
116+ where
95− prune' Active = inactive mst >> return [(k,v)]
117+ act Active = inactive mst >> return True
96− prune' Inactive = closeFd fd >> return []
118+ act Inactive = closeFd fd >> return False
97−prune k (Tom ent@(FdEntry _ fd mst) vs) = status mst >>= prune'
119+
120+----------------------------------------------------------------
121+
122+terminate :: MutableFdCache -> IO ()
123+terminate (MutableFdCache reaper) = do
124+ !t <- reaperStop reaper
125+ mapM_ (closeIt . snd) $ toList t
98 where
126 where
99− prune' Active = do
127+ closeIt (FdEntry fd _) = closeFd fd
100− inactive mst
101− zs <- prune k vs
102− case zs of
103− [] -> return [(k,One ent)]
104− [(_,zvs)] -> return [(k,Tom ent zvs)]
105− _ -> error "prune"
106− prune' Inactive = closeFd fd >> prune k vs
107
128
108----------------------------------------------------------------
129----------------------------------------------------------------
109
130
131+-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
110−getFd :: MutableFdCache -> FilePath -> IO (Fd, Refresh)
132+getFd :: MutableFdCache -> FilePath -> IO (Maybe Fd, Refresh)
111−getFd mfc path = look mfc path key >>= getFd'
133+getFd mfc@(MutableFdCache reaper) path = look mfc path >>= get
112 where
134 where
113− key = hash path
114− getFd' Nothing = do
135+ get Nothing = do
115− ent@(FdEntry _ fd mst) <- newFdEntry path
136+ ent@(FdEntry fd mst) <- newFdEntry path
116− update mfc (insert key ent)
137+ reaperAdd reaper (path,ent)
117− return (fd, refresh mst)
138+ return (Just fd, refresh mst)
118− getFd' (Just (FdEntry _ fd mst)) = do
139+ get (Just (FdEntry fd mst)) = do
119 refresh mst
140 refresh mst
120− return (fd, 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.hs+66−191
@@ -1,236 +1,111 @@
1+{-# LANGUAGE BangPatterns #-}
2+
1module Network.Wai.Handler.Warp.MultiMap (
3module Network.Wai.Handler.Warp.MultiMap (
2− MMap
4+ MultiMap
3− , Some(..)
5+ , isEmpty
4 , empty
6 , empty
5 , singleton
7 , singleton
6 , insert
8 , insert
7− , search
9+ , Network.Wai.Handler.Warp.MultiMap.lookup
8− , searchWith
9− , isEmpty
10− , valid
11 , pruneWith
10 , pruneWith
12− , fromList
13 , toList
11 , toList
14− , fromSortedList
15− , toSortedList
16 , merge
12 , merge
17 ) where
13 ) where
18
14
19−import Control.Applicative ((<$>))
15+import Data.Hashable (hash)
20−import Data.List (foldl')
16+import Data.IntMap.Strict (IntMap)
21−
17+import qualified Data.IntMap.Strict as I
22−----------------------------------------------------------------
18+import Data.Semigroup
23−
19+import Prelude -- Silence redundant import warnings
24−-- | One ore more list to implement multimap.
25−data Some a = One !a
26− | Tom !a !(Some a) -- Two or more
27− deriving (Eq,Show)
28−
29−-- This is slow but assuming rarely used.
30−snoc :: Some a -> a -> Some a
31−snoc (One x) y = Tom x (One y)
32−snoc (Tom x xs) y = Tom x (snoc xs y)
33−
34−top :: Some a -> a
35−top (One x) = x
36−top (Tom x _) = x
37−
38−----------------------------------------------------------------
39−
40−-- | Red black tree as multimap.
41−data MMap k v = Leaf -- color is Black
42− | Node Color !(MMap k v) !k !(Some v) !(MMap k v)
43− deriving (Show)
44−
45−data Color = B -- ^ Black
46− | R -- ^ Red
47− deriving (Eq, Show)
48
20
49----------------------------------------------------------------
21----------------------------------------------------------------
50
22
51−instance (Eq k, Eq v) => Eq (MMap k v) where
23+-- | 'MultiMap' is used for cache of file descriptors.
52− t1 == t2 = toSortedList t1 == toSortedList t2
24+-- Since multiple threads would open file descriptors for
53−
25+-- the same file simultaneously, multiple entries must
54−----------------------------------------------------------------
26+-- be contained for the file.
55−
27+-- Since hash values of file pathes are used as outer keys,
56−-- | O(log N)
28+-- collison would happen for multiple file pathes.
57−search :: Ord k => k -> MMap k v -> Maybe v
29+-- Becase only positive entries are contained,
58−search _ Leaf = Nothing
30+-- a bad guy cannot be cause the hash collision intentinally.
59−search xk (Node _ l k v r) = case compare xk k of
31+-- So, lists are good enough.
60− LT -> search xk l
32+newtype MultiMap v = MultiMap (IntMap [(FilePath,v)])
61− GT -> search xk r
62− EQ -> Just $ top v
63−
64−-- | O(log N)
65−searchWith :: Ord k => k -> (Some v -> Maybe v) -> MMap k v -> Maybe v
66−searchWith _ _ Leaf = Nothing
67−searchWith xk f (Node _ l k v r) = case compare xk k of
68− LT -> searchWith xk f l
69− GT -> searchWith xk f r
70− EQ -> f v
71
33
72----------------------------------------------------------------
34----------------------------------------------------------------
73
35
74-- | O(1)
36-- | O(1)
75−isEmpty :: (Eq k, Eq v) => MMap k v -> Bool
37+empty :: MultiMap v
76−isEmpty Leaf = True
38+empty = MultiMap $ I.empty
77−isEmpty _ = False
78
39
79-- | O(1)
40-- | O(1)
80−empty :: MMap k v
41+isEmpty :: MultiMap v -> Bool
81−empty = Leaf
42+isEmpty (MultiMap mm) = I.null mm
82
43
83----------------------------------------------------------------
44----------------------------------------------------------------
84
45
85-- | O(1)
46-- | O(1)
86−singleton :: Ord k => k -> v -> MMap k v
47+singleton :: FilePath -> v -> MultiMap v
87−singleton k v = Node B Leaf k (One v) Leaf
48+singleton path v = MultiMap mm
88−
49+ where
89−----------------------------------------------------------------
50+ !h = hash path
90−
51+ !mm = I.singleton h [(path,v)]
91−-- | O(log N)
92−insert :: Ord k => k -> v -> MMap k v -> MMap k v
93−insert kx kv t = turnB (insert' kx kv t)
94−
95−insert' :: Ord k => k -> v -> MMap k v -> MMap k v
96−insert' xk xv Leaf = Node R Leaf xk (One xv) Leaf
97−insert' xk xv (Node B l k v r) = case compare xk k of
98− LT -> balanceL' (insert' xk xv l) k v r
99− GT -> balanceR' l k v (insert' xk xv r)
100− EQ -> Node B l k (snoc v xv) r
101−insert' xk xv (Node R l k v r) = case compare xk k of
102− LT -> Node R (insert' xk xv l) k v r
103− GT -> Node R l k v (insert' xk xv r)
104− EQ -> Node R l k (snoc v xv) r
105−
106−balanceL' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
107−balanceL' (Node R (Node R a xk xv b) yk yv c) zk zv d =
108− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
109−balanceL' (Node R a xk xv (Node R b yk yv c)) zk zv d =
110− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
111−balanceL' l k v r = Node B l k v r
112−
113−balanceR' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
114−balanceR' a xk xv (Node R b yk yv (Node R c zk zv d)) =
115− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
116−balanceR' a xk xv (Node R (Node R b yk yv c) zk zv d) =
117− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
118−balanceR' l xk xv r = Node B l xk xv r
119−
120−turnB :: MMap k v -> MMap k v
121−turnB Leaf = error "turnB"
122−turnB (Node _ l k v r) = Node B l k v r
123
52
124----------------------------------------------------------------
53----------------------------------------------------------------
125
54
126−-- | O(N log N)
127−fromList :: Ord k => [(k,v)] -> MMap k v
128−fromList = foldl' (\t (k,v) -> insert k v t) empty
129−
130-- | O(N)
55-- | O(N)
131−toList :: MMap k v -> [(k,v)]
56+lookup :: FilePath -> MultiMap v -> Maybe v
132−toList t = inorder t []
57+lookup path (MultiMap mm) = case I.lookup h mm of
58+ Nothing -> Nothing
59+ Just s -> Prelude.lookup path s
133 where
60 where
134− inorder Leaf xs = xs
61+ !h = hash path
135− inorder (Node _ l k v r) xs = inorder l (pairs k v ++ inorder r xs)
136− pairs k (One v) = [(k,v)]
137− pairs k (Tom v vs) = (k,v) : pairs k vs
138
62
139----------------------------------------------------------------
63----------------------------------------------------------------
140
64
141−-- | O(N)
65+-- | O(log n)
142−-- "Constructing Red-Black Trees" by Ralf Hinze
66+insert :: FilePath -> v -> MultiMap v -> MultiMap v
143−fromSortedList :: Ord k => [(k,Some v)] -> MMap k v
67+insert path v (MultiMap mm) = MultiMap mm'
144−fromSortedList = linkAll . foldr add []
68+ where
145−
69+ !h = hash path
146−data Digit k v = Uno k (Some v) (MMap k v)
70+ !mm' = I.insertWith (<>) h [(path,v)] mm
147− | Due k (Some v) (MMap k v) k (Some v) (MMap k v)
148− deriving (Eq,Show)
149−
150−incr :: Digit k v -> [Digit k v] -> [Digit k v]
151−incr (Uno k v t) [] = [Uno k v t]
152−incr (Uno k1 v1 t1) (Uno k2 v2 t2 : ps) = Due k1 v1 t1 k2 v2 t2 : ps
153−incr (Uno k1 v1 t1) (Due k2 v2 t2 k3 v3 t3 : ps) = Uno k1 v1 t1 : incr (Uno k2 v2 (Node B t2 k3 v3 t3)) ps
154−incr _ _ = error "incr"
155−
156−add :: (k,Some v) -> [Digit k v] -> [Digit k v]
157−add (k,v) ps = incr (Uno k v Leaf) ps
158−
159−linkAll :: [Digit k v] -> MMap k v
160−linkAll = foldl' link Leaf
161−
162−link :: MMap k v -> Digit k v -> MMap k v
163−link l (Uno k v t) = Node B l k v t
164−--link l (Due k1 v1 t1 k2 v2 t2) = Node B (Node R l k1 v1 t1) k2 v2 t2
165−link l (Due k1 v1 t1 k2 v2 t2) = Node B l k1 v1 (Node R t1 k2 v2 t2)
166
71
167----------------------------------------------------------------
72----------------------------------------------------------------
168
73
169−-- | O(N)
74+-- | O(n)
170−toSortedList :: MMap k v -> [(k,Some v)]
75+toList :: MultiMap v -> [(FilePath,v)]
171−toSortedList t = inorder t []
76+toList (MultiMap mm) = concatMap snd $ I.toAscList mm
172− where
173− inorder Leaf xs = xs
174− inorder (Node _ l k v r) xs = inorder l ((k,v) : inorder r xs)
175
77
176----------------------------------------------------------------
78----------------------------------------------------------------
177
79
178−-- | O(N)
80+-- | O(n)
179−pruneWith :: Ord k =>
81+pruneWith :: MultiMap v
180− MMap k v
82+ -> ((FilePath,v) -> IO Bool)
181− -> (k -> Some v -> IO [(k, Some v)])
83+ -> IO (MultiMap v)
182− -> IO (MMap k v)
84+pruneWith (MultiMap mm) action = MultiMap <$> mm'
183−pruneWith t run = fromSortedList <$> inorder t []
184 where
85 where
185− inorder Leaf xs = return xs
86+ !mm' = I.fromAscList <$> go (I.toDescList mm) []
186− inorder (Node _ l k v r) xs = do
87+ go [] !acc = return acc
187− ys <- run k v
88+ go ((h,s):kss) !acc = do
188− zs <- inorder r xs
89+ rs <- prune action s
189− inorder l (ys ++ zs)
90+ case rs of
91+ [] -> go kss acc
92+ _ -> go kss ((h,rs) : acc)
190
93
191----------------------------------------------------------------
94----------------------------------------------------------------
192
95
193−-- O(N log N) where N is the size of the second argument
96+-- O(n + m) where N is the size of the second argument
194−merge :: Ord k => MMap k v -> MMap k v -> MMap k v
97+merge :: MultiMap v -> MultiMap v -> MultiMap v
195−merge base m = foldl' ins base xs
98+merge (MultiMap m1) (MultiMap m2) = MultiMap mm
196 where
99 where
197− ins t (k,v) = insert k v t
100+ !mm = I.unionWith (<>) m1 m2
198− xs = toList m
199
101
200----------------------------------------------------------------
102----------------------------------------------------------------
201−-- for testing
202−
203−valid :: Ord k => MMap k v -> Bool
204−valid t = isBalanced t && isOrdered t
205
103
206−isBalanced :: MMap k v -> Bool
104+prune :: ((FilePath,v) -> IO Bool) -> [(FilePath,v)] -> IO [(FilePath,v)]
207−isBalanced t = isBlackSame t && isRedSeparate t
105+prune action xs0 = go xs0
208−
209−isBlackSame :: MMap k v -> Bool
210−isBlackSame t = all (n==) ns
211− where
212− n:ns = blacks t
213−
214−blacks :: MMap k v -> [Int]
215−blacks = blacks' 0
216− where
217− blacks' n Leaf = [n+1]
218− blacks' n (Node R l _ _ r) = blacks' n l ++ blacks' n r
219− blacks' n (Node B l _ _ r) = blacks' n' l ++ blacks' n' r
220− where
221− n' = n + 1
222−
223−isRedSeparate :: MMap k v -> Bool
224−isRedSeparate = reds B
225−
226−reds :: Color -> MMap k v -> Bool
227−reds _ Leaf = True
228−reds R (Node R _ _ _ _) = False
229−reds _ (Node c l _ _ r) = reds c l && reds c r
230−
231−isOrdered :: Ord k => MMap k v -> Bool
232−isOrdered t = ordered $ toSortedList t
233 where
106 where
234− ordered [] = True
107+ go [] = return []
235− ordered [_] = True
108+ go (x:xs) = do
236− ordered (x:y:xys) = fst x <= fst y && ordered (y:xys)
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.hs+4−4
@@ -13,13 +13,13 @@ module Network.Wai.Handler.Warp.ReadInt (
13-- This function lives in its own file because the MagicHash pragma interacts
13-- This function lives in its own file because the MagicHash pragma interacts
14-- poorly with the CPP pragma.
14-- poorly with the CPP pragma.
15
15
16−import Data.ByteString (ByteString)
17import qualified Data.ByteString as S
16import qualified Data.ByteString as S
18−import Data.Int (Int64)
19import GHC.Prim
17import GHC.Prim
20import GHC.Types
18import GHC.Types
21import GHC.Word
19import GHC.Word
22
20
21+import Network.Wai.Handler.Warp.Imports hiding (readInt)
22+
23{-# INLINE readInt #-}
23{-# INLINE readInt #-}
24readInt :: Integral a => ByteString -> a
24readInt :: Integral a => ByteString -> a
25readInt bs = fromIntegral $ readInt64 bs
25readInt bs = fromIntegral $ readInt64 bs
@@ -32,14 +32,14 @@ readInt bs = fromIntegral $ readInt64 bs
32-- use Int64 here and then make a generic 'readInt' that allows conversion to
32-- use Int64 here and then make a generic 'readInt' that allows conversion to
33-- Int and Integer.
33-- Int and Integer.
34
34
35−{- NOINLINE readInt64MH #-}
35+{-# NOINLINE readInt64 #-}
36readInt64 :: ByteString -> Int64
36readInt64 :: ByteString -> Int64
37readInt64 bs = S.foldl' (\ !i !c -> i * 10 + fromIntegral (mhDigitToInt c)) 0
37readInt64 bs = S.foldl' (\ !i !c -> i * 10 + fromIntegral (mhDigitToInt c)) 0
38 $ S.takeWhile isDigit bs
38 $ S.takeWhile isDigit bs
39
39
40data Table = Table !Addr#
40data Table = Table !Addr#
41
41
42−{- NOINLINE mhDigitToInt #-}
42+{-# NOINLINE mhDigitToInt #-}
43mhDigitToInt :: Word8 -> Int
43mhDigitToInt :: Word8 -> Int
44mhDigitToInt (W8# i) = I# (word2Int# (indexWord8OffAddr# addr (word2Int# i)))
44mhDigitToInt (W8# i) = I# (word2Int# (indexWord8OffAddr# addr (word2Int# i)))
45 where
45 where
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.hs+226−148
@@ -1,142 +1,209 @@
1{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE CPP #-}
3{-# LANGUAGE CPP #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
5+{-# OPTIONS_GHC -fno-warn-deprecations #-}
4
6
5−module Network.Wai.Handler.Warp.Request where
7+module Network.Wai.Handler.Warp.Request (
8+ recvRequest
9+ , headerLines
10+ , pauseTimeoutKey
11+ , getFileInfoKey
12+ , getClientCertificateKey
13+ , NoKeepAliveRequest (..)
14+ ) where
6
15
7−import Control.Applicative
16+import qualified Control.Concurrent as Conc (yield)
8−import Control.Exception.Lifted (throwIO)
17+import Control.Exception (throwIO, Exception)
9−import Control.Monad.IO.Class (MonadIO, liftIO)
10−import Data.ByteString (ByteString)
18+import Data.Array ((!))
11import qualified Data.ByteString as S
19import qualified Data.ByteString as S
12−import qualified Data.ByteString.Char8 as B (unpack)
13import qualified Data.ByteString.Unsafe as SU
20import qualified Data.ByteString.Unsafe as SU
14import qualified Data.CaseInsensitive as CI
21import qualified Data.CaseInsensitive as CI
15−import Data.Conduit
16import qualified Data.IORef as I
22import qualified Data.IORef as I
17−import Data.Maybe (fromMaybe)
23+import Data.Typeable (Typeable)
18−import Data.Monoid (mempty)
24+import qualified Data.Vault.Lazy as Vault
19−import Data.Void (Void)
20−import Data.Word (Word8)
25+import Data.X509
21import qualified Network.HTTP.Types as H
26import qualified Network.HTTP.Types as H
22import Network.Socket (SockAddr)
27import Network.Socket (SockAddr)
23import Network.Wai
28import Network.Wai
24−import Network.Wai.Handler.Warp.Conduit
25−import Network.Wai.Handler.Warp.ReadInt
26import Network.Wai.Handler.Warp.Types
29import Network.Wai.Handler.Warp.Types
30+import Network.Wai.Internal
27import Prelude hiding (lines)
31import 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
28
63
29−-- FIXME come up with good values here
64+recvRequest firstRequest settings conn ii th addr src transport = do
30−maxTotalHeaderLength :: Int
65+ hdrlines <- headerLines (settingsMaxTotalHeaderLength settings) firstRequest src
31−maxTotalHeaderLength = 50 * 1024
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)
32
101
33−parseRequest :: Connection -> Port -> SockAddr
102+----------------------------------------------------------------
34− -> Source (ResourceT IO) ByteString
103+
35− -> ResourceT IO (Request, IO (ResumableSource (ResourceT IO) ByteString))
104+headerLines :: Int -> Bool -> Source -> IO [ByteString]
36−parseRequest conn port remoteHost' src1 = do
105+headerLines maxTotalHeaderLength firstRequest src = do
37− (src2, headers') <- src1 $$+ takeHeaders
106+ bs <- readSource src
38− parseRequest' conn port headers' remoteHost' src2
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+----------------------------------------------------------------
39
120
40handleExpect :: Connection
121handleExpect :: Connection
41 -> H.HttpVersion
122 -> H.HttpVersion
42− -> ([H.Header] -> [H.Header])
123+ -> Maybe HeaderValue
43− -> [H.Header]
124+ -> IO ()
44− -> IO [H.Header]
45−handleExpect _ _ front [] = return $ front []
46−handleExpect conn hv front (("expect", "100-continue"):rest) = do
125+handleExpect conn ver (Just "100-continue") = do
47− connSendAll conn $
126+ connSendAll conn continue
48− if hv == H.http11
127+ Conc.yield
128+ where
129+ continue
49− then "HTTP/1.1 100 Continue\r\n\r\n"
130+ | ver == H.http11 = "HTTP/1.1 100 Continue\r\n\r\n"
50− else "HTTP/1.0 100 Continue\r\n\r\n"
131+ | otherwise = "HTTP/1.0 100 Continue\r\n\r\n"
51− return $ front rest
132+handleExpect _ _ _ = return ()
52−handleExpect conn hv front (x:xs) = handleExpect conn hv (front . (x:)) xs
133+
53−
134+----------------------------------------------------------------
54−-- | Parse a set of header lines and body into a 'Request'.
135+
55−parseRequest' :: Connection
136+bodyAndSource :: Source
56− -> Port
137+ -> Maybe HeaderValue -- ^ content length
57− -> [ByteString]
138+ -> Maybe HeaderValue -- ^ transfer-encoding
58− -> SockAddr
139+ -> IO (IO ByteString
59− -> ResumableSource (ResourceT IO) ByteString -- FIXME was buffered
140+ ,Maybe (I.IORef Int)
60− -> ResourceT IO (Request, IO (ResumableSource (ResourceT IO) ByteString))
141+ ,RequestBodyLength
61−parseRequest' _ _ [] _ _ = throwIO $ NotEnoughLines []
142+ )
62−parseRequest' conn port (firstLine:otherLines) remoteHost' src = do
143+bodyAndSource src cl te
63− (method, rpath', gets, httpversion) <- parseFirst firstLine
144+ | chunked = do
64− let (host',rpath)
145+ csrc <- mkCSource src
65− | S.null rpath' = ("", "/")
66− | "http://" `S.isPrefixOf` rpath' = S.breakByte 47 $ S.drop 7 rpath'
67− | otherwise = ("", rpath')
68− heads <- liftIO
69− $ handleExpect conn httpversion id
70− (map parseHeaderNoAttr otherLines)
71− let host = fromMaybe host' $ lookup hHost heads
72− let len0 =
73− case lookup H.hContentLength heads of
74− Nothing -> 0
75− Just bs -> readInt bs
76− let serverName' = takeUntil 58 host -- ':'
77− let chunked = maybe False ((== "chunked") . CI.foldCase)
78− $ lookup hTransferEncoding heads
79− (rbody, getSource) <- liftIO $
80− if chunked
81− then do
82− ref <- I.newIORef (src, NeedLen)
83− return (chunkedSource ref, fst <$> I.readIORef ref)
84− else do
85− ibs <- IsolatedBSSource <$> I.newIORef (len0, src)
86− return (ibsIsolate ibs, ibsDone ibs)
87−
88− return (Request
89− { requestMethod = method
90− , httpVersion = httpversion
91− , pathInfo = H.decodePathSegments rpath
92− , rawPathInfo = rpath
93− , rawQueryString = gets
94− , queryString = H.parseQuery gets
95− , serverName = serverName'
96− , serverPort = port
97− , requestHeaders = heads
98− , isSecure = False
99− , remoteHost = remoteHost'
100− , requestBody = rbody
101− , vault = mempty
102−#if MIN_VERSION_wai(1, 4, 0)
103− , requestBodyLength =
104− if chunked
105− then ChunkedBody
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
106− else KnownLength $ fromIntegral len0
152+ bodyLen = KnownLength $ fromIntegral len
107−#endif
153+ chunked = isChunked te
108− }, getSource)
154+
109−
155+toLength :: Maybe HeaderValue -> Int
110−{-# INLINE takeUntil #-}
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
111−takeUntil :: Word8 -> ByteString -> ByteString
167+ -> IO ByteString
112−takeUntil c bs =
168+ -> IO ()
113− case S.elemIndex c bs of
169+ -> IO (IO ByteString)
114− Just !idx -> SU.unsafeTake idx bs
170+timeoutBody remainingRef timeoutHandle rbody handle100Continue = do
115− Nothing -> bs
171+ isFirstRef <- I.newIORef True
116−
172+
117−{-# INLINE parseFirst #-} -- FIXME is this inline necessary? the function is only called from one place and not exported
173+ let checkEmpty =
118−parseFirst :: ByteString
174+ case remainingRef of
119− -> ResourceT IO (ByteString, ByteString, ByteString, H.HttpVersion)
175+ Nothing -> return . S.null
120−parseFirst s =
176+ Just ref -> \bs -> if S.null bs
121− case filter (not . S.null) $ S.splitWith (\c -> c == 32 || c == 9) s of -- ' '
177+ then return True
122− (method:query:http'') -> do
178+ else do
123− let http' = S.concat http''
179+ x <- I.readIORef ref
124− (hfirst, hsecond) = S.splitAt 5 http'
180+ return $! x <= 0
125− if hfirst == "HTTP/"
181+
126− then let (rpath, qstring) = S.breakByte 63 query -- '?'
182+ return $ do
127− hv =
183+ isFirst <- I.readIORef isFirstRef
128− case hsecond of
184+
129− "1.1" -> H.http11
185+ when isFirst $ do
130− _ -> H.http10
186+ -- Only check if we need to produce the 100 Continue status
131− in return (method, rpath, qstring, hv)
187+ -- when asking for the first chunk of the body
132− else throwIO NonHttp
188+ handle100Continue
133− _ -> throwIO $ BadFirstLine $ B.unpack s
189+ -- Timeout handling was paused after receiving the full request
134−
190+ -- headers. Now we need to resume it to avoid a slowloris
135−parseHeaderNoAttr :: ByteString -> H.Header
191+ -- attack during request body sending.
136−parseHeaderNoAttr s =
192+ Timeout.resume timeoutHandle
137− let (k, rest) = S.breakByte 58 s -- ':'
193+ I.writeIORef isFirstRef False
138− rest' = S.dropWhile (\c -> c == 32 || c == 9) $ S.drop 1 rest
194+
139− in (CI.mk k, rest')
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+----------------------------------------------------------------
140
207
141type BSEndo = ByteString -> ByteString
208type BSEndo = ByteString -> ByteString
142type BSEndoList = [ByteString] -> [ByteString]
209type BSEndoList = [ByteString] -> [ByteString]
@@ -146,20 +213,20 @@ data THStatus = THStatus
146 BSEndoList -- previously parsed lines
213 BSEndoList -- previously parsed lines
147 BSEndo -- bytestrings to be prepended
214 BSEndo -- bytestrings to be prepended
148
215
149−{-# INLINE takeHeaders #-}
216+----------------------------------------------------------------
150−takeHeaders :: Sink ByteString (ResourceT IO) [ByteString]
151−takeHeaders =
152− await >>= maybe (throwIO ConnectionClosedByPeer) (push (THStatus 0 id id))
153
217
218+{- FIXME
154−close :: Sink ByteString (ResourceT IO) a
219+close :: Sink ByteString IO a
155close = throwIO IncompleteHeaders
220close = throwIO IncompleteHeaders
221+-}
156
222
157−push :: THStatus -> ByteString -> Sink ByteString (ResourceT IO) [ByteString]
223+push :: Int -> Source -> THStatus -> ByteString -> IO [ByteString]
158−push (THStatus len lines prepend) bs
224+push maxTotalHeaderLength src (THStatus len lines prepend) bs'
159 -- Too many bytes
225 -- Too many bytes
160 | len > maxTotalHeaderLength = throwIO OverLargeHeader
226 | len > maxTotalHeaderLength = throwIO OverLargeHeader
161 | otherwise = push' mnl
227 | otherwise = push' mnl
162 where
228 where
229+ bs = prepend bs'
163 bsLen = S.length bs
230 bsLen = S.length bs
164 mnl = do
231 mnl = do
165 nl <- S.elemIndex 10 bs
232 nl <- S.elemIndex 10 bs
@@ -171,55 +238,66 @@ push (THStatus len lines prepend) bs
171 0 -> True
238 0 -> True
172 1 -> S.index bs 0 == 13
239 1 -> S.index bs 0 == 13
173 _ -> False
240 _ -> False
174− in Just (nl, (not b) && (c == 32 || c == 9))
241+ in Just (nl, not b && (c == 32 || c == 9))
175 else
242 else
176 Just (nl, False)
243 Just (nl, False)
177
244
178 {-# INLINE push' #-}
245 {-# INLINE push' #-}
246+ push' :: Maybe (Int, Bool) -> IO [ByteString]
179 -- No newline find in this chunk. Add it to the prepend,
247 -- No newline find in this chunk. Add it to the prepend,
180 -- update the length, and continue processing.
248 -- update the length, and continue processing.
181− push' Nothing = await >>= maybe close (push status)
249+ push' Nothing = do
250+ bst <- readSource' src
251+ when (S.null bst) $ throwIO IncompleteHeaders
252+ push maxTotalHeaderLength src status bst
182 where
253 where
183 len' = len + bsLen
254 len' = len + bsLen
184− prepend' = prepend . S.append bs
255+ prepend' = S.append bs
185 status = THStatus len' lines prepend'
256 status = THStatus len' lines prepend'
186 -- Found a newline, but next line continues as a multiline header
257 -- Found a newline, but next line continues as a multiline header
187− push' (Just (end, True)) = push status rest
258+ push' (Just (end, True)) = push maxTotalHeaderLength src status rest
188 where
259 where
189 rest = S.drop (end + 1) bs
260 rest = S.drop (end + 1) bs
190− prepend' = prepend . S.append (SU.unsafeTake (checkCR bs end) bs)
261+ prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
191 len' = len + end
262 len' = len + end
192 status = THStatus len' lines prepend'
263 status = THStatus len' lines prepend'
193 -- Found a newline at position end.
264 -- Found a newline at position end.
194 push' (Just (end, False))
265 push' (Just (end, False))
195 -- leftover
266 -- leftover
196− | S.null line = let lines' = lines []
267+ | S.null line = do
197− rest = if start < bsLen then
198− Just (SU.unsafeDrop start bs)
268+ when (start < bsLen) $ leftoverSource src (SU.unsafeDrop start bs)
199− else
269+ return (lines [])
200− Nothing
201− in maybe (return ()) leftover rest >> return lines'
202 -- more headers
270 -- more headers
203 | otherwise = let len' = len + start
271 | otherwise = let len' = len + start
204 lines' = lines . (line:)
272 lines' = lines . (line:)
205 status = THStatus len' lines' id
273 status = THStatus len' lines' id
206 in if start < bsLen then
274 in if start < bsLen then
207 -- more bytes in this chunk, push again
275 -- more bytes in this chunk, push again
208− let bs' = SU.unsafeDrop start bs
276+ let bs'' = SU.unsafeDrop start bs
209− in push status bs'
277+ in push maxTotalHeaderLength src status bs''
210− else
278+ else do
211 -- no more bytes in this chunk, ask for more
279 -- no more bytes in this chunk, ask for more
212− await >>= maybe close (push status)
280+ bst <- readSource' src
281+ when (S.null bs) $ throwIO IncompleteHeaders
282+ push maxTotalHeaderLength src status bst
213 where
283 where
214 start = end + 1 -- start of next chunk
284 start = end + 1 -- start of next chunk
215− line
216− -- There were some bytes before the newline, get them
217− | end > 0 = prepend $ SU.unsafeTake (checkCR bs end) bs
285+ line = SU.unsafeTake (checkCR bs end) bs
218− -- No bytes before the newline
219− | otherwise = prepend S.empty
220
286
221{-# INLINE checkCR #-}
287{-# INLINE checkCR #-}
222checkCR :: ByteString -> Int -> Int
288checkCR :: ByteString -> Int -> Int
223−checkCR bs pos = if 13 == S.index bs p then p else pos -- 13 is CR
289+checkCR bs pos = if pos > 0 && 13 == S.index bs p then p else pos -- 13 is CR
224 where
290 where
225 !p = pos - 1
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.hs+358−152
@@ -1,142 +1,334 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3+{-# LANGUAGE RankNTypes #-}
4+{-# LANGUAGE CPP #-}
5+{-# LANGUAGE BangPatterns #-}
3
6
4module Network.Wai.Handler.Warp.Response (
7module Network.Wai.Handler.Warp.Response (
5 sendResponse
8 sendResponse
9+ , sanitizeHeaderValue -- for testing
10+ , warpVersion
11+ , hasBody
12+ , replaceHeader
13+ , addServer -- testing
6 ) where
14 ) where
7
15
8−import Blaze.ByteString.Builder (fromByteString, Builder, toByteStringIO, flush)
9−import Blaze.ByteString.Builder.HTTP (chunkedTransferEncoding, chunkedTransferTerminator)
16+import Data.ByteString.Builder.HTTP.Chunked (chunkedTransferEncoding, chunkedTransferTerminator)
10−import Control.Applicative
11−import Control.Exception
17+import qualified Control.Exception as E
12−import Control.Monad.IO.Class (MonadIO, liftIO)
18+import Data.Array ((!))
19+import qualified Data.ByteString as S
20+import Data.ByteString.Builder (byteString, Builder)
13−import Data.ByteString (ByteString)
21+import Data.ByteString.Builder.Extra (flush)
14−import qualified Data.ByteString.Char8 as B (pack)
22+import qualified Data.ByteString.Char8 as C8
15import qualified Data.CaseInsensitive as CI
23import qualified Data.CaseInsensitive as CI
16−import Data.Conduit
24+import Data.Function (on)
17−import Data.Conduit.Blaze (builderToByteString)
25+import Data.Streaming.ByteString.Builder (newByteStringBuilderRecv, reuseBufferStrategy)
18−import qualified Data.Conduit.List as CL
19−import Data.Maybe (isJust)
26+import Data.Version (showVersion)
20−import Data.Monoid (mappend)
27+import Data.Word8 (_cr, _lf)
21import qualified Network.HTTP.Types as H
28import qualified Network.HTTP.Types as H
29+import qualified Network.HTTP.Types.Header as H
22import Network.Wai
30import Network.Wai
23−import Network.Wai.Handler.Warp.ReadInt
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
24import Network.Wai.Handler.Warp.Settings
42import Network.Wai.Handler.Warp.Settings
25−import qualified Network.Wai.Handler.Warp.ResponseHeader as RH
26−import qualified Network.Wai.Handler.Warp.Timeout as T
27import Network.Wai.Handler.Warp.Types
43import Network.Wai.Handler.Warp.Types
28−import qualified System.PosixCompat.Files as P
29
44
30−----------------------------------------------------------------
45+-- $setup
46+-- >>> :set -XOverloadedStrings
47+
31----------------------------------------------------------------
48----------------------------------------------------------------
32
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+
33sendResponse :: Settings
101sendResponse :: Settings
34− -> Cleaner -> Request -> Connection -> Response
102+ -> Connection
35− -> ResourceT IO Bool
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)
36
210
37----------------------------------------------------------------
211----------------------------------------------------------------
38
212
39−sendResponse settings cleaner req conn (ResponseFile s hs path mpart) =
213+sendRsp conn _ ver s hs _ (RspBuilder body needsChunked) = do
40− headerAndLength >>= sendResponse'
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)
41 where
253 where
42− th = threadHandle cleaner
254+ recv = do
43− headerAndLength = case (readInt <$> checkLength hs, mpart) of
255+ bs <- src
44− (Just cl, _) -> return $ Right (hs, cl)
45− (Nothing, Nothing) -> liftIO . try $ do
46− cl <- fromIntegral . P.fileSize <$> P.getFileStatus path
47− return (addLength cl hs, cl)
48− (Nothing, Just part) -> do
49− let cl = fromIntegral $ filePartByteCount part
50− return $ Right (addLength cl hs, cl)
51−
52− sendResponse' (Right (lengthyHeaders, cl))
53− | hasBody s req = liftIO $ do
54− lheader <- composeHeader settings version s lengthyHeaders
55− connSendFile conn path beg end (T.tickle th) [lheader] cleaner
56− T.tickle th
256+ unless (S.null bs) tickle
57− return isPersist
257+ return bs
58− | otherwise = liftIO $ do
59− composeHeader settings version s hs >>= connSendAll conn
258+ send bs = connSendAll conn bs >> tickle
60− T.tickle th
259+
61− return isPersist -- FIXME isKeepAlive?
62− where
63− (beg,end) = case mpart of
64− Nothing -> (0,cl)
65− Just prt -> (filePartOffset prt, filePartByteCount prt)
66− version = httpVersion req
67− (isPersist,_) = infoFromRequest req
68−
69− sendResponse' (Left (_ :: SomeException)) =
70− sendResponse settings cleaner req conn notFound
71− where
72− notFound = responseLBS H.status404 [(H.hContentType, "text/plain")] "File not found"
73−
74−----------------------------------------------------------------
260+----------------------------------------------------------------
75−
261+
76−sendResponse settings cleaner req conn (ResponseBuilder s hs b)
262+-- Sophisticated WAI applications.
77− | hasBody s req = liftIO $ do
263+-- We respect s0. s0 MUST be a proper value.
78− header <- composeHeaderBuilder settings version s hs needsChunked
264+sendRsp conn ii ver s0 hs0 rspidxhdr (RspFile path (Just part) _ isHead hook) =
79− let body
265+ sendRspFile2XX conn ii ver s0 hs rspidxhdr path beg len isHead hook
80− | needsChunked = header `mappend` chunkedTransferEncoding b
81− `mappend` chunkedTransferTerminator
82− | otherwise = header `mappend` b
83− flip toByteStringIO body $ \bs -> do
84− connSendAll conn bs
85− T.tickle th
86− return isKeepAlive
87− | otherwise = liftIO $ do
88− composeHeader settings version s hs >>= connSendAll conn
89− T.tickle th
90− return isPersist
91 where
266 where
92− th = threadHandle cleaner
267+ beg = filePartOffset part
93− version = httpVersion req
268+ len = filePartByteCount part
94− reqinfo@(isPersist,_) = infoFromRequest req
269+ hs = addContentHeadersForFilePart hs0 part
95− (isKeepAlive, needsChunked) = infoFromResponse hs reqinfo
270+
96−
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+
97−----------------------------------------------------------------
287+----------------------------------------------------------------
98−
288+
99−sendResponse settings cleaner req conn (ResponseSource s hs bodyFlush)
289+sendRspFile2XX :: Connection
100− | hasBody s req = do
290+ -> InternalInfo
101− header <- liftIO $ composeHeaderBuilder settings version s hs needsChunked
291+ -> H.HttpVersion
102− let src = CL.sourceList [header] `mappend` cbody
292+ -> H.Status
103− src $$ builderToByteString =$ connSink conn th
293+ -> H.ResponseHeaders
104− return isKeepAlive
294+ -> IndexedHeader
105− | otherwise = liftIO $ do
295+ -> FilePath
106− composeHeader settings version s hs >>= connSendAll conn
296+ -> Integer
107− T.tickle th
297+ -> Integer
108− return isPersist
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)
109 where
318 where
110− th = threadHandle cleaner
319+ s = H.notFound404
111− body =
320+ hs = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
112− mapOutput (\x -> case x of
321+ body = byteString "File not found"
113− Flush -> flush
114− Chunk builder -> builder)
115− bodyFlush
116− cbody = if needsChunked then body $= chunk else body
117− -- FIXME perhaps alloca a buffer per thread and reuse that in all
118− -- functions below. Should lessen greatly the GC burden (I hope)
119− chunk :: Conduit Builder (ResourceT IO) Builder
120− chunk = await >>= maybe (yield chunkedTransferTerminator) (\x -> yield (chunkedTransferEncoding x) >> chunk)
121− version = httpVersion req
122− reqinfo@(isPersist,_) = infoFromRequest req
123− (isKeepAlive, needsChunked) = infoFromResponse hs reqinfo
124
322
125----------------------------------------------------------------
323----------------------------------------------------------------
126----------------------------------------------------------------
324----------------------------------------------------------------
127
325
128-- | Use 'connSendAll' to send this data while respecting timeout rules.
326-- | Use 'connSendAll' to send this data while respecting timeout rules.
129−connSink :: Connection -> T.Handle -> Sink ByteString (ResourceT IO) ()
327+sendFragment :: Connection -> T.Handle -> ByteString -> IO ()
130−connSink Connection { connSendAll = send } th =
328+sendFragment Connection { connSendAll = send } th bs = do
131− sink
132− where
133− sink = await >>= maybe close push
134− close = liftIO (T.resume th)
135− push x = do
136− liftIO $ T.resume th
329+ T.resume th
137− liftIO $ send x
330+ send bs
138− liftIO $ T.pause th
331+ T.pause th
139− sink
140 -- We pause timeouts before passing control back to user code. This ensures
332 -- We pause timeouts before passing control back to user code. This ensures
141 -- that a timeout will only ever be executed when Warp is in control. We
333 -- that a timeout will only ever be executed when Warp is in control. We
142 -- also make sure to resume the timeout after the completion of user code
334 -- also make sure to resume the timeout after the completion of user code
@@ -144,16 +336,17 @@ connSink Connection { connSendAll = send } th =
144
336
145----------------------------------------------------------------
337----------------------------------------------------------------
146
338
147−infoFromRequest :: Request -> (Bool,Bool)
339+infoFromRequest :: Request -> IndexedHeader -> (Bool -- isPersist
340+ ,Bool) -- isChunked
148−infoFromRequest req = (checkPersist req, checkChunk req)
341+infoFromRequest req reqidxhdr = (checkPersist req reqidxhdr, checkChunk req)
149
342
150−checkPersist :: Request -> Bool
343+checkPersist :: Request -> IndexedHeader -> Bool
151−checkPersist req
344+checkPersist req reqidxhdr
152 | ver == H.http11 = checkPersist11 conn
345 | ver == H.http11 = checkPersist11 conn
153 | otherwise = checkPersist10 conn
346 | otherwise = checkPersist10 conn
154 where
347 where
155 ver = httpVersion req
348 ver = httpVersion req
156− conn = lookup H.hConnection $ requestHeaders req
349+ conn = reqidxhdr ! fromEnum ReqConnection
157 checkPersist11 (Just x)
350 checkPersist11 (Just x)
158 | CI.foldCase x == "close" = False
351 | CI.foldCase x == "close" = False
159 checkPersist11 _ = True
352 checkPersist11 _ = True
@@ -166,56 +359,69 @@ checkChunk req = httpVersion req == H.http11
166
359
167----------------------------------------------------------------
360----------------------------------------------------------------
168
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.
169−infoFromResponse :: H.ResponseHeaders -> (Bool,Bool) -> (Bool,Bool)
369+infoFromResponse :: IndexedHeader -> (Bool,Bool) -> (Bool,Bool)
170−infoFromResponse hs (isPersist,isChunked) = (isKeepAlive, needsChunked)
370+infoFromResponse rspidxhdr (isPersist,isChunked) = (isKeepAlive, needsChunked)
171 where
371 where
172 needsChunked = isChunked && not hasLength
372 needsChunked = isChunked && not hasLength
173 isKeepAlive = isPersist && (isChunked || hasLength)
373 isKeepAlive = isPersist && (isChunked || hasLength)
174− hasLength = isJust $ checkLength hs
374+ hasLength = isJust $ rspidxhdr ! fromEnum ResContentLength
175−
176−checkLength :: H.ResponseHeaders -> Maybe ByteString
177−checkLength = lookup H.hContentLength
178
375
179----------------------------------------------------------------
376----------------------------------------------------------------
180
377
181−hasBody :: H.Status -> Request -> Bool
378+hasBody :: H.Status -> Bool
182−hasBody s req = sc /= 204
379+hasBody s = sc /= 204
183− && sc /= 304
380+ && sc /= 304
184− && sc >= 200
381+ && sc >= 200
185− && method /= H.methodHead
186 where
382 where
187 sc = H.statusCode s
383 sc = H.statusCode s
188− method = requestMethod req
189
384
190----------------------------------------------------------------
385----------------------------------------------------------------
191
386
192−addLength :: Integer -> H.ResponseHeaders -> H.ResponseHeaders
387+addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
193−addLength cl hdrs = (H.hContentLength, B.pack $ show cl) : hdrs
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
194
396
195−addEncodingHeader :: H.ResponseHeaders -> H.ResponseHeaders
397+----------------------------------------------------------------
196−addEncodingHeader hdrs = (hTransferEncoding, "chunked") : hdrs
197
398
198−addServerHeader :: Settings -> H.ResponseHeaders -> H.ResponseHeaders
399+-- | The version of Warp.
199−addServerHeader settings hdrs = case lookup hServer hdrs of
400+warpVersion :: String
200− Nothing -> warpVersionHeader settings : hdrs
401+warpVersion = showVersion Paths_warp.version
201− Just _ -> hdrs
202
402
203−warpVersionHeader :: Settings -> H.Header
403+{-# INLINE addServer #-}
204−warpVersionHeader settings = (hServer, settingsServerName settings)
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
205
411
206----------------------------------------------------------------
412----------------------------------------------------------------
207
413
208−composeHeader :: Settings
414+-- |
209− -> H.HttpVersion
415+--
210− -> H.Status
416+-- >>> replaceHeader "Content-Type" "new" [("content-type","old")]
211− -> H.ResponseHeaders
417+-- [("Content-Type","new")]
212− -> IO ByteString
418+replaceHeader :: H.HeaderName -> HeaderValue -> H.ResponseHeaders -> H.ResponseHeaders
213−composeHeader settings version s hs =
419+replaceHeader k v hdrs = (k,v) : deleteBy ((==) `on` fst) (k,v) hdrs
214− RH.composeHeader version s
420+
215− $ addServerHeader settings hs
421+----------------------------------------------------------------
216
422
217−composeHeaderBuilder :: Settings -> H.HttpVersion -> H.Status -> H.ResponseHeaders -> Bool -> IO Builder
423+composeHeaderBuilder :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> Bool -> IO Builder
218−composeHeaderBuilder settings ver s hs True =
424+composeHeaderBuilder ver s hs True =
219− fromByteString <$> composeHeader settings ver s (addEncodingHeader hs)
425+ byteString <$> composeHeader ver s (addTransferEncoding hs)
220−composeHeaderBuilder settings ver s hs False =
426+composeHeaderBuilder ver s hs False =
221− fromByteString <$> composeHeader settings ver s hs
427+ byteString <$> composeHeader ver s hs
warp/Network/Wai/Handler/Warp/ResponseHeader.hs+5−15
@@ -3,18 +3,16 @@
3
3
4module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
4module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
5
5
6−import Control.Monad
7−import Data.ByteString (ByteString)
8import qualified Data.ByteString as S
6import qualified Data.ByteString as S
9−import Data.ByteString.Internal (ByteString(..), create, memcpy)
7+import Data.ByteString.Internal (create)
10import qualified Data.CaseInsensitive as CI
8import qualified Data.CaseInsensitive as CI
11−import Data.List (foldl')
12−import Data.Word (Word8)
13−import Foreign.ForeignPtr
14import Foreign.Ptr
9import Foreign.Ptr
15import GHC.Storable
10import GHC.Storable
16import qualified Network.HTTP.Types as H
11import qualified Network.HTTP.Types as H
17
12
13+import Network.Wai.Handler.Warp.Buffer (copy)
14+import Network.Wai.Handler.Warp.Imports
15+
18----------------------------------------------------------------
16----------------------------------------------------------------
19
17
20composeHeader :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> IO ByteString
18composeHeader :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> IO ByteString
@@ -24,15 +22,9 @@ composeHeader !httpversion !status !responseHeaders = create len $ \ptr -> do
24 void $ copyCRLF ptr2
22 void $ copyCRLF ptr2
25 where
23 where
26 !len = 17 + slen + foldl' fieldLength 0 responseHeaders
24 !len = 17 + slen + foldl' fieldLength 0 responseHeaders
27− fieldLength !l !(k,v) = l + S.length (CI.original k) + S.length v + 4
25+ fieldLength !l (!k,!v) = l + S.length (CI.original k) + S.length v + 4
28 !slen = S.length $ H.statusMessage status
26 !slen = S.length $ H.statusMessage status
29
27
30−{-# INLINE copy #-}
31−copy :: Ptr Word8 -> ByteString -> IO (Ptr Word8)
32−copy !ptr !(PS fp o l) = withForeignPtr fp $ \p -> do
33− memcpy ptr (p `plusPtr` o) (fromIntegral l)
34− return $! ptr `plusPtr` l
35−
36httpVer11 :: ByteString
28httpVer11 :: ByteString
37httpVer11 = "HTTP/1.1 "
29httpVer11 = "HTTP/1.1 "
38
30
@@ -90,5 +82,3 @@ cr :: Word8
90cr = 13
82cr = 13
91lf :: Word8
83lf :: Word8
92lf = 10
84lf = 10
93−
94−
warp/Network/Wai/Handler/Warp/Run.hs+534−219
@@ -1,123 +1,170 @@
1+{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PackageImports #-}
5+{-# LANGUAGE PatternGuards #-}
6+{-# LANGUAGE RecordWildCards #-}
2{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
8+{-# LANGUAGE TupleSections #-}
9+{-# LANGUAGE ViewPatterns #-}
10+{-# OPTIONS_GHC -fno-warn-deprecations #-}
3
11
4module Network.Wai.Handler.Warp.Run where
12module Network.Wai.Handler.Warp.Run where
5
13
6−import Control.Concurrent (threadDelay, forkIOWithUnmask)
14+import "iproute" Data.IP (toHostAddress, toHostAddress6)
15+import Control.Arrow (first)
16+import qualified Control.Concurrent as Conc (yield)
7−import Control.Exception
17+import Control.Exception as E
8−import Control.Monad (forever, when, unless, void)
9−import Control.Monad.IO.Class (MonadIO, liftIO)
10−import Control.Monad.Trans.Class (lift)
11−import Data.ByteString (ByteString)
12import qualified Data.ByteString as S
18import qualified Data.ByteString as S
13−import Data.Conduit
19+import Data.Char (chr)
14−import Data.Conduit.Internal (ResumableSource (..))
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(..))
15−import qualified Data.Conduit.List as CL
24+import qualified Network.HTTP2 as H2
16−import Data.Conduit.Network (bindPort)
25+import Network.Socket (Socket, close, accept, withSocketsDo, SockAddr(SockAddrInet, SockAddrInet6), setSocketOption, SocketOption(..))
17−import Network (sClose, Socket)
26+#if MIN_VERSION_network(3,1,1)
18−import Network.Sendfile
27+import Network.Socket (gracefulClose)
19−import Network.Socket (accept, SockAddr)
28+#endif
20import qualified Network.Socket.ByteString as Sock
29import qualified Network.Socket.ByteString as Sock
21import Network.Wai
30import 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
22import Network.Wai.Handler.Warp.Request
47import Network.Wai.Handler.Warp.Request
23import Network.Wai.Handler.Warp.Response
48import Network.Wai.Handler.Warp.Response
49+import Network.Wai.Handler.Warp.SendFile
24import Network.Wai.Handler.Warp.Settings
50import Network.Wai.Handler.Warp.Settings
25−import qualified Network.Wai.Handler.Warp.Timeout as T
26import Network.Wai.Handler.Warp.Types
51import Network.Wai.Handler.Warp.Types
27−import Prelude hiding (catch)
28
52
29−-- Sock.recv first tries to call recvfrom() optimistically.
30−-- If EAGAIN returns, it polls incoming data with epoll/kqueue.
31−-- This code first polls incoming data with epoll/kqueue.
32
53
33#if WINDOWS
54#if WINDOWS
34−import qualified Control.Concurrent.MVar as MV
55+import Network.Wai.Handler.Warp.Windows
35−import Network.Socket (withSocketsDo)
36−import Control.Concurrent (forkIO)
37#else
56#else
38−import System.Posix.IO (FdOption(CloseOnExec), setFdOption)
39import Network.Socket (fdSocket)
57import Network.Socket (fdSocket)
40#endif
58#endif
41
59
42−#if SENDFILEFD
60+-- | Creating 'Connection' for plain HTTP based on a given socket.
43−import Control.Applicative
61+socketConnection :: Settings -> Socket -> IO Connection
44−import qualified Network.Wai.Handler.Warp.FdCache as F
62+#if MIN_VERSION_network(3,1,1)
45−#endif
63+socketConnection set s = do
46−
47−-- FIXME come up with good values here
48−bytesPerRead :: Int
49−bytesPerRead = 4096
50−
51−-- | Default action value for 'Connection'
52−socketConnection :: Socket -> Connection
53−socketConnection s = Connection
54− { connSendMany = Sock.sendMany s
55− , connSendAll = Sock.sendAll s
56− , connSendFile = sendFile s
57− , connClose = sClose s
58− , connRecv = Sock.recv s bytesPerRead
59− }
60−
61−sendFile :: Socket -> FilePath -> Integer -> Integer -> IO () -> [ByteString] -> Cleaner -> IO ()
62−#if SENDFILEFD
63−sendFile s path off len act hdr cleaner = case fdCacher cleaner of
64− Nothing -> sendfileWithHeader s path (PartOfFile off len) act hdr
65− Just fdc -> do
66− (fd, fresher) <- F.getFd fdc path
67− sendfileFdWithHeader s fd (PartOfFile off len) (act>>fresher) hdr
68#else
64#else
69−sendFile s path off len act hdr _ =
65+socketConnection _ s = do
70− sendfileWithHeader s path (PartOfFile off len) act hdr
71#endif
66#endif
72−
67+ bufferPool <- newBufferPool
73−#if __GLASGOW_HASKELL__ < 702
68+ writeBuf <- allocateBuffer bufferSize
74−allowInterrupt :: IO ()
69+ let sendall = Sock.sendAll s
75−allowInterrupt = unblock $ return ()
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
76#endif
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+ }
77
94
78−-- | Run an 'Application' on the given port. This calls 'runSettings' with
95+-- | Run an 'Application' on the given port.
79−-- 'defaultSettings'.
96+-- This calls 'runSettings' with 'defaultSettings'.
80run :: Port -> Application -> IO ()
97run :: Port -> Application -> IO ()
81run p = runSettings defaultSettings { settingsPort = p }
98run p = runSettings defaultSettings { settingsPort = p }
82
99
83−-- | Run a Warp server with the given settings.
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'.
84runSettings :: Settings -> Application -> IO ()
120runSettings :: Settings -> Application -> IO ()
85−#if WINDOWS
86−runSettings set app = withSocketsDo $ do
121+runSettings set app = withSocketsDo $
87− var <- MV.newMVar Nothing
88− let clean = MV.modifyMVar_ var $ \s -> maybe (return ()) sClose s >> return Nothing
89− void . forkIO $ bracket
90− (bindPort (settingsPort set) (settingsHost set))
91− (const clean)
92− (\s -> do
93− MV.modifyMVar_ var (\_ -> return $ Just s)
94− runSettingsSocket set s app)
95− forever (threadDelay maxBound) `finally` clean
96−#else
97−runSettings set app =
98 bracket
122 bracket
99− (bindPort (settingsPort set) (settingsHost set))
123+ (bindPortTCP (settingsPort set) (settingsHost set))
100− sClose
124+ close
101 (\socket -> do
125 (\socket -> do
102 setSocketCloseOnExec socket
126 setSocketCloseOnExec socket
103 runSettingsSocket set socket app)
127 runSettingsSocket set socket app)
104−#endif
105
128
106−-- | Same as 'runSettings', but uses a user-supplied socket instead of opening
129+-- | This installs a shutdown handler for the given socket and
107−-- one. This allows the user to provide, for example, Unix named socket, which
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
108-- can be used when reverse HTTP proxying into your application.
136-- can be used when reverse HTTP proxying into your application.
109--
137--
110-- Note that the 'settingsPort' will still be passed to 'Application's via the
138-- Note that the 'settingsPort' will still be passed to 'Application's via the
111-- 'serverPort' record.
139-- 'serverPort' record.
112runSettingsSocket :: Settings -> Socket -> Application -> IO ()
140runSettingsSocket :: Settings -> Socket -> Application -> IO ()
113−runSettingsSocket set socket app =
141+runSettingsSocket set socket app = do
142+ settingsInstallShutdownHandler set closeListenSocket
114− runSettingsConnection set getter app
143+ runSettingsConnection set getConn app
115 where
144 where
116− getter = do
145+ getConn = do
146+#if WINDOWS
117− (conn, sa) <- accept socket
147+ (s, sa) <- windowsThreadBlockHack $ accept socket
148+#else
149+ (s, sa) <- accept socket
150+#endif
118− setSocketCloseOnExec socket
151+ setSocketCloseOnExec s
152+ -- NoDelay causes an error for AF_UNIX.
153+ setSocketOption s NoDelay 1 `E.catch` \(E.SomeException _) -> return ()
119− return (socketConnection conn, sa)
154+ conn <- socketConnection set s
155+ return (conn, sa)
156+
157+ closeListenSocket = close socket
120
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
121runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
168runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
122runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMaker app
169runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMaker app
123 where
170 where
@@ -125,160 +172,428 @@ runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMa
125 (conn, sa) <- getConn
172 (conn, sa) <- getConn
126 return (return conn, sa)
173 return (return conn, sa)
127
174
128−-- | Allows you to provide a function which will return a @Connection@. In
175+-- | This modifies the connection maker so that it returns 'TCP' for 'Transport'
129−-- cases where creating the @Connection@ can be expensive, this allows the
176+-- (i.e. plain HTTP) then calls 'runSettingsConnectionMakerSecure'.
130−-- expensive computations to be performed in a separate thread instead of the
131−-- main server loop.
132−--
133−-- Since 1.3.5
134runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
177runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
135−runSettingsConnectionMaker set getConn app = do
178+runSettingsConnectionMaker x y =
136−#if SENDFILEFD
179+ runSettingsConnectionMakerSecure x (toTCP <$> y)
137− let duration = settingsFdCacheDuration set
180+ where
138− fc <- case duration of
181+ toTCP = first ((, TCP) <$>)
139− 0 -> return Nothing
182+
140− _ -> Just <$> F.initialize (duration * 1000000)
183+----------------------------------------------------------------
141−#endif
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
142 settingsBeforeMainLoop set
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
143
204
144− -- Note that there is a thorough discussion of the exception safety of the
205+ !fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
145− -- following code at: https://github.com/yesodweb/wai/issues/146
206+ !fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
146− --
207+ !timeoutInSeconds = settingsTimeout set * 1000000
147− -- We need to make sure of two things:
208+ withTimeoutManager f = case settingsManager set of
148− --
209+ Just tm -> f tm
149− -- 1. Asynchronous exceptions are not blocked entirely in the main loop.
210+ Nothing -> bracket
150− -- Doing so would make it impossible to kill the Warp thread.
211+ (T.initialize timeoutInSeconds)
151− --
212+ T.stopManager
152− -- 2. Once a connection maker is received via getConnLoop, the connection
213+ f
153− -- is guaranteed to be closed, even in the presence of async exceptions.
154− --
155− -- Our approach is explained in the comments below.
156
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
157− -- First mask all exceptions in the main loop. This is necessary to ensure
235+ -- First mask all exceptions in acceptLoop. This is necessary to
158− -- that no async exception is throw between the call to getConnLoop and the
236+ -- ensure that no async exception is throw between the call to
159− -- registering of connClose.
237+ -- acceptNewConnection and the registering of connClose.
160− withTimeoutManager $ \tm -> mask_ . forever $ do
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
161 -- Allow async exceptions before receiving the next connection maker.
247 -- Allow async exceptions before receiving the next connection maker.
162 allowInterrupt
248 allowInterrupt
163
249
164− -- getConnLoop will try to receive the next incoming request. It
250+ -- acceptNewConnection will try to receive the next incoming
165− -- returns a /connection maker/, not a connection, since in some
251+ -- request. It returns a /connection maker/, not a connection,
166− -- circumstances creating a working connection from a raw socket may be
252+ -- since in some circumstances creating a working connection
167− -- an expensive operation, and this expensive work should not be
253+ -- from a raw socket may be an expensive operation, and this
254+ -- expensive work should not be performed in the main event
168− -- performed in the main event loop. An example of something expensive
255+ -- loop. An example of something expensive would be TLS
169− -- would be TLS negotiation.
256+ -- negotiation.
257+ mx <- acceptNewConnection
258+ case mx of
259+ Nothing -> return ()
170− (mkConn, addr) <- getConnLoop
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
171
276
172− -- Fork a new worker thread for this connection maker, and ask for a
277+-- Fork a new worker thread for this connection maker, and ask for a
173− -- function to unmask (i.e., allow async exceptions to be thrown).
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.
174 --
296 --
175− -- GHC 7.8 cannot infer the type of "void . forkIOWithUnmask"
176− void $ forkIOWithUnmask $ \unmask ->
177− -- Run the connection maker to get a new connection, and ensure
178− -- that the connection is closed. If the mkConn call throws an
179− -- exception, we will leak the connection. If the mkConn call is
180− -- vulnerable to attacks (e.g., Slowloris), we do nothing to
181− -- protect the server. It is therefore vital that mkConn is well
182− -- vetted.
183− --
184− -- We grab the connection before registering timeouts since the
297+ -- We grab the connection before registering timeouts since the
185− -- timeouts will be useless during connection creation, due to the
298+ -- timeouts will be useless during connection creation, due to the
186− -- fact that async exceptions are still masked.
299+ -- fact that async exceptions are still masked.
187− bracket mkConn connClose $ \conn ->
300+ bracket mkConn cleanUp (serve unmask)
188−
189− -- We need to register a timeout handler for this thread, and
190− -- cancel that handler as soon as we exit.
191− bracket (T.registerKillThread tm) T.cancel $ \th ->
192−#if SENDFILEFD
193− let cleaner = Cleaner th fc
194−#else
195− let cleaner = Cleaner th
196−#endif
197− -- We now have fully registered a connection close handler
198− -- in the case of all exceptions, so it is safe to one
199− -- again allow async exceptions.
200− in unmask .
201− -- Call the user-supplied on exception code if any
202− -- exceptions are thrown.
203− handle onE .
204−
205− -- Call the user-supplied code for connection open and close events
206− bracket_ onOpen onClose $
207−
208− -- Actually serve this connection.
209− serveConnection set cleaner port app conn addr
210 where
301 where
211− -- FIXME: only IOEception is caught. What about other exceptions?
302+ cleanUp (conn, _) = connClose conn `finally` connFree conn
212− getConnLoop = getConn `catch` \(e :: IOException) -> do
303+
213− onE (toException e)
304+ -- We need to register a timeout handler for this thread, and
214− -- "resource exhausted (Too many open files)" may happen by accept().
305+ -- cancel that handler as soon as we exit.
215− -- Wait a second hoping that resource will be available.
306+ serve unmask (conn, transport) = bracket register cancel $ \th -> do
216− threadDelay 1000000
307+ -- We now have fully registered a connection close handler in
217− getConnLoop
308+ -- the case of all exceptions, so it is safe to once again
218− onE = settingsOnException set
309+ -- allow async exceptions.
219− port = settingsPort set
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+
220− onOpen = settingsOnOpen set
321+ onOpen adr = increase counter >> settingsOnOpen set adr
221− onClose = settingsOnClose set
322+ onClose adr _ = decrease counter >> settingsOnClose set adr
222−
323+
223− withTimeoutManager f =
224− case settingsManager set of
225− Nothing -> bracket
226− (T.initialize $ settingsTimeout set * 1000000)
227− T.stopManager
228− f
229− Just tm -> f tm
230−
231−serveConnection :: Settings
324+serveConnection :: Connection
232− -> Cleaner
325+ -> InternalInfo
233− -> Port -> Application -> Connection -> SockAddr-> IO ()
326+ -> T.Handle
234−serveConnection settings cleaner port app conn remoteHost' =
327+ -> SockAddr
235− runResourceT serveConnection'
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+
236 where
375 where
237− innerRunResourceT
376+ getProxyProtocolAddr src =
238− | settingsResourceTPerRequest settings = lift . runResourceT
377+ case settingsProxyProtocol settings of
239− | otherwise = id
378+ ProxyProtocolNone ->
240− th = threadHandle cleaner
379+ return origAddr
241−
380+ ProxyProtocolRequired -> do
242− serveConnection' :: ResourceT IO ()
381+ seg <- readSource src
243− serveConnection' = serveConnection'' $ connSource conn th
382+ parseProxyProtocolHeader src seg
244−
383+ ProxyProtocolOptional -> do
245− serveConnection'' fromClient = do
384+ seg <- readSource src
246− (env, getSource) <- parseRequest conn port remoteHost' fromClient
385+ if S.isPrefixOf "PROXY " seg
247− case settingsIntercept settings env of
386+ then parseProxyProtocolHeader src seg
248− Nothing -> do
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
249− -- Let the application run for as long as it wants
450+ -- Let the application run for as long as it wants
250− liftIO $ T.pause th
451+ T.pause th
251− keepAlive <- innerRunResourceT $ do
452+
252− res <- app env
453+ -- In the event that some scarce resource was acquired during
253−
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
254− liftIO $ T.resume th
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
255− sendResponse settings cleaner env conn res
463+ keepAlive <- sendResponse settings conn ii th req idxhdr (readSource src) res
256−
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
257− -- flush the rest of the request body
499+ -- flush the rest of the request body
258− requestBody env $$ CL.sinkNull
500+ isComplete <- flushBody nextBodyFlush maxToRead
259− ResumableSource fromClient' _ <- liftIO getSource
501+ if isComplete then do
260−
502+ T.resume th
261− when keepAlive $ serveConnection'' fromClient'
503+ return True
262− Just intercept -> do
504+ else
263− liftIO $ T.pause th
505+ return False
264− ResumableSource fromClient' _ <- liftIO getSource
506+ case mremainingRef of
265− intercept fromClient' conn
507+ Just ref -> do
266−
508+ remaining <- readIORef ref
267−connSource :: Connection -> T.Handle -> Source (ResourceT IO) ByteString
509+ if remaining <= maxToRead then
268−connSource Connection { connRecv = recv } th = src
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
269 where
533 where
270− src = do
534+ loop = do
271− bs <- liftIO recv
535+ bs <- src
272− unless (S.null bs) $ do
536+ unless (S.null bs) loop
273− when (S.length bs >= 2048) $ liftIO $ T.tickle th
274− yield bs
275− src
276
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+--
277-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
576-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
577+--
578+-- @since 3.2.17
278setSocketCloseOnExec :: Socket -> IO ()
579setSocketCloseOnExec :: Socket -> IO ()
279#if WINDOWS
580#if WINDOWS
280setSocketCloseOnExec _ = return ()
581setSocketCloseOnExec _ = return ()
281#else
582#else
282−setSocketCloseOnExec socket =
583+setSocketCloseOnExec socket = do
283− setFdOption (fromIntegral $ fdSocket socket) CloseOnExec True
584+#if MIN_VERSION_network(3,0,0)
585+ fd <- fdSocket socket
586+#else
587+ let fd = fdSocket socket
284#endif
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.hs+191−50

This diff is too big to show here.

warp/Network/Wai/Handler/Warp/Timeout.hsdeleted−122

This diff is too big to show here.

warp/Network/Wai/Handler/Warp/Types.hs+152−63

This diff is too big to show here.

warp/Network/Wai/Handler/Warp/Windows.hsnew file+27

This diff is too big to show here.

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/attic/hexnew file+1

This diff is too big to show here.

warp/attic/pong.hs+12−12

This diff is too big to show here.

warp/attic/server-no-keepalive.hs+1−1

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.hs+53−19

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/MultiMapSpec.hsdeleted−30

This diff is too big to show here.

warp/test/RequestSpec.hs+127−9

This diff is too big to show here.

warp/test/ResponseHeaderSpec.hs+25−5

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.hs+279−118

This diff is too big to show here.

warp/test/SendFileSpec.hsnew file+116

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.cabal+211−45

This diff is too big to show here.