on master help sign in
214 files changed+9742−3382
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+3 .travis.yml−10 CONTRIBUTING.md+94 LICENSE+1−1 README.md+2 auto-update/ChangeLog.md+34 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/README.md+11−3 auto-update/auto-update.cabal+15−14 auto-update/changelog.md−1 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+15 mime-types/Network/Mime.hs+8 mime-types/README.md+3 mime-types/mime-types.cabal+3−2 sources.txt−13 stack-lts-11.yaml+27 stack-lts-12.yaml+26 stack-nightly.yaml+20 stack.yaml+25 wai-eventsource/LICENSE → time-manager/LICENSE warp/Network/Wai/Handler/Warp/Timeout.hs → time-manager/System/TimeManager.hs+45−75 time-manager/time-manager.cabal+19 wai-app-static/.ghci+1−1 wai-app-static/ChangeLog.md+69 wai-app-static/Network/Wai/Application/Static.hs+90−58 wai-app-static/Util.hs+8−1 wai-app-static/WaiAppStatic/CmdLine.hs+15−8 wai-app-static/WaiAppStatic/Listing.hs+35−13 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+29−26 wai-app-static/WaiAppStatic/Types.hs+12−3 wai-app-static/test/EmbeddedTestEntries.hs+10 wai-app-static/test/WaiAppEmbeddedTest.hs+21−5 wai-app-static/test/WaiAppStaticTest.hs+65−6 wai-app-static/wai-app-static.cabal+12−15 wai-conduit/ChangeLog.md+7 wai-conduit/Network/Wai/Conduit.hs+6−7 wai-conduit/README.md+4 wai-conduit/example/Main.hs+19 wai-conduit/wai-conduit.cabal+5−6 wai-eventsource/Setup.lhs−7 wai-eventsource/wai-eventsource.cabal−16 wai-extra/ChangeLog.md+206 wai-extra/Network/Wai/EventSource.hs+27−6 wai-extra/Network/Wai/EventSource/EventStream.hs+12−11 wai-extra/Network/Wai/Handler/CGI.hs+31−27 wai-extra/Network/Wai/Handler/SCGI.hs+12−1 wai-extra/Network/Wai/Header.hs+18 wai-extra/Network/Wai/Middleware/AcceptOverride.hs−2 wai-extra/Network/Wai/Middleware/AddHeaders.hs+4−10 wai-extra/Network/Wai/Middleware/Approot.hs+121 wai-extra/Network/Wai/Middleware/Autohead.hs+3−1 wai-extra/Network/Wai/Middleware/CleanPath.hs+5−3 wai-extra/Network/Wai/Middleware/ForceDomain.hs+38 wai-extra/Network/Wai/Middleware/ForceSSL.hs+37 wai-extra/Network/Wai/Middleware/Gzip.hs+67−31 wai-extra/Network/Wai/Middleware/HttpAuth.hs+65−30 wai-extra/Network/Wai/Middleware/Jsonp.hs+16−16 wai-extra/Network/Wai/Middleware/Local.hs+1−1 wai-extra/Network/Wai/Middleware/MethodOverride.hs+4−6 wai-extra/Network/Wai/Middleware/MethodOverridePost.hs+6−3 wai-extra/Network/Wai/Middleware/RequestLogger.hs+162−75 wai-extra/Network/Wai/Middleware/RequestLogger/Internal.hs+6−2 wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hs+137 wai-extra/Network/Wai/Middleware/Rewrite.hs+321−15 wai-extra/Network/Wai/Middleware/Routed.hs+39 wai-extra/Network/Wai/Middleware/StreamFile.hs+8−4 wai-extra/Network/Wai/Middleware/StripHeaders.hs+45 wai-extra/Network/Wai/Middleware/Timeout.hs+33 wai-extra/Network/Wai/Middleware/Vhost.hs+5−3 wai-extra/Network/Wai/Parse.hs+369−87 wai-extra/Network/Wai/Request.hs+101 wai-extra/Network/Wai/Test.hs+147−28 wai-extra/Network/Wai/Test/Internal.hs+35 wai-extra/Network/Wai/UrlMap.hs+2−2 wai-extra/README−1 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/ApprootSpec.hs+37 wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hs+60 wai-extra/test/Network/Wai/Middleware/RoutedSpec.hs+53 wai-extra/test/Network/Wai/Middleware/StripHeadersSpec.hs+58 wai-extra/test/Network/Wai/Middleware/TimeoutSpec.hs+57 wai-extra/test/Network/Wai/ParseSpec.hs+94 wai-extra/test/Network/Wai/RequestSpec.hs+93 wai-extra/test/Network/Wai/TestSpec.hs+191 wai-extra/test/WaiExtraSpec.hs+7−4 wai-extra/wai-extra.cabal+126−15 wai-frontend-monadcgi/ChangeLog.md+7 wai-frontend-monadcgi/Network/Wai/Frontend/MonadCGI.hs+4−1 wai-frontend-monadcgi/README−1 wai-frontend-monadcgi/README.md+5 wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+4−3 wai-handler-fastcgi/.gitignore−4 wai-handler-fastcgi/LICENSE−20 wai-handler-fastcgi/Network/Wai/Handler/FastCGI.hsc−192 wai-handler-fastcgi/README 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/LICENSE−20 wai-handler-launch/Network/Wai/Handler/Launch.hs−206 wai-handler-launch/README 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−35 wai-handler-launch/windows.c−12 wai-handler-webkit/.gitignore−2 wai-handler-webkit/LICENSE−20 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−31 wai-handler-webkit/webkit.cpp−19 wai-test/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-test/.ghci−1 wai-test/Setup.lhs−8 wai-test/wai-test.cabal−16 wai-websockets/ChangeLog.md+27 wai-websockets/Network/Wai/Handler/WebSockets.hs+56−19 wai-websockets/README.md+3 wai-websockets/server.lhs+55−39 wai-websockets/wai-websockets.cabal+6−6 wai/ChangeLog.md+56 wai/Network/Wai.hs+75−37 wai/Network/Wai/Internal.hs+32−7 wai/README.md+1−1 wai/test/Network/WaiSpec.hs+7−9 wai/wai.cabal+9−7 wai/webkit-sample/webkit-sample.hs+2−2 warp-tls/ChangeLog.md+117−1 warp-tls/Network/Wai/Handler/WarpTLS.hs+364−129 warp-tls/README.md+4 warp-tls/warp-tls.cabal+21−10 warp/.ghci+1−1 warp/ChangeLog.md+356 warp/Network/Wai/Handler/Warp.hs+324−58 warp/Network/Wai/Handler/Warp/Buffer.hs+96−12 warp/Network/Wai/Handler/Warp/Conduit.hs+6−15 warp/Network/Wai/Handler/Warp/Counter.hs+15−9 warp/Network/Wai/Handler/Warp/Date.hs+17−22 warp/Network/Wai/Handler/Warp/FdCache.hs+78−88 warp/Network/Wai/Handler/Warp/File.hs+152 warp/Network/Wai/Handler/Warp/FileInfoCache.hs+108 warp/Network/Wai/Handler/Warp/HTTP2.hs+85 warp/Network/Wai/Handler/Warp/HTTP2/File.hs+30 warp/Network/Wai/Handler/Warp/HTTP2/PushPromise.hs+36 warp/Network/Wai/Handler/Warp/HTTP2/Request.hs+126 warp/Network/Wai/Handler/Warp/HTTP2/Response.hs+127 warp/Network/Wai/Handler/Warp/HTTP2/Types.hs+81 warp/Network/Wai/Handler/Warp/HashMap.hs+42 warp/Network/Wai/Handler/Warp/Header.hs+48−26 warp/Network/Wai/Handler/Warp/IO.hs+16−21 warp/Network/Wai/Handler/Warp/IORef.hs−26 warp/Network/Wai/Handler/Warp/Imports.hs+27 warp/Network/Wai/Handler/Warp/Internal.hs+82−17 warp/Network/Wai/Handler/Warp/MultiMap.hs+66−191 warp/Network/Wai/Handler/Warp/PackInt.hs+56 warp/Network/Wai/Handler/Warp/ReadInt.hs+2−2 warp/Network/Wai/Handler/Warp/Recv.hs+121−31 warp/Network/Wai/Handler/Warp/Request.hs+100−46 warp/Network/Wai/Handler/Warp/RequestHeader.hs+16−43 warp/Network/Wai/Handler/Warp/Response.hs+219−205 warp/Network/Wai/Handler/Warp/ResponseHeader.hs+5−15 warp/Network/Wai/Handler/Warp/Run.hs+356−152 warp/Network/Wai/Handler/Warp/SendFile.hs+139−19 warp/Network/Wai/Handler/Warp/Settings.hs+124−37 warp/Network/Wai/Handler/Warp/Types.hs+106−38 warp/Network/Wai/Handler/Warp/Windows.hs+5−1 warp/Network/Wai/Handler/Warp/WithApplication.hs+104 warp/README.md+3−2 warp/attic/server-no-keepalive.hs+1−1 warp/bench/Parser.hs+21−16 warp/test/BufferPoolSpec.hs+47 warp/test/ExceptionSpec.hs+18−31 warp/test/FdCacheSpec.hs+3−3 warp/test/FileSpec.hs+45 warp/test/HTTP.hs+41 warp/test/MultiMapSpec.hs−30 warp/test/RequestSpec.hs+12−8 warp/test/ResponseHeaderSpec.hs+25−5 warp/test/ResponseSpec.hs+51−68 warp/test/RunSpec.hs+169−95 warp/test/SendFileSpec.hs+116 warp/test/WithApplicationSpec.hs+45 warp/test/doctests.hs+1−8 warp/test/head-response+1 warp/test/inputFile+100 warp/warp.cabal+158−45
.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+3
@@ -7,3 +7,6 @@ tarballs/
77/.shelly
88.cabal-sandbox/
99cabal.sandbox.config
10+.stack-work/
11+*~
12+stack*.yaml.lock
.travis.ymldeleted−10
@@ -1,10 +0,0 @@
1−language: haskell
2−
3−install:
4− - sudo apt-get install libfcgi-dev
5− - cabal unpack wai-logger
6− - mv wai-logger-* wai-logger
7− - cabal install hspec doctest HTTP cabal-meta cabal-src
8− - cabal-meta install --force-reinstalls
9−
10−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+2
@@ -9,3 +9,5 @@ Code can be written that works with any web framework targeting WAI.
99[Documentation](http://www.yesodweb.com/book/web-application-interface)
1010
1111[Haddock Documentation](http://hackage.haskell.org/package/wai)
12+
13+[![Build Status](https://dev.azure.com/yesodweb/wai/_apis/build/status/yesodweb.wai?branchName=master)](https://dev.azure.com/yesodweb/wai/_build/latest?definitionId=1&branchName=master)
auto-update/ChangeLog.mdnew file+34
@@ -0,0 +1,34 @@
1+# ChangeLog for auto-update
2+
3+## 0.1.6
4+
5+* Add control of activation on leading vs. trailing edges for Control.Debounce
6+ [#756](https://github.com/yesodweb/wai/pull/756)
7+
8+## 0.1.5
9+
10+* Using the Strict and StrictData language extensions for GHC >8.
11+ [#752](https://github.com/yesodweb/wai/pull/752)
12+
13+## 0.1.4.1
14+
15+* [#693](https://github.com/yesodweb/wai/pull/693):
16+ Improve documentation for `reaperAction` function.
17+* [#732](https://github.com/yesodweb/wai/pull/732):
18+ Fixed memory leak in `reaperAdd` function.
19+
20+## 0.1.4
21+
22+* Provide updateActionModify API in AutoUpdate [#547](https://github.com/yesodweb/wai/pull/547)
23+
24+## 0.1.3.1
25+
26+* Doc improvements
27+
28+## 0.1.3
29+
30+* Adding a new AIP - reaperKill
31+
32+## 0.1.2
33+
34+* Added Control.Debounce
auto-update/Control/AutoUpdate.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/README.md+11−3
@@ -1,5 +1,13 @@
1−See https://github.com/yesodweb/yesod-scaffold/pull/15
1+## auto-update
22
3−Todo:
3+A common problem is the desire to have an action run at a scheduled interval,
4+but only if it is needed. For example, instead of having every web request
5+result in a new `getCurrentTime` call, we'd like to have a single worker thread
6+run every second, updating an `IORef`. However, if the request frequency is
7+less than once per second, this is a pessimization, and worse, kills idle GC.
48
5−- Add ThreadId to prevent race condition.
9+This library allows you to define actions which will either be performed by a
10+dedicated thread or, in times of low volume, will be executed by the calling
11+thread.
12+
13+For original use case, see [yesod-scaffold issue #15](https://github.com/yesodweb/yesod-scaffold/pull/15).
auto-update/auto-update.cabal+15−14
@@ -1,10 +1,7 @@
11name: auto-update
2−version: 0.1.2
2+version: 0.1.6
33synopsis: Efficiently run periodic, on-demand actions
4−description:
5− A common problem is the desire to have an action run at a scheduled interval, but only if it is needed. For example, instead of having every web request result in a new @getCurrentTime@ call, we'd like to have a single worker thread run every second, updating an @IORef@. However, if the request frequency is less than once per second, this is a pessimization, and worse, kills idle GC.
6− .
7− This library allows you to define actions which will either be performed by a dedicated thread or, in times of low volume, will be executed by the calling thread.
4+description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
85homepage: https://github.com/yesodweb/wai
96license: MIT
107license-file: LICENSE
@@ -13,25 +10,29 @@ maintainer: michael@snoyman.com
1310category: Control
1411build-type: Simple
1512extra-source-files: README.md
16− changelog.md
13+ ChangeLog.md
1714cabal-version: >=1.10
1815
1916library
2017 ghc-options: -Wall
2118 exposed-modules: Control.AutoUpdate
2219 Control.Debounce
20+ Control.Debounce.Internal
2321 Control.Reaper
2422 other-modules: Control.AutoUpdate.Util
2523 build-depends: base >= 4 && < 5
2624 default-language: Haskell2010
25+ if impl(ghc >= 8)
26+ default-extensions: Strict StrictData
2727
2828-- Test suite is currently not robust enough, gives too many false negatives.
2929
30−-- test-suite spec
31−-- main-is: Spec.hs
32−-- other-modules: Control.AutoUpdateSpec
33−-- Control.ReaperSpec
34−-- hs-source-dirs: test
35−-- type: exitcode-stdio-1.0
36−-- build-depends: base, auto-update, hspec
37−-- 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/changelog.mddeleted−1
@@ -1 +0,0 @@
1−__0.1.2__ Added Control.Debounce
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.mdnew file+15
@@ -0,0 +1,15 @@
1+## 0.1.0.9
2+
3+* Add mjs mime type
4+
5+## 0.1.0.8
6+
7+* Add wasm mime type
8+
9+## 0.1.0.7
10+
11+* Add support for .less files [#534](https://github.com/yesodweb/wai/pull/534)
12+
13+## 0.1.0.6
14+
15+* Add woff2 mime type [#350](https://github.com/yesodweb/wai/pull/350)
mime-types/Network/Mime.hs+8
@@ -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")
@@ -1000,6 +1007,7 @@ defaultMimeMap = Map.fromAscList [
10001007 , ("wmx", "video/x-ms-wmx")
10011008 , ("wmz", "application/x-msmetafile")
10021009 , ("woff", "application/font-woff")
1010+ , ("woff2", "application/font-woff2")
10031011 , ("wpd", "application/vnd.wordperfect")
10041012 , ("wpl", "application/vnd.ms-wpl")
10051013 , ("wps", "application/vnd.ms-works")
mime-types/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## mime-types
2+
3+Basic mime-type handling types and functions
mime-types/mime-types.cabal+3−2
@@ -1,7 +1,7 @@
11name: mime-types
2−version: 0.1.0.4
2+version: 0.1.0.9
33synopsis: Basic mime-type handling types and functions
4−description: Basic mime-type handling types and functions
4+description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
55homepage: https://github.com/yesodweb/wai
66license: MIT
77license-file: LICENSE
@@ -10,6 +10,7 @@ maintainer: michael@snoyman.com
1010category: Web
1111build-type: Simple
1212cabal-version: >=1.8
13+extra-source-files: README.md ChangeLog.md
1314
1415library
1516 exposed-modules: Network.Mime
sources.txtdeleted−13
@@ -1,13 +0,0 @@
1−./wai
2−./wai-test
3−./wai-extra
4−./warp
5−./warp-tls
6−./wai-app-static
7−./wai-handler-fastcgi
8−./wai-handler-launch
9−./wai-websockets
10−./wai-eventsource
11−./wai-conduit
12−./mime-types
13−./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.yamlnew file+25
@@ -0,0 +1,25 @@
1+resolver: lts-14.22
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
21+extra-deps:
22+- http2-2.0.0
23+- network-byte-order-0.1.1.0
24+- tls-1.5.3
25+- tls-session-manager-0.0.4
wai-eventsource/LICENSE → time-manager/LICENSErenamed

The content is the same.

warp/Network/Wai/Handler/Warp/Timeout.hs → time-manager/System/TimeManager.hsrenamed+45−75
@@ -1,66 +1,33 @@
1−{-# LANGUAGE CPP #-}
21{-# LANGUAGE DeriveDataTypeable #-}
3−{-# LANGUAGE MagicHash #-}
4−{-# LANGUAGE UnboxedTuples #-} -- for GHC 7.4 or earlier
5−
6−-- |
7−--
8−-- In order to provide slowloris protection, Warp provides timeout handlers. We
9−-- follow these rules:
10−--
11−-- * A timeout is created when a connection is opened.
12−--
13−-- * When all request headers are read, the timeout is tickled.
14−--
15−-- * Every time at least 2048 bytes of the request body are read, the timeout
16−-- is tickled.
17−--
18−-- * The timeout is paused while executing user code. This will apply to both
19−-- the application itself, and a ResponseSource response. The timeout is
20−-- resumed as soon as we return from user code.
21−--
22−-- * Every time data is successfully sent to the client, the timeout is tickled.
23−
24−module Network.Wai.Handler.Warp.Timeout (
25− -- * Types
2+
3+module System.TimeManager (
4+ -- ** Types
265 Manager
276 , TimeoutAction
287 , Handle
29− -- * Manager
8+ -- ** Manager
309 , initialize
3110 , stopManager
11+ , killManager
3212 , withManager
33− -- * Registration
13+ -- ** Registration
3414 , register
3515 , registerKillThread
36− -- * Control
16+ -- ** Control
3717 , tickle
3818 , cancel
3919 , pause
4020 , resume
41− -- * Exceptions
21+ -- ** Exceptions
4222 , TimeoutThread (..)
4323 ) where
4424
45−#ifndef MIN_VERSION_base
46−#define MIN_VERSION_base(x,y,z) 1
47−#endif
48−
49−#if MIN_VERSION_base(4,6,0)
50−import Control.Concurrent (mkWeakThreadId, ThreadId)
51−#else
52−import GHC.Conc (ThreadId(..))
53−import GHC.Exts (mkWeak#)
54−import GHC.IO (IO (IO))
55−#endif
5625import Control.Concurrent (myThreadId)
5726import qualified Control.Exception as E
58−import GHC.Weak (Weak (..))
59−import Network.Wai.Handler.Warp.IORef (IORef)
60−import qualified Network.Wai.Handler.Warp.IORef as I
61−import System.Mem.Weak (deRefWeak)
62−import Data.Typeable (Typeable)
6327import Control.Reaper
28+import Data.Typeable (Typeable)
29+import Data.IORef (IORef)
30+import qualified Data.IORef as I
6431
6532----------------------------------------------------------------
6633
@@ -71,7 +38,7 @@ type Manager = Reaper [Handle] Handle
7138type TimeoutAction = IO ()
7239
7340-- | A handle used by 'Manager'
74−data Handle = Handle TimeoutAction (IORef State)
41+data Handle = Handle !(IORef TimeoutAction) !(IORef State)
7542
7643data State = Active -- Manager turns it to Inactive.
7744 | Inactive -- Manager removes it with timeout action.
@@ -88,10 +55,11 @@ initialize timeout = mkReaper defaultReaperSettings
8855 , reaperDelay = timeout
8956 }
9057 where
91− prune m@(Handle onTimeout iactive) = do
92− state <- I.atomicModifyIORef' iactive (\x -> (inactivate x, x))
58+ prune m@(Handle actionRef stateRef) = do
59+ state <- I.atomicModifyIORef' stateRef (\x -> (inactivate x, x))
9360 case state of
9461 Inactive -> do
62+ onTimeout <- I.readIORef actionRef
9563 onTimeout `E.catch` ignoreAll
9664 return Nothing
9765 Canceled -> return Nothing
@@ -102,68 +70,70 @@ initialize timeout = mkReaper defaultReaperSettings
10270
10371----------------------------------------------------------------
10472
105−-- | Stopping timeout manager.
73+-- | Stopping timeout manager with onTimeout fired.
10674stopManager :: Manager -> IO ()
10775stopManager mgr = E.mask_ (reaperStop mgr >>= mapM_ fire)
10876 where
109− fire (Handle onTimeout _) = onTimeout `E.catch` ignoreAll
77+ fire (Handle actionRef _) = do
78+ onTimeout <- I.readIORef actionRef
79+ onTimeout `E.catch` ignoreAll
11080
11181ignoreAll :: E.SomeException -> IO ()
11282ignoreAll _ = return ()
11383
84+-- | Killing timeout manager immediately without firing onTimeout.
85+killManager :: Manager -> IO ()
86+killManager = reaperKill
87+
11488----------------------------------------------------------------
11589
11690-- | Registering a timeout action.
11791register :: Manager -> TimeoutAction -> IO Handle
11892register mgr onTimeout = do
119− iactive <- I.newIORef Active
120− let h = Handle onTimeout iactive
93+ actionRef <- I.newIORef onTimeout
94+ stateRef <- I.newIORef Active
95+ let h = Handle actionRef stateRef
12196 reaperAdd mgr h
12297 return h
12398
12499-- | Registering a timeout action of killing this thread.
125−registerKillThread :: Manager -> IO Handle
126−registerKillThread m = do
127− wtid <- myThreadId >>= mkWeakThreadId
128− register m $ killIfExist wtid
129−
130−-- If ThreadId is hold referred by a strong reference,
131−-- it leaks even after the thread is killed.
132−-- So, let's use a weak reference so that CG can throw ThreadId away.
133−-- deRefWeak checks if ThreadId referenced by the weak reference
134−-- exists. If exists, it means that the thread is alive.
135−killIfExist :: Weak ThreadId -> TimeoutAction
136−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
137110
138111data TimeoutThread = TimeoutThread
139112 deriving Typeable
140−instance E.Exception TimeoutThread
113+instance E.Exception TimeoutThread where
114+ toException = E.asyncExceptionToException
115+ fromException = E.asyncExceptionFromException
141116instance Show TimeoutThread where
142− show TimeoutThread = "Thread killed by Warp's timeout reaper"
143−
144−#if !MIN_VERSION_base(4,6,0)
145−mkWeakThreadId :: ThreadId -> IO (Weak ThreadId)
146−mkWeakThreadId t@(ThreadId t#) = IO $ \s ->
147− case mkWeak# t# t Nothing s of
148− (# s1, w #) -> (# s1, Weak w #)
149−#endif
117+ show TimeoutThread = "Thread killed by timeout manager"
150118
151119----------------------------------------------------------------
152120
153121-- | Setting the state to active.
154122-- 'Manager' turns active to inactive repeatedly.
155123tickle :: Handle -> IO ()
156−tickle (Handle _ iactive) = I.writeIORef iactive Active
124+tickle (Handle _ stateRef) = I.writeIORef stateRef Active
157125
158126-- | Setting the state to canceled.
159127-- 'Manager' eventually removes this without timeout action.
160128cancel :: Handle -> IO ()
161−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
162132
163133-- | Setting the state to paused.
164134-- 'Manager' does not change the value.
165135pause :: Handle -> IO ()
166−pause (Handle _ iactive) = I.writeIORef iactive Paused
136+pause (Handle _ stateRef) = I.writeIORef stateRef Paused
167137
168138-- | Setting the paused state to active.
169139-- 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/.ghci+1−1
@@ -1 +1 @@
1−:set -itest
1+:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h -XCPP
wai-app-static/ChangeLog.md+69
@@ -1,3 +1,72 @@
1+# wai-app-static changelog
2+
3+## 3.1.7.1
4+
5+* Update the test suite too
6+
7+## 3.1.7
8+
9+* Use 302 instead of 301 redirect, to avoid caching the presence of an index.html file
10+
11+## 3.1.6.3
12+
13+* The executable warp obeys `-h` option properly for host
14+now. Previously this used to invoke the help option. That can be
15+reached via `--help` as before.
16+
17+## 3.1.6.2
18+
19+* Drop dependency on blaze-builder
20+
21+## 3.1.6.1
22+
23+* Add `<>` import
24+
25+## 3.1.6
26+
27+* Make ssAddTrailingSlash work in combination with ssIndices [#569](https://github.com/yesodweb/wai/pull/569)
28+* Make ssIndices work with ssLookupFile and trailing slashes [#570](https://github.com/yesodweb/wai/pull/570)
29+
30+## 3.1.5
31+
32+* Switch to cryponite
33+
34+## 3.1.4.1
35+
36+* Support wai/warp 3.2
37+
38+## 3.1.4
39+
40+* Reinstate redirectToIndex
41+
42+## 3.1.3
43+
44+* Add 404 handler [#467](https://github.com/yesodweb/wai/pull/467)
45+
46+## 3.1.2
47+
48+* Honor ssIndices when used with defaultWebAppSettings [#460](https://github.com/yesodweb/wai/pull/460)
49+
50+## 3.1.1
51+
52+* Make adding a trailing slash optional [#327](https://github.com/yesodweb/wai/issues/327) [yesod#988](https://github.com/yesodweb/yesod/issues/988)
53+
54+## 3.1.0
55+
56+* Drop system-filepath
57+
58+## 3.0.1.1
59+
60+* Fix root links
61+
62+## 3.0.1
63+
64+* Better HEAD support [#354](https://github.com/yesodweb/wai/issues/354)
65+
66+## 3.0.0.6
67+
68+Fix trailing slashes for `UrlMap` and other non-root setups [#325](https://github.com/yesodweb/wai/issues/325)
69+
170## 3.0.0.4
271
372Add missing trailing slashes [#312](https://github.com/yesodweb/wai/issues/312)
wai-app-static/Network/Wai/Application/Static.hs+90−58
@@ -21,6 +21,8 @@ module Network.Wai.Application.Static
2121 , ssIndices
2222 , ssMaxAge
2323 , ssRedirectToIndex
24+ , ssAddTrailingSlash
25+ , ss404Handler
2426 ) where
2527
2628import Prelude hiding (FilePath)
@@ -32,16 +34,15 @@ import qualified Data.ByteString.Lazy as L
3234import Data.ByteString.Lazy.Char8 ()
3335import Control.Monad.IO.Class (liftIO)
3436
35−import Blaze.ByteString.Builder (toByteString)
37+import Data.ByteString.Builder (toLazyByteString)
3638
3739import Data.FileEmbed (embedFile)
3840
3941import Data.Text (Text)
4042import qualified Data.Text as T
43+import qualified Data.Text.Encoding as TE
4144
42−import Data.Either (rights)
4345import Network.HTTP.Date (parseHTTPDate, epochTimeToHTTPDate, formatHTTPDate)
44−import Data.Monoid (First (First, getFirst), mconcat)
4546
4647import WaiAppStatic.Types
4748import Util
@@ -52,6 +53,7 @@ import Network.Mime (MimeType)
5253data StaticResponse =
5354 -- | Just the etag hash or Nothing for no etag hash
5455 Redirect Pieces (Maybe ByteString)
56+ | RawRedirect ByteString
5557 | NotFound
5658 | FileResponse File H.ResponseHeaders
5759 | NotModified
@@ -72,47 +74,27 @@ filterButLast f (x:xs)
7274
7375-- | Serve an appropriate response for a folder request.
7476serveFolder :: StaticSettings -> Pieces -> W.Request -> Folder -> IO StaticResponse
75−serveFolder ss@StaticSettings {..} pieces req folder@Folder {..} =
76− -- first check if there is an index file in this folder
77− case getFirst $ mconcat $ map (findIndex $ rights folderContents) ssIndices of
78− Just index ->
79− let pieces' = setLast pieces index in
80− case () of
81− () | ssRedirectToIndex -> return $ Redirect pieces' Nothing
82− | noTrailingSlash pieces, Just trailing <- toPiece "" ->
83− return $ Redirect (pieces ++ [trailing]) Nothing
84− | otherwise ->
85− -- start the checking process over, with a new set
86− checkPieces ss pieces' req
87− Nothing ->
88− case ssListing of
89− Just _ | noTrailingSlash pieces, Just trailing <- toPiece "" ->
90− return $ Redirect (pieces ++ [trailing]) Nothing
91− Just listing -> do
92− -- directory listings turned on, display it
93− builder <- listing pieces folder
94− return $ WaiResponse $ W.responseBuilder H.status200
95− [ ("Content-Type", "text/html; charset=utf-8")
96− ] builder
97− Nothing -> return $ WaiResponse $ W.responseLBS H.status403
98− [ ("Content-Type", "text/plain")
99− ] "Directory listings disabled"
100− where
101− setLast :: Pieces -> Piece -> Pieces
102− setLast [] x = [x]
103− setLast [t] x
104− | fromPiece t == "" = [x]
105− setLast (a:b) x = a : setLast b x
106−
107− noTrailingSlash :: Pieces -> Bool
108− noTrailingSlash [] = False
109− noTrailingSlash [x] = fromPiece x /= ""
110− noTrailingSlash (_:xs) = noTrailingSlash xs
77+serveFolder StaticSettings {..} pieces req folder@Folder {..} =
78+ case ssListing of
79+ Just _ | Just path <- addTrailingSlash req, ssAddTrailingSlash ->
80+ return $ RawRedirect path
81+ Just listing -> do
82+ -- directory listings turned on, display it
83+ builder <- listing pieces folder
84+ return $ WaiResponse $ W.responseBuilder H.status200
85+ [ ("Content-Type", "text/html; charset=utf-8")
86+ ] builder
87+ Nothing -> return $ WaiResponse $ W.responseLBS H.status403
88+ [ ("Content-Type", "text/plain")
89+ ] "Directory listings disabled"
11190
112− findIndex :: [File] -> Piece -> First Piece
113− findIndex files index
114− | index `elem` map fileName files = First $ Just index
115− | otherwise = First Nothing
91+addTrailingSlash :: W.Request -> Maybe ByteString
92+addTrailingSlash req
93+ | S8.null rp = Just "/"
94+ | S8.last rp == '/' = Nothing
95+ | otherwise = Just $ S8.snoc rp '/'
96+ where
97+ rp = W.rawPathInfo req
11698
11799checkPieces :: StaticSettings
118100 -> Pieces -- ^ parsed request
@@ -124,11 +106,51 @@ checkPieces _ pieces _ | any (T.null . fromPiece) $ safeInit pieces =
124106 return $ Redirect (filterButLast (not . T.null . fromPiece) pieces) Nothing
125107
126108checkPieces ss@StaticSettings {..} pieces req = do
127− res <- ssLookupFile pieces
109+ res <- lookupResult
128110 case res of
129− LRNotFound -> return NotFound
130− LRFile file -> serveFile ss req file
131− 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
115+ where
116+ lookupResult :: IO (Either ByteString LookupResult)
117+ lookupResult = do
118+ nonIndexResult <- ssLookupFile pieces
119+ case nonIndexResult of
120+ LRFile{} -> return $ Right nonIndexResult
121+ _ -> do
122+ eIndexResult <- lookupIndices (map (\ index -> dropLastIfNull pieces ++ [index]) ssIndices)
123+ return $ case eIndexResult of
124+ Left redirect -> Left redirect
125+ Right indexResult -> case indexResult of
126+ LRNotFound -> Right nonIndexResult
127+ LRFile file | ssRedirectToIndex ->
128+ let relPath =
129+ case reverse pieces of
130+ -- Served at root
131+ [] -> fromPiece $ fileName file
132+ lastSegment:_ ->
133+ case fromPiece lastSegment of
134+ -- Ends with a trailing slash
135+ "" -> fromPiece $ fileName file
136+ -- Lacks a trailing slash
137+ lastSegment' -> T.concat
138+ [ lastSegment'
139+ , "/"
140+ , fromPiece $ fileName file
141+ ]
142+ in Left $ TE.encodeUtf8 relPath
143+ _ -> Right indexResult
144+
145+ lookupIndices :: [Pieces] -> IO (Either ByteString LookupResult)
146+ lookupIndices (x : xs) = do
147+ res <- ssLookupFile x
148+ case res of
149+ LRNotFound -> lookupIndices xs
150+ _ -> return $ case (ssAddTrailingSlash, addTrailingSlash req) of
151+ (True, Just redirect) -> Left redirect
152+ _ -> Right res
153+ lookupIndices [] = return $ Right LRNotFound
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.
@@ -205,10 +229,10 @@ staticApp set req = staticAppPieces set (W.pathInfo req) req
205229
206230staticAppPieces :: StaticSettings -> [Text] -> W.Application
207231staticAppPieces _ _ req sendResponse
208− | W.requestMethod req /= "GET" = sendResponse $ W.responseLBS
232+ | notElem (W.requestMethod req) ["GET", "HEAD"] = sendResponse $ W.responseLBS
209233 H.status405
210234 [("Content-Type", "text/plain")]
211− "Only GET is supported"
235+ "Only GET or HEAD is supported"
212236staticAppPieces _ [".hidden", "folder.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/folder.png")]
213237staticAppPieces _ [".hidden", "haskell.png"] _ sendResponse = sendResponse $ W.responseLBS H.status200 [("Content-Type", "image/png")] $ L.fromChunks [$(embedFile "images/haskell.png")]
214238staticAppPieces ss rawPieces req sendResponse = liftIO $ do
@@ -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,17 +264,25 @@ 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
253− response NotFound = sendResponse $ W.responseLBS H.status404
277+ response (RawRedirect path) =
278+ sendResponse $ W.responseLBS H.status302
279+ [ ("Content-Type", "text/plain")
280+ , ("Location", path)
281+ ] "Redirect"
282+
283+ response NotFound = case (ss404Handler ss) of
284+ Just app -> app req sendResponse
285+ Nothing -> sendResponse $ W.responseLBS H.status404
254286 [ ("Content-Type", "text/plain")
255287 ] "File not found"
256288
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+15−8
@@ -8,13 +8,12 @@ module WaiAppStatic.CmdLine
88import Network.Wai (Middleware)
99import Network.Wai.Application.Static (staticApp, defaultFileServerSettings)
1010import Network.Wai.Handler.Warp
11− ( runSettings, defaultSettings, settingsHost, settingsPort
11+ ( runSettings, defaultSettings, setHost, setPort
1212 )
1313import Options.Applicative
1414import Text.Printf (printf)
1515import System.Directory (canonicalizePath)
1616import Control.Monad (unless)
17−import Network.Wai.Middleware.Autohead
1817import Network.Wai.Middleware.RequestLogger (logStdout)
1918import Network.Wai.Middleware.Gzip
2019import qualified Data.Map as Map
@@ -26,6 +25,7 @@ import Network.Mime (defaultMimeMap, mimeByExt, defaultMimeType)
2625import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
2726import Data.Maybe (mapMaybe)
2827import Control.Arrow (second)
28+import Data.Monoid ((<>))
2929
3030data Args = Args
3131 { docroot :: FilePath
@@ -39,6 +39,7 @@ data Args = Args
3939 }
4040
4141#if MIN_VERSION_optparse_applicative(0, 10, 0)
42+option' :: Mod OptionFields Int -> Parser Int
4243option' = option auto
4344#else
4445option' = option
@@ -93,19 +94,25 @@ args = Args
9394-- Since 2.0.1
9495runCommandLine :: (Args -> Middleware) -> IO ()
9596runCommandLine middleware = do
96− args@Args {..} <- execParser $ info (helper <*> args) fullDesc
97+ args@Args {..} <- execParser $ info (helperOption <*> args) fullDesc
9798 let mime' = map (pack *** S8.pack) mime
9899 let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
99100 docroot' <- canonicalizePath docroot
100101 unless quiet $ printf "Serving directory %s on port %d with %s index files.\n" docroot' port (if noindex then "no" else show index)
101102 let middle = gzip def { gzipFiles = GzipCompress }
102103 . (if verbose then logStdout else id)
103− . autohead
104104 . (middleware args)
105− runSettings defaultSettings
106− { settingsPort = port
107− , settingsHost = fromString host
108− } $ middle $ staticApp (defaultFileServerSettings $ fromString docroot)
105+ runSettings
106+ ( setPort port
107+ $ setHost (fromString host)
108+ defaultSettings
109+ )
110+ $ middle $ staticApp (defaultFileServerSettings $ fromString docroot)
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+35−13
@@ -1,5 +1,6 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE ViewPatterns #-}
34module WaiAppStatic.Listing
45 ( defaultListing
56 ) where
@@ -21,7 +22,7 @@ import qualified Text.Blaze.Html.Renderer.Utf8 as HU
2122
2223-- | Provides a default directory listing, suitable for most apps.
2324--
24−-- 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>
2526defaultListing :: Listing
2627defaultListing pieces (Folder contents) = do
2728 let isTop = null pieces || map Just pieces == [toPiece ""]
@@ -48,8 +49,12 @@ defaultListing pieces (Folder contents) = do
4849 , "a { text-decoration: none }"
4950 ]
5051 H.body $ do
51− H.h1 $ showFolder $ filter (not . T.null . fromPiece) pieces
52− renderDirectoryContentsTable haskellSrc folderSrc fps''
52+ let hasTrailingSlash =
53+ case map fromPiece $ reverse $ pieces of
54+ "":_ -> True
55+ _ -> False
56+ H.h1 $ showFolder' hasTrailingSlash $ filter (not . T.null . fromPiece) pieces
57+ renderDirectoryContentsTable (map fromPiece pieces) haskellSrc folderSrc fps''
5358 where
5459 image x = T.unpack $ T.concat [(relativeDirFromPieces pieces), ".hidden/", x, ".png"]
5560 folderSrc = image "folder"
@@ -57,14 +62,21 @@ defaultListing pieces (Folder contents) = do
5762 showName "" = "root"
5863 showName x = x
5964
60− showFolder :: Pieces -> H.Html
61− showFolder [] = "/"
62− showFolder [x] = H.toHtml $ showName $ fromPiece x
63− showFolder (x:xs) = do
64− let href = concat $ replicate (length xs) "../" :: String
65+ -- Add a link to the root of the tree
66+ showFolder' :: Bool -> Pieces -> H.Html
67+ showFolder' hasTrailingSlash pieces' = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces')
68+
69+ showFolder :: Bool -> Pieces -> H.Html
70+ showFolder _ [] = "/" -- won't happen
71+ showFolder _ [x] = H.toHtml $ showName $ fromPiece x
72+ showFolder hasTrailingSlash (x:xs) = do
73+ let len = length xs - (if hasTrailingSlash then 0 else 1)
74+ href
75+ | len == 0 = "."
76+ | otherwise = concat $ replicate len "../" :: String
6577 H.a ! A.href (H.toValue href) $ H.toHtml $ showName $ fromPiece x
6678 " / " :: H.Html
67− showFolder xs
79+ showFolder hasTrailingSlash xs
6880
6981-- | a function to generate an HTML table showing the contents of a directory on the disk
7082--
@@ -74,11 +86,12 @@ defaultListing pieces (Folder contents) = do
7486-- a new page template to wrap around this HTML.
7587--
7688-- see also: 'getMetaData', 'renderDirectoryContents'
77−renderDirectoryContentsTable :: String
89+renderDirectoryContentsTable :: [T.Text] -- ^ requested path info
90+ -> String
7891 -> String
7992 -> [Either FolderName File]
8093 -> H.Html
81−renderDirectoryContentsTable haskellSrc folderSrc fps =
94+renderDirectoryContentsTable pathInfo' haskellSrc folderSrc fps =
8295 H.table $ do H.thead $ do H.th ! (A.class_ "first") $ H.img ! (A.src $ H.toValue haskellSrc)
8396 H.th "Name"
8497 H.th "Modified"
@@ -100,9 +113,18 @@ renderDirectoryContentsTable haskellSrc folderSrc fps =
100113 Left{} -> H.img ! A.src (H.toValue folderSrc)
101114 ! A.alt "Folder"
102115 Right{} -> return ()
103− let name = either id fileName md
116+ let name =
117+ case either id fileName md of
118+ (fromPiece -> "") -> unsafeToPiece ".."
119+ x -> x
104120 let isFile = either (const False) (const True) md
105− H.td (H.a ! A.href (H.toValue $ fromPiece name `T.append` if isFile then "" else "/") $ H.toHtml $ fromPiece name)
121+ href = addCurrentDir $ fromPiece name
122+ addCurrentDir x =
123+ case reverse pathInfo' of
124+ "":_ -> x -- has a trailing slash
125+ [] -> x -- at the root
126+ currentDir:_ -> T.concat [currentDir, "/", x]
127+ H.td (H.a ! A.href (H.toValue href) $ H.toHtml $ fromPiece name)
106128 H.td ! A.class_ "date" $ H.toHtml $
107129 case md of
108130 Right File { fileGetModified = Just t } ->
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+29−26
@@ -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
@@ -11,10 +12,9 @@ module WaiAppStatic.Storage.Filesystem
1112 ) where
1213
1314import WaiAppStatic.Types
14−import Prelude hiding (FilePath)
15−import Filesystem.Path.CurrentOS (FilePath, (</>))
16−import qualified Filesystem.Path.CurrentOS as F
17−import qualified Filesystem as F
15+import System.FilePath ((</>))
16+import System.IO (withBinaryFile, IOMode(..))
17+import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
1818import Data.List (foldl')
1919import Control.Monad (forM)
2020import Util
@@ -25,14 +25,14 @@ import WaiAppStatic.Listing
2525import Network.Mime
2626import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
2727import Data.Maybe (catMaybes)
28−import qualified Crypto.Hash.Conduit (hashFile)
29−import Data.Byteable (toBytes)
30−import Crypto.Hash (MD5, Digest)
31−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)
31+import qualified Data.Text as T
3232
3333-- | Construct a new path from a root and some @Pieces@.
3434pathFromPieces :: FilePath -> Pieces -> FilePath
35−pathFromPieces = foldl' (\fp p -> fp </> F.fromText (fromPiece p))
35+pathFromPieces = foldl' (\fp p -> fp </> T.unpack (fromPiece p))
3636
3737-- | Settings optimized for a web application. Files will have aggressive
3838-- caching applied and hashes calculated, and indices and listings are disabled.
@@ -47,6 +47,8 @@ defaultWebAppSettings root = StaticSettings
4747 , ssIndices = []
4848 , ssRedirectToIndex = False
4949 , ssUseHash = True
50+ , ssAddTrailingSlash = False
51+ , ss404Handler = Nothing
5052 }
5153
5254-- | Settings optimized for a file server. More conservative caching will be
@@ -62,6 +64,8 @@ defaultFileServerSettings root = StaticSettings
6264 , ssIndices = map unsafeToPiece ["index.html", "index.htm"]
6365 , ssRedirectToIndex = False
6466 , ssUseHash = False
67+ , ssAddTrailingSlash = False
68+ , ss404Handler = Nothing
6569 }
6670
6771-- | Same as @defaultWebAppSettings@, but additionally uses a specialized
@@ -86,12 +90,12 @@ fileHelper :: ETagLookup
8690 -> Piece -- ^ file name
8791 -> IO (Maybe File)
8892fileHelper hashFunc fp name = do
89− efs <- try $ getFileStatus $ F.encodeString fp
93+ efs <- try $ getFileStatus fp
9094 case efs of
9195 Left (_ :: SomeException) -> return Nothing
9296 Right fs | isRegularFile fs -> return $ Just File
9397 { fileGetSize = fromIntegral $ fileSize fs
94− , fileToResponse = \s h -> W.responseFile s h (F.encodeString fp) Nothing
98+ , fileToResponse = \s h -> W.responseFile s h fp Nothing
9599 , fileName = name
96100 , fileGetHash = hashFunc fp
97101 , fileGetModified = Just $ modificationTime fs
@@ -116,9 +120,10 @@ webAppLookup hashFunc prefix pieces =
116120-- | MD5 hash and base64-encode the file contents. Does not check if the file
117121-- exists.
118122hashFile :: FilePath -> IO ByteString
119−hashFile fp = do
120− h <- Crypto.Hash.Conduit.hashFile (F.encodeString fp)
121− 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
122127
123128hashFileIfExists :: ETagLookup
124129hashFileIfExists fp = do
@@ -128,12 +133,9 @@ hashFileIfExists fp = do
128133 Right x -> Just x
129134
130135isVisible :: FilePath -> Bool
131−isVisible =
132− go . F.encodeString . F.filename
133− where
134− go ('.':_) = False
135− go "" = False
136− go _ = True
136+isVisible ('.':_) = False
137+isVisible "" = False
138+isVisible _ = True
137139
138140-- | Get a proper @LookupResult@, checking if the path is a file or folder.
139141-- Compare with @webAppLookup@, which only deals with files.
@@ -141,17 +143,18 @@ fileSystemLookup :: ETagLookup
141143 -> FilePath -> Pieces -> IO LookupResult
142144fileSystemLookup hashFunc prefix pieces = do
143145 let fp = pathFromPieces prefix pieces
144− fe <- F.isFile fp
146+ fe <- doesFileExist fp
145147 if fe
146148 then fileHelperLR hashFunc fp lastPiece
147149 else do
148− de <- F.isDirectory fp
150+ de <- doesDirectoryExist fp
149151 if de
150152 then do
151− entries' <- fmap (filter isVisible) $ F.listDirectory fp
152− entries <- forM entries' $ \fp' -> do
153− let name = unsafeToPiece $ either id id $ F.toText $ F.filename fp'
154− de' <- F.isDirectory fp'
153+ entries' <- fmap (filter isVisible) $ getDirectoryContents fp
154+ entries <- forM entries' $ \fpRel' -> do
155+ let name = unsafeToPiece $ T.pack fpRel'
156+ fp' = fp </> fpRel'
157+ de' <- doesDirectoryExist fp'
155158 if de'
156159 then return $ Just $ Left name
157160 else do
wai-app-static/WaiAppStatic/Types.hs+12−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@.
@@ -141,4 +142,12 @@ data StaticSettings = StaticSettings
141142
142143 -- | Prefer usage of etag caching to last-modified caching.
143144 , ssUseHash :: Bool
145+
146+ -- | Force a trailing slash at the end of directories
147+ , ssAddTrailingSlash :: Bool
148+
149+ -- | Optional `W.Application` to be used in case of 404 errors
150+ --
151+ -- Since 3.1.3
152+ , ss404Handler :: Maybe W.Application
144153 }
wai-app-static/test/EmbeddedTestEntries.hs+10
@@ -42,4 +42,14 @@ mkEntries = return
4242 , EmbeddableEntry "e6.txt"
4343 "text/plain"
4444 (Right [| return ("" :: T.Text, body 1000 'W') |] )
45+
46+ -- An index file
47+ , EmbeddableEntry "index.html"
48+ "text/html"
49+ (Right [| return ("" :: T.Text, "index file") |] )
50+
51+ -- An index file in a subdir
52+ , EmbeddableEntry "foo/index.html"
53+ "text/html"
54+ (Right [| return ("" :: T.Text, "index file in subdir") |] )
4555 ]
wai-app-static/test/WaiAppEmbeddedTest.hs+21−5
@@ -8,16 +8,15 @@ import Network.Wai.Application.Static (staticApp)
88import Network.Wai.Test
99import Test.Hspec
1010import WaiAppStatic.Storage.Embedded
11−
12−embApp :: Application
13−embApp = staticApp $(mkSettings mkEntries)
11+import WaiAppStatic.Types
1412
1513defRequest :: Request
1614defRequest = defaultRequest
1715
1816embSpec :: Spec
1917embSpec = do
20− let embed = flip runSession embApp
18+ let embedSettings settings = flip runSession (staticApp settings)
19+ let embed = embedSettings $(mkSettings mkEntries)
2120 describe "embedded, compressed entry" $ do
2221 it "served correctly" $ embed $ do
2322 req <- request (setRawPathInfo defRequest "e1.txt")
@@ -33,6 +32,24 @@ embSpec = do
3332 { requestHeaders = [("If-None-Match", "Etag 1")] }
3433 assertStatus 304 req
3534
35+ it "ssIndices works" $ do
36+ let testSettings = $(mkSettings mkEntries){
37+ ssIndices = [unsafeToPiece "index.html"]
38+ }
39+ embedSettings testSettings $ do
40+ req <- request defRequest
41+ assertStatus 200 req
42+ assertBody "index file" req
43+
44+ it "ssIndices works with trailing slashes" $ do
45+ let testSettings = $(mkSettings mkEntries){
46+ ssIndices = [unsafeToPiece "index.html"]
47+ }
48+ embedSettings testSettings $ do
49+ req <- request (setRawPathInfo defRequest "/foo/")
50+ assertStatus 200 req
51+ assertBody "index file in subdir" req
52+
3653 describe "embedded, uncompressed entry" $ do
3754 it "too short" $ embed $ do
3855 req <- request (setRawPathInfo defRequest "e2.txt")
@@ -75,4 +92,3 @@ embSpec = do
7592 assertNoHeader "Content-Encoding" req
7693 assertNoHeader "ETag" req
7794 assertBody (body 1000 'W') req
78−
wai-app-static/test/WaiAppStaticTest.hs+65−6
@@ -2,13 +2,18 @@
22module WaiAppStaticTest (spec) where
33
44import Network.Wai.Application.Static
5+import WaiAppStatic.Types
56
67import Test.Hspec
8+import Test.Mockery.Directory
79import qualified Data.ByteString.Char8 as S8
810-- import qualified Data.ByteString.Lazy.Char8 as L8
911import System.PosixCompat.Files (getFileStatus, modificationTime)
12+import System.FilePath
13+import System.IO.Temp
1014
1115import Network.HTTP.Date
16+import Network.HTTP.Types (status500)
1217{-import System.Locale (defaultTimeLocale)-}
1318{-import Data.Time.Format (formatTime)-}
1419
@@ -24,7 +29,10 @@ defRequest = defaultRequest
2429spec :: Spec
2530spec = do
2631 let webApp = flip runSession $ staticApp $ defaultWebAppSettings "test"
27− let fileServerApp = flip runSession $ staticApp $ defaultFileServerSettings "test"
32+ let fileServerAppWithSettings settings = flip runSession $ staticApp settings
33+ let fileServerApp = fileServerAppWithSettings (defaultFileServerSettings "test")
34+ { ssAddTrailingSlash = True
35+ }
2836
2937 let etag = "1B2M2Y8AsgTpgAmY7PhCfg=="
3038 let file = "a/b"
@@ -49,22 +57,22 @@ spec = do
4957 assertStatus 200 =<<
5058 request (setRawPathInfo defRequest path)
5159
52− it "404 for non-existant files" $ webApp $
60+ it "404 for non-existent files" $ webApp $
5361 assertStatus 404 =<<
5462 request (setRawPathInfo defRequest "doesNotExist")
5563
56− it "301 redirect when multiple slashes" $ webApp $ do
64+ it "302 redirect when multiple slashes" $ webApp $ do
5765 req <- request (setRawPathInfo defRequest "a//b/c")
58− assertStatus 301 req
66+ assertStatus 302 req
5967 assertHeader "Location" "../../a/b/c" req
6068
6169 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
6270 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
6371 }
64− it "301 redirect when multiple slashes" $ absoluteApp $
72+ it "302 redirect when multiple slashes" $ absoluteApp $
6573 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
6674 req <- request (setRawPathInfo defRequest path)
67− assertStatus 301 req
75+ assertStatus 302 req
6876 assertHeader "Location" "http://www.example.com/a/b/c" req
6977
7078 describe "webApp when requesting a static asset" $ do
@@ -123,3 +131,54 @@ spec = do
123131 assertStatus 304 req
124132 assertNoHeader "Cache-Control" req
125133
134+ context "302 redirect to add a trailing slash on directories if missing" $ do
135+ it "works at the root" $ fileServerApp $ do
136+ req <- request (setRawPathInfo defRequest "/a")
137+ assertStatus 302 req
138+ assertHeader "Location" "/a/" req
139+
140+ it "works when an index.html is delivered" $ do
141+ let settings = (defaultFileServerSettings "."){
142+ ssAddTrailingSlash = True
143+ }
144+ inTempDirectory $ fileServerAppWithSettings settings $ do
145+ liftIO $ touch "foo/index.html"
146+ req <- request (setRawPathInfo defRequest "/foo")
147+ assertStatus 302 req
148+ assertHeader "Location" "/foo/" req
149+
150+ let urlMapApp = flip runSession $ \req send ->
151+ case pathInfo req of
152+ "subPath":rest ->
153+ let req' = req { pathInfo = rest }
154+ in (staticApp (defaultFileServerSettings "test")
155+ { ssAddTrailingSlash = True
156+ }) req' send
157+ _ -> send $ responseLBS status500 []
158+ "urlMapApp: only works at subPath"
159+ it "works with subpath at the root of the file server" $ urlMapApp $ do
160+ req <- request (setRawPathInfo defRequest "/subPath")
161+ assertStatus 302 req
162+ assertHeader "Location" "/subPath/" req
163+
164+ context "with defaultWebAppSettings" $ do
165+ it "ssIndices works" $ do
166+ withSystemTempDirectory "wai-app-static-test" $ \ dir -> do
167+ writeFile (dir </> "index.html") "foo"
168+ let testSettings = (defaultWebAppSettings dir) {
169+ ssIndices = [unsafeToPiece "index.html"]
170+ }
171+ fileServerAppWithSettings testSettings $ do
172+ resp <- request (setRawPathInfo defRequest "/")
173+ assertStatus 200 resp
174+ assertBody "foo" resp
175+
176+ context "with defaultFileServerSettings" $ do
177+ it "prefers ssIndices over ssListing" $ do
178+ withSystemTempDirectory "wai-app-static-test" $ \ dir -> do
179+ writeFile (dir </> "index.html") "foo"
180+ let testSettings = defaultFileServerSettings dir
181+ fileServerAppWithSettings testSettings $ do
182+ resp <- request (setRawPathInfo defRequest "/")
183+ assertStatus 200 resp
184+ assertBody "foo" resp
wai-app-static/wai-app-static.cabal+12−15
@@ -1,11 +1,11 @@
11name: wai-app-static
2−version: 3.0.0.4
2+version: 3.1.7.1
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>, Greg Weber <greg@gregweber.info>
77synopsis: WAI application for static serving
8−description: Hackage documentation generation is not reliable. For up to date documentation, please see: <http://www.stackage.org/package/wai-app-static>.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-app-static>.
99category: Web, Yesod
1010stability: Stable
1111cabal-version: >= 1.8
@@ -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,12 +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
44− , system-filepath >= 0.4
45− , system-fileio >= 0.3
40+ , cryptonite >= 0.6
41+ , memory >= 0.7
4642 , http-date
4743 , blaze-html >= 0.5
4844 , blaze-markup >= 0.5.1
@@ -53,9 +49,7 @@ library
5349 , filepath
5450 , wai-extra >= 3.0 && < 3.1
5551 , optparse-applicative >= 0.7
56− , warp >= 3.0 && < 3.1
57− -- Used exclusively for hashFile function
58− , cryptohash-conduit
52+ , warp >= 3.0.11 && < 3.4
5953
6054 exposed-modules: Network.Wai.Application.Static
6155 WaiAppStatic.Storage.Filesystem
@@ -79,7 +73,7 @@ Executable warp
7973 , wai-app-static
8074 , directory >= 1.0
8175 , containers >= 0.2
82− , bytestring >= 0.9.1.4
76+ , bytestring >= 0.10.4
8377 , text >= 0.7
8478 , mime-types >= 0.1 && < 0.2
8579
@@ -104,8 +98,11 @@ test-suite runtests
10498 , transformers
10599 , mime-types
106100 , zlib
101+ , filepath
102+ , temporary
103+ , mockery
107104 -- , containers
108− ghc-options: -Wall
105+ ghc-options: -Wall
109106
110107source-repository head
111108 type: git
wai-conduit/ChangeLog.mdnew file+7
@@ -0,0 +1,7 @@
1+## 3.0.0.4
2+
3+* Drop dependency on blaze-builder
4+
5+## 3.0.0.3
6+
7+* Support wai 3.2
wai-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/README.mdnew file+4
@@ -0,0 +1,4 @@
1+## wai-conduit
2+
3+Since version 3.0.0, WAI has no built-in streaming data abstraction. This
4+library provides similar functionality to what existed in WAI 2.x.
wai-conduit/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+5−6
@@ -1,8 +1,7 @@
11name: wai-conduit
2−version: 3.0.0.1
2+version: 3.0.0.4
33synopsis: conduit wrappers for WAI
4−description: Since version 3.0.0, WAI has no built-in streaming data abstraction.
5− This library provides similar functionality to what existed in WAI 2.x.
4+description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
65homepage: https://github.com/yesodweb/wai
76license: MIT
87license-file: LICENSE
@@ -11,14 +10,14 @@ maintainer: michael@snoyman.com
1110category: Web, Conduit
1211build-type: Simple
1312cabal-version: >=1.10
13+extra-source-files: README.md ChangeLog.md
1414
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-eventsource/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-eventsource/wai-eventsource.cabaldeleted−16
@@ -1,16 +0,0 @@
1−Name: wai-eventsource
2−Version: 3.0.0
3−Synopsis: WAI support for server-sent events (deprecated)
4−Description: Since WAI 3.0, this code has been merged into wai-extra.
5−License: MIT
6−Author: Chris Smith, Mathias Biilmann Christensen
7−Maintainer: greg@gregweber.info
8−Stability: Experimental
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.8
12−homepage: http://www.yesodweb.com/book/web-application-interface
13−license-file: LICENSE
14−
15−Library
16− build-depends: wai >= 3.0
wai-extra/ChangeLog.md+206
@@ -1,3 +1,209 @@
1+# Changelog for wai-extra
2+
3+## 3.0.29.1
4+
5+* Fix `Network.Wai.Test.request` always sending an empty request body [#794](https://github.com/yesodweb/wai/pull/794)
6+
7+## 3.0.29
8+
9+* Export `Network.Wai.EventSource.eventStreamAppRaw` [#786](https://github.com/yesodweb/wai/pull/786)
10+
11+## 3.0.28
12+
13+* Add `Network.Wai.EventSource.eventStreamAppRaw` [#767](https://github.com/yesodweb/wai/pull/767)
14+
15+## 3.0.27
16+
17+* Add custom request log formatter which includes response headers [#762](https://github.com/yesodweb/wai/pull/762)
18+
19+## 3.0.26.1
20+
21+* When available, supply the response size to custom loggers
22+ [#757](https://github.com/yesodweb/wai/pull/757)
23+
24+## 3.0.26
25+
26+* Throw 413 for too large payload
27+* Throw 431 for too large headers
28+ [#741](https://github.com/yesodweb/wai/pull/741)
29+
30+## 3.0.25
31+
32+* Supporting `network` version 3.0.
33+
34+## 3.0.24.3
35+
36+* Drop unnecessary `lifted-base` dependency
37+* Drop unnecessary `stringsearch` dependency [#714](https://github.com/yesodweb/wai/pull/714)
38+
39+## 3.0.24.2
40+
41+* Consider quoted multipart form boundary markers [#700](https://github.com/yesodweb/wai/pull/700).
42+* Don't raise exceptions in `formatAsJSON` [#709](https://github.com/yesodweb/wai/pull/709)
43+
44+## 3.0.24.1
45+
46+* Fix a "file not found" exception in wai-extra [#705](https://github.com/yesodweb/wai/pull/706)
47+
48+## 3.0.24.0
49+
50+* Add timeout middleware [#702](https://github.com/yesodweb/wai/pull/702).
51+
52+## 3.0.23.0
53+
54+* Add rewriteRoot middleware [#697](https://github.com/yesodweb/wai/pull/697).
55+
56+## 3.0.22.1
57+
58+* Drop dependency on blaze-builder, requiring streaming-commons >= 0.2
59+
60+## 3.0.22.0
61+
62+* Support for streaming-commons 0.2
63+* Support for resourcet 1.2
64+
65+## 3.0.21.0
66+
67+* Export `Network.Wai.Parse.noLimitParseRequestBodyOptions` [#662](https://github.com/yesodweb/wai/pull/662).
68+
69+## 3.0.20.2
70+
71+* Revert previous change to `srequest`, which caused breakage
72+
73+## 3.0.20.1
74+
75+* Set `requestBodyLength` for `srequest` [#654](https://github.com/yesodweb/wai/pull/654)
76+
77+## 3.0.20.0
78+
79+* runSessionWith (runSession variant that gives access to ClientState) [#629](https://github.com/yesodweb/wai/pull/629)
80+
81+## 3.0.19.1
82+
83+* All loggers follow the autoFlush setting [#604](https://github.com/yesodweb/wai/pull/604)
84+
85+## 3.0.19
86+
87+* Add a new function basicAuth', which passes request to the CheckCreds argument.
88+
89+## 3.0.18
90+
91+* ForceSSL: preserve port number when redirecting to https. [#582](https://github.com/yesodweb/wai/pull/582)
92+
93+## 3.0.17
94+
95+* Gzip pre compressed [#580](https://github.com/yesodweb/wai/pull/580)
96+
97+## 3.0.16.1
98+
99+* Fix the way the header length is checked (for limiting the max header length)
100+
101+## 3.0.16.0
102+
103+* Add a new function "parseRequestBodyEx" that allows various size limits to be set.
104+
105+## 3.0.15.3
106+
107+* Allow wai-logger 2.3
108+
109+## 3.0.15.2
110+
111+* Doc improvements
112+
113+## 3.0.15.1
114+
115+* don't use deprecated CRT functions on Windows [#544](https://github.com/yesodweb/wai/pull/544)
116+
117+## 3.0.15
118+
119+* add requestSizeCheck [#525](https://github.com/yesodweb/wai/pull/525)
120+
121+## 3.0.14.3
122+
123+* Add missing `requestHeaderReferer` and `requestHeaderUserAgent` fields to CGI [yesod#1186](https://github.com/yesodweb/yesod/issues/1186)
124+
125+## 3.0.14.2
126+
127+* Case insensitive multipart request header lookup [#518](https://github.com/yesodweb/wai/pull/518)
128+
129+## 3.0.14.1
130+
131+* Doc update for logStdout and logStdoutDev [#515](https://github.com/yesodweb/wai/issues/515)
132+
133+## 3.0.14
134+
135+* Middleware to force domain names. [#506](https://github.com/yesodweb/wai/issues/506) [#507](https://github.com/yesodweb/wai/pull/507)
136+
137+## 3.0.13.1
138+
139+* Support wai 3.2
140+
141+## 3.0.13
142+
143+* Autoflush handle [#466](https://github.com/yesodweb/wai/pull/466)
144+
145+## 3.0.12
146+
147+* Add Network.Wai.Header.contentLength to read the Content-Length header of a response
148+* The gzip middleware no longer zips responses smaller than 860 bytes
149+
150+## 3.0.11
151+
152+* Add constructor for more detailed custom output formats for RequestLogger
153+* Add JSON output formatter for RequestLogger
154+
155+## 3.0.10
156+
157+* Adding Request Body to RequestLogger [#401](https://github.com/yesodweb/wai/pull/401)
158+
159+## 3.0.9
160+
161+* Network.Wai.Middleware.Routed module added
162+
163+## 3.0.7
164+
165+* Add appearsSecure: check if a request appears to be using SSL even in the
166+ presence of reverse proxies [#362](https://github.com/yesodweb/wai/pull/362)
167+* Add ForceSSL middleware [#363](https://github.com/yesodweb/wai/pull/363)
168+* Add Approot middleware
169+
170+## 3.0.6.1
171+
172+* Test code: only include a Cookie header if there are cookies. Without this
173+ patch, yesod-test cookie handling is broken.
174+
175+## 3.0.6
176+
177+* Add Cookie Handling to Network.Wai.Test [#356](https://github.com/yesodweb/wai/pull/356)
178+
179+## 3.0.5
180+
181+* add functions to extract authentication data from Authorization header [#352](add functions to extract authentication data from Authorization header #352)
182+
183+## 3.0.4.6
184+
185+* Access log sequence not valid [#336](https://github.com/yesodweb/wai/issues/336)
186+
187+## 3.0.4.5
188+
189+* Allow fast-logger 2.3
190+
191+## 3.0.4.3
192+
193+Test suite warning cleanup
194+
195+## 3.0.4.2
196+
197+Allow blaze-builder 0.4
198+
199+## 3.0.4.1
200+
201+Fix compilation failure on Windows [#321](https://github.com/yesodweb/wai/issues/321)
202+
203+## 3.0.4
204+
205+Add the `StreamFile` middleware.
206+
1207## 3.0.3
2208
3209Add the `AddHeaders` middleware.
wai-extra/Network/Wai/EventSource.hs+27−6
@@ -1,19 +1,25 @@
1−{-# LANGUAGE OverloadedStrings #-}
21{-|
32 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.
410-}
511module Network.Wai.EventSource (
612 ServerEvent(..),
713 eventSourceAppChan,
8− eventSourceAppIO
14+ eventSourceAppIO,
15+ eventStreamAppRaw
916 ) where
1017
11−import Blaze.ByteString.Builder (Builder)
1218import Data.Function (fix)
1319import Control.Concurrent.Chan (Chan, dupChan, readChan)
1420import Control.Monad.IO.Class (liftIO)
15−import Network.HTTP.Types (status200)
16−import Network.Wai (Application, Response, responseStream)
21+import Network.HTTP.Types (status200, hContentType)
22+import Network.Wai (Application, responseStream)
1723
1824import Network.Wai.EventSource.EventStream
1925
@@ -30,9 +36,24 @@ eventSourceAppIO :: IO ServerEvent -> Application
3036eventSourceAppIO src _ sendResponse =
3137 sendResponse $ responseStream
3238 status200
33− [("Content-Type", "text/event-stream")]
39+ [(hContentType, "text/event-stream")]
3440 $ \sendChunk flush -> fix $ \loop -> do
3541 se <- src
3642 case eventToBuilder se of
3743 Nothing -> return ()
3844 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+12−11
@@ -1,5 +1,5 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{- code adapted by Mathias Billman originaly from Chris Smith https://github.com/cdsmith/gloss-web -}
1+{-# LANGUAGE CPP #-}
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,9 +9,10 @@ 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
13+#if __GLASGOW_HASKELL__ < 710
1414import Data.Monoid
15+#endif
1516
1617{-|
1718 Type representing a communication over an event stream. This can be an
@@ -37,18 +38,18 @@ data ServerEvent
3738 Newline as a Builder.
3839-}
3940nl :: Builder
40−nl = fromChar '\n'
41+nl = char7 '\n'
4142
4243
4344{-|
4445 Field names as Builder
4546-}
4647nameField, idField, dataField, retryField, commentField :: Builder
47−nameField = fromString "event:"
48−idField = fromString "id:"
49−dataField = fromString "data:"
50−retryField = fromString "retry:"
51−commentField = fromChar ':'
48+nameField = string7 "event:"
49+idField = string7 "id:"
50+dataField = string7 "data:"
51+retryField = string7 "retry:"
52+commentField = char7 ':'
5253
5354
5455{-|
@@ -64,7 +65,7 @@ field l b = l `mappend` b `mappend` nl
6465-}
6566eventToBuilder :: ServerEvent -> Maybe Builder
6667eventToBuilder (CommentEvent txt) = Just $ field commentField txt
67−eventToBuilder (RetryEvent n) = Just $ field retryField (fromShow n)
68+eventToBuilder (RetryEvent n) = Just $ field retryField (string8 . show $ n)
6869eventToBuilder (CloseEvent) = Nothing
6970eventToBuilder (ServerEvent n i d)= Just $
7071 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
wai-extra/Network/Wai/Handler/CGI.hs+31−27
@@ -1,6 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
3−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE RankNTypes, CPP #-}
42-- | Backend for Common Gateway Interface. Almost all users should use the
53-- 'run' function.
64module Network.Wai.Handler.CGI
@@ -21,16 +19,18 @@ import Control.Arrow ((***))
2119import Data.Char (toLower)
2220import qualified System.IO
2321import qualified Data.String as String
24−import Data.Monoid (mconcat, mempty)
25−import Blaze.ByteString.Builder (fromByteString, toLazyByteString, flush)
26−import Blaze.ByteString.Builder.Char8 (fromChar, fromString)
22+import Data.ByteString.Builder (byteString, toLazyByteString, char7, string8)
23+import Data.ByteString.Builder.Extra (flush)
2724import Data.ByteString.Lazy.Internal (defaultChunkSize)
2825import System.IO (Handle)
29−import Network.HTTP.Types (Status (..))
26+import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
3027import qualified Network.HTTP.Types as H
3128import qualified Data.CaseInsensitive as CI
32−import Data.Monoid (mappend)
33−import qualified Data.Streaming.Blaze as Blaze
29+#if __GLASGOW_HASKELL__ < 710
30+import Data.Monoid (mconcat, mempty, mappend)
31+#endif
32+
33+import qualified Data.Streaming.ByteString.Builder as Builder
3434import Data.Function (fix)
3535import Control.Monad (unless, void)
3636
@@ -118,7 +118,11 @@ runGeneric vars inputH outputH xsendfile app = do
118118 , vault = mempty
119119 , requestBodyLength = KnownLength $ fromIntegral contentLength
120120 , requestHeaderHost = lookup "host" reqHeaders
121− , requestHeaderRange = lookup "range" reqHeaders
121+ , requestHeaderRange = lookup hRange reqHeaders
122+#if MIN_VERSION_wai(3,2,0)
123+ , requestHeaderReferer = lookup "referer" reqHeaders
124+ , requestHeaderUserAgent = lookup "user-agent" reqHeaders
125+#endif
122126 }
123127 void $ app env $ \res ->
124128 case (xsendfile, res) of
@@ -127,7 +131,7 @@ runGeneric vars inputH outputH xsendfile app = do
127131 return ResponseReceived
128132 _ -> do
129133 let (s, hs, wb) = responseToStream res
130− (blazeRecv, blazeFinish) <- Blaze.newBlazeRecv Blaze.defaultStrategy
134+ (blazeRecv, blazeFinish) <- Builder.newBuilderRecv Builder.defaultStrategy
131135 wb $ \b -> do
132136 let sendBuilder builder = do
133137 popper <- blazeRecv builder
@@ -136,39 +140,39 @@ runGeneric vars inputH outputH xsendfile app = do
136140 unless (B.null bs) $ do
137141 outputH bs
138142 loop
139− sendBuilder $ headers s hs `mappend` fromChar '\n'
143+ sendBuilder $ headers s hs `mappend` char7 '\n'
140144 b sendBuilder (sendBuilder flush)
141145 blazeFinish >>= maybe (return ()) outputH
142146 return ResponseReceived
143147 where
144148 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
145− status (Status i m) = (fromByteString "Status", mconcat
146− [ fromString $ show i
147− , fromChar ' '
148− , fromByteString m
149+ status (Status i m) = (byteString "Status", mconcat
150+ [ string8 $ show i
151+ , char7 ' '
152+ , byteString m
149153 ])
150− header' (x, y) = (fromByteString $ CI.original x, fromByteString y)
154+ header' (x, y) = (byteString $ CI.original x, byteString y)
151155 header (x, y) = mconcat
152156 [ x
153− , fromByteString ": "
157+ , byteString ": "
154158 , y
155− , fromChar '\n'
159+ , char7 '\n'
156160 ]
157161 sfBuilder s hs sf fp = mconcat
158162 [ headers s hs
159− , header $ (fromByteString sf, fromString fp)
160− , fromChar '\n'
161− , fromByteString sf
162− , fromByteString " not supported"
163+ , header $ (byteString sf, string8 fp)
164+ , char7 '\n'
165+ , byteString sf
166+ , byteString " not supported"
163167 ]
164168 fixHeaders h =
165− case lookup "content-type" h of
166− Nothing -> ("Content-Type", "text/html; charset=utf-8") : h
169+ case lookup hContentType h of
170+ Nothing -> (hContentType, "text/html; charset=utf-8") : h
167171 Just _ -> h
168172
169173cleanupVarName :: String -> CI.CI B.ByteString
170−cleanupVarName "CONTENT_TYPE" = "Content-Type"
171−cleanupVarName "CONTENT_LENGTH" = "Content-Length"
174+cleanupVarName "CONTENT_TYPE" = hContentType
175+cleanupVarName "CONTENT_LENGTH" = hContentLength
172176cleanupVarName "SCRIPT_NAME" = "CGI-Script-Name"
173177cleanupVarName s =
174178 case s 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.hsnew file+18
@@ -0,0 +1,18 @@
1+-- | Some helpers for dealing with WAI 'Header's.
2+
3+module Network.Wai.Header
4+ ( contentLength
5+ ) where
6+
7+import qualified Data.ByteString.Char8 as S8
8+import Network.HTTP.Types as H
9+
10+-- | More useful for a response. A Wai Request already has a requestBodyLength
11+contentLength :: [(HeaderName, S8.ByteString)] -> Maybe Integer
12+contentLength hdrs = lookup H.hContentLength hdrs >>= readInt
13+
14+readInt :: S8.ByteString -> Maybe Integer
15+readInt bs =
16+ case S8.readInteger bs of
17+ Just (i, rest) | S8.null rest -> Just i
18+ _ -> Nothing
wai-extra/Network/Wai/Middleware/AcceptOverride.hs−2
@@ -1,5 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
31module Network.Wai.Middleware.AcceptOverride
42 ( acceptOverride
53 ) where
wai-extra/Network/Wai/Middleware/AddHeaders.hs+4−10
@@ -5,8 +5,8 @@ module Network.Wai.Middleware.AddHeaders
55 ( addHeaders
66 ) where
77
8−import Network.HTTP.Types (ResponseHeaders, Header)
9−import Network.Wai (Middleware)
8+import Network.HTTP.Types (Header)
9+import Network.Wai (Middleware, modifyResponse, mapResponseHeaders)
1010import Network.Wai.Internal (Response(..))
1111import Data.ByteString (ByteString)
1212
@@ -18,13 +18,7 @@ addHeaders :: [(ByteString, ByteString)] -> Middleware
1818--
1919-- Since 3.0.3
2020
21−addHeaders h app req respond = app req $ respond . addHeaders' (map (first CI.mk) h)
22−
23−mapHeader :: (ResponseHeaders -> ResponseHeaders) -> Response -> Response
24−mapHeader f (ResponseFile s h b1 b2) = ResponseFile s (f h) b1 b2
25−mapHeader f (ResponseBuilder s h b) = ResponseBuilder s (f h) b
26−mapHeader f (ResponseStream s h b) = ResponseStream s (f h) b
27−mapHeader _ r@(ResponseRaw _ _) = r
21+addHeaders h = modifyResponse $ addHeaders' (map (first CI.mk) h)
2822
2923addHeaders' :: [Header] -> Response -> Response
30−addHeaders' h = mapHeader (\hs -> h ++ hs)
24+addHeaders' h = mapResponseHeaders (\hs -> h ++ hs)
wai-extra/Network/Wai/Middleware/Approot.hsnew file+121
@@ -0,0 +1,121 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+-- | Middleware for establishing the root of the application.
3+--
4+-- Many application need the ability to create URLs referring back to the
5+-- application itself. For example: generate RSS feeds or sitemaps, giving
6+-- users copy-paste links, or sending emails. In many cases, the approot can be
7+-- determined correctly from the request headers. However, some things can
8+-- prevent this, especially reverse proxies. This module provides multiple ways
9+-- of configuring approot discovery, and functions for applications to get that
10+-- approot.
11+--
12+-- Approots are structured such that they can be prepended to a string such as
13+-- @/foo/bar?baz=bin@. For example, if your application is hosted on
14+-- example.com using HTTPS, the approot would be @https://example.com@. Note
15+-- the lack of a trailing slash.
16+module Network.Wai.Middleware.Approot
17+ ( -- * Middleware
18+ approotMiddleware
19+ -- * Common providers
20+ , envFallback
21+ , envFallbackNamed
22+ , hardcoded
23+ , fromRequest
24+ -- * Functions for applications
25+ , getApproot
26+ , getApprootMay
27+ ) where
28+
29+import Control.Exception (Exception, throw)
30+import Data.ByteString (ByteString)
31+import qualified Data.ByteString.Char8 as S8
32+import Data.Maybe (fromMaybe)
33+import Data.Typeable (Typeable)
34+import qualified Data.Vault.Lazy as V
35+import Network.Wai (Request, vault, Middleware)
36+import Network.Wai.Request (guessApproot)
37+import System.Environment (getEnvironment)
38+import System.IO.Unsafe (unsafePerformIO)
39+
40+approotKey :: V.Key ByteString
41+approotKey = unsafePerformIO V.newKey
42+{-# NOINLINE approotKey #-}
43+
44+-- | The most generic version of the middleware, allowing you to provide a
45+-- function to get the approot for each request. For many use cases, one of the
46+-- helper functions provided by this module will give the necessary
47+-- functionality more conveniently.
48+--
49+-- Since 3.0.7
50+approotMiddleware :: (Request -> IO ByteString) -- ^ get the approot
51+ -> Middleware
52+approotMiddleware getRoot app req respond = do
53+ ar <- getRoot req
54+ let req' = req { vault = V.insert approotKey ar $ vault req }
55+ app req' respond
56+
57+-- | Same as @'envFallbackNamed' "APPROOT"@.
58+--
59+-- The environment variable @APPROOT@ is used by Keter, School of Haskell, and yesod-devel.
60+--
61+-- Since 3.0.7
62+envFallback :: IO Middleware
63+envFallback = envFallbackNamed "APPROOT"
64+
65+-- | Produce a middleware that takes the approot from the given environment
66+-- variable, falling back to the behavior of 'fromRequest' if the variable is
67+-- not set.
68+--
69+-- Since 3.0.7
70+envFallbackNamed :: String -> IO Middleware
71+envFallbackNamed name = do
72+ env <- getEnvironment
73+ case lookup name env of
74+ Just s -> return $ hardcoded $ S8.pack s
75+ Nothing -> return fromRequest
76+
77+-- | Hard-code the given value as the approot.
78+--
79+-- Since 3.0.7
80+hardcoded :: ByteString -> Middleware
81+hardcoded ar = approotMiddleware (const $ return ar)
82+
83+-- | Get the approot by analyzing the request. This is not a full-proof
84+-- approach, but in many common cases will work. Situations that can break this
85+-- are:
86+--
87+-- * Requests which spoof headers and imply the connection is over HTTPS
88+--
89+-- * Reverse proxies that change ports in surprising ways
90+--
91+-- * Invalid Host headers
92+--
93+-- * Reverse proxies which modify the path info
94+--
95+-- Normally trusting headers in this way is insecure, however in the case of
96+-- approot, the worst that can happen is that the client will get an incorrect
97+-- URL. If you are relying on the approot for some security-sensitive purpose,
98+-- it is highly recommended to use @hardcoded@, which cannot be spoofed.
99+--
100+-- Since 3.0.7
101+fromRequest :: Middleware
102+fromRequest = approotMiddleware (return . guessApproot)
103+
104+data ApprootMiddlewareNotSetup = ApprootMiddlewareNotSetup
105+ deriving (Show, Typeable)
106+instance Exception ApprootMiddlewareNotSetup
107+
108+-- | Get the approot set by the middleware. If the middleware is not in use,
109+-- then this function will return an exception. For a total version of the
110+-- function, see 'getApprootMay'.
111+--
112+-- Since 3.0.7
113+getApproot :: Request -> ByteString
114+getApproot = fromMaybe (throw ApprootMiddlewareNotSetup) . getApprootMay
115+
116+-- | A total version of 'getApproot', which returns 'Nothing' if the middleware
117+-- is not in use.
118+--
119+-- Since 3.0.7
120+getApprootMay :: Request -> Maybe ByteString
121+getApprootMay req = V.lookup approotKey $ vault req
wai-extra/Network/Wai/Middleware/Autohead.hs+3−1
@@ -1,10 +1,12 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
22-- | Automatically produce responses to HEAD requests based on the underlying
33-- applications GET response.
44module Network.Wai.Middleware.Autohead (autohead) where
55
66import Network.Wai
7+#if __GLASGOW_HASKELL__ < 710
78import Data.Monoid (mempty)
9+#endif
810
911autohead :: Middleware
1012autohead app req sendResponse
wai-extra/Network/Wai/Middleware/CleanPath.hs+5−3
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
22module Network.Wai.Middleware.CleanPath
33 ( cleanPath
44 ) where
@@ -6,9 +6,11 @@ module Network.Wai.Middleware.CleanPath
66import Network.Wai
77import qualified Data.ByteString.Char8 as B
88import qualified Data.ByteString.Lazy as L
9−import Network.HTTP.Types (status301)
9+import Network.HTTP.Types (status301, hLocation)
1010import Data.Text (Text)
11+#if __GLASGOW_HASKELL__ < 710
1112import Data.Monoid (mconcat)
13+#endif
1214
1315cleanPath :: ([Text] -> Either B.ByteString [Text])
1416 -> B.ByteString
@@ -19,7 +21,7 @@ cleanPath splitter prefix app env sendResponse =
1921 Right pieces -> app pieces env sendResponse
2022 Left p -> sendResponse
2123 $ responseLBS status301
22− [("Location", mconcat [prefix, p, suffix])]
24+ [(hLocation, mconcat [prefix, p, suffix])]
2325 $ L.empty
2426 where
2527 -- include the query string if present
wai-extra/Network/Wai/Middleware/ForceDomain.hsnew file+38
@@ -0,0 +1,38 @@
1+-- |
2+--
3+-- @since 3.0.14
4+module Network.Wai.Middleware.ForceDomain where
5+
6+import Data.ByteString (ByteString)
7+import Data.Monoid ((<>), mempty)
8+import Network.HTTP.Types (hLocation, methodGet, status301, status307)
9+import Prelude
10+
11+import Network.Wai
12+import Network.Wai.Request
13+
14+-- | Force a domain by redirecting.
15+-- The `checkDomain` function takes the current domain and checks whether it is correct.
16+-- It should return `Nothing` if the domain is correct, or `Just "domain.com"` if it is incorrect.
17+--
18+-- @since 3.0.14
19+forceDomain :: (ByteString -> Maybe ByteString) -> Middleware
20+forceDomain checkDomain app req sendResponse =
21+ case requestHeaderHost req >>= checkDomain of
22+ Nothing ->
23+ app req sendResponse
24+ Just domain ->
25+ sendResponse $ redirectResponse domain
26+
27+ where
28+ -- From: Network.Wai.Middleware.ForceSSL
29+ redirectResponse domain =
30+ responseBuilder status [(hLocation, location domain)] mempty
31+
32+ location h =
33+ let p = if appearsSecure req then "https://" else "http://" in
34+ p <> h <> rawPathInfo req <> rawQueryString req
35+
36+ status
37+ | requestMethod req == methodGet = status301
38+ | otherwise = status307
wai-extra/Network/Wai/Middleware/ForceSSL.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE CPP #-}
2+-- | Redirect non-SSL requests to https
3+--
4+-- Since 3.0.7
5+module Network.Wai.Middleware.ForceSSL
6+ ( forceSSL
7+ ) where
8+
9+import Network.Wai
10+import Network.Wai.Request
11+
12+#if __GLASGOW_HASKELL__ < 710
13+import Control.Applicative ((<$>))
14+import Data.Monoid (mempty)
15+#endif
16+
17+import Data.Monoid ((<>))
18+import Network.HTTP.Types (hLocation, methodGet, status301, status307)
19+
20+-- | For requests that don't appear secure, redirect to https
21+--
22+-- Since 3.0.7
23+forceSSL :: Middleware
24+forceSSL app req sendResponse =
25+ case (appearsSecure req, redirectResponse req) of
26+ (False, Just resp) -> sendResponse resp
27+ _ -> app req sendResponse
28+
29+redirectResponse :: Request -> Maybe Response
30+redirectResponse req = do
31+ host <- requestHeaderHost req
32+ return $ responseBuilder status [(hLocation, location host)] mempty
33+ where
34+ location h = "https://" <> h <> rawPathInfo req <> rawQueryString req
35+ status
36+ | requestMethod req == methodGet = status301
37+ | otherwise = status307
wai-extra/Network/Wai/Middleware/Gzip.hs+67−31
@@ -1,6 +1,4 @@
1−{-# LANGUAGE Rank2Types #-}
2−{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE Rank2Types, ScopedTypeVariables #-}
42---------------------------------------------------------
53-- |
64-- Module : Network.Wai.Middleware.Gzip
@@ -29,43 +27,60 @@ import Data.Maybe (fromMaybe, isJust)
2927import qualified Data.ByteString.Char8 as S8
3028import qualified Data.ByteString as S
3129import Data.Default.Class
32−import Network.HTTP.Types (Status, Header)
33−import Control.Monad.IO.Class (liftIO)
34−import Control.Monad.Trans.Resource (runResourceT)
30+import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
31+ , hContentType, hContentLength)
3532import System.Directory (doesFileExist, createDirectoryIfMissing)
36−import Blaze.ByteString.Builder (fromByteString)
33+import Data.ByteString.Builder (byteString)
34+import qualified Data.ByteString.Builder.Extra as Blaze (flush)
3735import Control.Exception (try, SomeException)
3836import qualified Data.Set as Set
37+import Network.Wai.Header
3938import Network.Wai.Internal
40−import qualified Data.Streaming.Blaze as B
39+import qualified Data.Streaming.ByteString.Builder as B
4140import qualified Data.Streaming.Zlib as Z
42−import qualified Blaze.ByteString.Builder as Blaze
4341import Control.Monad (unless)
4442import Data.Function (fix)
4543import Control.Exception (throwIO)
4644import qualified System.IO as IO
4745import Data.ByteString.Lazy.Internal (defaultChunkSize)
46+import Data.Word8 (_semicolon)
4847
4948data GzipSettings = GzipSettings
5049 { gzipFiles :: GzipFiles
5150 , gzipCheckMime :: S.ByteString -> Bool
5251 }
5352
54−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
5565 deriving (Show, Eq, Read)
5666
67+-- | Use default MIME settings; /do not/ compress files.
5768instance Default GzipSettings where
5869 def = GzipSettings GzipIgnore defaultCheckMime
5970
71+-- | MIME types that will be compressed by default:
72+-- @text/@ @*@, @application/json@, @application/javascript@,
73+-- @application/ecmascript@, @image/x-icon@.
6074defaultCheckMime :: S.ByteString -> Bool
6175defaultCheckMime bs =
6276 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
6377 where
64− bs' = fst $ S.breakByte 59 bs -- semicolon
78+ bs' = fst $ S.break (== _semicolon) bs
6579 toCompress = Set.fromList
6680 [ "application/json"
6781 , "application/javascript"
6882 , "application/ecmascript"
83+ , "image/x-icon"
6984 ]
7085
7186-- | Use gzip to compress the body of the response.
@@ -73,30 +88,51 @@ defaultCheckMime bs =
7388-- Analyzes the \"Accept-Encoding\" header from the client to determine
7489-- if gzip is supported.
7590--
76−-- Possible future enhancements:
91+-- File responses will be compressed according to the 'GzipFiles' setting.
7792--
78−-- * 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'.
7995gzip :: GzipSettings -> Middleware
8096gzip set app env sendResponse = app env $ \res ->
8197 case res of
8298 ResponseRaw{} -> sendResponse res
8399 ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
84− _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res)
100+ _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
85101 then
86− case (res, gzipFiles set) of
87− (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
88− case lookup "content-type" hs of
89− Just m
90− | gzipCheckMime set m -> compressFile s hs file cache sendResponse
91− _ -> sendResponse res
92− _ -> 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)
93119 else sendResponse res
94120 where
95121 enc = fromMaybe [] $ (splitCommas . S8.unpack)
96122 `fmap` lookup "Accept-Encoding" (requestHeaders env)
97− ua = fromMaybe "" $ lookup "user-agent" $ requestHeaders env
123+ ua = fromMaybe "" $ lookup hUserAgent $ requestHeaders env
98124 isMSIE6 = "MSIE 6" `S.isInfixOf` ua
99− isEncoded res = isJust $ lookup "Content-Encoding" $ responseHeaders res
125+ isEncoded res = isJust $ lookup hContentEncoding $ responseHeaders res
126+
127+ bigEnough rsp = case contentLength (responseHeaders rsp) of
128+ Nothing -> True -- This could be a streaming case
129+ Just len -> len >= minimumLength
130+
131+ -- For a small enough response, gzipping will actually increase the size
132+ -- Potentially for anything less than 860 bytes gzipping could be a net loss
133+ -- The actual number is application specific though and may need to be adjusted
134+ -- http://webmasters.stackexchange.com/questions/31750/what-is-recommended-minimum-object-size-for-gzip-performance-benefits
135+ minimumLength = 860
100136
101137compressFile :: Status -> [Header] -> FilePath -> FilePath -> (Response -> IO a) -> IO a
102138compressFile s hs file cache sendResponse = do
@@ -118,7 +154,7 @@ compressFile s hs file cache sendResponse = do
118154 Z.PRNext bs -> do
119155 S.hPut outH bs
120156 loop
121− Z.PRError e -> throwIO e
157+ Z.PRError ex -> throwIO ex
122158 fix $ \loop -> do
123159 bs <- S.hGetSome inH defaultChunkSize
124160 unless (S.null bs) $ do
@@ -145,11 +181,11 @@ compressE :: GzipSettings
145181 -> (Response -> IO a)
146182 -> IO a
147183compressE set res sendResponse =
148− case lookup "content-type" hs of
184+ case lookup hContentType hs of
149185 Just m | gzipCheckMime set m ->
150186 let hs' = fixHeaders hs
151187 in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
152− (blazeRecv, blazeFinish) <- B.newBlazeRecv B.defaultStrategy
188+ (blazeRecv, _) <- B.newBuilderRecv B.defaultStrategy
153189 deflate <- Z.initDeflate 1 (Z.WindowBits 31)
154190 let sendBuilder builder = do
155191 popper <- blazeRecv builder
@@ -164,11 +200,11 @@ compressE set res sendResponse =
164200 deflatePopper $ Z.flushDeflate deflate
165201 flush
166202 deflatePopper popper = fix $ \loop -> do
167− res <- popper
168− case res of
203+ result <- popper
204+ case result of
169205 Z.PRDone -> return ()
170206 Z.PRNext bs' -> do
171− sendChunk $ fromByteString bs'
207+ sendChunk $ byteString bs'
172208 loop
173209 Z.PRError e -> throwIO e
174210
@@ -183,9 +219,9 @@ compressE set res sendResponse =
183219-- different length after gzip compression.
184220fixHeaders :: [Header] -> [Header]
185221fixHeaders =
186− (("Content-Encoding", "gzip") :) . filter notLength
222+ ((hContentEncoding, "gzip") :) . filter notLength
187223 where
188− notLength (x, _) = x /= "content-length"
224+ notLength (x, _) = x /= hContentLength
189225
190226splitCommas :: String -> [String]
191227splitCommas [] = []
wai-extra/Network/Wai/Middleware/HttpAuth.hs+65−30
@@ -1,23 +1,32 @@
1−{-# LANGUAGE RecordWildCards, OverloadedStrings #-}
1+{-# LANGUAGE RecordWildCards, TupleSections, CPP #-}
22-- | Implements HTTP Basic Authentication.
33--
44-- This module may add digest authentication in the future.
55module Network.Wai.Middleware.HttpAuth
6− ( basicAuth
6+ ( -- * Middleware
7+ basicAuth
8+ , basicAuth'
79 , CheckCreds
810 , AuthSettings
911 , authRealm
1012 , authOnNoAuth
1113 , authIsProtected
14+ -- * Helping functions
15+ , extractBasicAuth
16+ , extractBearerAuth
1217 ) where
13−
14−import Network.Wai
15−import Network.HTTP.Types (status401)
18+#if __GLASGOW_HASKELL__ < 710
19+import Control.Applicative
20+#endif
1621import Data.ByteString (ByteString)
17−import qualified Data.ByteString as S
22+import Data.ByteString.Base64 (decodeLenient)
1823import Data.String (IsString (..))
1924import Data.Word8 (isSpace, _colon, toLower)
20−import Data.ByteString.Base64 (decodeLenient)
25+import Network.HTTP.Types (status401, hContentType, hAuthorization)
26+import Network.Wai
27+
28+import qualified Data.ByteString as S
29+
2130
2231-- | Check if a given username and password is valid.
2332type CheckCreds = ByteString
@@ -28,11 +37,19 @@ type CheckCreds = ByteString
2837--
2938-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
3039--
31−-- Since 1.3.4
40+-- @since 1.3.4
3241basicAuth :: CheckCreds
3342 -> AuthSettings
3443 -> Middleware
35−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
3653 isProtected <- authIsProtected req
3754 allowed <- if isProtected then check else return True
3855 if allowed
@@ -40,44 +57,35 @@ basicAuth checkCreds AuthSettings {..} app req sendResponse = do
4057 else authOnNoAuth authRealm req sendResponse
4158 where
4259 check =
43− case lookup "Authorization" $ requestHeaders req of
60+ case (lookup hAuthorization $ requestHeaders req)
61+ >>= extractBasicAuth of
4462 Nothing -> return False
45− Just bs ->
46− let (x, y) = S.break isSpace bs
47− in if S.map toLower x == "basic"
48− then checkB64 $ S.dropWhile isSpace y
49− else return False
50− checkB64 encoded =
51− case S.uncons password' of
52− Just (_, password) -> checkCreds username password
53− Nothing -> return False
54− where
55− raw = decodeLenient encoded
56− (username, password') = S.breakByte _colon raw
63+ Just (username, password) -> checkCreds req username password
5764
58−-- | Authentication settings. This value is an instance of @IsString@, so the
59−-- recommended approach to create a value is to provide a string literal (which
60−-- will be the realm) and then overriding individual fields.
65+-- | Basic authentication settings. This value is an instance of
66+-- @IsString@, so the recommended approach to create a value is to
67+-- provide a string literal (which will be the realm) and then
68+-- overriding individual fields.
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
@@ -85,7 +93,7 @@ instance IsString AuthSettings where
8593 { authRealm = fromString s
8694 , authOnNoAuth = \realm _req f -> f $ responseLBS
8795 status401
88− [ ("Content-Type", "text/plain")
96+ [ (hContentType, "text/plain")
8997 , ("WWW-Authenticate", S.concat
9098 [ "Basic realm=\""
9199 , realm
@@ -95,3 +103,30 @@ instance IsString AuthSettings where
95103 "Basic authentication is required"
96104 , authIsProtected = const $ return True
97105 }
106+
107+-- | Extract basic authentication data from usually __Authorization__
108+-- header value. Returns username and password
109+--
110+-- @since 3.0.5
111+extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
112+extractBasicAuth bs =
113+ let (x, y) = S.break isSpace bs
114+ in if S.map toLower x == "basic"
115+ then extract $ S.dropWhile isSpace y
116+ else Nothing
117+ where
118+ extract encoded =
119+ let raw = decodeLenient encoded
120+ (username, password') = S.break (== _colon) raw
121+ in ((username,) . snd) <$> S.uncons password'
122+
123+-- | Extract bearer authentication data from __Authorization__ header
124+-- value. Returns bearer token
125+--
126+-- @since 3.0.5
127+extractBearerAuth :: ByteString -> Maybe ByteString
128+extractBearerAuth bs =
129+ let (x, y) = S.break isSpace bs
130+ in if S.map toLower x == "bearer"
131+ then Just $ S.dropWhile isSpace y
132+ else Nothing
wai-extra/Network/Wai/Middleware/Jsonp.hs+16−16
@@ -1,5 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE RankNTypes #-}
1+{-# LANGUAGE RankNTypes, CPP #-}
32---------------------------------------------------------
43-- |
54-- Module : Network.Wai.Middleware.Jsonp
@@ -19,14 +18,15 @@ import Network.Wai
1918import Network.Wai.Internal
2019import Data.ByteString (ByteString)
2120import qualified Data.ByteString.Char8 as B8
22−import Blaze.ByteString.Builder (Builder, copyByteString)
23−import Blaze.ByteString.Builder.Char8 (fromChar)
21+import Data.ByteString.Builder.Extra (byteStringCopy)
22+import Data.ByteString.Builder (char7)
23+#if __GLASGOW_HASKELL__ < 710
2424import Data.Monoid (mappend)
25+#endif
2526import Control.Monad (join)
2627import Data.Maybe (fromMaybe)
2728import qualified Data.ByteString as S
28−import Data.CaseInsensitive (CI)
29−import Network.HTTP.Types (Status)
29+import Network.HTTP.Types (hAccept, hContentType)
3030
3131-- | Wrap json responses in a jsonp callback.
3232--
@@ -37,7 +37,7 @@ import Network.HTTP.Types (Status)
3737-- callback function.
3838jsonp :: Middleware
3939jsonp app env sendResponse = do
40− let accept = fromMaybe B8.empty $ lookup "Accept" $ requestHeaders env
40+ let accept = fromMaybe B8.empty $ lookup hAccept $ requestHeaders env
4141 let callback :: Maybe B8.ByteString
4242 callback =
4343 if B8.pack "text/javascript" `B8.isInfixOf` accept
@@ -47,7 +47,7 @@ jsonp app env sendResponse = do
4747 case callback of
4848 Nothing -> env
4949 Just _ -> env
50− { requestHeaders = changeVal "Accept"
50+ { requestHeaders = changeVal hAccept
5151 "application/json"
5252 $ requestHeaders env
5353 }
@@ -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
@@ -72,18 +72,18 @@ jsonp app env sendResponse = do
7272 (s, hs, wb) = responseToStream r
7373
7474 checkJSON hs =
75− case lookup "Content-Type" hs of
75+ case lookup hContentType hs of
7676 Just x
7777 | B8.pack "application/json" `S.isPrefixOf` x ->
7878 Just $ fixHeaders hs
7979 _ -> Nothing
80− fixHeaders = changeVal "Content-Type" "text/javascript"
80+ fixHeaders = changeVal hContentType "text/javascript"
8181
8282 addCallback cb s hs wb =
8383 wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
84− sendChunk $ copyByteString cb `mappend` fromChar '('
85− body sendChunk flush
86− sendChunk $ fromChar ')'
84+ sendChunk $ byteStringCopy cb `mappend` char7 '('
85+ _ <- body sendChunk flush
86+ sendChunk $ char7 ')'
8787
8888changeVal :: Eq a
8989 => a
wai-extra/Network/Wai/Middleware/Local.hs+1−1
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings, CPP #-}
1+{-# LANGUAGE CPP #-}
22-- | Only allow local connections.
33--
44module Network.Wai.Middleware.Local
wai-extra/Network/Wai/Middleware/MethodOverride.hs+4−6
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
21module Network.Wai.Middleware.MethodOverride
32 ( methodOverride
43 ) where
@@ -6,12 +5,11 @@ module Network.Wai.Middleware.MethodOverride
65import Network.Wai
76import Control.Monad (join)
87
9−-- | Allows overriding of the HTTP request method via the _method query string
10−-- parameter.
8+-- | Overriding of HTTP request method via `_method` query string parameter.
119--
12−-- This middleware only applies when the initial request method is POST. This
13−-- allow submitting of normal HTML forms, without worries of semantics
14−-- 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.
1513methodOverride :: Middleware
1614methodOverride app req =
1715 app req'
wai-extra/Network/Wai/Middleware/MethodOverridePost.hs+6−3
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE CPP #-}
22-----------------------------------------------------------------
33-- | Module : Network.Wai.Middleware.MethodOverridePost
44--
@@ -9,8 +9,11 @@ module Network.Wai.Middleware.MethodOverridePost
99 ) where
1010
1111import Network.Wai
12−import Network.HTTP.Types (parseQuery)
12+import Network.HTTP.Types (parseQuery, hContentType)
13+
14+#if __GLASGOW_HASKELL__ < 710
1315import Data.Monoid (mconcat, mempty)
16+#endif
1417import Data.IORef
1518import Data.ByteString.Lazy (toChunks)
1619
@@ -27,7 +30,7 @@ import Data.ByteString.Lazy (toChunks)
2730--
2831methodOverridePost :: Middleware
2932methodOverridePost app req send =
30− case (requestMethod req, lookup "Content-Type" (requestHeaders req)) of
33+ case (requestMethod req, lookup hContentType (requestHeaders req)) of
3134 ("POST", Just "application/x-www-form-urlencoded") -> setPost req >>= flip app send
3235 _ -> app req send
3336
wai-extra/Network/Wai/Middleware/RequestLogger.hs+162−75
@@ -1,6 +1,4 @@
1−{-# LANGUAGE OverloadedStrings #-}
21{-# LANGUAGE RecordWildCards #-}
3−
42-- NOTE: Due to https://github.com/yesodweb/wai/issues/192, this module should
53-- not use CPP.
64module Network.Wai.Middleware.RequestLogger
@@ -15,48 +13,91 @@ module Network.Wai.Middleware.RequestLogger
1513 , destination
1614 , OutputFormat (..)
1715 , OutputFormatter
16+ , OutputFormatterWithDetails
17+ , OutputFormatterWithDetailsAndHeaders
1818 , Destination (..)
1919 , Callback
2020 , IPAddrSource (..)
2121 ) where
2222
23−import System.IO (Handle, stdout)
23+import System.IO (Handle, hFlush, stdout)
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)
27+import Control.Monad (when)
2628import Control.Monad.IO.Class (liftIO)
27−import Network.Wai (Request(..), Middleware, responseStatus, Response, responseHeaders)
29+import Network.Wai
30+ ( Request(..), requestBodyLength, RequestBodyLength(..)
31+ , Middleware
32+ , Response, responseStatus, responseHeaders
33+ )
2834import System.Log.FastLogger
2935import Network.HTTP.Types as H
3036import Data.Maybe (fromMaybe)
3137import Data.Monoid (mconcat, (<>))
32−import Data.Time (getCurrentTime, diffUTCTime)
33−
34−import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File, getRequestBodyType)
38+import Data.Time (getCurrentTime, diffUTCTime, NominalDiffTime)
39+import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File
40+ , getRequestBodyType)
3541import qualified Data.ByteString.Lazy as LBS
3642import qualified Data.ByteString.Char8 as S8
37−
3843import System.Console.ANSI
39−import Data.IORef.Lifted
44+import Data.IORef
4045import System.IO.Unsafe
41−import Control.Monad (unless)
42−import Network.Wai.Internal (Response (ResponseRaw))
43−
46+import Network.Wai.Internal (Response (..))
4447import Data.Default.Class (Default (def))
4548import Network.Wai.Logger
4649import Network.Wai.Middleware.RequestLogger.Internal
50+import Network.Wai.Header (contentLength)
51+import Data.Text.Encoding (decodeUtf8')
4752
48−data OutputFormat = Apache IPAddrSource
49− | Detailed Bool -- ^ use colors?
50− | CustomOutputFormat OutputFormatter
53+data OutputFormat
54+ = Apache IPAddrSource
55+ | Detailed Bool -- ^ use colors?
56+ | CustomOutputFormat OutputFormatter
57+ | CustomOutputFormatWithDetails OutputFormatterWithDetails
58+ | CustomOutputFormatWithDetailsAndHeaders OutputFormatterWithDetailsAndHeaders
5159
5260type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> LogStr
5361
62+type OutputFormatterWithDetails
63+ = ZonedDate
64+ -> Request
65+ -> Status
66+ -> Maybe Integer
67+ -> NominalDiffTime
68+ -> [S8.ByteString]
69+ -> B.Builder
70+ -> LogStr
71+
72+-- | Same as @OutputFormatterWithDetails@ but with response headers included
73+--
74+-- This is useful if you wish to include arbitrary application data in your
75+-- logs, e.g., an authenticated user ID, which you would set in a response
76+-- header in your application and retrieve in the log formatter.
77+--
78+-- @since 3.0.27
79+type OutputFormatterWithDetailsAndHeaders
80+ = ZonedDate -- ^ When the log message was generated
81+ -> Request -- ^ The WAI request
82+ -> Status -- ^ HTTP status code
83+ -> Maybe Integer -- ^ Response size
84+ -> NominalDiffTime -- ^ Duration of the request
85+ -> [S8.ByteString] -- ^ The request body
86+ -> B.Builder -- ^ Raw response
87+ -> [Header] -- ^ The response headers
88+ -> LogStr
89+
5490data Destination = Handle Handle
5591 | Logger LoggerSet
5692 | Callback Callback
5793
5894type Callback = LogStr -> IO ()
5995
96+-- | @RequestLoggerSettings@ is an instance of Default. See <https://hackage.haskell.org/package/data-default Data.Default> for more information.
97+--
98+-- @outputFormat@, @autoFlush@, and @destination@ are record fields
99+-- for the record type @RequestLoggerSettings@, so they can be used to
100+-- modify settings values using record syntax.
60101data RequestLoggerSettings = RequestLoggerSettings
61102 {
62103 -- | Default value: @Detailed@ @True@.
@@ -80,48 +121,85 @@ mkRequestLogger :: RequestLoggerSettings -> IO Middleware
80121mkRequestLogger RequestLoggerSettings{..} = do
81122 let (callback, flusher) =
82123 case destination of
83− Handle h -> (BS.hPutStr h . logToByteString, return ())
84− Logger l -> (pushLogStr l, flushLogStr l)
124+ Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
125+ Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
85126 Callback c -> (c, return ())
127+ callbackAndFlush str = callback str >> flusher
86128 case outputFormat of
87129 Apache ipsrc -> do
88130 getdate <- getDateGetter flusher
89− apache <- initLogger ipsrc (LogCallback callback (return ())) getdate
131+ apache <- initLogger ipsrc (LogCallback callback flusher) getdate
90132 return $ apacheMiddleware apache
91− Detailed useColors -> detailedMiddleware
92− (\str -> callback str >> flusher)
93− useColors
133+ Detailed useColors -> detailedMiddleware callbackAndFlush useColors
94134 CustomOutputFormat formatter -> do
135+ getDate <- getDateGetter flusher
136+ return $ customMiddleware callbackAndFlush getDate formatter
137+ CustomOutputFormatWithDetails formatter -> do
138+ getdate <- getDateGetter flusher
139+ return $ customMiddlewareWithDetails callbackAndFlush getdate formatter
140+ CustomOutputFormatWithDetailsAndHeaders formatter -> do
95141 getdate <- getDateGetter flusher
96− return $ customMiddleware callback getdate formatter
142+ return $ customMiddlewareWithDetailsAndHeaders callbackAndFlush getdate formatter
97143
98144apacheMiddleware :: ApacheLoggerActions -> Middleware
99145apacheMiddleware ala app req sendResponse = app req $ \res -> do
100− let msize = lookup "content-length" (responseHeaders res) >>= readInt'
101− readInt' bs =
102− case S8.readInteger bs of
103− Just (i, "") -> Just i
104− _ -> Nothing
146+ let msize = contentLength (responseHeaders res)
105147 apacheLogger ala req (responseStatus res) msize
106148 sendResponse res
107149
108150customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
109151customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
110152 date <- liftIO getdate
111− -- We use Nothing for the response size since we generally don't know it
112− liftIO $ cb $ formatter date req (responseStatus res) Nothing
153+ let msize = contentLength (responseHeaders res)
154+ liftIO $ cb $ formatter date req (responseStatus res) msize
113155 sendResponse res
114156
157+customMiddlewareWithDetails :: Callback -> IO ZonedDate -> OutputFormatterWithDetails -> Middleware
158+customMiddlewareWithDetails cb getdate formatter app req sendResponse = do
159+ (req', reqBody) <- getRequestBody req
160+ t0 <- getCurrentTime
161+ app req' $ \res -> do
162+ t1 <- getCurrentTime
163+ date <- liftIO getdate
164+ let msize = contentLength (responseHeaders res)
165+ builderIO <- newIORef $ B.byteString ""
166+ res' <- recordChunks builderIO res
167+ rspRcv <- sendResponse res'
168+ _ <- liftIO . cb .
169+ formatter date req' (responseStatus res') msize (t1 `diffUTCTime` t0) reqBody =<<
170+ readIORef builderIO
171+ return rspRcv
172+
173+customMiddlewareWithDetailsAndHeaders :: Callback -> IO ZonedDate -> OutputFormatterWithDetailsAndHeaders -> Middleware
174+customMiddlewareWithDetailsAndHeaders cb getdate formatter app req sendResponse = do
175+ (req', reqBody) <- getRequestBody req
176+ t0 <- getCurrentTime
177+ app req' $ \res -> do
178+ t1 <- getCurrentTime
179+ date <- liftIO getdate
180+ let msize = contentLength (responseHeaders res)
181+ builderIO <- newIORef $ B.byteString ""
182+ res' <- recordChunks builderIO res
183+ rspRcv <- sendResponse res'
184+ _ <- do
185+ rawResponse <- readIORef builderIO
186+ let status = responseStatus res'
187+ duration = t1 `diffUTCTime` t0
188+ resHeaders = responseHeaders res'
189+ liftIO . cb $ formatter date req' status msize duration reqBody rawResponse resHeaders
190+ return rspRcv
115191-- | Production request logger middleware.
116−-- Implemented on top of "logCallback", but prints to 'stdout'
192+--
193+-- This uses the 'Apache' logging format, and takes IP addresses for clients from
194+-- the socket (see 'IPAddrSource' for more information). It logs to 'stdout'.
195+{-# NOINLINE logStdout #-}
117196logStdout :: Middleware
118197logStdout = unsafePerformIO $ mkRequestLogger def { outputFormat = Apache FromSocket }
119198
120199-- | Development request logger middleware.
121−-- Implemented on top of "logCallbackDev", but prints to 'stdout'
122200--
123−-- Flushes 'stdout' on each request, which would be inefficient in production use.
124−-- Use "logStdout" in production.
201+-- This uses the 'Detailed' 'True' logging format and logs to 'stdout'.
202+{-# NOINLINE logStdoutDev #-}
125203logStdoutDev :: Middleware
126204logStdoutDev = unsafePerformIO $ mkRequestLogger def
127205
@@ -181,60 +259,68 @@ ansiStatusCode' c t = case S8.take 1 c of
181259 "5" -> ansiColor' Magenta t
182260 _ -> ansiColor' Blue t
183261
262+recordChunks :: IORef B.Builder -> Response -> IO Response
263+recordChunks i (ResponseStream s h sb) =
264+ return . ResponseStream s h $ (\send flush -> sb (\b -> modifyIORef i (<> b) >> send b) flush)
265+recordChunks i (ResponseBuilder s h b) =
266+ modifyIORef i (<> b) >> (return $ ResponseBuilder s h b)
267+recordChunks _ r =
268+ return r
269+
270+getRequestBody :: Request -> IO (Request, [S8.ByteString])
271+getRequestBody req = do
272+ let loop front = do
273+ bs <- requestBody req
274+ if S8.null bs
275+ then return $ front []
276+ else loop $ front . (bs:)
277+ body <- loop id
278+ -- logging the body here consumes it, so fill it back up
279+ -- obviously not efficient, but this is the development logger
280+ --
281+ -- Note: previously, we simply used CL.sourceList. However,
282+ -- that meant that you could read the request body in twice.
283+ -- While that in itself is not a problem, the issue is that,
284+ -- in production, you wouldn't be able to do this, and
285+ -- therefore some bugs wouldn't show up during testing. This
286+ -- implementation ensures that each chunk is only returned
287+ -- once.
288+ ichunks <- newIORef body
289+ let rbody = atomicModifyIORef ichunks $ \chunks ->
290+ case chunks of
291+ [] -> ([], S8.empty)
292+ x:y -> (y, x)
293+ let req' = req { requestBody = rbody }
294+ return (req', body)
295+
184296detailedMiddleware' :: Callback
185297 -> (Color -> BS.ByteString -> [BS.ByteString])
186298 -> (BS.ByteString -> [BS.ByteString])
187299 -> (BS.ByteString -> BS.ByteString -> [BS.ByteString])
188300 -> Middleware
189301detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode app req sendResponse = do
190− let mlen = lookup "content-length" (requestHeaders req) >>= readInt
191302 (req', body) <-
192− case mlen of
303+ -- second tuple item should not be necessary, but a test runner might mess it up
304+ case (requestBodyLength req, contentLength (requestHeaders req)) of
193305 -- log the request body if it is small
194− Just len | len <= 2048 -> do
195− let loop front = do
196− bs <- requestBody req
197− if S8.null bs
198− then return $ front []
199− else loop $ front . (bs:)
200− body <- loop id
201− -- logging the body here consumes it, so fill it back up
202− -- obviously not efficient, but this is the development logger
203− --
204− -- Note: previously, we simply used CL.sourceList. However,
205− -- that meant that you could read the request body in twice.
206− -- While that in itself is not a problem, the issue is that,
207− -- in production, you wouldn't be able to do this, and
208− -- therefore some bugs wouldn't show up during testing. This
209− -- implementation ensures that each chunk is only returned
210− -- once.
211− ichunks <- newIORef body
212− let rbody = atomicModifyIORef ichunks $ \chunks ->
213− case chunks of
214− [] -> ([], S8.empty)
215− x:y -> (y, x)
216− let req' = req { requestBody = rbody }
217− return (req', body)
306+ (KnownLength len, _) | len <= 2048 -> getRequestBody req
307+ (_, Just len) | len <= 2048 -> getRequestBody req
218308 _ -> return (req, [])
219309
310+ let reqbodylog _ = if null body then [""] else ansiColor White " Request Body: " <> body <> ["\n"]
311+ reqbody = concatMap (either (const [""]) reqbodylog . decodeUtf8') body
220312 postParams <- if requestMethod req `elem` ["GET", "HEAD"]
221313 then return []
222314 else do postParams <- liftIO $ allPostParams body
223315 return $ collectPostParams postParams
224316
225317 let getParams = map emptyGetParam $ queryString req
226− accept = fromMaybe "" $ lookup "Accept" $ requestHeaders req
318+ accept = fromMaybe "" $ lookup H.hAccept $ requestHeaders req
227319 params = let par | not $ null postParams = [pack (show postParams)]
228320 | not $ null getParams = [pack (show getParams)]
229321 | otherwise = []
230322 in if null par then [""] else ansiColor White " Params: " <> par <> ["\n"]
231323
232− -- log the request immediately.
233− liftIO $ cb $ mconcat $ map toLogStr $
234− ansiMethod (requestMethod req) ++ [" ", rawPathInfo req, "\n"] ++
235− params ++
236− ansiColor White " Accept: " ++ [accept, "\n"]
237−
238324 t0 <- getCurrentTime
239325 app req' $ \rsp -> do
240326 let isRaw =
@@ -246,10 +332,14 @@ detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode app req sendResponse
246332 t1 <- getCurrentTime
247333
248334 -- log the status of the response
249− unless isRaw $ cb $ mconcat $ map toLogStr $
250− ansiColor White " Status: " ++
251− ansiStatusCode stCode (stCode <> " " <> stMsg) ++
252− [" ", pack $ show $ diffUTCTime t1 t0, "\n"]
335+ cb $ mconcat $ map toLogStr $
336+ ansiMethod (requestMethod req) ++ [" ", rawPathInfo req, "\n"] ++
337+ params ++ reqbody ++
338+ ansiColor White " Accept: " ++ [accept, "\n"] ++
339+ if isRaw then [] else
340+ ansiColor White " Status: " ++
341+ ansiStatusCode stCode (stCode <> " " <> stMsg) ++
342+ [" ", pack $ show $ diffUTCTime t1 t0, "\n"]
253343
254344 sendResponse rsp
255345 where
@@ -272,10 +362,7 @@ detailedMiddleware' cb ansiColor ansiMethod ansiStatusCode app req sendResponse
272362 collectPostParams (postParams, files) = postParams ++
273363 map (\(k,v) -> (k, "FILE: " <> fileName v)) files
274364
275− readInt bs =
276− case reads $ unpack bs of
277− (i, _):_ -> Just (i :: Int)
278− [] -> Nothing
365+
279366
280367statusBS :: Response -> BS.ByteString
281368statusBS = pack . show . statusCode . responseStatus
wai-extra/Network/Wai/Middleware/RequestLogger/Internal.hs+6−2
@@ -8,9 +8,10 @@ module Network.Wai.Middleware.RequestLogger.Internal
88
99import Data.ByteString (ByteString)
1010import Network.Wai.Logger (clockDateCacher)
11+#if !MIN_VERSION_wai_logger(2, 2, 0)
1112import Control.Concurrent (forkIO, threadDelay)
1213import Control.Monad (forever)
13−
14+#endif
1415import System.Log.FastLogger (LogStr, fromLogStr)
1516
1617logToByteString :: LogStr -> ByteString
@@ -18,12 +19,15 @@ logToByteString = fromLogStr
1819
1920getDateGetter :: IO () -- ^ flusher
2021 -> IO (IO ByteString)
22+#if !MIN_VERSION_wai_logger(2, 2, 0)
2123getDateGetter flusher = do
2224 (getter, updater) <- clockDateCacher
23−#if !MIN_VERSION_wai_logger(2, 2, 0)
2425 _ <- forkIO $ forever $ do
2526 threadDelay 1000000
2627 updater
2728 flusher
29+#else
30+getDateGetter _ = do
31+ (getter, _) <- clockDateCacher
2832#endif
2933 return getter
wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hsnew file+137
@@ -0,0 +1,137 @@
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE CPP #-}
3+
4+module Network.Wai.Middleware.RequestLogger.JSON
5+ ( formatAsJSON
6+ , formatAsJSONWithHeaders
7+ ) where
8+
9+import qualified Data.ByteString.Builder as BB (toLazyByteString)
10+import Data.ByteString.Lazy (toStrict)
11+import Data.Aeson
12+import Data.CaseInsensitive (original)
13+import Data.Monoid ((<>))
14+import qualified Data.ByteString.Char8 as S8
15+import Data.IP
16+import qualified Data.Text as T
17+import Data.Text (Text)
18+import Data.Text.Encoding (decodeUtf8With)
19+import Data.Text.Encoding.Error (lenientDecode)
20+import Data.Time (NominalDiffTime)
21+import Data.Word (Word32)
22+import Network.HTTP.Types as H
23+import Network.Socket (SockAddr (..), PortNumber)
24+import Network.Wai
25+import Network.Wai.Middleware.RequestLogger
26+import System.Log.FastLogger (toLogStr)
27+import Text.Printf (printf)
28+
29+formatAsJSON :: OutputFormatterWithDetails
30+formatAsJSON date req status responseSize duration reqBody response =
31+ toLogStr (encode $
32+ object
33+ [ "request" .= requestToJSON duration req reqBody
34+ , "response" .=
35+ object
36+ [ "status" .= statusCode status
37+ , "size" .= responseSize
38+ , "body" .=
39+ if statusCode status >= 400
40+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ response
41+ else Nothing
42+ ]
43+ , "time" .= decodeUtf8With lenientDecode date
44+ ]) <> "\n"
45+
46+-- | Same as @formatAsJSON@ but with response headers included
47+--
48+-- This is useful for passing arbitrary data from your application out to the
49+-- WAI layer for it to be logged, but you may need to be careful to
50+-- subsequently redact any headers which may contain sensitive data.
51+--
52+-- @since 3.0.27
53+formatAsJSONWithHeaders :: OutputFormatterWithDetailsAndHeaders
54+formatAsJSONWithHeaders date req status resSize duration reqBody res resHeaders =
55+ toLogStr (encode $
56+ object
57+ [ "request" .= requestToJSON duration req reqBody
58+ , "response" .= object
59+ [ "status" .= statusCode status
60+ , "size" .= resSize
61+ , "headers" .= responseHeadersToJSON resHeaders
62+ , "body" .=
63+ if statusCode status >= 400
64+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ res
65+ else Nothing
66+ ]
67+ , "time" .= decodeUtf8With lenientDecode date
68+ ]) <> "\n"
69+
70+word32ToHostAddress :: Word32 -> Text
71+word32ToHostAddress = T.intercalate "." . map (T.pack . show) . fromIPv4 . fromHostAddress
72+
73+readAsDouble :: String -> Double
74+readAsDouble = read
75+
76+requestToJSON :: NominalDiffTime -> Request -> [S8.ByteString] -> Value
77+requestToJSON duration req reqBody =
78+ object
79+ [ "method" .= decodeUtf8With lenientDecode (requestMethod req)
80+ , "path" .= decodeUtf8With lenientDecode (rawPathInfo req)
81+ , "queryString" .= map queryItemToJSON (queryString req)
82+ , "durationMs" .= (readAsDouble . printf "%.2f" . rationalToDouble $ toRational duration * 1000)
83+ , "size" .= requestBodyLengthToJSON (requestBodyLength req)
84+ , "body" .= decodeUtf8With lenientDecode (S8.concat reqBody)
85+ , "remoteHost" .= sockToJSON (remoteHost req)
86+ , "httpVersion" .= httpVersionToJSON (httpVersion req)
87+ , "headers" .= requestHeadersToJSON (requestHeaders req)
88+ ]
89+ where
90+ rationalToDouble :: Rational -> Double
91+ rationalToDouble = fromRational
92+
93+sockToJSON :: SockAddr -> Value
94+sockToJSON (SockAddrInet pn ha) =
95+ object
96+ [ "port" .= portToJSON pn
97+ , "hostAddress" .= word32ToHostAddress ha
98+ ]
99+sockToJSON (SockAddrInet6 pn _ ha _) =
100+ object
101+ [ "port" .= portToJSON pn
102+ , "hostAddress" .= ha
103+ ]
104+sockToJSON (SockAddrUnix sock) =
105+ object [ "unix" .= sock ]
106+#if !MIN_VERSION_network(3,0,0)
107+sockToJSON (SockAddrCan i) =
108+ object [ "can" .= i ]
109+#endif
110+
111+queryItemToJSON :: QueryItem -> Value
112+queryItemToJSON (name, mValue) = toJSON (decodeUtf8With lenientDecode name, fmap (decodeUtf8With lenientDecode) mValue)
113+
114+requestHeadersToJSON :: RequestHeaders -> Value
115+requestHeadersToJSON = toJSON . map hToJ where
116+ -- Redact cookies
117+ hToJ ("Cookie", _) = toJSON ("Cookie" :: Text, "-RDCT-" :: Text)
118+ hToJ hd = headerToJSON hd
119+
120+responseHeadersToJSON :: [Header] -> Value
121+responseHeadersToJSON = toJSON . map hToJ where
122+ -- Redact cookies
123+ hToJ ("Set-Cookie", _) = toJSON ("Set-Cookie" :: Text, "-RDCT-" :: Text)
124+ hToJ hd = headerToJSON hd
125+
126+headerToJSON :: Header -> Value
127+headerToJSON (headerName, header) = toJSON (decodeUtf8With lenientDecode . original $ headerName, decodeUtf8With lenientDecode header)
128+
129+portToJSON :: PortNumber -> Value
130+portToJSON = toJSON . toInteger
131+
132+httpVersionToJSON :: HttpVersion -> Value
133+httpVersionToJSON (HttpVersion major minor) = String $ T.pack (show major) <> "." <> T.pack (show minor)
134+
135+requestBodyLengthToJSON :: RequestBodyLength -> Value
136+requestBodyLengthToJSON ChunkedBody = String "Unknown"
137+requestBodyLengthToJSON (KnownLength l) = toJSON l
wai-extra/Network/Wai/Middleware/Rewrite.hs+321−15
@@ -1,33 +1,339 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE TupleSections #-}
2+{-# LANGUAGE CPP #-}
3+
24module Network.Wai.Middleware.Rewrite
3− ( 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
440 ) where
541
642import Network.Wai
743import Control.Monad.IO.Class (liftIO)
844import Data.Text (Text)
45+import Data.Functor.Identity (Identity(..))
946import qualified Data.Text.Encoding as TE
1047import qualified Data.Text as T
1148import Network.HTTP.Types as H
1249
50+-- GHC ≤ 7.10 does not export Applicative functions from the prelude.
51+#if __GLASGOW_HASKELL__ <= 710
52+import Control.Applicative
53+#endif
1354
14−-- | rewrite based on your own conversion rules
15−rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
16−rewrite convert app req sendResponse = do
17− newPathInfo <- liftIO $ convert (pathInfo req) (requestHeaders req)
18− let rawPInfo = TE.encodeUtf8 $ T.intercalate "/" newPathInfo
19− 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.
2080
21−-- | rewrite based on your own conversion rules
22−-- 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
2399
24−-- staticConvert :: [Text] -> H.RequestHeaders -> [Text]
25−-- 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
26188-- where
27189-- piecesConvert [] = ["static", "html", "pages.html"]
28190-- 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.
29241rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
30242rewritePure convert app req =
31− let pInfo = convert (pathInfo req) (requestHeaders req)
32− rawPInfo = TE.encodeUtf8 $ T.intercalate "/" pInfo
33− 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/Routed.hsnew file+39
@@ -0,0 +1,39 @@
1+-- |
2+--
3+-- Since 3.0.9
4+module Network.Wai.Middleware.Routed
5+ ( routedMiddleware
6+ , hostedMiddleware
7+ ) where
8+
9+import Network.Wai
10+import Data.ByteString (ByteString)
11+import Data.Text (Text)
12+
13+-- | Apply a middleware based on a test of pathInfo
14+--
15+-- example:
16+--
17+-- > let corsify = routedMiddleWare ("static" `elem`) addCorsHeaders
18+--
19+-- Since 3.0.9
20+routedMiddleware :: ([Text] -> Bool) -- ^ Only use middleware if this pathInfo test returns True
21+ -> Middleware -- ^ middleware to apply the path prefix guard to
22+ -> Middleware -- ^ modified middleware
23+routedMiddleware pathCheck middle app req
24+ | pathCheck (pathInfo req) = middle app req
25+ | otherwise = app req
26+
27+-- | Only apply the middleware to certain hosts
28+--
29+-- Since 3.0.9
30+hostedMiddleware :: ByteString -- ^ Domain the middleware applies to
31+ -> Middleware -- ^ middleware to apply the path prefix guard to
32+ -> Middleware -- ^ modified middleware
33+hostedMiddleware domain middle app req
34+ | hasDomain domain req = middle app req
35+ | otherwise = app req
36+
37+hasDomain :: ByteString -> Request -> Bool
38+hasDomain domain req = maybe False (== domain) mHost
39+ where mHost = requestHeaderHost req
wai-extra/Network/Wai/Middleware/StreamFile.hs+8−4
@@ -1,5 +1,6 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
1+-- |
2+--
3+-- Since 3.0.4
34module Network.Wai.Middleware.StreamFile
45 (streamFile) where
56
@@ -7,7 +8,8 @@ import Network.Wai (responseStream)
78import Network.Wai.Internal
89import Network.Wai (Middleware, responseToStream)
910import qualified Data.ByteString.Char8 as S8
10−import System.Posix
11+import System.PosixCompat (getFileStatus, fileSize, FileOffset)
12+import Network.HTTP.Types (hContentLength)
1113
1214-- |Convert ResponseFile type responses into ResponseStream type
1315--
@@ -20,6 +22,8 @@ import System.Posix
2022-- Streaming a file will bypass a sendfile system call, and may be
2123-- useful to work around systems without working sendfile
2224-- implementations.
25+--
26+-- Since 3.0.4
2327streamFile :: Middleware
2428streamFile app env sendResponse = app env $ \res ->
2529 case res of
@@ -29,7 +33,7 @@ streamFile app env sendResponse = app env $ \res ->
2933 sendBody :: StreamingBody -> IO ResponseReceived
3034 sendBody body = do
3135 len <- getFileSize fp
32− let hs' = ("Content-Length", (S8.pack (show len))) : hs
36+ let hs' = (hContentLength, (S8.pack (show len))) : hs
3337 sendResponse $ responseStream s hs' body
3438 _ -> sendResponse res
3539
wai-extra/Network/Wai/Middleware/StripHeaders.hsnew file+45
@@ -0,0 +1,45 @@
1+-- This was written for one specific use case and then generalized.
2+
3+-- The specific use case was a JSON API with a consumer that would choke on the
4+-- "Set-Cookie" response header. The solution was to test for the API's
5+-- `pathInfo` in the Request and if it matched, filter the response headers.
6+
7+-- When using this, care should be taken not to strip out headers that are
8+-- required for correct operation of the client (eg Content-Type).
9+
10+module Network.Wai.Middleware.StripHeaders
11+ ( stripHeader
12+ , stripHeaders
13+ , stripHeaderIf
14+ , stripHeadersIf
15+ ) where
16+
17+import Network.Wai (Middleware, Request, modifyResponse, mapResponseHeaders, ifRequest)
18+import Network.Wai.Internal (Response)
19+import Data.ByteString (ByteString)
20+
21+import qualified Data.CaseInsensitive as CI
22+
23+stripHeader :: ByteString -> (Response -> Response)
24+stripHeader h = mapResponseHeaders (filter (\ hdr -> fst hdr /= CI.mk h))
25+
26+stripHeaders :: [ByteString] -> (Response -> Response)
27+stripHeaders hs =
28+ let hnames = map CI.mk hs
29+ in mapResponseHeaders (filter (\ hdr -> fst hdr `notElem` hnames))
30+
31+-- | If the request satisifes the provided predicate, strip headers matching
32+-- the provided header name.
33+--
34+-- Since 3.0.8
35+stripHeaderIf :: ByteString -> (Request -> Bool) -> Middleware
36+stripHeaderIf h rpred =
37+ ifRequest rpred (modifyResponse $ stripHeader h)
38+
39+-- | If the request satisifes the provided predicate, strip all headers whose
40+-- header name is in the list of provided header names.
41+--
42+-- Since 3.0.8
43+stripHeadersIf :: [ByteString] -> (Request -> Bool) -> Middleware
44+stripHeadersIf hs rpred
45+ = ifRequest rpred (modifyResponse $ stripHeaders hs)
wai-extra/Network/Wai/Middleware/Timeout.hsnew file+33
@@ -0,0 +1,33 @@
1+-- | Timeout requests
2+module Network.Wai.Middleware.Timeout
3+ ( timeout
4+ , timeoutStatus
5+ , timeoutAs
6+ ) where
7+
8+import Network.HTTP.Types (Status, status503)
9+import Network.Wai
10+import qualified System.Timeout as Timeout
11+
12+-- | Time out the request after the given number of seconds
13+--
14+-- Timeouts respond with @'status503'@. See @'timeoutStatus'@ or @'timeoutAs'@
15+-- to customize the behavior of the timed-out case.
16+--
17+-- @since 3.0.24.0@
18+timeout :: Int -> Middleware
19+timeout = timeoutStatus status503
20+
21+-- | Time out with the given @'Status'@
22+--
23+-- @since 3.0.24.0@
24+timeoutStatus :: Status -> Int -> Middleware
25+timeoutStatus status = timeoutAs $ responseLBS status [] ""
26+
27+-- | Time out with the given @'Response'@
28+--
29+-- @since 3.0.24.0@
30+timeoutAs :: Response -> Int -> Middleware
31+timeoutAs timeoutReponse seconds app req respond =
32+ maybe (respond timeoutReponse) pure
33+ =<< Timeout.timeout (seconds * 1000000) (app req respond)
wai-extra/Network/Wai/Middleware/Vhost.hs+5−3
@@ -1,5 +1,5 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−module Network.Wai.Middleware.Vhost (vhost, redirectWWW, redirectTo, redirectToLogged) where
1+{-# LANGUAGE CPP #-}
2+ module Network.Wai.Middleware.Vhost (vhost, redirectWWW, redirectTo, redirectToLogged) where
33
44import Network.Wai
55
@@ -7,7 +7,9 @@ import Network.HTTP.Types as H
77import qualified Data.Text.Encoding as TE
88import Data.Text (Text)
99import qualified Data.ByteString as BS
10+#if __GLASGOW_HASKELL__ < 710
1011import Data.Monoid (mappend)
12+#endif
1113
1214vhost :: [(Request -> Bool, Application)] -> Application -> Application
1315vhost vhosts def req =
@@ -27,7 +29,7 @@ redirectIf home cond app req sendResponse =
2729
2830redirectTo :: BS.ByteString -> Response
2931redirectTo location = responseLBS H.status301
30− [ ("Content-Type", "text/plain") , ("Location", location) ] "Redirect"
32+ [ (H.hContentType, "text/plain") , (H.hLocation, location) ] "Redirect"
3133
3234redirectToLogged :: (Text -> IO ()) -> BS.ByteString -> IO Response
3335redirectToLogged logger loc = do
wai-extra/Network/Wai/Parse.hs+369−87
@@ -1,5 +1,4 @@
11{-# LANGUAGE CPP #-}
2−{-# LANGUAGE OverloadedStrings #-}
32{-# LANGUAGE ExistentialQuantification #-}
43{-# LANGUAGE PatternGuards #-}
54{-# LANGUAGE TypeFamilies #-}
@@ -12,6 +11,7 @@ module Network.Wai.Parse
1211 , RequestBodyType (..)
1312 , getRequestBodyType
1413 , sinkRequestBody
14+ , sinkRequestBodyEx
1515 , BackEnd
1616 , lbsBackEnd
1717 , tempFileBackEnd
@@ -20,6 +20,24 @@ module Network.Wai.Parse
2020 , File
2121 , FileInfo (..)
2222 , 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
2341#if TEST
2442 , Bound (..)
2543 , findBound
@@ -30,21 +48,30 @@ module Network.Wai.Parse
3048#endif
3149 ) where
3250
33−import qualified Data.ByteString.Search as Search
51+import qualified Control.Exception as E
3452import qualified Data.ByteString as S
3553import qualified Data.ByteString.Lazy as L
3654import qualified Data.ByteString.Char8 as S8
3755import Data.Word (Word8)
38−import Data.Maybe (fromMaybe)
56+import Data.Int (Int64)
57+import Data.Maybe (catMaybes, fromMaybe)
3958import Data.List (sortBy)
4059import Data.Function (on, fix)
4160import System.Directory (removeFile, getTemporaryDirectory)
4261import System.IO (hClose, openBinaryTempFile)
62+import System.IO.Error (isDoesNotExistError)
4363import Network.Wai
4464import qualified Network.HTTP.Types as H
45−import Control.Monad (when, unless)
65+import Control.Applicative ((<$>))
66+import Control.Exception (catchJust)
67+import Control.Monad (when, unless, guard)
4668import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
4769import Data.IORef
70+import Network.HTTP.Types (hContentType)
71+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
72+import Data.CaseInsensitive (mk)
73+
74+import Prelude hiding (lines)
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,11 +305,19 @@ 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
143− ctype' <- lookup "Content-Type" $ requestHeaders req
320+ ctype' <- lookup hContentType $ requestHeaders req
144321 let (ctype, attrs) = parseContentType ctype'
145322 case ctype of
146323 "application/x-www-form-urlencoded" -> return UrlEncoded
@@ -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
@@ -383,25 +664,26 @@ wrapTillBound bound src = do
383664 NoBound -> do
384665 -- don't emit newlines, in case it's part of a bound
385666 let (toEmit, front') =
386− if not (S8.null bs) && S8.last bs `elem` "\r\n"
667+ if not (S8.null bs) && S8.last bs `elem` ['\r','\n']
387668 then let (x, y) = S.splitAt (S.length bs - 2) bs
388669 in (x, S.append y)
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.hsnew file+101
@@ -0,0 +1,101 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
2+-- | Some helpers for interrogating a WAI 'Request'.
3+
4+module Network.Wai.Request
5+ ( appearsSecure
6+ , guessApproot
7+ , RequestSizeException(..)
8+ , requestSizeCheck
9+ ) where
10+
11+import Data.ByteString (ByteString)
12+import Data.Maybe (fromMaybe)
13+import Network.HTTP.Types (HeaderName)
14+import Network.Wai
15+
16+import qualified Data.ByteString as S
17+import qualified Data.ByteString.Char8 as C
18+import Control.Exception (Exception, throwIO)
19+import Data.Typeable (Typeable)
20+import Data.Word (Word64)
21+import Data.IORef (atomicModifyIORef', newIORef)
22+
23+
24+-- | Does this request appear to have been made over an SSL connection?
25+--
26+-- This function first checks @'isSecure'@, but also checks for headers that may
27+-- indicate a secure connection even in the presence of reverse proxies.
28+--
29+-- Note: these headers can be easily spoofed, so decisions which require a true
30+-- SSL connection (i.e. sending sensitive information) should only use
31+-- @'isSecure'@. This is not always the case though: for example, deciding to
32+-- force a non-SSL request to SSL by redirect. One can safely choose not to
33+-- redirect when the request /appears/ secure, even if it's actually not.
34+--
35+-- @since 3.0.7
36+appearsSecure :: Request -> Bool
37+appearsSecure request = isSecure request || any (uncurry matchHeader)
38+ [ ("HTTPS" , (== "on"))
39+ , ("HTTP_X_FORWARDED_SSL" , (== "on"))
40+ , ("HTTP_X_FORWARDED_SCHEME", (== "https"))
41+ , ("HTTP_X_FORWARDED_PROTO" , ((== ["https"]) . take 1 . C.split ','))
42+ , ("X-Forwarded-Proto" , (== "https")) -- Used by Nginx and AWS ELB.
43+ ]
44+
45+ where
46+ matchHeader :: HeaderName -> (ByteString -> Bool) -> Bool
47+ matchHeader h f = maybe False f $ lookup h $ requestHeaders request
48+
49+-- | Guess the \"application root\" based on the given request.
50+--
51+-- The application root is the basis for forming URLs pointing at the current
52+-- application. For more information and relevant caveats, please see
53+-- "Network.Wai.Middleware.Approot".
54+--
55+-- @since 3.0.7
56+guessApproot :: Request -> ByteString
57+guessApproot req =
58+ (if appearsSecure req then "https://" else "http://") `S.append`
59+ (fromMaybe "localhost" $ requestHeaderHost req)
60+
61+-- | see 'requestSizeCheck'
62+--
63+-- @since 3.0.15
64+data RequestSizeException
65+ = RequestSizeException Word64
66+ deriving (Eq, Ord, Typeable)
67+
68+instance Exception RequestSizeException
69+
70+instance Show RequestSizeException where
71+ showsPrec p (RequestSizeException limit) =
72+ showString ("Request Body is larger than ") . showsPrec p limit . showString " bytes."
73+
74+-- | Check request body size to avoid server crash when request is too large.
75+--
76+-- This function first checks @'requestBodyLength'@, if content-length is known
77+-- but larger than limit, or it's unknown but we have received too many chunks,
78+-- a 'RequestSizeException' are thrown when user use @'requestBody'@ to extract
79+-- request body inside IO.
80+--
81+-- @since 3.0.15
82+requestSizeCheck :: Word64 -> Request -> IO Request
83+requestSizeCheck maxSize req =
84+ case requestBodyLength req of
85+ KnownLength len ->
86+ if len > maxSize
87+ then return $ req { requestBody = throwIO (RequestSizeException maxSize) }
88+ else return req
89+ ChunkedBody -> do
90+ currentSize <- newIORef 0
91+ return $ req
92+ { requestBody = do
93+ bs <- requestBody req
94+ total <-
95+ atomicModifyIORef' currentSize $ \sz ->
96+ let nextSize = sz + fromIntegral (S.length bs)
97+ in (nextSize, nextSize)
98+ if total > maxSize
99+ then throwIO (RequestSizeException maxSize)
100+ else return bs
101+ }
wai-extra/Network/Wai/Test.hs+147−28
@@ -5,6 +5,12 @@ module Network.Wai.Test
55 ( -- * Session
66 Session
77 , runSession
8+ -- * Client Cookies
9+ , ClientCookies
10+ , getClientCookies
11+ , modifyClientCookies
12+ , setClientCookie
13+ , deleteClientCookie
814 -- * Requests
915 , request
1016 , srequest
@@ -20,24 +26,33 @@ module Network.Wai.Test
2026 , assertBodyContains
2127 , assertHeader
2228 , assertNoHeader
29+ , assertClientCookieExists
30+ , assertNoClientCookieExists
31+ , assertClientCookieValue
2332 , WaiTestFailure (..)
2433 ) where
2534
35+#if __GLASGOW_HASKELL__ < 710
36+import Control.Applicative ((<$>))
37+import Data.Monoid (mempty, mappend)
38+#endif
39+
2640import Network.Wai
2741import Network.Wai.Internal (ResponseReceived (ResponseReceived))
42+import Network.Wai.Test.Internal
2843import Control.Monad.IO.Class (liftIO)
29−import Control.Monad.Trans.State (StateT, evalStateT)
30−import Control.Monad.Trans.Reader (ReaderT, runReaderT, ask)
44+import Control.Monad.Trans.Class (lift)
45+import qualified Control.Monad.Trans.State as ST
46+import Control.Monad.Trans.Reader (runReaderT, ask)
3147import Control.Monad (unless)
3248import Control.DeepSeq (deepseq)
3349import Control.Exception (throwIO, Exception)
3450import Data.Typeable (Typeable)
35−import Data.Map (Map)
3651import qualified Data.Map as Map
52+import qualified Web.Cookie as Cookie
3753import Data.ByteString (ByteString)
3854import qualified Data.ByteString.Char8 as S8
39−import Blaze.ByteString.Builder (toLazyByteString)
40−import qualified Blaze.ByteString.Builder as B
55+import Data.ByteString.Builder (toLazyByteString)
4156import qualified Data.ByteString.Lazy as L
4257import qualified Data.ByteString.Lazy.Char8 as L8
4358import qualified Network.HTTP.Types as H
@@ -46,23 +61,48 @@ import qualified Data.ByteString as S
4661import qualified Data.Text as T
4762import qualified Data.Text.Encoding as TE
4863import Data.IORef
49−import Data.Monoid (mempty, mappend)
64+import Data.Time.Clock (getCurrentTime)
5065
51−type Session = ReaderT Application (StateT ClientState IO)
66+-- |
67+--
68+-- Since 3.0.6
69+getClientCookies :: Session ClientCookies
70+getClientCookies = clientCookies <$> lift ST.get
5271
53−data ClientState = ClientState
54− { _clientCookies :: Map ByteString ByteString
55− }
72+-- |
73+--
74+-- Since 3.0.6
75+modifyClientCookies :: (ClientCookies -> ClientCookies) -> Session ()
76+modifyClientCookies f =
77+ lift (ST.modify (\cs -> cs { clientCookies = f $ clientCookies cs }))
78+
79+-- |
80+--
81+-- Since 3.0.6
82+setClientCookie :: Cookie.SetCookie -> Session ()
83+setClientCookie c =
84+ modifyClientCookies
85+ (Map.insert (Cookie.setCookieName c) c)
5686
57−initState :: ClientState
58−initState = ClientState Map.empty
87+-- |
88+--
89+-- Since 3.0.6
90+deleteClientCookie :: ByteString -> Session ()
91+deleteClientCookie cookieName =
92+ modifyClientCookies
93+ (Map.delete cookieName)
5994
95+-- | See also: 'runSessionWith'.
6096runSession :: Session a -> Application -> IO a
61−runSession session app = evalStateT (runReaderT session app) initState
97+runSession session app = ST.evalStateT (runReaderT session app) initState
6298
6399data SRequest = SRequest
64100 { simpleRequest :: Request
65101 , 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'.
66106 }
67107data SResponse = SResponse
68108 { simpleStatus :: H.Status
@@ -70,14 +110,22 @@ data SResponse = SResponse
70110 , simpleBody :: L.ByteString
71111 }
72112 deriving (Show, Eq)
113+
73114request :: Request -> Session SResponse
74−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
75123
76124-- | Set whole path (request path + query string).
77125setPath :: Request -> S8.ByteString -> Request
78126setPath req path = req {
79127 pathInfo = segments
80− , rawPathInfo = B.toByteString (H.encodePathSegments segments)
128+ , rawPathInfo = (L8.toStrict . toLazyByteString) (H.encodePathSegments segments)
81129 , queryString = query
82130 , rawQueryString = (H.renderQuery True query)
83131 }
@@ -93,22 +141,55 @@ setRawPathInfo r rawPinfo =
93141 dropFrontSlash ("":path) = path
94142 dropFrontSlash path = path
95143
144+addCookiesToRequest :: Request -> Session Request
145+addCookiesToRequest req = do
146+ oldClientCookies <- getClientCookies
147+ let requestPath = "/" `T.append` T.intercalate "/" (pathInfo req)
148+ currentUTCTime <- liftIO getCurrentTime
149+ let cookiesForRequest =
150+ Map.filter
151+ (\c -> checkCookieTime currentUTCTime c
152+ && checkCookiePath requestPath c)
153+ oldClientCookies
154+ let cookiePairs = [ (Cookie.setCookieName c, Cookie.setCookieValue c)
155+ | c <- map snd $ Map.toList cookiesForRequest
156+ ]
157+ let cookieValue = L8.toStrict . toLazyByteString $ Cookie.renderCookies cookiePairs
158+ addCookieHeader rest
159+ | null cookiePairs = rest
160+ | otherwise = ("Cookie", cookieValue) : rest
161+ return $ req { requestHeaders = addCookieHeader $ requestHeaders req }
162+ where checkCookieTime t c =
163+ case Cookie.setCookieExpires c of
164+ Nothing -> True
165+ Just t' -> t < t'
166+ checkCookiePath p c =
167+ case Cookie.setCookiePath c of
168+ Nothing -> True
169+ Just p' -> p' `S8.isPrefixOf` TE.encodeUtf8 p
170+
171+extractSetCookieFromSResponse :: SResponse -> Session SResponse
172+extractSetCookieFromSResponse response = do
173+ let setCookieHeaders =
174+ filter (("Set-Cookie"==) . fst) $ simpleHeaders response
175+ let newClientCookies = map (Cookie.parseSetCookie . snd) setCookieHeaders
176+ modifyClientCookies
177+ (Map.union
178+ (Map.fromList [(Cookie.setCookieName c, c) | c <- newClientCookies ]))
179+ return response
180+
181+-- | Similar to 'request', but allows setting the request body as a plain
182+-- 'L.ByteString'.
96183srequest :: SRequest -> Session SResponse
97184srequest (SRequest req bod) = do
98− app <- ask
99185 refChunks <- liftIO $ newIORef $ L.toChunks bod
100− let req' = req
101− { requestBody = atomicModifyIORef refChunks $ \bss ->
102− case bss of
103− [] -> ([], S.empty)
104− x:y -> (y, x)
105− }
106− liftIO $ do
107− ref <- newIORef $ error "runResponse gave no result"
108− ResponseReceived <- app req' (runResponse ref)
109− readIORef ref
110− -- FIXME cookie processing
111− --return sres
186+ request $
187+ req
188+ { requestBody = atomicModifyIORef refChunks $ \bss ->
189+ case bss of
190+ [] -> ([], S.empty)
191+ x:y -> (y, x)
192+ }
112193
113194runResponse :: IORef SResponse -> Response -> IO ResponseReceived
114195runResponse ref res = do
@@ -212,3 +293,41 @@ assertNoHeader header SResponse{simpleHeaders = h} =
212293 , " containing "
213294 , show s
214295 ]
296+
297+-- |
298+--
299+-- Since 3.0.6
300+assertClientCookieExists :: String -> ByteString -> Session ()
301+assertClientCookieExists s cookieName = do
302+ cookies <- getClientCookies
303+ assertBool s $ Map.member cookieName cookies
304+
305+-- |
306+--
307+-- Since 3.0.6
308+assertNoClientCookieExists :: String -> ByteString -> Session ()
309+assertNoClientCookieExists s cookieName = do
310+ cookies <- getClientCookies
311+ assertBool s $ not $ Map.member cookieName cookies
312+
313+-- |
314+--
315+-- Since 3.0.6
316+assertClientCookieValue :: String -> ByteString -> ByteString -> Session ()
317+assertClientCookieValue s cookieName cookieValue = do
318+ cookies <- getClientCookies
319+ case Map.lookup cookieName cookies of
320+ Nothing ->
321+ assertFailure (s ++ " (cookie does not exist)")
322+ Just c ->
323+ assertBool
324+ (concat
325+ [ s
326+ , " (actual value "
327+ , show $ Cookie.setCookieValue c
328+ , " expected value "
329+ , show cookieValue
330+ , ")"
331+ ]
332+ )
333+ (Cookie.setCookieValue c == cookieValue)
wai-extra/Network/Wai/Test/Internal.hsnew file+35
@@ -0,0 +1,35 @@
1+module Network.Wai.Test.Internal where
2+
3+import Network.Wai
4+import qualified Control.Monad.Trans.State as ST
5+import Control.Monad.Trans.Reader (ReaderT, runReaderT)
6+import Data.Map (Map)
7+import qualified Data.Map as Map
8+import qualified Web.Cookie as Cookie
9+import Data.ByteString (ByteString)
10+
11+type Session = ReaderT Application (ST.StateT ClientState IO)
12+
13+-- |
14+--
15+-- Since 3.0.6
16+type ClientCookies = Map ByteString Cookie.SetCookie
17+
18+data ClientState = ClientState
19+ { clientCookies :: ClientCookies
20+ }
21+
22+-- |
23+--
24+-- Since 3.0.20.0
25+initState :: ClientState
26+initState = ClientState Map.empty
27+
28+-- | Like 'runSession', but if allows you to hand in cookies and get
29+-- the updated cookies back. One use case for this is writing tests
30+-- that address the application under test alternatingly through rest
31+-- api and through db handle.
32+--
33+-- Since 3.0.20.0
34+runSessionWith :: ClientState -> Session a -> Application -> IO (a, ClientState)
35+runSessionWith st session app = ST.runStateT (runReaderT session app) st
wai-extra/Network/Wai/UrlMap.hs+2−2
@@ -1,4 +1,4 @@
1−{-# LANGUAGE OverloadedStrings, TypeSynonymInstances, FlexibleInstances #-}
1+{-# LANGUAGE TypeSynonymInstances, FlexibleInstances #-}
22{-# LANGUAGE ExistentialQuantification #-}
33{- | This module gives you a way to mount applications under sub-URIs.
44For example:
@@ -93,7 +93,7 @@ instance ToApplication UrlMap where
9393 Nothing ->
9494 sendResponse $ responseLBS
9595 status404
96− [("content-type", "text/plain")]
96+ [(hContentType, "text/plain")]
9797 "Not found\n"
9898
9999 where
wai-extra/READMEdeleted−1
@@ -1 +0,0 @@
1−Provides some basic WAI handlers and middleware.
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/ApprootSpec.hsnew file+37
@@ -0,0 +1,37 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.ApprootSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.Approot
10+import Network.Wai.Test
11+import Network.Wai
12+import Network.HTTP.Types
13+import Data.ByteString (ByteString)
14+
15+main :: IO ()
16+main = hspec spec
17+
18+spec :: Spec
19+spec = do
20+ let test name host secure headers expected = it name $ do
21+ resp <- runApp host secure headers
22+ simpleHeaders resp `shouldBe` [("Approot", expected)]
23+ test "respects host header" "foobar" False [] "http://foobar"
24+ test "respects isSecure" "foobar" True [] "https://foobar"
25+ test "respects SSL headers" "foobar" False
26+ [("HTTP_X_FORWARDED_SSL", "on")] "https://foobar"
27+
28+runApp :: ByteString -> Bool -> RequestHeaders -> IO SResponse
29+runApp host secure headers = runSession
30+ (request defaultRequest
31+ { requestHeaderHost = Just host
32+ , isSecure = secure
33+ , requestHeaders = headers
34+ }) $ fromRequest app
35+
36+ where
37+ app req respond = respond $ responseLBS status200 [("Approot", getApproot req)] ""
wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hsnew file+60
@@ -0,0 +1,60 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.ForceSSLSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.ForceSSL
10+
11+import Control.Monad
12+import Data.ByteString (ByteString)
13+import Data.Monoid ((<>))
14+import Network.HTTP.Types (methodPost, status200, status301, status307)
15+import Network.Wai
16+import Network.Wai.Test
17+
18+main :: IO ()
19+main = hspec spec
20+
21+spec :: Spec
22+spec = describe "forceSSL" (forM_ hosts $ \host -> hostSpec host)
23+ where
24+ hosts = ["example.com", "example.com:80", "example.com:8080"]
25+
26+hostSpec :: ByteString -> Spec
27+hostSpec host = describe ("forceSSL on host " <> show host <> "") $ do
28+
29+ it "redirects non-https requests to https" $ do
30+ resp <- runApp host forceSSL defaultRequest
31+
32+ simpleStatus resp `shouldBe` status301
33+ simpleHeaders resp `shouldBe` [("Location", "https://" <> host)]
34+
35+ it "redirects with 307 in the case of a non-GET request" $ do
36+ resp <- runApp host forceSSL defaultRequest
37+ { requestMethod = methodPost }
38+
39+ simpleStatus resp `shouldBe` status307
40+ simpleHeaders resp `shouldBe` [("Location", "https://" <> host)]
41+
42+ it "does not redirect already-secure requests" $ do
43+ resp <- runApp host forceSSL defaultRequest { isSecure = True }
44+
45+ simpleStatus resp `shouldBe` status200
46+
47+ it "preserves the original host, path, and query string" $ do
48+ resp <- runApp host forceSSL defaultRequest
49+ { rawPathInfo = "/foo/bar"
50+ , rawQueryString = "?baz=bat"
51+ }
52+
53+ simpleHeaders resp `shouldBe`
54+ [("Location", "https://" <> host <> "/foo/bar?baz=bat")]
55+
56+runApp :: ByteString -> Middleware -> Request -> IO SResponse
57+runApp host mw req = runSession
58+ (request req { requestHeaderHost = Just host }) $ mw app
59+ where
60+ app _ respond = respond $ responseLBS status200 [] ""
wai-extra/test/Network/Wai/Middleware/RoutedSpec.hsnew file+53
@@ -0,0 +1,53 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.RoutedSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.Routed
10+import Network.Wai.Middleware.ForceSSL (forceSSL)
11+
12+import Network.HTTP.Types (hContentType, status200)
13+import Network.Wai
14+import Network.Wai.Test
15+import Data.ByteString (ByteString)
16+import Data.String (IsString)
17+
18+main :: IO ()
19+main = hspec spec
20+
21+spec :: Spec
22+spec = describe "forceSSL" $ do
23+ it "routed middleware" $ do
24+ let destination = "https://example.com/d/"
25+ let routedSslJsonApp prefix = routedMiddleware (checkPrefix prefix) forceSSL jsonApp
26+ checkPrefix p (p1:_) = p == p1
27+ checkPrefix _ _ = False
28+
29+ flip runSession (routedSslJsonApp "r") $ do
30+ res <- testDPath "http"
31+ assertNoHeader location res
32+ assertStatus 200 res
33+ assertBody "{\"foo\":\"bar\"}" res
34+
35+ flip runSession (routedSslJsonApp "d") $ do
36+ res2 <- testDPath "http"
37+ assertHeader location destination res2
38+ assertStatus 301 res2
39+
40+jsonApp :: Application
41+jsonApp _req cps = cps $ responseLBS status200
42+ [(hContentType, "application/json")]
43+ "{\"foo\":\"bar\"}"
44+
45+testDPath :: ByteString -> Session SResponse
46+testDPath proto =
47+ request $ flip setRawPathInfo "/d/" defaultRequest
48+ { requestHeaders = [("X-Forwarded-Proto", proto)]
49+ , requestHeaderHost = Just "example.com"
50+ }
51+
52+location :: IsString ci => ci
53+location = "Location"
wai-extra/test/Network/Wai/Middleware/StripHeadersSpec.hsnew file+58
@@ -0,0 +1,58 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.Middleware.StripHeadersSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Network.Wai.Middleware.AddHeaders
10+import Network.Wai.Middleware.StripHeaders
11+
12+import Control.Arrow (first)
13+import Data.ByteString (ByteString)
14+import Data.Monoid ((<>))
15+import Network.HTTP.Types (status200)
16+import Network.Wai
17+import Network.Wai.Test
18+
19+import qualified Data.CaseInsensitive as CI
20+
21+
22+main :: IO ()
23+main = hspec spec
24+
25+
26+spec :: Spec
27+spec = describe "stripHeader" $ do
28+ let host = "example.com"
29+ let ciTestHeaders = map (first CI.mk) testHeaders
30+
31+ it "strips a specific header" $ do
32+ resp1 <- runApp host (addHeaders testHeaders) defaultRequest
33+ resp2 <- runApp host (stripHeaderIf "Foo" (const False) . addHeaders testHeaders) defaultRequest
34+ resp3 <- runApp host (stripHeaderIf "Foo" (const True) . addHeaders testHeaders) defaultRequest
35+
36+ simpleHeaders resp1 `shouldBe` ciTestHeaders
37+ simpleHeaders resp2 `shouldBe` ciTestHeaders
38+ simpleHeaders resp3 `shouldBe` tail ciTestHeaders
39+
40+ it "strips specific set of headers" $ do
41+ resp1 <- runApp host (addHeaders testHeaders) defaultRequest
42+ resp2 <- runApp host (stripHeadersIf ["Bar", "Foo"] (const False) . addHeaders testHeaders) defaultRequest
43+ resp3 <- runApp host (stripHeadersIf ["Bar", "Foo"] (const True) . addHeaders testHeaders) defaultRequest
44+
45+ simpleHeaders resp1 `shouldBe` ciTestHeaders
46+ simpleHeaders resp2 `shouldBe` ciTestHeaders
47+ simpleHeaders resp3 `shouldBe` [last ciTestHeaders]
48+
49+
50+testHeaders :: [(ByteString, ByteString)]
51+testHeaders = [("Foo", "fooey"), ("Bar", "barbican"), ("Baz", "bazooka")]
52+
53+
54+runApp :: ByteString -> Middleware -> Request -> IO SResponse
55+runApp host mw req = runSession
56+ (request req { requestHeaderHost = Just $ host <> ":80" }) $ mw app
57+ where
58+ app _ respond = respond $ responseLBS status200 [] ""
wai-extra/test/Network/Wai/Middleware/TimeoutSpec.hsnew file+57
@@ -0,0 +1,57 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module Network.Wai.Middleware.TimeoutSpec
4+ ( spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Control.Concurrent (threadDelay)
10+import Network.HTTP.Types (status200, status503, status504)
11+import Network.Wai
12+import Network.Wai.Middleware.Timeout
13+import Network.Wai.Test
14+
15+spec :: Spec
16+spec = do
17+ describe "timeout" $ do
18+ it "times out slow requests with 503" $ do
19+ let app _req respond = do
20+ threadDelay $ 2 * 1000000
21+ respond $ responseLBS status200 [] ""
22+
23+ resp <- runApp $ timeout 1 app
24+
25+ simpleStatus resp `shouldBe` status503
26+
27+ it "does not time out fast requests" $ do
28+ let app _req respond = respond $ responseLBS status200 [] ""
29+
30+ resp <- runApp $ timeout 3 app
31+
32+ simpleStatus resp `shouldBe` status200
33+
34+ describe "timeoutStatus" $ do
35+ it "allows customizing the timeout response status" $ do
36+ let app _req respond = do
37+ threadDelay $ 2 * 1000000
38+ respond $ responseLBS status200 [] ""
39+
40+ resp <- runApp $ timeoutStatus status504 1 app
41+
42+ simpleStatus resp `shouldBe` status504
43+
44+ describe "timeoutAs" $ do
45+ it "allows customizing the timeout response" $ do
46+ let app _req respond = do
47+ threadDelay $ 2 * 1000000
48+ respond $ responseLBS status200 [] ""
49+ timeoutResponse = responseLBS status503 [("X-Timeout", "1")] ""
50+
51+ resp <- runApp $ timeoutAs timeoutResponse 1 app
52+
53+ simpleStatus resp `shouldBe` status503
54+ simpleHeaders resp `shouldBe` [("X-Timeout", "1")]
55+
56+runApp :: Application -> IO SResponse
57+runApp = runSession $ request defaultRequest
wai-extra/test/Network/Wai/ParseSpec.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.hsnew file+93
@@ -0,0 +1,93 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+module Network.Wai.RequestSpec
3+ ( main
4+ , spec
5+ ) where
6+
7+import Test.Hspec
8+
9+import Data.ByteString (ByteString)
10+import Network.HTTP.Types (HeaderName)
11+import Network.Wai (Request(..), defaultRequest, RequestBodyLength(..))
12+
13+import Network.Wai.Request
14+import Control.Exception (try)
15+import Control.Monad (forever)
16+
17+main :: IO ()
18+main = hspec spec
19+
20+spec :: Spec
21+spec = do
22+ describe "requestSizeCheck" $ do
23+ it "too large content length should throw RequestSizeException" $ do
24+ let limit = 1024
25+ largeRequest = defaultRequest
26+ { isSecure = False
27+ , requestBodyLength = KnownLength (limit + 1)
28+ , requestBody = return "repeat this chunk"
29+ }
30+ checkedRequest <- requestSizeCheck limit largeRequest
31+ body <- try (requestBody checkedRequest)
32+ case body of
33+ Left (RequestSizeException l) -> l `shouldBe` limit
34+ Right _ -> expectationFailure "request size check failed"
35+
36+ it "too many chunks should throw RequestSizeException" $ do
37+ let limit = 1024
38+ largeRequest = defaultRequest
39+ { isSecure = False
40+ , requestBodyLength = ChunkedBody
41+ , requestBody = return "repeat this chunk"
42+ }
43+ checkedRequest <- requestSizeCheck limit largeRequest
44+ body <- try (forever $ requestBody checkedRequest)
45+ case body of
46+ Left (RequestSizeException l) -> l `shouldBe` limit
47+ Right _ -> expectationFailure "request size check failed"
48+
49+ describe "appearsSecure" $ do
50+ let insecureRequest = defaultRequest
51+ { isSecure = False
52+ , requestHeaders =
53+ [ ("HTTPS", "off")
54+ , ("HTTP_X_FORWARDED_SSL", "off")
55+ , ("HTTP_X_FORWARDED_SCHEME", "http")
56+ , ("HTTP_X_FORWARDED_PROTO", "http,xyz")
57+ ]
58+ }
59+
60+ it "returns False for an insecure request" $
61+ insecureRequest `shouldSatisfy` not . appearsSecure
62+
63+ it "checks if the Request is actually secure" $ do
64+ let req = insecureRequest { isSecure = True }
65+
66+ req `shouldSatisfy` appearsSecure
67+
68+ it "checks for HTTP: on" $ do
69+ let req = addHeader "HTTPS" "on" insecureRequest
70+
71+ req `shouldSatisfy` appearsSecure
72+
73+ it "checks for HTTP_X_FORWARDED_SSL: on" $ do
74+ let req = addHeader "HTTP_X_FORWARDED_SSL" "on" insecureRequest
75+
76+ req `shouldSatisfy` appearsSecure
77+
78+ it "checks for HTTP_X_FORWARDED_SCHEME: https" $ do
79+ let req = addHeader "HTTP_X_FORWARDED_SCHEME" "https" insecureRequest
80+
81+ req `shouldSatisfy` appearsSecure
82+
83+ it "checks for HTTP_X_FORWARDED_PROTO: https,..." $ do
84+ let req = addHeader "HTTP_X_FORWARDED_PROTO" "https,xyz" insecureRequest
85+
86+ req `shouldSatisfy` appearsSecure
87+
88+addHeader :: HeaderName -> ByteString -> Request -> Request
89+addHeader name value req = req
90+ { requestHeaders = (name, value) : otherHeaders }
91+
92+ where
93+ otherHeaders = filter ((/= name) . fst) $ requestHeaders req
wai-extra/test/Network/Wai/TestSpec.hs+191
@@ -1,14 +1,34 @@
11{-# LANGUAGE OverloadedStrings #-}
22module Network.Wai.TestSpec (main, spec) where
33
4+import Control.Monad (void)
5+
6+import qualified Data.IORef as IORef
7+
8+import qualified Data.Text.Encoding as TE
9+
10+import Data.Time.Calendar (fromGregorian)
11+import Data.Time.Clock (UTCTime(..))
12+
413import Test.Hspec
514
615import Network.Wai
716import Network.Wai.Test
817
18+import Network.HTTP.Types (status200)
19+
20+import qualified Data.ByteString.Lazy.Char8 as L8
21+import Data.ByteString.Builder (Builder, toLazyByteString)
22+import Data.ByteString (ByteString)
23+
24+import qualified Web.Cookie as Cookie
25+
926main :: IO ()
1027main = hspec spec
1128
29+toByteString :: Builder -> ByteString
30+toByteString = L8.toStrict . toLazyByteString
31+
1232spec :: Spec
1333spec = do
1434 describe "setPath" $ do
@@ -34,3 +54,174 @@ spec = do
3454 context "when path has no query string" $ do
3555 it "sets rawQueryString to empty string" $ do
3656 rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
57+
58+ describe "srequest" $ do
59+
60+ let echoApp req respond = do
61+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
62+ let reqHeaders = requestHeaders req
63+ respond $
64+ responseLBS
65+ status200
66+ reqHeaders
67+ reqBody
68+
69+ it "returns the response body of an echo app" $ do
70+ sresp <- flip runSession echoApp $
71+ srequest $ SRequest defaultRequest "request body"
72+ simpleBody sresp `shouldBe` "request body"
73+
74+ describe "request" $ do
75+
76+ let echoApp req respond = do
77+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
78+ let reqHeaders = requestHeaders req
79+ respond $
80+ responseLBS
81+ status200
82+ reqHeaders
83+ reqBody
84+
85+ it "returns the status code of an echo app on default request" $ do
86+ sresp <- runSession (request defaultRequest) echoApp
87+ simpleStatus sresp `shouldBe` status200
88+
89+ it "returns the response body of an echo app" $ do
90+ bodyRef <- IORef.newIORef "request body"
91+ let getBodyChunk = IORef.atomicModifyIORef bodyRef $ \leftover -> ("", leftover)
92+ sresp <- flip runSession echoApp $
93+ request $
94+ defaultRequest
95+ { requestBody = getBodyChunk
96+ }
97+ simpleBody sresp `shouldBe` "request body"
98+
99+ it "returns the response headers of an echo app" $ do
100+ sresp <- flip runSession echoApp $
101+ request $
102+ defaultRequest
103+ { requestHeaders = [("foo", "bar")]
104+ }
105+ simpleHeaders sresp `shouldBe` [("foo", "bar")]
106+
107+ let cookieApp req respond =
108+ case pathInfo req of
109+ ["set", name, val] ->
110+ respond $
111+ responseLBS
112+ status200
113+ [( "Set-Cookie"
114+ , toByteString $ Cookie.renderSetCookie $
115+ Cookie.def { Cookie.setCookieName = TE.encodeUtf8 name
116+ , Cookie.setCookieValue = TE.encodeUtf8 val
117+ }
118+ )
119+ ]
120+ "set_cookie_body"
121+ ["delete", name] ->
122+ respond $
123+ responseLBS
124+ status200
125+ [( "Set-Cookie"
126+ , toByteString $ Cookie.renderSetCookie $
127+ Cookie.def { Cookie.setCookieName =
128+ TE.encodeUtf8 name
129+ , Cookie.setCookieExpires =
130+ Just $ UTCTime (fromGregorian 1970 1 1) 0
131+ }
132+ )
133+ ]
134+ "set_cookie_body"
135+ _ ->
136+ respond $
137+ responseLBS
138+ status200
139+ []
140+ ( L8.pack
141+ $ show
142+ $ map snd
143+ $ filter ((=="Cookie") . fst)
144+ $ requestHeaders req
145+ )
146+
147+ it "sends a Cookie header with correct value after receiving a Set-Cookie header" $ do
148+ sresp <- flip runSession cookieApp $ do
149+ void $ request $
150+ setPath defaultRequest "/set/cookie_name/cookie_value"
151+ request $
152+ setPath defaultRequest "/get"
153+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
154+
155+ it "sends a Cookie header with updated value after receiving a Set-Cookie header update" $ do
156+ sresp <- flip runSession cookieApp $ do
157+ void $ request $
158+ setPath defaultRequest "/set/cookie_name/cookie_value"
159+ void $ request $
160+ setPath defaultRequest "/set/cookie_name/cookie_value2"
161+ request $
162+ setPath defaultRequest "/get"
163+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value2\"]"
164+
165+ it "handles multiple cookies" $ do
166+ sresp <- flip runSession cookieApp $ do
167+ void $ request $
168+ setPath defaultRequest "/set/cookie_name/cookie_value"
169+ void $ request $
170+ setPath defaultRequest "/set/cookie_name2/cookie_value2"
171+ request $
172+ setPath defaultRequest "/get"
173+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value;cookie_name2=cookie_value2\"]"
174+
175+ it "removes a deleted cookie" $ do
176+ sresp <- flip runSession cookieApp $ do
177+ void $ request $
178+ setPath defaultRequest "/set/cookie_name/cookie_value"
179+ void $ request $
180+ setPath defaultRequest "/set/cookie_name2/cookie_value2"
181+ void $ request $
182+ setPath defaultRequest "/delete/cookie_name2"
183+ request $
184+ setPath defaultRequest "/get"
185+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
186+
187+ it "sends a cookie set with setClientCookie to server" $ do
188+ sresp <- flip runSession cookieApp $ do
189+ setClientCookie
190+ (Cookie.def { Cookie.setCookieName = "cookie_name"
191+ , Cookie.setCookieValue = "cookie_value"
192+ }
193+ )
194+ request $
195+ setPath defaultRequest "/get"
196+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value\"]"
197+
198+ it "sends a cookie updated with setClientCookie to server" $ do
199+ sresp <- flip runSession cookieApp $ do
200+ setClientCookie
201+ (Cookie.def { Cookie.setCookieName = "cookie_name"
202+ , Cookie.setCookieValue = "cookie_value"
203+ }
204+ )
205+ setClientCookie
206+ (Cookie.def { Cookie.setCookieName = "cookie_name"
207+ , Cookie.setCookieValue = "cookie_value2"
208+ }
209+ )
210+ request $
211+ setPath defaultRequest "/get"
212+ simpleBody sresp `shouldBe` "[\"cookie_name=cookie_value2\"]"
213+
214+ it "does not send a cookie deleted with deleteClientCookie to server" $ do
215+ sresp <- flip runSession cookieApp $ do
216+ setClientCookie
217+ (Cookie.def { Cookie.setCookieName = "cookie_name"
218+ , Cookie.setCookieValue = "cookie_value"
219+ }
220+ )
221+ deleteClientCookie "cookie_name"
222+ request $
223+ setPath defaultRequest "/get"
224+ simpleBody sresp `shouldBe` "[]"
225+
226+
227+
wai-extra/test/WaiExtraSpec.hs+7−4
@@ -1,9 +1,14 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE OverloadedStrings #-}
23module WaiExtraSpec (spec, toRequest) where
34
45import Test.Hspec
56import Test.HUnit hiding (Test)
6−import Data.Monoid (mappend, mempty, (<>))
7+#if MIN_VERSION_base(4,8,0)
8+import Data.Monoid ((<>))
9+#else
10+import Data.Monoid (mempty, mappend, (<>))
11+#endif
712
813import Network.Wai
914import Network.Wai.Test
@@ -336,10 +341,8 @@ caseDebugRequestBody = do
336341 }
337342 where
338343 params = [("foo", "bar"), ("baz", "bin")]
339− -- FIXME change back once we include post parameter output in logging
340− -- postOutput = T.pack $ "POST \nAccept: \n Params: " ++ (show params)
341344 -- the time cannot be known, so match around it
342− postOutput = ("POST /\n Accept: \n Status: 200 OK 0", "s\n")
345+ postOutput = (T.pack $ "POST /\n Params: " ++ (show params), "s\n")
343346 getOutput params' = ("GET /location\n Params: " <> T.pack (show params') <> "\n Accept: \n Status: 200 OK 0", "s\n")
344347
345348 debugApp (beginning, ending) req send = do
wai-extra/wai-extra.cabal+126−15
@@ -1,7 +1,69 @@
11Name: wai-extra
2−Version: 3.0.3
2+Version: 3.0.29.1
33Synopsis: Provides some basic WAI handlers and middleware.
4−Description: The goal here is to provide common features without many dependencies.
4+description:
5+ Provides basic WAI handler and middleware functionality:
6+ .
7+ * WAI Testing Framework
8+ .
9+ Hspec testing facilities and helpers for WAI.
10+ .
11+ * Event Source/Event Stream
12+ .
13+ Send server events to the client. Compatible with the JavaScript
14+ EventSource API.
15+ .
16+ * Accept Override
17+ .
18+ Override the Accept header in a request. Special handling for the
19+ _accept query parameter (which is used throughout WAI override the
20+ Accept header).
21+ .
22+ * Add Headers
23+ .
24+ WAI Middleware for adding arbitrary headers to an HTTP request.
25+ .
26+ * Clean Path
27+ .
28+ Clean a request path to a canonical form.
29+ .
30+ * GZip Compression
31+ .
32+ Negotiate HTTP payload gzip compression.
33+ .
34+ * HTTP Basic Authentication
35+ .
36+ WAI Basic Authentication Middleware which uses Authorization header.
37+ .
38+ * JSONP
39+ .
40+ \"JSON with Padding\" middleware. Automatic wrapping of JSON
41+ responses to convert into JSONP.
42+ .
43+ * Method Override / Post
44+ .
45+ Allows overriding of the HTTP request method via the _method query string
46+ parameter.
47+ .
48+ * Request Logging
49+ .
50+ Request logging middleware for development and production environments
51+ .
52+ * Request Rewrite
53+ .
54+ Rewrite request path info based on a custom conversion rules.
55+ .
56+ * Stream Files
57+ .
58+ Convert ResponseFile type responses into ResponseStream type.
59+ .
60+ * Virtual Host
61+ .
62+ Redirect incoming requests to a new host based on custom rules.
63+ .
64+ .
65+ API docs and the README are available at <http://www.stackage.org/package/wai-extra>.
66+
567License: MIT
668License-file: LICENSE
769Author: Michael Snoyman
@@ -9,7 +71,7 @@ Maintainer: michael@snoyman.com
971Homepage: http://github.com/yesodweb/wai
1072Category: Web
1173Build-Type: Simple
12−Cabal-Version: >=1.8
74+Cabal-Version: >=1.10
1375Stability: Stable
1476extra-source-files:
1577 test/requests/dalvik-request
@@ -19,68 +81,112 @@ extra-source-files:
1981 ChangeLog.md
2082 README.md
2183
84+flag build-example
85+ description: Build example executable.
86+ manual: True
87+ default: False
88+
2289Library
23− Build-Depends: base >= 4 && < 5
24− , bytestring >= 0.9.1.4
25− , wai >= 3.0 && < 3.1
90+ Build-Depends: base >= 4.8 && < 5
91+ , bytestring >= 0.10.4
92+ , wai >= 3.0.3.0 && < 3.3
2693 , old-locale >= 1.0.0.2 && < 1.1
2794 , time >= 1.1.4
28− , network >= 2.2.1.5
95+ , network >= 2.6.1.0
2996 , directory >= 1.0.1
3097 , transformers >= 0.2.2
31− , blaze-builder >= 0.2.1.4 && < 0.4
3298 , http-types >= 0.7
3399 , text >= 0.7
34100 , case-insensitive >= 0.2
35101 , data-default-class
36− , fast-logger >= 2.1 && < 2.3
37− , wai-logger >= 2.0 && < 2.3
102+ , fast-logger >= 2.4.5
103+ , wai-logger >= 2.3.2
38104 , ansi-terminal
39− , resourcet >= 0.4.6 && < 1.2
105+ , resourcet >= 0.4.6 && < 1.3
40106 , void >= 0.5
41− , stringsearch >= 0.3 && < 0.4
42107 , containers
43108 , base64-bytestring
44109 , word8
45− , lifted-base >= 0.1.2
46110 , deepseq
47− , streaming-commons
111+ , streaming-commons >= 0.2
112+ , unix-compat
113+ , cookie
114+ , vault
115+ , zlib
116+ , aeson
117+ , iproute
118+ , http2
48119
49120 if os(windows)
50121 cpp-options: -DWINDOWS
51122 else
52123 build-depends: unix
53124
125+ default-extensions: OverloadedStrings
126+
54127 Exposed-modules: Network.Wai.Handler.CGI
55128 Network.Wai.Handler.SCGI
129+ Network.Wai.Header
56130 Network.Wai.Middleware.AcceptOverride
57131 Network.Wai.Middleware.AddHeaders
132+ Network.Wai.Middleware.Approot
58133 Network.Wai.Middleware.Autohead
59134 Network.Wai.Middleware.CleanPath
60135 Network.Wai.Middleware.Local
61136 Network.Wai.Middleware.RequestLogger
137+ Network.Wai.Middleware.RequestLogger.JSON
62138 Network.Wai.Middleware.Gzip
63139 Network.Wai.Middleware.Jsonp
64140 Network.Wai.Middleware.MethodOverride
65141 Network.Wai.Middleware.MethodOverridePost
66142 Network.Wai.Middleware.Rewrite
143+ Network.Wai.Middleware.StripHeaders
67144 Network.Wai.Middleware.Vhost
68145 Network.Wai.Middleware.HttpAuth
69146 Network.Wai.Middleware.StreamFile
147+ Network.Wai.Middleware.ForceDomain
148+ Network.Wai.Middleware.ForceSSL
149+ Network.Wai.Middleware.Routed
150+ Network.Wai.Middleware.Timeout
70151 Network.Wai.Parse
152+ Network.Wai.Request
71153 Network.Wai.UrlMap
72154 Network.Wai.Test
155+ Network.Wai.Test.Internal
73156 Network.Wai.EventSource
74157 Network.Wai.EventSource.EventStream
75158 other-modules: Network.Wai.Middleware.RequestLogger.Internal
159+ default-language: Haskell2010
76160 ghc-options: -Wall
77161
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+
78178test-suite spec
79179 type: exitcode-stdio-1.0
80180 hs-source-dirs: test
81181 main-is: Spec.hs
82182 other-modules: Network.Wai.TestSpec
83183 Network.Wai.ParseSpec
184+ Network.Wai.RequestSpec
185+ Network.Wai.Middleware.ApprootSpec
186+ Network.Wai.Middleware.ForceSSLSpec
187+ Network.Wai.Middleware.RoutedSpec
188+ Network.Wai.Middleware.StripHeadersSpec
189+ Network.Wai.Middleware.TimeoutSpec
84190 WaiExtraSpec
85191 build-depends: base >= 4 && < 5
86192 , wai-extra
@@ -94,7 +200,12 @@ test-suite spec
94200 , resourcet
95201 , bytestring
96202 , HUnit
97− ghc-options: -Wall -Werror
203+ , cookie
204+ , time
205+ , case-insensitive
206+ , http2
207+ ghc-options: -Wall
208+ default-language: Haskell2010
98209
99210source-repository head
100211 type: git
wai-frontend-monadcgi/ChangeLog.mdnew file+7
@@ -0,0 +1,7 @@
1+## 3.0.0.3
2+
3+* wai-frontend-monadcgi does not drop '?' in query string [#590](https://github.com/yesodweb/wai/issues/590)
4+
5+## 3.0.0.2
6+
7+* Support for wai 3.2
wai-frontend-monadcgi/Network/Wai/Frontend/MonadCGI.hs+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/READMEdeleted−1
@@ -1 +0,0 @@
1−Run CGI apps on WAI handlers.
wai-frontend-monadcgi/README.mdnew file+5
@@ -0,0 +1,5 @@
1+## wai-frontend-monadcgi
2+
3+Allows programs written against MonadCGI to run with any WAI handler. This is
4+most useful for running your existing CGI apps on Warp. For true "yo
5+dawg"-ness, try running this through the WAI CGI backend.
wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+4−3
@@ -1,15 +1,16 @@
11name: wai-frontend-monadcgi
2−version: 3.0.0
2+version: 3.0.0.3
33license: MIT
44license-file: LICENSE
55author: Michael Snoyman <michael@snoyman.com>
66maintainer: Michael Snoyman <michael@snoyman.com>
77synopsis: Run CGI apps on WAI.
8−description: Allows programs written against MonadCGI to run with any WAI handler. This is most useful for running your existing CGI apps on Warp. For true "yo dawg"-ness, try running this through the WAI CGI backend.
8+description: API docs and the README are available at <http://www.stackage.org/package/wai-frontend-monadcgi>.
99category: Web
1010stability: stable
1111cabal-version: >= 1.6
1212build-type: Simple
13+extra-source-files: README.md ChangeLog.md
1314
1415library
1516 build-depends: base >= 4 && < 5
@@ -19,7 +20,7 @@ library
1920 , http-types
2021 , transformers
2122 , case-insensitive
22− , wai >= 3.0 && < 3.1
23+ , wai >= 3.0 && < 3.3
2324 exposed-modules: Network.Wai.Frontend.MonadCGI
2425 ghc-options: -Wall
2526
wai-handler-fastcgi/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−/dist/
2−*.swp
3−*.hi
4−*.o
wai-handler-fastcgi/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-fastcgi/Network/Wai/Handler/FastCGI.hscdeleted−192
@@ -1,192 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−{-# LANGUAGE EmptyDataDecls #-}
3−{-# LANGUAGE CPP #-}
4−-----------------------------------------------------------------------------
5−-- |
6−-- Module : Network.Wai.Handler.FastCGI
7−-- Copyright : (c) Bjorn Bringert 2004-2005, (c) Lemmih 2006, (c) Michael Snoyman 2010
8−-- License : BSD-style (see the file libraries/network/LICENSE)
9−--
10−-- Maintainer : michael@snoyman.com
11−-- Stability : experimental
12−-- Portability : non-portable (uses FFI)
13−--
14−-- Interface for FastCGI <http://fastcgi.com/>, using the fcgiapp API.
15−-- Totally ripped off by Michael Snoyman to work with Hack, then WAI.
16−--
17−-----------------------------------------------------------------------------
18−module Network.Wai.Handler.FastCGI
19− ( run
20− , runSendfile
21− , runFork
22− ) where
23−
24−import Control.Monad ( liftM, forever )
25−import Data.Word (Word8)
26−import Foreign ( Ptr, castPtr, nullPtr, peekArray0
27− , throwIfNeg_, mallocBytes, free )
28−#ifdef GHC_7_4
29−import Foreign.C (CInt(..), CString, CStringLen)
30−#else
31−import Foreign.C (CInt, CString, CStringLen)
32−#endif
33−import Control.Exception (finally)
34−import Foreign.Storable ( Storable (..) )
35−
36−import qualified Network.Wai as W
37−import qualified Network.Wai.Handler.CGI as CGI
38−
39−import qualified Data.ByteString as S
40−import qualified Data.ByteString.Char8 as S8
41−import qualified Data.ByteString as BS
42−import qualified Data.ByteString.Internal as BSB
43−import qualified Data.ByteString.Unsafe as BSB
44−
45−import Control.Arrow ((***))
46−
47−#include <fcgiapp.h>
48−
49−------------------------------------------------------------------------
50−
51−data FCGX_Stream
52−type StreamPtr = Ptr FCGX_Stream
53−type Environ = Ptr CString
54−
55−------------------------------------------------------------------------
56−
57−foreign import ccall unsafe "fcgiapp.h FCGX_GetStr" fcgx_getStr
58− :: CString -> CInt -> StreamPtr -> IO CInt
59−
60−foreign import ccall unsafe "fcgiapp.h FCGX_PutStr" fcgx_putStr
61− :: CString -> CInt -> StreamPtr -> IO CInt
62−
63−
64−------------------------------------------------------------------------
65−
66−foreign import ccall unsafe "fcgiapp.h FCGX_Init" fcgx_init
67− :: IO CInt
68−
69−runFork :: Maybe S.ByteString -> (IO () -> IO a) -> Int -> W.Application -> IO ()
70−runFork sf fork threads app = do
71− testReturn "FCGX_Init" $ fcgx_init
72− let oneThread = forever $ oneRequest app sf
73− mapM_ fork $ replicate (threads - 1) oneThread
74− oneThread
75−
76−-- | Handle FastCGI requests in an infinite loop.
77−run :: W.Application -> IO ()
78−run = runFork Nothing id 1
79−
80−-- | Handle FastCGI requests in an infinite loop. For a server which supports
81−-- the X-Sendfile header.
82−runSendfile :: S.ByteString -> W.Application -> IO ()
83−runSendfile sf = runFork (Just sf) id 1
84−
85−oneRequest :: W.Application
86− -> Maybe S.ByteString -- X-Sendfile
87− -> IO ()
88−oneRequest app xsendfile = withRequest $ \r -> do
89− putStrLn "Received 1 request"
90− env <- peekEnvp r
91− ins <- peekIn r
92− outs <- peekOut r
93− handleRequest app ins outs env xsendfile
94−
95−peekIn, peekOut :: Ptr FCGX_Request -> IO (Ptr FCGX_Stream)
96−peekIn = (#peek FCGX_Request, in)
97−peekOut = (#peek FCGX_Request, out)
98−
99−peekEnvp :: Ptr FCGX_Request -> IO Environ
100−peekEnvp = (#peek FCGX_Request, envp)
101−
102−foreign import ccall unsafe "fcgiapp.h FCGX_InitRequest" fcgx_initrequest
103− :: Ptr FCGX_Request -> CInt -> CInt -> IO CInt
104−
105−foreign import ccall safe "fcgiapp.h FCGX_Accept_r" fcgx_accept_r
106− :: Ptr FCGX_Request -> IO CInt
107−
108−acceptRequest :: IO (Ptr FCGX_Request)
109−acceptRequest = do
110− reqp <- mallocBytes (#size FCGX_Request)
111− initAndAccept reqp
112− return reqp
113− where initAndAccept reqp = do
114− testReturn "FCGX_InitRequest" $ fcgx_initrequest reqp 0 0
115− testReturn "FCGX_Accept_r" $ fcgx_accept_r reqp
116−
117−withRequest :: (Ptr FCGX_Request -> IO ()) -> IO ()
118−withRequest f = do
119− req <- acceptRequest
120− f req `finally` finishRequest req
121−
122−foreign import ccall unsafe "fcgiapp.h FCGX_Finish_r" fcgx_finish_r
123− :: Ptr FCGX_Request -> IO ()
124−
125−finishRequest :: Ptr FCGX_Request -> IO ()
126−finishRequest reqp = do
127− fcgx_finish_r reqp
128− free reqp
129−
130−handleRequest :: W.Application
131− -> StreamPtr
132− -> StreamPtr
133− -> Environ
134− -> Maybe S.ByteString -- sendfile
135− -> IO ()
136−handleRequest f ins outs env xsendfile = do
137− vars <- environToTable env
138− let vars' = map (S8.unpack *** S8.unpack) vars
139− let input = const $ sRead ins
140− let hPut = sPutStr' outs
141− CGI.runGeneric vars' (CGI.requestBodyFunc input) hPut xsendfile f
142−
143−data FCGX_Request
144−
145−--
146−-- * Stream IO
147−--
148−
149−sPutStr' :: StreamPtr -> BS.ByteString -> IO ()
150−sPutStr' h str =
151− BSB.unsafeUseAsCStringLen str $ fcgxPutCStringLen h
152−
153−fcgxPutCStringLen :: StreamPtr -> CStringLen -> IO ()
154−fcgxPutCStringLen h (cs,len) =
155− testReturn "FCGX_PutStr" $ fcgx_putStr cs (fromIntegral len) h
156−
157−sRead :: StreamPtr -> IO (Maybe BS.ByteString)
158−sRead h = buildByteString (fcgxGetBuf h) 4096
159−
160−fcgxGetBuf :: StreamPtr -> Ptr a -> Int -> IO Int
161−fcgxGetBuf h p c =
162− liftM fromIntegral $ fcgx_getStr (castPtr p) (fromIntegral c) h
163−
164−--
165−-- * ByteString utilities
166−--
167−
168−-- | Data.ByteString.Lazy.hGetContentsN generalized to arbitrary
169−-- reading functions.
170−buildByteString :: (Ptr Word8 -> Int -> IO Int) -> Int -> IO (Maybe BS.ByteString)
171−buildByteString f k = do
172− ps <- BSB.createAndTrim k $ \p -> f p k
173− case BS.length ps of
174− 0 -> return Nothing
175− _ -> return $ Just ps
176−
177−--
178−-- * Utilities
179−--
180−
181−testReturn :: String -> IO CInt -> IO ()
182−testReturn e = throwIfNeg_ (\n -> e ++ " failed with error code: "++ show n)
183−
184−environToTable :: Environ -> IO [(S.ByteString, S.ByteString)]
185−environToTable arr = do
186− css <- peekArray0 nullPtr arr
187− ss <- mapM S.packCString css
188− return $ map splitEq ss
189− where
190− splitEq s =
191− let (a, b) = S.breakByte 61 s
192− in (a, S.drop 1 b)
wai-handler-fastcgi/READMEdeleted

No changes to the content.

wai-handler-fastcgi/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-fastcgi/configuredeleted−9
@@ -1,9 +0,0 @@
1−#!/bin/sh
2−#
3−
4−# subst standard header path variables
5−if test -n "$CPPFLAGS" ; then
6− echo "Found CPPFLAGS in environment: '$CPPFLAGS'"
7− sed 's,@CPPFLAGS@,'"$CPPFLAGS"',g;s,@LDFLAGS@,'"$LDFLAGS"',g' \
8− < fastcgi.buildinfo.in > fastcgi.buildinfo
9−fi
wai-handler-fastcgi/fastcgi.buildinfo.indeleted−3
@@ -1,3 +0,0 @@
1−ghc-options: -optc@CPPFLAGS@
2−cc-options: @CPPFLAGS@
3−ld-options: @LDFLAGS@
wai-handler-fastcgi/lighttpd.confdeleted−19
@@ -1,19 +0,0 @@
1−# Run with lighttpd -D -f lighttpd.conf
2−server.port = 3000
3−server.document-root = "."
4−server.modules = ("mod_fastcgi", "mod_rewrite")
5−
6−url.rewrite-once = (
7− "(.*)" => "/app/$1"
8−)
9−
10−fastcgi.server = (
11− "/app" => ((
12− "socket" => "/tmp/test.fastcgi.socket",
13− "check-local" => "disable",
14− "bin-path" => "./test",
15− "min-procs" => 1,
16− "max-procs" => 12,
17− "idle-timeout" => 30
18− ))
19−)
wai-handler-fastcgi/test.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.FastCGI
4−import Control.Monad.IO.Class
5−import qualified Data.ByteString.Lazy as L
6−import qualified Data.ByteString.Lazy.Char8 as L8
7−import qualified Data.Enumerator as E
8−
9−main = run app
10−
11−app req
12− | pathInfo req == "/" = return $ responseLBS status200 [("Content-Type", "text/html")] "<form method='post' action='/post'><input type='text' name='name'><input type='submit'></form>"
13−app req = do
14− bss <- E.consume
15− return $ responseLBS status200 [("Content-Type", "text/plain")] $ L.concat
16− [ L8.pack $ show $ requestHeaders req
17− , "\n"
18− , L.fromChunks bss
19− ]
wai-handler-fastcgi/wai-handler-fastcgi.cabaldeleted−31
@@ -1,31 +0,0 @@
1−name: wai-handler-fastcgi
2−version: 3.0.0
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Wai handler to fastcgi
8−category: Web
9−stability: stable
10−cabal-version: >= 1.6
11−build-type: Configure
12−extra-source-files: configure fastcgi.buildinfo.in
13−homepage: http://www.yesodweb.com/book/web-application-interface
14−description: Calls out to the libfcgi C library.
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 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/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/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−35
@@ -1,35 +0,0 @@
1−Name: wai-handler-launch
2−Version: 3.0.0
3−Synopsis: Launch a web app in the default browser.
4−Description: This handles cross-platform launching and inserts Javascript code to ping the server. When the server no longer receives pings, it shuts down.
5−License: MIT
6−License-file: LICENSE
7−Author: Michael Snoyman
8−Maintainer: michael@snoyman.com
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.6
12−
13−Library
14− Exposed-modules: Network.Wai.Handler.Launch
15− build-depends: base >= 4 && < 5
16− , wai >= 3.0 && < 3.1
17− , warp >= 3.0 && < 3.1
18− , http-types >= 0.7
19− , transformers >= 0.2.2
20− , bytestring >= 0.9.1.4
21− , blaze-builder >= 0.2.1.4 && < 0.4
22− , streaming-commons
23−
24− if os(windows)
25− c-sources: windows.c
26− cpp-options: -DWINDOWS
27− extra-libraries: Shell32
28− else
29− build-depends: process >= 1.0 && < 1.3
30− if os(darwin)
31− cpp-options: -DMAC
32−
33−source-repository head
34− type: git
35− 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/LICENSEdeleted−20
@@ -1,20 +0,0 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2−
3−Permission is hereby granted, free of charge, to any person obtaining
4−a copy of this software and associated documentation files (the
5−"Software"), to deal in the Software without restriction, including
6−without limitation the rights to use, copy, modify, merge, publish,
7−distribute, sublicense, and/or sell copies of the Software, and to
8−permit persons to whom the Software is furnished to do so, subject to
9−the following conditions:
10−
11−The above copyright notice and this permission notice shall be
12−included in all copies or substantial portions of the Software.
13−
14−THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15−EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16−MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17−NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18−LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19−OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20−WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-handler-webkit/Network/Wai/Handler/Webkit.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−module Network.Wai.Handler.Webkit (run) where
3−
4−import Network.Wai (Application)
5−import qualified Network.Wai.Handler.Warp as S
6−import Control.Concurrent (forkOS)
7−import Control.Concurrent.MVar
8−import Foreign.C.String (CString, withCString)
9−import Control.Exception (finally)
10−
11−run :: String -- ^ Title to show in titlebar
12− -> Application -> IO ()
13−run title app = do
14− mvar <- newEmptyMVar
15− _ <- forkOS $ finally (S.run 3000 app) (putMVar mvar ())
16− _ <- forkOS $ finally (withCString title startBrowser) (putMVar mvar ())
17− _ <- takeMVar mvar
18− return ()
19−
20−foreign import ccall "start_browser"
21− startBrowser :: CString -> IO ()
wai-handler-webkit/README.mddeleted−53
@@ -1,53 +0,0 @@
1−wai-handler-webkit
2−==================
3−
4−Turn WAI applications into standalone GUIs using Qt WebKit.
5−
6−
7−Linux
8−-----
9−
10−You'll need the appropriate system libraries, on Ubuntu:
11−
12− apt-get install libqtwebkit-dev
13−
14−On Lucid, this required adding a PPA:
15−
16− sudo add-apt-repository ppa:kubuntu-ppa/backports
17−
18−
19−Windows
20−-------
21−
22−Install the Qt SDK from <http://qt.nokia.com/downloads/>
23−
24−Your application's Cabal file will require certain options for Windows,
25−shown below. In particular, we need to link with `g++`, so make sure
26−it's in your `PATH`. The option `-optl-mwindows` ensures that the
27−application does not open a terminal.
28−
29− if os(windows)
30− ghc-options: -Wall -threaded -pgml g++ -optl-static -optl-mwindows
31− else
32− ghc-options: -Wall
33−
34−Run `cabal-install` with the Qt `include` and `lib` directories.
35−
36− export QT_PATH=c:/QtSDK/Desktop/Qt/4.7.3/mingw
37−
38− cabal-dev install \
39− --extra-include-dirs=$QT_PATH/include \
40− --extra-include-dirs=$QT_PATH/include/QtCore \
41− --extra-include-dirs=$QT_PATH/include/QtNetwork \
42− --extra-include-dirs=$QT_PATH/include/QtGui \
43− --extra-include-dirs=$QT_PATH/include/QtWebKit \
44− --extra-lib-dirs=$QT_PATH/lib
45−
46−You'll need to include these DLLs with your application:
47−
48− phonon4.dll
49− libgcc_s_dw2-1.dll
50− QtCore4.dll
51− QtGui4.dll
52− QtNetwork4.dll
53− QtWebKit4.dll
wai-handler-webkit/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-webkit/sample.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.Webkit
4−import Network.HTTP.Types
5−
6−main :: IO ()
7−main = run "Sample App" app
8−
9−app :: Application
10−app _ = return $ responseLBS status200 [("Content-Type", "text/html")] "<h1>Hello World!</h1>"
wai-handler-webkit/wai-handler-webkit.cabaldeleted−31
@@ -1,31 +0,0 @@
1−name: wai-handler-webkit
2−version: 3.0.0
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Turn WAI applications into standalone GUIs using QtWebkit.
8−description: Runs any WAI application using
9− the simpleserver handler and then pops up a Webkit browser
10− to view it.
11−category: Web
12−stability: unstable
13−cabal-version: >= 1.6
14−build-type: Simple
15−homepage: https://github.com/yesodweb/wai/tree/master/wai-handler-webkit
16−
17−library
18− build-depends: base >= 4 && < 5
19− , wai >= 3.0 && < 3.1
20− , warp >= 3.0 && < 3.1
21− ghc-options: -Wall
22− exposed-modules: Network.Wai.Handler.Webkit
23− c-sources: webkit.cpp
24− if os(windows)
25− extra-libraries: QtCore4, QtGui4, QtNetwork4, QtWebKit4
26− else
27− pkgconfig-depends: QtWebKit
28−
29−source-repository head
30− type: git
31− location: git://github.com/yesodweb/wai.git
wai-handler-webkit/webkit.cppdeleted−19
@@ -1,19 +0,0 @@
1−#include <QApplication>
2−#include <QPushButton>
3−#include <QtWebKit>
4−
5−extern "C" {
6− int start_browser(char *title)
7− {
8− char *argv[1];
9− argv[0] = title;
10− int argc = 1;
11−
12− QApplication app(argc, argv);
13− QWebView *view = new QWebView();
14− view->load(QUrl("http://localhost:3000/"));
15− view->show();
16−
17− return app.exec();
18− }
19−}
wai-test/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-test/.ghcideleted−1
@@ -1 +0,0 @@
1−:set -itest -optP-include -optPdist/build/autogen/cabal_macros.h
wai-test/Setup.lhsdeleted−8
@@ -1,8 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−> import System.Cmd (system)
6−
7−> main :: IO ()
8−> main = defaultMain
wai-test/wai-test.cabaldeleted−16
@@ -1,16 +0,0 @@
1−name: wai-test
2−version: 3.0.0
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Unit test framework (built on HUnit) for WAI applications. (deprecated)
8−description: Since WAI 3.0, this code has been merged into wai-extra.
9−category: Testing, Web, Yesod
10−stability: Stable
11−cabal-version: >= 1.8
12−build-type: Simple
13−homepage: http://www.yesodweb.com/book/web-application-interface
14−
15−library
16− build-depends: wai >= 3.0
wai-websockets/ChangeLog.mdnew file+27
@@ -0,0 +1,27 @@
1+## 3.0.1.2
2+
3+* Drop unused dependency on blaze-builder
4+
5+## 3.0.1.1
6+
7+* Doc improvement
8+
9+## 3.0.1
10+
11+* Improved connection close logic
12+
13+## 3.0.0.9
14+
15+* Clean up stream resources when websockets completes [#549](https://github.com/yesodweb/wai/pull/549)
16+
17+## 3.0.0.8
18+
19+* Support wai 3.2
20+
21+## 3.0.0.7
22+
23+* Improved documentation [#471](https://github.com/yesodweb/wai/pull/471)
24+
25+## 3.0.0.5
26+
27+Allow blaze-builder 0.4
wai-websockets/Network/Wai/Handler/WebSockets.hs+56−19
@@ -1,12 +1,13 @@
11{-# LANGUAGE OverloadedStrings #-}
22module Network.Wai.Handler.WebSockets
3− ( websocketsApp
4− , websocketsOr
3+ ( websocketsOr
4+ , websocketsApp
55 , isWebSocketsReq
66 , getRequestHead
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
@@ -18,11 +19,38 @@ import qualified Network.WebSockets.Connection as WS
1819import qualified Network.WebSockets.Stream as WS
1920
2021--------------------------------------------------------------------------------
22+-- | Returns whether or not the given 'Wai.Request' is a WebSocket request.
2123isWebSocketsReq :: Wai.Request -> Bool
2224isWebSocketsReq req =
2325 fmap CI.mk (lookup "upgrade" $ Wai.requestHeaders req) == Just "websocket"
2426
2527--------------------------------------------------------------------------------
28+-- | Upgrade a @websockets@ 'WS.ServerApp' to a @wai@ 'Wai.Application'. Uses
29+-- the given backup 'Wai.Application' to handle 'Wai.Request's that are not
30+-- WebSocket requests.
31+--
32+-- @
33+-- websocketsOr opts ws_app backup_app = \\req respond ->
34+-- __case__ 'websocketsApp' opts ws_app req __of__
35+-- 'Nothing' -> backup_app req send_response
36+-- 'Just' res -> respond res
37+-- @
38+--
39+-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
40+-- each connected client.
41+--
42+-- @
43+-- app :: 'Wai.Application'
44+-- app = 'websocketsOr' 'WS.defaultConnectionOptions' wsApp backupApp
45+-- __where__
46+-- wsApp :: 'WS.ServerApp'
47+-- wsApp pending_conn = do
48+-- conn <- 'WS.acceptRequest' pending_conn
49+-- 'WS.sendTextData' conn ("Hello, client!" :: 'Data.Text.Text')
50+--
51+-- backupApp :: 'Wai.Application'
52+-- backupApp _ respond = respond $ 'Wai.responseLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
53+-- @
2654websocketsOr :: WS.ConnectionOptions
2755 -> WS.ServerApp
2856 -> Wai.Application
@@ -33,6 +61,11 @@ websocketsOr opts app backup req sendResponse =
3361 Just res -> sendResponse res
3462
3563--------------------------------------------------------------------------------
64+-- | Handle a single @wai@ 'Wai.Request' with the given @websockets@
65+-- 'WS.ServerApp'. Returns 'Nothing' if the 'Wai.Request' is not a WebSocket
66+-- request, 'Just' otherwise.
67+--
68+-- Usually, 'websocketsOr' is more convenient.
3669websocketsApp :: WS.ConnectionOptions
3770 -> WS.ServerApp
3871 -> Wai.Request
@@ -55,27 +88,31 @@ getRequestHead req = WS.RequestHead
5588 (Wai.isSecure req)
5689
5790--------------------------------------------------------------------------------
58−---- | Internal function to run the WebSocket io-streams using the conduit library
91+-- | Internal function to run the WebSocket io-streams using the conduit library.
5992runWebSockets :: WS.ConnectionOptions
6093 -> WS.RequestHead
6194 -> (WS.PendingConnection -> IO a)
6295 -> IO ByteString
6396 -> (ByteString -> IO ())
6497 -> IO a
65−runWebSockets opts req app src sink = do
66− stream <- WS.makeStream
67− (do
68− bs <- src
69− return $ if BC.null bs then Nothing else Just bs)
70− (\mbBl -> case mbBl of
71− Nothing -> return ()
72− Just bl -> mapM_ sink (BL.toChunks bl))
73−
74− let pc = WS.PendingConnection
75− { WS.pendingOptions = opts
76− , WS.pendingRequest = req
77− , WS.pendingOnAccept = \_ -> return ()
78− , WS.pendingStream = stream
79− }
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))
80112
81− 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/README.mdnew file+3
@@ -0,0 +1,3 @@
1+## wai-websockets
2+
3+Use websockets with WAI applications, primarily those hosted via Warp.
wai-websockets/server.lhs+55−39
@@ -8,16 +8,17 @@ 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 (fromException, handle)
16+> import Control.Exception (finally)
1517> import Control.Monad (forM_, forever)
16−> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, forkIO)
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
20−
2122> import qualified Network.WebSockets as WS
2223> import qualified Network.Wai
2324> import qualified Network.Wai.Handler.Warp as Warp
@@ -25,7 +26,9 @@ nearby to check out the functions we use.
2526> import qualified Network.Wai.Application.Static as Static
2627> import Data.FileEmbed (embedDir)
2728
28−We represent a client by his username and a 'WS.Connection'. We will see how we obtain this 'WS.Connection' later on.
29+
30+We represent a client by their username and a `WS.Connection`. We will see how we
31+obtain this `WS.Connection` later on.
2932
3033> type Client = (Text, WS.Connection)
3134
@@ -35,73 +38,88 @@ later on.
3538
3639> type ServerState = [Client]
3740
38−Create a new, initial state
41+Create a new, initial state:
3942
4043> newServerState :: ServerState
4144> newServerState = []
4245
43−Get the number of active clients
46+Get the number of active clients:
4447
4548> numClients :: ServerState -> Int
4649> numClients = length
4750
48−Check if a user already exists (based on username)
51+Check if a user already exists (based on username):
4952
5053> clientExists :: Client -> ServerState -> Bool
5154> clientExists client = any ((== fst client) . fst)
5255
53−Add a client (first, you should verify the client is not already connected using
54−'clientExists')
56+Add a client (this does not check if the client already exists, you should do
57+this yourself using `clientExists`):
5558
5659> addClient :: Client -> ServerState -> ServerState
5760> addClient client clients = client : clients
5861
59−Remove a client
62+Remove a client:
6063
6164> removeClient :: Client -> ServerState -> ServerState
6265> removeClient client = filter ((/= fst client) . fst)
6366
64−Send a message to all clients, and log it on stdout.
67+Send a message to all clients, and log it on stdout:
6568
6669> broadcast :: Text -> ServerState -> IO ()
6770> broadcast message clients = do
6871> T.putStrLn message
69−> forM_ clients $ \(_, conn) -> forkIO $ WS.sendTextData conn message
72+> forM_ clients $ \(_, conn) -> WS.sendTextData conn message
7073
7174The main function first creates a new state for the server, then spawns the
72−actual server. For this purpose, we use the simple server provided by
73−'WS.runServer'.
75+actual server.
7476
7577> main :: IO ()
7678> main = do
7779> putStrLn "http://localhost:9160/client.html"
7880> state <- newMVar newServerState
79−> Warp.runSettings Warp.defaultSettings
80−> { Warp.settingsPort = 9160
81−> } $ WaiWS.websocketsOr WS.defaultConnectionOptions (application state) staticApp
81+> Warp.runSettings
82+> (Warp.setPort 9160 Warp.defaultSettings)
83+> $ WaiWS.websocketsOr WS.defaultConnectionOptions (application state) staticApp
8284
8385> staticApp :: Network.Wai.Application
8486> staticApp = Static.staticApp $ Static.embeddedSettings $(embedDir "static")
8587
86−When a client connects, we accept the connection, regardless of the path.
88+Our main application has the type:
8789
8890> application :: MVar ServerState -> WS.ServerApp
91+
92+Note that `WS.ServerApp` is nothing but a type synonym for
93+`WS.PendingConnection -> IO ()`.
94+
95+Our application starts by accepting the connection. In a more realistic
96+application, you probably want to check the path and headers provided by the
97+pending request.
98+
99+We also fork a pinging thread in the background. This will ensure the connection
100+stays alive on some browsers.
101+
89102> application state pending = do
90103> conn <- WS.acceptRequest pending
104+#if __GLASGOW_HASKELL__ >= 806
105+> WS.withPingThread conn 30 (return ()) $ do
106+#else
107+> WS.forkPingThread conn 30
108+#endif
91109
92−When a client is succesfully connected, we read the first message. This should
93−be in the format of "Hi, I am Jasper", where Jasper is the requested username.
110+When a client is successfully connected, we read the first message. This should
111+be in the format of "Hi! I am Jasper", where Jasper is the requested username.
94112
95113> msg <- WS.receiveData conn
96114> clients <- liftIO $ readMVar state
97115> case msg of
98116
99−Check that the first message has the right format
117+Check that the first message has the right format:
100118
101119> _ | not (prefix `T.isPrefixOf` msg) ->
102120> WS.sendTextData conn ("Wrong announcement" :: Text)
103121
104−Check the validity of the username
122+Check the validity of the username:
105123
106124> | any ($ fst client)
107125> [T.null, T.any isPunctuation, T.any isSpace] ->
@@ -109,14 +127,15 @@ Check the validity of the username
109127> "contain punctuation or whitespace, and " `mappend`
110128> "cannot be empty" :: Text)
111129
112−Check that the given username is not already taken
130+Check that the given username is not already taken:
113131
114132> | clientExists client clients ->
115133> WS.sendTextData conn ("User already exists" :: Text)
116134
117−All is right!
135+All is right! We're going to allow the client, but for safety reasons we *first*
136+setup a `disconnect` function that will be run when the exception is closed.
118137
119−> | otherwise -> do
138+> | otherwise -> flip finally disconnect $ do
120139
121140We send a "Welcome!", according to our own little protocol. We add the client to
122141the list and broadcast the fact that he has joined. Then, we give control to the
@@ -131,22 +150,19 @@ the list and broadcast the fact that he has joined. Then, we give control to the
131150> return s'
132151> talk conn state client
133152> where
134−> prefix = "Hi! I am "
135−> client = (T.drop (T.length prefix) msg, conn)
153+> prefix = "Hi! I am "
154+> client = (T.drop (T.length prefix) msg, conn)
155+> disconnect = do
156+> -- Remove client and return new state
157+> s <- modifyMVar state $ \s ->
158+> let s' = removeClient client s in return (s', s')
159+> broadcast (fst client `mappend` " disconnected") s
136160
137161The talk function continues to read messages from a single client until he
138162disconnects. All messages are broadcasted to the other clients.
139163
140164> talk :: WS.Connection -> MVar ServerState -> Client -> IO ()
141−> talk conn state client@(user, _) = handle catchDisconnect $
142−> forever $ do
143−> msg <- WS.receiveData conn
144−> liftIO $ readMVar state >>= broadcast
145−> (user `mappend` ": " `mappend` msg)
146−> where
147−> catchDisconnect e = case fromException e of
148−> Just WS.ConnectionClosed -> liftIO $ modifyMVar_ state $ \s -> do
149−> let s' = removeClient client s
150−> broadcast (user `mappend` " disconnected") s'
151−> return s'
152−> _ -> return ()
165+> talk conn state (user, _) = forever $ do
166+> msg <- WS.receiveData conn
167+> liftIO $ readMVar state >>= broadcast
168+> (user `mappend` ": " `mappend` msg)
wai-websockets/wai-websockets.cabal+6−6
@@ -1,6 +1,6 @@
11Name: wai-websockets
2−Version: 3.0.0.2
3−Synopsis: Provide a bridge betweeen WAI and the websockets package.
2+Version: 3.0.1.2
3+Synopsis: Provide a bridge between WAI and the websockets package.
44License: MIT
55License-file: LICENSE
66Author: Michael Snoyman, Jasper Van der Jeugt, Ting-Yen Lai
@@ -10,17 +10,17 @@ Category: Web, Yesod
1010Build-Type: Simple
1111Cabal-Version: >=1.8
1212Stability: Stable
13−Description: This is primarily intended for use with Warp and its settingsIntercept.
13+description: API docs and the README are available at <http://www.stackage.org/package/wai-websockets>.
1414
1515extra-source-files: static/client.js, static/client.html, static/screen.css
16+ README.md ChangeLog.md
1617
1718flag example
1819
1920Library
2021 Build-Depends: base >= 3 && < 5
2122 , bytestring >= 0.9.1.4
22− , wai >= 3.0 && < 3.1
23− , blaze-builder >= 0.2.1.4 && < 0.4
23+ , wai >= 3.0 && < 3.3
2424 , case-insensitive >= 0.2
2525 , network >= 2.2.1.5
2626 , transformers >= 0.2
@@ -40,12 +40,12 @@ Executable wai-websockets-example
4040 , wai-app-static
4141 , bytestring
4242 , case-insensitive
43− , blaze-builder
4443 , transformers
4544 , network
4645 , text
4746 , file-embed
4847 , http-types
48+ other-modules: Network.Wai.Handler.WebSockets
4949 else
5050 buildable: False
5151
wai/ChangeLog.mdnew file+56
@@ -0,0 +1,56 @@
1+# ChangeLog for wai
2+
3+## 3.2.2.1
4+
5+* Fix missing reexport of `getRequestBodyChunk` [#753](https://github.com/yesodweb/wai/issues/753)
6+
7+## 3.2.2
8+
9+* Deprecate `requestBody` in favor of the more clearly named `getRequestBodyChunk`. [#726](https://github.com/yesodweb/wai/pull/726)
10+
11+## 3.2.1.2
12+
13+* Remove dependency on blaze-builder [#683](https://github.com/yesodweb/wai/pull/683)
14+
15+## 3.2.1.1
16+
17+* Relax upper bound on bytestring-builder
18+
19+## 3.2.1
20+
21+* add mapResponseStatus [#532](https://github.com/yesodweb/wai/pull/532)
22+
23+## 3.2.0.1
24+
25+* Add missing changelog entry
26+
27+## 3.2.0
28+
29+* Major version up due to breaking changes. We chose 3.2.0, not 3.1.0
30+ for consistency with Warp 3.2.0.
31+* The Network.Wai.HTTP2 module was removed.
32+* tryGetFileSize, hContentRange, hAcceptRanges, contentRangeHeader and
33+ chooseFilePart, adjustForFilePart and parseByteRanges were removed
34+ from the Network.Wai.Internal module.
35+* New fields for Request: requestHeaderReferer and requestHeaderUserAgent.
36+
37+## 3.0.5.0
38+
39+* Avoid using the IsString Builder instance
40+
41+## 3.0.4.0
42+
43+* A new module Network.Wai.HTTP2 is exported.
44+
45+## 3.0.3.0
46+
47+* mapResponseHeaders, ifRequest and modifyResponse are exported.
48+
49+## 3.0.2.3
50+
51+* Allow blaze-builder 0.4
52+
53+## 3.0.2.2
54+
55+* Clarify some documentation on `rawPathInfo`. [Relevant Github
56+ discussion](https://github.com/yesodweb/wai/issues/325#issuecomment-69896780).
wai/Network/Wai.hs+75−37
@@ -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
@@ -71,14 +73,20 @@ module Network.Wai
7173 , responseLBS
7274 , responseStream
7375 , responseRaw
74− -- * Response accessors
76+ -- ** Response accessors
7577 , responseStatus
7678 , responseHeaders
79+ -- ** Response modifiers
7780 , responseToStream
81+ , mapResponseHeaders
82+ , mapResponseStatus
83+ -- * Middleware composition
84+ , ifRequest
85+ , modifyResponse
7886 ) where
7987
80−import Blaze.ByteString.Builder (Builder, fromLazyByteString)
81−import Blaze.ByteString.Builder (fromByteString)
88+import Data.ByteString.Builder (Builder, lazyByteString)
89+import Data.ByteString.Builder (byteString)
8290import Control.Monad (unless)
8391import qualified Data.ByteString as B
8492import qualified Data.ByteString.Lazy as L
@@ -86,7 +94,6 @@ import qualified Data.ByteString.Lazy.Internal as LI
8694import Data.ByteString.Lazy.Internal (defaultChunkSize)
8795import Data.ByteString.Lazy.Char8 ()
8896import Data.Function (fix)
89−import Data.Monoid (mempty)
9097import qualified Network.HTTP.Types as H
9198import Network.Socket (SockAddr (SockAddrInet))
9299import Network.Wai.Internal
@@ -114,13 +121,13 @@ responseFile = ResponseFile
114121--
115122-- A2. No. If the ByteStrings are small, then they will be copied into a larger
116123-- buffer, which should be a performance gain overall (less system calls). If
117−-- they are already large, then blaze-builder uses an InsertByteString
118−-- instruction to avoid copying.
124+-- they are already large, then an insert operation is used
125+-- to avoid copying.
119126--
120127-- Q3. Doesn't this prevent us from creating comet-style servers, since data
121128-- will be cached?
122129--
123−-- 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
124131-- optimal size by sending a flush command.
125132responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
126133responseBuilder = ResponseBuilder
@@ -128,7 +135,7 @@ responseBuilder = ResponseBuilder
128135-- | Creating 'Response' from 'L.ByteString'. This is a wrapper for
129136-- 'responseBuilder'.
130137responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
131−responseLBS s h = ResponseBuilder s h . fromLazyByteString
138+responseLBS s h = ResponseBuilder s h . lazyByteString
132139
133140-- | Creating 'Response' from a stream of values.
134141--
@@ -142,9 +149,9 @@ responseLBS s h = ResponseBuilder s h . fromLazyByteString
142149-- (putStrLn \"Allocating scarce resource\")
143150-- (putStrLn \"Cleaning up\")
144151-- $ respond $ responseStream status200 [] $ \\write flush -> do
145−-- write $ fromByteString \"Hello\\n\"
152+-- write $ byteString \"Hello\\n\"
146153-- flush
147−-- write $ fromByteString \"World\\n\"
154+-- write $ byteString \"World\\n\"
148155-- @
149156--
150157-- Note that in some cases you can use @bracket@ from inside @responseStream@
@@ -207,7 +214,7 @@ responseToStream (ResponseFile s h fp (Just part)) =
207214 bs <- B.hGetSome handle defaultChunkSize
208215 unless (B.null bs) $ do
209216 let x = B.take remaining bs
210− sendChunk $ fromByteString x
217+ sendChunk $ byteString x
211218 loop $ remaining - B.length x
212219 loop $ fromIntegral $ filePartByteCount part
213220 )
@@ -218,13 +225,27 @@ responseToStream (ResponseFile s h fp Nothing) =
218225 withBody $ \sendChunk _flush -> fix $ \loop -> do
219226 bs <- B.hGetSome handle defaultChunkSize
220227 unless (B.null bs) $ do
221− sendChunk $ fromByteString bs
228+ sendChunk $ byteString bs
222229 loop
223230 )
224231responseToStream (ResponseBuilder s h b) =
225232 (s, h, \withBody -> withBody $ \sendChunk _flush -> sendChunk b)
226233responseToStream (ResponseRaw _ res) = responseToStream res
227234
235+-- | Apply the provided function to the response header list of the Response.
236+mapResponseHeaders :: (H.ResponseHeaders -> H.ResponseHeaders) -> Response -> Response
237+mapResponseHeaders f (ResponseFile s h b1 b2) = ResponseFile s (f h) b1 b2
238+mapResponseHeaders f (ResponseBuilder s h b) = ResponseBuilder s (f h) b
239+mapResponseHeaders f (ResponseStream s h b) = ResponseStream s (f h) b
240+mapResponseHeaders _ r@(ResponseRaw _ _) = r
241+
242+-- | Apply the provided function to the response status of the Response.
243+mapResponseStatus :: (H.Status -> H.Status) -> Response -> Response
244+mapResponseStatus f (ResponseFile s h b1 b2) = ResponseFile (f s) h b1 b2
245+mapResponseStatus f (ResponseBuilder s h b) = ResponseBuilder (f s) h b
246+mapResponseStatus f (ResponseStream s h b) = ResponseStream (f s) h b
247+mapResponseStatus _ r@(ResponseRaw _ _) = r
248+
228249----------------------------------------------------------------
229250
230251-- | The WAI application.
@@ -242,21 +263,6 @@ responseToStream (ResponseRaw _ res) = responseToStream res
242263-- @
243264type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
244265
245−-- | Middleware is a component that sits between the server and application. It
246−-- can do such tasks as GZIP encoding or response caching. What follows is the
247−-- general definition of middleware, though a middleware author should feel
248−-- free to modify this.
249−--
250−-- As an example of an alternate type for middleware, suppose you write a
251−-- function to load up session information. The session information is simply a
252−-- string map \[(String, String)\]. A logical type signature for this middleware
253−-- might be:
254−--
255−-- @ loadSession :: ([(String, String)] -> Application) -> Application @
256−--
257−-- Here, instead of taking a standard 'Application' as its first argument, the
258−-- middleware takes a function which consumes the session information as well.
259−type Middleware = Application -> Application
260266
261267-- | A default, blank request.
262268--
@@ -277,8 +283,40 @@ defaultRequest = Request
277283 , requestBodyLength = KnownLength 0
278284 , requestHeaderHost = Nothing
279285 , requestHeaderRange = Nothing
286+ , requestHeaderReferer = Nothing
287+ , requestHeaderUserAgent = Nothing
280288 }
281289
290+
291+-- | Middleware is a component that sits between the server and application. It
292+-- can do such tasks as GZIP encoding or response caching. What follows is the
293+-- general definition of middleware, though a middleware author should feel
294+-- free to modify this.
295+--
296+-- As an example of an alternate type for middleware, suppose you write a
297+-- function to load up session information. The session information is simply a
298+-- string map \[(String, String)\]. A logical type signature for this middleware
299+-- might be:
300+--
301+-- @ loadSession :: ([(String, String)] -> Application) -> Application @
302+--
303+-- Here, instead of taking a standard 'Application' as its first argument, the
304+-- middleware takes a function which consumes the session information as well.
305+type Middleware = Application -> Application
306+
307+
308+-- | apply a function that modifies a response as a 'Middleware'
309+modifyResponse :: (Response -> Response) -> Middleware
310+modifyResponse f app req respond = app req $ respond . f
311+
312+
313+-- | conditionally apply a 'Middleware'
314+ifRequest :: (Request -> Bool) -> Middleware -> Middleware
315+ifRequest rpred middle app req | rpred req = middle app req
316+ | otherwise = app req
317+
318+
319+
282320-- | Get the request body as a lazy ByteString. However, do /not/ use any lazy
283321-- I\/O, instead reading the entire body into memory strictly.
284322--
@@ -288,7 +326,7 @@ strictRequestBody req =
288326 loop id
289327 where
290328 loop front = do
291− bs <- requestBody req
329+ bs <- getRequestBodyChunk req
292330 if B.null bs
293331 then return $ front LI.Empty
294332 else loop (front . LI.Chunk bs)
@@ -302,7 +340,7 @@ lazyRequestBody req =
302340 loop
303341 where
304342 loop = unsafeInterleaveIO $ do
305− bs <- requestBody req
343+ bs <- getRequestBodyChunk req
306344 if B.null bs
307345 then return LI.Empty
308346 else do
wai/Network/Wai/Internal.hs+32−7
@@ -1,17 +1,15 @@
11{-# OPTIONS_HADDOCK not-home #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
32{-# LANGUAGE CPP #-}
4−{-# LANGUAGE RankNTypes #-}
53{-# LANGUAGE RecordWildCards #-}
64-- | Internal constructors and helper functions. Note that no guarantees are
75-- given for stability of these interfaces.
86module Network.Wai.Internal where
97
10−import Blaze.ByteString.Builder (Builder)
11−import qualified Data.ByteString as B
8+import Data.ByteString.Builder (Builder)
9+import qualified Data.ByteString as B hiding (pack)
1210import Data.Text (Text)
1311import Data.Typeable (Typeable)
14−import Data.Vault.Lazy (Vault)
12+import Data.Vault.Lazy (Vault)
1513import Data.Word (Word64)
1614import qualified Network.HTTP.Types as H
1715import Network.Socket (SockAddr)
@@ -19,6 +17,7 @@ import Data.List (intercalate)
1917
2018-- | Information on the request sent by the client. This abstracts away the
2119-- 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." #-}
2221data Request = Request {
2322 -- | Request method such as GET.
2423 requestMethod :: H.Method
@@ -28,7 +27,18 @@ data Request = Request {
2827 -- depending on backend; in a standalone server setting, this is most likely
2928 -- all information after the domain name. In a CGI application, this would be
3029 -- the information following the path to the CGI executable itself.
31− -- Do not modify this raw value- modify pathInfo instead.
30+ --
31+ -- Middlewares and routing tools should not modify this raw value, as it may
32+ -- be used for such things as creating redirect destinations by applications.
33+ -- Instead, if you are writing a middleware or routing framework, modify the
34+ -- @pathInfo@ instead. This is the approach taken by systems like Yesod
35+ -- subsites.
36+ --
37+ -- /Note/: At the time of writing this documentation, there is at least one
38+ -- system (@Network.Wai.UrlMap@ from @wai-extra@) that does not follow the
39+ -- above recommendation. Therefore, it is recommended that you test the
40+ -- behavior of your application when using @rawPathInfo@ and any form of
41+ -- library that might modify the @Request@.
3242 , rawPathInfo :: B.ByteString
3343 -- | If no query string was specified, this should be empty. This value
3444 -- /will/ include the leading question mark.
@@ -53,7 +63,7 @@ data Request = Request {
5363 -- | Parsed query string information.
5464 , queryString :: H.Query
5565 -- | Get the next chunk of the body. Returns 'B.empty' when the
56− -- body is fully consumed.
66+ -- body is fully consumed. Since 3.2.2, this is deprecated in favor of 'getRequestBodyChunk'.
5767 , requestBody :: IO B.ByteString
5868 -- | A location for arbitrary data to be shared by applications and middleware.
5969 , vault :: Vault
@@ -70,9 +80,24 @@ data Request = Request {
7080 --
7181 -- Since 2.0.0
7282 , 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
7391 }
7492 deriving (Typeable)
7593
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+
76101instance Show Request where
77102 show Request{..} = "Request {" ++ intercalate ", " [a ++ " = " ++ b | (a,b) <- fields] ++ "}"
78103 where
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+9−7
@@ -1,7 +1,9 @@
11Name: wai
2−Version: 3.0.2
2+Version: 3.2.2.1
33Synopsis: Web Application Interface.
44Description: Provides a common protocol for communication between web applications and web servers.
5+ .
6+ API docs and the README are available at <http://www.stackage.org/package/wai>.
57License: MIT
68License-file: LICENSE
79Author: Michael Snoyman
@@ -11,15 +13,15 @@ Category: Web
1113Build-Type: Simple
1214Cabal-Version: >=1.8
1315Stability: Stable
16+extra-source-files: README.md ChangeLog.md
1417
1518Source-repository head
1619 type: git
1720 location: git://github.com/yesodweb/wai.git
1821
1922Library
20− Build-Depends: base >= 4 && < 5
21− , bytestring >= 0.9.1.4
22− , blaze-builder >= 0.2.1.4 && < 0.4
23+ Build-Depends: base >= 4.8 && < 5
24+ , bytestring >= 0.10.4
2325 , network >= 2.2.1.5
2426 , http-types >= 0.7
2527 , text >= 0.7
@@ -32,14 +34,14 @@ test-suite test
3234 hs-source-dirs: test
3335 main-is: Spec.hs
3436 type: exitcode-stdio-1.0
35− ghc-options: -threaded
37+ ghc-options: -threaded -Wall
3638 cpp-options: -DTEST
37− build-depends: base
39+ build-depends: base >= 4.8 && < 5
3840 , wai
3941 , hspec
40− , blaze-builder
4142 , bytestring
4243 other-modules: Network.WaiSpec
44+ build-tool-depends: hspec-discover:hspec-discover
4345
4446source-repository head
4547 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+117−1
@@ -1 +1,117 @@
1−__3.0.1__ [Support for in-memory certificates and keys](https://github.com/yesodweb/wai/issues/301)
1+## 3.2.11
2+
3+* Ignoring an exception from shutdown (gracefulClose).
4+
5+## 3.2.10
6+
7+* Passing client certificate, if any, to Warp
8+ [#783](https://github.com/yesodweb/wai/pull/783)
9+
10+## 3.2.9
11+
12+* Cooperating setGracefulCloseTimeout1 and setGracefulCloseTimeout2 of Warp.
13+ [#782](https://github.com/yesodweb/wai/pull/782)
14+
15+## 3.2.8
16+
17+* Using gracefullClose of network 3.1.1 or later if available.
18+
19+## 3.2.7
20+
21+* Relaxing version constraint.
22+
23+## 3.2.6
24+
25+* Using the Strict and StrictData language extensions for GHC >8.
26+ [#752](https://github.com/yesodweb/wai/pull/752)
27+
28+## 3.2.5
29+
30+* When tls 1.5.0 is available, TLS 1.3 is automatically supported.
31+
32+## 3.2.4.3
33+
34+* Using warp >= 3.2.17.
35+
36+## 3.2.4.2
37+
38+* Ignore socket errors while sending `close_notify` [#640](https://github.com/yesodweb/wai/issues/640)
39+
40+## 3.2.4
41+
42+* Using tls-session-manager.
43+
44+## 3.2.3
45+
46+* Stop using obsoleted APIs of network.
47+
48+## 3.2.2
49+
50+* New settting parameter: tlsServerDHEParams [#556](https://github.com/yesodweb/wai/pull/556)
51+* Preventing socket leakage [#559](https://github.com/yesodweb/wai/pull/559)
52+
53+## 3.2.1
54+
55+* Removing dependency to cprng-aes.
56+
57+## 3.2.0
58+
59+* Major version up due to breaking changes.
60+* runHTTP2TLS and runHTTP2TLSSocket were removed.
61+
62+## 3.1.4
63+
64+* Add an option to disable HTTP2 [#450](https://github.com/yesodweb/wai/pull/450)
65+
66+## 3.1.3
67+
68+* Removing SHA 512 and SHA 384 from supportedCiphers to rescue Safari and golang. [#429](https://github.com/yesodweb/wai/issues/429)
69+
70+## 3.1.2
71+
72+* [Getting Rating A from the SSL Server Test](http://www.yesodweb.com/blog/2015/08/ssl-server-test)
73+
74+## 3.1.1
75+
76+* Converting "send: resource vanished (Broken pipe)" to ConnectionClosedByPeer. [#421](https://github.com/yesodweb/wai/issues/421)
77+
78+## 3.1.0
79+
80+* Supporting HTTP/2 [#399](https://github.com/yesodweb/wai/pull/399)
81+* Removing RC4 [#400](https://github.com/yesodweb/wai/issues/400)
82+
83+## 3.0.4.2
84+
85+* tls 1.3 support [#390](https://github.com/yesodweb/wai/issues/390)
86+
87+## 3.0.4.1
88+
89+* Fix for leaked FDs [#378](https://github.com/yesodweb/wai/issues/378)
90+
91+## 3.0.4
92+
93+* Replace `acceptSafe` with `accept`, see [#361](https://github.com/yesodweb/wai/issues/361)
94+
95+## 3.0.3
96+
97+* Support chain certs [#349](https://github.com/yesodweb/wai/pull/349)
98+
99+## 3.0.2
100+
101+* Allow warp-tls to request client certificates. [#337](https://github.com/yesodweb/wai/pull/337)
102+
103+## 3.0.1.4
104+
105+Add additional Diffie-Hellman RSA and DSA ciphers to warp-tls.
106+
107+## 3.0.1.3
108+
109+[Unable to allow insecure connections with warp-tls #324](https://github.com/yesodweb/wai/issues/324)
110+
111+## 3.0.1.2
112+
113+[Make sure Timer is tickled in sendfile. #323](https://github.com/yesodweb/wai/pull/323)
114+
115+## 3.0.1
116+
117+[Support for in-memory certificates and keys](https://github.com/yesodweb/wai/issues/301)
warp-tls/Network/Wai/Handler/WarpTLS.hs+364−129
@@ -1,66 +1,89 @@
1+{-# LANGUAGE CPP #-}
12{-# LANGUAGE OverloadedStrings #-}
23{-# LANGUAGE RankNTypes #-}
34{-# LANGUAGE RecordWildCards #-}
45{-# LANGUAGE DeriveDataTypeable #-}
56{-# LANGUAGE PatternGuards #-}
67
7−-- | HTTP over SSL/TLS support for Warp via the TLS package.
8+-- | HTTP over TLS support for Warp via the TLS package.
9+--
10+-- If HTTP\/2 is negotiated by ALPN, HTTP\/2 over TLS is used.
11+-- Otherwise HTTP\/1.1 over TLS is used.
12+--
13+-- Support for SSL is now obsoleted.
814
915module Network.Wai.Handler.WarpTLS (
1016 -- * Settings
1117 TLSSettings
18+ , defaultTlsSettings
19+ -- * Smart constructors
20+ , tlsSettings
21+ , tlsSettingsMemory
22+ , tlsSettingsChain
23+ , tlsSettingsChainMemory
24+ -- * Accessors
1225 , certFile
1326 , keyFile
14− , onInsecure
1527 , tlsLogging
1628 , tlsAllowedVersions
1729 , tlsCiphers
18− , defaultTlsSettings
19− , tlsSettings
20− , tlsSettingsMemory
30+ , tlsWantClientCert
31+ , tlsServerHooks
32+ , tlsServerDHEParams
33+ , tlsSessionManagerConfig
34+ , onInsecure
2135 , OnInsecure (..)
2236 -- * Runner
2337 , runTLS
2438 , runTLSSocket
2539 -- * Exception
2640 , WarpTLSException (..)
41+ , DH.Params
42+ , DH.generateParams
2743 ) where
2844
29−import qualified Network.TLS as TLS
30−import Network.Wai.Handler.Warp
31−import Network.Wai (Application)
32−import Network.Socket (Socket, sClose, withSocketsDo, SockAddr)
45+import Control.Applicative ((<|>))
46+import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..), handleJust)
47+import qualified Control.Exception as E
48+import Control.Monad (void, guard)
3349import qualified Data.ByteString as S
3450import qualified Data.ByteString.Lazy as L
35−import Control.Exception (bracket, finally, handle, fromException, try, IOException)
36−import qualified Network.TLS.Extra as TLSExtra
37−import qualified Data.ByteString as B
38−import Data.Streaming.Network (bindPortTCP, acceptSafe, safeRecv)
39−import Control.Applicative ((<$>))
51+import Data.Default.Class (def)
4052import qualified Data.IORef as I
41−import Control.Exception (Exception, throwIO)
53+import Data.Streaming.Network (bindPortTCP, safeRecv)
4254import Data.Typeable (Typeable)
43−import Data.Default.Class (def)
44−import qualified Crypto.Random.AESCtr
45−import Network.Wai.Handler.Warp.Buffer (allocateBuffer, bufferSize, freeBuffer)
55+import Network.Socket (Socket, close, withSocketsDo, SockAddr, accept)
56+#if MIN_VERSION_network(3,1,1)
57+import Network.Socket (gracefulClose)
58+#endif
4659import Network.Socket.ByteString (sendAll)
47−import Control.Monad (unless, void)
48−import Data.ByteString.Lazy.Internal (defaultChunkSize)
49−import qualified System.IO as IO
60+import qualified Network.TLS as TLS
61+import qualified Crypto.PubKey.DH as DH
62+import qualified Network.TLS.Extra as TLSExtra
63+import qualified Network.TLS.SessionManager as SM
64+import Network.Wai (Application)
65+import Network.Wai.Handler.Warp
66+import Network.Wai.Handler.Warp.Internal
5067import System.IO.Error (isEOFError)
5168
5269----------------------------------------------------------------
5370
71+-- | Settings for WarpTLS.
5472data TLSSettings = TLSSettings {
5573 certFile :: FilePath
5674 -- ^ File containing the certificate.
75+ , chainCertFiles :: [FilePath]
76+ -- ^ Files containing chain certificates.
5777 , keyFile :: FilePath
78+ -- ^ File containing the key
5879 , certMemory :: Maybe S.ByteString
80+ , chainCertsMemory :: [S.ByteString]
5981 , keyMemory :: Maybe S.ByteString
60− -- ^ File containing the key
6182 , onInsecure :: OnInsecure
62− -- ^ Do we allow insecure connections with this server as well? Default
63− -- is a simple text response stating that a secure connection is required.
83+ -- ^ Do we allow insecure connections with this server as well?
84+ --
85+ -- >>> onInsecure defaultTlsSettings
86+ -- DenyInsecure "This server only accepts secure HTTPS connections."
6487 --
6588 -- Since 1.4.0
6689 , tlsLogging :: TLS.Logging
@@ -70,50 +93,109 @@ data TLSSettings = TLSSettings {
7093 --
7194 -- Since 1.4.0
7295 , 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
73104 -- ^ The TLS versions this server accepts.
74105 --
75− -- Default: '[TLS.TLS10,TLS.TLS11,TLS.TLS12]'.
106+ -- >>> tlsAllowedVersions defaultTlsSettings
107+ -- [TLS12,TLS11,TLS10]
76108 --
77109 -- Since 1.4.2
110+#endif
78111 , tlsCiphers :: [TLS.Cipher]
112+#if MIN_VERSION_tls(1,5,0)
79113 -- ^ The TLS ciphers this server accepts.
80114 --
81− -- Default: '[TLSExtra.cipher_AES128_SHA1, TLSExtra.cipher_AES256_SHA1, TLSEtra.cipher_RC4_128_MD5, TLSExtra.cipher_RC4_128_SHA1]'
115+ -- >>> tlsCiphers defaultTlsSettings
116+ -- [ECDHE-ECDSA-AES256GCM-SHA384,ECDHE-ECDSA-AES128GCM-SHA256,ECDHE-RSA-AES256GCM-SHA384,ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256GCM-SHA384,DHE-RSA-AES128GCM-SHA256,ECDHE-ECDSA-AES256CBC-SHA384,ECDHE-RSA-AES256CBC-SHA384,DHE-RSA-AES256-SHA256,ECDHE-ECDSA-AES256CBC-SHA,ECDHE-RSA-AES256CBC-SHA,DHE-RSA-AES256-SHA1,RSA-AES256GCM-SHA384,RSA-AES256-SHA256,RSA-AES256-SHA1,AES128GCM-SHA256,AES256GCM-SHA384]
82117 --
83118 -- Since 1.4.2
119+#else
120+ -- ^ The TLS ciphers this server accepts.
121+ --
122+ -- >>> tlsCiphers defaultTlsSettings
123+ -- [ECDHE-ECDSA-AES256GCM-SHA384,ECDHE-ECDSA-AES128GCM-SHA256,ECDHE-RSA-AES256GCM-SHA384,ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256GCM-SHA384,DHE-RSA-AES128GCM-SHA256,ECDHE-ECDSA-AES256CBC-SHA384,ECDHE-RSA-AES256CBC-SHA384,DHE-RSA-AES256-SHA256,ECDHE-ECDSA-AES256CBC-SHA,ECDHE-RSA-AES256CBC-SHA,DHE-RSA-AES256-SHA1,RSA-AES256GCM-SHA384,RSA-AES256-SHA256,RSA-AES256-SHA1]
124+ --
125+ -- Since 1.4.2
126+#endif
127+ , tlsWantClientCert :: Bool
128+ -- ^ Whether or not to demand a certificate from the client. If this
129+ -- is set to True, you must handle received certificates in a server hook
130+ -- or all connections will fail.
131+ --
132+ -- >>> tlsWantClientCert defaultTlsSettings
133+ -- False
134+ --
135+ -- Since 3.0.2
136+ , tlsServerHooks :: TLS.ServerHooks
137+ -- ^ The server-side hooks called by the tls package, including actions
138+ -- to take when a client certificate is received. See the "Network.TLS"
139+ -- module for details.
140+ --
141+ -- Default: def
142+ --
143+ -- Since 3.0.2
144+ , tlsServerDHEParams :: Maybe DH.Params
145+ -- ^ Configuration for ServerDHEParams
146+ -- more function lives in `cryptonite` package
147+ --
148+ -- Default: Nothing
149+ --
150+ -- Since 3.2.2
151+ , tlsSessionManagerConfig :: Maybe SM.Config
152+ -- ^ Configuration for in-memory TLS session manager.
153+ -- If Nothing, 'TLS.noSessionManager' is used.
154+ -- Otherwise, an in-memory TLS session manager is created
155+ -- according to 'Config'.
156+ --
157+ -- Default: Nothing
158+ --
159+ -- Since 3.2.4
84160 }
85161
86−-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name.
162+-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name (aka accessors).
87163defaultTlsSettings :: TLSSettings
88164defaultTlsSettings = TLSSettings {
89165 certFile = "certificate.pem"
166+ , chainCertFiles = []
90167 , keyFile = "key.pem"
91168 , certMemory = Nothing
169+ , chainCertsMemory = []
92170 , keyMemory = Nothing
93171 , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
94172 , tlsLogging = def
95− , tlsAllowedVersions = [TLS.TLS10,TLS.TLS11,TLS.TLS12]
173+#if MIN_VERSION_tls(1,5,0)
174+ , tlsAllowedVersions = [TLS.TLS13,TLS.TLS12,TLS.TLS11,TLS.TLS10]
175+#else
176+ , tlsAllowedVersions = [TLS.TLS12,TLS.TLS11,TLS.TLS10]
177+#endif
96178 , tlsCiphers = ciphers
179+ , tlsWantClientCert = False
180+ , tlsServerHooks = def
181+ , tlsServerDHEParams = Nothing
182+ , tlsSessionManagerConfig = Nothing
97183 }
98184
99185-- taken from stunnel example in tls-extra
100186ciphers :: [TLS.Cipher]
101−ciphers =
102− [ TLSExtra.cipher_AES128_SHA1
103− , TLSExtra.cipher_AES256_SHA1
104− , TLSExtra.cipher_RC4_128_MD5
105− , TLSExtra.cipher_RC4_128_SHA1
106− ]
187+ciphers = TLSExtra.ciphersuite_strong
107188
108189----------------------------------------------------------------
109190
110191-- | An action when a plain HTTP comes to HTTP over TLS/SSL port.
111192data OnInsecure = DenyInsecure L.ByteString
112193 | AllowInsecure
194+ deriving (Show)
113195
114196----------------------------------------------------------------
115197
116−-- | A smart constructor for 'TLSSettings'.
198+-- | A smart constructor for 'TLSSettings' based on 'defaultTlsSettings'.
117199tlsSettings :: FilePath -- ^ Certificate file
118200 -> FilePath -- ^ Key file
119201 -> TLSSettings
@@ -122,8 +204,23 @@ tlsSettings cert key = defaultTlsSettings {
122204 , keyFile = key
123205 }
124206
207+-- | A smart constructor for 'TLSSettings' that allows specifying
208+-- chain certificates based on 'defaultTlsSettings'.
209+--
210+-- Since 3.0.3
211+tlsSettingsChain
212+ :: FilePath -- ^ Certificate file
213+ -> [FilePath] -- ^ Chain certificate files
214+ -> FilePath -- ^ Key file
215+ -> TLSSettings
216+tlsSettingsChain cert chainCerts key = defaultTlsSettings {
217+ certFile = cert
218+ , chainCertFiles = chainCerts
219+ , keyFile = key
220+ }
221+
125222-- | A smart constructor for 'TLSSettings', but uses in-memory representations
126−-- of the certificate and key
223+-- of the certificate and key based on 'defaultTlsSettings'.
127224--
128225-- Since 3.0.1
129226tlsSettingsMemory
@@ -135,15 +232,29 @@ tlsSettingsMemory cert key = defaultTlsSettings
135232 , keyMemory = Just key
136233 }
137234
138−----------------------------------------------------------------
235+-- | A smart constructor for 'TLSSettings', but uses in-memory representations
236+-- of the certificate and key based on 'defaultTlsSettings'.
237+--
238+-- Since 3.0.3
239+tlsSettingsChainMemory
240+ :: S.ByteString -- ^ Certificate bytes
241+ -> [S.ByteString] -- ^ Chain certificate bytes
242+ -> S.ByteString -- ^ Key bytes
243+ -> TLSSettings
244+tlsSettingsChainMemory cert chainCerts key = defaultTlsSettings
245+ { certMemory = Just cert
246+ , chainCertsMemory = chainCerts
247+ , keyMemory = Just key
248+ }
139249
250+----------------------------------------------------------------
140251
141252-- | Running 'Application' with 'TLSSettings' and 'Settings'.
142253runTLS :: TLSSettings -> Settings -> Application -> IO ()
143254runTLS tset set app = withSocketsDo $
144255 bracket
145256 (bindPortTCP (getPort set) (getHost set))
146− sClose
257+ close
147258 (\sock -> runTLSSocket tset set sock app)
148259
149260----------------------------------------------------------------
@@ -153,141 +264,265 @@ runTLS tset set app = withSocketsDo $
153264runTLSSocket :: TLSSettings -> Settings -> Socket -> Application -> IO ()
154265runTLSSocket tlsset@TLSSettings{..} set sock app = do
155266 credential <- case (certMemory, keyMemory) of
156− (Nothing, Nothing) -> either error id <$> TLS.credentialLoadX509 certFile keyFile
267+ (Nothing, Nothing) ->
268+ either error id <$>
269+ TLS.credentialLoadX509Chain certFile chainCertFiles keyFile
157270 (mcert, mkey) -> do
158271 cert <- maybe (S.readFile certFile) return mcert
159272 key <- maybe (S.readFile keyFile) return mkey
160− either error return $ TLS.credentialLoadX509FromMemory cert key
161− runTLSSocket' tlsset set credential sock app
162−
163−runTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> Socket -> Application -> IO ()
164−runTLSSocket' tlsset@TLSSettings{..} set credential sock app =
273+ either error return $
274+ TLS.credentialLoadX509ChainFromMemory cert chainCertsMemory key
275+ mgr <- case tlsSessionManagerConfig of
276+ Nothing -> return TLS.noSessionManager
277+ Just config -> SM.newSessionManager config
278+ runTLSSocket' tlsset set credential mgr sock app
279+
280+runTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> TLS.SessionManager -> Socket -> Application -> IO ()
281+runTLSSocket' tlsset@TLSSettings{..} set credential mgr sock app =
165282 runSettingsConnectionMakerSecure set get app
166283 where
167− get = getter tlsset sock params
168− params = def {
169− TLS.serverWantClientCert = False
170− , TLS.serverSupported = def {
171− TLS.supportedVersions = tlsAllowedVersions
172− , TLS.supportedCiphers = tlsCiphers
173− }
174− , TLS.serverShared = def {
175− TLS.sharedCredentials = TLS.Credentials [credential]
176− }
284+ get = getter tlsset set sock params
285+ params = def { -- TLS.ServerParams
286+ TLS.serverWantClientCert = tlsWantClientCert
287+ , TLS.serverCACertificates = []
288+ , TLS.serverDHEParams = tlsServerDHEParams
289+ , TLS.serverHooks = hooks
290+ , TLS.serverShared = shared
291+ , TLS.serverSupported = supported
292+#if MIN_VERSION_tls(1,5,0)
293+ , TLS.serverEarlyDataSize = 2018
294+#endif
295+ }
296+ -- Adding alpn to user's tlsServerHooks.
297+ hooks = tlsServerHooks {
298+ TLS.onALPNClientSuggest = TLS.onALPNClientSuggest tlsServerHooks <|>
299+ (if settingsHTTP2Enabled set then Just alpn else Nothing)
300+ }
301+ shared = def {
302+ TLS.sharedCredentials = TLS.Credentials [credential]
303+ , TLS.sharedSessionManager = mgr
304+ }
305+ supported = def { -- TLS.Supported
306+ TLS.supportedVersions = tlsAllowedVersions
307+ , TLS.supportedCiphers = tlsCiphers
308+ , TLS.supportedCompressions = [TLS.nullCompression]
309+ , TLS.supportedSecureRenegotiation = True
310+ , TLS.supportedClientInitiatedRenegotiation = False
311+ , TLS.supportedSession = True
312+ , TLS.supportedFallbackScsv = True
313+#if MIN_VERSION_tls(1,5,0)
314+ , TLS.supportedGroups = [TLS.X25519,TLS.P256,TLS.P384]
315+#endif
177316 }
178317
179−----------------------------------------------------------------
318+alpn :: [S.ByteString] -> IO S.ByteString
319+alpn xs
320+ | "h2" `elem` xs = return "h2"
321+ | otherwise = return "http/1.1"
180322
181−getter :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (IO (Connection, Bool), SockAddr)
182−getter tlsset@TLSSettings{..} sock params = do
183− (s, sa) <- acceptSafe sock
184− return (mkConn tlsset s params, sa)
323+----------------------------------------------------------------
185324
186−mkConn :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (Connection, Bool)
187−mkConn tlsset s params = do
188− firstBS <- safeRecv s 4096
189− cachedRef <- I.newIORef firstBS
190− if not (B.null firstBS) && B.head firstBS == 0x16 then
191− httpOverTls tlsset s cachedRef params
192− else
193− plainHTTP tlsset s cachedRef
325+getter :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (IO (Connection, Transport), SockAddr)
326+getter tlsset@TLSSettings{..} set sock params = do
327+#if WINDOWS
328+ (s, sa) <- windowsThreadBlockHack $ accept sock
329+#else
330+ (s, sa) <- accept sock
331+#endif
332+ setSocketCloseOnExec s
333+ return (mkConn tlsset set s params, sa)
334+
335+mkConn :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (Connection, Transport)
336+mkConn tlsset set s params = switch `onException` close s
337+ where
338+ switch = do
339+ firstBS <- safeRecv s 4096
340+ if not (S.null firstBS) && S.head firstBS == 0x16 then
341+ httpOverTls tlsset set s firstBS params
342+ else
343+ plainHTTP tlsset set s firstBS
194344
195345----------------------------------------------------------------
196346
197−httpOverTls :: TLS.TLSParams params => TLSSettings -> Socket -> I.IORef B.ByteString -> params -> IO (Connection, Bool)
198−httpOverTls TLSSettings{..} s cachedRef params = do
199− gen <- Crypto.Random.AESCtr.makeSystem
200− ctx <- TLS.contextNew backend params gen
347+httpOverTls :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
348+httpOverTls TLSSettings{..} _set s bs0 params = do
349+ recvN <- makePlainReceiveN s bs0
350+ ctx <- TLS.contextNew (backend recvN) params
201351 TLS.contextHookSetLogging ctx tlsLogging
202352 TLS.handshake ctx
203− readBuf <- allocateBuffer bufferSize
353+ h2 <- (== Just "h2") <$> TLS.getNegotiatedProtocol ctx
354+ isH2 <- I.newIORef h2
204355 writeBuf <- allocateBuffer bufferSize
205− return (conn ctx readBuf writeBuf, True)
356+ -- Creating a cache for leftover input data.
357+ ref <- I.newIORef ""
358+ tls <- getTLSinfo ctx
359+ return (conn ctx writeBuf ref isH2, tls)
206360 where
207− backend = TLS.Backend {
361+ backend recvN = TLS.Backend {
208362 TLS.backendFlush = return ()
209− , TLS.backendClose = sClose s
210− , TLS.backendSend = sendAll s
211− , TLS.backendRecv = getNext cachedRef 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
368+ , TLS.backendSend = sendAll' s
369+ , TLS.backendRecv = recvN
212370 }
213− conn ctx readBuf writeBuf = Connection {
371+ sendAll' sock bs = sendAll sock bs `E.catch` \(SomeException _) ->
372+ throwIO ConnectionClosedByPeer
373+ conn ctx writeBuf ref isH2 = Connection {
214374 connSendMany = TLS.sendData ctx . L.fromChunks
215− , connSendAll = TLS.sendData ctx . L.fromChunks . return
375+ , connSendAll = sendall
216376 , connSendFile = sendfile
217− , connClose = close
218− , connRecv = recv
219− , connSendFileOverride = NotOverride
220− , connReadBuffer = readBuf
377+ , connClose = close'
378+ , connFree = freeBuffer writeBuf
379+ , connRecv = recv ref
380+ , connRecvBuf = recvBuf ref
221381 , connWriteBuffer = writeBuf
222382 , connBufferSize = bufferSize
383+ , connHTTP2 = isH2
223384 }
224385 where
225− sendfile fp offset len _th headers = do
226− TLS.sendData ctx $ L.fromChunks headers
227− IO.withBinaryFile fp IO.ReadMode $ \h -> do
228− IO.hSeek h IO.AbsoluteSeek offset
229− loop h $ fromIntegral len
230− where
231− loop _ remaining | remaining <= 0 = return ()
232− loop h remaining = do
233− bs <- B.hGetSome h defaultChunkSize
234− unless (B.null bs) $ do
235− let x = B.take remaining bs
236− TLS.sendData ctx $ L.fromChunks [x]
237− loop h $ remaining - B.length x
238−
239− close = freeBuffer readBuf `finally`
240− freeBuffer writeBuf `finally`
241− void (tryIO $ TLS.bye ctx) `finally`
242− TLS.contextClose ctx
243−
244− recv = handle onEOF go
386+ sendall = TLS.sendData ctx . L.fromChunks . return
387+ sendfile fid offset len hook headers =
388+ readSendFile writeBuf bufferSize sendall fid offset len hook headers
389+
390+ close' = void (tryIO sendBye) `finally`
391+ TLS.contextClose ctx
392+
393+ sendBye =
394+ -- It's fine if the connection was closed by the other side before
395+ -- receiving close_notify, see RFC 5246 section 7.2.1.
396+ handleJust
397+ (\e -> guard (e == ConnectionClosedByPeer) >> return e)
398+ (const (return ()))
399+ (TLS.bye ctx)
400+
401+ -- TLS version of recv with a cache for leftover input data.
402+ -- The cache is shared with recvBuf.
403+ recv cref = do
404+ cached <- I.readIORef cref
405+ if cached /= "" then do
406+ I.writeIORef cref ""
407+ return cached
408+ else
409+ recv'
410+
411+ -- TLS version of recv (decrypting) without a cache.
412+ recv' = handle onEOF go
245413 where
246414 onEOF e
247− | Just TLS.Error_EOF <- fromException e = return B.empty
248− | Just ioe <- fromException e, isEOFError ioe = return B.empty | otherwise = throwIO e
415+ | Just TLS.Error_EOF <- fromException e = return S.empty
416+ | Just ioe <- fromException e, isEOFError ioe = return S.empty | otherwise = throwIO e
249417 go = do
250418 x <- TLS.recvData ctx
251− if B.null x then
419+ if S.null x then
252420 go
253421 else
254422 return x
255423
424+ -- TLS version of recvBuf with a cache for leftover input data.
425+ recvBuf cref buf siz = do
426+ cached <- I.readIORef cref
427+ (ret, leftover) <- fill cached buf siz recv'
428+ I.writeIORef cref leftover
429+ return ret
430+
431+fill :: S.ByteString -> Buffer -> BufSize -> Recv -> IO (Bool,S.ByteString)
432+fill bs0 buf0 siz0 recv
433+ | siz0 <= len0 = do
434+ let (bs, leftover) = S.splitAt siz0 bs0
435+ void $ copy buf0 bs
436+ return (True, leftover)
437+ | otherwise = do
438+ buf <- copy buf0 bs0
439+ loop buf (siz0 - len0)
440+ where
441+ len0 = S.length bs0
442+ loop _ 0 = return (True, "")
443+ loop buf siz = do
444+ bs <- recv
445+ let len = S.length bs
446+ if len == 0 then return (False, "")
447+ else if (len <= siz) then do
448+ buf' <- copy buf bs
449+ loop buf' (siz - len)
450+ else do
451+ let (bs1,bs2) = S.splitAt siz bs
452+ void $ copy buf bs1
453+ return (True, bs2)
454+
455+getTLSinfo :: TLS.Context -> IO Transport
456+getTLSinfo ctx = do
457+ proto <- TLS.getNegotiatedProtocol ctx
458+ minfo <- TLS.contextGetInformation ctx
459+ case minfo of
460+ Nothing -> return TCP
461+ Just TLS.Information{..} -> do
462+ let (major, minor) = case infoVersion of
463+ TLS.SSL2 -> (2,0)
464+ TLS.SSL3 -> (3,0)
465+ TLS.TLS10 -> (3,1)
466+ TLS.TLS11 -> (3,2)
467+ TLS.TLS12 -> (3,3)
468+#if MIN_VERSION_tls(1,5,0)
469+ TLS.TLS13 -> (3,4)
470+#endif
471+ clientCert <- TLS.getClientCertificateChain ctx
472+ return TLS {
473+ tlsMajorVersion = major
474+ , tlsMinorVersion = minor
475+ , tlsNegotiatedProtocol = proto
476+ , tlsChiperID = TLS.cipherID infoCipher
477+ , tlsClientCertificate = clientCert
478+ }
479+
256480tryIO :: IO a -> IO (Either IOException a)
257481tryIO = try
258482
259483----------------------------------------------------------------
260484
261−plainHTTP :: TLSSettings -> Socket -> I.IORef B.ByteString -> IO (Connection, Bool)
262−plainHTTP TLSSettings{..} s cachedRef = case onInsecure of
485+plainHTTP :: TLSSettings -> Settings -> Socket -> S.ByteString -> IO (Connection, Transport)
486+plainHTTP TLSSettings{..} set s bs0 = case onInsecure of
263487 AllowInsecure -> do
264− conn' <- socketConnection s
265− return (conn' { connRecv = getNext cachedRef s 4096 }, False)
488+ conn' <- socketConnection set s
489+ cachedRef <- I.newIORef bs0
490+ let conn'' = conn'
491+ { connRecv = recvPlain cachedRef (connRecv conn')
492+ }
493+ return (conn'', TCP)
266494 DenyInsecure lbs -> do
267− 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"
268509 mapM_ (sendAll s) $ L.toChunks lbs
269− sClose s
510+ close s
270511 throwIO InsecureConnectionDenied
271512
272513----------------------------------------------------------------
273514
274−getNext :: I.IORef B.ByteString -> Socket -> Int -> IO B.ByteString
275−getNext cachedRef s size = do
276− cached <- I.readIORef cachedRef
277− loop cached
278− where
279− loop bs | B.length bs >= size = do
280− let (x, y) = B.splitAt size bs
281− I.writeIORef cachedRef y
282− return x
283− loop bs1 = do
284− bs2 <- safeRecv s 4096
285− if B.null bs2 then do
286− -- FIXME does this deserve an exception being thrown?
287− I.writeIORef cachedRef B.empty
288− return bs1
289− else
290− loop $ B.append bs1 bs2
515+-- | Modify the given receive function to first check the given @IORef@ for a
516+-- chunk of data. If present, takes the chunk of data from the @IORef@ and
517+-- empties out the @IORef@. Otherwise, calls the supplied receive function.
518+recvPlain :: I.IORef S.ByteString -> IO S.ByteString -> IO S.ByteString
519+recvPlain ref fallback = do
520+ bs <- I.readIORef ref
521+ if S.null bs
522+ then fallback
523+ else do
524+ I.writeIORef ref S.empty
525+ return bs
291526
292527----------------------------------------------------------------
293528
warp-tls/README.md+4
@@ -1,3 +1,7 @@
1+## warp-tls
2+
3+Serve WAI applications using the Warp webserver and the Haskell TLS library.
4+
15In order to generate a self-signed certificate for testing, try the following:
26
37 openssl genrsa -out key.pem 2048
warp-tls/warp-tls.cabal+21−10
@@ -1,6 +1,6 @@
11Name: warp-tls
2−Version: 3.0.1
3−Synopsis: HTTP over SSL/TLS support for Warp via the TLS package
2+Version: 3.2.11
3+Synopsis: HTTP over TLS support for Warp via the TLS package
44License: MIT
55License-file: LICENSE
66Author: Michael Snoyman
@@ -8,23 +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: HTTP over SSL/TLS support for Warp via the TLS package.
14−extra-source-files: ChangeLog.md
13+description: SSLv1 and SSLv2 are obsoleted by IETF.
14+ We should use TLS 1.2 (or TLS 1.1 or TLS 1.0 if necessary).
15+ HTTP/2 can be negotiated by ALPN.
16+ API docs and the README are available at
17+ <http://www.stackage.org/package/warp-tls>.
18+extra-source-files: ChangeLog.md README.md
1519
1620Library
17− Build-Depends: base >= 4 && < 5
21+ Build-Depends: base >= 4.10 && < 5
1822 , bytestring >= 0.9
19− , wai >= 3.0 && < 3.1
20− , warp >= 3.0 && < 3.1
23+ , wai >= 3.2 && < 3.3
24+ , warp >= 3.3.6 && < 3.4
2125 , data-default-class >= 0.0.1
22− , tls >= 1.2.1
26+ , tls >= 1.5.3
27+ , cryptonite >= 0.12
2328 , network >= 2.2.1
24− , cprng-aes >= 0.5.0
2529 , streaming-commons
30+ , tls-session-manager >= 0.0.4
2631 Exposed-modules: Network.Wai.Handler.WarpTLS
2732 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+
2839
2940source-repository head
3041 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+356
@@ -1,3 +1,359 @@
1+## 3.3.9
2+
3+* Don't insert Last-Modified: if exists.
4+ [#791](https://github.com/yesodweb/wai/pull/791)
5+
6+## 3.3.8
7+
8+* Maximum header size is configurable.
9+ [#781](https://github.com/yesodweb/wai/pull/781)
10+* Ignoring an exception from shutdown (gracefulClose).
11+
12+## 3.3.7
13+
14+* InvalidArgument (Bad file descriptor) is ignored in `receive`.
15+ [#787](https://github.com/yesodweb/wai/pull/787)
16+
17+## 3.3.6
18+
19+* Fixing a bug of thread killed in the case of event source with
20+ HTTP/2 (fixing #692 and #785)
21+* New APIs: clientCertificate to get client's certificate
22+ [#783](https://github.com/yesodweb/wai/pull/783)
23+
24+## 3.3.5
25+
26+* New APIs: setGracefulCloseTimeout1 and setGracefulCloseTimeout2.
27+ For HTTP/1.x, connections are closed immediately by default.
28+ gracefullClose is used for HTTP/2 by default.
29+ [#782](https://github.com/yesodweb/wai/pull/782)
30+
31+## 3.3.4
32+
33+* Setting isSecure of HTTP/2 correctly.
34+
35+## 3.3.3
36+
37+* Calling setOnException in HTTP/2.
38+ [#771](https://github.com/yesodweb/wai/pull/771)
39+
40+## 3.3.2
41+
42+* Fixing a bug of HTTP/2 without fd cache.
43+
44+## 3.3.1
45+
46+* Using gracefullClose of network 3.1.1 or later if available.
47+* If the first line of an HTTP request is really invalid,
48+ don't send an error response
49+
50+## 3.3.0
51+
52+* Switching from the original implementation to HTTP/2 server library.
53+ [#754](https://github.com/yesodweb/wai/pull/754)
54+* Breaking change: The type of `http2dataTrailers` is now
55+ `HTTP2Data -> TrailersMaker`.
56+
57+## 3.2.28
58+
59+* Using the Strict and StrictData language extensions for GHC >8.
60+ [#752](https://github.com/yesodweb/wai/pull/752)
61+* System.TimeManager is now in a separate package: time-manager.
62+ [#750](https://github.com/yesodweb/wai/pull/750)
63+* Fixing a bug of ALPN.
64+* Introducing the half closed state for HTTP/2.
65+ [#717](https://github.com/yesodweb/wai/pull/717)
66+
67+## 3.2.27
68+
69+* Internally, use `lookupEnv` instead of `getEnvironment` to get the
70+ value of the `PORT` environment variable
71+ [#736](https://github.com/yesodweb/wai/pull/736)
72+* Throw 413 for too large payload
73+* Throw 431 for too large headers
74+ [#741](https://github.com/yesodweb/wai/pull/741)
75+* Use exception response handler in HTTP/2 & improve connection preservation
76+ in HTTP/1.x if uncaught exceptions are thrown in an `Application`.
77+ [#738](https://github.com/yesodweb/wai/pull/738)
78+
79+## 3.2.26
80+
81+* Support network package version 3
82+
83+## 3.2.25
84+
85+* Removing Connection: and Transfer-Encoding: from HTTP/2
86+ response header
87+ [#707](https://github.com/yesodweb/wai/pull/707)
88+
89+## 3.2.24
90+
91+* Fix HTTP2 unwanted GoAways on late WindowUpdate frames.
92+ [#711](https://github.com/yesodweb/wai/pull/711)
93+
94+## 3.2.23
95+
96+* Log real requsts when an app throws an error.
97+ [#698](https://github.com/yesodweb/wai/pull/698)
98+
99+## 3.2.22
100+
101+* Fixing large request body in HTTP/2.
102+
103+## 3.2.21
104+
105+* Fixing HTTP/2's timeout handler in request's vault.
106+
107+## 3.2.20
108+
109+* Fixing large request body in HTTP/2
110+ [#593](https://github.com/yesodweb/wai/issues/593)
111+
112+## 3.2.19
113+
114+* Fixing 0-byte request body in HTTP/2
115+ [#597](https://github.com/yesodweb/wai/issues/597)
116+ [#679](https://github.com/yesodweb/wai/issues/679)
117+
118+## 3.2.18.2
119+
120+* Replace dependency on `blaze-builder` with `bsb-http-chunked`
121+
122+## 3.2.18.1
123+
124+* Fix benchmark compilation [#681](https://github.com/yesodweb/wai/issues/681)
125+
126+## 3.2.18
127+
128+* Make `testWithApplicationSettings` actually use the settings passed.
129+ [#677](https://github.com/yesodweb/wai/pull/677).
130+
131+## 3.2.17
132+* Add support for windows thread block hack and closeOnExec to TLS.
133+ [#674](https://github.com/yesodweb/wai/pull/674).
134+
135+## 3.2.16
136+
137+* In `testWithApplication`, don't `throwTo` ignorable exceptions
138+ [#671](https://github.com/yesodweb/wai/issues/671), and
139+ reuse `bindRandomPortTCP`
140+
141+## 3.2.15
142+
143+* Address space leak from exception handlers
144+ [#649](https://github.com/yesodweb/wai/issues/649)
145+
146+## 3.2.14
147+
148+* Support streaming-commons 0.2
149+* Warnings cleanup
150+
151+## 3.2.13
152+
153+* Tickling HTTP/2 timer. [624](https://github.com/yesodweb/wai/pull/624)
154+* Guarantee atomicity of WINDOW_UPDATE increments [622](https://github.com/yesodweb/wai/pull/622)
155+* Relax HTTP2 headers check [621](https://github.com/yesodweb/wai/pull/621)
156+
157+## 3.2.12
158+
159+* If an empty string is set by setServerName, the Server header is not included in response headers [#619](https://github.com/yesodweb/wai/issues/619)
160+
161+## 3.2.11.2
162+
163+* Don't throw exceptions when closing a keep-alive connection
164+ [#618](https://github.com/yesodweb/wai/issues/618)
165+
166+## 3.2.11.1
167+
168+* Move exception handling to top of thread (fixes
169+ [#613](https://github.com/yesodweb/wai/issues/613))
170+
171+## 3.2.11
172+
173+* Fixing 10 HTTP2 bugs pointed out by h2spec v2.
174+
175+## 3.2.10
176+
177+* Add `connFree` to `Connection`. Close socket connections on timeout triggered. Timeout exceptions extend from `SomeAsyncException`. [#602](https://github.com/yesodweb/wai/pull/602) [#605](https://github.com/yesodweb/wai/pull/605)
178+
179+## 3.2.9
180+
181+* Fixing a space leak. [#586](https://github.com/yesodweb/wai/pull/586)
182+
183+## 3.2.8
184+
185+* Fixing HTTP2 requestBodyLength. [#573](https://github.com/yesodweb/wai/pull/573)
186+* Making HTTP/2 :path optional for the CONNECT method. [#572](https://github.com/yesodweb/wai/pull/572)
187+* Adding new APIs for HTTP/2 trailers: http2dataTrailers and modifyHTTP2Data [#566](https://github.com/yesodweb/wai/pull/566)
188+
189+## 3.2.7
190+
191+* Adding new APIs for HTTP/2 server push: getHTTP2Data and setHTTP2Data [#510](https://github.com/yesodweb/wai/pull/510)
192+* Better accept(2) error handling [#553](https://github.com/yesodweb/wai/pull/553)
193+* Adding getGracefulShutdownTimeout.
194+* Add {test,}withApplicationSettings [#531](https://github.com/yesodweb/wai/pull/531)
195+
196+## 3.2.6
197+
198+* Using token based APIs of http2 1.6.
199+
200+## 3.2.5
201+
202+* Ignoring errors from setSocketOption. [#526](https://github.com/yesodweb/wai/issues/526).
203+
204+## 3.2.4
205+
206+* Added `withApplication`, `testWithApplication`, and `openFreePort`
207+* Fixing reaper delay value of file info cache.
208+
209+## 3.2.3
210+
211+* Using http2 v1.5.x which much improves the performance of HTTP/2.
212+* To get rid of the bottleneck of ByteString's (==), a new logic to
213+ compare header names is introduced.
214+
215+## 3.2.2
216+
217+* Throwing errno for pread [#499](https://github.com/yesodweb/wai/issues/499).
218+* Makeing compilable on Windows [#505](https://github.com/yesodweb/wai/issues/505).
219+
220+## 3.2.1
221+
222+* Add back `warpVersion`
223+
224+## 3.2.0
225+
226+* Major version up due to breaking changes. This is because the HTTP/2 code
227+ was started over with Warp 3.1.3 due to performance issue [#470](https://github.com/yesodweb/wai/issues/470).
228+* runHTTP2, runHTTP2Env, runHTTP2Settings and runHTTP2SettingsSocket were removed from the Network.Wai.Handler.Warp module.
229+* The performance of HTTP/2 was drastically improved. Now the performance of HTTP/2 is almost the same as that of HTTP/1.1.
230+* The logic to handle files in HTTP/2 is now identical to that in HTTP/1.1.
231+* Internal stuff was removed from the Network.Wai.Handler.Warp module according to [the plan](http://www.yesodweb.com/blog/2015/06/cleaning-up-warp-apis).
232+
233+## 3.1.12
234+
235+* Setting lower bound for auto-update [#495](https://github.com/yesodweb/wai/issues/495)
236+
237+## 3.1.11
238+
239+* Providing a new API: killManager.
240+* Preventing space leaks due to Weak ThreadId [#488](https://github.com/yesodweb/wai/issues/488)
241+* Setting upper bound for http2.
242+
243+## 3.1.10
244+
245+* `setFileInfoCacheDuration`
246+* `setLogger`
247+* `FileInfo`/`getFileInfo`
248+* Fix: warp-tls strips out the Host request header [#478](https://github.com/yesodweb/wai/issues/478)
249+
250+## 3.1.9
251+
252+* Using the new priority queue based on PSQ provided by http2 lib again.
253+
254+## 3.1.8
255+
256+* Using the new priority queue based on PSQ provided by http2 lib.
257+
258+## 3.1.7
259+
260+* A concatenated Cookie header is prepended to the headers to ensure that it flows pseudo headers. [#454](https://github.com/yesodweb/wai/pull/454)
261+* Providing a new settings: `setHTTP2Disabled` [#450](https://github.com/yesodweb/wai/pull/450)
262+
263+## 3.1.6
264+
265+* Adding back http-types 0.8 support [#449](https://github.com/yesodweb/wai/pull/449)
266+
267+## 3.1.5
268+
269+* Using http-types v0.9.
270+* Fixing build on OpenBSD. [#428](https://github.com/yesodweb/wai/pull/428) [#440](https://github.com/yesodweb/wai/pull/440)
271+* Fixing build on Windows. [#438](https://github.com/yesodweb/wai/pull/438)
272+
273+## 3.1.4
274+
275+* Using newer http2 library to prevent change table size attacks.
276+* API for HTTP/2 server push and trailers. [#426](https://github.com/yesodweb/wai/pull/426)
277+* Preventing response splitting attacks. [#435](https://github.com/yesodweb/wai/pull/435)
278+* Concatenating multiple Cookie: headers in HTTP/2.
279+
280+## 3.1.3
281+
282+* Warp now supports blaze-builder v0.4 or later only.
283+* HTTP/2 code was improved: dynamic priority change, efficient queuing and sender loop continuation. [#423](https://github.com/yesodweb/wai/pull/423) [#424](https://github.com/yesodweb/wai/pull/424)
284+
285+## 3.1.2
286+
287+* Configurable Slowloris size [#418](https://github.com/yesodweb/wai/pull/418)
288+
289+## 3.1.1
290+
291+* Fixing a bug of HTTP/2 when no FD cache is used [#411](https://github.com/yesodweb/wai/pull/411)
292+* Fixing a buffer-pool bug [#406](https://github.com/yesodweb/wai/pull/406) [#407](https://github.com/yesodweb/wai/pull/407)
293+
294+## 3.1.0
295+
296+* Supporting HTTP/2 [#399](https://github.com/yesodweb/wai/pull/399)
297+* Cleaning up APIs [#387](https://github.com/yesodweb/wai/issues/387)
298+
299+## 3.0.13.1
300+
301+* Remove dependency on the void package [#375](https://github.com/yesodweb/wai/pull/375)
302+
303+## 3.0.13
304+
305+* Turn off file descriptor cache by default [#371](https://github.com/yesodweb/wai/issues/371)
306+
307+## 3.0.12.1
308+
309+* Fix for: HEAD requests returning non-empty entity body [#369](https://github.com/yesodweb/wai/issues/369)
310+
311+## 3.0.12
312+
313+* Only conditionally produce HTTP 100 Continue
314+
315+## 3.0.11
316+
317+* Better HEAD support for files [#357](https://github.com/yesodweb/wai/pull/357)
318+
319+## 3.0.10
320+
321+* Fix [missing `IORef` tweak](https://github.com/yesodweb/wai/issues/351)
322+* Disable timeouts as soon as request body is fully consumed. This addresses
323+ the common case of a non-chunked request body. Previously, we would wait
324+ until a zero-length `ByteString` is returned, but that is suboptimal for some
325+ cases. For more information, see [issue
326+ 351](https://github.com/yesodweb/wai/issues/351).
327+* Add `pauseTimeout` function
328+
329+## 3.0.9.3
330+
331+* Don't serve a 416 status code for 0-length files [keter issue #75](https://github.com/snoyberg/keter/issues/75)
332+* Don't serve content-length for 416 responses [#346](https://github.com/yesodweb/wai/issues/346)
333+
334+## 3.0.9.2
335+
336+Fix support for old versions of bytestring
337+
338+## 3.0.9.1
339+
340+Add support for blaze-builder 0.4
341+
342+## 3.0.9
343+
344+* Add runEnv: like run but uses $PORT [#334](https://github.com/yesodweb/wai/pull/334)
345+
346+## 3.0.5.2
347+
348+* [Pass the Request to settingsOnException handlers when available. #326](https://github.com/yesodweb/wai/pull/326)
349+
350+## 3.0.5
351+
352+Support for PROXY protocol, such as used by Amazon ELB TCP. This is useful
353+since, for example, Amazon ELB HTTP does *not* have support for Websockets.
354+More information on the protocol [is available from
355+Amazon](http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol).
356+
1357## 3.0.4
2358
3359Added `setFork`.
warp/Network/Wai/Handler/Warp.hs+324−58
@@ -1,5 +1,6 @@
11{-# LANGUAGE CPP #-}
22{-# LANGUAGE RankNTypes #-}
3+{-# LANGUAGE PatternGuards #-}
34{-# OPTIONS_GHC -fno-warn-deprecations #-}
45
56---------------------------------------------------------
@@ -17,14 +18,32 @@
1718---------------------------------------------------------
1819
1920-- | A fast, light-weight HTTP server handler for WAI.
21+--
22+-- HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported. For HTTP\/2,
23+-- Warp supports direct and ALPN (in TLS) but not upgrade.
24+--
25+-- Note on slowloris timeouts: to prevent slowloris attacks, timeouts are used
26+-- at various points in request receiving and response sending. One interesting
27+-- corner case is partial request body consumption; in that case, Warp's
28+-- timeout handling is still in effect, and the timeout will not be triggered
29+-- again. Therefore, it is recommended that once you start consuming the
30+-- request body, you either:
31+--
32+-- * consume the entire body promptly
33+--
34+-- * call the 'pauseTimeout' function
35+--
36+-- For more information, see <https://github.com/yesodweb/wai/issues/351>.
37+--
38+--
2039module Network.Wai.Handler.Warp (
2140 -- * Run a Warp server
41+ -- | All of these automatically serve the same 'Application' over HTTP\/1,
42+ -- HTTP\/1.1, and HTTP\/2.
2243 run
44+ , runEnv
2345 , runSettings
2446 , runSettingsSocket
25− , runSettingsConnection
26− , runSettingsConnectionMaker
27− , runSettingsConnectionMakerSecure
2847 -- * Settings
2948 , Settings
3049 , defaultSettings
@@ -38,77 +57,97 @@ module Network.Wai.Handler.Warp (
3857 , setTimeout
3958 , setManager
4059 , setFdCacheDuration
60+ , setFileInfoCacheDuration
4161 , setBeforeMainLoop
4262 , setNoParsePath
4363 , setInstallShutdownHandler
4464 , setServerName
4565 , setMaximumBodyFlush
4666 , setFork
67+ , setProxyProtocolNone
68+ , setProxyProtocolRequired
69+ , setProxyProtocolOptional
70+ , setSlowlorisSize
71+ , setHTTP2Disabled
72+ , setLogger
73+ , setServerPushLogger
74+ , setGracefulShutdownTimeout
75+ , setGracefulCloseTimeout1
76+ , setGracefulCloseTimeout2
77+ , setMaxTotalHeaderLength
4778 -- ** Getters
4879 , getPort
4980 , getHost
50− -- ** Accessors
51− -- | Note: these accessors are deprecated, please use the @set@ versions instead.
52− , settingsPort
53− , settingsHost
54− , settingsOnException
55− , settingsOnExceptionResponse
56− , settingsOnOpen
57− , settingsOnClose
58− , settingsTimeout
59− , settingsManager
60− , settingsFdCacheDuration
61− , settingsBeforeMainLoop
62− , settingsNoParsePath
63− -- ** Debugging
64− , exceptionResponseForDebug
81+ , getOnOpen
82+ , getOnClose
83+ , getOnException
84+ , getGracefulShutdownTimeout
85+ , getGracefulCloseTimeout1
86+ , getGracefulCloseTimeout2
87+ -- ** Exception handler
88+ , defaultOnException
6589 , defaultShouldDisplayException
90+ -- ** Exception response handler
91+ , defaultOnExceptionResponse
92+ , exceptionResponseForDebug
6693 -- * Data types
67− , HostPreference (..)
94+ , HostPreference
6895 , Port
6996 , InvalidRequest (..)
70− , ConnSendFileOverride (..)
71− -- * Connection
72− , Connection (..)
73− , socketConnection
74− -- * Internal
75− -- ** Version
97+ -- * Utilities
98+ , pauseTimeout
99+ , FileInfo(..)
100+ , getFileInfo
101+ , clientCertificate
102+ , withApplication
103+ , withApplicationSettings
104+ , testWithApplication
105+ , testWithApplicationSettings
106+ , openFreePort
107+ -- * Version
76108 , warpVersion
77− -- ** Data types
78− , InternalInfo (..)
79− , HeaderValue
80− , IndexedHeader
81− , requestMaxIndex
82− -- ** Time out manager
83− , module Network.Wai.Handler.Warp.Timeout
84− -- ** File descriptor cache
85− , module Network.Wai.Handler.Warp.FdCache
86− -- ** Date
87− , module Network.Wai.Handler.Warp.Date
88− -- ** Request and response
89− , recvRequest
90− , sendResponse
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
91125 ) where
92126
93−import Network.Wai.Handler.Warp.Date
94−import Network.Wai.Handler.Warp.FdCache
95−import Network.Wai.Handler.Warp.Header
127+import Control.Exception (SomeException, throwIO)
128+import Data.Streaming.Network (HostPreference)
129+import qualified Data.Vault.Lazy as Vault
130+import Data.X509
131+import qualified Network.HTTP.Types as H
132+import Network.Socket (SockAddr)
133+import Network.Wai (Request, Response, vault)
134+import System.TimeManager
135+
136+import Network.Wai.Handler.Warp.FileInfoCache
137+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data, setHTTP2Data, modifyHTTP2Data)
138+import Network.Wai.Handler.Warp.HTTP2.Types
139+import Network.Wai.Handler.Warp.Imports
96140import Network.Wai.Handler.Warp.Request
97−import Network.Wai.Handler.Warp.Response
141+import Network.Wai.Handler.Warp.Response (warpVersion)
98142import Network.Wai.Handler.Warp.Run
99143import Network.Wai.Handler.Warp.Settings
100−import Network.Wai.Handler.Warp.Timeout
101−import Network.Wai.Handler.Warp.Types
102−import Control.Exception (SomeException)
103−import Network.Wai (Request, Response)
104−import Network.Socket (SockAddr)
105−import Data.Streaming.Network (HostPreference)
106−import Data.ByteString (ByteString)
144+import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
145+import Network.Wai.Handler.Warp.WithApplication
107146
108147-- | Port to listen on. Default value: 3000
109148--
110149-- Since 2.1.0
111−setPort :: Int -> Settings -> Settings
150+setPort :: Port -> Settings -> Settings
112151setPort x y = y { settingsPort = x }
113152
114153-- | Interface to bind to. Default value: HostIPv4
@@ -118,16 +157,24 @@ setHost :: HostPreference -> Settings -> Settings
118157setHost x y = y { settingsHost = x }
119158
120159-- | What to do with exceptions thrown by either the application or server.
121−-- Default: ignore server-generated exceptions (see 'InvalidRequest') and print
122−-- application-generated applications to stderr.
160+-- Default: 'defaultOnException'
123161--
124162-- Since 2.1.0
125163setOnException :: (Maybe Request -> SomeException -> IO ()) -> Settings -> Settings
126164setOnException x y = y { settingsOnException = x }
127165
128166-- | A function to create a `Response` when an exception occurs.
167+-- Default: 'defaultOnExceptionResponse'
129168--
130−-- Default: 500, text/plain, \"Something went wrong\"
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 -- ...
131178--
132179-- Since 2.1.0
133180setOnExceptionResponse :: (SomeException -> Response) -> Settings -> Settings
@@ -160,10 +207,36 @@ setTimeout x y = y { settingsTimeout = x }
160207setManager :: Manager -> Settings -> Settings
161208setManager x y = y { settingsManager = Just x }
162209
163−-- | Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 10
210+-- | Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used.
211+--
212+-- The FD cache is an optimization that is useful for servers dealing with
213+-- static files. However, if files are being modified, it can cause incorrect
214+-- results in some cases. Therefore, we disable it by default. If you know that
215+-- your files will be static or you prefer performance to file consistency,
216+-- it's recommended to turn this on; a reasonable value for those cases is 10.
217+-- Enabling this cache results in drastic performance improvement for file
218+-- transfers.
219+--
220+-- Default value: 0, was previously 10
221+--
222+-- Since 3.0.13
164223setFdCacheDuration :: Int -> Settings -> Settings
165224setFdCacheDuration x y = y { settingsFdCacheDuration = x }
166225
226+-- | Cache duration time of file information in seconds. 0 means that the cache mechanism is not used.
227+--
228+-- The file information cache is an optimization that is useful for servers dealing with
229+-- static files. However, if files are being modified, it can cause incorrect
230+-- results in some cases. Therefore, we disable it by default. If you know that
231+-- your files will be static or you prefer performance to file consistency,
232+-- it's recommended to turn this on; a reasonable value for those cases is 10.
233+-- Enabling this cache results in drastic performance improvement for file
234+-- transfers.
235+--
236+-- Default value: 0
237+setFileInfoCacheDuration :: Int -> Settings -> Settings
238+setFileInfoCacheDuration x y = y { settingsFileInfoCacheDuration = x }
239+
167240-- | Code to run after the listening socket is ready but before entering
168241-- the main event loop. Useful for signaling to tests that they can start
169242-- running, or to drop permissions after binding to a restricted port.
@@ -187,7 +260,7 @@ setNoParsePath x y = y { settingsNoParsePath = x }
187260-- | Get the listening port.
188261--
189262-- Since 2.1.1
190−getPort :: Settings -> Int
263+getPort :: Settings -> Port
191264getPort = settingsPort
192265
193266-- | Get the interface to bind to.
@@ -196,11 +269,51 @@ getPort = settingsPort
196269getHost :: Settings -> HostPreference
197270getHost = settingsHost
198271
272+-- | Get the action on opening connection.
273+getOnOpen :: Settings -> SockAddr -> IO Bool
274+getOnOpen = settingsOnOpen
275+
276+-- | Get the action on closeing connection.
277+getOnClose :: Settings -> SockAddr -> IO ()
278+getOnClose = settingsOnClose
279+
280+-- | Get the exception handler.
281+getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
282+getOnException = settingsOnException
283+
284+-- | Get the graceful shutdown timeout
285+--
286+-- Since 3.2.8
287+getGracefulShutdownTimeout :: Settings -> Maybe Int
288+getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
289+
199290-- | A code to install shutdown handler.
200291--
201292-- For instance, this code should set up a UNIX signal
202293-- handler. The handler should call the first argument,
203−-- 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'.
204317--
205318-- Default: does not install any code.
206319--
@@ -208,7 +321,10 @@ getHost = settingsHost
208321setInstallShutdownHandler :: (IO () -> IO ()) -> Settings -> Settings
209322setInstallShutdownHandler x y = y { settingsInstallShutdownHandler = x }
210323
211−-- | 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.
212328--
213329-- Since 3.0.2
214330setServerName :: ByteString -> Settings -> Settings
@@ -241,3 +357,153 @@ setMaximumBodyFlush x y
241357-- Since 3.0.4
242358setFork :: (((forall a. IO a -> IO a) -> IO ()) -> IO ()) -> Settings -> Settings
243359setFork fork' s = s { settingsFork = fork' }
360+
361+-- | Do not use the PROXY protocol.
362+--
363+-- Since 3.0.5
364+setProxyProtocolNone :: Settings -> Settings
365+setProxyProtocolNone y = y { settingsProxyProtocol = ProxyProtocolNone }
366+
367+-- | Require PROXY header.
368+--
369+-- This is for cases where a "dumb" TCP/SSL proxy is being used, which cannot
370+-- add an @X-Forwarded-For@ HTTP header field but has enabled support for the
371+-- PROXY protocol.
372+--
373+-- See <http://www.haproxy.org/download/1.5/doc/proxy-protocol.txt> and
374+-- <http://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#proxy-protocol>.
375+--
376+-- Only the human-readable header format (version 1) is supported. The binary
377+-- header format (version 2) is /not/ supported.
378+--
379+-- Since 3.0.5
380+setProxyProtocolRequired :: Settings -> Settings
381+setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
382+
383+-- | Use the PROXY header if it exists, but also accept
384+-- connections without the header. See 'setProxyProtocolRequired'.
385+--
386+-- WARNING: This is contrary to the PROXY protocol specification and
387+-- using it can indicate a security problem with your
388+-- architecture if the web server is directly accessible
389+-- to the public, since it would allow easy IP address
390+-- spoofing. However, it can be useful in some cases,
391+-- such as if a load balancer health check uses regular
392+-- HTTP without the PROXY header, but proxied
393+-- connections /do/ include the PROXY header.
394+--
395+-- Since 3.0.5
396+setProxyProtocolOptional :: Settings -> Settings
397+setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
398+
399+-- | Size in bytes read to prevent Slowloris attacks. Default value: 2048
400+--
401+-- Since 3.1.2
402+setSlowlorisSize :: Int -> Settings -> Settings
403+setSlowlorisSize x y = y { settingsSlowlorisSize = x }
404+
405+-- | Disable HTTP2.
406+--
407+-- Since 3.1.7
408+setHTTP2Disabled :: Settings -> Settings
409+setHTTP2Disabled y = y { settingsHTTP2Enabled = False }
410+
411+-- | Setting a log function.
412+--
413+-- Since 3.X.X
414+setLogger :: (Request -> H.Status -> Maybe Integer -> IO ()) -- ^ request, status, maybe file-size
415+ -> Settings
416+ -> Settings
417+setLogger lgr y = y { settingsLogger = lgr }
418+
419+-- | Setting a log function for HTTP/2 server push.
420+--
421+-- Since: 3.2.7
422+setServerPushLogger :: (Request -> ByteString -> Integer -> IO ()) -- ^ request, path, file-size
423+ -> Settings
424+ -> Settings
425+setServerPushLogger lgr y = y { settingsServerPushLogger = lgr }
426+
427+-- | Set the graceful shutdown timeout. A timeout of `Nothing' will
428+-- wait indefinitely, and a number, if provided, will be treated as seconds
429+-- to wait for requests to finish, before shutting down the server entirely.
430+--
431+-- Graceful shutdown mode is entered when the server socket is closed; see
432+-- 'setInstallShutdownHandler' for an example of how this could be done in
433+-- response to a UNIX signal.
434+--
435+-- Since 3.2.8
436+setGracefulShutdownTimeout :: Maybe Int
437+ -> Settings -> Settings
438+setGracefulShutdownTimeout time y = y { settingsGracefulShutdownTimeout = time }
439+
440+-- | Set the maximum header size that Warp will tolerate when using HTTP/1.x.
441+--
442+-- Since 3.3.8
443+setMaxTotalHeaderLength :: Int -> Settings -> Settings
444+setMaxTotalHeaderLength maxTotalHeaderLength settings = settings
445+ { settingsMaxTotalHeaderLength = maxTotalHeaderLength }
446+
447+-- | Explicitly pause the slowloris timeout.
448+--
449+-- This is useful for cases where you partially consume a request body. For
450+-- more information, see <https://github.com/yesodweb/wai/issues/351>
451+--
452+-- Since 3.0.10
453+pauseTimeout :: Request -> IO ()
454+pauseTimeout = fromMaybe (return ()) . Vault.lookup pauseTimeoutKey . vault
455+
456+-- | Getting file information of the target file.
457+--
458+-- This function first uses a stat(2) or similar system call
459+-- to obtain information of the target file, then registers
460+-- it into the internal cache.
461+-- From the next time, the information is obtained
462+-- from the cache. This reduces the overhead to call the system call.
463+-- The internal cache is refreshed every duration specified by
464+-- 'setFileInfoCacheDuration'.
465+--
466+-- This function throws an 'IO' exception if the information is not
467+-- available. For instance, the target file does not exist.
468+-- If this function is used an a Request generated by a WAI
469+-- backend besides Warp, it also throws an 'IO' exception.
470+--
471+-- Since 3.1.10
472+getFileInfo :: Request -> FilePath -> IO FileInfo
473+getFileInfo = fromMaybe (\_ -> throwIO (userError "getFileInfo")) . Vault.lookup getFileInfoKey . vault
474+
475+-- | A timeout to limit the time (in milliseconds) waiting for
476+-- FIN for HTTP/1.x. 0 means uses immediate close.
477+-- Default: 0.
478+--
479+-- Since 3.3.5
480+setGracefulCloseTimeout1 :: Int -> Settings -> Settings
481+setGracefulCloseTimeout1 x y = y { settingsGracefulCloseTimeout1 = x }
482+
483+-- | A timeout to limit the time (in milliseconds) waiting for
484+-- FIN for HTTP/1.x. 0 means uses immediate close.
485+--
486+-- Since 3.3.5
487+getGracefulCloseTimeout1 :: Settings -> Int
488+getGracefulCloseTimeout1 = settingsGracefulCloseTimeout1
489+
490+-- | A timeout to limit the time (in milliseconds) waiting for
491+-- FIN for HTTP/2. 0 means uses immediate close.
492+-- Default: 2000.
493+--
494+-- Since 3.3.5
495+setGracefulCloseTimeout2 :: Int -> Settings -> Settings
496+setGracefulCloseTimeout2 x y = y { settingsGracefulCloseTimeout2 = x }
497+
498+-- | A timeout to limit the time (in milliseconds) waiting for
499+-- FIN for HTTP/2. 0 means uses immediate close.
500+--
501+-- Since 3.3.5
502+getGracefulCloseTimeout2 :: Settings -> Int
503+getGracefulCloseTimeout2 = settingsGracefulCloseTimeout2
504+
505+-- | Getting information of client certificate.
506+--
507+-- Since 3.3.5
508+clientCertificate :: Request -> Maybe CertificateChain
509+clientCertificate = join . Vault.lookup getClientCertificateKey . vault
warp/Network/Wai/Handler/Warp/Buffer.hs+96−12
@@ -1,25 +1,109 @@
1−module Network.Wai.Handler.Warp.Buffer where
1+{-# LANGUAGE BangPatterns #-}
22
3−import qualified Blaze.ByteString.Builder.Internal.Buffer as B (Buffer (..))
4−import Data.Word (Word8)
5−import Foreign.ForeignPtr (newForeignPtr_)
6−import Foreign.Marshal.Alloc (mallocBytes, free)
7−import Foreign.Ptr (Ptr, plusPtr)
3+module Network.Wai.Handler.Warp.Buffer (
4+ bufferSize
5+ , allocateBuffer
6+ , freeBuffer
7+ , mallocBS
8+ , newBufferPool
9+ , withBufferPool
10+ , toBuilderBuffer
11+ , copy
12+ , bufferIO
13+ ) where
814
9−type Buffer = Ptr Word8
10−type BufSize = Int
15+import qualified Data.ByteString as BS
16+import Data.ByteString.Internal (memcpy)
17+import Data.ByteString.Unsafe (unsafeTake, unsafeDrop)
18+import Data.IORef (newIORef, readIORef, writeIORef)
19+import qualified Data.Streaming.ByteString.Builder.Buffer as B (Buffer (..))
20+import Foreign.ForeignPtr
21+import Foreign.Marshal.Alloc (mallocBytes, free, finalizerFree)
22+import Foreign.Ptr (castPtr, plusPtr)
1123
12−-- FIXME come up with good values here
24+import Network.Wai.Handler.Warp.Imports
25+import Network.Wai.Handler.Warp.Types
26+
27+----------------------------------------------------------------
28+
29+-- | The default size of the write buffer: 16384 (2^14 = 1024 * 16).
30+-- This is the maximum size of TLS record.
31+-- This is also the maximum size of HTTP/2 frame payload
32+-- (excluding frame header).
1333bufferSize :: BufSize
14−bufferSize = 4096
34+bufferSize = 16384
1535
36+-- | Allocating a buffer with malloc().
1637allocateBuffer :: Int -> IO Buffer
1738allocateBuffer = mallocBytes
1839
40+-- | Releasing a buffer with free().
1941freeBuffer :: Buffer -> IO ()
2042freeBuffer = free
2143
22−toBlazeBuffer :: Buffer -> BufSize -> IO B.Buffer
23−toBlazeBuffer ptr size = do
44+----------------------------------------------------------------
45+
46+largeBufferSize :: Int
47+largeBufferSize = 16384
48+
49+minBufferSize :: Int
50+minBufferSize = 2048
51+
52+newBufferPool :: IO BufferPool
53+newBufferPool = newIORef BS.empty
54+
55+mallocBS :: Int -> IO ByteString
56+mallocBS size = do
57+ ptr <- allocateBuffer size
58+ fptr <- newForeignPtr finalizerFree ptr
59+ return $! PS fptr 0 size
60+{-# INLINE mallocBS #-}
61+
62+usefulBuffer :: ByteString -> Bool
63+usefulBuffer buffer = BS.length buffer >= minBufferSize
64+{-# INLINE usefulBuffer #-}
65+
66+getBuffer :: BufferPool -> IO ByteString
67+getBuffer pool = do
68+ buffer <- readIORef pool
69+ if usefulBuffer buffer then return buffer else mallocBS largeBufferSize
70+{-# INLINE getBuffer #-}
71+
72+putBuffer :: BufferPool -> ByteString -> IO ()
73+putBuffer pool buffer = writeIORef pool buffer
74+{-# INLINE putBuffer #-}
75+
76+withForeignBuffer :: ByteString -> ((Buffer, BufSize) -> IO Int) -> IO Int
77+withForeignBuffer (PS ps s l) f = withForeignPtr ps $ \p -> f (castPtr p `plusPtr` s, l)
78+{-# INLINE withForeignBuffer #-}
79+
80+withBufferPool :: BufferPool -> ((Buffer, BufSize) -> IO Int) -> IO ByteString
81+withBufferPool pool f = do
82+ buffer <- getBuffer pool
83+ consumed <- withForeignBuffer buffer f
84+ putBuffer pool $! unsafeDrop consumed buffer
85+ return $! unsafeTake consumed buffer
86+{-# INLINE withBufferPool #-}
87+
88+----------------------------------------------------------------
89+--
90+-- Utilities
91+--
92+
93+toBuilderBuffer :: Buffer -> BufSize -> IO B.Buffer
94+toBuilderBuffer ptr size = do
2495 fptr <- newForeignPtr_ ptr
2596 return $ B.Buffer fptr ptr ptr (ptr `plusPtr` size)
97+
98+-- | Copying the bytestring to the buffer.
99+-- This function returns the point where the next copy should start.
100+copy :: Buffer -> ByteString -> IO Buffer
101+copy !ptr (PS fp o l) = withForeignPtr fp $ \p -> do
102+ memcpy ptr (p `plusPtr` o) (fromIntegral l)
103+ return $! ptr `plusPtr` l
104+{-# INLINE copy #-}
105+
106+bufferIO :: Buffer -> Int -> (ByteString -> IO ()) -> IO ()
107+bufferIO ptr siz io = do
108+ fptr <- newForeignPtr_ ptr
109+ io $ PS fptr 0 siz
warp/Network/Wai/Handler/Warp/Conduit.hs+6−15
@@ -1,13 +1,12 @@
1+{-# LANGUAGE CPP #-}
2+
13module Network.Wai.Handler.Warp.Conduit where
24
35import Control.Exception
4−import Control.Monad (when, unless)
5−import Data.ByteString (ByteString)
6−import Data.ByteString.Lazy.Char8 (pack)
76import qualified Data.ByteString as S
8−import qualified Data.ByteString.Lazy as L
97import qualified Data.IORef as I
10−import Data.Word (Word, Word8)
8+
9+import Network.Wai.Handler.Warp.Imports
1110import Network.Wai.Handler.Warp.Types
1211
1312----------------------------------------------------------------
@@ -61,11 +60,6 @@ readISource (ISource src ref) = do
6160 assert (count' == 0) $ I.writeIORef ref count'
6261 return x
6362
64−-- | Extract the underlying @Source@ from an @IsolatedBSSource@, which will not
65−-- perform any more isolation.
66−isourceDone :: ISource -> Source
67−isourceDone (ISource src _) = src
68−
6963----------------------------------------------------------------
7064
7165data CSource = CSource !Source !(I.IORef ChunkState)
@@ -76,9 +70,6 @@ data ChunkState = NeedLen
7670 | DoneChunking
7771 deriving Show
7872
79−bsCRLF :: L.ByteString
80−bsCRLF = pack "\r\n"
81−
8273mkCSource :: Source -> IO CSource
8374mkCSource src = do
8475 ref <- I.newIORef NeedLen
@@ -148,13 +139,13 @@ readCSource (CSource src ref) = do
148139 return S.empty
149140 else do
150141 (x, y) <-
151− case S.breakByte 10 bs of
142+ case S.break (== 10) bs of
152143 (x, y)
153144 | S.null y -> do
154145 bs2 <- readSource' src
155146 return $ if S.null bs2
156147 then (x, y)
157− else S.breakByte 10 $ bs `S.append` bs2
148+ else S.break (== 10) $ bs `S.append` bs2
158149 | otherwise -> return (x, y)
159150 let w =
160151 S.foldl' (\i c -> i * 16 + fromIntegral (hexToWord c)) 0
warp/Network/Wai/Handler/Warp/Counter.hs+15−9
@@ -1,24 +1,30 @@
1+{-# LANGUAGE CPP #-}
2+
13module Network.Wai.Handler.Warp.Counter (
24 Counter
35 , newCounter
4− , isZero
6+ , waitForZero
57 , increase
68 , decrease
79 ) where
810
9−import Network.Wai.Handler.Warp.IORef
10−import Control.Applicative ((<$>))
11+import Control.Concurrent.STM
12+
13+import Network.Wai.Handler.Warp.Imports
14+
1115
12−newtype Counter = Counter (IORef Int)
16+newtype Counter = Counter (TVar Int)
1317
1418newCounter :: IO Counter
15−newCounter = Counter <$> newIORef 0
19+newCounter = Counter <$> newTVarIO 0
1620
17−isZero :: Counter -> IO Bool
18−isZero (Counter ref) = (== 0) <$> readIORef ref
21+waitForZero :: Counter -> IO ()
22+waitForZero (Counter ref) = atomically $ do
23+ x <- readTVar ref
24+ unless (x == 0) retry
1925
2026increase :: Counter -> IO ()
21−increase (Counter ref) = atomicModifyIORef' ref $ \x -> (x + 1, ())
27+increase (Counter ref) = atomically $ modifyTVar' ref $ \x -> x + 1
2228
2329decrease :: Counter -> IO ()
24−decrease (Counter ref) = atomicModifyIORef' ref $ \x -> (x - 1, ())
30+decrease (Counter ref) = atomically $ modifyTVar' ref $ \x -> x - 1
warp/Network/Wai/Handler/Warp/Date.hs+17−22
@@ -2,45 +2,40 @@
22
33module Network.Wai.Handler.Warp.Date (
44 withDateCache
5− , getDate
6− , DateCache
75 , GMTDate
86 ) where
97
10−import Control.Applicative
118import Control.AutoUpdate (defaultUpdateSettings, updateAction, mkAutoUpdate)
12−import Data.ByteString.Char8
9+import Data.ByteString
10+import Network.HTTP.Date
1311
1412#if WINDOWS
15−import Data.Time
16−import System.Locale
13+import Data.Time (UTCTime, getCurrentTime)
14+import Data.Time.Clock.POSIX (utcTimeToPOSIXSeconds)
15+import Foreign.C.Types (CTime(..))
1716#else
18−import Network.HTTP.Date
1917import System.Posix (epochTime)
2018#endif
2119
2220-- | The type of the Date header value.
2321type GMTDate = ByteString
2422
25−-- | The type of the cache of the Date header value.
26−type DateCache = IO GMTDate
27−
2823-- | Creating 'DateCache' and executing the action.
29−withDateCache :: (DateCache -> IO a) -> IO a
24+withDateCache :: (IO GMTDate -> IO a) -> IO a
3025withDateCache action = initialize >>= action
3126
32−initialize :: IO DateCache
33−initialize = mkAutoUpdate defaultUpdateSettings { updateAction = getCurrentGMTDate }
27+initialize :: IO (IO GMTDate)
28+initialize = mkAutoUpdate defaultUpdateSettings {
29+ updateAction = formatHTTPDate <$> getCurrentHTTPDate
30+ }
3431
35−-- | Getting 'GMTDate' based on 'DateCache'.
36−getDate :: DateCache -> IO GMTDate
37−getDate = id
38−
39−getCurrentGMTDate :: IO GMTDate
4032#ifdef WINDOWS
41−getCurrentGMTDate = formatDate <$> getCurrentTime
42− where
43− formatDate = pack . formatTime defaultTimeLocale "%a, %d %b %Y %H:%M:%S GMT"
33+uToH :: UTCTime -> HTTPDate
34+uToH = epochTimeToHTTPDate . CTime . truncate . utcTimeToPOSIXSeconds
35+
36+getCurrentHTTPDate :: IO HTTPDate
37+getCurrentHTTPDate = uToH <$> getCurrentTime
4438#else
45−getCurrentGMTDate = formatHTTPDate . epochTimeToHTTPDate <$> epochTime
39+getCurrentHTTPDate :: IO HTTPDate
40+getCurrentHTTPDate = epochTimeToHTTPDate <$> epochTime
4641#endif
warp/Network/Wai/Handler/Warp/FdCache.hs+78−88
@@ -2,34 +2,46 @@
22
33-- | File descriptor cache to avoid locks in kernel.
44
5−#ifndef SENDFILEFD
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−import Control.Applicative ((<$>), (<*>))
26−import Control.Exception (bracket)
27−import Data.Hashable (hash)
28−import Network.Wai.Handler.Warp.IORef
29−import Network.Wai.Handler.Warp.MultiMap
30−import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd)
31−import System.Posix.Types (Fd)
32−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)
3345
3446----------------------------------------------------------------
3547
@@ -37,9 +49,6 @@ data Status = Active | Inactive
3749
3850newtype MutableStatus = MutableStatus (IORef Status)
3951
40−-- | An action to activate a Fd cache entry.
41−type Refresh = IO ()
42−
4352status :: MutableStatus -> IO Status
4453status (MutableStatus ref) = readIORef ref
4554
@@ -54,99 +63,80 @@ inactive (MutableStatus ref) = writeIORef ref Inactive
5463
5564----------------------------------------------------------------
5665
57−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
5876
5977newFdEntry :: FilePath -> IO FdEntry
60−newFdEntry path = FdEntry path
61− <$> openFd path ReadOnly Nothing defaultFileFlags{nonBlock=True}
62− <*> newActiveStatus
78+newFdEntry path = FdEntry <$> openFile path <*> newActiveStatus
79+
80+setFileCloseOnExec :: Fd -> IO ()
81+setFileCloseOnExec fd = setFdOption fd CloseOnExec True
6382
6483----------------------------------------------------------------
6584
66−type Hash = Int
67−type FdCache = MMap Hash FdEntry
85+type FdCache = MultiMap FdEntry
6886
6987-- | Mutable Fd cacher.
70−type MutableFdCache = Reaper FdCache (Hash, FdEntry)
88+newtype MutableFdCache = MutableFdCache (Reaper FdCache (FilePath,FdEntry))
7189
7290fdCache :: MutableFdCache -> IO FdCache
73−fdCache mfc = reaperRead mfc
74−
75−look :: MutableFdCache -> FilePath -> Hash -> IO (Maybe FdEntry)
76−look mfc path key = searchWith key check <$> fdCache mfc
77− where
78− check (One ent@(FdEntry path' _ _))
79− | path == path' = Just ent
80− | otherwise = Nothing
81− check (Tom ent@(FdEntry path' _ _) vs)
82− | path == path' = Just ent
83− | otherwise = check vs
84−
85−----------------------------------------------------------------
91+fdCache (MutableFdCache reaper) = reaperRead reaper
8692
87−-- | Creating 'MutableFdCache' and executing the action in the second
88−-- argument. The first argument is a cache duration in second.
89−withFdCache :: Int -> (Maybe MutableFdCache -> IO a) -> IO a
90−withFdCache duration action = bracket (initialize duration)
91− terminate
92− action
93+look :: MutableFdCache -> FilePath -> IO (Maybe FdEntry)
94+look mfc path = MM.lookup path <$> fdCache mfc
9395
9496----------------------------------------------------------------
9597
9698-- The first argument is a cache duration in second.
97−initialize :: Int -> IO (Maybe MutableFdCache)
98−initialize 0 = return Nothing
99−initialize duration = Just <$> mkReaper defaultReaperSettings
100− { reaperAction = clean
101− , reaperDelay = duration
102− , reaperCons = uncurry insert
103− , reaperNull = isEmpty
104− , reaperEmpty = empty
105− }
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+ }
106109
107110clean :: FdCache -> IO (FdCache -> FdCache)
108111clean old = do
109112 new <- pruneWith old prune
110113 return $ merge new
111−
112−prune :: t -> Some FdEntry -> IO [(t, Some FdEntry)]
113−prune k v@(One (FdEntry _ fd mst)) = status mst >>= prune'
114− where
115− prune' Active = inactive mst >> return [(k,v)]
116− prune' Inactive = closeFd fd >> return []
117−prune k (Tom ent@(FdEntry _ fd mst) vs) = status mst >>= prune'
118114 where
119− prune' Active = do
120− inactive mst
121− zs <- prune k vs
122− case zs of
123− [] -> return [(k,One ent)]
124− [(_,zvs)] -> return [(k,Tom ent zvs)]
125− _ -> error "prune"
126− 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
127119
128120----------------------------------------------------------------
129121
130−terminate :: Maybe MutableFdCache -> IO ()
131−terminate Nothing = return ()
132−terminate (Just mfc) = do
133− !t <- reaperStop mfc
134− mapM_ closeIt $ toList t
122+terminate :: MutableFdCache -> IO ()
123+terminate (MutableFdCache reaper) = do
124+ !t <- reaperStop reaper
125+ mapM_ (closeIt . snd) $ toList t
135126 where
136− closeIt (_, FdEntry _ fd _) = closeFd fd
127+ closeIt (FdEntry fd _) = closeFd fd
137128
138129----------------------------------------------------------------
139130
140131-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
141−getFd :: MutableFdCache -> FilePath -> IO (Fd, Refresh)
142−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
143134 where
144− key = hash path
145− getFd' Nothing = do
146− ent@(FdEntry _ fd mst) <- newFdEntry path
147− reaperAdd mfc (key, ent)
148− return (fd, refresh mst)
149− 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
150140 refresh mst
151− return (fd, refresh mst)
141+ return (Just fd, refresh mst)
152142#endif
warp/Network/Wai/Handler/Warp/File.hsnew file+152
@@ -0,0 +1,152 @@
1+{-# LANGUAGE CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
4+
5+module Network.Wai.Handler.Warp.File (
6+ RspFileInfo(..)
7+ , conditionalRequest
8+ , addContentHeadersForFilePart
9+ , H.parseByteRanges
10+ ) where
11+
12+import Data.Array ((!))
13+import qualified Data.ByteString.Char8 as C8 (pack)
14+import Network.HTTP.Date
15+import qualified Network.HTTP.Types as H
16+import qualified Network.HTTP.Types.Header as H
17+import Network.Wai
18+
19+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
20+import Network.Wai.Handler.Warp.Header
21+import Network.Wai.Handler.Warp.Imports
22+import Network.Wai.Handler.Warp.PackInt
23+
24+
25+-- $setup
26+-- >>> import Test.QuickCheck
27+
28+----------------------------------------------------------------
29+
30+data RspFileInfo = WithoutBody H.Status
31+ | WithBody H.Status H.ResponseHeaders Integer Integer
32+ deriving (Eq,Show)
33+
34+----------------------------------------------------------------
35+
36+conditionalRequest :: I.FileInfo
37+ -> H.ResponseHeaders
38+ -> IndexedHeader -- ^ Response
39+ -> IndexedHeader -- ^ Request
40+ -> RspFileInfo
41+conditionalRequest finfo hs0 rspidx reqidx = case condition of
42+ nobody@(WithoutBody _) -> nobody
43+ WithBody s _ off len -> let !hs1 = addContentHeaders hs0 off len size
44+ !hasLM = isJust $ rspidx ! fromEnum ResLastModified
45+ !hs = [ (H.hLastModified,date) | not hasLM ] ++ hs1
46+ in WithBody s hs off len
47+ where
48+ !mtime = I.fileInfoTime finfo
49+ !size = I.fileInfoSize finfo
50+ !date = I.fileInfoDate finfo
51+ !mcondition = ifmodified reqidx size mtime
52+ <|> ifunmodified reqidx size mtime
53+ <|> ifrange reqidx size mtime
54+ !condition = fromMaybe (unconditional reqidx size) mcondition
55+
56+----------------------------------------------------------------
57+
58+ifModifiedSince :: IndexedHeader -> Maybe HTTPDate
59+ifModifiedSince reqidx = reqidx ! fromEnum ReqIfModifiedSince >>= parseHTTPDate
60+
61+ifUnmodifiedSince :: IndexedHeader -> Maybe HTTPDate
62+ifUnmodifiedSince reqidx = reqidx ! fromEnum ReqIfUnmodifiedSince >>= parseHTTPDate
63+
64+ifRange :: IndexedHeader -> Maybe HTTPDate
65+ifRange reqidx = reqidx ! fromEnum ReqIfRange >>= parseHTTPDate
66+
67+----------------------------------------------------------------
68+
69+ifmodified :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
70+ifmodified reqidx size mtime = do
71+ date <- ifModifiedSince reqidx
72+ return $ if date /= mtime
73+ then unconditional reqidx size
74+ else WithoutBody H.notModified304
75+
76+ifunmodified :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
77+ifunmodified reqidx size mtime = do
78+ date <- ifUnmodifiedSince reqidx
79+ return $ if date == mtime
80+ then unconditional reqidx size
81+ else WithoutBody H.preconditionFailed412
82+
83+ifrange :: IndexedHeader -> Integer -> HTTPDate -> Maybe RspFileInfo
84+ifrange reqidx size mtime = do
85+ date <- ifRange reqidx
86+ rng <- reqidx ! fromEnum ReqRange
87+ return $ if date == mtime
88+ then parseRange rng size
89+ else WithBody H.ok200 [] 0 size
90+
91+unconditional :: IndexedHeader -> Integer -> RspFileInfo
92+unconditional reqidx size = case reqidx ! fromEnum ReqRange of
93+ Nothing -> WithBody H.ok200 [] 0 size
94+ Just rng -> parseRange rng size
95+
96+----------------------------------------------------------------
97+
98+parseRange :: ByteString -> Integer -> RspFileInfo
99+parseRange rng size = case H.parseByteRanges rng of
100+ Nothing -> WithoutBody H.requestedRangeNotSatisfiable416
101+ Just [] -> WithoutBody H.requestedRangeNotSatisfiable416
102+ Just (r:_) -> let (!beg, !end) = checkRange r size
103+ !len = end - beg + 1
104+ s = if beg == 0 && end == size - 1 then
105+ H.ok200
106+ else
107+ H.partialContent206
108+ in WithBody s [] beg len
109+
110+checkRange :: H.ByteRange -> Integer -> (Integer, Integer)
111+checkRange (H.ByteRangeFrom beg) size = (beg, size - 1)
112+checkRange (H.ByteRangeFromTo beg end) size = (beg, min (size - 1) end)
113+checkRange (H.ByteRangeSuffix count) size = (max 0 (size - count), size - 1)
114+
115+----------------------------------------------------------------
116+
117+-- | @contentRangeHeader beg end total@ constructs a Content-Range 'H.Header'
118+-- for the range specified.
119+contentRangeHeader :: Integer -> Integer -> Integer -> H.Header
120+contentRangeHeader beg end total = (H.hContentRange, range)
121+ where
122+ range = C8.pack
123+ -- building with ShowS
124+ $ 'b' : 'y': 't' : 'e' : 's' : ' '
125+ : (if beg > end then ('*':) else
126+ showInt beg
127+ . ('-' :)
128+ . showInt end)
129+ ( '/'
130+ : showInt total "")
131+
132+addContentHeaders :: H.ResponseHeaders -> Integer -> Integer -> Integer -> H.ResponseHeaders
133+addContentHeaders hs off len size
134+ | len == size = hs'
135+ | otherwise = let !ctrng = contentRangeHeader off (off + len - 1) size
136+ in ctrng:hs'
137+ where
138+ !lengthBS = packIntegral len
139+ !hs' = (H.hContentLength, lengthBS) : (H.hAcceptRanges,"bytes") : hs
140+
141+-- |
142+--
143+-- >>> addContentHeadersForFilePart [] (FilePart 2 10 16)
144+-- [("Content-Range","bytes 2-11/16"),("Content-Length","10"),("Accept-Ranges","bytes")]
145+-- >>> addContentHeadersForFilePart [] (FilePart 0 16 16)
146+-- [("Content-Length","16"),("Accept-Ranges","bytes")]
147+addContentHeadersForFilePart :: H.ResponseHeaders -> FilePart -> H.ResponseHeaders
148+addContentHeadersForFilePart hs part = addContentHeaders hs off len size
149+ where
150+ off = filePartOffset part
151+ len = filePartByteCount part
152+ size = filePartFileSize part
warp/Network/Wai/Handler/Warp/FileInfoCache.hsnew file+108
@@ -0,0 +1,108 @@
1+{-# LANGUAGE RecordWildCards, CPP #-}
2+
3+module Network.Wai.Handler.Warp.FileInfoCache (
4+ FileInfo(..)
5+ , withFileInfoCache
6+ , getInfo -- test purpose only
7+ ) where
8+
9+import Control.Exception as E
10+import Control.Reaper
11+import Network.HTTP.Date
12+import System.PosixCompat.Files
13+
14+import Network.Wai.Handler.Warp.HashMap (HashMap)
15+import qualified Network.Wai.Handler.Warp.HashMap as M
16+import Network.Wai.Handler.Warp.Imports
17+
18+----------------------------------------------------------------
19+
20+-- | File information.
21+data FileInfo = FileInfo {
22+ fileInfoName :: !FilePath
23+ , fileInfoSize :: !Integer
24+ , fileInfoTime :: HTTPDate -- ^ Modification time
25+ , fileInfoDate :: ByteString -- ^ Modification time in the GMT format
26+ } deriving (Eq, Show)
27+
28+data Entry = Negative | Positive FileInfo
29+type Cache = HashMap Entry
30+type FileInfoCache = Reaper Cache (FilePath,Entry)
31+
32+----------------------------------------------------------------
33+
34+-- | Getting the file information corresponding to the file.
35+getInfo :: FilePath -> IO FileInfo
36+getInfo path = do
37+ fs <- getFileStatus path -- file access
38+ let regular = not (isDirectory fs)
39+ readable = fileMode fs `intersectFileModes` ownerReadMode /= 0
40+ if regular && readable then do
41+ let time = epochTimeToHTTPDate $ modificationTime fs
42+ date = formatHTTPDate time
43+ size = fromIntegral $ fileSize fs
44+ info = FileInfo {
45+ fileInfoName = path
46+ , fileInfoSize = size
47+ , fileInfoTime = time
48+ , fileInfoDate = date
49+ }
50+ return info
51+ else
52+ throwIO (userError "FileInfoCache:getInfo")
53+
54+getInfoNaive :: FilePath -> IO FileInfo
55+getInfoNaive = getInfo
56+
57+----------------------------------------------------------------
58+
59+getAndRegisterInfo :: FileInfoCache -> FilePath -> IO FileInfo
60+getAndRegisterInfo reaper@Reaper{..} path = do
61+ cache <- reaperRead
62+ case M.lookup path cache of
63+ Just Negative -> throwIO (userError "FileInfoCache:getAndRegisterInfo")
64+ Just (Positive x) -> return x
65+ Nothing -> positive reaper path
66+ `E.onException` negative reaper path
67+
68+positive :: FileInfoCache -> FilePath -> IO FileInfo
69+positive Reaper{..} path = do
70+ info <- getInfo path
71+ reaperAdd (path, Positive info)
72+ return info
73+
74+negative :: FileInfoCache -> FilePath -> IO FileInfo
75+negative Reaper{..} path = do
76+ reaperAdd (path, Negative)
77+ throwIO (userError "FileInfoCache:negative")
78+
79+----------------------------------------------------------------
80+
81+-- | Creating a file information cache
82+-- and executing the action in the second argument.
83+-- The first argument is a cache duration in second.
84+withFileInfoCache :: Int
85+ -> ((FilePath -> IO FileInfo) -> IO a)
86+ -> IO a
87+withFileInfoCache 0 action = action getInfoNaive
88+withFileInfoCache duration action =
89+ E.bracket (initialize duration)
90+ terminate
91+ (action . getAndRegisterInfo)
92+
93+initialize :: Int -> IO FileInfoCache
94+initialize duration = mkReaper settings
95+ where
96+ settings = defaultReaperSettings {
97+ reaperAction = override
98+ , reaperDelay = duration
99+ , reaperCons = \(path,v) -> M.insert path v
100+ , reaperNull = M.isEmpty
101+ , reaperEmpty = M.empty
102+ }
103+
104+override :: Cache -> IO (Cache -> Cache)
105+override _ = return $ const M.empty
106+
107+terminate :: FileInfoCache -> IO ()
108+terminate x = void $ reaperStop x
warp/Network/Wai/Handler/Warp/HTTP2.hsnew file+85
@@ -0,0 +1,85 @@
1+{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
6+
7+module Network.Wai.Handler.Warp.HTTP2 (http2) where
8+
9+import qualified Data.IORef as I
10+import qualified Control.Exception as E
11+import qualified Network.HTTP2.Server as H2
12+import Network.Socket (SockAddr)
13+import Network.Wai
14+import Network.Wai.Internal (ResponseReceived(..))
15+import qualified System.TimeManager as T
16+
17+import Network.Wai.Handler.Warp.HTTP2.File
18+import Network.Wai.Handler.Warp.HTTP2.PushPromise
19+import Network.Wai.Handler.Warp.HTTP2.Request
20+import Network.Wai.Handler.Warp.HTTP2.Response
21+import Network.Wai.Handler.Warp.Imports
22+import qualified Network.Wai.Handler.Warp.Settings as S
23+import Network.Wai.Handler.Warp.Types
24+
25+----------------------------------------------------------------
26+
27+http2 :: Connection -> Transport -> InternalInfo -> SockAddr -> S.Settings -> (BufSize -> IO ByteString) -> (ByteString -> IO ()) -> Application -> IO ()
28+http2 conn transport ii addr settings readN send app =
29+ H2.run conf http2server
30+ where
31+ conf = H2.Config {
32+ confWriteBuffer = connWriteBuffer conn
33+ , confBufferSize = connBufferSize conn
34+ , confSendAll = send
35+ , confReadN = readN
36+ , confPositionReadMaker = pReadMaker ii
37+ }
38+
39+ http2server h2req aux response = do
40+ req <- toWAIRequest h2req aux
41+ ref <- I.newIORef Nothing
42+ eResponseReceived <- E.try $ app req $ \rsp -> do
43+ h2rsp <- fromResponse settings ii req rsp
44+ pps <- fromPushPromises ii req
45+ I.writeIORef ref $ Just (h2rsp, pps)
46+ _ <- response h2rsp pps
47+ return ResponseReceived
48+ case eResponseReceived of
49+ Right ResponseReceived -> do
50+ Just (h2rsp, pps) <- I.readIORef ref
51+ logResponse h2rsp req
52+ mapM_ (logPushPromise req) pps
53+ Left e@(E.SomeException _)
54+ -- killed by the local worker manager
55+ | Just E.ThreadKilled <- E.fromException e -> return ()
56+ -- killed by the local timeout manager
57+ | Just T.TimeoutThread <- E.fromException e -> return ()
58+ | otherwise -> do
59+ S.settingsOnException settings (Just req) e
60+ let ersp = S.settingsOnExceptionResponse settings e
61+ h2rsp' <- fromResponse settings ii req ersp
62+ _ <- response h2rsp' []
63+ logResponse h2rsp' req
64+ return ()
65+
66+ toWAIRequest h2req aux = toRequest ii settings addr hdr bdylen bdy th transport
67+ where
68+ !hdr = H2.requestHeaders h2req
69+ !bdy = H2.getRequestBodyChunk h2req
70+ !bdylen = H2.requestBodySize h2req
71+ !th = H2.auxTimeHandle aux
72+
73+ logResponse h2rsp req = logger req st msiz
74+ where
75+ !logger = S.settingsLogger settings
76+ !st = H2.responseStatus h2rsp
77+ !msiz = fromIntegral <$> H2.responseBodySize h2rsp
78+
79+ logPushPromise req pp = logger req path siz
80+ where
81+ !logger = S.settingsServerPushLogger settings
82+ !path = H2.promiseRequestPath pp
83+ !siz = case H2.responseBodySize $ H2.promiseResponse pp of
84+ Nothing -> 0
85+ Just s -> fromIntegral s
warp/Network/Wai/Handler/Warp/HTTP2/File.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.HTTP2.File where
4+
5+import Network.HTTP2.Server
6+
7+import Network.Wai.Handler.Warp.Types
8+
9+#ifdef WINDOWS
10+pReadMaker :: InternalInfo -> PositionReadMaker
11+pReadMaker _ = defaultPositionReadMaker
12+#else
13+import Network.Wai.Handler.Warp.FdCache
14+import Network.Wai.Handler.Warp.SendFile (positionRead)
15+
16+pReadMaker :: InternalInfo -> PositionReadMaker
17+pReadMaker ii path = do
18+ (mfd, refresh) <- getFd ii path
19+ case mfd of
20+ Just fd -> return (pread fd, Refresher refresh)
21+ Nothing -> do
22+ fd <- openFile path
23+ return (pread fd, Closer $ closeFile fd)
24+ where
25+ pread :: Fd -> PositionRead
26+ pread fd off bytes buf = fromIntegral <$> positionRead fd buf bytes' off'
27+ where
28+ bytes' = fromIntegral bytes
29+ off' = fromIntegral off
30+#endif
warp/Network/Wai/Handler/Warp/HTTP2/PushPromise.hsnew file+36
@@ -0,0 +1,36 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+module Network.Wai.Handler.Warp.HTTP2.PushPromise where
6+
7+import qualified Control.Exception as E
8+import qualified Network.HTTP.Types as H
9+import qualified Network.HTTP2.Server as H2
10+
11+import Network.Wai
12+import Network.Wai.Handler.Warp.FileInfoCache
13+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
14+import Network.Wai.Handler.Warp.HTTP2.Types
15+import Network.Wai.Handler.Warp.Imports
16+import Network.Wai.Handler.Warp.Types
17+
18+fromPushPromises :: InternalInfo -> Request -> IO [H2.PushPromise]
19+fromPushPromises ii req = do
20+ mh2data <- getHTTP2Data req
21+ let pp = case mh2data of
22+ Nothing -> []
23+ Just h2data -> http2dataPushPromise h2data
24+ catMaybes <$> mapM (fromPushPromise ii) pp
25+
26+fromPushPromise :: InternalInfo -> PushPromise -> IO (Maybe H2.PushPromise)
27+fromPushPromise ii (PushPromise path file rsphdr w) = do
28+ efinfo <- E.try $ getFileInfo ii file
29+ case efinfo of
30+ Left (_ex :: E.IOException) -> return Nothing
31+ Right finfo -> do
32+ let !siz = fromIntegral $ fileInfoSize finfo
33+ !fileSpec = H2.FileSpec file 0 siz
34+ !rsp = H2.responseFile H.ok200 rsphdr fileSpec
35+ !pp = H2.pushPromise path rsp w
36+ return $ Just pp
warp/Network/Wai/Handler/Warp/HTTP2/Request.hsnew file+126
@@ -0,0 +1,126 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.HTTP2.Request (
4+ toRequest
5+ , getHTTP2Data
6+ , setHTTP2Data
7+ , modifyHTTP2Data
8+ ) where
9+
10+import Control.Arrow (first)
11+import qualified Data.ByteString.Char8 as C8
12+import Data.IORef
13+import qualified Data.Vault.Lazy as Vault
14+import Network.HPACK
15+import Network.HPACK.Token
16+import qualified Network.HTTP.Types as H
17+import Network.Socket (SockAddr)
18+import Network.Wai
19+import Network.Wai.Internal (Request(..))
20+import System.IO.Unsafe (unsafePerformIO)
21+import qualified System.TimeManager as T
22+
23+import Network.Wai.Handler.Warp.HTTP2.Types
24+import Network.Wai.Handler.Warp.Imports
25+import Network.Wai.Handler.Warp.Request (getFileInfoKey, pauseTimeoutKey, getClientCertificateKey)
26+import qualified Network.Wai.Handler.Warp.Settings as S (Settings, settingsNoParsePath)
27+import Network.Wai.Handler.Warp.Types
28+
29+type ToReq = (TokenHeaderList,ValueTable) -> Maybe Int -> IO ByteString -> T.Handle -> Transport -> IO Request
30+
31+----------------------------------------------------------------
32+
33+toRequest :: InternalInfo -> S.Settings -> SockAddr -> ToReq
34+toRequest ii settings addr ht bodylen body th transport = do
35+ ref <- newIORef Nothing
36+ toRequest' ii settings addr ref ht bodylen body th transport
37+
38+toRequest' :: InternalInfo -> S.Settings -> SockAddr
39+ -> IORef (Maybe HTTP2Data)
40+ -> ToReq
41+toRequest' ii settings addr ref (reqths,reqvt) bodylen body th transport = return req
42+ where
43+ !req = Request {
44+ requestMethod = colonMethod
45+ , httpVersion = H.http20
46+ , rawPathInfo = rawPath
47+ , pathInfo = H.decodePathSegments path
48+ , rawQueryString = query
49+ , queryString = H.parseQuery query
50+ , requestHeaders = headers
51+ , isSecure = isTransportSecure transport
52+ , remoteHost = addr
53+ , requestBody = body
54+ , vault = vaultValue
55+ , requestBodyLength = maybe ChunkedBody (KnownLength . fromIntegral) bodylen
56+ , requestHeaderHost = mHost <|> mAuth
57+ , requestHeaderRange = mRange
58+ , requestHeaderReferer = mReferer
59+ , requestHeaderUserAgent = mUserAgent
60+ }
61+ headers = map (first tokenKey) ths
62+ where
63+ ths = case mHost of
64+ Just _ -> reqths
65+ Nothing -> case mAuth of
66+ Just auth -> (tokenHost, auth) : reqths
67+ _ -> reqths
68+ !mPath = getHeaderValue tokenPath reqvt -- SHOULD
69+ !colonMethod = fromJust $ getHeaderValue tokenMethod reqvt -- MUST
70+ !mAuth = getHeaderValue tokenAuthority reqvt -- SHOULD
71+ !mHost = getHeaderValue tokenHost reqvt
72+ !mRange = getHeaderValue tokenRange reqvt
73+ !mReferer = getHeaderValue tokenReferer reqvt
74+ !mUserAgent = getHeaderValue tokenUserAgent reqvt
75+ -- CONNECT request will have ":path" omitted, use ":authority" as unparsed
76+ -- path instead so that it will have consistent behavior compare to HTTP 1.0
77+ (unparsedPath,query) = C8.break (=='?') $ fromJust (mPath <|> mAuth)
78+ !path = H.extractPath unparsedPath
79+ !rawPath = if S.settingsNoParsePath settings then unparsedPath else path
80+ -- fixme: pauseTimeout. th is not available here.
81+ !vaultValue = Vault.insert getFileInfoKey (getFileInfo ii)
82+ $ Vault.insert getHTTP2DataKey (readIORef ref)
83+ $ Vault.insert setHTTP2DataKey (writeIORef ref)
84+ $ Vault.insert modifyHTTP2DataKey (modifyIORef' ref)
85+ $ Vault.insert pauseTimeoutKey (T.pause th)
86+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
87+ Vault.empty
88+
89+getHTTP2DataKey :: Vault.Key (IO (Maybe HTTP2Data))
90+getHTTP2DataKey = unsafePerformIO Vault.newKey
91+{-# NOINLINE getHTTP2DataKey #-}
92+
93+-- | Getting 'HTTP2Data' through vault of the request.
94+-- Warp uses this to receive 'HTTP2Data' from 'Middleware'.
95+--
96+-- Since: 3.2.7
97+getHTTP2Data :: Request -> IO (Maybe HTTP2Data)
98+getHTTP2Data req = case Vault.lookup getHTTP2DataKey (vault req) of
99+ Nothing -> return Nothing
100+ Just getter -> getter
101+
102+setHTTP2DataKey :: Vault.Key (Maybe HTTP2Data -> IO ())
103+setHTTP2DataKey = unsafePerformIO Vault.newKey
104+{-# NOINLINE setHTTP2DataKey #-}
105+
106+-- | Setting 'HTTP2Data' through vault of the request.
107+-- 'Application' or 'Middleware' should use this.
108+--
109+-- Since: 3.2.7
110+setHTTP2Data :: Request -> Maybe HTTP2Data -> IO ()
111+setHTTP2Data req mh2d = case Vault.lookup setHTTP2DataKey (vault req) of
112+ Nothing -> return ()
113+ Just setter -> setter mh2d
114+
115+modifyHTTP2DataKey :: Vault.Key ((Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ())
116+modifyHTTP2DataKey = unsafePerformIO Vault.newKey
117+{-# NOINLINE modifyHTTP2DataKey #-}
118+
119+-- | Modifying 'HTTP2Data' through vault of the request.
120+-- 'Application' or 'Middleware' should use this.
121+--
122+-- Since: 3.2.8
123+modifyHTTP2Data :: Request -> (Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ()
124+modifyHTTP2Data req func = case Vault.lookup modifyHTTP2DataKey (vault req) of
125+ Nothing -> return ()
126+ Just modify -> modify func
warp/Network/Wai/Handler/Warp/HTTP2/Response.hsnew file+127
@@ -0,0 +1,127 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+
6+module Network.Wai.Handler.Warp.HTTP2.Response (
7+ fromResponse
8+ ) where
9+
10+import qualified Control.Exception as E
11+import qualified Data.ByteString.Builder as BB
12+import qualified Network.HTTP.Types as H
13+import qualified Network.HTTP2.Server as H2
14+import Network.Wai hiding (responseFile, responseBuilder, responseStream)
15+import Network.Wai.Internal (Response(..))
16+
17+import Network.Wai.Handler.Warp.File
18+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
19+import Network.Wai.Handler.Warp.HTTP2.Types
20+import Network.Wai.Handler.Warp.Header
21+import qualified Network.Wai.Handler.Warp.Response as R
22+import qualified Network.Wai.Handler.Warp.Settings as S
23+import Network.Wai.Handler.Warp.Types
24+
25+----------------------------------------------------------------
26+
27+fromResponse :: S.Settings -> InternalInfo -> Request -> Response -> IO H2.Response
28+fromResponse settings ii req rsp = do
29+ date <- getDate ii
30+ h2rsp <- case rsp of
31+ ResponseFile st rsphdr path mpart -> do
32+ let rsphdr' = add date svr rsphdr
33+ responseFile st rsphdr' isHead path mpart ii reqhdr
34+ ResponseBuilder st rsphdr builder -> do
35+ let rsphdr' = add date svr rsphdr
36+ return $ responseBuilder st rsphdr' isHead builder
37+ ResponseStream st rsphdr strmbdy -> do
38+ let rsphdr' = add date svr rsphdr
39+ return $ responseStream st rsphdr' isHead strmbdy
40+ _ -> error "ResponseRaw is not supported in HTTP/2"
41+ mh2data <- getHTTP2Data req
42+ case mh2data of
43+ Nothing -> return h2rsp
44+ Just h2data -> do
45+ let !trailers = http2dataTrailers h2data
46+ return $ H2.setResponseTrailersMaker h2rsp trailers
47+ where
48+ !isHead = requestMethod req == H.methodHead
49+ !reqhdr = requestHeaders req
50+ !svr = S.settingsServerName settings
51+ add date server rsphdr = (H.hDate, date) : (H.hServer, server) : rsphdr
52+ -- fixme: not adding svr if already exists
53+
54+----------------------------------------------------------------
55+
56+responseFile :: H.Status -> H.ResponseHeaders -> Bool
57+ -> FilePath -> Maybe FilePart -> InternalInfo -> H.RequestHeaders
58+ -> IO H2.Response
59+responseFile st rsphdr _ _ _ _ _
60+ | noBody st = return $ responseNoBody st rsphdr
61+
62+responseFile st rsphdr isHead path (Just fp) _ _ =
63+ return $ responseFile2XX st rsphdr isHead fileSpec
64+ where
65+ !off' = fromIntegral $ filePartOffset fp
66+ !bytes' = fromIntegral $ filePartByteCount fp
67+ !fileSpec = H2.FileSpec path off' bytes'
68+
69+responseFile _ rsphdr isHead path Nothing ii reqhdr = do
70+ efinfo <- E.try $ getFileInfo ii path
71+ case efinfo of
72+ Left (_ex :: E.IOException) -> return $ response404 rsphdr
73+ Right finfo -> do
74+ let reqidx = indexRequestHeader reqhdr
75+ rspidx = indexResponseHeader rsphdr
76+ case conditionalRequest finfo rsphdr rspidx reqidx of
77+ WithoutBody s -> return $ responseNoBody s rsphdr
78+ WithBody s rsphdr' off bytes -> do
79+ let !off' = fromIntegral off
80+ !bytes' = fromIntegral bytes
81+ !fileSpec = H2.FileSpec path off' bytes'
82+ return $ responseFile2XX s rsphdr' isHead fileSpec
83+
84+----------------------------------------------------------------
85+
86+responseFile2XX :: H.Status -> H.ResponseHeaders -> Bool -> H2.FileSpec -> H2.Response
87+responseFile2XX st rsphdr isHead fileSpec
88+ | isHead = responseNoBody st rsphdr
89+ | otherwise = H2.responseFile st rsphdr fileSpec
90+
91+----------------------------------------------------------------
92+
93+responseBuilder :: H.Status -> H.ResponseHeaders -> Bool
94+ -> BB.Builder
95+ -> H2.Response
96+responseBuilder st rsphdr isHead builder
97+ | noBody st = responseNoBody st rsphdr
98+ | isHead = responseNoBody st rsphdr
99+ | otherwise = H2.responseBuilder st rsphdr builder
100+
101+----------------------------------------------------------------
102+
103+responseStream :: H.Status -> H.ResponseHeaders -> Bool
104+ -> StreamingBody
105+ -> H2.Response
106+responseStream st rsphdr isHead strmbdy
107+ | noBody st = responseNoBody st rsphdr
108+ | isHead = responseNoBody st rsphdr
109+ | otherwise = H2.responseStreaming st rsphdr strmbdy
110+
111+----------------------------------------------------------------
112+
113+responseNoBody :: H.Status -> H.ResponseHeaders -> H2.Response
114+responseNoBody st rsphdr = H2.responseNoBody st rsphdr
115+
116+----------------------------------------------------------------
117+
118+response404 :: H.ResponseHeaders -> H2.Response
119+response404 rsphdr = H2.responseBuilder H.notFound404 rsphdr' body
120+ where
121+ !rsphdr' = R.replaceHeader H.hContentType "text/plain; charset=utf-8" rsphdr
122+ !body = BB.byteString "File not found"
123+
124+----------------------------------------------------------------
125+
126+noBody :: H.Status -> Bool
127+noBody = not . R.hasBody
warp/Network/Wai/Handler/Warp/HTTP2/Types.hsnew file+81
@@ -0,0 +1,81 @@
1+{-# LANGUAGE NamedFieldPuns #-}
2+{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE RecordWildCards #-}
4+
5+module Network.Wai.Handler.Warp.HTTP2.Types where
6+
7+import qualified Data.ByteString as BS
8+import qualified Network.HTTP.Types as H
9+import Network.HTTP2
10+import qualified Network.HTTP2.Server as H2
11+
12+import Network.Wai.Handler.Warp.Imports
13+import Network.Wai.Handler.Warp.Types
14+
15+----------------------------------------------------------------
16+
17+isHTTP2 :: Transport -> Bool
18+isHTTP2 TCP = False
19+isHTTP2 tls = useHTTP2
20+ where
21+ useHTTP2 = case tlsNegotiatedProtocol tls of
22+ Nothing -> False
23+ Just proto -> "h2" `BS.isPrefixOf` proto
24+
25+----------------------------------------------------------------
26+
27+-- | HTTP/2 specific data.
28+--
29+-- Since: 3.2.7
30+data HTTP2Data = HTTP2Data {
31+ -- | Accessor for 'PushPromise' in 'HTTP2Data'.
32+ --
33+ -- Since: 3.2.7
34+ http2dataPushPromise :: [PushPromise]
35+ -- | Accessor for 'H2.TrailersMaker' in 'HTTP2Data'.
36+ --
37+ -- Since: 3.2.8 but the type changed in 3.3.0
38+ , http2dataTrailers :: H2.TrailersMaker
39+ }
40+
41+-- | Default HTTP/2 specific data.
42+--
43+-- Since: 3.2.7
44+defaultHTTP2Data :: HTTP2Data
45+defaultHTTP2Data = HTTP2Data [] H2.defaultTrailersMaker
46+
47+-- | HTTP/2 push promise or sever push.
48+-- This allows files only for backward-compatibility
49+-- while the HTTP/2 library supports other types.
50+--
51+-- Since: 3.2.7
52+data PushPromise = PushPromise {
53+ -- | Accessor for a URL path in 'PushPromise'.
54+ -- E.g. \"\/style\/default.css\".
55+ --
56+ -- Since: 3.2.7
57+ promisedPath :: ByteString
58+ -- | Accessor for 'FilePath' in 'PushPromise'.
59+ -- E.g. \"FILE_PATH/default.css\".
60+ --
61+ -- Since: 3.2.7
62+ , promisedFile :: FilePath
63+ -- | Accessor for 'H.ResponseHeaders' in 'PushPromise'
64+ -- \"content-type\" must be specified.
65+ -- Default value: [].
66+ --
67+ --
68+ -- Since: 3.2.7
69+ , promisedResponseHeaders :: H.ResponseHeaders
70+ -- | Accessor for 'Weight' in 'PushPromise'.
71+ -- Default value: 16.
72+ --
73+ -- Since: 3.2.7
74+ , promisedWeight :: Weight
75+ } deriving (Eq,Ord,Show)
76+
77+-- | Default push promise.
78+--
79+-- Since: 3.2.7
80+defaultPushPromise :: PushPromise
81+defaultPushPromise = PushPromise "" "" [] 16
warp/Network/Wai/Handler/Warp/HashMap.hsnew file+42
@@ -0,0 +1,42 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.HashMap where
4+
5+import Data.Hashable (hash)
6+import Data.IntMap.Strict (IntMap)
7+import qualified Data.IntMap.Strict as I
8+import Data.Map.Strict (Map)
9+import qualified Data.Map.Strict as M
10+import Prelude hiding (lookup)
11+
12+----------------------------------------------------------------
13+
14+-- | 'HashMap' is used for cache of file information.
15+-- Hash values of file pathes are used as outer keys.
16+-- Because negative entries are also contained,
17+-- a bad guy can intentionally cause the hash collison.
18+-- So, 'Map' is used internally to prevent
19+-- the hash collision attack.
20+newtype HashMap v = HashMap (IntMap (Map FilePath v))
21+
22+----------------------------------------------------------------
23+
24+empty :: HashMap v
25+empty = HashMap I.empty
26+
27+isEmpty :: HashMap v -> Bool
28+isEmpty (HashMap hm) = I.null hm
29+
30+----------------------------------------------------------------
31+
32+insert :: FilePath -> v -> HashMap v -> HashMap v
33+insert path v (HashMap hm) = HashMap $ I.insertWith f h m hm
34+ where
35+ !h = hash path
36+ !m = M.singleton path v
37+ f = M.union -- fimxe
38+
39+lookup :: FilePath -> HashMap v -> Maybe v
40+lookup path (HashMap hm) = I.lookup h hm >>= M.lookup path
41+ where
42+ !h = hash path
warp/Network/Wai/Handler/Warp/Header.hs+48−26
@@ -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,29 +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−idxContentLength = 0
23−idxTransferEncoding = 1
24−idxExpect = 2
25−idxConnection = 3
26−idxRange = 4
27−idxHost = 5
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)
2835
2936-- | The size for 'IndexedHeader' for HTTP Request.
3037-- From 0 to this corresponds to \"Content-Length\", \"Transfer-Encoding\",
31−-- \"Expect\", \"Connection\", \"Range\", and \"Host\".
38+-- \"Expect\", \"Connection\", \"Range\", \"Host\",
39+-- \"If-Modified-Since\", \"If-Unmodified-Since\" and \"If-Range\".
3240requestMaxIndex :: Int
33−requestMaxIndex = 5
41+requestMaxIndex = fromEnum (maxBound :: RequestHeaderIndex)
3442
3543requestKeyIndex :: HeaderName -> Int
36−requestKeyIndex "content-length" = idxContentLength
37−requestKeyIndex "transfer-encoding" = idxTransferEncoding
38−requestKeyIndex "expect" = idxExpect
39−requestKeyIndex "connection" = idxConnection
40−requestKeyIndex "range" = idxRange
41−requestKeyIndex "host" = idxHost
42−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
4360
4461defaultIndexRequestHeader :: IndexedHeader
4562defaultIndexRequestHeader = array (0,requestMaxIndex) [(i,Nothing)|i<-[0..requestMaxIndex]]
@@ -49,20 +66,25 @@ defaultIndexRequestHeader = array (0,requestMaxIndex) [(i,Nothing)|i<-[0..reques
4966indexResponseHeader :: ResponseHeaders -> IndexedHeader
5067indexResponseHeader hdr = traverseHeader hdr responseMaxIndex responseKeyIndex
5168
52−idxServer, idxDate :: Int
53−--idxContentLength = 0
54−idxServer = 1
55−idxDate = 2
69+data ResponseHeaderIndex = ResContentLength
70+ | ResServer
71+ | ResDate
72+ | ResLastModified
73+ deriving (Enum,Bounded)
5674
5775-- | The size for 'IndexedHeader' for HTTP Response.
5876responseMaxIndex :: Int
59−responseMaxIndex = 2
77+responseMaxIndex = fromEnum (maxBound :: ResponseHeaderIndex)
6078
6179responseKeyIndex :: HeaderName -> Int
62−responseKeyIndex "content-length" = idxContentLength
63−responseKeyIndex "server" = idxServer
64−responseKeyIndex "date" = idxDate
65−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
6688
6789----------------------------------------------------------------
6890
warp/Network/Wai/Handler/Warp/IO.hs+16−21
@@ -1,35 +1,30 @@
11{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE CPP #-}
23
34module Network.Wai.Handler.Warp.IO where
45
5−import Blaze.ByteString.Builder.Internal.Types (Builder(..), BuildSignal(..), BufRange(..), runBuildStep, buildStep)
6−import Data.ByteString.Internal (ByteString(..))
7−import Foreign.ForeignPtr (newForeignPtr_)
8−import Foreign.Ptr (plusPtr, minusPtr)
6+import Data.ByteString.Builder (Builder)
7+import Data.ByteString.Builder.Extra (runBuilder, Next(Done, More, Chunk))
8+
99import Network.Wai.Handler.Warp.Buffer
10+import Network.Wai.Handler.Warp.Imports
11+import Network.Wai.Handler.Warp.Types
1012
1113toBufIOWith :: Buffer -> BufSize -> (ByteString -> IO ()) -> Builder -> IO ()
12−toBufIOWith buf !size io (Builder build) = loop firstStep
14+toBufIOWith buf !size io builder = loop firstWriter
1315 where
14− firstStep = build (buildStep finalStep)
15− finalStep (BufRange p _) = return $ Done p ()
16− bufRange = BufRange buf (buf `plusPtr` size)
17− runIO ptr = toBS buf (ptr `minusPtr` buf) >>= io
18− loop step = do
19− signal <- runBuildStep step bufRange
16+ firstWriter = runBuilder builder
17+ runIO len = bufferIO buf len io
18+ loop writer = do
19+ (len, signal) <- writer buf size
2020 case signal of
21− Done ptr _ -> runIO ptr
22− BufferFull minSize ptr next
21+ Done -> runIO len
22+ More minSize next
2323 | size < minSize -> error "toBufIOWith: BufferFull: minSize"
2424 | otherwise -> do
25− runIO ptr
25+ runIO len
2626 loop next
27− InsertByteString ptr bs next -> do
28− runIO ptr
27+ Chunk bs next -> do
28+ runIO len
2929 io bs
3030 loop next
31−
32−toBS :: Buffer -> Int -> IO ByteString
33−toBS ptr siz = do
34− fptr <- newForeignPtr_ ptr
35− return $ PS fptr 0 siz
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+82−17
@@ -1,21 +1,86 @@
11{-# OPTIONS_GHC -fno-warn-deprecations #-}
2−module Network.Wai.Handler.Warp.Internal
3− ( Settings (..)
4− , getOnOpen
5− , getOnClose
6− , getOnException
7− ) where
82
9−import Network.Wai.Handler.Warp.Settings (Settings (..))
10−import Network.Socket (SockAddr)
11−import Network.Wai (Request)
12−import Control.Exception (SomeException)
3+module Network.Wai.Handler.Warp.Internal (
4+ -- * Settings
5+ Settings (..)
6+ , ProxyProtocol(..)
7+ -- * Low level run functions
8+ , runSettingsConnection
9+ , runSettingsConnectionMaker
10+ , runSettingsConnectionMakerSecure
11+ , Transport (..)
12+ -- * Connection
13+ , Connection (..)
14+ , socketConnection
15+ -- ** Receive
16+ , Recv
17+ , RecvBuf
18+ , makePlainReceiveN
19+ -- ** Buffer
20+ , Buffer
21+ , BufSize
22+ , bufferSize
23+ , allocateBuffer
24+ , freeBuffer
25+ , copy
26+ -- ** Sendfile
27+ , FileId (..)
28+ , SendFile
29+ , sendFile
30+ , readSendFile
31+ -- * Version
32+ , warpVersion
33+ -- * Data types
34+ , InternalInfo (..)
35+ , HeaderValue
36+ , IndexedHeader
37+ , requestMaxIndex
38+ -- * Time out manager
39+ -- |
40+ --
41+ -- In order to provide slowloris protection, Warp provides timeout handlers. We
42+ -- follow these rules:
43+ --
44+ -- * A timeout is created when a connection is opened.
45+ --
46+ -- * When all request headers are read, the timeout is tickled.
47+ --
48+ -- * Every time at least the slowloris size settings number of bytes of the request
49+ -- body are read, the timeout is tickled.
50+ --
51+ -- * The timeout is paused while executing user code. This will apply to both
52+ -- the application itself, and a ResponseSource response. The timeout is
53+ -- resumed as soon as we return from user code.
54+ --
55+ -- * Every time data is successfully sent to the client, the timeout is tickled.
56+ , module System.TimeManager
57+ -- * File descriptor cache
58+ , module Network.Wai.Handler.Warp.FdCache
59+ -- * File information cache
60+ , module Network.Wai.Handler.Warp.FileInfoCache
61+ -- * Date
62+ , module Network.Wai.Handler.Warp.Date
63+ -- * Request and response
64+ , Source
65+ , recvRequest
66+ , sendResponse
67+ -- * Platform dependent helper functions
68+ , setSocketCloseOnExec
69+ , windowsThreadBlockHack
70+ ) where
1371
14−getOnOpen :: Settings -> SockAddr -> IO Bool
15−getOnOpen = settingsOnOpen
72+import System.TimeManager
1673
17−getOnClose :: Settings -> SockAddr -> IO ()
18−getOnClose = settingsOnClose
19−
20−getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
21−getOnException = settingsOnException
74+import Network.Wai.Handler.Warp.Buffer
75+import Network.Wai.Handler.Warp.Date
76+import Network.Wai.Handler.Warp.FdCache
77+import Network.Wai.Handler.Warp.FileInfoCache
78+import Network.Wai.Handler.Warp.Header
79+import Network.Wai.Handler.Warp.Recv
80+import Network.Wai.Handler.Warp.Request
81+import Network.Wai.Handler.Warp.Response
82+import Network.Wai.Handler.Warp.Run
83+import Network.Wai.Handler.Warp.SendFile
84+import Network.Wai.Handler.Warp.Settings
85+import Network.Wai.Handler.Warp.Types
86+import Network.Wai.Handler.Warp.Windows
warp/Network/Wai/Handler/Warp/MultiMap.hs+66−191
@@ -1,236 +1,111 @@
1+{-# LANGUAGE BangPatterns #-}
2+
13module Network.Wai.Handler.Warp.MultiMap (
2− MMap
3− , Some(..)
4+ MultiMap
5+ , isEmpty
46 , empty
57 , singleton
68 , insert
7− , search
8− , searchWith
9− , isEmpty
10− , valid
9+ , Network.Wai.Handler.Warp.MultiMap.lookup
1110 , pruneWith
12− , fromList
1311 , toList
14− , fromSortedList
15− , toSortedList
1612 , merge
1713 ) where
1814
19−import Control.Applicative ((<$>))
20−import Data.List (foldl')
21−
22−----------------------------------------------------------------
23−
24−-- | One ore more list to implement multimap.
25−data Some a = One !a
26− | Tom !a !(Some a) -- Two or more
27− deriving (Eq,Show)
28−
29−-- This is slow but assuming rarely used.
30−snoc :: Some a -> a -> Some a
31−snoc (One x) y = Tom x (One y)
32−snoc (Tom x xs) y = Tom x (snoc xs y)
33−
34−top :: Some a -> a
35−top (One x) = x
36−top (Tom x _) = x
37−
38−----------------------------------------------------------------
39−
40−-- | Red black tree as multimap.
41−data MMap k v = Leaf -- color is Black
42− | Node Color !(MMap k v) !k !(Some v) !(MMap k v)
43− deriving (Show)
44−
45−data Color = B -- ^ Black
46− | R -- ^ Red
47− deriving (Eq, Show)
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
4820
4921----------------------------------------------------------------
5022
51−instance (Eq k, Eq v) => Eq (MMap k v) where
52− t1 == t2 = toSortedList t1 == toSortedList t2
53−
54−----------------------------------------------------------------
55−
56−-- | O(log N)
57−search :: Ord k => k -> MMap k v -> Maybe v
58−search _ Leaf = Nothing
59−search xk (Node _ l k v r) = case compare xk k of
60− LT -> search xk l
61− GT -> search xk r
62− EQ -> Just $ top v
63−
64−-- | O(log N)
65−searchWith :: Ord k => k -> (Some v -> Maybe v) -> MMap k v -> Maybe v
66−searchWith _ _ Leaf = Nothing
67−searchWith xk f (Node _ l k v r) = case compare xk k of
68− LT -> searchWith xk f l
69− GT -> searchWith xk f r
70− EQ -> f v
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)])
7133
7234----------------------------------------------------------------
7335
7436-- | O(1)
75−isEmpty :: MMap k v -> Bool
76−isEmpty Leaf = True
77−isEmpty _ = False
37+empty :: MultiMap v
38+empty = MultiMap $ I.empty
7839
7940-- | O(1)
80−empty :: MMap k v
81−empty = Leaf
41+isEmpty :: MultiMap v -> Bool
42+isEmpty (MultiMap mm) = I.null mm
8243
8344----------------------------------------------------------------
8445
8546-- | O(1)
86−singleton :: Ord k => k -> v -> MMap k v
87−singleton k v = Node B Leaf k (One v) Leaf
88−
89−----------------------------------------------------------------
90−
91−-- | O(log N)
92−insert :: Ord k => k -> v -> MMap k v -> MMap k v
93−insert kx kv t = turnB (insert' kx kv t)
94−
95−insert' :: Ord k => k -> v -> MMap k v -> MMap k v
96−insert' xk xv Leaf = Node R Leaf xk (One xv) Leaf
97−insert' xk xv (Node B l k v r) = case compare xk k of
98− LT -> balanceL' (insert' xk xv l) k v r
99− GT -> balanceR' l k v (insert' xk xv r)
100− EQ -> Node B l k (snoc v xv) r
101−insert' xk xv (Node R l k v r) = case compare xk k of
102− LT -> Node R (insert' xk xv l) k v r
103− GT -> Node R l k v (insert' xk xv r)
104− EQ -> Node R l k (snoc v xv) r
105−
106−balanceL' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
107−balanceL' (Node R (Node R a xk xv b) yk yv c) zk zv d =
108− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
109−balanceL' (Node R a xk xv (Node R b yk yv c)) zk zv d =
110− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
111−balanceL' l k v r = Node B l k v r
112−
113−balanceR' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
114−balanceR' a xk xv (Node R b yk yv (Node R c zk zv d)) =
115− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
116−balanceR' a xk xv (Node R (Node R b yk yv c) zk zv d) =
117− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
118−balanceR' l xk xv r = Node B l xk xv r
119−
120−turnB :: MMap k v -> MMap k v
121−turnB Leaf = error "turnB"
122−turnB (Node _ l k v r) = Node B l k v r
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)]
12352
12453----------------------------------------------------------------
12554
126−-- | O(N log N)
127−fromList :: Ord k => [(k,v)] -> MMap k v
128−fromList = foldl' (\t (k,v) -> insert k v t) empty
129−
13055-- | O(N)
131−toList :: MMap k v -> [(k,v)]
132−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
13360 where
134− inorder Leaf xs = xs
135− inorder (Node _ l k v r) xs = inorder l (pairs k v ++ inorder r xs)
136− pairs k (One v) = [(k,v)]
137− pairs k (Tom v vs) = (k,v) : pairs k vs
61+ !h = hash path
13862
13963----------------------------------------------------------------
14064
141−-- | O(N)
142−-- "Constructing Red-Black Trees" by Ralf Hinze
143−fromSortedList :: Ord k => [(k,Some v)] -> MMap k v
144−fromSortedList = linkAll . foldr add []
145−
146−data Digit k v = Uno k (Some v) (MMap k v)
147− | Due k (Some v) (MMap k v) k (Some v) (MMap k v)
148− deriving (Eq,Show)
149−
150−incr :: Digit k v -> [Digit k v] -> [Digit k v]
151−incr (Uno k v t) [] = [Uno k v t]
152−incr (Uno k1 v1 t1) (Uno k2 v2 t2 : ps) = Due k1 v1 t1 k2 v2 t2 : ps
153−incr (Uno k1 v1 t1) (Due k2 v2 t2 k3 v3 t3 : ps) = Uno k1 v1 t1 : incr (Uno k2 v2 (Node B t2 k3 v3 t3)) ps
154−incr _ _ = error "incr"
155−
156−add :: (k,Some v) -> [Digit k v] -> [Digit k v]
157−add (k,v) ps = incr (Uno k v Leaf) ps
158−
159−linkAll :: [Digit k v] -> MMap k v
160−linkAll = foldl' link Leaf
161−
162−link :: MMap k v -> Digit k v -> MMap k v
163−link l (Uno k v t) = Node B l k v t
164−--link l (Due k1 v1 t1 k2 v2 t2) = Node B (Node R l k1 v1 t1) k2 v2 t2
165−link l (Due k1 v1 t1 k2 v2 t2) = Node B l k1 v1 (Node R t1 k2 v2 t2)
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
16671
16772----------------------------------------------------------------
16873
169−-- | O(N)
170−toSortedList :: MMap k v -> [(k,Some v)]
171−toSortedList t = inorder t []
172− where
173− inorder Leaf xs = xs
174− 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
17577
17678----------------------------------------------------------------
17779
178−-- | O(N)
179−pruneWith :: Ord k =>
180− MMap k v
181− -> (k -> Some v -> IO [(k, Some v)])
182− -> IO (MMap k v)
183−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'
18485 where
185− inorder Leaf xs = return xs
186− inorder (Node _ l k v r) xs = do
187− ys <- run k v
188− zs <- inorder r xs
189− 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)
19093
19194----------------------------------------------------------------
19295
193−-- O(N log N) where N is the size of the second argument
194−merge :: Ord k => MMap k v -> MMap k v -> MMap k v
195−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
19699 where
197− ins t (k,v) = insert k v t
198− xs = toList m
100+ !mm = I.unionWith (<>) m1 m2
199101
200102----------------------------------------------------------------
201−-- for testing
202−
203−valid :: Ord k => MMap k v -> Bool
204−valid t = isBalanced t && isOrdered t
205103
206−isBalanced :: MMap k v -> Bool
207−isBalanced t = isBlackSame t && isRedSeparate t
208−
209−isBlackSame :: MMap k v -> Bool
210−isBlackSame t = all (n==) ns
211− where
212− n:ns = blacks t
213−
214−blacks :: MMap k v -> [Int]
215−blacks = blacks' 0
216− where
217− blacks' n Leaf = [n+1]
218− blacks' n (Node R l _ _ r) = blacks' n l ++ blacks' n r
219− blacks' n (Node B l _ _ r) = blacks' n' l ++ blacks' n' r
220− where
221− n' = n + 1
222−
223−isRedSeparate :: MMap k v -> Bool
224−isRedSeparate = reds B
225−
226−reds :: Color -> MMap k v -> Bool
227−reds _ Leaf = True
228−reds R (Node R _ _ _ _) = False
229−reds _ (Node c l _ _ r) = reds c l && reds c r
230−
231−isOrdered :: Ord k => MMap k v -> Bool
232−isOrdered t = ordered $ toSortedList t
104+prune :: ((FilePath,v) -> IO Bool) -> [(FilePath,v)] -> IO [(FilePath,v)]
105+prune action xs0 = go xs0
233106 where
234− ordered [] = True
235− ordered [_] = True
236− 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+121−31
@@ -1,23 +1,35 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
1+{-# LANGUAGE ForeignFunctionInterface, OverloadedStrings #-}
22{-# LANGUAGE CPP #-}
33
44module Network.Wai.Handler.Warp.Recv (
55 receive
6+ , receiveBuf
7+ , makeReceiveN
8+ , makePlainReceiveN
9+ , spell
610 ) where
711
8−import Control.Applicative ((<$>))
9−import Control.Monad (void)
10−import qualified Data.ByteString as BS (empty)
11−import Data.ByteString.Internal (ByteString(..), mallocByteString)
12−import Data.Word (Word8)
12+import qualified Control.Exception as E
13+import qualified Data.ByteString as BS
14+import Data.IORef
1315import Foreign.C.Error (eAGAIN, getErrno, throwErrno)
1416import Foreign.C.Types
1517import Foreign.ForeignPtr (withForeignPtr)
16−import Foreign.Ptr (Ptr, castPtr)
18+import Foreign.Ptr (Ptr, castPtr, plusPtr)
1719import GHC.Conc (threadWaitRead)
18−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
1928import System.Posix.Types (Fd(..))
29+
2030import Network.Wai.Handler.Warp.Buffer
31+import Network.Wai.Handler.Warp.Imports
32+import Network.Wai.Handler.Warp.Types
2133
2234#ifdef mingw32_HOST_OS
2335import GHC.IO.FD (FD(..), readRawBufferPtr)
@@ -26,45 +38,123 @@ import Network.Wai.Handler.Warp.Windows
2638
2739----------------------------------------------------------------
2840
29−receive :: Socket -> Buffer -> Int -> IO ByteString
30−receive sock buf size = do
31− bytes <- fromIntegral <$> receiveloop sock' buf' size'
32− if bytes == 0 then
33− return BS.empty
34− else do
35− fptr <- mallocByteString bytes
36− void $ withForeignPtr fptr $ \ptr ->
37− c_memcpy ptr buf (fromIntegral bytes)
38− return $! PS fptr 0 bytes
41+makeReceiveN :: ByteString -> Recv -> RecvBuf -> IO (BufSize -> IO ByteString)
42+makeReceiveN bs0 recv recvBuf = do
43+ ref <- newIORef bs0
44+ return $ receiveN ref recv recvBuf
45+
46+-- | This function returns a receiving function
47+-- based on two receiving functions.
48+-- The returned function efficiently manages received data
49+-- which is initialized by the first argument.
50+-- The returned function may allocate a byte string with malloc().
51+makePlainReceiveN :: Socket -> ByteString -> IO (BufSize -> IO ByteString)
52+makePlainReceiveN s bs0 = do
53+ ref <- newIORef bs0
54+ pool <- newBufferPool
55+ return $ receiveN ref (receive s pool) (receiveBuf s)
56+
57+receiveN :: IORef ByteString -> Recv -> RecvBuf -> BufSize -> IO ByteString
58+receiveN ref recv recvBuf size = E.handle handler $ do
59+ cached <- readIORef ref
60+ (bs, leftover) <- spell cached size recv recvBuf
61+ writeIORef ref leftover
62+ return bs
63+ where
64+ handler :: E.SomeException -> IO ByteString
65+ handler _ = return ""
66+
67+----------------------------------------------------------------
68+
69+spell :: ByteString -> BufSize -> IO ByteString -> RecvBuf -> IO (ByteString, ByteString)
70+spell init0 siz0 recv recvBuf
71+ | siz0 <= len0 = return $ BS.splitAt siz0 init0
72+ -- fixme: hard coding 4096
73+ | siz0 <= 4096 = loop [init0] (siz0 - len0)
74+ | otherwise = do
75+ bs@(PS fptr _ _) <- mallocBS siz0
76+ withForeignPtr fptr $ \ptr -> do
77+ ptr' <- copy ptr init0
78+ full <- recvBuf ptr' (siz0 - len0)
79+ if full then
80+ return (bs, "")
81+ else
82+ return ("", "") -- fixme
3983 where
40− sock' = fdSocket sock
41− buf' = castPtr buf
42− size' = fromIntegral size
84+ len0 = BS.length init0
85+ loop bss siz = do
86+ bs <- recv
87+ let len = BS.length bs
88+ if len == 0 then
89+ return ("", "")
90+ else if len >= siz then do
91+ let (consume, leftover) = BS.splitAt siz bs
92+ ret = BS.concat $ reverse (consume : bss)
93+ return (ret, leftover)
94+ else do
95+ let bss' = bs : bss
96+ siz' = siz - len
97+ loop bss' siz'
4398
44−#ifdef mingw32_HOST_OS
45−receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
99+-- The timeout manager may close the socket.
100+-- In that case, an error of "Bad file descriptor" occurs.
101+-- We ignores it because we expect TimeoutThread.
102+receive :: Socket -> BufferPool -> Recv
103+receive sock pool = E.handle handler $ withBufferPool pool $ \ (ptr, size) -> do
104+#if MIN_VERSION_network(3,1,0)
105+ withFdSocket sock $ \fd -> do
106+#elif MIN_VERSION_network(3,0,0)
107+ fd <- fdSocket sock
46108#else
47−receiveloop :: CInt -> Ptr CChar -> CSize -> IO CInt
109+ let fd = fdSocket sock
48110#endif
49−receiveloop sock buf size = do
111+ let size' = fromIntegral size
112+ fromIntegral <$> receiveloop fd ptr size'
113+ where
114+ handler :: E.IOException -> IO ByteString
115+ handler e
116+ | E.ioeGetErrorType e == E.InvalidArgument = return ""
117+ | otherwise = E.throwIO e
118+
119+receiveBuf :: Socket -> RecvBuf
120+receiveBuf sock buf0 siz0 = do
121+#if MIN_VERSION_network(3,1,0)
122+ withFdSocket sock $ \fd -> do
123+#elif MIN_VERSION_network(3,0,0)
124+ fd <- fdSocket sock
125+#else
126+ let fd = fdSocket sock
127+#endif
128+ loop fd buf0 siz0
129+ where
130+ loop _ _ 0 = return True
131+ loop fd buf siz = do
132+ n <- fromIntegral <$> receiveloop fd buf (fromIntegral siz)
133+ -- fixme: what should we do in the case of n == 0
134+ if n == 0 then
135+ return False
136+ else
137+ loop fd (buf `plusPtr` n) (siz - n)
138+
139+receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
140+receiveloop sock ptr size = do
50141#ifdef mingw32_HOST_OS
51− bytes <- windowsThreadBlockHack $ fmap fromIntegral $ readRawBufferPtr "recv" (FD sock 1) buf 0 size
142+ bytes <- windowsThreadBlockHack $ fromIntegral <$> readRawBufferPtr "recv" (FD sock 1) (castPtr ptr) 0 size
52143#else
53− bytes <- c_recv sock buf size 0
144+ bytes <- c_recv sock (castPtr ptr) size 0
54145#endif
55146 if bytes == -1 then do
56147 errno <- getErrno
57148 if errno == eAGAIN then do
58149 threadWaitRead (Fd sock)
59− receiveloop sock buf size
150+ receiveloop sock ptr size
60151 else
61152 throwErrno "receiveloop"
62153 else
63154 return bytes
64155
156+#ifndef mingw32_HOST_OS
65157-- fixme: the type of the return value
66158foreign import ccall unsafe "recv"
67159 c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt
68−
69−foreign import ccall unsafe "string.h memcpy"
70− c_memcpy :: Ptr Word8 -> Ptr Word8 -> CSize -> IO (Ptr Word8)
160+#endif
warp/Network/Wai/Handler/Warp/Request.hs+100−46
@@ -1,96 +1,120 @@
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 (
78 recvRequest
89 , headerLines
10+ , pauseTimeoutKey
11+ , getFileInfoKey
12+ , getClientCertificateKey
13+ , NoKeepAliveRequest (..)
914 ) where
1015
1116import qualified Control.Concurrent as Conc (yield)
12−import Control.Exception (throwIO)
17+import Control.Exception (throwIO, Exception)
1318import Data.Array ((!))
14−import Data.ByteString (ByteString)
1519import qualified Data.ByteString as S
1620import qualified Data.ByteString.Unsafe as SU
1721import qualified Data.CaseInsensitive as CI
1822import qualified Data.IORef as I
19−import Data.Monoid (mempty)
23+import Data.Typeable (Typeable)
24+import qualified Data.Vault.Lazy as Vault
25+import Data.X509
2026import qualified Network.HTTP.Types as H
2127import Network.Socket (SockAddr)
2228import Network.Wai
23−import Network.Wai.Handler.Warp.Conduit
24−import Network.Wai.Handler.Warp.Header
25−import Network.Wai.Handler.Warp.ReadInt
26−import Network.Wai.Handler.Warp.RequestHeader
27−import Network.Wai.Handler.Warp.Settings (Settings, settingsNoParsePath)
28−import qualified Network.Wai.Handler.Warp.Timeout as Timeout
2929import Network.Wai.Handler.Warp.Types
3030import Network.Wai.Internal
3131import Prelude hiding (lines)
32−import Control.Monad (when)
32+import System.IO.Unsafe (unsafePerformIO)
33+import qualified System.TimeManager as Timeout
3334
34−----------------------------------------------------------------
35−
36−-- FIXME come up with good values here
37−maxTotalHeaderLength :: Int
38−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)
3942
4043----------------------------------------------------------------
4144
4245-- | Receiving a HTTP request from 'Connection' and parsing its header
4346-- to create 'Request'.
44−recvRequest :: Settings
47+recvRequest :: Bool -- ^ first request on this connection?
48+ -> Settings
4549 -> Connection
4650 -> InternalInfo
51+ -> Timeout.Handle
4752 -> SockAddr -- ^ Peer's address.
4853 -> Source -- ^ Where HTTP request comes from.
54+ -> Transport
4955 -> IO (Request
5056 ,Maybe (I.IORef Int)
51− ,IndexedHeader) -- ^
57+ ,IndexedHeader
58+ ,IO ByteString) -- ^
5259 -- 'Request' passed to 'Application',
5360 -- how many bytes remain to be consumed, if known
5461 -- 'IndexedHeader' of HTTP request for internal use,
62+ -- Body producing action used for flushing the request body
5563
56−recvRequest settings conn ii addr src = do
57− hdrlines <- headerLines src
64+recvRequest firstRequest settings conn ii th addr src transport = do
65+ hdrlines <- headerLines (settingsMaxTotalHeaderLength settings) firstRequest src
5866 (method, unparsedPath, path, query, httpversion, hdr) <- parseHeaderLines hdrlines
5967 let idxhdr = indexRequestHeader hdr
60− expect = idxhdr ! idxExpect
61− cl = idxhdr ! idxContentLength
62− te = idxhdr ! idxTransferEncoding
63− handleExpect conn httpversion expect
68+ expect = idxhdr ! fromEnum ReqExpect
69+ cl = idxhdr ! fromEnum ReqContentLength
70+ te = idxhdr ! fromEnum ReqTransferEncoding
71+ handle100Continue = handleExpect conn httpversion expect
72+ rawPath = if settingsNoParsePath settings then unparsedPath else path
73+ vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
74+ $ Vault.insert getFileInfoKey (getFileInfo ii)
75+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
76+ Vault.empty
6477 (rbody, remainingRef, bodyLength) <- bodyAndSource src cl te
65− rbody' <- timeoutBody th rbody
78+ -- body producing function which will produce '100-continue', if needed
79+ rbody' <- timeoutBody remainingRef th rbody handle100Continue
80+ -- body producing function which will never produce 100-continue
81+ rbodyFlush <- timeoutBody remainingRef th rbody (return ())
6682 let req = Request {
6783 requestMethod = method
6884 , httpVersion = httpversion
6985 , pathInfo = H.decodePathSegments path
70− , rawPathInfo = if settingsNoParsePath settings then unparsedPath else path
86+ , rawPathInfo = rawPath
7187 , rawQueryString = query
7288 , queryString = H.parseQuery query
7389 , requestHeaders = hdr
74− , isSecure = False
90+ , isSecure = isTransportSecure transport
7591 , remoteHost = addr
7692 , requestBody = rbody'
77− , vault = mempty
93+ , vault = vaultValue
7894 , requestBodyLength = bodyLength
79− , requestHeaderHost = idxhdr ! idxHost
80− , requestHeaderRange = idxhdr ! idxRange
95+ , requestHeaderHost = idxhdr ! fromEnum ReqHost
96+ , requestHeaderRange = idxhdr ! fromEnum ReqRange
97+ , requestHeaderReferer = idxhdr ! fromEnum ReqReferer
98+ , requestHeaderUserAgent = idxhdr ! fromEnum ReqUserAgent
8199 }
82− return (req, remainingRef, idxhdr)
83− where
84− th = threadHandle ii
100+ return (req, remainingRef, idxhdr, rbodyFlush)
85101
86102----------------------------------------------------------------
87103
88−headerLines :: Source -> IO [ByteString]
89−headerLines src = do
104+headerLines :: Int -> Bool -> Source -> IO [ByteString]
105+headerLines maxTotalHeaderLength firstRequest src = do
90106 bs <- readSource src
91107 if S.null bs
92− then throwIO $ NotEnoughLines []
93− 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
94118
95119----------------------------------------------------------------
96120
@@ -138,18 +162,35 @@ isChunked _ = False
138162
139163----------------------------------------------------------------
140164
141−timeoutBody :: Timeout.Handle -> IO ByteString -> IO (IO ByteString)
142−timeoutBody timeoutHandle rbody = do
165+timeoutBody :: Maybe (I.IORef Int) -- ^ remaining
166+ -> Timeout.Handle
167+ -> IO ByteString
168+ -> IO ()
169+ -> IO (IO ByteString)
170+timeoutBody remainingRef timeoutHandle rbody handle100Continue = do
143171 isFirstRef <- I.newIORef True
144172
173+ let checkEmpty =
174+ case remainingRef of
175+ Nothing -> return . S.null
176+ Just ref -> \bs -> if S.null bs
177+ then return True
178+ else do
179+ x <- I.readIORef ref
180+ return $! x <= 0
181+
145182 return $ do
146183 isFirst <- I.readIORef isFirstRef
147184
148− when isFirst $
185+ when isFirst $ do
186+ -- Only check if we need to produce the 100 Continue status
187+ -- when asking for the first chunk of the body
188+ handle100Continue
149189 -- Timeout handling was paused after receiving the full request
150190 -- headers. Now we need to resume it to avoid a slowloris
151191 -- attack during request body sending.
152192 Timeout.resume timeoutHandle
193+ I.writeIORef isFirstRef False
153194
154195 bs <- rbody
155196
@@ -157,7 +198,8 @@ timeoutBody timeoutHandle rbody = do
157198 -- because the application is not interested in more bytes, or
158199 -- because there is no more data available, pause the timeout
159200 -- handler again.
160− when (S.null bs) (Timeout.pause timeoutHandle)
201+ isEmpty <- checkEmpty bs
202+ when isEmpty (Timeout.pause timeoutHandle)
161203
162204 return bs
163205
@@ -178,8 +220,8 @@ close :: Sink ByteString IO a
178220close = throwIO IncompleteHeaders
179221-}
180222
181−push :: Source -> THStatus -> ByteString -> IO [ByteString]
182−push src (THStatus len lines prepend) bs'
223+push :: Int -> Source -> THStatus -> ByteString -> IO [ByteString]
224+push maxTotalHeaderLength src (THStatus len lines prepend) bs'
183225 -- Too many bytes
184226 | len > maxTotalHeaderLength = throwIO OverLargeHeader
185227 | otherwise = push' mnl
@@ -207,13 +249,13 @@ push src (THStatus len lines prepend) bs'
207249 push' Nothing = do
208250 bst <- readSource' src
209251 when (S.null bst) $ throwIO IncompleteHeaders
210− push src status bst
252+ push maxTotalHeaderLength src status bst
211253 where
212254 len' = len + bsLen
213255 prepend' = S.append bs
214256 status = THStatus len' lines prepend'
215257 -- Found a newline, but next line continues as a multiline header
216− push' (Just (end, True)) = push src status rest
258+ push' (Just (end, True)) = push maxTotalHeaderLength src status rest
217259 where
218260 rest = S.drop (end + 1) bs
219261 prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
@@ -232,12 +274,12 @@ push src (THStatus len lines prepend) bs'
232274 in if start < bsLen then
233275 -- more bytes in this chunk, push again
234276 let bs'' = SU.unsafeDrop start bs
235− in push src status bs''
277+ in push maxTotalHeaderLength src status bs''
236278 else do
237279 -- no more bytes in this chunk, ask for more
238280 bst <- readSource' src
239281 when (S.null bs) $ throwIO IncompleteHeaders
240− push src status bst
282+ push maxTotalHeaderLength src status bst
241283 where
242284 start = end + 1 -- start of next chunk
243285 line = SU.unsafeTake (checkCR bs end) bs
@@ -247,3 +289,15 @@ checkCR :: ByteString -> Int -> Int
247289checkCR bs pos = if pos > 0 && 13 == S.index bs p then p else pos -- 13 is CR
248290 where
249291 !p = pos - 1
292+
293+pauseTimeoutKey :: Vault.Key (IO ())
294+pauseTimeoutKey = unsafePerformIO Vault.newKey
295+{-# NOINLINE pauseTimeoutKey #-}
296+
297+getFileInfoKey :: Vault.Key (FilePath -> IO FileInfo)
298+getFileInfoKey = unsafePerformIO Vault.newKey
299+{-# NOINLINE getFileInfoKey #-}
300+
301+getClientCertificateKey :: Vault.Key (Maybe CertificateChain)
302+getClientCertificateKey = unsafePerformIO Vault.newKey
303+{-# NOINLINE getClientCertificateKey #-}
warp/Network/Wai/Handler/Warp/RequestHeader.hs+16−43
@@ -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, readInteger)
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 qualified Network.HTTP.Types.Header as HH
19+
2220-- $setup
2321-- >>> :set -XOverloadedStrings
2422
@@ -51,6 +49,8 @@ parseHeaderLines (firstLine:otherLines) = do
5149-- *** Exception: Warp: Invalid first line of request: "GET "
5250-- >>> parseRequestLine "GET /NotHTTP UNKNOWN/1.1"
5351-- *** Exception: Warp: Request line specified a non-HTTP request
52+-- >>> parseRequestLine "PRI * HTTP/2.0"
53+-- ("PRI","*","",HTTP/2.0)
5454parseRequestLine :: ByteString
5555 -> IO (H.Method
5656 ,ByteString -- Path
@@ -88,7 +88,7 @@ parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> d
8888
8989 return (method,path,query,hv)
9090 where
91− baderr = BadFirstLine $ B.unpack requestLine
91+ baderr = BadFirstLine $ C8.unpack requestLine
9292 check :: Ptr Word8 -> Int -> Word8 -> IO ()
9393 check p n w = do
9494 w0 <- peek $ p `plusPtr` n
@@ -101,12 +101,13 @@ parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> d
101101 check httpptr 4 47 -- '/'
102102 check httpptr 6 46 -- '.'
103103 httpVersion httpptr = do
104− major <- peek $ httpptr `plusPtr` 5
105− minor <- peek $ httpptr `plusPtr` 7
106− return $ if major == (49 :: Word8) && minor == (49 :: Word8) then
107− H.http11
108− else
109− H.http10
104+ major <- peek (httpptr `plusPtr` 5) :: IO Word8
105+ minor <- peek (httpptr `plusPtr` 7) :: IO Word8
106+ let version
107+ | major == 49 = if minor == 49 then H.http11 else H.http10
108+ | major == 50 && minor == 48 = H.HttpVersion 2 0
109+ | otherwise = H.http10
110+ return version
110111 bs ptr p0 p1 = PS fptr o l
111112 where
112113 o = p0 `minusPtr` ptr
@@ -127,34 +128,6 @@ parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> d
127128
128129parseHeader :: ByteString -> H.Header
129130parseHeader s =
130− let (k, rest) = S.breakByte 58 s -- ':'
131+ let (k, rest) = S.break (== 58) s -- ':'
131132 rest' = S.dropWhile (\c -> c == 32 || c == 9) $ S.drop 1 rest
132133 in (CI.mk k, rest')
133−
134−parseByteRanges :: S.ByteString -> Maybe HH.ByteRanges
135−parseByteRanges bs1 = do
136− bs2 <- stripPrefix "bytes=" bs1
137− (r, bs3) <- range bs2
138− ranges (r:) bs3
139− where
140− range bs2 =
141− case stripPrefix "-" bs2 of
142− Just bs3 -> do
143− (i, bs4) <- B.readInteger bs3
144− Just (HH.ByteRangeSuffix i, bs4)
145− Nothing -> do
146− (i, bs3) <- B.readInteger bs2
147− bs4 <- stripPrefix "-" bs3
148− case B.readInteger bs4 of
149− Nothing -> Just (HH.ByteRangeFrom i, bs4)
150− Just (j, bs5) -> Just (HH.ByteRangeFromTo i j, bs5)
151− ranges front bs3 =
152− case stripPrefix "," bs3 of
153− Nothing -> Just (front [])
154− Just bs4 -> do
155− (r, bs5) <- range bs4
156− ranges (front . (r:)) bs5
157−
158− stripPrefix x y
159− | x `S.isPrefixOf` y = Just (S.drop (S.length x) y)
160− | otherwise = Nothing
warp/Network/Wai/Handler/Warp/Response.hs+219−205
@@ -1,126 +1,60 @@
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
9− , fileRange -- for testing
9+ , sanitizeHeaderValue -- for testing
1010 , warpVersion
11− , defaultServerValue
11+ , hasBody
12+ , replaceHeader
13+ , addServer -- testing
1214 ) where
1315
14−#ifndef MIN_VERSION_base
15−#define MIN_VERSION_base(x,y,z) 1
16−#endif
17−
18−import Blaze.ByteString.Builder (fromByteString, Builder, flush)
19−import Blaze.ByteString.Builder.HTTP (chunkedTransferEncoding, chunkedTransferTerminator)
20−import Control.Applicative
21−import Control.Exception
16+import Data.ByteString.Builder.HTTP.Chunked (chunkedTransferEncoding, chunkedTransferTerminator)
17+import qualified Control.Exception as E
2218import Data.Array ((!))
23−import Data.ByteString (ByteString)
24−import Data.Streaming.Blaze (newBlazeRecv, reuseBufferStrategy)
2519import qualified Data.ByteString as S
26−import Control.Monad (unless, when)
27−import qualified Data.ByteString.Char8 as B (pack)
20+import Data.ByteString.Builder (byteString, Builder)
21+import Data.ByteString.Builder.Extra (flush)
22+import qualified Data.ByteString.Char8 as C8
2823import qualified Data.CaseInsensitive as CI
2924import Data.Function (on)
30−import Data.List (deleteBy)
31−import Data.Maybe (isJust, listToMaybe)
32−#if MIN_VERSION_base(4,5,0)
33−import Data.Monoid ((<>))
34−#else
35−import Data.Monoid (mappend)
36−#endif
25+import Data.Streaming.ByteString.Builder (newByteStringBuilderRecv, reuseBufferStrategy)
3726import Data.Version (showVersion)
27+import Data.Word8 (_cr, _lf)
3828import qualified Network.HTTP.Types as H
29+import qualified Network.HTTP.Types.Header as H
3930import Network.Wai
31+import Network.Wai.Internal
32+import qualified Paths_warp
33+import qualified System.TimeManager as T
34+
35+import Network.Wai.Handler.Warp.Buffer (toBuilderBuffer)
4036import qualified Network.Wai.Handler.Warp.Date as D
41−import Network.Wai.Handler.Warp.Buffer (toBlazeBuffer)
37+import Network.Wai.Handler.Warp.File
4238import Network.Wai.Handler.Warp.Header
4339import Network.Wai.Handler.Warp.IO (toBufIOWith)
40+import Network.Wai.Handler.Warp.Imports
4441import Network.Wai.Handler.Warp.ResponseHeader
45−import Network.Wai.Handler.Warp.RequestHeader (parseByteRanges)
46−import qualified Network.Wai.Handler.Warp.Timeout as T
42+import Network.Wai.Handler.Warp.Settings
4743import Network.Wai.Handler.Warp.Types
48−import Network.Wai.Internal
49−import Numeric (showInt)
50−import qualified Paths_warp
51−import qualified System.PosixCompat.Files as P
52−
53−#if !MIN_VERSION_base(4,5,0)
54−(<>) :: Monoid m => m -> m -> m
55−(<>) = mappend
56−#endif
5744
5845-- $setup
5946-- >>> :set -XOverloadedStrings
6047
61−mapRight :: (b -> c) -> Either a b -> Either a c
62−mapRight f eith = case eith of
63− Right x -> Right (f x)
64− Left l -> Left l
65−
66−----------------------------------------------------------------
67−
68−fileRange :: H.Status -> H.ResponseHeaders -> FilePath
69− -> Maybe FilePart -> Maybe HeaderValue
70− -> IO (Either IOException
71− (H.Status, H.ResponseHeaders, Integer, Integer))
72−fileRange s0 hs0 path mPart mRange =
73− mapRight (fileRangeSized . fromIntegral . P.fileSize) <$>
74− try (P.getFileStatus path)
75− where
76− fileRangeSized :: Integer -> (H.Status, H.ResponseHeaders, Integer, Integer)
77− fileRangeSized fileSize =
78− let (beg, end, len, isEntire) = checkPartRange fileSize mPart mRange
79− hs1 = addContentLength len hs0
80− hs | isEntire = hs1
81− | otherwise = addContentRange beg end fileSize hs1
82− s | isEntire = s0
83− | otherwise = H.status206
84− in (s, hs, beg, len)
85−
86−
87−checkPartRange :: Integer -> Maybe FilePart -> Maybe HeaderValue
88− -> (Integer, Integer, Integer, Bool)
89−checkPartRange fileSize = checkPart
90− where
91− checkPart Nothing Nothing = (0, fileSize - 1, fileSize, True)
92− checkPart Nothing (Just range) = case parseByteRanges range >>= listToMaybe of
93− -- Range is broken
94− Nothing -> (0, fileSize - 1, fileSize, True)
95− Just hrange -> checkRange hrange
96− -- Ignore Range if FilePart is specified.
97− -- We assume that an application handled Range and specified
98− -- FilePart.
99− checkPart (Just part) _ = (beg, end, len, isEntire)
100− where
101− beg = filePartOffset part
102− len = filePartByteCount part
103− end = beg + len - 1
104− isEntire = beg == 0 && len == fileSize
105−
106− checkRange (H.ByteRangeFrom beg) = fromRange beg (fileSize - 1)
107− checkRange (H.ByteRangeFromTo beg end) = fromRange beg end
108− checkRange (H.ByteRangeSuffix count) = fromRange (fileSize - count) (fileSize - 1)
109−
110− fromRange beg end = (beg, end, len, isEntire)
111− where
112− len = end - beg + 1
113− isEntire = beg == 0 && len == fileSize
114−
11548----------------------------------------------------------------
11649
11750-- | Sending a HTTP response to 'Connection' according to 'Response'.
11851--
119−-- Applications/middlewares MUST specify a proper 'H.ResponseHeaders'.
52+-- Applications/middlewares MUST provide a proper 'H.ResponseHeaders'.
12053-- so that inconsistency does not happen.
12154-- No header is deleted by this function.
12255--
123−-- Especially, Applications/middlewares MUST take care of
56+-- Especially, Applications/middlewares MUST provide a proper
57+-- Content-Type. They MUST NOT provide
12458-- Content-Length, Content-Range, and Transfer-Encoding
12559-- because they are inserted, when necessary,
12660-- regardless they already exist.
@@ -132,66 +66,91 @@ checkPartRange fileSize = checkPart
13266--
13367-- There are three basic APIs to create 'Response':
13468--
69+-- ['responseBuilder' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Builder' -> 'Response']
70+-- HTTP response body is created from 'Builder'.
71+-- Transfer-Encoding: chunked is used in HTTP/1.1.
72+--
73+-- ['responseStream' :: 'H.Status' -> 'H.ResponseHeaders' -> 'StreamingBody' -> 'Response']
74+-- HTTP response body is created from 'Builder'.
75+-- Transfer-Encoding: chunked is used in HTTP/1.1.
76+--
77+-- ['responseRaw' :: ('IO' 'ByteString' -> ('ByteString' -> 'IO' ()) -> 'IO' ()) -> 'Response' -> 'Response']
78+-- No header is added and no Transfer-Encoding: is applied.
79+--
13580-- ['responseFile' :: 'H.Status' -> 'H.ResponseHeaders' -> 'FilePath' -> 'Maybe' 'FilePart' -> 'Response']
136−-- HTTP response body is sent by sendfile().
137−-- Applications are categorized into simple and sophisticated.
138−-- Simple applications should specify 'Nothing' to
139−-- 'Maybe' 'FilePart'. The size of the specified file is obtained
140−-- by disk access. Then Range is handled.
141−-- Sophisticated applications should specify 'Just' to
142−-- 'Maybe' 'FilePart'. They should treat Range (and If-Range) by
143−-- thierselves. In both cases,
144−-- Content-Length and Content-Range (if necessary) are automatically
145−-- added into the HTTP response header.
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.
14685-- If Content-Length and Content-Range exist in the HTTP response header,
14786-- they would cause inconsistency.
148−-- Status is also changed to 206 if necessary.
87+-- \"Accept-Ranges: bytes\" is also inserted.
14988--
150−-- ['responseBuilder' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Builder' -> 'Response']
151−-- HTTP response body is created from 'Source'.
152−-- Typically, Transfer-Encoding: chunked is used.
153−-- If Content-Length is specified, Transfer-Encoding: chunked is not used.
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.
15493--
155−-- ['responseSource' :: 'H.Status' -> 'H.ResponseHeaders' -> 'Source' 'IO' ('Flush' 'Builder') -> 'Response']
156−-- HTTP response body is created from 'Builder'.
157−-- Typically, Transfer-Encoding: chunked is used.
158−-- If Content-Length is specified, Transfer-Encoding: chunked is not used.
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.
159100
160−sendResponse :: ByteString -- ^ default server value
101+sendResponse :: Settings
161102 -> Connection
162103 -> InternalInfo
104+ -> T.Handle
163105 -> Request -- ^ HTTP request.
164106 -> IndexedHeader -- ^ Indexed header of HTTP request.
165107 -> IO ByteString -- ^ source from client, for raw response
166108 -> Response -- ^ HTTP response including status code and response header.
167109 -> IO Bool -- ^ Returing True if the connection is persistent.
168−sendResponse defServer conn ii req reqidxhdr src response = do
110+sendResponse settings conn ii th req reqidxhdr src response = do
169111 hs <- addServerAndDate hs0
170− if hasBody s req then do
171− sendRsp conn ver s hs rsp
112+ if hasBody s then do
113+ -- The response to HEAD does not have body.
114+ -- But to handle the conditional requests defined RFC 7232 and
115+ -- to generate appropriate content-length, content-range,
116+ -- and status, the response to HEAD is processed here.
117+ --
118+ -- See definition of rsp below for proper body stripping.
119+ (ms, mlen) <- sendRsp conn ii ver s hs rspidxhdr rsp
120+ case ms of
121+ Nothing -> return ()
122+ Just realStatus -> logger req realStatus mlen
172123 T.tickle th
173124 return ret
174125 else do
175− sendResponseNoBody conn ver s hs
126+ _ <- sendRsp conn ii ver s hs rspidxhdr RspNoBody
127+ logger req s Nothing
176128 T.tickle th
177129 return isPersist
178130 where
131+ defServer = settingsServerName settings
132+ logger = settingsLogger settings
179133 ver = httpVersion req
180134 s = responseStatus response
181− hs0 = responseHeaders response
135+ hs0 = sanitizeHeaders $ responseHeaders response
182136 rspidxhdr = indexResponseHeader hs0
183− th = threadHandle ii
184− dc = dateCacher ii
185− addServerAndDate = addDate dc rspidxhdr . addServer defServer rspidxhdr
186− mRange = reqidxhdr ! idxRange
187− reqinfo@(isPersist,_) = infoFromRequest req reqidxhdr
188− (isKeepAlive, needsChunked) = infoFromResponse rspidxhdr reqinfo
137+ getdate = getDate ii
138+ addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
139+ (isPersist,isChunked0) = infoFromRequest req reqidxhdr
140+ isChunked = not isHead && isChunked0
141+ (isKeepAlive, needsChunked) = infoFromResponse rspidxhdr (isPersist,isChunked)
142+ isHead = requestMethod req == H.methodHead
189143 rsp = case response of
190− ResponseFile _ _ path mPart -> RspFile path mPart mRange (T.tickle th)
191− ResponseBuilder _ _ b -> RspBuilder b needsChunked
192− ResponseStream _ _ fb -> RspStream fb needsChunked th
144+ ResponseFile _ _ path mPart -> RspFile path mPart reqidxhdr isHead (T.tickle th)
145+ ResponseBuilder _ _ b
146+ | isHead -> RspNoBody
147+ | otherwise -> RspBuilder b needsChunked
148+ ResponseStream _ _ fb
149+ | isHead -> RspNoBody
150+ | otherwise -> RspStream fb needsChunked th
193151 ResponseRaw raw _ -> RspRaw raw src (T.tickle th)
194− ret = case response of
152+ -- Make sure we don't hang on to 'response' (avoid space leak)
153+ !ret = case response of
195154 ResponseFile {} -> isPersist
196155 ResponseBuilder {} -> isKeepAlive
197156 ResponseStream {} -> isKeepAlive
@@ -199,7 +158,33 @@ sendResponse defServer conn ii req reqidxhdr src response = do
199158
200159----------------------------------------------------------------
201160
202−data Rsp = RspFile FilePath (Maybe FilePart) (Maybe HeaderValue) (IO ())
161+sanitizeHeaders :: H.ResponseHeaders -> H.ResponseHeaders
162+sanitizeHeaders = map (sanitize <$>)
163+ where
164+ sanitize v
165+ | containsNewlines v = sanitizeHeaderValue v -- slow path
166+ | otherwise = v -- fast path
167+
168+{-# INLINE containsNewlines #-}
169+containsNewlines :: ByteString -> Bool
170+containsNewlines = S.any (\w -> w == _cr || w == _lf)
171+
172+{-# INLINE sanitizeHeaderValue #-}
173+sanitizeHeaderValue :: ByteString -> ByteString
174+sanitizeHeaderValue v = case C8.lines $ S.filter (/= _cr) v of
175+ [] -> ""
176+ x : xs -> C8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
177+ where
178+ addSpaceIfMissing line = case C8.uncons line of
179+ Nothing -> Nothing
180+ Just (first, _)
181+ | first == ' ' || first == '\t' -> Just line
182+ | otherwise -> Just $ " " <> line
183+
184+----------------------------------------------------------------
185+
186+data Rsp = RspNoBody
187+ | RspFile FilePath (Maybe FilePart) IndexedHeader Bool (IO ())
203188 | RspBuilder Builder Bool
204189 | RspStream StreamingBody Bool T.Handle
205190 | RspRaw (IO ByteString -> (ByteString -> IO ()) -> IO ()) (IO ByteString) (IO ())
@@ -207,31 +192,25 @@ data Rsp = RspFile FilePath (Maybe FilePart) (Maybe HeaderValue) (IO ())
207192----------------------------------------------------------------
208193
209194sendRsp :: Connection
195+ -> InternalInfo
210196 -> H.HttpVersion
211197 -> H.Status
212198 -> H.ResponseHeaders
199+ -> IndexedHeader -- Response
213200 -> Rsp
214− -> IO ()
215−sendRsp conn ver s0 hs0 (RspFile path mPart mRange hook) = do
216− ex <- fileRange s0 hs path mPart mRange
217− case ex of
218− Left _ex ->
219−#ifdef WARP_DEBUG
220− print _ex >>
221−#endif
222− sendRsp conn ver s2 hs2 (RspBuilder body True)
223− Right (s, hs1, beg, len) -> do
224− lheader <- composeHeader ver s hs1
225− connSendFile conn path beg len hook [lheader]
226− where
227− hs = addAcceptRanges hs0
228− s2 = H.status404
229− hs2 = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
230− body = fromByteString "File not found"
201+ -> IO (Maybe H.Status, Maybe Integer)
231202
232203----------------------------------------------------------------
233204
234−sendRsp conn ver s hs (RspBuilder body needsChunked) = do
205+sendRsp conn _ ver s hs _ RspNoBody = do
206+ -- Not adding Content-Length.
207+ -- User agents treats it as Content-Length: 0.
208+ composeHeader ver s hs >>= connSendAll conn
209+ return (Just s, Nothing)
210+
211+----------------------------------------------------------------
212+
213+sendRsp conn _ ver s hs _ (RspBuilder body needsChunked) = do
235214 header <- composeHeaderBuilder ver s hs needsChunked
236215 let hdrBdy
237216 | needsChunked = header <> chunkedTransferEncoding body
@@ -240,34 +219,37 @@ sendRsp conn ver s hs (RspBuilder body needsChunked) = do
240219 buffer = connWriteBuffer conn
241220 size = connBufferSize conn
242221 toBufIOWith buffer size (connSendAll conn) hdrBdy
222+ return (Just s, Nothing) -- fixme: can we tell the actual sent bytes?
243223
244224----------------------------------------------------------------
245225
246−sendRsp conn ver s hs (RspStream withBodyFlush needsChunked th) = do
226+sendRsp conn _ ver s hs _ (RspStream streamingBody needsChunked th) = do
247227 header <- composeHeaderBuilder ver s hs needsChunked
248− (recv, finish) <- newBlazeRecv $ reuseBufferStrategy
249− $ toBlazeBuffer (connWriteBuffer conn) (connBufferSize conn)
250− let addChunk builder = do
228+ (recv, finish) <- newByteStringBuilderRecv $ reuseBufferStrategy
229+ $ toBuilderBuffer (connWriteBuffer conn) (connBufferSize conn)
230+ let send builder = do
251231 popper <- recv builder
252232 let loop = do
253233 bs <- popper
254234 unless (S.null bs) $ do
255− connSink conn th bs
235+ sendFragment conn th bs
256236 loop
257237 loop
258− addChunk'
259− | needsChunked = addChunk . chunkedTransferEncoding
260− | otherwise = addChunk
261− addChunk header
262− withBodyFlush addChunk' (addChunk' flush)
263− when needsChunked $ addChunk chunkedTransferTerminator
238+ sendChunk
239+ | needsChunked = send . chunkedTransferEncoding
240+ | otherwise = send
241+ send header
242+ streamingBody sendChunk (sendChunk flush)
243+ when needsChunked $ send chunkedTransferTerminator
264244 mbs <- finish
265− maybe (return ()) (connSink conn th) mbs
245+ maybe (return ()) (sendFragment conn th) mbs
246+ return (Just s, Nothing) -- fixme: can we tell the actual sent bytes?
266247
267248----------------------------------------------------------------
268249
269−sendRsp conn _ _ _ (RspRaw withApp src tickle) =
250+sendRsp conn _ _ _ _ _ (RspRaw withApp src tickle) = do
270251 withApp recv send
252+ return (Nothing, Nothing)
271253 where
272254 recv = do
273255 bs <- src
@@ -277,19 +259,73 @@ sendRsp conn _ _ _ (RspRaw withApp src tickle) =
277259
278260----------------------------------------------------------------
279261
280−sendResponseNoBody :: Connection
281− -> H.HttpVersion
282− -> H.Status
283− -> H.ResponseHeaders
284− -> IO ()
285−sendResponseNoBody conn ver s hs = composeHeader ver s hs >>= connSendAll conn
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"
286322
287323----------------------------------------------------------------
288324----------------------------------------------------------------
289325
290326-- | Use 'connSendAll' to send this data while respecting timeout rules.
291−connSink :: Connection -> T.Handle -> ByteString -> IO ()
292−connSink Connection { connSendAll = send } th bs = do
327+sendFragment :: Connection -> T.Handle -> ByteString -> IO ()
328+sendFragment Connection { connSendAll = send } th bs = do
293329 T.resume th
294330 send bs
295331 T.pause th
@@ -310,7 +346,7 @@ checkPersist req reqidxhdr
310346 | otherwise = checkPersist10 conn
311347 where
312348 ver = httpVersion req
313− conn = reqidxhdr ! idxConnection
349+ conn = reqidxhdr ! fromEnum ReqConnection
314350 checkPersist11 (Just x)
315351 | CI.foldCase x == "close" = False
316352 checkPersist11 _ = True
@@ -335,49 +371,26 @@ infoFromResponse rspidxhdr (isPersist,isChunked) = (isKeepAlive, needsChunked)
335371 where
336372 needsChunked = isChunked && not hasLength
337373 isKeepAlive = isPersist && (isChunked || hasLength)
338− hasLength = isJust $ rspidxhdr ! idxContentLength
374+ hasLength = isJust $ rspidxhdr ! fromEnum ResContentLength
339375
340376----------------------------------------------------------------
341377
342−hasBody :: H.Status -> Request -> Bool
343−hasBody s req = sc /= 204
344− && sc /= 304
345− && sc >= 200
346− && method /= H.methodHead
378+hasBody :: H.Status -> Bool
379+hasBody s = sc /= 204
380+ && sc /= 304
381+ && sc >= 200
347382 where
348383 sc = H.statusCode s
349− method = requestMethod req
350384
351385----------------------------------------------------------------
352386
353−addAcceptRanges :: H.ResponseHeaders -> H.ResponseHeaders
354−addAcceptRanges hdrs = (hAcceptRanges, "bytes") : hdrs
355−
356387addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
357−addTransferEncoding hdrs = (hTransferEncoding, "chunked") : hdrs
388+addTransferEncoding hdrs = (H.hTransferEncoding, "chunked") : hdrs
358389
359−addContentLength :: Integer -> H.ResponseHeaders -> H.ResponseHeaders
360−addContentLength cl hdrs = (H.hContentLength, len) : hdrs
361− where
362− len = B.pack $ show cl
363−
364−addContentRange :: Integer -> Integer -> Integer
365− -> H.ResponseHeaders -> H.ResponseHeaders
366−addContentRange beg end total hdrs = (hContentRange, range) : hdrs
367− where
368− range = B.pack
369− -- building with ShowS
370− $ 'b' : 'y': 't' : 'e' : 's' : ' '
371− : showInt beg
372− ( '-'
373− : showInt end
374− ( '/'
375− : showInt total ""))
376−
377−addDate :: D.DateCache -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
378−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
379392 Nothing -> do
380− gmtdate <- D.getDate dc
393+ gmtdate <- getdate
381394 return $ (H.hDate, gmtdate) : hdrs
382395 Just _ -> return hdrs
383396
@@ -387,12 +400,13 @@ addDate dc rspidxhdr hdrs = case rspidxhdr ! idxDate of
387400warpVersion :: String
388401warpVersion = showVersion Paths_warp.version
389402
390−defaultServerValue :: HeaderValue
391−defaultServerValue = B.pack $ "Warp/" ++ warpVersion
392−
403+{-# INLINE addServer #-}
393404addServer :: HeaderValue -> IndexedHeader -> H.ResponseHeaders -> H.ResponseHeaders
394−addServer defaultServerValue' rspidxhdr hdrs = case rspidxhdr ! idxServer of
395− Nothing -> (hServer, defaultServerValue') : hdrs
405+addServer "" rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
406+ Nothing -> hdrs
407+ _ -> filter ((/= H.hServer) . fst) hdrs
408+addServer serverName rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
409+ Nothing -> (H.hServer, serverName) : hdrs
396410 _ -> hdrs
397411
398412----------------------------------------------------------------
@@ -408,6 +422,6 @@ replaceHeader k v hdrs = (k,v) : deleteBy ((==) `on` fst) (k,v) hdrs
408422
409423composeHeaderBuilder :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> Bool -> IO Builder
410424composeHeaderBuilder ver s hs True =
411− fromByteString <$> composeHeader ver s (addTransferEncoding hs)
425+ byteString <$> composeHeader ver s (addTransferEncoding hs)
412426composeHeaderBuilder ver s hs False =
413− fromByteString <$> composeHeader ver s hs
427+ byteString <$> composeHeader ver s hs
warp/Network/Wai/Handler/Warp/ResponseHeader.hs+5−15
@@ -3,18 +3,16 @@
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
9−import Data.ByteString.Internal (ByteString(..), create, memcpy)
7+import Data.ByteString.Internal (create)
108import qualified Data.CaseInsensitive as CI
11−import Data.List (foldl')
12−import Data.Word (Word8)
13−import Foreign.ForeignPtr
149import Foreign.Ptr
1510import GHC.Storable
1611import qualified Network.HTTP.Types as H
1712
13+import Network.Wai.Handler.Warp.Buffer (copy)
14+import Network.Wai.Handler.Warp.Imports
15+
1816----------------------------------------------------------------
1917
2018composeHeader :: H.HttpVersion -> H.Status -> H.ResponseHeaders -> IO ByteString
@@ -24,15 +22,9 @@ 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
30−{-# INLINE copy #-}
31−copy :: Ptr Word8 -> ByteString -> IO (Ptr Word8)
32−copy !ptr (PS fp o l) = withForeignPtr fp $ \p -> do
33− memcpy ptr (p `plusPtr` o) (fromIntegral l)
34− return $! ptr `plusPtr` l
35−
3628httpVer11 :: ByteString
3729httpVer11 = "HTTP/1.1 "
3830
@@ -90,5 +82,3 @@ cr :: Word8
9082cr = 13
9183lf :: Word8
9284lf = 10
93−
94−
warp/Network/Wai/Handler/Warp/Run.hs+356−152
@@ -1,92 +1,142 @@
1+{-# LANGUAGE BangPatterns #-}
12{-# LANGUAGE CPP #-}
23{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PackageImports #-}
5+{-# LANGUAGE PatternGuards #-}
6+{-# LANGUAGE RecordWildCards #-}
37{-# LANGUAGE ScopedTypeVariables #-}
48{-# LANGUAGE TupleSections #-}
9+{-# LANGUAGE ViewPatterns #-}
510{-# OPTIONS_GHC -fno-warn-deprecations #-}
611
712module Network.Wai.Handler.Warp.Run where
813
14+import "iproute" Data.IP (toHostAddress, toHostAddress6)
915import Control.Arrow (first)
10−import Control.Concurrent (threadDelay)
1116import qualified Control.Concurrent as Conc (yield)
1217import Control.Exception as E
13−import Control.Monad (when, unless, void)
14−import Data.ByteString (ByteString)
1518import qualified Data.ByteString as S
19+import Data.Char (chr)
1620import Data.IORef (IORef, newIORef, readIORef, writeIORef)
1721import Data.Streaming.Network (bindPortTCP)
18−import Network (sClose, Socket)
19−import Network.Socket (accept, withSocketsDo, SockAddr)
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
2029import qualified Network.Socket.ByteString as Sock
2130import Network.Wai
31+import Network.Wai.Internal (ResponseReceived (ResponseReceived))
32+import System.Environment (lookupEnv)
33+import qualified System.TimeManager as T
34+import System.Timeout (timeout)
35+
2236import Network.Wai.Handler.Warp.Buffer
2337import Network.Wai.Handler.Warp.Counter
2438import qualified Network.Wai.Handler.Warp.Date as D
2539import qualified Network.Wai.Handler.Warp.FdCache as F
40+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
41+import Network.Wai.Handler.Warp.HTTP2 (http2)
42+import Network.Wai.Handler.Warp.HTTP2.Types (isHTTP2)
2643import Network.Wai.Handler.Warp.Header
44+import Network.Wai.Handler.Warp.Imports hiding (readInt)
45+import Network.Wai.Handler.Warp.ReadInt
2746import Network.Wai.Handler.Warp.Recv
2847import Network.Wai.Handler.Warp.Request
2948import Network.Wai.Handler.Warp.Response
3049import Network.Wai.Handler.Warp.SendFile
3150import Network.Wai.Handler.Warp.Settings
32−import qualified Network.Wai.Handler.Warp.Timeout as T
3351import Network.Wai.Handler.Warp.Types
34−import Network.Wai.Internal (ResponseReceived (ResponseReceived))
35−import System.IO.Error (isFullErrorType, ioeGetErrorType)
52+
3653
3754#if WINDOWS
3855import Network.Wai.Handler.Warp.Windows
3956#else
40−import System.Posix.IO (FdOption(CloseOnExec), setFdOption)
4157import Network.Socket (fdSocket)
4258#endif
4359
44−-- | Default action value for 'Connection'.
45−socketConnection :: Socket -> IO Connection
46−socketConnection s = do
47− readBuf <- allocateBuffer bufferSize
60+-- | Creating 'Connection' for plain HTTP based on a given socket.
61+socketConnection :: Settings -> Socket -> IO Connection
62+#if MIN_VERSION_network(3,1,1)
63+socketConnection set s = do
64+#else
65+socketConnection _ s = do
66+#endif
67+ bufferPool <- newBufferPool
4868 writeBuf <- allocateBuffer bufferSize
69+ let sendall = Sock.sendAll s
70+ isH2 <- newIORef False -- HTTP/1.x
4971 return Connection {
5072 connSendMany = Sock.sendMany s
51− , connSendAll = Sock.sendAll s
52− , connSendFile = defaultSendFile s
53− , connClose = sClose s >> freeBuffer readBuf >> freeBuffer writeBuf
54− , connRecv = receive s readBuf bufferSize
55− , connReadBuffer = readBuf
73+ , connSendAll = sendall
74+ , connSendFile = sendFile s writeBuf bufferSize sendall
75+#if MIN_VERSION_network(3,1,1)
76+ , connClose = do
77+ h2 <- readIORef isH2
78+ let tm = if h2 then settingsGracefulCloseTimeout2 set
79+ else settingsGracefulCloseTimeout1 set
80+ if tm == 0 then
81+ close s
82+ else
83+ gracefulClose s tm `E.catch` \(E.SomeException _) -> return ()
84+#else
85+ , connClose = close s
86+#endif
87+ , connFree = freeBuffer writeBuf
88+ , connRecv = receive s bufferPool
89+ , connRecvBuf = receiveBuf s
5690 , connWriteBuffer = writeBuf
5791 , connBufferSize = bufferSize
58− , connSendFileOverride = Override s
92+ , connHTTP2 = isH2
5993 }
6094
61−#if __GLASGOW_HASKELL__ < 702
62−allowInterrupt :: IO ()
63−allowInterrupt = unblock $ return ()
64−#endif
65−
66−-- | Run an 'Application' on the given port. This calls 'runSettings' with
67−-- 'defaultSettings'.
95+-- | Run an 'Application' on the given port.
96+-- This calls 'runSettings' with 'defaultSettings'.
6897run :: Port -> Application -> IO ()
6998run p = runSettings defaultSettings { settingsPort = p }
7099
100+-- | Run an 'Application' on the port present in the @PORT@
101+-- environment variable. Uses the 'Port' given when the variable is unset.
102+-- This calls 'runSettings' with 'defaultSettings'.
103+--
104+-- Since 3.0.9
105+runEnv :: Port -> Application -> IO ()
106+runEnv p app = do
107+ mp <- lookupEnv "PORT"
108+
109+ maybe (run p app) runReadPort mp
110+
111+ where
112+ runReadPort :: String -> IO ()
113+ runReadPort sp = case reads sp of
114+ ((p', _):_) -> run p' app
115+ _ -> fail $ "Invalid value in $PORT: " ++ sp
116+
71117-- | Run an 'Application' with the given 'Settings'.
118+-- This opens a listen socket on the port defined in 'Settings' and
119+-- calls 'runSettingsSocket'.
72120runSettings :: Settings -> Application -> IO ()
73121runSettings set app = withSocketsDo $
74122 bracket
75123 (bindPortTCP (settingsPort set) (settingsHost set))
76− sClose
124+ close
77125 (\socket -> do
78126 setSocketCloseOnExec socket
79127 runSettingsSocket set socket app)
80128
81−-- | Same as 'runSettings', but uses a user-supplied socket instead of opening
82−-- one. This allows the user to provide, for example, Unix named socket, which
129+-- | This installs a shutdown handler for the given socket and
130+-- calls 'runSettingsConnection' with the default connection setup action
131+-- which handles plain (non-cipher) HTTP.
132+-- When the listen socket in the second argument is closed, all live
133+-- connections are gracefully shut down.
134+--
135+-- The supplied socket can be a Unix named socket, which
83136-- can be used when reverse HTTP proxying into your application.
84137--
85138-- Note that the 'settingsPort' will still be passed to 'Application's via the
86139-- 'serverPort' record.
87−--
88−-- When the listen socket in the second argument is closed, all live
89−-- connections are gracefully shut-downed.
90140runSettingsSocket :: Settings -> Socket -> Application -> IO ()
91141runSettingsSocket set socket app = do
92142 settingsInstallShutdownHandler set closeListenSocket
@@ -99,15 +149,20 @@ runSettingsSocket set socket app = do
99149 (s, sa) <- accept socket
100150#endif
101151 setSocketCloseOnExec s
102− 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
103155 return (conn, sa)
104156
105− closeListenSocket = sClose socket
157+ closeListenSocket = close socket
106158
107−-- | Allows you to provide a function which will return a 'Connection'. In
108−-- cases where creating the @Connection@ can be expensive, this allows the
109−-- expensive computations to be performed in a separate thread instead of the
110−-- main server loop.
159+-- | The connection setup action would be expensive. A good example
160+-- is initialization of TLS.
161+-- So, this converts the connection setup action to the connection maker
162+-- which will be executed after forking a new worker thread.
163+-- Then this calls 'runSettingsConnectionMaker' with the connection maker.
164+-- This allows the expensive computations to be performed
165+-- in a separate worker thread instead of the main server loop.
111166--
112167-- Since 1.3.5
113168runSettingsConnection :: Settings -> IO (Connection, SockAddr) -> Application -> IO ()
@@ -117,41 +172,46 @@ runSettingsConnection set getConn app = runSettingsConnectionMaker set getConnMa
117172 (conn, sa) <- getConn
118173 return (return conn, sa)
119174
175+-- | This modifies the connection maker so that it returns 'TCP' for 'Transport'
176+-- (i.e. plain HTTP) then calls 'runSettingsConnectionMakerSecure'.
120177runSettingsConnectionMaker :: Settings -> IO (IO Connection, SockAddr) -> Application -> IO ()
121178runSettingsConnectionMaker x y =
122− runSettingsConnectionMakerSecure x (go y)
179+ runSettingsConnectionMakerSecure x (toTCP <$> y)
123180 where
124− go = fmap (first (fmap (, False)))
181+ toTCP = first ((, TCP) <$>)
125182
126183----------------------------------------------------------------
127184
128−-- | Allows you to provide a function which will return a function
129−-- which will return 'Connection'.
185+-- | The core run function which takes 'Settings',
186+-- a connection maker and 'Application'.
187+-- The connection maker can return a connection of either plain HTTP
188+-- or HTTP over TLS.
130189--
131190-- Since 2.1.4
132−runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Bool), SockAddr) -> Application -> IO ()
191+runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport), SockAddr) -> Application -> IO ()
133192runSettingsConnectionMakerSecure set getConnMaker app = do
134193 settingsBeforeMainLoop set
135194 counter <- newCounter
136−
137− D.withDateCache $ \dc ->
138− F.withFdCache fdCacheDurationInSeconds $ \fc ->
139− withTimeoutManager $ \tm ->
140− acceptConnection set getConnMaker app dc fc tm counter
195+ withII $ acceptConnection set getConnMaker app counter
141196 where
142− fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
197+ withII action =
198+ withTimeoutManager $ \tm ->
199+ D.withDateCache $ \dc ->
200+ F.withFdCache fdCacheDurationInSeconds $ \fdc ->
201+ I.withFileInfoCache fdFileInfoDurationInSeconds $ \fic -> do
202+ let ii = InternalInfo tm dc fdc fic
203+ action ii
204+
205+ !fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
206+ !fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
207+ !timeoutInSeconds = settingsTimeout set * 1000000
143208 withTimeoutManager f = case settingsManager set of
144209 Just tm -> f tm
145210 Nothing -> bracket
146− (T.initialize $ settingsTimeout set * 1000000)
211+ (T.initialize timeoutInSeconds)
147212 T.stopManager
148213 f
149214
150−onE :: Settings -> Maybe Request -> SomeException -> IO ()
151−onE set mreq e = case fromException e of
152− Just (NotEnoughLines []) -> return ()
153− _ -> settingsOnException set mreq e
154−
155215-- Note that there is a thorough discussion of the exception safety of the
156216-- following code at: https://github.com/yesodweb/wai/issues/146
157217--
@@ -166,19 +226,22 @@ onE set mreq e = case fromException e of
166226--
167227-- Our approach is explained in the comments below.
168228acceptConnection :: Settings
169− -> IO (IO (Connection, Bool), SockAddr)
229+ -> IO (IO (Connection, Transport), SockAddr)
170230 -> Application
171− -> D.DateCache
172− -> Maybe F.MutableFdCache
173− -> T.Manager
174231 -> Counter
232+ -> InternalInfo
175233 -> IO ()
176−acceptConnection set getConnMaker app dc fc tm counter = do
234+acceptConnection set getConnMaker app counter ii = do
177235 -- First mask all exceptions in acceptLoop. This is necessary to
178236 -- ensure that no async exception is throw between the call to
179237 -- acceptNewConnection and the registering of connClose.
180− void $ mask_ $ acceptLoop
181− gracefulShutdown counter
238+ --
239+ -- acceptLoop can be broken by closing the listing socket.
240+ void $ mask_ acceptLoop
241+ -- In some cases, we want to stop Warp here without graceful shutdown.
242+ -- So, async exceptions are allowed here.
243+ -- That's why `finally` is not used.
244+ gracefulShutdown set counter
182245 where
183246 acceptLoop = do
184247 -- Allow async exceptions before receiving the next connection maker.
@@ -195,106 +258,195 @@ acceptConnection set getConnMaker app dc fc tm counter = do
195258 case mx of
196259 Nothing -> return ()
197260 Just (mkConn, addr) -> do
198− fork set mkConn addr app dc fc tm counter
261+ fork set mkConn addr app counter ii
199262 acceptLoop
200263
201264 acceptNewConnection = do
202265 ex <- try getConnMaker
203266 case ex of
204267 Right x -> return $ Just x
205− Left e -> do
206− onE set Nothing $ toException e
207− if isFullErrorType (ioeGetErrorType e) then do
208− -- "resource exhausted (Too many open files)" may
209− -- happen by accept(). Wait a second hoping that
210− -- resource will be available.
211− threadDelay 1000000
212− acceptNewConnection
213− else
214− -- Assuming the listen socket is closed.
215− 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
216276
217277-- Fork a new worker thread for this connection maker, and ask for a
218278-- function to unmask (i.e., allow async exceptions to be thrown).
219279fork :: Settings
220− -> IO (Connection, Bool)
280+ -> IO (Connection, Transport)
221281 -> SockAddr
222282 -> Application
223− -> D.DateCache
224− -> Maybe F.MutableFdCache
225− -> T.Manager
226283 -> Counter
284+ -> InternalInfo
227285 -> IO ()
228−fork set mkConn addr app dc fc tm counter = settingsFork set $ \ unmask ->
229− -- Run the connection maker to get a new connection, and ensure
230− -- that the connection is closed. If the mkConn call throws an
231− -- exception, we will leak the connection. If the mkConn call is
232− -- vulnerable to attacks (e.g., Slowloris), we do nothing to
233− -- protect the server. It is therefore vital that mkConn is well
234− -- vetted.
235− --
236− -- We grab the connection before registering timeouts since the
237− -- timeouts will be useless during connection creation, due to the
238− -- fact that async exceptions are still masked.
239− bracket mkConn closeConn $ \(conn0, isSecure') ->
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
240303
241304 -- We need to register a timeout handler for this thread, and
242305 -- cancel that handler as soon as we exit.
243− bracket (T.registerKillThread tm) T.cancel $ \th ->
244−
245− let ii = InternalInfo th fc dc
246− conn = setSendFile conn0 fc
247− -- We now have fully registered a connection close handler
248− -- in the case of all exceptions, so it is safe to one
249− -- again allow async exceptions.
250− in unmask .
251− -- Call the user-supplied on exception code if any
252− -- exceptions are thrown.
253− handle (onE set Nothing) .
254−
255− -- Call the user-supplied code for connection open and close events
256− bracket (onOpen addr) (onClose addr) $ \goingon ->
257−
258− -- Actually serve this connection.
259− -- onnClose above ensures the termination of the connection.
260− when goingon $ serveConnection conn ii addr isSecure' set app
261− where
262− closeConn (conn, _isSecure) = 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
263320
264321 onOpen adr = increase counter >> settingsOnOpen set adr
265322 onClose adr _ = decrease counter >> settingsOnClose set adr
266323
267324serveConnection :: Connection
268325 -> InternalInfo
326+ -> T.Handle
269327 -> SockAddr
270− -> Bool -- ^ is secure?
328+ -> Transport
271329 -> Settings
272330 -> Application
273331 -> IO ()
274−serveConnection conn ii addr isSecure' settings app = do
332+serveConnection conn ii th origAddr transport settings app = do
333+ -- fixme: Upgrading to HTTP/2 should be supported.
334+ (h2,bs) <- if isHTTP2 transport then
335+ return (True, "")
336+ else do
337+ bs0 <- connRecv conn
338+ if S.length bs0 >= 4 && "PRI " `S.isPrefixOf` bs0 then
339+ return (True, bs0)
340+ else
341+ return (False, bs0)
275342 istatus <- newIORef False
276− src <- mkSource (connSource conn th istatus)
277− recvSendLoop istatus src `E.catch` \e -> do
278− sendErrorResponse istatus e
279− throwIO (e :: SomeException)
343+ if settingsHTTP2Enabled settings && h2 then do
344+ rawRecvN <- makeReceiveN bs (connRecv conn) (connRecvBuf conn)
345+ -- This thread becomes the sender in http2 library.
346+ -- In the case of event source, one request comes and one
347+ -- worker gets busy. But it is likely that the receiver does
348+ -- not receive any data at all while the sender is sending
349+ -- output data from the worker. It's not good enough to tickle
350+ -- the time handler in the receiver only. So, we should tickle
351+ -- the time handler in both the receiver and the sender.
352+ let recvN = wrappedRecvN th istatus (settingsSlowlorisSize settings) rawRecvN
353+ sendBS x = connSendAll conn x >> T.tickle th
354+ -- fixme: origAddr
355+ checkTLS
356+ setConnHTTP2 conn True
357+ http2 conn transport ii origAddr settings recvN sendBS app
358+ else do
359+ src <- mkSource (wrappedRecv conn th istatus (settingsSlowlorisSize settings))
360+ writeIORef istatus True
361+ leftoverSource src bs
362+ addr <- getProxyProtocolAddr src
363+ http1 True addr istatus src `E.catch` \e ->
364+ case () of
365+ ()
366+ -- See comment below referencing
367+ -- https://github.com/yesodweb/wai/issues/618
368+ | Just NoKeepAliveRequest <- fromException e -> return ()
369+ -- No valid request
370+ | Just (BadFirstLine _) <- fromException e -> return ()
371+ | otherwise -> do
372+ _ <- sendErrorResponse (dummyreq addr) istatus e
373+ throwIO e
280374
281375 where
282− th = threadHandle ii
283−
284− sendErrorResponse istatus e = do
376+ getProxyProtocolAddr src =
377+ case settingsProxyProtocol settings of
378+ ProxyProtocolNone ->
379+ return origAddr
380+ ProxyProtocolRequired -> do
381+ seg <- readSource src
382+ parseProxyProtocolHeader src seg
383+ ProxyProtocolOptional -> do
384+ seg <- readSource src
385+ if S.isPrefixOf "PROXY " seg
386+ then parseProxyProtocolHeader src seg
387+ else do leftoverSource src seg
388+ return origAddr
389+
390+ parseProxyProtocolHeader src seg = do
391+ let (header,seg') = S.break (== 0x0d) seg -- 0x0d == CR
392+ maybeAddr = case S.split 0x20 header of -- 0x20 == space
393+ ["PROXY","TCP4",clientAddr,_,clientPort,_] ->
394+ case [x | (x, t) <- reads (decodeAscii clientAddr), null t] of
395+ [a] -> Just (SockAddrInet (readInt clientPort)
396+ (toHostAddress a))
397+ _ -> Nothing
398+ ["PROXY","TCP6",clientAddr,_,clientPort,_] ->
399+ case [x | (x, t) <- reads (decodeAscii clientAddr), null t] of
400+ [a] -> Just (SockAddrInet6 (readInt clientPort)
401+ 0
402+ (toHostAddress6 a)
403+ 0)
404+ _ -> Nothing
405+ ("PROXY":"UNKNOWN":_) ->
406+ Just origAddr
407+ _ ->
408+ Nothing
409+ case maybeAddr of
410+ Nothing -> throwIO (BadProxyHeader (decodeAscii header))
411+ Just a -> do leftoverSource src (S.drop 2 seg') -- drop CRLF
412+ return a
413+
414+ decodeAscii = map (chr . fromEnum) . S.unpack
415+
416+ shouldSendErrorResponse se
417+ | Just ConnectionClosedByPeer <- fromException se = False
418+ | otherwise = True
419+
420+ sendErrorResponse req istatus e = do
285421 status <- readIORef istatus
286− when status $ void $
287− sendResponse
288− (settingsServerName settings)
289− conn ii dummyreq 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
290426
291− dummyreq = defaultRequest { remoteHost = addr }
427+ dummyreq addr = defaultRequest { remoteHost = addr }
292428
293429 errorResponse e = settingsOnExceptionResponse settings e
294430
295− recvSendLoop istatus fromClient = do
296− (req', mremainingRef, idxhdr) <- recvRequest settings conn ii addr fromClient
297− let req = req' { isSecure = isSecure' }
431+ http1 firstRequest addr istatus src = do
432+ (req, mremainingRef, idxhdr, nextBodyFlush) <- recvRequest firstRequest settings conn ii th addr src transport
433+ keepAlive <- processRequest istatus src req mremainingRef idxhdr nextBodyFlush
434+ `E.catch` \e -> do
435+ settingsOnException settings (Just req) e
436+ -- Don't throw the error again to prevent calling settingsOnException twice.
437+ return False
438+
439+ -- When doing a keep-alive connection, the other side may just
440+ -- close the connection. We don't want to treat that as an
441+ -- exceptional situation, so we pass in False to http1 (which
442+ -- in turn passes in False to recvRequest), indicating that
443+ -- this is not the first request. If, when trying to read the
444+ -- request headers, no data is available, recvRequest will
445+ -- throw a NoKeepAliveRequest exception, which we catch here
446+ -- and ignore. See: https://github.com/yesodweb/wai/issues/618
447+ when keepAlive $ http1 False addr istatus src
448+
449+ processRequest istatus src req mremainingRef idxhdr nextBodyFlush = do
298450 -- Let the application run for as long as it wants
299451 T.pause th
300452
@@ -302,50 +454,78 @@ serveConnection conn ii addr isSecure' settings app = do
302454 -- creating the request, we need to make sure that we don't get
303455 -- an async exception before calling the ResponseSource.
304456 keepAliveRef <- newIORef $ error "keepAliveRef not filled"
305− _ <- app req $ \res -> do
457+ r <- E.try $ app req $ \res -> do
306458 T.resume th
307459 -- FIXME consider forcing evaluation of the res here to
308460 -- send more meaningful error messages to the user.
309461 -- However, it may affect performance.
310462 writeIORef istatus False
311− keepAlive <- sendResponse
312− (settingsServerName settings)
313− conn ii req idxhdr (readSource fromClient) res
463+ keepAlive <- sendResponse settings conn ii th req idxhdr (readSource src) res
314464 writeIORef keepAliveRef keepAlive
315465 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+
316475 keepAlive <- readIORef keepAliveRef
317476
318477 -- We just send a Response and it takes a time to
319478 -- receive a Request again. If we immediately call recv,
320− -- it is likely to fail and the IO manager works.
321− -- It is very costy. So, we yield to another Haskell
322− -- thread hoping that the next Request will arraive
479+ -- it is likely to fail and cause the IO manager to do some work.
480+ -- It is very costly, so we yield to another Haskell
481+ -- thread hoping that the next Request will arrive
323482 -- when this Haskell thread will be re-scheduled.
324483 -- This improves performance at least when
325484 -- the number of cores is small.
326485 Conc.yield
327486
328− when keepAlive $ do
487+ if keepAlive
488+ then
329489 -- If there is an unknown or large amount of data to still be read
330490 -- from the request body, simple drop this connection instead of
331491 -- reading it all in to satisfy a keep-alive request.
332492 case settingsMaximumBodyFlush settings of
333493 Nothing -> do
334− flushEntireBody (requestBody req)
494+ flushEntireBody nextBodyFlush
335495 T.resume th
336− recvSendLoop istatus fromClient
496+ return True
337497 Just maxToRead -> do
338498 let tryKeepAlive = do
339499 -- flush the rest of the request body
340− isComplete <- flushBody (requestBody req) maxToRead
341− when isComplete $ do
500+ isComplete <- flushBody nextBodyFlush maxToRead
501+ if isComplete then do
342502 T.resume th
343− recvSendLoop istatus fromClient
503+ return True
504+ else
505+ return False
344506 case mremainingRef of
345507 Just ref -> do
346508 remaining <- readIORef ref
347− when (remaining <= maxToRead) tryKeepAlive
509+ if remaining <= maxToRead then
510+ tryKeepAlive
511+ else
512+ return False
348513 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
349529
350530flushEntireBody :: IO ByteString -> IO ()
351531flushEntireBody src =
@@ -370,26 +550,50 @@ flushBody src =
370550 | toRead' >= 0 -> loop toRead'
371551 | otherwise -> return False
372552
373−connSource :: Connection -> T.Handle -> IORef Bool -> IO ByteString
374−connSource Connection { connRecv = recv } th istatus = do
553+wrappedRecv :: Connection -> T.Handle -> IORef Bool -> Int -> IO ByteString
554+wrappedRecv Connection { connRecv = recv } th istatus slowlorisSize = do
375555 bs <- recv
376556 unless (S.null bs) $ do
377557 writeIORef istatus True
378− when (S.length bs >= 2048) $ T.tickle th
558+ when (S.length bs >= slowlorisSize) $ T.tickle th
559+ return bs
560+
561+wrappedRecvN :: T.Handle -> IORef Bool -> Int -> (BufSize -> IO ByteString) -> (BufSize -> IO ByteString)
562+wrappedRecvN th istatus slowlorisSize readN bufsize = do
563+ bs <- readN bufsize
564+ unless (S.null bs) $ do
565+ writeIORef istatus True
566+ -- TODO: think about the slowloris protection in HTTP2: current code
567+ -- might open a slow-loris attack vector. Rather than timing we should
568+ -- consider limiting the per-client connections assuming that in HTTP2
569+ -- we should allow only few connections per host (real-world
570+ -- deployments with large NATs may be trickier).
571+ when (S.length bs >= slowlorisSize || bufsize <= slowlorisSize) $ T.tickle th
379572 return bs
380573
574+-- | Set flag FileCloseOnExec flag on a socket (on Unix)
575+--
381576-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
577+--
578+-- @since 3.2.17
382579setSocketCloseOnExec :: Socket -> IO ()
383580#if WINDOWS
384581setSocketCloseOnExec _ = return ()
385582#else
386−setSocketCloseOnExec socket =
387− 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
388590#endif
389591
390−gracefulShutdown :: Counter -> IO ()
391−gracefulShutdown counter = do
392− -- To avoid race condition, we just use threadDelay, not MVar.
393− threadDelay 10000000
394− noConnections <- isZero counter
395− unless noConnections $ gracefulShutdown 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+139−19
@@ -1,29 +1,149 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
22
3−module Network.Wai.Handler.Warp.SendFile where
3+module Network.Wai.Handler.Warp.SendFile (
4+ sendFile
5+ , readSendFile
6+ , packHeader -- for testing
7+#ifndef WINDOWS
8+ , positionRead
9+#endif
10+ ) where
411
5−import Data.ByteString (ByteString)
6−import Network.Sendfile
12+import qualified Data.ByteString as BS
713import Network.Socket (Socket)
8−import qualified Network.Wai.Handler.Warp.FdCache as F
14+
15+#ifdef WINDOWS
16+import Foreign.ForeignPtr (newForeignPtr_)
17+import Foreign.Ptr (plusPtr)
18+import qualified System.IO as IO
19+#else
20+import Control.Exception
21+import Foreign.C.Error (throwErrno)
22+import Foreign.C.Types
23+import Foreign.Ptr (Ptr, castPtr, plusPtr)
24+import Network.Sendfile
25+import Network.Wai.Handler.Warp.FdCache (openFile, closeFile)
26+import System.Posix.Types
27+#endif
28+
29+import Network.Wai.Handler.Warp.Buffer
30+import Network.Wai.Handler.Warp.Imports
931import Network.Wai.Handler.Warp.Types
1032
11−defaultSendFile :: Socket -> FilePath -> Integer -> Integer -> IO () -> [ByteString] -> IO ()
12−defaultSendFile s path off len act hdr = sendfileWithHeader s path (PartOfFile off len) act hdr
33+----------------------------------------------------------------
1334
35+-- | Function to send a file based on sendfile() for Linux\/Mac\/FreeBSD.
36+-- This makes use of the file descriptor cache.
37+-- For other OSes, this is identical to 'readSendFile'.
38+--
39+-- Since: 3.1.0
40+sendFile :: Socket -> Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
41+#ifdef SENDFILEFD
42+sendFile s _ _ _ fid off len act hdr = case mfid of
43+ -- settingsFdCacheDuration is 0
44+ Nothing -> sendfileWithHeader s path (PartOfFile off len) act hdr
45+ Just fd -> sendfileFdWithHeader s fd (PartOfFile off len) act hdr
46+ where
47+ mfid = fileIdFd fid
48+ path = fileIdPath fid
49+#else
50+sendFile _ = readSendFile
51+#endif
52+
53+----------------------------------------------------------------
1454
15−#if SENDFILEFD
16−setSendFile :: Connection -> Maybe F.MutableFdCache -> Connection
17−setSendFile conn Nothing = conn
18−setSendFile conn (Just fdcs) = case connSendFileOverride conn of
19− NotOverride -> conn
20− Override s -> conn { connSendFile = sendFile fdcs s }
55+packHeader :: Buffer -> BufSize -> (ByteString -> IO ())
56+ -> IO () -> [ByteString]
57+ -> Int
58+ -> IO Int
59+packHeader _ _ _ _ [] n = return n
60+packHeader buf siz send hook (bs:bss) n
61+ | len < room = do
62+ let dst = buf `plusPtr` n
63+ void $ copy dst bs
64+ packHeader buf siz send hook bss (n + len)
65+ | otherwise = do
66+ let dst = buf `plusPtr` n
67+ (bs1, bs2) = BS.splitAt room bs
68+ void $ copy dst bs1
69+ bufferIO buf siz send
70+ hook
71+ packHeader buf siz send hook (bs2:bss) 0
72+ where
73+ len = BS.length bs
74+ room = siz - n
2175
22−sendFile :: F.MutableFdCache -> Socket -> FilePath -> Integer -> Integer -> IO () -> [ByteString] -> IO ()
23−sendFile fdcs s path off len act hdr = do
24− (fd, fresher) <- F.getFd fdcs path
25− sendfileFdWithHeader s fd (PartOfFile off len) (act>>fresher) hdr
76+mini :: Int -> Integer -> Int
77+mini i n
78+ | fromIntegral i < n = i
79+ | otherwise = fromIntegral n
80+
81+-- | Function to send a file based on pread()\/send() for Unix.
82+-- This makes use of the file descriptor cache.
83+-- For Windows, this is emulated by 'Handle'.
84+--
85+-- Since: 3.1.0
86+#ifdef WINDOWS
87+readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
88+readSendFile buf siz send fid off0 len0 hook headers = do
89+ hn <- packHeader buf siz send hook headers 0
90+ let room = siz - hn
91+ buf' = buf `plusPtr` hn
92+ IO.withBinaryFile path IO.ReadMode $ \h -> do
93+ IO.hSeek h IO.AbsoluteSeek off0
94+ n <- IO.hGetBufSome h buf' (mini room len0)
95+ bufferIO buf (hn + n) send
96+ hook
97+ let n' = fromIntegral n
98+ fptr <- newForeignPtr_ buf
99+ loop h fptr (len0 - n')
100+ where
101+ path = fileIdPath fid
102+ loop h fptr len
103+ | len <= 0 = return ()
104+ | otherwise = do
105+ n <- IO.hGetBufSome h buf (mini siz len)
106+ when (n /= 0) $ do
107+ let bs = PS fptr 0 n
108+ n' = fromIntegral n
109+ send bs
110+ hook
111+ loop h fptr (len - n')
26112#else
27−setSendFile :: Connection -> Maybe F.MutableFdCache -> Connection
28−setSendFile conn _ = conn
113+readSendFile :: Buffer -> BufSize -> (ByteString -> IO ()) -> SendFile
114+readSendFile buf siz send fid off0 len0 hook headers =
115+ bracket setup teardown $ \fd -> do
116+ hn <- packHeader buf siz send hook headers 0
117+ let room = siz - hn
118+ buf' = buf `plusPtr` hn
119+ n <- positionRead fd buf' (mini room len0) off0
120+ bufferIO buf (hn + n) send
121+ hook
122+ let n' = fromIntegral n
123+ loop fd (len0 - n') (off0 + n')
124+ where
125+ path = fileIdPath fid
126+ setup = case fileIdFd fid of
127+ Just fd -> return fd
128+ Nothing -> openFile path
129+ teardown fd = case fileIdFd fid of
130+ Just _ -> return ()
131+ Nothing -> closeFile fd
132+ loop fd len off
133+ | len <= 0 = return ()
134+ | otherwise = do
135+ n <- positionRead fd buf (mini siz len) off
136+ bufferIO buf n send
137+ let n' = fromIntegral n
138+ hook
139+ loop fd (len - n') (off + n')
140+
141+positionRead :: Fd -> Buffer -> BufSize -> Integer -> IO Int
142+positionRead fd buf siz off = do
143+ bytes <- fromIntegral <$> c_pread fd (castPtr buf) (fromIntegral siz) (fromIntegral off)
144+ when (bytes < 0) $ throwErrno "positionRead"
145+ return bytes
146+
147+foreign import ccall unsafe "pread"
148+ c_pread :: Fd -> Ptr CChar -> ByteCount -> FileOffset -> IO CSsize
29149#endif
warp/Network/Wai/Handler/Warp/Settings.hs+124−37
@@ -1,29 +1,30 @@
11{-# LANGUAGE OverloadedStrings, ScopedTypeVariables, ViewPatterns #-}
22{-# LANGUAGE PatternGuards, RankNTypes #-}
3−{-# LANGUAGE ImpredicativeTypes #-}
3+{-# LANGUAGE ImpredicativeTypes, CPP #-}
44
55module Network.Wai.Handler.Warp.Settings where
66
7−import Control.Exception
8−import Control.Monad (when, void)
97import Control.Concurrent (forkIOWithUnmask)
8+import Control.Exception
9+import Data.ByteString.Builder (byteString)
10+import qualified Data.ByteString.Char8 as C8
11+import Data.ByteString.Lazy (fromStrict)
12+import Data.Streaming.Network (HostPreference)
1013import qualified Data.Text as T
1114import qualified Data.Text.IO as TIO
12−import Data.Streaming.Network (HostPreference)
15+import Data.Version (showVersion)
1316import GHC.IO.Exception (IOErrorType(..))
1417import qualified Network.HTTP.Types as H
18+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
1519import Network.Socket (SockAddr)
1620import Network.Wai
17−import Network.Wai.Handler.Warp.Timeout
18−import Network.Wai.Handler.Warp.Types
21+import qualified Paths_warp
1922import System.IO (stderr)
2023import System.IO.Error (ioeGetErrorType)
21−import qualified Data.Text.Lazy as TL
22−import qualified Data.Text.Lazy.Encoding as TLE
23−import Data.ByteString (ByteString)
24−import qualified Data.ByteString.Char8 as S8
25−import Data.Version (showVersion)
26−import qualified Paths_warp
24+import System.TimeManager
25+
26+import Network.Wai.Handler.Warp.Imports
27+import Network.Wai.Handler.Warp.Types
2728
2829-- | Various Warp server settings. This is purposely kept as an abstract data
2930-- type so that new settings can be added without breaking backwards
@@ -32,7 +33,7 @@ import qualified Paths_warp
3233--
3334-- > setTimeout 20 defaultSettings
3435data Settings = Settings
35− { settingsPort :: Int -- ^ Port to listen on. Default value: 3000
36+ { settingsPort :: Port -- ^ Port to listen on. Default value: 3000
3637 , settingsHost :: HostPreference -- ^ Default value: HostIPv4
3738 , settingsOnException :: Maybe Request -> SomeException -> IO () -- ^ What to do with exceptions thrown by either the application or server. Default: ignore server-generated exceptions (see 'InvalidRequest') and print application-generated applications to stderr.
3839 , settingsOnExceptionResponse :: SomeException -> Response
@@ -45,7 +46,8 @@ data Settings = Settings
4546 , settingsOnClose :: SockAddr -> IO () -- ^ What to do when a connection is close. Default: do nothing.
4647 , settingsTimeout :: Int -- ^ Timeout value in seconds. Default value: 30
4748 , settingsManager :: Maybe Manager -- ^ Use an existing timeout manager instead of spawning a new one. If used, 'settingsTimeout' is ignored. Default is 'Nothing'
48− , settingsFdCacheDuration :: Int -- ^ Cache duratoin time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 10
49+ , settingsFdCacheDuration :: Int -- ^ Cache duration time of file descriptors in seconds. 0 means that the cache mechanism is not used. Default value: 0
50+ , settingsFileInfoCacheDuration :: Int -- ^ Cache duration time of file information in seconds. 0 means that the cache mechanism is not used. Default value: 0
4951 , settingsBeforeMainLoop :: IO ()
5052 -- ^ Code to run after the listening socket is ready but before entering
5153 -- the main event loop. Useful for signaling to tests that they can start
@@ -74,6 +76,13 @@ data Settings = Settings
7476 --
7577 -- Since 2.0.3
7678 , 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
7786 , settingsServerName :: ByteString
7887 -- ^ Default server name if application does not set one.
7988 --
@@ -82,30 +91,89 @@ data Settings = Settings
8291 -- ^ See @setMaximumBodyFlush@.
8392 --
8493 -- Since 3.0.3
94+ , settingsProxyProtocol :: ProxyProtocol
95+ -- ^ Specify usage of the PROXY protocol.
96+ --
97+ -- Since 3.0.5
98+ , settingsSlowlorisSize :: Int
99+ -- ^ Size of bytes read to prevent Slowloris protection. Default value: 2048
100+ --
101+ -- Since 3.1.2
102+ , settingsHTTP2Enabled :: Bool
103+ -- ^ Whether to enable HTTP2 ALPN/upgrades. Default: True
104+ --
105+ -- Since 3.1.7
106+ , settingsLogger :: Request -> H.Status -> Maybe Integer -> IO ()
107+ -- ^ A log function. Default: no action.
108+ --
109+ -- Since 3.1.10
110+ , settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
111+ -- ^ A HTTP/2 server push log function. Default: no action.
112+ --
113+ -- Since 3.2.7
114+ , settingsGracefulShutdownTimeout :: Maybe Int
115+ -- ^ An optional timeout to limit the time (in seconds) waiting for
116+ -- a graceful shutdown of the web server.
117+ --
118+ -- Since 3.2.8
119+ , settingsGracefulCloseTimeout1 :: Int
120+ -- ^ A timeout to limit the time (in milliseconds) waiting for
121+ -- FIN for HTTP/1.x. 0 means uses immediate close.
122+ -- Default: 0.
123+ --
124+ -- Since 3.3.5
125+ , settingsGracefulCloseTimeout2 :: Int
126+ -- ^ A timeout to limit the time (in milliseconds) waiting for
127+ -- FIN for HTTP/2. 0 means uses immediate close.
128+ -- Default: 2000.
129+ --
130+ -- Since 3.3.5
131+ , settingsMaxTotalHeaderLength :: Int
132+ -- ^ Determines the maximum header size that Warp will tolerate when using HTTP/1.x.
133+ --
134+ -- Since 3.3.8
85135 }
86136
137+-- | Specify usage of the PROXY protocol.
138+data ProxyProtocol = ProxyProtocolNone
139+ -- ^ See @setProxyProtocolNone@.
140+ | ProxyProtocolRequired
141+ -- ^ See @setProxyProtocolRequired@.
142+ | ProxyProtocolOptional
143+ -- ^ See @setProxyProtocolOptional@.
144+
87145-- | The default settings for the Warp server. See the individual settings for
88146-- the default value.
89147defaultSettings :: Settings
90148defaultSettings = Settings
91149 { settingsPort = 3000
92150 , settingsHost = "*4"
93− , settingsOnException = defaultExceptionHandler
94− , settingsOnExceptionResponse = defaultExceptionResponse
151+ , settingsOnException = defaultOnException
152+ , settingsOnExceptionResponse = defaultOnExceptionResponse
95153 , settingsOnOpen = const $ return True
96154 , settingsOnClose = const $ return ()
97155 , settingsTimeout = 30
98156 , settingsManager = Nothing
99− , settingsFdCacheDuration = 10
157+ , settingsFdCacheDuration = 0
158+ , settingsFileInfoCacheDuration = 0
100159 , settingsBeforeMainLoop = return ()
101160 , settingsFork = void . forkIOWithUnmask
102161 , settingsNoParsePath = False
103162 , settingsInstallShutdownHandler = const $ return ()
104− , settingsServerName = S8.pack $ "Warp/" ++ showVersion Paths_warp.version
163+ , settingsServerName = C8.pack $ "Warp/" ++ showVersion Paths_warp.version
105164 , settingsMaximumBodyFlush = Just 8192
165+ , settingsProxyProtocol = ProxyProtocolNone
166+ , settingsSlowlorisSize = 2048
167+ , settingsHTTP2Enabled = True
168+ , settingsLogger = \_ _ _ -> return ()
169+ , settingsServerPushLogger = \_ _ _ -> return ()
170+ , settingsGracefulShutdownTimeout = Nothing
171+ , settingsGracefulCloseTimeout1 = 0
172+ , settingsGracefulCloseTimeout2 = 2000
173+ , settingsMaxTotalHeaderLength = 50 * 1024
106174 }
107175
108−-- | Apply the logic provided by 'defaultExceptionHandler' to determine if an
176+-- | Apply the logic provided by 'defaultOnException' to determine if an
109177-- exception should be shown or not. The goal is to hide exceptions which occur
110178-- under the normal course of the web server running.
111179--
@@ -119,26 +187,45 @@ defaultShouldDisplayException se
119187 | Just TimeoutThread <- fromException se = False
120188 | otherwise = True
121189
122−defaultExceptionHandler :: Maybe Request -> SomeException -> IO ()
123−defaultExceptionHandler _ e =
190+-- | Printing an exception to standard error
191+-- if `defaultShouldDisplayException` returns `True`.
192+--
193+-- Since: 3.1.0
194+defaultOnException :: Maybe Request -> SomeException -> IO ()
195+defaultOnException _ e =
124196 when (defaultShouldDisplayException e)
125197 $ TIO.hPutStrLn stderr $ T.pack $ show e
126198
127−defaultExceptionResponse :: SomeException -> Response
128−defaultExceptionResponse _ = responseLBS H.internalServerError500 [(H.hContentType, "text/plain; charset=utf-8")] "Something went wrong"
199+-- | Sending 400 for bad requests.
200+-- Sending 500 for internal server errors.
201+-- Since: 3.1.0
202+-- Sending 413 for too large payload.
203+-- Sending 431 for too large headers.
204+-- Since 3.2.27
205+defaultOnExceptionResponse :: SomeException -> Response
206+defaultOnExceptionResponse e
207+ | Just (_ :: InvalidRequest) <-
208+ fromException e = responseLBS H.badRequest400
209+ [(H.hContentType, "text/plain; charset=utf-8")]
210+ "Bad Request"
211+ | Just (ConnectionError (UnknownErrorCode 413) t) <-
212+ fromException e = responseLBS H.status413
213+ [(H.hContentType, "text/plain; charset=utf-8")]
214+ (fromStrict t)
215+ | Just (ConnectionError (UnknownErrorCode 431) t) <-
216+ fromException e = responseLBS H.status431
217+ [(H.hContentType, "text/plain; charset=utf-8")]
218+ (fromStrict t)
219+ | otherwise = responseLBS H.internalServerError500
220+ [(H.hContentType, "text/plain; charset=utf-8")]
221+ "Something went wrong"
129222
130−-- | Default implementation of 'settingsOnExceptionResponse' for the debugging purpose. 500, text/plain, a showed exception.
223+-- | Exception handler for the debugging purpose.
224+-- 500, text/plain, a showed exception.
225+--
226+-- Since: 2.0.3.2
131227exceptionResponseForDebug :: SomeException -> Response
132−exceptionResponseForDebug e = responseLBS H.internalServerError500 [(H.hContentType, "text/plain; charset=utf-8")] (TLE.encodeUtf8 $ TL.pack $ "Exception: " ++ show e)
133−
134−{-# DEPRECATED settingsPort "Use setPort instead" #-}
135−{-# DEPRECATED settingsHost "Use setHost instead" #-}
136−{-# DEPRECATED settingsOnException "Use setOnException instead" #-}
137−{-# DEPRECATED settingsOnExceptionResponse "Use setOnExceptionResponse instead" #-}
138−{-# DEPRECATED settingsOnOpen "Use setOnOpen instead" #-}
139−{-# DEPRECATED settingsOnClose "Use setOnClose instead" #-}
140−{-# DEPRECATED settingsTimeout "Use setTimeout instead" #-}
141−{-# DEPRECATED settingsManager "Use setManager instead" #-}
142−{-# DEPRECATED settingsFdCacheDuration "Use setFdCacheDuration instead" #-}
143−{-# DEPRECATED settingsBeforeMainLoop "Use setBeforeMainLoop instead" #-}
144−{-# DEPRECATED settingsNoParsePath "Use setNoParsePath instead" #-}
228+exceptionResponseForDebug e =
229+ responseBuilder H.internalServerError500
230+ [(H.hContentType, "text/plain; charset=utf-8")]
231+ $ byteString . C8.pack $ "Exception: " ++ show e
warp/Network/Wai/Handler/Warp/Types.hs+106−38
@@ -5,16 +5,18 @@
55module Network.Wai.Handler.Warp.Types where
66
77import Control.Exception
8−import Data.ByteString (ByteString)
8+import qualified Data.ByteString as S
9+import Data.IORef (IORef, readIORef, writeIORef, newIORef)
910import Data.Typeable (Typeable)
10−import Network.HTTP.Types.Header
11−import Network.Socket (Socket)
11+import Data.X509
12+import Foreign.Ptr (Ptr)
13+import System.Posix.Types (Fd)
14+import qualified System.TimeManager as T
15+
1216import qualified Network.Wai.Handler.Warp.Date as D
1317import qualified Network.Wai.Handler.Warp.FdCache as F
14−import qualified Network.Wai.Handler.Warp.Timeout as T
15−import Network.Wai.Handler.Warp.Buffer (Buffer,BufSize)
16−import qualified Data.ByteString as S
17−import Data.IORef (IORef, readIORef, writeIORef, newIORef)
18+import qualified Network.Wai.Handler.Warp.FileInfoCache as I
19+import Network.Wai.Handler.Warp.Imports
1820
1921----------------------------------------------------------------
2022
@@ -26,18 +28,6 @@ type Port = Int
2628-- | The type for header value used with 'HeaderName'.
2729type HeaderValue = ByteString
2830
29−hTransferEncoding :: HeaderName
30−hTransferEncoding = "Transfer-Encoding"
31−
32−hContentRange :: HeaderName
33−hContentRange = "Content-Range"
34−
35−hAcceptRanges :: HeaderName
36−hAcceptRanges = "Accept-Ranges"
37−
38−hServer :: HeaderName
39−hServer = "Server"
40−
4131----------------------------------------------------------------
4232
4333-- | Error types for bad 'Request'.
@@ -47,6 +37,7 @@ data InvalidRequest = NotEnoughLines [String]
4737 | IncompleteHeaders
4838 | ConnectionClosedByPeer
4939 | OverLargeHeader
40+ | BadProxyHeader String
5041 deriving (Eq, Typeable)
5142
5243instance Show InvalidRequest where
@@ -56,43 +47,104 @@ instance Show InvalidRequest where
5647 show IncompleteHeaders = "Warp: Request headers did not finish transmission"
5748 show ConnectionClosedByPeer = "Warp: Client closed connection prematurely"
5849 show OverLargeHeader = "Warp: Request headers too large, possible memory attack detected. Closing connection."
50+ show (BadProxyHeader s) = "Warp: Invalid PROXY protocol header: " ++ show s
5951
6052instance Exception InvalidRequest
6153
6254----------------------------------------------------------------
6355
64−-- | Whether or not 'ConnSendFileOverride' in 'Connection' can be
65−-- overridden. This is a kind of hack to keep the signature of
66−-- 'Connection' clean.
67−data ConnSendFileOverride = NotOverride -- ^ Don't override
68− | Override Socket -- ^ Override with this 'Socket'
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
6967
7068----------------------------------------------------------------
7169
70+-- | Data type to abstract file identifiers.
71+-- On Unix, a file descriptor would be specified to make use of
72+-- the file descriptor cache.
73+--
74+-- Since: 3.1.0
75+data FileId = FileId {
76+ fileIdPath :: FilePath
77+ , fileIdFd :: Maybe Fd
78+ }
79+
80+-- | fileid, offset, length, hook action, HTTP headers
81+--
82+-- Since: 3.1.0
83+type SendFile = FileId -> Integer -> Integer -> IO () -> [ByteString] -> IO ()
84+
85+-- | Type for read buffer pool
86+type BufferPool = IORef ByteString
87+
88+-- | Type for buffer
89+type Buffer = Ptr Word8
90+
91+-- | Type for buffer size
92+type BufSize = Int
93+
94+-- | Type for the action to receive input data
95+type Recv = IO ByteString
96+
97+-- | Type for the action to receive input data with a buffer.
98+-- The result boolean indicates whether or not the buffer is fully filled.
99+type RecvBuf = Buffer -> BufSize -> IO Bool
100+
72101-- | Data type to manipulate IO actions for connections.
73−data Connection = Connection
74− { connSendMany :: [ByteString] -> IO ()
75− , connSendAll :: ByteString -> IO ()
76− , connSendFile :: FilePath -> Integer -> Integer -> IO () -> [ByteString] -> IO () -- ^ filepath, offset, length, hook action, HTTP headers
77− , connClose :: IO ()
78− , connRecv :: IO ByteString
79− , connReadBuffer :: Buffer
80− , connWriteBuffer :: Buffer
81− , connBufferSize :: BufSize
82− , connSendFileOverride :: ConnSendFileOverride
102+-- This is used to abstract IO actions for plain HTTP and HTTP over TLS.
103+data Connection = Connection {
104+ -- | This is not used at this moment.
105+ connSendMany :: [ByteString] -> IO ()
106+ -- | The sending function.
107+ , connSendAll :: ByteString -> IO ()
108+ -- | The sending function for files in HTTP/1.1.
109+ , connSendFile :: SendFile
110+ -- | The connection closing function. Warp guarantees it will only be
111+ -- called once. Other functions (like 'connRecv') may be called after
112+ -- 'connClose' is called.
113+ , connClose :: IO ()
114+ -- | Free any buffers allocated. Warp guarantees it will only be
115+ -- called once, and no other functions will be called after it.
116+ , connFree :: IO ()
117+ -- | The connection receiving function. This returns "" for EOF.
118+ , connRecv :: Recv
119+ -- | The connection receiving function. This tries to fill the buffer.
120+ -- This returns when the buffer is filled or reaches EOF.
121+ , connRecvBuf :: RecvBuf
122+ -- | The write buffer.
123+ , connWriteBuffer :: Buffer
124+ -- | The size of the write buffer.
125+ , connBufferSize :: BufSize
126+ -- | Is this connection HTTP/2?
127+ , connHTTP2 :: IORef Bool
83128 }
84129
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+
85136----------------------------------------------------------------
86137
87−-- | Internal information.
88138data InternalInfo = InternalInfo {
89− threadHandle :: T.Handle
90− , fdCacher :: Maybe F.MutableFdCache
91− , 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
92143 }
93144
94145----------------------------------------------------------------
95146
147+-- | Type for input streaming.
96148data Source = Source !(IORef ByteString) !(IO ByteString)
97149
98150mkSource :: IO ByteString -> IO Source
@@ -118,3 +170,19 @@ leftoverSource (Source ref _) bs = writeIORef ref bs
118170
119171readLeftoverSource :: Source -> IO ByteString
120172readLeftoverSource (Source ref _) = readIORef ref
173+
174+----------------------------------------------------------------
175+
176+-- | What kind of transport is used for this connection?
177+data Transport = TCP -- ^ Plain channel: TCP
178+ | TLS {
179+ tlsMajorVersion :: Int
180+ , tlsMinorVersion :: Int
181+ , tlsNegotiatedProtocol :: Maybe ByteString -- ^ The result of Application Layer Protocol Negociation in RFC 7301
182+ , tlsChiperID :: Word16
183+ , tlsClientCertificate :: Maybe CertificateChain
184+ } -- ^ Encrypted channel: TLS or SSL
185+
186+isTransportSecure :: Transport -> Bool
187+isTransportSecure TCP = False
188+isTransportSecure _ = True
warp/Network/Wai/Handler/Warp/Windows.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/README.md+3−2
@@ -1,2 +1,3 @@
1−The premier WAI handler. For more information, see [Warp: A Haskell Web
2−Server](http://steve.vinoski.net/blog/2011/05/01/warp-a-haskell-web-server/).
1+# Warp
2+
3+Warp is a server library for HTTP/1.x and HTTP/2 based WAI(Web Application Interface in Haskell). For more information, see [Warp](http://www.aosabook.org/en/posa/warp.html).
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/BufferPoolSpec.hsnew file+47
@@ -0,0 +1,47 @@
1+module BufferPoolSpec where
2+
3+import qualified Data.ByteString as B
4+import qualified Data.ByteString.Internal as B (ByteString(PS))
5+import Foreign.ForeignPtr (withForeignPtr)
6+import Foreign.Marshal.Utils (copyBytes)
7+import Foreign.Ptr (plusPtr)
8+
9+import Test.Hspec (Spec, hspec, shouldBe, describe, it)
10+
11+import Network.Wai.Handler.Warp.Buffer
12+ ( bufferSize
13+ , newBufferPool
14+ , withBufferPool
15+ )
16+import Network.Wai.Handler.Warp.Types (Buffer, BufSize)
17+
18+main :: IO ()
19+main = hspec spec
20+
21+-- Two ByteStrings each big enough to fill a 'bufferSize' buffer (16K).
22+wantData, otherData :: B.ByteString
23+wantData = B.replicate bufferSize 0xac
24+otherData = B.replicate bufferSize 0x77
25+
26+spec :: Spec
27+spec = describe "withBufferPool" $ do
28+ it "does not clobber buffers" $ do
29+ pool <- newBufferPool
30+ -- 'pool' contains B.empty; prime it to contain a real buffer.
31+ _ <- withBufferPool pool $ const $ return 0
32+ -- 'pool' contains a 16K buffer; fill it with \xac and keep the result.
33+ got <- withBufferPool pool $ blitBuffer wantData
34+ got `shouldBe` wantData
35+ -- 'pool' should now be empty and reallocate, rather than clobber the
36+ -- previous buffer.
37+ _ <- withBufferPool pool $ blitBuffer otherData
38+ got `shouldBe` wantData
39+
40+-- Fill the Buffer with the contents of the ByteString and return the number of
41+-- bytes written. To be used with 'withBufferPool'.
42+blitBuffer :: B.ByteString -> (Buffer, BufSize) -> IO Int
43+blitBuffer (B.PS fp off len) (dst, len') = withForeignPtr fp $ \ptr -> do
44+ let src = ptr `plusPtr` off
45+ n = min len len'
46+ copyBytes dst src n
47+ return n
warp/test/ExceptionSpec.hs+18−31
@@ -1,20 +1,22 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE OverloadedStrings, CPP #-}
22
33module ExceptionSpec (main, spec) where
44
5+#if __GLASGOW_HASKELL__ < 709
56import Control.Applicative
7+#endif
68import Control.Monad
7−import Network.HTTP
8−import Network.Stream
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)
18+
19+import HTTP
1820
1921main :: IO ()
2022main = hspec spec
@@ -22,7 +24,7 @@ main = hspec spec
2224withTestServer :: (Int -> IO a) -> IO a
2325withTestServer inner = bracket
2426 (N.bindRandomPortTCP "127.0.0.1")
25− (sClose . snd)
27+ (close . snd)
2628 $ \(prt, lsocket) -> do
2729 withAsync (runSettingsSocket defaultSettings lsocket testApp)
2830 $ \_ -> inner prt
@@ -47,33 +49,18 @@ spec :: Spec
4749spec = describe "responds even if there is an exception" $ do
4850 {- Disabling these tests. We can consider forcing evaluation in Warp.
4951 it "statusError" $ do
50− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/statusError"
51− sc `shouldBe` (5,0,0)
52+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/statusError"
53+ sc `shouldBe` internalServerError500
5254 it "headersError" $ do
53− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headersError"
54− sc `shouldBe` (5,0,0)
55+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headersError"
56+ sc `shouldBe` internalServerError500
5557 it "headerError" $ do
56− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headerError"
57− sc `shouldBe` (5,0,0)
58+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headerError"
59+ sc `shouldBe` internalServerError500
5860 it "bodyError" $ do
59− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/bodyError"
60− sc `shouldBe` (5,0,0)
61+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/bodyError"
62+ sc `shouldBe` internalServerError500
6163 -}
6264 it "ioException" $ withTestServer $ \prt -> do
63− sc <- rspCode <$> sendGET (concat $ ["http://127.0.0.1:", show prt, "/ioException"])
64− sc `shouldBe` (5,0,0)
65−
66−----------------------------------------------------------------
67−
68−sendGET :: String -> IO (Response String)
69−sendGET url = sendGETwH url []
70−
71−sendGETwH :: String -> [Header] -> IO (Response String)
72−sendGETwH url hdr = unResult $ simpleHTTP $ (getRequest url) { rqHeaders = hdr }
73−
74−unResult :: IO (Result (Response String)) -> IO (Response String)
75−unResult action = do
76− res <- action
77− case res of
78− Right rsp -> return rsp
79− Left _ -> error "Connection error"
65+ sc <- responseStatus <$> sendGET ("http://127.0.0.1:" ++ show prt ++ "/ioException")
66+ sc `shouldBe` internalServerError500
warp/test/FdCacheSpec.hs+3−3
@@ -3,7 +3,7 @@
33module FdCacheSpec where
44
55import Test.Hspec
6−#ifdef SENDFILEFD
6+#ifndef WINDOWS
77import Data.IORef
88import Network.Wai.Handler.Warp.FdCache
99import System.Posix.IO (fdRead)
@@ -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.hsnew file+41
@@ -0,0 +1,41 @@
1+module HTTP (
2+ sendGET
3+ , sendGETwH
4+ , sendHEAD
5+ , sendHEADwH
6+ , responseBody
7+ , responseStatus
8+ , responseHeaders
9+ , getHeaderValue
10+ , HeaderName
11+ ) where
12+
13+import Network.HTTP.Client
14+import Network.HTTP.Types
15+import Data.ByteString
16+import qualified Data.ByteString.Lazy as BL
17+
18+sendGET :: String -> IO (Response BL.ByteString)
19+sendGET url = sendGETwH url []
20+
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
28+
29+sendHEAD :: String -> IO (Response BL.ByteString)
30+sendHEAD url = sendHEADwH url []
31+
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
39+
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+51−68
@@ -1,17 +1,16 @@
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
1212import Network.Wai.Handler.Warp.Response
13−import RunSpec (withApp)
14−import System.IO (hClose, hFlush)
13+import RunSpec (withApp, msWrite, msRead, withMySocket)
1514import Test.Hspec
1615
1716main :: IO ()
@@ -19,21 +18,18 @@ main = hspec spec
1918
2019testRange :: S.ByteString -- ^ range value
2120 -> String -- ^ expected output
22− -> String -- ^ expected content-range value
21+ -> Maybe String -- ^ expected content-range value
2322 -> Spec
24−testRange range out crange = it title $ withApp defaultSettings app $ \port -> do
25− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
26− S.hPutStr handle "GET / HTTP/1.0\r\n"
27− S.hPutStr handle "Range: bytes="
28− S.hPutStr handle range
29− S.hPutStr handle "\r\n\r\n"
30− 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"
3128 threadDelay 10000
32− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
33− hClose handle
34− out `shouldBe` last bss
29+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
30+ last bss `shouldBe` out
3531 let hs = mapMaybe toHeader bss
36− lookup "Content-Range" hs `shouldBe` Just ("bytes " ++ crange)
32+ lookup "Content-Range" hs `shouldBe` fmap ("bytes " ++) crange
3733 lookup "Content-Length" hs `shouldBe` Just (show $ length $ last bss)
3834 where
3935 app _ = ($ responseFile status200 [] "attic/hex" Nothing)
@@ -48,13 +44,10 @@ testPartial :: Integer -- ^ file size
4844 -> Integer -- ^ byte count
4945 -> String -- ^ expected output
5046 -> Spec
51−testPartial size offset count out = it title $ withApp defaultSettings app $ \port -> do
52− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
53− S.hPutStr handle "GET / HTTP/1.0\r\n\r\n"
54− 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"
5549 threadDelay 10000
56− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
57− hClose handle
50+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
5851 out `shouldBe` last bss
5952 let hs = mapMaybe toHeader bss
6053 lookup "Content-Length" hs `shouldBe` Just (show $ length $ last bss)
@@ -68,57 +61,47 @@ testPartial size offset count out = it title $ withApp defaultSettings app $ \po
6861 _ -> Nothing
6962 range = "bytes " ++ show offset ++ "-" ++ show (offset + count - 1) ++ "/" ++ show size
7063
71−testFileRange :: String
72− -> Status -> ResponseHeaders -> FilePath
73− -> Maybe FilePart -> Maybe HeaderValue
74− -> Either String (Status, ResponseHeaders, Integer, Integer)
75− -> Spec
76−testFileRange desc s rsphdr file mPart mRange ans = it desc $ do
77− eres <- fileRange s rsphdr file mPart mRange
78− let res = case eres of
79− Left e -> Left $ show e
80− Right r -> Right r
81− res `shouldBe` ans
82−
8364spec :: Spec
8465spec = do
66+{- http-client does not support this.
67+ describe "preventing response splitting attack" $ do
68+ it "sanitizes header values" $ do
69+ let app _ respond = respond $ responseLBS status200 [("foo", "foo\r\nbar")] "Hello"
70+ withApp defaultSettings app $ \port -> do
71+ res <- sendGET $ "http://127.0.0.1:" ++ show port
72+ getHeaderValue "foo" (responseHeaders res) `shouldBe`
73+ Just "foo bar" -- HTTP inserts two spaces for \r\n.
74+-}
75+
76+ describe "sanitizeHeaderValue" $ do
77+ it "doesn't alter valid multiline header values" $ do
78+ sanitizeHeaderValue "foo\r\n bar" `shouldBe` "foo\r\n bar"
79+
80+ it "adds missing spaces after \r\n" $ do
81+ sanitizeHeaderValue "foo\r\nbar" `shouldBe` "foo\r\n bar"
82+
83+ it "discards empty lines" $ do
84+ sanitizeHeaderValue "foo\r\n\r\nbar" `shouldBe` "foo\r\n bar"
85+
86+ context "when sanitizing single occurrences of \n" $ do
87+ it "replaces \n with \r\n" $ do
88+ sanitizeHeaderValue "foo\n bar" `shouldBe` "foo\r\n bar"
89+
90+ it "adds missing spaces after \n" $ do
91+ sanitizeHeaderValue "foo\nbar" `shouldBe` "foo\r\n bar"
92+
93+ it "discards single occurrences of \r" $ do
94+ sanitizeHeaderValue "foo\rbar" `shouldBe` "foobar"
95+
8596 describe "range requests" $ do
86− testRange "2-3" "23" "2-3/16"
87− testRange "5-" "56789abcdef" "5-15/16"
88− testRange "5-8" "5678" "5-8/16"
89− testRange "-3" "def" "13-15/16"
97+ testRange "2-3" "23" $ Just "2-3/16"
98+ testRange "5-" "56789abcdef" $ Just "5-15/16"
99+ testRange "5-8" "5678" $ Just "5-8/16"
100+ testRange "-3" "def" $ Just "13-15/16"
101+ testRange "16-" "" $ Just "*/16"
102+ testRange "-17" "0123456789abcdef" Nothing
90103
91104 describe "partial files" $ do
92105 testPartial 16 2 2 "23"
93106 testPartial 16 0 2 "01"
94107 testPartial 16 3 8 "3456789a"
95−
96− describe "fileRange" $ do
97− testFileRange
98− "gets a file size from file system"
99− status200 [] "attic/hex" Nothing Nothing
100− $ Right (status200,[("Content-Length","16")],0,16)
101− testFileRange
102− "gets an error if a file does not exist"
103− status200 [] "attic/nonexist" Nothing Nothing
104− $ Left "attic/nonexist: getFileStatus: does not exist (No such file or directory)"
105− testFileRange
106− "changes status if FileParts is specified"
107− status200 [] "attic/hex" (Just (FilePart 2 10 16)) Nothing
108− $ Right (status206,[("Content-Range", "bytes 2-11/16"),("Content-Length","10")],2,10)
109− testFileRange
110− "does not change status and does not add Content-Range if FileParts means the entire"
111− status200 [] "attic/hex" (Just (FilePart 0 16 16)) Nothing
112− $ Right (status200,[("Content-Length","16")],0,16)
113− testFileRange
114− "gets a file size from file system and handles Range and returns Partical Content"
115− status200 [] "attic/hex" Nothing (Just "bytes=2-14")
116− $ Right (status206,[("Content-Range","bytes 2-14/16"),("Content-Length","13")],2,13)
117− testFileRange
118− "gets a file size from file system and handles Range and returns OK if Range means the entire"
119− status200 [] "attic/hex" Nothing (Just "bytes=0-15")
120− $ Right (status200,[("Content-Length","16")],0,16)
121− testFileRange
122− "igores Range if FilePart is specified"
123− status200 [] "attic/hex" (Just (FilePart 2 10 16)) (Just "bytes=8-9")
124− $ Right (status206,[("Content-Range", "bytes 2-11/16"),("Content-Length","10")],2,10)
warp/test/RunSpec.hs+169−95
@@ -1,33 +1,33 @@
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)
7+import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
8+import Control.Concurrent.STM
9+import qualified Control.Exception as E
10+import Control.Exception.Lifted (bracket, try, IOException, onException)
811import Control.Monad (forM_, replicateM_, unless)
9−import System.Timeout (timeout)
1012import Control.Monad.IO.Class (MonadIO, liftIO)
11−import Data.ByteString (ByteString, hPutStr, hGetSome)
12−import qualified Control.Exception as E
13+import Data.ByteString (ByteString)
1314import qualified Data.ByteString as S
15+import Data.ByteString.Builder (byteString)
1416import qualified Data.ByteString.Char8 as S8
1517import qualified Data.ByteString.Lazy as L
1618import qualified Data.IORef as I
17−import Network (connectTo, PortID (PortNumber))
19+import Data.Streaming.Network (bindPortTCP, getSocketTCP, safeRecv)
1820import Network.HTTP.Types
19−import Network.Wai
21+import Network.Socket
22+import Network.Socket.ByteString (sendAll)
23+import Network.Wai hiding (responseHeaders)
24+import Network.Wai.Internal (getRequestBodyChunk)
2025import Network.Wai.Handler.Warp
21−import System.IO (hFlush, hClose)
2226import System.IO.Unsafe (unsafePerformIO)
27+import System.Timeout (timeout)
2328import Test.Hspec
24−import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
25−import Control.Exception.Lifted (bracket, try, IOException, onException)
26−import Data.Streaming.Network (bindPortTCP, getSocketTCP, safeRecv)
27−import Network.Socket (sClose)
28−import qualified Network.HTTP as HTTP
29−import Blaze.ByteString.Builder (fromByteString)
30−import Network.Socket.ByteString (sendAll)
29+
30+import HTTP
3131
3232main :: IO ()
3333main = hspec spec
@@ -35,6 +35,52 @@ main = hspec spec
3535type Counter = I.IORef (Either String Int)
3636type CounterApplication = Counter -> Application
3737
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+
3884incr :: MonadIO m => Counter -> m ()
3985incr icount = liftIO $ I.atomicModifyIORef icount $ \ecount ->
4086 ((case ecount of
@@ -46,7 +92,7 @@ err icount msg = liftIO $ I.writeIORef icount $ Left $ show msg
4692
4793readBody :: CounterApplication
4894readBody icount req f = do
49− body <- consumeBody $ requestBody req
95+ body <- consumeBody $ getRequestBodyChunk req
5096 case () of
5197 ()
5298 | pathInfo req == ["hello"] && L.fromChunks body /= "Hello"
@@ -67,8 +113,8 @@ ignoreBody icount req f = do
67113
68114doubleConnect :: CounterApplication
69115doubleConnect icount req f = do
70− _ <- consumeBody $ requestBody req
71− _ <- consumeBody $ requestBody req
116+ _ <- consumeBody $ getRequestBodyChunk req
117+ _ <- consumeBody $ getRequestBodyChunk req
72118 incr icount
73119 f $ responseLBS status200 [] "double connect"
74120
@@ -82,8 +128,8 @@ getPort = do
82128 esocket <- try $ bindPortTCP port "127.0.0.1"
83129 case esocket of
84130 Left (_ :: IOException) -> RunSpec.getPort
85− Right socket -> do
86− sClose socket
131+ Right sock -> do
132+ close sock
87133 return port
88134
89135withApp :: Settings -> Application -> (Int -> IO a) -> IO a
@@ -97,7 +143,13 @@ withApp settings app f = do
97143 bracket
98144 (forkIO $ runSettings settings' app `onException` putMVar baton ())
99145 killThread
100− (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)
101153
102154runTest :: Int -- ^ expected number of requests
103155 -> CounterApplication
@@ -105,10 +157,9 @@ runTest :: Int -- ^ expected number of requests
105157 -> IO ()
106158runTest expected app chunks = do
107159 ref <- I.newIORef (Right 0)
108− withApp defaultSettings (app ref) $ \port -> do
109− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
110− forM_ chunks $ \chunk -> hPutStr handle chunk >> hFlush handle
111− _ <- 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
112163 res <- I.readIORef ref
113164 case res of
114165 Left s -> error s
@@ -123,11 +174,9 @@ runTerminateTest :: InvalidRequest
123174runTerminateTest expected input = do
124175 ref <- I.newIORef Nothing
125176 let onExc _ = I.writeIORef ref . Just
126− withApp (setOnException onExc defaultSettings) dummyApp $ \port -> do
127− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
128− hPutStr handle input
129− hFlush handle
130− hClose handle
177+ withApp (setOnException onExc defaultSettings) dummyApp $ withMySocket $ \ms -> do
178+ msWrite ms input
179+ msClose ms -- explicitly
131180 threadDelay 1000
132181 res <- I.readIORef ref
133182 show res `shouldBe` show (Just expected)
@@ -198,14 +247,11 @@ spec = do
198247 let app req f = do
199248 liftIO $ I.writeIORef iheaders $ requestHeaders req
200249 f $ responseLBS status200 [] ""
201− withApp defaultSettings app $ \port -> do
202− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
250+ withApp defaultSettings app $ withMySocket $ \ms -> do
203251 let input = S.concat
204252 [ "GET / HTTP/1.1\r\nfoo: bar\r\n baz\r\n\tbin\r\n\r\n"
205253 ]
206− hPutStr handle input
207− hFlush handle
208− hClose handle
254+ msWrite ms input
209255 threadDelay 1000
210256 headers <- I.readIORef iheaders
211257 headers `shouldBe`
@@ -216,14 +262,11 @@ spec = do
216262 let app req f = do
217263 liftIO $ I.writeIORef iheaders $ requestHeaders req
218264 f $ responseLBS status200 [] ""
219− withApp defaultSettings app $ \port -> do
220− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
265+ withApp defaultSettings app $ withMySocket $ \ms -> do
221266 let input = S.concat
222267 [ "GET / HTTP/1.1\r\nfoo:bar\r\n\r\n"
223268 ]
224− hPutStr handle input
225− hFlush handle
226− hClose handle
269+ msWrite ms input
227270 threadDelay 1000
228271 headers <- I.readIORef iheaders
229272 headers `shouldBe`
@@ -232,23 +275,24 @@ spec = do
232275
233276 describe "chunked bodies" $ do
234277 it "works" $ do
278+ countVar <- newTVarIO (0 :: Int)
235279 ifront <- I.newIORef id
236280 let app req f = do
237− bss <- consumeBody $ requestBody req
281+ bss <- consumeBody $ getRequestBodyChunk req
238282 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
283+ atomically $ modifyTVar countVar (+ 1)
239284 f $ responseLBS status200 [] ""
240− withApp defaultSettings app $ \port -> do
241− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
285+ withApp defaultSettings app $ withMySocket $ \ms -> do
242286 let input = S.concat
243287 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
244288 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n\r\n"
245289 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
246290 , "b\r\nHello World\r\n0\r\n\r\n"
247291 ]
248− hPutStr handle input
249− hFlush handle
250− hClose handle
251− threadDelay 1000
292+ msWrite ms input
293+ atomically $ do
294+ count <- readTVar countVar
295+ check $ count == 2
252296 front <- I.readIORef ifront
253297 front [] `shouldBe`
254298 [ "Hello World\nBye"
@@ -256,38 +300,44 @@ spec = do
256300 ]
257301 it "lots of chunks" $ do
258302 ifront <- I.newIORef id
303+ countVar <- newTVarIO (0 :: Int)
259304 let app req f = do
260− bss <- consumeBody $ requestBody req
305+ bss <- consumeBody $ getRequestBodyChunk req
261306 I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
307+ atomically $ modifyTVar countVar (+ 1)
262308 f $ responseLBS status200 [] ""
263− withApp defaultSettings app $ \port -> do
264− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
309+ withApp defaultSettings app $ withMySocket $ \ms -> do
265310 let input = concat $ replicate 2 $
266311 ["POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"] ++
267312 (replicate 50 "5\r\n12345\r\n") ++
268313 ["0\r\n\r\n"]
269− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) input
270− hClose handle
271− 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
272318 front <- I.readIORef ifront
273319 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.
274322 it "in chunks" $ do
275323 ifront <- I.newIORef id
324+ countVar <- newTVarIO (0 :: Int)
276325 let app req f = do
277− bss <- consumeBody $ requestBody req
326+ bss <- consumeBody $ getRequestBodyChunk req
278327 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
328+ atomically $ modifyTVar countVar (+ 1)
279329 f $ responseLBS status200 [] ""
280− withApp defaultSettings app $ \port -> do
281− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
330+ withApp defaultSettings app $ withMySocket $ \ms -> do
282331 let input = S.concat
283332 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
284333 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n"
285334 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
286335 , "b\r\nHello World\r\n0\r\n\r\n"
287336 ]
288− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) $ map S.singleton $ S.unpack input
289− hClose handle
290− threadDelay 1000
337+ mapM_ (msWrite ms) $ map S.singleton $ S.unpack input
338+ atomically $ do
339+ count <- readTVar countVar
340+ check $ count == 2
291341 front <- I.readIORef ifront
292342 front [] `shouldBe`
293343 [ "Hello World\nBye"
@@ -296,7 +346,7 @@ spec = do
296346 it "timeout in request body" $ do
297347 ifront <- I.newIORef id
298348 let app req f = do
299− bss <- (consumeBody $ requestBody req) `onException`
349+ bss <- (consumeBody $ getRequestBodyChunk req) `onException`
300350 liftIO (I.atomicModifyIORef ifront (\front -> (front . ("consume interrupted":), ())))
301351 liftIO $ threadDelay 4000000 `E.catch` \e -> do
302352 I.atomicModifyIORef ifront (\front ->
@@ -305,20 +355,18 @@ spec = do
305355 E.throwIO (e :: E.SomeException)
306356 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
307357 f $ responseLBS status200 [] ""
308− withApp (setTimeout 1 defaultSettings) app $ \port -> do
358+ withApp (setTimeout 1 defaultSettings) app $ withMySocket $ \ms -> do
309359 let bs1 = S.replicate 2048 88
310360 bs2 = "This is short"
311361 bs = S.append bs1 bs2
312− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
313− hPutStr handle "POST / HTTP/1.1\r\n"
314− hPutStr handle "content-length: "
315− hPutStr handle $ S8.pack $ show $ S.length bs
316− 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"
317366 threadDelay 100000
318− hPutStr handle bs1
367+ msWrite ms bs1
319368 threadDelay 100000
320− hPutStr handle bs2
321− hClose handle
369+ msWrite ms bs2
322370 threadDelay 5000000
323371 front <- I.readIORef ifront
324372 S.concat (front []) `shouldBe` bs
@@ -334,49 +382,75 @@ spec = do
334382 loop
335383 loop
336384 doubleBS = S.concatMap $ \w -> S.pack [w, w]
337− withApp defaultSettings app $ \port -> do
338− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
339− hPutStr handle "POST / HTTP/1.1\r\n\r\n12345"
340− hFlush handle
341− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "1122334455")
342− hPutStr handle "67890"
343− hFlush handle
344− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "6677889900")
345−
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")
346390 it "only one date and server header" $ do
347391 let app _ f = f $ responseLBS status200
348392 [ ("server", "server")
349393 , ("date", "date")
350394 ] ""
395+ getValues key = map snd
396+ . filter (\(key', _) -> key == key')
397+ . responseHeaders
351398 withApp defaultSettings app $ \port -> do
352− Right res <- HTTP.simpleHTTP (HTTP.getRequest $ "http://127.0.0.1:" ++ show port)
353− map HTTP.hdrValue (HTTP.retrieveHeaders HTTP.HdrServer res)
354− `shouldBe` ["server"]
355− map HTTP.hdrValue (HTTP.retrieveHeaders HTTP.HdrDate res)
356− `shouldBe` ["date"]
399+ res <- sendGET $ "http://127.0.0.1:" ++ show port
400+ getValues hServer res `shouldBe` ["server"]
401+ getValues hDate res `shouldBe` ["date"]
357402
358403 it "streaming echo #249" $ do
404+ countVar <- newTVarIO (0 :: Int)
359405 let app req f = f $ responseStream status200 [] $ \write _ -> do
360− let loop = do
361− bs <- requestBody req
406+ let loop = do
407+ bs <- getRequestBodyChunk req
362408 unless (S.null bs) $ do
363− write $ fromByteString bs
409+ write $ byteString bs
410+ atomically $ modifyTVar countVar (+ 1)
364411 loop
365− loop
366− withApp defaultSettings app $ \port -> do
367− (socket, _addr) <- getSocketTCP "127.0.0.1" port
368− 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"
369415 threadDelay 10000
370− sendAll socket "5\r\nhello\r\n0\r\n\r\n"
371− 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
372421 S.takeWhile (/= 13) bs `shouldBe` "HTTP/1.1 200 OK"
373422
374423 it "streaming response with length" $ do
375424 let app _ f = f $ responseStream status200 [("content-length", "20")] $ \write _ -> do
376− replicateM_ 4 $ write $ fromByteString "Hello"
425+ replicateM_ 4 $ write $ byteString "Hello"
377426 withApp defaultSettings app $ \port -> do
378− Right res <- HTTP.simpleHTTP (HTTP.getRequest $ "http://127.0.0.1:" ++ show port)
379− HTTP.rspBody res `shouldBe` "HelloHelloHelloHello"
427+ res <- sendGET $ "http://127.0.0.1:" ++ show port
428+ responseBody res `shouldBe` "HelloHelloHelloHello"
429+
430+ describe "head requests" $ do
431+ let fp = "test/head-response"
432+ let app req f =
433+ f $ case pathInfo req of
434+ ["builder"] -> responseBuilder status200 [] $ error "should never be evaluated"
435+ ["streaming"] -> responseStream status200 [] $ \write _ ->
436+ write $ error "should never be evaluated"
437+ ["file"] -> responseFile status200 [] fp Nothing
438+ _ -> error "invalid path"
439+ it "builder" $ withApp defaultSettings app $ \port -> do
440+ res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/builder"]
441+ responseBody res `shouldBe` ""
442+ it "streaming" $ withApp defaultSettings app $ \port -> do
443+ res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/streaming"]
444+ responseBody res `shouldBe` ""
445+ it "file, no range" $ withApp defaultSettings app $ \port -> do
446+ bs <- S.readFile fp
447+ res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/file"]
448+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just (S8.pack $ show $ S.length bs)
449+ it "file, with range" $ withApp defaultSettings app $ \port -> do
450+ res <- sendHEADwH
451+ (concat ["http://127.0.0.1:", show port, "/file"])
452+ [(hRange, "bytes=0-1")]
453+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just "2"
380454
381455consumeBody :: IO ByteString -> IO [ByteString]
382456consumeBody body =
warp/test/SendFileSpec.hsnew file+116
@@ -0,0 +1,116 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module SendFileSpec where
4+
5+import Control.Exception
6+import Control.Monad (when)
7+import Data.ByteString (ByteString)
8+import qualified Data.ByteString as BS
9+import Network.Wai.Handler.Warp.Buffer
10+import Network.Wai.Handler.Warp.SendFile
11+import Network.Wai.Handler.Warp.Types
12+import System.Directory
13+import System.Exit
14+import qualified System.IO as IO
15+import System.Process (system)
16+import Test.Hspec
17+
18+main :: IO ()
19+main = hspec spec
20+
21+spec :: Spec
22+spec = do
23+ describe "packHeader" $ do
24+ it "returns how much the buffer is consumed (1)" $
25+ tryPackHeader 10 ["foo"] `shouldReturn` 3
26+ it "returns how much the buffer is consumed (2)" $
27+ tryPackHeader 10 ["foo", "bar"] `shouldReturn` 6
28+ it "returns how much the buffer is consumed (3)" $
29+ tryPackHeader 10 ["0123456789"] `shouldReturn` 0
30+ it "returns how much the buffer is consumed (4)" $
31+ tryPackHeader 10 ["01234", "56789"] `shouldReturn` 0
32+ it "returns how much the buffer is consumed (5)" $
33+ tryPackHeader 10 ["01234567890", "12"] `shouldReturn` 3
34+ it "returns how much the buffer is consumed (6)" $
35+ tryPackHeader 10 ["012345678901234567890123456789012", "34"] `shouldReturn` 5
36+
37+ it "sends headers correctly (1)" $
38+ tryPackHeader2 10 ["foo"] "" `shouldReturn` True
39+ it "sends headers correctly (2)" $
40+ tryPackHeader2 10 ["foo", "bar"] "" `shouldReturn` True
41+ it "sends headers correctly (3)" $
42+ tryPackHeader2 10 ["0123456789"] "0123456789" `shouldReturn` True
43+ it "sends headers correctly (4)" $
44+ tryPackHeader2 10 ["01234", "56789"] "0123456789" `shouldReturn` True
45+ it "sends headers correctly (5)" $
46+ tryPackHeader2 10 ["01234567890", "12"] "0123456789" `shouldReturn` True
47+ it "sends headers correctly (6)" $
48+ tryPackHeader2 10 ["012345678901234567890123456789012", "34"] "012345678901234567890123456789" `shouldReturn` True
49+
50+ describe "readSendFile" $ do
51+ it "sends a file correctly (1)" $
52+ tryReadSendFile 10 0 1474 ["foo"] `shouldReturn` ExitSuccess
53+ it "sends a file correctly (2)" $
54+ tryReadSendFile 10 0 1474 ["012345678", "901234"] `shouldReturn` ExitSuccess
55+ it "sends a file correctly (3)" $
56+ tryReadSendFile 10 20 100 ["012345678", "901234"] `shouldReturn` ExitSuccess
57+
58+tryPackHeader :: Int -> [ByteString] -> IO Int
59+tryPackHeader siz hdrs = bracket (allocateBuffer siz) freeBuffer $ \buf ->
60+ packHeader buf siz send hook hdrs 0
61+ where
62+ send _ = return ()
63+ hook = return ()
64+
65+tryPackHeader2 :: Int -> [ByteString] -> ByteString -> IO Bool
66+tryPackHeader2 siz hdrs ans = bracket setup teardown $ \buf -> do
67+ _ <- packHeader buf siz send hook hdrs 0
68+ checkFile outputFile ans
69+ where
70+ setup = allocateBuffer siz
71+ teardown buf = freeBuffer buf >> removeFileIfExists outputFile
72+ outputFile = "tempfile"
73+ send = BS.appendFile outputFile
74+ hook = return ()
75+
76+tryReadSendFile :: Int -> Integer -> Integer -> [ByteString] -> IO ExitCode
77+tryReadSendFile siz off len hdrs = bracket setup teardown $ \buf -> do
78+ mapM_ (BS.appendFile expectedFile) hdrs
79+ copyfile inputFile expectedFile off len
80+ readSendFile buf siz send fid off len hook hdrs
81+ compareFiles expectedFile outputFile
82+ where
83+ hook = return ()
84+ setup = allocateBuffer siz
85+ teardown buf = do
86+ freeBuffer buf
87+ removeFileIfExists outputFile
88+ removeFileIfExists expectedFile
89+ inputFile = "test/inputFile"
90+ outputFile = "outputFile"
91+ expectedFile = "expectedFile"
92+ fid = FileId inputFile Nothing
93+ send = BS.appendFile outputFile
94+
95+checkFile :: FilePath -> ByteString -> IO Bool
96+checkFile path bs = do
97+ exist <- doesFileExist path
98+ if exist then do
99+ bs' <- BS.readFile path
100+ return $ bs == bs'
101+ else
102+ return $ bs == ""
103+
104+compareFiles :: FilePath -> FilePath -> IO ExitCode
105+compareFiles file1 file2 = system $ "cmp -s " ++ file1 ++ " " ++ file2
106+
107+copyfile :: FilePath -> FilePath -> Integer -> Integer -> IO ()
108+copyfile src dst off len =
109+ IO.withBinaryFile src IO.ReadMode $ \h -> do
110+ IO.hSeek h IO.AbsoluteSeek off
111+ BS.hGet h (fromIntegral len) >>= BS.appendFile dst
112+
113+removeFileIfExists :: FilePath -> IO ()
114+removeFileIfExists file = do
115+ exist <- doesFileExist file
116+ when exist $ removeFile file
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/test/doctests.hs+1−8
@@ -1,11 +1,4 @@
1−module Main where
2−
31import Test.DocTest
42
53main :: IO ()
6−main = doctest [
7− "-idist/build/autogen/"
8− , "-optP-include"
9− , "-optPdist/build/autogen/cabal_macros.h"
10− , "Network/Wai/Handler/Warp.hs"
11− ]
4+main = doctest ["Network"]
warp/test/head-responsenew file+1
@@ -0,0 +1 @@
1+This is the body
warp/test/inputFilenew file+100
@@ -0,0 +1,100 @@
1+A acid
2+abacus major
3+abacus pythagoricus
4+A battery
5+abbey counter
6+abbey laird
7+abbey lands
8+abbey lubber
9+abbot cloth
10+Abbott papyrus
11+abb wool
12+A-b-c book
13+A-b-c method
14+abdomino-uterotomy
15+Abdul-baha
16+a-be
17+aberrant duct
18+aberration constant
19+abiding place
20+able-bodied
21+able-bodiedness
22+able-minded
23+able-mindedness
24+able seaman
25+aboli fruit
26+A bond
27+Abor-miri
28+a-borning
29+about-face
30+about ship
31+about-sledge
32+above-cited
33+above-found
34+above-given
35+above-mentioned
36+above-named
37+above-quoted
38+above-reported
39+above-said
40+above-water
41+above-written
42+Abraham-man
43+abraum salts
44+abraxas stone
45+Abri audit culture
46+abruptly acuminate
47+abruptly pinnate
48+absciss layer
49+absence state
50+absentee voting
51+absent-minded
52+absent-mindedly
53+absent-mindedness
54+absent treatment
55+absent voter
56+Absent voting
57+absinthe green
58+absinthe oil
59+absorption bands
60+absorption circuit
61+absorption coefficient
62+absorption current
63+absorption dynamometer
64+absorption factor
65+absorption lines
66+absorption pipette
67+absorption screen
68+absorption spectrum
69+absorption system
70+A b station
71+abstinence theory
72+abstract group
73+Abt system
74+abundance declaree
75+aburachan seed
76+abutment arch
77+abutment pier
78+abutting joint
79+acacia veld
80+academy blue
81+academy board
82+academy figure
83+acajou balsam
84+acanthosis nigricans
85+acanthus family
86+acanthus leaf
87+acaroid resin
88+Acca larentia
89+acceleration note
90+accelerator nerve
91+accent mark
92+acceptance bill
93+acceptance house
94+acceptance supra protest
95+acceptor supra protest
96+accession book
97+accession number
98+accession service
99+access road
100+accident insurance
warp/warp.cabal+158−45
@@ -1,5 +1,5 @@
11Name: warp
2−Version: 3.0.4
2+Version: 3.3.9
33Synopsis: A fast, light-weight web server for WAI applications.
44License: MIT
55License-file: LICENSE
@@ -8,12 +8,18 @@ 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
13−Description: The premier WAI handler. For more information, see <http://steve.vinoski.net/blog/2011/05/01/warp-a-haskell-web-server/>.
13+description: HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported.
14+ For HTTP\/2, Warp supports direct and ALPN (in TLS)
15+ but not upgrade.
16+ API docs and the README are available at
17+ <http://www.stackage.org/package/warp>.
1418extra-source-files: attic/hex
1519 ChangeLog.md
1620 README.md
21+ test/head-response
22+ test/inputFile
1723
1824Flag network-bytestring
1925 Default: False
@@ -27,36 +33,57 @@ Flag warp-debug
2733 Default: False
2834
2935Library
30− Build-Depends: base >= 3 && < 5
36+ Build-Depends: base >= 4.8 && < 5
3137 , array
32− , auto-update >= 0.1.1 && < 0.2
33− , blaze-builder >= 0.3.3 && < 0.4
38+ , async
39+ , auto-update >= 0.1.3 && < 0.2
40+ , bsb-http-chunked < 0.1
3441 , bytestring >= 0.9.1.4
3542 , case-insensitive >= 0.2
43+ , containers
3644 , ghc-prim
37− , http-types >= 0.8.5
45+ , hashable
46+ , http-date
47+ , http-types >= 0.12
48+ , http2 >= 2.0 && < 2.1
49+ , iproute >= 1.3.1
3850 , simple-sendfile >= 0.2.7 && < 0.3
39− , unix-compat >= 0.2
40− , void
41− , wai >= 3.0 && < 3.1
51+ , stm >= 2.3
52+ , streaming-commons >= 0.1.10
4253 , text
43− , streaming-commons >= 0.1.2
54+ , time-manager
55+ , unix-compat >= 0.2
56+ , vault >= 0.3
57+ , wai >= 3.2 && < 3.3
58+ , word8
59+ , x509
60+ if impl(ghc < 8)
61+ Build-Depends: semigroups
4462 if flag(network-bytestring)
4563 Build-Depends: network >= 2.2.1.5 && < 2.2.3
4664 , network-bytestring >= 0.1.3 && < 0.1.4
4765 else
4866 Build-Depends: network >= 2.3
4967 Exposed-modules: Network.Wai.Handler.Warp
50− Network.Wai.Handler.Warp.Buffer
51− Network.Wai.Handler.Warp.Timeout
5268 Network.Wai.Handler.Warp.Internal
53− Other-modules: Network.Wai.Handler.Warp.Conduit
69+ Other-modules: Network.Wai.Handler.Warp.Buffer
70+ Network.Wai.Handler.Warp.Conduit
5471 Network.Wai.Handler.Warp.Counter
5572 Network.Wai.Handler.Warp.Date
5673 Network.Wai.Handler.Warp.FdCache
74+ Network.Wai.Handler.Warp.File
75+ Network.Wai.Handler.Warp.FileInfoCache
76+ Network.Wai.Handler.Warp.HashMap
77+ Network.Wai.Handler.Warp.HTTP2
78+ Network.Wai.Handler.Warp.HTTP2.File
79+ Network.Wai.Handler.Warp.HTTP2.PushPromise
80+ Network.Wai.Handler.Warp.HTTP2.Request
81+ Network.Wai.Handler.Warp.HTTP2.Response
82+ Network.Wai.Handler.Warp.HTTP2.Types
5783 Network.Wai.Handler.Warp.Header
5884 Network.Wai.Handler.Warp.IO
59− Network.Wai.Handler.Warp.IORef
85+ Network.Wai.Handler.Warp.Imports
86+ Network.Wai.Handler.Warp.PackInt
6087 Network.Wai.Handler.Warp.ReadInt
6188 Network.Wai.Handler.Warp.Recv
6289 Network.Wai.Handler.Warp.Request
@@ -68,6 +95,7 @@ Library
6895 Network.Wai.Handler.Warp.Settings
6996 Network.Wai.Handler.Warp.Types
7097 Network.Wai.Handler.Warp.Windows
98+ Network.Wai.Handler.Warp.WithApplication
7199 Paths_warp
72100 Ghc-Options: -Wall
73101
@@ -75,82 +103,167 @@ Library
75103 Cpp-Options: -DWARP_DEBUG
76104 if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
77105 Cpp-Options: -DSENDFILEFD
78− Build-Depends: hashable
79− Other-modules: Network.Wai.Handler.Warp.MultiMap
80106 if os(windows)
81107 Cpp-Options: -DWINDOWS
82108 Build-Depends: time
83− , old-locale
84109 else
85110 Build-Depends: unix
86− , http-date
111+ Other-modules: Network.Wai.Handler.Warp.MultiMap
112+ if impl(ghc >= 8)
113+ Default-Extensions: Strict StrictData
114+ Default-Language: Haskell2010
87115
88116Test-Suite doctest
117+ buildable: False
89118 Type: exitcode-stdio-1.0
90119 HS-Source-Dirs: test
91120 Ghc-Options: -threaded -Wall
92121 Main-Is: doctests.hs
93− Build-Depends: base
94− , doctest >= 0.9.3
122+ Build-Depends: base >= 4.8 && < 5
123+ , 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
95129
96130Test-Suite spec
97131 Main-Is: Spec.hs
98− Other-modules: ConduitSpec
132+ Other-modules: BufferPoolSpec
133+ ConduitSpec
99134 ExceptionSpec
100135 FdCacheSpec
101− MultiMapSpec
136+ FileSpec
102137 ReadIntSpec
103138 RequestSpec
104139 ResponseHeaderSpec
105140 ResponseSpec
106141 RunSpec
142+ SendFileSpec
143+ WithApplicationSpec
144+ 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+
107179 Hs-Source-Dirs: test, .
108180 Type: exitcode-stdio-1.0
109181
110− Ghc-Options: -Wall
111− Build-Depends: base >= 4 && < 5
182+ Ghc-Options: -Wall -threaded
183+ Build-Depends: base >= 4.8 && < 5
184+ , HUnit
185+ , QuickCheck
112186 , array
187+ , async
113188 , auto-update
114− , blaze-builder >= 0.3.3 && < 0.4
189+ , bsb-http-chunked < 0.1
115190 , bytestring >= 0.9.1.4
116191 , case-insensitive >= 0.2
192+ , containers
193+ , directory
117194 , ghc-prim
118− , HTTP
119− , http-types >= 0.8.4
195+ , hashable
196+ , hspec >= 1.3
197+ , http-client
198+ , http-date
199+ , http-types >= 0.12
200+ , http2 >= 2.0 && < 2.1
201+ , iproute >= 1.3.1
120202 , lifted-base >= 0.1
121− , simple-sendfile >= 0.2.4 && < 0.3
122− , transformers >= 0.2.2
123− , unix-compat >= 0.2
124− , void
125− , wai
126203 , network
127− , HUnit
128− , QuickCheck
129− , hspec >= 1.3
130− , time
131− , old-locale
204+ , process
205+ , simple-sendfile >= 0.2.4 && < 0.3
206+ , stm >= 2.3
207+ , streaming-commons >= 0.1.10
132208 , text
133− , streaming-commons >= 0.1.1
134− , async
209+ , time
210+ , time-manager
211+ , unix-compat >= 0.2
212+ , vault
213+ , wai >= 3.2 && < 3.3
214+ , word8
215+ , x509
216+ -- Build-Tool-Depends: hspec-discover:hspec-discover
217+ if impl(ghc < 8)
218+ Build-Depends: semigroups
219+ , transformers
135220
136221 if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
137222 Cpp-Options: -DSENDFILEFD
138223 Build-Depends: unix
139− , hashable
140− , http-date
141224 if os(windows)
142− 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
143230
144231Benchmark parser
145232 Type: exitcode-stdio-1.0
146233 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
147241 HS-Source-Dirs: bench .
148− Build-Depends: base
242+ Build-Depends: base >= 4.8 && < 5
243+ , auto-update
149244 , bytestring
150− , criterion
245+ , containers
246+ , gauge
247+ , hashable
248+ , http-date
151249 , http-types
152250 , network
153251 , 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
154267
155268Source-Repository head
156269 Type: git