on master help sign in
187 files changed+6139−5051
since splitsnapshots
unifiedsplit
.azure/azure-linux-template.yml+93 .azure/azure-osx-template.yml+30 .azure/azure-pipelines.yml+30 .azure/azure-windows-template.yml+23 .github/ISSUE_TEMPLATE.md+28 .github/PULL_REQUEST_TEMPLATE.md+14 .gitignore+2 .travis-setup.sh−10 .travis.yml−31 CONTRIBUTING.md+94 LICENSE+1−1 README.md+1−1 auto-update/ChangeLog.md+34−1 auto-update/Control/AutoUpdate.hs+64−28 auto-update/Control/Debounce.hs+41−59 auto-update/Control/Debounce/Internal.hs+98 auto-update/Control/Reaper.hs+131−36 auto-update/auto-update.cabal+13−9 auto-update/test/Control/AutoUpdateSpec.hs+26−25 auto-update/test/Control/DebounceSpec.hs+120 auto-update/test/Control/ReaperSpec.hs+29−27 mime-types/ChangeLog.md+12 mime-types/Network/Mime.hs+7 mime-types/mime-types.cabal+1−1 sources.txt−11 stack-lts-11.yaml+27 stack-lts-12.yaml+26 stack-nightly.yaml+20 stack.yaml+16−6 wai-handler-fastcgi/LICENSE → time-manager/LICENSE warp/Network/Wai/Handler/Warp/Timeout.hs → time-manager/System/TimeManager.hs+39−51 time-manager/time-manager.cabal+19 wai-app-static/ChangeLog.md+41 wai-app-static/Network/Wai/Application/Static.hs+53−29 wai-app-static/Util.hs+8−1 wai-app-static/WaiAppStatic/CmdLine.hs+8−1 wai-app-static/WaiAppStatic/Listing.hs+2−2 wai-app-static/WaiAppStatic/Storage/Embedded/Runtime.hs+7−8 wai-app-static/WaiAppStatic/Storage/Embedded/TH.hs+2−3 wai-app-static/WaiAppStatic/Storage/Filesystem.hs+9−7 wai-app-static/WaiAppStatic/Types.hs+4−3 wai-app-static/test/EmbeddedTestEntries.hs+5 wai-app-static/test/WaiAppEmbeddedTest.hs+9 wai-app-static/test/WaiAppStaticTest.hs+19−8 wai-app-static/wai-app-static.cabal+9−12 wai-conduit/ChangeLog.md+7−1 wai-conduit/Network/Wai/Conduit.hs+6−7 wai-conduit/example/Main.hs+19 wai-conduit/wai-conduit.cabal+3−4 wai-extra/ChangeLog.md+140 wai-extra/Network/Wai/EventSource.hs+24−1 wai-extra/Network/Wai/EventSource/EventStream.hs+9−10 wai-extra/Network/Wai/Handler/CGI.hs+21−16 wai-extra/Network/Wai/Handler/SCGI.hs+12−1 wai-extra/Network/Wai/Header.hs+1−1 wai-extra/Network/Wai/Middleware/ForceDomain.hs+38 wai-extra/Network/Wai/Middleware/ForceSSL.hs+2−8 wai-extra/Network/Wai/Middleware/Gzip.hs+42−15 wai-extra/Network/Wai/Middleware/HttpAuth.hs+18−10 wai-extra/Network/Wai/Middleware/Jsonp.hs+7−7 wai-extra/Network/Wai/Middleware/MethodOverride.hs+4−5 wai-extra/Network/Wai/Middleware/RequestLogger.hs+72−21 wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hs+48−10 wai-extra/Network/Wai/Middleware/Rewrite.hs+321−14 wai-extra/Network/Wai/Middleware/Timeout.hs+33 wai-extra/Network/Wai/Parse.hs+366−84 wai-extra/Network/Wai/Request.hs+53−3 wai-extra/Network/Wai/Test.hs+28−35 wai-extra/Network/Wai/Test/Internal.hs+35 wai-extra/README.md+14−1 wai-extra/app/Main.hs−55 wai-extra/example/Main.hs+62 wai-extra/app/index.html → wai-extra/example/index.html+3−2 wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hs+9−5 wai-extra/test/Network/Wai/Middleware/TimeoutSpec.hs+57 wai-extra/test/Network/Wai/ParseSpec.hs+94 wai-extra/test/Network/Wai/RequestSpec.hs+69−39 wai-extra/test/Network/Wai/TestSpec.hs+46−12 wai-extra/wai-extra.cabal+39−14 wai-frontend-monadcgi/ChangeLog.md+7−1 wai-frontend-monadcgi/Network/Wai/Frontend/MonadCGI.hs+4−1 wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+2−2 wai-handler-fastcgi/.gitignore−4 wai-handler-fastcgi/ChangeLog.md−1 wai-handler-fastcgi/Network/Wai/Handler/FastCGI.hsc−192 wai-handler-fastcgi/README wai-handler-fastcgi/README.md−3 wai-handler-fastcgi/Setup.lhs−7 wai-handler-fastcgi/configure−9 wai-handler-fastcgi/fastcgi.buildinfo.in−3 wai-handler-fastcgi/lighttpd.conf−19 wai-handler-fastcgi/test.hs−19 wai-handler-fastcgi/wai-handler-fastcgi.cabal−31 wai-handler-launch/.gitignore−2 wai-handler-launch/ChangeLog.md−7 wai-handler-launch/LICENSE−20 wai-handler-launch/Network/Wai/Handler/Launch.hs−206 wai-handler-launch/README wai-handler-launch/README.md−4 wai-handler-launch/Setup.lhs−7 wai-handler-launch/runtests.hs−22 wai-handler-launch/test.hs−7 wai-handler-launch/wai-handler-launch.cabal−36 wai-handler-launch/windows.c−12 wai-handler-webkit/.gitignore−2 wai-handler-webkit/ChangeLog.md−1 wai-handler-webkit/Network/Wai/Handler/Webkit.hs−21 wai-handler-webkit/README.md−53 wai-handler-webkit/Setup.lhs−7 wai-handler-webkit/sample.hs−10 wai-handler-webkit/wai-handler-webkit.cabal−30 wai-handler-webkit/webkit.cpp−19 wai-handler-webkit/LICENSE → wai-http2-extra/LICENSE+1−1 wai-http2-extra/Network/Wai/Middleware/Push/Referer.hs+236 wai-http2-extra/Network/Wai/Middleware/Push/Referer/LimitMultiMap.hs+40 wai-http2-extra/test/doctests.hs+4 wai-http2-extra/wai-http2-extra.cabal+44 wai-websockets/ChangeLog.md+20 wai-websockets/Network/Wai/Handler/WebSockets.hs+24−19 wai-websockets/server.lhs+9−3 wai-websockets/wai-websockets.cabal+3−4 wai/ChangeLog.md+36 wai/Network/Wai.hs+32−21 wai/Network/Wai/HTTP2.hs−272 wai/Network/Wai/Internal.hs+18−104 wai/README.md+1−1 wai/test/Network/WaiSpec.hs+7−9 wai/wai.cabal+8−12 wai/webkit-sample/webkit-sample.hs+2−2 warp-tls/ChangeLog.md+61 warp-tls/Network/Wai/Handler/WarpTLS.hs+142−99 warp-tls/warp-tls.cabal+16−8 warp/.ghci+1−1 warp/ChangeLog.md+249 warp/Network/Wai/Handler/Warp.hs+153−65 warp/Network/Wai/Handler/Warp/Buffer.hs+4−2 warp/Network/Wai/Handler/Warp/Conduit.hs+2−6 warp/Network/Wai/Handler/Warp/Counter.hs+3−4 warp/Network/Wai/Handler/Warp/Date.hs+5−20 warp/Network/Wai/Handler/Warp/FdCache.hs+78−90 warp/Network/Wai/Handler/Warp/File.hs+139−34 warp/Network/Wai/Handler/Warp/FileInfoCache.hs+21−19 warp/Network/Wai/Handler/Warp/HTTP2.hs+72−55 warp/Network/Wai/Handler/Warp/HTTP2/EncodeFrame.hs−35 warp/Network/Wai/Handler/Warp/HTTP2/File.hs+30 warp/Network/Wai/Handler/Warp/HTTP2/HPACK.hs−73 warp/Network/Wai/Handler/Warp/HTTP2/Manager.hs−86 warp/Network/Wai/Handler/Warp/HTTP2/PushPromise.hs+36 warp/Network/Wai/Handler/Warp/HTTP2/Receiver.hs−345 warp/Network/Wai/Handler/Warp/HTTP2/Request.hs+100−115 warp/Network/Wai/Handler/Warp/HTTP2/Response.hs+127 warp/Network/Wai/Handler/Warp/HTTP2/Sender.hs−426 warp/Network/Wai/Handler/Warp/HTTP2/Types.hs+63−294 warp/Network/Wai/Handler/Warp/HTTP2/Worker.hs−279 warp/Network/Wai/Handler/Warp/HashMap.hs+42 warp/Network/Wai/Handler/Warp/Header.hs+46−32 warp/Network/Wai/Handler/Warp/IO.hs+2−1 warp/Network/Wai/Handler/Warp/IORef.hs−26 warp/Network/Wai/Handler/Warp/Imports.hs+27 warp/Network/Wai/Handler/Warp/Internal.hs+7−13 warp/Network/Wai/Handler/Warp/MultiMap.hs+65−194 warp/Network/Wai/Handler/Warp/PackInt.hs+56 warp/Network/Wai/Handler/Warp/ReadInt.hs+2−2 warp/Network/Wai/Handler/Warp/Recv.hs+44−17 warp/Network/Wai/Handler/Warp/Request.hs+57−41 warp/Network/Wai/Handler/Warp/RequestHeader.hs+6−8 warp/Network/Wai/Handler/Warp/Response.hs+128−128 warp/Network/Wai/Handler/Warp/ResponseHeader.hs+3−5 warp/Network/Wai/Handler/Warp/Run.hs+235−209 warp/Network/Wai/Handler/Warp/SendFile.hs+12−14 warp/Network/Wai/Handler/Warp/Settings.hs+70−18 warp/Network/Wai/Handler/Warp/Types.hs+37−17 warp/Network/Wai/Handler/Warp/Windows.hs+5−1 warp/Network/Wai/Handler/Warp/WithApplication.hs+104 warp/attic/server-no-keepalive.hs+1−1 warp/bench/Parser.hs+21−16 warp/test/ExceptionSpec.hs+13−13 warp/test/FdCacheSpec.hs+2−2 warp/test/FileSpec.hs+45 warp/test/HTTP.hs+26−28 warp/test/MultiMapSpec.hs−30 warp/test/RequestSpec.hs+12−8 warp/test/ResponseHeaderSpec.hs+25−5 warp/test/ResponseSpec.hs+16−70 warp/test/RunSpec.hs+136−86 warp/test/WithApplicationSpec.hs+45 warp/warp.cabal+132−52
.azure/azure-linux-template.ymlnew file+93
@@ -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+2
@@ -8,3 +8,5 @@ tarballs/
88.cabal-sandbox/
99cabal.sandbox.config
1010.stack-work/
11+*~
12+stack*.yaml.lock
.travis-setup.shdeleted−10
@@ -1,10 +0,0 @@
1−#!/bin/sh
2−
3−set -eux
4−
5−mkdir -p $HOME/.cabal
6−cat > $HOME/.cabal/config <<EOF
7−remote-repo: hackage.haskell.org:http://hackage.fpcomplete.com/
8−remote-repo-cache: $HOME/.cabal/packages
9−jobs: \$ncpus
10−EOF
.travis.ymldeleted−31
@@ -1,31 +0,0 @@
1−
2−env:
3− - GHCVER=7.6.3 CABALVER=1.18
4− - GHCVER=7.8.4 CABALVER=1.18
5− - GHCVER=7.10.1 CABALVER=1.22
6− - GHCVER=7.10.2 CABALVER=1.22
7− - GHCVER=head CABALVER=head
8−
9−matrix:
10− allow_failures:
11− - env: GHCVER=head CABALVER=head
12−
13−before_install:
14− - travis_retry sudo add-apt-repository -y ppa:hvr/ghc
15− - travis_retry sudo apt-get update
16− - travis_retry sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER
17− - export PATH=/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.cabal/bin:$PATH
18− - ./.travis-setup.sh
19− - cabal --version
20−
21−install:
22− - ghc --version
23− - cabal --version
24− - sudo apt-get install libfcgi-dev
25− - travis_retry cabal update
26− - cabal unpack wai-logger
27− - mv wai-logger-* wai-logger
28− - cabal install hspec doctest HTTP temporary cabal-meta cabal-src
29− - cabal-meta install --force-reinstalls
30−
31−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/
22
33Permission is hereby granted, free of charge, to any person obtaining
44a copy of this software and associated documentation files (the
README.md+1−1
@@ -10,4 +10,4 @@ Code can be written that works with any web framework targeting WAI.
1010
1111[Haddock Documentation](http://hackage.haskell.org/package/wai)
1212
13−[![Build Status](https://travis-ci.org/yesodweb/wai.svg?branch=master)](https://travis-ci.org/yesodweb/wai)
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.md+34−1
@@ -1 +1,34 @@
1−__0.1.2__ Added Control.Debounce
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.hs+64−28
@@ -1,35 +1,60 @@
1−-- | A common problem is the desire to have an action run at a scheduled
2−-- interval, but only if it is needed. For example, instead of having
3−-- every web request result in a new @getCurrentTime@ call, we'd like to
4−-- have a single worker thread run every second, updating an @IORef@.
5−-- However, if the request frequency is less than once per second, this is
6−-- a pessimization, and worse, kills idle GC.
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'.
78--
8−-- This library allows you to define actions which will either be
9−-- performed by a dedicated thread or, in times of low volume, will be
10−-- executed by the calling thread.
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>.
1131module Control.AutoUpdate (
1232 -- * Type
1333 UpdateSettings
1434 , defaultUpdateSettings
1535 -- * Accessors
36+ , updateAction
1637 , updateFreq
1738 , updateSpawnThreshold
18− , updateAction
1939 -- * Creation
2040 , mkAutoUpdate
41+ , mkAutoUpdateWithModify
2142 ) where
2243
44+#if __GLASGOW_HASKELL__ < 709
45+import Control.Applicative ((<*>))
46+#endif
2347import Control.Concurrent (forkIO, threadDelay)
2448import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar,
2549 takeMVar, tryPutMVar)
26−import Control.Exception (SomeException, catch, throw, mask_, try)
50+import Control.Exception (SomeException, catch, mask_, throw,
51+ try)
2752import Control.Monad (void)
2853import Data.IORef (newIORef, readIORef, writeIORef)
2954
30−-- | Default value for creating an @UpdateSettings@.
55+-- | Default value for creating an 'UpdateSettings'.
3156--
32−-- Since 0.1.0
57+-- @since 0.1.0
3358defaultUpdateSettings :: UpdateSettings ()
3459defaultUpdateSettings = UpdateSettings
3560 { updateFreq = 1000000
@@ -39,46 +64,57 @@ defaultUpdateSettings = UpdateSettings
3964
4065-- | Settings to control how values are updated.
4166--
42−-- This should be constructed using @defaultUpdateSettings@ and record
67+-- This should be constructed using 'defaultUpdateSettings' and record
4368-- update syntax, e.g.:
4469--
4570-- @
46−-- let set = defaultUpdateSettings { updateAction = getCurrentTime }
71+-- let settings = 'defaultUpdateSettings' { 'updateAction' = 'Data.Time.Clock.getCurrentTime' }
4772-- @
4873--
49−-- Since 0.1.0
74+-- @since 0.1.0
5075data UpdateSettings a = UpdateSettings
5176 { updateFreq :: Int
5277 -- ^ Microseconds between update calls. Same considerations as
53− -- @threadDelay@ apply.
78+ -- 'threadDelay' apply.
5479 --
5580 -- Default: 1 second (1000000)
5681 --
57− -- Since 0.1.0
82+ -- @since 0.1.0
5883 , updateSpawnThreshold :: Int
5984 -- ^ NOTE: This value no longer has any effect, since worker threads are
6085 -- dedicated instead of spawned on demand.
6186 --
62− -- Previously, this determined: How many times the data must be requested
87+ -- Previously, this determined how many times the data must be requested
6388 -- before we decide to spawn a dedicated thread.
6489 --
6590 -- Default: 3
6691 --
67− -- Since 0.1.0
92+ -- @since 0.1.0
6893 , updateAction :: IO a
6994 -- ^ Action to be performed to get the current value.
7095 --
7196 -- Default: does nothing.
7297 --
73− -- Since 0.1.0
98+ -- @since 0.1.0
7499 }
75100
76101-- | Generate an action which will either read from an automatically
77102-- updated value, or run the update action in the current thread.
78103--
79−-- Since 0.1.0
104+-- @since 0.1.0
80105mkAutoUpdate :: UpdateSettings a -> IO (IO a)
81−mkAutoUpdate us = do
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
82118 -- A baton to tell the worker thread to generate a new value.
83119 needsRunning <- newEmptyMVar
84120
@@ -121,12 +157,12 @@ mkAutoUpdate us = do
121157 -- This infinite loop makes up out worker thread. It takes an a
122158 -- responseVar value where the next value should be putMVar'ed to for
123159 -- the benefit of any requesters currently blocked on it.
124− let loop responseVar = do
160+ let loop responseVar maybea = do
125161 -- block until a value is actually needed
126162 takeMVar needsRunning
127163
128164 -- new value requested, so run the updateAction
129− a <- catchSome $ updateAction us
165+ a <- catchSome $ maybe (updateAction us) id (updateActionModify <*> maybea)
130166
131167 -- we got a new value, update currRef and lastValue
132168 writeIORef currRef $ Right a
@@ -141,10 +177,10 @@ mkAutoUpdate us = do
141177 -- variable.
142178 responseVar' <- newEmptyMVar
143179 writeIORef currRef $ Left responseVar'
144− loop responseVar'
180+ loop responseVar' (Just a)
145181
146182 -- Kick off the loop, with the initial responseVar0 variable.
147− loop responseVar0
183+ loop responseVar0 Nothing
148184
149185 return $ do
150186 mval <- readIORef currRef
@@ -158,7 +194,7 @@ mkAutoUpdate us = do
158194 -- we have a current value, use it
159195 Right val -> return val
160196
161−-- | Turn a runtime exception into an impure exception, so that all @IO@
197+-- | Turn a runtime exception into an impure exception, so that all 'IO'
162198-- actions will complete successfully. This simply defers the exception until
163199-- the value is forced.
164200catchSome :: IO a -> IO a
auto-update/Control/Debounce.hs+41−59
@@ -3,76 +3,58 @@
33-- period of time.
44--
55-- This is useful as an optimization, for example to ensure that logs are only
6−-- flushed to disk at most once per second. See the fast-logger package for an
7−-- example usage.
6+-- flushed to disk at most once per second.
87--
9−-- Since 0.1.2
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
1027module Control.Debounce
1128 ( -- * Type
12− DebounceSettings
29+ DI.DebounceSettings
1330 , defaultDebounceSettings
1431 -- * Accessors
15− , debounceFreq
16− , debounceAction
32+ , DI.debounceFreq
33+ , DI.debounceAction
34+ , DI.debounceEdge
35+ , DI.leadingEdge
36+ , DI.trailingEdge
1737 -- * Creation
1838 , mkDebounce
1939 ) where
2040
21−import Control.Concurrent (forkIO, threadDelay)
22−import Control.Concurrent.MVar (newEmptyMVar, takeMVar, tryPutMVar)
23−import Control.Exception (SomeException, handle, mask_)
24−import Control.Monad (forever, void)
25−
26−-- | Settings to control how debouncing should work.
27−--
28−-- This should be constructed using @defaultDebounceSettings@ and record
29−-- update syntax, e.g.:
30−--
31−-- @
32−-- let set = defaultDebounceSettings { debounceAction = flushLog }
33−-- @
34−--
35−-- Since 0.1.2
36−data DebounceSettings = DebounceSettings
37− { debounceFreq :: Int
38− -- ^ Microseconds lag required between subsequence calls to the debounced
39− -- action.
40− --
41− -- Default: 1 second (1000000)
42− --
43− -- Since 0.1.2
44− , debounceAction :: IO ()
45− -- ^ Action to be performed.
46− --
47− -- Note: all exceptions thrown by this action will be silently discarded.
48− --
49− -- Default: does nothing.
50− --
51− -- Since 0.1.2
52− }
41+import Control.Concurrent (newEmptyMVar, threadDelay)
42+import qualified Control.Debounce.Internal as DI
5343
54−-- | Default value for creating a @DebounceSettings@.
44+-- | Default value for creating a 'DebounceSettings'.
5545--
56−-- Since 0.1.2
57−defaultDebounceSettings :: DebounceSettings
58−defaultDebounceSettings = DebounceSettings
59− { debounceFreq = 1000000
60− , debounceAction = return ()
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
6152 }
6253
63−-- | Generate an action which will trigger the debounced action to be
64−-- performed. The action will either be performed immediately, or after the
65−-- current cooldown period has expired.
54+-- | Generate an action which will trigger the debounced action to be performed.
6655--
67−-- Since 0.1.2
68−mkDebounce :: DebounceSettings -> IO (IO ())
69−mkDebounce (DebounceSettings freq action) = do
70− baton <- newEmptyMVar
71− mask_ $ void $ forkIO $ forever $ do
72− takeMVar baton
73− ignoreExc action
74− threadDelay freq
75− return $ void $ tryPutMVar baton ()
76−
77−ignoreExc :: IO () -> IO ()
78−ignoreExc = handle $ \(_ :: SomeException) -> return ()
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.hs+131−36
@@ -1,9 +1,20 @@
11{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
23
34-- | This module provides the ability to create reapers: dedicated cleanup
45-- threads. These threads will automatically spawn and die based on the
5−-- presence of a workload to process on.
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".
614module Control.Reaper (
15+ -- * Example: Regularly cleaning a cache
16+ -- $example1
17+
718 -- * Settings
819 ReaperSettings
920 , defaultReaperSettings
@@ -22,10 +33,9 @@ module Control.Reaper (
2233 ) where
2334
2435import Control.AutoUpdate.Util (atomicModifyIORef')
25−import Control.Concurrent (forkIO, threadDelay)
36+import Control.Concurrent (forkIO, threadDelay, killThread, ThreadId)
2637import Control.Exception (mask_)
27−import Control.Monad (join, void)
28−import Data.IORef (IORef, newIORef, readIORef)
38+import Data.IORef (IORef, newIORef, readIORef, writeIORef)
2939
3040-- | Settings for creating a reaper. This type has two parameters:
3141-- @workload@ gives the entire workload, whereas @item@ gives an
@@ -33,51 +43,52 @@ import Data.IORef (IORef, newIORef, readIORef)
3343-- be a list of @item@s. This is encouraged by 'defaultReaperSettings' and
3444-- 'mkListAction'.
3545--
36−-- Since 0.1.1
46+-- @since 0.1.1
3747data ReaperSettings workload item = ReaperSettings
3848 { reaperAction :: workload -> IO (workload -> workload)
3949 -- ^ The action to perform on a workload. The result of this is a
4050 -- \"workload modifying\" function. In the common case of using lists,
4151 -- the result should be a difference list that prepends the remaining
42− -- workload to the temporary workload. For help with setting up such
43− -- an action, see 'mkListAction'.
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'.
4455 --
4556 -- Default: do nothing with the workload, and then prepend it to the
4657 -- temporary workload. This is incredibly useless; you should
4758 -- definitely override this default.
4859 --
49− -- Since 0.1.1
60+ -- @since 0.1.1
5061 , reaperDelay :: {-# UNPACK #-} !Int
5162 -- ^ Number of microseconds to delay between calls of 'reaperAction'.
5263 --
5364 -- Default: 30 seconds.
5465 --
55− -- Since 0.1.1
66+ -- @since 0.1.1
5667 , reaperCons :: item -> workload -> workload
5768 -- ^ Add an item onto a workload.
5869 --
5970 -- Default: list consing.
6071 --
61− -- Since 0.1.1
72+ -- @since 0.1.1
6273 , reaperNull :: workload -> Bool
6374 -- ^ Check if a workload is empty, in which case the worker thread
6475 -- will shut down.
6576 --
6677 -- Default: 'null'.
6778 --
68− -- Since 0.1.1
79+ -- @since 0.1.1
6980 , reaperEmpty :: workload
7081 -- ^ An empty workload.
7182 --
7283 -- Default: empty list.
7384 --
74− -- Since 0.1.1
85+ -- @since 0.1.1
7586 }
7687
7788-- | Default @ReaperSettings@ value, biased towards having a list of work
7889-- items.
7990--
80−-- Since 0.1.1
91+-- @since 0.1.1
8192defaultReaperSettings :: ReaperSettings [item] item
8293defaultReaperSettings = ReaperSettings
8394 { reaperAction = \wl -> return (wl ++)
@@ -96,24 +107,28 @@ data Reaper workload item = Reaper {
96107 -- | Stopping the reaper thread if exists.
97108 -- The current workload is returned.
98109 , reaperStop :: IO workload
110+ -- | Killing the reaper thread immediately if exists.
111+ , reaperKill :: IO ()
99112 }
100113
101114-- | State of reaper.
102115data State workload = NoReaper -- ^ No reaper thread
103− | Workload workload -- ^ The current jobs
116+ | Workload !workload -- ^ The current jobs
104117
105−-- | Create a reaper addition function. This funciton can be used to add
118+-- | Create a reaper addition function. This function can be used to add
106119-- new items to the workload. Spawning of reaper threads will be handled
107120-- for you automatically.
108121--
109−-- Since 0.1.1
122+-- @since 0.1.1
110123mkReaper :: ReaperSettings workload item -> IO (Reaper workload item)
111124mkReaper settings@ReaperSettings{..} = do
112125 stateRef <- newIORef NoReaper
126+ tidRef <- newIORef Nothing
113127 return Reaper {
114− reaperAdd = update settings stateRef
128+ reaperAdd = add settings stateRef tidRef
115129 , reaperRead = readRef stateRef
116130 , reaperStop = stop stateRef
131+ , reaperKill = kill tidRef
117132 }
118133 where
119134 readRef stateRef = do
@@ -125,31 +140,46 @@ mkReaper settings@ReaperSettings{..} = do
125140 case mx of
126141 NoReaper -> (NoReaper, reaperEmpty)
127142 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
128148
129−update :: ReaperSettings workload item -> IORef (State workload) -> item
130− -> IO ()
131−update settings@ReaperSettings{..} stateRef item =
132− mask_ $ join $ atomicModifyIORef' stateRef cons
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
133156 where
134− cons NoReaper = (Workload $ reaperCons item reaperEmpty
135− ,spawn settings stateRef)
136− cons (Workload wl) = (Workload $ reaperCons item wl
137− ,return ())
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 ())
138161
139−spawn :: ReaperSettings workload item -> IORef (State workload) -> IO ()
140−spawn settings stateRef = void . forkIO $ reaper settings stateRef
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
141168
142−reaper :: ReaperSettings workload item -> IORef (State workload) -> IO ()
143−reaper settings@ReaperSettings{..} stateRef = do
169+reaper :: ReaperSettings workload item
170+ -> IORef (State workload) -> IORef (Maybe ThreadId)
171+ -> IO ()
172+reaper settings@ReaperSettings{..} stateRef tidRef = do
144173 threadDelay reaperDelay
145174 -- Getting the current jobs. Push an empty job to the reference.
146175 wl <- atomicModifyIORef' stateRef swapWithEmpty
147176 -- Do the jobs. A function to merge the left jobs and
148177 -- new jobs is returned.
149− merge <- reaperAction wl
178+ !merge <- reaperAction wl
150179 -- Merging the left jobs and new jobs.
151180 -- If there is no jobs, this thread finishes.
152− join $ atomicModifyIORef' stateRef (check merge)
181+ next <- atomicModifyIORef' stateRef (check merge)
182+ next
153183 where
154184 swapWithEmpty NoReaper = error "Control.Reaper.reaper: unexpected NoReaper (1)"
155185 swapWithEmpty (Workload wl) = (Workload reaperEmpty, wl)
@@ -157,9 +187,9 @@ reaper settings@ReaperSettings{..} stateRef = do
157187 check _ NoReaper = error "Control.Reaper.reaper: unexpected NoReaper (2)"
158188 check merge (Workload wl)
159189 -- If there is no job, reaper is terminated.
160− | reaperNull wl' = (NoReaper, return ())
190+ | reaperNull wl' = (NoReaper, writeIORef tidRef Nothing)
161191 -- If there are jobs, carry them out.
162− | otherwise = (Workload wl', reaper settings stateRef)
192+ | otherwise = (Workload wl', reaper settings stateRef tidRef)
163193 where
164194 wl' = merge wl
165195
@@ -168,18 +198,83 @@ reaper settings@ReaperSettings{..} stateRef = do
168198-- return either a new work item, or @Nothing@ if the work item is
169199-- expired.
170200--
171−-- Since 0.1.1
201+-- @since 0.1.1
172202mkListAction :: (item -> IO (Maybe item'))
173203 -> [item]
174204 -> IO ([item'] -> [item'])
175205mkListAction f =
176206 go id
177207 where
178− go front [] = return front
179− go front (x:xs) = do
208+ go !front [] = return front
209+ go !front (x:xs) = do
180210 my <- f x
181211 let front' =
182212 case my of
183213 Nothing -> front
184214 Just y -> front . (y:)
185215 go front' xs
216+
217+-- $example1
218+-- In this example code, we use a 'Data.Map.Strict.Map' to cache fibonacci numbers, and a 'Reaper' to prune the cache.
219+--
220+-- The @main@ function first creates a 'Reaper', with fields to initialize the
221+-- cache ('reaperEmpty'), add items to it ('reaperCons'), and prune it ('reaperAction').
222+-- The reaper will run every two seconds ('reaperDelay'), but will stop running while
223+-- 'reaperNull' is true.
224+--
225+-- @main@ then loops infinitely ('Control.Monad.forever'). Each second it calculates the fibonacci number
226+-- for a value between 30 and 34, first trying the cache ('reaperRead' and 'Data.Map.Strict.lookup'),
227+-- then falling back to manually calculating it (@fib@)
228+-- and updating the cache with the result ('reaperAdd')
229+--
230+-- @clean@ simply removes items cached for more than 10 seconds.
231+-- This function is where you would perform IO-related cleanup,
232+-- like killing threads or closing connections, if that was the purpose of your reaper.
233+--
234+-- @
235+-- module Main where
236+--
237+-- import "Data.Time" (UTCTime, getCurrentTime, diffUTCTime)
238+-- import "Control.Reaper"
239+-- import "Control.Concurrent" (threadDelay)
240+-- import "Data.Map.Strict" (Map)
241+-- import qualified "Data.Map.Strict" as Map
242+-- import "Control.Monad" (forever)
243+-- import "System.Random" (getStdRandom, randomR)
244+--
245+-- fib :: 'Int' -> 'Int'
246+-- fib 0 = 0
247+-- fib 1 = 1
248+-- fib n = fib (n-1) + fib (n-2)
249+--
250+-- type Cache = 'Data.Map.Strict.Map' 'Int' ('Int', 'Data.Time.Clock.UTCTime')
251+--
252+-- main :: IO ()
253+-- main = do
254+-- reaper <- 'mkReaper' 'defaultReaperSettings'
255+-- { 'reaperEmpty' = Map.'Data.Map.Strict.empty'
256+-- , 'reaperCons' = \\(k, v, time) workload -> Map.'Data.Map.Strict.insert' k (v, time) workload
257+-- , 'reaperAction' = clean
258+-- , 'reaperDelay' = 1000000 * 2 -- Clean every 2 seconds
259+-- , 'reaperNull' = Map.'Data.Map.Strict.null'
260+-- }
261+-- forever $ do
262+-- fibArg <- 'System.Random.getStdRandom' ('System.Random.randomR' (30,34))
263+-- cache <- 'reaperRead' reaper
264+-- let cachedResult = Map.'Data.Map.Strict.lookup' fibArg cache
265+-- case cachedResult of
266+-- 'Just' (fibResult, _createdAt) -> 'putStrLn' $ "Found in cache: `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
267+-- 'Nothing' -> do
268+-- let fibResult = fib fibArg
269+-- 'putStrLn' $ "Calculating `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
270+-- time <- 'Data.Time.Clock.getCurrentTime'
271+-- ('reaperAdd' reaper) (fibArg, fibResult, time)
272+-- 'threadDelay' 1000000 -- 1 second
273+--
274+-- -- Remove items > 10 seconds old
275+-- clean :: Cache -> IO (Cache -> Cache)
276+-- clean oldMap = do
277+-- currentTime <- 'Data.Time.Clock.getCurrentTime'
278+-- let pruned = Map.'Data.Map.Strict.filter' (\\(_, createdAt) -> currentTime \`diffUTCTime\` createdAt < 10.0) oldMap
279+-- return (\\newData -> Map.'Data.Map.Strict.union' pruned newData)
280+-- @
auto-update/auto-update.cabal+13−9
@@ -1,5 +1,5 @@
11name: auto-update
2−version: 0.1.2.2
2+version: 0.1.6
33synopsis: Efficiently run periodic, on-demand actions
44description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
55homepage: https://github.com/yesodweb/wai
@@ -17,18 +17,22 @@ library
1717 ghc-options: -Wall
1818 exposed-modules: Control.AutoUpdate
1919 Control.Debounce
20+ Control.Debounce.Internal
2021 Control.Reaper
2122 other-modules: Control.AutoUpdate.Util
2223 build-depends: base >= 4 && < 5
2324 default-language: Haskell2010
25+ if impl(ghc >= 8)
26+ default-extensions: Strict StrictData
2427
2528-- Test suite is currently not robust enough, gives too many false negatives.
2629
27−-- test-suite spec
28−-- main-is: Spec.hs
29−-- other-modules: Control.AutoUpdateSpec
30−-- Control.ReaperSpec
31−-- hs-source-dirs: test
32−-- type: exitcode-stdio-1.0
33−-- build-depends: base, auto-update, hspec
34−-- default-language: Haskell2010
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.hs+26−25
@@ -1,34 +1,35 @@
11module Control.AutoUpdateSpec (spec) where
22
3−import Test.Hspec
4−import Test.Hspec.QuickCheck
5−import Data.IORef
3+import Control.AutoUpdate
64import Control.Concurrent (threadDelay)
75import Control.Monad (replicateM_, forM_)
8−import Control.AutoUpdate
6+import Data.IORef
7+import Test.Hspec
8+import Test.Hspec.QuickCheck
99
1010spec :: Spec
11−spec = do
12− prop "incrementer" $ \st' -> do
13− let st = abs st' `mod` 10000
14− ref <- newIORef 0
15− next <- mkAutoUpdate defaultUpdateSettings
16− { updateAction = atomicModifyIORef ref $ \i ->
17− let i' = succ i in i' `seq` (i', i')
18− , updateSpawnThreshold = st
19− , updateFreq = 10000
20− }
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+ -- }
2122
22− forM_ [1..st + 1] $ \i -> do
23− j <- next
24− j `shouldBe` i
23+ -- forM_ [1..st + 1] $ \i -> do
24+ -- j <- next
25+ -- j `shouldBe` i
2526
26− replicateM_ 50 $ do
27− i <- next
28− i `shouldBe` st + 2
27+ -- replicateM_ 50 $ do
28+ -- i <- next
29+ -- i `shouldBe` st + 2
2930
30− threadDelay 60000
31− last1 <- readIORef ref
32− threadDelay 20000
33− last2 <- readIORef ref
34− last2 `shouldBe` last1
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.hs+29−27
@@ -1,37 +1,39 @@
11module Control.ReaperSpec (spec) where
22
3−import Control.Reaper
43import Control.Concurrent
4+import Control.Reaper
5+import Data.IORef
56import Test.Hspec
67import Test.Hspec.QuickCheck
7−import Data.IORef
88
9−type Item = (Int, IORef Int)
10−
11−action = mkListAction $ \(i, ref) -> do
12− modifyIORef ref succ
13− return $ if i > 1
14− then Just (pred i, ref)
15− else Nothing
169
1710spec :: Spec
18−spec = prop "works" $ \is -> do
19− reaper <- mkReaper defaultReaperSettings
20− { reaperAction = action
21− , reaperDelay = 1000
22− }
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 ()
2332
24− let mkTestCase i = do
25− ref <- newIORef 0
26− let expected = (abs i `mod` 10) + 1
27− reaperAdd reaper (expected, ref)
28− return (expected, ref)
29− testCases <- mapM mkTestCase is
33+-- type Item = (Int, IORef Int)
3034
31− let test (expected, ref) = do
32− actual <- readIORef ref
33− actual `shouldBe` (expected :: Int)
34− threadDelay 100000
35− mapM_ test testCases
36− [] <- reaperRead reaper
37− return ()
35+-- action = mkListAction $ \(i, ref) -> do
36+-- modifyIORef ref succ
37+-- return $ if i > 1
38+-- then Just (pred i, ref)
39+-- else Nothing
mime-types/ChangeLog.md+12
@@ -1,3 +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+
113## 0.1.0.6
214
315* Add woff2 mime type [#350](https://github.com/yesodweb/wai/pull/350)
mime-types/Network/Mime.hs+7
@@ -468,6 +468,11 @@ defaultMimeMap = Map.fromAscList [
468468 , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
469469 , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
470470 , ("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+
471476 , ("lha", "application/x-lzh-compressed")
472477 , ("link66", "application/vnd.route66.link66+xml")
473478 , ("list", "text/plain")
@@ -526,6 +531,7 @@ defaultMimeMap = Map.fromAscList [
526531 , ("mime", "message/rfc822")
527532 , ("mj2", "video/mj2")
528533 , ("mjp2", "video/mj2")
534+ , ("mjs", "application/javascript")
529535 , ("mk3d", "video/x-matroska")
530536 , ("mka", "audio/x-matroska")
531537 , ("mks", "video/x-matroska")
@@ -974,6 +980,7 @@ defaultMimeMap = Map.fromAscList [
974980 , ("w3d", "application/x-director")
975981 , ("wad", "application/x-doom")
976982 , ("war", "application/java-archive")
983+ , ("wasm", "application/wasm")
977984 , ("wav", "audio/x-wav")
978985 , ("wax", "audio/x-ms-wax")
979986 , ("wbmp", "image/vnd.wap.wbmp")
mime-types/mime-types.cabal+1−1
@@ -1,5 +1,5 @@
11name: mime-types
2−version: 0.1.0.6
2+version: 0.1.0.9
33synopsis: Basic mime-type handling types and functions
44description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
55homepage: https://github.com/yesodweb/wai
sources.txtdeleted−11
@@ -1,11 +0,0 @@
1−./wai
2−./wai-extra
3−./warp
4−./warp-tls
5−./wai-app-static
6−./wai-handler-fastcgi
7−./wai-handler-launch
8−./wai-websockets
9−./wai-conduit
10−./mime-types
11−./auto-update
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.yaml+16−6
@@ -1,15 +1,25 @@
1−resolver: lts-3.13
1+resolver: lts-14.22
22packages:
3+- ./auto-update
4+- ./mime-types
35- ./wai
46- ./wai-extra
57- ./warp
68- ./warp-tls
79- ./wai-app-static
8−- ./wai-handler-fastcgi
9−- ./wai-handler-launch
1010- ./wai-websockets
1111- ./wai-conduit
12−- ./mime-types
13−- ./auto-update
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
1421extra-deps:
15−- http2-1.3.0
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-handler-fastcgi/LICENSE → time-manager/LICENSErenamed

The content is the same.

warp/Network/Wai/Handler/Warp/Timeout.hs → time-manager/System/TimeManager.hsrenamed+39−51
@@ -1,9 +1,6 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE MagicHash #-}
4−{-# LANGUAGE UnboxedTuples #-} -- for GHC 7.4 or earlier
52
6−module Network.Wai.Handler.Warp.Timeout (
3+module System.TimeManager (
74 -- ** Types
85 Manager
96 , TimeoutAction
@@ -11,6 +8,7 @@ module Network.Wai.Handler.Warp.Timeout (
118 -- ** Manager
129 , initialize
1310 , stopManager
11+ , killManager
1412 , withManager
1513 -- ** Registration
1614 , register
@@ -24,25 +22,12 @@ module Network.Wai.Handler.Warp.Timeout (
2422 , TimeoutThread (..)
2523 ) where
2624
27−#ifndef MIN_VERSION_base
28−#define MIN_VERSION_base(x,y,z) 1
29−#endif
30−
31−#if MIN_VERSION_base(4,6,0)
32−import Control.Concurrent (mkWeakThreadId, ThreadId)
33−#else
34−import GHC.Conc (ThreadId(..))
35−import GHC.Exts (mkWeak#)
36−import GHC.IO (IO (IO))
37−#endif
3825import Control.Concurrent (myThreadId)
3926import qualified Control.Exception as E
40−import GHC.Weak (Weak (..))
41−import Network.Wai.Handler.Warp.IORef (IORef)
42−import qualified Network.Wai.Handler.Warp.IORef as I
43−import System.Mem.Weak (deRefWeak)
44−import Data.Typeable (Typeable)
4527import Control.Reaper
28+import Data.Typeable (Typeable)
29+import Data.IORef (IORef)
30+import qualified Data.IORef as I
4631
4732----------------------------------------------------------------
4833
@@ -53,7 +38,7 @@ type Manager = Reaper [Handle] Handle
5338type TimeoutAction = IO ()
5439
5540-- | A handle used by 'Manager'
56−data Handle = Handle TimeoutAction (IORef State)
41+data Handle = Handle !(IORef TimeoutAction) !(IORef State)
5742
5843data State = Active -- Manager turns it to Inactive.
5944 | Inactive -- Manager removes it with timeout action.
@@ -70,10 +55,11 @@ initialize timeout = mkReaper defaultReaperSettings
7055 , reaperDelay = timeout
7156 }
7257 where
73− prune m@(Handle onTimeout iactive) = do
74− state <- I.atomicModifyIORef' iactive (\x -> (inactivate x, x))
58+ prune m@(Handle actionRef stateRef) = do
59+ state <- I.atomicModifyIORef' stateRef (\x -> (inactivate x, x))
7560 case state of
7661 Inactive -> do
62+ onTimeout <- I.readIORef actionRef
7763 onTimeout `E.catch` ignoreAll
7864 return Nothing
7965 Canceled -> return Nothing
@@ -84,68 +70,70 @@ initialize timeout = mkReaper defaultReaperSettings
8470
8571----------------------------------------------------------------
8672
87−-- | Stopping timeout manager.
73+-- | Stopping timeout manager with onTimeout fired.
8874stopManager :: Manager -> IO ()
8975stopManager mgr = E.mask_ (reaperStop mgr >>= mapM_ fire)
9076 where
91− fire (Handle onTimeout _) = onTimeout `E.catch` ignoreAll
77+ fire (Handle actionRef _) = do
78+ onTimeout <- I.readIORef actionRef
79+ onTimeout `E.catch` ignoreAll
9280
9381ignoreAll :: E.SomeException -> IO ()
9482ignoreAll _ = return ()
9583
84+-- | Killing timeout manager immediately without firing onTimeout.
85+killManager :: Manager -> IO ()
86+killManager = reaperKill
87+
9688----------------------------------------------------------------
9789
9890-- | Registering a timeout action.
9991register :: Manager -> TimeoutAction -> IO Handle
10092register mgr onTimeout = do
101− iactive <- I.newIORef Active
102− let h = Handle onTimeout iactive
93+ actionRef <- I.newIORef onTimeout
94+ stateRef <- I.newIORef Active
95+ let h = Handle actionRef stateRef
10396 reaperAdd mgr h
10497 return h
10598
10699-- | Registering a timeout action of killing this thread.
107−registerKillThread :: Manager -> IO Handle
108−registerKillThread m = do
109− wtid <- myThreadId >>= mkWeakThreadId
110− register m $ killIfExist wtid
111−
112−-- If ThreadId is hold referred by a strong reference,
113−-- it leaks even after the thread is killed.
114−-- So, let's use a weak reference so that CG can throw ThreadId away.
115−-- deRefWeak checks if ThreadId referenced by the weak reference
116−-- exists. If exists, it means that the thread is alive.
117−killIfExist :: Weak ThreadId -> TimeoutAction
118−killIfExist wtid = deRefWeak wtid >>= maybe (return ()) (`E.throwTo` TimeoutThread)
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
119110
120111data TimeoutThread = TimeoutThread
121112 deriving Typeable
122−instance E.Exception TimeoutThread
113+instance E.Exception TimeoutThread where
114+ toException = E.asyncExceptionToException
115+ fromException = E.asyncExceptionFromException
123116instance Show TimeoutThread where
124− show TimeoutThread = "Thread killed by Warp's timeout reaper"
125−
126−#if !MIN_VERSION_base(4,6,0)
127−mkWeakThreadId :: ThreadId -> IO (Weak ThreadId)
128−mkWeakThreadId t@(ThreadId t#) = IO $ \s ->
129− case mkWeak# t# t Nothing s of
130− (# s1, w #) -> (# s1, Weak w #)
131−#endif
117+ show TimeoutThread = "Thread killed by timeout manager"
132118
133119----------------------------------------------------------------
134120
135121-- | Setting the state to active.
136122-- 'Manager' turns active to inactive repeatedly.
137123tickle :: Handle -> IO ()
138−tickle (Handle _ iactive) = I.writeIORef iactive Active
124+tickle (Handle _ stateRef) = I.writeIORef stateRef Active
139125
140126-- | Setting the state to canceled.
141127-- 'Manager' eventually removes this without timeout action.
142128cancel :: Handle -> IO ()
143−cancel (Handle _ iactive) = I.writeIORef iactive Canceled
129+cancel (Handle actionRef stateRef) = do
130+ I.writeIORef actionRef (return ()) -- ensuring to release ThreadId
131+ I.writeIORef stateRef Canceled
144132
145133-- | Setting the state to paused.
146134-- 'Manager' does not change the value.
147135pause :: Handle -> IO ()
148−pause (Handle _ iactive) = I.writeIORef iactive Paused
136+pause (Handle _ stateRef) = I.writeIORef stateRef Paused
149137
150138-- | Setting the paused state to active.
151139-- This is an alias to 'tickle'.
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/ChangeLog.md+41
@@ -1,3 +1,44 @@
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+
142## 3.1.3
243
344* Add 404 handler [#467](https://github.com/yesodweb/wai/pull/467)
wai-app-static/Network/Wai/Application/Static.hs+53−29
@@ -34,12 +34,13 @@ import qualified Data.ByteString.Lazy as L
3434import Data.ByteString.Lazy.Char8 ()
3535import Control.Monad.IO.Class (liftIO)
3636
37−import Blaze.ByteString.Builder (toByteString)
37+import Data.ByteString.Builder (toLazyByteString)
3838
3939import Data.FileEmbed (embedFile)
4040
4141import Data.Text (Text)
4242import qualified Data.Text as T
43+import qualified Data.Text.Encoding as TE
4344
4445import Network.HTTP.Date (parseHTTPDate, epochTimeToHTTPDate, formatHTTPDate)
4546
@@ -86,14 +87,14 @@ serveFolder StaticSettings {..} pieces req folder@Folder {..} =
8687 Nothing -> return $ WaiResponse $ W.responseLBS H.status403
8788 [ ("Content-Type", "text/plain")
8889 ] "Directory listings disabled"
90+
91+addTrailingSlash :: W.Request -> Maybe ByteString
92+addTrailingSlash req
93+ | S8.null rp = Just "/"
94+ | S8.last rp == '/' = Nothing
95+ | otherwise = Just $ S8.snoc rp '/'
8996 where
90− addTrailingSlash :: W.Request -> Maybe ByteString
91− addTrailingSlash req
92− | S8.null rp = Just "/"
93− | S8.last rp == '/' = Nothing
94− | otherwise = Just $ S8.snoc rp '/'
95− where
96− rp = W.rawPathInfo req
97+ rp = W.rawPathInfo req
9798
9899checkPieces :: StaticSettings
99100 -> Pieces -- ^ parsed request
@@ -107,28 +108,49 @@ checkPieces _ pieces _ | any (T.null . fromPiece) $ safeInit pieces =
107108checkPieces ss@StaticSettings {..} pieces req = do
108109 res <- lookupResult
109110 case res of
110− LRNotFound -> return NotFound
111− LRFile file -> serveFile ss req file
112− LRFolder folder -> serveFolder ss pieces req folder
111+ Left location -> return $ RawRedirect location
112+ Right LRNotFound -> return NotFound
113+ Right (LRFile file) -> serveFile ss req file
114+ Right (LRFolder folder) -> serveFolder ss pieces req folder
113115 where
114− lookupResult :: IO LookupResult
116+ lookupResult :: IO (Either ByteString LookupResult)
115117 lookupResult = do
116118 nonIndexResult <- ssLookupFile pieces
117119 case nonIndexResult of
118− LRFile{} -> return nonIndexResult
120+ LRFile{} -> return $ Right nonIndexResult
119121 _ -> do
120− indexResult <- lookupIndices (map (\ index -> pieces ++ [index]) ssIndices)
121− return $ case indexResult of
122− LRNotFound -> nonIndexResult
123− _ -> indexResult
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
124144
125− lookupIndices :: [Pieces] -> IO LookupResult
145+ lookupIndices :: [Pieces] -> IO (Either ByteString LookupResult)
126146 lookupIndices (x : xs) = do
127147 res <- ssLookupFile x
128148 case res of
129149 LRNotFound -> lookupIndices xs
130− _ -> return res
131− lookupIndices [] = return LRNotFound
150+ _ -> return $ case (ssAddTrailingSlash, addTrailingSlash req) of
151+ (True, Just redirect) -> Left redirect
152+ _ -> Right res
153+ lookupIndices [] = return $ Right LRNotFound
132154
133155serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
134156serveFile StaticSettings {..} req file
@@ -142,11 +164,13 @@ serveFile StaticSettings {..} req file
142164 -- Didn't match, but we have a hash value. Send the file contents
143165 -- with an ETag header.
144166 --
145− -- Note: It would be arguably better to next check
146− -- if-modified-since and return a 304 if that indicates a match as
147− -- well. However, the circumstances under which such a situation
148− -- could arise would be very anomolous, and should likely warrant a
149− -- new file being sent anyway.
167+ -- RFC7232 (HTTP 1.1):
168+ -- > A recipient MUST ignore If-Modified-Since if the request contains an
169+ -- > If-None-Match header field; the condition in If-None-Match is
170+ -- > considered to be a more accurate replacement for the condition in
171+ -- > If-Modified-Since, and the two are only combined for the sake of
172+ -- > interoperating with older intermediaries that might not implement
173+ -- > If-None-Match.
150174 (Just hash, _) -> respond [("ETag", hash)]
151175
152176 -- No hash value available, fall back to last modified support.
@@ -221,7 +245,7 @@ staticAppPieces ss rawPieces req sendResponse = liftIO $ do
221245 response :: StaticResponse -> IO W.ResponseReceived
222246 response (FileResponse file ch) = do
223247 mimetype <- ssGetMimeType ss file
224− let filesize = fileGetSize file
248+ -- let filesize = fileGetSize file
225249 let headers = ("Content-Type", mimetype)
226250 -- Let Warp provide the content-length, since it takes
227251 -- range requests into account
@@ -240,18 +264,18 @@ staticAppPieces ss rawPieces req sendResponse = liftIO $ do
240264 ] lbs
241265
242266 response (Redirect pieces' mHash) = do
243− 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')
244268 let qString = case mHash of
245269 Just hash -> replace "etag" (Just hash) (W.queryString req)
246270 Nothing -> remove "etag" (W.queryString req)
247271
248− sendResponse $ W.responseLBS H.status301
272+ sendResponse $ W.responseLBS H.status302
249273 [ ("Content-Type", "text/plain")
250274 , ("Location", S8.append loc $ H.renderQuery True qString)
251275 ] "Redirect"
252276
253277 response (RawRedirect path) =
254− sendResponse $ W.responseLBS H.status301
278+ sendResponse $ W.responseLBS H.status302
255279 [ ("Content-Type", "text/plain")
256280 , ("Location", path)
257281 ] "Redirect"
wai-app-static/Util.hs+8−1
@@ -1,9 +1,10 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE OverloadedStrings, ViewPatterns #-}
22module Util
33 ( relativeDirFromPieces
44 , defaultMkRedirect
55 , replace
66 , remove
7+ , dropLastIfNull
78 ) where
89
910import WaiAppStatic.Types
@@ -36,3 +37,9 @@ defaultMkRedirect pieces newPath
3637 | otherwise = relDir `S8.append` S8.tail newPath
3738 where
3839 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.hs+8−1
@@ -25,6 +25,7 @@ import Network.Mime (defaultMimeMap, mimeByExt, defaultMimeType)
2525import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
2626import Data.Maybe (mapMaybe)
2727import Control.Arrow (second)
28+import Data.Monoid ((<>))
2829
2930data Args = Args
3031 { docroot :: FilePath
@@ -38,6 +39,7 @@ data Args = Args
3839 }
3940
4041#if MIN_VERSION_optparse_applicative(0, 10, 0)
42+option' :: Mod OptionFields Int -> Parser Int
4143option' = option auto
4244#else
4345option' = option
@@ -92,7 +94,7 @@ args = Args
9294-- Since 2.0.1
9395runCommandLine :: (Args -> Middleware) -> IO ()
9496runCommandLine middleware = do
95− args@Args {..} <- execParser $ info (helper <*> args) fullDesc
97+ args@Args {..} <- execParser $ info (helperOption <*> args) fullDesc
9698 let mime' = map (pack *** S8.pack) mime
9799 let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
98100 docroot' <- canonicalizePath docroot
@@ -109,3 +111,8 @@ runCommandLine middleware = do
109111 { ssIndices = if noindex then [] else mapMaybe (toPiece . pack) index
110112 , ssGetMimeType = return . mimeByExt mimeMap defaultMimeType . fromPiece . fileName
111113 }
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+2−2
@@ -22,7 +22,7 @@ import qualified Text.Blaze.Html.Renderer.Utf8 as HU
2222
2323-- | Provides a default directory listing, suitable for most apps.
2424--
25−-- 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>
2626defaultListing :: Listing
2727defaultListing pieces (Folder contents) = do
2828 let isTop = null pieces || map Just pieces == [toPiece ""]
@@ -64,7 +64,7 @@ defaultListing pieces (Folder contents) = do
6464
6565 -- Add a link to the root of the tree
6666 showFolder' :: Bool -> Pieces -> H.Html
67− showFolder' hasTrailingSlash pieces = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces)
67+ showFolder' hasTrailingSlash pieces' = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces')
6868
6969 showFolder :: Bool -> Pieces -> H.Html
7070 showFolder _ [] = "/" -- won't happen
wai-app-static/WaiAppStatic/Storage/Embedded/Runtime.hs+7−8
@@ -8,7 +8,7 @@ import WaiAppStatic.Types
88import Data.ByteString (ByteString)
99import Control.Arrow ((&&&), second)
1010import Data.List
11−import Blaze.ByteString.Builder (fromByteString)
11+import Data.ByteString.Builder (byteString)
1212import qualified Network.Wai as W
1313import qualified Data.Map as Map
1414import Data.Function (on)
@@ -16,8 +16,7 @@ import qualified Data.Text as T
1616import Data.Ord
1717import qualified Data.ByteString as S
1818import Crypto.Hash (hash, MD5, Digest)
19−import Data.Byteable (toBytes)
20−import qualified Data.ByteString.Base64 as B64
19+import Data.ByteArray.Encoding
2120import WaiAppStatic.Storage.Filesystem (defaultFileServerSettings)
2221import System.FilePath (isPathSeparator)
2322
@@ -50,8 +49,8 @@ embeddedLookup root pieces =
5049toEntry :: (Piece, EmbeddedEntry) -> Either FolderName File
5150toEntry (name, EEFolder{}) = Left name
5251toEntry (name, EEFile bs) = Right File
53− { fileGetSize = S.length bs
54− , fileToResponse = \s h -> W.responseBuilder s h $ fromByteString bs
52+ { fileGetSize = fromIntegral $ S.length bs
53+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
5554 , fileName = name
5655 , fileGetHash = return $ Just $ runHash bs
5756 , fileGetModified = Nothing
@@ -87,12 +86,12 @@ toEmbedded fps =
8786
8887bsToFile :: Piece -> ByteString -> File
8988bsToFile name bs = File
90− { fileGetSize = S.length bs
91− , fileToResponse = \s h -> W.responseBuilder s h $ fromByteString bs
89+ { fileGetSize = fromIntegral $ S.length bs
90+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
9291 , fileName = name
9392 , fileGetHash = return $ Just $ runHash bs
9493 , fileGetModified = Nothing
9594 }
9695
9796runHash :: ByteString -> ByteString
98−runHash = B64.encode . toBytes . (hash :: S.ByteString -> Digest MD5)
97+runHash = convertToBase Base64 . (hash :: S.ByteString -> Digest MD5)
wai-app-static/WaiAppStatic/Storage/Embedded/TH.hs+2−3
@@ -5,9 +5,8 @@ module WaiAppStatic.Storage.Embedded.TH(
55 , mkSettings
66) where
77
8−import Blaze.ByteString.Builder.ByteString (insertByteString)
8+import Data.ByteString.Builder.Extra (byteStringInsert)
99import Codec.Compression.GZip (compress)
10−import Control.Applicative
1110import Data.ByteString.Unsafe (unsafePackAddressLen)
1211import Data.Either (lefts, rights)
1312import GHC.Exts (Int(..))
@@ -130,7 +129,7 @@ embeddedToFile entry = File
130129 let h' = if embCompressed entry
131130 then h ++ [("Content-Encoding", "gzip")]
132131 else h
133− in W.responseBuilder s h' $ insertByteString $ embContent entry
132+ in W.responseBuilder s h' $ byteStringInsert $ embContent entry
134133
135134 -- Usually the fileName should just be the filename not the entire path,
136135 -- but we need the whole path to make the lookup within lookupMime
wai-app-static/WaiAppStatic/Storage/Filesystem.hs+9−7
@@ -1,5 +1,6 @@
11{-# LANGUAGE ScopedTypeVariables #-}
22{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
34-- | Access files on the filesystem.
45module WaiAppStatic.Storage.Filesystem
56 ( -- * Types
@@ -12,6 +13,7 @@ module WaiAppStatic.Storage.Filesystem
1213
1314import WaiAppStatic.Types
1415import System.FilePath ((</>))
16+import System.IO (withBinaryFile, IOMode(..))
1517import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
1618import Data.List (foldl')
1719import Control.Monad (forM)
@@ -23,10 +25,9 @@ import WaiAppStatic.Listing
2325import Network.Mime
2426import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
2527import Data.Maybe (catMaybes)
26−import qualified Crypto.Hash.Conduit (hashFile)
27−import Data.Byteable (toBytes)
28−import Crypto.Hash (MD5, Digest)
29−import qualified Data.ByteString.Base64 as B64
28+import Data.ByteArray.Encoding
29+import Crypto.Hash (hashlazy, MD5, Digest)
30+import qualified Data.ByteString.Lazy as BL (hGetContents)
3031import qualified Data.Text as T
3132
3233-- | Construct a new path from a root and some @Pieces@.
@@ -119,9 +120,10 @@ webAppLookup hashFunc prefix pieces =
119120-- | MD5 hash and base64-encode the file contents. Does not check if the file
120121-- exists.
121122hashFile :: FilePath -> IO ByteString
122−hashFile fp = do
123− h <- Crypto.Hash.Conduit.hashFile fp
124− return $ B64.encode $ toBytes (h :: Digest MD5)
123+hashFile fp = withBinaryFile fp ReadMode $ \h -> do
124+ f <- BL.hGetContents h
125+ let !hash = hashlazy f :: Digest MD5
126+ return $ convertToBase Base64 hash
125127
126128hashFileIfExists :: ETagLookup
127129hashFileIfExists fp = do
wai-app-static/WaiAppStatic/Types.hs+4−3
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
21module WaiAppStatic.Types
32 ( -- * Pieces
43 Piece
@@ -25,7 +24,7 @@ import qualified Network.Wai as W
2524import Data.ByteString (ByteString)
2625import System.Posix.Types (EpochTime)
2726import qualified Data.Text as T
28−import Blaze.ByteString.Builder (Builder)
27+import Data.ByteString.Builder (Builder)
2928import Network.Mime (MimeType)
3029
3130-- | An individual component of a path, or of a filepath.
@@ -60,6 +59,8 @@ toPieces :: [Text] -> Maybe Pieces
6059toPieces = mapM toPiece
6160
6261-- | Request coming from a user. Corresponds to @pathInfo@.
62+--
63+-- The root path is the empty list.
6364type Pieces = [Piece]
6465
6566-- | Values for the max-age component of the cache-control response header.
@@ -79,7 +80,7 @@ data Folder = Folder
7980-- | Information on an individual file.
8081data File = File
8182 { -- | Size of file in bytes
82− fileGetSize :: Int
83+ fileGetSize :: Integer
8384 -- | How to construct a WAI response for this file. Some files are stored
8485 -- on the filesystem and can use @ResponseFile@, while others are stored
8586 -- in memory and should use @ResponseBuilder@.
wai-app-static/test/EmbeddedTestEntries.hs+5
@@ -47,4 +47,9 @@ mkEntries = return
4747 , EmbeddableEntry "index.html"
4848 "text/html"
4949 (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") |] )
5055 ]
wai-app-static/test/WaiAppEmbeddedTest.hs+9
@@ -41,6 +41,15 @@ embSpec = do
4141 assertStatus 200 req
4242 assertBody "index file" req
4343
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+
4453 describe "embedded, uncompressed entry" $ do
4554 it "too short" $ embed $ do
4655 req <- request (setRawPathInfo defRequest "e2.txt")
wai-app-static/test/WaiAppStaticTest.hs+19−8
@@ -5,6 +5,7 @@ import Network.Wai.Application.Static
55import WaiAppStatic.Types
66
77import Test.Hspec
8+import Test.Mockery.Directory
89import qualified Data.ByteString.Char8 as S8
910-- import qualified Data.ByteString.Lazy.Char8 as L8
1011import System.PosixCompat.Files (getFileStatus, modificationTime)
@@ -56,22 +57,22 @@ spec = do
5657 assertStatus 200 =<<
5758 request (setRawPathInfo defRequest path)
5859
59− it "404 for non-existant files" $ webApp $
60+ it "404 for non-existent files" $ webApp $
6061 assertStatus 404 =<<
6162 request (setRawPathInfo defRequest "doesNotExist")
6263
63− it "301 redirect when multiple slashes" $ webApp $ do
64+ it "302 redirect when multiple slashes" $ webApp $ do
6465 req <- request (setRawPathInfo defRequest "a//b/c")
65− assertStatus 301 req
66+ assertStatus 302 req
6667 assertHeader "Location" "../../a/b/c" req
6768
6869 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
6970 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
7071 }
71− it "301 redirect when multiple slashes" $ absoluteApp $
72+ it "302 redirect when multiple slashes" $ absoluteApp $
7273 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
7374 req <- request (setRawPathInfo defRequest path)
74− assertStatus 301 req
75+ assertStatus 302 req
7576 assertHeader "Location" "http://www.example.com/a/b/c" req
7677
7778 describe "webApp when requesting a static asset" $ do
@@ -130,12 +131,22 @@ spec = do
130131 assertStatus 304 req
131132 assertNoHeader "Cache-Control" req
132133
133− context "301 redirect to add a trailing slash on directories if missing" $ do
134+ context "302 redirect to add a trailing slash on directories if missing" $ do
134135 it "works at the root" $ fileServerApp $ do
135136 req <- request (setRawPathInfo defRequest "/a")
136− assertStatus 301 req
137+ assertStatus 302 req
137138 assertHeader "Location" "/a/" req
138139
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+
139150 let urlMapApp = flip runSession $ \req send ->
140151 case pathInfo req of
141152 "subPath":rest ->
@@ -147,7 +158,7 @@ spec = do
147158 "urlMapApp: only works at subPath"
148159 it "works with subpath at the root of the file server" $ urlMapApp $ do
149160 req <- request (setRawPathInfo defRequest "/subPath")
150− assertStatus 301 req
161+ assertStatus 302 req
151162 assertHeader "Location" "/subPath/" req
152163
153164 context "with defaultWebAppSettings" $ do
wai-app-static/wai-app-static.cabal+9−12
@@ -1,5 +1,5 @@
11name: wai-app-static
2−version: 3.1.3
2+version: 3.1.7.1
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
@@ -26,8 +26,8 @@ Flag print
2626
2727library
2828 build-depends: base >= 4 && < 5
29− , wai >= 3.0 && < 3.1
30− , bytestring >= 0.9.1.4
29+ , wai >= 3.0 && < 3.3
30+ , bytestring >= 0.10.4
3131 , http-types >= 0.7
3232 , transformers >= 0.2.2
3333 , unix-compat >= 0.2
@@ -37,10 +37,8 @@ library
3737 , old-locale >= 1.0.0.2
3838 , file-embed >= 0.0.3.1
3939 , text >= 0.7
40− , blaze-builder >= 0.2.1.4
41− , base64-bytestring >= 0.1
42− , byteable
43− , cryptohash >= 0.11
40+ , cryptonite >= 0.6
41+ , memory >= 0.7
4442 , http-date
4543 , blaze-html >= 0.5
4644 , blaze-markup >= 0.5.1
@@ -51,9 +49,7 @@ library
5149 , filepath
5250 , wai-extra >= 3.0 && < 3.1
5351 , optparse-applicative >= 0.7
54− , warp >= 3.0.11 && < 3.2
55− -- Used exclusively for hashFile function
56− , cryptohash-conduit
52+ , warp >= 3.0.11 && < 3.4
5753
5854 exposed-modules: Network.Wai.Application.Static
5955 WaiAppStatic.Storage.Filesystem
@@ -77,7 +73,7 @@ Executable warp
7773 , wai-app-static
7874 , directory >= 1.0
7975 , containers >= 0.2
80− , bytestring >= 0.9.1.4
76+ , bytestring >= 0.10.4
8177 , text >= 0.7
8278 , mime-types >= 0.1 && < 0.2
8379
@@ -104,8 +100,9 @@ test-suite runtests
104100 , zlib
105101 , filepath
106102 , temporary
103+ , mockery
107104 -- , containers
108− ghc-options: -Wall
105+ ghc-options: -Wall
109106
110107source-repository head
111108 type: git
wai-conduit/ChangeLog.md+7−1
@@ -1 +1,7 @@
1−No changes logged yet.
1+## 3.0.0.4
2+
3+* Drop dependency on blaze-builder
4+
5+## 3.0.0.3
6+
7+* Support wai 3.2
wai-conduit/Network/Wai/Conduit.hs+6−7
@@ -16,18 +16,17 @@ import Data.ByteString (ByteString)
1616import qualified Data.ByteString as S
1717import Control.Monad (unless)
1818import Network.HTTP.Types
19−import Blaze.ByteString.Builder (Builder)
20−import Data.IORef
19+import Data.ByteString.Builder (Builder)
2120import qualified Data.Conduit.List as CL
2221
2322-- | Stream the request body.
2423--
2524-- Since 3.0.0
26−sourceRequestBody :: MonadIO m => Request -> Source m ByteString
25+sourceRequestBody :: MonadIO m => Request -> ConduitT () ByteString m ()
2726sourceRequestBody req =
2827 loop
2928 where
30− go = liftIO (requestBody req)
29+ go = liftIO (getRequestBodyChunk req)
3130
3231 loop = do
3332 bs <- go
@@ -38,9 +37,9 @@ sourceRequestBody req =
3837-- | Create an HTTP response out of a @Source@.
3938--
4039-- Since 3.0.0
41−responseSource :: Status -> ResponseHeaders -> Source IO (Flush Builder) -> Response
40+responseSource :: Status -> ResponseHeaders -> ConduitT () (Flush Builder) IO () -> Response
4241responseSource s hs src = responseStream s hs $ \send flush ->
43− src $$ CL.mapM_ (\mbuilder ->
42+ runConduit $ src .| CL.mapM_ (\mbuilder ->
4443 case mbuilder of
4544 Chunk b -> send b
4645 Flush -> flush)
@@ -50,7 +49,7 @@ responseSource s hs src = responseStream s hs $ \send flush ->
5049--
5150-- Since 3.0.0
5251responseRawSource :: (MonadIO m, MonadIO n)
53− => (Source m ByteString -> Sink ByteString n () -> IO ())
52+ => (ConduitT () ByteString m () -> ConduitT ByteString Void n () -> IO ())
5453 -> Response
5554 -> Response
5655responseRawSource app =
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.cabal+3−4
@@ -1,5 +1,5 @@
11name: wai-conduit
2−version: 3.0.0.2
2+version: 3.0.0.4
33synopsis: conduit wrappers for WAI
44description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
55homepage: https://github.com/yesodweb/wai
@@ -15,10 +15,9 @@ extra-source-files: README.md ChangeLog.md
1515library
1616 exposed-modules: Network.Wai.Conduit
1717 build-depends: base >= 4 && < 5
18− , wai >= 3.0 && < 3.1
18+ , wai >= 3.0 && < 3.3
1919 , conduit
2020 , transformers
21− , bytestring
21+ , bytestring >= 0.10.4
2222 , http-types
23− , blaze-builder
2423 default-language: Haskell2010
wai-extra/ChangeLog.md+140
@@ -1,3 +1,143 @@
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+
1141## 3.0.13
2142
3143* Autoflush handle [#466](https://github.com/yesodweb/wai/pull/466)
wai-extra/Network/Wai/EventSource.hs+24−1
@@ -1,10 +1,18 @@
11{-|
22 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.
310-}
411module Network.Wai.EventSource (
512 ServerEvent(..),
613 eventSourceAppChan,
7− eventSourceAppIO
14+ eventSourceAppIO,
15+ eventStreamAppRaw
816 ) where
917
1018import Data.Function (fix)
@@ -34,3 +42,18 @@ eventSourceAppIO src _ sendResponse =
3442 case eventToBuilder se of
3543 Nothing -> return ()
3644 Just b -> sendChunk b >> flush >> loop
45+
46+-- | Make a new WAI EventSource application with a handler that emits events.
47+--
48+-- @since 3.0.28
49+eventStreamAppRaw :: ((ServerEvent -> IO()) -> IO () -> IO ()) -> Application
50+eventStreamAppRaw handler _ sendResponse =
51+ sendResponse $ responseStream
52+ status200
53+ [(hContentType, "text/event-stream")]
54+ $ \sendChunk flush -> handler (sendEvent sendChunk) flush
55+ where
56+ sendEvent sendChunk event =
57+ case eventToBuilder event of
58+ Nothing -> return ()
59+ Just b -> sendChunk b
wai-extra/Network/Wai/EventSource/EventStream.hs+9−10
@@ -1,5 +1,5 @@
11{-# 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 -}
33
44{-|
55 Internal module, usually you don't need to use it.
@@ -9,8 +9,7 @@ module Network.Wai.EventSource.EventStream (
99 eventToBuilder
1010 ) where
1111
12−import Blaze.ByteString.Builder
13−import Blaze.ByteString.Builder.Char8
12+import Data.ByteString.Builder
1413#if __GLASGOW_HASKELL__ < 710
1514import Data.Monoid
1615#endif
@@ -39,18 +38,18 @@ data ServerEvent
3938 Newline as a Builder.
4039-}
4140nl :: Builder
42−nl = fromChar '\n'
41+nl = char7 '\n'
4342
4443
4544{-|
4645 Field names as Builder
4746-}
4847nameField, idField, dataField, retryField, commentField :: Builder
49−nameField = fromString "event:"
50−idField = fromString "id:"
51−dataField = fromString "data:"
52−retryField = fromString "retry:"
53−commentField = fromChar ':'
48+nameField = string7 "event:"
49+idField = string7 "id:"
50+dataField = string7 "data:"
51+retryField = string7 "retry:"
52+commentField = char7 ':'
5453
5554
5655{-|
@@ -66,7 +65,7 @@ field l b = l `mappend` b `mappend` nl
6665-}
6766eventToBuilder :: ServerEvent -> Maybe Builder
6867eventToBuilder (CommentEvent txt) = Just $ field commentField txt
69−eventToBuilder (RetryEvent n) = Just $ field retryField (fromShow n)
68+eventToBuilder (RetryEvent n) = Just $ field retryField (string8 . show $ n)
7069eventToBuilder (CloseEvent) = Nothing
7170eventToBuilder (ServerEvent n i d)= Just $
7271 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
wai-extra/Network/Wai/Handler/CGI.hs+21−16
@@ -19,8 +19,8 @@ import Control.Arrow ((***))
1919import Data.Char (toLower)
2020import qualified System.IO
2121import qualified Data.String as String
22−import Blaze.ByteString.Builder (fromByteString, toLazyByteString, flush)
23−import Blaze.ByteString.Builder.Char8 (fromChar, fromString)
22+import Data.ByteString.Builder (byteString, toLazyByteString, char7, string8)
23+import Data.ByteString.Builder.Extra (flush)
2424import Data.ByteString.Lazy.Internal (defaultChunkSize)
2525import System.IO (Handle)
2626import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
@@ -29,7 +29,8 @@ import qualified Data.CaseInsensitive as CI
2929#if __GLASGOW_HASKELL__ < 710
3030import Data.Monoid (mconcat, mempty, mappend)
3131#endif
32−import qualified Data.Streaming.Blaze as Blaze
32+
33+import qualified Data.Streaming.ByteString.Builder as Builder
3334import Data.Function (fix)
3435import Control.Monad (unless, void)
3536
@@ -118,6 +119,10 @@ runGeneric vars inputH outputH xsendfile app = do
118119 , requestBodyLength = KnownLength $ fromIntegral contentLength
119120 , requestHeaderHost = lookup "host" reqHeaders
120121 , requestHeaderRange = lookup hRange reqHeaders
122+#if MIN_VERSION_wai(3,2,0)
123+ , requestHeaderReferer = lookup "referer" reqHeaders
124+ , requestHeaderUserAgent = lookup "user-agent" reqHeaders
125+#endif
121126 }
122127 void $ app env $ \res ->
123128 case (xsendfile, res) of
@@ -126,7 +131,7 @@ runGeneric vars inputH outputH xsendfile app = do
126131 return ResponseReceived
127132 _ -> do
128133 let (s, hs, wb) = responseToStream res
129− (blazeRecv, blazeFinish) <- Blaze.newBlazeRecv Blaze.defaultStrategy
134+ (blazeRecv, blazeFinish) <- Builder.newBuilderRecv Builder.defaultStrategy
130135 wb $ \b -> do
131136 let sendBuilder builder = do
132137 popper <- blazeRecv builder
@@ -135,30 +140,30 @@ runGeneric vars inputH outputH xsendfile app = do
135140 unless (B.null bs) $ do
136141 outputH bs
137142 loop
138− sendBuilder $ headers s hs `mappend` fromChar '\n'
143+ sendBuilder $ headers s hs `mappend` char7 '\n'
139144 b sendBuilder (sendBuilder flush)
140145 blazeFinish >>= maybe (return ()) outputH
141146 return ResponseReceived
142147 where
143148 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
144− status (Status i m) = (fromByteString "Status", mconcat
145− [ fromString $ show i
146− , fromChar ' '
147− , fromByteString m
149+ status (Status i m) = (byteString "Status", mconcat
150+ [ string8 $ show i
151+ , char7 ' '
152+ , byteString m
148153 ])
149− header' (x, y) = (fromByteString $ CI.original x, fromByteString y)
154+ header' (x, y) = (byteString $ CI.original x, byteString y)
150155 header (x, y) = mconcat
151156 [ x
152− , fromByteString ": "
157+ , byteString ": "
153158 , y
154− , fromChar '\n'
159+ , char7 '\n'
155160 ]
156161 sfBuilder s hs sf fp = mconcat
157162 [ headers s hs
158− , header $ (fromByteString sf, fromString fp)
159− , fromChar '\n'
160− , fromByteString sf
161− , fromByteString " not supported"
163+ , header $ (byteString sf, string8 fp)
164+ , char7 '\n'
165+ , byteString sf
166+ , byteString " not supported"
162167 ]
163168 fixHeaders h =
164169 case lookup hContentType h of
wai-extra/Network/Wai/Handler/SCGI.hs+12−1
@@ -1,4 +1,4 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
22module Network.Wai.Handler.SCGI
33 ( run
44 , runSendfile
@@ -86,6 +86,16 @@ readByteString socket len = do
8686foreign import ccall unsafe "accept"
8787 c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
8888
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
8999foreign import ccall unsafe "close"
90100 c'close :: CInt -> IO CInt
91101
@@ -94,3 +104,4 @@ foreign import ccall unsafe "write"
94104
95105foreign import ccall unsafe "read"
96106 c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
107+#endif
wai-extra/Network/Wai/Header.hs+1−1
@@ -14,5 +14,5 @@ contentLength hdrs = lookup H.hContentLength hdrs >>= readInt
1414readInt :: S8.ByteString -> Maybe Integer
1515readInt bs =
1616 case S8.readInteger bs of
17− Just (i, "") -> Just i
17+ Just (i, rest) | S8.null rest -> Just i
1818 _ -> Nothing
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.hs+2−8
@@ -17,9 +17,6 @@ import Data.Monoid (mempty)
1717import Data.Monoid ((<>))
1818import Network.HTTP.Types (hLocation, methodGet, status301, status307)
1919
20−import qualified Data.ByteString as S
21−import Data.Word8 (_colon)
22−
2320-- | For requests that don't appear secure, redirect to https
2421--
2522-- Since 3.0.7
@@ -31,13 +28,10 @@ forceSSL app req sendResponse =
3128
3229redirectResponse :: Request -> Maybe Response
3330redirectResponse req = do
34− (host, _) <- S.break (== _colon) <$> requestHeaderHost req
35−
36− return $ responseBuilder status [(hLocation, location host)] mempty
37−
31+ host <- requestHeaderHost req
32+ return $ responseBuilder status [(hLocation, location host)] mempty
3833 where
3934 location h = "https://" <> h <> rawPathInfo req <> rawQueryString req
40−
4135 status
4236 | requestMethod req == methodGet = status301
4337 | otherwise = status307
wai-extra/Network/Wai/Middleware/Gzip.hs+42−15
@@ -30,14 +30,14 @@ import Data.Default.Class
3030import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
3131 , hContentType, hContentLength)
3232import System.Directory (doesFileExist, createDirectoryIfMissing)
33−import Blaze.ByteString.Builder (fromByteString)
33+import Data.ByteString.Builder (byteString)
34+import qualified Data.ByteString.Builder.Extra as Blaze (flush)
3435import Control.Exception (try, SomeException)
3536import qualified Data.Set as Set
3637import Network.Wai.Header
3738import Network.Wai.Internal
38−import qualified Data.Streaming.Blaze as B
39+import qualified Data.Streaming.ByteString.Builder as B
3940import qualified Data.Streaming.Zlib as Z
40−import qualified Blaze.ByteString.Builder as Blaze
4141import Control.Monad (unless)
4242import Data.Function (fix)
4343import Control.Exception (throwIO)
@@ -50,12 +50,27 @@ data GzipSettings = GzipSettings
5050 , gzipCheckMime :: S.ByteString -> Bool
5151 }
5252
53−data GzipFiles = GzipIgnore | GzipCompress | GzipCacheFolder FilePath
53+-- | Gzip behavior for files.
54+data GzipFiles
55+ = GzipIgnore -- ^ Do not compress file responses.
56+ | GzipCompress -- ^ Compress files. Note that this may counteract
57+ -- zero-copy response optimizations on some
58+ -- platforms.
59+ | GzipCacheFolder FilePath -- ^ Compress files, caching them in
60+ -- some directory.
61+ | GzipPreCompressed GzipFiles -- ^ If we use compression then try to use the filename with ".gz"
62+ -- appended to it, if the file is missing then try next action
63+ --
64+ -- @since 3.0.17
5465 deriving (Show, Eq, Read)
5566
67+-- | Use default MIME settings; /do not/ compress files.
5668instance Default GzipSettings where
5769 def = GzipSettings GzipIgnore defaultCheckMime
5870
71+-- | MIME types that will be compressed by default:
72+-- @text/@ @*@, @application/json@, @application/javascript@,
73+-- @application/ecmascript@, @image/x-icon@.
5974defaultCheckMime :: S.ByteString -> Bool
6075defaultCheckMime bs =
6176 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
@@ -65,6 +80,7 @@ defaultCheckMime bs =
6580 [ "application/json"
6681 , "application/javascript"
6782 , "application/ecmascript"
83+ , "image/x-icon"
6884 ]
6985
7086-- | Use gzip to compress the body of the response.
@@ -72,9 +88,10 @@ defaultCheckMime bs =
7288-- Analyzes the \"Accept-Encoding\" header from the client to determine
7389-- if gzip is supported.
7490--
75−-- Possible future enhancements:
91+-- File responses will be compressed according to the 'GzipFiles' setting.
7692--
77−-- * 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'.
7895gzip :: GzipSettings -> Middleware
7996gzip set app env sendResponse = app env $ \res ->
8097 case res of
@@ -82,13 +99,23 @@ gzip set app env sendResponse = app env $ \res ->
8299 ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
83100 _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
84101 then
85− case (res, gzipFiles set) of
86− (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
87− case lookup hContentType hs of
88− Just m
89− | gzipCheckMime set m -> compressFile s hs file cache sendResponse
90− _ -> sendResponse res
91− _ -> compressE set res sendResponse
102+ let runAction x = case x of
103+ (ResponseFile s hs file Nothing, GzipPreCompressed nextAction) ->
104+ let
105+ compressedVersion = file ++ ".gz"
106+ in
107+ doesFileExist compressedVersion >>= \y ->
108+ if y
109+ then (sendResponse $ ResponseFile s (fixHeaders hs) compressedVersion Nothing)
110+ else (runAction (ResponseFile s hs file Nothing, nextAction))
111+ (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
112+ case lookup hContentType hs of
113+ Just m
114+ | gzipCheckMime set m -> compressFile s hs file cache sendResponse
115+ _ -> sendResponse res
116+ (ResponseFile {}, GzipIgnore) -> sendResponse res
117+ _ -> compressE set res sendResponse
118+ in runAction (res, gzipFiles set)
92119 else sendResponse res
93120 where
94121 enc = fromMaybe [] $ (splitCommas . S8.unpack)
@@ -158,7 +185,7 @@ compressE set res sendResponse =
158185 Just m | gzipCheckMime set m ->
159186 let hs' = fixHeaders hs
160187 in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
161− (blazeRecv, _) <- B.newBlazeRecv B.defaultStrategy
188+ (blazeRecv, _) <- B.newBuilderRecv B.defaultStrategy
162189 deflate <- Z.initDeflate 1 (Z.WindowBits 31)
163190 let sendBuilder builder = do
164191 popper <- blazeRecv builder
@@ -177,7 +204,7 @@ compressE set res sendResponse =
177204 case result of
178205 Z.PRDone -> return ()
179206 Z.PRNext bs' -> do
180− sendChunk $ fromByteString bs'
207+ sendChunk $ byteString bs'
181208 loop
182209 Z.PRError e -> throwIO e
183210
wai-extra/Network/Wai/Middleware/HttpAuth.hs+18−10
@@ -5,6 +5,7 @@
55module Network.Wai.Middleware.HttpAuth
66 ( -- * Middleware
77 basicAuth
8+ , basicAuth'
89 , CheckCreds
910 , AuthSettings
1011 , authRealm
@@ -36,11 +37,19 @@ type CheckCreds = ByteString
3637--
3738-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
3839--
39−-- Since 1.3.4
40+-- @since 1.3.4
4041basicAuth :: CheckCreds
4142 -> AuthSettings
4243 -> Middleware
43−basicAuth checkCreds AuthSettings {..} app req sendResponse = 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
4453 isProtected <- authIsProtected req
4554 allowed <- if isProtected then check else return True
4655 if allowed
@@ -51,8 +60,7 @@ basicAuth checkCreds AuthSettings {..} app req sendResponse = do
5160 case (lookup hAuthorization $ requestHeaders req)
5261 >>= extractBasicAuth of
5362 Nothing -> return False
54− Just (username, password) -> checkCreds username password
55−
63+ Just (username, password) -> checkCreds req username password
5664
5765-- | Basic authentication settings. This value is an instance of
5866-- @IsString@, so the recommended approach to create a value is to
@@ -61,23 +69,23 @@ basicAuth checkCreds AuthSettings {..} app req sendResponse = do
6169--
6270-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
6371--
64−-- Since 1.3.4
72+-- @since 1.3.4
6573data AuthSettings = AuthSettings
6674 { authRealm :: !ByteString
6775 -- ^
6876 --
69− -- Since 1.3.4
77+ -- @since 1.3.4
7078 , authOnNoAuth :: !(ByteString -> Application)
7179 -- ^ Takes the realm and returns an appropriate 401 response when
7280 -- authentication is not provided.
7381 --
74− -- Since 1.3.4
82+ -- @since 1.3.4
7583 , authIsProtected :: !(Request -> IO Bool)
7684 -- ^ Determine if access to the requested resource is restricted.
7785 --
7886 -- Default: always returns @True@.
7987 --
80− -- Since 1.3.4
88+ -- @since 1.3.4
8189 }
8290
8391instance IsString AuthSettings where
@@ -99,7 +107,7 @@ instance IsString AuthSettings where
99107-- | Extract basic authentication data from usually __Authorization__
100108-- header value. Returns username and password
101109--
102−-- Since 3.0.5
110+-- @since 3.0.5
103111extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
104112extractBasicAuth bs =
105113 let (x, y) = S.break isSpace bs
@@ -115,7 +123,7 @@ extractBasicAuth bs =
115123-- | Extract bearer authentication data from __Authorization__ header
116124-- value. Returns bearer token
117125--
118−-- Since 3.0.5
126+-- @since 3.0.5
119127extractBearerAuth :: ByteString -> Maybe ByteString
120128extractBearerAuth bs =
121129 let (x, y) = S.break isSpace bs
wai-extra/Network/Wai/Middleware/Jsonp.hs+7−7
@@ -18,8 +18,8 @@ import Network.Wai
1818import Network.Wai.Internal
1919import Data.ByteString (ByteString)
2020import qualified Data.ByteString.Char8 as B8
21−import Blaze.ByteString.Builder (copyByteString)
22−import Blaze.ByteString.Builder.Char8 (fromChar)
21+import Data.ByteString.Builder.Extra (byteStringCopy)
22+import Data.ByteString.Builder (char7)
2323#if __GLASGOW_HASKELL__ < 710
2424import Data.Monoid (mappend)
2525#endif
@@ -60,10 +60,10 @@ jsonp app env sendResponse = do
6060 sendResponse $ case checkJSON hs of
6161 Nothing -> r
6262 Just hs' -> responseBuilder s hs' $
63− copyByteString c
64− `mappend` fromChar '('
63+ byteStringCopy c
64+ `mappend` char7 '('
6565 `mappend` b
66− `mappend` fromChar ')'
66+ `mappend` char7 ')'
6767 go c r =
6868 case checkJSON hs of
6969 Just hs' -> addCallback c s hs' wb
@@ -81,9 +81,9 @@ jsonp app env sendResponse = do
8181
8282 addCallback cb s hs wb =
8383 wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
84− sendChunk $ copyByteString cb `mappend` fromChar '('
84+ sendChunk $ byteStringCopy cb `mappend` char7 '('
8585 _ <- body sendChunk flush
86− sendChunk $ fromChar ')'
86+ sendChunk $ char7 ')'
8787
8888changeVal :: Eq a
8989 => a
wai-extra/Network/Wai/Middleware/MethodOverride.hs+4−5
@@ -5,12 +5,11 @@ module Network.Wai.Middleware.MethodOverride
55import Network.Wai
66import Control.Monad (join)
77
8−-- | Allows overriding of the HTTP request method via the _method query string
9−-- parameter.
8+-- | Overriding of HTTP request method via `_method` query string parameter.
109--
11−-- This middleware only applies when the initial request method is POST. This
12−-- allow submitting of normal HTML forms, without worries of semantics
13−-- mismatches in the HTTP spec.
10+-- This middleware only applies when the initial request method is POST.
11+-- Allows submitting of normal HTML forms, without worries of semantic
12+-- mismatches with the HTTP spec.
1413methodOverride :: Middleware
1514methodOverride app req =
1615 app req'
wai-extra/Network/Wai/Middleware/RequestLogger.hs+72−21
@@ -14,15 +14,16 @@ module Network.Wai.Middleware.RequestLogger
1414 , OutputFormat (..)
1515 , OutputFormatter
1616 , OutputFormatterWithDetails
17+ , OutputFormatterWithDetailsAndHeaders
1718 , Destination (..)
1819 , Callback
1920 , IPAddrSource (..)
2021 ) where
2122
2223import System.IO (Handle, hFlush, stdout)
23−import qualified Blaze.ByteString.Builder as B
24+import qualified Data.ByteString.Builder as B (Builder, byteString)
2425import qualified Data.ByteString as BS
25−import Data.ByteString.Char8 (pack, unpack)
26+import Data.ByteString.Char8 (pack)
2627import Control.Monad (when)
2728import Control.Monad.IO.Class (liftIO)
2829import Network.Wai
@@ -40,7 +41,7 @@ import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File
4041import qualified Data.ByteString.Lazy as LBS
4142import qualified Data.ByteString.Char8 as S8
4243import System.Console.ANSI
43−import Data.IORef.Lifted
44+import Data.IORef
4445import System.IO.Unsafe
4546import Network.Wai.Internal (Response (..))
4647import Data.Default.Class (Default (def))
@@ -49,14 +50,42 @@ import Network.Wai.Middleware.RequestLogger.Internal
4950import Network.Wai.Header (contentLength)
5051import Data.Text.Encoding (decodeUtf8')
5152
52−data OutputFormat = Apache IPAddrSource
53− | Detailed Bool -- ^ use colors?
54− | CustomOutputFormat OutputFormatter
55− | CustomOutputFormatWithDetails OutputFormatterWithDetails
53+data OutputFormat
54+ = Apache IPAddrSource
55+ | Detailed Bool -- ^ use colors?
56+ | CustomOutputFormat OutputFormatter
57+ | CustomOutputFormatWithDetails OutputFormatterWithDetails
58+ | CustomOutputFormatWithDetailsAndHeaders OutputFormatterWithDetailsAndHeaders
5659
5760type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> LogStr
58−type OutputFormatterWithDetails =
59− ZonedDate -> Request -> Status -> Maybe Integer -> NominalDiffTime -> [S8.ByteString] -> B.Builder -> 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
6089
6190data Destination = Handle Handle
6291 | Logger LoggerSet
@@ -95,20 +124,22 @@ mkRequestLogger RequestLoggerSettings{..} = do
95124 Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
96125 Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
97126 Callback c -> (c, return ())
127+ callbackAndFlush str = callback str >> flusher
98128 case outputFormat of
99129 Apache ipsrc -> do
100130 getdate <- getDateGetter flusher
101131 apache <- initLogger ipsrc (LogCallback callback flusher) getdate
102132 return $ apacheMiddleware apache
103− Detailed useColors -> detailedMiddleware
104− (\str -> callback str >> flusher)
105− useColors
133+ Detailed useColors -> detailedMiddleware callbackAndFlush useColors
106134 CustomOutputFormat formatter -> do
107135 getDate <- getDateGetter flusher
108− return $ customMiddleware callback getDate formatter
136+ return $ customMiddleware callbackAndFlush getDate formatter
109137 CustomOutputFormatWithDetails formatter -> do
110138 getdate <- getDateGetter flusher
111− return $ customMiddlewareWithDetails callback getdate formatter
139+ return $ customMiddlewareWithDetails callbackAndFlush getdate formatter
140+ CustomOutputFormatWithDetailsAndHeaders formatter -> do
141+ getdate <- getDateGetter flusher
142+ return $ customMiddlewareWithDetailsAndHeaders callbackAndFlush getdate formatter
112143
113144apacheMiddleware :: ApacheLoggerActions -> Middleware
114145apacheMiddleware ala app req sendResponse = app req $ \res -> do
@@ -119,8 +150,8 @@ apacheMiddleware ala app req sendResponse = app req $ \res -> do
119150customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
120151customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
121152 date <- liftIO getdate
122− -- We use Nothing for the response size since we generally don't know it
123− liftIO $ cb $ formatter date req (responseStatus res) Nothing
153+ let msize = contentLength (responseHeaders res)
154+ liftIO $ cb $ formatter date req (responseStatus res) msize
124155 sendResponse res
125156
126157customMiddlewareWithDetails :: Callback -> IO ZonedDate -> OutputFormatterWithDetails -> Middleware
@@ -130,24 +161,44 @@ customMiddlewareWithDetails cb getdate formatter app req sendResponse = do
130161 app req' $ \res -> do
131162 t1 <- getCurrentTime
132163 date <- liftIO getdate
133− -- We use Nothing for the response size since we generally don't know it
134− builderIO <- newIORef $ B.fromByteString ""
164+ let msize = contentLength (responseHeaders res)
165+ builderIO <- newIORef $ B.byteString ""
135166 res' <- recordChunks builderIO res
136167 rspRcv <- sendResponse res'
137168 _ <- liftIO . cb .
138− formatter date req' (responseStatus res') Nothing (t1 `diffUTCTime` t0) reqBody =<<
169+ formatter date req' (responseStatus res') msize (t1 `diffUTCTime` t0) reqBody =<<
139170 readIORef builderIO
140171 return rspRcv
141172
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
142191-- | Production request logger middleware.
192+--
193+-- This uses the 'Apache' logging format, and takes IP addresses for clients from
194+-- the socket (see 'IPAddrSource' for more information). It logs to 'stdout'.
143195{-# NOINLINE logStdout #-}
144196logStdout :: Middleware
145197logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
146198
147199-- | Development request logger middleware.
148200--
149−-- Flushes 'stdout' on each request, which would be inefficient in production use.
150−-- Use "logStdout" in production.
201+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
151202{-# NOINLINE logStdoutDev #-}
152203logStdoutDev :: Middleware
153204logStdoutDev = unsafePerformIO $ mkRequestLogger def
wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hs+48−10
@@ -1,8 +1,13 @@
11{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE CPP #-}
23
3−module Network.Wai.Middleware.RequestLogger.JSON (formatAsJSON) where
4+module Network.Wai.Middleware.RequestLogger.JSON
5+ ( formatAsJSON
6+ , formatAsJSONWithHeaders
7+ ) where
48
5−import qualified Blaze.ByteString.Builder as BB
9+import qualified Data.ByteString.Builder as BB (toLazyByteString)
10+import Data.ByteString.Lazy (toStrict)
611import Data.Aeson
712import Data.CaseInsensitive (original)
813import Data.Monoid ((<>))
@@ -10,7 +15,8 @@ import qualified Data.ByteString.Char8 as S8
1015import Data.IP
1116import qualified Data.Text as T
1217import Data.Text (Text)
13−import Data.Text.Encoding (decodeUtf8)
18+import Data.Text.Encoding (decodeUtf8With)
19+import Data.Text.Encoding.Error (lenientDecode)
1420import Data.Time (NominalDiffTime)
1521import Data.Word (Word32)
1622import Network.HTTP.Types as H
@@ -31,10 +37,34 @@ formatAsJSON date req status responseSize duration reqBody response =
3137 , "size" .= responseSize
3238 , "body" .=
3339 if statusCode status >= 400
34− then Just . decodeUtf8 . BB.toByteString $ response
40+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ response
3541 else Nothing
3642 ]
37− , "time" .= decodeUtf8 date
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
3868 ]) <> "\n"
3969
4070word32ToHostAddress :: Word32 -> Text
@@ -46,12 +76,12 @@ readAsDouble = read
4676requestToJSON :: NominalDiffTime -> Request -> [S8.ByteString] -> Value
4777requestToJSON duration req reqBody =
4878 object
49− [ "method" .= decodeUtf8 (requestMethod req)
50− , "path" .= decodeUtf8 (rawPathInfo req)
79+ [ "method" .= decodeUtf8With lenientDecode (requestMethod req)
80+ , "path" .= decodeUtf8With lenientDecode (rawPathInfo req)
5181 , "queryString" .= map queryItemToJSON (queryString req)
5282 , "durationMs" .= (readAsDouble . printf "%.2f" . rationalToDouble $ toRational duration * 1000)
5383 , "size" .= requestBodyLengthToJSON (requestBodyLength req)
54− , "body" .= decodeUtf8 (S8.concat reqBody)
84+ , "body" .= decodeUtf8With lenientDecode (S8.concat reqBody)
5585 , "remoteHost" .= sockToJSON (remoteHost req)
5686 , "httpVersion" .= httpVersionToJSON (httpVersion req)
5787 , "headers" .= requestHeadersToJSON (requestHeaders req)
@@ -73,11 +103,13 @@ sockToJSON (SockAddrInet6 pn _ ha _) =
73103 ]
74104sockToJSON (SockAddrUnix sock) =
75105 object [ "unix" .= sock ]
106+#if !MIN_VERSION_network(3,0,0)
76107sockToJSON (SockAddrCan i) =
77108 object [ "can" .= i ]
109+#endif
78110
79111queryItemToJSON :: QueryItem -> Value
80−queryItemToJSON (name, mValue) = toJSON (decodeUtf8 name, fmap decodeUtf8 mValue)
112+queryItemToJSON (name, mValue) = toJSON (decodeUtf8With lenientDecode name, fmap (decodeUtf8With lenientDecode) mValue)
81113
82114requestHeadersToJSON :: RequestHeaders -> Value
83115requestHeadersToJSON = toJSON . map hToJ where
@@ -85,8 +117,14 @@ requestHeadersToJSON = toJSON . map hToJ where
85117 hToJ ("Cookie", _) = toJSON ("Cookie" :: Text, "-RDCT-" :: Text)
86118 hToJ hd = headerToJSON hd
87119
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+
88126headerToJSON :: Header -> Value
89−headerToJSON (headerName, header) = toJSON (decodeUtf8 . original $ headerName, decodeUtf8 header)
127+headerToJSON (headerName, header) = toJSON (decodeUtf8With lenientDecode . original $ headerName, decodeUtf8With lenientDecode header)
90128
91129portToJSON :: PortNumber -> Value
92130portToJSON = toJSON . toInteger
wai-extra/Network/Wai/Middleware/Rewrite.hs+321−14
@@ -1,32 +1,339 @@
1+{-# LANGUAGE TupleSections #-}
2+{-# LANGUAGE CPP #-}
3+
14module Network.Wai.Middleware.Rewrite
2− ( rewrite, rewritePure
5+ ( -- * How to use this module
6+ -- $howto
7+
8+ -- ** A note on semantics
9+
10+ -- $semantics
11+
12+ -- ** Paths and Queries
13+
14+ -- $pathsandqueries
15+ PathsAndQueries
16+
17+ -- ** An example rewriting paths with queries
18+
19+ -- $takeover
20+
21+ -- ** Upgrading from wai-extra ≤ 3.0.16.1
22+
23+ -- $upgrading
24+
25+ -- * 'Middleware'
26+
27+ -- ** Recommended functions
28+ , rewriteWithQueries
29+ , rewritePureWithQueries
30+ , rewriteRoot
31+
32+ -- ** Deprecated
33+ , rewrite
34+ , rewritePure
35+
36+ -- * Operating on 'Request's
37+
38+ , rewriteRequest
39+ , rewriteRequestPure
340 ) where
441
542import Network.Wai
643import Control.Monad.IO.Class (liftIO)
744import Data.Text (Text)
45+import Data.Functor.Identity (Identity(..))
846import qualified Data.Text.Encoding as TE
947import qualified Data.Text as T
1048import Network.HTTP.Types as H
1149
50+-- GHC ≤ 7.10 does not export Applicative functions from the prelude.
51+#if __GLASGOW_HASKELL__ <= 710
52+import Control.Applicative
53+#endif
1254
13−-- | rewrite based on your own conversion rules
14−rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
15−rewrite convert app req sendResponse = do
16− newPathInfo <- liftIO $ convert (pathInfo req) (requestHeaders req)
17− let rawPInfo = TE.encodeUtf8 $ T.intercalate "/" newPathInfo
18− app req { pathInfo = newPathInfo, rawPathInfo = rawPInfo } sendResponse
55+-- $howto
56+-- This module provides 'Middleware' to rewrite URL paths. It also provides
57+-- functions that will convert a 'Request' to a modified 'Request'.
58+-- Both operations require a function that takes URL parameters and
59+-- headers, and returns new URL parameters. Parameters are pieces of URL
60+-- paths and query parameters.
61+--
62+-- If you are a new user of the library, use 'rewriteWithQueries' or
63+-- 'rewritePureWithQueries' for middleware. For modifying 'Request's
64+-- directly, use 'rewriteRequest' or 'rewriteRequestPure'.
65+
66+-- $semantics
67+--
68+-- Versions of this library in wai-extra ≤ 3.0.16.1 exported only
69+-- 'rewrite' and 'rewritePure' and both modified 'rawPathInfo' of the
70+-- underlying requests. Such modification has been proscribed. The
71+-- semantics of these functions have not changed; instead the recommended
72+-- approach is to use 'rewriteWithQueries' and 'rewritePureWithQueries'.
73+-- The new functions are slightly different, as described in the section
74+-- on upgrading; code for previous library versions can be upgraded with
75+-- a single change, and as the type of the new function is different the
76+-- compiler will indicate where this change must be made.
77+--
78+-- The 'rewriteRequest' and 'rewriteRequestPure' functions use the new
79+-- semantics, too.
1980
20−-- | rewrite based on your own conversion rules
21−-- Example convert function:
81+-- $pathsandqueries
82+--
83+-- This library defines the type synonym `PathsAndQueries` to make code
84+-- handling paths and queries easier to read.
85+--
86+-- /e.g./ /\/foo\/bar/ would look like
87+--
88+-- > ["foo", "bar"] :: Text
89+--
90+-- /?bar=baz/ would look like
91+--
92+-- > [("bar", Just "baz")] :: QueryText
93+--
94+-- Together,
95+--
96+-- /\/foo?bar=baz/ would look like
97+--
98+-- > (["foo"],[("bar", Just "baz")]) :: PathsAndQueries
2299
23−-- staticConvert :: [Text] -> H.RequestHeaders -> [Text]
24−-- staticConvert pieces _ = piecesConvert pieces
100+-- $takeover
101+-- Let’s say we want to replace a website written in PHP with one written
102+-- using WAI. We’ll use the
103+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
104+-- package to serve the old
105+-- site from the new site, but there’s a problem. The old site uses pages like
106+--
107+-- @
108+-- index.php?page=/page/
109+-- @
110+--
111+-- whereas the new site would look like
112+--
113+-- @
114+-- index\//page/
115+-- @
116+--
117+-- In doing this, we want to separate the migration code from our new
118+-- website. So we’d like to handle links internally using the path
119+-- formulation, but externally have the old links still work.
120+--
121+-- Therefore, we will use middleware ('rewritePureWithQueries') from this
122+-- module to rewrite incoming requests from the query formulation to the
123+-- paths formulation.
124+--
125+-- > {-# LANGUAGE ViewPatterns #-}
126+-- >
127+-- > rewritePathFromPhp :: Middleware
128+-- > rewritePathFromPhp = rewritePureWithQueries pathFromPhp
129+-- >
130+-- > pathFromPhp :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
131+-- > pathFromPhp (pieces, queries) _ = piecesConvert pieces queries
132+-- > where
133+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
134+-- > piecesConvert ["index.php"] qs@(join . lookup "page" -> Just page) =
135+-- > ( ["index", TE.decodeUtf8With TE.lenientDecode page]
136+-- > , delete ("page", pure page) qs
137+-- > )
138+-- > piecesConvert ps qs = (ps, qs)
139+--
140+-- On the other side, we will use 'rewriteRequestPure' to rewrite outgoing
141+-- requests to the original website from the reverse proxy code (using the
142+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequest' or
143+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequestSecure' constructors. Note,
144+-- these links will only work if the haddock documentation for
145+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
146+-- is installed).
147+--
148+-- > rewritePhpFromPath :: Request -> Request
149+-- > rewritePhpFromPath = rewriteRequestPure phpFromPath
150+-- >
151+-- > phpFromPath :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
152+-- > phpFromPath (pieces, queries) _ = piecesConvert pieces queries
153+-- > where
154+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
155+-- > piecesConvert ["index", page] qs = ( ["index.php"], ("page", pure . TE.encodeUtf8 $ page) : qs )
156+-- > piecesConvert ps qs = (ps, qs)
157+--
158+-- For the whole example, see
159+-- <https://gist.github.com/dbaynard/c844d0df124f68ec8b6da152c581ce6d>.
160+
161+-- $upgrading
162+-- It is quite simple to upgrade from 'rewrite' and 'rewritePure', to
163+-- 'rewriteWithQueries' and 'rewritePureWithQueries'.
164+-- Insert 'Data.Bifunctor.first', which specialises to
165+--
166+-- @
167+-- 'Data.Bifunctor.first' :: (['Text'] -> ['Text']) -> 'PathsAndQueries' -> 'PathsAndQueries'
168+-- @
169+--
170+-- as the following example demonstrates.
171+--
172+-- Old versions of the library could only handle path pieces, not queries.
173+-- This could have been supplied to 'rewritePure'.
174+--
175+-- @
176+-- staticConvert' :: [Text] -> H.RequestHeaders -> [Text]
177+-- staticConvert' pieces _ = piecesConvert pieces
178+-- where
179+-- piecesConvert [] = ["static", "html", "pages.html"]
180+-- piecesConvert route@("pages":_) = "static":"html":route
181+-- @
182+--
183+-- Instead, use this function, supplied to 'rewritePureWithQueries'.
184+--
185+-- @
186+-- staticConvert :: 'PathsAndQueries' -> H.RequestHeaders -> 'PathsAndQueries'
187+-- staticConvert pathsAndQueries _ = 'Data.Bifunctor.first' piecesConvert pathsAndQueries
25188-- where
26189-- piecesConvert [] = ["static", "html", "pages.html"]
27190-- 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.
28241rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
29242rewritePure convert app req =
30− let pInfo = convert (pathInfo req) (requestHeaders req)
31− rawPInfo = TE.encodeUtf8 $ T.intercalate "/" pInfo
32− in app req { pathInfo = pInfo, rawPathInfo = rawPInfo }
243+ let convertPure = pathsOnly . curry $ Identity . uncurry convert
244+ newReq = runIdentity $ rewriteRequestRawM convertPure req
245+ in app newReq
246+{-# WARNING rewritePure [
247+ "This modifies the 'rawPathInfo' field of a 'Request'."
248+ , " This is not recommended behaviour; it is however how"
249+ , " this function has worked in the past."
250+ , " Use 'rewritePureWithQueries' instead"] #-}
251+
252+-- | Rewrite based on your own conversion function for paths and queries.
253+-- This function is to be supplied by users of this library, and operates
254+-- in 'IO'.
255+rewriteWithQueries :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
256+ -> Middleware
257+rewriteWithQueries convert app req sendResponse = do
258+ newReq <- rewriteRequestM convert req
259+ app newReq sendResponse
260+
261+-- | Rewrite based on pure conversion function for paths and queries. This
262+-- function is to be supplied by users of this library.
263+rewritePureWithQueries :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
264+ -> Middleware
265+rewritePureWithQueries convert app req = app $ rewriteRequestPure convert req
266+
267+-- | Rewrite root requests (/) to a specified path
268+--
269+-- Note that /index.html/ in example below should already be a valid route.
270+--
271+-- @
272+-- rewriteRoot "index.html" :: Middleware
273+-- @
274+--
275+-- @since 3.0.23.0
276+rewriteRoot :: Text -> Middleware
277+rewriteRoot root = rewritePureWithQueries onlyRoot
278+ where
279+ onlyRoot ([], q) _ = ([root], q)
280+ onlyRoot paths _ = paths
281+
282+--------------------------------------------------
283+-- * Modifying 'Request's directly
284+--------------------------------------------------
285+
286+-- | Modify a 'Request' using the supplied function in 'IO'. This is suitable for
287+-- the reverse proxy example.
288+rewriteRequest :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
289+ -> Request -> IO Request
290+rewriteRequest convert req =
291+ let convertIO = curry $ liftIO . uncurry convert
292+ in rewriteRequestRawM convertIO req
293+
294+-- | Modify a 'Request' using the pure supplied function. This is suitable for
295+-- the reverse proxy example.
296+rewriteRequestPure :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
297+ -> Request -> Request
298+rewriteRequestPure convert req =
299+ let convertPure = curry $ Identity . uncurry convert
300+ in runIdentity $ rewriteRequestRawM convertPure req
301+
302+--------------------------------------------------
303+-- * Helper functions
304+--------------------------------------------------
305+
306+-- | This helper function factors out the common behaviour of rewriting requests.
307+rewriteRequestM :: (Applicative m, Monad m)
308+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
309+ -> Request -> m Request
310+rewriteRequestM convert req = do
311+ (pInfo, qByteStrings) <- curry convert (pathInfo req) (queryString req) (requestHeaders req)
312+ pure req {pathInfo = pInfo, queryString = qByteStrings}
313+
314+-- | This helper function preserves the semantics of wai-extra ≤ 3.0, in
315+-- which the rewrite functions modify the 'rawPathInfo' parameter. Note
316+-- that this has not been extended to modify the 'rawQueryInfo' as
317+-- modifying either of these values has been deprecated.
318+rewriteRequestRawM :: (Applicative m, Monad m)
319+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
320+ -> Request -> m Request
321+rewriteRequestRawM convert req = do
322+ newReq <- rewriteRequestM convert req
323+ let rawPInfo = TE.encodeUtf8 . T.intercalate "/" . pathInfo $ newReq
324+ pure newReq { rawPathInfo = rawPInfo }
325+{-# WARNING rewriteRequestRawM [
326+ "This modifies the 'rawPathInfo' field of a 'Request'."
327+ , " This is not recommended behaviour; it is however how"
328+ , " this function has worked in the past."
329+ , " Use 'rewriteRequestM' instead"] #-}
330+
331+-- | Produce a function that works on 'PathsAndQueries' from one working
332+-- only on paths. This is not exported, as it is only needed to handle
333+-- code written for versions ≤ 3.0 of the library; see the
334+-- example above using 'Data.Bifunctor.first' to do something similar.
335+pathsOnly :: (Applicative m, Monad m)
336+ => ([Text] -> H.RequestHeaders -> m [Text])
337+ -> PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries
338+pathsOnly convert psAndQs headers = (,[]) <$> convert (fst psAndQs) headers
339+{-# INLINE pathsOnly #-}
wai-extra/Network/Wai/Middleware/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/Parse.hs+366−84
@@ -11,6 +11,7 @@ module Network.Wai.Parse
1111 , RequestBodyType (..)
1212 , getRequestBodyType
1313 , sinkRequestBody
14+ , sinkRequestBodyEx
1415 , BackEnd
1516 , lbsBackEnd
1617 , tempFileBackEnd
@@ -19,6 +20,24 @@ module Network.Wai.Parse
1920 , File
2021 , FileInfo (..)
2122 , 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
2241#if TEST
2342 , Bound (..)
2443 , findBound
@@ -29,22 +48,30 @@ module Network.Wai.Parse
2948#endif
3049 ) where
3150
32−import qualified Data.ByteString.Search as Search
51+import qualified Control.Exception as E
3352import qualified Data.ByteString as S
3453import qualified Data.ByteString.Lazy as L
3554import qualified Data.ByteString.Char8 as S8
3655import Data.Word (Word8)
37−import Data.Maybe (fromMaybe)
56+import Data.Int (Int64)
57+import Data.Maybe (catMaybes, fromMaybe)
3858import Data.List (sortBy)
3959import Data.Function (on, fix)
4060import System.Directory (removeFile, getTemporaryDirectory)
4161import System.IO (hClose, openBinaryTempFile)
62+import System.IO.Error (isDoesNotExistError)
4263import Network.Wai
4364import qualified Network.HTTP.Types as H
44−import Control.Monad (when, unless)
65+import Control.Applicative ((<$>))
66+import Control.Exception (catchJust)
67+import Control.Monad (when, unless, guard)
4568import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
4669import Data.IORef
4770import Network.HTTP.Types (hContentType)
71+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
72+import Data.CaseInsensitive (mk)
73+
74+import Prelude hiding (lines)
4875
4976breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
5077breakDiscard w s =
@@ -94,7 +121,7 @@ lbsBackEnd _ _ popper =
94121tempFileBackEnd :: InternalState -> ignored1 -> ignored2 -> IO S.ByteString -> IO FilePath
95122tempFileBackEnd = tempFileBackEndOpts getTemporaryDirectory "webenc.buf"
96123
97−-- | Same as 'tempFileSink', but use configurable temp folders and patterns.
124+-- | Same as 'tempFileBackEnd', but use configurable temp folders and patterns.
98125tempFileBackEndOpts :: IO FilePath -- ^ get temporary directory
99126 -> String -- ^ filename pattern
100127 -> InternalState
@@ -102,11 +129,9 @@ tempFileBackEndOpts :: IO FilePath -- ^ get temporary directory
102129 -> ignored2
103130 -> IO S.ByteString
104131 -> IO FilePath
105−tempFileBackEndOpts getTmpDir pattern internalState _ _ popper = do
106− (key, (fp, h)) <- flip runInternalState internalState $ allocate (do
107− tempDir <- getTmpDir
108− openBinaryTempFile tempDir pattern) (\(_, h) -> hClose h)
109− _ <- runInternalState (register $ removeFile fp) internalState
132+tempFileBackEndOpts getTmpDir pattrn internalState _ _ popper = do
133+ (key, (fp, h)) <- flip runInternalState internalState $ allocate it (hClose . snd)
134+ _ <- runInternalState (register $ removeFileQuiet fp) internalState
110135 fix $ \loop -> do
111136 bs <- popper
112137 unless (S.null bs) $ do
@@ -114,6 +139,150 @@ tempFileBackEndOpts getTmpDir pattern internalState _ _ popper = do
114139 loop
115140 release key
116141 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 }
117286
118287-- | Information on an uploaded file.
119288data FileInfo c = FileInfo
@@ -136,8 +305,16 @@ type BackEnd a = S.ByteString -- ^ parameter name
136305 -> IO S.ByteString
137306 -> IO a
138307
139−data RequestBodyType = UrlEncoded | Multipart S.ByteString
308+-- | The mimetype of the http body.
309+-- Depending on whether just parameters or parameters and files
310+-- are passed, one or the other mimetype should be used.
311+data RequestBodyType
312+ = -- | application/x-www-form-urlencoded (parameters only)
313+ UrlEncoded
314+ | -- | multipart/form-data (parameters and files)
315+ Multipart S.ByteString
140316
317+-- | Get the mimetype of the body of an http request.
141318getRequestBodyType :: Request -> Maybe RequestBodyType
142319getRequestBodyType req = do
143320 ctype' <- lookup hContentType $ requestHeaders req
@@ -150,7 +327,7 @@ getRequestBodyType req = do
150327-- | Parse a content type value, turning a single @ByteString@ into the actual
151328-- content type and a list of pairs of attributes.
152329--
153−-- Since 1.3.2
330+-- @since 1.3.2
154331parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
155332parseContentType a = do
156333 let (ctype, b) = S.break (== semicolon) a
@@ -160,6 +337,9 @@ parseContentType a = do
160337 semicolon = 59
161338 equals = 61
162339 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
163343 goAttrs front bs
164344 | S.null bs = front []
165345 | otherwise =
@@ -168,79 +348,140 @@ parseContentType a = do
168348 goAttr bs =
169349 let (k, v') = S.break (== equals) bs
170350 v = S.drop 1 v'
171− in (strip k, strip v)
351+ in (strip k, dq $ strip v)
172352 strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
173353
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.
174360parseRequestBody :: BackEnd y
175361 -> Request
176362 -> IO ([Param], [File y])
177−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 =
178376 case getRequestBodyType r of
179377 Nothing -> return ([], [])
180− Just rbt -> sinkRequestBody s rbt (requestBody r)
378+ Just rbt -> sinkRequestBodyEx o s rbt (requestBody r)
181379
182380sinkRequestBody :: BackEnd y
183381 -> RequestBodyType
184382 -> IO S.ByteString
185383 -> IO ([Param], [File y])
186−sinkRequestBody s r body = do
187− ref <- newIORef (id, id)
384+sinkRequestBody = sinkRequestBodyEx noLimitParseRequestBodyOptions
385+
386+-- |
387+--
388+-- @since 3.0.16.0
389+sinkRequestBodyEx :: ParseRequestBodyOptions
390+ -> BackEnd y
391+ -> RequestBodyType
392+ -> IO S.ByteString
393+ -> IO ([Param], [File y])
394+sinkRequestBodyEx o s r body = do
395+ ref <- newIORef ([], [])
188396 let add x = atomicModifyIORef ref $ \(y, z) ->
189397 case x of
190− Left y' -> ((y . (y':), z), ())
191− Right z' -> ((y, z . (z':)), ())
192− conduitRequestBody s r body add
193− (x, y) <- readIORef ref
194− return (x [], y [])
195−
196−conduitRequestBody :: BackEnd y
197− -> RequestBodyType
198− -> IO S.ByteString
199− -> (Either Param (File y) -> IO ())
200− -> IO ()
201−conduitRequestBody _ UrlEncoded rbody add = do
398+ Left y' -> ((y':y, z), ())
399+ Right z' -> ((y, z':z), ())
400+ conduitRequestBodyEx o s r body add
401+ (\(a, b) -> (reverse a, reverse b)) <$> readIORef ref
402+
403+conduitRequestBodyEx :: ParseRequestBodyOptions
404+ -> BackEnd y
405+ -> RequestBodyType
406+ -> IO S.ByteString
407+ -> (Either Param (File y) -> IO ())
408+ -> IO ()
409+conduitRequestBodyEx o _ UrlEncoded rbody add = do
202410 -- NOTE: in general, url-encoded data will be in a single chunk.
203411 -- Therefore, I'm optimizing for the usual case by sticking with
204412 -- strict byte strings here.
205− let loop front = do
413+ let loop size front = do
206414 bs <- rbody
207415 if S.null bs
208416 then return $ S.concat $ front []
209− else loop $ front . (bs:)
210− bs <- loop id
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
211425 mapM_ (add . Left) $ H.parseSimpleQuery bs
212−conduitRequestBody backend (Multipart bound) rbody add =
213− parsePieces backend (S8.pack "--" `S.append` bound) rbody add
426+conduitRequestBodyEx o backend (Multipart bound) rbody add =
427+ parsePiecesEx o backend (S8.pack "--" `S.append` bound) rbody add
428+
214429
215−takeLine :: Source -> IO (Maybe S.ByteString)
216−takeLine src =
217− go id
430+-- | Take one header or subheader line.
431+-- Since: 3.0.26
432+-- Throw 431 if headers too large.
433+takeLine :: Maybe Int -> Source -> IO (Maybe S.ByteString)
434+takeLine maxlen src =
435+ go ""
218436 where
219437 go front = do
220438 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 ()
221444 if S.null bs
222445 then close front
223446 else push front bs
224447
225− close front = leftover src (front S.empty) >> return Nothing
448+ close front = leftover src front >> return Nothing
226449 push front bs = do
227− let (x, y) = S.break (== 10) $ front bs -- LF
450+ let (x, y) = S.break (== 10) bs -- LF
228451 in if S.null y
229− then go $ S.append x
452+ then go $ front `S.append` x
230453 else do
231454 when (S.length y > 1) $ leftover src $ S.drop 1 y
232− return $ Just $ killCR x
233−
234−takeLines :: Source -> IO [S.ByteString]
235−takeLines src = do
236− res <- takeLine src
455+ let res = front `S.append` x
456+ case maxlen of
457+ Just maxlen' -> when (S.length res > maxlen') $
458+ E.throwIO $ ConnectionError (UnknownErrorCode 431)
459+ "Request Header Fields Too Large"
460+ Nothing -> return ()
461+ return $ Just $ killCR $ res
462+
463+takeLines' :: Maybe Int -> Maybe Int -> Source -> IO [S.ByteString]
464+takeLines' lineLength maxLines source =
465+ reverse <$> takeLines'' [] lineLength maxLines source
466+
467+takeLines''
468+ :: [S.ByteString]
469+ -> Maybe Int
470+ -> Maybe Int
471+ -> Source
472+ -> IO [S.ByteString]
473+takeLines'' lines lineLength maxLines src = do
474+ case maxLines of
475+ Just maxLines' ->
476+ when (length lines > maxLines') $
477+ error "Too many lines in mime/multipart header"
478+ Nothing -> return ()
479+ res <- takeLine lineLength src
237480 case res of
238− Nothing -> return []
481+ Nothing -> return lines
239482 Just l
240− | S.null l -> return []
241− | otherwise -> do
242− ls <- takeLines src
243− return $ l : ls
483+ | S.null l -> return lines
484+ | otherwise -> takeLines'' (l:lines) lineLength maxLines src
244485
245486data Source = Source (IO S.ByteString) (IORef S.ByteString)
246487
@@ -259,17 +500,20 @@ readSource (Source f ref) = do
259500leftover :: Source -> S.ByteString -> IO ()
260501leftover (Source _ ref) bs = writeIORef ref bs
261502
262−parsePieces :: BackEnd y
263− -> S.ByteString
264− -> IO S.ByteString
265− -> (Either Param (File y) -> IO ())
266− -> IO ()
267−parsePieces sink bound rbody add =
268− mkSource rbody >>= loop
503+parsePiecesEx :: ParseRequestBodyOptions
504+ -> BackEnd y
505+ -> S.ByteString
506+ -> IO S.ByteString
507+ -> (Either Param (File y) -> IO ())
508+ -> IO ()
509+parsePiecesEx o sink bound rbody add =
510+ mkSource rbody >>= loop 0 0 0 0
269511 where
270− loop src = do
271− _boundLine <- takeLine src
272− res' <- takeLines src
512+ loop :: Int -> Int -> Int -> Int64 -> Source -> IO ()
513+ loop numParms numFiles parmSize filesSize src = do
514+ _boundLine <- takeLine (prboMaxHeaderLineLength o) src
515+ res' <- takeLines' (prboMaxHeaderLineLength o)
516+ (prboMaxHeaderLines o) src
273517 unless (null res') $ do
274518 let ls' = map parsePair res'
275519 let x = do
@@ -280,31 +524,57 @@ parsePieces sink bound rbody add =
280524 return (ct, name, lookup "filename" attrs)
281525 case x of
282526 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 ()
283536 let ct = fromMaybe "application/octet-stream" mct
284537 fi0 = FileInfo filename ct ()
285− (wasFound, y) <- sinkTillBound' bound name fi0 sink src
538+ fs = catMaybes [ prboMaxFileSize o
539+ , subtract filesSize <$> prboMaxFilesSize o ]
540+ mfs = if fs == [] then Nothing else Just $ minimum fs
541+ ((wasFound, fileSize), y) <- sinkTillBound' bound name fi0 sink src mfs
542+ let newFilesSize = filesSize + fileSize
286543 add $ Right (name, fi0 { fileContent = y })
287− when wasFound (loop src)
544+ when wasFound $ loop numParms (numFiles + 1) parmSize newFilesSize src
288545 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 ()
289551 let seed = id
290552 let iter front bs = return $ front . (:) bs
291− (wasFound, front) <- sinkTillBound bound iter seed src
553+ ((wasFound, _fileSize), front) <- sinkTillBound bound iter seed src
554+ (fromIntegral <$> prboMaxParmsSize o)
292555 let bs = S.concat $ front []
293556 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 ()
294562 add $ Left x'
295− when wasFound (loop src)
563+ when wasFound $ loop (numParms + 1) numFiles
564+ newParmSize filesSize src
296565 _ -> do
297566 -- ignore this part
298567 let seed = ()
299568 iter () _ = return ()
300− (wasFound, ()) <- sinkTillBound bound iter seed src
301− when wasFound (loop src)
569+ ((wasFound, _fileSize), ()) <- sinkTillBound bound iter seed src Nothing
570+ when wasFound $ loop numParms numFiles parmSize filesSize src
302571 where
303− contDisp = S8.pack "Content-Disposition"
304− contType = S8.pack "Content-Type"
572+ contDisp = mk $ S8.pack "Content-Disposition"
573+ contType = mk $ S8.pack "Content-Type"
305574 parsePair s =
306575 let (x, y) = breakDiscard 58 s -- colon
307− in (x, S.dropWhile (== 32) y) -- space
576+ in (mk $ x, S.dropWhile (== 32) y) -- space
577+
308578
309579data Bound = FoundBound S.ByteString S.ByteString
310580 | NoBound
@@ -312,7 +582,7 @@ data Bound = FoundBound S.ByteString S.ByteString
312582 deriving (Eq, Show)
313583
314584findBound :: S.ByteString -> S.ByteString -> Bound
315−findBound b bs = handleBreak $ Search.breakOn b bs
585+findBound b bs = handleBreak $ S.breakSubstring b bs
316586 where
317587 handleBreak (h, t)
318588 | S.null t = go [lowBound..S.length bs - 1]
@@ -339,9 +609,10 @@ sinkTillBound' :: S.ByteString
339609 -> FileInfo ()
340610 -> BackEnd y
341611 -> Source
342− -> IO (Bool, y)
343−sinkTillBound' bound name fi sink src = do
344− (next, final) <- wrapTillBound bound src
612+ -> Maybe Int64
613+ -> IO ((Bool, Int64), y)
614+sinkTillBound' bound name fi sink src max' = do
615+ (next, final) <- wrapTillBound bound src max'
345616 y <- sink name fi next
346617 b <- final
347618 return (b, y)
@@ -350,30 +621,40 @@ data WTB = WTBWorking (S.ByteString -> S.ByteString)
350621 | WTBDone Bool
351622wrapTillBound :: S.ByteString -- ^ bound
352623 -> Source
353− -> IO (IO S.ByteString, IO Bool) -- ^ Bool indicates if the bound was found
354−wrapTillBound bound src = do
624+ -> Maybe Int64
625+ -> IO (IO S.ByteString, IO (Bool, Int64)) -- ^ Bool indicates if the bound was found
626+wrapTillBound bound src max' = do
355627 ref <- newIORef $ WTBWorking id
356− return (go ref, final ref)
628+ sref <- newIORef (0 :: Int64)
629+ return (go ref sref, final ref sref)
357630 where
358− final ref = do
631+ final ref sref = do
359632 x <- readIORef ref
360633 case x of
361634 WTBWorking _ -> error "wrapTillBound did not finish"
362− WTBDone y -> return y
635+ WTBDone y -> do
636+ siz <- readIORef sref
637+ return (y, siz)
363638
364− go ref = do
639+ go ref sref = do
365640 state <- readIORef ref
366641 case state of
367642 WTBDone _ -> return S.empty
368643 WTBWorking front -> do
369644 bs <- readSource src
645+ cur <- atomicModifyIORef' sref $ \ cur ->
646+ let new = cur + fromIntegral (S.length bs) in (new, new)
647+ case max' of
648+ Just max'' | cur > max'' ->
649+ E.throwIO $ ConnectionError (UnknownErrorCode 413) "Payload Too Large"
650+ _ -> return ()
370651 if S.null bs
371652 then do
372653 writeIORef ref $ WTBDone False
373654 return $ front bs
374655 else push $ front bs
375656 where
376− push bs =
657+ push bs = do
377658 case findBound bound bs of
378659 FoundBound before after -> do
379660 let before' = killCRLF before
@@ -389,19 +670,20 @@ wrapTillBound bound src = do
389670 else (bs, id)
390671 writeIORef ref $ WTBWorking front'
391672 if S.null toEmit
392− then go ref
673+ then go ref sref
393674 else return toEmit
394675 PartialBound -> do
395676 writeIORef ref $ WTBWorking $ S.append bs
396− go ref
677+ go ref sref
397678
398679sinkTillBound :: S.ByteString
399680 -> (x -> S.ByteString -> IO x)
400681 -> x
401682 -> Source
402− -> IO (Bool, x)
403−sinkTillBound bound iter seed0 src = do
404− (next, final) <- wrapTillBound bound src
683+ -> Maybe Int64
684+ -> IO ((Bool, Int64), x)
685+sinkTillBound bound iter seed0 src max' = do
686+ (next, final) <- wrapTillBound bound src max'
405687 let loop seed = do
406688 bs <- next
407689 if S.null bs
wai-extra/Network/Wai/Request.hs+53−3
@@ -1,17 +1,25 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
12-- | Some helpers for interrogating a WAI 'Request'.
23
34module Network.Wai.Request
45 ( appearsSecure
56 , guessApproot
7+ , RequestSizeException(..)
8+ , requestSizeCheck
69 ) where
710
811import Data.ByteString (ByteString)
912import Data.Maybe (fromMaybe)
1013import Network.HTTP.Types (HeaderName)
11−import Network.Wai (Request, isSecure, requestHeaders, requestHeaderHost)
14+import Network.Wai
1215
1316import qualified Data.ByteString as S
1417import 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+
1523
1624-- | Does this request appear to have been made over an SSL connection?
1725--
@@ -24,7 +32,7 @@ import qualified Data.ByteString.Char8 as C
2432-- force a non-SSL request to SSL by redirect. One can safely choose not to
2533-- redirect when the request /appears/ secure, even if it's actually not.
2634--
27−-- Since 3.0.7
35+-- @since 3.0.7
2836appearsSecure :: Request -> Bool
2937appearsSecure request = isSecure request || any (uncurry matchHeader)
3038 [ ("HTTPS" , (== "on"))
@@ -44,8 +52,50 @@ appearsSecure request = isSecure request || any (uncurry matchHeader)
4452-- application. For more information and relevant caveats, please see
4553-- "Network.Wai.Middleware.Approot".
4654--
47−-- Since 3.0.7
55+-- @since 3.0.7
4856guessApproot :: Request -> ByteString
4957guessApproot req =
5058 (if appearsSecure req then "https://" else "http://") `S.append`
5159 (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.hs+28−35
@@ -39,21 +39,20 @@ import Data.Monoid (mempty, mappend)
3939
4040import Network.Wai
4141import Network.Wai.Internal (ResponseReceived (ResponseReceived))
42+import Network.Wai.Test.Internal
4243import Control.Monad.IO.Class (liftIO)
4344import Control.Monad.Trans.Class (lift)
4445import qualified Control.Monad.Trans.State as ST
45−import Control.Monad.Trans.Reader (ReaderT, runReaderT, ask)
46+import Control.Monad.Trans.Reader (runReaderT, ask)
4647import Control.Monad (unless)
4748import Control.DeepSeq (deepseq)
4849import Control.Exception (throwIO, Exception)
4950import Data.Typeable (Typeable)
50−import Data.Map (Map)
5151import qualified Data.Map as Map
5252import qualified Web.Cookie as Cookie
5353import Data.ByteString (ByteString)
5454import qualified Data.ByteString.Char8 as S8
55−import Blaze.ByteString.Builder (toLazyByteString, toByteString)
56−import qualified Blaze.ByteString.Builder as B
55+import Data.ByteString.Builder (toLazyByteString)
5756import qualified Data.ByteString.Lazy as L
5857import qualified Data.ByteString.Lazy.Char8 as L8
5958import qualified Network.HTTP.Types as H
@@ -64,17 +63,6 @@ import qualified Data.Text.Encoding as TE
6463import Data.IORef
6564import Data.Time.Clock (getCurrentTime)
6665
67−type Session = ReaderT Application (ST.StateT ClientState IO)
68−
69−-- |
70−--
71−-- Since 3.0.6
72−type ClientCookies = Map ByteString Cookie.SetCookie
73−
74−data ClientState = ClientState
75− { clientCookies :: ClientCookies
76− }
77−
7866-- |
7967--
8068-- Since 3.0.6
@@ -104,15 +92,17 @@ deleteClientCookie cookieName =
10492 modifyClientCookies
10593 (Map.delete cookieName)
10694
107−initState :: ClientState
108−initState = ClientState Map.empty
109−
95+-- | See also: 'runSessionWith'.
11096runSession :: Session a -> Application -> IO a
11197runSession session app = ST.evalStateT (runReaderT session app) initState
11298
11399data SRequest = SRequest
114100 { simpleRequest :: Request
115101 , 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'.
116106 }
117107data SResponse = SResponse
118108 { simpleStatus :: H.Status
@@ -120,14 +110,22 @@ data SResponse = SResponse
120110 , simpleBody :: L.ByteString
121111 }
122112 deriving (Show, Eq)
113+
123114request :: Request -> Session SResponse
124−request = srequest . flip SRequest L.empty
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
125123
126124-- | Set whole path (request path + query string).
127125setPath :: Request -> S8.ByteString -> Request
128126setPath req path = req {
129127 pathInfo = segments
130− , rawPathInfo = B.toByteString (H.encodePathSegments segments)
128+ , rawPathInfo = (L8.toStrict . toLazyByteString) (H.encodePathSegments segments)
131129 , queryString = query
132130 , rawQueryString = (H.renderQuery True query)
133131 }
@@ -156,7 +154,7 @@ addCookiesToRequest req = do
156154 let cookiePairs = [ (Cookie.setCookieName c, Cookie.setCookieValue c)
157155 | c <- map snd $ Map.toList cookiesForRequest
158156 ]
159− let cookieValue = toByteString $ Cookie.renderCookies cookiePairs
157+ let cookieValue = L8.toStrict . toLazyByteString $ Cookie.renderCookies cookiePairs
160158 addCookieHeader rest
161159 | null cookiePairs = rest
162160 | otherwise = ("Cookie", cookieValue) : rest
@@ -180,22 +178,18 @@ extractSetCookieFromSResponse response = do
180178 (Map.fromList [(Cookie.setCookieName c, c) | c <- newClientCookies ]))
181179 return response
182180
181+-- | Similar to 'request', but allows setting the request body as a plain
182+-- 'L.ByteString'.
183183srequest :: SRequest -> Session SResponse
184184srequest (SRequest req bod) = do
185− app <- ask
186185 refChunks <- liftIO $ newIORef $ L.toChunks bod
187− let req' = req
188− { requestBody = atomicModifyIORef refChunks $ \bss ->
189− case bss of
190− [] -> ([], S.empty)
191− x:y -> (y, x)
192− }
193− req'' <- addCookiesToRequest req'
194− response <- liftIO $ do
195− ref <- newIORef $ error "runResponse gave no result"
196− ResponseReceived <- app req'' (runResponse ref)
197− readIORef ref
198− extractSetCookieFromSResponse response
186+ request $
187+ req
188+ { requestBody = atomicModifyIORef refChunks $ \bss ->
189+ case bss of
190+ [] -> ([], S.empty)
191+ x:y -> (y, x)
192+ }
199193
200194runResponse :: IORef SResponse -> Response -> IO ResponseReceived
201195runResponse ref res = do
@@ -337,4 +331,3 @@ assertClientCookieValue s cookieName cookieValue = do
337331 ]
338332 )
339333 (Cookie.setCookieValue c == cookieValue)
340−
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/README.md+14−1
@@ -1,3 +1,16 @@
1−## wai-extra
1+# wai-extra
22
33The 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/app/Main.hsdeleted−55
@@ -1,55 +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 (status200)
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 status200 [("Content-Type", "text/html")] "static/index.html" Nothing
22− ["esold"] -> eventSourceAppChan 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 (C.ResourceT IO) ServerEvent
43−eventSource = forever $ do
44− time <- liftIO $ do
45− threadDelay 1000000
46− getPOSIXTime
47− C.yield $ ServerEvent (Just $ fromString "source")
48− Nothing
49− [fromString . show $ time]
50−
51−main = do
52− chan <- newChan
53− _ <- forkIO . eventChan $ chan
54− run 8080 (gzip def $ app chan)
55−
wai-extra/example/Main.hsnew file+62
@@ -0,0 +1,62 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Main where
3+
4+import Data.ByteString.Builder (string8)
5+import Control.Concurrent (forkIO, threadDelay)
6+import Control.Concurrent.Chan
7+import Control.Monad
8+import Data.Time.Clock.POSIX (getPOSIXTime)
9+import Network.HTTP.Types (status200)
10+import Network.Wai (Application, Middleware, pathInfo, responseFile)
11+import Network.Wai.EventSource (ServerEvent(..), eventSourceAppChan, eventSourceAppIO)
12+import Network.Wai.Handler.Warp (run)
13+import Network.Wai.Middleware.AddHeaders (addHeaders)
14+import Network.Wai.Middleware.Gzip (gzip, def)
15+
16+
17+app :: Chan ServerEvent -> Application
18+app chan req respond =
19+ case pathInfo req of
20+ [] -> respond $ responseFile status200 [("Content-Type", "text/html")] "example/index.html" Nothing
21+ ["esold"] -> eventSourceAppChan chan req respond
22+ ["eschan"] -> eventSourceAppChan chan req respond
23+ ["esio"] -> eventSourceAppIO eventIO req respond
24+ _ -> error "unexpected pathInfo"
25+
26+eventChan :: Chan ServerEvent -> IO ()
27+eventChan chan = forever $ do
28+ threadDelay 1000000
29+ time <- getPOSIXTime
30+ writeChan chan (ServerEvent Nothing Nothing [string8 . show $ time])
31+
32+eventIO :: IO ServerEvent
33+eventIO = do
34+ threadDelay 1000000
35+ time <- getPOSIXTime
36+ return $ ServerEvent (Just $ string8 "io")
37+ Nothing
38+ [string8 . show $ time]
39+
40+eventRaw :: (ServerEvent -> IO ()) -> IO () -> IO ()
41+eventRaw = handle 0
42+ where
43+ handle counter emit flush = do
44+ threadDelay 1000000
45+ _ <- emit $ ServerEvent (Just $ string8 "raw")
46+ Nothing
47+ [string8 . show $ counter]
48+ _ <- flush
49+ handle (counter + 1) emit flush
50+
51+main :: IO ()
52+main = do
53+ chan <- newChan
54+ _ <- forkIO . eventChan $ chan
55+ run 8080 (gzip def $ headers $ app chan)
56+ where
57+ -- headers required for SSE to work through nginx
58+ -- not required if using warp directly
59+ headers :: Middleware
60+ headers = addHeaders [ ("X-Accel-Buffering", "no")
61+ , ("Cache-Control", "no-cache")
62+ ]
wai-extra/app/index.html → wai-extra/example/index.htmlrenamed+3−2
@@ -1,8 +1,9 @@
11<!doctype html>
22<head>
3− <title>Hello</title>
3+ <title>Example</title>
4+ <link rel="icon" href="data:;base64,=">
45</head>
5−<h1>Testing</h1>
6+<h1>Testing Server-Sent Events</h1>
67
78<div id="output"></div>
89
wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hs+9−5
@@ -8,6 +8,7 @@ import Test.Hspec
88
99import Network.Wai.Middleware.ForceSSL
1010
11+import Control.Monad
1112import Data.ByteString (ByteString)
1213import Data.Monoid ((<>))
1314import Network.HTTP.Types (methodPost, status200, status301, status307)
@@ -18,8 +19,12 @@ main :: IO ()
1819main = hspec spec
1920
2021spec :: Spec
21−spec = describe "forceSSL" $ do
22− let host = "example.com"
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
2328
2429 it "redirects non-https requests to https" $ do
2530 resp <- runApp host forceSSL defaultRequest
@@ -39,7 +44,7 @@ spec = describe "forceSSL" $ do
3944
4045 simpleStatus resp `shouldBe` status200
4146
42− it "preserves the original path and query string" $ do
47+ it "preserves the original host, path, and query string" $ do
4348 resp <- runApp host forceSSL defaultRequest
4449 { rawPathInfo = "/foo/bar"
4550 , rawQueryString = "?baz=bat"
@@ -50,7 +55,6 @@ spec = describe "forceSSL" $ do
5055
5156runApp :: ByteString -> Middleware -> Request -> IO SResponse
5257runApp host mw req = runSession
53− (request req { requestHeaderHost = Just $ host <> ":80" }) $ mw app
54−
58+ (request req { requestHeaderHost = Just host }) $ mw app
5559 where
5660 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.hs+94
@@ -13,6 +13,7 @@ import qualified Data.ByteString.Lazy as L
1313import qualified Data.Text as TS
1414import qualified Data.Text.Encoding as TE
1515import Control.Monad.Trans.Resource (withInternalState, runResourceT)
16+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
1617
1718import Network.Wai
1819import Network.Wai.Test
@@ -30,6 +31,7 @@ spec = do
3031 [ ("text/plain", "text/plain", [])
3132 , ("text/plain; charset=UTF-8 ", "text/plain", [("charset", "UTF-8")])
3233 , ("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")])
3335 ]
3436 it "parseHttpAccept" caseParseHttpAccept
3537 describe "parseRequestBody" $ do
@@ -93,6 +95,11 @@ caseParseRequestBody = do
9395 let expectedfile3 = [("yaml", FileInfo "README" "application/octet-stream" "Photo blog using Hack.\n")]
9496 let expected3 = (expectedsmap3, expectedfile3)
9597
98+ let unknownErrorException c (ConnectionError (UnknownErrorCode code) _) = c == code
99+ unknownErrorException _ _ = False
100+
101+
102+ let def = defaultParseRequestBodyOptions
96103 it "parsing actual post multipart/form-data" $ do
97104 result3 <- parseRequestBody' lbsBackEnd $ toRequest ctype3 content3
98105 result3 `shouldBe` expected3
@@ -100,6 +107,61 @@ caseParseRequestBody = do
100107 it "parsing actual post multipart/form-data 2" $ do
101108 result3' <- parseRequestBody' lbsBackEnd $ toRequest' ctype3 content3
102109 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+
103165 where
104166 content2 =
105167 "--AaB03x\n"
@@ -123,6 +185,27 @@ caseParseRequestBody = do
123185 <> "Content-Type: application/octet-stream\r\n\r\n"
124186 <> "Photo blog using Hack.\n\r\n"
125187 <> "------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"
126209
127210caseMultipartPlus :: Assertion
128211caseMultipartPlus = do
@@ -198,3 +281,14 @@ toRequest' :: S8.ByteString -> S8.ByteString -> SRequest
198281toRequest' ctype content = SRequest defaultRequest
199282 { requestHeaders = [("Content-Type", ctype)]
200283 } (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.hs+69−39
@@ -8,52 +8,82 @@ import Test.Hspec
88
99import Data.ByteString (ByteString)
1010import Network.HTTP.Types (HeaderName)
11−import Network.Wai (Request(..), defaultRequest)
11+import Network.Wai (Request(..), defaultRequest, RequestBodyLength(..))
1212
1313import Network.Wai.Request
14+import Control.Exception (try)
15+import Control.Monad (forever)
1416
1517main :: IO ()
1618main = hspec spec
1719
1820spec :: Spec
19−spec = describe "appearsSecure" $ do
20− let insecureRequest = defaultRequest
21− { isSecure = False
22− , requestHeaders =
23− [ ("HTTPS", "off")
24− , ("HTTP_X_FORWARDED_SSL", "off")
25− , ("HTTP_X_FORWARDED_SCHEME", "http")
26− , ("HTTP_X_FORWARDED_PROTO", "http,xyz")
27− ]
28− }
29−
30− it "returns False for an insecure request" $
31− insecureRequest `shouldSatisfy` not . appearsSecure
32−
33− it "checks if the Request is actually secure" $ do
34− let req = insecureRequest { isSecure = True }
35−
36− req `shouldSatisfy` appearsSecure
37−
38− it "checks for HTTP: on" $ do
39− let req = addHeader "HTTPS" "on" insecureRequest
40−
41− req `shouldSatisfy` appearsSecure
42−
43− it "checks for HTTP_X_FORWARDED_SSL: on" $ do
44− let req = addHeader "HTTP_X_FORWARDED_SSL" "on" insecureRequest
45−
46− req `shouldSatisfy` appearsSecure
47−
48− it "checks for HTTP_X_FORWARDED_SCHEME: https" $ do
49− let req = addHeader "HTTP_X_FORWARDED_SCHEME" "https" insecureRequest
50−
51− req `shouldSatisfy` appearsSecure
52−
53− it "checks for HTTP_X_FORWARDED_PROTO: https,..." $ do
54− let req = addHeader "HTTP_X_FORWARDED_PROTO" "https,xyz" insecureRequest
55−
56− req `shouldSatisfy` appearsSecure
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
5787
5888addHeader :: HeaderName -> ByteString -> Request -> Request
5989addHeader name value req = req
wai-extra/test/Network/Wai/TestSpec.hs+46−12
@@ -3,6 +3,8 @@ module Network.Wai.TestSpec (main, spec) where
33
44import Control.Monad (void)
55
6+import qualified Data.IORef as IORef
7+
68import qualified Data.Text.Encoding as TE
79
810import Data.Time.Calendar (fromGregorian)
@@ -16,13 +18,17 @@ import Network.Wai.Test
1618import Network.HTTP.Types (status200)
1719
1820import qualified Data.ByteString.Lazy.Char8 as L8
19−import Blaze.ByteString.Builder (toByteString)
21+import Data.ByteString.Builder (Builder, toLazyByteString)
22+import Data.ByteString (ByteString)
2023
2124import qualified Web.Cookie as Cookie
2225
2326main :: IO ()
2427main = hspec spec
2528
29+toByteString :: Builder -> ByteString
30+toByteString = L8.toStrict . toLazyByteString
31+
2632spec :: Spec
2733spec = do
2834 describe "setPath" $ do
@@ -49,25 +55,53 @@ spec = do
4955 it "sets rawQueryString to empty string" $ do
5056 rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
5157
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+
5274 describe "request" $ do
5375
54− let simpleApp _req respond =
76+ let echoApp req respond = do
77+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
78+ let reqHeaders = requestHeaders req
5579 respond $
5680 responseLBS
5781 status200
58− [("foo", "bar")]
59− "simple"
82+ reqHeaders
83+ reqBody
6084
61− it "returns the status code of a simple app on default request" $ do
62− sresp <- runSession (request defaultRequest) simpleApp
85+ it "returns the status code of an echo app on default request" $ do
86+ sresp <- runSession (request defaultRequest) echoApp
6387 simpleStatus sresp `shouldBe` status200
6488
65− it "returns the response body of a simple app on default request" $ do
66− sresp <- runSession (request defaultRequest) simpleApp
67− simpleBody sresp `shouldBe` "simple"
68−
69− it "returns the response headers of a simple app on default request" $ do
70− sresp <- runSession (request defaultRequest) simpleApp
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+ }
71105 simpleHeaders sresp `shouldBe` [("foo", "bar")]
72106
73107 let cookieApp req respond =
wai-extra/wai-extra.cabal+39−14
@@ -1,5 +1,5 @@
11Name: wai-extra
2−Version: 3.0.13
2+Version: 3.0.29.1
33Synopsis: Provides some basic WAI handlers and middleware.
44description:
55 Provides basic WAI handler and middleware functionality:
@@ -71,7 +71,7 @@ Maintainer: michael@snoyman.com
7171Homepage: http://github.com/yesodweb/wai
7272Category: Web
7373Build-Type: Simple
74−Cabal-Version: >=1.8
74+Cabal-Version: >=1.10
7575Stability: Stable
7676extra-source-files:
7777 test/requests/dalvik-request
@@ -81,45 +81,48 @@ extra-source-files:
8181 ChangeLog.md
8282 README.md
8383
84+flag build-example
85+ description: Build example executable.
86+ manual: True
87+ default: False
88+
8489Library
85− Build-Depends: base >= 4 && < 5
86− , bytestring >= 0.9.1.4
87− , wai >= 3.0.3.0 && < 3.1
90+ Build-Depends: base >= 4.8 && < 5
91+ , bytestring >= 0.10.4
92+ , wai >= 3.0.3.0 && < 3.3
8893 , old-locale >= 1.0.0.2 && < 1.1
8994 , time >= 1.1.4
9095 , network >= 2.6.1.0
9196 , directory >= 1.0.1
9297 , transformers >= 0.2.2
93− , blaze-builder >= 0.2.1.4 && < 0.5
9498 , http-types >= 0.7
9599 , text >= 0.7
96100 , case-insensitive >= 0.2
97101 , data-default-class
98− , fast-logger >= 2.1 && < 2.5
99− , wai-logger >= 2.0 && < 2.3
102+ , fast-logger >= 2.4.5
103+ , wai-logger >= 2.3.2
100104 , ansi-terminal
101− , resourcet >= 0.4.6 && < 1.2
105+ , resourcet >= 0.4.6 && < 1.3
102106 , void >= 0.5
103− , stringsearch >= 0.3 && < 0.4
104107 , containers
105108 , base64-bytestring
106109 , word8
107− , lifted-base >= 0.1.2
108110 , deepseq
109− , streaming-commons
111+ , streaming-commons >= 0.2
110112 , unix-compat
111113 , cookie
112114 , vault
113115 , zlib
114116 , aeson
115117 , iproute
118+ , http2
116119
117120 if os(windows)
118121 cpp-options: -DWINDOWS
119122 else
120123 build-depends: unix
121124
122− extensions: OverloadedStrings
125+ default-extensions: OverloadedStrings
123126
124127 Exposed-modules: Network.Wai.Handler.CGI
125128 Network.Wai.Handler.SCGI
@@ -141,17 +144,37 @@ Library
141144 Network.Wai.Middleware.Vhost
142145 Network.Wai.Middleware.HttpAuth
143146 Network.Wai.Middleware.StreamFile
147+ Network.Wai.Middleware.ForceDomain
144148 Network.Wai.Middleware.ForceSSL
145149 Network.Wai.Middleware.Routed
150+ Network.Wai.Middleware.Timeout
146151 Network.Wai.Parse
147152 Network.Wai.Request
148153 Network.Wai.UrlMap
149154 Network.Wai.Test
155+ Network.Wai.Test.Internal
150156 Network.Wai.EventSource
151157 Network.Wai.EventSource.EventStream
152158 other-modules: Network.Wai.Middleware.RequestLogger.Internal
159+ default-language: Haskell2010
153160 ghc-options: -Wall
154161
162+executable example
163+ hs-source-dirs: example
164+ main-is: Main.hs
165+ ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall
166+ if flag(build-example)
167+ build-depends: base
168+ , wai-extra
169+ , warp
170+ , wai
171+ , time
172+ , http-types
173+ , bytestring
174+ else
175+ buildable: False
176+ default-language: Haskell2010
177+
155178test-suite spec
156179 type: exitcode-stdio-1.0
157180 hs-source-dirs: test
@@ -163,6 +186,7 @@ test-suite spec
163186 Network.Wai.Middleware.ForceSSLSpec
164187 Network.Wai.Middleware.RoutedSpec
165188 Network.Wai.Middleware.StripHeadersSpec
189+ Network.Wai.Middleware.TimeoutSpec
166190 WaiExtraSpec
167191 build-depends: base >= 4 && < 5
168192 , wai-extra
@@ -176,11 +200,12 @@ test-suite spec
176200 , resourcet
177201 , bytestring
178202 , HUnit
179− , blaze-builder
180203 , cookie
181204 , time
182205 , case-insensitive
206+ , http2
183207 ghc-options: -Wall
208+ default-language: Haskell2010
184209
185210source-repository head
186211 type: git
wai-frontend-monadcgi/ChangeLog.md+7−1
@@ -1 +1,7 @@
1−No changes logged yet.
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+4−1
@@ -64,5 +64,8 @@ getCgiVars :: Request -> [(String, String)]
6464getCgiVars e =
6565 [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
6666 , ("REQUEST_METHOD", show $ requestMethod e)
67− , ("QUERY_STRING", S8.unpack $ rawQueryString e)
67+ , ("QUERY_STRING",
68+ case S8.unpack $ rawQueryString e of
69+ '?':rest -> rest
70+ x -> x)
6871 ]
wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+2−2
@@ -1,5 +1,5 @@
11name: wai-frontend-monadcgi
2−version: 3.0.0.1
2+version: 3.0.0.3
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
@@ -20,7 +20,7 @@ library
2020 , http-types
2121 , transformers
2222 , case-insensitive
23− , wai >= 3.0 && < 3.1
23+ , wai >= 3.0 && < 3.3
2424 exposed-modules: Network.Wai.Frontend.MonadCGI
2525 ghc-options: -Wall
2626
wai-handler-fastcgi/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−/dist/
2−*.swp
3−*.hi
4−*.o
wai-handler-fastcgi/ChangeLog.mddeleted−1
@@ -1 +0,0 @@
1−No changes logged yet.
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/README.mddeleted−3
@@ -1,3 +0,0 @@
1−## wai-handler-fastcgi
2−
3−Calls out to the libfcgi C library.
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: 3.0.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: Wai handler to fastcgi
8−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-fastcgi>.
9−category: Web
10−stability: stable
11−cabal-version: >= 1.6
12−build-type: Configure
13−extra-source-files: configure fastcgi.buildinfo.in README.md ChangeLog.md
14−homepage: http://www.yesodweb.com/book/web-application-interface
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 3.0 && < 3.1
19− , wai-extra >= 3.0 && < 3.1
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/ChangeLog.mddeleted−7
@@ -1,7 +0,0 @@
1−## 3.0.0.3
2−
3−Allow blaze-builder 0.4
4−
5−## 3.0.0.2
6−
7−* Support for Win64
wai-handler-launch/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-launch/Network/Wai/Handler/Launch.hsdeleted−206
@@ -1,206 +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.Wai.Internal
12−import Network.HTTP.Types
13−import qualified Network.Wai.Handler.Warp as Warp
14−import Data.IORef
15−import Data.Monoid (mappend)
16−import Control.Concurrent (forkIO, threadDelay)
17−import Control.Monad.IO.Class (liftIO)
18−import Control.Monad (unless)
19−import Control.Exception (throwIO)
20−import Data.Function (fix)
21−import qualified Data.ByteString as S
22−import Blaze.ByteString.Builder (fromByteString, Builder, flush)
23−import qualified Blaze.ByteString.Builder as Blaze
24−#if WINDOWS
25−import Foreign
26−import Foreign.C.String
27−#else
28−import System.Process (rawSystem)
29−#endif
30−import Data.Streaming.Blaze (newBlazeRecv, defaultStrategy)
31−import qualified Data.Streaming.Zlib as Z
32−
33−ping :: IORef Bool -> Middleware
34−ping var app req sendResponse
35− | pathInfo req == ["_ping"] = do
36− liftIO $ writeIORef var True
37− sendResponse $ responseLBS status200 [] ""
38− | otherwise = app req $ \res -> do
39− let isHtml hs =
40− case lookup "content-type" hs of
41− Just ct -> "text/html" `S.isPrefixOf` ct
42− Nothing -> False
43− if isHtml $ responseHeaders res
44− then do
45− let (s, hs, withBody) = responseToStream res
46− (isEnc, headers') = fixHeaders id hs
47− headers'' = filter (\(x, _) -> x /= "content-length") headers'
48− withBody $ \body ->
49− sendResponse $ responseStream s headers'' $ \sendChunk flush ->
50− addInsideHead sendChunk flush $ \sendChunk' flush' ->
51− if isEnc
52− then decode sendChunk' flush' body
53− else body sendChunk' flush'
54− else sendResponse res
55−
56−decode :: (Builder -> IO ()) -> IO ()
57− -> StreamingBody
58− -> IO ()
59−decode sendInner flushInner streamingBody = do
60− (blazeRecv, blazeFinish) <- newBlazeRecv defaultStrategy
61− inflate <- Z.initInflate $ Z.WindowBits 31
62− let send builder = blazeRecv builder >>= goBuilderPopper
63− goBuilderPopper popper = fix $ \loop -> do
64− bs <- popper
65− unless (S.null bs) $ do
66− Z.feedInflate inflate bs >>= goZlibPopper
67− loop
68− goZlibPopper popper = fix $ \loop -> do
69− res <- popper
70− case res of
71− Z.PRDone -> return ()
72− Z.PRNext bs -> do
73− sendInner $ fromByteString bs
74− loop
75− Z.PRError e -> throwIO e
76− streamingBody send (send flush)
77− mbs <- blazeFinish
78− case mbs of
79− Nothing -> return ()
80− Just bs -> Z.feedInflate inflate bs >>= goZlibPopper
81− Z.finishInflate inflate >>= sendInner . fromByteString
82−
83−toInsert :: S.ByteString
84−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>"
85−
86−addInsideHead :: (Builder -> IO ())
87− -> IO ()
88− -> StreamingBody
89− -> IO ()
90−addInsideHead sendInner flushInner streamingBody = do
91− (blazeRecv, blazeFinish) <- newBlazeRecv defaultStrategy
92− ref <- newIORef $ Just (S.empty, whole)
93− streamingBody (inner blazeRecv ref) (flush blazeRecv ref)
94− state <- readIORef ref
95− mbs <- blazeFinish
96− held <- case mbs of
97− Nothing -> return state
98− Just bs -> push state bs
99− case state of
100− Nothing -> return ()
101− Just (held, _) -> sendInner $ fromByteString held `mappend` fromByteString toInsert
102− where
103− whole = "<head>"
104−
105− flush blazeRecv ref = inner blazeRecv ref Blaze.flush
106−
107− inner blazeRecv ref builder = do
108− state0 <- readIORef ref
109− popper <- blazeRecv builder
110− let loop state = do
111− bs <- popper
112− if S.null bs
113− then writeIORef ref state
114− else push state bs >>= loop
115− loop state0
116−
117− push Nothing x = sendInner (fromByteString x) >> return Nothing
118− push (Just (held, atFront)) x
119− | atFront `S.isPrefixOf` x = do
120− let y = S.drop (S.length atFront) x
121− sendInner $ fromByteString held
122− `mappend` fromByteString atFront
123− `mappend` fromByteString toInsert
124− `mappend` fromByteString y
125− return Nothing
126− | whole `S.isInfixOf` x = do
127− let (before, rest) = S.breakSubstring whole x
128− let after = S.drop (S.length whole) rest
129− sendInner $ fromByteString held
130− `mappend` fromByteString before
131− `mappend` fromByteString whole
132− `mappend` fromByteString toInsert
133− `mappend` fromByteString after
134− return Nothing
135− | x `S.isPrefixOf` atFront = do
136− let held' = held `S.append` x
137− atFront' = S.drop (S.length x) atFront
138− return $ Just (held', atFront')
139− | otherwise = do
140− let (held', atFront', x') = getOverlap whole x
141− sendInner $ fromByteString held `mappend` fromByteString x'
142− return $ Just (held', atFront')
143−
144−getOverlap :: S.ByteString -> S.ByteString -> (S.ByteString, S.ByteString, S.ByteString)
145−getOverlap whole x =
146− go whole
147− where
148− go piece
149− | S.null piece = ("", whole, x)
150− | piece `S.isSuffixOf` x =
151− let x' = S.take (S.length x - S.length piece) x
152− atFront = S.drop (S.length piece) whole
153− in (piece, atFront, x')
154− | otherwise = go $ S.init piece
155−
156−fixHeaders :: ([Header] -> [Header])
157− -> [Header]
158− -> (Bool, [Header])
159−fixHeaders front [] = (False, front [])
160−fixHeaders front (("content-encoding", "gzip"):rest) = (True, front rest)
161−fixHeaders front (x:xs) = fixHeaders (front . (:) x) xs
162−
163−#if WINDOWS
164−foreign import ccall "launch"
165− launch' :: Int -> CString -> IO ()
166−#endif
167−
168−launch :: Int -> String -> IO ()
169−
170−#if WINDOWS
171−launch port s = withCString s $ launch' port
172−#else
173−launch port s = forkIO (rawSystem
174−#if MAC
175− "open"
176−#else
177− "xdg-open"
178−#endif
179− ["http://127.0.0.1:" ++ show port ++ "/" ++ s] >> return ()) >> return ()
180−#endif
181−
182−run :: Application -> IO ()
183−run = runUrl ""
184−
185−runUrl :: String -> Application -> IO ()
186−runUrl = runUrlPort 4587
187−
188−runUrlPort :: Int -> String -> Application -> IO ()
189−runUrlPort port url app = do
190− x <- newIORef True
191− _ <- forkIO $ Warp.runSettings
192− ( Warp.setPort port
193− $ Warp.setOnException (\_ _ -> return ())
194− $ Warp.setHost "*4" Warp.defaultSettings)
195− $ ping x app
196− launch port url
197− loop x
198−
199−loop :: IORef Bool -> IO ()
200−loop x = do
201− let seconds = 120
202− threadDelay $ 1000000 * seconds
203− b <- readIORef x
204− if b
205− then writeIORef x False >> loop x
206− else return ()
wai-handler-launch/READMEdeleted

No changes to the content.

wai-handler-launch/README.mddeleted−4
@@ -1,4 +0,0 @@
1−## wai-handler-launch
2−
3−This handles cross-platform launching and inserts Javascript code to ping the
4−server. When the server no longer receives pings, it shuts down.
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 def $ \_ f -> f $ responseLBS status200 [("Content-Type", "text/html; charset=utf8")] "<html><head></head><body>HELLO THERE"
wai-handler-launch/wai-handler-launch.cabaldeleted−36
@@ -1,36 +0,0 @@
1−Name: wai-handler-launch
2−Version: 3.0.0.4
3−Synopsis: Launch a web app in the default browser.
4−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-launch>.
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−extra-source-files: README.md ChangeLog.md
13−
14−Library
15− Exposed-modules: Network.Wai.Handler.Launch
16− build-depends: base >= 4 && < 5
17− , wai >= 3.0 && < 3.1
18− , warp >= 3.0 && < 3.2
19− , http-types >= 0.7
20− , transformers >= 0.2.2
21− , bytestring >= 0.9.1.4
22− , blaze-builder >= 0.2.1.4 && < 0.5
23− , streaming-commons
24−
25− if os(windows)
26− c-sources: windows.c
27− cpp-options: -DWINDOWS
28− extra-libraries: Shell32 msvcrt
29− else
30− build-depends: process >= 1.0 && < 1.3
31− if os(darwin)
32− cpp-options: -DMAC
33−
34−source-repository head
35− type: git
36− 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-webkit/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−dist
2−*.swp
wai-handler-webkit/ChangeLog.mddeleted−1
@@ -1 +0,0 @@
1−No changes logged yet
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 _ response = response $ responseLBS status200 [("Content-Type", "text/html")] "<h1>Hello World!</h1>"
wai-handler-webkit/wai-handler-webkit.cabaldeleted−30
@@ -1,30 +0,0 @@
1−name: wai-handler-webkit
2−version: 3.0.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: Turn WAI applications into standalone GUIs using QtWebkit.
8−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-webkit>.
9−category: Web
10−stability: unstable
11−cabal-version: >= 1.6
12−build-type: Simple
13−homepage: https://github.com/yesodweb/wai/tree/master/wai-handler-webkit
14−extra-source-files: README.md ChangeLog.md
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 3.0 && < 3.2
19− , warp >= 3.0 && < 3.2
20− ghc-options: -Wall
21− exposed-modules: Network.Wai.Handler.Webkit
22− c-sources: webkit.cpp
23− if os(windows)
24− extra-libraries: QtCore4, QtGui4, QtNetwork4, QtWebKit4
25− else
26− pkgconfig-depends: QtWebKit
27−
28−source-repository head
29− type: git
30− 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-webkit/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/
22
33Permission is hereby granted, free of charge, to any person obtaining
44a 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-websockets/ChangeLog.md+20
@@ -1,3 +1,23 @@
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+
121## 3.0.0.7
222
323* Improved documentation [#471](https://github.com/yesodweb/wai/pull/471)
wai-websockets/Network/Wai/Handler/WebSockets.hs+24−19
@@ -7,6 +7,7 @@ module Network.Wai.Handler.WebSockets
77 , runWebSockets
88 ) where
99
10+import Control.Exception (bracket, tryJust)
1011import Data.ByteString (ByteString)
1112import qualified Data.ByteString.Char8 as BC
1213import qualified Data.ByteString.Lazy as BL
@@ -29,10 +30,10 @@ isWebSocketsReq req =
2930-- WebSocket requests.
3031--
3132-- @
32−-- websocketsOr opts ws_app backup_app = \\req send_response ->
33+-- websocketsOr opts ws_app backup_app = \\req respond ->
3334-- __case__ 'websocketsApp' opts ws_app req __of__
3435-- 'Nothing' -> backup_app req send_response
35−-- 'Just' res -> send_response res
36+-- 'Just' res -> respond res
3637-- @
3738--
3839-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
@@ -48,7 +49,7 @@ isWebSocketsReq req =
4849-- 'WS.sendTextData' conn ("Hello, client!" :: 'Data.Text.Text')
4950--
5051-- backupApp :: 'Wai.Application'
51−-- backupApp = 'Wai.respondLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
52+-- backupApp _ respond = respond $ 'Wai.responseLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
5253-- @
5354websocketsOr :: WS.ConnectionOptions
5455 -> WS.ServerApp
@@ -94,20 +95,24 @@ runWebSockets :: WS.ConnectionOptions
9495 -> IO ByteString
9596 -> (ByteString -> IO ())
9697 -> IO a
97−runWebSockets opts req app src sink = do
98− stream <- WS.makeStream
99− (do
100− bs <- src
101− return $ if BC.null bs then Nothing else Just bs)
102− (\mbBl -> case mbBl of
103− Nothing -> return ()
104− Just bl -> mapM_ sink (BL.toChunks bl))
105−
106− let pc = WS.PendingConnection
107− { WS.pendingOptions = opts
108− , WS.pendingRequest = req
109− , WS.pendingOnAccept = \_ -> return ()
110− , WS.pendingStream = stream
111− }
98+runWebSockets opts req app src sink = bracket mkStream ensureClose (app . pc)
99+ where
100+ ensureClose = tryJust onConnectionException . WS.close
101+ onConnectionException :: WS.ConnectionException -> Maybe ()
102+ onConnectionException WS.ConnectionClosed = Just ()
103+ onConnectionException _ = Nothing
104+ mkStream =
105+ WS.makeStream
106+ (do
107+ bs <- src
108+ return $ if BC.null bs then Nothing else Just bs)
109+ (\mbBl -> case mbBl of
110+ Nothing -> return ()
111+ Just bl -> mapM_ sink (BL.toChunks bl))
112112
113− app pc
113+ pc stream = WS.PendingConnection
114+ { WS.pendingOptions = opts
115+ , WS.pendingRequest = req
116+ , WS.pendingOnAccept = \_ -> return ()
117+ , WS.pendingStream = stream
118+ }
wai-websockets/server.lhs+9−3
@@ -8,12 +8,14 @@ this example, keep the [reference](http://jaspervdj.be/websockets/reference)
88nearby to check out the functions we use.
99
1010> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
11+> {-# LANGUAGE CPP #-}
12+> {-# OPTIONS_GHC -Wno-unused-top-binds #-} -- for numClients
1113> import Data.Char (isPunctuation, isSpace)
1214> import Data.Monoid (mappend)
1315> import Data.Text (Text)
14−> import Control.Exception (finally)
16+> import Control.Exception (finally)
1517> import Control.Monad (forM_, forever)
16−> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, forkIO, modifyMVar)
18+> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, modifyMVar)
1719> import Control.Monad.IO.Class (liftIO)
1820> import qualified Data.Text as T
1921> import qualified Data.Text.IO as T
@@ -99,9 +101,13 @@ stays alive on some browsers.
99101
100102> application state pending = do
101103> conn <- WS.acceptRequest pending
104+#if __GLASGOW_HASKELL__ >= 806
105+> WS.withPingThread conn 30 (return ()) $ do
106+#else
102107> WS.forkPingThread conn 30
108+#endif
103109
104−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
105111be in the format of "Hi! I am Jasper", where Jasper is the requested username.
106112
107113> msg <- WS.receiveData conn
wai-websockets/wai-websockets.cabal+3−4
@@ -1,5 +1,5 @@
11Name: wai-websockets
2−Version: 3.0.0.7
2+Version: 3.0.1.2
33Synopsis: Provide a bridge between WAI and the websockets package.
44License: MIT
55License-file: LICENSE
@@ -20,8 +20,7 @@ flag example
2020Library
2121 Build-Depends: base >= 3 && < 5
2222 , bytestring >= 0.9.1.4
23− , wai >= 3.0 && < 3.1
24− , blaze-builder >= 0.2.1.4 && < 0.5
23+ , wai >= 3.0 && < 3.3
2524 , case-insensitive >= 0.2
2625 , network >= 2.2.1.5
2726 , transformers >= 0.2
@@ -41,12 +40,12 @@ Executable wai-websockets-example
4140 , wai-app-static
4241 , bytestring
4342 , case-insensitive
44− , blaze-builder
4543 , transformers
4644 , network
4745 , text
4846 , file-embed
4947 , http-types
48+ other-modules: Network.Wai.Handler.WebSockets
5049 else
5150 buildable: False
5251
wai/ChangeLog.md+36
@@ -1,3 +1,39 @@
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+
137## 3.0.5.0
238
339* Avoid using the IsString Builder instance
wai/Network/Wai.hs+32−21
@@ -1,15 +1,14 @@
1−{-# LANGUAGE Rank2Types #-}
2−{-# LANGUAGE CPP #-}
31{-|
42
53This module defines a generic web application interface. It is a common
64protocol between web servers and web applications.
75
86The overriding design principles here are performance and generality. To
9−address performance, this library is built on top of the conduit and
10−blaze-builder packages. The advantages of conduits over lazy IO have been
11−debated elsewhere and so will not be addressed here. However, helper functions
12−like 'responseLBS' allow you to continue using lazy IO if you so desire.
7+address performance, this library uses a streaming interface for request and
8+response bodies, paired with bytestring's 'Builder' type. The advantages of a
9+streaming API over lazy IO have been debated elsewhere and so will not be
10+addressed here. However, helper functions like 'responseLBS' allow you to
11+continue using lazy IO if you so desire.
1312
1413Generality is achieved by removing many variables commonly found in similar
1514projects that are not universal to all servers. The goal is that the 'Request'
@@ -31,9 +30,9 @@ include:
3130
3231[wai-extra] <http://hackage.haskell.org/package/wai-extra>
3332
34−[wai-test] <http://hackage.haskell.org/package/wai-test>
35−
3633-}
34+-- Ignore deprecations, because this module needs to use the deprecated requestBody to construct a response.
35+{-# OPTIONS_GHC -fno-warn-deprecations #-}
3736module Network.Wai
3837 (
3938 -- * Types
@@ -54,11 +53,14 @@ module Network.Wai
5453 , remoteHost
5554 , pathInfo
5655 , queryString
56+ , getRequestBodyChunk
5757 , requestBody
5858 , vault
5959 , requestBodyLength
6060 , requestHeaderHost
6161 , requestHeaderRange
62+ , requestHeaderReferer
63+ , requestHeaderUserAgent
6264 , strictRequestBody
6365 , lazyRequestBody
6466 -- * Response
@@ -77,13 +79,14 @@ module Network.Wai
7779 -- ** Response modifiers
7880 , responseToStream
7981 , mapResponseHeaders
82+ , mapResponseStatus
8083 -- * Middleware composition
8184 , ifRequest
8285 , modifyResponse
8386 ) where
8487
85−import Blaze.ByteString.Builder (Builder, fromLazyByteString)
86−import Blaze.ByteString.Builder (fromByteString)
88+import Data.ByteString.Builder (Builder, lazyByteString)
89+import Data.ByteString.Builder (byteString)
8790import Control.Monad (unless)
8891import qualified Data.ByteString as B
8992import qualified Data.ByteString.Lazy as L
@@ -91,7 +94,6 @@ import qualified Data.ByteString.Lazy.Internal as LI
9194import Data.ByteString.Lazy.Internal (defaultChunkSize)
9295import Data.ByteString.Lazy.Char8 ()
9396import Data.Function (fix)
94−import Data.Monoid (mempty)
9597import qualified Network.HTTP.Types as H
9698import Network.Socket (SockAddr (SockAddrInet))
9799import Network.Wai.Internal
@@ -119,13 +121,13 @@ responseFile = ResponseFile
119121--
120122-- A2. No. If the ByteStrings are small, then they will be copied into a larger
121123-- buffer, which should be a performance gain overall (less system calls). If
122−-- they are already large, then blaze-builder uses an InsertByteString
123−-- instruction to avoid copying.
124+-- they are already large, then an insert operation is used
125+-- to avoid copying.
124126--
125127-- Q3. Doesn't this prevent us from creating comet-style servers, since data
126128-- will be cached?
127129--
128−-- 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
129131-- optimal size by sending a flush command.
130132responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
131133responseBuilder = ResponseBuilder
@@ -133,7 +135,7 @@ responseBuilder = ResponseBuilder
133135-- | Creating 'Response' from 'L.ByteString'. This is a wrapper for
134136-- 'responseBuilder'.
135137responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
136−responseLBS s h = ResponseBuilder s h . fromLazyByteString
138+responseLBS s h = ResponseBuilder s h . lazyByteString
137139
138140-- | Creating 'Response' from a stream of values.
139141--
@@ -147,9 +149,9 @@ responseLBS s h = ResponseBuilder s h . fromLazyByteString
147149-- (putStrLn \"Allocating scarce resource\")
148150-- (putStrLn \"Cleaning up\")
149151-- $ respond $ responseStream status200 [] $ \\write flush -> do
150−-- write $ fromByteString \"Hello\\n\"
152+-- write $ byteString \"Hello\\n\"
151153-- flush
152−-- write $ fromByteString \"World\\n\"
154+-- write $ byteString \"World\\n\"
153155-- @
154156--
155157-- Note that in some cases you can use @bracket@ from inside @responseStream@
@@ -212,7 +214,7 @@ responseToStream (ResponseFile s h fp (Just part)) =
212214 bs <- B.hGetSome handle defaultChunkSize
213215 unless (B.null bs) $ do
214216 let x = B.take remaining bs
215− sendChunk $ fromByteString x
217+ sendChunk $ byteString x
216218 loop $ remaining - B.length x
217219 loop $ fromIntegral $ filePartByteCount part
218220 )
@@ -223,7 +225,7 @@ responseToStream (ResponseFile s h fp Nothing) =
223225 withBody $ \sendChunk _flush -> fix $ \loop -> do
224226 bs <- B.hGetSome handle defaultChunkSize
225227 unless (B.null bs) $ do
226− sendChunk $ fromByteString bs
228+ sendChunk $ byteString bs
227229 loop
228230 )
229231responseToStream (ResponseBuilder s h b) =
@@ -237,6 +239,13 @@ mapResponseHeaders f (ResponseBuilder s h b) = ResponseBuilder s (f h) b
237239mapResponseHeaders f (ResponseStream s h b) = ResponseStream s (f h) b
238240mapResponseHeaders _ r@(ResponseRaw _ _) = r
239241
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+
240249----------------------------------------------------------------
241250
242251-- | The WAI application.
@@ -274,6 +283,8 @@ defaultRequest = Request
274283 , requestBodyLength = KnownLength 0
275284 , requestHeaderHost = Nothing
276285 , requestHeaderRange = Nothing
286+ , requestHeaderReferer = Nothing
287+ , requestHeaderUserAgent = Nothing
277288 }
278289
279290
@@ -315,7 +326,7 @@ strictRequestBody req =
315326 loop id
316327 where
317328 loop front = do
318− bs <- requestBody req
329+ bs <- getRequestBodyChunk req
319330 if B.null bs
320331 then return $ front LI.Empty
321332 else loop (front . LI.Chunk bs)
@@ -329,7 +340,7 @@ lazyRequestBody req =
329340 loop
330341 where
331342 loop = unsafeInterleaveIO $ do
332− bs <- requestBody req
343+ bs <- getRequestBodyChunk req
333344 if B.null bs
334345 then return LI.Empty
335346 else do
wai/Network/Wai/HTTP2.hsdeleted−272
@@ -1,272 +0,0 @@
1−{-# LANGUAGE OverloadedStrings, RankNTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DeriveDataTypeable #-}
4−
5−-- | An HTTP\/2-aware variant of the 'Network.Wai.Application' type. Compared
6−-- to the original, this exposes the new functionality of server push and
7−-- trailers, allows stream fragments to be sent in the form of file ranges, and
8−-- allows the stream body to produce a value to be used in constructing the
9−-- trailers. Existing @Applications@ can be faithfully upgraded to HTTP\/2
10−-- with 'promoteApplication' or served transparently over both protocols with
11−-- the normal Warp 'Network.Wai.Handler.Warp.run' family of functions.
12−--
13−-- An 'HTTP2Application' takes a 'Request' and a 'PushFunc' and produces a
14−-- 'Responder' that will push any associated resources and send the response
15−-- body. The response is always a stream of 'Builder's and file chunks.
16−-- Equivalents of the 'Network.Wai.responseBuilder' family of functions are
17−-- provided for creating 'Responder's conveniently.
18−--
19−-- Pushed streams are handled by an IO action that triggers a server push. It
20−-- returns @True@ if the @PUSH_PROMISE@ frame was sent, @False@ if not. Note
21−-- this means it will still return @True@ if the client reset or ignored the
22−-- stream. This gives handlers the freedom to implement their own heuristics
23−-- for whether to actually push a resource, while also allowing middleware and
24−-- frameworks to trigger server pushes automatically.
25−
26−module Network.Wai.HTTP2
27− (
28− -- * Applications
29− HTTP2Application
30− -- * Responder
31− , Responder(..)
32− , RespondFunc
33− , Body
34− , Chunk(..)
35− , Trailers
36− -- * Server push
37− , PushFunc
38− , PushPromise(..)
39− , promiseHeaders
40− -- * Conveniences
41− , promoteApplication
42− -- ** Responders
43− , respond
44− , respondCont
45− , respondIO
46− , respondFile
47− , respondFilePart
48− , respondNotFound
49− , respondWith
50− -- ** Stream Bodies
51− , streamFilePart
52− , streamBuilder
53− , streamSimple
54− ) where
55−
56−import Blaze.ByteString.Builder (Builder)
57−import Blaze.ByteString.Builder.ByteString (fromByteString)
58−import Control.Exception (Exception, throwIO)
59−import Control.Monad.Trans.Cont (ContT(..))
60−import Data.ByteString (ByteString)
61−#if __GLASGOW_HASKELL__ < 709
62−import Data.Functor ((<$>))
63−#endif
64−import Data.IORef (newIORef, readIORef, writeIORef)
65−#if __GLASGOW_HASKELL__ < 709
66−import Data.Monoid (mempty)
67−#endif
68−import Data.Typeable (Typeable)
69−import qualified Network.HTTP.Types as H
70−
71−import Network.Wai (Application)
72−import Network.Wai.Internal
73− ( FilePart(..)
74− , Request(requestHeaders)
75− , Response(..)
76− , ResponseReceived(..)
77− , StreamingBody
78− , adjustForFilePart
79− , chooseFilePart
80− , tryGetFileSize
81− )
82−
83−-- | Headers sent after the end of a data stream, as defined by section 4.1.2 of
84−-- the HTTP\/1.1 spec (RFC 7230), and section 8.1 of the HTTP\/2 spec.
85−type Trailers = [H.Header]
86−
87−-- | The synthesized request and headers of a pushed stream.
88−data PushPromise = PushPromise
89− { promisedMethod :: H.Method
90− , promisedPath :: ByteString
91− , promisedAuthority :: ByteString
92− , promisedScheme :: ByteString
93− , promisedHeader :: H.RequestHeaders
94− }
95−
96−-- | The HTTP\/2-aware equivalent of 'Network.Wai.Application'.
97−type HTTP2Application = Request -> PushFunc -> Responder
98−
99−-- | Part of a streaming response -- either a 'Builder' or a range of a file.
100−data Chunk = FileChunk FilePath FilePart | BuilderChunk Builder
101−
102−-- | The streaming body of a response. Equivalent to
103−-- 'Network.Wai.StreamingBody' except that it can also write file ranges and
104−-- return the stream's trailers.
105−type Body = (Chunk -> IO ()) -> IO () -> IO Trailers
106−
107−-- | Given to 'Responders'; provide a status, headers, and a stream body, and
108−-- we'll give you a token proving you called the 'RespondFunc'.
109−type RespondFunc s = H.Status -> H.ResponseHeaders -> Body -> IO s
110−
111−-- | The result of an 'HTTP2Application'; or, alternately, an application
112−-- that's independent of the request. This is a continuation-passing style
113−-- function that first provides a response by calling the given respond
114−-- function, then returns the request's 'Trailers'.
115−--
116−-- The respond function is similar to the one in 'Network.Wai.Application', but
117−-- it only takes a streaming body, the status and headers are curried, and it
118−-- also produces trailers for the stream.
119−newtype Responder = Responder
120− { runResponder :: forall s. RespondFunc s -> IO s }
121−
122−-- | A function given to an 'HTTP2Application' to initiate a server-pushed
123−-- stream. Its argument is the same as the result of an 'HTTP2Application', so
124−-- you can either implement the response inline, or call your own application
125−-- to create the response.
126−--
127−-- The result is 'True' if the @PUSH_PROMISE@ frame will be sent, or 'False' if
128−-- it will not. This can happen if server push is disabled, the concurrency
129−-- limit of server-initiated streams is reached, or the associated stream has
130−-- already been closed.
131−--
132−-- This function shall ensure that stream data provided after it returns will
133−-- be sent after the @PUSH_PROMISE@ frame, so that servers can implement the
134−-- requirement that any pushed stream for a resource be initiated before
135−-- sending DATA frames that reference it.
136−type PushFunc = PushPromise -> Responder -> IO Bool
137−
138−-- | Create the 'H.RequestHeaders' corresponding to the given 'PushPromise'.
139−--
140−-- This is primarily useful for WAI handlers like Warp, and application
141−-- implementers are unlikely to use it directly.
142−promiseHeaders :: PushPromise -> H.RequestHeaders
143−promiseHeaders p =
144− [ (":method", promisedMethod p)
145− , (":path", promisedPath p)
146− , (":authority", promisedAuthority p)
147− , (":scheme", promisedScheme p)
148− ] ++ promisedHeader p
149−
150−-- | Create a response body consisting of a single range of a file. Does not
151−-- set Content-Length or Content-Range headers. For that, use
152−-- 'respondFilePart' or 'respondFile'.
153−streamFilePart :: FilePath -> FilePart -> Body
154−streamFilePart path part write _ = write (FileChunk path part) >> return []
155−
156−-- | Respond with a single range of a file, adding the Accept-Ranges,
157−-- Content-Length and Content-Range headers and changing the status to 206 as
158−-- appropriate.
159−--
160−-- If you want the range to be inferred automatically from the Range header,
161−-- use 'respondFile' instead. On the other hand, if you want to avoid the
162−-- automatic header and status adjustments, use 'respond' and 'streamFilePart'
163−-- directly.
164−respondFilePart :: H.Status -> H.ResponseHeaders -> FilePath -> FilePart -> Responder
165−respondFilePart s h path part = Responder $ \k -> do
166− let (s', h') = adjustForFilePart s h part
167− k s' h' $ streamFilePart path part
168−
169−-- | Serve the requested range of the specified file (based on the Range
170−-- header), using the given 'H.Status' and 'H.ResponseHeaders' as a base. If
171−-- the file is not accessible, the status will be replaced with 404 and a
172−-- default not-found message will be served. If a partial file is requested,
173−-- the status will be replaced with 206 and the Content-Range header will be
174−-- added. The Content-Length header will always be added.
175−respondFile :: H.Status -> H.ResponseHeaders -> FilePath -> H.RequestHeaders -> Responder
176−respondFile s h path reqHdrs = Responder $ \k -> do
177− fileSize <- tryGetFileSize path
178− case fileSize of
179− Left _ -> runResponder (respondNotFound h) k
180− Right size -> runResponder (respondFileExists s h path size reqHdrs) k
181−
182−-- As 'respondFile', but with prior knowledge of the file's existence and size.
183−respondFileExists :: H.Status -> H.ResponseHeaders -> FilePath -> Integer -> H.RequestHeaders -> Responder
184−respondFileExists s h path size reqHdrs =
185− respondFilePart s h path $ chooseFilePart size $ lookup H.hRange reqHdrs
186−
187−-- | Respond with a minimal 404 page with the given headers.
188−respondNotFound :: H.ResponseHeaders -> Responder
189−respondNotFound h = Responder $ \k -> k H.notFound404 h' $
190− streamBuilder $ fromByteString "File not found."
191− where
192− contentType = (H.hContentType, "text/plain; charset=utf-8")
193− h' = contentType:filter ((/=H.hContentType) . fst) h
194−
195−-- | Construct a 'Responder' that will just call the 'RespondFunc' with the
196−-- given arguments.
197−respond :: H.Status -> H.ResponseHeaders -> Body -> Responder
198−respond s h b = Responder $ \k -> k s h b
199−
200−-- | Fold the given bracketing action into a 'Responder'. Note the first
201−-- argument is isomorphic to @Codensity IO a@ or @forall s. ContT s IO a@, and
202−-- is the type of a partially-applied 'Control.Exception.bracket' or
203−-- @with@-style function.
204−--
205−-- > respondWith (bracket acquire release) $
206−-- > \x -> respondNotFound [("x", show x)]
207−--
208−-- is equivalent to
209−--
210−-- > Responder $ \k -> bracket acquire release $
211−-- > \x -> runResponder (respondNotFound [("x", show x)] k
212−--
213−-- This is morally equivalent to ('>>=') on 'Codensity' 'IO'.
214−respondWith :: (forall s. (a -> IO s) -> IO s) -> (a -> Responder) -> Responder
215−respondWith with f = respondCont $ f <$> ContT with
216−
217−-- | Fold the 'ContT' into the contained 'Responder'.
218−respondCont :: (forall r. ContT r IO Responder) -> Responder
219−respondCont cont = Responder $ \k -> runContT cont $ \r -> runResponder r k
220−
221−-- | Fold the 'IO' into the contained 'Responder'.
222−respondIO :: IO Responder -> Responder
223−respondIO io = Responder $ \k -> io >>= \r -> runResponder r k
224−
225−-- | Create a response body consisting of a single builder.
226−streamBuilder :: Builder -> Body
227−streamBuilder builder write _ = write (BuilderChunk builder) >> return []
228−
229−-- | Create a response body of a stream of 'Builder's.
230−streamSimple :: StreamingBody -> Body
231−streamSimple body write flush = body (write . BuilderChunk) flush >> return []
232−
233−-- | Use a normal WAI 'Response' to send the response. Useful if you're
234−-- sharing code between HTTP\/2 applications and HTTP\/1 applications.
235−--
236−-- The 'Request' is used to determine the right file range to serve for
237−-- 'ResponseFile'.
238−promoteResponse :: Request -> Response -> Responder
239−promoteResponse req response = case response of
240− (ResponseBuilder s h b) ->
241− Responder $ \k -> k s h (streamBuilder b)
242− (ResponseStream s h body) ->
243− Responder $ \k -> k s h (streamSimple body)
244− (ResponseRaw _ fallback) -> promoteResponse req fallback
245− (ResponseFile s h path mpart) -> maybe
246− (respondFile s h path $ requestHeaders req)
247− (respondFilePart s h path)
248− mpart
249−
250−-- | An 'Network.Wai.Application' we tried to promote neither called its
251−-- respond action nor raised; this is only possible if it imported the
252−-- 'ResponseReceived' constructor and used it to lie about having called the
253−-- action.
254−data RespondNeverCalled = RespondNeverCalled deriving (Show, Typeable)
255−
256−instance Exception RespondNeverCalled
257−
258−-- | Promote a normal WAI 'Application' to an 'HTTP2Application' by ignoring
259−-- the HTTP/2-specific features.
260−promoteApplication :: Application -> HTTP2Application
261−promoteApplication app req _ = Responder $ \k -> do
262− -- In HTTP2Applications, the Responder is required to ferry a value of
263− -- arbitrary type from the RespondFunc back to the caller of the
264− -- application, but in Application the type is fixed to ResponseReceived.
265− -- To add this extra power to an Application, we have to squirrel it away
266− -- in an IORef as a hack.
267− ref <- newIORef Nothing
268− let k' r = do
269− writeIORef ref . Just =<< runResponder (promoteResponse req r) k
270− return ResponseReceived
271− ResponseReceived <- app req k'
272− readIORef ref >>= maybe (throwIO RespondNeverCalled) return
wai/Network/Wai/Internal.hs+18−104
@@ -1,36 +1,23 @@
11{-# OPTIONS_HADDOCK not-home #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
32{-# LANGUAGE CPP #-}
4−{-# LANGUAGE OverloadedStrings #-}
5−{-# LANGUAGE RankNTypes #-}
63{-# LANGUAGE RecordWildCards #-}
74-- | Internal constructors and helper functions. Note that no guarantees are
85-- given for stability of these interfaces.
96module Network.Wai.Internal where
107
11−import Blaze.ByteString.Builder (Builder)
12−import Control.Exception (IOException, try)
8+import Data.ByteString.Builder (Builder)
139import qualified Data.ByteString as B hiding (pack)
14−import qualified Data.ByteString.Builder as B
15−import qualified Data.ByteString.Char8 as B (pack, readInteger)
16−import qualified Data.ByteString.Lazy as L
17−#if __GLASGOW_HASKELL__ < 709
18−import Data.Functor ((<$>))
19−#endif
20−import Data.Maybe (listToMaybe)
2110import Data.Text (Text)
2211import Data.Typeable (Typeable)
2312import Data.Vault.Lazy (Vault)
2413import Data.Word (Word64)
2514import qualified Network.HTTP.Types as H
26−import qualified Network.HTTP.Types.Header as HH
2715import Network.Socket (SockAddr)
28−import Numeric (showInt)
2916import Data.List (intercalate)
30−import qualified System.PosixCompat.Files as P
3117
3218-- | Information on the request sent by the client. This abstracts away the
3319-- 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." #-}
3421data Request = Request {
3522 -- | Request method such as GET.
3623 requestMethod :: H.Method
@@ -76,7 +63,7 @@ data Request = Request {
7663 -- | Parsed query string information.
7764 , queryString :: H.Query
7865 -- | Get the next chunk of the body. Returns 'B.empty' when the
79− -- body is fully consumed.
66+ -- body is fully consumed. Since 3.2.2, this is deprecated in favor of 'getRequestBodyChunk'.
8067 , requestBody :: IO B.ByteString
8168 -- | A location for arbitrary data to be shared by applications and middleware.
8269 , vault :: Vault
@@ -93,9 +80,24 @@ data Request = Request {
9380 --
9481 -- Since 2.0.0
9582 , 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
9691 }
9792 deriving (Typeable)
9893
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+
99101instance Show Request where
100102 show Request{..} = "Request {" ++ intercalate ", " [a ++ " = " ++ b | (a,b) <- fields] ++ "}"
101103 where
@@ -157,91 +159,3 @@ data FilePart = FilePart
157159-- Since 3.0.0
158160data ResponseReceived = ResponseReceived
159161 deriving Typeable
160−
161−-- | Look up the size of a file in 'Right' or the 'IOException' in 'Left'.
162−tryGetFileSize :: FilePath -> IO (Either IOException Integer)
163−tryGetFileSize path =
164− fmap (fromIntegral . P.fileSize) <$> try (P.getFileStatus path)
165−
166−-- | \"Content-Range\".
167−hContentRange :: H.HeaderName
168−hContentRange = "Content-Range"
169−
170−-- | \"Accept-Ranges\".
171−hAcceptRanges :: H.HeaderName
172−hAcceptRanges = "Accept-Ranges"
173−
174−-- | @contentRangeHeader beg end total@ constructs a Content-Range 'H.Header'
175−-- for the range specified.
176−contentRangeHeader :: Integer -> Integer -> Integer -> H.Header
177−contentRangeHeader beg end total = (hContentRange, range)
178− where
179− range = B.pack
180− -- building with ShowS
181− $ 'b' : 'y': 't' : 'e' : 's' : ' '
182− : (if beg > end then ('*':) else
183− showInt beg
184− . ('-' :)
185− . showInt end)
186− ( '/'
187− : showInt total "")
188−
189−-- | Given the full size of a file and optionally a Range header value,
190−-- determine the range to serve by parsing the range header and obeying it, or
191−-- serving the whole file if it's absent or malformed.
192−chooseFilePart :: Integer -> Maybe B.ByteString -> FilePart
193−chooseFilePart size Nothing = FilePart 0 size size
194−chooseFilePart size (Just range) = case parseByteRanges range >>= listToMaybe of
195− -- Range is broken
196− Nothing -> FilePart 0 size size
197− Just hrange -> checkRange hrange
198− where
199− checkRange (H.ByteRangeFrom beg) = fromRange beg (size - 1)
200− checkRange (H.ByteRangeFromTo beg end) = fromRange beg (min (size - 1) end)
201− checkRange (H.ByteRangeSuffix count) = fromRange (max 0 (size - count)) (size - 1)
202−
203− fromRange beg end = FilePart beg (end - beg + 1) size
204−
205−-- | Adjust the given 'H.Status' and 'H.ResponseHeaders' based on the given
206−-- 'FilePart'. This means replacing the status with 206 if the response is
207−-- partial, and adding the Content-Length and Accept-Ranges (always) and
208−-- Content-Range (if appropriate) headers.
209−adjustForFilePart :: H.Status -> H.ResponseHeaders -> FilePart -> (H.Status, H.ResponseHeaders)
210−adjustForFilePart s h part = (s', h'')
211− where
212− off = filePartOffset part
213− len = filePartByteCount part
214− size = filePartFileSize part
215−
216− contentRange = contentRangeHeader off (off + len - 1) size
217− lengthBS = L.toStrict $ B.toLazyByteString $ B.integerDec len
218− s' = if filePartByteCount part /= size then H.partialContent206 else s
219− h' = (H.hContentLength, lengthBS):(hAcceptRanges, "bytes"):h
220− h'' = (if len == size then id else (contentRange:)) h'
221−
222−-- | Parse the value of a Range header into a 'HH.ByteRanges'.
223−parseByteRanges :: B.ByteString -> Maybe HH.ByteRanges
224−parseByteRanges bs1 = do
225− bs2 <- stripPrefix "bytes=" bs1
226− (r, bs3) <- range bs2
227− ranges (r:) bs3
228− where
229− range bs2 = do
230− (i, bs3) <- B.readInteger bs2
231− if i < 0 -- has prefix "-" ("-0" is not valid, but here treated as "0-")
232− then Just (HH.ByteRangeSuffix (negate i), bs3)
233− else do
234− bs4 <- stripPrefix "-" bs3
235− case B.readInteger bs4 of
236− Just (j, bs5) | j >= i -> Just (HH.ByteRangeFromTo i j, bs5)
237− _ -> Just (HH.ByteRangeFrom i, bs4)
238− ranges front bs3
239− | B.null bs3 = Just (front [])
240− | otherwise = do
241− bs4 <- stripPrefix "," bs3
242− (r, bs5) <- range bs4
243− ranges (front . (r:)) bs5
244−
245− stripPrefix x y
246− | x `B.isPrefixOf` y = Just (B.drop (B.length x) y)
247− | otherwise = Nothing
wai/README.md+1−1
@@ -67,7 +67,7 @@ Basic dispatching
6767An `Application` maps `Request`s to `Response`s:
6868
6969 ghci> :info Application
70− type Application = Request -> IO Response
70+ type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
7171
7272Depending on the path info provided with each `Request` we can serve different `Response`s:
7373
wai/test/Network/WaiSpec.hs+7−9
@@ -3,12 +3,10 @@ module Network.WaiSpec (spec) where
33import Test.Hspec
44import Test.Hspec.QuickCheck (prop)
55import Network.Wai
6−import Network.Wai.Internal (Request (Request))
76import Data.IORef
8−import Data.Monoid
97import qualified Data.ByteString as S
108import qualified Data.ByteString.Lazy as L
11−import Blaze.ByteString.Builder (toByteString, Builder, fromWord8)
9+import Data.ByteString.Builder (Builder, toLazyByteString, word8)
1210import Control.Monad (forM_)
1311
1412spec :: Spec
@@ -24,17 +22,17 @@ spec = do
2422 flush :: IO ()
2523 flush = return ()
2624 streamingBody add flush
27− fmap toByteString $ readIORef builderRef
25+ fmap (L.toStrict . toLazyByteString) $ readIORef builderRef
2826 prop "responseLBS" $ \bytes -> do
2927 body <- getBody $ responseLBS undefined undefined $ L.pack bytes
3028 body `shouldBe` S.pack bytes
3129 prop "responseBuilder" $ \bytes -> do
3230 body <- getBody $ responseBuilder undefined undefined
33− $ mconcat $ map fromWord8 bytes
31+ $ mconcat $ map word8 bytes
3432 body `shouldBe` S.pack bytes
3533 prop "responseStream" $ \chunks -> do
3634 body <- getBody $ responseStream undefined undefined $ \sendChunk _ ->
37− forM_ chunks $ \chunk -> sendChunk $ mconcat $ map fromWord8 chunk
35+ forM_ chunks $ \chunk -> sendChunk $ mconcat $ map word8 chunk
3836 body `shouldBe` S.concat (map S.pack chunks)
3937 it "responseFile total" $ do
4038 let fp = "wai.cabal"
@@ -57,7 +55,7 @@ spec = do
5755 describe "lazyRequestBody" $ do
5856 prop "works" $ \chunks -> do
5957 ref <- newIORef $ map S.pack $ filter (not . null) chunks
60− let req = Request
58+ let req = defaultRequest
6159 { requestBody = atomicModifyIORef ref $ \bss ->
6260 case bss of
6361 [] -> ([], S.empty)
@@ -66,7 +64,7 @@ spec = do
6664 body <- lazyRequestBody req
6765 body `shouldBe` L.fromChunks (map S.pack chunks)
6866 it "is lazy" $ do
69− let req = Request
67+ let req = defaultRequest
7068 { requestBody = error "requestBody"
7169 }
7270 _ <- lazyRequestBody req
@@ -74,7 +72,7 @@ spec = do
7472 describe "strictRequestBody" $ do
7573 prop "works" $ \chunks -> do
7674 ref <- newIORef $ map S.pack $ filter (not . null) chunks
77− let req = Request
75+ let req = defaultRequest
7876 { requestBody = atomicModifyIORef ref $ \bss ->
7977 case bss of
8078 [] -> ([], S.empty)
wai/wai.cabal+8−12
@@ -1,8 +1,9 @@
11Name: wai
2−Version: 3.0.5.0
2+Version: 3.2.2.1
33Synopsis: Web Application Interface.
44Description: Provides a common protocol for communication between web applications and web servers.
5−description: API docs and the README are available at <http://www.stackage.org/package/wai>.
5+ .
6+ API docs and the README are available at <http://www.stackage.org/package/wai>.
67License: MIT
78License-file: LICENSE
89Author: Michael Snoyman
@@ -19,18 +20,13 @@ Source-repository head
1920 location: git://github.com/yesodweb/wai.git
2021
2122Library
22− Build-Depends: base >= 4 && < 5
23− , bytestring >= 0.10
24− , bytestring-builder >= 0.10.4.0 && < 0.10.7
25− , blaze-builder >= 0.2.1.4 && < 0.5
23+ Build-Depends: base >= 4.8 && < 5
24+ , bytestring >= 0.10.4
2625 , network >= 2.2.1.5
2726 , http-types >= 0.7
2827 , text >= 0.7
29− , transformers >= 0.0
30− , unix-compat >= 0.2
3128 , vault >= 0.3 && < 0.4
3229 Exposed-modules: Network.Wai
33− Network.Wai.HTTP2
3430 Network.Wai.Internal
3531 ghc-options: -Wall
3632
@@ -38,14 +34,14 @@ test-suite test
3834 hs-source-dirs: test
3935 main-is: Spec.hs
4036 type: exitcode-stdio-1.0
41− ghc-options: -threaded
37+ ghc-options: -threaded -Wall
4238 cpp-options: -DTEST
43− build-depends: base
39+ build-depends: base >= 4.8 && < 5
4440 , wai
4541 , hspec
46− , blaze-builder
4742 , bytestring
4843 other-modules: Network.WaiSpec
44+ build-tool-depends: hspec-discover:hspec-discover
4945
5046source-repository head
5147 type: git
wai/webkit-sample/webkit-sample.hs+2−2
@@ -5,7 +5,7 @@ import Network.Wai.Handler.Webkit
55import Data.ByteString (ByteString)
66import qualified Data.ByteString.Lazy as L
77import Data.Enumerator (consume, Iteratee)
8−import Blaze.ByteString.Builder (fromLazyByteString)
8+import Data.ByteString.Builder (lazyByteString)
99
1010main :: IO ()
1111main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
@@ -27,4 +27,4 @@ postResponse :: L.ByteString -> Iteratee ByteString IO Response
2727postResponse lbs = return $ ResponseBuilder
2828 status200
2929 [("Content-Type", "text/plain")]
30− (fromLazyByteString lbs)
30+ (lazyByteString lbs)
warp-tls/ChangeLog.md+61
@@ -1,3 +1,64 @@
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+
162## 3.1.4
263
364* Add an option to disable HTTP2 [#450](https://github.com/yesodweb/wai/pull/450)
warp-tls/Network/Wai/Handler/WarpTLS.hs+142−99
@@ -4,7 +4,6 @@
44{-# LANGUAGE RecordWildCards #-}
55{-# LANGUAGE DeriveDataTypeable #-}
66{-# LANGUAGE PatternGuards #-}
7−{-# LANGUAGE CPP #-}
87
98-- | HTTP over TLS support for Warp via the TLS package.
109--
@@ -30,37 +29,39 @@ module Network.Wai.Handler.WarpTLS (
3029 , tlsCiphers
3130 , tlsWantClientCert
3231 , tlsServerHooks
32+ , tlsServerDHEParams
33+ , tlsSessionManagerConfig
3334 , onInsecure
3435 , OnInsecure (..)
3536 -- * Runner
3637 , runTLS
3738 , runTLSSocket
38− , runHTTP2TLS
39− , runHTTP2TLSSocket
4039 -- * Exception
4140 , WarpTLSException (..)
41+ , DH.Params
42+ , DH.generateParams
4243 ) where
4344
44−#if __GLASGOW_HASKELL__ < 709
45−import Control.Applicative ((<$>))
46−#endif
4745import Control.Applicative ((<|>))
48−import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..))
46+import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..), handleJust)
4947import qualified Control.Exception as E
50−import Control.Monad (void)
51−import qualified Crypto.Random.AESCtr
48+import Control.Monad (void, guard)
5249import qualified Data.ByteString as S
5350import qualified Data.ByteString.Lazy as L
5451import Data.Default.Class (def)
5552import qualified Data.IORef as I
5653import Data.Streaming.Network (bindPortTCP, safeRecv)
5754import Data.Typeable (Typeable)
58−import Network.Socket (Socket, sClose, withSocketsDo, SockAddr, accept)
55+import Network.Socket (Socket, close, withSocketsDo, SockAddr, accept)
56+#if MIN_VERSION_network(3,1,1)
57+import Network.Socket (gracefulClose)
58+#endif
5959import Network.Socket.ByteString (sendAll)
6060import qualified Network.TLS as TLS
61+import qualified Crypto.PubKey.DH as DH
6162import qualified Network.TLS.Extra as TLSExtra
63+import qualified Network.TLS.SessionManager as SM
6264import Network.Wai (Application)
63−import Network.Wai.HTTP2 (HTTP2Application)
6465import Network.Wai.Handler.Warp
6566import Network.Wai.Handler.Warp.Internal
6667import System.IO.Error (isEOFError)
@@ -92,19 +93,37 @@ data TLSSettings = TLSSettings {
9293 --
9394 -- Since 1.4.0
9495 , 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
95104 -- ^ The TLS versions this server accepts.
96105 --
97106 -- >>> tlsAllowedVersions defaultTlsSettings
98107 -- [TLS12,TLS11,TLS10]
99108 --
100109 -- Since 1.4.2
110+#endif
101111 , tlsCiphers :: [TLS.Cipher]
112+#if MIN_VERSION_tls(1,5,0)
102113 -- ^ The TLS ciphers this server accepts.
103114 --
104115 -- >>> tlsCiphers defaultTlsSettings
105− -- [ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256-SHA256,DHE-RSA-AES128-SHA256,DHE-RSA-AES256-SHA1,DHE-RSA-AES128-SHA1,DHE-DSA-AES128-SHA1,DHE-DSA-AES256-SHA1,RSA-aes128-sha1,RSA-aes256-sha1]
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]
106117 --
107118 -- 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
108127 , tlsWantClientCert :: Bool
109128 -- ^ Whether or not to demand a certificate from the client. If this
110129 -- is set to True, you must handle received certificates in a server hook
@@ -122,6 +141,22 @@ data TLSSettings = TLSSettings {
122141 -- Default: def
123142 --
124143 -- 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
125160 }
126161
127162-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name (aka accessors).
@@ -135,28 +170,21 @@ defaultTlsSettings = TLSSettings {
135170 , keyMemory = Nothing
136171 , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
137172 , tlsLogging = def
173+#if MIN_VERSION_tls(1,5,0)
174+ , tlsAllowedVersions = [TLS.TLS13,TLS.TLS12,TLS.TLS11,TLS.TLS10]
175+#else
138176 , tlsAllowedVersions = [TLS.TLS12,TLS.TLS11,TLS.TLS10]
177+#endif
139178 , tlsCiphers = ciphers
140179 , tlsWantClientCert = False
141180 , tlsServerHooks = def
181+ , tlsServerDHEParams = Nothing
182+ , tlsSessionManagerConfig = Nothing
142183 }
143184
144185-- taken from stunnel example in tls-extra
145186ciphers :: [TLS.Cipher]
146−ciphers =
147− [ TLSExtra.cipher_ECDHE_RSA_AES128GCM_SHA256
148− , TLSExtra.cipher_ECDHE_RSA_AES128CBC_SHA256
149− , TLSExtra.cipher_ECDHE_RSA_AES128CBC_SHA
150− , TLSExtra.cipher_DHE_RSA_AES128GCM_SHA256
151− , TLSExtra.cipher_DHE_RSA_AES256_SHA256
152− , TLSExtra.cipher_DHE_RSA_AES128_SHA256
153− , TLSExtra.cipher_DHE_RSA_AES256_SHA1
154− , TLSExtra.cipher_DHE_RSA_AES128_SHA1
155− , TLSExtra.cipher_DHE_DSS_AES128_SHA1
156− , TLSExtra.cipher_DHE_DSS_AES256_SHA1
157− , TLSExtra.cipher_AES128_SHA1
158− , TLSExtra.cipher_AES256_SHA1
159− ]
187+ciphers = TLSExtra.ciphersuite_strong
160188
161189----------------------------------------------------------------
162190
@@ -221,39 +249,20 @@ tlsSettingsChainMemory cert chainCerts key = defaultTlsSettings
221249
222250----------------------------------------------------------------
223251
224−-- Composition over two arguments at once; used for runHTTP2\*.
225−(.:) :: (c -> d) -> (a -> b -> c) -> a -> b -> d
226−f .: g = curry $ f . uncurry g
227−
228252-- | Running 'Application' with 'TLSSettings' and 'Settings'.
229253runTLS :: TLSSettings -> Settings -> Application -> IO ()
230−runTLS tset set = runServeTLS tset set . serveDefault
231−
232−-- | Run an HTTP\/2-aware server with 'TLSSettings' and 'Settings'.
233−runHTTP2TLS :: TLSSettings -> Settings -> HTTP2Application -> Application -> IO ()
234−runHTTP2TLS tset set = runServeTLS tset set .: serveHTTP2
235−
236−runServeTLS :: TLSSettings -> Settings -> ServeConnection -> IO ()
237−runServeTLS tset set serve = withSocketsDo $
254+runTLS tset set app = withSocketsDo $
238255 bracket
239256 (bindPortTCP (getPort set) (getHost set))
240− sClose
241− (\sock -> runServeTLSSocket tset set sock serve)
257+ close
258+ (\sock -> runTLSSocket tset set sock app)
242259
243260----------------------------------------------------------------
244261
245262-- | Running 'Application' with 'TLSSettings' and 'Settings' using
246263-- specified 'Socket'.
247264runTLSSocket :: TLSSettings -> Settings -> Socket -> Application -> IO ()
248−runTLSSocket tset set sock = runServeTLSSocket tset set sock . serveDefault
249−
250−-- | Run an HTTP\/2-aware server with 'TLSSettings' and 'Settings' using
251−-- specified 'Socket'.
252−runHTTP2TLSSocket :: TLSSettings -> Settings -> Socket -> HTTP2Application -> Application -> IO ()
253−runHTTP2TLSSocket tset set sock = runServeTLSSocket tset set sock .: serveHTTP2
254−
255−runServeTLSSocket :: TLSSettings -> Settings -> Socket -> ServeConnection -> IO ()
256−runServeTLSSocket tlsset@TLSSettings{..} set sock serve = do
265+runTLSSocket tlsset@TLSSettings{..} set sock app = do
257266 credential <- case (certMemory, keyMemory) of
258267 (Nothing, Nothing) ->
259268 either error id <$>
@@ -263,20 +272,26 @@ runServeTLSSocket tlsset@TLSSettings{..} set sock serve = do
263272 key <- maybe (S.readFile keyFile) return mkey
264273 either error return $
265274 TLS.credentialLoadX509ChainFromMemory cert chainCertsMemory key
266− runServeTLSSocket' tlsset set credential sock serve
267−
268−runServeTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> Socket -> ServeConnection -> IO ()
269−runServeTLSSocket' tlsset@TLSSettings{..} set credential sock serve =
270− runServeSettingsConnectionMakerSecure set get serve
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
271283 where
272− get = getter tlsset sock params
273− params = TLS.ServerParams {
284+ get = getter tlsset set sock params
285+ params = def { -- TLS.ServerParams
274286 TLS.serverWantClientCert = tlsWantClientCert
275287 , TLS.serverCACertificates = []
276− , TLS.serverDHEParams = Nothing
288+ , TLS.serverDHEParams = tlsServerDHEParams
277289 , TLS.serverHooks = hooks
278290 , TLS.serverShared = shared
279291 , TLS.serverSupported = supported
292+#if MIN_VERSION_tls(1,5,0)
293+ , TLS.serverEarlyDataSize = 2018
294+#endif
280295 }
281296 -- Adding alpn to user's tlsServerHooks.
282297 hooks = tlsServerHooks {
@@ -284,94 +299,104 @@ runServeTLSSocket' tlsset@TLSSettings{..} set credential sock serve =
284299 (if settingsHTTP2Enabled set then Just alpn else Nothing)
285300 }
286301 shared = def {
287− TLS.sharedCredentials = TLS.Credentials [credential]
302+ TLS.sharedCredentials = TLS.Credentials [credential]
303+ , TLS.sharedSessionManager = mgr
288304 }
289− supported = TLS.Supported {
305+ supported = def { -- TLS.Supported
290306 TLS.supportedVersions = tlsAllowedVersions
291307 , TLS.supportedCiphers = tlsCiphers
292308 , TLS.supportedCompressions = [TLS.nullCompression]
293− , TLS.supportedHashSignatures = [
294− -- Safari 8 and go tls have bugs on SHA 512 and SHA 384.
295− -- So, we don't specify them here at this moment.
296− (TLS.HashSHA256, TLS.SignatureRSA)
297− , (TLS.HashSHA224, TLS.SignatureRSA)
298− , (TLS.HashSHA1, TLS.SignatureRSA)
299− , (TLS.HashSHA1, TLS.SignatureDSS)
300− ]
301309 , TLS.supportedSecureRenegotiation = True
302310 , TLS.supportedClientInitiatedRenegotiation = False
303311 , TLS.supportedSession = True
304312 , TLS.supportedFallbackScsv = True
313+#if MIN_VERSION_tls(1,5,0)
314+ , TLS.supportedGroups = [TLS.X25519,TLS.P256,TLS.P384]
315+#endif
305316 }
306317
307318alpn :: [S.ByteString] -> IO S.ByteString
308319alpn xs
309320 | "h2" `elem` xs = return "h2"
310− | "h2-16" `elem` xs = return "h2-16"
311− | "h2-15" `elem` xs = return "h2-15"
312− | "h2-14" `elem` xs = return "h2-14"
313321 | otherwise = return "http/1.1"
314322
315323----------------------------------------------------------------
316324
317−getter :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (IO (Connection, Transport), SockAddr)
318−getter tlsset@TLSSettings{..} sock params = do
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
319330 (s, sa) <- accept sock
320− return (mkConn tlsset s params, sa)
331+#endif
332+ setSocketCloseOnExec s
333+ return (mkConn tlsset set s params, sa)
321334
322−mkConn :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (Connection, Transport)
323−mkConn tlsset s params = do
324− firstBS <- safeRecv s 4096
325− (if not (S.null firstBS) && S.head firstBS == 0x16 then
326− httpOverTls tlsset s firstBS params
327− else
328− plainHTTP tlsset s firstBS) `onException` sClose s
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
329344
330345----------------------------------------------------------------
331346
332−httpOverTls :: TLS.TLSParams params => TLSSettings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
333−httpOverTls TLSSettings{..} s bs0 params = do
347+httpOverTls :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
348+httpOverTls TLSSettings{..} _set s bs0 params = do
334349 recvN <- makePlainReceiveN s bs0
335−#if MIN_VERSION_tls(1,3,0)
336350 ctx <- TLS.contextNew (backend recvN) params
337−#else
338− gen <- Crypto.Random.AESCtr.makeSystem
339− ctx <- TLS.contextNew (backend recvN) params gen
340−#endif
341351 TLS.contextHookSetLogging ctx tlsLogging
342352 TLS.handshake ctx
353+ h2 <- (== Just "h2") <$> TLS.getNegotiatedProtocol ctx
354+ isH2 <- I.newIORef h2
343355 writeBuf <- allocateBuffer bufferSize
344356 -- Creating a cache for leftover input data.
345357 ref <- I.newIORef ""
346358 tls <- getTLSinfo ctx
347− return (conn ctx writeBuf ref, tls)
359+ return (conn ctx writeBuf ref isH2, tls)
348360 where
349361 backend recvN = TLS.Backend {
350362 TLS.backendFlush = return ()
351− , TLS.backendClose = sClose s
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
352368 , TLS.backendSend = sendAll' s
353369 , TLS.backendRecv = recvN
354370 }
355371 sendAll' sock bs = sendAll sock bs `E.catch` \(SomeException _) ->
356372 throwIO ConnectionClosedByPeer
357− conn ctx writeBuf ref = Connection {
373+ conn ctx writeBuf ref isH2 = Connection {
358374 connSendMany = TLS.sendData ctx . L.fromChunks
359375 , connSendAll = sendall
360376 , connSendFile = sendfile
361− , connClose = close
377+ , connClose = close'
378+ , connFree = freeBuffer writeBuf
362379 , connRecv = recv ref
363380 , connRecvBuf = recvBuf ref
364381 , connWriteBuffer = writeBuf
365382 , connBufferSize = bufferSize
383+ , connHTTP2 = isH2
366384 }
367385 where
368386 sendall = TLS.sendData ctx . L.fromChunks . return
369387 sendfile fid offset len hook headers =
370388 readSendFile writeBuf bufferSize sendall fid offset len hook headers
371389
372− close = freeBuffer writeBuf `finally`
373− void (tryIO $ TLS.bye ctx) `finally`
374− TLS.contextClose ctx
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)
375400
376401 -- TLS version of recv with a cache for leftover input data.
377402 -- The cache is shared with recvBuf.
@@ -440,11 +465,16 @@ getTLSinfo ctx = do
440465 TLS.TLS10 -> (3,1)
441466 TLS.TLS11 -> (3,2)
442467 TLS.TLS12 -> (3,3)
468+#if MIN_VERSION_tls(1,5,0)
469+ TLS.TLS13 -> (3,4)
470+#endif
471+ clientCert <- TLS.getClientCertificateChain ctx
443472 return TLS {
444473 tlsMajorVersion = major
445474 , tlsMinorVersion = minor
446475 , tlsNegotiatedProtocol = proto
447476 , tlsChiperID = TLS.cipherID infoCipher
477+ , tlsClientCertificate = clientCert
448478 }
449479
450480tryIO :: IO a -> IO (Either IOException a)
@@ -452,19 +482,32 @@ tryIO = try
452482
453483----------------------------------------------------------------
454484
455−plainHTTP :: TLSSettings -> Socket -> S.ByteString -> IO (Connection, Transport)
456−plainHTTP TLSSettings{..} s bs0 = case onInsecure of
485+plainHTTP :: TLSSettings -> Settings -> Socket -> S.ByteString -> IO (Connection, Transport)
486+plainHTTP TLSSettings{..} set s bs0 = case onInsecure of
457487 AllowInsecure -> do
458− conn' <- socketConnection s
488+ conn' <- socketConnection set s
459489 cachedRef <- I.newIORef bs0
460490 let conn'' = conn'
461491 { connRecv = recvPlain cachedRef (connRecv conn')
462492 }
463493 return (conn'', TCP)
464494 DenyInsecure lbs -> do
465− sendAll s "HTTP/1.1 200 OK\r\nContent-Type: text/plain\r\n\r\n"
495+ -- Listening port 443 but TLS records do not arrive.
496+ -- We want to let the browser know that TLS is required.
497+ -- So, we use 426.
498+ -- http://tools.ietf.org/html/rfc2817#section-4.2
499+ -- https://tools.ietf.org/html/rfc7231#section-6.5.15
500+ -- FIXME: should we distinguish HTTP/1.1 and HTTP/2?
501+ -- In the case of HTTP/2, should we send
502+ -- GOAWAY + INADEQUATE_SECURITY?
503+ -- FIXME: Content-Length:
504+ -- FIXME: TLS/<version>
505+ sendAll s "HTTP/1.1 426 Upgrade Required\
506+ \r\nUpgrade: TLS/1.0, HTTP/1.1\
507+ \r\nConnection: Upgrade\
508+ \r\nContent-Type: text/plain\r\n\r\n"
466509 mapM_ (sendAll s) $ L.toChunks lbs
467− sClose s
510+ close s
468511 throwIO InsecureConnectionDenied
469512
470513----------------------------------------------------------------
warp-tls/warp-tls.cabal+16−8
@@ -1,5 +1,5 @@
11Name: warp-tls
2−Version: 3.1.4
2+Version: 3.2.11
33Synopsis: HTTP over TLS support for Warp via the TLS package
44License: MIT
55License-file: LICENSE
@@ -8,26 +8,34 @@ Maintainer: michael@snoyman.com
88Homepage: http://github.com/yesodweb/wai
99Category: Web, Yesod
1010Build-Type: Simple
11−Cabal-Version: >=1.6
11+Cabal-Version: >= 1.10
1212Stability: Stable
13−description: Support for SSL is now obsoleted.
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).
1415 HTTP/2 can be negotiated by ALPN.
1516 API docs and the README are available at
1617 <http://www.stackage.org/package/warp-tls>.
1718extra-source-files: ChangeLog.md README.md
1819
1920Library
20− Build-Depends: base >= 4 && < 5
21+ Build-Depends: base >= 4.10 && < 5
2122 , bytestring >= 0.9
22− , wai >= 3.0.4 && < 3.1
23− , warp >= 3.1.7 && < 3.2
23+ , wai >= 3.2 && < 3.3
24+ , warp >= 3.3.6 && < 3.4
2425 , data-default-class >= 0.0.1
25− , tls >= 1.3.2
26+ , tls >= 1.5.3
27+ , cryptonite >= 0.12
2628 , network >= 2.2.1
27− , cprng-aes >= 0.5.0
2829 , streaming-commons
30+ , tls-session-manager >= 0.0.4
2931 Exposed-modules: Network.Wai.Handler.WarpTLS
3032 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+
3139
3240source-repository head
3341 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.md+249
@@ -1,3 +1,252 @@
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+
1250## 3.1.9
2251
3252* Using the new priority queue based on PSQ provided by http2 lib again.
warp/Network/Wai/Handler/Warp.hs+153−65
@@ -44,15 +44,6 @@ module Network.Wai.Handler.Warp (
4444 , runEnv
4545 , runSettings
4646 , runSettingsSocket
47− -- * Run an HTTP\/2-aware server
48− -- | Each of these takes an HTTP\/2-aware application as well as a backup
49− -- 'Application' to be used for HTTP\/1.1 and HTTP\/1 connections. These
50− -- are only needed if your application needs access to HTTP\/2-specific
51− -- features such as trailers or pushed streams.
52− , runHTTP2
53− , runHTTP2Env
54− , runHTTP2Settings
55− , runHTTP2SettingsSocket
5647 -- * Settings
5748 , Settings
5849 , defaultSettings
@@ -79,12 +70,20 @@ module Network.Wai.Handler.Warp (
7970 , setSlowlorisSize
8071 , setHTTP2Disabled
8172 , setLogger
73+ , setServerPushLogger
74+ , setGracefulShutdownTimeout
75+ , setGracefulCloseTimeout1
76+ , setGracefulCloseTimeout2
77+ , setMaxTotalHeaderLength
8278 -- ** Getters
8379 , getPort
8480 , getHost
8581 , getOnOpen
8682 , getOnClose
8783 , getOnException
84+ , getGracefulShutdownTimeout
85+ , getGracefulCloseTimeout1
86+ , getGracefulCloseTimeout2
8887 -- ** Exception handler
8988 , defaultOnException
9089 , defaultShouldDisplayException
@@ -92,74 +91,58 @@ module Network.Wai.Handler.Warp (
9291 , defaultOnExceptionResponse
9392 , exceptionResponseForDebug
9493 -- * Data types
95− , HostPreference (..)
94+ , HostPreference
9695 , Port
9796 , InvalidRequest (..)
9897 -- * Utilities
9998 , pauseTimeout
10099 , FileInfo(..)
101100 , getFileInfo
102− -- * Internal
103− -- | The following APIs will be removed in Warp 3.2.0. Please use ones exported from Network.Wai.Handler.Warp.Internal.
104−
105− -- ** Low level run functions
106− , runSettingsConnection
107− , runSettingsConnectionMaker
108− , runSettingsConnectionMakerSecure
109− , Transport (..)
110− -- ** Connection
111− , Connection (..)
112− , socketConnection
113− -- ** Buffer
114− , Buffer
115− , BufSize
116− , bufferSize
117− , allocateBuffer
118− , freeBuffer
119− -- ** Sendfile
120− , FileId (..)
121− , SendFile
122− , sendFile
123− , readSendFile
124− -- ** Version
101+ , clientCertificate
102+ , withApplication
103+ , withApplicationSettings
104+ , testWithApplication
105+ , testWithApplicationSettings
106+ , openFreePort
107+ -- * Version
125108 , warpVersion
126− -- ** Data types
127− , InternalInfo (..)
128− , HeaderValue
129− , IndexedHeader
130− , requestMaxIndex
131− -- ** File descriptor cache
132− , module Network.Wai.Handler.Warp.FdCache
133− -- ** Date
134− , module Network.Wai.Handler.Warp.Date
135− -- ** Request and response
136− , Source
137− , recvRequest
138− , sendResponse
139− -- ** Time out manager
140− , module Network.Wai.Handler.Warp.Timeout
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
141125 ) where
142126
143127import Control.Exception (SomeException, throwIO)
144−import Data.ByteString (ByteString)
145−import Data.Maybe (fromMaybe)
146128import Data.Streaming.Network (HostPreference)
147129import qualified Data.Vault.Lazy as Vault
130+import Data.X509
148131import qualified Network.HTTP.Types as H
149132import Network.Socket (SockAddr)
150133import Network.Wai (Request, Response, vault)
151−import Network.Wai.Handler.Warp.Buffer
152−import Network.Wai.Handler.Warp.Date
153−import Network.Wai.Handler.Warp.FdCache
134+import System.TimeManager
135+
154136import Network.Wai.Handler.Warp.FileInfoCache
155−import Network.Wai.Handler.Warp.Header
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
156140import Network.Wai.Handler.Warp.Request
157−import Network.Wai.Handler.Warp.Response
141+import Network.Wai.Handler.Warp.Response (warpVersion)
158142import Network.Wai.Handler.Warp.Run
159−import Network.Wai.Handler.Warp.SendFile
160143import Network.Wai.Handler.Warp.Settings
161−import Network.Wai.Handler.Warp.Timeout
162−import Network.Wai.Handler.Warp.Types
144+import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
145+import Network.Wai.Handler.Warp.WithApplication
163146
164147-- | Port to listen on. Default value: 3000
165148--
@@ -181,9 +164,18 @@ setOnException :: (Maybe Request -> SomeException -> IO ()) -> Settings -> Setti
181164setOnException x y = y { settingsOnException = x }
182165
183166-- | A function to create a `Response` when an exception occurs.
184−--
185167-- Default: 'defaultOnExceptionResponse'
186168--
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+--
187179-- Since 2.1.0
188180setOnExceptionResponse :: (SomeException -> Response) -> Settings -> Settings
189181setOnExceptionResponse x y = y { settingsOnExceptionResponse = x }
@@ -289,11 +281,39 @@ getOnClose = settingsOnClose
289281getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
290282getOnException = settingsOnException
291283
284+-- | Get the graceful shutdown timeout
285+--
286+-- Since 3.2.8
287+getGracefulShutdownTimeout :: Settings -> Maybe Int
288+getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
289+
292290-- | A code to install shutdown handler.
293291--
294292-- For instance, this code should set up a UNIX signal
295293-- handler. The handler should call the first argument,
296−-- which close the listen socket, at shutdown.
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'.
297317--
298318-- Default: does not install any code.
299319--
@@ -301,7 +321,10 @@ getOnException = settingsOnException
301321setInstallShutdownHandler :: (IO () -> IO ()) -> Settings -> Settings
302322setInstallShutdownHandler x y = y { settingsInstallShutdownHandler = x }
303323
304−-- | Default server name if application does not set one.
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.
305328--
306329-- Since 3.0.2
307330setServerName :: ByteString -> Settings -> Settings
@@ -362,7 +385,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
362385--
363386-- WARNING: This is contrary to the PROXY protocol specification and
364387-- using it can indicate a security problem with your
365−-- architecture if the web server is directly accessable
388+-- architecture if the web server is directly accessible
366389-- to the public, since it would allow easy IP address
367390-- spoofing. However, it can be useful in some cases,
368391-- such as if a load balancer health check uses regular
@@ -373,7 +396,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
373396setProxyProtocolOptional :: Settings -> Settings
374397setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
375398
376−-- | Size in bytes read to prevent Slowloris protection. Default value: 2048
399+-- | Size in bytes read to prevent Slowloris attacks. Default value: 2048
377400--
378401-- Since 3.1.2
379402setSlowlorisSize :: Int -> Settings -> Settings
@@ -388,10 +411,39 @@ setHTTP2Disabled y = y { settingsHTTP2Enabled = False }
388411-- | Setting a log function.
389412--
390413-- Since 3.X.X
391−setLogger :: (Request -> H.Status -> Maybe Integer -> IO ())
392− -> Settings -> Settings
414+setLogger :: (Request -> H.Status -> Maybe Integer -> IO ()) -- ^ request, status, maybe file-size
415+ -> Settings
416+ -> Settings
393417setLogger lgr y = y { settingsLogger = lgr }
394418
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+
395447-- | Explicitly pause the slowloris timeout.
396448--
397449-- This is useful for cases where you partially consume a request body. For
@@ -419,3 +471,39 @@ pauseTimeout = fromMaybe (return ()) . Vault.lookup pauseTimeoutKey . vault
419471-- Since 3.1.10
420472getFileInfo :: Request -> FilePath -> IO FileInfo
421473getFileInfo = 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.hs+4−2
@@ -1,4 +1,4 @@
1−{-# LANGUAGE BangPatterns, OverloadedStrings #-}
1+{-# LANGUAGE BangPatterns #-}
22
33module Network.Wai.Handler.Warp.Buffer (
44 bufferSize
@@ -13,13 +13,15 @@ module Network.Wai.Handler.Warp.Buffer (
1313 ) where
1414
1515import qualified Data.ByteString as BS
16−import Data.ByteString.Internal (ByteString(..), memcpy)
16+import Data.ByteString.Internal (memcpy)
1717import Data.ByteString.Unsafe (unsafeTake, unsafeDrop)
1818import Data.IORef (newIORef, readIORef, writeIORef)
1919import qualified Data.Streaming.ByteString.Builder.Buffer as B (Buffer (..))
2020import Foreign.ForeignPtr
2121import Foreign.Marshal.Alloc (mallocBytes, free, finalizerFree)
2222import Foreign.Ptr (castPtr, plusPtr)
23+
24+import Network.Wai.Handler.Warp.Imports
2325import Network.Wai.Handler.Warp.Types
2426
2527----------------------------------------------------------------
warp/Network/Wai/Handler/Warp/Conduit.hs+2−6
@@ -3,14 +3,10 @@
33module Network.Wai.Handler.Warp.Conduit where
44
55import Control.Exception
6−import Control.Monad (when, unless)
7−import Data.ByteString (ByteString)
86import qualified Data.ByteString as S
97import qualified Data.IORef as I
10−#if __GLASGOW_HASKELL__ < 709
11−import Data.Word (Word)
12−#endif
13−import Data.Word (Word8)
8+
9+import Network.Wai.Handler.Warp.Imports
1410import Network.Wai.Handler.Warp.Types
1511
1612----------------------------------------------------------------
warp/Network/Wai/Handler/Warp/Counter.hs+3−4
@@ -8,11 +8,10 @@ module Network.Wai.Handler.Warp.Counter (
88 , decrease
99 ) where
1010
11−#if __GLASGOW_HASKELL__ < 709
12−import Control.Applicative ((<$>))
13−#endif
1411import Control.Concurrent.STM
15−import Control.Monad (unless)
12+
13+import Network.Wai.Handler.Warp.Imports
14+
1615
1716newtype Counter = Counter (TVar Int)
1817
warp/Network/Wai/Handler/Warp/Date.hs+5−20
@@ -2,24 +2,16 @@
22
33module Network.Wai.Handler.Warp.Date (
44 withDateCache
5− , getDate
6− , DateCache
75 , GMTDate
8−#if WINDOWS
9− , uToH
10−#endif
116 ) where
127
13−#if __GLASGOW_HASKELL__ < 709
14−import Control.Applicative
15−#endif
168import Control.AutoUpdate (defaultUpdateSettings, updateAction, mkAutoUpdate)
17−import Data.ByteString.Char8
9+import Data.ByteString
1810import Network.HTTP.Date
1911
2012#if WINDOWS
21−import Data.Time (UTCTime, formatTime, getCurrentTime)
22−import Data.Time.Clock.POSIX (posixSecondsToUTCTime, utcTimeToPOSIXSeconds)
13+import Data.Time (UTCTime, getCurrentTime)
14+import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
2315import Foreign.C.Types (CTime(..))
2416#else
2517import System.Posix (epochTime)
@@ -28,22 +20,15 @@ import System.Posix (epochTime)
2820-- | The type of the Date header value.
2921type GMTDate = ByteString
3022
31−-- | The type of the cache of the Date header value.
32−type DateCache = IO GMTDate
33−
3423-- | Creating 'DateCache' and executing the action.
35−withDateCache :: (DateCache -> IO a) -> IO a
24+withDateCache :: (IO GMTDate -> IO a) -> IO a
3625withDateCache action = initialize >>= action
3726
38−initialize :: IO DateCache
27+initialize :: IO (IO GMTDate)
3928initialize = mkAutoUpdate defaultUpdateSettings {
4029 updateAction = formatHTTPDate <$> getCurrentHTTPDate
4130 }
4231
43−-- | Getting current 'GMTDate' based on 'DateCache'.
44−getDate :: DateCache -> IO GMTDate
45−getDate = id
46−
4732#ifdef WINDOWS
4833uToH :: UTCTime -> HTTPDate
4934uToH = epochTimeToHTTPDate . CTime . truncate . utcTimeToPOSIXSeconds
warp/Network/Wai/Handler/Warp/FdCache.hs+78−90
@@ -2,36 +2,46 @@
22
33-- | File descriptor cache to avoid locks in kernel.
44
5−#ifdef WINDOWS
65module Network.Wai.Handler.Warp.FdCache (
76 withFdCache
8− , MutableFdCache
7+ , Fd
98 , Refresh
9+#ifndef WINDOWS
10+ , openFile
11+ , closeFile
12+ , setFileCloseOnExec
13+#endif
1014 ) where
1115
16+#ifndef WINDOWS
17+import Control.Exception (bracket)
18+import Control.Reaper
19+import Data.IORef
20+import Network.Wai.Handler.Warp.MultiMap as MM
21+import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd, FdOption(CloseOnExec), setFdOption)
22+#endif
23+import System.Posix.Types (Fd)
24+
25+----------------------------------------------------------------
26+
27+-- | An action to activate a Fd cache entry.
1228type Refresh = IO ()
13−data MutableFdCache = MutableFdCache
1429
15−withFdCache :: Int -> (Maybe MutableFdCache -> IO a) -> IO a
16−withFdCache _ f = f Nothing
17−#else
18−module Network.Wai.Handler.Warp.FdCache (
19− withFdCache
20− , getFd
21− , MutableFdCache
22− , Refresh
23− ) where
30+getFdNothing :: FilePath -> IO (Maybe Fd, Refresh)
31+getFdNothing _ = return (Nothing, return ())
2432
25−#if __GLASGOW_HASKELL__ < 709
26−import Control.Applicative ((<$>), (<*>))
27−#endif
28−import Control.Exception (bracket)
29−import Data.Hashable (hash)
30−import Network.Wai.Handler.Warp.IORef
31−import Network.Wai.Handler.Warp.MultiMap
32−import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd)
33−import System.Posix.Types (Fd)
34−import Control.Reaper
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)
3545
3646----------------------------------------------------------------
3747
@@ -39,9 +49,6 @@ data Status = Active | Inactive
3949
4050newtype MutableStatus = MutableStatus (IORef Status)
4151
42−-- | An action to activate a Fd cache entry.
43−type Refresh = IO ()
44−
4552status :: MutableStatus -> IO Status
4653status (MutableStatus ref) = readIORef ref
4754
@@ -56,99 +63,80 @@ inactive (MutableStatus ref) = writeIORef ref Inactive
5663
5764----------------------------------------------------------------
5865
59−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
6076
6177newFdEntry :: FilePath -> IO FdEntry
62−newFdEntry path = FdEntry path
63− <$> openFd path ReadOnly Nothing defaultFileFlags{nonBlock=True}
64− <*> newActiveStatus
78+newFdEntry path = FdEntry <$> openFile path <*> newActiveStatus
79+
80+setFileCloseOnExec :: Fd -> IO ()
81+setFileCloseOnExec fd = setFdOption fd CloseOnExec True
6582
6683----------------------------------------------------------------
6784
68−type Hash = Int
69−type FdCache = MMap Hash FdEntry
85+type FdCache = MultiMap FdEntry
7086
7187-- | Mutable Fd cacher.
72−type MutableFdCache = Reaper FdCache (Hash, FdEntry)
88+newtype MutableFdCache = MutableFdCache (Reaper FdCache (FilePath,FdEntry))
7389
7490fdCache :: MutableFdCache -> IO FdCache
75−fdCache mfc = reaperRead mfc
91+fdCache (MutableFdCache reaper) = reaperRead reaper
7692
77−look :: MutableFdCache -> FilePath -> Hash -> IO (Maybe FdEntry)
78−look mfc path key = searchWith key check <$> fdCache mfc
79− where
80− check (One ent@(FdEntry path' _ _))
81− | path == path' = Just ent
82− | otherwise = Nothing
83− check (Tom ent@(FdEntry path' _ _) vs)
84− | path == path' = Just ent
85− | otherwise = check vs
86−
87−----------------------------------------------------------------
88−
89−-- | Creating 'MutableFdCache' and executing the action in the second
90−-- argument. The first argument is a cache duration in second.
91−withFdCache :: Int -> (Maybe MutableFdCache -> IO a) -> IO a
92−withFdCache duration action = bracket (initialize duration)
93− terminate
94− action
93+look :: MutableFdCache -> FilePath -> IO (Maybe FdEntry)
94+look mfc path = MM.lookup path <$> fdCache mfc
9595
9696----------------------------------------------------------------
9797
9898-- The first argument is a cache duration in second.
99−initialize :: Int -> IO (Maybe MutableFdCache)
100−initialize 0 = return Nothing
101−initialize duration = Just <$> mkReaper defaultReaperSettings
102− { reaperAction = clean
103− , reaperDelay = duration
104− , reaperCons = uncurry insert
105− , reaperNull = isEmpty
106− , reaperEmpty = empty
107− }
99+initialize :: Int -> IO MutableFdCache
100+initialize duration = MutableFdCache <$> mkReaper settings
101+ where
102+ settings = defaultReaperSettings {
103+ reaperAction = clean
104+ , reaperDelay = duration
105+ , reaperCons = uncurry insert
106+ , reaperNull = isEmpty
107+ , reaperEmpty = empty
108+ }
108109
109110clean :: FdCache -> IO (FdCache -> FdCache)
110111clean old = do
111112 new <- pruneWith old prune
112113 return $ merge new
113−
114−prune :: t -> Some FdEntry -> IO [(t, Some FdEntry)]
115−prune k v@(One (FdEntry _ fd mst)) = status mst >>= prune'
116− where
117− prune' Active = inactive mst >> return [(k,v)]
118− prune' Inactive = closeFd fd >> return []
119−prune k (Tom ent@(FdEntry _ fd mst) vs) = status mst >>= prune'
120114 where
121− prune' Active = do
122− inactive mst
123− zs <- prune k vs
124− case zs of
125− [] -> return [(k,One ent)]
126− [(_,zvs)] -> return [(k,Tom ent zvs)]
127− _ -> error "prune"
128− prune' Inactive = closeFd fd >> prune k vs
115+ prune (_,FdEntry fd mst) = status mst >>= act
116+ where
117+ act Active = inactive mst >> return True
118+ act Inactive = closeFd fd >> return False
129119
130120----------------------------------------------------------------
131121
132−terminate :: Maybe MutableFdCache -> IO ()
133−terminate Nothing = return ()
134−terminate (Just mfc) = do
135− !t <- reaperStop mfc
136− mapM_ closeIt $ toList t
122+terminate :: MutableFdCache -> IO ()
123+terminate (MutableFdCache reaper) = do
124+ !t <- reaperStop reaper
125+ mapM_ (closeIt . snd) $ toList t
137126 where
138− closeIt (_, FdEntry _ fd _) = closeFd fd
127+ closeIt (FdEntry fd _) = closeFd fd
139128
140129----------------------------------------------------------------
141130
142131-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
143−getFd :: MutableFdCache -> FilePath -> IO (Fd, Refresh)
144−getFd mfc path = look mfc path key >>= getFd'
132+getFd :: MutableFdCache -> FilePath -> IO (Maybe Fd, Refresh)
133+getFd mfc@(MutableFdCache reaper) path = look mfc path >>= get
145134 where
146− key = hash path
147− getFd' Nothing = do
148− ent@(FdEntry _ fd mst) <- newFdEntry path
149− reaperAdd mfc (key, ent)
150− return (fd, refresh mst)
151− getFd' (Just (FdEntry _ fd mst)) = do
135+ get Nothing = do
136+ ent@(FdEntry fd mst) <- newFdEntry path
137+ reaperAdd reaper (path,ent)
138+ return (Just fd, refresh mst)
139+ get (Just (FdEntry fd mst)) = do
152140 refresh mst
153− return (fd, refresh mst)
141+ return (Just fd, refresh mst)
154142#endif
warp/Network/Wai/Handler/Warp/File.hs+139−34
@@ -1,47 +1,152 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE TupleSections #-}
4−{-# LANGUAGE RankNTypes #-}
51{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
64
7−module Network.Wai.Handler.Warp.File where
5+module Network.Wai.Handler.Warp.File (
6+ RspFileInfo(..)
7+ , conditionalRequest
8+ , addContentHeadersForFilePart
9+ , H.parseByteRanges
10+ ) where
811
9−#if __GLASGOW_HASKELL__ < 709
10−import Control.Applicative
11−#endif
12−import Control.Exception
13−import Data.Maybe
12+import Data.Array ((!))
13+import qualified Data.ByteString.Char8 as C8 (pack)
14+import Network.HTTP.Date
1415import qualified Network.HTTP.Types as H
16+import qualified Network.HTTP.Types.Header as H
1517import Network.Wai
18+
1619import qualified Network.Wai.Handler.Warp.FileInfoCache as I
17−import Network.Wai.Handler.Warp.Types
18−import Network.Wai.Internal
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)
1933
2034----------------------------------------------------------------
2135
22−fileRange :: H.Status -> H.ResponseHeaders -> FilePath
23− -> Maybe FilePart -> Maybe HeaderValue
24− -> (FilePath -> IO I.FileInfo)
25− -> IO (Either IOException
26− (H.Status, H.ResponseHeaders, Integer, Integer))
27−fileRange s0 hs0 path Nothing mRange get = do
28− efinfo <- try (get path)
29− case efinfo of
30− Left e -> return $ Left e
31− Right finfo -> do
32− let ret = fileRangeSized s0 hs0 Nothing mRange $ I.fileInfoSize finfo
33− return $ Right ret
34−fileRange s0 hs0 _ mPart@(Just part) mRange _ =
35− return . Right $ fileRangeSized s0 hs0 mPart mRange size
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
3647 where
37− size = filePartFileSize part
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+----------------------------------------------------------------
3868
39−fileRangeSized :: H.Status -> H.ResponseHeaders
40− -> Maybe FilePart -> Maybe HeaderValue -> Integer
41− -> (H.Status, H.ResponseHeaders, Integer, Integer)
42−fileRangeSized s0 hs0 mPart mRange fileSize = (s, hs, beg, len)
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'
43137 where
44− part = fromMaybe (chooseFilePart fileSize mRange) mPart
45− beg = filePartOffset part
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
46151 len = filePartByteCount part
47− (s, hs) = adjustForFilePart s0 hs0 $ FilePart beg len fileSize
152+ size = filePartFileSize part
warp/Network/Wai/Handler/Warp/FileInfoCache.hs+21−19
@@ -7,18 +7,13 @@ module Network.Wai.Handler.Warp.FileInfoCache (
77 ) where
88
99import Control.Exception as E
10−import Control.Monad (void)
1110import Control.Reaper
12−import Data.ByteString (ByteString)
13−import Data.HashMap.Strict (HashMap)
14−import qualified Data.HashMap.Strict as M
1511import Network.HTTP.Date
1612import System.PosixCompat.Files
1713
18−#if WINDOWS
19−import Data.Time (UTCTime)
20−import Network.Wai.Handler.Warp.Date (uToH)
21−#endif
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
2217
2318----------------------------------------------------------------
2419
@@ -31,7 +26,7 @@ data FileInfo = FileInfo {
3126 } deriving (Eq, Show)
3227
3328data Entry = Negative | Positive FileInfo
34−type Cache = HashMap FilePath Entry
29+type Cache = HashMap Entry
3530type FileInfoCache = Reaper Cache (FilePath,Entry)
3631
3732----------------------------------------------------------------
@@ -56,6 +51,9 @@ getInfo path = do
5651 else
5752 throwIO (userError "FileInfoCache:getInfo")
5853
54+getInfoNaive :: FilePath -> IO FileInfo
55+getInfoNaive = getInfo
56+
5957----------------------------------------------------------------
6058
6159getAndRegisterInfo :: FileInfoCache -> FilePath -> IO FileInfo
@@ -64,7 +62,8 @@ getAndRegisterInfo reaper@Reaper{..} path = do
6462 case M.lookup path cache of
6563 Just Negative -> throwIO (userError "FileInfoCache:getAndRegisterInfo")
6664 Just (Positive x) -> return x
67− Nothing -> positive reaper path `E.onException` negative reaper path
65+ Nothing -> positive reaper path
66+ `E.onException` negative reaper path
6867
6968positive :: FileInfoCache -> FilePath -> IO FileInfo
7069positive Reaper{..} path = do
@@ -74,7 +73,7 @@ positive Reaper{..} path = do
7473
7574negative :: FileInfoCache -> FilePath -> IO FileInfo
7675negative Reaper{..} path = do
77− reaperAdd (path,Negative)
76+ reaperAdd (path, Negative)
7877 throwIO (userError "FileInfoCache:negative")
7978
8079----------------------------------------------------------------
@@ -82,20 +81,23 @@ negative Reaper{..} path = do
8281-- | Creating a file information cache
8382-- and executing the action in the second argument.
8483-- The first argument is a cache duration in second.
85−withFileInfoCache :: Int -> ((FilePath -> IO FileInfo) -> IO a) -> IO a
86−withFileInfoCache 0 action = action getInfo
87−withFileInfoCache duration action = E.bracket (initialize duration)
88− terminate
89− (\c -> action (getAndRegisterInfo c))
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)
9092
9193initialize :: Int -> IO FileInfoCache
9294initialize duration = mkReaper settings
9395 where
9496 settings = defaultReaperSettings {
9597 reaperAction = override
96− , reaperDelay = duration * 1000000
97− , reaperCons = uncurry M.insert
98− , reaperNull = M.null
98+ , reaperDelay = duration
99+ , reaperCons = \(path,v) -> M.insert path v
100+ , reaperNull = M.isEmpty
99101 , reaperEmpty = M.empty
100102 }
101103
warp/Network/Wai/Handler/Warp/HTTP2.hs+72−55
@@ -1,68 +1,85 @@
1−{-# LANGUAGE OverloadedStrings #-}
21{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
36
4−module Network.Wai.Handler.Warp.HTTP2 (isHTTP2, http2) where
7+module Network.Wai.Handler.Warp.HTTP2 (http2) where
58
6−import Control.Concurrent (forkIO, killThread)
9+import qualified Data.IORef as I
710import qualified Control.Exception as E
8−import Control.Monad (when, unless, replicateM_)
9−import Data.ByteString (ByteString)
10−
11−import Network.HTTP2
11+import qualified Network.HTTP2.Server as H2
1212import Network.Socket (SockAddr)
13+import Network.Wai
14+import Network.Wai.Internal (ResponseReceived(..))
15+import qualified System.TimeManager as T
1316
14−import Network.Wai.HTTP2 (HTTP2Application)
15−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
16−import Network.Wai.Handler.Warp.HTTP2.Manager
17−import Network.Wai.Handler.Warp.HTTP2.Receiver
17+import Network.Wai.Handler.Warp.HTTP2.File
18+import Network.Wai.Handler.Warp.HTTP2.PushPromise
1819import Network.Wai.Handler.Warp.HTTP2.Request
19−import Network.Wai.Handler.Warp.HTTP2.Sender
20−import Network.Wai.Handler.Warp.HTTP2.Types
21−import Network.Wai.Handler.Warp.HTTP2.Worker
22−import qualified Network.Wai.Handler.Warp.Settings as S (Settings)
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
2323import Network.Wai.Handler.Warp.Types
2424
2525----------------------------------------------------------------
2626
27−http2 :: Connection -> InternalInfo -> SockAddr -> Transport -> S.Settings -> (BufSize -> IO ByteString) -> HTTP2Application -> IO ()
28−http2 conn ii addr transport settings readN app = do
29− checkTLS
30− ok <- checkPreface
31− when ok $ do
32− ctx <- newContext
33− -- Workers & Manager
34− mgr <- start
35− let responder = response ctx mgr
36− action = worker ctx settings tm app responder
37− setAction mgr action
38− -- fixme: hard coding: 10
39− replicateM_ 10 $ spawnAction mgr
40− -- Receiver
41− let mkreq = mkRequest settings addr
42− tid <- forkIO $ frameReceiver ctx mkreq readN
43− -- Sender
44− -- frameSender is the main thread because it ensures to send
45− -- a goway frame.
46− frameSender ctx conn ii settings `E.finally` do
47− clearContext ctx
48− stop mgr
49− killThread tid
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
5030 where
51− tm = timeoutManager ii
52− checkTLS = case transport of
53− TCP -> return () -- direct
54− tls -> unless (tls12orLater tls) $ goaway conn InadequateSecurity "Weak TLS"
55− tls12orLater tls = tlsMajorVersion tls == 3 && tlsMinorVersion tls >= 3
56− checkPreface = do
57− preface <- readN connectionPrefaceLength
58− if connectionPreface /= preface then do
59− goaway conn ProtocolError "Preface mismatch"
60− return False
61− else
62− return True
31+ conf = H2.Config {
32+ confWriteBuffer = connWriteBuffer conn
33+ , confBufferSize = connBufferSize conn
34+ , confSendAll = send
35+ , confReadN = readN
36+ , confPositionReadMaker = pReadMaker ii
37+ }
6338
64−-- connClose must not be called here since Run:fork calls it
65−goaway :: Connection -> ErrorCodeId -> ByteString -> IO ()
66−goaway Connection{..} etype debugmsg = connSendAll bytestream
67− where
68− bytestream = goawayFrame 0 etype debugmsg
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/EncodeFrame.hsdeleted−35
@@ -1,35 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Network.Wai.Handler.Warp.HTTP2.EncodeFrame where
4−
5−import Data.ByteString (ByteString)
6−import Network.HTTP2
7−
8−----------------------------------------------------------------
9−
10−goawayFrame :: StreamId -> ErrorCodeId -> ByteString -> ByteString
11−goawayFrame sid etype debugmsg = encodeFrame einfo frame
12− where
13− einfo = encodeInfo id 0
14− frame = GoAwayFrame sid etype debugmsg
15−
16−resetFrame :: ErrorCodeId -> StreamId -> ByteString
17−resetFrame etype sid = encodeFrame einfo frame
18− where
19− einfo = encodeInfo id sid
20− frame = RSTStreamFrame etype
21−
22−settingsFrame :: (FrameFlags -> FrameFlags) -> SettingsList -> ByteString
23−settingsFrame func alist = encodeFrame einfo $ SettingsFrame alist
24− where
25− einfo = encodeInfo func 0
26−
27−pingFrame :: ByteString -> ByteString
28−pingFrame bs = encodeFrame einfo $ PingFrame bs
29− where
30− einfo = encodeInfo setAck 0
31−
32−windowUpdateFrame :: StreamId -> WindowSize -> ByteString
33−windowUpdateFrame sid winsiz = encodeFrame einfo $ WindowUpdateFrame winsiz
34− where
35− einfo = encodeInfo id sid
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/HPACK.hsdeleted−73
@@ -1,73 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE NamedFieldPuns #-}
3−
4−module Network.Wai.Handler.Warp.HTTP2.HPACK where
5−
6−import Control.Arrow (first)
7−import qualified Control.Exception as E
8−import qualified Data.ByteString as B
9−import Data.ByteString.Builder (Builder)
10−import qualified Data.ByteString.Char8 as B8
11−import Data.CaseInsensitive (foldedCase)
12−import Data.IORef (readIORef, writeIORef)
13−import Network.HPACK
14−import qualified Network.HTTP.Types as H
15−import Network.HTTP2
16−import Network.Wai.Handler.Warp.HTTP2.Types
17−import Network.Wai.Handler.Warp.Header
18−import Network.Wai.Handler.Warp.Response
19−import qualified Network.Wai.Handler.Warp.Settings as S
20−import Network.Wai.Handler.Warp.Types
21−
22−-- $setup
23−-- >>> :set -XOverloadedStrings
24−
25−-- Set-Cookie: contains only one cookie value.
26−-- So, we don't need to split it.
27−hpackEncodeHeader :: Context -> InternalInfo -> S.Settings -> H.Status
28− -> H.ResponseHeaders -> IO Builder
29−hpackEncodeHeader ctx ii settings s h = do
30− hdr1 <- addServerAndDate h
31− let hdr2 = (":status", status) : map (first foldedCase) hdr1
32− hpackEncodeRawHeaders ctx hdr2
33− where
34− status = B8.pack $ show $ H.statusCode $ s
35− dc = dateCacher ii
36− rspidxhdr = indexResponseHeader h
37− defServer = S.settingsServerName settings
38− addServerAndDate = addDate dc rspidxhdr . addServer defServer rspidxhdr
39−
40−hpackEncodeCIHeaders :: Context -> [H.Header] -> IO Builder
41−hpackEncodeCIHeaders ctx = hpackEncodeRawHeaders ctx . map (first foldedCase)
42−
43−hpackEncodeRawHeaders :: Context -> [(B.ByteString, B.ByteString)] -> IO Builder
44−hpackEncodeRawHeaders Context{encodeDynamicTable} hdr = do
45− ehdrtbl <- readIORef encodeDynamicTable
46− (ehdrtbl', builder) <- encodeHeaderBuilder defaultEncodeStrategy ehdrtbl hdr
47− writeIORef encodeDynamicTable ehdrtbl'
48− return builder
49−
50−----------------------------------------------------------------
51−
52−hpackDecodeHeader :: HeaderBlockFragment -> Context -> IO HeaderList
53−hpackDecodeHeader hdrblk Context{decodeDynamicTable} = do
54− hdrtbl <- readIORef decodeDynamicTable
55− (hdrtbl', hdr) <- decodeHeader hdrtbl hdrblk `E.onException` cleanup
56− writeIORef decodeDynamicTable hdrtbl'
57− return $ concatCookie hdr
58− where
59− cleanup = E.throwIO $ ConnectionError CompressionError "cannot decompress the header"
60−
61−-- |
62−--
63−-- >>> concatCookie [("foo","bar")]
64−-- [("foo","bar")]
65−-- >>> concatCookie [("cookie","a=b"),("foo","bar"),("cookie","c=d"),("cookie","e=f")]
66−-- [("foo","bar"),("cookie","a=b; c=d; e=f")]
67−concatCookie :: HeaderList -> HeaderList
68−concatCookie = collect []
69− where
70− collect cookies (("cookie",c):rest) = collect (cookies ++ [c]) rest
71− collect cookies (h:rest) = h : collect cookies rest
72− collect [] [] = []
73− collect cookies [] = [("cookie", B.intercalate "; " cookies)]
warp/Network/Wai/Handler/Warp/HTTP2/Manager.hsdeleted−86
@@ -1,86 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−
3−-- | A thread pool manager.
4−-- The manager has responsibility to spawn and kill
5−-- worker threads.
6−module Network.Wai.Handler.Warp.HTTP2.Manager (
7− Manager
8− , start
9− , setAction
10− , stop
11− , spawnAction
12− , replaceWithAction
13− ) where
14−
15−#if __GLASGOW_HASKELL__ < 709
16−import Control.Applicative
17−#endif
18−import Control.Concurrent
19−import Control.Concurrent.STM
20−import Control.Monad (void)
21−import Data.Set (Set)
22−import qualified Data.Set as Set
23−import Network.Wai.Handler.Warp.IORef
24−
25−----------------------------------------------------------------
26−
27−data Command = Stop | Spawn | Replace ThreadId
28−
29−data Manager = Manager (TQueue Command) (IORef (IO ()))
30−
31−-- | Starting a thread pool manager.
32−-- Its action is initially set to 'return ()' and should be set
33−-- by 'setAction'. This allows that the action can include
34−-- the manager itself.
35−start :: IO Manager
36−start = do
37− tset <- newThreadSet
38− q <- newTQueueIO
39− ref <- newIORef (return ())
40− void $ forkIO $ go q tset ref
41− return $ Manager q ref
42− where
43− go q tset ref = do
44− x <- atomically $ readTQueue q
45− case x of
46− Stop -> kill tset
47− Spawn -> next
48− Replace oldtid -> do
49− del tset oldtid
50− next
51− where
52− next = do
53− action <- readIORef ref
54− newtid <- forkIO action
55− add tset newtid
56− go q tset ref
57−
58−setAction :: Manager -> IO () -> IO ()
59−setAction (Manager _ ref) action = writeIORef ref action
60−
61−stop :: Manager -> IO ()
62−stop (Manager q _) = atomically $ writeTQueue q Stop
63−
64−spawnAction :: Manager -> IO ()
65−spawnAction (Manager q _) = atomically $ writeTQueue q Spawn
66−
67−replaceWithAction :: Manager -> ThreadId -> IO ()
68−replaceWithAction (Manager q _) tid = atomically $ writeTQueue q $ Replace tid
69−
70−----------------------------------------------------------------
71−
72−newtype ThreadSet = ThreadSet (IORef (Set ThreadId))
73−
74−newThreadSet :: IO ThreadSet
75−newThreadSet = ThreadSet <$> newIORef Set.empty
76−
77−add :: ThreadSet -> ThreadId -> IO ()
78−add (ThreadSet ref) tid =
79− atomicModifyIORef' ref (\set -> (Set.insert tid set, ()))
80−
81−del :: ThreadSet -> ThreadId -> IO ()
82−del (ThreadSet ref) tid =
83− atomicModifyIORef' ref (\set -> (Set.delete tid set, ()))
84−
85−kill :: ThreadSet -> IO ()
86−kill (ThreadSet ref) = Set.toList <$> readIORef ref >>= mapM_ killThread
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/Receiver.hsdeleted−345
@@ -1,345 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE NamedFieldPuns #-}
3−{-# LANGUAGE BangPatterns #-}
4−{-# LANGUAGE CPP #-}
5−{-# LANGUAGE PatternGuards #-}
6−
7−module Network.Wai.Handler.Warp.HTTP2.Receiver (frameReceiver) where
8−
9−#if __GLASGOW_HASKELL__ < 709
10−import Control.Applicative
11−#endif
12−import Control.Concurrent.STM
13−import qualified Control.Exception as E
14−import Control.Monad (when, unless, void)
15−import Data.ByteString (ByteString)
16−import qualified Data.ByteString as BS
17−import Data.Maybe (isJust)
18−import Network.HTTP2
19−import Network.HTTP2.Priority
20−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
21−import Network.Wai.Handler.Warp.HTTP2.HPACK
22−import Network.Wai.Handler.Warp.HTTP2.Request
23−import Network.Wai.Handler.Warp.HTTP2.Types
24−import Network.Wai.Handler.Warp.IORef
25−import Network.Wai.Handler.Warp.Types
26−
27−----------------------------------------------------------------
28−
29−frameReceiver :: Context -> MkReq -> (BufSize -> IO ByteString) -> IO ()
30−frameReceiver ctx mkreq recvN = loop `E.catch` sendGoaway
31− where
32− Context{ http2settings
33− , streamTable
34− , concurrency
35− , continued
36− , currentStreamId
37− , inputQ
38− , outputQ
39− } = ctx
40− sendGoaway e
41− | Just (ConnectionError err msg) <- E.fromException e = do
42− csid <- readIORef currentStreamId
43− let frame = goawayFrame csid err msg
44− enqueueControl outputQ 0 $ OGoaway frame
45− | otherwise = return ()
46−
47− sendReset err sid = do
48− let frame = resetFrame err sid
49− enqueueControl outputQ 0 $ OFrame frame
50−
51− loop = do
52− hd <- recvN frameHeaderLength
53− if BS.null hd then
54− enqueueControl outputQ 0 OFinish
55− else do
56− cont <- processStreamGuardingError $ decodeFrameHeader hd
57− when cont loop
58−
59− processStreamGuardingError (FrameHeaders, FrameHeader{streamId})
60− | isResponse streamId = E.throwIO $ ConnectionError ProtocolError "stream id should be odd"
61− processStreamGuardingError (FrameUnknown _, FrameHeader{payloadLength}) = do
62− mx <- readIORef continued
63− case mx of
64− Nothing -> do
65− -- ignoring unknown frame
66− consume payloadLength
67− return True
68− Just _ -> E.throwIO $ ConnectionError ProtocolError "unknown frame"
69− processStreamGuardingError (FramePushPromise, _) =
70− E.throwIO $ ConnectionError ProtocolError "push promise is not allowed"
71− processStreamGuardingError typhdr@(ftyp, header@FrameHeader{payloadLength}) = do
72− settings <- readIORef http2settings
73− case checkFrameHeader settings typhdr of
74− Left h2err -> case h2err of
75− StreamError err sid -> do
76− sendReset err sid
77− consume payloadLength
78− return True
79− connErr -> E.throwIO connErr
80− Right _ -> do
81− ex <- E.try $ controlOrStream ftyp header
82− case ex of
83− Left (StreamError err sid) -> do
84− sendReset err sid
85− return True
86− Left connErr -> E.throw connErr
87− Right cont -> return cont
88−
89− controlOrStream ftyp header@FrameHeader{streamId, payloadLength}
90− | isControl streamId = do
91− pl <- recvN payloadLength
92− control ftyp header pl ctx
93− | otherwise = do
94− checkContinued
95− strm@Stream{streamState,streamContentLength,streamPrecedence} <- getStream
96− pl <- recvN payloadLength
97− state <- readIORef streamState
98− state' <- stream ftyp header pl ctx state strm
99− case state' of
100− Open (NoBody hdr pri) -> do
101− resetContinued
102− case validateHeaders hdr of
103− Just vh -> do
104− when (isJust (vhCL vh) && vhCL vh /= Just 0) $
105− E.throwIO $ StreamError ProtocolError streamId
106− writeIORef streamPrecedence $ toPrecedence pri
107− writeIORef streamState HalfClosed
108− let req = mkreq vh (return "")
109− atomically $ writeTQueue inputQ $ Input strm req
110− Nothing -> E.throwIO $ StreamError ProtocolError streamId
111− Open (HasBody hdr pri) -> do
112− resetContinued
113− case validateHeaders hdr of
114− Just vh -> do
115− q <- newTQueueIO
116− writeIORef streamPrecedence $ toPrecedence pri
117− writeIORef streamState (Open (Body q))
118− writeIORef streamContentLength $ vhCL vh
119− readQ <- newReadBody q
120− bodySource <- mkSource readQ
121− let req = mkreq vh (readSource bodySource)
122− atomically $ writeTQueue inputQ $ Input strm req
123− Nothing -> E.throwIO $ StreamError ProtocolError streamId
124− s@(Open Continued{}) -> do
125− setContinued
126− writeIORef streamState s
127− s -> do -- Idle, Open Body, HalfClosed, Closed
128− resetContinued
129− writeIORef streamState s
130− return True
131− where
132− setContinued = writeIORef continued (Just streamId)
133− resetContinued = writeIORef continued Nothing
134− checkContinued = do
135− mx <- readIORef continued
136− case mx of
137− Nothing -> return ()
138− Just sid
139− | sid == streamId && ftyp == FrameContinuation -> return ()
140− | otherwise -> E.throwIO $ ConnectionError ProtocolError "continuation frame must follow"
141− getStream = do
142− mstrm0 <- search streamTable streamId
143− case mstrm0 of
144− Just strm0 -> do
145− when (ftyp == FrameHeaders) $ do
146− st <- readIORef $ streamState strm0
147− when (isHalfClosed st) $ E.throwIO $ ConnectionError StreamClosed "header must not be sent to half closed"
148− return strm0
149− Nothing -> do
150− when (ftyp `notElem` [FrameHeaders,FramePriority]) $
151− E.throwIO $ ConnectionError ProtocolError "this frame is not allowed in an idel stream"
152− when (ftyp == FrameHeaders) $ do
153− csid <- readIORef currentStreamId
154− if streamId <= csid then
155− E.throwIO $ ConnectionError ProtocolError "stream identifier must not decrease"
156− else
157− writeIORef currentStreamId streamId
158− cnt <- readIORef concurrency
159− when (cnt >= recommendedConcurrency) $ do
160− -- Record that the stream is closed, rather than
161− -- idle, so that receiving frames on it is only a
162− -- stream error.
163− consume payloadLength
164− strm <- newStream concurrency streamId 0
165− writeIORef (streamState strm) $ Closed $
166− ResetByMe $ E.toException $
167− StreamError RefusedStream streamId
168− insert streamTable streamId strm
169− E.throwIO $ StreamError RefusedStream streamId
170− ws <- initialWindowSize <$> readIORef http2settings
171− newstrm <- newStream concurrency streamId (fromIntegral ws)
172− when (ftyp == FrameHeaders) $ opened newstrm
173− insert streamTable streamId newstrm
174− return newstrm
175−
176− consume = void . recvN
177−
178−----------------------------------------------------------------
179−
180−control :: FrameTypeId -> FrameHeader -> ByteString -> Context -> IO Bool
181−control FrameSettings header@FrameHeader{flags} bs Context{http2settings, outputQ} = do
182− SettingsFrame alist <- guardIt $ decodeSettingsFrame header bs
183− case checkSettingsList alist of
184− Just x -> E.throwIO x
185− Nothing -> return ()
186− unless (testAck flags) $ do
187− modifyIORef http2settings $ \old -> updateSettings old alist
188− let frame = settingsFrame setAck []
189− enqueueControl outputQ 0 $ OSettings frame alist
190− return True
191−
192−control FramePing FrameHeader{flags} bs Context{outputQ} =
193− if testAck flags then
194− E.throwIO $ ConnectionError ProtocolError "the ack flag of this ping frame must not be set"
195− else do
196− let frame = pingFrame bs
197− enqueueControl outputQ 0 $ OFrame frame
198− return True
199−
200−control FrameGoAway _ _ Context{outputQ} = do
201− enqueueControl outputQ 0 OFinish
202− return False
203−
204−control FrameWindowUpdate header bs Context{connectionWindow} = do
205− WindowUpdateFrame n <- guardIt $ decodeWindowUpdateFrame header bs
206− w <- (n +) <$> atomically (readTVar connectionWindow)
207− when (isWindowOverflow w) $ E.throwIO $ ConnectionError FlowControlError "control window should be less than 2^31"
208− atomically $ writeTVar connectionWindow w
209− return True
210−
211−control _ _ _ _ =
212− -- must not reach here
213− return False
214−
215−----------------------------------------------------------------
216−
217−guardIt :: Either HTTP2Error a -> IO a
218−guardIt x = case x of
219− Left err -> E.throwIO err
220− Right frame -> return frame
221−
222−checkPriority :: Priority -> StreamId -> IO ()
223−checkPriority p me
224− | dep == me = E.throwIO $ StreamError ProtocolError me
225− | otherwise = return ()
226− where
227− dep = streamDependency p
228−
229−stream :: FrameTypeId -> FrameHeader -> ByteString -> Context -> StreamState -> Stream -> IO StreamState
230−stream FrameHeaders header@FrameHeader{flags} bs ctx (Open JustOpened) Stream{streamNumber} = do
231− HeadersFrame mp frag <- guardIt $ decodeHeadersFrame header bs
232− pri <- case mp of
233− Nothing -> return defaultPriority
234− Just p -> do
235− checkPriority p streamNumber
236− return p
237− let endOfStream = testEndStream flags
238− endOfHeader = testEndHeader flags
239− if endOfHeader then do
240− hdr <- hpackDecodeHeader frag ctx
241− return $ if endOfStream then
242− Open (NoBody hdr pri)
243− else
244− Open (HasBody hdr pri)
245− else do
246− let !siz = BS.length frag
247− return $ Open $ Continued [frag] siz 1 endOfStream pri
248−
249−stream FrameHeaders header@FrameHeader{flags} bs _ (Open (Body q)) _ = do
250− -- trailer is not supported.
251− -- let's read and ignore it.
252− HeadersFrame _ _ <- guardIt $ decodeHeadersFrame header bs
253− let endOfStream = testEndStream flags
254− if endOfStream then do
255− atomically $ writeTQueue q ""
256− return HalfClosed
257− else
258− -- we don't support continuation here.
259− E.throwIO $ ConnectionError ProtocolError "continuation in trailer is not supported"
260−
261−stream FrameData
262− header@FrameHeader{flags,payloadLength,streamId}
263− bs
264− Context{outputQ} s@(Open (Body q))
265− Stream{streamNumber,streamBodyLength,streamContentLength} = do
266− DataFrame body <- guardIt $ decodeDataFrame header bs
267− let endOfStream = testEndStream flags
268− len0 <- readIORef streamBodyLength
269− let !len = len0 + payloadLength
270− writeIORef streamBodyLength len
271− when (payloadLength /= 0) $ do
272− let frame1 = windowUpdateFrame 0 payloadLength
273− frame2 = windowUpdateFrame streamNumber payloadLength
274− frame = frame1 `BS.append` frame2
275− enqueueControl outputQ 0 $ OFrame frame
276− atomically $ writeTQueue q body
277− if endOfStream then do
278− mcl <- readIORef streamContentLength
279− case mcl of
280− Nothing -> return ()
281− Just cl -> when (cl /= len) $ E.throwIO $ StreamError ProtocolError streamId
282− atomically $ writeTQueue q ""
283− return HalfClosed
284− else
285− return s
286−
287−stream FrameContinuation FrameHeader{flags} frag ctx (Open (Continued rfrags siz n endOfStream pri)) _ = do
288− let endOfHeader = testEndHeader flags
289− rfrags' = frag : rfrags
290− siz' = siz + BS.length frag
291− n' = n + 1
292− when (siz' > 51200) $ -- fixme: hard coding: 50K
293− E.throwIO $ ConnectionError EnhanceYourCalm "Header is too big"
294− when (n' > 10) $ -- fixme: hard coding
295− E.throwIO $ ConnectionError EnhanceYourCalm "Header is too fragmented"
296− if endOfHeader then do
297− let hdrblk = BS.concat $ reverse rfrags'
298− hdr <- hpackDecodeHeader hdrblk ctx
299− return $ if endOfStream then
300− Open (NoBody hdr pri)
301− else
302− Open (HasBody hdr pri)
303− else
304− return $ Open $ Continued rfrags' siz' n' endOfStream pri
305−
306−stream FrameWindowUpdate header@FrameHeader{streamId} bs _ s Stream{streamWindow} = do
307− WindowUpdateFrame n <- guardIt $ decodeWindowUpdateFrame header bs
308− w <- (n +) <$> atomically (readTVar streamWindow)
309− when (isWindowOverflow w) $
310− E.throwIO $ StreamError FlowControlError streamId
311− atomically $ writeTVar streamWindow w
312− return s
313−
314−stream FrameRSTStream header bs _ _ strm = do
315− RSTStreamFrame e <- guardIt $ decoderstStreamFrame header bs
316− let cc = Reset e
317− closed strm cc
318− return $ Closed cc -- will be written to streamState again
319−
320−stream FramePriority header bs Context{outputQ,priorityTreeSize} s Stream{streamNumber,streamPrecedence} = do
321− PriorityFrame newpri <- guardIt $ decodePriorityFrame header bs
322− checkPriority newpri streamNumber
323− -- checkme: this should be tested
324− oldpre <- readIORef streamPrecedence
325− let !newpre = toPrecedence newpri
326− writeIORef streamPrecedence newpre
327− if isIdle s then do
328− n <- atomicModifyIORef' priorityTreeSize (\x -> (x+1,x+1))
329− -- fixme hard coding
330− when (n >= 20) $ E.throwIO $ ConnectionError EnhanceYourCalm "too many idle priority frames"
331− prepare outputQ streamNumber newpri
332− else do
333− mx <- delete outputQ streamNumber oldpre
334− case mx of
335− Nothing -> return ()
336− Just x -> enqueue outputQ streamNumber newpre x
337− return s
338−
339−-- this ordering is important
340−stream FrameContinuation _ _ _ _ _ = E.throwIO $ ConnectionError ProtocolError "continue frame cannot come here"
341−stream _ _ _ _ (Open Continued{}) _ = E.throwIO $ ConnectionError ProtocolError "an illegal frame follows header/continuation frames"
342−-- Ignore frames to streams we have just reset, per section 5.1.
343−stream _ _ _ _ st@(Closed (ResetByMe _)) _ = return st
344−stream FrameData FrameHeader{streamId} _ _ _ _ = E.throwIO $ StreamError StreamClosed streamId
345−stream _ FrameHeader{streamId} _ _ _ _ = E.throwIO $ StreamError ProtocolError streamId
warp/Network/Wai/Handler/Warp/HTTP2/Request.hs+100−115
@@ -1,141 +1,126 @@
1−{-# LANGUAGE OverloadedStrings, CPP #-}
1+{-# LANGUAGE BangPatterns #-}
22
33module Network.Wai.Handler.Warp.HTTP2.Request (
4− mkRequest
5− , newReadBody
6− , MkReq
7− , ValidHeaders(..)
8− , validateHeaders
4+ toRequest
5+ , getHTTP2Data
6+ , setHTTP2Data
7+ , modifyHTTP2Data
98 ) where
109
11−#if __GLASGOW_HASKELL__ < 709
12−import Control.Applicative ((<$>))
13−#endif
14−import Control.Concurrent.STM
15−import Control.Monad (when)
16−import Data.ByteString (ByteString)
17−import qualified Data.ByteString as BS
18−import qualified Data.ByteString.Char8 as B8
19−import Data.CaseInsensitive (mk)
20−import Data.IORef (IORef, readIORef, newIORef, writeIORef)
21−import Data.Maybe (isJust)
22−#if __GLASGOW_HASKELL__ < 709
23−import Data.Monoid (mempty)
24−#endif
25−import Data.Word8 (isUpper,_colon)
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
2614import Network.HPACK
27−import Network.HTTP.Types (RequestHeaders,hRange)
15+import Network.HPACK.Token
2816import qualified Network.HTTP.Types as H
2917import Network.Socket (SockAddr)
3018import Network.Wai
19+import Network.Wai.Internal (Request(..))
20+import System.IO.Unsafe (unsafePerformIO)
21+import qualified System.TimeManager as T
22+
3123import Network.Wai.Handler.Warp.HTTP2.Types
32−import Network.Wai.Handler.Warp.ReadInt
24+import Network.Wai.Handler.Warp.Imports
25+import Network.Wai.Handler.Warp.Request (getFileInfoKey, pauseTimeoutKey, getClientCertificateKey)
3326import qualified Network.Wai.Handler.Warp.Settings as S (Settings, settingsNoParsePath)
34−import Network.Wai.Internal (Request(..))
27+import Network.Wai.Handler.Warp.Types
3528
36−data ValidHeaders = ValidHeaders {
37− vhMethod :: ByteString
38− , vhPath :: ByteString
39− , vhAuth :: Maybe ByteString
40− , vhCL :: Maybe Int -- ^ Content-Length
41− , vhHeader :: RequestHeaders
42− }
29+type ToReq = (TokenHeaderList,ValueTable) -> Maybe Int -> IO ByteString -> T.Handle -> Transport -> IO Request
4330
44−type MkReq = ValidHeaders -> IO ByteString -> Request
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
4537
46−mkRequest :: S.Settings -> SockAddr -> MkReq
47−mkRequest settings addr (ValidHeaders m p ma _ hdr) body = req
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
4842 where
49− (unparsedPath,query) = B8.break (=='?') p
50− path = H.extractPath unparsedPath
51− req = Request {
52− requestMethod = m
53− , httpVersion = http2ver
54− , rawPathInfo = if S.settingsNoParsePath settings then unparsedPath else path
43+ !req = Request {
44+ requestMethod = colonMethod
45+ , httpVersion = H.http20
46+ , rawPathInfo = rawPath
5547 , pathInfo = H.decodePathSegments path
5648 , rawQueryString = query
5749 , queryString = H.parseQuery query
58− , requestHeaders = hdr
59− , isSecure = True
50+ , requestHeaders = headers
51+ , isSecure = isTransportSecure transport
6052 , remoteHost = addr
6153 , requestBody = body
62− , vault = mempty
63− , requestBodyLength = ChunkedBody -- fixme
64− , requestHeaderHost = ma
65− , requestHeaderRange = lookup hRange hdr
54+ , vault = vaultValue
55+ , requestBodyLength = maybe ChunkedBody (KnownLength . fromIntegral) bodylen
56+ , requestHeaderHost = mHost <|> mAuth
57+ , requestHeaderRange = mRange
58+ , requestHeaderReferer = mReferer
59+ , requestHeaderUserAgent = mUserAgent
6660 }
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
6788
68−----------------------------------------------------------------
69−
70−data Pseudo = Pseudo {
71− colonMethod :: !(Maybe ByteString)
72− , colonPath :: !(Maybe ByteString)
73− , colonAuth :: !(Maybe ByteString)
74− , contentLen :: !(Maybe ByteString)
75− }
76−
77−emptyPseudo :: Pseudo
78−emptyPseudo = Pseudo Nothing Nothing Nothing Nothing
79−
80−validateHeaders :: HeaderList -> Maybe ValidHeaders
81−validateHeaders hs = case pseudo hs (emptyPseudo,id) of
82− Just (Pseudo (Just m) (Just p) ma mcl, h)
83− -> Just $ ValidHeaders m p ma (readInt <$> mcl) h
84− _ -> Nothing
85− where
86− pseudo [] (p,b) = Just (p,b [])
87− pseudo h@((k,v):kvs) (p,b)
88− | k == ":method" = if isJust (colonMethod p) then
89− Nothing
90− else
91− pseudo kvs (p { colonMethod = Just v },b)
92− | k == ":path" = if isJust (colonPath p) then
93− Nothing
94− else
95− pseudo kvs (p { colonPath = Just v },b)
96− | k == ":authority" = if isJust (colonAuth p) then
97− Nothing
98− else
99− pseudo kvs (p { colonAuth = Just v },b)
100− | k == ":scheme" = pseudo kvs (p,b) -- fixme: how to store :scheme?
101− | isPseudo k = Nothing
102− | otherwise = normal h (p,b)
103−
104− normal [] (p,b) = Just (p,b [])
105− normal ((k,v):kvs) (p,b)
106− | isPseudo k = Nothing
107− | k == "connection" = Nothing
108− | k == "te" = if v == "trailers" then
109− normal kvs (p, b . ((mk k,v) :))
110− else
111− Nothing
112− | k == "content-length"
113− = normal kvs (p { contentLen = Just v },b)
114− | k == "host" = if isJust (colonAuth p) then
115− normal kvs (p,b)
116− else
117− normal kvs (p { colonAuth = Just v },b)
118− | otherwise = case BS.find isUpper k of
119− Nothing -> normal kvs (p, b . ((mk k,v) :))
120− Just _ -> Nothing
89+getHTTP2DataKey :: Vault.Key (IO (Maybe HTTP2Data))
90+getHTTP2DataKey = unsafePerformIO Vault.newKey
91+{-# NOINLINE getHTTP2DataKey #-}
12192
122− isPseudo "" = False
123− isPseudo k = BS.head k == _colon
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
124101
102+setHTTP2DataKey :: Vault.Key (Maybe HTTP2Data -> IO ())
103+setHTTP2DataKey = unsafePerformIO Vault.newKey
104+{-# NOINLINE setHTTP2DataKey #-}
125105
126−----------------------------------------------------------------
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
127114
128−newReadBody :: TQueue ByteString -> IO (IO ByteString)
129−newReadBody q = do
130− ref <- newIORef False
131− return $ readBody q ref
115+modifyHTTP2DataKey :: Vault.Key ((Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ())
116+modifyHTTP2DataKey = unsafePerformIO Vault.newKey
117+{-# NOINLINE modifyHTTP2DataKey #-}
132118
133−readBody :: TQueue ByteString -> IORef Bool -> IO ByteString
134−readBody q ref = do
135− eof <- readIORef ref
136− if eof then
137− return ""
138− else do
139− bs <- atomically $ readTQueue q
140− when (bs == "") $ writeIORef ref True
141− return bs
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/Sender.hsdeleted−426
@@ -1,426 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE BangPatterns, CPP #-}
3−{-# LANGUAGE NamedFieldPuns #-}
4−
5−module Network.Wai.Handler.Warp.HTTP2.Sender (frameSender) where
6−
7−#if __GLASGOW_HASKELL__ < 709
8−import Control.Applicative
9−#endif
10−import Control.Concurrent.MVar (putMVar)
11−import Control.Concurrent.STM
12−import qualified Control.Exception as E
13−import Control.Monad (void, when)
14−import qualified Data.ByteString as BS
15−import qualified Data.ByteString.Builder as B (int32BE)
16−import qualified Data.ByteString.Builder.Extra as B
17−import Data.Monoid ((<>))
18−import Foreign.Ptr
19−import qualified Network.HTTP.Types as H
20−import Network.HPACK (setLimitForEncoding)
21−import Network.HTTP2
22−import Network.HTTP2.Priority
23−import Network.Wai (FilePart(..))
24−import Network.Wai.HTTP2 (Trailers, promiseHeaders)
25−import Network.Wai.Handler.Warp.Buffer
26−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
27−import Network.Wai.Handler.Warp.HTTP2.HPACK
28−import Network.Wai.Handler.Warp.HTTP2.Types
29−import Network.Wai.Handler.Warp.IORef
30−import qualified Network.Wai.Handler.Warp.Settings as S
31−import Network.Wai.Handler.Warp.Types
32−
33−#ifdef WINDOWS
34−import qualified System.IO as IO
35−#else
36−import Network.Wai.Handler.Warp.FdCache (getFd)
37−import Network.Wai.Handler.Warp.SendFile (positionRead)
38−import qualified Network.Wai.Handler.Warp.Timeout as T
39−import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd)
40−import System.Posix.Types (Fd)
41−#endif
42−
43−----------------------------------------------------------------
44−
45−-- | The platform-specific type of an open file to stream from. On Windows we
46−-- don't have pread, so this is just a Handle; on Unix platforms with pread,
47−-- this is a file descriptor supplied by the fd cache.
48−#ifdef WINDOWS
49−type OpenFile = IO.Handle
50−#else
51−type OpenFile = Fd
52−#endif
53−
54−data Leftover = LZero
55− | LOne B.BufferWriter
56− | LTwo BS.ByteString B.BufferWriter
57− | LFile OpenFile Integer Integer (IO ())
58−
59−----------------------------------------------------------------
60−
61−-- | Run the given action if the stream is not closed; handle any exceptions by
62−-- resetting the stream.
63−unlessClosed :: Connection -> Stream -> IO () -> IO Bool
64−unlessClosed Connection{connSendAll}
65− strm@Stream{streamState,streamNumber}
66− body = E.handle resetStream $ do
67− state <- readIORef streamState
68− if (isClosed state) then return False else body >> return True
69− where
70− resetStream e = do
71− closed strm (ResetByMe e)
72− let rst = resetFrame InternalError streamNumber
73− connSendAll rst
74− return False
75−
76−getWindowSize :: TVar WindowSize -> TVar WindowSize -> IO WindowSize
77−getWindowSize connWindow strmWindow = do
78− -- Waiting that the connection window gets open.
79− cw <- atomically $ do
80− w <- readTVar connWindow
81− check (w > 0)
82− return w
83− -- This stream window is greater than 0 thanks to the invariant.
84− sw <- atomically $ readTVar strmWindow
85− return $ min cw sw
86−
87−frameSender :: Context -> Connection -> InternalInfo -> S.Settings -> IO ()
88−frameSender ctx@Context{outputQ,connectionWindow,encodeDynamicTable}
89− conn@Connection{connWriteBuffer,connBufferSize,connSendAll}
90− ii settings = go `E.catch` ignore
91− where
92− initialSettings = [(SettingsMaxConcurrentStreams,recommendedConcurrency)]
93− initialFrame = settingsFrame id initialSettings
94− bufHeaderPayload = connWriteBuffer `plusPtr` frameHeaderLength
95− headerPayloadLim = connBufferSize - frameHeaderLength
96−
97− go = do
98− connSendAll initialFrame
99− loop
100−
101− -- ignoring the old priority because the value might be changed.
102− loop = dequeue outputQ >>= \(_sid,pre,out) -> switch out pre
103−
104− ignore :: E.SomeException -> IO ()
105− ignore _ = return ()
106−
107− switch OFinish _ = return ()
108− switch (OGoaway frame) _ = connSendAll frame
109− switch (OSettings frame alist) _ = do
110− connSendAll frame
111− case lookup SettingsHeaderTableSize alist of
112− Nothing -> return ()
113− Just siz -> do
114− dyntbl <- readIORef encodeDynamicTable
115− setLimitForEncoding siz dyntbl
116− loop
117− switch (OFrame frame) _ = do
118− connSendAll frame
119− loop
120− switch (OResponse strm s h aux) pre = do
121− writeIORef (streamPrecedence strm) pre -- fixme
122− _ <- unlessClosed conn strm $
123− getWindowSize connectionWindow (streamWindow strm) >>=
124− sendResponse strm s h aux
125− loop
126− switch (ONext strm curr) pre = do
127− writeIORef (streamPrecedence strm) pre
128− _ <- unlessClosed conn strm $ do
129− lim <- getWindowSize connectionWindow (streamWindow strm)
130− -- Data frame payload
131− Next datPayloadLen mnext <- curr lim
132− fillDataHeaderSend strm 0 datPayloadLen
133− dispatchNext strm mnext
134− loop
135− switch (OPush oldStrm push mvar strm s h aux) pre = do
136− writeIORef (streamPrecedence strm) pre -- fixme
137− pushed <- unlessClosed conn oldStrm $ do
138− lim <- getWindowSize connectionWindow (streamWindow strm)
139− -- Write and send the promise.
140− builder <- hpackEncodeCIHeaders ctx $ promiseHeaders push
141− off <- pushContinue (streamNumber oldStrm) (streamNumber strm) builder
142− flushN $ off + frameHeaderLength
143− -- TODO(awpr): refactor sendResponse to be able to handle non-zero
144− -- initial offsets and use that to potentially avoid the extra syscall.
145− sendResponse strm s h aux lim
146− putMVar mvar pushed
147− loop
148−
149− -- Send the response headers and as much of the response as is immediately
150− -- available; shared by normal responses and pushed streams.
151− sendResponse :: Stream -> H.Status -> H.ResponseHeaders -> Aux -> WindowSize -> IO ()
152− sendResponse strm s h (Persist sq tvar) lim = do
153− -- Header frame and Continuation frame
154− let sid = streamNumber strm
155− builder <- hpackEncodeHeader ctx ii settings s h
156− len <- headerContinue sid builder False
157− let total = len + frameHeaderLength
158− (off, needSend) <- sendHeadersIfNecessary total
159− let payloadOff = off + frameHeaderLength
160− Next datPayloadLen mnext <-
161− fillStreamBodyGetNext ii conn payloadOff lim sq tvar strm
162− -- If no data was immediately available, avoid sending an
163− -- empty data frame.
164− if datPayloadLen > 0 then
165− fillDataHeaderSend strm total datPayloadLen
166− else
167− when needSend $ flushN off
168− dispatchNext strm mnext
169−
170− -- Send the stream's trailers and close the stream.
171− sendTrailers :: Stream -> Trailers -> IO ()
172− sendTrailers strm trailers = do
173− -- Trailers always indicate the end of a stream; send them in
174− -- consecutive header+continuation frames and end the stream. Some
175− -- clients dislike empty headers frames, so end the stream with an
176− -- empty data frame instead, as recommended by the spec.
177− toFlush <- case trailers of
178− [] -> frameHeaderLength <$ fillFrameHeader FrameData 0
179− (streamNumber strm)
180− (setEndStream defaultFlags)
181− connWriteBuffer
182− _ -> do
183− builder <- hpackEncodeCIHeaders ctx trailers
184− off <- headerContinue (streamNumber strm) builder True
185− return (off + frameHeaderLength)
186− -- 'closed' must be before 'flushN'. If not, the context would be
187− -- switched to the receiver, resulting in the inconsistency of
188− -- concurrency.
189− closed strm Finished
190− flushN toFlush
191−
192− -- Flush the connection buffer to the socket, where the first 'n' bytes of
193− -- the buffer are filled.
194− flushN :: Int -> IO ()
195− flushN n = bufferIO connWriteBuffer n connSendAll
196−
197− -- A flags value with the end-header flag set iff the argument is B.Done.
198− maybeEndHeaders B.Done = setEndHeader defaultFlags
199− maybeEndHeaders _ = defaultFlags
200−
201− -- Write PUSH_PROMISE and possibly CONTINUATION frames into the connection
202− -- buffer, using the given builder as their contents; flush them to the
203− -- socket as necessary.
204− pushContinue sid newSid builder = do
205− let builder' = B.int32BE (fromIntegral newSid) <> builder
206− (len, signal) <- B.runBuilder builder' bufHeaderPayload headerPayloadLim
207− let flag = maybeEndHeaders signal
208− fillFrameHeader FramePushPromise len sid flag connWriteBuffer
209− continue sid len signal
210−
211− -- Write HEADER and possibly CONTINUATION frames.
212− headerContinue sid builder endOfStream = do
213− (len, signal) <- B.runBuilder builder bufHeaderPayload headerPayloadLim
214− let flag0 = maybeEndHeaders signal
215− flag = if endOfStream then setEndStream flag0 else flag0
216− fillFrameHeader FrameHeaders len sid flag connWriteBuffer
217− continue sid len signal
218−
219− continue _ len B.Done = return len
220− continue sid len (B.More _ writer) = do
221− flushN $ len + frameHeaderLength
222− (len', signal') <- writer bufHeaderPayload headerPayloadLim
223− let flag = maybeEndHeaders signal'
224− fillFrameHeader FrameContinuation len' sid flag connWriteBuffer
225− continue sid len' signal'
226− continue sid len (B.Chunk bs writer) = do
227− flushN $ len + frameHeaderLength
228− let (bs1,bs2) = BS.splitAt headerPayloadLim bs
229− len' = BS.length bs1
230− void $ copy bufHeaderPayload bs1
231− fillFrameHeader FrameContinuation len' sid defaultFlags connWriteBuffer
232− if bs2 == "" then
233− continue sid len' (B.More 0 writer)
234− else
235− continue sid len' (B.Chunk bs2 writer)
236−
237− -- True if the connection buffer has room for a 1-byte data frame.
238− canFitDataFrame total = total + frameHeaderLength < connBufferSize
239−
240− -- Take the appropriate action based on the given 'Control':
241− -- - If more output is immediately available, re-enqueue the stream in the
242− -- output queue.
243− -- - If the output is over and trailers are available, send them now and
244− -- end the stream.
245− -- - If we've drained the queue and handed the stream back to its waiter,
246− -- do nothing.
247− --
248− -- This is done after sending any part of the stream body, so it's shared
249− -- by 'sendResponse' and @switch (ONext ...)@.
250− dispatchNext :: Stream -> Control DynaNext -> IO ()
251− dispatchNext _ CNone = return ()
252− dispatchNext strm (CFinish trailers) = sendTrailers strm trailers
253− dispatchNext strm (CNext next) = do
254− let out = ONext strm next
255− enqueueOrSpawnTemporaryWaiter strm outputQ out
256−
257−
258− -- Send headers if there is not room for a 1-byte data frame, and return
259− -- the offset of the next frame's first header byte and whether the headers
260− -- still need to be sent.
261− sendHeadersIfNecessary total
262− | canFitDataFrame total = return (total, True)
263− | otherwise = do
264− flushN total
265− return (0, False)
266−
267− fillDataHeaderSend strm otherLen datPayloadLen = do
268− -- Data frame header
269− let sid = streamNumber strm
270− buf = connWriteBuffer `plusPtr` otherLen
271− total = otherLen + frameHeaderLength + datPayloadLen
272− fillFrameHeader FrameData datPayloadLen sid defaultFlags buf
273− flushN total
274− atomically $ do
275− modifyTVar' connectionWindow (subtract datPayloadLen)
276− modifyTVar' (streamWindow strm) (subtract datPayloadLen)
277−
278− fillFrameHeader ftyp len sid flag buf = encodeFrameHeaderBuf ftyp hinfo buf
279− where
280− hinfo = FrameHeader len flag sid
281−
282−----------------------------------------------------------------
283−
284−fillStreamBodyGetNext :: InternalInfo -> Connection -> Int -> WindowSize
285− -> TBQueue Sequence -> TVar Sync -> Stream -> IO Next
286−fillStreamBodyGetNext ii Connection{connWriteBuffer,connBufferSize}
287− off lim sq tvar strm = do
288− let datBuf = connWriteBuffer `plusPtr` off
289− room = min (connBufferSize - off) lim
290− (leftover, cont, len) <- runStreamBuilder ii datBuf room sq
291− nextForStream ii connWriteBuffer connBufferSize sq tvar strm leftover cont len
292−
293−----------------------------------------------------------------
294−
295−runStreamBuilder :: InternalInfo -> Buffer -> BufSize -> TBQueue Sequence
296− -> IO (Leftover, Maybe Trailers, BytesFilled)
297−runStreamBuilder ii buf0 room0 sq = loop buf0 room0 0
298− where
299− loop !buf !room !total = do
300− mbuilder <- atomically $ tryReadTBQueue sq
301− case mbuilder of
302− Nothing -> return (LZero, Nothing, total)
303− Just (SBuilder builder) -> do
304− (len, signal) <- B.runBuilder builder buf room
305− let !total' = total + len
306− case signal of
307− B.Done -> loop (buf `plusPtr` len) (room - len) total'
308− B.More _ writer -> return (LOne writer, Nothing, total')
309− B.Chunk bs writer -> return (LTwo bs writer, Nothing, total')
310− Just (SFile path part) -> do
311− (leftover, len) <- runStreamFile ii buf room path part
312− let !total' = total + len
313− case leftover of
314− LZero -> loop (buf `plusPtr` len) (room - len) total'
315− _ -> return (leftover, Nothing, total')
316−
317− Just SFlush -> return (LZero, Nothing, total)
318− Just (SFinish trailers) -> return (LZero, Just trailers, total)
319−
320−-- | Open the file and start reading into the send buffer.
321−runStreamFile :: InternalInfo -> Buffer -> BufSize -> FilePath -> FilePart
322− -> IO (Leftover, BytesFilled)
323−
324−-- | Read the given (OS-specific) file representation into the buffer. On
325−-- non-Windows systems this uses pread; on Windows this ignores the position
326−-- because we use the Handle's internal read position instead (because it's not
327−-- potentially shared with other readers).
328−readOpenFile :: OpenFile -> Buffer -> BufSize -> Integer -> IO Int
329−
330−#ifdef WINDOWS
331−runStreamFile _ buf room path part = do
332− let start = filePartOffset part
333− bytes = filePartByteCount part
334− -- fixme: how to close Handle? GC does it at this moment.
335− h <- IO.openBinaryFile path IO.ReadMode
336− IO.hSeek h IO.AbsoluteSeek start
337− fillBufFile buf room h start bytes (return ())
338−
339−readOpenFile h buf room _ = IO.hGetBufSome h buf room
340−#else
341−runStreamFile ii buf room path part = do
342− let start = filePartOffset part
343− bytes = filePartByteCount part
344− (fd, refresh) <- case fdCacher ii of
345− Just fdcache -> getFd fdcache path
346− Nothing -> do
347− fd' <- openFd path ReadOnly Nothing defaultFileFlags{nonBlock=True}
348− th <- T.register (timeoutManager ii) (closeFd fd')
349− return (fd', T.tickle th)
350− fillBufFile buf room fd start bytes refresh
351−
352−readOpenFile = positionRead
353−#endif
354−
355−-- | Read as much of the file as is currently available into the buffer, then
356−-- return a 'Leftover' to indicate whether this file chunk has more data to
357−-- send. If this read hit the end of the file range, return 'LZero'; otherwise
358−-- return 'LFile' so this stream will continue reading from the file the next
359−-- time it's pulled from the queue.
360−fillBufFile :: Buffer -> BufSize -> OpenFile -> Integer -> Integer -> (IO ())
361− -> IO (Leftover, BytesFilled)
362−fillBufFile buf room f start bytes refresh = do
363− len <- readOpenFile f buf (mini room bytes) start
364− refresh
365− let len' = fromIntegral len
366− leftover = if bytes > len' then
367− LFile f (start + len') (bytes - len') refresh
368− else
369− LZero
370− return (leftover, len)
371−
372−mini :: Int -> Integer -> Int
373−mini i n
374− | fromIntegral i < n = i
375− | otherwise = fromIntegral n
376−
377−fillBufStream :: InternalInfo -> Buffer -> BufSize -> Leftover
378− -> TBQueue Sequence -> TVar Sync -> Stream -> DynaNext
379−fillBufStream ii buf0 siz0 leftover0 sq tvar strm lim0 = do
380− let payloadBuf = buf0 `plusPtr` frameHeaderLength
381− room0 = min (siz0 - frameHeaderLength) lim0
382− case leftover0 of
383− LZero -> do
384− (leftover, end, len) <- runStreamBuilder ii payloadBuf room0 sq
385− getNext leftover end len
386− LOne writer -> write writer payloadBuf room0 0
387− LTwo bs writer
388− | BS.length bs <= room0 -> do
389− buf1 <- copy payloadBuf bs
390− let len = BS.length bs
391− write writer buf1 (room0 - len) len
392− | otherwise -> do
393− let (bs1,bs2) = BS.splitAt room0 bs
394− void $ copy payloadBuf bs1
395− getNext (LTwo bs2 writer) Nothing room0
396− LFile fd start bytes refresh -> do
397− (leftover, len) <- fillBufFile payloadBuf room0 fd start bytes refresh
398− getNext leftover Nothing len
399− where
400− getNext = nextForStream ii buf0 siz0 sq tvar strm
401− write writer1 buf room sofar = do
402− (len, signal) <- writer1 buf room
403− case signal of
404− B.Done -> do
405− (leftover, end, extra) <- runStreamBuilder ii (buf `plusPtr` len) (room - len) sq
406− let !total = sofar + len + extra
407− getNext leftover end total
408− B.More _ writer -> do
409− let !total = sofar + len
410− getNext (LOne writer) Nothing total
411− B.Chunk bs writer -> do
412− let !total = sofar + len
413− getNext (LTwo bs writer) Nothing total
414−
415−nextForStream :: InternalInfo -> Buffer -> BufSize -> TBQueue Sequence
416− -> TVar Sync -> Stream -> Leftover -> Maybe Trailers
417− -> BytesFilled -> IO Next
418−nextForStream _ _ _ _ tvar _ _ (Just trailers) len = do
419− atomically $ writeTVar tvar $ SyncFinish
420− return $ Next len $ CFinish trailers
421−nextForStream ii buf siz sq tvar strm LZero Nothing len = do
422− let out = ONext strm (fillBufStream ii buf siz LZero sq tvar strm)
423− atomically $ writeTVar tvar $ SyncNext out
424− return $ Next len CNone
425−nextForStream ii buf siz sq tvar strm leftover Nothing len =
426− return $ Next len (CNext (fillBufStream ii buf siz leftover sq tvar strm))
warp/Network/Wai/Handler/Warp/HTTP2/Types.hs+63−294
@@ -1,36 +1,18 @@
1−{-# LANGUAGE OverloadedStrings, CPP #-}
2−{-# LANGUAGE NamedFieldPuns, RecordWildCards #-}
1+{-# LANGUAGE NamedFieldPuns #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
34
45module Network.Wai.Handler.Warp.HTTP2.Types where
56
6−import Data.ByteString.Builder (Builder)
7−#if __GLASGOW_HASKELL__ < 709
8−import Control.Applicative ((<$>), (<*>), pure)
9−#endif
10−import Control.Concurrent (forkIO)
11−import Control.Concurrent.MVar (MVar)
12−import Control.Concurrent.STM
13−import Control.Exception (SomeException)
14−import Control.Monad (void)
15−import Control.Reaper
16−import Data.ByteString (ByteString)
177import qualified Data.ByteString as BS
18−import Data.IntMap.Strict (IntMap, IntMap)
19−import qualified Data.IntMap.Strict as M
208import qualified Network.HTTP.Types as H
21−import Network.Wai (Request, FilePart)
22−import Network.Wai.HTTP2 (PushPromise, Trailers)
23−import Network.Wai.Handler.Warp.IORef
24−import Network.Wai.Handler.Warp.Types
25−
269import Network.HTTP2
27−import Network.HTTP2.Priority
28−import Network.HPACK
10+import qualified Network.HTTP2.Server as H2
2911
30−----------------------------------------------------------------
12+import Network.Wai.Handler.Warp.Imports
13+import Network.Wai.Handler.Warp.Types
3114
32−http2ver :: H.HttpVersion
33−http2ver = H.HttpVersion 2 0
15+----------------------------------------------------------------
3416
3517isHTTP2 :: Transport -> Bool
3618isHTTP2 TCP = False
@@ -38,275 +20,62 @@ isHTTP2 tls = useHTTP2
3820 where
3921 useHTTP2 = case tlsNegotiatedProtocol tls of
4022 Nothing -> False
41− Just proto -> "h2-" `BS.isPrefixOf` proto || proto == "h2"
42−
43−----------------------------------------------------------------
44−
45−data Input = Input Stream Request
46−
47−----------------------------------------------------------------
48−
49−-- | The result of writing data from a stream's queue into the buffer.
50−data Control a = CFinish Trailers
51− -- ^ The stream has ended, and the trailers should be sent.
52− | CNext a
53− -- ^ The stream has more data immediately available, and we
54− -- should re-enqueue it when the stream window becomes open.
55− | CNone
56− -- ^ The stream queue has been drained and we've handed it off
57− -- to its dedicated waiter thread, which will re-enqueue it when
58− -- more data is available.
59−
60−instance Show (Control a) where
61− show (CFinish _) = "CFinish"
62− show (CNext _) = "CNext"
63− show CNone = "CNone"
64−
65−type DynaNext = WindowSize -> IO Next
66−
67−type BytesFilled = Int
68−
69−data Next = Next BytesFilled (Control DynaNext)
70−
71−data Output = OFinish
72− -- ^ Terminate the connection.
73− | OGoaway ByteString
74− -- ^ Send a goaway frame and terminate the connection.
75− | OSettings ByteString SettingsList
76− -- ^ Update settings and send an ack settings frame.
77− | OFrame ByteString
78− -- ^ Send an entire pre-encoded frame.
79− | OResponse Stream H.Status H.ResponseHeaders Aux
80− -- ^ Send the headers and as much of the response as is immediately
81− -- available.
82− | OPush Stream PushPromise (MVar Bool) Stream H.Status H.ResponseHeaders Aux
83− -- ^ Send a PUSH_PROMISE frame, then act like OResponse; signal the
84− -- MVar whether the promise has been sent.
85− | ONext Stream DynaNext
86− -- ^ Send a chunk of the response.
87−
88−outputStream :: Output -> Stream
89−outputStream (OResponse strm _ _ _) = strm
90−outputStream (ONext strm _) = strm
91−outputStream (OPush strm _ _ _ _ _ _) = strm
92−outputStream _ = error "outputStream"
93−
94−----------------------------------------------------------------
95−
96−-- | An element on the queue between a running stream and the sender; the order
97−-- should consist of any number of 'SFile', 'SBuilder', and 'SFlush', followed
98−-- by a single 'SFinish'.
99−data Sequence = SFinish Trailers
100− -- ^ The stream is over; its trailers are provided.
101− | SFlush
102− -- ^ Any buffered data should be sent immediately.
103− | SBuilder Builder
104− -- ^ Append a chunk of data to the stream.
105− | SFile FilePath FilePart
106− -- ^ Append a chunk of a file's contents to the stream.
107−
108−-- | A message from the sender to a stream's dedicated waiter thread.
109−data Sync = SyncNone
110− -- ^ Nothing interesting has happened. Go back to sleep.
111− | SyncFinish
112− -- ^ The stream has ended.
113− | SyncNext Output
114− -- ^ The stream's queue has been drained; wait for more to be
115− -- available and re-enqueue the given 'Output'.
116−
117−-- | Auxiliary information needed to communicate with a running stream: a queue
118−-- of stream elements ('Sequence') and a 'TVar' connected to its waiter thread.
119−data Aux = Persist (TBQueue Sequence) (TVar Sync)
120−
121−----------------------------------------------------------------
122−
123−-- | The context for HTTP/2 connection.
124−data Context = Context {
125− http2settings :: IORef Settings
126− , streamTable :: StreamTable
127− -- | Number of active streams initiated by the client; for enforcing our own
128− -- max concurrency setting.
129− , concurrency :: IORef Int
130− -- | Number of active streams initiated by the server; for respecting the
131− -- client's max concurrency setting.
132− , pushConcurrency :: IORef Int
133− , priorityTreeSize :: IORef Int
134− -- | RFC 7540 says "Other frames (from any stream) MUST NOT
135− -- occur between the HEADERS frame and any CONTINUATION
136− -- frames that might follow". This field is used to implement
137− -- this requirement.
138− , continued :: IORef (Maybe StreamId)
139− , currentStreamId :: IORef StreamId
140− -- ^ Last client-initiated stream ID we've handled.
141− , nextPushStreamId :: IORef StreamId
142− -- ^ Next available server-initiated stream ID.
143− , inputQ :: TQueue Input
144− , outputQ :: PriorityTree Output
145− , encodeDynamicTable :: IORef DynamicTable
146− , decodeDynamicTable :: IORef DynamicTable
147− , connectionWindow :: TVar WindowSize
148− }
149−
150−----------------------------------------------------------------
151−
152−newContext :: IO Context
153−newContext = Context <$> newIORef defaultSettings
154− <*> initialize 10 -- fixme: hard coding: 10
155− <*> newIORef 0
156− <*> newIORef 0
157− <*> newIORef 0
158− <*> newIORef Nothing
159− <*> newIORef 0
160− <*> newIORef 2 -- first server push stream; 0 is reserved
161− <*> newTQueueIO
162− <*> newPriorityTree
163− <*> (newDynamicTableForEncoding defaultDynamicTableSize >>= newIORef)
164− <*> (newDynamicTableForDecoding defaultDynamicTableSize >>= newIORef)
165− <*> newTVarIO defaultInitialWindowSize
166−
167−clearContext :: Context -> IO ()
168−clearContext ctx = void $ reaperStop $ streamTable ctx
23+ Just proto -> "h2" `BS.isPrefixOf` proto
16924
17025----------------------------------------------------------------
17126
172−data OpenState =
173− JustOpened
174− | Continued [HeaderBlockFragment]
175− Int -- Total size
176− Int -- The number of continuation frames
177− Bool -- End of stream
178− Priority
179− | NoBody HeaderList Priority
180− | HasBody HeaderList Priority
181− | Body (TQueue ByteString)
182−
183−data ClosedCode = Finished
184− | Killed
185− | Reset ErrorCodeId
186− | ResetByMe SomeException
187− deriving Show
188−
189−data StreamState =
190− Idle
191− | Open OpenState
192− | HalfClosed
193− | Closed ClosedCode
194−
195−isIdle :: StreamState -> Bool
196−isIdle Idle = True
197−isIdle _ = False
198−
199−isOpen :: StreamState -> Bool
200−isOpen Open{} = True
201−isOpen _ = False
202−
203−isHalfClosed :: StreamState -> Bool
204−isHalfClosed HalfClosed = True
205−isHalfClosed _ = False
206−
207−isClosed :: StreamState -> Bool
208−isClosed Closed{} = True
209−isClosed _ = False
210−
211−instance Show StreamState where
212− show Idle = "Idle"
213− show Open{} = "Open"
214− show HalfClosed = "HalfClosed"
215− show (Closed e) = "Closed: " ++ show e
216−
217−----------------------------------------------------------------
218−
219−data Stream = Stream {
220− streamNumber :: StreamId
221− , streamState :: IORef StreamState
222− -- Next two fields are for error checking.
223− , streamContentLength :: IORef (Maybe Int)
224− , streamBodyLength :: IORef Int
225− , streamWindow :: TVar WindowSize
226− , streamPrecedence :: IORef Precedence
227− -- | The concurrency IORef in which this stream has been counted. The client
228− -- and server each have separate concurrency values to respect, so pushed
229− -- streams need to decrement a different count when they're closed. This
230− -- should be either @concurrency ctx@ or @pushConcurrency ctx@.
231− , concurrencyRef :: IORef Int
232− }
233−
234−instance Show Stream where
235− show s = show (streamNumber s)
236−
237−newStream :: IORef Int -> StreamId -> WindowSize -> IO Stream
238−newStream ref sid win =
239− Stream sid <$> newIORef Idle
240− <*> newIORef Nothing
241− <*> newIORef 0
242− <*> newTVarIO win
243− <*> newIORef defaultPrecedence
244− <*> pure ref
245−
246−----------------------------------------------------------------
247−
248−opened :: Stream -> IO ()
249−opened Stream{concurrencyRef,streamState} = do
250− atomicModifyIORef' concurrencyRef (\x -> (x+1,()))
251− writeIORef streamState (Open JustOpened)
252−
253−closed :: Stream -> ClosedCode -> IO ()
254−closed Stream{concurrencyRef,streamState} cc = do
255− atomicModifyIORef' concurrencyRef (\x -> (x-1,()))
256− writeIORef streamState (Closed cc)
257−
258−----------------------------------------------------------------
259−
260−type StreamTable = Reaper (IntMap Stream) (M.Key, Stream)
261−
262−initialize :: Int -> IO StreamTable
263−initialize duration = mkReaper settings
264− where
265− settings = defaultReaperSettings {
266− reaperAction = clean
267− , reaperDelay = duration * 1000000
268− , reaperCons = uncurry M.insert
269− , reaperNull = M.null
270− , reaperEmpty = M.empty
271− }
272−
273−clean :: IntMap Stream -> IO (IntMap Stream -> IntMap Stream)
274−clean old = do
275− new <- M.fromAscList <$> prune oldlist []
276− return $ M.union new
277− where
278− oldlist = M.toDescList old
279− prune [] lst = return lst
280− prune (x@(_,s):xs) lst = do
281− st <- readIORef (streamState s)
282− if isClosed st then
283− prune xs lst
284− else
285− prune xs (x:lst)
286−
287−insert :: StreamTable -> M.Key -> Stream -> IO ()
288−insert strmtbl k v = reaperAdd strmtbl (k,v)
289−
290−search :: StreamTable -> M.Key -> IO (Maybe Stream)
291−search strmtbl k = M.lookup k <$> reaperRead strmtbl
292−
293−
294−-- INVARIANT: streams in the output queue have non-zero window size.
295−enqueueWhenWindowIsOpen :: PriorityTree Output -> Output -> IO ()
296−enqueueWhenWindowIsOpen outQ out = do
297− let Stream{..} = outputStream out
298− atomically $ do
299− x <- readTVar streamWindow
300− check (x > 0)
301− pre <- readIORef streamPrecedence
302− enqueue outQ streamNumber pre out
303−
304−enqueueOrSpawnTemporaryWaiter :: Stream -> PriorityTree Output -> Output -> IO ()
305−enqueueOrSpawnTemporaryWaiter Stream{..} outQ out = do
306− sw <- atomically $ readTVar streamWindow
307− if sw == 0 then
308− -- This waiter waits only for the stream window.
309− void $ forkIO $ enqueueWhenWindowIsOpen outQ out
310− else do
311− pre <- readIORef streamPrecedence
312− enqueue outQ streamNumber pre out
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/HTTP2/Worker.hsdeleted−279
@@ -1,279 +0,0 @@
1−{-# LANGUAGE DeriveDataTypeable #-}
2−{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE NamedFieldPuns #-}
4−{-# LANGUAGE PatternGuards #-}
5−{-# LANGUAGE CPP #-}
6−
7−module Network.Wai.Handler.Warp.HTTP2.Worker (
8− Respond
9− , response
10− , worker
11− ) where
12−
13−#if __GLASGOW_HASKELL__ < 709
14−import Control.Applicative
15−#endif
16−import Control.Concurrent
17−import Control.Concurrent.STM
18−import Control.Exception (Exception, SomeException(..), AsyncException(..))
19−import qualified Control.Exception as E
20−import Control.Monad (void, when)
21−import Data.Typeable
22−import qualified Network.HTTP.Types as H
23−import Network.HTTP2
24−import Network.HTTP2.Priority
25−import Network.Wai
26−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
27−import Network.Wai.Handler.Warp.HTTP2.Manager
28−import Network.Wai.Handler.Warp.HTTP2.Types
29−import Network.Wai.Handler.Warp.IORef
30−import Network.Wai.HTTP2
31− ( Chunk(..)
32− , HTTP2Application
33− , PushPromise
34− , Responder(runResponder)
35− , RespondFunc
36− )
37−import qualified Network.Wai.Handler.Warp.Settings as S
38−import qualified Network.Wai.Handler.Warp.Timeout as T
39−
40−----------------------------------------------------------------
41−
42−-- | An 'HTTP2Application' takes a function of status, headers, trailers, and
43−-- body; this type implements that by currying some internal arguments.
44−--
45−-- The token type of the RespondFunc is set to be (). This is a bit
46−-- anti-climactic, but the real benefit of the token type is that the
47−-- application is forced to call the responder, and making it a boring type
48−-- doesn't break that property.
49−--
50−-- This is the argument to a 'Responder'.
51−type Respond = IO () -> Stream -> RespondFunc ()
52−
53−-- | This function is passed to workers. They also pass responses from
54−-- 'HTTP2Application's to this function. This function enqueues commands for
55−-- the HTTP/2 sender.
56−response :: Context -> Manager -> ThreadContinue -> Respond
57−response ctx mgr tconf tickle strm s h strmbdy = do
58− -- TODO(awpr) HEAD requests will still stream.
59−
60− -- We must not exit this WAI application.
61− -- If the application exits, streaming would be also closed.
62− -- So, this work occupies this thread.
63− --
64− -- We need to increase the number of workers.
65− myThreadId >>= replaceWithAction mgr
66− -- After this work, this thread stops to decrease the number of workers.
67− setThreadContinue tconf False
68−
69− runStream ctx OResponse tickle strm s h strmbdy
70−
71−-- | Set up a waiter thread and run the stream body with functions to enqueue
72−-- 'Sequence's on the stream's queue.
73−runStream :: Context
74− -> (Stream -> H.Status -> H.ResponseHeaders -> Aux -> Output)
75− -> Respond
76−runStream Context{outputQ} mkOutput tickle strm s h strmbdy = do
77− -- Since 'Body' is loop, we cannot control it.
78− -- So, let's serialize 'Builder' with a designated queue.
79− sq <- newTBQueueIO 10 -- fixme: hard coding: 10
80− tvar <- newTVarIO SyncNone
81− let out = mkOutput strm s h (Persist sq tvar)
82− -- Since we must not enqueue an empty queue to the priority
83− -- queue, we spawn a thread to ensure that the designated
84− -- queue is not empty.
85− void $ forkIO $ waiter tvar sq strm outputQ
86− atomically $ writeTVar tvar $ SyncNext out
87− let write chunk = do
88− atomically $ writeTBQueue sq $ case chunk of
89− BuilderChunk b -> SBuilder b
90− FileChunk path part -> SFile path part
91− tickle
92− flush = atomically $ writeTBQueue sq SFlush
93− trailers <- strmbdy write flush
94− atomically $ writeTBQueue sq $ SFinish trailers
95−
96−-- | Handle abnormal termination of a stream: mark it as closed, send a reset
97−-- frame, and call the user's 'settingsOnException' handler if applicable.
98−cleanupStream :: Context -> S.Settings -> Stream -> Maybe Request -> Maybe SomeException -> IO ()
99−cleanupStream Context{outputQ} set strm req me = do
100− closed strm Killed
101− let sid = streamNumber strm
102− frame = resetFrame InternalError sid
103− enqueueControl outputQ sid $ OFrame frame
104− case me of
105− Nothing -> return ()
106− Just e -> S.settingsOnException set req e
107−
108−-- | Push the given 'Responder' to the client if the settings allow it
109−-- (specifically 'enablePush' and 'maxConcurrentStreams'). Returns 'True' if
110−-- the stream was actually pushed.
111−--
112−-- This is the push function given to an 'HTTP2Application'.
113−pushResponder :: Context -> S.Settings -> Stream -> PushPromise -> Responder -> IO Bool
114−pushResponder ctx set strm promise responder = do
115− let Context{ http2settings
116− , pushConcurrency
117− } = ctx
118− cnt <- readIORef pushConcurrency
119− settings <- readIORef http2settings
120− let enabled = enablePush settings
121− fits = maybe True (cnt <) $ maxConcurrentStreams settings
122− canPush = fits && enabled
123− if canPush then
124− actuallyPushResponder ctx set strm promise responder
125− else
126− return False
127−
128−-- | Set up a pushed stream and run the 'Responder' in its own thread. Waits
129−-- for the sender thread to handle the push request. This can fail to push the
130−-- stream and return 'False' if the sender dequeued the push request after the
131−-- associated stream was closed.
132−actuallyPushResponder :: Context -> S.Settings -> Stream -> PushPromise -> Responder -> IO Bool
133−actuallyPushResponder ctx set strm promise responder = do
134− let Context{ http2settings
135− , nextPushStreamId
136− , pushConcurrency
137− , streamTable
138− } = ctx
139− -- Claim the next outgoing stream.
140− newSid <- atomicModifyIORef nextPushStreamId $ \sid -> (sid+2, sid)
141− ws <- initialWindowSize <$> readIORef http2settings
142−
143− newStrm <- newStream pushConcurrency newSid ws
144− -- Section 5.3.5 of RFC 7540 defines the weight of push promise is 16.
145− -- But we need not to follow the spec. So, this value would change
146− -- if necessary.
147− writeIORef (streamPrecedence newStrm) $
148− toPrecedence $ defaultPriority { streamDependency = streamNumber strm }
149− opened newStrm
150− insert streamTable newSid newStrm
151−
152− -- Set up a channel for the sender to report back whether it pushed the
153− -- stream.
154− mvar <- newEmptyMVar
155−
156− let mkOutput = OPush strm promise mvar
157− tickle = return ()
158− respond = runStream ctx mkOutput
159−
160− -- TODO(awpr): synthesize a Request for 'settingsOnException'?
161− _ <- forkIO $ runResponder responder (respond tickle newStrm) `E.catch`
162− (cleanupStream ctx set strm Nothing . Just)
163−
164− takeMVar mvar
165−
166−data Break = Break deriving (Show, Typeable)
167−
168−instance Exception Break
169−
170−worker :: Context
171− -> S.Settings
172− -> T.Manager
173− -> HTTP2Application
174− -> (ThreadContinue -> Respond)
175− -> IO ()
176−worker ctx@Context{inputQ} set tm app respond = do
177− tid <- myThreadId
178− sinfo <- newStreamInfo
179− tcont <- newThreadContinue
180− let setup = T.register tm $ E.throwTo tid Break
181− E.bracket setup T.cancel $ go sinfo tcont
182− where
183− go sinfo tcont th = do
184− setThreadContinue tcont True
185−
186− ex <- E.try $ do
187− T.pause th
188− Input strm req <- atomically $ readTQueue inputQ
189− setStreamInfo sinfo strm req
190− T.resume th
191− T.tickle th
192− let responder = app req $ pushResponder ctx set strm
193− runResponder responder $ respond tcont (T.tickle th) strm
194− cont1 <- case ex of
195− Right () -> return True
196− Left e@(SomeException _)
197− | Just Break <- E.fromException e -> do
198− cleanup sinfo Nothing
199− return True
200− -- killed by the sender
201− | Just ThreadKilled <- E.fromException e -> do
202− cleanup sinfo Nothing
203− return False
204− | otherwise -> do
205− cleanup sinfo (Just e)
206− return True
207− cont2 <- getThreadContinue tcont
208− when (cont1 && cont2) $ go sinfo tcont th
209− cleanup sinfo me = do
210− m <- getStreamInfo sinfo
211− case m of
212− Nothing -> return ()
213− Just (strm,req) -> do
214− cleanupStream ctx set strm (Just req) me
215− clearStreamInfo sinfo
216−
217−-- | A dedicated waiter thread to re-enqueue the stream in the priority tree
218−-- whenever output becomes available. When the sender drains the queue and
219−-- moves on to another stream, it drops a message in the 'TVar', and this
220−-- thread wakes up, waits for more output to become available, and re-enqueues
221−-- the stream.
222−waiter :: TVar Sync -> TBQueue Sequence -> Stream -> PriorityTree Output -> IO ()
223−waiter tvar sq strm outQ = do
224− -- waiting for actions other than SyncNone
225− mx <- atomically $ do
226− mout <- readTVar tvar
227− case mout of
228− SyncNone -> retry
229− SyncNext out -> do
230− writeTVar tvar SyncNone
231− return $ Just out
232− SyncFinish -> return Nothing
233− case mx of
234− Nothing -> return ()
235− Just out -> do
236− -- ensuring that the streaming queue is not empty.
237− atomically $ do
238− isEmpty <- isEmptyTBQueue sq
239− when isEmpty retry
240− -- ensuring that stream window is greater than 0.
241− enqueueWhenWindowIsOpen outQ out
242− waiter tvar sq strm outQ
243−
244−----------------------------------------------------------------
245−
246−-- | It would nice if responders could return values to workers.
247−-- Unfortunately, 'ResponseReceived' is already defined in WAI 2.0.
248−-- It is not wise to change this type.
249−-- So, a reference is shared by a 'Respond' and its worker.
250−-- The reference refers a value of this type as a return value.
251−-- If 'True', the worker continue to serve requests.
252−-- Otherwise, the worker get finished.
253−newtype ThreadContinue = ThreadContinue (IORef Bool)
254−
255−newThreadContinue :: IO ThreadContinue
256−newThreadContinue = ThreadContinue <$> newIORef True
257−
258−setThreadContinue :: ThreadContinue -> Bool -> IO ()
259−setThreadContinue (ThreadContinue ref) x = writeIORef ref x
260−
261−getThreadContinue :: ThreadContinue -> IO Bool
262−getThreadContinue (ThreadContinue ref) = readIORef ref
263−
264−----------------------------------------------------------------
265−
266−-- | The type to store enough information for 'settingsOnException'.
267−newtype StreamInfo = StreamInfo (IORef (Maybe (Stream,Request)))
268−
269−newStreamInfo :: IO StreamInfo
270−newStreamInfo = StreamInfo <$> newIORef Nothing
271−
272−clearStreamInfo :: StreamInfo -> IO ()
273−clearStreamInfo (StreamInfo ref) = writeIORef ref Nothing
274−
275−setStreamInfo :: StreamInfo -> Stream -> Request -> IO ()
276−setStreamInfo (StreamInfo ref) strm req = writeIORef ref $ Just (strm,req)
277−
278−getStreamInfo :: StreamInfo -> IO (Maybe (Stream, Request))
279−getStreamInfo (StreamInfo ref) = readIORef ref
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.hs+46−32
@@ -4,7 +4,10 @@ module Network.Wai.Handler.Warp.Header where
44
55import Data.Array
66import Data.Array.ST
7+import qualified Data.ByteString as BS
8+import Data.CaseInsensitive (foldedCase)
79import Network.HTTP.Types
10+
811import Network.Wai.Handler.Warp.Types
912
1013----------------------------------------------------------------
@@ -17,37 +20,43 @@ type IndexedHeader = Array Int (Maybe HeaderValue)
1720indexRequestHeader :: RequestHeaders -> IndexedHeader
1821indexRequestHeader hdr = traverseHeader hdr requestMaxIndex requestKeyIndex
1922
20−idxContentLength,idxTransferEncoding,idxExpect :: Int
21−idxConnection,idxRange,idxHost :: Int
22−idxIfModifiedSince,idxIfUnmodifiedSince,idxIfRange :: Int
23−idxContentLength = 0
24−idxTransferEncoding = 1
25−idxExpect = 2
26−idxConnection = 3
27−idxRange = 4
28−idxHost = 5
29−idxIfModifiedSince = 6
30−idxIfUnmodifiedSince = 7
31−idxIfRange = 8
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)
3235
3336-- | The size for 'IndexedHeader' for HTTP Request.
3437-- From 0 to this corresponds to \"Content-Length\", \"Transfer-Encoding\",
3538-- \"Expect\", \"Connection\", \"Range\", \"Host\",
3639-- \"If-Modified-Since\", \"If-Unmodified-Since\" and \"If-Range\".
3740requestMaxIndex :: Int
38−requestMaxIndex = 8
41+requestMaxIndex = fromEnum (maxBound :: RequestHeaderIndex)
3942
4043requestKeyIndex :: HeaderName -> Int
41−requestKeyIndex "content-length" = idxContentLength
42−requestKeyIndex "transfer-encoding" = idxTransferEncoding
43−requestKeyIndex "expect" = idxExpect
44−requestKeyIndex "connection" = idxConnection
45−requestKeyIndex "range" = idxRange
46−requestKeyIndex "host" = idxHost
47−requestKeyIndex "if-modified-since" = idxIfModifiedSince
48−requestKeyIndex "if-unmodified-since" = idxIfUnmodifiedSince
49−requestKeyIndex "if-range" = idxIfRange
50−requestKeyIndex _ = -1
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
5160
5261defaultIndexRequestHeader :: IndexedHeader
5362defaultIndexRequestHeader = array (0,requestMaxIndex) [(i,Nothing)|i<-[0..requestMaxIndex]]
@@ -57,20 +66,25 @@ defaultIndexRequestHeader = array (0,requestMaxIndex) [(i,Nothing)|i<-[0..reques
5766indexResponseHeader :: ResponseHeaders -> IndexedHeader
5867indexResponseHeader hdr = traverseHeader hdr responseMaxIndex responseKeyIndex
5968
60−idxServer, idxDate :: Int
61−--idxContentLength = 0
62−idxServer = 1
63−idxDate = 2
69+data ResponseHeaderIndex = ResContentLength
70+ | ResServer
71+ | ResDate
72+ | ResLastModified
73+ deriving (Enum,Bounded)
6474
6575-- | The size for 'IndexedHeader' for HTTP Response.
6676responseMaxIndex :: Int
67−responseMaxIndex = 2
77+responseMaxIndex = fromEnum (maxBound :: ResponseHeaderIndex)
6878
6979responseKeyIndex :: HeaderName -> Int
70−responseKeyIndex "content-length" = idxContentLength
71−responseKeyIndex "server" = idxServer
72−responseKeyIndex "date" = idxDate
73−responseKeyIndex _ = -1
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
7488
7589----------------------------------------------------------------
7690
warp/Network/Wai/Handler/Warp/IO.hs+2−1
@@ -3,10 +3,11 @@
33
44module Network.Wai.Handler.Warp.IO where
55
6−import Data.ByteString (ByteString)
76import Data.ByteString.Builder (Builder)
87import Data.ByteString.Builder.Extra (runBuilder, Next(Done, More, Chunk))
8+
99import Network.Wai.Handler.Warp.Buffer
10+import Network.Wai.Handler.Warp.Imports
1011import Network.Wai.Handler.Warp.Types
1112
1213toBufIOWith :: Buffer -> BufSize -> (ByteString -> IO ()) -> Builder -> IO ()
warp/Network/Wai/Handler/Warp/IORef.hsdeleted−26
@@ -1,26 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−
3−#ifndef MIN_VERSION_base
4−#define MIN_VERSION_base(x,y,z) 1
5−#endif
6−
7−module Network.Wai.Handler.Warp.IORef (
8− module Data.IORef
9−#if !MIN_VERSION_base(4,6,0)
10− , atomicModifyIORef'
11−#endif
12− ) where
13−
14−import Data.IORef
15−
16−#if !MIN_VERSION_base(4,6,0)
17−-- | Strict version of 'atomicModifyIORef'. This forces both the value stored
18−-- in the 'IORef' as well as the value returned.
19−atomicModifyIORef' :: IORef a -> (a -> (a,b)) -> IO b
20−atomicModifyIORef' ref f = do
21− c <- atomicModifyIORef ref
22− (\x -> let (a, b) = f x -- Lazy application of "f"
23− in (a, a `seq` b)) -- Lazy application of "seq"
24− -- The following forces "a `seq` b", so it also forces "f x".
25− c `seq` return c
26−#endif
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.hs+7−13
@@ -8,18 +8,7 @@ module Network.Wai.Handler.Warp.Internal (
88 , runSettingsConnection
99 , runSettingsConnectionMaker
1010 , runSettingsConnectionMakerSecure
11− , runServe
12− , runServeEnv
13− , runServeSettings
14− , runServeSettingsSocket
15− , runServeSettingsConnection
16− , runServeSettingsConnectionMaker
17− , runServeSettingsConnectionMakerSecure
1811 , Transport (..)
19− -- * ServeConnection
20− , ServeConnection
21− , serveDefault
22− , serveHTTP2
2312 -- * Connection
2413 , Connection (..)
2514 , socketConnection
@@ -64,7 +53,7 @@ module Network.Wai.Handler.Warp.Internal (
6453 -- resumed as soon as we return from user code.
6554 --
6655 -- * Every time data is successfully sent to the client, the timeout is tickled.
67− , module Network.Wai.Handler.Warp.Timeout
56+ , module System.TimeManager
6857 -- * File descriptor cache
6958 , module Network.Wai.Handler.Warp.FdCache
7059 -- * File information cache
@@ -75,8 +64,13 @@ module Network.Wai.Handler.Warp.Internal (
7564 , Source
7665 , recvRequest
7766 , sendResponse
67+ -- * Platform dependent helper functions
68+ , setSocketCloseOnExec
69+ , windowsThreadBlockHack
7870 ) where
7971
72+import System.TimeManager
73+
8074import Network.Wai.Handler.Warp.Buffer
8175import Network.Wai.Handler.Warp.Date
8276import Network.Wai.Handler.Warp.FdCache
@@ -88,5 +82,5 @@ import Network.Wai.Handler.Warp.Response
8882import Network.Wai.Handler.Warp.Run
8983import Network.Wai.Handler.Warp.SendFile
9084import Network.Wai.Handler.Warp.Settings
91−import Network.Wai.Handler.Warp.Timeout
9285import Network.Wai.Handler.Warp.Types
86+import Network.Wai.Handler.Warp.Windows
warp/Network/Wai/Handler/Warp/MultiMap.hs+65−194
@@ -1,240 +1,111 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE BangPatterns #-}
22
33module Network.Wai.Handler.Warp.MultiMap (
4− MMap
5− , Some(..)
4+ MultiMap
5+ , isEmpty
66 , empty
77 , singleton
88 , insert
9− , search
10− , searchWith
11− , isEmpty
12− , valid
9+ , Network.Wai.Handler.Warp.MultiMap.lookup
1310 , pruneWith
14− , fromList
1511 , toList
16− , fromSortedList
17− , toSortedList
1812 , merge
1913 ) where
2014
21−#if __GLASGOW_HASKELL__ < 709
22−import Control.Applicative ((<$>))
23−#endif
24−import Data.List (foldl')
15+import Data.Hashable (hash)
16+import Data.IntMap.Strict (IntMap)
17+import qualified Data.IntMap.Strict as I
18+import Data.Semigroup
19+import Prelude -- Silence redundant import warnings
2520
2621----------------------------------------------------------------
2722
28−-- | One ore more list to implement multimap.
29−data Some a = One !a
30− | Tom !a !(Some a) -- Two or more
31− deriving (Eq,Show)
32−
33−-- This is slow but assuming rarely used.
34−snoc :: Some a -> a -> Some a
35−snoc (One x) y = Tom x (One y)
36−snoc (Tom x xs) y = Tom x (snoc xs y)
37−
38−top :: Some a -> a
39−top (One x) = x
40−top (Tom x _) = x
41−
42−----------------------------------------------------------------
43−
44−-- | Red black tree as multimap.
45−data MMap k v = Leaf -- color is Black
46− | Node Color !(MMap k v) !k !(Some v) !(MMap k v)
47− deriving (Show)
48−
49−data Color = B -- ^ Black
50− | R -- ^ Red
51− deriving (Eq, Show)
52−
53−----------------------------------------------------------------
54−
55−instance (Eq k, Eq v) => Eq (MMap k v) where
56− t1 == t2 = toSortedList t1 == toSortedList t2
57−
58−----------------------------------------------------------------
59−
60−-- | O(log N)
61−search :: Ord k => k -> MMap k v -> Maybe v
62−search _ Leaf = Nothing
63−search xk (Node _ l k v r) = case compare xk k of
64− LT -> search xk l
65− GT -> search xk r
66− EQ -> Just $ top v
67−
68−-- | O(log N)
69−searchWith :: Ord k => k -> (Some v -> Maybe v) -> MMap k v -> Maybe v
70−searchWith _ _ Leaf = Nothing
71−searchWith xk f (Node _ l k v r) = case compare xk k of
72− LT -> searchWith xk f l
73− GT -> searchWith xk f r
74− EQ -> f v
23+-- | 'MultiMap' is used for cache of file descriptors.
24+-- Since multiple threads would open file descriptors for
25+-- the same file simultaneously, multiple entries must
26+-- be contained for the file.
27+-- Since hash values of file pathes are used as outer keys,
28+-- collison would happen for multiple file pathes.
29+-- Becase only positive entries are contained,
30+-- a bad guy cannot be cause the hash collision intentinally.
31+-- So, lists are good enough.
32+newtype MultiMap v = MultiMap (IntMap [(FilePath,v)])
7533
7634----------------------------------------------------------------
7735
7836-- | O(1)
79−isEmpty :: MMap k v -> Bool
80−isEmpty Leaf = True
81−isEmpty _ = False
37+empty :: MultiMap v
38+empty = MultiMap $ I.empty
8239
8340-- | O(1)
84−empty :: MMap k v
85−empty = Leaf
41+isEmpty :: MultiMap v -> Bool
42+isEmpty (MultiMap mm) = I.null mm
8643
8744----------------------------------------------------------------
8845
8946-- | O(1)
90−singleton :: Ord k => k -> v -> MMap k v
91−singleton k v = Node B Leaf k (One v) Leaf
92−
93−----------------------------------------------------------------
94−
95−-- | O(log N)
96−insert :: Ord k => k -> v -> MMap k v -> MMap k v
97−insert kx kv t = turnB (insert' kx kv t)
98−
99−insert' :: Ord k => k -> v -> MMap k v -> MMap k v
100−insert' xk xv Leaf = Node R Leaf xk (One xv) Leaf
101−insert' xk xv (Node B l k v r) = case compare xk k of
102− LT -> balanceL' (insert' xk xv l) k v r
103− GT -> balanceR' l k v (insert' xk xv r)
104− EQ -> Node B l k (snoc v xv) r
105−insert' xk xv (Node R l k v r) = case compare xk k of
106− LT -> Node R (insert' xk xv l) k v r
107− GT -> Node R l k v (insert' xk xv r)
108− EQ -> Node R l k (snoc v xv) r
109−
110−balanceL' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
111−balanceL' (Node R (Node R a xk xv b) yk yv c) zk zv d =
112− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
113−balanceL' (Node R a xk xv (Node R b yk yv c)) zk zv d =
114− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
115−balanceL' l k v r = Node B l k v r
116−
117−balanceR' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
118−balanceR' a xk xv (Node R b yk yv (Node R c zk zv d)) =
119− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
120−balanceR' a xk xv (Node R (Node R b yk yv c) zk zv d) =
121− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
122−balanceR' l xk xv r = Node B l xk xv r
123−
124−turnB :: MMap k v -> MMap k v
125−turnB Leaf = error "turnB"
126−turnB (Node _ l k v r) = Node B l k v r
47+singleton :: FilePath -> v -> MultiMap v
48+singleton path v = MultiMap mm
49+ where
50+ !h = hash path
51+ !mm = I.singleton h [(path,v)]
12752
12853----------------------------------------------------------------
12954
130−-- | O(N log N)
131−fromList :: Ord k => [(k,v)] -> MMap k v
132−fromList = foldl' (\t (k,v) -> insert k v t) empty
133−
13455-- | O(N)
135−toList :: MMap k v -> [(k,v)]
136−toList t = inorder t []
56+lookup :: FilePath -> MultiMap v -> Maybe v
57+lookup path (MultiMap mm) = case I.lookup h mm of
58+ Nothing -> Nothing
59+ Just s -> Prelude.lookup path s
13760 where
138− inorder Leaf xs = xs
139− inorder (Node _ l k v r) xs = inorder l (pairs k v ++ inorder r xs)
140− pairs k (One v) = [(k,v)]
141− pairs k (Tom v vs) = (k,v) : pairs k vs
61+ !h = hash path
14262
14363----------------------------------------------------------------
14464
145−-- | O(N)
146−-- "Constructing Red-Black Trees" by Ralf Hinze
147−fromSortedList :: Ord k => [(k,Some v)] -> MMap k v
148−fromSortedList = linkAll . foldr add []
149−
150−data Digit k v = Uno k (Some v) (MMap k v)
151− | Due k (Some v) (MMap k v) k (Some v) (MMap k v)
152− deriving (Eq,Show)
153−
154−incr :: Digit k v -> [Digit k v] -> [Digit k v]
155−incr (Uno k v t) [] = [Uno k v t]
156−incr (Uno k1 v1 t1) (Uno k2 v2 t2 : ps) = Due k1 v1 t1 k2 v2 t2 : ps
157−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
158−incr _ _ = error "incr"
159−
160−add :: (k,Some v) -> [Digit k v] -> [Digit k v]
161−add (k,v) ps = incr (Uno k v Leaf) ps
162−
163−linkAll :: [Digit k v] -> MMap k v
164−linkAll = foldl' link Leaf
165−
166−link :: MMap k v -> Digit k v -> MMap k v
167−link l (Uno k v t) = Node B l k v t
168−--link l (Due k1 v1 t1 k2 v2 t2) = Node B (Node R l k1 v1 t1) k2 v2 t2
169−link l (Due k1 v1 t1 k2 v2 t2) = Node B l k1 v1 (Node R t1 k2 v2 t2)
65+-- | O(log n)
66+insert :: FilePath -> v -> MultiMap v -> MultiMap v
67+insert path v (MultiMap mm) = MultiMap mm'
68+ where
69+ !h = hash path
70+ !mm' = I.insertWith (<>) h [(path,v)] mm
17071
17172----------------------------------------------------------------
17273
173−-- | O(N)
174−toSortedList :: MMap k v -> [(k,Some v)]
175−toSortedList t = inorder t []
176− where
177− inorder Leaf xs = xs
178− inorder (Node _ l k v r) xs = inorder l ((k,v) : inorder r xs)
74+-- | O(n)
75+toList :: MultiMap v -> [(FilePath,v)]
76+toList (MultiMap mm) = concatMap snd $ I.toAscList mm
17977
18078----------------------------------------------------------------
18179
182−-- | O(N)
183−pruneWith :: Ord k =>
184− MMap k v
185− -> (k -> Some v -> IO [(k, Some v)])
186− -> IO (MMap k v)
187−pruneWith t run = fromSortedList <$> inorder t []
80+-- | O(n)
81+pruneWith :: MultiMap v
82+ -> ((FilePath,v) -> IO Bool)
83+ -> IO (MultiMap v)
84+pruneWith (MultiMap mm) action = MultiMap <$> mm'
18885 where
189− inorder Leaf xs = return xs
190− inorder (Node _ l k v r) xs = do
191− ys <- run k v
192− zs <- inorder r xs
193− inorder l (ys ++ zs)
86+ !mm' = I.fromAscList <$> go (I.toDescList mm) []
87+ go [] !acc = return acc
88+ go ((h,s):kss) !acc = do
89+ rs <- prune action s
90+ case rs of
91+ [] -> go kss acc
92+ _ -> go kss ((h,rs) : acc)
19493
19594----------------------------------------------------------------
19695
197−-- O(N log N) where N is the size of the second argument
198−merge :: Ord k => MMap k v -> MMap k v -> MMap k v
199−merge base m = foldl' ins base xs
96+-- O(n + m) where N is the size of the second argument
97+merge :: MultiMap v -> MultiMap v -> MultiMap v
98+merge (MultiMap m1) (MultiMap m2) = MultiMap mm
20099 where
201− ins t (k,v) = insert k v t
202− xs = toList m
100+ !mm = I.unionWith (<>) m1 m2
203101
204102----------------------------------------------------------------
205−-- for testing
206−
207−valid :: Ord k => MMap k v -> Bool
208−valid t = isBalanced t && isOrdered t
209103
210−isBalanced :: MMap k v -> Bool
211−isBalanced t = isBlackSame t && isRedSeparate t
212−
213−isBlackSame :: MMap k v -> Bool
214−isBlackSame t = all (n==) ns
215− where
216− n:ns = blacks t
217−
218−blacks :: MMap k v -> [Int]
219−blacks = blacks' 0
220− where
221− blacks' n Leaf = [n+1]
222− blacks' n (Node R l _ _ r) = blacks' n l ++ blacks' n r
223− blacks' n (Node B l _ _ r) = blacks' n' l ++ blacks' n' r
224− where
225− n' = n + 1
226−
227−isRedSeparate :: MMap k v -> Bool
228−isRedSeparate = reds B
229−
230−reds :: Color -> MMap k v -> Bool
231−reds _ Leaf = True
232−reds R (Node R _ _ _ _) = False
233−reds _ (Node c l _ _ r) = reds c l && reds c r
234−
235−isOrdered :: Ord k => MMap k v -> Bool
236−isOrdered t = ordered $ toSortedList t
104+prune :: ((FilePath,v) -> IO Bool) -> [(FilePath,v)] -> IO [(FilePath,v)]
105+prune action xs0 = go xs0
237106 where
238− ordered [] = True
239− ordered [_] = True
240− ordered (x:y:xys) = fst x <= fst y && ordered (y:xys)
107+ go [] = return []
108+ go (x:xs) = do
109+ keep <- action x
110+ rs <- go xs
111+ return $ if keep then x:rs else rs
warp/Network/Wai/Handler/Warp/PackInt.hsnew file+56
@@ -0,0 +1,56 @@
1+{-# LANGUAGE OverloadedStrings, BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.PackInt where
4+
5+import Data.ByteString.Internal (unsafeCreate)
6+import Foreign.Ptr (Ptr, plusPtr)
7+import Foreign.Storable (poke)
8+import qualified Network.HTTP.Types as H
9+
10+import Network.Wai.Handler.Warp.Imports
11+
12+-- $setup
13+-- >>> import Data.ByteString.Char8 as C8
14+-- >>> import Test.QuickCheck (Large(..))
15+
16+-- |
17+--
18+-- prop> packIntegral (abs n) == C8.pack (show (abs n))
19+-- prop> \(Large n) -> let n' = fromIntegral (abs n :: Int) in packIntegral n' == C8.pack (show n')
20+
21+packIntegral :: Integral a => a -> ByteString
22+packIntegral 0 = "0"
23+packIntegral n | n < 0 = error "packIntegral"
24+packIntegral n = unsafeCreate len go0
25+ where
26+ n' = fromIntegral n + 1 :: Double
27+ len = ceiling $ logBase 10 n'
28+ go0 p = go n $ p `plusPtr` (len - 1)
29+ go :: Integral a => a -> Ptr Word8 -> IO ()
30+ go i p = do
31+ let (d,r) = i `divMod` 10
32+ poke p (48 + fromIntegral r)
33+ when (d /= 0) $ go d (p `plusPtr` (-1))
34+
35+{-# SPECIALIZE packIntegral :: Int -> ByteString #-}
36+{-# SPECIALIZE packIntegral :: Integer -> ByteString #-}
37+
38+-- |
39+--
40+-- >>> packStatus H.status200
41+-- "200"
42+-- >>> packStatus H.preconditionFailed412
43+-- "412"
44+
45+packStatus :: H.Status -> ByteString
46+packStatus status = unsafeCreate 3 $ \p -> do
47+ poke p (toW8 r2)
48+ poke (p `plusPtr` 1) (toW8 r1)
49+ poke (p `plusPtr` 2) (toW8 r0)
50+ where
51+ toW8 :: Int -> Word8
52+ toW8 n = 48 + fromIntegral n
53+ !s = fromIntegral $ H.statusCode status
54+ (!q0,!r0) = s `divMod` 10
55+ (!q1,!r1) = q0 `divMod` 10
56+ !r2 = q1 `mod` 10
warp/Network/Wai/Handler/Warp/ReadInt.hs+2−2
@@ -13,13 +13,13 @@ module Network.Wai.Handler.Warp.ReadInt (
1313-- This function lives in its own file because the MagicHash pragma interacts
1414-- poorly with the CPP pragma.
1515
16−import Data.ByteString (ByteString)
1716import qualified Data.ByteString as S
18−import Data.Int (Int64)
1917import GHC.Prim
2018import GHC.Types
2119import GHC.Word
2220
21+import Network.Wai.Handler.Warp.Imports hiding (readInt)
22+
2323{-# INLINE readInt #-}
2424readInt :: Integral a => ByteString -> a
2525readInt bs = fromIntegral $ readInt64 bs
warp/Network/Wai/Handler/Warp/Recv.hs+44−17
@@ -9,23 +9,27 @@ module Network.Wai.Handler.Warp.Recv (
99 , spell
1010 ) where
1111
12−#if __GLASGOW_HASKELL__ < 709
13−import Control.Applicative ((<$>))
14−#endif
1512import qualified Control.Exception as E
1613import qualified Data.ByteString as BS
17−import Data.ByteString.Internal (ByteString(..))
18−import Data.Word (Word8)
14+import Data.IORef
1915import Foreign.C.Error (eAGAIN, getErrno, throwErrno)
2016import Foreign.C.Types
2117import Foreign.ForeignPtr (withForeignPtr)
2218import Foreign.Ptr (Ptr, castPtr, plusPtr)
2319import GHC.Conc (threadWaitRead)
24−import Network.Socket (Socket, fdSocket)
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+
2530import Network.Wai.Handler.Warp.Buffer
26−import Network.Wai.Handler.Warp.IORef
31+import Network.Wai.Handler.Warp.Imports
2732import Network.Wai.Handler.Warp.Types
28−import System.Posix.Types (Fd(..))
2933
3034#ifdef mingw32_HOST_OS
3135import GHC.IO.FD (FD(..), readRawBufferPtr)
@@ -92,24 +96,45 @@ spell init0 siz0 recv recvBuf
9296 siz' = siz - len
9397 loop bss' siz'
9498
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.
95102receive :: Socket -> BufferPool -> Recv
96−receive sock pool = withBufferPool pool $ \ (ptr, size) -> do
97− let sock' = fdSocket sock
98− size' = fromIntegral size
99− fromIntegral <$> receiveloop sock' ptr size'
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
100118
101119receiveBuf :: Socket -> RecvBuf
102−receiveBuf sock buf0 siz0 = loop buf0 siz0
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
103129 where
104− loop _ 0 = return True
105− loop buf siz = do
130+ loop _ _ 0 = return True
131+ loop fd buf siz = do
106132 n <- fromIntegral <$> receiveloop fd buf (fromIntegral siz)
107133 -- fixme: what should we do in the case of n == 0
108134 if n == 0 then
109135 return False
110136 else
111− loop (buf `plusPtr` n) (siz - n)
112− fd = fdSocket sock
137+ loop fd (buf `plusPtr` n) (siz - n)
113138
114139receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
115140receiveloop sock ptr size = do
@@ -128,6 +153,8 @@ receiveloop sock ptr size = do
128153 else
129154 return bytes
130155
156+#ifndef mingw32_HOST_OS
131157-- fixme: the type of the return value
132158foreign import ccall unsafe "recv"
133159 c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt
160+#endif
warp/Network/Wai/Handler/Warp/Request.hs+57−41
@@ -1,6 +1,7 @@
11{-# LANGUAGE BangPatterns #-}
22{-# LANGUAGE OverloadedStrings #-}
33{-# LANGUAGE CPP #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
45{-# OPTIONS_GHC -fno-warn-deprecations #-}
56
67module Network.Wai.Handler.Warp.Request (
@@ -8,48 +9,49 @@ module Network.Wai.Handler.Warp.Request (
89 , headerLines
910 , pauseTimeoutKey
1011 , getFileInfoKey
12+ , getClientCertificateKey
13+ , NoKeepAliveRequest (..)
1114 ) where
1215
1316import qualified Control.Concurrent as Conc (yield)
14−import Control.Exception (throwIO)
17+import Control.Exception (throwIO, Exception)
1518import Data.Array ((!))
16−import Data.ByteString (ByteString)
1719import qualified Data.ByteString as S
1820import qualified Data.ByteString.Unsafe as SU
1921import qualified Data.CaseInsensitive as CI
2022import qualified Data.IORef as I
23+import Data.Typeable (Typeable)
24+import qualified Data.Vault.Lazy as Vault
25+import Data.X509
2126import qualified Network.HTTP.Types as H
2227import Network.Socket (SockAddr)
2328import Network.Wai
24−import Network.Wai.Handler.Warp.Conduit
25−import Network.Wai.Handler.Warp.FileInfoCache
26−import Network.Wai.Handler.Warp.Header
27−import Network.Wai.Handler.Warp.ReadInt
28−import Network.Wai.Handler.Warp.RequestHeader
29−import Network.Wai.Handler.Warp.Settings (Settings, settingsNoParsePath)
30−import qualified Network.Wai.Handler.Warp.Timeout as Timeout
3129import Network.Wai.Handler.Warp.Types
3230import Network.Wai.Internal
3331import Prelude hiding (lines)
34−import Control.Monad (when)
35−import qualified Data.Vault.Lazy as Vault
3632import System.IO.Unsafe (unsafePerformIO)
33+import qualified System.TimeManager as Timeout
3734
38−----------------------------------------------------------------
39−
40−-- FIXME come up with good values here
41−maxTotalHeaderLength :: Int
42−maxTotalHeaderLength = 50 * 1024
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)
4342
4443----------------------------------------------------------------
4544
4645-- | Receiving a HTTP request from 'Connection' and parsing its header
4746-- to create 'Request'.
48−recvRequest :: Settings
47+recvRequest :: Bool -- ^ first request on this connection?
48+ -> Settings
4949 -> Connection
5050 -> InternalInfo
51+ -> Timeout.Handle
5152 -> SockAddr -- ^ Peer's address.
5253 -> Source -- ^ Where HTTP request comes from.
54+ -> Transport
5355 -> IO (Request
5456 ,Maybe (I.IORef Int)
5557 ,IndexedHeader
@@ -59,14 +61,19 @@ recvRequest :: Settings
5961 -- 'IndexedHeader' of HTTP request for internal use,
6062 -- Body producing action used for flushing the request body
6163
62−recvRequest settings conn ii addr src = do
63− hdrlines <- headerLines src
64+recvRequest firstRequest settings conn ii th addr src transport = do
65+ hdrlines <- headerLines (settingsMaxTotalHeaderLength settings) firstRequest src
6466 (method, unparsedPath, path, query, httpversion, hdr) <- parseHeaderLines hdrlines
6567 let idxhdr = indexRequestHeader hdr
66− expect = idxhdr ! idxExpect
67− cl = idxhdr ! idxContentLength
68− te = idxhdr ! idxTransferEncoding
68+ expect = idxhdr ! fromEnum ReqExpect
69+ cl = idxhdr ! fromEnum ReqContentLength
70+ te = idxhdr ! fromEnum ReqTransferEncoding
6971 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
7077 (rbody, remainingRef, bodyLength) <- bodyAndSource src cl te
7178 -- body producing function which will produce '100-continue', if needed
7279 rbody' <- timeoutBody remainingRef th rbody handle100Continue
@@ -76,33 +83,38 @@ recvRequest settings conn ii addr src = do
7683 requestMethod = method
7784 , httpVersion = httpversion
7885 , pathInfo = H.decodePathSegments path
79− , rawPathInfo = if settingsNoParsePath settings then unparsedPath else path
86+ , rawPathInfo = rawPath
8087 , rawQueryString = query
8188 , queryString = H.parseQuery query
8289 , requestHeaders = hdr
83− , isSecure = False
90+ , isSecure = isTransportSecure transport
8491 , remoteHost = addr
8592 , requestBody = rbody'
8693 , vault = vaultValue
8794 , requestBodyLength = bodyLength
88− , requestHeaderHost = idxhdr ! idxHost
89− , requestHeaderRange = idxhdr ! idxRange
95+ , requestHeaderHost = idxhdr ! fromEnum ReqHost
96+ , requestHeaderRange = idxhdr ! fromEnum ReqRange
97+ , requestHeaderReferer = idxhdr ! fromEnum ReqReferer
98+ , requestHeaderUserAgent = idxhdr ! fromEnum ReqUserAgent
9099 }
91100 return (req, remainingRef, idxhdr, rbodyFlush)
92− where
93− th = threadHandle ii
94− vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
95− $ Vault.insert getFileInfoKey (fileInfo ii)
96− Vault.empty
97101
98102----------------------------------------------------------------
99103
100−headerLines :: Source -> IO [ByteString]
101−headerLines src = do
104+headerLines :: Int -> Bool -> Source -> IO [ByteString]
105+headerLines maxTotalHeaderLength firstRequest src = do
102106 bs <- readSource src
103107 if S.null bs
104− then throwIO ConnectionClosedByPeer
105− else push src (THStatus 0 id id) 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
106118
107119----------------------------------------------------------------
108120
@@ -208,8 +220,8 @@ close :: Sink ByteString IO a
208220close = throwIO IncompleteHeaders
209221-}
210222
211−push :: Source -> THStatus -> ByteString -> IO [ByteString]
212−push src (THStatus len lines prepend) bs'
223+push :: Int -> Source -> THStatus -> ByteString -> IO [ByteString]
224+push maxTotalHeaderLength src (THStatus len lines prepend) bs'
213225 -- Too many bytes
214226 | len > maxTotalHeaderLength = throwIO OverLargeHeader
215227 | otherwise = push' mnl
@@ -237,13 +249,13 @@ push src (THStatus len lines prepend) bs'
237249 push' Nothing = do
238250 bst <- readSource' src
239251 when (S.null bst) $ throwIO IncompleteHeaders
240− push src status bst
252+ push maxTotalHeaderLength src status bst
241253 where
242254 len' = len + bsLen
243255 prepend' = S.append bs
244256 status = THStatus len' lines prepend'
245257 -- Found a newline, but next line continues as a multiline header
246− push' (Just (end, True)) = push src status rest
258+ push' (Just (end, True)) = push maxTotalHeaderLength src status rest
247259 where
248260 rest = S.drop (end + 1) bs
249261 prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
@@ -262,12 +274,12 @@ push src (THStatus len lines prepend) bs'
262274 in if start < bsLen then
263275 -- more bytes in this chunk, push again
264276 let bs'' = SU.unsafeDrop start bs
265− in push src status bs''
277+ in push maxTotalHeaderLength src status bs''
266278 else do
267279 -- no more bytes in this chunk, ask for more
268280 bst <- readSource' src
269281 when (S.null bs) $ throwIO IncompleteHeaders
270− push src status bst
282+ push maxTotalHeaderLength src status bst
271283 where
272284 start = end + 1 -- start of next chunk
273285 line = SU.unsafeTake (checkCR bs end) bs
@@ -285,3 +297,7 @@ pauseTimeoutKey = unsafePerformIO Vault.newKey
285297getFileInfoKey :: Vault.Key (FilePath -> IO FileInfo)
286298getFileInfoKey = unsafePerformIO Vault.newKey
287299{-# NOINLINE getFileInfoKey #-}
300+
301+getClientCertificateKey :: Vault.Key (Maybe CertificateChain)
302+getClientCertificateKey = unsafePerformIO Vault.newKey
303+{-# NOINLINE getClientCertificateKey #-}
warp/Network/Wai/Handler/Warp/RequestHeader.hs+6−8
@@ -1,24 +1,22 @@
1−{-# LANGUAGE OverloadedStrings #-}
21{-# LANGUAGE BangPatterns #-}
32
43module Network.Wai.Handler.Warp.RequestHeader (
54 parseHeaderLines
6− , parseByteRanges
75 ) where
86
97import Control.Exception (throwIO)
10−import Control.Monad (when)
118import qualified Data.ByteString as S
12−import qualified Data.ByteString.Char8 as B (unpack)
13−import Data.ByteString.Internal (ByteString(..), memchr)
9+import qualified Data.ByteString.Char8 as C8 (unpack)
10+import Data.ByteString.Internal (memchr)
1411import qualified Data.CaseInsensitive as CI
15−import Data.Word (Word8)
1612import Foreign.ForeignPtr (withForeignPtr)
1713import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
1814import Foreign.Storable (peek)
1915import qualified Network.HTTP.Types as H
16+
17+import Network.Wai.Handler.Warp.Imports
2018import Network.Wai.Handler.Warp.Types
21−import Network.Wai.Internal (parseByteRanges)
19+
2220-- $setup
2321-- >>> :set -XOverloadedStrings
2422
@@ -90,7 +88,7 @@ parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> d
9088
9189 return (method,path,query,hv)
9290 where
93− baderr = BadFirstLine $ B.unpack requestLine
91+ baderr = BadFirstLine $ C8.unpack requestLine
9492 check :: Ptr Word8 -> Int -> Word8 -> IO ()
9593 check p n w = do
9694 w0 <- peek $ p `plusPtr` n
warp/Network/Wai/Handler/Warp/Response.hs+128−128
@@ -1,75 +1,46 @@
11{-# LANGUAGE OverloadedStrings #-}
22{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE TupleSections #-}
43{-# LANGUAGE RankNTypes #-}
54{-# LANGUAGE CPP #-}
5+{-# LANGUAGE BangPatterns #-}
66
77module Network.Wai.Handler.Warp.Response (
88 sendResponse
99 , sanitizeHeaderValue -- for testing
10− , fileRange -- for testing
1110 , warpVersion
12− , addDate
13− , addServer
1411 , hasBody
12+ , replaceHeader
13+ , addServer -- testing
1514 ) where
1615
17−#ifndef MIN_VERSION_base
18−#define MIN_VERSION_base(x,y,z) 1
19−#endif
20−
21−#ifndef MIN_VERSION_http_types
22−#define MIN_VERSION_http_types(x,y,z) 1
23−#endif
24−
25−import Blaze.ByteString.Builder.HTTP (chunkedTransferEncoding, chunkedTransferTerminator)
26−#if __GLASGOW_HASKELL__ < 709
27−import Control.Applicative
28−#endif
29−import Control.Monad (unless, when)
16+import Data.ByteString.Builder.HTTP.Chunked (chunkedTransferEncoding, chunkedTransferTerminator)
17+import qualified Control.Exception as E
3018import Data.Array ((!))
31−import Data.ByteString (ByteString)
3219import qualified Data.ByteString as S
33−import qualified Data.ByteString.Char8 as S8
3420import Data.ByteString.Builder (byteString, Builder)
3521import Data.ByteString.Builder.Extra (flush)
22+import qualified Data.ByteString.Char8 as C8
3623import qualified Data.CaseInsensitive as CI
3724import Data.Function (on)
38−import Data.List (deleteBy)
39−import Data.Maybe
40−#if MIN_VERSION_base(4,5,0)
41−# if __GLASGOW_HASKELL__ < 709
42−import Data.Monoid (mempty)
43−# endif
44−import Data.Monoid ((<>))
45−#else
46−import Data.Monoid (mappend, mempty)
47−#endif
48−import Data.Streaming.Blaze (newBlazeRecv, reuseBufferStrategy)
25+import Data.Streaming.ByteString.Builder (newByteStringBuilderRecv, reuseBufferStrategy)
4926import Data.Version (showVersion)
5027import Data.Word8 (_cr, _lf)
5128import qualified Network.HTTP.Types as H
52−#if MIN_VERSION_http_types(0,9,0)
5329import qualified Network.HTTP.Types.Header as H
54−#endif
5530import Network.Wai
31+import Network.Wai.Internal
32+import qualified Paths_warp
33+import qualified System.TimeManager as T
34+
5635import Network.Wai.Handler.Warp.Buffer (toBuilderBuffer)
5736import qualified Network.Wai.Handler.Warp.Date as D
58−import qualified Network.Wai.Handler.Warp.FdCache as F
5937import Network.Wai.Handler.Warp.File
6038import Network.Wai.Handler.Warp.Header
6139import Network.Wai.Handler.Warp.IO (toBufIOWith)
40+import Network.Wai.Handler.Warp.Imports
6241import Network.Wai.Handler.Warp.ResponseHeader
6342import Network.Wai.Handler.Warp.Settings
64−import qualified Network.Wai.Handler.Warp.Timeout as T
6543import Network.Wai.Handler.Warp.Types
66−import Network.Wai.Internal
67−import qualified Paths_warp
68−
69−#if !MIN_VERSION_base(4,5,0)
70−(<>) :: Monoid m => m -> m -> m
71−(<>) = mappend
72−#endif
7344
7445-- $setup
7546-- >>> :set -XOverloadedStrings
@@ -78,11 +49,12 @@ import qualified Paths_warp
7849
7950-- | Sending a HTTP response to 'Connection' according to 'Response'.
8051--
81−-- Applications/middlewares MUST specify a proper 'H.ResponseHeaders'.
52+-- Applications/middlewares MUST provide a proper 'H.ResponseHeaders'.
8253-- so that inconsistency does not happen.
8354-- No header is deleted by this function.
8455--
85−-- Especially, Applications/middlewares MUST take care of
56+-- Especially, Applications/middlewares MUST provide a proper
57+-- Content-Type. They MUST NOT provide
8658-- Content-Length, Content-Range, and Transfer-Encoding
8759-- because they are inserted, when necessary,
8860-- regardless they already exist.
@@ -94,22 +66,6 @@ import qualified Paths_warp
9466--
9567-- There are three basic APIs to create 'Response':
9668--
97−-- ['responseFile' :: 'H.Status' -> 'H.ResponseHeaders' -> 'FilePath' -> 'Maybe' 'FilePart' -> 'Response']
98−-- HTTP response body is sent by sendfile() for GET method.
99−-- HTTP response body is not sent by HEAD method.
100−-- Applications are categorized into simple and sophisticated.
101−-- Simple applications should specify 'Nothing' to
102−-- 'Maybe' 'FilePart'. The size of the specified file is obtained
103−-- by disk access. Then Range is handled.
104−-- Sophisticated applications should specify 'Just' to
105−-- 'Maybe' 'FilePart'. They should treat Range (and If-Range) by
106−-- themselves. In both cases,
107−-- Content-Length and Content-Range (if necessary) are automatically
108−-- added into the HTTP response header.
109−-- If Content-Length and Content-Range exist in the HTTP response header,
110−-- they would cause inconsistency.
111−-- Status is also changed to 206 (Partial Content) if necessary.
112−--
11369-- ['responseBuilder' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Builder' -> 'Response']
11470-- HTTP response body is created from 'Builder'.
11571-- Transfer-Encoding: chunked is used in HTTP/1.1.
@@ -120,16 +76,38 @@ import qualified Paths_warp
12076--
12177-- ['responseRaw' :: ('IO' 'ByteString' -> ('ByteString' -> 'IO' ()) -> 'IO' ()) -> 'Response' -> 'Response']
12278-- 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.
123100
124101sendResponse :: Settings
125102 -> Connection
126103 -> InternalInfo
104+ -> T.Handle
127105 -> Request -- ^ HTTP request.
128106 -> IndexedHeader -- ^ Indexed header of HTTP request.
129107 -> IO ByteString -- ^ source from client, for raw response
130108 -> Response -- ^ HTTP response including status code and response header.
131109 -> IO Bool -- ^ Returing True if the connection is persistent.
132−sendResponse settings conn ii req reqidxhdr src response = do
110+sendResponse settings conn ii th req reqidxhdr src response = do
133111 hs <- addServerAndDate hs0
134112 if hasBody s then do
135113 -- The response to HEAD does not have body.
@@ -138,14 +116,14 @@ sendResponse settings conn ii req reqidxhdr src response = do
138116 -- and status, the response to HEAD is processed here.
139117 --
140118 -- See definition of rsp below for proper body stripping.
141− (ms, mlen) <- sendRsp conn ii ver s hs rsp
119+ (ms, mlen) <- sendRsp conn ii ver s hs rspidxhdr rsp
142120 case ms of
143121 Nothing -> return ()
144122 Just realStatus -> logger req realStatus mlen
145123 T.tickle th
146124 return ret
147125 else do
148− _ <- sendRsp conn ii ver s hs RspNoBody
126+ _ <- sendRsp conn ii ver s hs rspidxhdr RspNoBody
149127 logger req s Nothing
150128 T.tickle th
151129 return isPersist
@@ -156,16 +134,14 @@ sendResponse settings conn ii req reqidxhdr src response = do
156134 s = responseStatus response
157135 hs0 = sanitizeHeaders $ responseHeaders response
158136 rspidxhdr = indexResponseHeader hs0
159− th = threadHandle ii
160− dc = dateCacher ii
161− addServerAndDate = addDate dc rspidxhdr . addServer defServer rspidxhdr
162− mRange = reqidxhdr ! idxRange
137+ getdate = getDate ii
138+ addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
163139 (isPersist,isChunked0) = infoFromRequest req reqidxhdr
164140 isChunked = not isHead && isChunked0
165141 (isKeepAlive, needsChunked) = infoFromResponse rspidxhdr (isPersist,isChunked)
166142 isHead = requestMethod req == H.methodHead
167143 rsp = case response of
168− ResponseFile _ _ path mPart -> RspFile path mPart mRange isHead (T.tickle th)
144+ ResponseFile _ _ path mPart -> RspFile path mPart reqidxhdr isHead (T.tickle th)
169145 ResponseBuilder _ _ b
170146 | isHead -> RspNoBody
171147 | otherwise -> RspBuilder b needsChunked
@@ -173,7 +149,8 @@ sendResponse settings conn ii req reqidxhdr src response = do
173149 | isHead -> RspNoBody
174150 | otherwise -> RspStream fb needsChunked th
175151 ResponseRaw raw _ -> RspRaw raw src (T.tickle th)
176− ret = case response of
152+ -- Make sure we don't hang on to 'response' (avoid space leak)
153+ !ret = case response of
177154 ResponseFile {} -> isPersist
178155 ResponseBuilder {} -> isKeepAlive
179156 ResponseStream {} -> isKeepAlive
@@ -194,11 +171,11 @@ containsNewlines = S.any (\w -> w == _cr || w == _lf)
194171
195172{-# INLINE sanitizeHeaderValue #-}
196173sanitizeHeaderValue :: ByteString -> ByteString
197−sanitizeHeaderValue v = case S8.lines $ S.filter (/= _cr) v of
174+sanitizeHeaderValue v = case C8.lines $ S.filter (/= _cr) v of
198175 [] -> ""
199− x : xs -> S8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
176+ x : xs -> C8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
200177 where
201− addSpaceIfMissing line = case S8.uncons line of
178+ addSpaceIfMissing line = case C8.uncons line of
202179 Nothing -> Nothing
203180 Just (first, _)
204181 | first == ' ' || first == '\t' -> Just line
@@ -207,7 +184,7 @@ sanitizeHeaderValue v = case S8.lines $ S.filter (/= _cr) v of
207184----------------------------------------------------------------
208185
209186data Rsp = RspNoBody
210− | RspFile FilePath (Maybe FilePart) (Maybe HeaderValue) Bool (IO ())
187+ | RspFile FilePath (Maybe FilePart) IndexedHeader Bool (IO ())
211188 | RspBuilder Builder Bool
212189 | RspStream StreamingBody Bool T.Handle
213190 | RspRaw (IO ByteString -> (ByteString -> IO ()) -> IO ()) (IO ByteString) (IO ())
@@ -219,12 +196,13 @@ sendRsp :: Connection
219196 -> H.HttpVersion
220197 -> H.Status
221198 -> H.ResponseHeaders
199+ -> IndexedHeader -- Response
222200 -> Rsp
223201 -> IO (Maybe H.Status, Maybe Integer)
224202
225203----------------------------------------------------------------
226204
227−sendRsp conn _ ver s hs RspNoBody = do
205+sendRsp conn _ ver s hs _ RspNoBody = do
228206 -- Not adding Content-Length.
229207 -- User agents treats it as Content-Length: 0.
230208 composeHeader ver s hs >>= connSendAll conn
@@ -232,48 +210,7 @@ sendRsp conn _ ver s hs RspNoBody = do
232210
233211----------------------------------------------------------------
234212
235−sendRsp conn ii ver s0 hs0 (RspFile path mPart mRange isHead hook) = do
236− ex <- fileRange s0 hs0 path mPart mRange get
237− case ex of
238− Left _ex ->
239−#ifdef WARP_DEBUG
240− print _ex >>
241−#endif
242− sendRsp conn ii ver s2 hs2 (RspBuilder body True)
243− Right (s, hs, beg, len)
244− | len >= 0 ->
245− if isHead then
246− sendRsp conn ii ver s hs RspNoBody
247− else do
248− lheader <- composeHeader ver s hs
249−#ifdef WINDOWS
250− let fid = FileId path Nothing
251− hook' = hook
252−#else
253− (mfd, hook') <- case mfdc of
254− -- settingsFdCacheDuration is 0
255− Nothing -> return (Nothing, hook)
256− Just fdc -> do
257− (fd, fresher) <- F.getFd fdc path
258− return (Just fd, hook >> fresher)
259− let fid = FileId path mfd
260−#endif
261− connSendFile conn fid beg len hook' [lheader]
262− return (Just s, Just len)
263− | otherwise -> do
264− sendRsp conn ii ver H.requestedRangeNotSatisfiable416
265− (filter (\(k, _) -> k /= "content-length") hs)
266− (RspBuilder mempty True)
267− where
268− s2 = H.notFound404
269− hs2 = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
270− body = byteString "File not found"
271− mfdc = fdCacher ii
272− get = fileInfo ii
273−
274−----------------------------------------------------------------
275−
276−sendRsp conn _ ver s hs (RspBuilder body needsChunked) = do
213+sendRsp conn _ ver s hs _ (RspBuilder body needsChunked) = do
277214 header <- composeHeaderBuilder ver s hs needsChunked
278215 let hdrBdy
279216 | needsChunked = header <> chunkedTransferEncoding body
@@ -286,9 +223,9 @@ sendRsp conn _ ver s hs (RspBuilder body needsChunked) = do
286223
287224----------------------------------------------------------------
288225
289−sendRsp conn _ ver s hs (RspStream streamingBody needsChunked th) = do
226+sendRsp conn _ ver s hs _ (RspStream streamingBody needsChunked th) = do
290227 header <- composeHeaderBuilder ver s hs needsChunked
291− (recv, finish) <- newBlazeRecv $ reuseBufferStrategy
228+ (recv, finish) <- newByteStringBuilderRecv $ reuseBufferStrategy
292229 $ toBuilderBuffer (connWriteBuffer conn) (connBufferSize conn)
293230 let send builder = do
294231 popper <- recv builder
@@ -310,7 +247,7 @@ sendRsp conn _ ver s hs (RspStream streamingBody needsChunked th) = do
310247
311248----------------------------------------------------------------
312249
313−sendRsp conn _ _ _ _ (RspRaw withApp src tickle) = do
250+sendRsp conn _ _ _ _ _ (RspRaw withApp src tickle) = do
314251 withApp recv send
315252 return (Nothing, Nothing)
316253 where
@@ -320,6 +257,69 @@ sendRsp conn _ _ _ _ (RspRaw withApp src tickle) = do
320257 return bs
321258 send bs = connSendAll conn bs >> tickle
322259
260+----------------------------------------------------------------
261+
262+-- Sophisticated WAI applications.
263+-- We respect s0. s0 MUST be a proper value.
264+sendRsp conn ii ver s0 hs0 rspidxhdr (RspFile path (Just part) _ isHead hook) =
265+ sendRspFile2XX conn ii ver s0 hs rspidxhdr path beg len isHead hook
266+ where
267+ beg = filePartOffset part
268+ len = filePartByteCount part
269+ hs = addContentHeadersForFilePart hs0 part
270+
271+----------------------------------------------------------------
272+
273+-- Simple WAI applications.
274+-- Status is ignored
275+sendRsp conn ii ver _ hs0 rspidxhdr (RspFile path Nothing reqidxhdr isHead hook) = do
276+ efinfo <- E.try $ getFileInfo ii path
277+ case efinfo of
278+ Left (_ex :: E.IOException) ->
279+#ifdef WARP_DEBUG
280+ print _ex >>
281+#endif
282+ sendRspFile404 conn ii ver hs0 rspidxhdr
283+ Right finfo -> case conditionalRequest finfo hs0 rspidxhdr reqidxhdr of
284+ WithoutBody s -> sendRsp conn ii ver s hs0 rspidxhdr RspNoBody
285+ WithBody s hs beg len -> sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
286+
287+----------------------------------------------------------------
288+
289+sendRspFile2XX :: Connection
290+ -> InternalInfo
291+ -> H.HttpVersion
292+ -> H.Status
293+ -> H.ResponseHeaders
294+ -> IndexedHeader
295+ -> FilePath
296+ -> Integer
297+ -> Integer
298+ -> Bool
299+ -> IO ()
300+ -> IO (Maybe H.Status, Maybe Integer)
301+sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
302+ | isHead = sendRsp conn ii ver s hs rspidxhdr RspNoBody
303+ | otherwise = do
304+ lheader <- composeHeader ver s hs
305+ (mfd, fresher) <- getFd ii path
306+ let fid = FileId path mfd
307+ hook' = hook >> fresher
308+ connSendFile conn fid beg len hook' [lheader]
309+ return (Just s, Just len)
310+
311+sendRspFile404 :: Connection
312+ -> InternalInfo
313+ -> H.HttpVersion
314+ -> H.ResponseHeaders
315+ -> IndexedHeader
316+ -> IO (Maybe H.Status, Maybe Integer)
317+sendRspFile404 conn ii ver hs0 rspidxhdr = sendRsp conn ii ver s hs rspidxhdr (RspBuilder body True)
318+ where
319+ s = H.notFound404
320+ hs = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
321+ body = byteString "File not found"
322+
323323----------------------------------------------------------------
324324----------------------------------------------------------------
325325
@@ -346,7 +346,7 @@ checkPersist req reqidxhdr
346346 | otherwise = checkPersist10 conn
347347 where
348348 ver = httpVersion req
349− conn = reqidxhdr ! idxConnection
349+ conn = reqidxhdr ! fromEnum ReqConnection
350350 checkPersist11 (Just x)
351351 | CI.foldCase x == "close" = False
352352 checkPersist11 _ = True
@@ -371,7 +371,7 @@ infoFromResponse rspidxhdr (isPersist,isChunked) = (isKeepAlive, needsChunked)
371371 where
372372 needsChunked = isChunked && not hasLength
373373 isKeepAlive = isPersist && (isChunked || hasLength)
374− hasLength = isJust $ rspidxhdr ! idxContentLength
374+ hasLength = isJust $ rspidxhdr ! fromEnum ResContentLength
375375
376376----------------------------------------------------------------
377377
@@ -385,16 +385,12 @@ hasBody s = sc /= 204
385385----------------------------------------------------------------
386386
387387addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
388−#if MIN_VERSION_http_types(0,9,0)
389388addTransferEncoding hdrs = (H.hTransferEncoding, "chunked") : hdrs
390−#else
391−addTransferEncoding hdrs = ("transfer-encoding", "chunked") : hdrs
392−#endif
393389
394−addDate :: D.DateCache -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
395−addDate dc rspidxhdr hdrs = case rspidxhdr ! idxDate of
390+addDate :: IO D.GMTDate -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
391+addDate getdate rspidxhdr hdrs = case rspidxhdr ! fromEnum ResDate of
396392 Nothing -> do
397− gmtdate <- D.getDate dc
393+ gmtdate <- getdate
398394 return $ (H.hDate, gmtdate) : hdrs
399395 Just _ -> return hdrs
400396
@@ -404,8 +400,12 @@ addDate dc rspidxhdr hdrs = case rspidxhdr ! idxDate of
404400warpVersion :: String
405401warpVersion = showVersion Paths_warp.version
406402
403+{-# INLINE addServer #-}
407404addServer :: HeaderValue -> IndexedHeader -> H.ResponseHeaders -> H.ResponseHeaders
408−addServer serverName rspidxhdr hdrs = case rspidxhdr ! idxServer of
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
409409 Nothing -> (H.hServer, serverName) : hdrs
410410 _ -> hdrs
411411
warp/Network/Wai/Handler/Warp/ResponseHeader.hs+3−5
@@ -3,17 +3,15 @@
33
44module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
55
6−import Control.Monad
7−import Data.ByteString (ByteString)
86import qualified Data.ByteString as S
97import Data.ByteString.Internal (create)
108import qualified Data.CaseInsensitive as CI
11−import Data.List (foldl')
12−import Data.Word (Word8)
139import Foreign.Ptr
1410import GHC.Storable
1511import qualified Network.HTTP.Types as H
12+
1613import Network.Wai.Handler.Warp.Buffer (copy)
14+import Network.Wai.Handler.Warp.Imports
1715
1816----------------------------------------------------------------
1917
@@ -24,7 +22,7 @@ composeHeader !httpversion !status !responseHeaders = create len $ \ptr -> do
2422 void $ copyCRLF ptr2
2523 where
2624 !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
2826 !slen = S.length $ H.statusMessage status
2927
3028httpVer11 :: ByteString
warp/Network/Wai/Handler/Warp/Run.hs+235−209
@@ -1,96 +1,101 @@
1+{-# LANGUAGE BangPatterns #-}
12{-# LANGUAGE CPP #-}
23{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PackageImports #-}
5+{-# LANGUAGE PatternGuards #-}
6+{-# LANGUAGE RecordWildCards #-}
37{-# LANGUAGE ScopedTypeVariables #-}
48{-# LANGUAGE TupleSections #-}
5−{-# LANGUAGE PatternGuards #-}
9+{-# LANGUAGE ViewPatterns #-}
610{-# OPTIONS_GHC -fno-warn-deprecations #-}
711
812module Network.Wai.Handler.Warp.Run where
913
10−#if __GLASGOW_HASKELL__ < 709
11−import Control.Applicative ((<$>))
12−#endif
14+import "iproute" Data.IP (toHostAddress, toHostAddress6)
1315import Control.Arrow (first)
14−import Control.Concurrent (threadDelay)
1516import qualified Control.Concurrent as Conc (yield)
1617import Control.Exception as E
17−import Control.Monad (when, unless, void)
18−import Data.ByteString (ByteString)
1918import qualified Data.ByteString as S
2019import Data.Char (chr)
21−import Data.IP (toHostAddress, toHostAddress6)
2220import Data.IORef (IORef, newIORef, readIORef, writeIORef)
2321import Data.Streaming.Network (bindPortTCP)
24−import Network (sClose, Socket)
25−import Network.Socket (accept, withSocketsDo, SockAddr(SockAddrInet, SockAddrInet6))
22+import Foreign.C.Error (Errno(..), eCONNABORTED)
23+import GHC.IO.Exception (IOException(..))
24+import qualified Network.HTTP2 as H2
25+import Network.Socket (Socket, close, accept, withSocketsDo, SockAddr(SockAddrInet, SockAddrInet6), setSocketOption, SocketOption(..))
26+#if MIN_VERSION_network(3,1,1)
27+import Network.Socket (gracefulClose)
28+#endif
2629import qualified Network.Socket.ByteString as Sock
2730import Network.Wai
28−import Network.Wai.HTTP2 (HTTP2Application, promoteApplication)
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+
2936import Network.Wai.Handler.Warp.Buffer
3037import Network.Wai.Handler.Warp.Counter
3138import qualified Network.Wai.Handler.Warp.Date as D
3239import qualified Network.Wai.Handler.Warp.FdCache as F
3340import qualified Network.Wai.Handler.Warp.FileInfoCache as I
34−import Network.Wai.Handler.Warp.HTTP2 (http2, isHTTP2)
41+import Network.Wai.Handler.Warp.HTTP2 (http2)
42+import Network.Wai.Handler.Warp.HTTP2.Types (isHTTP2)
3543import Network.Wai.Handler.Warp.Header
44+import Network.Wai.Handler.Warp.Imports hiding (readInt)
3645import Network.Wai.Handler.Warp.ReadInt
3746import Network.Wai.Handler.Warp.Recv
3847import Network.Wai.Handler.Warp.Request
3948import Network.Wai.Handler.Warp.Response
4049import Network.Wai.Handler.Warp.SendFile
4150import Network.Wai.Handler.Warp.Settings
42−import qualified Network.Wai.Handler.Warp.Timeout as T
4351import Network.Wai.Handler.Warp.Types
44−import Network.Wai.Internal (ResponseReceived (ResponseReceived))
45−import System.Environment (getEnvironment)
46−import System.IO.Error (isFullErrorType, ioeGetErrorType)
52+
4753
4854#if WINDOWS
4955import Network.Wai.Handler.Warp.Windows
5056#else
51−import System.Posix.IO (FdOption(CloseOnExec), setFdOption)
5257import Network.Socket (fdSocket)
5358#endif
5459
5560-- | Creating 'Connection' for plain HTTP based on a given socket.
56−socketConnection :: Socket -> IO Connection
57−socketConnection s = do
61+socketConnection :: Settings -> Socket -> IO Connection
62+#if MIN_VERSION_network(3,1,1)
63+socketConnection set s = do
64+#else
65+socketConnection _ s = do
66+#endif
5867 bufferPool <- newBufferPool
5968 writeBuf <- allocateBuffer bufferSize
6069 let sendall = Sock.sendAll s
70+ isH2 <- newIORef False -- HTTP/1.x
6171 return Connection {
6272 connSendMany = Sock.sendMany s
6373 , connSendAll = sendall
6474 , connSendFile = sendFile s writeBuf bufferSize sendall
65− , connClose = sClose s >> freeBuffer writeBuf
75+#if MIN_VERSION_network(3,1,1)
76+ , connClose = do
77+ h2 <- readIORef isH2
78+ let tm = if h2 then settingsGracefulCloseTimeout2 set
79+ else settingsGracefulCloseTimeout1 set
80+ if tm == 0 then
81+ close s
82+ else
83+ gracefulClose s tm `E.catch` \(E.SomeException _) -> return ()
84+#else
85+ , connClose = close s
86+#endif
87+ , connFree = freeBuffer writeBuf
6688 , connRecv = receive s bufferPool
6789 , connRecvBuf = receiveBuf s
6890 , connWriteBuffer = writeBuf
6991 , connBufferSize = bufferSize
92+ , connHTTP2 = isH2
7093 }
7194
72−#if __GLASGOW_HASKELL__ < 702
73−allowInterrupt :: IO ()
74−allowInterrupt = unblock $ return ()
75−#endif
76−
77−-- Composition over two arguments at once; used for runHTTP2\*.
78−(.:) :: (c -> d) -> (a -> b -> c) -> a -> b -> d
79−f .: g = curry $ f . uncurry g
80−
8195-- | Run an 'Application' on the given port.
8296-- This calls 'runSettings' with 'defaultSettings'.
8397run :: Port -> Application -> IO ()
84−run port = runServe port . serveDefault
85−
86−-- | Serve an 'HTTP2Application' and an 'Application' together on the given
87−-- port.
88−runHTTP2 :: Port -> HTTP2Application -> Application -> IO ()
89−runHTTP2 port = runServe port .: serveHTTP2
90−
91−-- | The generalized form of 'run'.
92−runServe :: Port -> ServeConnection -> IO ()
93−runServe p = runServeSettings defaultSettings { settingsPort = p }
98+run p = runSettings defaultSettings { settingsPort = p }
9499
95100-- | Run an 'Application' on the port present in the @PORT@
96101-- environment variable. Uses the 'Port' given when the variable is unset.
@@ -98,44 +103,28 @@ runServe p = runServeSettings defaultSettings { settingsPort = p }
98103--
99104-- Since 3.0.9
100105runEnv :: Port -> Application -> IO ()
101−runEnv port = runServeEnv port . serveDefault
102−
103−-- | The HTTP\/2-aware form of 'runEnv'.
104−runHTTP2Env :: Port -> HTTP2Application -> Application -> IO ()
105−runHTTP2Env port = runServeEnv port .: serveHTTP2
106+runEnv p app = do
107+ mp <- lookupEnv "PORT"
106108
107−-- | The generalized form of 'runEnv'.
108−runServeEnv :: Port -> ServeConnection -> IO ()
109−runServeEnv p serveConn = do
110− mp <- lookup "PORT" <$> getEnvironment
111−
112− maybe (runServe p serveConn) runReadPort mp
109+ maybe (run p app) runReadPort mp
113110
114111 where
115112 runReadPort :: String -> IO ()
116113 runReadPort sp = case reads sp of
117− ((p', _):_) -> runServe p' serveConn
114+ ((p', _):_) -> run p' app
118115 _ -> fail $ "Invalid value in $PORT: " ++ sp
119116
120117-- | Run an 'Application' with the given 'Settings'.
121118-- This opens a listen socket on the port defined in 'Settings' and
122119-- calls 'runSettingsSocket'.
123120runSettings :: Settings -> Application -> IO ()
124−runSettings set = runServeSettings set . serveDefault
125−
126−-- | The HTTP\/2-aware form of 'runSettings'.
127−runHTTP2Settings :: Settings -> HTTP2Application -> Application -> IO ()
128−runHTTP2Settings set = runServeSettings set .: serveHTTP2
129−
130−-- | The generalized form of 'runSettings'.
131−runServeSettings :: Settings -> ServeConnection -> IO ()
132−runServeSettings set serveConn = withSocketsDo $
121+runSettings set app = withSocketsDo $
133122 bracket
134123 (bindPortTCP (settingsPort set) (settingsHost set))
135− sClose
124+ close
136125 (\socket -> do
137126 setSocketCloseOnExec socket
138− runServeSettingsSocket set socket serveConn)
127+ runSettingsSocket set socket app)
139128
140129-- | This installs a shutdown handler for the given socket and
141130-- calls 'runSettingsConnection' with the default connection setup action
@@ -149,22 +138,9 @@ runServeSettings set serveConn = withSocketsDo $
149138-- Note that the 'settingsPort' will still be passed to 'Application's via the
150139-- 'serverPort' record.
151140runSettingsSocket :: Settings -> Socket -> Application -> IO ()
152−runSettingsSocket set socket = runServeSettingsSocket set socket . serveDefault
153−
154−-- | The HTTP\/2-aware form of 'runSettingsSocket'.
155−runHTTP2SettingsSocket :: Settings
156− -> Socket
157− -> HTTP2Application
158− -> Application
159− -> IO ()
160−runHTTP2SettingsSocket set socket =
161− runServeSettingsSocket set socket .: serveHTTP2
162−
163−-- | The generalized form of 'runSettingsSocket'.
164−runServeSettingsSocket :: Settings -> Socket -> ServeConnection -> IO ()
165−runServeSettingsSocket set socket serveConn = do
141+runSettingsSocket set socket app = do
166142 settingsInstallShutdownHandler set closeListenSocket
167− runServeSettingsConnection set getConn serveConn
143+ runSettingsConnection set getConn app
168144 where
169145 getConn = do
170146#if WINDOWS
@@ -173,10 +149,12 @@ runServeSettingsSocket set socket serveConn = do
173149 (s, sa) <- accept socket
174150#endif
175151 setSocketCloseOnExec s
176− conn <- socketConnection s
152+ -- NoDelay causes an error for AF_UNIX.
153+ setSocketOption s NoDelay 1 `E.catch` \(E.SomeException _) -> return ()
154+ conn <- socketConnection set s
177155 return (conn, sa)
178156
179− closeListenSocket = sClose socket
157+ closeListenSocket = close socket
180158
181159-- | The connection setup action would be expensive. A good example
182160-- is initialization of TLS.
@@ -188,16 +166,7 @@ runServeSettingsSocket set socket serveConn = do
188166--
189167-- Since 1.3.5
190168runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
191−runSettingsConnection set getConn =
192− runServeSettingsConnection set getConn . serveDefault
193−
194−-- | The generalized form of 'runSettingsConnection'.
195−runServeSettingsConnection :: Settings
196− -> IO (Connection, SockAddr)
197− -> ServeConnection
198− -> IO ()
199−runServeSettingsConnection set getConn serveConn =
200− runServeSettingsConnectionMaker set getConnMaker serveConn
169+runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMaker app
201170 where
202171 getConnMaker = do
203172 (conn, sa) <- getConn
@@ -206,16 +175,8 @@ runServeSettingsConnection set getConn serveConn =
206175-- | This modifies the connection maker so that it returns 'TCP' for 'Transport'
207176-- (i.e. plain HTTP) then calls 'runSettingsConnectionMakerSecure'.
208177runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
209−runSettingsConnectionMaker set getConnMaker =
210− runServeSettingsConnectionMaker set getConnMaker . serveDefault
211−
212−-- | The generalized form of 'runSettingsConnectionMaker'.
213−runServeSettingsConnectionMaker :: Settings
214− -> IO (IO Connection, SockAddr)
215− -> ServeConnection
216− -> IO ()
217−runServeSettingsConnectionMaker x y =
218− runServeSettingsConnectionMakerSecure x (toTCP <$> y)
178+runSettingsConnectionMaker x y =
179+ runSettingsConnectionMakerSecure x (toTCP <$> y)
219180 where
220181 toTCP = first ((, TCP) <$>)
221182
@@ -228,33 +189,26 @@ runServeSettingsConnectionMaker x y =
228189--
229190-- Since 2.1.4
230191runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO ()
231−runSettingsConnectionMakerSecure set getConnMaker =
232− runServeSettingsConnectionMakerSecure set getConnMaker . serveDefault
233−
234−-- | The generalized form of 'runSettingsConnectionMakerSecure'.
235−runServeSettingsConnectionMakerSecure :: Settings
236− -> IO (IO (Connection, Transport), SockAddr)
237− -> ServeConnection
238− -> IO ()
239−runServeSettingsConnectionMakerSecure set getConnMaker serveConn = do
192+runSettingsConnectionMakerSecure set getConnMaker app = do
240193 settingsBeforeMainLoop set
241194 counter <- newCounter
242− withII $ acceptConnection set getConnMaker serveConn counter
195+ withII $ acceptConnection set getConnMaker app counter
243196 where
244197 withII action =
198+ withTimeoutManager $ \tm ->
245199 D.withDateCache $ \dc ->
246− F.withFdCache fdCacheDurationInSeconds $ \fc ->
247− I.withFileInfoCache fdFileInfoDurationInSeconds $ \get ->
248− withTimeoutManager $ \tm -> do
249− let ii0 = InternalInfo undefined tm fc get dc -- fixme: undefined
250− action ii0
251−
252− fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
253− fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
200+ F.withFdCache fdCacheDurationInSeconds $ \fdc ->
201+ I.withFileInfoCache fdFileInfoDurationInSeconds $ \fic -> do
202+ let ii = InternalInfo tm dc fdc fic
203+ action ii
204+
205+ !fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
206+ !fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
207+ !timeoutInSeconds = settingsTimeout set * 1000000
254208 withTimeoutManager f = case settingsManager set of
255209 Just tm -> f tm
256210 Nothing -> bracket
257− (T.initialize $ settingsTimeout set * 1000000)
211+ (T.initialize timeoutInSeconds)
258212 T.stopManager
259213 f
260214
@@ -273,16 +227,21 @@ runServeSettingsConnectionMakerSecure set getConnMaker serveConn = do
273227-- Our approach is explained in the comments below.
274228acceptConnection :: Settings
275229 -> IO (IO (Connection, Transport), SockAddr)
276− -> ServeConnection
230+ -> Application
277231 -> Counter
278232 -> InternalInfo
279233 -> IO ()
280−acceptConnection set getConnMaker serveConn counter ii0 = do
234+acceptConnection set getConnMaker app counter ii = do
281235 -- First mask all exceptions in acceptLoop. This is necessary to
282236 -- ensure that no async exception is throw between the call to
283237 -- acceptNewConnection and the registering of connClose.
238+ --
239+ -- acceptLoop can be broken by closing the listing socket.
284240 void $ mask_ acceptLoop
285− gracefulShutdown counter
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
286245 where
287246 acceptLoop = do
288247 -- Allow async exceptions before receiving the next connection maker.
@@ -299,88 +258,78 @@ acceptConnection set getConnMaker serveConn counter ii0 = do
299258 case mx of
300259 Nothing -> return ()
301260 Just (mkConn, addr) -> do
302− fork set mkConn addr serveConn counter ii0
261+ fork set mkConn addr app counter ii
303262 acceptLoop
304263
305264 acceptNewConnection = do
306265 ex <- try getConnMaker
307266 case ex of
308267 Right x -> return $ Just x
309− Left e -> do
310− settingsOnException set Nothing $ toException e
311− if isFullErrorType (ioeGetErrorType e) then do
312− -- "resource exhausted (Too many open files)" may
313− -- happen by accept(). Wait a second hoping that
314− -- resource will be available.
315− threadDelay 1000000
316− acceptNewConnection
317− else
318− -- Assuming the listen socket is closed.
319− return Nothing
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
320276
321277-- Fork a new worker thread for this connection maker, and ask for a
322278-- function to unmask (i.e., allow async exceptions to be thrown).
323279fork :: Settings
324280 -> IO (Connection, Transport)
325281 -> SockAddr
326− -> ServeConnection
282+ -> Application
327283 -> Counter
328284 -> InternalInfo
329285 -> IO ()
330−fork set mkConn addr serveConn counter ii0 = settingsFork set $ \ unmask ->
331− -- Run the connection maker to get a new connection, and ensure
332− -- that the connection is closed. If the mkConn call throws an
333− -- exception, we will leak the connection. If the mkConn call is
334− -- vulnerable to attacks (e.g., Slowloris), we do nothing to
335− -- protect the server. It is therefore vital that mkConn is well
336− -- vetted.
337− --
338− -- We grab the connection before registering timeouts since the
339− -- timeouts will be useless during connection creation, due to the
340− -- fact that async exceptions are still masked.
341− bracket mkConn closeConn $ \(conn, transport) ->
286+fork set mkConn addr app counter ii = settingsFork set $ \unmask ->
287+ -- Call the user-supplied on exception code if any
288+ -- exceptions are thrown.
289+ handle (settingsOnException set Nothing) $
290+ -- Run the connection maker to get a new connection, and ensure
291+ -- that the connection is closed. If the mkConn call throws an
292+ -- exception, we will leak the connection. If the mkConn call is
293+ -- vulnerable to attacks (e.g., Slowloris), we do nothing to
294+ -- protect the server. It is therefore vital that mkConn is well
295+ -- vetted.
296+ --
297+ -- We grab the connection before registering timeouts since the
298+ -- timeouts will be useless during connection creation, due to the
299+ -- fact that async exceptions are still masked.
300+ bracket mkConn cleanUp (serve unmask)
301+ where
302+ cleanUp (conn, _) = connClose conn `finally` connFree conn
342303
343304 -- We need to register a timeout handler for this thread, and
344305 -- cancel that handler as soon as we exit.
345− bracket (T.registerKillThread (timeoutManager ii0)) T.cancel $ \th ->
346−
347− let ii = ii0 { threadHandle = th }
348− -- We now have fully registered a connection close handler
349− -- in the case of all exceptions, so it is safe to one
350− -- again allow async exceptions.
351− in unmask .
352− -- Call the user-supplied on exception code if any
353− -- exceptions are thrown.
354− handle (settingsOnException set Nothing) .
355−
356− -- Call the user-supplied code for connection open and close events
357− bracket (onOpen addr) (onClose addr) $ \goingon ->
358−
359− -- Actually serve this connection.
360− -- bracket with closeConn above ensures the connection is closed.
361− when goingon $ serveConn conn ii addr transport set
362− where
363− closeConn (conn, _transport) = connClose conn
306+ serve unmask (conn, transport) = bracket register cancel $ \th -> do
307+ -- We now have fully registered a connection close handler in
308+ -- the case of all exceptions, so it is safe to once again
309+ -- allow async exceptions.
310+ unmask .
311+ -- Call the user-supplied code for connection open and
312+ -- close events
313+ bracket (onOpen addr) (onClose addr) $ \goingon ->
314+ -- Actually serve this connection. bracket with closeConn
315+ -- above ensures the connection is closed.
316+ when goingon $ serveConnection conn ii th addr transport set app
317+ where
318+ register = T.registerKillThread (timeoutManager ii) (connClose conn)
319+ cancel = T.cancel
364320
365321 onOpen adr = increase counter >> settingsOnOpen set adr
366322 onClose adr _ = decrease counter >> settingsOnClose set adr
367323
368−-- The type of a function to serve a fully-prepared connection.
369−type ServeConnection = Connection
370− -> InternalInfo
371− -> SockAddr
372− -> Transport
373− -> Settings
374− -> IO ()
375−
376−-- Serve an HTTP\/2-unaware Application to a connection over any HTTP version.
377−serveDefault :: Application -> ServeConnection
378−serveDefault app = serveHTTP2 (promoteApplication app) app
379−
380−-- Serve an HTTP\/2-aware application over HTTP\/2 or a backup 'Application'
381−-- over HTTP\/1.1 or HTTP\/1.
382−serveHTTP2 :: HTTP2Application -> Application -> ServeConnection
383−serveHTTP2 app2 app conn ii origAddr transport settings = do
324+serveConnection :: Connection
325+ -> InternalInfo
326+ -> T.Handle
327+ -> SockAddr
328+ -> Transport
329+ -> Settings
330+ -> Application
331+ -> IO ()
332+serveConnection conn ii th origAddr transport settings app = do
384333 -- fixme: Upgrading to HTTP/2 should be supported.
385334 (h2,bs) <- if isHTTP2 transport then
386335 return (True, "")
@@ -390,19 +339,39 @@ serveHTTP2 app2 app conn ii origAddr transport settings = do
390339 return (True, bs0)
391340 else
392341 return (False, bs0)
342+ istatus <- newIORef False
393343 if settingsHTTP2Enabled settings && h2 then do
394− recvN <- makeReceiveN bs (connRecv conn) (connRecvBuf conn)
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
395354 -- fixme: origAddr
396− http2 conn ii origAddr transport settings recvN app2
355+ checkTLS
356+ setConnHTTP2 conn True
357+ http2 conn transport ii origAddr settings recvN sendBS app
397358 else do
398− istatus <- newIORef False
399359 src <- mkSource (wrappedRecv conn th istatus (settingsSlowlorisSize settings))
400360 writeIORef istatus True
401361 leftoverSource src bs
402362 addr <- getProxyProtocolAddr src
403− http1 addr istatus src `E.catch` \e -> do
404− sendErrorResponse addr istatus e
405− throwIO (e :: SomeException)
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+
406375 where
407376 getProxyProtocolAddr src =
408377 case settingsProxyProtocol settings of
@@ -444,32 +413,38 @@ serveHTTP2 app2 app conn ii origAddr transport settings = do
444413
445414 decodeAscii = map (chr . fromEnum) . S.unpack
446415
447− th = threadHandle ii
448−
449416 shouldSendErrorResponse se
450417 | Just ConnectionClosedByPeer <- fromException se = False
451418 | otherwise = True
452419
453− sendErrorResponse addr istatus e = do
420+ sendErrorResponse req istatus e = do
454421 status <- readIORef istatus
455− when (shouldSendErrorResponse e && status) $ void $
456− sendResponse settings conn ii (dummyreq addr) defaultIndexRequestHeader (return S.empty) (errorResponse e)
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
457426
458427 dummyreq addr = defaultRequest { remoteHost = addr }
459428
460429 errorResponse e = settingsOnExceptionResponse settings e
461430
462− http1 addr istatus src = do
463− (req', mremainingRef, idxhdr, nextBodyFlush) <- recvRequest settings conn ii addr src
464− let req = req' { isSecure = isTransportSecure transport }
431+ http1 firstRequest addr istatus src = do
432+ (req, mremainingRef, idxhdr, nextBodyFlush) <- recvRequest firstRequest settings conn ii th addr src transport
465433 keepAlive <- processRequest istatus src req mremainingRef idxhdr nextBodyFlush
466434 `E.catch` \e -> do
467− -- Call the user-supplied exception handlers, passing the request.
468− sendErrorResponse addr istatus e
469435 settingsOnException settings (Just req) e
470436 -- Don't throw the error again to prevent calling settingsOnException twice.
471437 return False
472− when keepAlive $ http1 addr istatus src
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
473448
474449 processRequest istatus src req mremainingRef idxhdr nextBodyFlush = do
475450 -- Let the application run for as long as it wants
@@ -479,30 +454,38 @@ serveHTTP2 app2 app conn ii origAddr transport settings = do
479454 -- creating the request, we need to make sure that we don't get
480455 -- an async exception before calling the ResponseSource.
481456 keepAliveRef <- newIORef $ error "keepAliveRef not filled"
482− _ <- app req $ \res -> do
457+ r <- E.try $ app req $ \res -> do
483458 T.resume th
484459 -- FIXME consider forcing evaluation of the res here to
485460 -- send more meaningful error messages to the user.
486461 -- However, it may affect performance.
487462 writeIORef istatus False
488− keepAlive <- sendResponse settings conn ii req idxhdr (readSource src) res
463+ keepAlive <- sendResponse settings conn ii th req idxhdr (readSource src) res
489464 writeIORef keepAliveRef keepAlive
490465 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+
491475 keepAlive <- readIORef keepAliveRef
492476
493477 -- We just send a Response and it takes a time to
494478 -- receive a Request again. If we immediately call recv,
495− -- it is likely to fail and the IO manager works.
496− -- It is very costly. So, we yield to another Haskell
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
497481 -- thread hoping that the next Request will arrive
498482 -- when this Haskell thread will be re-scheduled.
499483 -- This improves performance at least when
500484 -- the number of cores is small.
501485 Conc.yield
502486
503− if not keepAlive then
504− return False
505− else
487+ if keepAlive
488+ then
506489 -- If there is an unknown or large amount of data to still be read
507490 -- from the request body, simple drop this connection instead of
508491 -- reading it all in to satisfy a keep-alive request.
@@ -528,6 +511,21 @@ serveHTTP2 app2 app conn ii origAddr transport settings = do
528511 else
529512 return False
530513 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
531529
532530flushEntireBody :: IO ByteString -> IO ()
533531flushEntireBody src =
@@ -560,14 +558,42 @@ wrappedRecv Connection { connRecv = recv } th istatus slowlorisSize = do
560558 when (S.length bs >= slowlorisSize) $ T.tickle th
561559 return bs
562560
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+--
563576-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
577+--
578+-- @since 3.2.17
564579setSocketCloseOnExec :: Socket -> IO ()
565580#if WINDOWS
566581setSocketCloseOnExec _ = return ()
567582#else
568−setSocketCloseOnExec socket =
569− setFdOption (fromIntegral $ fdSocket socket) CloseOnExec True
583+setSocketCloseOnExec socket = do
584+#if MIN_VERSION_network(3,0,0)
585+ fd <- fdSocket socket
586+#else
587+ let fd = fdSocket socket
588+#endif
589+ F.setFileCloseOnExec $ fromIntegral fd
570590#endif
571591
572−gracefulShutdown :: Counter -> IO ()
573−gracefulShutdown counter = waitForZero counter
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.hs+12−14
@@ -9,31 +9,27 @@ module Network.Wai.Handler.Warp.SendFile (
99#endif
1010 ) where
1111
12−import Control.Monad (void)
13−import Data.ByteString (ByteString)
1412import qualified Data.ByteString as BS
1513import Network.Socket (Socket)
16−import Network.Wai.Handler.Warp.Buffer
17−import Network.Wai.Handler.Warp.Types
1814
1915#ifdef WINDOWS
20−import Control.Monad (when)
21−import Data.ByteString.Internal (ByteString(..))
2216import Foreign.ForeignPtr (newForeignPtr_)
2317import Foreign.Ptr (plusPtr)
2418import qualified System.IO as IO
2519#else
26−# if __GLASGOW_HASKELL__ < 709
27−import Control.Applicative ((<$>))
28−# endif
2920import Control.Exception
21+import Foreign.C.Error (throwErrno)
3022import Foreign.C.Types
3123import Foreign.Ptr (Ptr, castPtr, plusPtr)
3224import Network.Sendfile
33−import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd)
25+import Network.Wai.Handler.Warp.FdCache (openFile, closeFile)
3426import System.Posix.Types
3527#endif
3628
29+import Network.Wai.Handler.Warp.Buffer
30+import Network.Wai.Handler.Warp.Imports
31+import Network.Wai.Handler.Warp.Types
32+
3733----------------------------------------------------------------
3834
3935-- | Function to send a file based on sendfile() for Linux\/Mac\/FreeBSD.
@@ -129,10 +125,10 @@ readSendFile buf siz send fid off0 len0 hook headers =
129125 path = fileIdPath fid
130126 setup = case fileIdFd fid of
131127 Just fd -> return fd
132− Nothing -> openFd path ReadOnly Nothing defaultFileFlags{nonBlock=True}
128+ Nothing -> openFile path
133129 teardown fd = case fileIdFd fid of
134130 Just _ -> return ()
135− Nothing -> closeFd fd
131+ Nothing -> closeFile fd
136132 loop fd len off
137133 | len <= 0 = return ()
138134 | otherwise = do
@@ -143,8 +139,10 @@ readSendFile buf siz send fid off0 len0 hook headers =
143139 loop fd (len - n') (off + n')
144140
145141positionRead :: Fd -> Buffer -> BufSize -> Integer -> IO Int
146−positionRead fd buf siz off =
147− fromIntegral <$> c_pread fd (castPtr buf) (fromIntegral siz) (fromIntegral off)
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
148146
149147foreign import ccall unsafe "pread"
150148 c_pread :: Fd -> Ptr CChar -> ByteCount -> FileOffset -> IO CSsize
warp/Network/Wai/Handler/Warp/Settings.hs+70−18
@@ -6,26 +6,25 @@ module Network.Wai.Handler.Warp.Settings where
66
77import Control.Concurrent (forkIOWithUnmask)
88import Control.Exception
9−import Control.Monad (when, void)
10−import Data.ByteString (ByteString)
11−import qualified Data.ByteString.Char8 as S8
129import Data.ByteString.Builder (byteString)
13−#if __GLASGOW_HASKELL__ < 709
14−import Data.Monoid (mappend)
15−#endif
10+import qualified Data.ByteString.Char8 as C8
11+import Data.ByteString.Lazy (fromStrict)
1612import Data.Streaming.Network (HostPreference)
1713import qualified Data.Text as T
1814import qualified Data.Text.IO as TIO
1915import Data.Version (showVersion)
2016import GHC.IO.Exception (IOErrorType(..))
2117import qualified Network.HTTP.Types as H
18+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
2219import Network.Socket (SockAddr)
2320import Network.Wai
24−import Network.Wai.Handler.Warp.Timeout
25−import Network.Wai.Handler.Warp.Types
2621import qualified Paths_warp
2722import System.IO (stderr)
2823import System.IO.Error (ioeGetErrorType)
24+import System.TimeManager
25+
26+import Network.Wai.Handler.Warp.Imports
27+import Network.Wai.Handler.Warp.Types
2928
3029-- | Various Warp server settings. This is purposely kept as an abstract data
3130-- type so that new settings can be added without breaking backwards
@@ -77,6 +76,13 @@ data Settings = Settings
7776 --
7877 -- Since 2.0.3
7978 , settingsInstallShutdownHandler :: IO () -> IO ()
79+ -- ^ An action to install a handler (e.g. Unix signal handler)
80+ -- to close a listen socket.
81+ -- The first argument is an action to close the listen socket.
82+ --
83+ -- Default: no action
84+ --
85+ -- Since 3.0.1
8086 , settingsServerName :: ByteString
8187 -- ^ Default server name if application does not set one.
8288 --
@@ -88,19 +94,44 @@ data Settings = Settings
8894 , settingsProxyProtocol :: ProxyProtocol
8995 -- ^ Specify usage of the PROXY protocol.
9096 --
91− -- Since 3.0.5.
97+ -- Since 3.0.5
9298 , settingsSlowlorisSize :: Int
9399 -- ^ Size of bytes read to prevent Slowloris protection. Default value: 2048
94100 --
95− -- Since 3.1.2.
101+ -- Since 3.1.2
96102 , settingsHTTP2Enabled :: Bool
97103 -- ^ Whether to enable HTTP2 ALPN/upgrades. Default: True
98104 --
99− -- Since 3.1.7.
105+ -- Since 3.1.7
100106 , settingsLogger :: Request -> H.Status -> Maybe Integer -> IO ()
101107 -- ^ A log function. Default: no action.
102108 --
103− -- Since 3.X.X.
109+ -- Since 3.1.10
110+ , settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
111+ -- ^ A HTTP/2 server push log function. Default: no action.
112+ --
113+ -- Since 3.2.7
114+ , settingsGracefulShutdownTimeout :: Maybe Int
115+ -- ^ An optional timeout to limit the time (in seconds) waiting for
116+ -- a graceful shutdown of the web server.
117+ --
118+ -- Since 3.2.8
119+ , settingsGracefulCloseTimeout1 :: Int
120+ -- ^ A timeout to limit the time (in milliseconds) waiting for
121+ -- FIN for HTTP/1.x. 0 means uses immediate close.
122+ -- Default: 0.
123+ --
124+ -- Since 3.3.5
125+ , settingsGracefulCloseTimeout2 :: Int
126+ -- ^ A timeout to limit the time (in milliseconds) waiting for
127+ -- FIN for HTTP/2. 0 means uses immediate close.
128+ -- Default: 2000.
129+ --
130+ -- Since 3.3.5
131+ , settingsMaxTotalHeaderLength :: Int
132+ -- ^ Determines the maximum header size that Warp will tolerate when using HTTP/1.x.
133+ --
134+ -- Since 3.3.8
104135 }
105136
106137-- | Specify usage of the PROXY protocol.
@@ -129,12 +160,17 @@ defaultSettings = Settings
129160 , settingsFork = void . forkIOWithUnmask
130161 , settingsNoParsePath = False
131162 , settingsInstallShutdownHandler = const $ return ()
132− , settingsServerName = S8.pack $ "Warp/" ++ showVersion Paths_warp.version
163+ , settingsServerName = C8.pack $ "Warp/" ++ showVersion Paths_warp.version
133164 , settingsMaximumBodyFlush = Just 8192
134165 , settingsProxyProtocol = ProxyProtocolNone
135166 , settingsSlowlorisSize = 2048
136167 , settingsHTTP2Enabled = True
137168 , settingsLogger = \_ _ _ -> return ()
169+ , settingsServerPushLogger = \_ _ _ -> return ()
170+ , settingsGracefulShutdownTimeout = Nothing
171+ , settingsGracefulCloseTimeout1 = 0
172+ , settingsGracefulCloseTimeout2 = 2000
173+ , settingsMaxTotalHeaderLength = 50 * 1024
138174 }
139175
140176-- | Apply the logic provided by 'defaultOnException' to determine if an
@@ -160,13 +196,29 @@ defaultOnException _ e =
160196 when (defaultShouldDisplayException e)
161197 $ TIO.hPutStrLn stderr $ T.pack $ show e
162198
163−-- | Sending 400 for bad requests. Sending 500 for internal server errors.
164−--
199+-- | Sending 400 for bad requests.
200+-- Sending 500 for internal server errors.
165201-- Since: 3.1.0
202+-- Sending 413 for too large payload.
203+-- Sending 431 for too large headers.
204+-- Since 3.2.27
166205defaultOnExceptionResponse :: SomeException -> Response
167206defaultOnExceptionResponse e
168− | Just (_ :: InvalidRequest) <- fromException e = responseLBS H.badRequest400 [(H.hContentType, "text/plain; charset=utf-8")] "Bad Request"
169− | otherwise = responseLBS H.internalServerError500 [(H.hContentType, "text/plain; charset=utf-8")] "Something went wrong"
207+ | Just (_ :: InvalidRequest) <-
208+ fromException e = responseLBS H.badRequest400
209+ [(H.hContentType, "text/plain; charset=utf-8")]
210+ "Bad Request"
211+ | Just (ConnectionError (UnknownErrorCode 413) t) <-
212+ fromException e = responseLBS H.status413
213+ [(H.hContentType, "text/plain; charset=utf-8")]
214+ (fromStrict t)
215+ | Just (ConnectionError (UnknownErrorCode 431) t) <-
216+ fromException e = responseLBS H.status431
217+ [(H.hContentType, "text/plain; charset=utf-8")]
218+ (fromStrict t)
219+ | otherwise = responseLBS H.internalServerError500
220+ [(H.hContentType, "text/plain; charset=utf-8")]
221+ "Something went wrong"
170222
171223-- | Exception handler for the debugging purpose.
172224-- 500, text/plain, a showed exception.
@@ -176,4 +228,4 @@ exceptionResponseForDebug :: SomeException -> Response
176228exceptionResponseForDebug e =
177229 responseBuilder H.internalServerError500
178230 [(H.hContentType, "text/plain; charset=utf-8")]
179− $ byteString . S8.pack $ "Exception: " ++ show e
231+ $ byteString . C8.pack $ "Exception: " ++ show e
warp/Network/Wai/Handler/Warp/Types.hs+37−17
@@ -5,20 +5,18 @@
55module Network.Wai.Handler.Warp.Types where
66
77import Control.Exception
8−import Data.ByteString (ByteString)
98import qualified Data.ByteString as S
109import Data.IORef (IORef, readIORef, writeIORef, newIORef)
1110import Data.Typeable (Typeable)
12−import Data.Word (Word16, Word8)
11+import Data.X509
1312import Foreign.Ptr (Ptr)
13+import System.Posix.Types (Fd)
14+import qualified System.TimeManager as T
15+
1416import qualified Network.Wai.Handler.Warp.Date as D
1517import qualified Network.Wai.Handler.Warp.FdCache as F
1618import qualified Network.Wai.Handler.Warp.FileInfoCache as I
17−import qualified Network.Wai.Handler.Warp.Timeout as T
18−
19−#ifndef WINDOWS
20−import System.Posix.Types (Fd)
21−#endif
19+import Network.Wai.Handler.Warp.Imports
2220
2321----------------------------------------------------------------
2422
@@ -55,9 +53,19 @@ instance Exception InvalidRequest
5553
5654----------------------------------------------------------------
5755
58−#ifdef WINDOWS
59−type Fd = ()
60−#endif
56+-- | Exception thrown if something goes wrong while in the midst of
57+-- sending a response, since the status code can't be altered at that
58+-- point.
59+--
60+-- Used to determine whether keeping the HTTP1.1 connection / HTTP2 stream alive is safe
61+-- or irrecoverable.
62+
63+newtype ExceptionInsideResponseBody = ExceptionInsideResponseBody SomeException
64+ deriving (Show, Typeable)
65+
66+instance Exception ExceptionInsideResponseBody
67+
68+----------------------------------------------------------------
6169
6270-- | Data type to abstract file identifiers.
6371-- On Unix, a file descriptor would be specified to make use of
@@ -99,8 +107,13 @@ data Connection = Connection {
99107 , connSendAll :: ByteString -> IO ()
100108 -- | The sending function for files in HTTP/1.1.
101109 , connSendFile :: SendFile
102− -- | The connection closing function.
110+ -- | The connection closing function. Warp guarantees it will only be
111+ -- called once. Other functions (like 'connRecv') may be called after
112+ -- 'connClose' is called.
103113 , connClose :: IO ()
114+ -- | Free any buffers allocated. Warp guarantees it will only be
115+ -- called once, and no other functions will be called after it.
116+ , connFree :: IO ()
104117 -- | The connection receiving function. This returns "" for EOF.
105118 , connRecv :: Recv
106119 -- | The connection receiving function. This tries to fill the buffer.
@@ -110,17 +123,23 @@ data Connection = Connection {
110123 , connWriteBuffer :: Buffer
111124 -- | The size of the write buffer.
112125 , connBufferSize :: BufSize
126+ -- | Is this connection HTTP/2?
127+ , connHTTP2 :: IORef Bool
113128 }
114129
130+getConnHTTP2 :: Connection -> IO Bool
131+getConnHTTP2 conn = readIORef (connHTTP2 conn)
132+
133+setConnHTTP2 :: Connection -> Bool -> IO ()
134+setConnHTTP2 conn b = writeIORef (connHTTP2 conn) b
135+
115136----------------------------------------------------------------
116137
117−-- | Internal information.
118138data InternalInfo = InternalInfo {
119− threadHandle :: T.Handle
120− , timeoutManager :: T.Manager
121− , fdCacher :: Maybe F.MutableFdCache
122− , fileInfo :: FilePath -> IO I.FileInfo
123− , dateCacher :: D.DateCache
139+ timeoutManager :: T.Manager
140+ , getDate :: IO D.GMTDate
141+ , getFd :: FilePath -> IO (Maybe F.Fd, F.Refresh)
142+ , getFileInfo :: FilePath -> IO I.FileInfo
124143 }
125144
126145----------------------------------------------------------------
@@ -161,6 +180,7 @@ data Transport = TCP -- ^ Plain channel: TCP
161180 , tlsMinorVersion :: Int
162181 , tlsNegotiatedProtocol :: Maybe ByteString -- ^ The result of Application Layer Protocol Negociation in RFC 7301
163182 , tlsChiperID :: Word16
183+ , tlsClientCertificate :: Maybe CertificateChain
164184 } -- ^ Encrypted channel: TLS or SSL
165185
166186isTransportSecure :: Transport -> Bool
warp/Network/Wai/Handler/Warp/Windows.hs+5−1
@@ -7,8 +7,12 @@ module Network.Wai.Handler.Warp.Windows
77import Control.Exception
88import Control.Concurrent.MVar
99import Control.Concurrent
10−import Control.Monad
1110
11+import Network.Wai.Handler.Warp.Imports
12+
13+-- | Allow main socket listening thread to be interrupted on Windows platform
14+--
15+-- @since 3.2.17
1216windowsThreadBlockHack :: IO a -> IO a
1317windowsThreadBlockHack act = do
1418 var <- newEmptyMVar :: IO (MVar (Either SomeException a))
warp/Network/Wai/Handler/Warp/WithApplication.hsnew file+104
@@ -0,0 +1,104 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Handler.Warp.WithApplication (
3+ withApplication,
4+ withApplicationSettings,
5+ testWithApplication,
6+ testWithApplicationSettings,
7+ openFreePort,
8+ withFreePort,
9+) where
10+
11+import Control.Concurrent
12+import Control.Concurrent.Async
13+import Control.Exception
14+import Control.Monad (when)
15+import Data.Streaming.Network (bindRandomPortTCP)
16+import Network.Socket
17+import Network.Wai
18+import Network.Wai.Handler.Warp.Run
19+import Network.Wai.Handler.Warp.Settings
20+import Network.Wai.Handler.Warp.Types
21+
22+-- | Runs the given 'Application' on a free port. Passes the port to the given
23+-- operation and executes it, while the 'Application' is running. Shuts down the
24+-- server before returning.
25+--
26+-- @since 3.2.4
27+withApplication :: IO Application -> (Port -> IO a) -> IO a
28+withApplication = withApplicationSettings defaultSettings
29+
30+-- | 'withApplication' with given 'Settings'. This will ignore the port value
31+-- set by 'setPort' in 'Settings'.
32+--
33+-- @since 3.2.7
34+withApplicationSettings :: Settings -> IO Application -> (Port -> IO a) -> IO a
35+withApplicationSettings settings' mkApp action = do
36+ app <- mkApp
37+ withFreePort $ \ (port, sock) -> do
38+ started <- mkWaiter
39+ let settings =
40+ settings' {
41+ settingsBeforeMainLoop
42+ = notify started () >> settingsBeforeMainLoop settings'
43+ }
44+ result <- race
45+ (runSettingsSocket settings sock app)
46+ (waitFor started >> action port)
47+ case result of
48+ Left () -> throwIO $ ErrorCall "Unexpected: runSettingsSocket exited"
49+ Right x -> return x
50+
51+-- | Same as 'withApplication' but with different exception handling: If the
52+-- given 'Application' throws an exception, 'testWithApplication' will re-throw
53+-- the exception to the calling thread, possibly interrupting the execution of
54+-- the given operation.
55+--
56+-- This is handy for running tests against an 'Application' over a real network
57+-- port. When running tests, it's useful to let exceptions thrown by your
58+-- 'Application' propagate to the main thread of the test-suite.
59+--
60+-- __The exception handling makes this function unsuitable for use in production.__
61+-- Use 'withApplication' instead.
62+--
63+-- @since 3.2.4
64+testWithApplication :: IO Application -> (Port -> IO a) -> IO a
65+testWithApplication = testWithApplicationSettings defaultSettings
66+
67+-- | 'testWithApplication' with given 'Settings'.
68+--
69+-- @since 3.2.7
70+testWithApplicationSettings :: Settings -> IO Application -> (Port -> IO a) -> IO a
71+testWithApplicationSettings settings mkApp action = do
72+ callingThread <- myThreadId
73+ app <- mkApp
74+ let wrappedApp request respond =
75+ app request respond `catch` \ e -> do
76+ when
77+ (defaultShouldDisplayException e)
78+ (throwTo callingThread e)
79+ throwIO e
80+ withApplicationSettings settings (return wrappedApp) action
81+
82+data Waiter a
83+ = Waiter {
84+ notify :: a -> IO (),
85+ waitFor :: IO a
86+ }
87+
88+mkWaiter :: IO (Waiter a)
89+mkWaiter = do
90+ mvar <- newEmptyMVar
91+ return Waiter {
92+ notify = putMVar mvar,
93+ waitFor = readMVar mvar
94+ }
95+
96+-- | Opens a socket on a free port and returns both port and socket.
97+--
98+-- @since 3.2.4
99+openFreePort :: IO (Port, Socket)
100+openFreePort = bindRandomPortTCP "127.0.0.1"
101+
102+-- | Like 'openFreePort' but closes the socket before exiting.
103+withFreePort :: ((Port, Socket) -> IO a) -> IO a
104+withFreePort = bracket openFreePort (close . snd)
warp/attic/server-no-keepalive.hs+1−1
@@ -12,7 +12,7 @@ import Network.Wai (responseLBS)
1212import Network.HTTP.Types (status200)
1313import Data.Enumerator (($$), run_)
1414
15−app = const $ return $ responseLBS status200 [("Content-type", "text/plain")] "This is not kept alive under any circumtances"
15+app = const $ return $ responseLBS status200 [("Content-type", "text/plain")] "This is not kept alive under any circumstances"
1616
1717main = withManager 30000000 $ \man -> bracket
1818 (bindPort (settingsPort set) (settingsHost set))
warp/bench/Parser.hs+21−16
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE OverloadedStrings #-}
23{-# LANGUAGE BangPatterns #-}
34
@@ -18,7 +19,11 @@ import Foreign.ForeignPtr
1819import Foreign.Ptr
1920import Foreign.Storable
2021
21−import Criterion.Main
22+#if MIN_VERSION_gauge(0, 2, 0)
23+import Gauge
24+#else
25+import Gauge.Main
26+#endif
2227
2328-- $setup
2429-- >>> :set -XOverloadedStrings
@@ -32,15 +37,15 @@ main = do
3237 defaultMain [
3338 bgroup "requestLine1" [
3439 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine1
35− , bench "parseRequestLine2" $ parseRequestLine2 requestLine1
36− , bench "parseRequestLine1" $ parseRequestLine1 requestLine1
37− , bench "parseRequestLine0" $ parseRequestLine0 requestLine1
40+ , bench "parseRequestLine2" $ whnfIO $ parseRequestLine2 requestLine1
41+ , bench "parseRequestLine1" $ whnfIO $ parseRequestLine1 requestLine1
42+ , bench "parseRequestLine0" $ whnfIO $ parseRequestLine0 requestLine1
3843 ]
3944 , bgroup "requestLine2" [
4045 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine2
41− , bench "parseRequestLine2" $ parseRequestLine2 requestLine2
42− , bench "parseRequestLine1" $ parseRequestLine1 requestLine2
43− , bench "parseRequestLine0" $ parseRequestLine0 requestLine2
46+ , bench "parseRequestLine2" $ whnfIO $ parseRequestLine2 requestLine2
47+ , bench "parseRequestLine1" $ whnfIO $ parseRequestLine1 requestLine2
48+ , bench "parseRequestLine0" $ whnfIO $ parseRequestLine0 requestLine2
4449 ]
4550 ]
4651
@@ -63,15 +68,15 @@ parseRequestLine3 :: ByteString
6368 ,H.HttpVersion)
6469parseRequestLine3 requestLine = ret
6570 where
66− (!method,!rest) = S.breakByte 32 requestLine -- ' '
71+ (!method,!rest) = S.break (== 32) requestLine -- ' '
6772 (!pathQuery,!httpVer')
6873 | rest == "" = throw badmsg
69− | otherwise = S.breakByte 32 (S.drop 1 rest) -- ' '
70− (!path,!query) = S.breakByte 63 pathQuery -- '?'
74+ | otherwise = S.break (== 32) (S.drop 1 rest) -- ' '
75+ (!path,!query) = S.break (== 63) pathQuery -- '?'
7176 !httpVer = S.drop 1 httpVer'
7277 (!http,!ver)
7378 | httpVer == "" = throw badmsg
74− | otherwise = S.breakByte 47 httpVer -- '/'
79+ | otherwise = S.break (== 47) httpVer -- '/'
7580 !hv | http /= "HTTP" = throw NonHttp
7681 | ver == "/1.1" = H.http11
7782 | otherwise = H.http10
@@ -169,13 +174,13 @@ parseRequestLine1 :: ByteString
169174 ,ByteString -- Query
170175 ,H.HttpVersion)
171176parseRequestLine1 requestLine = do
172− let (!method,!rest) = S.breakByte 32 requestLine -- ' '
173− (!pathQuery,!httpVer') = S.breakByte 32 (S.drop 1 rest) -- ' '
177+ let (!method,!rest) = S.break (== 32) requestLine -- ' '
178+ (!pathQuery,!httpVer') = S.break (== 32) (S.drop 1 rest) -- ' '
174179 !httpVer = S.drop 1 httpVer'
175180 when (rest == "" || httpVer == "") $
176181 throwIO $ BadFirstLine $ B.unpack requestLine
177− let (!path,!query) = S.breakByte 63 pathQuery -- '?'
178− (!http,!ver) = S.breakByte 47 httpVer -- '/'
182+ let (!path,!query) = S.break (== 63) pathQuery -- '?'
183+ (!http,!ver) = S.break (== 47) httpVer -- '/'
179184 when (http /= "HTTP") $ throwIO NonHttp
180185 let !hv | ver == "/1.1" = H.http11
181186 | otherwise = H.http10
@@ -205,7 +210,7 @@ parseRequestLine0 s =
205210 !http' = S.concat http''
206211 (!hfirst, !hsecond) = S.splitAt 5 http'
207212 if hfirst == "HTTP/"
208− then let (!rpath, !qstring) = S.breakByte 63 query -- '?'
213+ then let (!rpath, !qstring) = S.break (== 63) query -- '?'
209214 !hv =
210215 case hsecond of
211216 "1.1" -> H.http11
warp/test/ExceptionSpec.hs+13−13
@@ -7,14 +7,14 @@ import Control.Applicative
77#endif
88import Control.Monad
99import Network.HTTP.Types hiding (Header)
10−import Network.Wai hiding (Response)
10+import Network.Wai hiding (Response, responseStatus)
1111import Network.Wai.Internal (Request(..))
1212import Network.Wai.Handler.Warp
1313import Test.Hspec
1414import Control.Exception
1515import qualified Data.Streaming.Network as N
1616import Control.Concurrent.Async (withAsync)
17−import Network.Socket (sClose)
17+import Network.Socket (close)
1818
1919import HTTP
2020
@@ -24,7 +24,7 @@ main = hspec spec
2424withTestServer :: (Int -> IO a) -> IO a
2525withTestServer inner = bracket
2626 (N.bindRandomPortTCP "127.0.0.1")
27− (sClose . snd)
27+ (close . snd)
2828 $ \(prt, lsocket) -> do
2929 withAsync (runSettingsSocket defaultSettings lsocket testApp)
3030 $ \_ -> inner prt
@@ -49,18 +49,18 @@ spec :: Spec
4949spec = describe "responds even if there is an exception" $ do
5050 {- Disabling these tests. We can consider forcing evaluation in Warp.
5151 it "statusError" $ do
52− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/statusError"
53− sc `shouldBe` (5,0,0)
52+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/statusError"
53+ sc `shouldBe` internalServerError500
5454 it "headersError" $ do
55− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headersError"
56− sc `shouldBe` (5,0,0)
55+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headersError"
56+ sc `shouldBe` internalServerError500
5757 it "headerError" $ do
58− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headerError"
59− sc `shouldBe` (5,0,0)
58+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headerError"
59+ sc `shouldBe` internalServerError500
6060 it "bodyError" $ do
61− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/bodyError"
62− sc `shouldBe` (5,0,0)
61+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/bodyError"
62+ sc `shouldBe` internalServerError500
6363 -}
6464 it "ioException" $ withTestServer $ \prt -> do
65− sc <- rspCode <$> sendGET ("http://127.0.0.1:" ++ show prt ++ "/ioException")
66− sc `shouldBe` (5,0,0)
65+ sc <- responseStatus <$> sendGET ("http://127.0.0.1:" ++ show prt ++ "/ioException")
66+ sc `shouldBe` internalServerError500
warp/test/FdCacheSpec.hs+2−2
@@ -16,8 +16,8 @@ spec :: Spec
1616spec = describe "withFdCache" $ do
1717 it "clean up Fd" $ do
1818 ref <- newIORef (Fd (-1))
19− withFdCache 30000000 $ \(Just mfc) -> do
20− (fd,_) <- getFd mfc "warp.cabal"
19+ withFdCache 30000000 $ \getFd -> do
20+ (Just fd,_) <- getFd "warp.cabal"
2121 writeIORef ref fd
2222 nfd <- readIORef ref
2323 fdRead nfd 1 `shouldThrow` anyIOException
warp/test/FileSpec.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module FileSpec (main, spec) where
4+
5+import Network.HTTP.Types
6+import Network.Wai.Handler.Warp.File
7+import Network.Wai.Handler.Warp.FileInfoCache
8+import Network.Wai.Handler.Warp.Header
9+
10+import Test.Hspec
11+
12+main :: IO ()
13+main = hspec spec
14+
15+testFileRange :: String
16+ -> RequestHeaders -> FilePath
17+ -> RspFileInfo
18+ -> Spec
19+testFileRange desc reqhs file ans = it desc $ do
20+ finfo <- getInfo file
21+ let WithBody s hs off len = ans
22+ hs' = ("Last-Modified",fileInfoDate finfo) : hs
23+ ans' = WithBody s hs' off len
24+ conditionalRequest finfo [] (indexResponseHeader hs) (indexRequestHeader reqhs) `shouldBe` ans'
25+
26+spec :: Spec
27+spec = do
28+ describe "conditionalRequest" $ do
29+ testFileRange
30+ "gets a file size from file system"
31+ [] "attic/hex"
32+ $ WithBody ok200 [("Content-Length","16"),("Accept-Ranges","bytes")] 0 16
33+ testFileRange
34+ "gets a file size from file system and handles Range and returns Partical Content"
35+ [("Range","bytes=2-14")] "attic/hex"
36+ $ WithBody status206 [("Content-Range","bytes 2-14/16"),("Content-Length","13"),("Accept-Ranges","bytes")] 2 13
37+ testFileRange
38+ "truncates end point of range to file size"
39+ [("Range","bytes=10-20")] "attic/hex"
40+ $ WithBody status206 [("Content-Range","bytes 10-15/16"),("Content-Length","6"),("Accept-Ranges","bytes")] 10 6
41+ testFileRange
42+ "gets a file size from file system and handles Range and returns OK if Range means the entire"
43+ [("Range:","bytes=0-15")] "attic/hex"
44+ $ WithBody status200 [("Content-Length","16"),("Accept-Ranges","bytes")] 0 16
45+
warp/test/HTTP.hs+26−28
@@ -1,43 +1,41 @@
1−{-# LANGUAGE StandaloneDeriving #-}
2−{-# OPTIONS_GHC -fno-warn-orphans #-}
31module HTTP (
42 sendGET
53 , sendGETwH
64 , sendHEAD
75 , sendHEADwH
8− , rspBody
9− , rspCode
10− , rspHeaders
6+ , responseBody
7+ , responseStatus
8+ , responseHeaders
119 , getHeaderValue
12− , HeaderName(..)
13− , mkHeader
10+ , HeaderName
1411 ) where
1512
16−import Network.HTTP
17−import Network.Stream
13+import Network.HTTP.Client
14+import Network.HTTP.Types
15+import Data.ByteString
16+import qualified Data.ByteString.Lazy as BL
1817
19−sendGET :: String -> IO (Response String)
18+sendGET :: String -> IO (Response BL.ByteString)
2019sendGET url = sendGETwH url []
2120
22−sendGETwH :: String -> [Header] -> IO (Response String)
23−sendGETwH url hdr = unResult $ simpleHTTP $ (getRequest url) { rqHeaders = hdr }
21+sendGETwH :: String -> [Header] -> IO (Response BL.ByteString)
22+sendGETwH url hdr = do
23+ manager <- newManager defaultManagerSettings
24+ request <- parseRequest url
25+ let request' = request { requestHeaders = hdr }
26+ response <- httpLbs request' manager
27+ return response
2428
25−sendHEAD :: String -> IO (Response String)
29+sendHEAD :: String -> IO (Response BL.ByteString)
2630sendHEAD url = sendHEADwH url []
2731
28−sendHEADwH :: String -> [Header] -> IO (Response String)
29−sendHEADwH url hdr = unResult $ simpleHTTP $ (headRequest url) { rqHeaders = hdr }
32+sendHEADwH :: String -> [Header] -> IO (Response BL.ByteString)
33+sendHEADwH url hdr = do
34+ manager <- newManager defaultManagerSettings
35+ request <- parseRequest url
36+ let request' = request { requestHeaders = hdr, method = methodHead }
37+ response <- httpLbs request' manager
38+ return response
3039
31−unResult :: IO (Result (Response String)) -> IO (Response String)
32−unResult action = do
33− res <- action
34− case res of
35− Right rsp -> return rsp
36− Left _ -> error "Connection error"
37−
38−getHeaderValue :: HasHeaders a => HeaderName -> a -> Maybe String
39−getHeaderValue key r = case retrieveHeaders key r of
40− [] -> Nothing
41− x:_ -> Just $ hdrValue x
42−
43−deriving instance Eq Header
40+getHeaderValue :: HeaderName -> [Header] -> Maybe ByteString
41+getHeaderValue = lookup
warp/test/MultiMapSpec.hsdeleted−30
@@ -1,30 +0,0 @@
1−module MultiMapSpec where
2−
3−import Network.Wai.Handler.Warp.MultiMap
4−import Test.Hspec
5−import Test.QuickCheck (property)
6−
7−type Alist = [(Int,Char)]
8−
9−spec :: Spec
10−spec = do
11− describe "fromList" $ do
12− it "generates a valid tree" $ property $ \xs ->
13− valid $ fromList (xs :: Alist)
14− describe "toSortedList" $ do
15− it "generated a sorted list" $ property $ \xs ->
16− ordered $ toSortedList $ fromList (xs :: Alist)
17− describe "search" $ do
18− it "acts as the list model" $ property $ \x xs ->
19− search x (fromList xs) == lookup x (xs :: Alist)
20− describe "fromSortedList" $ do
21− it "generates a valid tree" $ property $ \xs ->
22− valid . fromSortedList . toSortedList . fromList $ (xs :: Alist)
23− it "maintains the tree with toSortedList" $ property $ \xs ->
24− let t1 = fromList (xs :: Alist)
25− t2 = fromSortedList $ toSortedList t1
26− in t1 == t2
27−
28−ordered :: Ord a => [(a, b)] -> Bool
29−ordered (x:y:xys) = fst x <= fst y && ordered (y:xys)
30−ordered _ = True
warp/test/RequestSpec.hs+12−8
@@ -4,9 +4,10 @@
44
55module RequestSpec (main, spec) where
66
7+import Network.Wai.Handler.Warp.File (parseByteRanges)
78import Network.Wai.Handler.Warp.Request
8−import Network.Wai.Handler.Warp.RequestHeader (parseByteRanges)
99import Network.Wai.Handler.Warp.Types
10+import Network.Wai.Handler.Warp.Settings (settingsMaxTotalHeaderLength, defaultSettings)
1011import Test.Hspec
1112import Test.Hspec.QuickCheck
1213import qualified Data.ByteString as S
@@ -17,6 +18,9 @@ import Data.IORef
1718main :: IO ()
1819main = hspec spec
1920
21+defaultMaxTotalHeaderLength :: Int
22+defaultMaxTotalHeaderLength = settingsMaxTotalHeaderLength defaultSettings
23+
2024spec :: Spec
2125spec = do
2226 describe "headerLines" $ do
@@ -63,29 +67,29 @@ spec = do
6367 describe "headerLines" $ do
6468 it "can handle a nomarl case" $ do
6569 src <- mkSourceFunc ["Status: 200\r\nContent-Type: text/plain\r\n\r\n"] >>= mkSource
66− x <- headerLines src
70+ x <- headerLines defaultMaxTotalHeaderLength True src
6771 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
6872
6973 it "can handle a nasty case (1)" $ do
7074 src <- mkSourceFunc ["Status: 200", "\r\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
71− x <- headerLines src
75+ x <- headerLines defaultMaxTotalHeaderLength True src
7276 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
7377
7478 it "can handle a nasty case (1)" $ do
7579 src <- mkSourceFunc ["Status: 200", "\r", "\nContent-Type: text/plain", "\r", "\n\r\n"] >>= mkSource
76− x <- headerLines src
80+ x <- headerLines defaultMaxTotalHeaderLength True src
7781 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
7882
7983 it "can handle a nasty case (1)" $ do
8084 src <- mkSourceFunc ["Status: 200", "\r", "\n", "Content-Type: text/plain", "\r", "\n", "\r", "\n"] >>= mkSource
81− x <- headerLines src
85+ x <- headerLines defaultMaxTotalHeaderLength True src
8286 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
8387
8488 it "can handle an illegal case (1)" $ do
8589 src <- mkSourceFunc ["\nStatus:", "\n 200", "\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
86− x <- headerLines src
90+ x <- headerLines defaultMaxTotalHeaderLength True src
8791 x `shouldBe` []
88− y <- headerLines src
92+ y <- headerLines defaultMaxTotalHeaderLength True src
8993 y `shouldBe` ["Status: 200", "Content-Type: text/plain"]
9094
9195 where
@@ -111,7 +115,7 @@ headerLinesList' orig = do
111115 writeIORef ref z
112116 return y
113117 src' <- mkSource src
114− res <- headerLines src'
118+ res <- headerLines defaultMaxTotalHeaderLength True src'
115119 return (res, src')
116120
117121consumeLen :: Int -> Source -> IO S8.ByteString
warp/test/ResponseHeaderSpec.hs+25−5
@@ -5,24 +5,44 @@ module ResponseHeaderSpec (main, spec) where
55import Data.ByteString
66import qualified Network.HTTP.Types as H
77import Network.Wai.Handler.Warp.ResponseHeader
8+import Network.Wai.Handler.Warp.Response
9+import Network.Wai.Handler.Warp.Header
810import Test.Hspec
911
1012main :: IO ()
1113main = hspec spec
1214
1315spec :: Spec
14−spec = describe "composeHeader" $ do
15− it "composes a HTTP header" $
16− composeHeader H.http11 H.ok200 headers `shouldReturn` composedHeader
16+spec = do
17+ describe "composeHeader" $ do
18+ it "composes a HTTP header" $
19+ composeHeader H.http11 H.ok200 headers `shouldReturn` composedHeader
20+ describe "addServer" $ do
21+ it "adds Server if not exist" $ do
22+ let hdrs = []
23+ rspidxhdr = indexResponseHeader hdrs
24+ addServer "MyServer" rspidxhdr hdrs `shouldBe` [("Server","MyServer")]
25+ it "does not add Server if exists" $ do
26+ let hdrs = [("Server","MyServer")]
27+ rspidxhdr = indexResponseHeader hdrs
28+ addServer "MyServer2" rspidxhdr hdrs `shouldBe` hdrs
29+ it "does not add Server if empty" $ do
30+ let hdrs = []
31+ rspidxhdr = indexResponseHeader hdrs
32+ addServer "" rspidxhdr hdrs `shouldBe` hdrs
33+ it "deletes Server " $ do
34+ let hdrs = [("Server","MyServer")]
35+ rspidxhdr = indexResponseHeader hdrs
36+ addServer "" rspidxhdr hdrs `shouldBe` []
1737
1838headers :: H.ResponseHeaders
1939headers = [
2040 ("Date", "Mon, 13 Aug 2012 04:22:55 GMT")
21− , ("Content-Lenght", "151")
41+ , ("Content-Length", "151")
2242 , ("Server", "Mighttpd/2.5.8")
2343 , ("Last-Modified", "Fri, 22 Jun 2012 01:18:08 GMT")
2444 , ("Content-Type", "text/html")
2545 ]
2646
2747composedHeader :: ByteString
28−composedHeader = "HTTP/1.1 200 OK\r\nDate: Mon, 13 Aug 2012 04:22:55 GMT\r\nContent-Lenght: 151\r\nServer: Mighttpd/2.5.8\r\nLast-Modified: Fri, 22 Jun 2012 01:18:08 GMT\r\nContent-Type: text/html\r\n\r\n"
48+composedHeader = "HTTP/1.1 200 OK\r\nDate: Mon, 13 Aug 2012 04:22:55 GMT\r\nContent-Length: 151\r\nServer: Mighttpd/2.5.8\r\nLast-Modified: Fri, 22 Jun 2012 01:18:08 GMT\r\nContent-Type: text/html\r\n\r\n"
warp/test/ResponseSpec.hs+16−70
@@ -1,22 +1,18 @@
11{-# LANGUAGE OverloadedStrings #-}
2+
23module ResponseSpec (main, spec) where
34
45import Control.Concurrent (threadDelay)
56import qualified Data.ByteString as S
67import qualified Data.ByteString.Char8 as S8
78import Data.Maybe (mapMaybe)
8−import Network (connectTo, PortID (PortNumber))
99import Network.HTTP.Types
10−import Network.Wai
10+import Network.Wai hiding (responseHeaders)
1111import Network.Wai.Handler.Warp
12−import Network.Wai.Handler.Warp.FileInfoCache
1312import Network.Wai.Handler.Warp.Response
14−import RunSpec (withApp)
15−import System.IO (hClose, hFlush)
13+import RunSpec (withApp, msWrite, msRead, withMySocket)
1614import Test.Hspec
1715
18−import HTTP
19−
2016main :: IO ()
2117main = hspec spec
2218
@@ -24,16 +20,13 @@ testRange :: S.ByteString -- ^ range value
2420 -> String -- ^ expected output
2521 -> Maybe String -- ^ expected content-range value
2622 -> Spec
27−testRange range out crange = it title $ withApp defaultSettings app $ \port -> do
28− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
29− S.hPutStr handle "GET / HTTP/1.0\r\n"
30− S.hPutStr handle "Range: bytes="
31− S.hPutStr handle range
32− S.hPutStr handle "\r\n\r\n"
33− hFlush handle
23+testRange range out crange = it title $ withApp defaultSettings app $ withMySocket $ \ms -> do
24+ msWrite ms "GET / HTTP/1.0\r\n"
25+ msWrite ms "Range: bytes="
26+ msWrite ms range
27+ msWrite ms "\r\n\r\n"
3428 threadDelay 10000
35− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
36− hClose handle
29+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
3730 last bss `shouldBe` out
3831 let hs = mapMaybe toHeader bss
3932 lookup "Content-Range" hs `shouldBe` fmap ("bytes " ++) crange
@@ -51,13 +44,10 @@ testPartial :: Integer -- ^ file size
5144 -> Integer -- ^ byte count
5245 -> String -- ^ expected output
5346 -> Spec
54−testPartial size offset count out = it title $ withApp defaultSettings app $ \port -> do
55− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
56− S.hPutStr handle "GET / HTTP/1.0\r\n\r\n"
57− hFlush handle
47+testPartial size offset count out = it title $ withApp defaultSettings app $ withMySocket $ \ms -> do
48+ msWrite ms "GET / HTTP/1.0\r\n\r\n"
5849 threadDelay 10000
59− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
60− hClose handle
50+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
6151 out `shouldBe` last bss
6252 let hs = mapMaybe toHeader bss
6353 lookup "Content-Length" hs `shouldBe` Just (show $ length $ last bss)
@@ -71,27 +61,17 @@ testPartial size offset count out = it title $ withApp defaultSettings app $ \po
7161 _ -> Nothing
7262 range = "bytes " ++ show offset ++ "-" ++ show (offset + count - 1) ++ "/" ++ show size
7363
74−testFileRange :: String
75− -> Status -> ResponseHeaders -> FilePath
76− -> Maybe FilePart -> Maybe HeaderValue
77− -> Either String (Status, ResponseHeaders, Integer, Integer)
78− -> Spec
79−testFileRange desc s rsphdr file mPart mRange ans = it desc $ do
80− eres <- fileRange s rsphdr file mPart mRange getInfo
81− let res = case eres of
82− Left e -> Left $ show e
83− Right r -> Right r
84− res `shouldBe` ans
85−
8664spec :: Spec
8765spec = do
66+{- http-client does not support this.
8867 describe "preventing response splitting attack" $ do
8968 it "sanitizes header values" $ do
9069 let app _ respond = respond $ responseLBS status200 [("foo", "foo\r\nbar")] "Hello"
9170 withApp defaultSettings app $ \port -> do
9271 res <- sendGET $ "http://127.0.0.1:" ++ show port
93− getHeaderValue (HdrCustom "foo") res `shouldBe`
72+ getHeaderValue "foo" (responseHeaders res) `shouldBe`
9473 Just "foo bar" -- HTTP inserts two spaces for \r\n.
74+-}
9575
9676 describe "sanitizeHeaderValue" $ do
9777 it "doesn't alter valid multiline header values" $ do
@@ -103,7 +83,7 @@ spec = do
10383 it "discards empty lines" $ do
10484 sanitizeHeaderValue "foo\r\n\r\nbar" `shouldBe` "foo\r\n bar"
10585
106− context "when sanitizing single occurences of \n" $ do
86+ context "when sanitizing single occurrences of \n" $ do
10787 it "replaces \n with \r\n" $ do
10888 sanitizeHeaderValue "foo\n bar" `shouldBe` "foo\r\n bar"
10989
@@ -125,37 +105,3 @@ spec = do
125105 testPartial 16 2 2 "23"
126106 testPartial 16 0 2 "01"
127107 testPartial 16 3 8 "3456789a"
128−
129− describe "fileRange" $ do
130− testFileRange
131− "gets a file size from file system"
132− status200 [] "attic/hex" Nothing Nothing
133− $ Right (status200,[("Content-Length","16"), ("Accept-Ranges","bytes")],0,16)
134− testFileRange
135− "gets an error if a file does not exist"
136− status200 [] "attic/nonexist" Nothing Nothing
137− $ Left "attic/nonexist: getFileStatus: does not exist (No such file or directory)"
138− testFileRange
139− "changes status if FileParts is specified"
140− status200 [] "attic/hex" (Just (FilePart 2 10 16)) Nothing
141− $ Right (status206,[("Content-Range", "bytes 2-11/16"),("Content-Length","10"),("Accept-Ranges","bytes")],2,10)
142− testFileRange
143− "does not change status and does not add Content-Range if FileParts means the entire"
144− status200 [] "attic/hex" (Just (FilePart 0 16 16)) Nothing
145− $ Right (status200,[("Content-Length","16"), ("Accept-Ranges","bytes")],0,16)
146− testFileRange
147− "gets a file size from file system and handles Range and returns Partical Content"
148− status200 [] "attic/hex" Nothing (Just "bytes=2-14")
149− $ Right (status206,[("Content-Range","bytes 2-14/16"),("Content-Length","13"),("Accept-Ranges","bytes")],2,13)
150− testFileRange
151− "truncates end point of range to file size"
152− status200 [] "attic/hex" Nothing (Just "bytes=10-20")
153− $ Right (status206,[("Content-Range","bytes 10-15/16"),("Content-Length","6"),("Accept-Ranges","bytes")],10,6)
154− testFileRange
155− "gets a file size from file system and handles Range and returns OK if Range means the entire"
156− status200 [] "attic/hex" Nothing (Just "bytes=0-15")
157− $ Right (status200,[("Content-Length","16"),("Accept-Ranges","bytes")],0,16)
158− testFileRange
159− "igores Range if FilePart is specified"
160− status200 [] "attic/hex" (Just (FilePart 2 10 16)) (Just "bytes=8-9")
161− $ Right (status206,[("Content-Range", "bytes 2-11/16"),("Content-Length","10"),("Accept-Ranges","bytes")],2,10)
warp/test/RunSpec.hs+136−86
@@ -1,29 +1,28 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE OverloadedStrings #-}
32{-# LANGUAGE ScopedTypeVariables #-}
43
5−module RunSpec (main, spec, withApp) where
4+module RunSpec (main, spec, withApp, MySocket, msWrite, msRead, withMySocket) where
65
76import Control.Concurrent (forkIO, killThread, threadDelay)
87import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
8+import Control.Concurrent.STM
99import qualified Control.Exception as E
1010import Control.Exception.Lifted (bracket, try, IOException, onException)
1111import Control.Monad (forM_, replicateM_, unless)
1212import Control.Monad.IO.Class (MonadIO, liftIO)
13−import Data.ByteString (ByteString, hPutStr, hGetSome)
13+import Data.ByteString (ByteString)
1414import qualified Data.ByteString as S
1515import Data.ByteString.Builder (byteString)
1616import qualified Data.ByteString.Char8 as S8
1717import qualified Data.ByteString.Lazy as L
1818import qualified Data.IORef as I
1919import Data.Streaming.Network (bindPortTCP, getSocketTCP, safeRecv)
20−import Network (connectTo, PortID (PortNumber))
2120import Network.HTTP.Types
22−import Network.Socket (sClose)
21+import Network.Socket
2322import Network.Socket.ByteString (sendAll)
24−import Network.Wai
23+import Network.Wai hiding (responseHeaders)
24+import Network.Wai.Internal (getRequestBodyChunk)
2525import Network.Wai.Handler.Warp
26−import System.IO (hFlush, hClose)
2726import System.IO.Unsafe (unsafePerformIO)
2827import System.Timeout (timeout)
2928import Test.Hspec
@@ -36,6 +35,52 @@ main = hspec spec
3635type Counter = I.IORef (Either String Int)
3736type CounterApplication = Counter -> Application
3837
38+data MySocket = MySocket
39+ { msSocket :: !Socket
40+ , msBuffer :: !(I.IORef ByteString)
41+ }
42+
43+msWrite :: MySocket -> ByteString -> IO ()
44+msWrite ms bs = sendAll (msSocket ms) bs
45+
46+msRead :: MySocket -> Int -> IO ByteString
47+msRead (MySocket s ref) expected = do
48+ bs <- I.readIORef ref
49+ inner (bs:) (S.length bs)
50+ where
51+ inner front total =
52+ case compare total expected of
53+ EQ -> do
54+ I.writeIORef ref mempty
55+ pure $ S.concat $ front []
56+ GT -> do
57+ let bs = S.concat $ front []
58+ (x, y) = S.splitAt expected bs
59+ I.writeIORef ref y
60+ pure x
61+ LT -> do
62+ bs <- safeRecv s 4096
63+ if S.null bs
64+ then do
65+ I.writeIORef ref mempty
66+ pure $ S.concat $ front []
67+ else inner (front . (bs:)) (total + S.length bs)
68+
69+msClose :: MySocket -> IO ()
70+msClose = Network.Socket.close . msSocket
71+
72+connectTo :: Int -> IO MySocket
73+connectTo port = do
74+ s <- fst <$> getSocketTCP "127.0.0.1" port
75+ ref <- I.newIORef mempty
76+ return MySocket {
77+ msSocket = s
78+ , msBuffer = ref
79+ }
80+
81+withMySocket :: (MySocket -> IO a) -> Int -> IO a
82+withMySocket body port = bracket (connectTo port) msClose body
83+
3984incr :: MonadIO m => Counter -> m ()
4085incr icount = liftIO $ I.atomicModifyIORef icount $ \ecount ->
4186 ((case ecount of
@@ -47,7 +92,7 @@ err icount msg = liftIO $ I.writeIORef icount $ Left $ show msg
4792
4893readBody :: CounterApplication
4994readBody icount req f = do
50− body <- consumeBody $ requestBody req
95+ body <- consumeBody $ getRequestBodyChunk req
5196 case () of
5297 ()
5398 | pathInfo req == ["hello"] && L.fromChunks body /= "Hello"
@@ -68,8 +113,8 @@ ignoreBody icount req f = do
68113
69114doubleConnect :: CounterApplication
70115doubleConnect icount req f = do
71− _ <- consumeBody $ requestBody req
72− _ <- consumeBody $ requestBody req
116+ _ <- consumeBody $ getRequestBodyChunk req
117+ _ <- consumeBody $ getRequestBodyChunk req
73118 incr icount
74119 f $ responseLBS status200 [] "double connect"
75120
@@ -83,8 +128,8 @@ getPort = do
83128 esocket <- try $ bindPortTCP port "127.0.0.1"
84129 case esocket of
85130 Left (_ :: IOException) -> RunSpec.getPort
86− Right socket -> do
87− sClose socket
131+ Right sock -> do
132+ close sock
88133 return port
89134
90135withApp :: Settings -> Application -> (Int -> IO a) -> IO a
@@ -98,7 +143,13 @@ withApp settings app f = do
98143 bracket
99144 (forkIO $ runSettings settings' app `onException` putMVar baton ())
100145 killThread
101− (const $ takeMVar baton >> f port)
146+ (const $ do
147+ takeMVar baton
148+ -- use timeout to make sure we don't take too long
149+ mres <- timeout (60 * 1000 * 1000) (f port)
150+ case mres of
151+ Nothing -> error "Timeout triggered, too slow!"
152+ Just a -> pure a)
102153
103154runTest :: Int -- ^ expected number of requests
104155 -> CounterApplication
@@ -106,10 +157,9 @@ runTest :: Int -- ^ expected number of requests
106157 -> IO ()
107158runTest expected app chunks = do
108159 ref <- I.newIORef (Right 0)
109− withApp defaultSettings (app ref) $ \port -> do
110− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
111− forM_ chunks $ \chunk -> hPutStr handle chunk >> hFlush handle
112− _ <- timeout 100000 $ replicateM_ expected $ hGetSome handle 4096
160+ withApp defaultSettings (app ref) $ withMySocket $ \ms -> do
161+ forM_ chunks $ \chunk -> msWrite ms chunk
162+ _ <- timeout 100000 $ replicateM_ expected $ msRead ms 4096
113163 res <- I.readIORef ref
114164 case res of
115165 Left s -> error s
@@ -124,11 +174,9 @@ runTerminateTest :: InvalidRequest
124174runTerminateTest expected input = do
125175 ref <- I.newIORef Nothing
126176 let onExc _ = I.writeIORef ref . Just
127− withApp (setOnException onExc defaultSettings) dummyApp $ \port -> do
128− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
129− hPutStr handle input
130− hFlush handle
131− hClose handle
177+ withApp (setOnException onExc defaultSettings) dummyApp $ withMySocket $ \ms -> do
178+ msWrite ms input
179+ msClose ms -- explicitly
132180 threadDelay 1000
133181 res <- I.readIORef ref
134182 show res `shouldBe` show (Just expected)
@@ -199,14 +247,11 @@ spec = do
199247 let app req f = do
200248 liftIO $ I.writeIORef iheaders $ requestHeaders req
201249 f $ responseLBS status200 [] ""
202− withApp defaultSettings app $ \port -> do
203− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
250+ withApp defaultSettings app $ withMySocket $ \ms -> do
204251 let input = S.concat
205252 [ "GET / HTTP/1.1\r\nfoo: bar\r\n baz\r\n\tbin\r\n\r\n"
206253 ]
207− hPutStr handle input
208− hFlush handle
209− hClose handle
254+ msWrite ms input
210255 threadDelay 1000
211256 headers <- I.readIORef iheaders
212257 headers `shouldBe`
@@ -217,14 +262,11 @@ spec = do
217262 let app req f = do
218263 liftIO $ I.writeIORef iheaders $ requestHeaders req
219264 f $ responseLBS status200 [] ""
220− withApp defaultSettings app $ \port -> do
221− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
265+ withApp defaultSettings app $ withMySocket $ \ms -> do
222266 let input = S.concat
223267 [ "GET / HTTP/1.1\r\nfoo:bar\r\n\r\n"
224268 ]
225− hPutStr handle input
226− hFlush handle
227− hClose handle
269+ msWrite ms input
228270 threadDelay 1000
229271 headers <- I.readIORef iheaders
230272 headers `shouldBe`
@@ -233,23 +275,24 @@ spec = do
233275
234276 describe "chunked bodies" $ do
235277 it "works" $ do
278+ countVar <- newTVarIO (0 :: Int)
236279 ifront <- I.newIORef id
237280 let app req f = do
238− bss <- consumeBody $ requestBody req
281+ bss <- consumeBody $ getRequestBodyChunk req
239282 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
283+ atomically $ modifyTVar countVar (+ 1)
240284 f $ responseLBS status200 [] ""
241− withApp defaultSettings app $ \port -> do
242− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
285+ withApp defaultSettings app $ withMySocket $ \ms -> do
243286 let input = S.concat
244287 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
245288 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n\r\n"
246289 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
247290 , "b\r\nHello World\r\n0\r\n\r\n"
248291 ]
249− hPutStr handle input
250− hFlush handle
251− hClose handle
252− threadDelay 1000
292+ msWrite ms input
293+ atomically $ do
294+ count <- readTVar countVar
295+ check $ count == 2
253296 front <- I.readIORef ifront
254297 front [] `shouldBe`
255298 [ "Hello World\nBye"
@@ -257,38 +300,44 @@ spec = do
257300 ]
258301 it "lots of chunks" $ do
259302 ifront <- I.newIORef id
303+ countVar <- newTVarIO (0 :: Int)
260304 let app req f = do
261− bss <- consumeBody $ requestBody req
305+ bss <- consumeBody $ getRequestBodyChunk req
262306 I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
307+ atomically $ modifyTVar countVar (+ 1)
263308 f $ responseLBS status200 [] ""
264− withApp defaultSettings app $ \port -> do
265− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
309+ withApp defaultSettings app $ withMySocket $ \ms -> do
266310 let input = concat $ replicate 2 $
267311 ["POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"] ++
268312 (replicate 50 "5\r\n12345\r\n") ++
269313 ["0\r\n\r\n"]
270− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) input
271− hClose handle
272− threadDelay 100000 -- FIXME why does this delay need to be so high?
314+ mapM_ (msWrite ms) input
315+ atomically $ do
316+ count <- readTVar countVar
317+ check $ count == 2
273318 front <- I.readIORef ifront
274319 front [] `shouldBe` replicate 2 (S.concat $ replicate 50 "12345")
320+-- For some reason, the following test on Windows causes the socket
321+-- to be killed prematurely. Worth investigating in the future if possible.
275322 it "in chunks" $ do
276323 ifront <- I.newIORef id
324+ countVar <- newTVarIO (0 :: Int)
277325 let app req f = do
278− bss <- consumeBody $ requestBody req
326+ bss <- consumeBody $ getRequestBodyChunk req
279327 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
328+ atomically $ modifyTVar countVar (+ 1)
280329 f $ responseLBS status200 [] ""
281− withApp defaultSettings app $ \port -> do
282− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
330+ withApp defaultSettings app $ withMySocket $ \ms -> do
283331 let input = S.concat
284332 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
285333 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n"
286334 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
287335 , "b\r\nHello World\r\n0\r\n\r\n"
288336 ]
289− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) $ map S.singleton $ S.unpack input
290− hClose handle
291− threadDelay 1000
337+ mapM_ (msWrite ms) $ map S.singleton $ S.unpack input
338+ atomically $ do
339+ count <- readTVar countVar
340+ check $ count == 2
292341 front <- I.readIORef ifront
293342 front [] `shouldBe`
294343 [ "Hello World\nBye"
@@ -297,7 +346,7 @@ spec = do
297346 it "timeout in request body" $ do
298347 ifront <- I.newIORef id
299348 let app req f = do
300− bss <- (consumeBody $ requestBody req) `onException`
349+ bss <- (consumeBody $ getRequestBodyChunk req) `onException`
301350 liftIO (I.atomicModifyIORef ifront (\front -> (front . ("consume interrupted":), ())))
302351 liftIO $ threadDelay 4000000 `E.catch` \e -> do
303352 I.atomicModifyIORef ifront (\front ->
@@ -306,20 +355,18 @@ spec = do
306355 E.throwIO (e :: E.SomeException)
307356 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
308357 f $ responseLBS status200 [] ""
309− withApp (setTimeout 1 defaultSettings) app $ \port -> do
358+ withApp (setTimeout 1 defaultSettings) app $ withMySocket $ \ms -> do
310359 let bs1 = S.replicate 2048 88
311360 bs2 = "This is short"
312361 bs = S.append bs1 bs2
313− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
314− hPutStr handle "POST / HTTP/1.1\r\n"
315− hPutStr handle "content-length: "
316− hPutStr handle $ S8.pack $ show $ S.length bs
317− hPutStr handle "\r\n\r\n"
362+ msWrite ms "POST / HTTP/1.1\r\n"
363+ msWrite ms "content-length: "
364+ msWrite ms $ S8.pack $ show $ S.length bs
365+ msWrite ms "\r\n\r\n"
318366 threadDelay 100000
319− hPutStr handle bs1
367+ msWrite ms bs1
320368 threadDelay 100000
321− hPutStr handle bs2
322− hClose handle
369+ msWrite ms bs2
323370 threadDelay 5000000
324371 front <- I.readIORef ifront
325372 S.concat (front []) `shouldBe` bs
@@ -335,39 +382,42 @@ spec = do
335382 loop
336383 loop
337384 doubleBS = S.concatMap $ \w -> S.pack [w, w]
338− withApp defaultSettings app $ \port -> do
339− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
340− hPutStr handle "POST / HTTP/1.1\r\n\r\n12345"
341− hFlush handle
342− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "1122334455")
343− hPutStr handle "67890"
344− hFlush handle
345− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "6677889900")
346−
385+ withApp defaultSettings app $ withMySocket $ \ms -> do
386+ msWrite ms "POST / HTTP/1.1\r\n\r\n12345"
387+ timeout 100000 (msRead ms 10) >>= (`shouldBe` Just "1122334455")
388+ msWrite ms "67890"
389+ timeout 100000 (msRead ms 10) >>= (`shouldBe` Just "6677889900")
347390 it "only one date and server header" $ do
348391 let app _ f = f $ responseLBS status200
349392 [ ("server", "server")
350393 , ("date", "date")
351394 ] ""
395+ getValues key = map snd
396+ . filter (\(key', _) -> key == key')
397+ . responseHeaders
352398 withApp defaultSettings app $ \port -> do
353399 res <- sendGET $ "http://127.0.0.1:" ++ show port
354− getHeaderValue HdrServer res `shouldBe` Just "server"
355− getHeaderValue HdrDate res `shouldBe` Just "date"
400+ getValues hServer res `shouldBe` ["server"]
401+ getValues hDate res `shouldBe` ["date"]
356402
357403 it "streaming echo #249" $ do
404+ countVar <- newTVarIO (0 :: Int)
358405 let app req f = f $ responseStream status200 [] $ \write _ -> do
359− let loop = do
360− bs <- requestBody req
406+ let loop = do
407+ bs <- getRequestBodyChunk req
361408 unless (S.null bs) $ do
362409 write $ byteString bs
410+ atomically $ modifyTVar countVar (+ 1)
363411 loop
364− loop
365− withApp defaultSettings app $ \port -> do
366− (socket, _addr) <- getSocketTCP "127.0.0.1" port
367− sendAll socket "POST / HTTP/1.1\r\ntransfer-encoding: chunked\r\n\r\n"
412+ loop
413+ withApp defaultSettings app $ withMySocket $ \ms -> do
414+ msWrite ms "POST / HTTP/1.1\r\ntransfer-encoding: chunked\r\n\r\n"
368415 threadDelay 10000
369− sendAll socket "5\r\nhello\r\n0\r\n\r\n"
370− bs <- safeRecv socket 4096
416+ msWrite ms "5\r\nhello\r\n0\r\n\r\n"
417+ atomically $ do
418+ count <- readTVar countVar
419+ check $ count >= 1
420+ bs <- safeRecv (msSocket ms) 4096 -- must not use msRead
371421 S.takeWhile (/= 13) bs `shouldBe` "HTTP/1.1 200 OK"
372422
373423 it "streaming response with length" $ do
@@ -375,7 +425,7 @@ spec = do
375425 replicateM_ 4 $ write $ byteString "Hello"
376426 withApp defaultSettings app $ \port -> do
377427 res <- sendGET $ "http://127.0.0.1:" ++ show port
378− rspBody res `shouldBe` "HelloHelloHelloHello"
428+ responseBody res `shouldBe` "HelloHelloHelloHello"
379429
380430 describe "head requests" $ do
381431 let fp = "test/head-response"
@@ -388,19 +438,19 @@ spec = do
388438 _ -> error "invalid path"
389439 it "builder" $ withApp defaultSettings app $ \port -> do
390440 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/builder"]
391− rspBody res `shouldBe` ""
441+ responseBody res `shouldBe` ""
392442 it "streaming" $ withApp defaultSettings app $ \port -> do
393443 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/streaming"]
394− rspBody res `shouldBe` ""
444+ responseBody res `shouldBe` ""
395445 it "file, no range" $ withApp defaultSettings app $ \port -> do
396446 bs <- S.readFile fp
397447 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/file"]
398− getHeaderValue HdrContentLength res `shouldBe` Just (show $ S.length bs)
448+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just (S8.pack $ show $ S.length bs)
399449 it "file, with range" $ withApp defaultSettings app $ \port -> do
400450 res <- sendHEADwH
401451 (concat ["http://127.0.0.1:", show port, "/file"])
402− [mkHeader HdrRange "bytes=0-1"]
403− getHeaderValue HdrContentLength res `shouldBe` Just "2"
452+ [(hRange, "bytes=0-1")]
453+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just "2"
404454
405455consumeBody :: IO ByteString -> IO [ByteString]
406456consumeBody body =
warp/test/WithApplicationSpec.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module WithApplicationSpec where
4+
5+import Control.Exception
6+import Network.HTTP.Types
7+import Network.Wai
8+import System.Environment
9+import System.Process
10+import Test.Hspec
11+
12+import Network.Wai.Handler.Warp.WithApplication
13+
14+spec :: Spec
15+spec = do
16+ runIO $ do
17+ unsetEnv "http_proxy"
18+ unsetEnv "https_proxy"
19+ describe "withApplication" $ do
20+ it "runs a wai Application while executing the given action" $ do
21+ let mkApp = return $ \ _request respond -> respond $ responseLBS ok200 [] "foo"
22+ withApplication mkApp $ \ port -> do
23+ output <- readProcess "curl" ["-s", "localhost:" ++ show port] ""
24+ output `shouldBe` "foo"
25+
26+ it "does not propagate exceptions from the server to the executing thread" $ do
27+ let mkApp = return $ \ _request _respond -> throwIO $ ErrorCall "foo"
28+ withApplication mkApp $ \ port -> do
29+ output <- readProcess "curl" ["-s", "localhost:" ++ show port] ""
30+ output `shouldContain` "Something went wron"
31+
32+ describe "testWithApplication" $ do
33+ it "propagates exceptions from the server to the executing thread" $ do
34+ let mkApp = return $ \ _request _respond -> throwIO $ ErrorCall "foo"
35+ (testWithApplication mkApp $ \ port -> do
36+ readProcess "curl" ["-s", "localhost:" ++ show port] "")
37+ `shouldThrow` (errorCall "foo")
38+
39+{- The future netwrok library will not export MkSocket.
40+ describe "withFreePort" $ do
41+ it "closes the socket before exiting" $ do
42+ MkSocket _ _ _ _ statusMVar <- withFreePort $ \ (_, sock) -> do
43+ return sock
44+ readMVar statusMVar `shouldReturn` Closed
45+-}
warp/warp.cabal+132−52
@@ -1,5 +1,5 @@
11Name: warp
2−Version: 3.1.9
2+Version: 3.3.9
33Synopsis: A fast, light-weight web server for WAI applications.
44License: MIT
55License-file: LICENSE
@@ -8,7 +8,7 @@ Maintainer: michael@snoyman.com
88Homepage: http://github.com/yesodweb/wai
99Category: Web, Yesod
1010Build-Type: Simple
11−Cabal-Version: >=1.8
11+Cabal-Version: >= 1.10
1212Stability: Stable
1313description: HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported.
1414 For HTTP\/2, Warp supports direct and ALPN (in TLS)
@@ -19,6 +19,7 @@ extra-source-files: attic/hex
1919 ChangeLog.md
2020 README.md
2121 test/head-response
22+ test/inputFile
2223
2324Flag network-bytestring
2425 Default: False
@@ -32,28 +33,32 @@ Flag warp-debug
3233 Default: False
3334
3435Library
35− Build-Depends: base >= 3 && < 5
36+ Build-Depends: base >= 4.8 && < 5
3637 , array
37− , auto-update >= 0.1.1 && < 0.2
38− , blaze-builder >= 0.4
38+ , async
39+ , auto-update >= 0.1.3 && < 0.2
40+ , bsb-http-chunked < 0.1
3941 , bytestring >= 0.9.1.4
40− , bytestring-builder
4142 , case-insensitive >= 0.2
4243 , containers
4344 , ghc-prim
44− , http-types >= 0.8.5
45+ , hashable
46+ , http-date
47+ , http-types >= 0.12
48+ , http2 >= 2.0 && < 2.1
4549 , iproute >= 1.3.1
46− , http2 >= 1.3
4750 , simple-sendfile >= 0.2.7 && < 0.3
48− , unix-compat >= 0.2
49− , wai >= 3.0.4 && < 3.1
50− , text
51+ , stm >= 2.3
5152 , streaming-commons >= 0.1.10
53+ , text
54+ , time-manager
55+ , unix-compat >= 0.2
5256 , vault >= 0.3
53− , stm >= 2.3
57+ , wai >= 3.2 && < 3.3
5458 , word8
55− , hashable
56− , unordered-containers
59+ , x509
60+ if impl(ghc < 8)
61+ Build-Depends: semigroups
5762 if flag(network-bytestring)
5863 Build-Depends: network >= 2.2.1.5 && < 2.2.3
5964 , network-bytestring >= 0.1.3 && < 0.1.4
@@ -68,18 +73,17 @@ Library
6873 Network.Wai.Handler.Warp.FdCache
6974 Network.Wai.Handler.Warp.File
7075 Network.Wai.Handler.Warp.FileInfoCache
76+ Network.Wai.Handler.Warp.HashMap
7177 Network.Wai.Handler.Warp.HTTP2
72− Network.Wai.Handler.Warp.HTTP2.EncodeFrame
73− Network.Wai.Handler.Warp.HTTP2.HPACK
74− Network.Wai.Handler.Warp.HTTP2.Manager
75− Network.Wai.Handler.Warp.HTTP2.Receiver
78+ Network.Wai.Handler.Warp.HTTP2.File
79+ Network.Wai.Handler.Warp.HTTP2.PushPromise
7680 Network.Wai.Handler.Warp.HTTP2.Request
77− Network.Wai.Handler.Warp.HTTP2.Sender
81+ Network.Wai.Handler.Warp.HTTP2.Response
7882 Network.Wai.Handler.Warp.HTTP2.Types
79− Network.Wai.Handler.Warp.HTTP2.Worker
8083 Network.Wai.Handler.Warp.Header
8184 Network.Wai.Handler.Warp.IO
82− Network.Wai.Handler.Warp.IORef
85+ Network.Wai.Handler.Warp.Imports
86+ Network.Wai.Handler.Warp.PackInt
8387 Network.Wai.Handler.Warp.ReadInt
8488 Network.Wai.Handler.Warp.Recv
8589 Network.Wai.Handler.Warp.Request
@@ -89,9 +93,9 @@ Library
8993 Network.Wai.Handler.Warp.Run
9094 Network.Wai.Handler.Warp.SendFile
9195 Network.Wai.Handler.Warp.Settings
92− Network.Wai.Handler.Warp.Timeout
9396 Network.Wai.Handler.Warp.Types
9497 Network.Wai.Handler.Warp.Windows
98+ Network.Wai.Handler.Warp.WithApplication
9599 Paths_warp
96100 Ghc-Options: -Wall
97101
@@ -104,16 +108,24 @@ Library
104108 Build-Depends: time
105109 else
106110 Build-Depends: unix
107− , http-date
108111 Other-modules: Network.Wai.Handler.Warp.MultiMap
112+ if impl(ghc >= 8)
113+ Default-Extensions: Strict StrictData
114+ Default-Language: Haskell2010
109115
110116Test-Suite doctest
117+ buildable: False
111118 Type: exitcode-stdio-1.0
112119 HS-Source-Dirs: test
113120 Ghc-Options: -threaded -Wall
114121 Main-Is: doctests.hs
115− Build-Depends: base
122+ Build-Depends: base >= 4.8 && < 5
116123 , doctest >= 0.10.1
124+ if os(windows)
125+ Buildable: False
126+ if impl(ghc >= 8)
127+ Default-Extensions: Strict StrictData
128+ Default-Language: Haskell2010
117129
118130Test-Suite spec
119131 Main-Is: Spec.hs
@@ -121,69 +133,137 @@ Test-Suite spec
121133 ConduitSpec
122134 ExceptionSpec
123135 FdCacheSpec
124− MultiMapSpec
136+ FileSpec
125137 ReadIntSpec
126138 RequestSpec
127139 ResponseHeaderSpec
128140 ResponseSpec
129141 RunSpec
130142 SendFileSpec
143+ WithApplicationSpec
131144 HTTP
145+ Network.Wai.Handler.Warp
146+ Network.Wai.Handler.Warp.Buffer
147+ Network.Wai.Handler.Warp.Conduit
148+ Network.Wai.Handler.Warp.Counter
149+ Network.Wai.Handler.Warp.Date
150+ Network.Wai.Handler.Warp.FdCache
151+ Network.Wai.Handler.Warp.File
152+ Network.Wai.Handler.Warp.FileInfoCache
153+ Network.Wai.Handler.Warp.HTTP2
154+ Network.Wai.Handler.Warp.HTTP2.File
155+ Network.Wai.Handler.Warp.HTTP2.PushPromise
156+ Network.Wai.Handler.Warp.HTTP2.Request
157+ Network.Wai.Handler.Warp.HTTP2.Response
158+ Network.Wai.Handler.Warp.HTTP2.Types
159+ Network.Wai.Handler.Warp.HashMap
160+ Network.Wai.Handler.Warp.Header
161+ Network.Wai.Handler.Warp.IO
162+ Network.Wai.Handler.Warp.Imports
163+ Network.Wai.Handler.Warp.MultiMap
164+ Network.Wai.Handler.Warp.PackInt
165+ Network.Wai.Handler.Warp.ReadInt
166+ Network.Wai.Handler.Warp.Recv
167+ Network.Wai.Handler.Warp.Request
168+ Network.Wai.Handler.Warp.RequestHeader
169+ Network.Wai.Handler.Warp.Response
170+ Network.Wai.Handler.Warp.ResponseHeader
171+ Network.Wai.Handler.Warp.Run
172+ Network.Wai.Handler.Warp.SendFile
173+ Network.Wai.Handler.Warp.Settings
174+ Network.Wai.Handler.Warp.Types
175+ Network.Wai.Handler.Warp.Windows
176+ Network.Wai.Handler.Warp.WithApplication
177+ Paths_warp
178+
132179 Hs-Source-Dirs: test, .
133180 Type: exitcode-stdio-1.0
134181
135− Ghc-Options: -Wall
136− Build-Depends: base >= 4 && < 5
182+ Ghc-Options: -Wall -threaded
183+ Build-Depends: base >= 4.8 && < 5
184+ , HUnit
185+ , QuickCheck
137186 , array
187+ , async
138188 , auto-update
139− , blaze-builder >= 0.4
189+ , bsb-http-chunked < 0.1
140190 , bytestring >= 0.9.1.4
141− , bytestring-builder
142191 , case-insensitive >= 0.2
192+ , containers
193+ , directory
143194 , ghc-prim
144− , HTTP
145− , http-types >= 0.8.5
195+ , hashable
196+ , hspec >= 1.3
197+ , http-client
198+ , http-date
199+ , http-types >= 0.12
200+ , http2 >= 2.0 && < 2.1
146201 , iproute >= 1.3.1
147202 , lifted-base >= 0.1
148− , simple-sendfile >= 0.2.4 && < 0.3
149− , transformers >= 0.2.2
150− , unix-compat >= 0.2
151− , wai >= 3.0.4 && < 3.1
152203 , network
153− , HUnit
154− , QuickCheck
155− , hspec >= 1.3
156− , time
157− , text
204+ , process
205+ , simple-sendfile >= 0.2.4 && < 0.3
206+ , stm >= 2.3
158207 , streaming-commons >= 0.1.10
159− , async
208+ , text
209+ , time
210+ , time-manager
211+ , unix-compat >= 0.2
160212 , vault
161− , stm >= 2.3
162− , directory
163− , process
164− , containers
165− , http2 >= 1.3
213+ , wai >= 3.2 && < 3.3
166214 , word8
167− , hashable
168− , unordered-containers
215+ , x509
216+ -- Build-Tool-Depends: hspec-discover:hspec-discover
217+ if impl(ghc < 8)
218+ Build-Depends: semigroups
219+ , transformers
169220
170221 if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
171222 Cpp-Options: -DSENDFILEFD
172223 Build-Depends: unix
173− , http-date
174224 if os(windows)
175− Cpp-Options: -DWINDOWS
225+ Cpp-Options: -DWINDOWS
226+ Build-Depends: time
227+ if impl(ghc >= 8)
228+ Default-Extensions: Strict StrictData
229+ Default-Language: Haskell2010
176230
177231Benchmark parser
178232 Type: exitcode-stdio-1.0
179233 Main-Is: Parser.hs
234+ other-modules: Network.Wai.Handler.Warp.Date
235+ Network.Wai.Handler.Warp.FdCache
236+ Network.Wai.Handler.Warp.FileInfoCache
237+ Network.Wai.Handler.Warp.HashMap
238+ Network.Wai.Handler.Warp.Imports
239+ Network.Wai.Handler.Warp.MultiMap
240+ Network.Wai.Handler.Warp.Types
180241 HS-Source-Dirs: bench .
181− Build-Depends: base
242+ Build-Depends: base >= 4.8 && < 5
243+ , auto-update
182244 , bytestring
183− , criterion
245+ , containers
246+ , gauge
247+ , hashable
248+ , http-date
184249 , http-types
185250 , network
186251 , network
252+ , time-manager
253+ , unix-compat
254+ , x509
255+ if impl(ghc < 8)
256+ Build-Depends: semigroups
257+
258+ if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
259+ Cpp-Options: -DSENDFILEFD
260+ Build-Depends: unix
261+ if os(windows)
262+ Cpp-Options: -DWINDOWS
263+ Build-Depends: time
264+ if impl(ghc >= 8)
265+ Default-Extensions: Strict StrictData
266+ Default-Language: Haskell2010
187267
188268Source-Repository head
189269 Type: git