on master help sign in
.azure/azure-linux-template.ymlnew file+93
since splitsnapshots
unifiedsplit
@@ -0,0 +1,93 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-11:
9+ BUILD: stack
10+ STACK_YAML: stack-lts-11.yaml
11+ ARGS: "--resolver lts-11"
12+ stack-lts-12:
13+ BUILD: stack
14+ STACK_YAML: stack-lts-12.yaml
15+ ARGS: "--resolver lts-12"
16+ stack-lts-14:
17+ BUILD: stack
18+ ARGS: "--resolver lts-14"
19+ stack-nightly:
20+ BUILD: stack
21+ STACK_YAML: stack-nightly.yaml
22+ ARGS: "--resolver nightly"
23+ cabal-8.2.2:
24+ BUILD: cabal
25+ GHCVER: 8.4.4
26+ CABALVER: 2.0
27+ cabal-8.4.4:
28+ BUILD: cabal
29+ GHCVER: 8.4.4
30+ CABALVER: 2.2
31+ cabal-8.6.5:
32+ BUILD: cabal
33+ GHCVER: 8.6.5
34+ CABALVER: 2.4
35+ maxParallel: 6
36+ steps:
37+ - script: |
38+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
39+ mkdir -p ~/.local/bin
40+ curl -L https://get.haskellstack.org/stable/linux-x86_64.tar.gz | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
41+ case "$BUILD" in
42+ cabal)
43+ sudo add-apt-repository -y ppa:hvr/ghc
44+ sudo apt-get update
45+ sudo apt-get install cabal-install-$CABALVER ghc-$GHCVER
46+ # See note here: https://github.com/haskell-CI/haskell-ci#alex--happy-with-ghc--78
47+ if [ "$GHCVER" = "head" ] || [ "${GHCVER%.*}" = "7.8" ] || [ "${GHCVER%.*}" = "7.10" ]; then
48+ sudo apt-get install happy-1.19.4 alex-3.1.3
49+ export PATH=/opt/alex/3.1.3/bin:/opt/happy/1.19.4/bin:$PATH
50+ else
51+ sudo apt-get install happy alex
52+ fi
53+ export PATH=$HOME/.local/bin:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$PATH
54+ cabal --version
55+ cabal update
56+ PACKAGES=$(stack --install-ghc query locals | grep '^ *path' | sed 's@^ *path:@@')
57+ cabal install --only-dependencies --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
58+ ;;
59+ *)
60+ export PATH=$HOME/.local/bin:$PATH
61+ stack --install-ghc $ARGS test --bench --only-dependencies
62+ ;;
63+ esac
64+ set -ex
65+ case "$BUILD" in
66+ cabal)
67+ cabal install --enable-tests --enable-benchmarks --force-reinstalls --ghc-options=-O0 --reorder-goals --max-backjumps=-1 $CABALARGS $PACKAGES
68+
69+ ORIGDIR=$(pwd)
70+ for dir in $PACKAGES
71+ do
72+ cd $dir
73+ cabal check || [ "$CABALVER" == "1.22" ] # https://github.com/yesodweb/wai/pull/754#issuecomment-504866279
74+ cabal sdist
75+ PKGVER=$(cabal info . | awk '{print $2;exit}')
76+ SRC_TGZ=$PKGVER.tar.gz
77+ cd dist
78+ tar zxfv "$SRC_TGZ"
79+ cd "$PKGVER"
80+ cabal configure --enable-tests --ghc-options -O0
81+ cabal build
82+ cabal test --show-details=streaming
83+ cd $ORIGDIR
84+ done
85+ ;;
86+ *)
87+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
88+ ;;
89+ esac
90+ set +ex
91+ env:
92+ OS_NAME: ${{ parameters.os }}
93+ displayName: 'Installation ${{parameters.os}} & Test'
.azure/azure-osx-template.ymlnew file+30
@@ -0,0 +1,30 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-11:
9+ BUILD: stack
10+ STACK_YAML: stack-lts-11.yaml
11+ ARGS: "--resolver lts-11"
12+ stack-lts-12:
13+ BUILD: stack
14+ STACK_YAML: stack-lts-12.yaml
15+ ARGS: "--resolver lts-12"
16+ stack-lts-14:
17+ BUILD: stack
18+ ARGS: "--resolver lts-14"
19+ maxParallel: 3
20+ steps:
21+ - script: |
22+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
23+ mkdir -p ~/.local/bin
24+ curl -skL https://get.haskellstack.org/stable/osx-x86_64.tar.gz | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin;
25+ export PATH=$HOME/.local/bin:$PATH
26+ stack --install-ghc $ARGS test --bench --only-dependencies
27+ stack $ARGS test --bench --no-run-benchmarks --haddock --no-haddock-deps
28+ env:
29+ OS_NAME: ${{ parameters.os }}
30+ displayName: 'Installation ${{parameters.os}} & Test'
.azure/azure-pipelines.ymlnew file+30
@@ -0,0 +1,30 @@
1+# This is the complex Azure configuration, which is intended for use
2+# on open source libraries which need compatibility across multiple GHC
3+# versions, must work with cabal-install, and should be
4+# cross-platform. For more information and other options, see:
5+#
6+# https://docs.haskellstack.org/en/stable/azure_ci/
7+#
8+# Copy these contents into the root directory of your Github project in a file
9+# named azure-pipelines.yml
10+#
11+# For better organization, you split various jobs into seprate parts
12+# and each of them are controlled via individual file.
13+jobs:
14+- template: azure-linux-template.yml
15+ parameters:
16+ name: Linux
17+ vmImage: ubuntu-16.04
18+ os: linux
19+
20+- template: azure-osx-template.yml
21+ parameters:
22+ name: macOS
23+ vmImage: macOS-10.13
24+ os: osx
25+
26+- template: azure-windows-template.yml
27+ parameters:
28+ name: Windows
29+ vmImage: vs2017-win2016
30+ os: windows
.azure/azure-windows-template.ymlnew file+23
@@ -0,0 +1,23 @@
1+jobs:
2+- job: ${{ parameters.name }}
3+ timeoutInMinutes: 180
4+ pool:
5+ vmImage: ${{ parameters.vmImage }}
6+ strategy:
7+ matrix:
8+ stack-lts-14:
9+ BUILD: stack
10+ ARGS: "--resolver lts-14"
11+ maxParallel: 3
12+ steps:
13+ - bash: |
14+ export STACK_ROOT="$(Build.SourcesDirectory)"/.stack-root;
15+ curl -sSkL http://www.stackage.org/stack/windows-x86_64 -o /usr/bin/stack.zip
16+ unzip -o /usr/bin/stack.zip -d /usr/bin/
17+ stack setup $ARGS > /dev/null
18+ stack --install-ghc $ARGS test --bench --only-dependencies
19+ stack $ARGS test --bench --no-run-benchmarks --no-run-tests
20+ stack $ARGS test --bench --no-run-benchmarks --jobs 1 # non-parallel test execution
21+ env:
22+ OS_NAME: ${{ parameters.os }}
23+ displayName: 'Installation ${{parameters.os}} & Test'
.github/ISSUE_TEMPLATE.mdnew file+28
@@ -0,0 +1,28 @@
1+<!---
2+
3+### Bug Reports
4+
5+Reporting a bug? If relevant, we recommend including:
6+
7+* Your OS name and version
8+* The versions of tools you're using (e.g. `stack`, `ghc`).
9+* The versions of dependencies you're using
10+
11+For your convenience, we recommend pasting this script into bash and uploading the output [as a gist](https://gist.github.com/).
12+
13+```
14+command -v sw_vers && sw_vers # OS X only
15+command -v uname && uname -a # Kernel version
16+command -v stack && stack --version
17+command -v stack && stack ghc -- --version
18+command -v stack && stack list-dependencies
19+```
20+
21+* Also, is there anything custom or unusual about your setup? i.e. new or prerelease versions of GHC, Stack, etc.
22+
23+* Finally, if possible, please reproduce the error in a small script, or if necessary create a new Github repo with the smallest possible reproducing case. [Stack's scripting support](https://docs.haskellstack.org/en/stable/GUIDE/#script-interpreter) might be useful for creating your reproduction example.
24+
25+### Support
26+
27+Please direct support questions to [Stack Overflow](https://stackoverflow.com/questions/tagged/yesod+haskell) or the [Yesod Google Group](https://groups.google.com/forum/#!forum/yesodweb). If you don't get a response there, or you suspect there may be a bug in Wai causing your problem, you're welcome to ask here.
28+-->
.github/PULL_REQUEST_TEMPLATE.mdnew file+14
@@ -0,0 +1,14 @@
1+Before submitting your PR, check that you've:
2+
3+- [ ] Bumped the version number
4+- [ ] Documented new APIs with [Haddock markup](https://www.haskell.org/haddock/doc/html/index.html)
5+- [ ] Added [`@since` declarations](http://haskell-haddock.readthedocs.io/en/latest/markup.html#since) to the Haddock
6+
7+After submitting your PR:
8+
9+- [ ] Update the Changelog.md file with a link to your PR
10+- [ ] Check that CI passes (or if it fails, for reasons unrelated to your change, like CI timeouts)
11+
12+<!---Thanks so much for contributing! :)
13+
14+_If these checkboxes don't apply to your PR, you can delete them_-->
.gitignore+2
@@ -8,3 +8,5 @@ tarballs/
8.cabal-sandbox/
8.cabal-sandbox/
9cabal.sandbox.config
9cabal.sandbox.config
10.stack-work/
10.stack-work/
11+*~
12+stack*.yaml.lock
.travis-setup.shdeleted−23
@@ -1,23 +0,0 @@
1−#!/bin/sh
2−
3−set -eux
4−
5−# For simplicity, installing cabal-meta and Stack for both the Cabal and Stack
6−# build plans, even though they're never both necessary.
7−
8−mkdir -p ~/.local/bin
9−if [ `uname` = "Darwin" ]
10−then
11− curl --insecure -L https://www.stackage.org/stack/osx-x86_64 | tar xz --strip-components=1 --include '*/stack' -C ~/.local/bin
12− brew install fcgi
13−else
14− curl -L https://www.stackage.org/stack/linux-x86_64 | tar xz --wildcards --strip-components=1 -C ~/.local/bin '*/stack'
15− curl -L http://download.fpcomplete.com/michael/cabal-meta.tar.gz | tar xz -C $HOME/.local/bin
16−fi
17−
18−mkdir -p $HOME/.cabal
19−cat > $HOME/.cabal/config <<EOF
20−remote-repo: hackage.haskell.org:http://hackage.fpcomplete.com/
21−remote-repo-cache: $HOME/.cabal/packages
22−jobs: \$ncpus
23−EOF
.travis.ymldeleted−91
@@ -1,91 +0,0 @@
1−# Use new container infrastructure to enable caching
2−sudo: false
3−
4−# Choose a lightweight base image; we provide our own build tools.
5−language: c
6−
7−matrix:
8− include:
9− - env: CABALVER=1.18 GHCVER=7.6.3 BUILD=cabal
10− addons: {apt: {packages: [libfcgi-dev,cabal-install-1.18,ghc-7.6.3], sources: [hvr-ghc]}}
11−
12− - env: CABALVER=1.18 GHCVER=7.8.4 BUILD=cabal
13− addons: {apt: {packages: [libfcgi-dev,cabal-install-1.18,ghc-7.8.4], sources: [hvr-ghc]}}
14−
15− - env: CABALVER=1.22 GHCVER=7.10.1 BUILD=cabal
16− addons: {apt: {packages: [libfcgi-dev,cabal-install-1.22,ghc-7.10.1], sources: [hvr-ghc]}}
17−
18− - env: CABALVER=1.22 GHCVER=7.10.2 BUILD=cabal
19− addons: {apt: {packages: [libfcgi-dev,cabal-install-1.22,ghc-7.10.2], sources: [hvr-ghc]}}
20−
21− - env: CABALVER=head GHCVER=head BUILD=cabal
22− addons: {apt: {packages: [libfcgi-dev,cabal-install-head,ghc-head], sources: [hvr-ghc]}}
23−
24− - env: ARGS= BUILD=stack
25− addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
26−
27− - env: ARGS="--resolver lts-4" BUILD=stack
28− addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
29−
30− - env: ARGS="--resolver lts-3" BUILD=stack
31− addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
32−
33− - env: ARGS="--resolver lts" BUILD=stack
34− addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
35−
36− - env: ARGS="--resolver nightly" BUILD=stack
37− addons: {apt: {packages: [libfcgi-dev,libgmp-dev]}}
38−
39− - env: ARGS= BUILD=stack
40− os: osx
41−
42− - env: ARGS="--resolver lts-3" BUILD=stack
43− os: osx
44−
45− - env: ARGS="--resolver lts" BUILD=stack
46− os: osx
47−
48− - env: ARGS="--resolver nightly" BUILD=stack
49− os: osx
50−
51− allow_failures:
52− - env: CABALVER=head GHCVER=head BUILD=cabal
53−
54−before_install:
55−# Set up path and additional build tools
56−- ./.travis-setup.sh
57−- case "$BUILD" in
58− stack)
59− export PATH=$HOME/.local/bin:$HOME/.cabal/bin:$PATH;
60− stack --version;;
61− cabal)
62− export PATH=$HOME/.local/bin:/opt/ghc/$GHCVER/bin:/opt/cabal/$CABALVER/bin:$HOME/.cabal/bin:$PATH;
63− ghc --version;
64− cabal --version;;
65− esac
66−
67−install:
68−- case "$BUILD" in
69− stack)
70− stack $ARGS setup --no-terminal;;
71− cabal)
72− travis_retry cabal update;
73− cabal unpack wai-logger;
74− mv wai-logger-* wai-logger;
75− cabal install hspec doctest HTTP temporary;
76− cabal-meta install --force-reinstalls --enable-tests;;
77− esac
78−
79−script:
80−- case "$BUILD" in
81− stack)
82− stack $ARGS --no-terminal test --haddock;;
83− cabal)
84− mega-sdist --test;;
85− esac
86−
87−# Caching so the next build will be fast too.
88−cache:
89− directories:
90− - $HOME/.stack
91− - $HOME/.cabal/packages
CONTRIBUTING.mdnew file+94
@@ -0,0 +1,94 @@
1+# Contributing
2+
3+Thanks for your interest in contributing to Wai! This file has some tips for developing Wai and getting a pull request accepted.
4+
5+## Development
6+
7+Wai is a mega-repo that contains many Haskell packages, each in a different directory. All the subprojects can be developed with Stack, using `stack <command> <subproject>`, e.g.
8+
9+* `stack build mime-types`
10+* `stack test auto-update`
11+* `stack haddock warp`
12+
13+If you'd like to test your changes in a full-fledged Wai app, you can use Stack to build against it, e.g.:
14+
15+```
16+packages:
17+- '/path/to/this/repo/wai'
18+```
19+
20+## Coding Guidelines
21+
22+### Safety
23+
24+Avoid partial functions. Even if you know the partial function is safe in your instance, partial functions require more reasoning from the programmer and are not resilient to refactoring. For the rare cases where a partial function is appropriate, a custom `error` should be used.
25+
26+### Style
27+
28+Keep coding style consistent with the rest of the file, but don't worry about style too much otherwise. PRs changing code style are viewed skeptically.
29+
30+### Dependencies
31+
32+Avoid adding unnecessary dependencies. If a dependency provides only a minor convenience for your implementation, it's probably better to skip it.
33+
34+If you do add a new dependency, try to support a wide range of versions of it.
35+
36+### Backwards Compatibility
37+
38+Backwards incompatible changes are viewed skeptically—best to ask in an issue to see if a particular backwards incompatible change would be approved. If possible keep backwards compatibility by adding new APIs and deprecating old ones.
39+
40+Keep backwards compatibility with old versions of dependencies when possible.
41+
42+## PR Guidelines
43+
44+### PR Scope
45+
46+As much as possible, keep separate changes in separate PRs.
47+
48+### Testing
49+
50+Tests are recommended, but not required.
51+
52+### Documentation
53+
54+All public APIs must be documented. Documenting private functions is optional, but may be nice depending on their complexity. Example documentation:
55+
56+```
57+-- | Generate an action which will either read from an automatically
58+-- updated value, or run the update action in the current thread.
59+--
60+-- ==== __Examples__
61+--
62+-- > getTime <- mkAutoUpdate defaultUpdateSettings
63+--
64+-- @since 0.1.0
65+mkAutoUpdate :: UpdateSettings a -> IO (IO a)
66+```
67+
68+Examples are recommended, but not required, in documentation. Marking new APIs with `@since <version number>` is required.
69+
70+### Versioning
71+
72+Wai packages roughly follow the Haskell Package Versioning Policy style of A.B.C.[D] (MAJOR.MAJOR.MINOR.[PATCH])
73+
74+* A - Used for massive changes in the library. (Example: 1.2.3.4 becomes 2.0.0)
75+* B - Used for smaller breaking changes, like removing, renaming, or changing behavior of existing public API. (Example: 1.2.3.4 becomes 1.3.0)
76+* C - Used for new public APIs (Example: 1.2.3.4 becomes 1.2.4)
77+* D - Used for bug fixes (Example: 1.2.3.4 becomes 1.2.3.5).
78+ * D is optional in the version number, so 2.0.0 is a valid version.
79+
80+Documentation changes don't require a new version.
81+
82+If you feel there is ambiguity to a change (e.g. fixing a bug in a function, when people may be relying on the old broken behavior), you can ask in an issue or pull request.
83+
84+Unlike in the Package Versioning Policy, deprecations are not counted as MAJOR changes.
85+
86+In some cases, dropping compatibility with a major version of a dependency (e.g. changing from transformers >= 0.3 to transformers >= 0.4), is considered a breaking change.
87+
88+### Changelog
89+
90+After you submit a PR, update the subproject's Changelog.md file with the new version number and a link to your PR. If your PR does not need to bump the version number, include the change in an "Unreleased" section at the top.
91+
92+### Releases
93+
94+Releases should be done as soon as possible after a pull request is merged—don't be shy about reminding us to make a release if we forget.
LICENSE+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2012-2017 Michael Snoyman, http://www.yesodweb.com/
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
README.md+1−1
@@ -10,4 +10,4 @@ Code can be written that works with any web framework targeting WAI.
10
10
11[Haddock Documentation](http://hackage.haskell.org/package/wai)
11[Haddock Documentation](http://hackage.haskell.org/package/wai)
12
12
13−[![Build Status](https://travis-ci.org/yesodweb/wai.svg?branch=master)](https://travis-ci.org/yesodweb/wai)
13+[![Build Status](https://dev.azure.com/yesodweb/wai/_apis/build/status/yesodweb.wai?branchName=master)](https://dev.azure.com/yesodweb/wai/_build/latest?definitionId=1&branchName=master)
auto-update/ChangeLog.md+33−2
@@ -1,3 +1,34 @@
1−__0.1.3__ Adding a new AIP - reaperKill
1+# ChangeLog for auto-update
2
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+
3−__0.1.2__ Added Control.Debounce
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
1+{-# LANGUAGE CPP #-}
2−-- interval, but only if it is needed. For example, instead of having
2+-- | In a multithreaded environment, running actions on a regularly scheduled
3−-- every web request result in a new @getCurrentTime@ call, we'd like to
3+-- background thread can dramatically improve performance.
4−-- have a single worker thread run every second, updating an @IORef@.
4+-- For example, web servers need to return the current time with each HTTP response.
5−-- However, if the request frequency is less than once per second, this is
5+-- For a high-volume server, it's much faster for a dedicated thread to run every
6−-- a pessimization, and worse, kills idle GC.
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'.
7--
8--
9+-- But for a low-volume server, whose request frequency is less than once per
10+-- second, that approach will result in /more/ calls to 'getCurrentTime' than
11+-- necessary, and worse, kills idle GC.
12+--
8−-- This library allows you to define actions which will either be
13+-- This library solves that problem by allowing you to define actions which will
9−-- performed by a dedicated thread or, in times of low volume, will be
14+-- either be performed by a dedicated thread, or, in times of low volume, will
10−-- executed by the calling thread.
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>.
11module Control.AutoUpdate (
31module Control.AutoUpdate (
12 -- * Type
32 -- * Type
13 UpdateSettings
33 UpdateSettings
14 , defaultUpdateSettings
34 , defaultUpdateSettings
15 -- * Accessors
35 -- * Accessors
36+ , updateAction
16 , updateFreq
37 , updateFreq
17 , updateSpawnThreshold
38 , updateSpawnThreshold
18− , updateAction
19 -- * Creation
39 -- * Creation
20 , mkAutoUpdate
40 , mkAutoUpdate
41+ , mkAutoUpdateWithModify
21 ) where
42 ) where
22
43
44+#if __GLASGOW_HASKELL__ < 709
45+import Control.Applicative ((<*>))
46+#endif
23import Control.Concurrent (forkIO, threadDelay)
47import Control.Concurrent (forkIO, threadDelay)
24import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar,
48import Control.Concurrent.MVar (newEmptyMVar, putMVar, readMVar,
25 takeMVar, tryPutMVar)
49 takeMVar, tryPutMVar)
26−import Control.Exception (SomeException, catch, throw, mask_, try)
50+import Control.Exception (SomeException, catch, mask_, throw,
51+ try)
27import Control.Monad (void)
52import Control.Monad (void)
28import Data.IORef (newIORef, readIORef, writeIORef)
53import Data.IORef (newIORef, readIORef, writeIORef)
29
54
30−-- | Default value for creating an @UpdateSettings@.
55+-- | Default value for creating an 'UpdateSettings'.
31--
56--
32−-- Since 0.1.0
57+-- @since 0.1.0
33defaultUpdateSettings :: UpdateSettings ()
58defaultUpdateSettings :: UpdateSettings ()
34defaultUpdateSettings = UpdateSettings
59defaultUpdateSettings = UpdateSettings
35 { updateFreq = 1000000
60 { updateFreq = 1000000
@@ -39,46 +64,57 @@ defaultUpdateSettings = UpdateSettings
39
64
40-- | Settings to control how values are updated.
65-- | Settings to control how values are updated.
41--
66--
42−-- This should be constructed using @defaultUpdateSettings@ and record
67+-- This should be constructed using 'defaultUpdateSettings' and record
43-- update syntax, e.g.:
68-- update syntax, e.g.:
44--
69--
45-- @
70-- @
46−-- let set = defaultUpdateSettings { updateAction = getCurrentTime }
71+-- let settings = 'defaultUpdateSettings' { 'updateAction' = 'Data.Time.Clock.getCurrentTime' }
47-- @
72-- @
48--
73--
49−-- Since 0.1.0
74+-- @since 0.1.0
50data UpdateSettings a = UpdateSettings
75data UpdateSettings a = UpdateSettings
51 { updateFreq :: Int
76 { updateFreq :: Int
52 -- ^ Microseconds between update calls. Same considerations as
77 -- ^ Microseconds between update calls. Same considerations as
53− -- @threadDelay@ apply.
78+ -- 'threadDelay' apply.
54 --
79 --
55 -- Default: 1 second (1000000)
80 -- Default: 1 second (1000000)
56 --
81 --
57− -- Since 0.1.0
82+ -- @since 0.1.0
58 , updateSpawnThreshold :: Int
83 , updateSpawnThreshold :: Int
59 -- ^ NOTE: This value no longer has any effect, since worker threads are
84 -- ^ NOTE: This value no longer has any effect, since worker threads are
60 -- dedicated instead of spawned on demand.
85 -- dedicated instead of spawned on demand.
61 --
86 --
62− -- Previously, this determined: How many times the data must be requested
87+ -- Previously, this determined how many times the data must be requested
63 -- before we decide to spawn a dedicated thread.
88 -- before we decide to spawn a dedicated thread.
64 --
89 --
65 -- Default: 3
90 -- Default: 3
66 --
91 --
67− -- Since 0.1.0
92+ -- @since 0.1.0
68 , updateAction :: IO a
93 , updateAction :: IO a
69 -- ^ Action to be performed to get the current value.
94 -- ^ Action to be performed to get the current value.
70 --
95 --
71 -- Default: does nothing.
96 -- Default: does nothing.
72 --
97 --
73− -- Since 0.1.0
98+ -- @since 0.1.0
74 }
99 }
75
100
76-- | Generate an action which will either read from an automatically
101-- | Generate an action which will either read from an automatically
77-- updated value, or run the update action in the current thread.
102-- updated value, or run the update action in the current thread.
78--
103--
79−-- Since 0.1.0
104+-- @since 0.1.0
80mkAutoUpdate :: UpdateSettings a -> IO (IO a)
105mkAutoUpdate :: 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
82 -- A baton to tell the worker thread to generate a new value.
118 -- A baton to tell the worker thread to generate a new value.
83 needsRunning <- newEmptyMVar
119 needsRunning <- newEmptyMVar
84
120
@@ -121,12 +157,12 @@ mkAutoUpdate us = do
121 -- This infinite loop makes up out worker thread. It takes an a
157 -- This infinite loop makes up out worker thread. It takes an a
122 -- responseVar value where the next value should be putMVar'ed to for
158 -- responseVar value where the next value should be putMVar'ed to for
123 -- the benefit of any requesters currently blocked on it.
159 -- the benefit of any requesters currently blocked on it.
124− let loop responseVar = do
160+ let loop responseVar maybea = do
125 -- block until a value is actually needed
161 -- block until a value is actually needed
126 takeMVar needsRunning
162 takeMVar needsRunning
127
163
128 -- new value requested, so run the updateAction
164 -- new value requested, so run the updateAction
129− a <- catchSome $ updateAction us
165+ a <- catchSome $ maybe (updateAction us) id (updateActionModify <*> maybea)
130
166
131 -- we got a new value, update currRef and lastValue
167 -- we got a new value, update currRef and lastValue
132 writeIORef currRef $ Right a
168 writeIORef currRef $ Right a
@@ -141,10 +177,10 @@ mkAutoUpdate us = do
141 -- variable.
177 -- variable.
142 responseVar' <- newEmptyMVar
178 responseVar' <- newEmptyMVar
143 writeIORef currRef $ Left responseVar'
179 writeIORef currRef $ Left responseVar'
144− loop responseVar'
180+ loop responseVar' (Just a)
145
181
146 -- Kick off the loop, with the initial responseVar0 variable.
182 -- Kick off the loop, with the initial responseVar0 variable.
147− loop responseVar0
183+ loop responseVar0 Nothing
148
184
149 return $ do
185 return $ do
150 mval <- readIORef currRef
186 mval <- readIORef currRef
@@ -158,7 +194,7 @@ mkAutoUpdate us = do
158 -- we have a current value, use it
194 -- we have a current value, use it
159 Right val -> return val
195 Right val -> return val
160
196
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'
162-- actions will complete successfully. This simply defers the exception until
198-- actions will complete successfully. This simply defers the exception until
163-- the value is forced.
199-- the value is forced.
164catchSome :: IO a -> IO a
200catchSome :: IO a -> IO a
auto-update/Control/Debounce.hs+41−59
@@ -3,76 +3,58 @@
3-- period of time.
3-- period of time.
4--
4--
5-- This is useful as an optimization, for example to ensure that logs are only
5-- 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
6+-- flushed to disk at most once per second.
7−-- example usage.
8--
7--
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
10module Control.Debounce
27module Control.Debounce
11 ( -- * Type
28 ( -- * Type
12− DebounceSettings
29+ DI.DebounceSettings
13 , defaultDebounceSettings
30 , defaultDebounceSettings
14 -- * Accessors
31 -- * Accessors
15− , debounceFreq
32+ , DI.debounceFreq
16− , debounceAction
33+ , DI.debounceAction
34+ , DI.debounceEdge
35+ , DI.leadingEdge
36+ , DI.trailingEdge
17 -- * Creation
37 -- * Creation
18 , mkDebounce
38 , mkDebounce
19 ) where
39 ) where
20
40
21−import Control.Concurrent (forkIO, threadDelay)
41+import Control.Concurrent (newEmptyMVar, threadDelay)
22−import Control.Concurrent.MVar (newEmptyMVar, takeMVar, tryPutMVar)
42+import qualified Control.Debounce.Internal as DI
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− }
53
43
54−-- | Default value for creating a @DebounceSettings@.
44+-- | Default value for creating a 'DebounceSettings'.
55--
45--
56−-- Since 0.1.2
46+-- @since 0.1.2
57−defaultDebounceSettings :: DebounceSettings
47+defaultDebounceSettings :: DI.DebounceSettings
58−defaultDebounceSettings = DebounceSettings
48+defaultDebounceSettings = DI.DebounceSettings
59− { debounceFreq = 1000000
49+ { DI.debounceFreq = 1000000
60− , debounceAction = return ()
50+ , DI.debounceAction = return ()
51+ , DI.debounceEdge = DI.leadingEdge
61 }
52 }
62
53
63−-- | Generate an action which will trigger the debounced action to be
54+-- | Generate an action which will trigger the debounced action to be performed.
64−-- performed. The action will either be performed immediately, or after the
65−-- current cooldown period has expired.
66--
55--
67−-- Since 0.1.2
56+-- @since 0.1.2
68−mkDebounce :: DebounceSettings -> IO (IO ())
57+mkDebounce :: DI.DebounceSettings -> IO (IO ())
69−mkDebounce (DebounceSettings freq action) = do
58+mkDebounce settings = do
70− baton <- newEmptyMVar
59+ baton <- newEmptyMVar
71− mask_ $ void $ forkIO $ forever $ do
60+ DI.mkDebounceInternal baton threadDelay settings
72− takeMVar baton
73− ignoreExc action
74− threadDelay freq
75− return $ void $ tryPutMVar baton ()
76−
77−ignoreExc :: IO () -> IO ()
78−ignoreExc = handle $ \(_ :: SomeException) -> return ()
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+91−15
@@ -3,8 +3,18 @@
3
3
4-- | This module provides the ability to create reapers: dedicated cleanup
4-- | This module provides the ability to create reapers: dedicated cleanup
5-- threads. These threads will automatically spawn and die based on the
5-- threads. These threads will automatically spawn and die based on the
6−-- 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".
7module Control.Reaper (
14module Control.Reaper (
15+ -- * Example: Regularly cleaning a cache
16+ -- $example1
17+
8 -- * Settings
18 -- * Settings
9 ReaperSettings
19 ReaperSettings
10 , defaultReaperSettings
20 , defaultReaperSettings
@@ -33,51 +43,52 @@ import Data.IORef (IORef, newIORef, readIORef, writeIORef)
33-- be a list of @item@s. This is encouraged by 'defaultReaperSettings' and
43-- be a list of @item@s. This is encouraged by 'defaultReaperSettings' and
34-- 'mkListAction'.
44-- 'mkListAction'.
35--
45--
36−-- Since 0.1.1
46+-- @since 0.1.1
37data ReaperSettings workload item = ReaperSettings
47data ReaperSettings workload item = ReaperSettings
38 { reaperAction :: workload -> IO (workload -> workload)
48 { reaperAction :: workload -> IO (workload -> workload)
39 -- ^ The action to perform on a workload. The result of this is a
49 -- ^ The action to perform on a workload. The result of this is a
40 -- \"workload modifying\" function. In the common case of using lists,
50 -- \"workload modifying\" function. In the common case of using lists,
41 -- the result should be a difference list that prepends the remaining
51 -- the result should be a difference list that prepends the remaining
42− -- workload to the temporary workload. For help with setting up such
52+ -- workload to the temporary workload. The temporary workload here
53+ -- refers to items added to the workload while the reaper action is
43− -- an action, see 'mkListAction'.
54+ -- running. For help with setting up such an action, see 'mkListAction'.
44 --
55 --
45 -- Default: do nothing with the workload, and then prepend it to the
56 -- Default: do nothing with the workload, and then prepend it to the
46 -- temporary workload. This is incredibly useless; you should
57 -- temporary workload. This is incredibly useless; you should
47 -- definitely override this default.
58 -- definitely override this default.
48 --
59 --
49− -- Since 0.1.1
60+ -- @since 0.1.1
50 , reaperDelay :: {-# UNPACK #-} !Int
61 , reaperDelay :: {-# UNPACK #-} !Int
51 -- ^ Number of microseconds to delay between calls of 'reaperAction'.
62 -- ^ Number of microseconds to delay between calls of 'reaperAction'.
52 --
63 --
53 -- Default: 30 seconds.
64 -- Default: 30 seconds.
54 --
65 --
55− -- Since 0.1.1
66+ -- @since 0.1.1
56 , reaperCons :: item -> workload -> workload
67 , reaperCons :: item -> workload -> workload
57 -- ^ Add an item onto a workload.
68 -- ^ Add an item onto a workload.
58 --
69 --
59 -- Default: list consing.
70 -- Default: list consing.
60 --
71 --
61− -- Since 0.1.1
72+ -- @since 0.1.1
62 , reaperNull :: workload -> Bool
73 , reaperNull :: workload -> Bool
63 -- ^ Check if a workload is empty, in which case the worker thread
74 -- ^ Check if a workload is empty, in which case the worker thread
64 -- will shut down.
75 -- will shut down.
65 --
76 --
66 -- Default: 'null'.
77 -- Default: 'null'.
67 --
78 --
68− -- Since 0.1.1
79+ -- @since 0.1.1
69 , reaperEmpty :: workload
80 , reaperEmpty :: workload
70 -- ^ An empty workload.
81 -- ^ An empty workload.
71 --
82 --
72 -- Default: empty list.
83 -- Default: empty list.
73 --
84 --
74− -- Since 0.1.1
85+ -- @since 0.1.1
75 }
86 }
76
87
77-- | Default @ReaperSettings@ value, biased towards having a list of work
88-- | Default @ReaperSettings@ value, biased towards having a list of work
78-- items.
89-- items.
79--
90--
80−-- Since 0.1.1
91+-- @since 0.1.1
81defaultReaperSettings :: ReaperSettings [item] item
92defaultReaperSettings :: ReaperSettings [item] item
82defaultReaperSettings = ReaperSettings
93defaultReaperSettings = ReaperSettings
83 { reaperAction = \wl -> return (wl ++)
94 { reaperAction = \wl -> return (wl ++)
@@ -102,13 +113,13 @@ data Reaper workload item = Reaper {
102
113
103-- | State of reaper.
114-- | State of reaper.
104data State workload = NoReaper -- ^ No reaper thread
115data State workload = NoReaper -- ^ No reaper thread
105− | Workload workload -- ^ The current jobs
116+ | Workload !workload -- ^ The current jobs
106
117
107−-- | 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
108-- new items to the workload. Spawning of reaper threads will be handled
119-- new items to the workload. Spawning of reaper threads will be handled
109-- for you automatically.
120-- for you automatically.
110--
121--
111−-- Since 0.1.1
122+-- @since 0.1.1
112mkReaper :: ReaperSettings workload item -> IO (Reaper workload item)
123mkReaper :: ReaperSettings workload item -> IO (Reaper workload item)
113mkReaper settings@ReaperSettings{..} = do
124mkReaper settings@ReaperSettings{..} = do
114 stateRef <- newIORef NoReaper
125 stateRef <- newIORef NoReaper
@@ -143,7 +154,7 @@ add settings@ReaperSettings{..} stateRef tidRef item =
143 next <- atomicModifyIORef' stateRef cons
154 next <- atomicModifyIORef' stateRef cons
144 next
155 next
145 where
156 where
146− cons NoReaper = let !wl = reaperCons item reaperEmpty
157+ cons NoReaper = let wl = reaperCons item reaperEmpty
147 in (Workload wl, spawn settings stateRef tidRef)
158 in (Workload wl, spawn settings stateRef tidRef)
148 cons (Workload wl) = let wl' = reaperCons item wl
159 cons (Workload wl) = let wl' = reaperCons item wl
149 in (Workload wl', return ())
160 in (Workload wl', return ())
@@ -187,7 +198,7 @@ reaper settings@ReaperSettings{..} stateRef tidRef = do
187-- return either a new work item, or @Nothing@ if the work item is
198-- return either a new work item, or @Nothing@ if the work item is
188-- expired.
199-- expired.
189--
200--
190−-- Since 0.1.1
201+-- @since 0.1.1
191mkListAction :: (item -> IO (Maybe item'))
202mkListAction :: (item -> IO (Maybe item'))
192 -> [item]
203 -> [item]
193 -> IO ([item'] -> [item'])
204 -> IO ([item'] -> [item'])
@@ -202,3 +213,68 @@ mkListAction f =
202 Nothing -> front
213 Nothing -> front
203 Just y -> front . (y:)
214 Just y -> front . (y:)
204 go front' xs
215 go front' xs
216+
217+-- $example1
218+-- In this example code, we use a 'Data.Map.Strict.Map' to cache fibonacci numbers, and a 'Reaper' to prune the cache.
219+--
220+-- The @main@ function first creates a 'Reaper', with fields to initialize the
221+-- cache ('reaperEmpty'), add items to it ('reaperCons'), and prune it ('reaperAction').
222+-- The reaper will run every two seconds ('reaperDelay'), but will stop running while
223+-- 'reaperNull' is true.
224+--
225+-- @main@ then loops infinitely ('Control.Monad.forever'). Each second it calculates the fibonacci number
226+-- for a value between 30 and 34, first trying the cache ('reaperRead' and 'Data.Map.Strict.lookup'),
227+-- then falling back to manually calculating it (@fib@)
228+-- and updating the cache with the result ('reaperAdd')
229+--
230+-- @clean@ simply removes items cached for more than 10 seconds.
231+-- This function is where you would perform IO-related cleanup,
232+-- like killing threads or closing connections, if that was the purpose of your reaper.
233+--
234+-- @
235+-- module Main where
236+--
237+-- import "Data.Time" (UTCTime, getCurrentTime, diffUTCTime)
238+-- import "Control.Reaper"
239+-- import "Control.Concurrent" (threadDelay)
240+-- import "Data.Map.Strict" (Map)
241+-- import qualified "Data.Map.Strict" as Map
242+-- import "Control.Monad" (forever)
243+-- import "System.Random" (getStdRandom, randomR)
244+--
245+-- fib :: 'Int' -> 'Int'
246+-- fib 0 = 0
247+-- fib 1 = 1
248+-- fib n = fib (n-1) + fib (n-2)
249+--
250+-- type Cache = 'Data.Map.Strict.Map' 'Int' ('Int', 'Data.Time.Clock.UTCTime')
251+--
252+-- main :: IO ()
253+-- main = do
254+-- reaper <- 'mkReaper' 'defaultReaperSettings'
255+-- { 'reaperEmpty' = Map.'Data.Map.Strict.empty'
256+-- , 'reaperCons' = \\(k, v, time) workload -> Map.'Data.Map.Strict.insert' k (v, time) workload
257+-- , 'reaperAction' = clean
258+-- , 'reaperDelay' = 1000000 * 2 -- Clean every 2 seconds
259+-- , 'reaperNull' = Map.'Data.Map.Strict.null'
260+-- }
261+-- forever $ do
262+-- fibArg <- 'System.Random.getStdRandom' ('System.Random.randomR' (30,34))
263+-- cache <- 'reaperRead' reaper
264+-- let cachedResult = Map.'Data.Map.Strict.lookup' fibArg cache
265+-- case cachedResult of
266+-- 'Just' (fibResult, _createdAt) -> 'putStrLn' $ "Found in cache: `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
267+-- 'Nothing' -> do
268+-- let fibResult = fib fibArg
269+-- 'putStrLn' $ "Calculating `fib " ++ 'show' fibArg ++ "` " ++ 'show' fibResult
270+-- time <- 'Data.Time.Clock.getCurrentTime'
271+-- ('reaperAdd' reaper) (fibArg, fibResult, time)
272+-- 'threadDelay' 1000000 -- 1 second
273+--
274+-- -- Remove items > 10 seconds old
275+-- clean :: Cache -> IO (Cache -> Cache)
276+-- clean oldMap = do
277+-- currentTime <- 'Data.Time.Clock.getCurrentTime'
278+-- let pruned = Map.'Data.Map.Strict.filter' (\\(_, createdAt) -> currentTime \`diffUTCTime\` createdAt < 10.0) oldMap
279+-- return (\\newData -> Map.'Data.Map.Strict.union' pruned newData)
280+-- @
auto-update/auto-update.cabal+13−9
@@ -1,5 +1,5 @@
1name: auto-update
1name: auto-update
2−version: 0.1.3
2+version: 0.1.6
3synopsis: Efficiently run periodic, on-demand actions
3synopsis: Efficiently run periodic, on-demand actions
4description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
4description: API docs and the README are available at <http://www.stackage.org/package/auto-update>.
5homepage: https://github.com/yesodweb/wai
5homepage: https://github.com/yesodweb/wai
@@ -17,18 +17,22 @@ library
17 ghc-options: -Wall
17 ghc-options: -Wall
18 exposed-modules: Control.AutoUpdate
18 exposed-modules: Control.AutoUpdate
19 Control.Debounce
19 Control.Debounce
20+ Control.Debounce.Internal
20 Control.Reaper
21 Control.Reaper
21 other-modules: Control.AutoUpdate.Util
22 other-modules: Control.AutoUpdate.Util
22 build-depends: base >= 4 && < 5
23 build-depends: base >= 4 && < 5
23 default-language: Haskell2010
24 default-language: Haskell2010
25+ if impl(ghc >= 8)
26+ default-extensions: Strict StrictData
24
27
25-- Test suite is currently not robust enough, gives too many false negatives.
28-- Test suite is currently not robust enough, gives too many false negatives.
26
29
27−-- test-suite spec
30+test-suite spec
28−-- main-is: Spec.hs
31+ main-is: Spec.hs
29−-- other-modules: Control.AutoUpdateSpec
32+ other-modules: Control.AutoUpdateSpec
33+ Control.DebounceSpec
30−-- Control.ReaperSpec
34+ Control.ReaperSpec
31−-- hs-source-dirs: test
35+ hs-source-dirs: test
32−-- type: exitcode-stdio-1.0
36+ type: exitcode-stdio-1.0
33−-- build-depends: base, auto-update, hspec
37+ build-depends: base, auto-update, exceptions, hspec, retry, HUnit
34−-- default-language: Haskell2010
38+ default-language: Haskell2010
auto-update/test/Control/AutoUpdateSpec.hs+26−25
@@ -1,34 +1,35 @@
1module Control.AutoUpdateSpec (spec) where
1module Control.AutoUpdateSpec (spec) where
2
2
3−import Test.Hspec
3+import Control.AutoUpdate
4−import Test.Hspec.QuickCheck
5−import Data.IORef
6import Control.Concurrent (threadDelay)
4import Control.Concurrent (threadDelay)
7import Control.Monad (replicateM_, forM_)
5import Control.Monad (replicateM_, forM_)
8−import Control.AutoUpdate
6+import Data.IORef
7+import Test.Hspec
8+import Test.Hspec.QuickCheck
9
9
10spec :: Spec
10spec :: Spec
11−spec = do
11+spec = return ()
12+ -- do
12− prop "incrementer" $ \st' -> do
13+ -- prop "incrementer" $ \st' -> do
13− let st = abs st' `mod` 10000
14+ -- let st = abs st' `mod` 10000
14− ref <- newIORef 0
15+ -- ref <- newIORef 0
15− next <- mkAutoUpdate defaultUpdateSettings
16+ -- next <- mkAutoUpdate defaultUpdateSettings
16− { updateAction = atomicModifyIORef ref $ \i ->
17+ -- { updateAction = atomicModifyIORef ref $ \i ->
17− let i' = succ i in i' `seq` (i', i')
18+ -- let i' = succ i in i' `seq` (i', i')
18− , updateSpawnThreshold = st
19+ -- , updateSpawnThreshold = st
19− , updateFreq = 10000
20+ -- , updateFreq = 10000
20− }
21+ -- }
21
22
22− forM_ [1..st + 1] $ \i -> do
23+ -- forM_ [1..st + 1] $ \i -> do
23− j <- next
24+ -- j <- next
24− j `shouldBe` i
25+ -- j `shouldBe` i
25
26
26− replicateM_ 50 $ do
27+ -- replicateM_ 50 $ do
27− i <- next
28+ -- i <- next
28− i `shouldBe` st + 2
29+ -- i `shouldBe` st + 2
29
30
30− threadDelay 60000
31+ -- threadDelay 60000
31− last1 <- readIORef ref
32+ -- last1 <- readIORef ref
32− threadDelay 20000
33+ -- threadDelay 20000
33− last2 <- readIORef ref
34+ -- last2 <- readIORef ref
34− last2 `shouldBe` last1
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 @@
1module Control.ReaperSpec (spec) where
1module Control.ReaperSpec (spec) where
2
2
3−import Control.Reaper
4import Control.Concurrent
3import Control.Concurrent
4+import Control.Reaper
5+import Data.IORef
5import Test.Hspec
6import Test.Hspec
6import Test.Hspec.QuickCheck
7import Test.Hspec.QuickCheck
7−import Data.IORef
8
8
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
16
9
17spec :: Spec
10spec :: Spec
11+spec = return ()
18−spec = prop "works" $ \is -> do
12+-- prop "works" $ \is -> do
19− reaper <- mkReaper defaultReaperSettings
13+-- reaper <- mkReaper defaultReaperSettings
20− { reaperAction = action
14+-- { reaperAction = action
21− , reaperDelay = 1000
15+-- , reaperDelay = 1000
22− }
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 ()
23
32
24− let mkTestCase i = do
33+-- type Item = (Int, IORef Int)
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
30
34
31− let test (expected, ref) = do
35+-- action = mkListAction $ \(i, ref) -> do
32− actual <- readIORef ref
36+-- modifyIORef ref succ
33− actual `shouldBe` (expected :: Int)
34− threadDelay 100000
35− mapM_ test testCases
36− [] <- reaperRead reaper
37− return ()
37+-- return $ if i > 1
38+-- then Just (pred i, ref)
39+-- else Nothing
mime-types/ChangeLog.md+12
@@ -1,3 +1,15 @@
1+## 0.1.0.9
2+
3+* Add mjs mime type
4+
5+## 0.1.0.8
6+
7+* Add wasm mime type
8+
9+## 0.1.0.7
10+
11+* Add support for .less files [#534](https://github.com/yesodweb/wai/pull/534)
12+
1## 0.1.0.6
13## 0.1.0.6
2
14
3* Add woff2 mime type [#350](https://github.com/yesodweb/wai/pull/350)
15* Add woff2 mime type [#350](https://github.com/yesodweb/wai/pull/350)
mime-types/Network/Mime.hs+7
@@ -468,6 +468,11 @@ defaultMimeMap = Map.fromAscList [
468 , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
468 , ("lbd", "application/vnd.llamagraphics.life-balance.desktop")
469 , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
469 , ("lbe", "application/vnd.llamagraphics.life-balance.exchange+xml")
470 , ("les", "application/vnd.hhe.lesson-player")
470 , ("les", "application/vnd.hhe.lesson-player")
471+
472+ -- Added after deliberation in PR (https://github.com/yesodweb/wai/pull/534)
473+ -- Accepted mainly because of StackOverflow (http://stackoverflow.com/questions/7319555/how-to-add-less-to-iis-7-0)
474+ , ("less", "text/css")
475+
471 , ("lha", "application/x-lzh-compressed")
476 , ("lha", "application/x-lzh-compressed")
472 , ("link66", "application/vnd.route66.link66+xml")
477 , ("link66", "application/vnd.route66.link66+xml")
473 , ("list", "text/plain")
478 , ("list", "text/plain")
@@ -526,6 +531,7 @@ defaultMimeMap = Map.fromAscList [
526 , ("mime", "message/rfc822")
531 , ("mime", "message/rfc822")
527 , ("mj2", "video/mj2")
532 , ("mj2", "video/mj2")
528 , ("mjp2", "video/mj2")
533 , ("mjp2", "video/mj2")
534+ , ("mjs", "application/javascript")
529 , ("mk3d", "video/x-matroska")
535 , ("mk3d", "video/x-matroska")
530 , ("mka", "audio/x-matroska")
536 , ("mka", "audio/x-matroska")
531 , ("mks", "video/x-matroska")
537 , ("mks", "video/x-matroska")
@@ -974,6 +980,7 @@ defaultMimeMap = Map.fromAscList [
974 , ("w3d", "application/x-director")
980 , ("w3d", "application/x-director")
975 , ("wad", "application/x-doom")
981 , ("wad", "application/x-doom")
976 , ("war", "application/java-archive")
982 , ("war", "application/java-archive")
983+ , ("wasm", "application/wasm")
977 , ("wav", "audio/x-wav")
984 , ("wav", "audio/x-wav")
978 , ("wax", "audio/x-ms-wax")
985 , ("wax", "audio/x-ms-wax")
979 , ("wbmp", "image/vnd.wap.wbmp")
986 , ("wbmp", "image/vnd.wap.wbmp")
mime-types/mime-types.cabal+1−1
@@ -1,5 +1,5 @@
1name: mime-types
1name: mime-types
2−version: 0.1.0.6
2+version: 0.1.0.9
3synopsis: Basic mime-type handling types and functions
3synopsis: Basic mime-type handling types and functions
4description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
4description: API docs and the README are available at <http://www.stackage.org/package/mime-types>.
5homepage: https://github.com/yesodweb/wai
5homepage: https://github.com/yesodweb/wai
sources.txtdeleted−11
@@ -1,11 +0,0 @@
1−./wai
2−./wai-extra
3−./warp
4−./warp-tls
5−./wai-app-static
6−./wai-handler-fastcgi
7−./wai-handler-launch
8−./wai-websockets
9−./wai-conduit
10−./mime-types
11−./auto-update
stack-lts-11.yamlnew file+27
@@ -0,0 +1,27 @@
1+resolver: lts-11.21
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+extra-deps:
17+- streaming-commons-0.2.1.0@sha256:163af02944f374f316e35257c1afbffefd2c2852a85a151d1ea0ad22152cf28d,4990
18+- http2-2.0.0
19+- network-byte-order-0.1.1.0
20+- tls-1.5.3
21+- tls-session-manager-0.0.4
22+- x509-1.7.5
23+nix:
24+ enable: false
25+ packages:
26+ - fcgi
27+ - zlib
stack-lts-12.yamlnew file+26
@@ -0,0 +1,26 @@
1+resolver: lts-12.6
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
21+extra-deps:
22+- http2-2.0.0
23+- network-byte-order-0.1.1.0
24+- tls-1.5.3
25+- tls-session-manager-0.0.4
26+- x509-1.7.5
stack-nightly.yamlnew file+20
@@ -0,0 +1,20 @@
1+resolver: nightly-2020-01-08
2+packages:
3+- ./auto-update
4+- ./mime-types
5+- ./wai
6+- ./wai-extra
7+- ./warp
8+- ./warp-tls
9+- ./wai-app-static
10+- ./wai-websockets
11+- ./wai-conduit
12+- ./time-manager
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
stack.yaml+16−6
@@ -1,15 +1,25 @@
1−resolver: lts-4.1
1+resolver: lts-14.22
2packages:
2packages:
3+- ./auto-update
4+- ./mime-types
3- ./wai
5- ./wai
4- ./wai-extra
6- ./wai-extra
5- ./warp
7- ./warp
6- ./warp-tls
8- ./warp-tls
7- ./wai-app-static
9- ./wai-app-static
8−- ./wai-handler-fastcgi
9−- ./wai-handler-launch
10- ./wai-websockets
10- ./wai-websockets
11- ./wai-conduit
11- ./wai-conduit
12−- ./mime-types
12+- ./time-manager
13−- ./auto-update
13+flags:
14+ wai-extra:
15+ build-example: true
16+nix:
17+ enable: false
18+ packages:
19+ - fcgi
20+ - zlib
14extra-deps:
21extra-deps:
15−- http2-1.5.0
22+- http2-2.0.0
23+- network-byte-order-0.1.1.0
24+- tls-1.5.3
25+- tls-session-manager-0.0.4
wai-handler-fastcgi/LICENSE → time-manager/LICENSErenamed

The content is the same.

warp/Network/Wai/Handler/Warp/Timeout.hs → time-manager/System/TimeManager.hsrenamed+11−8
@@ -1,6 +1,6 @@
1{-# LANGUAGE DeriveDataTypeable #-}
1{-# LANGUAGE DeriveDataTypeable #-}
2
2
3−module Network.Wai.Handler.Warp.Timeout (
3+module System.TimeManager (
4 -- ** Types
4 -- ** Types
5 Manager
5 Manager
6 , TimeoutAction
6 , TimeoutAction
@@ -26,8 +26,8 @@ import Control.Concurrent (myThreadId)
26import qualified Control.Exception as E
26import qualified Control.Exception as E
27import Control.Reaper
27import Control.Reaper
28import Data.Typeable (Typeable)
28import Data.Typeable (Typeable)
29−import Network.Wai.Handler.Warp.IORef (IORef)
29+import Data.IORef (IORef)
30−import qualified Network.Wai.Handler.Warp.IORef as I
30+import qualified Data.IORef as I
31
31
32----------------------------------------------------------------
32----------------------------------------------------------------
33
33
@@ -97,21 +97,24 @@ register mgr onTimeout = do
97 return h
97 return h
98
98
99-- | Registering a timeout action of killing this thread.
99-- | Registering a timeout action of killing this thread.
100−registerKillThread :: Manager -> IO Handle
100+registerKillThread :: Manager -> TimeoutAction -> IO Handle
101−registerKillThread m = do
101+registerKillThread m onTimeout = do
102 -- If we hold ThreadId, the stack and data of the thread is leaked.
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
103 -- If we hold Weak ThreadId, the stack is released. However, its
104 -- data is still leaked probably because of a bug of GHC.
104 -- data is still leaked probably because of a bug of GHC.
105 -- So, let's just use ThreadId and release ThreadId by
105 -- So, let's just use ThreadId and release ThreadId by
106 -- overriding the timeout action by "cancel".
106 -- overriding the timeout action by "cancel".
107 tid <- myThreadId
107 tid <- myThreadId
108+ -- First run the timeout action in case the child thread is masked.
108− register m $ E.throwTo tid TimeoutThread
109+ register m $ onTimeout `E.finally` E.throwTo tid TimeoutThread
109
110
110data TimeoutThread = TimeoutThread
111data TimeoutThread = TimeoutThread
111 deriving Typeable
112 deriving Typeable
112−instance E.Exception TimeoutThread
113+instance E.Exception TimeoutThread where
114+ toException = E.asyncExceptionToException
115+ fromException = E.asyncExceptionFromException
113instance Show TimeoutThread where
116instance Show TimeoutThread where
114− show TimeoutThread = "Thread killed by Warp's timeout reaper"
117+ show TimeoutThread = "Thread killed by timeout manager"
115
118
116----------------------------------------------------------------
119----------------------------------------------------------------
117
120
time-manager/time-manager.cabalnew file+19
@@ -0,0 +1,19 @@
1+Name: time-manager
2+Version: 0.0.0
3+Synopsis: Scalable timer
4+License: MIT
5+License-file: LICENSE
6+Author: Michael Snoyman and Kazu Yamamoto
7+Maintainer: kazu@iij.ad.jp
8+Homepage: http://github.com/yesodweb/wai
9+Category: System
10+Build-Type: Simple
11+Cabal-Version: >=1.8
12+Stability: Stable
13+Description: Scalable timer functions provided by a timer manager.
14+
15+Library
16+ Build-Depends: base >= 4.8 && < 5
17+ , auto-update
18+ Exposed-modules: System.TimeManager
19+ Ghc-Options: -Wall
wai-app-static/ChangeLog.md+33
@@ -1,3 +1,36 @@
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+
1## 3.1.4.1
34## 3.1.4.1
2
35
3* Support wai/warp 3.2
36* Support wai/warp 3.2
wai-app-static/Network/Wai/Application/Static.hs+48−42
@@ -34,7 +34,7 @@ import qualified Data.ByteString.Lazy as L
34import Data.ByteString.Lazy.Char8 ()
34import Data.ByteString.Lazy.Char8 ()
35import Control.Monad.IO.Class (liftIO)
35import Control.Monad.IO.Class (liftIO)
36
36
37−import Blaze.ByteString.Builder (toByteString)
37+import Data.ByteString.Builder (toLazyByteString)
38
38
39import Data.FileEmbed (embedFile)
39import Data.FileEmbed (embedFile)
40
40
@@ -87,14 +87,14 @@ serveFolder StaticSettings {..} pieces req folder@Folder {..} =
87 Nothing -> return $ WaiResponse $ W.responseLBS H.status403
87 Nothing -> return $ WaiResponse $ W.responseLBS H.status403
88 [ ("Content-Type", "text/plain")
88 [ ("Content-Type", "text/plain")
89 ] "Directory listings disabled"
89 ] "Directory listings disabled"
90+
91+addTrailingSlash :: W.Request -> Maybe ByteString
92+addTrailingSlash req
93+ | S8.null rp = Just "/"
94+ | S8.last rp == '/' = Nothing
95+ | otherwise = Just $ S8.snoc rp '/'
90 where
96 where
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
97+ rp = W.rawPathInfo req
98
98
99checkPieces :: StaticSettings
99checkPieces :: StaticSettings
100 -> Pieces -- ^ parsed request
100 -> Pieces -- ^ parsed request
@@ -108,45 +108,49 @@ checkPieces _ pieces _ | any (T.null . fromPiece) $ safeInit pieces =
108checkPieces ss@StaticSettings {..} pieces req = do
108checkPieces ss@StaticSettings {..} pieces req = do
109 res <- lookupResult
109 res <- lookupResult
110 case res of
110 case res of
111− Left location -> return $ RawRedirect $ TE.encodeUtf8 location
111+ Left location -> return $ RawRedirect location
112 Right LRNotFound -> return NotFound
112 Right LRNotFound -> return NotFound
113 Right (LRFile file) -> serveFile ss req file
113 Right (LRFile file) -> serveFile ss req file
114 Right (LRFolder folder) -> serveFolder ss pieces req folder
114 Right (LRFolder folder) -> serveFolder ss pieces req folder
115 where
115 where
116− lookupResult :: IO (Either Text LookupResult)
116+ lookupResult :: IO (Either ByteString LookupResult)
117 lookupResult = do
117 lookupResult = do
118 nonIndexResult <- ssLookupFile pieces
118 nonIndexResult <- ssLookupFile pieces
119 case nonIndexResult of
119 case nonIndexResult of
120 LRFile{} -> return $ Right nonIndexResult
120 LRFile{} -> return $ Right nonIndexResult
121 _ -> do
121 _ -> do
122− indexResult <- lookupIndices (map (\ index -> pieces ++ [index]) ssIndices)
122+ eIndexResult <- lookupIndices (map (\ index -> dropLastIfNull pieces ++ [index]) ssIndices)
123+ return $ case eIndexResult of
124+ Left redirect -> Left redirect
123− return $ case indexResult of
125+ Right indexResult -> case indexResult of
124− LRNotFound -> Right nonIndexResult
126+ LRNotFound -> Right nonIndexResult
125− LRFile file | ssRedirectToIndex ->
127+ LRFile file | ssRedirectToIndex ->
126− let relPath =
128+ let relPath =
127− case reverse pieces of
129+ case reverse pieces of
128− -- Served at root
130+ -- Served at root
129− [] -> fromPiece $ fileName file
131+ [] -> fromPiece $ fileName file
130− lastSegment:_ ->
132+ lastSegment:_ ->
131− case fromPiece lastSegment of
133+ case fromPiece lastSegment of
132− -- Ends with a trailing slash
134+ -- Ends with a trailing slash
133− "" -> fromPiece $ fileName file
135+ "" -> fromPiece $ fileName file
134− -- Lacks a trailing slash
136+ -- Lacks a trailing slash
135− lastSegment' -> T.concat
137+ lastSegment' -> T.concat
136− [ lastSegment'
138+ [ lastSegment'
137− , "/"
139+ , "/"
138− , fromPiece $ fileName file
140+ , fromPiece $ fileName file
139− ]
141+ ]
140− in Left relPath
142+ in Left $ TE.encodeUtf8 relPath
141− _ -> Right indexResult
143+ _ -> Right indexResult
142
144
143− lookupIndices :: [Pieces] -> IO LookupResult
145+ lookupIndices :: [Pieces] -> IO (Either ByteString LookupResult)
144 lookupIndices (x : xs) = do
146 lookupIndices (x : xs) = do
145 res <- ssLookupFile x
147 res <- ssLookupFile x
146 case res of
148 case res of
147 LRNotFound -> lookupIndices xs
149 LRNotFound -> lookupIndices xs
148− _ -> return res
150+ _ -> return $ case (ssAddTrailingSlash, addTrailingSlash req) of
151+ (True, Just redirect) -> Left redirect
152+ _ -> Right res
149− lookupIndices [] = return LRNotFound
153+ lookupIndices [] = return $ Right LRNotFound
150
154
151serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
155serveFile :: StaticSettings -> W.Request -> File -> IO StaticResponse
152serveFile StaticSettings {..} req file
156serveFile StaticSettings {..} req file
@@ -160,11 +164,13 @@ serveFile StaticSettings {..} req file
160 -- Didn't match, but we have a hash value. Send the file contents
164 -- Didn't match, but we have a hash value. Send the file contents
161 -- with an ETag header.
165 -- with an ETag header.
162 --
166 --
163− -- Note: It would be arguably better to next check
167+ -- RFC7232 (HTTP 1.1):
164− -- if-modified-since and return a 304 if that indicates a match as
168+ -- > A recipient MUST ignore If-Modified-Since if the request contains an
165− -- well. However, the circumstances under which such a situation
169+ -- > If-None-Match header field; the condition in If-None-Match is
166− -- could arise would be very anomolous, and should likely warrant a
170+ -- > considered to be a more accurate replacement for the condition in
167− -- new file being sent anyway.
171+ -- > If-Modified-Since, and the two are only combined for the sake of
172+ -- > interoperating with older intermediaries that might not implement
173+ -- > If-None-Match.
168 (Just hash, _) -> respond [("ETag", hash)]
174 (Just hash, _) -> respond [("ETag", hash)]
169
175
170 -- No hash value available, fall back to last modified support.
176 -- No hash value available, fall back to last modified support.
@@ -239,7 +245,7 @@ staticAppPieces ss rawPieces req sendResponse = liftIO $ do
239 response :: StaticResponse -> IO W.ResponseReceived
245 response :: StaticResponse -> IO W.ResponseReceived
240 response (FileResponse file ch) = do
246 response (FileResponse file ch) = do
241 mimetype <- ssGetMimeType ss file
247 mimetype <- ssGetMimeType ss file
242− let filesize = fileGetSize file
248+ -- let filesize = fileGetSize file
243 let headers = ("Content-Type", mimetype)
249 let headers = ("Content-Type", mimetype)
244 -- Let Warp provide the content-length, since it takes
250 -- Let Warp provide the content-length, since it takes
245 -- range requests into account
251 -- range requests into account
@@ -258,18 +264,18 @@ staticAppPieces ss rawPieces req sendResponse = liftIO $ do
258 ] lbs
264 ] lbs
259
265
260 response (Redirect pieces' mHash) = do
266 response (Redirect pieces' mHash) = do
261− 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')
262 let qString = case mHash of
268 let qString = case mHash of
263 Just hash -> replace "etag" (Just hash) (W.queryString req)
269 Just hash -> replace "etag" (Just hash) (W.queryString req)
264 Nothing -> remove "etag" (W.queryString req)
270 Nothing -> remove "etag" (W.queryString req)
265
271
266− sendResponse $ W.responseLBS H.status301
272+ sendResponse $ W.responseLBS H.status302
267 [ ("Content-Type", "text/plain")
273 [ ("Content-Type", "text/plain")
268 , ("Location", S8.append loc $ H.renderQuery True qString)
274 , ("Location", S8.append loc $ H.renderQuery True qString)
269 ] "Redirect"
275 ] "Redirect"
270
276
271 response (RawRedirect path) =
277 response (RawRedirect path) =
272− sendResponse $ W.responseLBS H.status301
278+ sendResponse $ W.responseLBS H.status302
273 [ ("Content-Type", "text/plain")
279 [ ("Content-Type", "text/plain")
274 , ("Location", path)
280 , ("Location", path)
275 ] "Redirect"
281 ] "Redirect"
wai-app-static/Util.hs+8−1
@@ -1,9 +1,10 @@
1−{-# LANGUAGE OverloadedStrings #-}
1+{-# LANGUAGE OverloadedStrings, ViewPatterns #-}
2module Util
2module Util
3 ( relativeDirFromPieces
3 ( relativeDirFromPieces
4 , defaultMkRedirect
4 , defaultMkRedirect
5 , replace
5 , replace
6 , remove
6 , remove
7+ , dropLastIfNull
7 ) where
8 ) where
8
9
9import WaiAppStatic.Types
10import WaiAppStatic.Types
@@ -36,3 +37,9 @@ defaultMkRedirect pieces newPath
36 | otherwise = relDir `S8.append` S8.tail newPath
37 | otherwise = relDir `S8.append` S8.tail newPath
37 where
38 where
38 relDir = TE.encodeUtf8 (relativeDirFromPieces pieces)
39 relDir = TE.encodeUtf8 (relativeDirFromPieces pieces)
40+
41+dropLastIfNull :: [Piece] -> [Piece]
42+dropLastIfNull pieces = case pieces of
43+ [fromPiece -> ""] -> []
44+ (a : r) -> a : dropLastIfNull r
45+ [] -> []
wai-app-static/WaiAppStatic/CmdLine.hs+8−1
@@ -25,6 +25,7 @@ import Network.Mime (defaultMimeMap, mimeByExt, defaultMimeType)
25import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
25import WaiAppStatic.Types (ssIndices, toPiece, ssGetMimeType, fileName, fromPiece)
26import Data.Maybe (mapMaybe)
26import Data.Maybe (mapMaybe)
27import Control.Arrow (second)
27import Control.Arrow (second)
28+import Data.Monoid ((<>))
28
29
29data Args = Args
30data Args = Args
30 { docroot :: FilePath
31 { docroot :: FilePath
@@ -38,6 +39,7 @@ data Args = Args
38 }
39 }
39
40
40#if MIN_VERSION_optparse_applicative(0, 10, 0)
41#if MIN_VERSION_optparse_applicative(0, 10, 0)
42+option' :: Mod OptionFields Int -> Parser Int
41option' = option auto
43option' = option auto
42#else
44#else
43option' = option
45option' = option
@@ -92,7 +94,7 @@ args = Args
92-- Since 2.0.1
94-- Since 2.0.1
93runCommandLine :: (Args -> Middleware) -> IO ()
95runCommandLine :: (Args -> Middleware) -> IO ()
94runCommandLine middleware = do
96runCommandLine middleware = do
95− args@Args {..} <- execParser $ info (helper <*> args) fullDesc
97+ args@Args {..} <- execParser $ info (helperOption <*> args) fullDesc
96 let mime' = map (pack *** S8.pack) mime
98 let mime' = map (pack *** S8.pack) mime
97 let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
99 let mimeMap = Map.fromList mime' `Map.union` defaultMimeMap
98 docroot' <- canonicalizePath docroot
100 docroot' <- canonicalizePath docroot
@@ -109,3 +111,8 @@ runCommandLine middleware = do
109 { ssIndices = if noindex then [] else mapMaybe (toPiece . pack) index
111 { ssIndices = if noindex then [] else mapMaybe (toPiece . pack) index
110 , ssGetMimeType = return . mimeByExt mimeMap defaultMimeType . fromPiece . fileName
112 , ssGetMimeType = return . mimeByExt mimeMap defaultMimeType . fromPiece . fileName
111 }
113 }
114+ where
115+ helperOption :: Parser (a -> a)
116+ helperOption =
117+ abortOption ShowHelpText $
118+ mconcat [long "help", help "Show this help text", hidden]
wai-app-static/WaiAppStatic/Listing.hs+2−2
@@ -22,7 +22,7 @@ import qualified Text.Blaze.Html.Renderer.Utf8 as HU
22
22
23-- | Provides a default directory listing, suitable for most apps.
23-- | Provides a default directory listing, suitable for most apps.
24--
24--
25−-- Code below taken from Happstack: <http://patch-tag.com/r/mae/happstack/snapshot/current/content/pretty/happstack-server/src/Happstack/Server/FileServe/BuildingBlocks.hs>
25+-- Code below taken from Happstack: <https://github.com/Happstack/happstack-server/blob/87e6c01a65c687d06c61345430a112fc9a444a95/src/Happstack/Server/FileServe/BuildingBlocks.hs>
26defaultListing :: Listing
26defaultListing :: Listing
27defaultListing pieces (Folder contents) = do
27defaultListing pieces (Folder contents) = do
28 let isTop = null pieces || map Just pieces == [toPiece ""]
28 let isTop = null pieces || map Just pieces == [toPiece ""]
@@ -64,7 +64,7 @@ defaultListing pieces (Folder contents) = do
64
64
65 -- Add a link to the root of the tree
65 -- Add a link to the root of the tree
66 showFolder' :: Bool -> Pieces -> H.Html
66 showFolder' :: Bool -> Pieces -> H.Html
67− showFolder' hasTrailingSlash pieces = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces)
67+ showFolder' hasTrailingSlash pieces' = showFolder hasTrailingSlash (unsafeToPiece "root" : pieces')
68
68
69 showFolder :: Bool -> Pieces -> H.Html
69 showFolder :: Bool -> Pieces -> H.Html
70 showFolder _ [] = "/" -- won't happen
70 showFolder _ [] = "/" -- won't happen
wai-app-static/WaiAppStatic/Storage/Embedded/Runtime.hs+7−8
@@ -8,7 +8,7 @@ import WaiAppStatic.Types
8import Data.ByteString (ByteString)
8import Data.ByteString (ByteString)
9import Control.Arrow ((&&&), second)
9import Control.Arrow ((&&&), second)
10import Data.List
10import Data.List
11−import Blaze.ByteString.Builder (fromByteString)
11+import Data.ByteString.Builder (byteString)
12import qualified Network.Wai as W
12import qualified Network.Wai as W
13import qualified Data.Map as Map
13import qualified Data.Map as Map
14import Data.Function (on)
14import Data.Function (on)
@@ -16,8 +16,7 @@ import qualified Data.Text as T
16import Data.Ord
16import Data.Ord
17import qualified Data.ByteString as S
17import qualified Data.ByteString as S
18import Crypto.Hash (hash, MD5, Digest)
18import Crypto.Hash (hash, MD5, Digest)
19−import Data.Byteable (toBytes)
19+import Data.ByteArray.Encoding
20−import qualified Data.ByteString.Base64 as B64
21import WaiAppStatic.Storage.Filesystem (defaultFileServerSettings)
20import WaiAppStatic.Storage.Filesystem (defaultFileServerSettings)
22import System.FilePath (isPathSeparator)
21import System.FilePath (isPathSeparator)
23
22
@@ -50,8 +49,8 @@ embeddedLookup root pieces =
50toEntry :: (Piece, EmbeddedEntry) -> Either FolderName File
49toEntry :: (Piece, EmbeddedEntry) -> Either FolderName File
51toEntry (name, EEFolder{}) = Left name
50toEntry (name, EEFolder{}) = Left name
52toEntry (name, EEFile bs) = Right File
51toEntry (name, EEFile bs) = Right File
53− { fileGetSize = S.length bs
52+ { fileGetSize = fromIntegral $ S.length bs
54− , fileToResponse = \s h -> W.responseBuilder s h $ fromByteString bs
53+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
55 , fileName = name
54 , fileName = name
56 , fileGetHash = return $ Just $ runHash bs
55 , fileGetHash = return $ Just $ runHash bs
57 , fileGetModified = Nothing
56 , fileGetModified = Nothing
@@ -87,12 +86,12 @@ toEmbedded fps =
87
86
88bsToFile :: Piece -> ByteString -> File
87bsToFile :: Piece -> ByteString -> File
89bsToFile name bs = File
88bsToFile name bs = File
90− { fileGetSize = S.length bs
89+ { fileGetSize = fromIntegral $ S.length bs
91− , fileToResponse = \s h -> W.responseBuilder s h $ fromByteString bs
90+ , fileToResponse = \s h -> W.responseBuilder s h $ byteString bs
92 , fileName = name
91 , fileName = name
93 , fileGetHash = return $ Just $ runHash bs
92 , fileGetHash = return $ Just $ runHash bs
94 , fileGetModified = Nothing
93 , fileGetModified = Nothing
95 }
94 }
96
95
97runHash :: ByteString -> ByteString
96runHash :: 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(
5 , mkSettings
5 , mkSettings
6) where
6) where
7
7
8−import Blaze.ByteString.Builder.ByteString (insertByteString)
8+import Data.ByteString.Builder.Extra (byteStringInsert)
9import Codec.Compression.GZip (compress)
9import Codec.Compression.GZip (compress)
10−import Control.Applicative
11import Data.ByteString.Unsafe (unsafePackAddressLen)
10import Data.ByteString.Unsafe (unsafePackAddressLen)
12import Data.Either (lefts, rights)
11import Data.Either (lefts, rights)
13import GHC.Exts (Int(..))
12import GHC.Exts (Int(..))
@@ -130,7 +129,7 @@ embeddedToFile entry = File
130 let h' = if embCompressed entry
129 let h' = if embCompressed entry
131 then h ++ [("Content-Encoding", "gzip")]
130 then h ++ [("Content-Encoding", "gzip")]
132 else h
131 else h
133− in W.responseBuilder s h' $ insertByteString $ embContent entry
132+ in W.responseBuilder s h' $ byteStringInsert $ embContent entry
134
133
135 -- Usually the fileName should just be the filename not the entire path,
134 -- Usually the fileName should just be the filename not the entire path,
136 -- but we need the whole path to make the lookup within lookupMime
135 -- but we need the whole path to make the lookup within lookupMime
wai-app-static/WaiAppStatic/Storage/Filesystem.hs+9−7
@@ -1,5 +1,6 @@
1{-# LANGUAGE ScopedTypeVariables #-}
1{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3+{-# LANGUAGE BangPatterns #-}
3-- | Access files on the filesystem.
4-- | Access files on the filesystem.
4module WaiAppStatic.Storage.Filesystem
5module WaiAppStatic.Storage.Filesystem
5 ( -- * Types
6 ( -- * Types
@@ -12,6 +13,7 @@ module WaiAppStatic.Storage.Filesystem
12
13
13import WaiAppStatic.Types
14import WaiAppStatic.Types
14import System.FilePath ((</>))
15import System.FilePath ((</>))
16+import System.IO (withBinaryFile, IOMode(..))
15import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
17import System.Directory (doesFileExist, doesDirectoryExist, getDirectoryContents)
16import Data.List (foldl')
18import Data.List (foldl')
17import Control.Monad (forM)
19import Control.Monad (forM)
@@ -23,10 +25,9 @@ import WaiAppStatic.Listing
23import Network.Mime
25import Network.Mime
24import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
26import System.PosixCompat.Files (fileSize, getFileStatus, modificationTime, isRegularFile)
25import Data.Maybe (catMaybes)
27import Data.Maybe (catMaybes)
26−import qualified Crypto.Hash.Conduit (hashFile)
28+import Data.ByteArray.Encoding
27−import Data.Byteable (toBytes)
28−import Crypto.Hash (MD5, Digest)
29+import Crypto.Hash (hashlazy, MD5, Digest)
29−import qualified Data.ByteString.Base64 as B64
30+import qualified Data.ByteString.Lazy as BL (hGetContents)
30import qualified Data.Text as T
31import qualified Data.Text as T
31
32
32-- | Construct a new path from a root and some @Pieces@.
33-- | Construct a new path from a root and some @Pieces@.
@@ -119,9 +120,10 @@ webAppLookup hashFunc prefix pieces =
119-- | MD5 hash and base64-encode the file contents. Does not check if the file
120-- | MD5 hash and base64-encode the file contents. Does not check if the file
120-- exists.
121-- exists.
121hashFile :: FilePath -> IO ByteString
122hashFile :: FilePath -> IO ByteString
122−hashFile fp = do
123+hashFile fp = withBinaryFile fp ReadMode $ \h -> do
123− h <- Crypto.Hash.Conduit.hashFile fp
124+ f <- BL.hGetContents h
124− return $ B64.encode $ toBytes (h :: Digest MD5)
125+ let !hash = hashlazy f :: Digest MD5
126+ return $ convertToBase Base64 hash
125
127
126hashFileIfExists :: ETagLookup
128hashFileIfExists :: ETagLookup
127hashFileIfExists fp = do
129hashFileIfExists fp = do
wai-app-static/WaiAppStatic/Types.hs+4−3
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2module WaiAppStatic.Types
1module WaiAppStatic.Types
3 ( -- * Pieces
2 ( -- * Pieces
4 Piece
3 Piece
@@ -25,7 +24,7 @@ import qualified Network.Wai as W
25import Data.ByteString (ByteString)
24import Data.ByteString (ByteString)
26import System.Posix.Types (EpochTime)
25import System.Posix.Types (EpochTime)
27import qualified Data.Text as T
26import qualified Data.Text as T
28−import Blaze.ByteString.Builder (Builder)
27+import Data.ByteString.Builder (Builder)
29import Network.Mime (MimeType)
28import Network.Mime (MimeType)
30
29
31-- | An individual component of a path, or of a filepath.
30-- | An individual component of a path, or of a filepath.
@@ -60,6 +59,8 @@ toPieces :: [Text] -> Maybe Pieces
60toPieces = mapM toPiece
59toPieces = mapM toPiece
61
60
62-- | Request coming from a user. Corresponds to @pathInfo@.
61-- | Request coming from a user. Corresponds to @pathInfo@.
62+--
63+-- The root path is the empty list.
63type Pieces = [Piece]
64type Pieces = [Piece]
64
65
65-- | Values for the max-age component of the cache-control response header.
66-- | Values for the max-age component of the cache-control response header.
@@ -79,7 +80,7 @@ data Folder = Folder
79-- | Information on an individual file.
80-- | Information on an individual file.
80data File = File
81data File = File
81 { -- | Size of file in bytes
82 { -- | Size of file in bytes
82− fileGetSize :: Int
83+ fileGetSize :: Integer
83 -- | How to construct a WAI response for this file. Some files are stored
84 -- | How to construct a WAI response for this file. Some files are stored
84 -- on the filesystem and can use @ResponseFile@, while others are stored
85 -- on the filesystem and can use @ResponseFile@, while others are stored
85 -- in memory and should use @ResponseBuilder@.
86 -- in memory and should use @ResponseBuilder@.
wai-app-static/test/EmbeddedTestEntries.hs+5
@@ -47,4 +47,9 @@ mkEntries = return
47 , EmbeddableEntry "index.html"
47 , EmbeddableEntry "index.html"
48 "text/html"
48 "text/html"
49 (Right [| return ("" :: T.Text, "index file") |] )
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") |] )
50 ]
55 ]
wai-app-static/test/WaiAppEmbeddedTest.hs+9
@@ -41,6 +41,15 @@ embSpec = do
41 assertStatus 200 req
41 assertStatus 200 req
42 assertBody "index file" req
42 assertBody "index file" req
43
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+
44 describe "embedded, uncompressed entry" $ do
53 describe "embedded, uncompressed entry" $ do
45 it "too short" $ embed $ do
54 it "too short" $ embed $ do
46 req <- request (setRawPathInfo defRequest "e2.txt")
55 req <- request (setRawPathInfo defRequest "e2.txt")
wai-app-static/test/WaiAppStaticTest.hs+19−8
@@ -5,6 +5,7 @@ import Network.Wai.Application.Static
5import WaiAppStatic.Types
5import WaiAppStatic.Types
6
6
7import Test.Hspec
7import Test.Hspec
8+import Test.Mockery.Directory
8import qualified Data.ByteString.Char8 as S8
9import qualified Data.ByteString.Char8 as S8
9-- import qualified Data.ByteString.Lazy.Char8 as L8
10-- import qualified Data.ByteString.Lazy.Char8 as L8
10import System.PosixCompat.Files (getFileStatus, modificationTime)
11import System.PosixCompat.Files (getFileStatus, modificationTime)
@@ -56,22 +57,22 @@ spec = do
56 assertStatus 200 =<<
57 assertStatus 200 =<<
57 request (setRawPathInfo defRequest path)
58 request (setRawPathInfo defRequest path)
58
59
59− it "404 for non-existant files" $ webApp $
60+ it "404 for non-existent files" $ webApp $
60 assertStatus 404 =<<
61 assertStatus 404 =<<
61 request (setRawPathInfo defRequest "doesNotExist")
62 request (setRawPathInfo defRequest "doesNotExist")
62
63
63− it "301 redirect when multiple slashes" $ webApp $ do
64+ it "302 redirect when multiple slashes" $ webApp $ do
64 req <- request (setRawPathInfo defRequest "a//b/c")
65 req <- request (setRawPathInfo defRequest "a//b/c")
65− assertStatus 301 req
66+ assertStatus 302 req
66 assertHeader "Location" "../../a/b/c" req
67 assertHeader "Location" "../../a/b/c" req
67
68
68 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
69 let absoluteApp = flip runSession $ staticApp $ (defaultWebAppSettings "test") {
69 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
70 ssMkRedirect = \_ u -> S8.append "http://www.example.com" u
70 }
71 }
71− it "301 redirect when multiple slashes" $ absoluteApp $
72+ it "302 redirect when multiple slashes" $ absoluteApp $
72 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
73 flip mapM_ ["/a//b/c", "a//b/c"] $ \path -> do
73 req <- request (setRawPathInfo defRequest path)
74 req <- request (setRawPathInfo defRequest path)
74− assertStatus 301 req
75+ assertStatus 302 req
75 assertHeader "Location" "http://www.example.com/a/b/c" req
76 assertHeader "Location" "http://www.example.com/a/b/c" req
76
77
77 describe "webApp when requesting a static asset" $ do
78 describe "webApp when requesting a static asset" $ do
@@ -130,12 +131,22 @@ spec = do
130 assertStatus 304 req
131 assertStatus 304 req
131 assertNoHeader "Cache-Control" req
132 assertNoHeader "Cache-Control" req
132
133
133− context "301 redirect to add a trailing slash on directories if missing" $ do
134+ context "302 redirect to add a trailing slash on directories if missing" $ do
134 it "works at the root" $ fileServerApp $ do
135 it "works at the root" $ fileServerApp $ do
135 req <- request (setRawPathInfo defRequest "/a")
136 req <- request (setRawPathInfo defRequest "/a")
136− assertStatus 301 req
137+ assertStatus 302 req
137 assertHeader "Location" "/a/" req
138 assertHeader "Location" "/a/" req
138
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+
139 let urlMapApp = flip runSession $ \req send ->
150 let urlMapApp = flip runSession $ \req send ->
140 case pathInfo req of
151 case pathInfo req of
141 "subPath":rest ->
152 "subPath":rest ->
@@ -147,7 +158,7 @@ spec = do
147 "urlMapApp: only works at subPath"
158 "urlMapApp: only works at subPath"
148 it "works with subpath at the root of the file server" $ urlMapApp $ do
159 it "works with subpath at the root of the file server" $ urlMapApp $ do
149 req <- request (setRawPathInfo defRequest "/subPath")
160 req <- request (setRawPathInfo defRequest "/subPath")
150− assertStatus 301 req
161+ assertStatus 302 req
151 assertHeader "Location" "/subPath/" req
162 assertHeader "Location" "/subPath/" req
152
163
153 context "with defaultWebAppSettings" $ do
164 context "with defaultWebAppSettings" $ do
wai-app-static/wai-app-static.cabal+8−11
@@ -1,5 +1,5 @@
1name: wai-app-static
1name: wai-app-static
2−version: 3.1.4.1
2+version: 3.1.7.1
3license: MIT
3license: MIT
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>
5author: Michael Snoyman <michael@snoyman.com>
@@ -27,7 +27,7 @@ Flag print
27library
27library
28 build-depends: base >= 4 && < 5
28 build-depends: base >= 4 && < 5
29 , wai >= 3.0 && < 3.3
29 , wai >= 3.0 && < 3.3
30− , bytestring >= 0.9.1.4
30+ , bytestring >= 0.10.4
31 , http-types >= 0.7
31 , http-types >= 0.7
32 , transformers >= 0.2.2
32 , transformers >= 0.2.2
33 , unix-compat >= 0.2
33 , unix-compat >= 0.2
@@ -37,10 +37,8 @@ library
37 , old-locale >= 1.0.0.2
37 , old-locale >= 1.0.0.2
38 , file-embed >= 0.0.3.1
38 , file-embed >= 0.0.3.1
39 , text >= 0.7
39 , text >= 0.7
40− , blaze-builder >= 0.2.1.4
40+ , cryptonite >= 0.6
41− , base64-bytestring >= 0.1
41+ , memory >= 0.7
42− , byteable
43− , cryptohash >= 0.11
44 , http-date
42 , http-date
45 , blaze-html >= 0.5
43 , blaze-html >= 0.5
46 , blaze-markup >= 0.5.1
44 , blaze-markup >= 0.5.1
@@ -51,9 +49,7 @@ library
51 , filepath
49 , filepath
52 , wai-extra >= 3.0 && < 3.1
50 , wai-extra >= 3.0 && < 3.1
53 , optparse-applicative >= 0.7
51 , optparse-applicative >= 0.7
54− , warp >= 3.0.11 && < 3.3
52+ , warp >= 3.0.11 && < 3.4
55− -- Used exclusively for hashFile function
56− , cryptohash-conduit
57
53
58 exposed-modules: Network.Wai.Application.Static
54 exposed-modules: Network.Wai.Application.Static
59 WaiAppStatic.Storage.Filesystem
55 WaiAppStatic.Storage.Filesystem
@@ -77,7 +73,7 @@ Executable warp
77 , wai-app-static
73 , wai-app-static
78 , directory >= 1.0
74 , directory >= 1.0
79 , containers >= 0.2
75 , containers >= 0.2
80− , bytestring >= 0.9.1.4
76+ , bytestring >= 0.10.4
81 , text >= 0.7
77 , text >= 0.7
82 , mime-types >= 0.1 && < 0.2
78 , mime-types >= 0.1 && < 0.2
83
79
@@ -104,8 +100,9 @@ test-suite runtests
104 , zlib
100 , zlib
105 , filepath
101 , filepath
106 , temporary
102 , temporary
103+ , mockery
107 -- , containers
104 -- , containers
108− ghc-options: -Wall
105+ ghc-options: -Wall
109
106
110source-repository head
107source-repository head
111 type: git
108 type: git
wai-conduit/ChangeLog.md+4
@@ -1,3 +1,7 @@
1+## 3.0.0.4
2+
3+* Drop dependency on blaze-builder
4+
1## 3.0.0.3
5## 3.0.0.3
2
6
3* Support wai 3.2
7* Support wai 3.2
wai-conduit/Network/Wai/Conduit.hs+6−7
@@ -16,18 +16,17 @@ import Data.ByteString (ByteString)
16import qualified Data.ByteString as S
16import qualified Data.ByteString as S
17import Control.Monad (unless)
17import Control.Monad (unless)
18import Network.HTTP.Types
18import Network.HTTP.Types
19−import Blaze.ByteString.Builder (Builder)
19+import Data.ByteString.Builder (Builder)
20−import Data.IORef
21import qualified Data.Conduit.List as CL
20import qualified Data.Conduit.List as CL
22
21
23-- | Stream the request body.
22-- | Stream the request body.
24--
23--
25-- Since 3.0.0
24-- Since 3.0.0
26−sourceRequestBody :: MonadIO m => Request -> Source m ByteString
25+sourceRequestBody :: MonadIO m => Request -> ConduitT () ByteString m ()
27sourceRequestBody req =
26sourceRequestBody req =
28 loop
27 loop
29 where
28 where
30− go = liftIO (requestBody req)
29+ go = liftIO (getRequestBodyChunk req)
31
30
32 loop = do
31 loop = do
33 bs <- go
32 bs <- go
@@ -38,9 +37,9 @@ sourceRequestBody req =
38-- | Create an HTTP response out of a @Source@.
37-- | Create an HTTP response out of a @Source@.
39--
38--
40-- Since 3.0.0
39-- Since 3.0.0
41−responseSource :: Status -> ResponseHeaders -> Source IO (Flush Builder) -> Response
40+responseSource :: Status -> ResponseHeaders -> ConduitT () (Flush Builder) IO () -> Response
42responseSource s hs src = responseStream s hs $ \send flush ->
41responseSource s hs src = responseStream s hs $ \send flush ->
43− src $$ CL.mapM_ (\mbuilder ->
42+ runConduit $ src .| CL.mapM_ (\mbuilder ->
44 case mbuilder of
43 case mbuilder of
45 Chunk b -> send b
44 Chunk b -> send b
46 Flush -> flush)
45 Flush -> flush)
@@ -50,7 +49,7 @@ responseSource s hs src = responseStream s hs $ \send flush ->
50--
49--
51-- Since 3.0.0
50-- Since 3.0.0
52responseRawSource :: (MonadIO m, MonadIO n)
51responseRawSource :: (MonadIO m, MonadIO n)
53− => (Source m ByteString -> Sink ByteString n () -> IO ())
52+ => (ConduitT () ByteString m () -> ConduitT ByteString Void n () -> IO ())
54 -> Response
53 -> Response
55 -> Response
54 -> Response
56responseRawSource app =
55responseRawSource app =
wai-conduit/example/Main.hsnew file+19
@@ -0,0 +1,19 @@
1+#!/usr/bin/env stack
2+-- stack --resolver lts-11.10 script
3+import Network.Wai
4+import Network.Wai.Handler.Warp
5+import Network.Wai.Conduit
6+import Network.HTTP.Types
7+import Conduit
8+import Data.ByteString.Builder (byteString)
9+import Control.Monad.Trans.Resource
10+
11+main :: IO ()
12+main = run 3000 app
13+
14+app :: Application
15+app _req respond =
16+ runResourceT $ withInternalState $ \is ->
17+ respond $ responseSource status200 [] $
18+ transPipe (`runInternalState` is) (sourceFile "Main.hs") .|
19+ mapC (Chunk . byteString)
wai-conduit/wai-conduit.cabal+2−3
@@ -1,5 +1,5 @@
1name: wai-conduit
1name: wai-conduit
2−version: 3.0.0.3
2+version: 3.0.0.4
3synopsis: conduit wrappers for WAI
3synopsis: conduit wrappers for WAI
4description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
4description: API docs and the README are available at <http://www.stackage.org/package/wai-conduit>.
5homepage: https://github.com/yesodweb/wai
5homepage: https://github.com/yesodweb/wai
@@ -18,7 +18,6 @@ library
18 , wai >= 3.0 && < 3.3
18 , wai >= 3.0 && < 3.3
19 , conduit
19 , conduit
20 , transformers
20 , transformers
21− , bytestring
21+ , bytestring >= 0.10.4
22 , http-types
22 , http-types
23− , blaze-builder
24 default-language: Haskell2010
23 default-language: Haskell2010
wai-extra/ChangeLog.md+128
@@ -1,3 +1,131 @@
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+
1## 3.0.14.1
129## 3.0.14.1
2
130
3* Doc update for logStdout and logStdoutDev [#515](https://github.com/yesodweb/wai/issues/515)
131* Doc update for logStdout and logStdoutDev [#515](https://github.com/yesodweb/wai/issues/515)
wai-extra/Network/Wai/EventSource.hs+24−1
@@ -1,10 +1,18 @@
1{-|
1{-|
2 A WAI adapter to the HTML5 Server-Sent Events API.
2 A WAI adapter to the HTML5 Server-Sent Events API.
3+
4+ If running through a proxy like Nginx you might need to add the
5+ headers:
6+
7+ > [ ("X-Accel-Buffering", "no"), ("Cache-Control", "no-cache")]
8+
9+ There is a small example using these functions in the @example@ directory.
3-}
10-}
4module Network.Wai.EventSource (
11module Network.Wai.EventSource (
5 ServerEvent(..),
12 ServerEvent(..),
6 eventSourceAppChan,
13 eventSourceAppChan,
7− eventSourceAppIO
14+ eventSourceAppIO,
15+ eventStreamAppRaw
8 ) where
16 ) where
9
17
10import Data.Function (fix)
18import Data.Function (fix)
@@ -34,3 +42,18 @@ eventSourceAppIO src _ sendResponse =
34 case eventToBuilder se of
42 case eventToBuilder se of
35 Nothing -> return ()
43 Nothing -> return ()
36 Just b -> sendChunk b >> flush >> loop
44 Just b -> sendChunk b >> flush >> loop
45+
46+-- | Make a new WAI EventSource application with a handler that emits events.
47+--
48+-- @since 3.0.28
49+eventStreamAppRaw :: ((ServerEvent -> IO()) -> IO () -> IO ()) -> Application
50+eventStreamAppRaw handler _ sendResponse =
51+ sendResponse $ responseStream
52+ status200
53+ [(hContentType, "text/event-stream")]
54+ $ \sendChunk flush -> handler (sendEvent sendChunk) flush
55+ where
56+ sendEvent sendChunk event =
57+ case eventToBuilder event of
58+ Nothing -> return ()
59+ Just b -> sendChunk b
wai-extra/Network/Wai/EventSource/EventStream.hs+9−10
@@ -1,5 +1,5 @@
1{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
2−{- code adapted by Mathias Billman originaly from Chris Smith https://github.com/cdsmith/gloss-web -}
2+{- code adapted by Mathias Billman originally from Chris Smith https://github.com/cdsmith/gloss-web -}
3
3
4{-|
4{-|
5 Internal module, usually you don't need to use it.
5 Internal module, usually you don't need to use it.
@@ -9,8 +9,7 @@ module Network.Wai.EventSource.EventStream (
9 eventToBuilder
9 eventToBuilder
10 ) where
10 ) where
11
11
12−import Blaze.ByteString.Builder
13−import Blaze.ByteString.Builder.Char8
12+import Data.ByteString.Builder
14#if __GLASGOW_HASKELL__ < 710
13#if __GLASGOW_HASKELL__ < 710
15import Data.Monoid
14import Data.Monoid
16#endif
15#endif
@@ -39,18 +38,18 @@ data ServerEvent
39 Newline as a Builder.
38 Newline as a Builder.
40-}
39-}
41nl :: Builder
40nl :: Builder
42−nl = fromChar '\n'
41+nl = char7 '\n'
43
42
44
43
45{-|
44{-|
46 Field names as Builder
45 Field names as Builder
47-}
46-}
48nameField, idField, dataField, retryField, commentField :: Builder
47nameField, idField, dataField, retryField, commentField :: Builder
49−nameField = fromString "event:"
48+nameField = string7 "event:"
50−idField = fromString "id:"
49+idField = string7 "id:"
51−dataField = fromString "data:"
50+dataField = string7 "data:"
52−retryField = fromString "retry:"
51+retryField = string7 "retry:"
53−commentField = fromChar ':'
52+commentField = char7 ':'
54
53
55
54
56{-|
55{-|
@@ -66,7 +65,7 @@ field l b = l `mappend` b `mappend` nl
66-}
65-}
67eventToBuilder :: ServerEvent -> Maybe Builder
66eventToBuilder :: ServerEvent -> Maybe Builder
68eventToBuilder (CommentEvent txt) = Just $ field commentField txt
67eventToBuilder (CommentEvent txt) = Just $ field commentField txt
69−eventToBuilder (RetryEvent n) = Just $ field retryField (fromShow n)
68+eventToBuilder (RetryEvent n) = Just $ field retryField (string8 . show $ n)
70eventToBuilder (CloseEvent) = Nothing
69eventToBuilder (CloseEvent) = Nothing
71eventToBuilder (ServerEvent n i d)= Just $
70eventToBuilder (ServerEvent n i d)= Just $
72 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
71 (name n $ evid i $ mconcat (map (field dataField) d)) `mappend` nl
wai-extra/Network/Wai/Handler/CGI.hs+21−16
@@ -19,8 +19,8 @@ import Control.Arrow ((***))
19import Data.Char (toLower)
19import Data.Char (toLower)
20import qualified System.IO
20import qualified System.IO
21import qualified Data.String as String
21import qualified Data.String as String
22−import Blaze.ByteString.Builder (fromByteString, toLazyByteString, flush)
22+import Data.ByteString.Builder (byteString, toLazyByteString, char7, string8)
23−import Blaze.ByteString.Builder.Char8 (fromChar, fromString)
23+import Data.ByteString.Builder.Extra (flush)
24import Data.ByteString.Lazy.Internal (defaultChunkSize)
24import Data.ByteString.Lazy.Internal (defaultChunkSize)
25import System.IO (Handle)
25import System.IO (Handle)
26import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
26import Network.HTTP.Types (Status (..), hRange, hContentType, hContentLength)
@@ -29,7 +29,8 @@ import qualified Data.CaseInsensitive as CI
29#if __GLASGOW_HASKELL__ < 710
29#if __GLASGOW_HASKELL__ < 710
30import Data.Monoid (mconcat, mempty, mappend)
30import Data.Monoid (mconcat, mempty, mappend)
31#endif
31#endif
32+
32−import qualified Data.Streaming.Blaze as Blaze
33+import qualified Data.Streaming.ByteString.Builder as Builder
33import Data.Function (fix)
34import Data.Function (fix)
34import Control.Monad (unless, void)
35import Control.Monad (unless, void)
35
36
@@ -118,6 +119,10 @@ runGeneric vars inputH outputH xsendfile app = do
118 , requestBodyLength = KnownLength $ fromIntegral contentLength
119 , requestBodyLength = KnownLength $ fromIntegral contentLength
119 , requestHeaderHost = lookup "host" reqHeaders
120 , requestHeaderHost = lookup "host" reqHeaders
120 , requestHeaderRange = lookup hRange 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
121 }
126 }
122 void $ app env $ \res ->
127 void $ app env $ \res ->
123 case (xsendfile, res) of
128 case (xsendfile, res) of
@@ -126,7 +131,7 @@ runGeneric vars inputH outputH xsendfile app = do
126 return ResponseReceived
131 return ResponseReceived
127 _ -> do
132 _ -> do
128 let (s, hs, wb) = responseToStream res
133 let (s, hs, wb) = responseToStream res
129− (blazeRecv, blazeFinish) <- Blaze.newBlazeRecv Blaze.defaultStrategy
134+ (blazeRecv, blazeFinish) <- Builder.newBuilderRecv Builder.defaultStrategy
130 wb $ \b -> do
135 wb $ \b -> do
131 let sendBuilder builder = do
136 let sendBuilder builder = do
132 popper <- blazeRecv builder
137 popper <- blazeRecv builder
@@ -135,30 +140,30 @@ runGeneric vars inputH outputH xsendfile app = do
135 unless (B.null bs) $ do
140 unless (B.null bs) $ do
136 outputH bs
141 outputH bs
137 loop
142 loop
138− sendBuilder $ headers s hs `mappend` fromChar '\n'
143+ sendBuilder $ headers s hs `mappend` char7 '\n'
139 b sendBuilder (sendBuilder flush)
144 b sendBuilder (sendBuilder flush)
140 blazeFinish >>= maybe (return ()) outputH
145 blazeFinish >>= maybe (return ()) outputH
141 return ResponseReceived
146 return ResponseReceived
142 where
147 where
143 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
148 headers s hs = mconcat (map header $ status s : map header' (fixHeaders hs))
144− status (Status i m) = (fromByteString "Status", mconcat
149+ status (Status i m) = (byteString "Status", mconcat
145− [ fromString $ show i
150+ [ string8 $ show i
146− , fromChar ' '
151+ , char7 ' '
147− , fromByteString m
152+ , byteString m
148 ])
153 ])
149− header' (x, y) = (fromByteString $ CI.original x, fromByteString y)
154+ header' (x, y) = (byteString $ CI.original x, byteString y)
150 header (x, y) = mconcat
155 header (x, y) = mconcat
151 [ x
156 [ x
152− , fromByteString ": "
157+ , byteString ": "
153 , y
158 , y
154− , fromChar '\n'
159+ , char7 '\n'
155 ]
160 ]
156 sfBuilder s hs sf fp = mconcat
161 sfBuilder s hs sf fp = mconcat
157 [ headers s hs
162 [ headers s hs
158− , header $ (fromByteString sf, fromString fp)
163+ , header $ (byteString sf, string8 fp)
159− , fromChar '\n'
164+ , char7 '\n'
160− , fromByteString sf
165+ , byteString sf
161− , fromByteString " not supported"
166+ , byteString " not supported"
162 ]
167 ]
163 fixHeaders h =
168 fixHeaders h =
164 case lookup hContentType h of
169 case lookup hContentType h of
wai-extra/Network/Wai/Handler/SCGI.hs+12−1
@@ -1,4 +1,4 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
1+{-# LANGUAGE CPP, ForeignFunctionInterface #-}
2module Network.Wai.Handler.SCGI
2module Network.Wai.Handler.SCGI
3 ( run
3 ( run
4 , runSendfile
4 , runSendfile
@@ -86,6 +86,16 @@ readByteString socket len = do
86foreign import ccall unsafe "accept"
86foreign import ccall unsafe "accept"
87 c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
87 c'accept :: CInt -> Ptr a -> Ptr a -> IO CInt
88
88
89+#if WINDOWS
90+foreign import ccall unsafe "_close"
91+ c'close :: CInt -> IO CInt
92+
93+foreign import ccall unsafe "_write"
94+ c'write :: CInt -> Ptr CChar -> CInt -> IO CInt
95+
96+foreign import ccall unsafe "_read"
97+ c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
98+#else
89foreign import ccall unsafe "close"
99foreign import ccall unsafe "close"
90 c'close :: CInt -> IO CInt
100 c'close :: CInt -> IO CInt
91
101
@@ -94,3 +104,4 @@ foreign import ccall unsafe "write"
94
104
95foreign import ccall unsafe "read"
105foreign import ccall unsafe "read"
96 c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
106 c'read :: CInt -> Ptr CChar -> CInt -> IO CInt
107+#endif
wai-extra/Network/Wai/Header.hs+1−1
@@ -14,5 +14,5 @@ contentLength hdrs = lookup H.hContentLength hdrs >>= readInt
14readInt :: S8.ByteString -> Maybe Integer
14readInt :: S8.ByteString -> Maybe Integer
15readInt bs =
15readInt bs =
16 case S8.readInteger bs of
16 case S8.readInteger bs of
17− Just (i, "") -> Just i
17+ Just (i, rest) | S8.null rest -> Just i
18 _ -> Nothing
18 _ -> Nothing
wai-extra/Network/Wai/Middleware/ForceSSL.hs+2−8
@@ -17,9 +17,6 @@ import Data.Monoid (mempty)
17import Data.Monoid ((<>))
17import Data.Monoid ((<>))
18import Network.HTTP.Types (hLocation, methodGet, status301, status307)
18import Network.HTTP.Types (hLocation, methodGet, status301, status307)
19
19
20−import qualified Data.ByteString as S
21−import Data.Word8 (_colon)
22−
23-- | For requests that don't appear secure, redirect to https
20-- | For requests that don't appear secure, redirect to https
24--
21--
25-- Since 3.0.7
22-- Since 3.0.7
@@ -31,13 +28,10 @@ forceSSL app req sendResponse =
31
28
32redirectResponse :: Request -> Maybe Response
29redirectResponse :: Request -> Maybe Response
33redirectResponse req = do
30redirectResponse req = do
34− (host, _) <- S.break (== _colon) <$> requestHeaderHost req
31+ host <- requestHeaderHost req
35−
36− return $ responseBuilder status [(hLocation, location host)] mempty
32+ return $ responseBuilder status [(hLocation, location host)] mempty
37−
38 where
33 where
39 location h = "https://" <> h <> rawPathInfo req <> rawQueryString req
34 location h = "https://" <> h <> rawPathInfo req <> rawQueryString req
40−
41 status
35 status
42 | requestMethod req == methodGet = status301
36 | requestMethod req == methodGet = status301
43 | otherwise = status307
37 | otherwise = status307
wai-extra/Network/Wai/Middleware/Gzip.hs+41−15
@@ -30,14 +30,14 @@ import Data.Default.Class
30import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
30import Network.HTTP.Types ( Status, Header, hContentEncoding, hUserAgent
31 , hContentType, hContentLength)
31 , hContentType, hContentLength)
32import System.Directory (doesFileExist, createDirectoryIfMissing)
32import System.Directory (doesFileExist, createDirectoryIfMissing)
33−import Blaze.ByteString.Builder (fromByteString)
33+import Data.ByteString.Builder (byteString)
34+import qualified Data.ByteString.Builder.Extra as Blaze (flush)
34import Control.Exception (try, SomeException)
35import Control.Exception (try, SomeException)
35import qualified Data.Set as Set
36import qualified Data.Set as Set
36import Network.Wai.Header
37import Network.Wai.Header
37import Network.Wai.Internal
38import Network.Wai.Internal
38−import qualified Data.Streaming.Blaze as B
39+import qualified Data.Streaming.ByteString.Builder as B
39import qualified Data.Streaming.Zlib as Z
40import qualified Data.Streaming.Zlib as Z
40−import qualified Blaze.ByteString.Builder as Blaze
41import Control.Monad (unless)
41import Control.Monad (unless)
42import Data.Function (fix)
42import Data.Function (fix)
43import Control.Exception (throwIO)
43import Control.Exception (throwIO)
@@ -50,12 +50,27 @@ data GzipSettings = GzipSettings
50 , gzipCheckMime :: S.ByteString -> Bool
50 , gzipCheckMime :: S.ByteString -> Bool
51 }
51 }
52
52
53+-- | Gzip behavior for files.
54+data GzipFiles
55+ = GzipIgnore -- ^ Do not compress file responses.
56+ | GzipCompress -- ^ Compress files. Note that this may counteract
57+ -- zero-copy response optimizations on some
58+ -- platforms.
53−data GzipFiles = GzipIgnore | GzipCompress | GzipCacheFolder FilePath
59+ | GzipCacheFolder FilePath -- ^ Compress files, caching them in
60+ -- some directory.
61+ | GzipPreCompressed GzipFiles -- ^ If we use compression then try to use the filename with ".gz"
62+ -- appended to it, if the file is missing then try next action
63+ --
64+ -- @since 3.0.17
54 deriving (Show, Eq, Read)
65 deriving (Show, Eq, Read)
55
66
67+-- | Use default MIME settings; /do not/ compress files.
56instance Default GzipSettings where
68instance Default GzipSettings where
57 def = GzipSettings GzipIgnore defaultCheckMime
69 def = GzipSettings GzipIgnore defaultCheckMime
58
70
71+-- | MIME types that will be compressed by default:
72+-- @text/@ @*@, @application/json@, @application/javascript@,
73+-- @application/ecmascript@, @image/x-icon@.
59defaultCheckMime :: S.ByteString -> Bool
74defaultCheckMime :: S.ByteString -> Bool
60defaultCheckMime bs =
75defaultCheckMime bs =
61 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
76 S8.isPrefixOf "text/" bs || bs' `Set.member` toCompress
@@ -73,9 +88,10 @@ defaultCheckMime bs =
73-- Analyzes the \"Accept-Encoding\" header from the client to determine
88-- Analyzes the \"Accept-Encoding\" header from the client to determine
74-- if gzip is supported.
89-- if gzip is supported.
75--
90--
76−-- Possible future enhancements:
91+-- File responses will be compressed according to the 'GzipFiles' setting.
77--
92--
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'.
79gzip :: GzipSettings -> Middleware
95gzip :: GzipSettings -> Middleware
80gzip set app env sendResponse = app env $ \res ->
96gzip set app env sendResponse = app env $ \res ->
81 case res of
97 case res of
@@ -83,13 +99,23 @@ gzip set app env sendResponse = app env $ \res ->
83 ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
99 ResponseFile{} | gzipFiles set == GzipIgnore -> sendResponse res
84 _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
100 _ -> if "gzip" `elem` enc && not isMSIE6 && not (isEncoded res) && (bigEnough res)
85 then
101 then
86− case (res, gzipFiles set) of
102+ let runAction x = case x of
103+ (ResponseFile s hs file Nothing, GzipPreCompressed nextAction) ->
104+ let
105+ compressedVersion = file ++ ".gz"
106+ in
107+ doesFileExist compressedVersion >>= \y ->
108+ if y
109+ then (sendResponse $ ResponseFile s (fixHeaders hs) compressedVersion Nothing)
110+ else (runAction (ResponseFile s hs file Nothing, nextAction))
87− (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
111+ (ResponseFile s hs file Nothing, GzipCacheFolder cache) ->
88− case lookup hContentType hs of
112+ case lookup hContentType hs of
89− Just m
113+ Just m
90− | gzipCheckMime set m -> compressFile s hs file cache sendResponse
114+ | gzipCheckMime set m -> compressFile s hs file cache sendResponse
91− _ -> sendResponse res
115+ _ -> sendResponse res
116+ (ResponseFile {}, GzipIgnore) -> sendResponse res
92− _ -> compressE set res sendResponse
117+ _ -> compressE set res sendResponse
118+ in runAction (res, gzipFiles set)
93 else sendResponse res
119 else sendResponse res
94 where
120 where
95 enc = fromMaybe [] $ (splitCommas . S8.unpack)
121 enc = fromMaybe [] $ (splitCommas . S8.unpack)
@@ -159,7 +185,7 @@ compressE set res sendResponse =
159 Just m | gzipCheckMime set m ->
185 Just m | gzipCheckMime set m ->
160 let hs' = fixHeaders hs
186 let hs' = fixHeaders hs
161 in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
187 in wb $ \body -> sendResponse $ responseStream s hs' $ \sendChunk flush -> do
162− (blazeRecv, _) <- B.newBlazeRecv B.defaultStrategy
188+ (blazeRecv, _) <- B.newBuilderRecv B.defaultStrategy
163 deflate <- Z.initDeflate 1 (Z.WindowBits 31)
189 deflate <- Z.initDeflate 1 (Z.WindowBits 31)
164 let sendBuilder builder = do
190 let sendBuilder builder = do
165 popper <- blazeRecv builder
191 popper <- blazeRecv builder
@@ -178,7 +204,7 @@ compressE set res sendResponse =
178 case result of
204 case result of
179 Z.PRDone -> return ()
205 Z.PRDone -> return ()
180 Z.PRNext bs' -> do
206 Z.PRNext bs' -> do
181− sendChunk $ fromByteString bs'
207+ sendChunk $ byteString bs'
182 loop
208 loop
183 Z.PRError e -> throwIO e
209 Z.PRError e -> throwIO e
184
210
wai-extra/Network/Wai/Middleware/HttpAuth.hs+18−10
@@ -5,6 +5,7 @@
5module Network.Wai.Middleware.HttpAuth
5module Network.Wai.Middleware.HttpAuth
6 ( -- * Middleware
6 ( -- * Middleware
7 basicAuth
7 basicAuth
8+ , basicAuth'
8 , CheckCreds
9 , CheckCreds
9 , AuthSettings
10 , AuthSettings
10 , authRealm
11 , authRealm
@@ -36,11 +37,19 @@ type CheckCreds = ByteString
36--
37--
37-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
38-- > basicAuth (\u p -> return $ u == "michael" && p == "mypass") "My Realm"
38--
39--
39−-- Since 1.3.4
40+-- @since 1.3.4
40basicAuth :: CheckCreds
41basicAuth :: CheckCreds
41 -> AuthSettings
42 -> AuthSettings
42 -> Middleware
43 -> Middleware
44+basicAuth checkCreds = basicAuth' (\_ -> checkCreds)
45+
46+-- | Like 'basicAuth', but also passes a request to the authentication function.
47+--
48+-- @since 3.0.19
49+basicAuth' :: (Request -> CheckCreds)
50+ -> AuthSettings
51+ -> Middleware
43−basicAuth checkCreds AuthSettings {..} app req sendResponse = do
52+basicAuth' checkCreds AuthSettings {..} app req sendResponse = do
44 isProtected <- authIsProtected req
53 isProtected <- authIsProtected req
45 allowed <- if isProtected then check else return True
54 allowed <- if isProtected then check else return True
46 if allowed
55 if allowed
@@ -51,8 +60,7 @@ basicAuth checkCreds AuthSettings {..} app req sendResponse = do
51 case (lookup hAuthorization $ requestHeaders req)
60 case (lookup hAuthorization $ requestHeaders req)
52 >>= extractBasicAuth of
61 >>= extractBasicAuth of
53 Nothing -> return False
62 Nothing -> return False
54− Just (username, password) -> checkCreds username password
63+ Just (username, password) -> checkCreds req username password
55−
56
64
57-- | Basic authentication settings. This value is an instance of
65-- | Basic authentication settings. This value is an instance of
58-- @IsString@, so the recommended approach to create a value is to
66-- @IsString@, so the recommended approach to create a value is to
@@ -61,23 +69,23 @@ basicAuth checkCreds AuthSettings {..} app req sendResponse = do
61--
69--
62-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
70-- > "My Realm" { authIsProtected = someFunc } :: AuthSettings
63--
71--
64−-- Since 1.3.4
72+-- @since 1.3.4
65data AuthSettings = AuthSettings
73data AuthSettings = AuthSettings
66 { authRealm :: !ByteString
74 { authRealm :: !ByteString
67 -- ^
75 -- ^
68 --
76 --
69− -- Since 1.3.4
77+ -- @since 1.3.4
70 , authOnNoAuth :: !(ByteString -> Application)
78 , authOnNoAuth :: !(ByteString -> Application)
71 -- ^ Takes the realm and returns an appropriate 401 response when
79 -- ^ Takes the realm and returns an appropriate 401 response when
72 -- authentication is not provided.
80 -- authentication is not provided.
73 --
81 --
74− -- Since 1.3.4
82+ -- @since 1.3.4
75 , authIsProtected :: !(Request -> IO Bool)
83 , authIsProtected :: !(Request -> IO Bool)
76 -- ^ Determine if access to the requested resource is restricted.
84 -- ^ Determine if access to the requested resource is restricted.
77 --
85 --
78 -- Default: always returns @True@.
86 -- Default: always returns @True@.
79 --
87 --
80− -- Since 1.3.4
88+ -- @since 1.3.4
81 }
89 }
82
90
83instance IsString AuthSettings where
91instance IsString AuthSettings where
@@ -99,7 +107,7 @@ instance IsString AuthSettings where
99-- | Extract basic authentication data from usually __Authorization__
107-- | Extract basic authentication data from usually __Authorization__
100-- header value. Returns username and password
108-- header value. Returns username and password
101--
109--
102−-- Since 3.0.5
110+-- @since 3.0.5
103extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
111extractBasicAuth :: ByteString -> Maybe (ByteString, ByteString)
104extractBasicAuth bs =
112extractBasicAuth bs =
105 let (x, y) = S.break isSpace bs
113 let (x, y) = S.break isSpace bs
@@ -115,7 +123,7 @@ extractBasicAuth bs =
115-- | Extract bearer authentication data from __Authorization__ header
123-- | Extract bearer authentication data from __Authorization__ header
116-- value. Returns bearer token
124-- value. Returns bearer token
117--
125--
118−-- Since 3.0.5
126+-- @since 3.0.5
119extractBearerAuth :: ByteString -> Maybe ByteString
127extractBearerAuth :: ByteString -> Maybe ByteString
120extractBearerAuth bs =
128extractBearerAuth bs =
121 let (x, y) = S.break isSpace bs
129 let (x, y) = S.break isSpace bs
wai-extra/Network/Wai/Middleware/Jsonp.hs+7−7
@@ -18,8 +18,8 @@ import Network.Wai
18import Network.Wai.Internal
18import Network.Wai.Internal
19import Data.ByteString (ByteString)
19import Data.ByteString (ByteString)
20import qualified Data.ByteString.Char8 as B8
20import qualified Data.ByteString.Char8 as B8
21−import Blaze.ByteString.Builder (copyByteString)
21+import Data.ByteString.Builder.Extra (byteStringCopy)
22−import Blaze.ByteString.Builder.Char8 (fromChar)
22+import Data.ByteString.Builder (char7)
23#if __GLASGOW_HASKELL__ < 710
23#if __GLASGOW_HASKELL__ < 710
24import Data.Monoid (mappend)
24import Data.Monoid (mappend)
25#endif
25#endif
@@ -60,10 +60,10 @@ jsonp app env sendResponse = do
60 sendResponse $ case checkJSON hs of
60 sendResponse $ case checkJSON hs of
61 Nothing -> r
61 Nothing -> r
62 Just hs' -> responseBuilder s hs' $
62 Just hs' -> responseBuilder s hs' $
63− copyByteString c
63+ byteStringCopy c
64− `mappend` fromChar '('
64+ `mappend` char7 '('
65 `mappend` b
65 `mappend` b
66− `mappend` fromChar ')'
66+ `mappend` char7 ')'
67 go c r =
67 go c r =
68 case checkJSON hs of
68 case checkJSON hs of
69 Just hs' -> addCallback c s hs' wb
69 Just hs' -> addCallback c s hs' wb
@@ -81,9 +81,9 @@ jsonp app env sendResponse = do
81
81
82 addCallback cb s hs wb =
82 addCallback cb s hs wb =
83 wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
83 wb $ \body -> sendResponse $ responseStream s hs $ \sendChunk flush -> do
84− sendChunk $ copyByteString cb `mappend` fromChar '('
84+ sendChunk $ byteStringCopy cb `mappend` char7 '('
85 _ <- body sendChunk flush
85 _ <- body sendChunk flush
86− sendChunk $ fromChar ')'
86+ sendChunk $ char7 ')'
87
87
88changeVal :: Eq a
88changeVal :: Eq a
89 => a
89 => a
wai-extra/Network/Wai/Middleware/MethodOverride.hs+4−5
@@ -5,12 +5,11 @@ module Network.Wai.Middleware.MethodOverride
5import Network.Wai
5import Network.Wai
6import Control.Monad (join)
6import Control.Monad (join)
7
7
8−-- | Allows overriding of the HTTP request method via the _method query string
8+-- | Overriding of HTTP request method via `_method` query string parameter.
9−-- parameter.
10--
9--
11−-- This middleware only applies when the initial request method is POST. This
10+-- This middleware only applies when the initial request method is POST.
12−-- allow submitting of normal HTML forms, without worries of semantics
11+-- Allows submitting of normal HTML forms, without worries of semantic
13−-- mismatches in the HTTP spec.
12+-- mismatches with the HTTP spec.
14methodOverride :: Middleware
13methodOverride :: Middleware
15methodOverride app req =
14methodOverride app req =
16 app req'
15 app req'
wai-extra/Network/Wai/Middleware/RequestLogger.hs+68−19
@@ -14,15 +14,16 @@ module Network.Wai.Middleware.RequestLogger
14 , OutputFormat (..)
14 , OutputFormat (..)
15 , OutputFormatter
15 , OutputFormatter
16 , OutputFormatterWithDetails
16 , OutputFormatterWithDetails
17+ , OutputFormatterWithDetailsAndHeaders
17 , Destination (..)
18 , Destination (..)
18 , Callback
19 , Callback
19 , IPAddrSource (..)
20 , IPAddrSource (..)
20 ) where
21 ) where
21
22
22import System.IO (Handle, hFlush, stdout)
23import System.IO (Handle, hFlush, stdout)
23−import qualified Blaze.ByteString.Builder as B
24+import qualified Data.ByteString.Builder as B (Builder, byteString)
24import qualified Data.ByteString as BS
25import qualified Data.ByteString as BS
25−import Data.ByteString.Char8 (pack, unpack)
26+import Data.ByteString.Char8 (pack)
26import Control.Monad (when)
27import Control.Monad (when)
27import Control.Monad.IO.Class (liftIO)
28import Control.Monad.IO.Class (liftIO)
28import Network.Wai
29import Network.Wai
@@ -40,7 +41,7 @@ import Network.Wai.Parse (sinkRequestBody, lbsBackEnd, fileName, Param, File
40import qualified Data.ByteString.Lazy as LBS
41import qualified Data.ByteString.Lazy as LBS
41import qualified Data.ByteString.Char8 as S8
42import qualified Data.ByteString.Char8 as S8
42import System.Console.ANSI
43import System.Console.ANSI
43−import Data.IORef.Lifted
44+import Data.IORef
44import System.IO.Unsafe
45import System.IO.Unsafe
45import Network.Wai.Internal (Response (..))
46import Network.Wai.Internal (Response (..))
46import Data.Default.Class (Default (def))
47import Data.Default.Class (Default (def))
@@ -49,14 +50,42 @@ import Network.Wai.Middleware.RequestLogger.Internal
49import Network.Wai.Header (contentLength)
50import Network.Wai.Header (contentLength)
50import Data.Text.Encoding (decodeUtf8')
51import Data.Text.Encoding (decodeUtf8')
51
52
53+data OutputFormat
52−data OutputFormat = Apache IPAddrSource
54+ = Apache IPAddrSource
53− | Detailed Bool -- ^ use colors?
55+ | Detailed Bool -- ^ use colors?
54− | CustomOutputFormat OutputFormatter
56+ | CustomOutputFormat OutputFormatter
55− | CustomOutputFormatWithDetails OutputFormatterWithDetails
57+ | CustomOutputFormatWithDetails OutputFormatterWithDetails
58+ | CustomOutputFormatWithDetailsAndHeaders OutputFormatterWithDetailsAndHeaders
56
59
57type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> LogStr
60type OutputFormatter = ZonedDate -> Request -> Status -> Maybe Integer -> LogStr
61+
58−type OutputFormatterWithDetails =
62+type OutputFormatterWithDetails
59− ZonedDate -> Request -> Status -> Maybe Integer -> NominalDiffTime -> [S8.ByteString] -> B.Builder -> LogStr
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
60
89
61data Destination = Handle Handle
90data Destination = Handle Handle
62 | Logger LoggerSet
91 | Logger LoggerSet
@@ -95,20 +124,22 @@ mkRequestLogger RequestLoggerSettings{..} = do
95 Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
124 Handle h -> (BS.hPutStr h . logToByteString, when autoFlush (hFlush h))
96 Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
125 Logger l -> (pushLogStr l, when autoFlush (flushLogStr l))
97 Callback c -> (c, return ())
126 Callback c -> (c, return ())
127+ callbackAndFlush str = callback str >> flusher
98 case outputFormat of
128 case outputFormat of
99 Apache ipsrc -> do
129 Apache ipsrc -> do
100 getdate <- getDateGetter flusher
130 getdate <- getDateGetter flusher
101 apache <- initLogger ipsrc (LogCallback callback flusher) getdate
131 apache <- initLogger ipsrc (LogCallback callback flusher) getdate
102 return $ apacheMiddleware apache
132 return $ apacheMiddleware apache
103− Detailed useColors -> detailedMiddleware
133+ Detailed useColors -> detailedMiddleware callbackAndFlush useColors
104− (\str -> callback str >> flusher)
105− useColors
106 CustomOutputFormat formatter -> do
134 CustomOutputFormat formatter -> do
107 getDate <- getDateGetter flusher
135 getDate <- getDateGetter flusher
108− return $ customMiddleware callback getDate formatter
136+ return $ customMiddleware callbackAndFlush getDate formatter
109 CustomOutputFormatWithDetails formatter -> do
137 CustomOutputFormatWithDetails formatter -> do
110 getdate <- getDateGetter flusher
138 getdate <- getDateGetter flusher
111− return $ customMiddlewareWithDetails callback getdate formatter
139+ return $ customMiddlewareWithDetails callbackAndFlush getdate formatter
140+ CustomOutputFormatWithDetailsAndHeaders formatter -> do
141+ getdate <- getDateGetter flusher
142+ return $ customMiddlewareWithDetailsAndHeaders callbackAndFlush getdate formatter
112
143
113apacheMiddleware :: ApacheLoggerActions -> Middleware
144apacheMiddleware :: ApacheLoggerActions -> Middleware
114apacheMiddleware ala app req sendResponse = app req $ \res -> do
145apacheMiddleware ala app req sendResponse = app req $ \res -> do
@@ -119,8 +150,8 @@ apacheMiddleware ala app req sendResponse = app req $ \res -> do
119customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
150customMiddleware :: Callback -> IO ZonedDate -> OutputFormatter -> Middleware
120customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
151customMiddleware cb getdate formatter app req sendResponse = app req $ \res -> do
121 date <- liftIO getdate
152 date <- liftIO getdate
122− -- We use Nothing for the response size since we generally don't know it
153+ let msize = contentLength (responseHeaders res)
123− liftIO $ cb $ formatter date req (responseStatus res) Nothing
154+ liftIO $ cb $ formatter date req (responseStatus res) msize
124 sendResponse res
155 sendResponse res
125
156
126customMiddlewareWithDetails :: Callback -> IO ZonedDate -> OutputFormatterWithDetails -> Middleware
157customMiddlewareWithDetails :: Callback -> IO ZonedDate -> OutputFormatterWithDetails -> Middleware
@@ -130,15 +161,33 @@ customMiddlewareWithDetails cb getdate formatter app req sendResponse = do
130 app req' $ \res -> do
161 app req' $ \res -> do
131 t1 <- getCurrentTime
162 t1 <- getCurrentTime
132 date <- liftIO getdate
163 date <- liftIO getdate
133− -- We use Nothing for the response size since we generally don't know it
164+ let msize = contentLength (responseHeaders res)
134− builderIO <- newIORef $ B.fromByteString ""
165+ builderIO <- newIORef $ B.byteString ""
135 res' <- recordChunks builderIO res
166 res' <- recordChunks builderIO res
136 rspRcv <- sendResponse res'
167 rspRcv <- sendResponse res'
137 _ <- liftIO . cb .
168 _ <- liftIO . cb .
138− formatter date req' (responseStatus res') Nothing (t1 `diffUTCTime` t0) reqBody =<<
169+ formatter date req' (responseStatus res') msize (t1 `diffUTCTime` t0) reqBody =<<
139 readIORef builderIO
170 readIORef builderIO
140 return rspRcv
171 return rspRcv
141
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
142-- | Production request logger middleware.
191-- | Production request logger middleware.
143--
192--
144-- This uses the 'Apache' logging format, and takes IP addresses for clients from
193-- This uses the 'Apache' logging format, and takes IP addresses for clients from
wai-extra/Network/Wai/Middleware/RequestLogger/JSON.hs+48−10
@@ -1,8 +1,13 @@
1{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE CPP #-}
2
3
3−module Network.Wai.Middleware.RequestLogger.JSON (formatAsJSON) where
4+module Network.Wai.Middleware.RequestLogger.JSON
5+ ( formatAsJSON
6+ , formatAsJSONWithHeaders
7+ ) where
4
8
5−import qualified Blaze.ByteString.Builder as BB
9+import qualified Data.ByteString.Builder as BB (toLazyByteString)
10+import Data.ByteString.Lazy (toStrict)
6import Data.Aeson
11import Data.Aeson
7import Data.CaseInsensitive (original)
12import Data.CaseInsensitive (original)
8import Data.Monoid ((<>))
13import Data.Monoid ((<>))
@@ -10,7 +15,8 @@ import qualified Data.ByteString.Char8 as S8
10import Data.IP
15import Data.IP
11import qualified Data.Text as T
16import qualified Data.Text as T
12import Data.Text (Text)
17import Data.Text (Text)
13−import Data.Text.Encoding (decodeUtf8)
18+import Data.Text.Encoding (decodeUtf8With)
19+import Data.Text.Encoding.Error (lenientDecode)
14import Data.Time (NominalDiffTime)
20import Data.Time (NominalDiffTime)
15import Data.Word (Word32)
21import Data.Word (Word32)
16import Network.HTTP.Types as H
22import Network.HTTP.Types as H
@@ -31,10 +37,34 @@ formatAsJSON date req status responseSize duration reqBody response =
31 , "size" .= responseSize
37 , "size" .= responseSize
32 , "body" .=
38 , "body" .=
33 if statusCode status >= 400
39 if statusCode status >= 400
34− then Just . decodeUtf8 . BB.toByteString $ response
40+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ response
35 else Nothing
41 else Nothing
36 ]
42 ]
37− , "time" .= decodeUtf8 date
43+ , "time" .= decodeUtf8With lenientDecode date
44+ ]) <> "\n"
45+
46+-- | Same as @formatAsJSON@ but with response headers included
47+--
48+-- This is useful for passing arbitrary data from your application out to the
49+-- WAI layer for it to be logged, but you may need to be careful to
50+-- subsequently redact any headers which may contain sensitive data.
51+--
52+-- @since 3.0.27
53+formatAsJSONWithHeaders :: OutputFormatterWithDetailsAndHeaders
54+formatAsJSONWithHeaders date req status resSize duration reqBody res resHeaders =
55+ toLogStr (encode $
56+ object
57+ [ "request" .= requestToJSON duration req reqBody
58+ , "response" .= object
59+ [ "status" .= statusCode status
60+ , "size" .= resSize
61+ , "headers" .= responseHeadersToJSON resHeaders
62+ , "body" .=
63+ if statusCode status >= 400
64+ then Just . decodeUtf8With lenientDecode . toStrict . BB.toLazyByteString $ res
65+ else Nothing
66+ ]
67+ , "time" .= decodeUtf8With lenientDecode date
38 ]) <> "\n"
68 ]) <> "\n"
39
69
40word32ToHostAddress :: Word32 -> Text
70word32ToHostAddress :: Word32 -> Text
@@ -46,12 +76,12 @@ readAsDouble = read
46requestToJSON :: NominalDiffTime -> Request -> [S8.ByteString] -> Value
76requestToJSON :: NominalDiffTime -> Request -> [S8.ByteString] -> Value
47requestToJSON duration req reqBody =
77requestToJSON duration req reqBody =
48 object
78 object
49− [ "method" .= decodeUtf8 (requestMethod req)
79+ [ "method" .= decodeUtf8With lenientDecode (requestMethod req)
50− , "path" .= decodeUtf8 (rawPathInfo req)
80+ , "path" .= decodeUtf8With lenientDecode (rawPathInfo req)
51 , "queryString" .= map queryItemToJSON (queryString req)
81 , "queryString" .= map queryItemToJSON (queryString req)
52 , "durationMs" .= (readAsDouble . printf "%.2f" . rationalToDouble $ toRational duration * 1000)
82 , "durationMs" .= (readAsDouble . printf "%.2f" . rationalToDouble $ toRational duration * 1000)
53 , "size" .= requestBodyLengthToJSON (requestBodyLength req)
83 , "size" .= requestBodyLengthToJSON (requestBodyLength req)
54− , "body" .= decodeUtf8 (S8.concat reqBody)
84+ , "body" .= decodeUtf8With lenientDecode (S8.concat reqBody)
55 , "remoteHost" .= sockToJSON (remoteHost req)
85 , "remoteHost" .= sockToJSON (remoteHost req)
56 , "httpVersion" .= httpVersionToJSON (httpVersion req)
86 , "httpVersion" .= httpVersionToJSON (httpVersion req)
57 , "headers" .= requestHeadersToJSON (requestHeaders req)
87 , "headers" .= requestHeadersToJSON (requestHeaders req)
@@ -73,11 +103,13 @@ sockToJSON (SockAddrInet6 pn _ ha _) =
73 ]
103 ]
74sockToJSON (SockAddrUnix sock) =
104sockToJSON (SockAddrUnix sock) =
75 object [ "unix" .= sock ]
105 object [ "unix" .= sock ]
106+#if !MIN_VERSION_network(3,0,0)
76sockToJSON (SockAddrCan i) =
107sockToJSON (SockAddrCan i) =
77 object [ "can" .= i ]
108 object [ "can" .= i ]
109+#endif
78
110
79queryItemToJSON :: QueryItem -> Value
111queryItemToJSON :: QueryItem -> Value
80−queryItemToJSON (name, mValue) = toJSON (decodeUtf8 name, fmap decodeUtf8 mValue)
112+queryItemToJSON (name, mValue) = toJSON (decodeUtf8With lenientDecode name, fmap (decodeUtf8With lenientDecode) mValue)
81
113
82requestHeadersToJSON :: RequestHeaders -> Value
114requestHeadersToJSON :: RequestHeaders -> Value
83requestHeadersToJSON = toJSON . map hToJ where
115requestHeadersToJSON = toJSON . map hToJ where
@@ -85,8 +117,14 @@ requestHeadersToJSON = toJSON . map hToJ where
85 hToJ ("Cookie", _) = toJSON ("Cookie" :: Text, "-RDCT-" :: Text)
117 hToJ ("Cookie", _) = toJSON ("Cookie" :: Text, "-RDCT-" :: Text)
86 hToJ hd = headerToJSON hd
118 hToJ hd = headerToJSON hd
87
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+
88headerToJSON :: Header -> Value
126headerToJSON :: Header -> Value
89−headerToJSON (headerName, header) = toJSON (decodeUtf8 . original $ headerName, decodeUtf8 header)
127+headerToJSON (headerName, header) = toJSON (decodeUtf8With lenientDecode . original $ headerName, decodeUtf8With lenientDecode header)
90
128
91portToJSON :: PortNumber -> Value
129portToJSON :: PortNumber -> Value
92portToJSON = toJSON . toInteger
130portToJSON = toJSON . toInteger
wai-extra/Network/Wai/Middleware/Rewrite.hs+321−14
@@ -1,32 +1,339 @@
1+{-# LANGUAGE TupleSections #-}
2+{-# LANGUAGE CPP #-}
3+
1module Network.Wai.Middleware.Rewrite
4module Network.Wai.Middleware.Rewrite
5+ ( -- * How to use this module
6+ -- $howto
7+
8+ -- ** A note on semantics
9+
10+ -- $semantics
11+
12+ -- ** Paths and Queries
13+
14+ -- $pathsandqueries
15+ PathsAndQueries
16+
17+ -- ** An example rewriting paths with queries
18+
19+ -- $takeover
20+
21+ -- ** Upgrading from wai-extra ≤ 3.0.16.1
22+
23+ -- $upgrading
24+
25+ -- * 'Middleware'
26+
27+ -- ** Recommended functions
28+ , rewriteWithQueries
29+ , rewritePureWithQueries
30+ , rewriteRoot
31+
32+ -- ** Deprecated
33+ , rewrite
2− ( rewrite, rewritePure
34+ , rewritePure
35+
36+ -- * Operating on 'Request's
37+
38+ , rewriteRequest
39+ , rewriteRequestPure
3 ) where
40 ) where
4
41
5import Network.Wai
42import Network.Wai
6import Control.Monad.IO.Class (liftIO)
43import Control.Monad.IO.Class (liftIO)
7import Data.Text (Text)
44import Data.Text (Text)
45+import Data.Functor.Identity (Identity(..))
8import qualified Data.Text.Encoding as TE
46import qualified Data.Text.Encoding as TE
9import qualified Data.Text as T
47import qualified Data.Text as T
10import Network.HTTP.Types as H
48import Network.HTTP.Types as H
11
49
50+-- GHC ≤ 7.10 does not export Applicative functions from the prelude.
51+#if __GLASGOW_HASKELL__ <= 710
52+import Control.Applicative
53+#endif
12
54
13−-- | rewrite based on your own conversion rules
55+-- $howto
14−rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
56+-- This module provides 'Middleware' to rewrite URL paths. It also provides
15−rewrite convert app req sendResponse = do
57+-- functions that will convert a 'Request' to a modified 'Request'.
16− newPathInfo <- liftIO $ convert (pathInfo req) (requestHeaders req)
58+-- Both operations require a function that takes URL parameters and
17− let rawPInfo = TE.encodeUtf8 $ T.intercalate "/" newPathInfo
59+-- headers, and returns new URL parameters. Parameters are pieces of URL
18− app req { pathInfo = newPathInfo, rawPathInfo = rawPInfo } sendResponse
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.
19
80
20−-- | rewrite based on your own conversion rules
81+-- $pathsandqueries
21−-- Example convert function:
82+--
83+-- This library defines the type synonym `PathsAndQueries` to make code
84+-- handling paths and queries easier to read.
85+--
86+-- /e.g./ /\/foo\/bar/ would look like
87+--
88+-- > ["foo", "bar"] :: Text
89+--
90+-- /?bar=baz/ would look like
91+--
92+-- > [("bar", Just "baz")] :: QueryText
93+--
94+-- Together,
95+--
96+-- /\/foo?bar=baz/ would look like
97+--
98+-- > (["foo"],[("bar", Just "baz")]) :: PathsAndQueries
22
99
100+-- $takeover
101+-- Let’s say we want to replace a website written in PHP with one written
102+-- using WAI. We’ll use the
103+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
104+-- package to serve the old
105+-- site from the new site, but there’s a problem. The old site uses pages like
106+--
107+-- @
108+-- index.php?page=/page/
109+-- @
110+--
111+-- whereas the new site would look like
112+--
113+-- @
114+-- index\//page/
115+-- @
116+--
117+-- In doing this, we want to separate the migration code from our new
118+-- website. So we’d like to handle links internally using the path
119+-- formulation, but externally have the old links still work.
120+--
121+-- Therefore, we will use middleware ('rewritePureWithQueries') from this
122+-- module to rewrite incoming requests from the query formulation to the
123+-- paths formulation.
124+--
125+-- > {-# LANGUAGE ViewPatterns #-}
126+-- >
127+-- > rewritePathFromPhp :: Middleware
128+-- > rewritePathFromPhp = rewritePureWithQueries pathFromPhp
129+-- >
130+-- > pathFromPhp :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
131+-- > pathFromPhp (pieces, queries) _ = piecesConvert pieces queries
132+-- > where
133+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
134+-- > piecesConvert ["index.php"] qs@(join . lookup "page" -> Just page) =
135+-- > ( ["index", TE.decodeUtf8With TE.lenientDecode page]
136+-- > , delete ("page", pure page) qs
137+-- > )
138+-- > piecesConvert ps qs = (ps, qs)
139+--
140+-- On the other side, we will use 'rewriteRequestPure' to rewrite outgoing
141+-- requests to the original website from the reverse proxy code (using the
142+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequest' or
143+-- 'Network.HTTP.ReverseProxy.WPRModifiedRequestSecure' constructors. Note,
144+-- these links will only work if the haddock documentation for
145+-- <https://hackage.haskell.org/package/http-reverse-proxy http-reverse-proxy>
146+-- is installed).
147+--
148+-- > rewritePhpFromPath :: Request -> Request
149+-- > rewritePhpFromPath = rewriteRequestPure phpFromPath
150+-- >
151+-- > phpFromPath :: PathsAndQueries -> H.RequestHeaders -> PathsAndQueries
152+-- > phpFromPath (pieces, queries) _ = piecesConvert pieces queries
153+-- > where
154+-- > piecesConvert :: [Text] -> H.Query -> PathsAndQueries
155+-- > piecesConvert ["index", page] qs = ( ["index.php"], ("page", pure . TE.encodeUtf8 $ page) : qs )
156+-- > piecesConvert ps qs = (ps, qs)
157+--
158+-- For the whole example, see
159+-- <https://gist.github.com/dbaynard/c844d0df124f68ec8b6da152c581ce6d>.
160+
161+-- $upgrading
162+-- It is quite simple to upgrade from 'rewrite' and 'rewritePure', to
163+-- 'rewriteWithQueries' and 'rewritePureWithQueries'.
164+-- Insert 'Data.Bifunctor.first', which specialises to
165+--
166+-- @
167+-- 'Data.Bifunctor.first' :: (['Text'] -> ['Text']) -> 'PathsAndQueries' -> 'PathsAndQueries'
168+-- @
169+--
170+-- as the following example demonstrates.
171+--
172+-- Old versions of the library could only handle path pieces, not queries.
173+-- This could have been supplied to 'rewritePure'.
174+--
175+-- @
23−-- staticConvert :: [Text] -> H.RequestHeaders -> [Text]
176+-- staticConvert' :: [Text] -> H.RequestHeaders -> [Text]
24−-- staticConvert pieces _ = piecesConvert pieces
177+-- staticConvert' pieces _ = piecesConvert pieces
178+-- where
179+-- piecesConvert [] = ["static", "html", "pages.html"]
180+-- piecesConvert route@("pages":_) = "static":"html":route
181+-- @
182+--
183+-- Instead, use this function, supplied to 'rewritePureWithQueries'.
184+--
185+-- @
186+-- staticConvert :: 'PathsAndQueries' -> H.RequestHeaders -> 'PathsAndQueries'
187+-- staticConvert pathsAndQueries _ = 'Data.Bifunctor.first' piecesConvert pathsAndQueries
25-- where
188-- where
26-- piecesConvert [] = ["static", "html", "pages.html"]
189-- piecesConvert [] = ["static", "html", "pages.html"]
27-- piecesConvert route@("pages":_) = "static":"html":route
190-- piecesConvert route@("pages":_) = "static":"html":route
191+-- @
192+--
193+-- The former formulation is deprecated for two reasons:
194+--
195+-- 1. The original formulation of 'rewrite' modified 'rawPathInfo', which
196+-- is deprecated behaviour.
197+--
198+-- 2. The original formulation did not allow query parameters to
199+-- influence the path.
200+--
201+-- Concerning the first point, take care with semantics of your program when
202+-- upgrading as the upgraded functions no longer modify 'rawPathInfo'.
203+
204+--------------------------------------------------
205+-- * Types
206+--------------------------------------------------
207+
208+-- | A tuple of the path sections as ['Text'] and query parameters as
209+-- 'H.Query'. This makes writing type signatures for the conversion
210+-- function far more pleasant.
211+--
212+-- Note that this uses 'H.Query' not 'H.QueryText' to more accurately
213+-- reflect the paramaters that can be supplied in URLs. It may be safe to
214+-- treat parameters as text; use the 'H.queryToQueryText' and
215+-- 'H.queryTextToQuery' functions to interconvert.
216+type PathsAndQueries = ([Text], H.Query)
217+
218+--------------------------------------------------
219+-- * Rewriting 'Middleware'
220+--------------------------------------------------
221+
222+-- | Rewrite based on your own conversion function for paths only, to be
223+-- supplied by users of this library (with the conversion operating in 'IO').
224+--
225+-- For new code, use 'rewriteWithQueries' instead.
226+rewrite :: ([Text] -> H.RequestHeaders -> IO [Text]) -> Middleware
227+rewrite convert app req sendResponse = do
228+ let convertIO = pathsOnly . curry $ liftIO . uncurry convert
229+ newReq <- rewriteRequestRawM convertIO req
230+ app newReq sendResponse
231+{-# WARNING rewrite [
232+ "This modifies the 'rawPathInfo' field of a 'Request'."
233+ , " This is not recommended behaviour; it is however how"
234+ , " this function has worked in the past."
235+ , " Use 'rewriteWithQueries' instead"] #-}
236+
237+-- | Rewrite based on pure conversion function for paths only, to be
238+-- supplied by users of this library.
239+--
240+-- For new code, use 'rewritePureWithQueries' instead.
28rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
241rewritePure :: ([Text] -> H.RequestHeaders -> [Text]) -> Middleware
29rewritePure convert app req =
242rewritePure convert app req =
243+ let convertPure = pathsOnly . curry $ Identity . uncurry convert
244+ newReq = runIdentity $ rewriteRequestRawM convertPure req
245+ in app newReq
246+{-# WARNING rewritePure [
247+ "This modifies the 'rawPathInfo' field of a 'Request'."
248+ , " This is not recommended behaviour; it is however how"
249+ , " this function has worked in the past."
250+ , " Use 'rewritePureWithQueries' instead"] #-}
251+
252+-- | Rewrite based on your own conversion function for paths and queries.
253+-- This function is to be supplied by users of this library, and operates
254+-- in 'IO'.
255+rewriteWithQueries :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
256+ -> Middleware
257+rewriteWithQueries convert app req sendResponse = do
258+ newReq <- rewriteRequestM convert req
259+ app newReq sendResponse
260+
261+-- | Rewrite based on pure conversion function for paths and queries. This
262+-- function is to be supplied by users of this library.
263+rewritePureWithQueries :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
264+ -> Middleware
265+rewritePureWithQueries convert app req = app $ rewriteRequestPure convert req
266+
267+-- | Rewrite root requests (/) to a specified path
268+--
269+-- Note that /index.html/ in example below should already be a valid route.
270+--
271+-- @
272+-- rewriteRoot "index.html" :: Middleware
273+-- @
274+--
275+-- @since 3.0.23.0
276+rewriteRoot :: Text -> Middleware
277+rewriteRoot root = rewritePureWithQueries onlyRoot
278+ where
279+ onlyRoot ([], q) _ = ([root], q)
280+ onlyRoot paths _ = paths
281+
282+--------------------------------------------------
283+-- * Modifying 'Request's directly
284+--------------------------------------------------
285+
286+-- | Modify a 'Request' using the supplied function in 'IO'. This is suitable for
287+-- the reverse proxy example.
288+rewriteRequest :: (PathsAndQueries -> H.RequestHeaders -> IO PathsAndQueries)
289+ -> Request -> IO Request
290+rewriteRequest convert req =
291+ let convertIO = curry $ liftIO . uncurry convert
292+ in rewriteRequestRawM convertIO req
293+
294+-- | Modify a 'Request' using the pure supplied function. This is suitable for
295+-- the reverse proxy example.
296+rewriteRequestPure :: (PathsAndQueries -> H.RequestHeaders -> PathsAndQueries)
297+ -> Request -> Request
298+rewriteRequestPure convert req =
299+ let convertPure = curry $ Identity . uncurry convert
300+ in runIdentity $ rewriteRequestRawM convertPure req
301+
302+--------------------------------------------------
303+-- * Helper functions
304+--------------------------------------------------
305+
306+-- | This helper function factors out the common behaviour of rewriting requests.
307+rewriteRequestM :: (Applicative m, Monad m)
308+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
309+ -> Request -> m Request
310+rewriteRequestM convert req = do
30− let pInfo = convert (pathInfo req) (requestHeaders req)
311+ (pInfo, qByteStrings) <- curry convert (pathInfo req) (queryString req) (requestHeaders req)
312+ pure req {pathInfo = pInfo, queryString = qByteStrings}
313+
314+-- | This helper function preserves the semantics of wai-extra ≤ 3.0, in
315+-- which the rewrite functions modify the 'rawPathInfo' parameter. Note
316+-- that this has not been extended to modify the 'rawQueryInfo' as
317+-- modifying either of these values has been deprecated.
318+rewriteRequestRawM :: (Applicative m, Monad m)
319+ => (PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries)
320+ -> Request -> m Request
321+rewriteRequestRawM convert req = do
322+ newReq <- rewriteRequestM convert req
31− rawPInfo = TE.encodeUtf8 $ T.intercalate "/" pInfo
323+ let rawPInfo = TE.encodeUtf8 . T.intercalate "/" . pathInfo $ newReq
32− in app req { pathInfo = pInfo, rawPathInfo = rawPInfo }
324+ pure newReq { rawPathInfo = rawPInfo }
325+{-# WARNING rewriteRequestRawM [
326+ "This modifies the 'rawPathInfo' field of a 'Request'."
327+ , " This is not recommended behaviour; it is however how"
328+ , " this function has worked in the past."
329+ , " Use 'rewriteRequestM' instead"] #-}
330+
331+-- | Produce a function that works on 'PathsAndQueries' from one working
332+-- only on paths. This is not exported, as it is only needed to handle
333+-- code written for versions ≤ 3.0 of the library; see the
334+-- example above using 'Data.Bifunctor.first' to do something similar.
335+pathsOnly :: (Applicative m, Monad m)
336+ => ([Text] -> H.RequestHeaders -> m [Text])
337+ -> PathsAndQueries -> H.RequestHeaders -> m PathsAndQueries
338+pathsOnly convert psAndQs headers = (,[]) <$> convert (fst psAndQs) headers
339+{-# INLINE pathsOnly #-}
wai-extra/Network/Wai/Middleware/Timeout.hsnew file+33
@@ -0,0 +1,33 @@
1+-- | Timeout requests
2+module Network.Wai.Middleware.Timeout
3+ ( timeout
4+ , timeoutStatus
5+ , timeoutAs
6+ ) where
7+
8+import Network.HTTP.Types (Status, status503)
9+import Network.Wai
10+import qualified System.Timeout as Timeout
11+
12+-- | Time out the request after the given number of seconds
13+--
14+-- Timeouts respond with @'status503'@. See @'timeoutStatus'@ or @'timeoutAs'@
15+-- to customize the behavior of the timed-out case.
16+--
17+-- @since 3.0.24.0@
18+timeout :: Int -> Middleware
19+timeout = timeoutStatus status503
20+
21+-- | Time out with the given @'Status'@
22+--
23+-- @since 3.0.24.0@
24+timeoutStatus :: Status -> Int -> Middleware
25+timeoutStatus status = timeoutAs $ responseLBS status [] ""
26+
27+-- | Time out with the given @'Response'@
28+--
29+-- @since 3.0.24.0@
30+timeoutAs :: Response -> Int -> Middleware
31+timeoutAs timeoutReponse seconds app req respond =
32+ maybe (respond timeoutReponse) pure
33+ =<< Timeout.timeout (seconds * 1000000) (app req respond)
wai-extra/Network/Wai/Parse.hs+365−83
@@ -11,6 +11,7 @@ module Network.Wai.Parse
11 , RequestBodyType (..)
11 , RequestBodyType (..)
12 , getRequestBodyType
12 , getRequestBodyType
13 , sinkRequestBody
13 , sinkRequestBody
14+ , sinkRequestBodyEx
14 , BackEnd
15 , BackEnd
15 , lbsBackEnd
16 , lbsBackEnd
16 , tempFileBackEnd
17 , tempFileBackEnd
@@ -19,6 +20,24 @@ module Network.Wai.Parse
19 , File
20 , File
20 , FileInfo (..)
21 , FileInfo (..)
21 , parseContentType
22 , parseContentType
23+ , ParseRequestBodyOptions
24+ , defaultParseRequestBodyOptions
25+ , noLimitParseRequestBodyOptions
26+ , parseRequestBodyEx
27+ , setMaxRequestKeyLength
28+ , clearMaxRequestKeyLength
29+ , setMaxRequestNumFiles
30+ , clearMaxRequestNumFiles
31+ , setMaxRequestFileSize
32+ , clearMaxRequestFileSize
33+ , setMaxRequestFilesSize
34+ , clearMaxRequestFilesSize
35+ , setMaxRequestParmsSize
36+ , clearMaxRequestParmsSize
37+ , setMaxHeaderLines
38+ , clearMaxHeaderLines
39+ , setMaxHeaderLineLength
40+ , clearMaxHeaderLineLength
22#if TEST
41#if TEST
23 , Bound (..)
42 , Bound (..)
24 , findBound
43 , findBound
@@ -29,22 +48,30 @@ module Network.Wai.Parse
29#endif
48#endif
30 ) where
49 ) where
31
50
32−import qualified Data.ByteString.Search as Search
51+import qualified Control.Exception as E
33import qualified Data.ByteString as S
52import qualified Data.ByteString as S
34import qualified Data.ByteString.Lazy as L
53import qualified Data.ByteString.Lazy as L
35import qualified Data.ByteString.Char8 as S8
54import qualified Data.ByteString.Char8 as S8
36import Data.Word (Word8)
55import Data.Word (Word8)
56+import Data.Int (Int64)
37−import Data.Maybe (fromMaybe)
57+import Data.Maybe (catMaybes, fromMaybe)
38import Data.List (sortBy)
58import Data.List (sortBy)
39import Data.Function (on, fix)
59import Data.Function (on, fix)
40import System.Directory (removeFile, getTemporaryDirectory)
60import System.Directory (removeFile, getTemporaryDirectory)
41import System.IO (hClose, openBinaryTempFile)
61import System.IO (hClose, openBinaryTempFile)
62+import System.IO.Error (isDoesNotExistError)
42import Network.Wai
63import Network.Wai
43import qualified Network.HTTP.Types as H
64import qualified Network.HTTP.Types as H
44−import Control.Monad (when, unless)
65+import Control.Applicative ((<$>))
66+import Control.Exception (catchJust)
67+import Control.Monad (when, unless, guard)
45import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
68import Control.Monad.Trans.Resource (allocate, release, register, InternalState, runInternalState)
46import Data.IORef
69import Data.IORef
47import Network.HTTP.Types (hContentType)
70import Network.HTTP.Types (hContentType)
71+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
72+import Data.CaseInsensitive (mk)
73+
74+import Prelude hiding (lines)
48
75
49breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
76breakDiscard :: Word8 -> S.ByteString -> (S.ByteString, S.ByteString)
50breakDiscard w s =
77breakDiscard w s =
@@ -102,11 +129,9 @@ tempFileBackEndOpts :: IO FilePath -- ^ get temporary directory
102 -> ignored2
129 -> ignored2
103 -> IO S.ByteString
130 -> IO S.ByteString
104 -> IO FilePath
131 -> IO FilePath
105−tempFileBackEndOpts getTmpDir pattern internalState _ _ popper = do
132+tempFileBackEndOpts getTmpDir pattrn internalState _ _ popper = do
106− (key, (fp, h)) <- flip runInternalState internalState $ allocate (do
133+ (key, (fp, h)) <- flip runInternalState internalState $ allocate it (hClose . snd)
107− tempDir <- getTmpDir
108− openBinaryTempFile tempDir pattern) (\(_, h) -> hClose h)
109− _ <- runInternalState (register $ removeFile fp) internalState
134+ _ <- runInternalState (register $ removeFileQuiet fp) internalState
110 fix $ \loop -> do
135 fix $ \loop -> do
111 bs <- popper
136 bs <- popper
112 unless (S.null bs) $ do
137 unless (S.null bs) $ do
@@ -114,6 +139,150 @@ tempFileBackEndOpts getTmpDir pattern internalState _ _ popper = do
114 loop
139 loop
115 release key
140 release key
116 return fp
141 return fp
142+ where
143+ it = do
144+ tempDir <- getTmpDir
145+ openBinaryTempFile tempDir pattrn
146+ removeFileQuiet fp = catchJust (guard . isDoesNotExistError)
147+ (removeFile fp)
148+ (const $ return ())
149+
150+-- | A data structure that describes the behavior of
151+-- the parseRequestBodyEx function.
152+--
153+-- @since 3.0.16.0
154+data ParseRequestBodyOptions = ParseRequestBodyOptions
155+ { -- | The maximum length of a filename
156+ prboKeyLength :: Maybe Int
157+ , -- | The maximum number of files.
158+ prboMaxNumFiles :: Maybe Int
159+ , -- | The maximum filesize per file.
160+ prboMaxFileSize :: Maybe Int64
161+ , -- | The maximum total filesize.
162+ prboMaxFilesSize :: Maybe Int64
163+ , -- | The maximum size of the sum of all parameters
164+ prboMaxParmsSize :: Maybe Int
165+ , -- | The maximum header lines per mime/multipart entry
166+ prboMaxHeaderLines :: Maybe Int
167+ , -- | The maximum header line length per mime/multipart entry
168+ prboMaxHeaderLineLength :: Maybe Int }
169+
170+-- | Set the maximum length of a filename.
171+--
172+-- @since 3.0.16.0
173+setMaxRequestKeyLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
174+setMaxRequestKeyLength l p = p { prboKeyLength=Just l }
175+
176+-- | Do not limit the length of filenames.
177+--
178+-- @since 3.0.16.0
179+clearMaxRequestKeyLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
180+clearMaxRequestKeyLength p = p { prboKeyLength=Nothing }
181+
182+-- | Set the maximum number of files per request.
183+--
184+-- @since 3.0.16.0
185+setMaxRequestNumFiles :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
186+setMaxRequestNumFiles l p = p { prboMaxNumFiles=Just l }
187+
188+-- | Do not limit the maximum number of files per request.
189+--
190+-- @since 3.0.16.0
191+clearMaxRequestNumFiles :: ParseRequestBodyOptions -> ParseRequestBodyOptions
192+clearMaxRequestNumFiles p = p { prboMaxNumFiles=Nothing }
193+
194+-- | Set the maximum filesize per file (in bytes).
195+--
196+-- @since 3.0.16.0
197+setMaxRequestFileSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
198+setMaxRequestFileSize l p = p { prboMaxFileSize=Just l }
199+
200+-- | Do not limit the maximum filesize per file.
201+--
202+-- @since 3.0.16.0
203+clearMaxRequestFileSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
204+clearMaxRequestFileSize p = p { prboMaxFileSize=Nothing }
205+
206+-- | Set the maximum size of all files per request.
207+--
208+-- @since 3.0.16.0
209+setMaxRequestFilesSize :: Int64 -> ParseRequestBodyOptions -> ParseRequestBodyOptions
210+setMaxRequestFilesSize l p = p { prboMaxFilesSize=Just l }
211+
212+-- | Do not limit the maximum size of all files per request.
213+--
214+-- @since 3.0.16.0
215+clearMaxRequestFilesSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
216+clearMaxRequestFilesSize p = p { prboMaxFilesSize=Nothing }
217+
218+-- | Set the maximum size of the sum of all parameters.
219+--
220+-- @since 3.0.16.0
221+setMaxRequestParmsSize :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
222+setMaxRequestParmsSize l p = p { prboMaxParmsSize=Just l }
223+
224+-- | Do not limit the maximum size of the sum of all parameters.
225+--
226+-- @since 3.0.16.0
227+clearMaxRequestParmsSize :: ParseRequestBodyOptions -> ParseRequestBodyOptions
228+clearMaxRequestParmsSize p = p { prboMaxParmsSize=Nothing }
229+
230+-- | Set the maximum header lines per mime/multipart entry.
231+--
232+-- @since 3.0.16.0
233+setMaxHeaderLines :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
234+setMaxHeaderLines l p = p { prboMaxHeaderLines=Just l }
235+
236+-- | Do not limit the maximum header lines per mime/multipart entry.
237+--
238+-- @since 3.0.16.0
239+clearMaxHeaderLines:: ParseRequestBodyOptions -> ParseRequestBodyOptions
240+clearMaxHeaderLines p = p { prboMaxHeaderLines=Nothing }
241+
242+-- | Set the maximum header line length per mime/multipart entry.
243+--
244+-- @since 3.0.16.0
245+setMaxHeaderLineLength :: Int -> ParseRequestBodyOptions -> ParseRequestBodyOptions
246+setMaxHeaderLineLength l p = p { prboMaxHeaderLineLength=Just l }
247+
248+-- | Do not limit the maximum header lines per mime/multipart entry.
249+--
250+-- @since 3.0.16.0
251+clearMaxHeaderLineLength :: ParseRequestBodyOptions -> ParseRequestBodyOptions
252+clearMaxHeaderLineLength p = p { prboMaxHeaderLineLength=Nothing }
253+
254+-- | A reasonable default set of parsing options.
255+-- Maximum key/filename length: 32 bytes;
256+-- maximum files: 10; filesize unlimited; maximum
257+-- size for parameters: 64kbytes; maximum number of header
258+-- lines: 32 bytes (applies only to headers of a mime/multipart message);
259+-- maximum header line length: Apache's default for that is 8190 bytes
260+-- (http://httpd.apache.org/docs/2.2/mod/core.html#limitrequestline)
261+-- so we're using that here as well.
262+--
263+-- @since 3.0.16.0
264+defaultParseRequestBodyOptions :: ParseRequestBodyOptions
265+defaultParseRequestBodyOptions = ParseRequestBodyOptions
266+ { prboKeyLength=Just 32
267+ , prboMaxNumFiles=Just 10
268+ , prboMaxFileSize=Nothing
269+ , prboMaxFilesSize=Nothing
270+ , prboMaxParmsSize=Just 65336
271+ , prboMaxHeaderLines=Just 32
272+ , prboMaxHeaderLineLength=Just 8190 }
273+
274+-- | Do not impose any memory limits.
275+--
276+-- @since 3.0.21.0
277+noLimitParseRequestBodyOptions :: ParseRequestBodyOptions
278+noLimitParseRequestBodyOptions = ParseRequestBodyOptions
279+ { prboKeyLength=Nothing
280+ , prboMaxNumFiles=Nothing
281+ , prboMaxFileSize=Nothing
282+ , prboMaxFilesSize=Nothing
283+ , prboMaxParmsSize=Nothing
284+ , prboMaxHeaderLines=Nothing
285+ , prboMaxHeaderLineLength=Nothing }
117
286
118-- | Information on an uploaded file.
287-- | Information on an uploaded file.
119data FileInfo c = FileInfo
288data FileInfo c = FileInfo
@@ -136,8 +305,16 @@ type BackEnd a = S.ByteString -- ^ parameter name
136 -> IO S.ByteString
305 -> IO S.ByteString
137 -> IO a
306 -> IO a
138
307
308+-- | The mimetype of the http body.
309+-- Depending on whether just parameters or parameters and files
310+-- are passed, one or the other mimetype should be used.
311+data RequestBodyType
312+ = -- | application/x-www-form-urlencoded (parameters only)
313+ UrlEncoded
314+ | -- | multipart/form-data (parameters and files)
139−data RequestBodyType = UrlEncoded | Multipart S.ByteString
315+ Multipart S.ByteString
140
316
317+-- | Get the mimetype of the body of an http request.
141getRequestBodyType :: Request -> Maybe RequestBodyType
318getRequestBodyType :: Request -> Maybe RequestBodyType
142getRequestBodyType req = do
319getRequestBodyType req = do
143 ctype' <- lookup hContentType $ requestHeaders req
320 ctype' <- lookup hContentType $ requestHeaders req
@@ -150,7 +327,7 @@ getRequestBodyType req = do
150-- | Parse a content type value, turning a single @ByteString@ into the actual
327-- | Parse a content type value, turning a single @ByteString@ into the actual
151-- content type and a list of pairs of attributes.
328-- content type and a list of pairs of attributes.
152--
329--
153−-- Since 1.3.2
330+-- @since 1.3.2
154parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
331parseContentType :: S.ByteString -> (S.ByteString, [(S.ByteString, S.ByteString)])
155parseContentType a = do
332parseContentType a = do
156 let (ctype, b) = S.break (== semicolon) a
333 let (ctype, b) = S.break (== semicolon) a
@@ -160,6 +337,9 @@ parseContentType a = do
160 semicolon = 59
337 semicolon = 59
161 equals = 61
338 equals = 61
162 space = 32
339 space = 32
340+ dq s = if S.length s > 2 && S.head s == 34 && S.last s == 34 -- quote
341+ then S.tail $ S.init s
342+ else s
163 goAttrs front bs
343 goAttrs front bs
164 | S.null bs = front []
344 | S.null bs = front []
165 | otherwise =
345 | otherwise =
@@ -168,79 +348,140 @@ parseContentType a = do
168 goAttr bs =
348 goAttr bs =
169 let (k, v') = S.break (== equals) bs
349 let (k, v') = S.break (== equals) bs
170 v = S.drop 1 v'
350 v = S.drop 1 v'
171− in (strip k, strip v)
351+ in (strip k, dq $ strip v)
172 strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
352 strip = S.dropWhile (== space) . fst . S.breakEnd (/= space)
173
353
354+-- | Parse the body of an HTTP request.
355+-- See parseRequestBodyEx for details.
356+-- Note: This function does not limit the memory it allocates.
357+-- When dealing with untrusted data (as is usually the case when
358+-- receiving input from the internet), it is recommended to
359+-- use the 'parseRequestBodyEx' function instead.
174parseRequestBody :: BackEnd y
360parseRequestBody :: BackEnd y
175 -> Request
361 -> Request
176 -> IO ([Param], [File y])
362 -> 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 =
178 case getRequestBodyType r of
376 case getRequestBodyType r of
179 Nothing -> return ([], [])
377 Nothing -> return ([], [])
180− Just rbt -> sinkRequestBody s rbt (requestBody r)
378+ Just rbt -> sinkRequestBodyEx o s rbt (requestBody r)
181
379
182sinkRequestBody :: BackEnd y
380sinkRequestBody :: BackEnd y
183 -> RequestBodyType
381 -> RequestBodyType
184 -> IO S.ByteString
382 -> IO S.ByteString
185 -> IO ([Param], [File y])
383 -> IO ([Param], [File y])
186−sinkRequestBody s r body = do
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
187− ref <- newIORef (id, id)
395+ ref <- newIORef ([], [])
188 let add x = atomicModifyIORef ref $ \(y, z) ->
396 let add x = atomicModifyIORef ref $ \(y, z) ->
189 case x of
397 case x of
190− Left y' -> ((y . (y':), z), ())
398+ Left y' -> ((y':y, z), ())
191− Right z' -> ((y, z . (z':)), ())
399+ Right z' -> ((y, z':z), ())
192− conduitRequestBody s r body add
400+ conduitRequestBodyEx o s r body add
193− (x, y) <- readIORef ref
401+ (\(a, b) -> (reverse a, reverse b)) <$> readIORef ref
194− return (x [], y [])
402+
195−
403+conduitRequestBodyEx :: ParseRequestBodyOptions
196−conduitRequestBody :: BackEnd y
404+ -> BackEnd y
197− -> RequestBodyType
405+ -> RequestBodyType
198− -> IO S.ByteString
406+ -> IO S.ByteString
199− -> (Either Param (File y) -> IO ())
407+ -> (Either Param (File y) -> IO ())
200− -> IO ()
408+ -> IO ()
201−conduitRequestBody _ UrlEncoded rbody add = do
409+conduitRequestBodyEx o _ UrlEncoded rbody add = do
202 -- NOTE: in general, url-encoded data will be in a single chunk.
410 -- NOTE: in general, url-encoded data will be in a single chunk.
203 -- Therefore, I'm optimizing for the usual case by sticking with
411 -- Therefore, I'm optimizing for the usual case by sticking with
204 -- strict byte strings here.
412 -- strict byte strings here.
205− let loop front = do
413+ let loop size front = do
206 bs <- rbody
414 bs <- rbody
207 if S.null bs
415 if S.null bs
208 then return $ S.concat $ front []
416 then return $ S.concat $ front []
417+ else do
418+ let newsize = size + S.length bs
419+ case prboMaxParmsSize o of
420+ Just maxSize -> when (newsize > maxSize) $
421+ error "Maximum size of parameters exceeded"
422+ Nothing -> return ()
209− else loop $ front . (bs:)
423+ loop newsize $ front . (bs:)
210− bs <- loop id
424+ bs <- loop 0 id
211 mapM_ (add . Left) $ H.parseSimpleQuery bs
425 mapM_ (add . Left) $ H.parseSimpleQuery bs
212−conduitRequestBody backend (Multipart bound) rbody add =
426+conduitRequestBodyEx o backend (Multipart bound) rbody add =
213− parsePieces backend (S8.pack "--" `S.append` bound) rbody add
427+ parsePiecesEx o backend (S8.pack "--" `S.append` bound) rbody add
428+
214
429
430+-- | Take one header or subheader line.
431+-- Since: 3.0.26
432+-- Throw 431 if headers too large.
215−takeLine :: Source -> IO (Maybe S.ByteString)
433+takeLine :: Maybe Int -> Source -> IO (Maybe S.ByteString)
216−takeLine src =
434+takeLine maxlen src =
217− go id
435+ go ""
218 where
436 where
219 go front = do
437 go front = do
220 bs <- readSource src
438 bs <- readSource src
439+ case maxlen of
440+ Just maxlen' -> when (S.length front > maxlen') $
441+ E.throwIO $ ConnectionError (UnknownErrorCode 431)
442+ "Request Header Fields Too Large"
443+ Nothing -> return ()
221 if S.null bs
444 if S.null bs
222 then close front
445 then close front
223 else push front bs
446 else push front bs
224
447
225− close front = leftover src (front S.empty) >> return Nothing
448+ close front = leftover src front >> return Nothing
226 push front bs = do
449 push front bs = do
227− let (x, y) = S.break (== 10) $ front bs -- LF
450+ let (x, y) = S.break (== 10) bs -- LF
228 in if S.null y
451 in if S.null y
229− then go $ S.append x
452+ then go $ front `S.append` x
230 else do
453 else do
231 when (S.length y > 1) $ leftover src $ S.drop 1 y
454 when (S.length y > 1) $ leftover src $ S.drop 1 y
232− return $ Just $ killCR x
455+ let res = front `S.append` x
233−
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+
234−takeLines :: Source -> IO [S.ByteString]
463+takeLines' :: Maybe Int -> Maybe Int -> Source -> IO [S.ByteString]
235−takeLines src = do
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 ()
236− res <- takeLine src
479+ res <- takeLine lineLength src
237 case res of
480 case res of
238− Nothing -> return []
481+ Nothing -> return lines
239 Just l
482 Just l
240− | S.null l -> return []
483+ | S.null l -> return lines
241− | otherwise -> do
484+ | otherwise -> takeLines'' (l:lines) lineLength maxLines src
242− ls <- takeLines src
243− return $ l : ls
244
485
245data Source = Source (IO S.ByteString) (IORef S.ByteString)
486data Source = Source (IO S.ByteString) (IORef S.ByteString)
246
487
@@ -259,17 +500,20 @@ readSource (Source f ref) = do
259leftover :: Source -> S.ByteString -> IO ()
500leftover :: Source -> S.ByteString -> IO ()
260leftover (Source _ ref) bs = writeIORef ref bs
501leftover (Source _ ref) bs = writeIORef ref bs
261
502
503+parsePiecesEx :: ParseRequestBodyOptions
262−parsePieces :: BackEnd y
504+ -> BackEnd y
263− -> S.ByteString
505+ -> S.ByteString
264− -> IO S.ByteString
506+ -> IO S.ByteString
265− -> (Either Param (File y) -> IO ())
507+ -> (Either Param (File y) -> IO ())
266− -> IO ()
508+ -> IO ()
267−parsePieces sink bound rbody add =
509+parsePiecesEx o sink bound rbody add =
268− mkSource rbody >>= loop
510+ mkSource rbody >>= loop 0 0 0 0
269 where
511 where
270− loop src = do
512+ loop :: Int -> Int -> Int -> Int64 -> Source -> IO ()
513+ loop numParms numFiles parmSize filesSize src = do
271− _boundLine <- takeLine src
514+ _boundLine <- takeLine (prboMaxHeaderLineLength o) src
272− res' <- takeLines src
515+ res' <- takeLines' (prboMaxHeaderLineLength o)
516+ (prboMaxHeaderLines o) src
273 unless (null res') $ do
517 unless (null res') $ do
274 let ls' = map parsePair res'
518 let ls' = map parsePair res'
275 let x = do
519 let x = do
@@ -280,31 +524,57 @@ parsePieces sink bound rbody add =
280 return (ct, name, lookup "filename" attrs)
524 return (ct, name, lookup "filename" attrs)
281 case x of
525 case x of
282 Just (mct, name, Just filename) -> do
526 Just (mct, name, Just filename) -> do
527+ case prboKeyLength o of
528+ Just maxKeyLength ->
529+ when (S.length name > maxKeyLength) $
530+ error "Filename is too long"
531+ Nothing -> return ()
532+ case prboMaxNumFiles o of
533+ Just maxFiles -> when (numFiles >= maxFiles) $
534+ error "Maximum number of files exceeded"
535+ Nothing -> return ()
283 let ct = fromMaybe "application/octet-stream" mct
536 let ct = fromMaybe "application/octet-stream" mct
284 fi0 = FileInfo filename ct ()
537 fi0 = FileInfo filename ct ()
538+ fs = catMaybes [ prboMaxFileSize o
539+ , subtract filesSize <$> prboMaxFilesSize o ]
540+ mfs = if fs == [] then Nothing else Just $ minimum fs
285− (wasFound, y) <- sinkTillBound' bound name fi0 sink src
541+ ((wasFound, fileSize), y) <- sinkTillBound' bound name fi0 sink src mfs
542+ let newFilesSize = filesSize + fileSize
286 add $ Right (name, fi0 { fileContent = y })
543 add $ Right (name, fi0 { fileContent = y })
287− when wasFound (loop src)
544+ when wasFound $ loop numParms (numFiles + 1) parmSize newFilesSize src
288 Just (_ct, name, Nothing) -> do
545 Just (_ct, name, Nothing) -> do
546+ case prboKeyLength o of
547+ Just maxKeyLength ->
548+ when (S.length name > maxKeyLength) $
549+ error "Parameter name is too long"
550+ Nothing -> return ()
289 let seed = id
551 let seed = id
290 let iter front bs = return $ front . (:) bs
552 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)
292 let bs = S.concat $ front []
555 let bs = S.concat $ front []
293 let x' = (name, bs)
556 let x' = (name, bs)
557+ let newParmSize = parmSize + S.length name + S.length bs
558+ case prboMaxParmsSize o of
559+ Just maxParmSize -> when (newParmSize > maxParmSize) $
560+ error "Maximum size of parameters exceeded"
561+ Nothing -> return ()
294 add $ Left x'
562 add $ Left x'
295− when wasFound (loop src)
563+ when wasFound $ loop (numParms + 1) numFiles
564+ newParmSize filesSize src
296 _ -> do
565 _ -> do
297 -- ignore this part
566 -- ignore this part
298 let seed = ()
567 let seed = ()
299 iter () _ = return ()
568 iter () _ = return ()
300− (wasFound, ()) <- sinkTillBound bound iter seed src
569+ ((wasFound, _fileSize), ()) <- sinkTillBound bound iter seed src Nothing
301− when wasFound (loop src)
570+ when wasFound $ loop numParms numFiles parmSize filesSize src
302 where
571 where
303− contDisp = S8.pack "Content-Disposition"
572+ contDisp = mk $ S8.pack "Content-Disposition"
304− contType = S8.pack "Content-Type"
573+ contType = mk $ S8.pack "Content-Type"
305 parsePair s =
574 parsePair s =
306 let (x, y) = breakDiscard 58 s -- colon
575 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+
308
578
309data Bound = FoundBound S.ByteString S.ByteString
579data Bound = FoundBound S.ByteString S.ByteString
310 | NoBound
580 | NoBound
@@ -312,7 +582,7 @@ data Bound = FoundBound S.ByteString S.ByteString
312 deriving (Eq, Show)
582 deriving (Eq, Show)
313
583
314findBound :: S.ByteString -> S.ByteString -> Bound
584findBound :: S.ByteString -> S.ByteString -> Bound
315−findBound b bs = handleBreak $ Search.breakOn b bs
585+findBound b bs = handleBreak $ S.breakSubstring b bs
316 where
586 where
317 handleBreak (h, t)
587 handleBreak (h, t)
318 | S.null t = go [lowBound..S.length bs - 1]
588 | S.null t = go [lowBound..S.length bs - 1]
@@ -339,9 +609,10 @@ sinkTillBound' :: S.ByteString
339 -> FileInfo ()
609 -> FileInfo ()
340 -> BackEnd y
610 -> BackEnd y
341 -> Source
611 -> Source
612+ -> Maybe Int64
342− -> IO (Bool, y)
613+ -> IO ((Bool, Int64), y)
343−sinkTillBound' bound name fi sink src = do
614+sinkTillBound' bound name fi sink src max' = do
344− (next, final) <- wrapTillBound bound src
615+ (next, final) <- wrapTillBound bound src max'
345 y <- sink name fi next
616 y <- sink name fi next
346 b <- final
617 b <- final
347 return (b, y)
618 return (b, y)
@@ -350,30 +621,40 @@ data WTB = WTBWorking (S.ByteString -> S.ByteString)
350 | WTBDone Bool
621 | WTBDone Bool
351wrapTillBound :: S.ByteString -- ^ bound
622wrapTillBound :: S.ByteString -- ^ bound
352 -> Source
623 -> Source
624+ -> Maybe Int64
353− -> IO (IO S.ByteString, IO Bool) -- ^ Bool indicates if the bound was found
625+ -> IO (IO S.ByteString, IO (Bool, Int64)) -- ^ Bool indicates if the bound was found
354−wrapTillBound bound src = do
626+wrapTillBound bound src max' = do
355 ref <- newIORef $ WTBWorking id
627 ref <- newIORef $ WTBWorking id
628+ sref <- newIORef (0 :: Int64)
356− return (go ref, final ref)
629+ return (go ref sref, final ref sref)
357 where
630 where
358− final ref = do
631+ final ref sref = do
359 x <- readIORef ref
632 x <- readIORef ref
360 case x of
633 case x of
361 WTBWorking _ -> error "wrapTillBound did not finish"
634 WTBWorking _ -> error "wrapTillBound did not finish"
362− WTBDone y -> return y
635+ WTBDone y -> do
636+ siz <- readIORef sref
637+ return (y, siz)
363
638
364− go ref = do
639+ go ref sref = do
365 state <- readIORef ref
640 state <- readIORef ref
366 case state of
641 case state of
367 WTBDone _ -> return S.empty
642 WTBDone _ -> return S.empty
368 WTBWorking front -> do
643 WTBWorking front -> do
369 bs <- readSource src
644 bs <- readSource src
645+ cur <- atomicModifyIORef' sref $ \ cur ->
646+ let new = cur + fromIntegral (S.length bs) in (new, new)
647+ case max' of
648+ Just max'' | cur > max'' ->
649+ E.throwIO $ ConnectionError (UnknownErrorCode 413) "Payload Too Large"
650+ _ -> return ()
370 if S.null bs
651 if S.null bs
371 then do
652 then do
372 writeIORef ref $ WTBDone False
653 writeIORef ref $ WTBDone False
373 return $ front bs
654 return $ front bs
374 else push $ front bs
655 else push $ front bs
375 where
656 where
376− push bs =
657+ push bs = do
377 case findBound bound bs of
658 case findBound bound bs of
378 FoundBound before after -> do
659 FoundBound before after -> do
379 let before' = killCRLF before
660 let before' = killCRLF before
@@ -389,19 +670,20 @@ wrapTillBound bound src = do
389 else (bs, id)
670 else (bs, id)
390 writeIORef ref $ WTBWorking front'
671 writeIORef ref $ WTBWorking front'
391 if S.null toEmit
672 if S.null toEmit
392− then go ref
673+ then go ref sref
393 else return toEmit
674 else return toEmit
394 PartialBound -> do
675 PartialBound -> do
395 writeIORef ref $ WTBWorking $ S.append bs
676 writeIORef ref $ WTBWorking $ S.append bs
396− go ref
677+ go ref sref
397
678
398sinkTillBound :: S.ByteString
679sinkTillBound :: S.ByteString
399 -> (x -> S.ByteString -> IO x)
680 -> (x -> S.ByteString -> IO x)
400 -> x
681 -> x
401 -> Source
682 -> Source
683+ -> Maybe Int64
402− -> IO (Bool, x)
684+ -> IO ((Bool, Int64), x)
403−sinkTillBound bound iter seed0 src = do
685+sinkTillBound bound iter seed0 src max' = do
404− (next, final) <- wrapTillBound bound src
686+ (next, final) <- wrapTillBound bound src max'
405 let loop seed = do
687 let loop seed = do
406 bs <- next
688 bs <- next
407 if S.null bs
689 if S.null bs
wai-extra/Network/Wai/Request.hs+53−3
@@ -1,17 +1,25 @@
1+{-# LANGUAGE DeriveDataTypeable #-}
1-- | Some helpers for interrogating a WAI 'Request'.
2-- | Some helpers for interrogating a WAI 'Request'.
2
3
3module Network.Wai.Request
4module Network.Wai.Request
4 ( appearsSecure
5 ( appearsSecure
5 , guessApproot
6 , guessApproot
7+ , RequestSizeException(..)
8+ , requestSizeCheck
6 ) where
9 ) where
7
10
8import Data.ByteString (ByteString)
11import Data.ByteString (ByteString)
9import Data.Maybe (fromMaybe)
12import Data.Maybe (fromMaybe)
10import Network.HTTP.Types (HeaderName)
13import Network.HTTP.Types (HeaderName)
11−import Network.Wai (Request, isSecure, requestHeaders, requestHeaderHost)
14+import Network.Wai
12
15
13import qualified Data.ByteString as S
16import qualified Data.ByteString as S
14import qualified Data.ByteString.Char8 as C
17import 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+
15
23
16-- | Does this request appear to have been made over an SSL connection?
24-- | Does this request appear to have been made over an SSL connection?
17--
25--
@@ -24,7 +32,7 @@ import qualified Data.ByteString.Char8 as C
24-- force a non-SSL request to SSL by redirect. One can safely choose not to
32-- force a non-SSL request to SSL by redirect. One can safely choose not to
25-- redirect when the request /appears/ secure, even if it's actually not.
33-- redirect when the request /appears/ secure, even if it's actually not.
26--
34--
27−-- Since 3.0.7
35+-- @since 3.0.7
28appearsSecure :: Request -> Bool
36appearsSecure :: Request -> Bool
29appearsSecure request = isSecure request || any (uncurry matchHeader)
37appearsSecure request = isSecure request || any (uncurry matchHeader)
30 [ ("HTTPS" , (== "on"))
38 [ ("HTTPS" , (== "on"))
@@ -44,8 +52,50 @@ appearsSecure request = isSecure request || any (uncurry matchHeader)
44-- application. For more information and relevant caveats, please see
52-- application. For more information and relevant caveats, please see
45-- "Network.Wai.Middleware.Approot".
53-- "Network.Wai.Middleware.Approot".
46--
54--
47−-- Since 3.0.7
55+-- @since 3.0.7
48guessApproot :: Request -> ByteString
56guessApproot :: Request -> ByteString
49guessApproot req =
57guessApproot req =
50 (if appearsSecure req then "https://" else "http://") `S.append`
58 (if appearsSecure req then "https://" else "http://") `S.append`
51 (fromMaybe "localhost" $ requestHeaderHost req)
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+28−35
@@ -39,21 +39,20 @@ import Data.Monoid (mempty, mappend)
39
39
40import Network.Wai
40import Network.Wai
41import Network.Wai.Internal (ResponseReceived (ResponseReceived))
41import Network.Wai.Internal (ResponseReceived (ResponseReceived))
42+import Network.Wai.Test.Internal
42import Control.Monad.IO.Class (liftIO)
43import Control.Monad.IO.Class (liftIO)
43import Control.Monad.Trans.Class (lift)
44import Control.Monad.Trans.Class (lift)
44import qualified Control.Monad.Trans.State as ST
45import qualified Control.Monad.Trans.State as ST
45−import Control.Monad.Trans.Reader (ReaderT, runReaderT, ask)
46+import Control.Monad.Trans.Reader (runReaderT, ask)
46import Control.Monad (unless)
47import Control.Monad (unless)
47import Control.DeepSeq (deepseq)
48import Control.DeepSeq (deepseq)
48import Control.Exception (throwIO, Exception)
49import Control.Exception (throwIO, Exception)
49import Data.Typeable (Typeable)
50import Data.Typeable (Typeable)
50−import Data.Map (Map)
51import qualified Data.Map as Map
51import qualified Data.Map as Map
52import qualified Web.Cookie as Cookie
52import qualified Web.Cookie as Cookie
53import Data.ByteString (ByteString)
53import Data.ByteString (ByteString)
54import qualified Data.ByteString.Char8 as S8
54import qualified Data.ByteString.Char8 as S8
55−import Blaze.ByteString.Builder (toLazyByteString, toByteString)
55+import Data.ByteString.Builder (toLazyByteString)
56−import qualified Blaze.ByteString.Builder as B
57import qualified Data.ByteString.Lazy as L
56import qualified Data.ByteString.Lazy as L
58import qualified Data.ByteString.Lazy.Char8 as L8
57import qualified Data.ByteString.Lazy.Char8 as L8
59import qualified Network.HTTP.Types as H
58import qualified Network.HTTP.Types as H
@@ -64,17 +63,6 @@ import qualified Data.Text.Encoding as TE
64import Data.IORef
63import Data.IORef
65import Data.Time.Clock (getCurrentTime)
64import Data.Time.Clock (getCurrentTime)
66
65
67−type Session = ReaderT Application (ST.StateT ClientState IO)
68−
69−-- |
70−--
71−-- Since 3.0.6
72−type ClientCookies = Map ByteString Cookie.SetCookie
73−
74−data ClientState = ClientState
75− { clientCookies :: ClientCookies
76− }
77−
78-- |
66-- |
79--
67--
80-- Since 3.0.6
68-- Since 3.0.6
@@ -104,15 +92,17 @@ deleteClientCookie cookieName =
104 modifyClientCookies
92 modifyClientCookies
105 (Map.delete cookieName)
93 (Map.delete cookieName)
106
94
107−initState :: ClientState
95+-- | See also: 'runSessionWith'.
108−initState = ClientState Map.empty
109−
110runSession :: Session a -> Application -> IO a
96runSession :: Session a -> Application -> IO a
111runSession session app = ST.evalStateT (runReaderT session app) initState
97runSession session app = ST.evalStateT (runReaderT session app) initState
112
98
113data SRequest = SRequest
99data SRequest = SRequest
114 { simpleRequest :: Request
100 { simpleRequest :: Request
115 , simpleRequestBody :: L.ByteString
101 , simpleRequestBody :: L.ByteString
102+ -- ^ Request body that will override the one set in 'simpleRequest'.
103+ --
104+ -- This is usually simpler than setting the body as a stateful IO-action
105+ -- in 'simpleRequest'.
116 }
106 }
117data SResponse = SResponse
107data SResponse = SResponse
118 { simpleStatus :: H.Status
108 { simpleStatus :: H.Status
@@ -120,14 +110,22 @@ data SResponse = SResponse
120 , simpleBody :: L.ByteString
110 , simpleBody :: L.ByteString
121 }
111 }
122 deriving (Show, Eq)
112 deriving (Show, Eq)
113+
123request :: Request -> Session SResponse
114request :: Request -> Session SResponse
124−request = srequest . flip SRequest L.empty
115+request req = do
116+ app <- ask
117+ req' <- addCookiesToRequest req
118+ response <- liftIO $ do
119+ ref <- newIORef $ error "runResponse gave no result"
120+ ResponseReceived <- app req' (runResponse ref)
121+ readIORef ref
122+ extractSetCookieFromSResponse response
125
123
126-- | Set whole path (request path + query string).
124-- | Set whole path (request path + query string).
127setPath :: Request -> S8.ByteString -> Request
125setPath :: Request -> S8.ByteString -> Request
128setPath req path = req {
126setPath req path = req {
129 pathInfo = segments
127 pathInfo = segments
130− , rawPathInfo = B.toByteString (H.encodePathSegments segments)
128+ , rawPathInfo = (L8.toStrict . toLazyByteString) (H.encodePathSegments segments)
131 , queryString = query
129 , queryString = query
132 , rawQueryString = (H.renderQuery True query)
130 , rawQueryString = (H.renderQuery True query)
133 }
131 }
@@ -156,7 +154,7 @@ addCookiesToRequest req = do
156 let cookiePairs = [ (Cookie.setCookieName c, Cookie.setCookieValue c)
154 let cookiePairs = [ (Cookie.setCookieName c, Cookie.setCookieValue c)
157 | c <- map snd $ Map.toList cookiesForRequest
155 | c <- map snd $ Map.toList cookiesForRequest
158 ]
156 ]
159− let cookieValue = toByteString $ Cookie.renderCookies cookiePairs
157+ let cookieValue = L8.toStrict . toLazyByteString $ Cookie.renderCookies cookiePairs
160 addCookieHeader rest
158 addCookieHeader rest
161 | null cookiePairs = rest
159 | null cookiePairs = rest
162 | otherwise = ("Cookie", cookieValue) : rest
160 | otherwise = ("Cookie", cookieValue) : rest
@@ -180,22 +178,18 @@ extractSetCookieFromSResponse response = do
180 (Map.fromList [(Cookie.setCookieName c, c) | c <- newClientCookies ]))
178 (Map.fromList [(Cookie.setCookieName c, c) | c <- newClientCookies ]))
181 return response
179 return response
182
180
181+-- | Similar to 'request', but allows setting the request body as a plain
182+-- 'L.ByteString'.
183srequest :: SRequest -> Session SResponse
183srequest :: SRequest -> Session SResponse
184srequest (SRequest req bod) = do
184srequest (SRequest req bod) = do
185− app <- ask
186 refChunks <- liftIO $ newIORef $ L.toChunks bod
185 refChunks <- liftIO $ newIORef $ L.toChunks bod
186+ request $
187− let req' = req
187+ req
188− { requestBody = atomicModifyIORef refChunks $ \bss ->
188+ { requestBody = atomicModifyIORef refChunks $ \bss ->
189− case bss of
189+ case bss of
190− [] -> ([], S.empty)
190+ [] -> ([], S.empty)
191− x:y -> (y, x)
191+ x:y -> (y, x)
192− }
192+ }
193− req'' <- addCookiesToRequest req'
194− response <- liftIO $ do
195− ref <- newIORef $ error "runResponse gave no result"
196− ResponseReceived <- app req'' (runResponse ref)
197− readIORef ref
198− extractSetCookieFromSResponse response
199
193
200runResponse :: IORef SResponse -> Response -> IO ResponseReceived
194runResponse :: IORef SResponse -> Response -> IO ResponseReceived
201runResponse ref res = do
195runResponse ref res = do
@@ -337,4 +331,3 @@ assertClientCookieValue s cookieName cookieValue = do
337 ]
331 ]
338 )
332 )
339 (Cookie.setCookieValue c == cookieValue)
333 (Cookie.setCookieValue c == cookieValue)
340−
wai-extra/Network/Wai/Test/Internal.hsnew file+35
@@ -0,0 +1,35 @@
1+module Network.Wai.Test.Internal where
2+
3+import Network.Wai
4+import qualified Control.Monad.Trans.State as ST
5+import Control.Monad.Trans.Reader (ReaderT, runReaderT)
6+import Data.Map (Map)
7+import qualified Data.Map as Map
8+import qualified Web.Cookie as Cookie
9+import Data.ByteString (ByteString)
10+
11+type Session = ReaderT Application (ST.StateT ClientState IO)
12+
13+-- |
14+--
15+-- Since 3.0.6
16+type ClientCookies = Map ByteString Cookie.SetCookie
17+
18+data ClientState = ClientState
19+ { clientCookies :: ClientCookies
20+ }
21+
22+-- |
23+--
24+-- Since 3.0.20.0
25+initState :: ClientState
26+initState = ClientState Map.empty
27+
28+-- | Like 'runSession', but if allows you to hand in cookies and get
29+-- the updated cookies back. One use case for this is writing tests
30+-- that address the application under test alternatingly through rest
31+-- api and through db handle.
32+--
33+-- Since 3.0.20.0
34+runSessionWith :: ClientState -> Session a -> Application -> IO (a, ClientState)
35+runSessionWith st session app = ST.runStateT (runReaderT session app) st
wai-extra/README.md+14−1
@@ -1,3 +1,16 @@
1−## wai-extra
1+# wai-extra
2
2
3The goal here is to provide common features without many dependencies.
3The 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 @@
1<!doctype html>
1<!doctype html>
2<head>
2<head>
3− <title>Hello</title>
3+ <title>Example</title>
4+ <link rel="icon" href="data:;base64,=">
4</head>
5</head>
5−<h1>Testing</h1>
6+<h1>Testing Server-Sent Events</h1>
6
7
7<div id="output"></div>
8<div id="output"></div>
8
9
wai-extra/test/Network/Wai/Middleware/ForceSSLSpec.hs+9−5
@@ -8,6 +8,7 @@ import Test.Hspec
8
8
9import Network.Wai.Middleware.ForceSSL
9import Network.Wai.Middleware.ForceSSL
10
10
11+import Control.Monad
11import Data.ByteString (ByteString)
12import Data.ByteString (ByteString)
12import Data.Monoid ((<>))
13import Data.Monoid ((<>))
13import Network.HTTP.Types (methodPost, status200, status301, status307)
14import Network.HTTP.Types (methodPost, status200, status301, status307)
@@ -18,8 +19,12 @@ main :: IO ()
18main = hspec spec
19main = hspec spec
19
20
20spec :: Spec
21spec :: Spec
21−spec = describe "forceSSL" $ do
22+spec = describe "forceSSL" (forM_ hosts $ \host -> hostSpec host)
22− let host = "example.com"
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
23
28
24 it "redirects non-https requests to https" $ do
29 it "redirects non-https requests to https" $ do
25 resp <- runApp host forceSSL defaultRequest
30 resp <- runApp host forceSSL defaultRequest
@@ -39,7 +44,7 @@ spec = describe "forceSSL" $ do
39
44
40 simpleStatus resp `shouldBe` status200
45 simpleStatus resp `shouldBe` status200
41
46
42− it "preserves the original path and query string" $ do
47+ it "preserves the original host, path, and query string" $ do
43 resp <- runApp host forceSSL defaultRequest
48 resp <- runApp host forceSSL defaultRequest
44 { rawPathInfo = "/foo/bar"
49 { rawPathInfo = "/foo/bar"
45 , rawQueryString = "?baz=bat"
50 , rawQueryString = "?baz=bat"
@@ -50,7 +55,6 @@ spec = describe "forceSSL" $ do
50
55
51runApp :: ByteString -> Middleware -> Request -> IO SResponse
56runApp :: ByteString -> Middleware -> Request -> IO SResponse
52runApp host mw req = runSession
57runApp host mw req = runSession
53− (request req { requestHeaderHost = Just $ host <> ":80" }) $ mw app
58+ (request req { requestHeaderHost = Just host }) $ mw app
54−
55 where
59 where
56 app _ respond = respond $ responseLBS status200 [] ""
60 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
13import qualified Data.Text as TS
13import qualified Data.Text as TS
14import qualified Data.Text.Encoding as TE
14import qualified Data.Text.Encoding as TE
15import Control.Monad.Trans.Resource (withInternalState, runResourceT)
15import Control.Monad.Trans.Resource (withInternalState, runResourceT)
16+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
16
17
17import Network.Wai
18import Network.Wai
18import Network.Wai.Test
19import Network.Wai.Test
@@ -30,6 +31,7 @@ spec = do
30 [ ("text/plain", "text/plain", [])
31 [ ("text/plain", "text/plain", [])
31 , ("text/plain; charset=UTF-8 ", "text/plain", [("charset", "UTF-8")])
32 , ("text/plain; charset=UTF-8 ", "text/plain", [("charset", "UTF-8")])
32 , ("text/plain; charset=UTF-8 ; boundary = foo", "text/plain", [("charset", "UTF-8"), ("boundary", "foo")])
33 , ("text/plain; charset=UTF-8 ; boundary = foo", "text/plain", [("charset", "UTF-8"), ("boundary", "foo")])
34+ , ("text/plain; charset=UTF-8 ; boundary = \"quoted\"", "text/plain", [("charset", "UTF-8"), ("boundary", "quoted")])
33 ]
35 ]
34 it "parseHttpAccept" caseParseHttpAccept
36 it "parseHttpAccept" caseParseHttpAccept
35 describe "parseRequestBody" $ do
37 describe "parseRequestBody" $ do
@@ -93,6 +95,11 @@ caseParseRequestBody = do
93 let expectedfile3 = [("yaml", FileInfo "README" "application/octet-stream" "Photo blog using Hack.\n")]
95 let expectedfile3 = [("yaml", FileInfo "README" "application/octet-stream" "Photo blog using Hack.\n")]
94 let expected3 = (expectedsmap3, expectedfile3)
96 let expected3 = (expectedsmap3, expectedfile3)
95
97
98+ let unknownErrorException c (ConnectionError (UnknownErrorCode code) _) = c == code
99+ unknownErrorException _ _ = False
100+
101+
102+ let def = defaultParseRequestBodyOptions
96 it "parsing actual post multipart/form-data" $ do
103 it "parsing actual post multipart/form-data" $ do
97 result3 <- parseRequestBody' lbsBackEnd $ toRequest ctype3 content3
104 result3 <- parseRequestBody' lbsBackEnd $ toRequest ctype3 content3
98 result3 `shouldBe` expected3
105 result3 `shouldBe` expected3
@@ -100,6 +107,61 @@ caseParseRequestBody = do
100 it "parsing actual post multipart/form-data 2" $ do
107 it "parsing actual post multipart/form-data 2" $ do
101 result3' <- parseRequestBody' lbsBackEnd $ toRequest' ctype3 content3
108 result3' <- parseRequestBody' lbsBackEnd $ toRequest' ctype3 content3
102 result3' `shouldBe` expected3
109 result3' `shouldBe` expected3
110+
111+ it "parsing with memory limit" $ do
112+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
113+ result4' <- parseRequestBodyEx ( setMaxRequestNumFiles 1 $ setMaxRequestKeyLength 14 def ) lbsBackEnd req4
114+ result4' `shouldBe` expected3
115+
116+ it "exceeding number of files" $ do
117+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
118+ (parseRequestBodyEx ( setMaxRequestNumFiles 0 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
119+
120+ it "exceeding parameter length" $ do
121+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
122+ (parseRequestBodyEx ( setMaxRequestKeyLength 2 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
123+
124+ it "exceeding file size" $ do
125+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
126+ (parseRequestBodyEx ( setMaxRequestFileSize 2 def ) lbsBackEnd req4)
127+ `shouldThrow` unknownErrorException 413
128+
129+ it "exceeding total file size" $ do
130+ SRequest req4 _bod4 <- toRequest'' ctype3 content3
131+ (parseRequestBodyEx ( setMaxRequestFilesSize 20 def ) lbsBackEnd req4)
132+ `shouldThrow` unknownErrorException 413
133+ SRequest req5 _bod5 <- toRequest'' ctype3 content5
134+ (parseRequestBodyEx ( setMaxRequestFilesSize 20 def ) lbsBackEnd req5)
135+ `shouldThrow` unknownErrorException 413
136+
137+ it "exceeding max parm value size" $ do
138+ SRequest req4 _bod4 <- toRequest'' ctype2 content2
139+ (parseRequestBodyEx ( setMaxRequestParmsSize 10 def ) lbsBackEnd req4)
140+ `shouldThrow` unknownErrorException 413
141+
142+ it "exceeding max header lines" $ do
143+ SRequest req4 _bod4 <- toRequest'' ctype2 content2
144+ (parseRequestBodyEx ( setMaxHeaderLines 1 def ) lbsBackEnd req4) `shouldThrow` anyErrorCall
145+
146+ it "exceeding header line size" $ do
147+ SRequest req4 _bod4 <- toRequest'' ctype3 content4
148+ (parseRequestBodyEx ( setMaxHeaderLineLength 8190 def ) lbsBackEnd req4)
149+ `shouldThrow` unknownErrorException 431
150+
151+ it "Testing parseRequestBodyEx with application/x-www-form-urlencoded" $ do
152+ let content = "thisisalongparameterkey=andthisbeanevenlongerparametervaluehelloworldhowareyou"
153+ let ctype = "application/x-www-form-urlencoded"
154+ SRequest req _bod <- toRequest'' ctype content
155+ result <- parseRequestBodyEx def lbsBackEnd req
156+ result `shouldBe` ([( "thisisalongparameterkey"
157+ , "andthisbeanevenlongerparametervaluehelloworldhowareyou" )], [])
158+
159+ it "exceeding max parm value size with x-www-form-urlencoded mimetype" $ do
160+ let content = "thisisalongparameterkey=andthisbeanevenlongerparametervaluehelloworldhowareyou"
161+ let ctype = "application/x-www-form-urlencoded"
162+ SRequest req _bod <- toRequest'' ctype content
163+ (parseRequestBodyEx ( setMaxRequestParmsSize 10 def ) lbsBackEnd req) `shouldThrow` anyErrorCall
164+
103 where
165 where
104 content2 =
166 content2 =
105 "--AaB03x\n"
167 "--AaB03x\n"
@@ -123,6 +185,27 @@ caseParseRequestBody = do
123 <> "Content-Type: application/octet-stream\r\n\r\n"
185 <> "Content-Type: application/octet-stream\r\n\r\n"
124 <> "Photo blog using Hack.\n\r\n"
186 <> "Photo blog using Hack.\n\r\n"
125 <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
187 <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
188+ content4 =
189+ "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
190+ <> "Content-Disposition: form-data; name=\"alb\"; filename=\"README\"\r\n"
191+ <> "Content-Type: application/octet-stream\r\n\r\n"
192+ <> "Photo blog using Hack.\r\n\r\n"
193+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
194+ <> "Content-Disposition: form-data; name=\"bla\"; filename=\"riedmi"
195+ <> S8.replicate 8190 'e' <> "\"\r\n"
196+ <> "Content-Type: application/octet-stream\r\n\r\n"
197+ <> "Photo blog using Hack.\r\n\r\n"
198+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
199+ content5 =
200+ "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
201+ <> "Content-Disposition: form-data; name=\"yaml\"; filename=\"README\"\r\n"
202+ <> "Content-Type: application/octet-stream\r\n\r\n"
203+ <> "Photo blog using Hack.\n\r\n"
204+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh\r\n"
205+ <> "Content-Disposition: form-data; name=\"yaml2\"; filename=\"MEADRE\"\r\n"
206+ <> "Content-Type: application/octet-stream\r\n\r\n"
207+ <> "Photo blog using Hack.\n\r\n"
208+ <> "------WebKitFormBoundaryB1pWXPZ6lNr8RiLh--\r\n"
126
209
127caseMultipartPlus :: Assertion
210caseMultipartPlus :: Assertion
128caseMultipartPlus = do
211caseMultipartPlus = do
@@ -198,3 +281,14 @@ toRequest' :: S8.ByteString -> S8.ByteString -> SRequest
198toRequest' ctype content = SRequest defaultRequest
281toRequest' ctype content = SRequest defaultRequest
199 { requestHeaders = [("Content-Type", ctype)]
282 { requestHeaders = [("Content-Type", ctype)]
200 } (L.fromChunks $ map S.singleton $ S.unpack content)
283 } (L.fromChunks $ map S.singleton $ S.unpack content)
284+
285+toRequest'' :: S8.ByteString -> S8.ByteString -> IO SRequest
286+toRequest'' ctype content = mkRB content >>= \b -> return $ SRequest defaultRequest
287+ { requestHeaders = [("Content-Type", ctype)], requestBody = b
288+ } (L.fromChunks $ map S.singleton $ S.unpack content)
289+
290+mkRB :: S8.ByteString -> IO (IO S8.ByteString)
291+mkRB content = do
292+ r <- I.newIORef content
293+ return $
294+ I.atomicModifyIORef r $ \a -> (S8.empty, a)
wai-extra/test/Network/Wai/RequestSpec.hs+69−39
@@ -8,52 +8,82 @@ import Test.Hspec
8
8
9import Data.ByteString (ByteString)
9import Data.ByteString (ByteString)
10import Network.HTTP.Types (HeaderName)
10import Network.HTTP.Types (HeaderName)
11−import Network.Wai (Request(..), defaultRequest)
11+import Network.Wai (Request(..), defaultRequest, RequestBodyLength(..))
12
12
13import Network.Wai.Request
13import Network.Wai.Request
14+import Control.Exception (try)
15+import Control.Monad (forever)
14
16
15main :: IO ()
17main :: IO ()
16main = hspec spec
18main = hspec spec
17
19
18spec :: Spec
20spec :: 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+
19−spec = describe "appearsSecure" $ do
49+ describe "appearsSecure" $ do
20− let insecureRequest = defaultRequest
50+ let insecureRequest = defaultRequest
21− { isSecure = False
51+ { isSecure = False
22− , requestHeaders =
52+ , requestHeaders =
23− [ ("HTTPS", "off")
53+ [ ("HTTPS", "off")
24− , ("HTTP_X_FORWARDED_SSL", "off")
54+ , ("HTTP_X_FORWARDED_SSL", "off")
25− , ("HTTP_X_FORWARDED_SCHEME", "http")
55+ , ("HTTP_X_FORWARDED_SCHEME", "http")
26− , ("HTTP_X_FORWARDED_PROTO", "http,xyz")
56+ , ("HTTP_X_FORWARDED_PROTO", "http,xyz")
27− ]
57+ ]
28− }
58+ }
29−
59+
30− it "returns False for an insecure request" $
60+ it "returns False for an insecure request" $
31− insecureRequest `shouldSatisfy` not . appearsSecure
61+ insecureRequest `shouldSatisfy` not . appearsSecure
32−
62+
33− it "checks if the Request is actually secure" $ do
63+ it "checks if the Request is actually secure" $ do
34− let req = insecureRequest { isSecure = True }
64+ let req = insecureRequest { isSecure = True }
35−
65+
36− req `shouldSatisfy` appearsSecure
66+ req `shouldSatisfy` appearsSecure
37−
67+
38− it "checks for HTTP: on" $ do
68+ it "checks for HTTP: on" $ do
39− let req = addHeader "HTTPS" "on" insecureRequest
69+ let req = addHeader "HTTPS" "on" insecureRequest
40−
70+
41− req `shouldSatisfy` appearsSecure
71+ req `shouldSatisfy` appearsSecure
42−
72+
43− it "checks for HTTP_X_FORWARDED_SSL: on" $ do
73+ it "checks for HTTP_X_FORWARDED_SSL: on" $ do
44− let req = addHeader "HTTP_X_FORWARDED_SSL" "on" insecureRequest
74+ let req = addHeader "HTTP_X_FORWARDED_SSL" "on" insecureRequest
45−
75+
46− req `shouldSatisfy` appearsSecure
76+ req `shouldSatisfy` appearsSecure
47−
77+
48− it "checks for HTTP_X_FORWARDED_SCHEME: https" $ do
78+ it "checks for HTTP_X_FORWARDED_SCHEME: https" $ do
49− let req = addHeader "HTTP_X_FORWARDED_SCHEME" "https" insecureRequest
79+ let req = addHeader "HTTP_X_FORWARDED_SCHEME" "https" insecureRequest
50−
80+
51− req `shouldSatisfy` appearsSecure
81+ req `shouldSatisfy` appearsSecure
52−
82+
53− it "checks for HTTP_X_FORWARDED_PROTO: https,..." $ do
83+ it "checks for HTTP_X_FORWARDED_PROTO: https,..." $ do
54− let req = addHeader "HTTP_X_FORWARDED_PROTO" "https,xyz" insecureRequest
84+ let req = addHeader "HTTP_X_FORWARDED_PROTO" "https,xyz" insecureRequest
55−
85+
56− req `shouldSatisfy` appearsSecure
86+ req `shouldSatisfy` appearsSecure
57
87
58addHeader :: HeaderName -> ByteString -> Request -> Request
88addHeader :: HeaderName -> ByteString -> Request -> Request
59addHeader name value req = req
89addHeader name value req = req
wai-extra/test/Network/Wai/TestSpec.hs+46−12
@@ -3,6 +3,8 @@ module Network.Wai.TestSpec (main, spec) where
3
3
4import Control.Monad (void)
4import Control.Monad (void)
5
5
6+import qualified Data.IORef as IORef
7+
6import qualified Data.Text.Encoding as TE
8import qualified Data.Text.Encoding as TE
7
9
8import Data.Time.Calendar (fromGregorian)
10import Data.Time.Calendar (fromGregorian)
@@ -16,13 +18,17 @@ import Network.Wai.Test
16import Network.HTTP.Types (status200)
18import Network.HTTP.Types (status200)
17
19
18import qualified Data.ByteString.Lazy.Char8 as L8
20import qualified Data.ByteString.Lazy.Char8 as L8
19−import Blaze.ByteString.Builder (toByteString)
21+import Data.ByteString.Builder (Builder, toLazyByteString)
22+import Data.ByteString (ByteString)
20
23
21import qualified Web.Cookie as Cookie
24import qualified Web.Cookie as Cookie
22
25
23main :: IO ()
26main :: IO ()
24main = hspec spec
27main = hspec spec
25
28
29+toByteString :: Builder -> ByteString
30+toByteString = L8.toStrict . toLazyByteString
31+
26spec :: Spec
32spec :: Spec
27spec = do
33spec = do
28 describe "setPath" $ do
34 describe "setPath" $ do
@@ -49,25 +55,53 @@ spec = do
49 it "sets rawQueryString to empty string" $ do
55 it "sets rawQueryString to empty string" $ do
50 rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
56 rawQueryString (setPath defaultRequest "/foo/bar/baz") `shouldBe` ""
51
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+
52 describe "request" $ do
74 describe "request" $ do
53
75
54− let simpleApp _req respond =
76+ let echoApp req respond = do
77+ reqBody <- L8.fromStrict <$> getRequestBodyChunk req
78+ let reqHeaders = requestHeaders req
55 respond $
79 respond $
56 responseLBS
80 responseLBS
57 status200
81 status200
58− [("foo", "bar")]
82+ reqHeaders
59− "simple"
83+ reqBody
60
84
61− it "returns the status code of a simple app on default request" $ do
85+ it "returns the status code of an echo app on default request" $ do
62− sresp <- runSession (request defaultRequest) simpleApp
86+ sresp <- runSession (request defaultRequest) echoApp
63 simpleStatus sresp `shouldBe` status200
87 simpleStatus sresp `shouldBe` status200
64
88
65− it "returns the response body of a simple app on default request" $ do
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 $
66− sresp <- runSession (request defaultRequest) simpleApp
94+ defaultRequest
95+ { requestBody = getBodyChunk
96+ }
67− simpleBody sresp `shouldBe` "simple"
97+ simpleBody sresp `shouldBe` "request body"
68−
98+
69− it "returns the response headers of a simple app on default request" $ do
99+ it "returns the response headers of an echo app" $ do
100+ sresp <- flip runSession echoApp $
101+ request $
70− sresp <- runSession (request defaultRequest) simpleApp
102+ defaultRequest
103+ { requestHeaders = [("foo", "bar")]
104+ }
71 simpleHeaders sresp `shouldBe` [("foo", "bar")]
105 simpleHeaders sresp `shouldBe` [("foo", "bar")]
72
106
73 let cookieApp req respond =
107 let cookieApp req respond =
wai-extra/wai-extra.cabal+37−13
@@ -1,5 +1,5 @@
1Name: wai-extra
1Name: wai-extra
2−Version: 3.0.14.1
2+Version: 3.0.29.1
3Synopsis: Provides some basic WAI handlers and middleware.
3Synopsis: Provides some basic WAI handlers and middleware.
4description:
4description:
5 Provides basic WAI handler and middleware functionality:
5 Provides basic WAI handler and middleware functionality:
@@ -71,7 +71,7 @@ Maintainer: michael@snoyman.com
71Homepage: http://github.com/yesodweb/wai
71Homepage: http://github.com/yesodweb/wai
72Category: Web
72Category: Web
73Build-Type: Simple
73Build-Type: Simple
74−Cabal-Version: >=1.8
74+Cabal-Version: >=1.10
75Stability: Stable
75Stability: Stable
76extra-source-files:
76extra-source-files:
77 test/requests/dalvik-request
77 test/requests/dalvik-request
@@ -81,45 +81,48 @@ extra-source-files:
81 ChangeLog.md
81 ChangeLog.md
82 README.md
82 README.md
83
83
84+flag build-example
85+ description: Build example executable.
86+ manual: True
87+ default: False
88+
84Library
89Library
85− Build-Depends: base >= 4 && < 5
90+ Build-Depends: base >= 4.8 && < 5
86− , bytestring >= 0.9.1.4
91+ , bytestring >= 0.10.4
87 , wai >= 3.0.3.0 && < 3.3
92 , wai >= 3.0.3.0 && < 3.3
88 , old-locale >= 1.0.0.2 && < 1.1
93 , old-locale >= 1.0.0.2 && < 1.1
89 , time >= 1.1.4
94 , time >= 1.1.4
90 , network >= 2.6.1.0
95 , network >= 2.6.1.0
91 , directory >= 1.0.1
96 , directory >= 1.0.1
92 , transformers >= 0.2.2
97 , transformers >= 0.2.2
93− , blaze-builder >= 0.2.1.4 && < 0.5
94 , http-types >= 0.7
98 , http-types >= 0.7
95 , text >= 0.7
99 , text >= 0.7
96 , case-insensitive >= 0.2
100 , case-insensitive >= 0.2
97 , data-default-class
101 , data-default-class
98− , fast-logger >= 2.1 && < 2.5
102+ , fast-logger >= 2.4.5
99− , wai-logger >= 2.0 && < 2.3
103+ , wai-logger >= 2.3.2
100 , ansi-terminal
104 , ansi-terminal
101− , resourcet >= 0.4.6 && < 1.2
105+ , resourcet >= 0.4.6 && < 1.3
102 , void >= 0.5
106 , void >= 0.5
103− , stringsearch >= 0.3 && < 0.4
104 , containers
107 , containers
105 , base64-bytestring
108 , base64-bytestring
106 , word8
109 , word8
107− , lifted-base >= 0.1.2
108 , deepseq
110 , deepseq
109− , streaming-commons
111+ , streaming-commons >= 0.2
110 , unix-compat
112 , unix-compat
111 , cookie
113 , cookie
112 , vault
114 , vault
113 , zlib
115 , zlib
114 , aeson
116 , aeson
115 , iproute
117 , iproute
118+ , http2
116
119
117 if os(windows)
120 if os(windows)
118 cpp-options: -DWINDOWS
121 cpp-options: -DWINDOWS
119 else
122 else
120 build-depends: unix
123 build-depends: unix
121
124
122− extensions: OverloadedStrings
125+ default-extensions: OverloadedStrings
123
126
124 Exposed-modules: Network.Wai.Handler.CGI
127 Exposed-modules: Network.Wai.Handler.CGI
125 Network.Wai.Handler.SCGI
128 Network.Wai.Handler.SCGI
@@ -144,15 +147,34 @@ Library
144 Network.Wai.Middleware.ForceDomain
147 Network.Wai.Middleware.ForceDomain
145 Network.Wai.Middleware.ForceSSL
148 Network.Wai.Middleware.ForceSSL
146 Network.Wai.Middleware.Routed
149 Network.Wai.Middleware.Routed
150+ Network.Wai.Middleware.Timeout
147 Network.Wai.Parse
151 Network.Wai.Parse
148 Network.Wai.Request
152 Network.Wai.Request
149 Network.Wai.UrlMap
153 Network.Wai.UrlMap
150 Network.Wai.Test
154 Network.Wai.Test
155+ Network.Wai.Test.Internal
151 Network.Wai.EventSource
156 Network.Wai.EventSource
152 Network.Wai.EventSource.EventStream
157 Network.Wai.EventSource.EventStream
153 other-modules: Network.Wai.Middleware.RequestLogger.Internal
158 other-modules: Network.Wai.Middleware.RequestLogger.Internal
159+ default-language: Haskell2010
154 ghc-options: -Wall
160 ghc-options: -Wall
155
161
162+executable example
163+ hs-source-dirs: example
164+ main-is: Main.hs
165+ ghc-options: -threaded -rtsopts -with-rtsopts=-N -Wall
166+ if flag(build-example)
167+ build-depends: base
168+ , wai-extra
169+ , warp
170+ , wai
171+ , time
172+ , http-types
173+ , bytestring
174+ else
175+ buildable: False
176+ default-language: Haskell2010
177+
156test-suite spec
178test-suite spec
157 type: exitcode-stdio-1.0
179 type: exitcode-stdio-1.0
158 hs-source-dirs: test
180 hs-source-dirs: test
@@ -164,6 +186,7 @@ test-suite spec
164 Network.Wai.Middleware.ForceSSLSpec
186 Network.Wai.Middleware.ForceSSLSpec
165 Network.Wai.Middleware.RoutedSpec
187 Network.Wai.Middleware.RoutedSpec
166 Network.Wai.Middleware.StripHeadersSpec
188 Network.Wai.Middleware.StripHeadersSpec
189+ Network.Wai.Middleware.TimeoutSpec
167 WaiExtraSpec
190 WaiExtraSpec
168 build-depends: base >= 4 && < 5
191 build-depends: base >= 4 && < 5
169 , wai-extra
192 , wai-extra
@@ -177,11 +200,12 @@ test-suite spec
177 , resourcet
200 , resourcet
178 , bytestring
201 , bytestring
179 , HUnit
202 , HUnit
180− , blaze-builder
181 , cookie
203 , cookie
182 , time
204 , time
183 , case-insensitive
205 , case-insensitive
206+ , http2
184 ghc-options: -Wall
207 ghc-options: -Wall
208+ default-language: Haskell2010
185
209
186source-repository head
210source-repository head
187 type: git
211 type: git
wai-frontend-monadcgi/ChangeLog.md+4
@@ -1,3 +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+
1## 3.0.0.2
5## 3.0.0.2
2
6
3* Support for wai 3.2
7* Support for wai 3.2
wai-frontend-monadcgi/Network/Wai/Frontend/MonadCGI.hs+4−1
@@ -64,5 +64,8 @@ getCgiVars :: Request -> [(String, String)]
64getCgiVars e =
64getCgiVars e =
65 [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
65 [ ("PATH_INFO", S8.unpack $ rawPathInfo e)
66 , ("REQUEST_METHOD", show $ requestMethod e)
66 , ("REQUEST_METHOD", show $ requestMethod e)
67+ , ("QUERY_STRING",
67− , ("QUERY_STRING", S8.unpack $ rawQueryString e)
68+ case S8.unpack $ rawQueryString e of
69+ '?':rest -> rest
70+ x -> x)
68 ]
71 ]
wai-frontend-monadcgi/wai-frontend-monadcgi.cabal+1−1
@@ -1,5 +1,5 @@
1name: wai-frontend-monadcgi
1name: wai-frontend-monadcgi
2−version: 3.0.0.2
2+version: 3.0.0.3
3license: MIT
3license: MIT
4license-file: LICENSE
4license-file: LICENSE
5author: Michael Snoyman <michael@snoyman.com>
5author: Michael Snoyman <michael@snoyman.com>
wai-handler-fastcgi/.gitignoredeleted−4
@@ -1,4 +0,0 @@
1−/dist/
2−*.swp
3−*.hi
4−*.o
wai-handler-fastcgi/ChangeLog.mddeleted−3
@@ -1,3 +0,0 @@
1−## 3.0.0.2
2−
3−* Support wai 3.2
wai-handler-fastcgi/Network/Wai/Handler/FastCGI.hscdeleted−192
@@ -1,192 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−{-# LANGUAGE EmptyDataDecls #-}
3−{-# LANGUAGE CPP #-}
4−-----------------------------------------------------------------------------
5−-- |
6−-- Module : Network.Wai.Handler.FastCGI
7−-- Copyright : (c) Bjorn Bringert 2004-2005, (c) Lemmih 2006, (c) Michael Snoyman 2010
8−-- License : BSD-style (see the file libraries/network/LICENSE)
9−--
10−-- Maintainer : michael@snoyman.com
11−-- Stability : experimental
12−-- Portability : non-portable (uses FFI)
13−--
14−-- Interface for FastCGI <http://fastcgi.com/>, using the fcgiapp API.
15−-- Totally ripped off by Michael Snoyman to work with Hack, then WAI.
16−--
17−-----------------------------------------------------------------------------
18−module Network.Wai.Handler.FastCGI
19− ( run
20− , runSendfile
21− , runFork
22− ) where
23−
24−import Control.Monad ( liftM, forever )
25−import Data.Word (Word8)
26−import Foreign ( Ptr, castPtr, nullPtr, peekArray0
27− , throwIfNeg_, mallocBytes, free )
28−#ifdef GHC_7_4
29−import Foreign.C (CInt(..), CString, CStringLen)
30−#else
31−import Foreign.C (CInt, CString, CStringLen)
32−#endif
33−import Control.Exception (finally)
34−import Foreign.Storable ( Storable (..) )
35−
36−import qualified Network.Wai as W
37−import qualified Network.Wai.Handler.CGI as CGI
38−
39−import qualified Data.ByteString as S
40−import qualified Data.ByteString.Char8 as S8
41−import qualified Data.ByteString as BS
42−import qualified Data.ByteString.Internal as BSB
43−import qualified Data.ByteString.Unsafe as BSB
44−
45−import Control.Arrow ((***))
46−
47−#include <fcgiapp.h>
48−
49−------------------------------------------------------------------------
50−
51−data FCGX_Stream
52−type StreamPtr = Ptr FCGX_Stream
53−type Environ = Ptr CString
54−
55−------------------------------------------------------------------------
56−
57−foreign import ccall unsafe "fcgiapp.h FCGX_GetStr" fcgx_getStr
58− :: CString -> CInt -> StreamPtr -> IO CInt
59−
60−foreign import ccall unsafe "fcgiapp.h FCGX_PutStr" fcgx_putStr
61− :: CString -> CInt -> StreamPtr -> IO CInt
62−
63−
64−------------------------------------------------------------------------
65−
66−foreign import ccall unsafe "fcgiapp.h FCGX_Init" fcgx_init
67− :: IO CInt
68−
69−runFork :: Maybe S.ByteString -> (IO () -> IO a) -> Int -> W.Application -> IO ()
70−runFork sf fork threads app = do
71− testReturn "FCGX_Init" $ fcgx_init
72− let oneThread = forever $ oneRequest app sf
73− mapM_ fork $ replicate (threads - 1) oneThread
74− oneThread
75−
76−-- | Handle FastCGI requests in an infinite loop.
77−run :: W.Application -> IO ()
78−run = runFork Nothing id 1
79−
80−-- | Handle FastCGI requests in an infinite loop. For a server which supports
81−-- the X-Sendfile header.
82−runSendfile :: S.ByteString -> W.Application -> IO ()
83−runSendfile sf = runFork (Just sf) id 1
84−
85−oneRequest :: W.Application
86− -> Maybe S.ByteString -- X-Sendfile
87− -> IO ()
88−oneRequest app xsendfile = withRequest $ \r -> do
89− putStrLn "Received 1 request"
90− env <- peekEnvp r
91− ins <- peekIn r
92− outs <- peekOut r
93− handleRequest app ins outs env xsendfile
94−
95−peekIn, peekOut :: Ptr FCGX_Request -> IO (Ptr FCGX_Stream)
96−peekIn = (#peek FCGX_Request, in)
97−peekOut = (#peek FCGX_Request, out)
98−
99−peekEnvp :: Ptr FCGX_Request -> IO Environ
100−peekEnvp = (#peek FCGX_Request, envp)
101−
102−foreign import ccall unsafe "fcgiapp.h FCGX_InitRequest" fcgx_initrequest
103− :: Ptr FCGX_Request -> CInt -> CInt -> IO CInt
104−
105−foreign import ccall safe "fcgiapp.h FCGX_Accept_r" fcgx_accept_r
106− :: Ptr FCGX_Request -> IO CInt
107−
108−acceptRequest :: IO (Ptr FCGX_Request)
109−acceptRequest = do
110− reqp <- mallocBytes (#size FCGX_Request)
111− initAndAccept reqp
112− return reqp
113− where initAndAccept reqp = do
114− testReturn "FCGX_InitRequest" $ fcgx_initrequest reqp 0 0
115− testReturn "FCGX_Accept_r" $ fcgx_accept_r reqp
116−
117−withRequest :: (Ptr FCGX_Request -> IO ()) -> IO ()
118−withRequest f = do
119− req <- acceptRequest
120− f req `finally` finishRequest req
121−
122−foreign import ccall unsafe "fcgiapp.h FCGX_Finish_r" fcgx_finish_r
123− :: Ptr FCGX_Request -> IO ()
124−
125−finishRequest :: Ptr FCGX_Request -> IO ()
126−finishRequest reqp = do
127− fcgx_finish_r reqp
128− free reqp
129−
130−handleRequest :: W.Application
131− -> StreamPtr
132− -> StreamPtr
133− -> Environ
134− -> Maybe S.ByteString -- sendfile
135− -> IO ()
136−handleRequest f ins outs env xsendfile = do
137− vars <- environToTable env
138− let vars' = map (S8.unpack *** S8.unpack) vars
139− let input = const $ sRead ins
140− let hPut = sPutStr' outs
141− CGI.runGeneric vars' (CGI.requestBodyFunc input) hPut xsendfile f
142−
143−data FCGX_Request
144−
145−--
146−-- * Stream IO
147−--
148−
149−sPutStr' :: StreamPtr -> BS.ByteString -> IO ()
150−sPutStr' h str =
151− BSB.unsafeUseAsCStringLen str $ fcgxPutCStringLen h
152−
153−fcgxPutCStringLen :: StreamPtr -> CStringLen -> IO ()
154−fcgxPutCStringLen h (cs,len) =
155− testReturn "FCGX_PutStr" $ fcgx_putStr cs (fromIntegral len) h
156−
157−sRead :: StreamPtr -> IO (Maybe BS.ByteString)
158−sRead h = buildByteString (fcgxGetBuf h) 4096
159−
160−fcgxGetBuf :: StreamPtr -> Ptr a -> Int -> IO Int
161−fcgxGetBuf h p c =
162− liftM fromIntegral $ fcgx_getStr (castPtr p) (fromIntegral c) h
163−
164−--
165−-- * ByteString utilities
166−--
167−
168−-- | Data.ByteString.Lazy.hGetContentsN generalized to arbitrary
169−-- reading functions.
170−buildByteString :: (Ptr Word8 -> Int -> IO Int) -> Int -> IO (Maybe BS.ByteString)
171−buildByteString f k = do
172− ps <- BSB.createAndTrim k $ \p -> f p k
173− case BS.length ps of
174− 0 -> return Nothing
175− _ -> return $ Just ps
176−
177−--
178−-- * Utilities
179−--
180−
181−testReturn :: String -> IO CInt -> IO ()
182−testReturn e = throwIfNeg_ (\n -> e ++ " failed with error code: "++ show n)
183−
184−environToTable :: Environ -> IO [(S.ByteString, S.ByteString)]
185−environToTable arr = do
186− css <- peekArray0 nullPtr arr
187− ss <- mapM S.packCString css
188− return $ map splitEq ss
189− where
190− splitEq s =
191− let (a, b) = S.breakByte 61 s
192− in (a, S.drop 1 b)
wai-handler-fastcgi/READMEdeleted

No changes to the content.

wai-handler-fastcgi/README.mddeleted−3
@@ -1,3 +0,0 @@
1−## wai-handler-fastcgi
2−
3−Calls out to the libfcgi C library.
wai-handler-fastcgi/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-fastcgi/configuredeleted−9
@@ -1,9 +0,0 @@
1−#!/bin/sh
2−#
3−
4−# subst standard header path variables
5−if test -n "$CPPFLAGS" ; then
6− echo "Found CPPFLAGS in environment: '$CPPFLAGS'"
7− sed 's,@CPPFLAGS@,'"$CPPFLAGS"',g;s,@LDFLAGS@,'"$LDFLAGS"',g' \
8− < fastcgi.buildinfo.in > fastcgi.buildinfo
9−fi
wai-handler-fastcgi/fastcgi.buildinfo.indeleted−3
@@ -1,3 +0,0 @@
1−ghc-options: -optc@CPPFLAGS@
2−cc-options: @CPPFLAGS@
3−ld-options: @LDFLAGS@
wai-handler-fastcgi/lighttpd.confdeleted−19
@@ -1,19 +0,0 @@
1−# Run with lighttpd -D -f lighttpd.conf
2−server.port = 3000
3−server.document-root = "."
4−server.modules = ("mod_fastcgi", "mod_rewrite")
5−
6−url.rewrite-once = (
7− "(.*)" => "/app/$1"
8−)
9−
10−fastcgi.server = (
11− "/app" => ((
12− "socket" => "/tmp/test.fastcgi.socket",
13− "check-local" => "disable",
14− "bin-path" => "./test",
15− "min-procs" => 1,
16− "max-procs" => 12,
17− "idle-timeout" => 30
18− ))
19−)
wai-handler-fastcgi/test.hsdeleted−19
@@ -1,19 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.FastCGI
4−import Control.Monad.IO.Class
5−import qualified Data.ByteString.Lazy as L
6−import qualified Data.ByteString.Lazy.Char8 as L8
7−import qualified Data.Enumerator as E
8−
9−main = run app
10−
11−app req
12− | pathInfo req == "/" = return $ responseLBS status200 [("Content-Type", "text/html")] "<form method='post' action='/post'><input type='text' name='name'><input type='submit'></form>"
13−app req = do
14− bss <- E.consume
15− return $ responseLBS status200 [("Content-Type", "text/plain")] $ L.concat
16− [ L8.pack $ show $ requestHeaders req
17− , "\n"
18− , L.fromChunks bss
19− ]
wai-handler-fastcgi/wai-handler-fastcgi.cabaldeleted−31
@@ -1,31 +0,0 @@
1−name: wai-handler-fastcgi
2−version: 3.0.0.2
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Wai handler to fastcgi
8−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-fastcgi>.
9−category: Web
10−stability: stable
11−cabal-version: >= 1.6
12−build-type: Configure
13−extra-source-files: configure fastcgi.buildinfo.in README.md ChangeLog.md
14−homepage: http://www.yesodweb.com/book/web-application-interface
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 3.0 && < 3.3
19− , wai-extra >= 3.0 && < 3.1
20− , bytestring >= 0.9.1.4
21− exposed-modules: Network.Wai.Handler.FastCGI
22− ghc-options: -Wall
23− includes: fcgiapp.h
24− extra-libraries: fcgi
25−
26− if impl(ghc >= 7.4)
27− cpp-options: -DGHC_7_4
28−
29−source-repository head
30− type: git
31− location: git://github.com/yesodweb/wai.git
wai-handler-launch/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−dist/
2−*.swp
wai-handler-launch/ChangeLog.mddeleted−11
@@ -1,11 +0,0 @@
1−## 3.0.0.5
2−
3−* Support wai/warp 3.2
4−
5−## 3.0.0.3
6−
7−Allow blaze-builder 0.4
8−
9−## 3.0.0.2
10−
11−* Support for Win64
wai-handler-launch/LICENSEdeleted−20
@@ -1,20 +0,0 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
2−
3−Permission is hereby granted, free of charge, to any person obtaining
4−a copy of this software and associated documentation files (the
5−"Software"), to deal in the Software without restriction, including
6−without limitation the rights to use, copy, modify, merge, publish,
7−distribute, sublicense, and/or sell copies of the Software, and to
8−permit persons to whom the Software is furnished to do so, subject to
9−the following conditions:
10−
11−The above copyright notice and this permission notice shall be
12−included in all copies or substantial portions of the Software.
13−
14−THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15−EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16−MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17−NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18−LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19−OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20−WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
wai-handler-launch/Network/Wai/Handler/Launch.hsdeleted−206
@@ -1,206 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE ForeignFunctionInterface #-}
3−{-# LANGUAGE CPP #-}
4−module Network.Wai.Handler.Launch
5− ( run
6− , runUrl
7− , runUrlPort
8− ) where
9−
10−import Network.Wai
11−import Network.Wai.Internal
12−import Network.HTTP.Types
13−import qualified Network.Wai.Handler.Warp as Warp
14−import Data.IORef
15−import Data.Monoid (mappend)
16−import Control.Concurrent (forkIO, threadDelay)
17−import Control.Monad.IO.Class (liftIO)
18−import Control.Monad (unless)
19−import Control.Exception (throwIO)
20−import Data.Function (fix)
21−import qualified Data.ByteString as S
22−import Blaze.ByteString.Builder (fromByteString, Builder, flush)
23−import qualified Blaze.ByteString.Builder as Blaze
24−#if WINDOWS
25−import Foreign
26−import Foreign.C.String
27−#else
28−import System.Process (rawSystem)
29−#endif
30−import Data.Streaming.Blaze (newBlazeRecv, defaultStrategy)
31−import qualified Data.Streaming.Zlib as Z
32−
33−ping :: IORef Bool -> Middleware
34−ping var app req sendResponse
35− | pathInfo req == ["_ping"] = do
36− liftIO $ writeIORef var True
37− sendResponse $ responseLBS status200 [] ""
38− | otherwise = app req $ \res -> do
39− let isHtml hs =
40− case lookup "content-type" hs of
41− Just ct -> "text/html" `S.isPrefixOf` ct
42− Nothing -> False
43− if isHtml $ responseHeaders res
44− then do
45− let (s, hs, withBody) = responseToStream res
46− (isEnc, headers') = fixHeaders id hs
47− headers'' = filter (\(x, _) -> x /= "content-length") headers'
48− withBody $ \body ->
49− sendResponse $ responseStream s headers'' $ \sendChunk flush ->
50− addInsideHead sendChunk flush $ \sendChunk' flush' ->
51− if isEnc
52− then decode sendChunk' flush' body
53− else body sendChunk' flush'
54− else sendResponse res
55−
56−decode :: (Builder -> IO ()) -> IO ()
57− -> StreamingBody
58− -> IO ()
59−decode sendInner flushInner streamingBody = do
60− (blazeRecv, blazeFinish) <- newBlazeRecv defaultStrategy
61− inflate <- Z.initInflate $ Z.WindowBits 31
62− let send builder = blazeRecv builder >>= goBuilderPopper
63− goBuilderPopper popper = fix $ \loop -> do
64− bs <- popper
65− unless (S.null bs) $ do
66− Z.feedInflate inflate bs >>= goZlibPopper
67− loop
68− goZlibPopper popper = fix $ \loop -> do
69− res <- popper
70− case res of
71− Z.PRDone -> return ()
72− Z.PRNext bs -> do
73− sendInner $ fromByteString bs
74− loop
75− Z.PRError e -> throwIO e
76− streamingBody send (send flush)
77− mbs <- blazeFinish
78− case mbs of
79− Nothing -> return ()
80− Just bs -> Z.feedInflate inflate bs >>= goZlibPopper
81− Z.finishInflate inflate >>= sendInner . fromByteString
82−
83−toInsert :: S.ByteString
84−toInsert = "<script>setInterval(function(){var x;if(window.XMLHttpRequest){x=new XMLHttpRequest();}else{x=new ActiveXObject(\"Microsoft.XMLHTTP\");}x.open(\"GET\",\"/_ping\",false);x.send();},60000)</script>"
85−
86−addInsideHead :: (Builder -> IO ())
87− -> IO ()
88− -> StreamingBody
89− -> IO ()
90−addInsideHead sendInner flushInner streamingBody = do
91− (blazeRecv, blazeFinish) <- newBlazeRecv defaultStrategy
92− ref <- newIORef $ Just (S.empty, whole)
93− streamingBody (inner blazeRecv ref) (flush blazeRecv ref)
94− state <- readIORef ref
95− mbs <- blazeFinish
96− held <- case mbs of
97− Nothing -> return state
98− Just bs -> push state bs
99− case state of
100− Nothing -> return ()
101− Just (held, _) -> sendInner $ fromByteString held `mappend` fromByteString toInsert
102− where
103− whole = "<head>"
104−
105− flush blazeRecv ref = inner blazeRecv ref Blaze.flush
106−
107− inner blazeRecv ref builder = do
108− state0 <- readIORef ref
109− popper <- blazeRecv builder
110− let loop state = do
111− bs <- popper
112− if S.null bs
113− then writeIORef ref state
114− else push state bs >>= loop
115− loop state0
116−
117− push Nothing x = sendInner (fromByteString x) >> return Nothing
118− push (Just (held, atFront)) x
119− | atFront `S.isPrefixOf` x = do
120− let y = S.drop (S.length atFront) x
121− sendInner $ fromByteString held
122− `mappend` fromByteString atFront
123− `mappend` fromByteString toInsert
124− `mappend` fromByteString y
125− return Nothing
126− | whole `S.isInfixOf` x = do
127− let (before, rest) = S.breakSubstring whole x
128− let after = S.drop (S.length whole) rest
129− sendInner $ fromByteString held
130− `mappend` fromByteString before
131− `mappend` fromByteString whole
132− `mappend` fromByteString toInsert
133− `mappend` fromByteString after
134− return Nothing
135− | x `S.isPrefixOf` atFront = do
136− let held' = held `S.append` x
137− atFront' = S.drop (S.length x) atFront
138− return $ Just (held', atFront')
139− | otherwise = do
140− let (held', atFront', x') = getOverlap whole x
141− sendInner $ fromByteString held `mappend` fromByteString x'
142− return $ Just (held', atFront')
143−
144−getOverlap :: S.ByteString -> S.ByteString -> (S.ByteString, S.ByteString, S.ByteString)
145−getOverlap whole x =
146− go whole
147− where
148− go piece
149− | S.null piece = ("", whole, x)
150− | piece `S.isSuffixOf` x =
151− let x' = S.take (S.length x - S.length piece) x
152− atFront = S.drop (S.length piece) whole
153− in (piece, atFront, x')
154− | otherwise = go $ S.init piece
155−
156−fixHeaders :: ([Header] -> [Header])
157− -> [Header]
158− -> (Bool, [Header])
159−fixHeaders front [] = (False, front [])
160−fixHeaders front (("content-encoding", "gzip"):rest) = (True, front rest)
161−fixHeaders front (x:xs) = fixHeaders (front . (:) x) xs
162−
163−#if WINDOWS
164−foreign import ccall "launch"
165− launch' :: Int -> CString -> IO ()
166−#endif
167−
168−launch :: Int -> String -> IO ()
169−
170−#if WINDOWS
171−launch port s = withCString s $ launch' port
172−#else
173−launch port s = forkIO (rawSystem
174−#if MAC
175− "open"
176−#else
177− "xdg-open"
178−#endif
179− ["http://127.0.0.1:" ++ show port ++ "/" ++ s] >> return ()) >> return ()
180−#endif
181−
182−run :: Application -> IO ()
183−run = runUrl ""
184−
185−runUrl :: String -> Application -> IO ()
186−runUrl = runUrlPort 4587
187−
188−runUrlPort :: Int -> String -> Application -> IO ()
189−runUrlPort port url app = do
190− x <- newIORef True
191− _ <- forkIO $ Warp.runSettings
192− ( Warp.setPort port
193− $ Warp.setOnException (\_ _ -> return ())
194− $ Warp.setHost "*4" Warp.defaultSettings)
195− $ ping x app
196− launch port url
197− loop x
198−
199−loop :: IORef Bool -> IO ()
200−loop x = do
201− let seconds = 120
202− threadDelay $ 1000000 * seconds
203− b <- readIORef x
204− if b
205− then writeIORef x False >> loop x
206− else return ()
wai-handler-launch/READMEdeleted

No changes to the content.

wai-handler-launch/README.mddeleted−4
@@ -1,4 +0,0 @@
1−## wai-handler-launch
2−
3−This handles cross-platform launching and inserts Javascript code to ping the
4−server. When the server no longer receives pings, it shuts down.
wai-handler-launch/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-launch/runtests.hsdeleted−22
@@ -1,22 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai.Handler.Launch (insideHead)
3−import Test.Hspec
4−import Test.Hspec.HUnit
5−import Data.Enumerator hiding (map)
6−import Test.HUnit
7−import qualified Data.ByteString as S
8−
9−main :: IO ()
10−main = hspec $ describe "insideHead"
11− [ it "handles single chunks" $ helper "bar<head>foobaz" ["bar<head>baz"]
12− , it "handles single chunks, no <head>" $ helper "barfoo" ["bar"]
13− , it "handles whole chunks" $ helper "bar<head>foobaz" ["bar", "<head>", "baz"]
14− , it "handles split chunks" $ helper "bar<head>foobaz" ["bar", "<he", "ad>", "baz"]
15− , it "handles many chunks" $ helper "bar<head>foobaz1234567890" ["bar", "<he", "ad>", "baz", "1", "2", "3", "4", "5", "6", "7", "8", "9", "0"]
16− , it "handles many pieces" $ helper "bar<head>foobaz" $ map S.singleton $ S.unpack "bar<head>baz"
17− ]
18−
19−helper :: S.ByteString -> [S.ByteString] -> Assertion
20−helper res pieces = do
21− x <- run_ $ enumList 1 pieces $$ joinI $ insideHead "foo" $$ consume
22− S.concat x @?= res
wai-handler-launch/test.hsdeleted−7
@@ -1,7 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.HTTP.Types
4−import Network.Wai.Handler.Launch
5−import Network.Wai.Middleware.Gzip
6−
7−main = runUrl "FIXME" $ gzip def $ \_ f -> f $ responseLBS status200 [("Content-Type", "text/html; charset=utf8")] "<html><head></head><body>HELLO THERE"
wai-handler-launch/wai-handler-launch.cabaldeleted−36
@@ -1,36 +0,0 @@
1−Name: wai-handler-launch
2−Version: 3.0.0.5
3−Synopsis: Launch a web app in the default browser.
4−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-launch>.
5−License: MIT
6−License-file: LICENSE
7−Author: Michael Snoyman
8−Maintainer: michael@snoyman.com
9−Category: Web
10−Build-type: Simple
11−Cabal-version: >=1.6
12−extra-source-files: README.md ChangeLog.md
13−
14−Library
15− Exposed-modules: Network.Wai.Handler.Launch
16− build-depends: base >= 4 && < 5
17− , wai >= 3.0 && < 3.3
18− , warp >= 3.0 && < 3.3
19− , http-types >= 0.7
20− , transformers >= 0.2.2
21− , bytestring >= 0.9.1.4
22− , blaze-builder >= 0.2.1.4 && < 0.5
23− , streaming-commons
24−
25− if os(windows)
26− c-sources: windows.c
27− cpp-options: -DWINDOWS
28− extra-libraries: Shell32 msvcrt
29− else
30− build-depends: process >= 1.0 && < 1.3
31− if os(darwin)
32− cpp-options: -DMAC
33−
34−source-repository head
35− type: git
36− location: git://github.com/yesodweb/wai.git
wai-handler-launch/windows.cdeleted−12
@@ -1,12 +0,0 @@
1−#include <windows.h>
2−#include <shellapi.h>
3−#include <stdio.h>
4−
5−void launch(int port, char *s)
6−{
7− int len = 8 + strlen("http://127.0.0.1:") + strlen(s);
8− char *buff = malloc(len);
9− _snprintf(buff, len, "http://127.0.0.1:%d/%s", port, s);
10− ShellExecute(NULL, "open", buff, NULL, NULL, SW_SHOWNORMAL);
11− free(buff);
12−}
wai-handler-webkit/.gitignoredeleted−2
@@ -1,2 +0,0 @@
1−dist
2−*.swp
wai-handler-webkit/ChangeLog.mddeleted−3
@@ -1,3 +0,0 @@
1−## 3.0.0.3
2−
3−* Support for wai/warp 3.2
wai-handler-webkit/Network/Wai/Handler/Webkit.hsdeleted−21
@@ -1,21 +0,0 @@
1−{-# LANGUAGE ForeignFunctionInterface #-}
2−module Network.Wai.Handler.Webkit (run) where
3−
4−import Network.Wai (Application)
5−import qualified Network.Wai.Handler.Warp as S
6−import Control.Concurrent (forkOS)
7−import Control.Concurrent.MVar
8−import Foreign.C.String (CString, withCString)
9−import Control.Exception (finally)
10−
11−run :: String -- ^ Title to show in titlebar
12− -> Application -> IO ()
13−run title app = do
14− mvar <- newEmptyMVar
15− _ <- forkOS $ finally (S.run 3000 app) (putMVar mvar ())
16− _ <- forkOS $ finally (withCString title startBrowser) (putMVar mvar ())
17− _ <- takeMVar mvar
18− return ()
19−
20−foreign import ccall "start_browser"
21− startBrowser :: CString -> IO ()
wai-handler-webkit/README.mddeleted−53
@@ -1,53 +0,0 @@
1−wai-handler-webkit
2−==================
3−
4−Turn WAI applications into standalone GUIs using Qt WebKit.
5−
6−
7−Linux
8−-----
9−
10−You'll need the appropriate system libraries, on Ubuntu:
11−
12− apt-get install libqtwebkit-dev
13−
14−On Lucid, this required adding a PPA:
15−
16− sudo add-apt-repository ppa:kubuntu-ppa/backports
17−
18−
19−Windows
20−-------
21−
22−Install the Qt SDK from <http://qt.nokia.com/downloads/>
23−
24−Your application's Cabal file will require certain options for Windows,
25−shown below. In particular, we need to link with `g++`, so make sure
26−it's in your `PATH`. The option `-optl-mwindows` ensures that the
27−application does not open a terminal.
28−
29− if os(windows)
30− ghc-options: -Wall -threaded -pgml g++ -optl-static -optl-mwindows
31− else
32− ghc-options: -Wall
33−
34−Run `cabal-install` with the Qt `include` and `lib` directories.
35−
36− export QT_PATH=c:/QtSDK/Desktop/Qt/4.7.3/mingw
37−
38− cabal-dev install \
39− --extra-include-dirs=$QT_PATH/include \
40− --extra-include-dirs=$QT_PATH/include/QtCore \
41− --extra-include-dirs=$QT_PATH/include/QtNetwork \
42− --extra-include-dirs=$QT_PATH/include/QtGui \
43− --extra-include-dirs=$QT_PATH/include/QtWebKit \
44− --extra-lib-dirs=$QT_PATH/lib
45−
46−You'll need to include these DLLs with your application:
47−
48− phonon4.dll
49− libgcc_s_dw2-1.dll
50− QtCore4.dll
51− QtGui4.dll
52− QtNetwork4.dll
53− QtWebKit4.dll
wai-handler-webkit/Setup.lhsdeleted−7
@@ -1,7 +0,0 @@
1−#!/usr/bin/env runhaskell
2−
3−> module Main where
4−> import Distribution.Simple
5−
6−> main :: IO ()
7−> main = defaultMain
wai-handler-webkit/sample.hsdeleted−10
@@ -1,10 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−import Network.Wai
3−import Network.Wai.Handler.Webkit
4−import Network.HTTP.Types
5−
6−main :: IO ()
7−main = run "Sample App" app
8−
9−app :: Application
10−app _ response = response $ responseLBS status200 [("Content-Type", "text/html")] "<h1>Hello World!</h1>"
wai-handler-webkit/wai-handler-webkit.cabaldeleted−30
@@ -1,30 +0,0 @@
1−name: wai-handler-webkit
2−version: 3.0.0.3
3−license: MIT
4−license-file: LICENSE
5−author: Michael Snoyman <michael@snoyman.com>
6−maintainer: Michael Snoyman <michael@snoyman.com>
7−synopsis: Turn WAI applications into standalone GUIs using QtWebkit.
8−description: API docs and the README are available at <http://www.stackage.org/package/wai-handler-webkit>.
9−category: Web
10−stability: unstable
11−cabal-version: >= 1.6
12−build-type: Simple
13−homepage: https://github.com/yesodweb/wai/tree/master/wai-handler-webkit
14−extra-source-files: README.md ChangeLog.md
15−
16−library
17− build-depends: base >= 4 && < 5
18− , wai >= 3.0 && < 3.3
19− , warp >= 3.0 && < 3.3
20− ghc-options: -Wall
21− exposed-modules: Network.Wai.Handler.Webkit
22− c-sources: webkit.cpp
23− if os(windows)
24− extra-libraries: QtCore4, QtGui4, QtNetwork4, QtWebKit4
25− else
26− pkgconfig-depends: QtWebKit
27−
28−source-repository head
29− type: git
30− location: git://github.com/yesodweb/wai.git
wai-handler-webkit/webkit.cppdeleted−19
@@ -1,19 +0,0 @@
1−#include <QApplication>
2−#include <QPushButton>
3−#include <QtWebKit>
4−
5−extern "C" {
6− int start_browser(char *title)
7− {
8− char *argv[1];
9− argv[0] = title;
10− int argc = 1;
11−
12− QApplication app(argc, argv);
13− QWebView *view = new QWebView();
14− view->load(QUrl("http://localhost:3000/"));
15− view->show();
16−
17− return app.exec();
18− }
19−}
wai-handler-webkit/LICENSE → wai-http2-extra/LICENSErenamed+1−1
@@ -1,4 +1,4 @@
1−Copyright (c) 2012 Michael Snoyman, http://www.yesodweb.com/
1+Copyright (c) 2016 Kazu Yamamoto, http://www.yesodweb.com/
2
2
3Permission is hereby granted, free of charge, to any person obtaining
3Permission is hereby granted, free of charge, to any person obtaining
4a copy of this software and associated documentation files (the
4a copy of this software and associated documentation files (the
wai-http2-extra/Network/Wai/Middleware/Push/Referer.hsnew file+236
@@ -0,0 +1,236 @@
1+{-# LANGUAGE BangPatterns, OverloadedStrings, RecordWildCards #-}
2+
3+-- | Middleware for server push learning dependency based on Referer:.
4+module Network.Wai.Middleware.Push.Referer (
5+ -- * Middleware
6+ pushOnReferer
7+ -- * Making push promise
8+ , URLPath
9+ , MakePushPromise
10+ , defaultMakePushPromise
11+ -- * Settings
12+ , Settings
13+ , defaultSettings
14+ , makePushPromise
15+ , duration
16+ , keyLimit
17+ , valueLimit
18+ ) where
19+
20+import Control.Monad (when, unless)
21+import Control.Reaper
22+import Data.ByteString (ByteString)
23+import qualified Data.ByteString as BS
24+import Data.ByteString.Internal (ByteString(..), memchr)
25+import Data.IORef
26+import Data.Maybe (isNothing)
27+import Data.Word (Word8)
28+import Data.Word8
29+import Foreign.ForeignPtr (withForeignPtr, ForeignPtr)
30+import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
31+import Foreign.Storable (peek)
32+import Network.HTTP.Types (Status(..))
33+import Network.Wai
34+import Network.Wai.Handler.Warp hiding (Settings, defaultSettings)
35+import Network.Wai.Internal (Response(..))
36+import System.IO.Unsafe (unsafePerformIO)
37+
38+import qualified Network.Wai.Middleware.Push.Referer.LimitMultiMap as M
39+
40+-- $setup
41+-- >>> :set -XOverloadedStrings
42+
43+-- | Making a push promise based on Referer:,
44+-- path to be pushed and file to be pushed.
45+-- If the middleware should push this file in the next time when
46+-- the page of Referer: is accessed,
47+-- this function should return 'Just'.
48+-- If 'Nothing' is returned,
49+-- the middleware learns nothing.
50+type MakePushPromise = URLPath -- ^ path in referer (key: /index.html)
51+ -> URLPath -- ^ path to be pushed (value: /style.css)
52+ -> FilePath -- ^ file to be pushed (file_path/style.css)
53+ -> IO (Maybe PushPromise)
54+
55+-- | Type for URL path.
56+type URLPath = ByteString
57+
58+type Cache = M.LimitMultiMap URLPath PushPromise
59+
60+initialized :: IORef Bool
61+initialized = unsafePerformIO $ newIORef False
62+{-# NOINLINE initialized #-}
63+
64+cacheReaper :: IORef (Maybe (Reaper Cache (URLPath,PushPromise)))
65+cacheReaper = unsafePerformIO $ newIORef Nothing
66+{-# NOINLINE cacheReaper #-}
67+
68+-- | Settings for server push based on Referer:.
69+data Settings = Settings {
70+ makePushPromise :: MakePushPromise -- ^ Default: 'defaultMakePushPromise'
71+ , duration :: Int -- ^ Duration (in micro seconds) to keep the learning information. The information completely cleared every this duration. Default: 30000000
72+ , keyLimit :: Int -- ^ Max number of keys (e.g. index.html) in the learning information. Default: 20
73+ , valueLimit :: Int -- ^ Max number of values (e.g. style.css) in the learning information. Default: 20
74+ }
75+
76+-- | Default settings.
77+defaultSettings :: Settings
78+defaultSettings = Settings {
79+ makePushPromise = defaultMakePushPromise
80+ , duration = 30000000
81+ , keyLimit = 20
82+ , valueLimit = 20
83+ }
84+
85+tryInitialize :: Settings -> IO ()
86+tryInitialize Settings{..} = do
87+ isInitialized <- atomicModifyIORef' initialized $ \x -> (True, x)
88+ unless isInitialized $ do
89+ reaper <- mkReaper settings
90+ writeIORef cacheReaper (Just reaper)
91+ where
92+ emptyCache = M.empty keyLimit valueLimit
93+ settings :: ReaperSettings Cache (URLPath,PushPromise)
94+ settings = defaultReaperSettings {
95+ reaperAction = \_ -> return (\_ -> emptyCache)
96+ , reaperCons = M.insert
97+ , reaperNull = M.isEmpty
98+ , reaperEmpty = emptyCache
99+ , reaperDelay = duration
100+ }
101+
102+-- | The middleware to push files based on Referer:.
103+-- Learning strategy is implemented in the first argument.
104+pushOnReferer :: Settings -> Middleware
105+pushOnReferer settings@Settings{..} app req sendResponse = do
106+ tryInitialize settings
107+ mreaper <- readIORef cacheReaper
108+ case mreaper of
109+ Nothing -> app req sendResponse
110+ Just reaper -> app req (push reaper)
111+ where
112+ push reaper res@(ResponseFile (Status 200 "OK") _ file Nothing) = do
113+ let !path = rawPathInfo req
114+ m <- reaperRead reaper
115+ case M.lookup path m of
116+ [] -> case requestHeaderReferer req of
117+ Nothing -> return ()
118+ Just referer -> do
119+ (mauth,refPath) <- parseUrl referer
120+ when (isNothing mauth
121+ || requestHeaderHost req == mauth) $ do
122+ when (path /= refPath) $ do -- just in case
123+ let !path' = BS.copy path
124+ !refPath' = BS.copy refPath
125+ mpp <- makePushPromise refPath' path' file
126+ case mpp of
127+ Nothing -> return ()
128+ Just pp -> reaperAdd reaper (refPath',pp)
129+ ps -> do
130+ let !h2d = defaultHTTP2Data { http2dataPushPromise = ps}
131+ setHTTP2Data req (Just h2d)
132+ sendResponse res
133+ push _ res = sendResponse res
134+
135+
136+-- | Learn if the file to be pushed is CSS (.css) or JavaScript (.js) file
137+-- AND the Referer: ends with \"/\" or \".html\" or \".htm\".
138+defaultMakePushPromise :: MakePushPromise
139+defaultMakePushPromise refPath path file
140+ | isHTML refPath = case getCT path of
141+ Nothing -> return Nothing
142+ Just ct -> do
143+ let pp = defaultPushPromise {
144+ promisedPath = path
145+ , promisedFile = file
146+ , promisedResponseHeaders = [("content-type", ct)
147+ ,("x-http2-push", refPath)]
148+ }
149+ return $ Just pp
150+ | otherwise = return Nothing
151+
152+getCT :: URLPath -> Maybe ByteString
153+getCT p
154+ | ".js" `BS.isSuffixOf` p = Just "application/javascript"
155+ | ".css" `BS.isSuffixOf` p = Just "text/css"
156+ | otherwise = Nothing
157+
158+isHTML :: URLPath -> Bool
159+isHTML p = ("/" `BS.isSuffixOf` p)
160+ || (".html" `BS.isSuffixOf` p)
161+ || (".htm" `BS.isSuffixOf` p)
162+
163+-- |
164+--
165+-- >>> parseUrl ""
166+-- (Nothing,"")
167+-- >>> parseUrl "/"
168+-- (Nothing,"/")
169+-- >>> parseUrl "ht"
170+-- (Nothing,"")
171+-- >>> parseUrl "http://example.com/foo/bar/"
172+-- (Just "example.com","/foo/bar/")
173+-- >>> parseUrl "https://www.example.com/path/to/dir/"
174+-- (Just "www.example.com","/path/to/dir/")
175+-- >>> parseUrl "http://www.example.com:8080/path/to/dir/"
176+-- (Just "www.example.com:8080","/path/to/dir/")
177+-- >>> parseUrl "//www.example.com:8080/path/to/dir/"
178+-- (Just "www.example.com:8080","/path/to/dir/")
179+-- >>> parseUrl "/path/to/dir/"
180+-- (Nothing,"/path/to/dir/")
181+
182+parseUrl :: ByteString -> IO (Maybe ByteString, URLPath)
183+parseUrl bs@(PS fptr0 off len)
184+ | len == 0 = return (Nothing, "")
185+ | len == 1 = return (Nothing, bs)
186+ | otherwise = withForeignPtr fptr0 $ \ptr0 -> do
187+ let begptr = ptr0 `plusPtr` off
188+ limptr = begptr `plusPtr` len
189+ parseUrl' fptr0 ptr0 begptr limptr len
190+
191+parseUrl' :: ForeignPtr Word8 -> Ptr Word8 -> Ptr Word8 -> Ptr Word8 -> Int
192+ -> IO (Maybe ByteString, URLPath)
193+parseUrl' fptr0 ptr0 begptr limptr len0 = do
194+ w0 <- peek begptr
195+ if w0 == _slash then do
196+ w1 <- peek $ begptr `plusPtr` 1
197+ if w1 == _slash then
198+ doubleSlashed begptr len0
199+ else
200+ slashed begptr len0 Nothing
201+ else do
202+ colonptr <- memchr begptr _colon $ fromIntegral len0
203+ if colonptr == nullPtr then
204+ return (Nothing, "")
205+ else do
206+ let !authptr = colonptr `plusPtr` 1
207+ doubleSlashed authptr (limptr `minusPtr` authptr)
208+ where
209+ -- // / ?
210+ doubleSlashed :: Ptr Word8 -> Int -> IO (Maybe ByteString, URLPath)
211+ doubleSlashed ptr len
212+ | len < 2 = return (Nothing, "")
213+ | otherwise = do
214+ let ptr1 = ptr `plusPtr` 2
215+ pathptr <- memchr ptr1 _slash $ fromIntegral len
216+ if pathptr == nullPtr then
217+ return (Nothing, "")
218+ else do
219+ let !auth = bs ptr0 ptr1 pathptr
220+ slashed pathptr (limptr `minusPtr` pathptr) (Just auth)
221+
222+ -- / ?
223+ slashed :: Ptr Word8 -> Int -> Maybe ByteString -> IO (Maybe ByteString, URLPath)
224+ slashed ptr len mauth = do
225+ questionptr <- memchr ptr _question $ fromIntegral len
226+ if questionptr == nullPtr then do
227+ let !path = bs ptr0 ptr limptr
228+ return (mauth, path)
229+ else do
230+ let !path = bs ptr0 ptr questionptr
231+ return (mauth, path)
232+ bs p0 p1 p2 = path
233+ where
234+ !off = p1 `minusPtr` p0
235+ !siz = p2 `minusPtr` p1
236+ !path = PS fptr0 off siz
wai-http2-extra/Network/Wai/Middleware/Push/Referer/LimitMultiMap.hsnew file+40
@@ -0,0 +1,40 @@
1+{-# LANGUAGE BangPatterns #-}
2+
3+module Network.Wai.Middleware.Push.Referer.LimitMultiMap where
4+
5+import Data.Map (Map)
6+import qualified Data.Map.Strict as M
7+import Data.Set (Set)
8+import qualified Data.Set as S
9+
10+data LimitMultiMap k v = LimitMultiMap {
11+ limitKey :: !Int
12+ , limitVal :: !Int
13+ , multiMap :: !(Map k (Set v))
14+ } deriving (Eq, Show)
15+
16+isEmpty :: LimitMultiMap k t -> Bool
17+isEmpty (LimitMultiMap _ _ m) = M.null m
18+
19+empty :: Int -> Int -> LimitMultiMap k v
20+empty lk lv = LimitMultiMap lk lv M.empty
21+
22+insert :: (Ord k, Ord v) => (k,v) -> LimitMultiMap k v -> LimitMultiMap k v
23+insert (k,v) (LimitMultiMap lk lv m)
24+ | siz < lk = let !m' = M.alter alt k m in LimitMultiMap lk lv m'
25+ | siz == lk = let !m' = M.adjust adj k m in LimitMultiMap lk lv m'
26+ | otherwise = error "insert"
27+ where
28+ siz = M.size m
29+ alt Nothing = Just $ S.singleton v
30+ alt s@(Just set)
31+ | S.size set == lv = s
32+ | otherwise = Just $ S.insert v set
33+ adj set
34+ | S.size set == lv = set
35+ | otherwise = S.insert v set
36+
37+lookup :: Ord k => k -> LimitMultiMap k v -> [v]
38+lookup k (LimitMultiMap _ _ m) = case M.lookup k m of
39+ Nothing -> []
40+ Just set -> S.toList set
wai-http2-extra/test/doctests.hsnew file+4
@@ -0,0 +1,4 @@
1+import Test.DocTest
2+
3+main :: IO ()
4+main = doctest ["Network"]
wai-http2-extra/wai-http2-extra.cabalnew file+44
@@ -0,0 +1,44 @@
1+Name: wai-http2-extra
2+Version: 0.1.2
3+Synopsis: WAI utilities for HTTP/2
4+License: MIT
5+License-file: LICENSE
6+Author: Kazu Yamamoto
7+Maintainer: kazu@iij.ad.jp
8+Homepage: http://github.com/yesodweb/wai
9+Category: Web
10+Build-Type: Simple
11+Cabal-Version: >=1.10
12+Stability: Stable
13+Description: WAI utilities for HTTP/2
14+
15+Library
16+ Build-Depends: base >= 3 && < 5
17+ , auto-update >= 0.1.3 && < 0.2
18+ , bytestring
19+ , containers
20+ , http-types
21+ , wai
22+ , warp
23+ , word8
24+ Exposed-modules: Network.Wai.Middleware.Push.Referer
25+ Other-modules: Network.Wai.Middleware.Push.Referer.LimitMultiMap
26+ Ghc-Options: -Wall
27+ if impl(ghc >= 8)
28+ default-extensions: Strict StrictData
29+ default-language: Haskell2010
30+
31+Test-Suite doctest
32+ Type: exitcode-stdio-1.0
33+ HS-Source-Dirs: test
34+ Ghc-Options: -threaded -Wall
35+ Main-Is: doctests.hs
36+ Build-Depends: base
37+ , doctest >= 0.10.1
38+ if impl(ghc >= 8)
39+ default-extensions: Strict StrictData
40+ default-language: Haskell2010
41+
42+Source-Repository head
43+ Type: git
44+ Location: git://github.com/yesodweb/wai.git
wai-websockets/ChangeLog.md+16
@@ -1,3 +1,19 @@
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+
1## 3.0.0.8
17## 3.0.0.8
2
18
3* Support wai 3.2
19* Support wai 3.2
wai-websockets/Network/Wai/Handler/WebSockets.hs+24−19
@@ -7,6 +7,7 @@ module Network.Wai.Handler.WebSockets
7 , runWebSockets
7 , runWebSockets
8 ) where
8 ) where
9
9
10+import Control.Exception (bracket, tryJust)
10import Data.ByteString (ByteString)
11import Data.ByteString (ByteString)
11import qualified Data.ByteString.Char8 as BC
12import qualified Data.ByteString.Char8 as BC
12import qualified Data.ByteString.Lazy as BL
13import qualified Data.ByteString.Lazy as BL
@@ -29,10 +30,10 @@ isWebSocketsReq req =
29-- WebSocket requests.
30-- WebSocket requests.
30--
31--
31-- @
32-- @
32−-- websocketsOr opts ws_app backup_app = \\req send_response ->
33+-- websocketsOr opts ws_app backup_app = \\req respond ->
33-- __case__ 'websocketsApp' opts ws_app req __of__
34-- __case__ 'websocketsApp' opts ws_app req __of__
34-- 'Nothing' -> backup_app req send_response
35-- 'Nothing' -> backup_app req send_response
35−-- 'Just' res -> send_response res
36+-- 'Just' res -> respond res
36-- @
37-- @
37--
38--
38-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
39-- For example, below is an 'Wai.Application' that sends @"Hello, client!"@ to
@@ -48,7 +49,7 @@ isWebSocketsReq req =
48-- 'WS.sendTextData' conn ("Hello, client!" :: 'Data.Text.Text')
49-- 'WS.sendTextData' conn ("Hello, client!" :: 'Data.Text.Text')
49--
50--
50-- backupApp :: 'Wai.Application'
51-- backupApp :: 'Wai.Application'
51−-- backupApp = 'Wai.respondLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
52+-- backupApp _ respond = respond $ 'Wai.responseLBS' 'Network.HTTP.Types.status400' [] "Not a WebSocket request"
52-- @
53-- @
53websocketsOr :: WS.ConnectionOptions
54websocketsOr :: WS.ConnectionOptions
54 -> WS.ServerApp
55 -> WS.ServerApp
@@ -94,20 +95,24 @@ runWebSockets :: WS.ConnectionOptions
94 -> IO ByteString
95 -> IO ByteString
95 -> (ByteString -> IO ())
96 -> (ByteString -> IO ())
96 -> IO a
97 -> IO a
97−runWebSockets opts req app src sink = do
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 =
98− stream <- WS.makeStream
105+ WS.makeStream
99− (do
106+ (do
100− bs <- src
107+ bs <- src
101− return $ if BC.null bs then Nothing else Just bs)
108+ return $ if BC.null bs then Nothing else Just bs)
102− (\mbBl -> case mbBl of
109+ (\mbBl -> case mbBl of
103− Nothing -> return ()
110+ Nothing -> return ()
104− Just bl -> mapM_ sink (BL.toChunks bl))
111+ Just bl -> mapM_ sink (BL.toChunks bl))
105−
106− let pc = WS.PendingConnection
107− { WS.pendingOptions = opts
108− , WS.pendingRequest = req
109− , WS.pendingOnAccept = \_ -> return ()
110− , WS.pendingStream = stream
111− }
112
112
113− app pc
113+ pc stream = WS.PendingConnection
114+ { WS.pendingOptions = opts
115+ , WS.pendingRequest = req
116+ , WS.pendingOnAccept = \_ -> return ()
117+ , WS.pendingStream = stream
118+ }
wai-websockets/server.lhs+9−3
@@ -8,12 +8,14 @@ this example, keep the [reference](http://jaspervdj.be/websockets/reference)
8nearby to check out the functions we use.
8nearby to check out the functions we use.
9
9
10> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
10> {-# LANGUAGE OverloadedStrings, TemplateHaskell #-}
11+> {-# LANGUAGE CPP #-}
12+> {-# OPTIONS_GHC -Wno-unused-top-binds #-} -- for numClients
11> import Data.Char (isPunctuation, isSpace)
13> import Data.Char (isPunctuation, isSpace)
12> import Data.Monoid (mappend)
14> import Data.Monoid (mappend)
13> import Data.Text (Text)
15> import Data.Text (Text)
14−> import Control.Exception (finally)
16+> import Control.Exception (finally)
15> import Control.Monad (forM_, forever)
17> import Control.Monad (forM_, forever)
16−> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, forkIO, modifyMVar)
18+> import Control.Concurrent (MVar, newMVar, modifyMVar_, readMVar, modifyMVar)
17> import Control.Monad.IO.Class (liftIO)
19> import Control.Monad.IO.Class (liftIO)
18> import qualified Data.Text as T
20> import qualified Data.Text as T
19> import qualified Data.Text.IO as T
21> import qualified Data.Text.IO as T
@@ -99,9 +101,13 @@ stays alive on some browsers.
99
101
100> application state pending = do
102> application state pending = do
101> conn <- WS.acceptRequest pending
103> conn <- WS.acceptRequest pending
104+#if __GLASGOW_HASKELL__ >= 806
105+> WS.withPingThread conn 30 (return ()) $ do
106+#else
102> WS.forkPingThread conn 30
107> WS.forkPingThread conn 30
108+#endif
103
109
104−When a client is succesfully connected, we read the first message. This should
110+When a client is successfully connected, we read the first message. This should
105be in the format of "Hi! I am Jasper", where Jasper is the requested username.
111be in the format of "Hi! I am Jasper", where Jasper is the requested username.
106
112
107> msg <- WS.receiveData conn
113> msg <- WS.receiveData conn
wai-websockets/wai-websockets.cabal+2−3
@@ -1,5 +1,5 @@
1Name: wai-websockets
1Name: wai-websockets
2−Version: 3.0.0.8
2+Version: 3.0.1.2
3Synopsis: Provide a bridge between WAI and the websockets package.
3Synopsis: Provide a bridge between WAI and the websockets package.
4License: MIT
4License: MIT
5License-file: LICENSE
5License-file: LICENSE
@@ -21,7 +21,6 @@ Library
21 Build-Depends: base >= 3 && < 5
21 Build-Depends: base >= 3 && < 5
22 , bytestring >= 0.9.1.4
22 , bytestring >= 0.9.1.4
23 , wai >= 3.0 && < 3.3
23 , wai >= 3.0 && < 3.3
24− , blaze-builder >= 0.2.1.4 && < 0.5
25 , case-insensitive >= 0.2
24 , case-insensitive >= 0.2
26 , network >= 2.2.1.5
25 , network >= 2.2.1.5
27 , transformers >= 0.2
26 , transformers >= 0.2
@@ -41,12 +40,12 @@ Executable wai-websockets-example
41 , wai-app-static
40 , wai-app-static
42 , bytestring
41 , bytestring
43 , case-insensitive
42 , case-insensitive
44− , blaze-builder
45 , transformers
43 , transformers
46 , network
44 , network
47 , text
45 , text
48 , file-embed
46 , file-embed
49 , http-types
47 , http-types
48+ other-modules: Network.Wai.Handler.WebSockets
50 else
49 else
51 buildable: False
50 buildable: False
52
51
wai/ChangeLog.md+26
@@ -1,3 +1,29 @@
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+
1## 3.2.0
27## 3.2.0
2
28
3* Major version up due to breaking changes. We chose 3.2.0, not 3.1.0
29* Major version up due to breaking changes. We chose 3.2.0, not 3.1.0
wai/Network/Wai.hs+28−21
@@ -1,15 +1,14 @@
1−{-# LANGUAGE Rank2Types #-}
2−{-# LANGUAGE CPP #-}
3{-|
1{-|
4
2
5This module defines a generic web application interface. It is a common
3This module defines a generic web application interface. It is a common
6protocol between web servers and web applications.
4protocol between web servers and web applications.
7
5
8The overriding design principles here are performance and generality. To
6The overriding design principles here are performance and generality. To
9−address performance, this library is built on top of the conduit and
7+address performance, this library uses a streaming interface for request and
10−blaze-builder packages. The advantages of conduits over lazy IO have been
8+response bodies, paired with bytestring's 'Builder' type. The advantages of a
9+streaming API over lazy IO have been debated elsewhere and so will not be
11−debated elsewhere and so will not be addressed here. However, helper functions
10+addressed here. However, helper functions like 'responseLBS' allow you to
12−like 'responseLBS' allow you to continue using lazy IO if you so desire.
11+continue using lazy IO if you so desire.
13
12
14Generality is achieved by removing many variables commonly found in similar
13Generality is achieved by removing many variables commonly found in similar
15projects that are not universal to all servers. The goal is that the 'Request'
14projects that are not universal to all servers. The goal is that the 'Request'
@@ -31,9 +30,9 @@ include:
31
30
32[wai-extra] <http://hackage.haskell.org/package/wai-extra>
31[wai-extra] <http://hackage.haskell.org/package/wai-extra>
33
32
34−[wai-test] <http://hackage.haskell.org/package/wai-test>
35−
36-}
33-}
34+-- Ignore deprecations, because this module needs to use the deprecated requestBody to construct a response.
35+{-# OPTIONS_GHC -fno-warn-deprecations #-}
37module Network.Wai
36module Network.Wai
38 (
37 (
39 -- * Types
38 -- * Types
@@ -54,6 +53,7 @@ module Network.Wai
54 , remoteHost
53 , remoteHost
55 , pathInfo
54 , pathInfo
56 , queryString
55 , queryString
56+ , getRequestBodyChunk
57 , requestBody
57 , requestBody
58 , vault
58 , vault
59 , requestBodyLength
59 , requestBodyLength
@@ -79,13 +79,14 @@ module Network.Wai
79 -- ** Response modifiers
79 -- ** Response modifiers
80 , responseToStream
80 , responseToStream
81 , mapResponseHeaders
81 , mapResponseHeaders
82+ , mapResponseStatus
82 -- * Middleware composition
83 -- * Middleware composition
83 , ifRequest
84 , ifRequest
84 , modifyResponse
85 , modifyResponse
85 ) where
86 ) where
86
87
87−import Blaze.ByteString.Builder (Builder, fromLazyByteString)
88+import Data.ByteString.Builder (Builder, lazyByteString)
88−import Blaze.ByteString.Builder (fromByteString)
89+import Data.ByteString.Builder (byteString)
89import Control.Monad (unless)
90import Control.Monad (unless)
90import qualified Data.ByteString as B
91import qualified Data.ByteString as B
91import qualified Data.ByteString.Lazy as L
92import qualified Data.ByteString.Lazy as L
@@ -93,7 +94,6 @@ import qualified Data.ByteString.Lazy.Internal as LI
93import Data.ByteString.Lazy.Internal (defaultChunkSize)
94import Data.ByteString.Lazy.Internal (defaultChunkSize)
94import Data.ByteString.Lazy.Char8 ()
95import Data.ByteString.Lazy.Char8 ()
95import Data.Function (fix)
96import Data.Function (fix)
96−import Data.Monoid (mempty)
97import qualified Network.HTTP.Types as H
97import qualified Network.HTTP.Types as H
98import Network.Socket (SockAddr (SockAddrInet))
98import Network.Socket (SockAddr (SockAddrInet))
99import Network.Wai.Internal
99import Network.Wai.Internal
@@ -121,13 +121,13 @@ responseFile = ResponseFile
121--
121--
122-- A2. No. If the ByteStrings are small, then they will be copied into a larger
122-- A2. No. If the ByteStrings are small, then they will be copied into a larger
123-- buffer, which should be a performance gain overall (less system calls). If
123-- buffer, which should be a performance gain overall (less system calls). If
124−-- they are already large, then blaze-builder uses an InsertByteString
124+-- they are already large, then an insert operation is used
125−-- instruction to avoid copying.
125+-- to avoid copying.
126--
126--
127-- Q3. Doesn't this prevent us from creating comet-style servers, since data
127-- Q3. Doesn't this prevent us from creating comet-style servers, since data
128-- will be cached?
128-- will be cached?
129--
129--
130−-- 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
131-- optimal size by sending a flush command.
131-- optimal size by sending a flush command.
132responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
132responseBuilder :: H.Status -> H.ResponseHeaders -> Builder -> Response
133responseBuilder = ResponseBuilder
133responseBuilder = ResponseBuilder
@@ -135,7 +135,7 @@ responseBuilder = ResponseBuilder
135-- | Creating 'Response' from 'L.ByteString'. This is a wrapper for
135-- | Creating 'Response' from 'L.ByteString'. This is a wrapper for
136-- 'responseBuilder'.
136-- 'responseBuilder'.
137responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
137responseLBS :: H.Status -> H.ResponseHeaders -> L.ByteString -> Response
138−responseLBS s h = ResponseBuilder s h . fromLazyByteString
138+responseLBS s h = ResponseBuilder s h . lazyByteString
139
139
140-- | Creating 'Response' from a stream of values.
140-- | Creating 'Response' from a stream of values.
141--
141--
@@ -149,9 +149,9 @@ responseLBS s h = ResponseBuilder s h . fromLazyByteString
149-- (putStrLn \"Allocating scarce resource\")
149-- (putStrLn \"Allocating scarce resource\")
150-- (putStrLn \"Cleaning up\")
150-- (putStrLn \"Cleaning up\")
151-- $ respond $ responseStream status200 [] $ \\write flush -> do
151-- $ respond $ responseStream status200 [] $ \\write flush -> do
152−-- write $ fromByteString \"Hello\\n\"
152+-- write $ byteString \"Hello\\n\"
153-- flush
153-- flush
154−-- write $ fromByteString \"World\\n\"
154+-- write $ byteString \"World\\n\"
155-- @
155-- @
156--
156--
157-- Note that in some cases you can use @bracket@ from inside @responseStream@
157-- Note that in some cases you can use @bracket@ from inside @responseStream@
@@ -214,7 +214,7 @@ responseToStream (ResponseFile s h fp (Just part)) =
214 bs <- B.hGetSome handle defaultChunkSize
214 bs <- B.hGetSome handle defaultChunkSize
215 unless (B.null bs) $ do
215 unless (B.null bs) $ do
216 let x = B.take remaining bs
216 let x = B.take remaining bs
217− sendChunk $ fromByteString x
217+ sendChunk $ byteString x
218 loop $ remaining - B.length x
218 loop $ remaining - B.length x
219 loop $ fromIntegral $ filePartByteCount part
219 loop $ fromIntegral $ filePartByteCount part
220 )
220 )
@@ -225,7 +225,7 @@ responseToStream (ResponseFile s h fp Nothing) =
225 withBody $ \sendChunk _flush -> fix $ \loop -> do
225 withBody $ \sendChunk _flush -> fix $ \loop -> do
226 bs <- B.hGetSome handle defaultChunkSize
226 bs <- B.hGetSome handle defaultChunkSize
227 unless (B.null bs) $ do
227 unless (B.null bs) $ do
228− sendChunk $ fromByteString bs
228+ sendChunk $ byteString bs
229 loop
229 loop
230 )
230 )
231responseToStream (ResponseBuilder s h b) =
231responseToStream (ResponseBuilder s h b) =
@@ -239,6 +239,13 @@ mapResponseHeaders f (ResponseBuilder s h b) = ResponseBuilder s (f h) b
239mapResponseHeaders f (ResponseStream s h b) = ResponseStream s (f h) b
239mapResponseHeaders f (ResponseStream s h b) = ResponseStream s (f h) b
240mapResponseHeaders _ r@(ResponseRaw _ _) = r
240mapResponseHeaders _ r@(ResponseRaw _ _) = r
241
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+
242----------------------------------------------------------------
249----------------------------------------------------------------
243
250
244-- | The WAI application.
251-- | The WAI application.
@@ -319,7 +326,7 @@ strictRequestBody req =
319 loop id
326 loop id
320 where
327 where
321 loop front = do
328 loop front = do
322− bs <- requestBody req
329+ bs <- getRequestBodyChunk req
323 if B.null bs
330 if B.null bs
324 then return $ front LI.Empty
331 then return $ front LI.Empty
325 else loop (front . LI.Chunk bs)
332 else loop (front . LI.Chunk bs)
@@ -333,7 +340,7 @@ lazyRequestBody req =
333 loop
340 loop
334 where
341 where
335 loop = unsafeInterleaveIO $ do
342 loop = unsafeInterleaveIO $ do
336− bs <- requestBody req
343+ bs <- getRequestBodyChunk req
337 if B.null bs
344 if B.null bs
338 then return LI.Empty
345 then return LI.Empty
339 else do
346 else do
wai/Network/Wai/Internal.hs+10−7
@@ -1,17 +1,12 @@
1{-# OPTIONS_HADDOCK not-home #-}
1{-# OPTIONS_HADDOCK not-home #-}
2−{-# LANGUAGE DeriveDataTypeable #-}
3{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
4−{-# LANGUAGE RankNTypes #-}
5{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE RecordWildCards #-}
6-- | Internal constructors and helper functions. Note that no guarantees are
4-- | Internal constructors and helper functions. Note that no guarantees are
7-- given for stability of these interfaces.
5-- given for stability of these interfaces.
8module Network.Wai.Internal where
6module Network.Wai.Internal where
9
7
10−import Blaze.ByteString.Builder (Builder)
8+import Data.ByteString.Builder (Builder)
11import qualified Data.ByteString as B hiding (pack)
9import qualified Data.ByteString as B hiding (pack)
12−#if __GLASGOW_HASKELL__ < 709
13−import Data.Functor ((<$>))
14−#endif
15import Data.Text (Text)
10import Data.Text (Text)
16import Data.Typeable (Typeable)
11import Data.Typeable (Typeable)
17import Data.Vault.Lazy (Vault)
12import Data.Vault.Lazy (Vault)
@@ -22,6 +17,7 @@ import Data.List (intercalate)
22
17
23-- | Information on the request sent by the client. This abstracts away the
18-- | Information on the request sent by the client. This abstracts away the
24-- details of the underlying implementation.
19-- details of the underlying implementation.
20+{-# DEPRECATED requestBody "requestBody's name is misleading because it only gets a partial chunk of the body. Use getRequestBodyChunk instead." #-}
25data Request = Request {
21data Request = Request {
26 -- | Request method such as GET.
22 -- | Request method such as GET.
27 requestMethod :: H.Method
23 requestMethod :: H.Method
@@ -67,7 +63,7 @@ data Request = Request {
67 -- | Parsed query string information.
63 -- | Parsed query string information.
68 , queryString :: H.Query
64 , queryString :: H.Query
69 -- | Get the next chunk of the body. Returns 'B.empty' when the
65 -- | Get the next chunk of the body. Returns 'B.empty' when the
70− -- body is fully consumed.
66+ -- body is fully consumed. Since 3.2.2, this is deprecated in favor of 'getRequestBodyChunk'.
71 , requestBody :: IO B.ByteString
67 , requestBody :: IO B.ByteString
72 -- | A location for arbitrary data to be shared by applications and middleware.
68 -- | A location for arbitrary data to be shared by applications and middleware.
73 , vault :: Vault
69 , vault :: Vault
@@ -95,6 +91,13 @@ data Request = Request {
95 }
91 }
96 deriving (Typeable)
92 deriving (Typeable)
97
93
94+-- | Get the next chunk of the body. Returns 'B.empty' when the
95+-- body is fully consumed.
96+--
97+-- @since 3.2.2
98+getRequestBodyChunk :: Request -> IO B.ByteString
99+getRequestBodyChunk = requestBody
100+
98instance Show Request where
101instance Show Request where
99 show Request{..} = "Request {" ++ intercalate ", " [a ++ " = " ++ b | (a,b) <- fields] ++ "}"
102 show Request{..} = "Request {" ++ intercalate ", " [a ++ " = " ++ b | (a,b) <- fields] ++ "}"
100 where
103 where
wai/README.md+1−1
@@ -67,7 +67,7 @@ Basic dispatching
67An `Application` maps `Request`s to `Response`s:
67An `Application` maps `Request`s to `Response`s:
68
68
69 ghci> :info Application
69 ghci> :info Application
70− type Application = Request -> IO Response
70+ type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived
71
71
72Depending on the path info provided with each `Request` we can serve different `Response`s:
72Depending on the path info provided with each `Request` we can serve different `Response`s:
73
73
wai/test/Network/WaiSpec.hs+7−9
@@ -3,12 +3,10 @@ module Network.WaiSpec (spec) where
3import Test.Hspec
3import Test.Hspec
4import Test.Hspec.QuickCheck (prop)
4import Test.Hspec.QuickCheck (prop)
5import Network.Wai
5import Network.Wai
6−import Network.Wai.Internal (Request (Request))
7import Data.IORef
6import Data.IORef
8−import Data.Monoid
9import qualified Data.ByteString as S
7import qualified Data.ByteString as S
10import qualified Data.ByteString.Lazy as L
8import qualified Data.ByteString.Lazy as L
11−import Blaze.ByteString.Builder (toByteString, Builder, fromWord8)
9+import Data.ByteString.Builder (Builder, toLazyByteString, word8)
12import Control.Monad (forM_)
10import Control.Monad (forM_)
13
11
14spec :: Spec
12spec :: Spec
@@ -24,17 +22,17 @@ spec = do
24 flush :: IO ()
22 flush :: IO ()
25 flush = return ()
23 flush = return ()
26 streamingBody add flush
24 streamingBody add flush
27− fmap toByteString $ readIORef builderRef
25+ fmap (L.toStrict . toLazyByteString) $ readIORef builderRef
28 prop "responseLBS" $ \bytes -> do
26 prop "responseLBS" $ \bytes -> do
29 body <- getBody $ responseLBS undefined undefined $ L.pack bytes
27 body <- getBody $ responseLBS undefined undefined $ L.pack bytes
30 body `shouldBe` S.pack bytes
28 body `shouldBe` S.pack bytes
31 prop "responseBuilder" $ \bytes -> do
29 prop "responseBuilder" $ \bytes -> do
32 body <- getBody $ responseBuilder undefined undefined
30 body <- getBody $ responseBuilder undefined undefined
33− $ mconcat $ map fromWord8 bytes
31+ $ mconcat $ map word8 bytes
34 body `shouldBe` S.pack bytes
32 body `shouldBe` S.pack bytes
35 prop "responseStream" $ \chunks -> do
33 prop "responseStream" $ \chunks -> do
36 body <- getBody $ responseStream undefined undefined $ \sendChunk _ ->
34 body <- getBody $ responseStream undefined undefined $ \sendChunk _ ->
37− forM_ chunks $ \chunk -> sendChunk $ mconcat $ map fromWord8 chunk
35+ forM_ chunks $ \chunk -> sendChunk $ mconcat $ map word8 chunk
38 body `shouldBe` S.concat (map S.pack chunks)
36 body `shouldBe` S.concat (map S.pack chunks)
39 it "responseFile total" $ do
37 it "responseFile total" $ do
40 let fp = "wai.cabal"
38 let fp = "wai.cabal"
@@ -57,7 +55,7 @@ spec = do
57 describe "lazyRequestBody" $ do
55 describe "lazyRequestBody" $ do
58 prop "works" $ \chunks -> do
56 prop "works" $ \chunks -> do
59 ref <- newIORef $ map S.pack $ filter (not . null) chunks
57 ref <- newIORef $ map S.pack $ filter (not . null) chunks
60− let req = Request
58+ let req = defaultRequest
61 { requestBody = atomicModifyIORef ref $ \bss ->
59 { requestBody = atomicModifyIORef ref $ \bss ->
62 case bss of
60 case bss of
63 [] -> ([], S.empty)
61 [] -> ([], S.empty)
@@ -66,7 +64,7 @@ spec = do
66 body <- lazyRequestBody req
64 body <- lazyRequestBody req
67 body `shouldBe` L.fromChunks (map S.pack chunks)
65 body `shouldBe` L.fromChunks (map S.pack chunks)
68 it "is lazy" $ do
66 it "is lazy" $ do
69− let req = Request
67+ let req = defaultRequest
70 { requestBody = error "requestBody"
68 { requestBody = error "requestBody"
71 }
69 }
72 _ <- lazyRequestBody req
70 _ <- lazyRequestBody req
@@ -74,7 +72,7 @@ spec = do
74 describe "strictRequestBody" $ do
72 describe "strictRequestBody" $ do
75 prop "works" $ \chunks -> do
73 prop "works" $ \chunks -> do
76 ref <- newIORef $ map S.pack $ filter (not . null) chunks
74 ref <- newIORef $ map S.pack $ filter (not . null) chunks
77− let req = Request
75+ let req = defaultRequest
78 { requestBody = atomicModifyIORef ref $ \bss ->
76 { requestBody = atomicModifyIORef ref $ \bss ->
79 case bss of
77 case bss of
80 [] -> ([], S.empty)
78 [] -> ([], S.empty)
wai/wai.cabal+8−10
@@ -1,8 +1,9 @@
1Name: wai
1Name: wai
2−Version: 3.2.0
2+Version: 3.2.2.1
3Synopsis: Web Application Interface.
3Synopsis: Web Application Interface.
4Description: Provides a common protocol for communication between web applications and web servers.
4Description: Provides a common protocol for communication between web applications and web servers.
5+ .
5−description: API docs and the README are available at <http://www.stackage.org/package/wai>.
6+ API docs and the README are available at <http://www.stackage.org/package/wai>.
6License: MIT
7License: MIT
7License-file: LICENSE
8License-file: LICENSE
8Author: Michael Snoyman
9Author: Michael Snoyman
@@ -19,14 +20,11 @@ Source-repository head
19 location: git://github.com/yesodweb/wai.git
20 location: git://github.com/yesodweb/wai.git
20
21
21Library
22Library
22− Build-Depends: base >= 4 && < 5
23+ Build-Depends: base >= 4.8 && < 5
23− , bytestring >= 0.10
24+ , bytestring >= 0.10.4
24− , bytestring-builder >= 0.10.4.0 && < 0.10.7
25− , blaze-builder >= 0.2.1.4 && < 0.5
26 , network >= 2.2.1.5
25 , network >= 2.2.1.5
27 , http-types >= 0.7
26 , http-types >= 0.7
28 , text >= 0.7
27 , text >= 0.7
29− , transformers >= 0.0
30 , vault >= 0.3 && < 0.4
28 , vault >= 0.3 && < 0.4
31 Exposed-modules: Network.Wai
29 Exposed-modules: Network.Wai
32 Network.Wai.Internal
30 Network.Wai.Internal
@@ -36,14 +34,14 @@ test-suite test
36 hs-source-dirs: test
34 hs-source-dirs: test
37 main-is: Spec.hs
35 main-is: Spec.hs
38 type: exitcode-stdio-1.0
36 type: exitcode-stdio-1.0
39− ghc-options: -threaded
37+ ghc-options: -threaded -Wall
40 cpp-options: -DTEST
38 cpp-options: -DTEST
41− build-depends: base
39+ build-depends: base >= 4.8 && < 5
42 , wai
40 , wai
43 , hspec
41 , hspec
44− , blaze-builder
45 , bytestring
42 , bytestring
46 other-modules: Network.WaiSpec
43 other-modules: Network.WaiSpec
44+ build-tool-depends: hspec-discover:hspec-discover
47
45
48source-repository head
46source-repository head
49 type: git
47 type: git
wai/webkit-sample/webkit-sample.hs+2−2
@@ -5,7 +5,7 @@ import Network.Wai.Handler.Webkit
5import Data.ByteString (ByteString)
5import Data.ByteString (ByteString)
6import qualified Data.ByteString.Lazy as L
6import qualified Data.ByteString.Lazy as L
7import Data.Enumerator (consume, Iteratee)
7import Data.Enumerator (consume, Iteratee)
8−import Blaze.ByteString.Builder (fromLazyByteString)
8+import Data.ByteString.Builder (lazyByteString)
9
9
10main :: IO ()
10main :: IO ()
11main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
11main = putStrLn "http://localhost:3000/" >> run "Webkit Sample" app
@@ -27,4 +27,4 @@ postResponse :: L.ByteString -> Iteratee ByteString IO Response
27postResponse lbs = return $ ResponseBuilder
27postResponse lbs = return $ ResponseBuilder
28 status200
28 status200
29 [("Content-Type", "text/plain")]
29 [("Content-Type", "text/plain")]
30− (fromLazyByteString lbs)
30+ (lazyByteString lbs)
warp-tls/ChangeLog.md+52
@@ -1,3 +1,55 @@
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+
1## 3.2.1
53## 3.2.1
2
54
3* Removing dependency to cprng-aes.
55* Removing dependency to cprng-aes.
warp-tls/Network/Wai/Handler/WarpTLS.hs+131−65
@@ -4,7 +4,6 @@
4{-# LANGUAGE RecordWildCards #-}
4{-# LANGUAGE RecordWildCards #-}
5{-# LANGUAGE DeriveDataTypeable #-}
5{-# LANGUAGE DeriveDataTypeable #-}
6{-# LANGUAGE PatternGuards #-}
6{-# LANGUAGE PatternGuards #-}
7−{-# LANGUAGE CPP #-}
8
7
9-- | HTTP over TLS support for Warp via the TLS package.
8-- | HTTP over TLS support for Warp via the TLS package.
10--
9--
@@ -30,6 +29,8 @@ module Network.Wai.Handler.WarpTLS (
30 , tlsCiphers
29 , tlsCiphers
31 , tlsWantClientCert
30 , tlsWantClientCert
32 , tlsServerHooks
31 , tlsServerHooks
32+ , tlsServerDHEParams
33+ , tlsSessionManagerConfig
33 , onInsecure
34 , onInsecure
34 , OnInsecure (..)
35 , OnInsecure (..)
35 -- * Runner
36 -- * Runner
@@ -37,25 +38,29 @@ module Network.Wai.Handler.WarpTLS (
37 , runTLSSocket
38 , runTLSSocket
38 -- * Exception
39 -- * Exception
39 , WarpTLSException (..)
40 , WarpTLSException (..)
41+ , DH.Params
42+ , DH.generateParams
40 ) where
43 ) where
41
44
42−#if __GLASGOW_HASKELL__ < 709
43−import Control.Applicative ((<$>))
44−#endif
45import Control.Applicative ((<|>))
45import Control.Applicative ((<|>))
46−import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..))
46+import Control.Exception (Exception, throwIO, bracket, finally, handle, fromException, try, IOException, onException, SomeException(..), handleJust)
47import qualified Control.Exception as E
47import qualified Control.Exception as E
48−import Control.Monad (void)
48+import Control.Monad (void, guard)
49import qualified Data.ByteString as S
49import qualified Data.ByteString as S
50import qualified Data.ByteString.Lazy as L
50import qualified Data.ByteString.Lazy as L
51import Data.Default.Class (def)
51import Data.Default.Class (def)
52import qualified Data.IORef as I
52import qualified Data.IORef as I
53import Data.Streaming.Network (bindPortTCP, safeRecv)
53import Data.Streaming.Network (bindPortTCP, safeRecv)
54import Data.Typeable (Typeable)
54import Data.Typeable (Typeable)
55−import Network.Socket (Socket, sClose, withSocketsDo, SockAddr, accept)
55+import Network.Socket (Socket, close, withSocketsDo, SockAddr, accept)
56+#if MIN_VERSION_network(3,1,1)
57+import Network.Socket (gracefulClose)
58+#endif
56import Network.Socket.ByteString (sendAll)
59import Network.Socket.ByteString (sendAll)
57import qualified Network.TLS as TLS
60import qualified Network.TLS as TLS
61+import qualified Crypto.PubKey.DH as DH
58import qualified Network.TLS.Extra as TLSExtra
62import qualified Network.TLS.Extra as TLSExtra
63+import qualified Network.TLS.SessionManager as SM
59import Network.Wai (Application)
64import Network.Wai (Application)
60import Network.Wai.Handler.Warp
65import Network.Wai.Handler.Warp
61import Network.Wai.Handler.Warp.Internal
66import Network.Wai.Handler.Warp.Internal
@@ -88,19 +93,37 @@ data TLSSettings = TLSSettings {
88 --
93 --
89 -- Since 1.4.0
94 -- Since 1.4.0
90 , tlsAllowedVersions :: [TLS.Version]
95 , tlsAllowedVersions :: [TLS.Version]
96+#if MIN_VERSION_tls(1,5,0)
97+ -- ^ The TLS versions this server accepts.
98+ --
99+ -- >>> tlsAllowedVersions defaultTlsSettings
100+ -- [TLS13,TLS12,TLS11,TLS10]
101+ --
102+ -- Since 1.4.2
103+#else
91 -- ^ The TLS versions this server accepts.
104 -- ^ The TLS versions this server accepts.
92 --
105 --
93 -- >>> tlsAllowedVersions defaultTlsSettings
106 -- >>> tlsAllowedVersions defaultTlsSettings
94 -- [TLS12,TLS11,TLS10]
107 -- [TLS12,TLS11,TLS10]
95 --
108 --
96 -- Since 1.4.2
109 -- Since 1.4.2
110+#endif
97 , tlsCiphers :: [TLS.Cipher]
111 , tlsCiphers :: [TLS.Cipher]
112+#if MIN_VERSION_tls(1,5,0)
113+ -- ^ The TLS ciphers this server accepts.
114+ --
115+ -- >>> tlsCiphers defaultTlsSettings
116+ -- [ECDHE-ECDSA-AES256GCM-SHA384,ECDHE-ECDSA-AES128GCM-SHA256,ECDHE-RSA-AES256GCM-SHA384,ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256GCM-SHA384,DHE-RSA-AES128GCM-SHA256,ECDHE-ECDSA-AES256CBC-SHA384,ECDHE-RSA-AES256CBC-SHA384,DHE-RSA-AES256-SHA256,ECDHE-ECDSA-AES256CBC-SHA,ECDHE-RSA-AES256CBC-SHA,DHE-RSA-AES256-SHA1,RSA-AES256GCM-SHA384,RSA-AES256-SHA256,RSA-AES256-SHA1,AES128GCM-SHA256,AES256GCM-SHA384]
117+ --
118+ -- Since 1.4.2
119+#else
98 -- ^ The TLS ciphers this server accepts.
120 -- ^ The TLS ciphers this server accepts.
99 --
121 --
100 -- >>> tlsCiphers defaultTlsSettings
122 -- >>> tlsCiphers defaultTlsSettings
101− -- [ECDHE-RSA-AES128GCM-SHA256,DHE-RSA-AES128GCM-SHA256,DHE-RSA-AES256-SHA256,DHE-RSA-AES128-SHA256,DHE-RSA-AES256-SHA1,DHE-RSA-AES128-SHA1,DHE-DSA-AES128-SHA1,DHE-DSA-AES256-SHA1,RSA-aes128-sha1,RSA-aes256-sha1]
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]
102 --
124 --
103 -- Since 1.4.2
125 -- Since 1.4.2
126+#endif
104 , tlsWantClientCert :: Bool
127 , tlsWantClientCert :: Bool
105 -- ^ Whether or not to demand a certificate from the client. If this
128 -- ^ Whether or not to demand a certificate from the client. If this
106 -- is set to True, you must handle received certificates in a server hook
129 -- is set to True, you must handle received certificates in a server hook
@@ -118,6 +141,22 @@ data TLSSettings = TLSSettings {
118 -- Default: def
141 -- Default: def
119 --
142 --
120 -- Since 3.0.2
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
121 }
160 }
122
161
123-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name (aka accessors).
162-- | Default 'TLSSettings'. Use this to create 'TLSSettings' with the field record name (aka accessors).
@@ -131,28 +170,21 @@ defaultTlsSettings = TLSSettings {
131 , keyMemory = Nothing
170 , keyMemory = Nothing
132 , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
171 , onInsecure = DenyInsecure "This server only accepts secure HTTPS connections."
133 , tlsLogging = def
172 , tlsLogging = def
173+#if MIN_VERSION_tls(1,5,0)
174+ , tlsAllowedVersions = [TLS.TLS13,TLS.TLS12,TLS.TLS11,TLS.TLS10]
175+#else
134 , tlsAllowedVersions = [TLS.TLS12,TLS.TLS11,TLS.TLS10]
176 , tlsAllowedVersions = [TLS.TLS12,TLS.TLS11,TLS.TLS10]
177+#endif
135 , tlsCiphers = ciphers
178 , tlsCiphers = ciphers
136 , tlsWantClientCert = False
179 , tlsWantClientCert = False
137 , tlsServerHooks = def
180 , tlsServerHooks = def
181+ , tlsServerDHEParams = Nothing
182+ , tlsSessionManagerConfig = Nothing
138 }
183 }
139
184
140-- taken from stunnel example in tls-extra
185-- taken from stunnel example in tls-extra
141ciphers :: [TLS.Cipher]
186ciphers :: [TLS.Cipher]
142−ciphers =
187+ciphers = TLSExtra.ciphersuite_strong
143− [ TLSExtra.cipher_ECDHE_RSA_AES128GCM_SHA256
144− , TLSExtra.cipher_ECDHE_RSA_AES128CBC_SHA256
145− , TLSExtra.cipher_ECDHE_RSA_AES128CBC_SHA
146− , TLSExtra.cipher_DHE_RSA_AES128GCM_SHA256
147− , TLSExtra.cipher_DHE_RSA_AES256_SHA256
148− , TLSExtra.cipher_DHE_RSA_AES128_SHA256
149− , TLSExtra.cipher_DHE_RSA_AES256_SHA1
150− , TLSExtra.cipher_DHE_RSA_AES128_SHA1
151− , TLSExtra.cipher_DHE_DSS_AES128_SHA1
152− , TLSExtra.cipher_DHE_DSS_AES256_SHA1
153− , TLSExtra.cipher_AES128_SHA1
154− , TLSExtra.cipher_AES256_SHA1
155− ]
156
188
157----------------------------------------------------------------
189----------------------------------------------------------------
158
190
@@ -222,7 +254,7 @@ runTLS :: TLSSettings -> Settings -> Application -> IO ()
222runTLS tset set app = withSocketsDo $
254runTLS tset set app = withSocketsDo $
223 bracket
255 bracket
224 (bindPortTCP (getPort set) (getHost set))
256 (bindPortTCP (getPort set) (getHost set))
225− sClose
257+ close
226 (\sock -> runTLSSocket tset set sock app)
258 (\sock -> runTLSSocket tset set sock app)
227
259
228----------------------------------------------------------------
260----------------------------------------------------------------
@@ -240,20 +272,26 @@ runTLSSocket tlsset@TLSSettings{..} set sock app = do
240 key <- maybe (S.readFile keyFile) return mkey
272 key <- maybe (S.readFile keyFile) return mkey
241 either error return $
273 either error return $
242 TLS.credentialLoadX509ChainFromMemory cert chainCertsMemory key
274 TLS.credentialLoadX509ChainFromMemory cert chainCertsMemory key
275+ mgr <- case tlsSessionManagerConfig of
276+ Nothing -> return TLS.noSessionManager
277+ Just config -> SM.newSessionManager config
243− runTLSSocket' tlsset set credential sock app
278+ runTLSSocket' tlsset set credential mgr sock app
244
279
245−runTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> Socket -> Application -> IO ()
280+runTLSSocket' :: TLSSettings -> Settings -> TLS.Credential -> TLS.SessionManager -> Socket -> Application -> IO ()
246−runTLSSocket' tlsset@TLSSettings{..} set credential sock app =
281+runTLSSocket' tlsset@TLSSettings{..} set credential mgr sock app =
247 runSettingsConnectionMakerSecure set get app
282 runSettingsConnectionMakerSecure set get app
248 where
283 where
249− get = getter tlsset sock params
284+ get = getter tlsset set sock params
250 params = def { -- TLS.ServerParams
285 params = def { -- TLS.ServerParams
251 TLS.serverWantClientCert = tlsWantClientCert
286 TLS.serverWantClientCert = tlsWantClientCert
252 , TLS.serverCACertificates = []
287 , TLS.serverCACertificates = []
253− , TLS.serverDHEParams = Nothing
288+ , TLS.serverDHEParams = tlsServerDHEParams
254 , TLS.serverHooks = hooks
289 , TLS.serverHooks = hooks
255 , TLS.serverShared = shared
290 , TLS.serverShared = shared
256 , TLS.serverSupported = supported
291 , TLS.serverSupported = supported
292+#if MIN_VERSION_tls(1,5,0)
293+ , TLS.serverEarlyDataSize = 2018
294+#endif
257 }
295 }
258 -- Adding alpn to user's tlsServerHooks.
296 -- Adding alpn to user's tlsServerHooks.
259 hooks = tlsServerHooks {
297 hooks = tlsServerHooks {
@@ -261,89 +299,104 @@ runTLSSocket' tlsset@TLSSettings{..} set credential sock app =
261 (if settingsHTTP2Enabled set then Just alpn else Nothing)
299 (if settingsHTTP2Enabled set then Just alpn else Nothing)
262 }
300 }
263 shared = def {
301 shared = def {
264− TLS.sharedCredentials = TLS.Credentials [credential]
302+ TLS.sharedCredentials = TLS.Credentials [credential]
303+ , TLS.sharedSessionManager = mgr
265 }
304 }
266 supported = def { -- TLS.Supported
305 supported = def { -- TLS.Supported
267 TLS.supportedVersions = tlsAllowedVersions
306 TLS.supportedVersions = tlsAllowedVersions
268 , TLS.supportedCiphers = tlsCiphers
307 , TLS.supportedCiphers = tlsCiphers
269 , TLS.supportedCompressions = [TLS.nullCompression]
308 , TLS.supportedCompressions = [TLS.nullCompression]
270− , TLS.supportedHashSignatures = [
271− -- Safari 8 and go tls have bugs on SHA 512 and SHA 384.
272− -- So, we don't specify them here at this moment.
273− (TLS.HashSHA256, TLS.SignatureRSA)
274− , (TLS.HashSHA224, TLS.SignatureRSA)
275− , (TLS.HashSHA1, TLS.SignatureRSA)
276− , (TLS.HashSHA1, TLS.SignatureDSS)
277− ]
278 , TLS.supportedSecureRenegotiation = True
309 , TLS.supportedSecureRenegotiation = True
279 , TLS.supportedClientInitiatedRenegotiation = False
310 , TLS.supportedClientInitiatedRenegotiation = False
280 , TLS.supportedSession = True
311 , TLS.supportedSession = True
281 , TLS.supportedFallbackScsv = True
312 , TLS.supportedFallbackScsv = True
313+#if MIN_VERSION_tls(1,5,0)
314+ , TLS.supportedGroups = [TLS.X25519,TLS.P256,TLS.P384]
315+#endif
282 }
316 }
283
317
284alpn :: [S.ByteString] -> IO S.ByteString
318alpn :: [S.ByteString] -> IO S.ByteString
285alpn xs
319alpn xs
286 | "h2" `elem` xs = return "h2"
320 | "h2" `elem` xs = return "h2"
287− | "h2-16" `elem` xs = return "h2-16"
288− | "h2-15" `elem` xs = return "h2-15"
289− | "h2-14" `elem` xs = return "h2-14"
290 | otherwise = return "http/1.1"
321 | otherwise = return "http/1.1"
291
322
292----------------------------------------------------------------
323----------------------------------------------------------------
293
324
294−getter :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (IO (Connection, Transport), SockAddr)
325+getter :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (IO (Connection, Transport), SockAddr)
295−getter tlsset@TLSSettings{..} sock params = do
326+getter tlsset@TLSSettings{..} set sock params = do
327+#if WINDOWS
328+ (s, sa) <- windowsThreadBlockHack $ accept sock
329+#else
296 (s, sa) <- accept sock
330 (s, sa) <- accept sock
331+#endif
332+ setSocketCloseOnExec s
297− return (mkConn tlsset s params, sa)
333+ return (mkConn tlsset set s params, sa)
298
334
299−mkConn :: TLS.TLSParams params => TLSSettings -> Socket -> params -> IO (Connection, Transport)
335+mkConn :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> params -> IO (Connection, Transport)
300−mkConn tlsset s params = do
336+mkConn tlsset set s params = switch `onException` close s
337+ where
338+ switch = do
301− firstBS <- safeRecv s 4096
339+ firstBS <- safeRecv s 4096
302− (if not (S.null firstBS) && S.head firstBS == 0x16 then
340+ if not (S.null firstBS) && S.head firstBS == 0x16 then
303− httpOverTls tlsset s firstBS params
341+ httpOverTls tlsset set s firstBS params
304− else
342+ else
305− plainHTTP tlsset s firstBS) `onException` sClose s
343+ plainHTTP tlsset set s firstBS
306
344
307----------------------------------------------------------------
345----------------------------------------------------------------
308
346
309−httpOverTls :: TLS.TLSParams params => TLSSettings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
347+httpOverTls :: TLS.TLSParams params => TLSSettings -> Settings -> Socket -> S.ByteString -> params -> IO (Connection, Transport)
310−httpOverTls TLSSettings{..} s bs0 params = do
348+httpOverTls TLSSettings{..} _set s bs0 params = do
311 recvN <- makePlainReceiveN s bs0
349 recvN <- makePlainReceiveN s bs0
312 ctx <- TLS.contextNew (backend recvN) params
350 ctx <- TLS.contextNew (backend recvN) params
313 TLS.contextHookSetLogging ctx tlsLogging
351 TLS.contextHookSetLogging ctx tlsLogging
314 TLS.handshake ctx
352 TLS.handshake ctx
353+ h2 <- (== Just "h2") <$> TLS.getNegotiatedProtocol ctx
354+ isH2 <- I.newIORef h2
315 writeBuf <- allocateBuffer bufferSize
355 writeBuf <- allocateBuffer bufferSize
316 -- Creating a cache for leftover input data.
356 -- Creating a cache for leftover input data.
317 ref <- I.newIORef ""
357 ref <- I.newIORef ""
318 tls <- getTLSinfo ctx
358 tls <- getTLSinfo ctx
319− return (conn ctx writeBuf ref, tls)
359+ return (conn ctx writeBuf ref isH2, tls)
320 where
360 where
321 backend recvN = TLS.Backend {
361 backend recvN = TLS.Backend {
322 TLS.backendFlush = return ()
362 TLS.backendFlush = return ()
323− , TLS.backendClose = sClose s
363+#if MIN_VERSION_network(3,1,1)
364+ , TLS.backendClose = gracefulClose s 5000 `E.catch` \(SomeException _) -> return ()
365+#else
366+ , TLS.backendClose = close s
367+#endif
324 , TLS.backendSend = sendAll' s
368 , TLS.backendSend = sendAll' s
325 , TLS.backendRecv = recvN
369 , TLS.backendRecv = recvN
326 }
370 }
327 sendAll' sock bs = sendAll sock bs `E.catch` \(SomeException _) ->
371 sendAll' sock bs = sendAll sock bs `E.catch` \(SomeException _) ->
328 throwIO ConnectionClosedByPeer
372 throwIO ConnectionClosedByPeer
329− conn ctx writeBuf ref = Connection {
373+ conn ctx writeBuf ref isH2 = Connection {
330 connSendMany = TLS.sendData ctx . L.fromChunks
374 connSendMany = TLS.sendData ctx . L.fromChunks
331 , connSendAll = sendall
375 , connSendAll = sendall
332 , connSendFile = sendfile
376 , connSendFile = sendfile
333− , connClose = close
377+ , connClose = close'
378+ , connFree = freeBuffer writeBuf
334 , connRecv = recv ref
379 , connRecv = recv ref
335 , connRecvBuf = recvBuf ref
380 , connRecvBuf = recvBuf ref
336 , connWriteBuffer = writeBuf
381 , connWriteBuffer = writeBuf
337 , connBufferSize = bufferSize
382 , connBufferSize = bufferSize
383+ , connHTTP2 = isH2
338 }
384 }
339 where
385 where
340 sendall = TLS.sendData ctx . L.fromChunks . return
386 sendall = TLS.sendData ctx . L.fromChunks . return
341 sendfile fid offset len hook headers =
387 sendfile fid offset len hook headers =
342 readSendFile writeBuf bufferSize sendall fid offset len hook headers
388 readSendFile writeBuf bufferSize sendall fid offset len hook headers
343
389
344− close = freeBuffer writeBuf `finally`
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 ()))
345− void (tryIO $ TLS.bye ctx) `finally`
399+ (TLS.bye ctx)
346− TLS.contextClose ctx
347
400
348 -- TLS version of recv with a cache for leftover input data.
401 -- TLS version of recv with a cache for leftover input data.
349 -- The cache is shared with recvBuf.
402 -- The cache is shared with recvBuf.
@@ -412,11 +465,16 @@ getTLSinfo ctx = do
412 TLS.TLS10 -> (3,1)
465 TLS.TLS10 -> (3,1)
413 TLS.TLS11 -> (3,2)
466 TLS.TLS11 -> (3,2)
414 TLS.TLS12 -> (3,3)
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
415 return TLS {
472 return TLS {
416 tlsMajorVersion = major
473 tlsMajorVersion = major
417 , tlsMinorVersion = minor
474 , tlsMinorVersion = minor
418 , tlsNegotiatedProtocol = proto
475 , tlsNegotiatedProtocol = proto
419 , tlsChiperID = TLS.cipherID infoCipher
476 , tlsChiperID = TLS.cipherID infoCipher
477+ , tlsClientCertificate = clientCert
420 }
478 }
421
479
422tryIO :: IO a -> IO (Either IOException a)
480tryIO :: IO a -> IO (Either IOException a)
@@ -424,24 +482,32 @@ tryIO = try
424
482
425----------------------------------------------------------------
483----------------------------------------------------------------
426
484
427−plainHTTP :: TLSSettings -> Socket -> S.ByteString -> IO (Connection, Transport)
485+plainHTTP :: TLSSettings -> Settings -> Socket -> S.ByteString -> IO (Connection, Transport)
428−plainHTTP TLSSettings{..} s bs0 = case onInsecure of
486+plainHTTP TLSSettings{..} set s bs0 = case onInsecure of
429 AllowInsecure -> do
487 AllowInsecure -> do
430− conn' <- socketConnection s
488+ conn' <- socketConnection set s
431 cachedRef <- I.newIORef bs0
489 cachedRef <- I.newIORef bs0
432 let conn'' = conn'
490 let conn'' = conn'
433 { connRecv = recvPlain cachedRef (connRecv conn')
491 { connRecv = recvPlain cachedRef (connRecv conn')
434 }
492 }
435 return (conn'', TCP)
493 return (conn'', TCP)
436 DenyInsecure lbs -> do
494 DenyInsecure lbs -> do
437− -- FIXME: what about HTTP/2?
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.
438− -- http://tools.ietf.org/html/rfc2817#section-4.2
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>
439 sendAll s "HTTP/1.1 426 Upgrade Required\
505 sendAll s "HTTP/1.1 426 Upgrade Required\
440 \r\nUpgrade: TLS/1.0, HTTP/1.1\
506 \r\nUpgrade: TLS/1.0, HTTP/1.1\
441 \r\nConnection: Upgrade\
507 \r\nConnection: Upgrade\
442 \r\nContent-Type: text/plain\r\n\r\n"
508 \r\nContent-Type: text/plain\r\n\r\n"
443 mapM_ (sendAll s) $ L.toChunks lbs
509 mapM_ (sendAll s) $ L.toChunks lbs
444− sClose s
510+ close s
445 throwIO InsecureConnectionDenied
511 throwIO InsecureConnectionDenied
446
512
447----------------------------------------------------------------
513----------------------------------------------------------------
warp-tls/warp-tls.cabal+15−6
@@ -1,5 +1,5 @@
1Name: warp-tls
1Name: warp-tls
2−Version: 3.2.1
2+Version: 3.2.11
3Synopsis: HTTP over TLS support for Warp via the TLS package
3Synopsis: HTTP over TLS support for Warp via the TLS package
4License: MIT
4License: MIT
5License-file: LICENSE
5License-file: LICENSE
@@ -8,25 +8,34 @@ Maintainer: michael@snoyman.com
8Homepage: http://github.com/yesodweb/wai
8Homepage: http://github.com/yesodweb/wai
9Category: Web, Yesod
9Category: Web, Yesod
10Build-Type: Simple
10Build-Type: Simple
11−Cabal-Version: >=1.6
11+Cabal-Version: >= 1.10
12Stability: Stable
12Stability: Stable
13−description: Support for SSL is now obsoleted.
13+description: SSLv1 and SSLv2 are obsoleted by IETF.
14+ We should use TLS 1.2 (or TLS 1.1 or TLS 1.0 if necessary).
14 HTTP/2 can be negotiated by ALPN.
15 HTTP/2 can be negotiated by ALPN.
15 API docs and the README are available at
16 API docs and the README are available at
16 <http://www.stackage.org/package/warp-tls>.
17 <http://www.stackage.org/package/warp-tls>.
17extra-source-files: ChangeLog.md README.md
18extra-source-files: ChangeLog.md README.md
18
19
19Library
20Library
20− Build-Depends: base >= 4 && < 5
21+ Build-Depends: base >= 4.10 && < 5
21 , bytestring >= 0.9
22 , bytestring >= 0.9
22 , wai >= 3.2 && < 3.3
23 , wai >= 3.2 && < 3.3
23− , warp >= 3.2 && < 3.3
24+ , warp >= 3.3.6 && < 3.4
24 , data-default-class >= 0.0.1
25 , data-default-class >= 0.0.1
25− , tls >= 1.3.2
26+ , tls >= 1.5.3
27+ , cryptonite >= 0.12
26 , network >= 2.2.1
28 , network >= 2.2.1
27 , streaming-commons
29 , streaming-commons
30+ , tls-session-manager >= 0.0.4
28 Exposed-modules: Network.Wai.Handler.WarpTLS
31 Exposed-modules: Network.Wai.Handler.WarpTLS
29 ghc-options: -Wall
32 ghc-options: -Wall
33+ if os(windows)
34+ Cpp-Options: -DWINDOWS
35+ if impl(ghc >= 8)
36+ Default-Extensions: Strict StrictData
37+ Default-Language: Haskell2010
38+
30
39
31source-repository head
40source-repository head
32 type: git
41 type: git
warp/ChangeLog.md+208
@@ -1,3 +1,211 @@
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+
1## 3.2.3
209## 3.2.3
2
210
3* Using http2 v1.5.x which much improves the performance of HTTP/2.
211* Using http2 v1.5.x which much improves the performance of HTTP/2.
warp/Network/Wai/Handler/Warp.hs+149−10
@@ -70,12 +70,20 @@ module Network.Wai.Handler.Warp (
70 , setSlowlorisSize
70 , setSlowlorisSize
71 , setHTTP2Disabled
71 , setHTTP2Disabled
72 , setLogger
72 , setLogger
73+ , setServerPushLogger
74+ , setGracefulShutdownTimeout
75+ , setGracefulCloseTimeout1
76+ , setGracefulCloseTimeout2
77+ , setMaxTotalHeaderLength
73 -- ** Getters
78 -- ** Getters
74 , getPort
79 , getPort
75 , getHost
80 , getHost
76 , getOnOpen
81 , getOnOpen
77 , getOnClose
82 , getOnClose
78 , getOnException
83 , getOnException
84+ , getGracefulShutdownTimeout
85+ , getGracefulCloseTimeout1
86+ , getGracefulCloseTimeout2
79 -- ** Exception handler
87 -- ** Exception handler
80 , defaultOnException
88 , defaultOnException
81 , defaultShouldDisplayException
89 , defaultShouldDisplayException
@@ -90,25 +98,51 @@ module Network.Wai.Handler.Warp (
90 , pauseTimeout
98 , pauseTimeout
91 , FileInfo(..)
99 , FileInfo(..)
92 , getFileInfo
100 , getFileInfo
101+ , clientCertificate
102+ , withApplication
103+ , withApplicationSettings
104+ , testWithApplication
105+ , testWithApplicationSettings
106+ , openFreePort
93 -- * Version
107 -- * Version
94 , warpVersion
108 , warpVersion
109+ -- * HTTP/2
110+ -- ** HTTP2 data
111+ , HTTP2Data
112+ , http2dataPushPromise
113+ , http2dataTrailers
114+ , defaultHTTP2Data
115+ , getHTTP2Data
116+ , setHTTP2Data
117+ , modifyHTTP2Data
118+ -- ** Push promise
119+ , PushPromise
120+ , promisedPath
121+ , promisedFile
122+ , promisedResponseHeaders
123+ , promisedWeight
124+ , defaultPushPromise
95 ) where
125 ) where
96
126
97import Control.Exception (SomeException, throwIO)
127import Control.Exception (SomeException, throwIO)
98−import Data.ByteString (ByteString)
99−import Data.Maybe (fromMaybe)
100import Data.Streaming.Network (HostPreference)
128import Data.Streaming.Network (HostPreference)
101import qualified Data.Vault.Lazy as Vault
129import qualified Data.Vault.Lazy as Vault
130+import Data.X509
102import qualified Network.HTTP.Types as H
131import qualified Network.HTTP.Types as H
103import Network.Socket (SockAddr)
132import Network.Socket (SockAddr)
104import Network.Wai (Request, Response, vault)
133import Network.Wai (Request, Response, vault)
134+import System.TimeManager
135+
105import Network.Wai.Handler.Warp.FileInfoCache
136import 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
106import Network.Wai.Handler.Warp.Request
140import Network.Wai.Handler.Warp.Request
107import Network.Wai.Handler.Warp.Response (warpVersion)
141import Network.Wai.Handler.Warp.Response (warpVersion)
108import Network.Wai.Handler.Warp.Run
142import Network.Wai.Handler.Warp.Run
109import Network.Wai.Handler.Warp.Settings
143import Network.Wai.Handler.Warp.Settings
110−import Network.Wai.Handler.Warp.Timeout
111import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
144import Network.Wai.Handler.Warp.Types hiding (getFileInfo)
145+import Network.Wai.Handler.Warp.WithApplication
112
146
113-- | Port to listen on. Default value: 3000
147-- | Port to listen on. Default value: 3000
114--
148--
@@ -130,9 +164,18 @@ setOnException :: (Maybe Request -> SomeException -> IO ()) -> Settings -> Setti
130setOnException x y = y { settingsOnException = x }
164setOnException x y = y { settingsOnException = x }
131
165
132-- | A function to create a `Response` when an exception occurs.
166-- | A function to create a `Response` when an exception occurs.
133−--
134-- Default: 'defaultOnExceptionResponse'
167-- Default: 'defaultOnExceptionResponse'
135--
168--
169+-- Note that an application can handle its own exceptions without interfering with Warp:
170+--
171+-- > myApp :: Application
172+-- > myApp request respond = innerApp `catch` onError
173+-- > where
174+-- > onError = respond . response500 request
175+-- >
176+-- > response500 :: Request -> SomeException -> Response
177+-- > response500 req someEx = responseLBS status500 -- ...
178+--
136-- Since 2.1.0
179-- Since 2.1.0
137setOnExceptionResponse :: (SomeException -> Response) -> Settings -> Settings
180setOnExceptionResponse :: (SomeException -> Response) -> Settings -> Settings
138setOnExceptionResponse x y = y { settingsOnExceptionResponse = x }
181setOnExceptionResponse x y = y { settingsOnExceptionResponse = x }
@@ -238,11 +281,39 @@ getOnClose = settingsOnClose
238getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
281getOnException :: Settings -> Maybe Request -> SomeException -> IO ()
239getOnException = settingsOnException
282getOnException = settingsOnException
240
283
284+-- | Get the graceful shutdown timeout
285+--
286+-- Since 3.2.8
287+getGracefulShutdownTimeout :: Settings -> Maybe Int
288+getGracefulShutdownTimeout = settingsGracefulShutdownTimeout
289+
241-- | A code to install shutdown handler.
290-- | A code to install shutdown handler.
242--
291--
243-- For instance, this code should set up a UNIX signal
292-- For instance, this code should set up a UNIX signal
244-- handler. The handler should call the first argument,
293-- handler. The handler should call the first argument,
245−-- 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'.
246--
317--
247-- Default: does not install any code.
318-- Default: does not install any code.
248--
319--
@@ -250,7 +321,10 @@ getOnException = settingsOnException
250setInstallShutdownHandler :: (IO () -> IO ()) -> Settings -> Settings
321setInstallShutdownHandler :: (IO () -> IO ()) -> Settings -> Settings
251setInstallShutdownHandler x y = y { settingsInstallShutdownHandler = x }
322setInstallShutdownHandler x y = y { settingsInstallShutdownHandler = x }
252
323
324+-- | Default server name to be sent as the \"Server:\" header
253−-- | Default server name if application does not set one.
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.
254--
328--
255-- Since 3.0.2
329-- Since 3.0.2
256setServerName :: ByteString -> Settings -> Settings
330setServerName :: ByteString -> Settings -> Settings
@@ -311,7 +385,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
311--
385--
312-- WARNING: This is contrary to the PROXY protocol specification and
386-- WARNING: This is contrary to the PROXY protocol specification and
313-- using it can indicate a security problem with your
387-- using it can indicate a security problem with your
314−-- architecture if the web server is directly accessable
388+-- architecture if the web server is directly accessible
315-- to the public, since it would allow easy IP address
389-- to the public, since it would allow easy IP address
316-- spoofing. However, it can be useful in some cases,
390-- spoofing. However, it can be useful in some cases,
317-- such as if a load balancer health check uses regular
391-- such as if a load balancer health check uses regular
@@ -322,7 +396,7 @@ setProxyProtocolRequired y = y { settingsProxyProtocol = ProxyProtocolRequired }
322setProxyProtocolOptional :: Settings -> Settings
396setProxyProtocolOptional :: Settings -> Settings
323setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
397setProxyProtocolOptional y = y { settingsProxyProtocol = ProxyProtocolOptional }
324
398
325−-- | Size in bytes read to prevent Slowloris protection. Default value: 2048
399+-- | Size in bytes read to prevent Slowloris attacks. Default value: 2048
326--
400--
327-- Since 3.1.2
401-- Since 3.1.2
328setSlowlorisSize :: Int -> Settings -> Settings
402setSlowlorisSize :: Int -> Settings -> Settings
@@ -337,10 +411,39 @@ setHTTP2Disabled y = y { settingsHTTP2Enabled = False }
337-- | Setting a log function.
411-- | Setting a log function.
338--
412--
339-- Since 3.X.X
413-- Since 3.X.X
340−setLogger :: (Request -> H.Status -> Maybe Integer -> IO ())
414+setLogger :: (Request -> H.Status -> Maybe Integer -> IO ()) -- ^ request, status, maybe file-size
341− -> Settings -> Settings
415+ -> Settings
416+ -> Settings
342setLogger lgr y = y { settingsLogger = lgr }
417setLogger lgr y = y { settingsLogger = lgr }
343
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+
344-- | Explicitly pause the slowloris timeout.
447-- | Explicitly pause the slowloris timeout.
345--
448--
346-- This is useful for cases where you partially consume a request body. For
449-- This is useful for cases where you partially consume a request body. For
@@ -368,3 +471,39 @@ pauseTimeout = fromMaybe (return ()) . Vault.lookup pauseTimeoutKey . vault
368-- Since 3.1.10
471-- Since 3.1.10
369getFileInfo :: Request -> FilePath -> IO FileInfo
472getFileInfo :: Request -> FilePath -> IO FileInfo
370getFileInfo = fromMaybe (\_ -> throwIO (userError "getFileInfo")) . Vault.lookup getFileInfoKey . vault
473getFileInfo = fromMaybe (\_ -> throwIO (userError "getFileInfo")) . Vault.lookup getFileInfoKey . vault
474+
475+-- | A timeout to limit the time (in milliseconds) waiting for
476+-- FIN for HTTP/1.x. 0 means uses immediate close.
477+-- Default: 0.
478+--
479+-- Since 3.3.5
480+setGracefulCloseTimeout1 :: Int -> Settings -> Settings
481+setGracefulCloseTimeout1 x y = y { settingsGracefulCloseTimeout1 = x }
482+
483+-- | A timeout to limit the time (in milliseconds) waiting for
484+-- FIN for HTTP/1.x. 0 means uses immediate close.
485+--
486+-- Since 3.3.5
487+getGracefulCloseTimeout1 :: Settings -> Int
488+getGracefulCloseTimeout1 = settingsGracefulCloseTimeout1
489+
490+-- | A timeout to limit the time (in milliseconds) waiting for
491+-- FIN for HTTP/2. 0 means uses immediate close.
492+-- Default: 2000.
493+--
494+-- Since 3.3.5
495+setGracefulCloseTimeout2 :: Int -> Settings -> Settings
496+setGracefulCloseTimeout2 x y = y { settingsGracefulCloseTimeout2 = x }
497+
498+-- | A timeout to limit the time (in milliseconds) waiting for
499+-- FIN for HTTP/2. 0 means uses immediate close.
500+--
501+-- Since 3.3.5
502+getGracefulCloseTimeout2 :: Settings -> Int
503+getGracefulCloseTimeout2 = settingsGracefulCloseTimeout2
504+
505+-- | Getting information of client certificate.
506+--
507+-- Since 3.3.5
508+clientCertificate :: Request -> Maybe CertificateChain
509+clientCertificate = join . Vault.lookup getClientCertificateKey . vault
warp/Network/Wai/Handler/Warp/Buffer.hs+4−2
@@ -1,4 +1,4 @@
1−{-# LANGUAGE BangPatterns, OverloadedStrings #-}
1+{-# LANGUAGE BangPatterns #-}
2
2
3module Network.Wai.Handler.Warp.Buffer (
3module Network.Wai.Handler.Warp.Buffer (
4 bufferSize
4 bufferSize
@@ -13,13 +13,15 @@ module Network.Wai.Handler.Warp.Buffer (
13 ) where
13 ) where
14
14
15import qualified Data.ByteString as BS
15import qualified Data.ByteString as BS
16−import Data.ByteString.Internal (ByteString(..), memcpy)
16+import Data.ByteString.Internal (memcpy)
17import Data.ByteString.Unsafe (unsafeTake, unsafeDrop)
17import Data.ByteString.Unsafe (unsafeTake, unsafeDrop)
18import Data.IORef (newIORef, readIORef, writeIORef)
18import Data.IORef (newIORef, readIORef, writeIORef)
19import qualified Data.Streaming.ByteString.Builder.Buffer as B (Buffer (..))
19import qualified Data.Streaming.ByteString.Builder.Buffer as B (Buffer (..))
20import Foreign.ForeignPtr
20import Foreign.ForeignPtr
21import Foreign.Marshal.Alloc (mallocBytes, free, finalizerFree)
21import Foreign.Marshal.Alloc (mallocBytes, free, finalizerFree)
22import Foreign.Ptr (castPtr, plusPtr)
22import Foreign.Ptr (castPtr, plusPtr)
23+
24+import Network.Wai.Handler.Warp.Imports
23import Network.Wai.Handler.Warp.Types
25import Network.Wai.Handler.Warp.Types
24
26
25----------------------------------------------------------------
27----------------------------------------------------------------
warp/Network/Wai/Handler/Warp/Conduit.hs+2−6
@@ -3,14 +3,10 @@
3module Network.Wai.Handler.Warp.Conduit where
3module Network.Wai.Handler.Warp.Conduit where
4
4
5import Control.Exception
5import Control.Exception
6−import Control.Monad (when, unless)
7−import Data.ByteString (ByteString)
8import qualified Data.ByteString as S
6import qualified Data.ByteString as S
9import qualified Data.IORef as I
7import qualified Data.IORef as I
10−#if __GLASGOW_HASKELL__ < 709
8+
11−import Data.Word (Word)
9+import Network.Wai.Handler.Warp.Imports
12−#endif
13−import Data.Word (Word8)
14import Network.Wai.Handler.Warp.Types
10import Network.Wai.Handler.Warp.Types
15
11
16----------------------------------------------------------------
12----------------------------------------------------------------
warp/Network/Wai/Handler/Warp/Counter.hs+3−4
@@ -8,11 +8,10 @@ module Network.Wai.Handler.Warp.Counter (
8 , decrease
8 , decrease
9 ) where
9 ) where
10
10
11−#if __GLASGOW_HASKELL__ < 709
12−import Control.Applicative ((<$>))
13−#endif
14import Control.Concurrent.STM
11import Control.Concurrent.STM
15−import Control.Monad (unless)
12+
13+import Network.Wai.Handler.Warp.Imports
14+
16
15
17newtype Counter = Counter (TVar Int)
16newtype Counter = Counter (TVar Int)
18
17
warp/Network/Wai/Handler/Warp/Date.hs+1−4
@@ -5,11 +5,8 @@ module Network.Wai.Handler.Warp.Date (
5 , GMTDate
5 , GMTDate
6 ) where
6 ) where
7
7
8−#if __GLASGOW_HASKELL__ < 709
9−import Control.Applicative
10−#endif
11import Control.AutoUpdate (defaultUpdateSettings, updateAction, mkAutoUpdate)
8import Control.AutoUpdate (defaultUpdateSettings, updateAction, mkAutoUpdate)
12−import Data.ByteString.Char8
9+import Data.ByteString
13import Network.HTTP.Date
10import Network.HTTP.Date
14
11
15#if WINDOWS
12#if WINDOWS
warp/Network/Wai/Handler/Warp/FdCache.hs+23−46
@@ -14,39 +14,34 @@ module Network.Wai.Handler.Warp.FdCache (
14 ) where
14 ) where
15
15
16#ifndef WINDOWS
16#ifndef WINDOWS
17−#if __GLASGOW_HASKELL__ < 709
18−import Control.Applicative ((<$>), (<*>))
19−#endif
20import Control.Exception (bracket)
17import Control.Exception (bracket)
21−import Network.Wai.Handler.Warp.IORef
22−import Network.Wai.Handler.Warp.MultiMap
23import Control.Reaper
18import Control.Reaper
19+import Data.IORef
20+import Network.Wai.Handler.Warp.MultiMap as MM
24import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd, FdOption(CloseOnExec), setFdOption)
21import System.Posix.IO (openFd, OpenFileFlags(..), defaultFileFlags, OpenMode(ReadOnly), closeFd, FdOption(CloseOnExec), setFdOption)
25#endif
22#endif
26import System.Posix.Types (Fd)
23import System.Posix.Types (Fd)
27
24
28----------------------------------------------------------------
25----------------------------------------------------------------
29
26
30−type Hash = Int
31−
32-- | An action to activate a Fd cache entry.
27-- | An action to activate a Fd cache entry.
33type Refresh = IO ()
28type Refresh = IO ()
34
29
35−getFdNothing :: Hash -> FilePath -> IO (Maybe Fd, Refresh)
30+getFdNothing :: FilePath -> IO (Maybe Fd, Refresh)
36−getFdNothing _ _ = return (Nothing, return ())
31+getFdNothing _ = return (Nothing, return ())
37
32
38----------------------------------------------------------------
33----------------------------------------------------------------
39
34
40-- | Creating 'MutableFdCache' and executing the action in the second
35-- | Creating 'MutableFdCache' and executing the action in the second
41-- argument. The first argument is a cache duration in second.
36-- argument. The first argument is a cache duration in second.
42−withFdCache :: Int -> ((Hash -> FilePath -> IO (Maybe Fd, Refresh)) -> IO a) -> IO a
37+withFdCache :: Int -> ((FilePath -> IO (Maybe Fd, Refresh)) -> IO a) -> IO a
43#ifdef WINDOWS
38#ifdef WINDOWS
44withFdCache _ action = action getFdNothing
39withFdCache _ action = action getFdNothing
45#else
40#else
46withFdCache 0 action = action getFdNothing
41withFdCache 0 action = action getFdNothing
47withFdCache duration action = bracket (initialize duration)
42withFdCache duration action = bracket (initialize duration)
48 terminate
43 terminate
49− (\mfc -> action (getFd mfc))
44+ (action . getFd)
50
45
51----------------------------------------------------------------
46----------------------------------------------------------------
52
47
@@ -68,7 +63,7 @@ inactive (MutableStatus ref) = writeIORef ref Inactive
68
63
69----------------------------------------------------------------
64----------------------------------------------------------------
70
65
71−data FdEntry = FdEntry !FilePath !Fd !MutableStatus
66+data FdEntry = FdEntry !Fd !MutableStatus
72
67
73openFile :: FilePath -> IO Fd
68openFile :: FilePath -> IO Fd
74openFile path = do
69openFile path = do
@@ -80,30 +75,23 @@ closeFile :: Fd -> IO ()
80closeFile = closeFd
75closeFile = closeFd
81
76
82newFdEntry :: FilePath -> IO FdEntry
77newFdEntry :: FilePath -> IO FdEntry
83−newFdEntry path = FdEntry path <$> openFile path <*> newActiveStatus
78+newFdEntry path = FdEntry <$> openFile path <*> newActiveStatus
84
79
85setFileCloseOnExec :: Fd -> IO ()
80setFileCloseOnExec :: Fd -> IO ()
86setFileCloseOnExec fd = setFdOption fd CloseOnExec True
81setFileCloseOnExec fd = setFdOption fd CloseOnExec True
87
82
88----------------------------------------------------------------
83----------------------------------------------------------------
89
84
90−type FdCache = MMap Hash FdEntry
85+type FdCache = MultiMap FdEntry
91
86
92-- | Mutable Fd cacher.
87-- | Mutable Fd cacher.
93−newtype MutableFdCache = MutableFdCache (Reaper FdCache (Hash, FdEntry))
88+newtype MutableFdCache = MutableFdCache (Reaper FdCache (FilePath,FdEntry))
94
89
95fdCache :: MutableFdCache -> IO FdCache
90fdCache :: MutableFdCache -> IO FdCache
96fdCache (MutableFdCache reaper) = reaperRead reaper
91fdCache (MutableFdCache reaper) = reaperRead reaper
97
92
98−look :: MutableFdCache -> FilePath -> Hash -> IO (Maybe FdEntry)
93+look :: MutableFdCache -> FilePath -> IO (Maybe FdEntry)
99−look mfc path key = searchWith key check <$> fdCache mfc
94+look mfc path = MM.lookup path <$> fdCache mfc
100− where
101− check (One ent@(FdEntry path' _ _))
102− | path == path' = Just ent
103− | otherwise = Nothing
104− check (Tom ent@(FdEntry path' _ _) vs)
105− | path == path' = Just ent
106− | otherwise = check vs
107
95
108----------------------------------------------------------------
96----------------------------------------------------------------
109
97
@@ -123,43 +111,32 @@ clean :: FdCache -> IO (FdCache -> FdCache)
123clean old = do
111clean old = do
124 new <- pruneWith old prune
112 new <- pruneWith old prune
125 return $ merge new
113 return $ merge new
126−
127−prune :: t -> Some FdEntry -> IO [(t, Some FdEntry)]
128−prune k v@(One (FdEntry _ fd mst)) = status mst >>= prune'
129− where
130− prune' Active = inactive mst >> return [(k,v)]
131− prune' Inactive = closeFd fd >> return []
132−prune k (Tom ent@(FdEntry _ fd mst) vs) = status mst >>= prune'
133 where
114 where
134− prune' Active = do
115+ prune (_,FdEntry fd mst) = status mst >>= act
116+ where
135− inactive mst
117+ act Active = inactive mst >> return True
136− zs <- prune k vs
137− case zs of
138− [] -> return [(k,One ent)]
139− [(_,zvs)] -> return [(k,Tom ent zvs)]
140− _ -> error "prune"
141− prune' Inactive = closeFd fd >> prune k vs
118+ act Inactive = closeFd fd >> return False
142
119
143----------------------------------------------------------------
120----------------------------------------------------------------
144
121
145terminate :: MutableFdCache -> IO ()
122terminate :: MutableFdCache -> IO ()
146terminate (MutableFdCache reaper) = do
123terminate (MutableFdCache reaper) = do
147 !t <- reaperStop reaper
124 !t <- reaperStop reaper
148− mapM_ closeIt $ toList t
125+ mapM_ (closeIt . snd) $ toList t
149 where
126 where
150− closeIt (_, FdEntry _ fd _) = closeFd fd
127+ closeIt (FdEntry fd _) = closeFd fd
151
128
152----------------------------------------------------------------
129----------------------------------------------------------------
153
130
154-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
131-- | Getting 'Fd' and 'Refresh' from the mutable Fd cacher.
155−getFd :: MutableFdCache -> Hash -> FilePath -> IO (Maybe Fd, Refresh)
132+getFd :: MutableFdCache -> FilePath -> IO (Maybe Fd, Refresh)
156−getFd mfc@(MutableFdCache reaper) h path = look mfc path h >>= get
133+getFd mfc@(MutableFdCache reaper) path = look mfc path >>= get
157 where
134 where
158 get Nothing = do
135 get Nothing = do
159− ent@(FdEntry _ fd mst) <- newFdEntry path
136+ ent@(FdEntry fd mst) <- newFdEntry path
160− reaperAdd reaper (h, ent)
137+ reaperAdd reaper (path,ent)
161 return (Just fd, refresh mst)
138 return (Just fd, refresh mst)
162− get (Just (FdEntry _ fd mst)) = do
139+ get (Just (FdEntry fd mst)) = do
163 refresh mst
140 refresh mst
164 return (Just fd, refresh mst)
141 return (Just fd, refresh mst)
165#endif
142#endif
warp/Network/Wai/Handler/Warp/File.hs+20−60
@@ -6,26 +6,24 @@ module Network.Wai.Handler.Warp.File (
6 RspFileInfo(..)
6 RspFileInfo(..)
7 , conditionalRequest
7 , conditionalRequest
8 , addContentHeadersForFilePart
8 , addContentHeadersForFilePart
9− , parseByteRanges
9+ , H.parseByteRanges
10 ) where
10 ) where
11
11
12−import Control.Applicative ((<|>))
13import Data.Array ((!))
12import Data.Array ((!))
14−import Data.ByteString (ByteString)
15−import qualified Data.ByteString as B hiding (pack)
16−import qualified Data.ByteString.Char8 as B (pack, readInteger)
13+import qualified Data.ByteString.Char8 as C8 (pack)
17−import Data.Maybe (fromMaybe)
18import Network.HTTP.Date
14import Network.HTTP.Date
19import qualified Network.HTTP.Types as H
15import qualified Network.HTTP.Types as H
20import qualified Network.HTTP.Types.Header as H
16import qualified Network.HTTP.Types.Header as H
21import Network.Wai
17import Network.Wai
18+
22import qualified Network.Wai.Handler.Warp.FileInfoCache as I
19import qualified Network.Wai.Handler.Warp.FileInfoCache as I
23import Network.Wai.Handler.Warp.Header
20import Network.Wai.Handler.Warp.Header
24−import Numeric (showInt)
21+import Network.Wai.Handler.Warp.Imports
22+import Network.Wai.Handler.Warp.PackInt
23+
25
24
26−#ifndef MIN_VERSION_http_types
25+-- $setup
27−#define MIN_VERSION_http_types(x,y,z) 1
26+-- >>> import Test.QuickCheck
28−#endif
29
27
30----------------------------------------------------------------
28----------------------------------------------------------------
31
29
@@ -36,12 +34,15 @@ data RspFileInfo = WithoutBody H.Status
36----------------------------------------------------------------
34----------------------------------------------------------------
37
35
38conditionalRequest :: I.FileInfo
36conditionalRequest :: I.FileInfo
39− -> H.ResponseHeaders -> IndexedHeader
37+ -> H.ResponseHeaders
38+ -> IndexedHeader -- ^ Response
39+ -> IndexedHeader -- ^ Request
40 -> RspFileInfo
40 -> RspFileInfo
41−conditionalRequest finfo hs0 reqidx = case condition of
41+conditionalRequest finfo hs0 rspidx reqidx = case condition of
42 nobody@(WithoutBody _) -> nobody
42 nobody@(WithoutBody _) -> nobody
43+ WithBody s _ off len -> let !hs1 = addContentHeaders hs0 off len size
44+ !hasLM = isJust $ rspidx ! fromEnum ResLastModified
43− WithBody s _ off len -> let !hs = (H.hLastModified,date) :
45+ !hs = [ (H.hLastModified,date) | not hasLM ] ++ hs1
44− addContentHeaders hs0 off len size
45 in WithBody s hs off len
46 in WithBody s hs off len
46 where
47 where
47 !mtime = I.fileInfoTime finfo
48 !mtime = I.fileInfoTime finfo
@@ -95,7 +96,7 @@ unconditional reqidx size = case reqidx ! fromEnum ReqRange of
95----------------------------------------------------------------
96----------------------------------------------------------------
96
97
97parseRange :: ByteString -> Integer -> RspFileInfo
98parseRange :: ByteString -> Integer -> RspFileInfo
98−parseRange rng size = case parseByteRanges rng of
99+parseRange rng size = case H.parseByteRanges rng of
99 Nothing -> WithoutBody H.requestedRangeNotSatisfiable416
100 Nothing -> WithoutBody H.requestedRangeNotSatisfiable416
100 Just [] -> WithoutBody H.requestedRangeNotSatisfiable416
101 Just [] -> WithoutBody H.requestedRangeNotSatisfiable416
101 Just (r:_) -> let (!beg, !end) = checkRange r size
102 Just (r:_) -> let (!beg, !end) = checkRange r size
@@ -111,48 +112,14 @@ checkRange (H.ByteRangeFrom beg) size = (beg, size - 1)
111checkRange (H.ByteRangeFromTo beg end) size = (beg, min (size - 1) end)
112checkRange (H.ByteRangeFromTo beg end) size = (beg, min (size - 1) end)
112checkRange (H.ByteRangeSuffix count) size = (max 0 (size - count), size - 1)
113checkRange (H.ByteRangeSuffix count) size = (max 0 (size - count), size - 1)
113
114
114−-- | Parse the value of a Range header into a 'H.ByteRanges'.
115−parseByteRanges :: B.ByteString -> Maybe H.ByteRanges
116−parseByteRanges bs1 = do
117− bs2 <- stripPrefix "bytes=" bs1
118− (r, bs3) <- range bs2
119− ranges (r:) bs3
120− where
121− range bs2 = do
122− (i, bs3) <- B.readInteger bs2
123− if i < 0 -- has prefix "-" ("-0" is not valid, but here treated as "0-")
124− then Just (H.ByteRangeSuffix (negate i), bs3)
125− else do
126− bs4 <- stripPrefix "-" bs3
127− case B.readInteger bs4 of
128− Just (j, bs5) | j >= i -> Just (H.ByteRangeFromTo i j, bs5)
129− _ -> Just (H.ByteRangeFrom i, bs4)
130− ranges front bs3
131− | B.null bs3 = Just (front [])
132− | otherwise = do
133− bs4 <- stripPrefix "," bs3
134− (r, bs5) <- range bs4
135− ranges (front . (r:)) bs5
136−
137− stripPrefix x y
138− | x `B.isPrefixOf` y = Just (B.drop (B.length x) y)
139− | otherwise = Nothing
140−
141----------------------------------------------------------------
115----------------------------------------------------------------
142
116
143−contentRange :: H.HeaderName
144−#if MIN_VERSION_http_types(0,9,0)
145−contentRange = H.hContentRange
146−#else
147−contentRange = "Content-Range"
148−#endif
149−
150-- | @contentRangeHeader beg end total@ constructs a Content-Range 'H.Header'
117-- | @contentRangeHeader beg end total@ constructs a Content-Range 'H.Header'
151-- for the range specified.
118-- for the range specified.
152contentRangeHeader :: Integer -> Integer -> Integer -> H.Header
119contentRangeHeader :: Integer -> Integer -> Integer -> H.Header
153−contentRangeHeader beg end total = (contentRange, range)
120+contentRangeHeader beg end total = (H.hContentRange, range)
154 where
121 where
155− range = B.pack
122+ range = C8.pack
156 -- building with ShowS
123 -- building with ShowS
157 $ 'b' : 'y': 't' : 'e' : 's' : ' '
124 $ 'b' : 'y': 't' : 'e' : 's' : ' '
158 : (if beg > end then ('*':) else
125 : (if beg > end then ('*':) else
@@ -162,21 +129,14 @@ contentRangeHeader beg end total = (contentRange, range)
162 ( '/'
129 ( '/'
163 : showInt total "")
130 : showInt total "")
164
131
165−acceptRange :: H.HeaderName
166−#if MIN_VERSION_http_types(0,9,0)
167−acceptRange = H.hAcceptRanges
168−#else
169−acceptRange = "Accept-Ranges"
170−#endif
171−
172addContentHeaders :: H.ResponseHeaders -> Integer -> Integer -> Integer -> H.ResponseHeaders
132addContentHeaders :: H.ResponseHeaders -> Integer -> Integer -> Integer -> H.ResponseHeaders
173addContentHeaders hs off len size
133addContentHeaders hs off len size
174 | len == size = hs'
134 | len == size = hs'
175 | otherwise = let !ctrng = contentRangeHeader off (off + len - 1) size
135 | otherwise = let !ctrng = contentRangeHeader off (off + len - 1) size
176 in ctrng:hs'
136 in ctrng:hs'
177 where
137 where
178− !lengthBS = B.pack $ show len -- fixme
138+ !lengthBS = packIntegral len
179− !hs' = (H.hContentLength, lengthBS) : (acceptRange,"bytes") : hs
139+ !hs' = (H.hContentLength, lengthBS) : (H.hAcceptRanges,"bytes") : hs
180
140
181-- |
141-- |
182--
142--
warp/Network/Wai/Handler/Warp/FileInfoCache.hs+24−27
@@ -2,24 +2,21 @@
2
2
3module Network.Wai.Handler.Warp.FileInfoCache (
3module Network.Wai.Handler.Warp.FileInfoCache (
4 FileInfo(..)
4 FileInfo(..)
5− , Hash
6 , withFileInfoCache
5 , withFileInfoCache
7 , getInfo -- test purpose only
6 , getInfo -- test purpose only
8 ) where
7 ) where
9
8
10import Control.Exception as E
9import Control.Exception as E
11−import Control.Monad (void)
12import Control.Reaper
10import Control.Reaper
13−import Data.ByteString (ByteString)
14import Network.HTTP.Date
11import Network.HTTP.Date
12+import System.PosixCompat.Files
13+
15import Network.Wai.Handler.Warp.HashMap (HashMap)
14import Network.Wai.Handler.Warp.HashMap (HashMap)
16import qualified Network.Wai.Handler.Warp.HashMap as M
15import qualified Network.Wai.Handler.Warp.HashMap as M
17−import System.PosixCompat.Files
16+import Network.Wai.Handler.Warp.Imports
18
17
19----------------------------------------------------------------
18----------------------------------------------------------------
20
19
21−type Hash = Int
22−
23-- | File information.
20-- | File information.
24data FileInfo = FileInfo {
21data FileInfo = FileInfo {
25 fileInfoName :: !FilePath
22 fileInfoName :: !FilePath
@@ -29,8 +26,8 @@ data FileInfo = FileInfo {
29 } deriving (Eq, Show)
26 } deriving (Eq, Show)
30
27
31data Entry = Negative | Positive FileInfo
28data Entry = Negative | Positive FileInfo
32−type Cache = HashMap FilePath Entry
29+type Cache = HashMap Entry
33−type FileInfoCache = Reaper Cache (Int,FilePath,Entry)
30+type FileInfoCache = Reaper Cache (FilePath,Entry)
34
31
35----------------------------------------------------------------
32----------------------------------------------------------------
36
33
@@ -54,29 +51,29 @@ getInfo path = do
54 else
51 else
55 throwIO (userError "FileInfoCache:getInfo")
52 throwIO (userError "FileInfoCache:getInfo")
56
53
57−getInfoNaive :: Hash -> FilePath -> IO FileInfo
54+getInfoNaive :: FilePath -> IO FileInfo
58−getInfoNaive _ = getInfo
55+getInfoNaive = getInfo
59
56
60----------------------------------------------------------------
57----------------------------------------------------------------
61
58
62−getAndRegisterInfo :: FileInfoCache -> Hash -> FilePath -> IO FileInfo
59+getAndRegisterInfo :: FileInfoCache -> FilePath -> IO FileInfo
63−getAndRegisterInfo reaper@Reaper{..} h path = do
60+getAndRegisterInfo reaper@Reaper{..} path = do
64 cache <- reaperRead
61 cache <- reaperRead
65− case M.lookup h path cache of
62+ case M.lookup path cache of
66 Just Negative -> throwIO (userError "FileInfoCache:getAndRegisterInfo")
63 Just Negative -> throwIO (userError "FileInfoCache:getAndRegisterInfo")
67 Just (Positive x) -> return x
64 Just (Positive x) -> return x
68− Nothing -> positive reaper h path
65+ Nothing -> positive reaper path
69− `E.onException` negative reaper h path
66+ `E.onException` negative reaper path
70
67
71−positive :: FileInfoCache -> Hash -> FilePath -> IO FileInfo
68+positive :: FileInfoCache -> FilePath -> IO FileInfo
72−positive Reaper{..} h path = do
69+positive Reaper{..} path = do
73 info <- getInfo path
70 info <- getInfo path
74− reaperAdd (h, path, Positive info)
71+ reaperAdd (path, Positive info)
75 return info
72 return info
76
73
77−negative :: FileInfoCache -> Hash -> FilePath -> IO FileInfo
74+negative :: FileInfoCache -> FilePath -> IO FileInfo
78−negative Reaper{..} h path = do
75+negative Reaper{..} path = do
79− reaperAdd (h, path,Negative)
76+ reaperAdd (path, Negative)
80 throwIO (userError "FileInfoCache:negative")
77 throwIO (userError "FileInfoCache:negative")
81
78
82----------------------------------------------------------------
79----------------------------------------------------------------
@@ -85,22 +82,22 @@ negative Reaper{..} h path = do
85-- and executing the action in the second argument.
82-- and executing the action in the second argument.
86-- The first argument is a cache duration in second.
83-- The first argument is a cache duration in second.
87withFileInfoCache :: Int
84withFileInfoCache :: Int
88− -> ((Hash -> FilePath -> IO FileInfo) -> IO a)
85+ -> ((FilePath -> IO FileInfo) -> IO a)
89 -> IO a
86 -> IO a
90withFileInfoCache 0 action = action getInfoNaive
87withFileInfoCache 0 action = action getInfoNaive
91withFileInfoCache duration action =
88withFileInfoCache duration action =
92 E.bracket (initialize duration)
89 E.bracket (initialize duration)
93 terminate
90 terminate
94− (\r -> action (getAndRegisterInfo r))
91+ (action . getAndRegisterInfo)
95
92
96−initialize :: Hash -> IO FileInfoCache
93+initialize :: Int -> IO FileInfoCache
97initialize duration = mkReaper settings
94initialize duration = mkReaper settings
98 where
95 where
99 settings = defaultReaperSettings {
96 settings = defaultReaperSettings {
100 reaperAction = override
97 reaperAction = override
101− , reaperDelay = duration * 1000000
98+ , reaperDelay = duration
102− , reaperCons = \(h,k,v) -> M.insert h k v
99+ , reaperCons = \(path,v) -> M.insert path v
103− , reaperNull = M.null
100+ , reaperNull = M.isEmpty
104 , reaperEmpty = M.empty
101 , reaperEmpty = M.empty
105 }
102 }
106
103
warp/Network/Wai/Handler/Warp/HTTP2.hs+72−56
@@ -1,69 +1,85 @@
1−{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE RecordWildCards #-}
1{-# LANGUAGE RecordWildCards #-}
2+{-# LANGUAGE BangPatterns #-}
3+{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PatternGuards #-}
5+{-# LANGUAGE ScopedTypeVariables #-}
3
6
4−module Network.Wai.Handler.Warp.HTTP2 (isHTTP2, http2) where
7+module Network.Wai.Handler.Warp.HTTP2 (http2) where
5
8
6−import Control.Concurrent (forkIO, killThread)
9+import qualified Data.IORef as I
7import qualified Control.Exception as E
10import qualified Control.Exception as E
8−import Control.Monad (when, unless, replicateM_)
9−import Data.ByteString (ByteString)
10−import Network.HTTP2
11+import qualified Network.HTTP2.Server as H2
11import Network.Socket (SockAddr)
12import Network.Socket (SockAddr)
12import Network.Wai
13import Network.Wai
13−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
14+import Network.Wai.Internal (ResponseReceived(..))
15+import qualified System.TimeManager as T
16+
14−import Network.Wai.Handler.Warp.HTTP2.Manager
17+import Network.Wai.Handler.Warp.HTTP2.File
15−import Network.Wai.Handler.Warp.HTTP2.Receiver
18+import Network.Wai.Handler.Warp.HTTP2.PushPromise
16import Network.Wai.Handler.Warp.HTTP2.Request
19import Network.Wai.Handler.Warp.HTTP2.Request
17−import Network.Wai.Handler.Warp.HTTP2.Sender
20+import Network.Wai.Handler.Warp.HTTP2.Response
18−import Network.Wai.Handler.Warp.HTTP2.Types
21+import Network.Wai.Handler.Warp.Imports
19−import Network.Wai.Handler.Warp.HTTP2.Worker
20−import qualified Network.Wai.Handler.Warp.Settings as S (Settings)
22+import qualified Network.Wai.Handler.Warp.Settings as S
21import Network.Wai.Handler.Warp.Types
23import Network.Wai.Handler.Warp.Types
22
24
23----------------------------------------------------------------
25----------------------------------------------------------------
24
26
25−http2 :: Connection -> InternalInfo1 -> SockAddr -> Transport -> S.Settings -> (BufSize -> IO ByteString) -> Application -> IO ()
27+http2 :: Connection -> Transport -> InternalInfo -> SockAddr -> S.Settings -> (BufSize -> IO ByteString) -> (ByteString -> IO ()) -> Application -> IO ()
26−http2 conn ii1 addr transport settings readN app = do
28+http2 conn transport ii addr settings readN send app =
27− checkTLS
29+ H2.run conf http2server
28− ok <- checkPreface
29− when ok $ do
30− ctx <- newContext
31− -- Workers, worker manager and timer manager
32− mgr <- start settings
33− let responder = response settings ctx mgr
34− action = worker ctx settings app responder
35− setAction mgr action
36− -- The number of workers is 3.
37− -- This was carefully chosen based on a lot of benchmarks.
38− -- If it is 1, we cannot avoid head-of-line blocking.
39− -- If it is large, huge memory is consumed and many
40− -- context switches happen.
41− replicateM_ 3 $ spawnAction mgr
42− -- Receiver
43− let mkreq = mkRequest ii1 settings addr
44− tid <- forkIO $ frameReceiver ctx mkreq readN
45− -- Sender
46− -- frameSender is the main thread because it ensures to send
47− -- a goway frame.
48− frameSender ctx conn settings mgr `E.finally` do
49− clearContext ctx
50− stop mgr
51− killThread tid
52 where
30 where
53− checkTLS = case transport of
31+ conf = H2.Config {
54− TCP -> return () -- direct
32+ confWriteBuffer = connWriteBuffer conn
55− tls -> unless (tls12orLater tls) $ goaway conn InadequateSecurity "Weak TLS"
33+ , confBufferSize = connBufferSize conn
56− tls12orLater tls = tlsMajorVersion tls == 3 && tlsMinorVersion tls >= 3
34+ , confSendAll = send
57− checkPreface = do
35+ , confReadN = readN
58− preface <- readN connectionPrefaceLength
36+ , confPositionReadMaker = pReadMaker ii
59− if connectionPreface /= preface then do
37+ }
60− goaway conn ProtocolError "Preface mismatch"
61− return False
62− else
63− return True
64
38
65−-- connClose must not be called here since Run:fork calls it
39+ http2server h2req aux response = do
66−goaway :: Connection -> ErrorCodeId -> ByteString -> IO ()
40+ req <- toWAIRequest h2req aux
67−goaway Connection{..} etype debugmsg = connSendAll bytestream
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
68− where
74+ where
69− bytestream = goawayFrame 0 etype debugmsg
75+ !logger = S.settingsLogger settings
76+ !st = H2.responseStatus h2rsp
77+ !msiz = fromIntegral <$> H2.responseBodySize h2rsp
78+
79+ logPushPromise req pp = logger req path siz
80+ where
81+ !logger = S.settingsServerPushLogger settings
82+ !path = H2.promiseRequestPath pp
83+ !siz = case H2.responseBodySize $ H2.promiseResponse pp of
84+ Nothing -> 0
85+ Just s -> fromIntegral s
warp/Network/Wai/Handler/Warp/HTTP2/EncodeFrame.hsdeleted−35
@@ -1,35 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−
3−module Network.Wai.Handler.Warp.HTTP2.EncodeFrame where
4−
5−import Data.ByteString (ByteString)
6−import Network.HTTP2
7−
8−----------------------------------------------------------------
9−
10−goawayFrame :: StreamId -> ErrorCodeId -> ByteString -> ByteString
11−goawayFrame sid etype debugmsg = encodeFrame einfo frame
12− where
13− einfo = encodeInfo id 0
14− frame = GoAwayFrame sid etype debugmsg
15−
16−resetFrame :: ErrorCodeId -> StreamId -> ByteString
17−resetFrame etype sid = encodeFrame einfo frame
18− where
19− einfo = encodeInfo id sid
20− frame = RSTStreamFrame etype
21−
22−settingsFrame :: (FrameFlags -> FrameFlags) -> SettingsList -> ByteString
23−settingsFrame func alist = encodeFrame einfo $ SettingsFrame alist
24− where
25− einfo = encodeInfo func 0
26−
27−pingFrame :: ByteString -> ByteString
28−pingFrame bs = encodeFrame einfo $ PingFrame bs
29− where
30− einfo = encodeInfo setAck 0
31−
32−windowUpdateFrame :: StreamId -> WindowSize -> ByteString
33−windowUpdateFrame sid winsiz = encodeFrame einfo $ WindowUpdateFrame winsiz
34− where
35− einfo = encodeInfo id sid
warp/Network/Wai/Handler/Warp/HTTP2/File.hsnew file+30
@@ -0,0 +1,30 @@
1+{-# LANGUAGE CPP #-}
2+
3+module Network.Wai.Handler.Warp.HTTP2.File where
4+
5+import Network.HTTP2.Server
6+
7+import Network.Wai.Handler.Warp.Types
8+
9+#ifdef WINDOWS
10+pReadMaker :: InternalInfo -> PositionReadMaker
11+pReadMaker _ = defaultPositionReadMaker
12+#else
13+import Network.Wai.Handler.Warp.FdCache
14+import Network.Wai.Handler.Warp.SendFile (positionRead)
15+
16+pReadMaker :: InternalInfo -> PositionReadMaker
17+pReadMaker ii path = do
18+ (mfd, refresh) <- getFd ii path
19+ case mfd of
20+ Just fd -> return (pread fd, Refresher refresh)
21+ Nothing -> do
22+ fd <- openFile path
23+ return (pread fd, Closer $ closeFile fd)
24+ where
25+ pread :: Fd -> PositionRead
26+ pread fd off bytes buf = fromIntegral <$> positionRead fd buf bytes' off'
27+ where
28+ bytes' = fromIntegral bytes
29+ off' = fromIntegral off
30+#endif
warp/Network/Wai/Handler/Warp/HTTP2/HPACK.hsdeleted−52
@@ -1,52 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE NamedFieldPuns, RecordWildCards #-}
3−
4−module Network.Wai.Handler.Warp.HTTP2.HPACK where
5−
6−import Control.Arrow (first)
7−import qualified Control.Exception as E
8−import qualified Data.ByteString.Char8 as B8
9−import Data.CaseInsensitive (foldedCase)
10−import Network.HPACK hiding (Buffer)
11−import qualified Network.HTTP.Types as H
12−import Network.HTTP2
13−import Network.Wai.Handler.Warp.HTTP2.Types
14−import Network.Wai.Handler.Warp.Header
15−import Network.Wai.Handler.Warp.Response
16−import qualified Network.Wai.Handler.Warp.Settings as S
17−import Network.Wai.Handler.Warp.Types
18−
19−-- $setup
20−-- >>> :set -XOverloadedStrings
21−
22−strategy :: EncodeStrategy
23−strategy = EncodeStrategy { compressionAlgo = Linear, useHuffman = False }
24−
25−-- Set-Cookie: contains only one cookie value.
26−-- So, we don't need to split it.
27−hpackEncodeHeader :: Context -> Buffer -> BufSize
28− -> InternalInfo -> S.Settings
29− -> H.Status -> H.ResponseHeaders
30− -> IO (HeaderList, Int)
31−hpackEncodeHeader Context{..} buf siz ii settings s hdr0 = do
32− hdr1 <- addServerAndDate hdr0
33− let hs = (":status", status) : map (first foldedCase) hdr1
34− encodeHeaderBuffer buf siz strategy True encodeDynamicTable hs
35− where
36− status = B8.pack $ show $ H.statusCode s
37− getdate = getDate ii
38− rspidxhdr = indexResponseHeader hdr0
39− defServer = S.settingsServerName settings
40− addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
41−
42−hpackEncodeHeaderLoop :: Context -> Buffer -> BufSize -> HeaderList
43− -> IO (HeaderList, Int)
44−hpackEncodeHeaderLoop Context{..} buf siz hs =
45− encodeHeaderBuffer buf siz strategy False encodeDynamicTable hs
46−
47−----------------------------------------------------------------
48−
49−hpackDecodeHeader :: HeaderBlockFragment -> Context -> IO HeaderList
50−hpackDecodeHeader hdrblk Context{..} =
51− decodeHeader decodeDynamicTable hdrblk `E.catch` \(E.SomeException _) ->
52− E.throwIO $ ConnectionError CompressionError "cannot decompress the header"
warp/Network/Wai/Handler/Warp/HTTP2/Manager.hsdeleted−97
@@ -1,97 +0,0 @@
1−{-# LANGUAGE CPP, BangPatterns #-}
2−
3−-- | A thread pool manager.
4−-- The manager has responsibility to spawn and kill
5−-- worker threads.
6−module Network.Wai.Handler.Warp.HTTP2.Manager (
7− Manager
8− , start
9− , setAction
10− , stop
11− , spawnAction
12− , addMyId
13− , deleteMyId
14− ) where
15−
16−#if __GLASGOW_HASKELL__ < 709
17−import Control.Applicative
18−#endif
19−import Control.Concurrent
20−import Control.Concurrent.STM
21−import Control.Monad (void)
22−import Data.Set (Set)
23−import qualified Data.Set as Set
24−import Data.Foldable
25−import Network.Wai.Handler.Warp.IORef
26−import Network.Wai.Handler.Warp.Settings
27−import qualified Network.Wai.Handler.Warp.Timeout as T
28−
29−----------------------------------------------------------------
30−
31−type Action = T.Manager -> IO ()
32−
33−data Command = Stop | Spawn | Add ThreadId | Delete ThreadId
34−
35−data Manager = Manager (TQueue Command) (IORef Action)
36−
37−-- | Starting a thread pool manager.
38−-- Its action is initially set to 'return ()' and should be set
39−-- by 'setAction'. This allows that the action can include
40−-- the manager itself.
41−start :: Settings -> IO Manager
42−start set = do
43− q <- newTQueueIO
44− ref <- newIORef (\_ -> return ())
45− timmgr <- T.initialize $ settingsTimeout set * 1000000
46− void $ forkIO $ go q Set.empty ref timmgr
47− return $ Manager q ref
48− where
49− go q !tset0 ref timmgr = do
50− x <- atomically $ readTQueue q
51− case x of
52− Stop -> kill tset0 >> T.killManager timmgr
53− Spawn -> next tset0
54− Add newtid -> let !tset = add newtid tset0
55− in go q tset ref timmgr
56− Delete oldtid -> let !tset = del oldtid tset0
57− in go q tset ref timmgr
58− where
59− next tset = do
60− action <- readIORef ref
61− newtid <- forkIO (action timmgr)
62− let !tset' = add newtid tset
63− go q tset' ref timmgr
64−
65−setAction :: Manager -> Action -> IO ()
66−setAction (Manager _ ref) action = writeIORef ref action
67−
68−stop :: Manager -> IO ()
69−stop (Manager q _) = atomically $ writeTQueue q Stop
70−
71−spawnAction :: Manager -> IO ()
72−spawnAction (Manager q _) = atomically $ writeTQueue q Spawn
73−
74−addMyId :: Manager -> IO ()
75−addMyId (Manager q _) = do
76− tid <- myThreadId
77− atomically $ writeTQueue q $ Add tid
78−
79−deleteMyId :: Manager -> IO ()
80−deleteMyId (Manager q _) = do
81− tid <- myThreadId
82− atomically $ writeTQueue q $ Delete tid
83−
84−----------------------------------------------------------------
85−
86−add :: ThreadId -> Set ThreadId -> Set ThreadId
87−add tid set = set'
88− where
89− !set' = Set.insert tid set
90−
91−del :: ThreadId -> Set ThreadId -> Set ThreadId
92−del tid set = set'
93− where
94− !set' = Set.delete tid set
95−
96−kill :: Set ThreadId -> IO ()
97−kill set = traverse_ killThread set
warp/Network/Wai/Handler/Warp/HTTP2/PushPromise.hsnew file+36
@@ -0,0 +1,36 @@
1+{-# LANGUAGE BangPatterns #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE ScopedTypeVariables #-}
4+
5+module Network.Wai.Handler.Warp.HTTP2.PushPromise where
6+
7+import qualified Control.Exception as E
8+import qualified Network.HTTP.Types as H
9+import qualified Network.HTTP2.Server as H2
10+
11+import Network.Wai
12+import Network.Wai.Handler.Warp.FileInfoCache
13+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
14+import Network.Wai.Handler.Warp.HTTP2.Types
15+import Network.Wai.Handler.Warp.Imports
16+import Network.Wai.Handler.Warp.Types
17+
18+fromPushPromises :: InternalInfo -> Request -> IO [H2.PushPromise]
19+fromPushPromises ii req = do
20+ mh2data <- getHTTP2Data req
21+ let pp = case mh2data of
22+ Nothing -> []
23+ Just h2data -> http2dataPushPromise h2data
24+ catMaybes <$> mapM (fromPushPromise ii) pp
25+
26+fromPushPromise :: InternalInfo -> PushPromise -> IO (Maybe H2.PushPromise)
27+fromPushPromise ii (PushPromise path file rsphdr w) = do
28+ efinfo <- E.try $ getFileInfo ii file
29+ case efinfo of
30+ Left (_ex :: E.IOException) -> return Nothing
31+ Right finfo -> do
32+ let !siz = fromIntegral $ fileInfoSize finfo
33+ !fileSpec = H2.FileSpec file 0 siz
34+ !rsp = H2.responseFile H.ok200 rsphdr fileSpec
35+ !pp = H2.pushPromise path rsp w
36+ return $ Just pp
warp/Network/Wai/Handler/Warp/HTTP2/Receiver.hsdeleted−347
@@ -1,347 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE NamedFieldPuns #-}
3−{-# LANGUAGE BangPatterns #-}
4−{-# LANGUAGE CPP #-}
5−{-# LANGUAGE PatternGuards #-}
6−
7−module Network.Wai.Handler.Warp.HTTP2.Receiver (frameReceiver) where
8−
9−#if __GLASGOW_HASKELL__ < 709
10−import Control.Applicative
11−#endif
12−import Control.Concurrent
13−import Control.Concurrent.STM
14−import qualified Control.Exception as E
15−import Control.Monad (when, unless, void)
16−import Data.ByteString (ByteString)
17−import qualified Data.ByteString as BS
18−import Data.Maybe (isJust)
19−import Network.HTTP2
20−import Network.HTTP2.Priority (toPrecedence, delete, prepare)
21−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
22−import Network.Wai.Handler.Warp.HTTP2.HPACK
23−import Network.Wai.Handler.Warp.HTTP2.Request
24−import Network.Wai.Handler.Warp.HTTP2.Types
25−import Network.Wai.Handler.Warp.IORef
26−import Network.Wai.Handler.Warp.Types
27−
28−----------------------------------------------------------------
29−
30−frameReceiver :: Context -> MkReq -> (BufSize -> IO ByteString) -> IO ()
31−frameReceiver ctx mkreq recvN = loop 0 `E.catch` sendGoaway
32− where
33− Context{ http2settings
34− , streamTable
35− , concurrency
36− , continued
37− , currentStreamId
38− , inputQ
39− , controlQ
40− } = ctx
41− sendGoaway e
42− | Just (ConnectionError err msg) <- E.fromException e = do
43− csid <- readIORef currentStreamId
44− let !frame = goawayFrame csid err msg
45− enqueueControl controlQ $ CGoaway frame
46− | otherwise = return ()
47−
48− sendReset err sid = do
49− let !frame = resetFrame err sid
50− enqueueControl controlQ $ CFrame frame
51−
52− loop :: Int -> IO ()
53− loop !n
54− | n == 6 = do
55− yield
56− loop 0
57− | otherwise = do
58− hd <- recvN frameHeaderLength
59− if BS.null hd then
60− enqueueControl controlQ CFinish
61− else do
62− cont <- processStreamGuardingError $ decodeFrameHeader hd
63− when cont $ loop (n + 1)
64−
65− processStreamGuardingError (_, FrameHeader{streamId})
66− | isResponse streamId = E.throwIO $ ConnectionError ProtocolError "stream id should be odd"
67− processStreamGuardingError (FrameUnknown _, FrameHeader{payloadLength}) = do
68− mx <- readIORef continued
69− case mx of
70− Nothing -> do
71− -- ignoring unknown frame
72− consume payloadLength
73− return True
74− Just _ -> E.throwIO $ ConnectionError ProtocolError "unknown frame"
75− processStreamGuardingError (FramePushPromise, _) =
76− E.throwIO $ ConnectionError ProtocolError "push promise is not allowed"
77− processStreamGuardingError typhdr@(ftyp, header@FrameHeader{payloadLength}) = do
78− settings <- readIORef http2settings
79− case checkFrameHeader settings typhdr of
80− Left h2err -> case h2err of
81− StreamError err sid -> do
82− sendReset err sid
83− consume payloadLength
84− return True
85− connErr -> E.throwIO connErr
86− Right _ -> do
87− ex <- E.try $ controlOrStream ftyp header
88− case ex of
89− Left (StreamError err sid) -> do
90− sendReset err sid
91− return True
92− Left connErr -> E.throw connErr
93− Right cont -> return cont
94−
95− controlOrStream ftyp header@FrameHeader{streamId, payloadLength}
96− | isControl streamId = do
97− pl <- recvN payloadLength
98− control ftyp header pl ctx
99− | otherwise = do
100− checkContinued
101− !strm@Stream{streamState,streamContentLength,streamPrecedence} <- getStream
102− pl <- recvN payloadLength
103− state <- readIORef streamState
104− state' <- stream ftyp header pl ctx state strm
105− case state' of
106− Open (NoBody hdr pri) -> do
107− resetContinued
108− case validateHeaders hdr of
109− Just vh -> do
110− when (isJust (vhCL vh) && vhCL vh /= Just 0) $
111− E.throwIO $ StreamError ProtocolError streamId
112− writeIORef streamPrecedence $ toPrecedence pri
113− writeIORef streamState HalfClosed
114− let (!req, !ii) = mkreq vh (return "")
115− atomically $ writeTQueue inputQ $ Input strm req ii
116− Nothing -> E.throwIO $ StreamError ProtocolError streamId
117− Open (HasBody hdr pri) -> do
118− resetContinued
119− case validateHeaders hdr of
120− Just vh -> do
121− q <- newTQueueIO
122− writeIORef streamPrecedence $ toPrecedence pri
123− writeIORef streamState (Open (Body q))
124− writeIORef streamContentLength $ vhCL vh
125− readQ <- newReadBody q
126− bodySource <- mkSource readQ
127− let (!req, !ii) = mkreq vh (readSource bodySource)
128− atomically $ writeTQueue inputQ $ Input strm req ii
129− Nothing -> E.throwIO $ StreamError ProtocolError streamId
130− s@(Open Continued{}) -> do
131− setContinued
132− writeIORef streamState s
133− s -> do -- Idle, Open Body, HalfClosed, Closed
134− resetContinued
135− writeIORef streamState s
136− return True
137− where
138− setContinued = writeIORef continued (Just streamId)
139− resetContinued = writeIORef continued Nothing
140− checkContinued = do
141− mx <- readIORef continued
142− case mx of
143− Nothing -> return ()
144− Just sid
145− | sid == streamId && ftyp == FrameContinuation -> return ()
146− | otherwise -> E.throwIO $ ConnectionError ProtocolError "continuation frame must follow"
147− getStream = do
148− mstrm0 <- search streamTable streamId
149− case mstrm0 of
150− Just strm0 -> do
151− when (ftyp == FrameHeaders) $ do
152− st <- readIORef $ streamState strm0
153− when (isHalfClosed st) $ E.throwIO $ ConnectionError StreamClosed "header must not be sent to half closed"
154− return strm0
155− Nothing -> do
156− -- checkme
157− when (ftyp `notElem` [FrameHeaders,FramePriority]) $
158− E.throwIO $ ConnectionError ProtocolError "this frame is not allowed in an idel stream"
159− csid <- readIORef currentStreamId
160− when (streamId <= csid) $
161− E.throwIO $ ConnectionError ProtocolError "stream identifier must not decrease"
162− when (ftyp == FrameHeaders) $ do
163− writeIORef currentStreamId streamId
164− cnt <- readIORef concurrency
165− when (cnt >= recommendedConcurrency) $
166− E.throwIO $ StreamError RefusedStream streamId
167− ws <- initialWindowSize <$> readIORef http2settings
168− newstrm <- newStream streamId (fromIntegral ws)
169− when (ftyp == FrameHeaders) $ opened ctx newstrm
170− insert streamTable streamId newstrm
171− return newstrm
172−
173− consume = void . recvN
174−
175−initialFrame :: ByteString
176−initialFrame = settingsFrame id [(SettingsMaxConcurrentStreams,recommendedConcurrency)]
177−
178−----------------------------------------------------------------
179−
180−control :: FrameTypeId -> FrameHeader -> ByteString -> Context -> IO Bool
181−control FrameSettings header@FrameHeader{flags} bs Context{http2settings, controlQ,firstSettings} = do
182− SettingsFrame alist <- guardIt $ decodeSettingsFrame header bs
183− case checkSettingsList alist of
184− Just x -> E.throwIO x
185− Nothing -> return ()
186− unless (testAck flags) $ do
187− modifyIORef' http2settings $ \old -> updateSettings old alist
188− let !frame = settingsFrame setAck []
189− sent <- readIORef firstSettings
190− let !frame' = if sent then frame else BS.append initialFrame frame
191− unless sent $ writeIORef firstSettings True
192− enqueueControl controlQ $ CSettings frame' alist
193− return True
194−
195−control FramePing FrameHeader{flags} bs Context{controlQ} =
196− if testAck flags then
197− E.throwIO $ ConnectionError ProtocolError "the ack flag of this ping frame must not be set"
198− else do
199− let !frame = pingFrame bs
200− enqueueControl controlQ $ CFrame frame
201− return True
202−
203−control FrameGoAway _ _ Context{controlQ} = do
204− enqueueControl controlQ CFinish
205− return False
206−
207−control FrameWindowUpdate header bs Context{connectionWindow} = do
208− WindowUpdateFrame n <- guardIt $ decodeWindowUpdateFrame header bs
209− !w <- (n +) <$> atomically (readTVar connectionWindow)
210− when (isWindowOverflow w) $ E.throwIO $ ConnectionError FlowControlError "control window should be less than 2^31"
211− atomically $ writeTVar connectionWindow w
212− return True
213−
214−control _ _ _ _ =
215− -- must not reach here
216− return False
217−
218−----------------------------------------------------------------
219−
220−guardIt :: Either HTTP2Error a -> IO a
221−guardIt x = case x of
222− Left err -> E.throwIO err
223− Right frame -> return frame
224−
225−checkPriority :: Priority -> StreamId -> IO ()
226−checkPriority p me
227− | dep == me = E.throwIO $ StreamError ProtocolError me
228− | otherwise = return ()
229− where
230− dep = streamDependency p
231−
232−stream :: FrameTypeId -> FrameHeader -> ByteString -> Context -> StreamState -> Stream -> IO StreamState
233−stream FrameHeaders header@FrameHeader{flags} bs ctx (Open JustOpened) Stream{streamNumber} = do
234− HeadersFrame mp frag <- guardIt $ decodeHeadersFrame header bs
235− pri <- case mp of
236− Nothing -> return defaultPriority
237− Just p -> do
238− checkPriority p streamNumber
239− return p
240− let !endOfStream = testEndStream flags
241− !endOfHeader = testEndHeader flags
242− if endOfHeader then do
243− hdr <- hpackDecodeHeader frag ctx
244− return $ if endOfStream then
245− Open (NoBody hdr pri)
246− else
247− Open (HasBody hdr pri)
248− else do
249− let !siz = BS.length frag
250− return $ Open $ Continued [frag] siz 1 endOfStream pri
251−
252−stream FrameHeaders header@FrameHeader{flags} bs _ (Open (Body q)) _ = do
253− -- trailer is not supported.
254− -- let's read and ignore it.
255− HeadersFrame _ _ <- guardIt $ decodeHeadersFrame header bs
256− let !endOfStream = testEndStream flags
257− if endOfStream then do
258− atomically $ writeTQueue q ""
259− return HalfClosed
260− else
261− -- we don't support continuation here.
262− E.throwIO $ ConnectionError ProtocolError "continuation in trailer is not supported"
263−
264−stream FrameData
265− header@FrameHeader{flags,payloadLength,streamId}
266− bs
267− Context{controlQ} s@(Open (Body q))
268− Stream{streamNumber,streamBodyLength,streamContentLength} = do
269− DataFrame body <- guardIt $ decodeDataFrame header bs
270− let !endOfStream = testEndStream flags
271− len0 <- readIORef streamBodyLength
272− let !len = len0 + payloadLength
273− writeIORef streamBodyLength len
274− when (payloadLength /= 0) $ do
275− let !frame1 = windowUpdateFrame 0 payloadLength
276− !frame2 = windowUpdateFrame streamNumber payloadLength
277− !frame = frame1 `BS.append` frame2
278− enqueueControl controlQ $ CFrame frame
279− atomically $ writeTQueue q body
280− if endOfStream then do
281− mcl <- readIORef streamContentLength
282− case mcl of
283− Nothing -> return ()
284− Just cl -> when (cl /= len) $ E.throwIO $ StreamError ProtocolError streamId
285− atomically $ writeTQueue q ""
286− return HalfClosed
287− else
288− return s
289−
290−stream FrameContinuation FrameHeader{flags} frag ctx (Open (Continued rfrags siz n endOfStream pri)) _ = do
291− let !endOfHeader = testEndHeader flags
292− !rfrags' = frag : rfrags
293− !siz' = siz + BS.length frag
294− !n' = n + 1
295− when (siz' > 51200) $ -- fixme: hard coding: 50K
296− E.throwIO $ ConnectionError EnhanceYourCalm "Header is too big"
297− when (n' > 10) $ -- fixme: hard coding
298− E.throwIO $ ConnectionError EnhanceYourCalm "Header is too fragmented"
299− if endOfHeader then do
300− let !hdrblk = BS.concat $ reverse rfrags'
301− hdr <- hpackDecodeHeader hdrblk ctx
302− return $ if endOfStream then
303− Open (NoBody hdr pri)
304− else
305− Open (HasBody hdr pri)
306− else
307− return $ Open $ Continued rfrags' siz' n' endOfStream pri
308−
309−stream FrameWindowUpdate header@FrameHeader{streamId} bs _ s Stream{streamWindow} = do
310− WindowUpdateFrame n <- guardIt $ decodeWindowUpdateFrame header bs
311− !w <- (n +) <$> atomically (readTVar streamWindow)
312− when (isWindowOverflow w) $
313− E.throwIO $ StreamError FlowControlError streamId
314− atomically $ writeTVar streamWindow w
315− return s
316−
317−stream FrameRSTStream header bs ctx _ strm = do
318− RSTStreamFrame e <- guardIt $ decoderstStreamFrame header bs
319− let !cc = Reset e
320− closed ctx strm cc
321− return $ Closed cc -- will be written to streamState again
322−
323−stream FramePriority header bs Context{outputQ,priorityTreeSize} s Stream{streamNumber,streamPrecedence} = do
324− PriorityFrame newpri <- guardIt $ decodePriorityFrame header bs
325− checkPriority newpri streamNumber
326− oldpre <- readIORef streamPrecedence
327− let !newpre = toPrecedence newpri
328− writeIORef streamPrecedence newpre
329− if isIdle s then do
330− n <- atomicModifyIORef' priorityTreeSize (\x -> (x+1,x+1))
331− -- fixme hard coding
332− when (n >= 20) $ E.throwIO $ ConnectionError EnhanceYourCalm "too many idle priority frames"
333− prepare outputQ streamNumber newpri
334− else do
335− mx <- delete outputQ streamNumber oldpre
336− case mx of
337− Nothing -> return ()
338− Just out -> enqueueOutput outputQ out
339− return s
340−
341−-- this ordering is important
342−stream FrameContinuation _ _ _ _ _ = E.throwIO $ ConnectionError ProtocolError "continue frame cannot come here"
343−stream _ _ _ _ (Open Continued{}) _ = E.throwIO $ ConnectionError ProtocolError "an illegal frame follows header/continuation frames"
344−-- Ignore frames to streams we have just reset, per section 5.1.
345−stream _ _ _ _ st@(Closed (ResetByMe _)) _ = return st
346−stream FrameData FrameHeader{streamId} _ _ _ _ = E.throwIO $ StreamError StreamClosed streamId
347−stream _ FrameHeader{streamId} _ _ _ _ = E.throwIO $ StreamError ProtocolError streamId
warp/Network/Wai/Handler/Warp/HTTP2/Request.hs+93−155
@@ -1,188 +1,126 @@
1−{-# LANGUAGE OverloadedStrings, CPP #-}
2{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
3
2
4module Network.Wai.Handler.Warp.HTTP2.Request (
3module Network.Wai.Handler.Warp.HTTP2.Request (
5− mkRequest
4+ toRequest
6− , newReadBody
5+ , getHTTP2Data
7− , MkReq
6+ , setHTTP2Data
8− , ValidHeaders(..)
7+ , modifyHTTP2Data
9− , validateHeaders
10 ) where
8 ) where
11
9
12−#if __GLASGOW_HASKELL__ < 709
13−import Control.Applicative ((<$>))
10+import Control.Arrow (first)
14−#endif
15−import Control.Concurrent.STM
16−import Control.Monad (when)
17−import Data.ByteString (ByteString)
18−import qualified Data.ByteString as BS
19−import qualified Data.ByteString.Char8 as B8
11+import qualified Data.ByteString.Char8 as C8
20−import Data.CaseInsensitive (mk)
21−import Data.IORef (IORef, readIORef, newIORef, writeIORef)
12+import Data.IORef
22−import Data.Maybe (isJust)
23import qualified Data.Vault.Lazy as Vault
13import qualified Data.Vault.Lazy as Vault
24−#if __GLASGOW_HASKELL__ < 709
25−import Data.Monoid (mempty)
26−#endif
27−import Data.Word8 (isUpper,_colon)
28import Network.HPACK
14import Network.HPACK
29−import Network.HTTP.Types (RequestHeaders)
15+import Network.HPACK.Token
30import qualified Network.HTTP.Types as H
16import qualified Network.HTTP.Types as H
31import Network.Socket (SockAddr)
17import Network.Socket (SockAddr)
32import Network.Wai
18import Network.Wai
33−import Network.Wai.Handler.Warp.HTTP2.Types
34−import Network.Wai.Handler.Warp.HashMap (hashByteString)
35−import Network.Wai.Handler.Warp.ReadInt
36−import Network.Wai.Handler.Warp.Request (pauseTimeoutKey, getFileInfoKey)
37−import Network.Wai.Handler.Warp.Types
38import Network.Wai.Internal (Request(..))
19import 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)
39import qualified Network.Wai.Handler.Warp.Settings as S (Settings, settingsNoParsePath)
26import qualified Network.Wai.Handler.Warp.Settings as S (Settings, settingsNoParsePath)
40−import qualified Network.Wai.Handler.Warp.Timeout as Timeout
27+import Network.Wai.Handler.Warp.Types
41
28
42−data ValidHeaders = ValidHeaders {
29+type ToReq = (TokenHeaderList,ValueTable) -> Maybe Int -> IO ByteString -> T.Handle -> Transport -> IO Request
43− vhMethod :: !ByteString
44− , vhPath :: !ByteString
45− , vhAuth :: !(Maybe ByteString)
46− , vhRange :: !(Maybe ByteString)
47− , vhReferer :: !(Maybe ByteString)
48− , vhUA :: !(Maybe ByteString)
49− , vhCL :: !(Maybe Int)
50− , vhHeader :: !RequestHeaders
51− } deriving Show
52
30
53−type MkReq = ValidHeaders -> IO ByteString -> (Request,InternalInfo)
31+----------------------------------------------------------------
54
32
55−mkRequest :: InternalInfo1 -> S.Settings -> SockAddr -> MkReq
33+toRequest :: InternalInfo -> S.Settings -> SockAddr -> ToReq
56−mkRequest ii1 settings addr (ValidHeaders m p ma mrng mrr mua _ hdr) body =
34+toRequest ii settings addr ht bodylen body th transport = do
57− (req,ii)
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
58 where
42 where
59− (unparsedPath,query) = B8.break (=='?') p
60− !path = H.extractPath unparsedPath
61− !rawPath = if S.settingsNoParsePath settings then unparsedPath else path
62− !h = hashByteString rawPath
63 !req = Request {
43 !req = Request {
64− requestMethod = m
44+ requestMethod = colonMethod
65− , httpVersion = http2ver
45+ , httpVersion = H.http20
66 , rawPathInfo = rawPath
46 , rawPathInfo = rawPath
67 , pathInfo = H.decodePathSegments path
47 , pathInfo = H.decodePathSegments path
68 , rawQueryString = query
48 , rawQueryString = query
69 , queryString = H.parseQuery query
49 , queryString = H.parseQuery query
70− , requestHeaders = case ma of
50+ , requestHeaders = headers
71− Nothing -> hdr
51+ , isSecure = isTransportSecure transport
72− Just hv -> (mk "host", hv) : hdr
73− , isSecure = True
74 , remoteHost = addr
52 , remoteHost = addr
75 , requestBody = body
53 , requestBody = body
76 , vault = vaultValue
54 , vault = vaultValue
77− , requestBodyLength = ChunkedBody -- fixme
55+ , requestBodyLength = maybe ChunkedBody (KnownLength . fromIntegral) bodylen
78− , requestHeaderHost = ma
56+ , requestHeaderHost = mHost <|> mAuth
79− , requestHeaderRange = mrng
57+ , requestHeaderRange = mRange
80− , requestHeaderReferer = mrr
58+ , requestHeaderReferer = mReferer
81− , requestHeaderUserAgent = mua
59+ , requestHeaderUserAgent = mUserAgent
82 }
60 }
83− !ii = toInternalInfo ii1 h
61+ headers = map (first tokenKey) ths
84− !th = threadHandle ii
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− !vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
85+ $ Vault.insert pauseTimeoutKey (T.pause th)
86− $ Vault.insert getFileInfoKey (getFileInfo ii)
86+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
87 Vault.empty
87 Vault.empty
88
88
89−----------------------------------------------------------------
89+getHTTP2DataKey :: Vault.Key (IO (Maybe HTTP2Data))
90−
90+getHTTP2DataKey = unsafePerformIO Vault.newKey
91−data Special = Special {
91+{-# NOINLINE getHTTP2DataKey #-}
92− colonMethod :: !(Maybe ByteString)
93− , colonPath :: !(Maybe ByteString)
94− , colonAuth :: !(Maybe ByteString)
95− , sRange :: !(Maybe ByteString)
96− , sReferer :: !(Maybe ByteString)
97− , sUA :: !(Maybe ByteString)
98− , contentLen :: !(Maybe ByteString)
99− } deriving Show
100
92
101−emptySpecial :: Special
93+-- | Getting 'HTTP2Data' through vault of the request.
102−emptySpecial = Special Nothing Nothing Nothing Nothing Nothing Nothing Nothing
94+-- Warp uses this to receive 'HTTP2Data' from 'Middleware'.
103−
104−-- |
105--
95--
106−-- >>> validateHeaders [(":method","GET"),(":path","path")]
96+-- Since: 3.2.7
107−-- Just (ValidHeaders {vhMethod = "GET", vhPath = "path", vhAuth = Nothing, vhRange = Nothing, vhReferer = Nothing, vhUA = Nothing, vhCL = Nothing, vhHeader = []})
97+getHTTP2Data :: Request -> IO (Maybe HTTP2Data)
108−-- >>> validateHeaders [(":method","GET"),(":path","path"),(":authority","authority"),("accept-language","en")]
98+getHTTP2Data req = case Vault.lookup getHTTP2DataKey (vault req) of
109−-- Just (ValidHeaders {vhMethod = "GET", vhPath = "path", vhAuth = Just "authority", vhRange = Nothing, vhReferer = Nothing, vhUA = Nothing, vhCL = Nothing, vhHeader = [("accept-language","en")]})
110−-- >>> validateHeaders [(":method","GET"),(":path","path"),("cookie","a=b"),("accept-language","en"),("cookie","c=d"),("cookie","e=f")]
111−-- Just (ValidHeaders {vhMethod = "GET", vhPath = "path", vhAuth = Nothing, vhRange = Nothing, vhReferer = Nothing, vhUA = Nothing, vhCL = Nothing, vhHeader = [("accept-language","en"),("cookie","a=b; c=d; e=f")]})
112−validateHeaders :: HeaderList -> Maybe ValidHeaders
113−validateHeaders hs = case pseudo hs emptySpecial of
114− Just (Special (Just m) (Just p) ma mrng mrr mua mcl, !h)
115− -> Just $! ValidHeaders m p ma mrng mrr mua (readInt <$> mcl) h
116− _ -> Nothing
117− where
118− pseudo [] !s = Just (s,[])
119− pseudo h@((k,v):kvs) !s
120− | k == ":method" = if isJust (colonMethod s) then
121− Nothing
99+ Nothing -> return Nothing
122− else
100+ Just getter -> getter
123− pseudo kvs (s { colonMethod = Just v })
124− | k == ":path" = if isJust (colonPath s) then
125− Nothing
126− else
127− pseudo kvs (s { colonPath = Just v })
128− | k == ":authority" = if isJust (colonAuth s) then
129− Nothing
130− else
131− pseudo kvs (s { colonAuth = Just v })
132− | k == ":scheme" = pseudo kvs s -- fixme: how to store :scheme?
133− | isPseudo k = Nothing
134− | otherwise = normal h (s,id,id)
135
101
136− normal [] (!s,b,c) = Just (s, mkH b c)
102+setHTTP2DataKey :: Vault.Key (Maybe HTTP2Data -> IO ())
137− normal ((k,v):kvs) (!s,b,c)
103+setHTTP2DataKey = unsafePerformIO Vault.newKey
138− | isPseudo k = Nothing
104+{-# NOINLINE setHTTP2DataKey #-}
139− | k == "connection" = Nothing
140− | k == "te" = if v == "trailers" then
141− normal kvs (s, b . ((mk k,v) :), c)
142− else
143− Nothing
144− | k == "range"
145− = normal kvs (s {sRange = Just v }, b . ((mk k,v) :), c)
146− | k == "referer"
147− = normal kvs (s { sReferer = Just v }, b . ((mk k,v) :), c)
148− | k == "user-agent"
149− = normal kvs (s { sUA = Just v }, b . ((mk k,v) :), c)
150− | k == "content-length"
151− = normal kvs (s { contentLen = Just v }, b . ((mk k,v) :), c)
152− | k == "host" = if isJust (colonAuth s) then
153− normal kvs (s, b, c)
154− else
155− normal kvs (s { colonAuth = Just v }, b, c)
156− | k == "cookie" = normal kvs (s, b, c . (v:))
157− | otherwise = case BS.find isUpper k of
158− Nothing -> normal kvs (s, b . ((mk k,v) :), c)
159− Just _ -> Nothing
160
105
161− mkH b c = h
106+-- | Setting 'HTTP2Data' through vault of the request.
162− where
107+-- 'Application' or 'Middleware' should use this.
163− !h = b anchor
108+--
164− !cookieList = c []
109+-- Since: 3.2.7
165− !anchor
110+setHTTP2Data :: Request -> Maybe HTTP2Data -> IO ()
166− | null cookieList = []
111+setHTTP2Data req mh2d = case Vault.lookup setHTTP2DataKey (vault req) of
167− | otherwise = let !v = BS.intercalate "; " cookieList
112+ Nothing -> return ()
168− in [("cookie",v)]
113+ Just setter -> setter mh2d
169− isPseudo "" = False
170− isPseudo k = BS.head k == _colon
171−
172−
173−----------------------------------------------------------------
174
114
175−newReadBody :: TQueue ByteString -> IO (IO ByteString)
115+modifyHTTP2DataKey :: Vault.Key ((Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ())
176−newReadBody q = do
116+modifyHTTP2DataKey = unsafePerformIO Vault.newKey
177− ref <- newIORef False
117+{-# NOINLINE modifyHTTP2DataKey #-}
178− return $ readBody q ref
179
118
180−readBody :: TQueue ByteString -> IORef Bool -> IO ByteString
119+-- | Modifying 'HTTP2Data' through vault of the request.
181−readBody q ref = do
120+-- 'Application' or 'Middleware' should use this.
182− eof <- readIORef ref
121+--
183− if eof then
122+-- Since: 3.2.8
184− return ""
123+modifyHTTP2Data :: Request -> (Maybe HTTP2Data -> Maybe HTTP2Data) -> IO ()
185− else do
124+modifyHTTP2Data req func = case Vault.lookup modifyHTTP2DataKey (vault req) of
186− bs <- atomically $ readTQueue q
125+ Nothing -> return ()
187− when (bs == "") $ writeIORef ref True
126+ Just modify -> modify func
188− return bs
warp/Network/Wai/Handler/Warp/HTTP2/Response.hsnew file+127
@@ -0,0 +1,127 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+{-# LANGUAGE RecordWildCards #-}
3+{-# LANGUAGE BangPatterns #-}
4+{-# LANGUAGE ScopedTypeVariables #-}
5+
6+module Network.Wai.Handler.Warp.HTTP2.Response (
7+ fromResponse
8+ ) where
9+
10+import qualified Control.Exception as E
11+import qualified Data.ByteString.Builder as BB
12+import qualified Network.HTTP.Types as H
13+import qualified Network.HTTP2.Server as H2
14+import Network.Wai hiding (responseFile, responseBuilder, responseStream)
15+import Network.Wai.Internal (Response(..))
16+
17+import Network.Wai.Handler.Warp.File
18+import Network.Wai.Handler.Warp.HTTP2.Request (getHTTP2Data)
19+import Network.Wai.Handler.Warp.HTTP2.Types
20+import Network.Wai.Handler.Warp.Header
21+import qualified Network.Wai.Handler.Warp.Response as R
22+import qualified Network.Wai.Handler.Warp.Settings as S
23+import Network.Wai.Handler.Warp.Types
24+
25+----------------------------------------------------------------
26+
27+fromResponse :: S.Settings -> InternalInfo -> Request -> Response -> IO H2.Response
28+fromResponse settings ii req rsp = do
29+ date <- getDate ii
30+ h2rsp <- case rsp of
31+ ResponseFile st rsphdr path mpart -> do
32+ let rsphdr' = add date svr rsphdr
33+ responseFile st rsphdr' isHead path mpart ii reqhdr
34+ ResponseBuilder st rsphdr builder -> do
35+ let rsphdr' = add date svr rsphdr
36+ return $ responseBuilder st rsphdr' isHead builder
37+ ResponseStream st rsphdr strmbdy -> do
38+ let rsphdr' = add date svr rsphdr
39+ return $ responseStream st rsphdr' isHead strmbdy
40+ _ -> error "ResponseRaw is not supported in HTTP/2"
41+ mh2data <- getHTTP2Data req
42+ case mh2data of
43+ Nothing -> return h2rsp
44+ Just h2data -> do
45+ let !trailers = http2dataTrailers h2data
46+ return $ H2.setResponseTrailersMaker h2rsp trailers
47+ where
48+ !isHead = requestMethod req == H.methodHead
49+ !reqhdr = requestHeaders req
50+ !svr = S.settingsServerName settings
51+ add date server rsphdr = (H.hDate, date) : (H.hServer, server) : rsphdr
52+ -- fixme: not adding svr if already exists
53+
54+----------------------------------------------------------------
55+
56+responseFile :: H.Status -> H.ResponseHeaders -> Bool
57+ -> FilePath -> Maybe FilePart -> InternalInfo -> H.RequestHeaders
58+ -> IO H2.Response
59+responseFile st rsphdr _ _ _ _ _
60+ | noBody st = return $ responseNoBody st rsphdr
61+
62+responseFile st rsphdr isHead path (Just fp) _ _ =
63+ return $ responseFile2XX st rsphdr isHead fileSpec
64+ where
65+ !off' = fromIntegral $ filePartOffset fp
66+ !bytes' = fromIntegral $ filePartByteCount fp
67+ !fileSpec = H2.FileSpec path off' bytes'
68+
69+responseFile _ rsphdr isHead path Nothing ii reqhdr = do
70+ efinfo <- E.try $ getFileInfo ii path
71+ case efinfo of
72+ Left (_ex :: E.IOException) -> return $ response404 rsphdr
73+ Right finfo -> do
74+ let reqidx = indexRequestHeader reqhdr
75+ rspidx = indexResponseHeader rsphdr
76+ case conditionalRequest finfo rsphdr rspidx reqidx of
77+ WithoutBody s -> return $ responseNoBody s rsphdr
78+ WithBody s rsphdr' off bytes -> do
79+ let !off' = fromIntegral off
80+ !bytes' = fromIntegral bytes
81+ !fileSpec = H2.FileSpec path off' bytes'
82+ return $ responseFile2XX s rsphdr' isHead fileSpec
83+
84+----------------------------------------------------------------
85+
86+responseFile2XX :: H.Status -> H.ResponseHeaders -> Bool -> H2.FileSpec -> H2.Response
87+responseFile2XX st rsphdr isHead fileSpec
88+ | isHead = responseNoBody st rsphdr
89+ | otherwise = H2.responseFile st rsphdr fileSpec
90+
91+----------------------------------------------------------------
92+
93+responseBuilder :: H.Status -> H.ResponseHeaders -> Bool
94+ -> BB.Builder
95+ -> H2.Response
96+responseBuilder st rsphdr isHead builder
97+ | noBody st = responseNoBody st rsphdr
98+ | isHead = responseNoBody st rsphdr
99+ | otherwise = H2.responseBuilder st rsphdr builder
100+
101+----------------------------------------------------------------
102+
103+responseStream :: H.Status -> H.ResponseHeaders -> Bool
104+ -> StreamingBody
105+ -> H2.Response
106+responseStream st rsphdr isHead strmbdy
107+ | noBody st = responseNoBody st rsphdr
108+ | isHead = responseNoBody st rsphdr
109+ | otherwise = H2.responseStreaming st rsphdr strmbdy
110+
111+----------------------------------------------------------------
112+
113+responseNoBody :: H.Status -> H.ResponseHeaders -> H2.Response
114+responseNoBody st rsphdr = H2.responseNoBody st rsphdr
115+
116+----------------------------------------------------------------
117+
118+response404 :: H.ResponseHeaders -> H2.Response
119+response404 rsphdr = H2.responseBuilder H.notFound404 rsphdr' body
120+ where
121+ !rsphdr' = R.replaceHeader H.hContentType "text/plain; charset=utf-8" rsphdr
122+ !body = BB.byteString "File not found"
123+
124+----------------------------------------------------------------
125+
126+noBody :: H.Status -> Bool
127+noBody = not . R.hasBody
warp/Network/Wai/Handler/Warp/HTTP2/Sender.hsdeleted−453
@@ -1,453 +0,0 @@
1−{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE BangPatterns, CPP #-}
3−{-# LANGUAGE NamedFieldPuns #-}
4−
5−module Network.Wai.Handler.Warp.HTTP2.Sender (frameSender) where
6−
7−#if __GLASGOW_HASKELL__ < 709
8−import Control.Applicative
9−#endif
10−import Control.Concurrent.STM
11−import qualified Control.Exception as E
12−import Control.Monad (void, when)
13−import qualified Data.ByteString as BS
14−import Data.ByteString.Builder (Builder)
15−import qualified Data.ByteString.Builder.Extra as B
16−import Data.Maybe (isNothing)
17−import Foreign.Ptr
18−import Network.HPACK (setLimitForEncoding)
19−import Network.HTTP2
20−import Network.HTTP2.Priority (isEmptySTM, dequeueSTM, Precedence)
21−import Network.Wai
22−import Network.Wai.Handler.Warp.Buffer
23−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
24−import Network.Wai.Handler.Warp.HTTP2.HPACK
25−import Network.Wai.Handler.Warp.HTTP2.Manager (Manager)
26−import Network.Wai.Handler.Warp.HTTP2.Types
27−import Network.Wai.Handler.Warp.IORef
28−import qualified Network.Wai.Handler.Warp.Settings as S
29−import Network.Wai.Handler.Warp.Types
30−
31−#ifdef WINDOWS
32−import qualified System.IO as IO
33−#else
34−import Network.Wai.Handler.Warp.FdCache
35−import Network.Wai.Handler.Warp.SendFile (positionRead)
36−import qualified Network.Wai.Handler.Warp.Timeout as T
37−#endif
38−
39−----------------------------------------------------------------
40−
41−data Leftover = LZero
42− | LOne B.BufferWriter
43− | LTwo BS.ByteString B.BufferWriter
44−
45−----------------------------------------------------------------
46−
47−getStreamWindowSize :: Stream -> IO WindowSize
48−getStreamWindowSize Stream{streamWindow} = atomically $ readTVar streamWindow
49−
50−waitStreamWindowSize :: Stream -> STM ()
51−waitStreamWindowSize Stream{streamWindow} = do
52− w <- readTVar streamWindow
53− check (w > 0)
54−
55−waitStreaming :: TBQueue a -> STM ()
56−waitStreaming tbq = do
57− isEmpty <- isEmptyTBQueue tbq
58− check (isEmpty == False)
59−
60−data Switch = C Control
61− | O (StreamId,Precedence,Output)
62− | Flush
63−
64−frameSender :: Context -> Connection -> S.Settings -> Manager -> IO ()
65−frameSender ctx@Context{outputQ,controlQ,connectionWindow,encodeDynamicTable}
66− conn@Connection{connWriteBuffer,connBufferSize,connSendAll}
67− settings mgr = loop 0 `E.catch` ignore
68− where
69− dequeue off = do
70− isEmpty <- isEmptyTQueue controlQ
71− if isEmpty then do
72− w <- readTVar connectionWindow
73− check (w > 0)
74− emp <- isEmptySTM outputQ
75− if emp then
76− if off /= 0 then return Flush else retry
77− else
78− O <$> dequeueSTM outputQ
79− else
80− C <$> readTQueue controlQ
81−
82− loop off = do
83− x <- atomically $ dequeue off
84− case x of
85− C ctl -> do
86− when (off /= 0) $ flushN off
87− cont <- control ctl
88− when cont $ loop 0
89− O (_,pre,out) -> do
90− let strm = outputStream out
91− writeIORef (streamPrecedence strm) pre
92− off' <- whenReadyOrEnqueueAgain out off $ output out off
93− case off' of
94− 0 -> loop 0
95− _ | off' > 12288 -> flushN off' >> loop 0 -- fixme: hard-coding
96− | otherwise -> loop off'
97− Flush -> flushN off >> loop 0
98−
99− control CFinish = return False
100− control (CGoaway frame) = connSendAll frame >> return False
101− control (CFrame frame) = connSendAll frame >> return True
102− control (CSettings frame alist) = do
103− connSendAll frame
104− case lookup SettingsHeaderTableSize alist of
105− Nothing -> return ()
106− Just siz -> setLimitForEncoding siz encodeDynamicTable
107− return True
108−
109− output (ONext strm curr mtbq) off0 lim = do
110− -- Data frame payload
111− let !buf = connWriteBuffer `plusPtr` off0
112− !siz = connBufferSize - off0
113− Next datPayloadLen mnext <- curr buf siz lim
114− off <- fillDataHeader strm off0 datPayloadLen mnext
115− maybeEnqueueNext strm mtbq mnext
116− return off
117−
118− output (ORspn strm rspn ii) off0 lim = do
119− -- Header frame and Continuation frame
120− let sid = streamNumber strm
121− endOfStream = case rspn of
122− RspnNobody _ _ -> True
123− _ -> False
124− kvlen <- headerContinue sid rspn endOfStream off0 ii
125− off <- sendHeadersIfNecessary $ off0 + frameHeaderLength + kvlen
126− case rspn of
127− RspnNobody _ _ -> do
128− closed ctx strm Finished
129− return off
130− RspnFile _ _ path mpart -> do
131− -- Data frame payload
132− let payloadOff = off + frameHeaderLength
133− Next datPayloadLen mnext <-
134− fillFileBodyGetNext conn ii payloadOff lim path mpart
135− off' <- fillDataHeader strm off datPayloadLen mnext
136− maybeEnqueueNext strm Nothing mnext
137− return off'
138− RspnBuilder _ _ builder -> do
139− -- Data frame payload
140− let payloadOff = off + frameHeaderLength
141− Next datPayloadLen mnext <-
142− fillBuilderBodyGetNext conn ii payloadOff lim builder
143− off' <- fillDataHeader strm off datPayloadLen mnext
144− maybeEnqueueNext strm Nothing mnext
145− return off'
146− RspnStreaming _ _ tbq -> do
147− let payloadOff = off + frameHeaderLength
148− Next datPayloadLen mnext <-
149− fillStreamBodyGetNext conn payloadOff lim tbq strm
150− off' <- fillDataHeader strm off datPayloadLen mnext
151− maybeEnqueueNext strm (Just tbq) mnext
152− return off'
153−
154− whenReadyOrEnqueueAgain out off body = E.handle resetStream $ do
155− state <- readIORef $ streamState strm
156− if isClosed state then
157− return off
158− else case mtbq of
159− Just tbq -> checkStreaming tbq
160− _ -> checkStreamWindowSize
161− where
162− strm = outputStream out
163− mtbq = outputMaybeTBQueue out
164− checkStreaming tbq = do
165− isEmpty <- atomically $ isEmptyTBQueue tbq
166− if isEmpty then do
167− forkAndEnqueueWhenReady (waitStreaming tbq) outputQ out mgr
168− return off
169− else
170− checkStreamWindowSize
171− checkStreamWindowSize = do
172− sws <- getStreamWindowSize strm
173− if sws == 0 then do
174− forkAndEnqueueWhenReady (waitStreamWindowSize strm) outputQ out mgr
175− return off
176− else do
177− cws <- atomically $ readTVar connectionWindow -- not 0
178− let !lim = min cws sws
179− body lim
180− resetStream e = do
181− closed ctx strm (ResetByMe e)
182− let !rst = resetFrame InternalError $ streamNumber strm
183− enqueueControl controlQ $ CFrame rst
184− return off
185−
186− -- Flush the connection buffer to the socket, where the first 'n' bytes of
187− -- the buffer are filled.
188− flushN :: Int -> IO ()
189− flushN n = bufferIO connWriteBuffer n connSendAll
190−
191− headerContinue sid rspn endOfStream off ii = do
192− let !s = rspnStatus rspn
193− !h = rspnHeaders rspn
194− let !offkv = off + frameHeaderLength
195− let !bufkv = connWriteBuffer `plusPtr` offkv
196− !limkv = connBufferSize - offkv
197− (hs,kvlen) <- hpackEncodeHeader ctx bufkv limkv ii settings s h
198− let flag0 = case hs of
199− [] -> setEndHeader defaultFlags
200− _ -> defaultFlags
201− flag = if endOfStream then setEndStream flag0 else flag0
202− let buf = connWriteBuffer `plusPtr` off
203− fillFrameHeader FrameHeaders kvlen sid flag buf
204− continue sid kvlen hs
205−
206− bufHeaderPayload = connWriteBuffer `plusPtr` frameHeaderLength
207− headerPayloadLim = connBufferSize - frameHeaderLength
208−
209− continue _ kvlen [] = return kvlen
210− continue sid kvlen hs = do
211− flushN $ kvlen + frameHeaderLength
212− -- Now off is 0
213− (hs', kvlen') <- hpackEncodeHeaderLoop ctx bufHeaderPayload headerPayloadLim hs
214− when (hs == hs') $ E.throwIO $ ConnectionError CompressionError "cannot compress the header"
215− let flag = case hs' of
216− [] -> setEndHeader defaultFlags
217− _ -> defaultFlags
218− fillFrameHeader FrameContinuation kvlen' sid flag connWriteBuffer
219− continue sid kvlen' hs'
220−
221− -- Re-enqueue the stream in the output queue.
222− maybeEnqueueNext :: Stream -> Maybe (TBQueue Sequence) -> Maybe DynaNext -> IO ()
223− maybeEnqueueNext _ _ Nothing = return ()
224− maybeEnqueueNext strm mtbq (Just next) = enqueueOutput outputQ out
225− where
226− !out = ONext strm next mtbq
227−
228− -- Send headers if there is not room for a 1-byte data frame, and return
229− -- the offset of the next frame's first header byte.
230− sendHeadersIfNecessary off
231− -- True if the connection buffer has room for a 1-byte data frame.
232− | off + frameHeaderLength < connBufferSize = return off
233− | otherwise = do
234− flushN off
235− return 0
236−
237− fillDataHeader strm off datPayloadLen mnext = do
238− -- Data frame header
239− let !sid = streamNumber strm
240− !buf = connWriteBuffer `plusPtr` off
241− !off' = off + frameHeaderLength + datPayloadLen
242− flag = case mnext of
243− Nothing -> setEndStream defaultFlags
244− _ -> defaultFlags
245− fillFrameHeader FrameData datPayloadLen sid flag buf
246− when (isNothing mnext) $ closed ctx strm Finished
247− atomically $ modifyTVar' connectionWindow (subtract datPayloadLen)
248− atomically $ modifyTVar' (streamWindow strm) (subtract datPayloadLen)
249− return off'
250−
251− fillFrameHeader ftyp len sid flag buf = encodeFrameHeaderBuf ftyp hinfo buf
252− where
253− hinfo = FrameHeader len flag sid
254−
255− ignore :: E.SomeException -> IO ()
256− ignore _ = return ()
257−
258−----------------------------------------------------------------
259−
260−{-
261−ResponseFile Status ResponseHeaders FilePath (Maybe FilePart)
262−ResponseBuilder Status ResponseHeaders Builder
263−ResponseStream Status ResponseHeaders StreamingBody
264−ResponseRaw (IO ByteString -> (ByteString -> IO ()) -> IO ()) Response
265−-}
266−
267−fillBuilderBodyGetNext :: Connection -> InternalInfo -> Int -> WindowSize -> Builder -> IO Next
268−fillBuilderBodyGetNext Connection{connWriteBuffer,connBufferSize}
269− _ off lim bb = do
270− let datBuf = connWriteBuffer `plusPtr` off
271− room = min (connBufferSize - off) lim
272− (len, signal) <- B.runBuilder bb datBuf room
273− return $ nextForBuilder len signal
274−
275−fillFileBodyGetNext :: Connection -> InternalInfo -> Int -> WindowSize -> FilePath -> Maybe FilePart -> IO Next
276−#ifdef WINDOWS
277−fillFileBodyGetNext Connection{connWriteBuffer,connBufferSize}
278− _ off lim path mpart = do
279− let datBuf = connWriteBuffer `plusPtr` off
280− room = min (connBufferSize - off) lim
281− (start, bytes) <- fileStartEnd path mpart
282− -- fixme: how to close Handle? GC does it at this moment.
283− hdl <- IO.openBinaryFile path IO.ReadMode
284− IO.hSeek hdl IO.AbsoluteSeek start
285− len <- IO.hGetBufSome hdl datBuf (mini room bytes)
286− let bytes' = bytes - fromIntegral len
287− -- fixme: connWriteBuffer connBufferSize
288− return $ nextForFile len hdl bytes' (return ())
289−#else
290−fillFileBodyGetNext Connection{connWriteBuffer,connBufferSize}
291− ii off lim path mpart = do
292− (mfd, refresh') <- getFd ii path
293− (fd, refresh) <- case mfd of
294− Nothing -> do
295− fd' <- openFile path
296− th <- T.register (timeoutManager ii) (closeFile fd')
297− return (fd', T.tickle th)
298− Just fd -> return (fd, refresh')
299− let datBuf = connWriteBuffer `plusPtr` off
300− room = min (connBufferSize - off) lim
301− (start, bytes) <- fileStartEnd path mpart
302− len <- positionRead fd datBuf (mini room bytes) start
303− refresh
304− let len' = fromIntegral len
305− return $ nextForFile len fd (start + len') (bytes - len') refresh
306−#endif
307−
308−fileStartEnd :: FilePath -> Maybe FilePart -> IO (Integer, Integer)
309−fileStartEnd _ (Just part) =
310− return (filePartOffset part, filePartByteCount part)
311−fileStartEnd _ _ = error "fileStartEnd"
312−
313−----------------------------------------------------------------
314−
315−fillStreamBodyGetNext :: Connection -> Int -> WindowSize -> TBQueue Sequence -> Stream -> IO Next
316−fillStreamBodyGetNext Connection{connWriteBuffer,connBufferSize}
317− off lim sq strm = do
318− let datBuf = connWriteBuffer `plusPtr` off
319− room = min (connBufferSize - off) lim
320− (leftover, cont, len) <- runStreamBuilder datBuf room sq
321− return $ nextForStream sq strm leftover cont len
322−
323−----------------------------------------------------------------
324−
325−fillBufBuilder :: Leftover -> DynaNext
326−fillBufBuilder leftover buf0 siz0 lim = do
327− let payloadBuf = buf0 `plusPtr` frameHeaderLength
328− room = min (siz0 - frameHeaderLength) lim
329− case leftover of
330− LZero -> error "fillBufBuilder: LZero"
331− LOne writer -> do
332− (len, signal) <- writer payloadBuf room
333− getNext len signal
334− LTwo bs writer
335− | BS.length bs <= room -> do
336− buf1 <- copy payloadBuf bs
337− let len1 = BS.length bs
338− (len2, signal) <- writer buf1 (room - len1)
339− getNext (len1 + len2) signal
340− | otherwise -> do
341− let (bs1,bs2) = BS.splitAt room bs
342− void $ copy payloadBuf bs1
343− getNext room (B.Chunk bs2 writer)
344− where
345− getNext l s = return $ nextForBuilder l s
346−
347−nextForBuilder :: BytesFilled -> B.Next -> Next
348−nextForBuilder len B.Done
349− = Next len Nothing
350−nextForBuilder len (B.More _ writer)
351− = Next len $ Just (fillBufBuilder (LOne writer))
352−nextForBuilder len (B.Chunk bs writer)
353− = Next len $ Just (fillBufBuilder (LTwo bs writer))
354−
355−----------------------------------------------------------------
356−
357−runStreamBuilder :: Buffer -> BufSize -> TBQueue Sequence
358− -> IO (Leftover, Bool, BytesFilled)
359−runStreamBuilder buf0 room0 sq = loop buf0 room0 0
360− where
361− loop !buf !room !total = do
362− mbuilder <- atomically $ tryReadTBQueue sq
363− case mbuilder of
364− Nothing -> return (LZero, True, total)
365− Just (SBuilder builder) -> do
366− (len, signal) <- B.runBuilder builder buf room
367− let !total' = total + len
368− case signal of
369− B.Done -> loop (buf `plusPtr` len) (room - len) total'
370− B.More _ writer -> return (LOne writer, True, total')
371− B.Chunk bs writer -> return (LTwo bs writer, True, total')
372− Just SFlush -> return (LZero, True, total)
373− Just SFinish -> return (LZero, False, total)
374−
375−fillBufStream :: Leftover -> TBQueue Sequence -> Stream -> DynaNext
376−fillBufStream leftover0 sq strm buf0 siz0 lim0 = do
377− let payloadBuf = buf0 `plusPtr` frameHeaderLength
378− room0 = min (siz0 - frameHeaderLength) lim0
379− case leftover0 of
380− LZero -> do
381− (leftover, cont, len) <- runStreamBuilder payloadBuf room0 sq
382− getNext leftover cont len
383− LOne writer -> write writer payloadBuf room0 0
384− LTwo bs writer
385− | BS.length bs <= room0 -> do
386− buf1 <- copy payloadBuf bs
387− let len = BS.length bs
388− write writer buf1 (room0 - len) len
389− | otherwise -> do
390− let (bs1,bs2) = BS.splitAt room0 bs
391− void $ copy payloadBuf bs1
392− getNext (LTwo bs2 writer) True room0
393− where
394− getNext l b r = return $ nextForStream sq strm l b r
395− write writer1 buf room sofar = do
396− (len, signal) <- writer1 buf room
397− case signal of
398− B.Done -> do
399− (leftover, cont, extra) <- runStreamBuilder (buf `plusPtr` len) (room - len) sq
400− let !total = sofar + len + extra
401− getNext leftover cont total
402− B.More _ writer -> do
403− let !total = sofar + len
404− getNext (LOne writer) True total
405− B.Chunk bs writer -> do
406− let !total = sofar + len
407− getNext (LTwo bs writer) True total
408−
409−nextForStream :: TBQueue Sequence -> Stream
410− -> Leftover -> Bool -> BytesFilled
411− -> Next
412−nextForStream _ _ _ False len = Next len Nothing
413−nextForStream sq strm leftOrZero True len =
414− Next len $ Just (fillBufStream leftOrZero sq strm)
415−
416−----------------------------------------------------------------
417−
418−#ifdef WINDOWS
419−fillBufFile :: IO.Handle -> Integer -> IO () -> DynaNext
420−fillBufFile h bytes refresh buf siz lim = do
421− let payloadBuf = buf `plusPtr` frameHeaderLength
422− room = min (siz - frameHeaderLength) lim
423− len <- IO.hGetBufSome h payloadBuf room
424− refresh
425− let bytes' = bytes - fromIntegral len
426− return $ nextForFile len h bytes' refresh
427−
428−nextForFile :: BytesFilled -> IO.Handle -> Integer -> IO () -> Next
429−nextForFile 0 _ _ _ = Next 0 Nothing
430−nextForFile len _ 0 _ = Next len Nothing
431−nextForFile len h bytes refresh =
432− Next len $ Just (fillBufFile h bytes refresh)
433−#else
434−fillBufFile :: Fd -> Integer -> Integer -> IO () -> DynaNext
435−fillBufFile fd start bytes refresh buf siz lim = do
436− let payloadBuf = buf `plusPtr` frameHeaderLength
437− room = min (siz - frameHeaderLength) lim
438− len <- positionRead fd payloadBuf (mini room bytes) start
439− let len' = fromIntegral len
440− refresh
441− return $ nextForFile len fd (start + len') (bytes - len') refresh
442−
443−nextForFile :: BytesFilled -> Fd -> Integer -> Integer -> IO () -> Next
444−nextForFile 0 _ _ _ _ = Next 0 Nothing
445−nextForFile len _ _ 0 _ = Next len Nothing
446−nextForFile len fd start bytes refresh =
447− Next len $ Just (fillBufFile fd start bytes refresh)
448−#endif
449−
450−mini :: Int -> Integer -> Int
451−mini i n
452− | fromIntegral i < n = i
453− | otherwise = fromIntegral n
warp/Network/Wai/Handler/Warp/HTTP2/Types.hs+63−240
@@ -1,35 +1,18 @@
1+{-# LANGUAGE NamedFieldPuns #-}
1−{-# LANGUAGE OverloadedStrings, CPP #-}
2+{-# LANGUAGE OverloadedStrings #-}
2−{-# LANGUAGE NamedFieldPuns, RecordWildCards #-}
3+{-# LANGUAGE RecordWildCards #-}
3−{-# LANGUAGE BangPatterns #-}
4
4
5module Network.Wai.Handler.Warp.HTTP2.Types where
5module Network.Wai.Handler.Warp.HTTP2.Types where
6
6
7−import Data.ByteString.Builder (Builder)
8−#if __GLASGOW_HASKELL__ < 709
9−import Control.Applicative ((<$>),(<*>))
10−#endif
11−import Control.Concurrent (forkIO)
12−import Control.Concurrent.STM
13−import Control.Exception (SomeException, bracket)
14−import Control.Monad (void)
15−import Data.ByteString (ByteString)
16import qualified Data.ByteString as BS
7import qualified Data.ByteString as BS
17−import Data.IntMap.Strict (IntMap, IntMap)
18−import qualified Data.IntMap.Strict as M
19import qualified Network.HTTP.Types as H
8import qualified Network.HTTP.Types as H
20−import Network.Wai (Request, FilePart)
21−import Network.Wai.Handler.Warp.HTTP2.Manager
22−import Network.Wai.Handler.Warp.IORef
23−import Network.Wai.Handler.Warp.Types
24−
25import Network.HTTP2
9import Network.HTTP2
26−import Network.HTTP2.Priority
10+import qualified Network.HTTP2.Server as H2
27−import Network.HPACK hiding (Buffer)
28
11
29−----------------------------------------------------------------
12+import Network.Wai.Handler.Warp.Imports
13+import Network.Wai.Handler.Warp.Types
30
14
31−http2ver :: H.HttpVersion
15+----------------------------------------------------------------
32−http2ver = H.HttpVersion 2 0
33
16
34isHTTP2 :: Transport -> Bool
17isHTTP2 :: Transport -> Bool
35isHTTP2 TCP = False
18isHTTP2 TCP = False
@@ -37,222 +20,62 @@ isHTTP2 tls = useHTTP2
37 where
20 where
38 useHTTP2 = case tlsNegotiatedProtocol tls of
21 useHTTP2 = case tlsNegotiatedProtocol tls of
39 Nothing -> False
22 Nothing -> False
40− Just proto -> "h2-" `BS.isPrefixOf` proto
23+ Just proto -> "h2" `BS.isPrefixOf` proto
41−
42−----------------------------------------------------------------
43−
44−data Input = Input Stream Request InternalInfo
45
24
46----------------------------------------------------------------
25----------------------------------------------------------------
47
26
48−type DynaNext = Buffer -> BufSize -> WindowSize -> IO Next
27+-- | HTTP/2 specific data.
49−
28+--
50−type BytesFilled = Int
29+-- Since: 3.2.7
51−
30+data HTTP2Data = HTTP2Data {
52−data Next = Next !BytesFilled (Maybe DynaNext)
31+ -- | Accessor for 'PushPromise' in 'HTTP2Data'.
53−
32+ --
54−data Rspn = RspnNobody H.Status H.ResponseHeaders
33+ -- Since: 3.2.7
55− | RspnStreaming H.Status H.ResponseHeaders (TBQueue Sequence)
34+ http2dataPushPromise :: [PushPromise]
56− | RspnBuilder H.Status H.ResponseHeaders Builder
35+ -- | Accessor for 'H2.TrailersMaker' in 'HTTP2Data'.
57− | RspnFile H.Status H.ResponseHeaders FilePath (Maybe FilePart)
36+ --
58−
37+ -- Since: 3.2.8 but the type changed in 3.3.0
59−rspnStatus :: Rspn -> H.Status
38+ , http2dataTrailers :: H2.TrailersMaker
60−rspnStatus (RspnNobody s _) = s
39+ }
61−rspnStatus (RspnStreaming s _ _) = s
40+
62−rspnStatus (RspnBuilder s _ _) = s
41+-- | Default HTTP/2 specific data.
63−rspnStatus (RspnFile s _ _ _ ) = s
42+--
64−
43+-- Since: 3.2.7
65−rspnHeaders :: Rspn -> H.ResponseHeaders
44+defaultHTTP2Data :: HTTP2Data
66−rspnHeaders (RspnNobody _ h) = h
45+defaultHTTP2Data = HTTP2Data [] H2.defaultTrailersMaker
67−rspnHeaders (RspnStreaming _ h _) = h
46+
68−rspnHeaders (RspnBuilder _ h _) = h
47+-- | HTTP/2 push promise or sever push.
69−rspnHeaders (RspnFile _ h _ _ ) = h
48+-- This allows files only for backward-compatibility
70−
49+-- while the HTTP/2 library supports other types.
71−data Output = ORspn !Stream !Rspn !InternalInfo
50+--
72− | ONext !Stream !DynaNext !(Maybe (TBQueue Sequence))
51+-- Since: 3.2.7
73−
52+data PushPromise = PushPromise {
74−outputStream :: Output -> Stream
53+ -- | Accessor for a URL path in 'PushPromise'.
75−outputStream (ORspn strm _ _) = strm
54+ -- E.g. \"\/style\/default.css\".
76−outputStream (ONext strm _ _) = strm
55+ --
77−
56+ -- Since: 3.2.7
78−outputMaybeTBQueue :: Output -> Maybe (TBQueue Sequence)
57+ promisedPath :: ByteString
79−outputMaybeTBQueue (ORspn _ (RspnStreaming _ _ tbq) _) = Just tbq
58+ -- | Accessor for 'FilePath' in 'PushPromise'.
80−outputMaybeTBQueue (ORspn _ _ _) = Nothing
59+ -- E.g. \"FILE_PATH/default.css\".
81−outputMaybeTBQueue (ONext _ _ mtbq) = mtbq
60+ --
82−
61+ -- Since: 3.2.7
83−data Control = CFinish
62+ , promisedFile :: FilePath
84− | CGoaway !ByteString
63+ -- | Accessor for 'H.ResponseHeaders' in 'PushPromise'
85− | CFrame !ByteString
64+ -- \"content-type\" must be specified.
86− | CSettings !ByteString !SettingsList
65+ -- Default value: [].
87−
66+ --
88−----------------------------------------------------------------
67+ --
89−
68+ -- Since: 3.2.7
90−data Sequence = SFinish
69+ , promisedResponseHeaders :: H.ResponseHeaders
91− | SFlush
70+ -- | Accessor for 'Weight' in 'PushPromise'.
92− | SBuilder Builder
71+ -- Default value: 16.
93−
72+ --
94−----------------------------------------------------------------
73+ -- Since: 3.2.7
95−
74+ , promisedWeight :: Weight
96−-- | The context for HTTP/2 connection.
75+ } deriving (Eq,Ord,Show)
97−data Context = Context {
76+
98− http2settings :: !(IORef Settings)
77+-- | Default push promise.
99− , firstSettings :: !(IORef Bool)
78+--
100− , streamTable :: !StreamTable
79+-- Since: 3.2.7
101− , concurrency :: !(IORef Int)
80+defaultPushPromise :: PushPromise
102− , priorityTreeSize :: !(IORef Int)
81+defaultPushPromise = PushPromise "" "" [] 16
103− -- | RFC 7540 says "Other frames (from any stream) MUST NOT
104− -- occur between the HEADERS frame and any CONTINUATION
105− -- frames that might follow". This field is used to implement
106− -- this requirement.
107− , continued :: !(IORef (Maybe StreamId))
108− , currentStreamId :: !(IORef StreamId)
109− , inputQ :: !(TQueue Input)
110− , outputQ :: !(PriorityTree Output)
111− , controlQ :: !(TQueue Control)
112− , encodeDynamicTable :: !DynamicTable
113− , decodeDynamicTable :: !DynamicTable
114− , connectionWindow :: !(TVar WindowSize)
115− }
116−
117−----------------------------------------------------------------
118−
119−newContext :: IO Context
120−newContext = Context <$> newIORef defaultSettings
121− <*> newIORef False
122− <*> newStreamTable
123− <*> newIORef 0
124− <*> newIORef 0
125− <*> newIORef Nothing
126− <*> newIORef 0
127− <*> newTQueueIO
128− <*> newPriorityTree
129− <*> newTQueueIO
130− <*> newDynamicTableForEncoding defaultDynamicTableSize
131− <*> newDynamicTableForDecoding defaultDynamicTableSize 4096
132− <*> newTVarIO defaultInitialWindowSize
133−
134−clearContext :: Context -> IO ()
135−clearContext _ctx = return ()
136−
137−----------------------------------------------------------------
138−
139−data OpenState =
140− JustOpened
141− | Continued [HeaderBlockFragment]
142− !Int -- Total size
143− !Int -- The number of continuation frames
144− !Bool -- End of stream
145− !Priority
146− | NoBody HeaderList !Priority
147− | HasBody HeaderList !Priority
148− | Body !(TQueue ByteString)
149−
150−data ClosedCode = Finished
151− | Killed
152− | Reset !ErrorCodeId
153− | ResetByMe SomeException
154− deriving Show
155−
156−data StreamState =
157− Idle
158− | Open !OpenState
159− | HalfClosed
160− | Closed !ClosedCode
161−
162−isIdle :: StreamState -> Bool
163−isIdle Idle = True
164−isIdle _ = False
165−
166−isOpen :: StreamState -> Bool
167−isOpen Open{} = True
168−isOpen _ = False
169−
170−isHalfClosed :: StreamState -> Bool
171−isHalfClosed HalfClosed = True
172−isHalfClosed _ = False
173−
174−isClosed :: StreamState -> Bool
175−isClosed Closed{} = True
176−isClosed _ = False
177−
178−instance Show StreamState where
179− show Idle = "Idle"
180− show Open{} = "Open"
181− show HalfClosed = "HalfClosed"
182− show (Closed e) = "Closed: " ++ show e
183−
184−----------------------------------------------------------------
185−
186−data Stream = Stream {
187− streamNumber :: !StreamId
188− , streamState :: !(IORef StreamState)
189− -- Next two fields are for error checking.
190− , streamContentLength :: !(IORef (Maybe Int))
191− , streamBodyLength :: !(IORef Int)
192− , streamWindow :: !(TVar WindowSize)
193− , streamPrecedence :: !(IORef Precedence)
194− }
195−
196−instance Show Stream where
197− show s = show (streamNumber s)
198−
199−newStream :: StreamId -> WindowSize -> IO Stream
200−newStream sid win = Stream sid <$> newIORef Idle
201− <*> newIORef Nothing
202− <*> newIORef 0
203− <*> newTVarIO win
204− <*> newIORef defaultPrecedence
205−
206−----------------------------------------------------------------
207−
208−opened :: Context -> Stream -> IO ()
209−opened Context{concurrency} Stream{streamState} = do
210− atomicModifyIORef' concurrency (\x -> (x+1,()))
211− writeIORef streamState (Open JustOpened)
212−
213−closed :: Context -> Stream -> ClosedCode -> IO ()
214−closed Context{concurrency,streamTable} Stream{streamState,streamNumber} cc = do
215− remove streamTable streamNumber
216− atomicModifyIORef' concurrency (\x -> (x-1,()))
217− writeIORef streamState (Closed cc) -- anyway
218−
219−----------------------------------------------------------------
220−
221−newtype StreamTable = StreamTable (IORef (IntMap Stream))
222−
223−newStreamTable :: IO StreamTable
224−newStreamTable = StreamTable <$> newIORef M.empty
225−
226−insert :: StreamTable -> M.Key -> Stream -> IO ()
227−insert (StreamTable ref) k v = atomicModifyIORef' ref $ \m ->
228− let !m' = M.insert k v m
229− in (m', ())
230−
231−remove :: StreamTable -> M.Key -> IO ()
232−remove (StreamTable ref) k = atomicModifyIORef' ref $ \m ->
233− let !m' = M.delete k m
234− in (m', ())
235−
236−search :: StreamTable -> M.Key -> IO (Maybe Stream)
237−search (StreamTable ref) k = M.lookup k <$> readIORef ref
238−
239−{-# INLINE forkAndEnqueueWhenReady #-}
240−forkAndEnqueueWhenReady :: STM () -> PriorityTree Output -> Output -> Manager -> IO ()
241−forkAndEnqueueWhenReady wait outQ out mgr = bracket setup teardown $ \_ ->
242− void . forkIO $ do
243− atomically wait
244− enqueueOutput outQ out
245− where
246− setup = addMyId mgr
247− teardown _ = deleteMyId mgr
248−
249−{-# INLINE enqueueOutput #-}
250−enqueueOutput :: PriorityTree Output -> Output -> IO ()
251−enqueueOutput outQ out = do
252− let Stream{..} = outputStream out
253− pre <- readIORef streamPrecedence
254− enqueue outQ streamNumber pre out
255−
256−{-# INLINE enqueueControl #-}
257−enqueueControl :: TQueue Control -> Control -> IO ()
258−enqueueControl ctlQ ctl = atomically $ writeTQueue ctlQ ctl
warp/Network/Wai/Handler/Warp/HTTP2/Worker.hsdeleted−222
@@ -1,222 +0,0 @@
1−{-# LANGUAGE NamedFieldPuns #-}
2−{-# LANGUAGE PatternGuards #-}
3−{-# LANGUAGE CPP #-}
4−{-# LANGUAGE ScopedTypeVariables #-}
5−{-# LANGUAGE OverloadedStrings #-}
6−{-# LANGUAGE BangPatterns #-}
7−
8−module Network.Wai.Handler.Warp.HTTP2.Worker (
9− Responder
10− , response
11− , worker
12− ) where
13−
14−#if __GLASGOW_HASKELL__ < 709
15−import Control.Applicative
16−import Data.Monoid (mempty)
17−#endif
18−import Control.Concurrent.STM
19−import Control.Exception (SomeException(..), AsyncException(..))
20−import qualified Control.Exception as E
21−import Control.Monad (when)
22−import Data.ByteString.Builder (byteString)
23−import qualified Network.HTTP.Types as H
24−import Network.HTTP2
25−import Network.Wai
26−import Network.Wai.Handler.Warp.File
27−import Network.Wai.Handler.Warp.FileInfoCache
28−import Network.Wai.Handler.Warp.HTTP2.EncodeFrame
29−import Network.Wai.Handler.Warp.HTTP2.Manager
30−import Network.Wai.Handler.Warp.HTTP2.Types
31−import Network.Wai.Handler.Warp.Header
32−import Network.Wai.Handler.Warp.IORef
33−import qualified Network.Wai.Handler.Warp.Response as R
34−import qualified Network.Wai.Handler.Warp.Settings as S
35−import qualified Network.Wai.Handler.Warp.Timeout as T
36−import Network.Wai.Handler.Warp.Types
37−import Network.Wai.Internal (Response(..), ResponseReceived(..), ResponseReceived(..))
38−
39−----------------------------------------------------------------
40−
41−-- | The wai definition is 'type Application = Request -> (Response -> IO ResponseReceived) -> IO ResponseReceived'.
42−-- This type implements the second argument (Response -> IO ResponseReceived)
43−-- with extra arguments.
44−type Responder = InternalInfo -> ThreadContinue -> Stream -> Request ->
45− Response -> IO ResponseReceived
46−
47−-- | This function is passed to workers.
48−-- They also pass 'Response's from 'Application's to this function.
49−-- This function enqueues commands for the HTTP/2 sender.
50−response :: S.Settings -> Context -> Manager -> Responder
51−response settings Context{outputQ} mgr ii tconf strm req rsp
52− | R.hasBody s0 = case rsp of
53− ResponseStream _ _ strmbdy
54− | isHead -> responseNoBody s0 hs0
55− | otherwise -> responseStreaming strmbdy
56− ResponseBuilder _ _ b
57− | isHead -> responseNoBody s0 hs0
58− | otherwise -> responseBuilderBody s0 hs0 b
59− ResponseFile _ _ p mp -> responseFileXXX p mp
60− ResponseRaw _ _ -> error "HTTP/2 does not support ResponseRaw"
61− | otherwise = responseNoBody s0 hs0
62− where
63− !isHead = requestMethod req == H.methodHead
64− !s0 = responseStatus rsp
65− !hs0 = responseHeaders rsp
66− !logger = S.settingsLogger settings
67− !th = threadHandle ii
68−
69− -- Ideally, log messages should be written when responses are
70− -- actually sent. But there is no way to keep good memory usage
71− -- (resist to Request leak) and throughput. By compromise,
72− -- log message are written here even the window size of streams
73− -- is 0.
74−
75− responseNoBody s hs = do
76− logger req s Nothing
77− setThreadContinue tconf True
78− let rspn = RspnNobody s hs
79− out = ORspn strm rspn ii
80− enqueueOutput outputQ out
81− return ResponseReceived
82−
83− responseBuilderBody s hs bdy = do
84− logger req s Nothing
85− setThreadContinue tconf True
86− let rspn = RspnBuilder s hs bdy
87− out = ORspn strm rspn ii
88− enqueueOutput outputQ out
89− return ResponseReceived
90−
91− responseFileXXX path Nothing = do
92− efinfo <- E.try $ getFileInfo ii path
93− case efinfo of
94− Left (_ex :: E.IOException) -> response404
95− Right finfo -> case conditionalRequest finfo hs0 (indexRequestHeader (requestHeaders req)) of
96− WithoutBody s -> responseNoBody s hs0
97− WithBody s hs beg len -> responseFile2XX s hs path (Just (FilePart beg len (fileInfoSize finfo)))
98−
99− responseFileXXX path mpart = responseFile2XX s0 hs0 path mpart
100−
101− responseFile2XX s hs path mpart
102− | isHead = do
103− logger req s Nothing
104− responseNoBody s hs
105− | otherwise = do
106− logger req s (filePartByteCount <$> mpart)
107− setThreadContinue tconf True
108− let rspn = RspnFile s hs path mpart
109− out = ORspn strm rspn ii
110− enqueueOutput outputQ out
111− return ResponseReceived
112−
113− response404 = responseBuilderBody s hs body
114− where
115− s = H.notFound404
116− hs = R.replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
117− body = byteString "File not found"
118−
119− responseStreaming strmbdy = do
120− logger req s0 Nothing
121− -- We must not exit this WAI application.
122− -- If the application exits, streaming would be also closed.
123− -- So, this work occupies this thread.
124− --
125− -- We need to increase the number of workers.
126− spawnAction mgr
127− -- After this work, this thread stops to decease
128− -- the number of workers.
129− setThreadContinue tconf False
130− -- Since 'StreamingBody' is loop, we cannot control it.
131− -- So, let's serialize 'Builder' with a designated queue.
132− tbq <- newTBQueueIO 10 -- fixme: hard coding: 10
133− let rspn = RspnStreaming s0 hs0 tbq
134− out = ORspn strm rspn ii
135− enqueueOutput outputQ out
136− let push b = do
137− atomically $ writeTBQueue tbq (SBuilder b)
138− T.tickle th
139− flush = atomically $ writeTBQueue tbq SFlush
140− _ <- strmbdy push flush
141− atomically $ writeTBQueue tbq SFinish
142− deleteMyId mgr
143− return ResponseReceived
144−
145−worker :: Context -> S.Settings -> Application -> Responder -> T.Manager -> IO ()
146−worker ctx@Context{inputQ,controlQ} set app responder tm = do
147− sinfo <- newStreamInfo
148− tcont <- newThreadContinue
149− E.bracket (T.registerKillThread tm) T.cancel $ go sinfo tcont
150− where
151− go sinfo tcont th = do
152− setThreadContinue tcont True
153− ex <- E.try $ do
154− T.pause th
155− inp@(Input strm req ii) <- atomically $ readTQueue inputQ
156− setStreamInfo sinfo inp
157− T.resume th
158− T.tickle th
159− app req $ responder ii tcont strm req
160− cont1 <- case ex of
161− Right ResponseReceived -> return True
162− Left e@(SomeException _)
163− -- killed by the local worker manager
164− | Just ThreadKilled <- E.fromException e -> return False
165− -- killed by the local timeout manager
166− | Just T.TimeoutThread <- E.fromException e -> do
167− cleanup sinfo Nothing
168− return True
169− | otherwise -> do
170− cleanup sinfo $ Just e
171− return True
172− cont2 <- getThreadContinue tcont
173− clearStreamInfo sinfo
174− when (cont1 && cont2) $ go sinfo tcont th
175− cleanup sinfo me = do
176− minp <- getStreamInfo sinfo
177− case minp of
178− Nothing -> return ()
179− Just (Input strm req _ii) -> do
180− closed ctx strm Killed
181− let frame = resetFrame InternalError (streamNumber strm)
182− enqueueControl controlQ $ CFrame frame
183− case me of
184− Nothing -> return ()
185− Just e -> S.settingsOnException set (Just req) e
186−
187−----------------------------------------------------------------
188−
189−-- | It would nice if responders could return values to workers.
190−-- Unfortunately, 'ResponseReceived' is already defined in WAI 2.0.
191−-- It is not wise to change this type.
192−-- So, a reference is shared by a responder and its worker.
193−-- The reference refers a value of this type as a return value.
194−-- If 'True', the worker continue to serve requests.
195−-- Otherwise, the worker get finished.
196−newtype ThreadContinue = ThreadContinue (IORef Bool)
197−
198−newThreadContinue :: IO ThreadContinue
199−newThreadContinue = ThreadContinue <$> newIORef True
200−
201−setThreadContinue :: ThreadContinue -> Bool -> IO ()
202−setThreadContinue (ThreadContinue ref) x = writeIORef ref x
203−
204−getThreadContinue :: ThreadContinue -> IO Bool
205−getThreadContinue (ThreadContinue ref) = readIORef ref
206−
207−----------------------------------------------------------------
208−
209−-- | The type to store enough information for 'settingsOnException'.
210−newtype StreamInfo = StreamInfo (IORef (Maybe Input))
211−
212−newStreamInfo :: IO StreamInfo
213−newStreamInfo = StreamInfo <$> newIORef Nothing
214−
215−clearStreamInfo :: StreamInfo -> IO ()
216−clearStreamInfo (StreamInfo ref) = writeIORef ref Nothing
217−
218−setStreamInfo :: StreamInfo -> Input -> IO ()
219−setStreamInfo (StreamInfo ref) inp = writeIORef ref $ Just inp
220−
221−getStreamInfo :: StreamInfo -> IO (Maybe Input)
222−getStreamInfo (StreamInfo ref) = readIORef ref
warp/Network/Wai/Handler/Warp/HashMap.hs+27−14
@@ -1,29 +1,42 @@
1+{-# LANGUAGE BangPatterns #-}
2+
1module Network.Wai.Handler.Warp.HashMap where
3module Network.Wai.Handler.Warp.HashMap where
2
4
3−import Data.ByteString (ByteString)
4import Data.Hashable (hash)
5import Data.Hashable (hash)
5import Data.IntMap.Strict (IntMap)
6import Data.IntMap.Strict (IntMap)
6import qualified Data.IntMap.Strict as I
7import qualified Data.IntMap.Strict as I
7import Data.Map.Strict (Map)
8import Data.Map.Strict (Map)
8import qualified Data.Map.Strict as M
9import qualified Data.Map.Strict as M
10+import Prelude hiding (lookup)
11+
12+----------------------------------------------------------------
9
13
10−type Hash = Int
14+-- | 'HashMap' is used for cache of file information.
11−newtype HashMap k v = HashMap (IntMap (Map k v))
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))
12
21
13−hashByteString :: ByteString -> Hash
22+----------------------------------------------------------------
14−hashByteString = hash
15
23
16−empty :: HashMap k v
24+empty :: HashMap v
17−empty = HashMap $ I.empty
25+empty = HashMap I.empty
18
26
19−null :: HashMap k v -> Bool
27+isEmpty :: HashMap v -> Bool
20−null (HashMap hm) = I.null hm
28+isEmpty (HashMap hm) = I.null hm
21
29
22−insert :: Ord k => Hash -> k -> v -> HashMap k v -> HashMap k v
30+----------------------------------------------------------------
23−insert h k v (HashMap hm) = HashMap $ I.insertWith f h m hm
31+
32+insert :: FilePath -> v -> HashMap v -> HashMap v
33+insert path v (HashMap hm) = HashMap $ I.insertWith f h m hm
24 where
34 where
25− m = M.singleton k v
35+ !h = hash path
36+ !m = M.singleton path v
26 f = M.union -- fimxe
37 f = M.union -- fimxe
27
38
28−lookup :: Ord k => Hash -> k -> HashMap k v -> Maybe v
39+lookup :: FilePath -> HashMap v -> Maybe v
29−lookup h k (HashMap hm) = I.lookup h hm >>= M.lookup k
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+3
@@ -7,6 +7,7 @@ import Data.Array.ST
7import qualified Data.ByteString as BS
7import qualified Data.ByteString as BS
8import Data.CaseInsensitive (foldedCase)
8import Data.CaseInsensitive (foldedCase)
9import Network.HTTP.Types
9import Network.HTTP.Types
10+
10import Network.Wai.Handler.Warp.Types
11import Network.Wai.Handler.Warp.Types
11
12
12----------------------------------------------------------------
13----------------------------------------------------------------
@@ -68,6 +69,7 @@ indexResponseHeader hdr = traverseHeader hdr responseMaxIndex responseKeyIndex
68data ResponseHeaderIndex = ResContentLength
69data ResponseHeaderIndex = ResContentLength
69 | ResServer
70 | ResServer
70 | ResDate
71 | ResDate
72+ | ResLastModified
71 deriving (Enum,Bounded)
73 deriving (Enum,Bounded)
72
74
73-- | The size for 'IndexedHeader' for HTTP Response.
75-- | The size for 'IndexedHeader' for HTTP Response.
@@ -78,6 +80,7 @@ responseKeyIndex :: HeaderName -> Int
78responseKeyIndex hn = case BS.length bs of
80responseKeyIndex hn = case BS.length bs of
79 4 -> if bs == "date" then fromEnum ResDate else -1
81 4 -> if bs == "date" then fromEnum ResDate else -1
80 6 -> if bs == "server" then fromEnum ResServer else -1
82 6 -> if bs == "server" then fromEnum ResServer else -1
83+ 13 -> if bs == "last-modified" then fromEnum ResLastModified else -1
81 14 -> if bs == "content-length" then fromEnum ResContentLength else -1
84 14 -> if bs == "content-length" then fromEnum ResContentLength else -1
82 _ -> -1
85 _ -> -1
83 where
86 where
warp/Network/Wai/Handler/Warp/IO.hs+2−1
@@ -3,10 +3,11 @@
3
3
4module Network.Wai.Handler.Warp.IO where
4module Network.Wai.Handler.Warp.IO where
5
5
6−import Data.ByteString (ByteString)
7import Data.ByteString.Builder (Builder)
6import Data.ByteString.Builder (Builder)
8import Data.ByteString.Builder.Extra (runBuilder, Next(Done, More, Chunk))
7import Data.ByteString.Builder.Extra (runBuilder, Next(Done, More, Chunk))
8+
9import Network.Wai.Handler.Warp.Buffer
9import Network.Wai.Handler.Warp.Buffer
10+import Network.Wai.Handler.Warp.Imports
10import Network.Wai.Handler.Warp.Types
11import Network.Wai.Handler.Warp.Types
11
12
12toBufIOWith :: Buffer -> BufSize -> (ByteString -> IO ()) -> Builder -> IO ()
13toBufIOWith :: Buffer -> BufSize -> (ByteString -> IO ()) -> Builder -> IO ()
warp/Network/Wai/Handler/Warp/IORef.hsdeleted−26
@@ -1,26 +0,0 @@
1−{-# LANGUAGE CPP #-}
2−
3−#ifndef MIN_VERSION_base
4−#define MIN_VERSION_base(x,y,z) 1
5−#endif
6−
7−module Network.Wai.Handler.Warp.IORef (
8− module Data.IORef
9−#if !MIN_VERSION_base(4,6,0)
10− , atomicModifyIORef'
11−#endif
12− ) where
13−
14−import Data.IORef
15−
16−#if !MIN_VERSION_base(4,6,0)
17−-- | Strict version of 'atomicModifyIORef'. This forces both the value stored
18−-- in the 'IORef' as well as the value returned.
19−atomicModifyIORef' :: IORef a -> (a -> (a,b)) -> IO b
20−atomicModifyIORef' ref f = do
21− c <- atomicModifyIORef ref
22− (\x -> let (a, b) = f x -- Lazy application of "f"
23− in (a, a `seq` b)) -- Lazy application of "seq"
24− -- The following forces "a `seq` b", so it also forces "f x".
25− c `seq` return c
26−#endif
warp/Network/Wai/Handler/Warp/Imports.hsnew file+27
@@ -0,0 +1,27 @@
1+module Network.Wai.Handler.Warp.Imports (
2+ ByteString(..)
3+ , NonEmpty(..)
4+ , module Control.Applicative
5+ , module Control.Monad
6+ , module Data.Bits
7+ , module Data.List
8+ , module Data.Int
9+ , module Data.Monoid
10+ , module Data.Ord
11+ , module Data.Word
12+ , module Data.Maybe
13+ , module Numeric
14+ ) where
15+
16+import Control.Applicative
17+import Control.Monad
18+import Data.Bits
19+import Data.ByteString.Internal (ByteString(..))
20+import Data.Int
21+import Data.List
22+import Data.List.NonEmpty (NonEmpty(..))
23+import Data.Maybe
24+import Data.Monoid
25+import Data.Ord
26+import Data.Word
27+import Numeric
warp/Network/Wai/Handler/Warp/Internal.hs+7−2
@@ -53,7 +53,7 @@ module Network.Wai.Handler.Warp.Internal (
53 -- resumed as soon as we return from user code.
53 -- resumed as soon as we return from user code.
54 --
54 --
55 -- * Every time data is successfully sent to the client, the timeout is tickled.
55 -- * Every time data is successfully sent to the client, the timeout is tickled.
56− , module Network.Wai.Handler.Warp.Timeout
56+ , module System.TimeManager
57 -- * File descriptor cache
57 -- * File descriptor cache
58 , module Network.Wai.Handler.Warp.FdCache
58 , module Network.Wai.Handler.Warp.FdCache
59 -- * File information cache
59 -- * File information cache
@@ -64,8 +64,13 @@ module Network.Wai.Handler.Warp.Internal (
64 , Source
64 , Source
65 , recvRequest
65 , recvRequest
66 , sendResponse
66 , sendResponse
67+ -- * Platform dependent helper functions
68+ , setSocketCloseOnExec
69+ , windowsThreadBlockHack
67 ) where
70 ) where
68
71
72+import System.TimeManager
73+
69import Network.Wai.Handler.Warp.Buffer
74import Network.Wai.Handler.Warp.Buffer
70import Network.Wai.Handler.Warp.Date
75import Network.Wai.Handler.Warp.Date
71import Network.Wai.Handler.Warp.FdCache
76import Network.Wai.Handler.Warp.FdCache
@@ -77,5 +82,5 @@ import Network.Wai.Handler.Warp.Response
77import Network.Wai.Handler.Warp.Run
82import Network.Wai.Handler.Warp.Run
78import Network.Wai.Handler.Warp.SendFile
83import Network.Wai.Handler.Warp.SendFile
79import Network.Wai.Handler.Warp.Settings
84import Network.Wai.Handler.Warp.Settings
80−import Network.Wai.Handler.Warp.Timeout
81import Network.Wai.Handler.Warp.Types
85import Network.Wai.Handler.Warp.Types
86+import Network.Wai.Handler.Warp.Windows
warp/Network/Wai/Handler/Warp/MultiMap.hs+65−194
@@ -1,240 +1,111 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE BangPatterns #-}
2
2
3module Network.Wai.Handler.Warp.MultiMap (
3module Network.Wai.Handler.Warp.MultiMap (
4− MMap
4+ MultiMap
5− , Some(..)
5+ , isEmpty
6 , empty
6 , empty
7 , singleton
7 , singleton
8 , insert
8 , insert
9− , search
9+ , Network.Wai.Handler.Warp.MultiMap.lookup
10− , searchWith
11− , isEmpty
12− , valid
13 , pruneWith
10 , pruneWith
14− , fromList
15 , toList
11 , toList
16− , fromSortedList
17− , toSortedList
18 , merge
12 , merge
19 ) where
13 ) where
20
14
21−#if __GLASGOW_HASKELL__ < 709
15+import Data.Hashable (hash)
22−import Control.Applicative ((<$>))
16+import Data.IntMap.Strict (IntMap)
23−#endif
17+import qualified Data.IntMap.Strict as I
24−import Data.List (foldl')
18+import Data.Semigroup
19+import Prelude -- Silence redundant import warnings
25
20
26----------------------------------------------------------------
21----------------------------------------------------------------
27
22
28−-- | One ore more list to implement multimap.
23+-- | 'MultiMap' is used for cache of file descriptors.
29−data Some a = One !a
24+-- Since multiple threads would open file descriptors for
30− | Tom !a !(Some a) -- Two or more
25+-- the same file simultaneously, multiple entries must
31− deriving (Eq,Show)
26+-- be contained for the file.
32−
27+-- Since hash values of file pathes are used as outer keys,
33−-- This is slow but assuming rarely used.
28+-- collison would happen for multiple file pathes.
34−snoc :: Some a -> a -> Some a
29+-- Becase only positive entries are contained,
35−snoc (One x) y = Tom x (One y)
30+-- a bad guy cannot be cause the hash collision intentinally.
36−snoc (Tom x xs) y = Tom x (snoc xs y)
31+-- So, lists are good enough.
37−
32+newtype MultiMap v = MultiMap (IntMap [(FilePath,v)])
38−top :: Some a -> a
39−top (One x) = x
40−top (Tom x _) = x
41−
42−----------------------------------------------------------------
43−
44−-- | Red black tree as multimap.
45−data MMap k v = Leaf -- color is Black
46− | Node Color !(MMap k v) !k !(Some v) !(MMap k v)
47− deriving (Show)
48−
49−data Color = B -- ^ Black
50− | R -- ^ Red
51− deriving (Eq, Show)
52−
53−----------------------------------------------------------------
54−
55−instance (Eq k, Eq v) => Eq (MMap k v) where
56− t1 == t2 = toSortedList t1 == toSortedList t2
57−
58−----------------------------------------------------------------
59−
60−-- | O(log N)
61−search :: Ord k => k -> MMap k v -> Maybe v
62−search _ Leaf = Nothing
63−search xk (Node _ l k v r) = case compare xk k of
64− LT -> search xk l
65− GT -> search xk r
66− EQ -> Just $ top v
67−
68−-- | O(log N)
69−searchWith :: Ord k => k -> (Some v -> Maybe v) -> MMap k v -> Maybe v
70−searchWith _ _ Leaf = Nothing
71−searchWith xk f (Node _ l k v r) = case compare xk k of
72− LT -> searchWith xk f l
73− GT -> searchWith xk f r
74− EQ -> f v
75
33
76----------------------------------------------------------------
34----------------------------------------------------------------
77
35
78-- | O(1)
36-- | O(1)
79−isEmpty :: MMap k v -> Bool
37+empty :: MultiMap v
80−isEmpty Leaf = True
38+empty = MultiMap $ I.empty
81−isEmpty _ = False
82
39
83-- | O(1)
40-- | O(1)
84−empty :: MMap k v
41+isEmpty :: MultiMap v -> Bool
85−empty = Leaf
42+isEmpty (MultiMap mm) = I.null mm
86
43
87----------------------------------------------------------------
44----------------------------------------------------------------
88
45
89-- | O(1)
46-- | O(1)
90−singleton :: Ord k => k -> v -> MMap k v
47+singleton :: FilePath -> v -> MultiMap v
91−singleton k v = Node B Leaf k (One v) Leaf
48+singleton path v = MultiMap mm
92−
49+ where
93−----------------------------------------------------------------
50+ !h = hash path
94−
51+ !mm = I.singleton h [(path,v)]
95−-- | O(log N)
96−insert :: Ord k => k -> v -> MMap k v -> MMap k v
97−insert kx kv t = turnB (insert' kx kv t)
98−
99−insert' :: Ord k => k -> v -> MMap k v -> MMap k v
100−insert' xk xv Leaf = Node R Leaf xk (One xv) Leaf
101−insert' xk xv (Node B l k v r) = case compare xk k of
102− LT -> balanceL' (insert' xk xv l) k v r
103− GT -> balanceR' l k v (insert' xk xv r)
104− EQ -> Node B l k (snoc v xv) r
105−insert' xk xv (Node R l k v r) = case compare xk k of
106− LT -> Node R (insert' xk xv l) k v r
107− GT -> Node R l k v (insert' xk xv r)
108− EQ -> Node R l k (snoc v xv) r
109−
110−balanceL' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
111−balanceL' (Node R (Node R a xk xv b) yk yv c) zk zv d =
112− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
113−balanceL' (Node R a xk xv (Node R b yk yv c)) zk zv d =
114− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
115−balanceL' l k v r = Node B l k v r
116−
117−balanceR' :: MMap k v -> k -> Some v -> MMap k v -> MMap k v
118−balanceR' a xk xv (Node R b yk yv (Node R c zk zv d)) =
119− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
120−balanceR' a xk xv (Node R (Node R b yk yv c) zk zv d) =
121− Node R (Node B a xk xv b) yk yv (Node B c zk zv d)
122−balanceR' l xk xv r = Node B l xk xv r
123−
124−turnB :: MMap k v -> MMap k v
125−turnB Leaf = error "turnB"
126−turnB (Node _ l k v r) = Node B l k v r
127
52
128----------------------------------------------------------------
53----------------------------------------------------------------
129
54
130−-- | O(N log N)
131−fromList :: Ord k => [(k,v)] -> MMap k v
132−fromList = foldl' (\t (k,v) -> insert k v t) empty
133−
134-- | O(N)
55-- | O(N)
135−toList :: MMap k v -> [(k,v)]
56+lookup :: FilePath -> MultiMap v -> Maybe v
136−toList t = inorder t []
57+lookup path (MultiMap mm) = case I.lookup h mm of
58+ Nothing -> Nothing
59+ Just s -> Prelude.lookup path s
137 where
60 where
138− inorder Leaf xs = xs
61+ !h = hash path
139− inorder (Node _ l k v r) xs = inorder l (pairs k v ++ inorder r xs)
140− pairs k (One v) = [(k,v)]
141− pairs k (Tom v vs) = (k,v) : pairs k vs
142
62
143----------------------------------------------------------------
63----------------------------------------------------------------
144
64
145−-- | O(N)
65+-- | O(log n)
146−-- "Constructing Red-Black Trees" by Ralf Hinze
66+insert :: FilePath -> v -> MultiMap v -> MultiMap v
147−fromSortedList :: Ord k => [(k,Some v)] -> MMap k v
67+insert path v (MultiMap mm) = MultiMap mm'
148−fromSortedList = linkAll . foldr add []
68+ where
149−
69+ !h = hash path
150−data Digit k v = Uno k (Some v) (MMap k v)
70+ !mm' = I.insertWith (<>) h [(path,v)] mm
151− | Due k (Some v) (MMap k v) k (Some v) (MMap k v)
152− deriving (Eq,Show)
153−
154−incr :: Digit k v -> [Digit k v] -> [Digit k v]
155−incr (Uno k v t) [] = [Uno k v t]
156−incr (Uno k1 v1 t1) (Uno k2 v2 t2 : ps) = Due k1 v1 t1 k2 v2 t2 : ps
157−incr (Uno k1 v1 t1) (Due k2 v2 t2 k3 v3 t3 : ps) = Uno k1 v1 t1 : incr (Uno k2 v2 (Node B t2 k3 v3 t3)) ps
158−incr _ _ = error "incr"
159−
160−add :: (k,Some v) -> [Digit k v] -> [Digit k v]
161−add (k,v) ps = incr (Uno k v Leaf) ps
162−
163−linkAll :: [Digit k v] -> MMap k v
164−linkAll = foldl' link Leaf
165−
166−link :: MMap k v -> Digit k v -> MMap k v
167−link l (Uno k v t) = Node B l k v t
168−--link l (Due k1 v1 t1 k2 v2 t2) = Node B (Node R l k1 v1 t1) k2 v2 t2
169−link l (Due k1 v1 t1 k2 v2 t2) = Node B l k1 v1 (Node R t1 k2 v2 t2)
170
71
171----------------------------------------------------------------
72----------------------------------------------------------------
172
73
173−-- | O(N)
74+-- | O(n)
174−toSortedList :: MMap k v -> [(k,Some v)]
75+toList :: MultiMap v -> [(FilePath,v)]
175−toSortedList t = inorder t []
76+toList (MultiMap mm) = concatMap snd $ I.toAscList mm
176− where
177− inorder Leaf xs = xs
178− inorder (Node _ l k v r) xs = inorder l ((k,v) : inorder r xs)
179
77
180----------------------------------------------------------------
78----------------------------------------------------------------
181
79
182−-- | O(N)
80+-- | O(n)
183−pruneWith :: Ord k =>
81+pruneWith :: MultiMap v
184− MMap k v
82+ -> ((FilePath,v) -> IO Bool)
185− -> (k -> Some v -> IO [(k, Some v)])
83+ -> IO (MultiMap v)
186− -> IO (MMap k v)
84+pruneWith (MultiMap mm) action = MultiMap <$> mm'
187−pruneWith t run = fromSortedList <$> inorder t []
188 where
85 where
189− inorder Leaf xs = return xs
86+ !mm' = I.fromAscList <$> go (I.toDescList mm) []
190− inorder (Node _ l k v r) xs = do
87+ go [] !acc = return acc
191− ys <- run k v
88+ go ((h,s):kss) !acc = do
192− zs <- inorder r xs
89+ rs <- prune action s
193− inorder l (ys ++ zs)
90+ case rs of
91+ [] -> go kss acc
92+ _ -> go kss ((h,rs) : acc)
194
93
195----------------------------------------------------------------
94----------------------------------------------------------------
196
95
197−-- O(N log N) where N is the size of the second argument
96+-- O(n + m) where N is the size of the second argument
198−merge :: Ord k => MMap k v -> MMap k v -> MMap k v
97+merge :: MultiMap v -> MultiMap v -> MultiMap v
199−merge base m = foldl' ins base xs
98+merge (MultiMap m1) (MultiMap m2) = MultiMap mm
200 where
99 where
201− ins t (k,v) = insert k v t
100+ !mm = I.unionWith (<>) m1 m2
202− xs = toList m
203
101
204----------------------------------------------------------------
102----------------------------------------------------------------
205−-- for testing
206−
207−valid :: Ord k => MMap k v -> Bool
208−valid t = isBalanced t && isOrdered t
209
103
210−isBalanced :: MMap k v -> Bool
104+prune :: ((FilePath,v) -> IO Bool) -> [(FilePath,v)] -> IO [(FilePath,v)]
211−isBalanced t = isBlackSame t && isRedSeparate t
105+prune action xs0 = go xs0
212−
213−isBlackSame :: MMap k v -> Bool
214−isBlackSame t = all (n==) ns
215− where
216− n:ns = blacks t
217−
218−blacks :: MMap k v -> [Int]
219−blacks = blacks' 0
220− where
221− blacks' n Leaf = [n+1]
222− blacks' n (Node R l _ _ r) = blacks' n l ++ blacks' n r
223− blacks' n (Node B l _ _ r) = blacks' n' l ++ blacks' n' r
224− where
225− n' = n + 1
226−
227−isRedSeparate :: MMap k v -> Bool
228−isRedSeparate = reds B
229−
230−reds :: Color -> MMap k v -> Bool
231−reds _ Leaf = True
232−reds R (Node R _ _ _ _) = False
233−reds _ (Node c l _ _ r) = reds c l && reds c r
234−
235−isOrdered :: Ord k => MMap k v -> Bool
236−isOrdered t = ordered $ toSortedList t
237 where
106 where
238− ordered [] = True
107+ go [] = return []
239− ordered [_] = True
108+ go (x:xs) = do
240− ordered (x:y:xys) = fst x <= fst y && ordered (y:xys)
109+ keep <- action x
110+ rs <- go xs
111+ return $ if keep then x:rs else rs
warp/Network/Wai/Handler/Warp/PackInt.hsnew file+56
@@ -0,0 +1,56 @@
1+{-# LANGUAGE OverloadedStrings, BangPatterns #-}
2+
3+module Network.Wai.Handler.Warp.PackInt where
4+
5+import Data.ByteString.Internal (unsafeCreate)
6+import Foreign.Ptr (Ptr, plusPtr)
7+import Foreign.Storable (poke)
8+import qualified Network.HTTP.Types as H
9+
10+import Network.Wai.Handler.Warp.Imports
11+
12+-- $setup
13+-- >>> import Data.ByteString.Char8 as C8
14+-- >>> import Test.QuickCheck (Large(..))
15+
16+-- |
17+--
18+-- prop> packIntegral (abs n) == C8.pack (show (abs n))
19+-- prop> \(Large n) -> let n' = fromIntegral (abs n :: Int) in packIntegral n' == C8.pack (show n')
20+
21+packIntegral :: Integral a => a -> ByteString
22+packIntegral 0 = "0"
23+packIntegral n | n < 0 = error "packIntegral"
24+packIntegral n = unsafeCreate len go0
25+ where
26+ n' = fromIntegral n + 1 :: Double
27+ len = ceiling $ logBase 10 n'
28+ go0 p = go n $ p `plusPtr` (len - 1)
29+ go :: Integral a => a -> Ptr Word8 -> IO ()
30+ go i p = do
31+ let (d,r) = i `divMod` 10
32+ poke p (48 + fromIntegral r)
33+ when (d /= 0) $ go d (p `plusPtr` (-1))
34+
35+{-# SPECIALIZE packIntegral :: Int -> ByteString #-}
36+{-# SPECIALIZE packIntegral :: Integer -> ByteString #-}
37+
38+-- |
39+--
40+-- >>> packStatus H.status200
41+-- "200"
42+-- >>> packStatus H.preconditionFailed412
43+-- "412"
44+
45+packStatus :: H.Status -> ByteString
46+packStatus status = unsafeCreate 3 $ \p -> do
47+ poke p (toW8 r2)
48+ poke (p `plusPtr` 1) (toW8 r1)
49+ poke (p `plusPtr` 2) (toW8 r0)
50+ where
51+ toW8 :: Int -> Word8
52+ toW8 n = 48 + fromIntegral n
53+ !s = fromIntegral $ H.statusCode status
54+ (!q0,!r0) = s `divMod` 10
55+ (!q1,!r1) = q0 `divMod` 10
56+ !r2 = q1 `mod` 10
warp/Network/Wai/Handler/Warp/ReadInt.hs+2−2
@@ -13,13 +13,13 @@ module Network.Wai.Handler.Warp.ReadInt (
13-- This function lives in its own file because the MagicHash pragma interacts
13-- This function lives in its own file because the MagicHash pragma interacts
14-- poorly with the CPP pragma.
14-- poorly with the CPP pragma.
15
15
16−import Data.ByteString (ByteString)
17import qualified Data.ByteString as S
16import qualified Data.ByteString as S
18−import Data.Int (Int64)
19import GHC.Prim
17import GHC.Prim
20import GHC.Types
18import GHC.Types
21import GHC.Word
19import GHC.Word
22
20
21+import Network.Wai.Handler.Warp.Imports hiding (readInt)
22+
23{-# INLINE readInt #-}
23{-# INLINE readInt #-}
24readInt :: Integral a => ByteString -> a
24readInt :: Integral a => ByteString -> a
25readInt bs = fromIntegral $ readInt64 bs
25readInt bs = fromIntegral $ readInt64 bs
warp/Network/Wai/Handler/Warp/Recv.hs+44−17
@@ -9,23 +9,27 @@ module Network.Wai.Handler.Warp.Recv (
9 , spell
9 , spell
10 ) where
10 ) where
11
11
12−#if __GLASGOW_HASKELL__ < 709
13−import Control.Applicative ((<$>))
14−#endif
15import qualified Control.Exception as E
12import qualified Control.Exception as E
16import qualified Data.ByteString as BS
13import qualified Data.ByteString as BS
17−import Data.ByteString.Internal (ByteString(..))
14+import Data.IORef
18−import Data.Word (Word8)
19import Foreign.C.Error (eAGAIN, getErrno, throwErrno)
15import Foreign.C.Error (eAGAIN, getErrno, throwErrno)
20import Foreign.C.Types
16import Foreign.C.Types
21import Foreign.ForeignPtr (withForeignPtr)
17import Foreign.ForeignPtr (withForeignPtr)
22import Foreign.Ptr (Ptr, castPtr, plusPtr)
18import Foreign.Ptr (Ptr, castPtr, plusPtr)
23import GHC.Conc (threadWaitRead)
19import GHC.Conc (threadWaitRead)
24−import Network.Socket (Socket, fdSocket)
20+import qualified GHC.IO.Exception as E
21+import Network.Socket (Socket)
22+import qualified System.IO.Error as E
23+#if MIN_VERSION_network(3,1,0)
24+import Network.Socket (withFdSocket)
25+#else
26+import Network.Socket (fdSocket)
27+#endif
28+import System.Posix.Types (Fd(..))
29+
25import Network.Wai.Handler.Warp.Buffer
30import Network.Wai.Handler.Warp.Buffer
26−import Network.Wai.Handler.Warp.IORef
31+import Network.Wai.Handler.Warp.Imports
27import Network.Wai.Handler.Warp.Types
32import Network.Wai.Handler.Warp.Types
28−import System.Posix.Types (Fd(..))
29
33
30#ifdef mingw32_HOST_OS
34#ifdef mingw32_HOST_OS
31import GHC.IO.FD (FD(..), readRawBufferPtr)
35import GHC.IO.FD (FD(..), readRawBufferPtr)
@@ -92,24 +96,45 @@ spell init0 siz0 recv recvBuf
92 siz' = siz - len
96 siz' = siz - len
93 loop bss' siz'
97 loop bss' siz'
94
98
99+-- The timeout manager may close the socket.
100+-- In that case, an error of "Bad file descriptor" occurs.
101+-- We ignores it because we expect TimeoutThread.
95receive :: Socket -> BufferPool -> Recv
102receive :: Socket -> BufferPool -> Recv
96−receive sock pool = withBufferPool pool $ \ (ptr, size) -> do
103+receive sock pool = E.handle handler $ withBufferPool pool $ \ (ptr, size) -> do
97− let sock' = fdSocket sock
104+#if MIN_VERSION_network(3,1,0)
98− size' = fromIntegral size
105+ withFdSocket sock $ \fd -> do
99− fromIntegral <$> receiveloop sock' ptr size'
106+#elif MIN_VERSION_network(3,0,0)
107+ fd <- fdSocket sock
108+#else
109+ let fd = fdSocket sock
110+#endif
111+ let size' = fromIntegral size
112+ fromIntegral <$> receiveloop fd ptr size'
113+ where
114+ handler :: E.IOException -> IO ByteString
115+ handler e
116+ | E.ioeGetErrorType e == E.InvalidArgument = return ""
117+ | otherwise = E.throwIO e
100
118
101receiveBuf :: Socket -> RecvBuf
119receiveBuf :: Socket -> RecvBuf
102−receiveBuf sock buf0 siz0 = loop buf0 siz0
120+receiveBuf sock buf0 siz0 = do
121+#if MIN_VERSION_network(3,1,0)
122+ withFdSocket sock $ \fd -> do
123+#elif MIN_VERSION_network(3,0,0)
124+ fd <- fdSocket sock
125+#else
126+ let fd = fdSocket sock
127+#endif
128+ loop fd buf0 siz0
103 where
129 where
104− loop _ 0 = return True
130+ loop _ _ 0 = return True
105− loop buf siz = do
131+ loop fd buf siz = do
106 n <- fromIntegral <$> receiveloop fd buf (fromIntegral siz)
132 n <- fromIntegral <$> receiveloop fd buf (fromIntegral siz)
107 -- fixme: what should we do in the case of n == 0
133 -- fixme: what should we do in the case of n == 0
108 if n == 0 then
134 if n == 0 then
109 return False
135 return False
110 else
136 else
111− loop (buf `plusPtr` n) (siz - n)
137+ loop fd (buf `plusPtr` n) (siz - n)
112− fd = fdSocket sock
113
138
114receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
139receiveloop :: CInt -> Ptr Word8 -> CSize -> IO CInt
115receiveloop sock ptr size = do
140receiveloop sock ptr size = do
@@ -128,6 +153,8 @@ receiveloop sock ptr size = do
128 else
153 else
129 return bytes
154 return bytes
130
155
156+#ifndef mingw32_HOST_OS
131-- fixme: the type of the return value
157-- fixme: the type of the return value
132foreign import ccall unsafe "recv"
158foreign import ccall unsafe "recv"
133 c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt
159 c_recv :: CInt -> Ptr CChar -> CSize -> CInt -> IO CInt
160+#endif
warp/Network/Wai/Handler/Warp/Request.hs+48−38
@@ -1,6 +1,7 @@
1{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE CPP #-}
3{-# LANGUAGE CPP #-}
4+{-# LANGUAGE DeriveDataTypeable #-}
4{-# OPTIONS_GHC -fno-warn-deprecations #-}
5{-# OPTIONS_GHC -fno-warn-deprecations #-}
5
6
6module Network.Wai.Handler.Warp.Request (
7module Network.Wai.Handler.Warp.Request (
@@ -8,61 +9,60 @@ module Network.Wai.Handler.Warp.Request (
8 , headerLines
9 , headerLines
9 , pauseTimeoutKey
10 , pauseTimeoutKey
10 , getFileInfoKey
11 , getFileInfoKey
12+ , getClientCertificateKey
13+ , NoKeepAliveRequest (..)
11 ) where
14 ) where
12
15
13import qualified Control.Concurrent as Conc (yield)
16import qualified Control.Concurrent as Conc (yield)
14−import Control.Exception (throwIO)
17+import Control.Exception (throwIO, Exception)
15import Data.Array ((!))
18import Data.Array ((!))
16−import Data.ByteString (ByteString)
17import qualified Data.ByteString as S
19import qualified Data.ByteString as S
18import qualified Data.ByteString.Unsafe as SU
20import qualified Data.ByteString.Unsafe as SU
19import qualified Data.CaseInsensitive as CI
21import qualified Data.CaseInsensitive as CI
20import qualified Data.IORef as I
22import qualified Data.IORef as I
23+import Data.Typeable (Typeable)
24+import qualified Data.Vault.Lazy as Vault
25+import Data.X509
21import qualified Network.HTTP.Types as H
26import qualified Network.HTTP.Types as H
22import Network.Socket (SockAddr)
27import Network.Socket (SockAddr)
23import Network.Wai
28import Network.Wai
24−import Network.Wai.Handler.Warp.Conduit
25−import Network.Wai.Handler.Warp.FileInfoCache
26−import Network.Wai.Handler.Warp.HashMap (hashByteString)
27−import Network.Wai.Handler.Warp.Header
28−import Network.Wai.Handler.Warp.ReadInt
29−import Network.Wai.Handler.Warp.RequestHeader
30−import Network.Wai.Handler.Warp.Settings (Settings, settingsNoParsePath)
31−import qualified Network.Wai.Handler.Warp.Timeout as Timeout
32import Network.Wai.Handler.Warp.Types
29import Network.Wai.Handler.Warp.Types
33import Network.Wai.Internal
30import Network.Wai.Internal
34import Prelude hiding (lines)
31import Prelude hiding (lines)
35−import Control.Monad (when)
36−import qualified Data.Vault.Lazy as Vault
37import System.IO.Unsafe (unsafePerformIO)
32import System.IO.Unsafe (unsafePerformIO)
33+import qualified System.TimeManager as Timeout
38
34
39−----------------------------------------------------------------
35+import Network.Wai.Handler.Warp.Conduit
40−
36+import Network.Wai.Handler.Warp.FileInfoCache
41−-- FIXME come up with good values here
37+import Network.Wai.Handler.Warp.Header
42−maxTotalHeaderLength :: Int
38+import Network.Wai.Handler.Warp.Imports hiding (readInt, lines)
43−maxTotalHeaderLength = 50 * 1024
39+import Network.Wai.Handler.Warp.ReadInt
40+import Network.Wai.Handler.Warp.RequestHeader
41+import Network.Wai.Handler.Warp.Settings (Settings, settingsNoParsePath, settingsMaxTotalHeaderLength)
44
42
45----------------------------------------------------------------
43----------------------------------------------------------------
46
44
47-- | Receiving a HTTP request from 'Connection' and parsing its header
45-- | Receiving a HTTP request from 'Connection' and parsing its header
48-- to create 'Request'.
46-- to create 'Request'.
49−recvRequest :: Settings
47+recvRequest :: Bool -- ^ first request on this connection?
48+ -> Settings
50 -> Connection
49 -> Connection
51− -> InternalInfo1
50+ -> InternalInfo
51+ -> Timeout.Handle
52 -> SockAddr -- ^ Peer's address.
52 -> SockAddr -- ^ Peer's address.
53 -> Source -- ^ Where HTTP request comes from.
53 -> Source -- ^ Where HTTP request comes from.
54+ -> Transport
54 -> IO (Request
55 -> IO (Request
55 ,Maybe (I.IORef Int)
56 ,Maybe (I.IORef Int)
56 ,IndexedHeader
57 ,IndexedHeader
57− ,IO ByteString
58+ ,IO ByteString) -- ^
58− ,InternalInfo) -- ^
59 -- 'Request' passed to 'Application',
59 -- 'Request' passed to 'Application',
60 -- how many bytes remain to be consumed, if known
60 -- how many bytes remain to be consumed, if known
61 -- 'IndexedHeader' of HTTP request for internal use,
61 -- 'IndexedHeader' of HTTP request for internal use,
62 -- Body producing action used for flushing the request body
62 -- Body producing action used for flushing the request body
63
63
64−recvRequest settings conn ii1 addr src = do
64+recvRequest firstRequest settings conn ii th addr src transport = do
65− hdrlines <- headerLines src
65+ hdrlines <- headerLines (settingsMaxTotalHeaderLength settings) firstRequest src
66 (method, unparsedPath, path, query, httpversion, hdr) <- parseHeaderLines hdrlines
66 (method, unparsedPath, path, query, httpversion, hdr) <- parseHeaderLines hdrlines
67 let idxhdr = indexRequestHeader hdr
67 let idxhdr = indexRequestHeader hdr
68 expect = idxhdr ! fromEnum ReqExpect
68 expect = idxhdr ! fromEnum ReqExpect
@@ -70,11 +70,9 @@ recvRequest settings conn ii1 addr src = do
70 te = idxhdr ! fromEnum ReqTransferEncoding
70 te = idxhdr ! fromEnum ReqTransferEncoding
71 handle100Continue = handleExpect conn httpversion expect
71 handle100Continue = handleExpect conn httpversion expect
72 rawPath = if settingsNoParsePath settings then unparsedPath else path
72 rawPath = if settingsNoParsePath settings then unparsedPath else path
73− h = hashByteString rawPath
74− ii = toInternalInfo ii1 h
75− th = threadHandle ii
76 vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
73 vaultValue = Vault.insert pauseTimeoutKey (Timeout.pause th)
77 $ Vault.insert getFileInfoKey (getFileInfo ii)
74 $ Vault.insert getFileInfoKey (getFileInfo ii)
75+ $ Vault.insert getClientCertificateKey (tlsClientCertificate transport)
78 Vault.empty
76 Vault.empty
79 (rbody, remainingRef, bodyLength) <- bodyAndSource src cl te
77 (rbody, remainingRef, bodyLength) <- bodyAndSource src cl te
80 -- body producing function which will produce '100-continue', if needed
78 -- body producing function which will produce '100-continue', if needed
@@ -89,7 +87,7 @@ recvRequest settings conn ii1 addr src = do
89 , rawQueryString = query
87 , rawQueryString = query
90 , queryString = H.parseQuery query
88 , queryString = H.parseQuery query
91 , requestHeaders = hdr
89 , requestHeaders = hdr
92− , isSecure = False
90+ , isSecure = isTransportSecure transport
93 , remoteHost = addr
91 , remoteHost = addr
94 , requestBody = rbody'
92 , requestBody = rbody'
95 , vault = vaultValue
93 , vault = vaultValue
@@ -99,16 +97,24 @@ recvRequest settings conn ii1 addr src = do
99 , requestHeaderReferer = idxhdr ! fromEnum ReqReferer
97 , requestHeaderReferer = idxhdr ! fromEnum ReqReferer
100 , requestHeaderUserAgent = idxhdr ! fromEnum ReqUserAgent
98 , requestHeaderUserAgent = idxhdr ! fromEnum ReqUserAgent
101 }
99 }
102− return (req, remainingRef, idxhdr, rbodyFlush, ii)
100+ return (req, remainingRef, idxhdr, rbodyFlush)
103
101
104----------------------------------------------------------------
102----------------------------------------------------------------
105
103
106−headerLines :: Source -> IO [ByteString]
104+headerLines :: Int -> Bool -> Source -> IO [ByteString]
107−headerLines src = do
105+headerLines maxTotalHeaderLength firstRequest src = do
108 bs <- readSource src
106 bs <- readSource src
109 if S.null bs
107 if S.null bs
110− then throwIO ConnectionClosedByPeer
108+ -- When we're working on a keep-alive connection and trying to
111− else push src (THStatus 0 id id) bs
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
112
118
113----------------------------------------------------------------
119----------------------------------------------------------------
114
120
@@ -214,8 +220,8 @@ close :: Sink ByteString IO a
214close = throwIO IncompleteHeaders
220close = throwIO IncompleteHeaders
215-}
221-}
216
222
217−push :: Source -> THStatus -> ByteString -> IO [ByteString]
223+push :: Int -> Source -> THStatus -> ByteString -> IO [ByteString]
218−push src (THStatus len lines prepend) bs'
224+push maxTotalHeaderLength src (THStatus len lines prepend) bs'
219 -- Too many bytes
225 -- Too many bytes
220 | len > maxTotalHeaderLength = throwIO OverLargeHeader
226 | len > maxTotalHeaderLength = throwIO OverLargeHeader
221 | otherwise = push' mnl
227 | otherwise = push' mnl
@@ -243,13 +249,13 @@ push src (THStatus len lines prepend) bs'
243 push' Nothing = do
249 push' Nothing = do
244 bst <- readSource' src
250 bst <- readSource' src
245 when (S.null bst) $ throwIO IncompleteHeaders
251 when (S.null bst) $ throwIO IncompleteHeaders
246− push src status bst
252+ push maxTotalHeaderLength src status bst
247 where
253 where
248 len' = len + bsLen
254 len' = len + bsLen
249 prepend' = S.append bs
255 prepend' = S.append bs
250 status = THStatus len' lines prepend'
256 status = THStatus len' lines prepend'
251 -- Found a newline, but next line continues as a multiline header
257 -- Found a newline, but next line continues as a multiline header
252− push' (Just (end, True)) = push src status rest
258+ push' (Just (end, True)) = push maxTotalHeaderLength src status rest
253 where
259 where
254 rest = S.drop (end + 1) bs
260 rest = S.drop (end + 1) bs
255 prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
261 prepend' = S.append (SU.unsafeTake (checkCR bs end) bs)
@@ -268,12 +274,12 @@ push src (THStatus len lines prepend) bs'
268 in if start < bsLen then
274 in if start < bsLen then
269 -- more bytes in this chunk, push again
275 -- more bytes in this chunk, push again
270 let bs'' = SU.unsafeDrop start bs
276 let bs'' = SU.unsafeDrop start bs
271− in push src status bs''
277+ in push maxTotalHeaderLength src status bs''
272 else do
278 else do
273 -- no more bytes in this chunk, ask for more
279 -- no more bytes in this chunk, ask for more
274 bst <- readSource' src
280 bst <- readSource' src
275 when (S.null bs) $ throwIO IncompleteHeaders
281 when (S.null bs) $ throwIO IncompleteHeaders
276− push src status bst
282+ push maxTotalHeaderLength src status bst
277 where
283 where
278 start = end + 1 -- start of next chunk
284 start = end + 1 -- start of next chunk
279 line = SU.unsafeTake (checkCR bs end) bs
285 line = SU.unsafeTake (checkCR bs end) bs
@@ -291,3 +297,7 @@ pauseTimeoutKey = unsafePerformIO Vault.newKey
291getFileInfoKey :: Vault.Key (FilePath -> IO FileInfo)
297getFileInfoKey :: Vault.Key (FilePath -> IO FileInfo)
292getFileInfoKey = unsafePerformIO Vault.newKey
298getFileInfoKey = unsafePerformIO Vault.newKey
293{-# NOINLINE getFileInfoKey #-}
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+5−6
@@ -1,4 +1,3 @@
1−{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE BangPatterns #-}
3
2
4module Network.Wai.Handler.Warp.RequestHeader (
3module Network.Wai.Handler.Warp.RequestHeader (
@@ -6,16 +5,16 @@ module Network.Wai.Handler.Warp.RequestHeader (
6 ) where
5 ) where
7
6
8import Control.Exception (throwIO)
7import Control.Exception (throwIO)
9−import Control.Monad (when)
10import qualified Data.ByteString as S
8import qualified Data.ByteString as S
11−import qualified Data.ByteString.Char8 as B (unpack)
9+import qualified Data.ByteString.Char8 as C8 (unpack)
12−import Data.ByteString.Internal (ByteString(..), memchr)
10+import Data.ByteString.Internal (memchr)
13import qualified Data.CaseInsensitive as CI
11import qualified Data.CaseInsensitive as CI
14−import Data.Word (Word8)
15import Foreign.ForeignPtr (withForeignPtr)
12import Foreign.ForeignPtr (withForeignPtr)
16import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
13import Foreign.Ptr (Ptr, plusPtr, minusPtr, nullPtr)
17import Foreign.Storable (peek)
14import Foreign.Storable (peek)
18import qualified Network.HTTP.Types as H
15import qualified Network.HTTP.Types as H
16+
17+import Network.Wai.Handler.Warp.Imports
19import Network.Wai.Handler.Warp.Types
18import Network.Wai.Handler.Warp.Types
20
19
21-- $setup
20-- $setup
@@ -89,7 +88,7 @@ parseRequestLine requestLine@(PS fptr off len) = withForeignPtr fptr $ \ptr -> d
89
88
90 return (method,path,query,hv)
89 return (method,path,query,hv)
91 where
90 where
92− baderr = BadFirstLine $ B.unpack requestLine
91+ baderr = BadFirstLine $ C8.unpack requestLine
93 check :: Ptr Word8 -> Int -> Word8 -> IO ()
92 check :: Ptr Word8 -> Int -> Word8 -> IO ()
94 check p n w = do
93 check p n w = do
95 w0 <- peek $ p `plusPtr` n
94 w0 <- peek $ p `plusPtr` n
warp/Network/Wai/Handler/Warp/Response.hs+41−66
@@ -1,75 +1,46 @@
1{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
3−{-# LANGUAGE TupleSections #-}
4{-# LANGUAGE RankNTypes #-}
3{-# LANGUAGE RankNTypes #-}
5{-# LANGUAGE CPP #-}
4{-# LANGUAGE CPP #-}
5+{-# LANGUAGE BangPatterns #-}
6
6
7module Network.Wai.Handler.Warp.Response (
7module Network.Wai.Handler.Warp.Response (
8 sendResponse
8 sendResponse
9 , sanitizeHeaderValue -- for testing
9 , sanitizeHeaderValue -- for testing
10 , warpVersion
10 , warpVersion
11− , addDate
12− , addServer
13 , hasBody
11 , hasBody
14 , replaceHeader
12 , replaceHeader
13+ , addServer -- testing
15 ) where
14 ) where
16
15
17−#ifndef MIN_VERSION_base
16+import Data.ByteString.Builder.HTTP.Chunked (chunkedTransferEncoding, chunkedTransferTerminator)
18−#define MIN_VERSION_base(x,y,z) 1
19−#endif
20−
21−#ifndef MIN_VERSION_http_types
22−#define MIN_VERSION_http_types(x,y,z) 1
23−#endif
24−
25−import Blaze.ByteString.Builder.HTTP (chunkedTransferEncoding, chunkedTransferTerminator)
26−#if __GLASGOW_HASKELL__ < 709
27−import Control.Applicative
28−#endif
29import qualified Control.Exception as E
17import qualified Control.Exception as E
30−import Control.Monad (unless, when)
31import Data.Array ((!))
18import Data.Array ((!))
32−import Data.ByteString (ByteString)
33import qualified Data.ByteString as S
19import qualified Data.ByteString as S
34−import qualified Data.ByteString.Char8 as S8
35import Data.ByteString.Builder (byteString, Builder)
20import Data.ByteString.Builder (byteString, Builder)
36import Data.ByteString.Builder.Extra (flush)
21import Data.ByteString.Builder.Extra (flush)
22+import qualified Data.ByteString.Char8 as C8
37import qualified Data.CaseInsensitive as CI
23import qualified Data.CaseInsensitive as CI
38import Data.Function (on)
24import Data.Function (on)
39−import Data.List (deleteBy)
25+import Data.Streaming.ByteString.Builder (newByteStringBuilderRecv, reuseBufferStrategy)
40−import Data.Maybe
41−#if MIN_VERSION_base(4,5,0)
42−# if __GLASGOW_HASKELL__ < 709
43−import Data.Monoid (mempty)
44−# endif
45−import Data.Monoid ((<>))
46−#else
47−import Data.Monoid (mappend, mempty)
48−#endif
49−import Data.Streaming.Blaze (newBlazeRecv, reuseBufferStrategy)
50import Data.Version (showVersion)
26import Data.Version (showVersion)
51import Data.Word8 (_cr, _lf)
27import Data.Word8 (_cr, _lf)
52import qualified Network.HTTP.Types as H
28import qualified Network.HTTP.Types as H
53−#if MIN_VERSION_http_types(0,9,0)
54import qualified Network.HTTP.Types.Header as H
29import qualified Network.HTTP.Types.Header as H
55−#endif
56import Network.Wai
30import Network.Wai
31+import Network.Wai.Internal
32+import qualified Paths_warp
33+import qualified System.TimeManager as T
34+
57import Network.Wai.Handler.Warp.Buffer (toBuilderBuffer)
35import Network.Wai.Handler.Warp.Buffer (toBuilderBuffer)
58import qualified Network.Wai.Handler.Warp.Date as D
36import qualified Network.Wai.Handler.Warp.Date as D
59import Network.Wai.Handler.Warp.File
37import Network.Wai.Handler.Warp.File
60import Network.Wai.Handler.Warp.Header
38import Network.Wai.Handler.Warp.Header
61import Network.Wai.Handler.Warp.IO (toBufIOWith)
39import Network.Wai.Handler.Warp.IO (toBufIOWith)
40+import Network.Wai.Handler.Warp.Imports
62import Network.Wai.Handler.Warp.ResponseHeader
41import Network.Wai.Handler.Warp.ResponseHeader
63import Network.Wai.Handler.Warp.Settings
42import Network.Wai.Handler.Warp.Settings
64−import qualified Network.Wai.Handler.Warp.Timeout as T
65import Network.Wai.Handler.Warp.Types
43import Network.Wai.Handler.Warp.Types
66−import Network.Wai.Internal
67−import qualified Paths_warp
68−
69−#if !MIN_VERSION_base(4,5,0)
70−(<>) :: Monoid m => m -> m -> m
71−(<>) = mappend
72−#endif
73
44
74-- $setup
45-- $setup
75-- >>> :set -XOverloadedStrings
46-- >>> :set -XOverloadedStrings
@@ -130,12 +101,13 @@ import qualified Paths_warp
130sendResponse :: Settings
101sendResponse :: Settings
131 -> Connection
102 -> Connection
132 -> InternalInfo
103 -> InternalInfo
104+ -> T.Handle
133 -> Request -- ^ HTTP request.
105 -> Request -- ^ HTTP request.
134 -> IndexedHeader -- ^ Indexed header of HTTP request.
106 -> IndexedHeader -- ^ Indexed header of HTTP request.
135 -> IO ByteString -- ^ source from client, for raw response
107 -> IO ByteString -- ^ source from client, for raw response
136 -> Response -- ^ HTTP response including status code and response header.
108 -> Response -- ^ HTTP response including status code and response header.
137 -> IO Bool -- ^ Returing True if the connection is persistent.
109 -> IO Bool -- ^ Returing True if the connection is persistent.
138−sendResponse settings conn ii req reqidxhdr src response = do
110+sendResponse settings conn ii th req reqidxhdr src response = do
139 hs <- addServerAndDate hs0
111 hs <- addServerAndDate hs0
140 if hasBody s then do
112 if hasBody s then do
141 -- The response to HEAD does not have body.
113 -- The response to HEAD does not have body.
@@ -144,14 +116,14 @@ sendResponse settings conn ii req reqidxhdr src response = do
144 -- and status, the response to HEAD is processed here.
116 -- and status, the response to HEAD is processed here.
145 --
117 --
146 -- See definition of rsp below for proper body stripping.
118 -- See definition of rsp below for proper body stripping.
147− (ms, mlen) <- sendRsp conn ii ver s hs rsp
119+ (ms, mlen) <- sendRsp conn ii ver s hs rspidxhdr rsp
148 case ms of
120 case ms of
149 Nothing -> return ()
121 Nothing -> return ()
150 Just realStatus -> logger req realStatus mlen
122 Just realStatus -> logger req realStatus mlen
151 T.tickle th
123 T.tickle th
152 return ret
124 return ret
153 else do
125 else do
154− _ <- sendRsp conn ii ver s hs RspNoBody
126+ _ <- sendRsp conn ii ver s hs rspidxhdr RspNoBody
155 logger req s Nothing
127 logger req s Nothing
156 T.tickle th
128 T.tickle th
157 return isPersist
129 return isPersist
@@ -162,7 +134,6 @@ sendResponse settings conn ii req reqidxhdr src response = do
162 s = responseStatus response
134 s = responseStatus response
163 hs0 = sanitizeHeaders $ responseHeaders response
135 hs0 = sanitizeHeaders $ responseHeaders response
164 rspidxhdr = indexResponseHeader hs0
136 rspidxhdr = indexResponseHeader hs0
165− th = threadHandle ii
166 getdate = getDate ii
137 getdate = getDate ii
167 addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
138 addServerAndDate = addDate getdate rspidxhdr . addServer defServer rspidxhdr
168 (isPersist,isChunked0) = infoFromRequest req reqidxhdr
139 (isPersist,isChunked0) = infoFromRequest req reqidxhdr
@@ -178,7 +149,8 @@ sendResponse settings conn ii req reqidxhdr src response = do
178 | isHead -> RspNoBody
149 | isHead -> RspNoBody
179 | otherwise -> RspStream fb needsChunked th
150 | otherwise -> RspStream fb needsChunked th
180 ResponseRaw raw _ -> RspRaw raw src (T.tickle th)
151 ResponseRaw raw _ -> RspRaw raw src (T.tickle th)
181− ret = case response of
152+ -- Make sure we don't hang on to 'response' (avoid space leak)
153+ !ret = case response of
182 ResponseFile {} -> isPersist
154 ResponseFile {} -> isPersist
183 ResponseBuilder {} -> isKeepAlive
155 ResponseBuilder {} -> isKeepAlive
184 ResponseStream {} -> isKeepAlive
156 ResponseStream {} -> isKeepAlive
@@ -199,11 +171,11 @@ containsNewlines = S.any (\w -> w == _cr || w == _lf)
199
171
200{-# INLINE sanitizeHeaderValue #-}
172{-# INLINE sanitizeHeaderValue #-}
201sanitizeHeaderValue :: ByteString -> ByteString
173sanitizeHeaderValue :: ByteString -> ByteString
202−sanitizeHeaderValue v = case S8.lines $ S.filter (/= _cr) v of
174+sanitizeHeaderValue v = case C8.lines $ S.filter (/= _cr) v of
203 [] -> ""
175 [] -> ""
204− x : xs -> S8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
176+ x : xs -> C8.intercalate "\r\n" (x : mapMaybe addSpaceIfMissing xs)
205 where
177 where
206− addSpaceIfMissing line = case S8.uncons line of
178+ addSpaceIfMissing line = case C8.uncons line of
207 Nothing -> Nothing
179 Nothing -> Nothing
208 Just (first, _)
180 Just (first, _)
209 | first == ' ' || first == '\t' -> Just line
181 | first == ' ' || first == '\t' -> Just line
@@ -224,12 +196,13 @@ sendRsp :: Connection
224 -> H.HttpVersion
196 -> H.HttpVersion
225 -> H.Status
197 -> H.Status
226 -> H.ResponseHeaders
198 -> H.ResponseHeaders
199+ -> IndexedHeader -- Response
227 -> Rsp
200 -> Rsp
228 -> IO (Maybe H.Status, Maybe Integer)
201 -> IO (Maybe H.Status, Maybe Integer)
229
202
230----------------------------------------------------------------
203----------------------------------------------------------------
231
204
232−sendRsp conn _ ver s hs RspNoBody = do
205+sendRsp conn _ ver s hs _ RspNoBody = do
233 -- Not adding Content-Length.
206 -- Not adding Content-Length.
234 -- User agents treats it as Content-Length: 0.
207 -- User agents treats it as Content-Length: 0.
235 composeHeader ver s hs >>= connSendAll conn
208 composeHeader ver s hs >>= connSendAll conn
@@ -237,7 +210,7 @@ sendRsp conn _ ver s hs RspNoBody = do
237
210
238----------------------------------------------------------------
211----------------------------------------------------------------
239
212
240−sendRsp conn _ ver s hs (RspBuilder body needsChunked) = do
213+sendRsp conn _ ver s hs _ (RspBuilder body needsChunked) = do
241 header <- composeHeaderBuilder ver s hs needsChunked
214 header <- composeHeaderBuilder ver s hs needsChunked
242 let hdrBdy
215 let hdrBdy
243 | needsChunked = header <> chunkedTransferEncoding body
216 | needsChunked = header <> chunkedTransferEncoding body
@@ -250,9 +223,9 @@ sendRsp conn _ ver s hs (RspBuilder body needsChunked) = do
250
223
251----------------------------------------------------------------
224----------------------------------------------------------------
252
225
253−sendRsp conn _ ver s hs (RspStream streamingBody needsChunked th) = do
226+sendRsp conn _ ver s hs _ (RspStream streamingBody needsChunked th) = do
254 header <- composeHeaderBuilder ver s hs needsChunked
227 header <- composeHeaderBuilder ver s hs needsChunked
255− (recv, finish) <- newBlazeRecv $ reuseBufferStrategy
228+ (recv, finish) <- newByteStringBuilderRecv $ reuseBufferStrategy
256 $ toBuilderBuffer (connWriteBuffer conn) (connBufferSize conn)
229 $ toBuilderBuffer (connWriteBuffer conn) (connBufferSize conn)
257 let send builder = do
230 let send builder = do
258 popper <- recv builder
231 popper <- recv builder
@@ -274,7 +247,7 @@ sendRsp conn _ ver s hs (RspStream streamingBody needsChunked th) = do
274
247
275----------------------------------------------------------------
248----------------------------------------------------------------
276
249
277−sendRsp conn _ _ _ _ (RspRaw withApp src tickle) = do
250+sendRsp conn _ _ _ _ _ (RspRaw withApp src tickle) = do
278 withApp recv send
251 withApp recv send
279 return (Nothing, Nothing)
252 return (Nothing, Nothing)
280 where
253 where
@@ -288,8 +261,8 @@ sendRsp conn _ _ _ _ (RspRaw withApp src tickle) = do
288
261
289-- Sophisticated WAI applications.
262-- Sophisticated WAI applications.
290-- We respect s0. s0 MUST be a proper value.
263-- We respect s0. s0 MUST be a proper value.
291−sendRsp conn ii ver s0 hs0 (RspFile path (Just part) _ isHead hook) =
264+sendRsp conn ii ver s0 hs0 rspidxhdr (RspFile path (Just part) _ isHead hook) =
292− sendRspFile2XX conn ii ver s0 hs path beg len isHead hook
265+ sendRspFile2XX conn ii ver s0 hs rspidxhdr path beg len isHead hook
293 where
266 where
294 beg = filePartOffset part
267 beg = filePartOffset part
295 len = filePartByteCount part
268 len = filePartByteCount part
@@ -299,17 +272,17 @@ sendRsp conn ii ver s0 hs0 (RspFile path (Just part) _ isHead hook) =
299
272
300-- Simple WAI applications.
273-- Simple WAI applications.
301-- Status is ignored
274-- Status is ignored
302−sendRsp conn ii ver _ hs0 (RspFile path Nothing idxhdr isHead hook) = do
275+sendRsp conn ii ver _ hs0 rspidxhdr (RspFile path Nothing reqidxhdr isHead hook) = do
303 efinfo <- E.try $ getFileInfo ii path
276 efinfo <- E.try $ getFileInfo ii path
304 case efinfo of
277 case efinfo of
305 Left (_ex :: E.IOException) ->
278 Left (_ex :: E.IOException) ->
306#ifdef WARP_DEBUG
279#ifdef WARP_DEBUG
307 print _ex >>
280 print _ex >>
308#endif
281#endif
309− sendRspFile404 conn ii ver hs0
282+ sendRspFile404 conn ii ver hs0 rspidxhdr
310− Right finfo -> case conditionalRequest finfo hs0 idxhdr of
283+ Right finfo -> case conditionalRequest finfo hs0 rspidxhdr reqidxhdr of
311− WithoutBody s -> sendRsp conn ii ver s hs0 RspNoBody
284+ WithoutBody s -> sendRsp conn ii ver s hs0 rspidxhdr RspNoBody
312− WithBody s hs beg len -> sendRspFile2XX conn ii ver s hs path beg len isHead hook
285+ WithBody s hs beg len -> sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
313
286
314----------------------------------------------------------------
287----------------------------------------------------------------
315
288
@@ -318,14 +291,15 @@ sendRspFile2XX :: Connection
318 -> H.HttpVersion
291 -> H.HttpVersion
319 -> H.Status
292 -> H.Status
320 -> H.ResponseHeaders
293 -> H.ResponseHeaders
294+ -> IndexedHeader
321 -> FilePath
295 -> FilePath
322 -> Integer
296 -> Integer
323 -> Integer
297 -> Integer
324 -> Bool
298 -> Bool
325 -> IO ()
299 -> IO ()
326 -> IO (Maybe H.Status, Maybe Integer)
300 -> IO (Maybe H.Status, Maybe Integer)
327−sendRspFile2XX conn ii ver s hs path beg len isHead hook
301+sendRspFile2XX conn ii ver s hs rspidxhdr path beg len isHead hook
328− | isHead = sendRsp conn ii ver s hs RspNoBody
302+ | isHead = sendRsp conn ii ver s hs rspidxhdr RspNoBody
329 | otherwise = do
303 | otherwise = do
330 lheader <- composeHeader ver s hs
304 lheader <- composeHeader ver s hs
331 (mfd, fresher) <- getFd ii path
305 (mfd, fresher) <- getFd ii path
@@ -338,8 +312,9 @@ sendRspFile404 :: Connection
338 -> InternalInfo
312 -> InternalInfo
339 -> H.HttpVersion
313 -> H.HttpVersion
340 -> H.ResponseHeaders
314 -> H.ResponseHeaders
315+ -> IndexedHeader
341 -> IO (Maybe H.Status, Maybe Integer)
316 -> IO (Maybe H.Status, Maybe Integer)
342−sendRspFile404 conn ii ver hs0 = sendRsp conn ii ver s hs (RspBuilder body True)
317+sendRspFile404 conn ii ver hs0 rspidxhdr = sendRsp conn ii ver s hs rspidxhdr (RspBuilder body True)
343 where
318 where
344 s = H.notFound404
319 s = H.notFound404
345 hs = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
320 hs = replaceHeader H.hContentType "text/plain; charset=utf-8" hs0
@@ -410,11 +385,7 @@ hasBody s = sc /= 204
410----------------------------------------------------------------
385----------------------------------------------------------------
411
386
412addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
387addTransferEncoding :: H.ResponseHeaders -> H.ResponseHeaders
413−#if MIN_VERSION_http_types(0,9,0)
414addTransferEncoding hdrs = (H.hTransferEncoding, "chunked") : hdrs
388addTransferEncoding hdrs = (H.hTransferEncoding, "chunked") : hdrs
415−#else
416−addTransferEncoding hdrs = ("transfer-encoding", "chunked") : hdrs
417−#endif
418
389
419addDate :: IO D.GMTDate -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
390addDate :: IO D.GMTDate -> IndexedHeader -> H.ResponseHeaders -> IO H.ResponseHeaders
420addDate getdate rspidxhdr hdrs = case rspidxhdr ! fromEnum ResDate of
391addDate getdate rspidxhdr hdrs = case rspidxhdr ! fromEnum ResDate of
@@ -429,7 +400,11 @@ addDate getdate rspidxhdr hdrs = case rspidxhdr ! fromEnum ResDate of
429warpVersion :: String
400warpVersion :: String
430warpVersion = showVersion Paths_warp.version
401warpVersion = showVersion Paths_warp.version
431
402
403+{-# INLINE addServer #-}
432addServer :: HeaderValue -> IndexedHeader -> H.ResponseHeaders -> H.ResponseHeaders
404addServer :: HeaderValue -> IndexedHeader -> H.ResponseHeaders -> H.ResponseHeaders
405+addServer "" rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
406+ Nothing -> hdrs
407+ _ -> filter ((/= H.hServer) . fst) hdrs
433addServer serverName rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
408addServer serverName rspidxhdr hdrs = case rspidxhdr ! fromEnum ResServer of
434 Nothing -> (H.hServer, serverName) : hdrs
409 Nothing -> (H.hServer, serverName) : hdrs
435 _ -> hdrs
410 _ -> hdrs
warp/Network/Wai/Handler/Warp/ResponseHeader.hs+3−5
@@ -3,17 +3,15 @@
3
3
4module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
4module Network.Wai.Handler.Warp.ResponseHeader (composeHeader) where
5
5
6−import Control.Monad
7−import Data.ByteString (ByteString)
8import qualified Data.ByteString as S
6import qualified Data.ByteString as S
9import Data.ByteString.Internal (create)
7import Data.ByteString.Internal (create)
10import qualified Data.CaseInsensitive as CI
8import qualified Data.CaseInsensitive as CI
11−import Data.List (foldl')
12−import Data.Word (Word8)
13import Foreign.Ptr
9import Foreign.Ptr
14import GHC.Storable
10import GHC.Storable
15import qualified Network.HTTP.Types as H
11import qualified Network.HTTP.Types as H
12+
16import Network.Wai.Handler.Warp.Buffer (copy)
13import Network.Wai.Handler.Warp.Buffer (copy)
14+import Network.Wai.Handler.Warp.Imports
17
15
18----------------------------------------------------------------
16----------------------------------------------------------------
19
17
@@ -24,7 +22,7 @@ composeHeader !httpversion !status !responseHeaders = create len $ \ptr -> do
24 void $ copyCRLF ptr2
22 void $ copyCRLF ptr2
25 where
23 where
26 !len = 17 + slen + foldl' fieldLength 0 responseHeaders
24 !len = 17 + slen + foldl' fieldLength 0 responseHeaders
27− fieldLength !l !(k,v) = l + S.length (CI.original k) + S.length v + 4
25+ fieldLength !l (!k,!v) = l + S.length (CI.original k) + S.length v + 4
28 !slen = S.length $ H.statusMessage status
26 !slen = S.length $ H.statusMessage status
29
27
30httpVer11 :: ByteString
28httpVer11 :: ByteString
warp/Network/Wai/Handler/Warp/Run.hs+216−115
@@ -1,48 +1,55 @@
1+{-# LANGUAGE BangPatterns #-}
1{-# LANGUAGE CPP #-}
2{-# LANGUAGE CPP #-}
2{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE OverloadedStrings #-}
4+{-# LANGUAGE PackageImports #-}
5+{-# LANGUAGE PatternGuards #-}
6+{-# LANGUAGE RecordWildCards #-}
3{-# LANGUAGE ScopedTypeVariables #-}
7{-# LANGUAGE ScopedTypeVariables #-}
4{-# LANGUAGE TupleSections #-}
8{-# LANGUAGE TupleSections #-}
5−{-# LANGUAGE PatternGuards #-}
9+{-# LANGUAGE ViewPatterns #-}
6{-# OPTIONS_GHC -fno-warn-deprecations #-}
10{-# OPTIONS_GHC -fno-warn-deprecations #-}
7
11
8module Network.Wai.Handler.Warp.Run where
12module Network.Wai.Handler.Warp.Run where
9
13
10−#if __GLASGOW_HASKELL__ < 709
14+import "iproute" Data.IP (toHostAddress, toHostAddress6)
11−import Control.Applicative ((<$>))
12−#endif
13import Control.Arrow (first)
15import Control.Arrow (first)
14−import Control.Concurrent (threadDelay)
15import qualified Control.Concurrent as Conc (yield)
16import qualified Control.Concurrent as Conc (yield)
16import Control.Exception as E
17import Control.Exception as E
17−import Control.Monad (when, unless, void)
18−import Data.ByteString (ByteString)
19import qualified Data.ByteString as S
18import qualified Data.ByteString as S
20import Data.Char (chr)
19import Data.Char (chr)
21−import Data.IP (toHostAddress, toHostAddress6)
22import Data.IORef (IORef, newIORef, readIORef, writeIORef)
20import Data.IORef (IORef, newIORef, readIORef, writeIORef)
23import Data.Streaming.Network (bindPortTCP)
21import Data.Streaming.Network (bindPortTCP)
24−import Network (sClose, Socket)
22+import Foreign.C.Error (Errno(..), eCONNABORTED)
25−import Network.Socket (accept, withSocketsDo, SockAddr(SockAddrInet, SockAddrInet6), setSocketOption, SocketOption(..))
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
26import qualified Network.Socket.ByteString as Sock
29import qualified Network.Socket.ByteString as Sock
27import Network.Wai
30import Network.Wai
31+import Network.Wai.Internal (ResponseReceived (ResponseReceived))
32+import System.Environment (lookupEnv)
33+import qualified System.TimeManager as T
34+import System.Timeout (timeout)
35+
28import Network.Wai.Handler.Warp.Buffer
36import Network.Wai.Handler.Warp.Buffer
29import Network.Wai.Handler.Warp.Counter
37import Network.Wai.Handler.Warp.Counter
30import qualified Network.Wai.Handler.Warp.Date as D
38import qualified Network.Wai.Handler.Warp.Date as D
31import qualified Network.Wai.Handler.Warp.FdCache as F
39import qualified Network.Wai.Handler.Warp.FdCache as F
32import qualified Network.Wai.Handler.Warp.FileInfoCache as I
40import qualified Network.Wai.Handler.Warp.FileInfoCache as I
33−import Network.Wai.Handler.Warp.HTTP2 (http2, isHTTP2)
41+import Network.Wai.Handler.Warp.HTTP2 (http2)
42+import Network.Wai.Handler.Warp.HTTP2.Types (isHTTP2)
34import Network.Wai.Handler.Warp.Header
43import Network.Wai.Handler.Warp.Header
44+import Network.Wai.Handler.Warp.Imports hiding (readInt)
35import Network.Wai.Handler.Warp.ReadInt
45import Network.Wai.Handler.Warp.ReadInt
36import Network.Wai.Handler.Warp.Recv
46import Network.Wai.Handler.Warp.Recv
37import Network.Wai.Handler.Warp.Request
47import Network.Wai.Handler.Warp.Request
38import Network.Wai.Handler.Warp.Response
48import Network.Wai.Handler.Warp.Response
39import Network.Wai.Handler.Warp.SendFile
49import Network.Wai.Handler.Warp.SendFile
40import Network.Wai.Handler.Warp.Settings
50import Network.Wai.Handler.Warp.Settings
41−import qualified Network.Wai.Handler.Warp.Timeout as T
42import Network.Wai.Handler.Warp.Types
51import Network.Wai.Handler.Warp.Types
43−import Network.Wai.Internal (ResponseReceived (ResponseReceived))
52+
44−import System.Environment (getEnvironment)
45−import System.IO.Error (isFullErrorType, ioeGetErrorType)
46
53
47#if WINDOWS
54#if WINDOWS
48import Network.Wai.Handler.Warp.Windows
55import Network.Wai.Handler.Warp.Windows
@@ -51,27 +58,40 @@ import Network.Socket (fdSocket)
51#endif
58#endif
52
59
53-- | Creating 'Connection' for plain HTTP based on a given socket.
60-- | Creating 'Connection' for plain HTTP based on a given socket.
54−socketConnection :: Socket -> IO Connection
61+socketConnection :: Settings -> Socket -> IO Connection
55−socketConnection s = do
62+#if MIN_VERSION_network(3,1,1)
63+socketConnection set s = do
64+#else
65+socketConnection _ s = do
66+#endif
56 bufferPool <- newBufferPool
67 bufferPool <- newBufferPool
57 writeBuf <- allocateBuffer bufferSize
68 writeBuf <- allocateBuffer bufferSize
58 let sendall = Sock.sendAll s
69 let sendall = Sock.sendAll s
70+ isH2 <- newIORef False -- HTTP/1.x
59 return Connection {
71 return Connection {
60 connSendMany = Sock.sendMany s
72 connSendMany = Sock.sendMany s
61 , connSendAll = sendall
73 , connSendAll = sendall
62 , connSendFile = sendFile s writeBuf bufferSize sendall
74 , connSendFile = sendFile s writeBuf bufferSize sendall
63− , connClose = sClose s >> freeBuffer writeBuf
75+#if MIN_VERSION_network(3,1,1)
76+ , connClose = do
77+ h2 <- readIORef isH2
78+ let tm = if h2 then settingsGracefulCloseTimeout2 set
79+ else settingsGracefulCloseTimeout1 set
80+ if tm == 0 then
81+ close s
82+ else
83+ gracefulClose s tm `E.catch` \(E.SomeException _) -> return ()
84+#else
85+ , connClose = close s
86+#endif
87+ , connFree = freeBuffer writeBuf
64 , connRecv = receive s bufferPool
88 , connRecv = receive s bufferPool
65 , connRecvBuf = receiveBuf s
89 , connRecvBuf = receiveBuf s
66 , connWriteBuffer = writeBuf
90 , connWriteBuffer = writeBuf
67 , connBufferSize = bufferSize
91 , connBufferSize = bufferSize
92+ , connHTTP2 = isH2
68 }
93 }
69
94
70−#if __GLASGOW_HASKELL__ < 702
71−allowInterrupt :: IO ()
72−allowInterrupt = unblock $ return ()
73−#endif
74−
75-- | Run an 'Application' on the given port.
95-- | Run an 'Application' on the given port.
76-- This calls 'runSettings' with 'defaultSettings'.
96-- This calls 'runSettings' with 'defaultSettings'.
77run :: Port -> Application -> IO ()
97run :: Port -> Application -> IO ()
@@ -84,7 +104,7 @@ run p = runSettings defaultSettings { settingsPort = p }
84-- Since 3.0.9
104-- Since 3.0.9
85runEnv :: Port -> Application -> IO ()
105runEnv :: Port -> Application -> IO ()
86runEnv p app = do
106runEnv p app = do
87− mp <- lookup "PORT" <$> getEnvironment
107+ mp <- lookupEnv "PORT"
88
108
89 maybe (run p app) runReadPort mp
109 maybe (run p app) runReadPort mp
90
110
@@ -101,7 +121,7 @@ runSettings :: Settings -> Application -> IO ()
101runSettings set app = withSocketsDo $
121runSettings set app = withSocketsDo $
102 bracket
122 bracket
103 (bindPortTCP (settingsPort set) (settingsHost set))
123 (bindPortTCP (settingsPort set) (settingsHost set))
104− sClose
124+ close
105 (\socket -> do
125 (\socket -> do
106 setSocketCloseOnExec socket
126 setSocketCloseOnExec socket
107 runSettingsSocket set socket app)
127 runSettingsSocket set socket app)
@@ -129,11 +149,12 @@ runSettingsSocket set socket app = do
129 (s, sa) <- accept socket
149 (s, sa) <- accept socket
130#endif
150#endif
131 setSocketCloseOnExec s
151 setSocketCloseOnExec s
132− setSocketOption s NoDelay 1
152+ -- NoDelay causes an error for AF_UNIX.
133− conn <- socketConnection s
153+ setSocketOption s NoDelay 1 `E.catch` \(E.SomeException _) -> return ()
154+ conn <- socketConnection set s
134 return (conn, sa)
155 return (conn, sa)
135
156
136− closeListenSocket = sClose socket
157+ closeListenSocket = close socket
137
158
138-- | The connection setup action would be expensive. A good example
159-- | The connection setup action would be expensive. A good example
139-- is initialization of TLS.
160-- is initialization of TLS.
@@ -171,22 +192,23 @@ runSettingsConnectionMakerSecure :: Settings -> IO (IO (Connection, Transport),
171runSettingsConnectionMakerSecure set getConnMaker app = do
192runSettingsConnectionMakerSecure set getConnMaker app = do
172 settingsBeforeMainLoop set
193 settingsBeforeMainLoop set
173 counter <- newCounter
194 counter <- newCounter
174− withII0 $ acceptConnection set getConnMaker app counter
195+ withII $ acceptConnection set getConnMaker app counter
175 where
196 where
176− withII0 action =
197+ withII action =
177 withTimeoutManager $ \tm ->
198 withTimeoutManager $ \tm ->
178 D.withDateCache $ \dc ->
199 D.withDateCache $ \dc ->
179 F.withFdCache fdCacheDurationInSeconds $ \fdc ->
200 F.withFdCache fdCacheDurationInSeconds $ \fdc ->
180 I.withFileInfoCache fdFileInfoDurationInSeconds $ \fic -> do
201 I.withFileInfoCache fdFileInfoDurationInSeconds $ \fic -> do
181− let ii0 = InternalInfo0 tm dc fdc fic
202+ let ii = InternalInfo tm dc fdc fic
182− action ii0
203+ action ii
183
204
184− fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
205+ !fdCacheDurationInSeconds = settingsFdCacheDuration set * 1000000
185− fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
206+ !fdFileInfoDurationInSeconds = settingsFileInfoCacheDuration set * 1000000
207+ !timeoutInSeconds = settingsTimeout set * 1000000
186 withTimeoutManager f = case settingsManager set of
208 withTimeoutManager f = case settingsManager set of
187 Just tm -> f tm
209 Just tm -> f tm
188 Nothing -> bracket
210 Nothing -> bracket
189− (T.initialize $ settingsTimeout set * 1000000)
211+ (T.initialize timeoutInSeconds)
190 T.stopManager
212 T.stopManager
191 f
213 f
192
214
@@ -207,14 +229,19 @@ acceptConnection :: Settings
207 -> IO (IO (Connection, Transport), SockAddr)
229 -> IO (IO (Connection, Transport), SockAddr)
208 -> Application
230 -> Application
209 -> Counter
231 -> Counter
210− -> InternalInfo0
232+ -> InternalInfo
211 -> IO ()
233 -> IO ()
212−acceptConnection set getConnMaker app counter ii0 = do
234+acceptConnection set getConnMaker app counter ii = do
213 -- First mask all exceptions in acceptLoop. This is necessary to
235 -- First mask all exceptions in acceptLoop. This is necessary to
214 -- ensure that no async exception is throw between the call to
236 -- ensure that no async exception is throw between the call to
215 -- acceptNewConnection and the registering of connClose.
237 -- acceptNewConnection and the registering of connClose.
238+ --
239+ -- acceptLoop can be broken by closing the listing socket.
216 void $ mask_ acceptLoop
240 void $ mask_ acceptLoop
217− gracefulShutdown counter
241+ -- In some cases, we want to stop Warp here without graceful shutdown.
242+ -- So, async exceptions are allowed here.
243+ -- That's why `finally` is not used.
244+ gracefulShutdown set counter
218 where
245 where
219 acceptLoop = do
246 acceptLoop = do
220 -- Allow async exceptions before receiving the next connection maker.
247 -- Allow async exceptions before receiving the next connection maker.
@@ -231,24 +258,21 @@ acceptConnection set getConnMaker app counter ii0 = do
231 case mx of
258 case mx of
232 Nothing -> return ()
259 Nothing -> return ()
233 Just (mkConn, addr) -> do
260 Just (mkConn, addr) -> do
234− fork set mkConn addr app counter ii0
261+ fork set mkConn addr app counter ii
235 acceptLoop
262 acceptLoop
236
263
237 acceptNewConnection = do
264 acceptNewConnection = do
238 ex <- try getConnMaker
265 ex <- try getConnMaker
239 case ex of
266 case ex of
240 Right x -> return $ Just x
267 Right x -> return $ Just x
241− Left e -> do
268+ Left e -> do
242− settingsOnException set Nothing $ toException e
269+ let eConnAborted = getErrno eCONNABORTED
243− if isFullErrorType (ioeGetErrorType e) then do
270+ getErrno (Errno cInt) = cInt
244− -- "resource exhausted (Too many open files)" may
271+ if ioe_errno e == Just eConnAborted
245− -- happen by accept(). Wait a second hoping that
272+ then acceptNewConnection
246− -- resource will be available.
273+ else do
247− threadDelay 1000000
274+ settingsOnException set Nothing $ toException e
248− acceptNewConnection
275+ return Nothing
249− else
250− -- Assuming the listen socket is closed.
251− return Nothing
252
276
253-- Fork a new worker thread for this connection maker, and ask for a
277-- Fork a new worker thread for this connection maker, and ask for a
254-- function to unmask (i.e., allow async exceptions to be thrown).
278-- function to unmask (i.e., allow async exceptions to be thrown).
@@ -257,54 +281,55 @@ fork :: Settings
257 -> SockAddr
281 -> SockAddr
258 -> Application
282 -> Application
259 -> Counter
283 -> Counter
260− -> InternalInfo0
284+ -> InternalInfo
261 -> IO ()
285 -> IO ()
262−fork set mkConn addr app counter ii0 = settingsFork set $ \ unmask ->
286+fork set mkConn addr app counter ii = settingsFork set $ \unmask ->
263− -- Run the connection maker to get a new connection, and ensure
287+ -- Call the user-supplied on exception code if any
264− -- that the connection is closed. If the mkConn call throws an
288+ -- exceptions are thrown.
265− -- exception, we will leak the connection. If the mkConn call is
289+ handle (settingsOnException set Nothing) $
266− -- vulnerable to attacks (e.g., Slowloris), we do nothing to
290+ -- Run the connection maker to get a new connection, and ensure
267− -- protect the server. It is therefore vital that mkConn is well
291+ -- that the connection is closed. If the mkConn call throws an
268− -- vetted.
292+ -- exception, we will leak the connection. If the mkConn call is
269− --
293+ -- vulnerable to attacks (e.g., Slowloris), we do nothing to
270− -- We grab the connection before registering timeouts since the
294+ -- protect the server. It is therefore vital that mkConn is well
271− -- timeouts will be useless during connection creation, due to the
295+ -- vetted.
272− -- fact that async exceptions are still masked.
296+ --
273− bracket mkConn closeConn $ \(conn, transport) ->
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
274
303
275 -- We need to register a timeout handler for this thread, and
304 -- We need to register a timeout handler for this thread, and
276 -- cancel that handler as soon as we exit.
305 -- cancel that handler as soon as we exit.
277− bracket (T.registerKillThread (timeoutManager0 ii0)) T.cancel $ \th ->
306+ serve unmask (conn, transport) = bracket register cancel $ \th -> do
278−
307+ -- We now have fully registered a connection close handler in
279− let ii1 = toInternalInfo1 ii0 th
308+ -- the case of all exceptions, so it is safe to once again
280− -- We now have fully registered a connection close handler
309+ -- allow async exceptions.
281− -- in the case of all exceptions, so it is safe to one
310+ unmask .
282− -- again allow async exceptions.
311+ -- Call the user-supplied code for connection open and
283− in unmask .
312+ -- close events
284− -- Call the user-supplied on exception code if any
313+ bracket (onOpen addr) (onClose addr) $ \goingon ->
285− -- exceptions are thrown.
314+ -- Actually serve this connection. bracket with closeConn
286− handle (settingsOnException set Nothing) .
315+ -- above ensures the connection is closed.
287−
316+ when goingon $ serveConnection conn ii th addr transport set app
288− -- Call the user-supplied code for connection open and close events
317+ where
289− bracket (onOpen addr) (onClose addr) $ \goingon ->
318+ register = T.registerKillThread (timeoutManager ii) (connClose conn)
290−
319+ cancel = T.cancel
291− -- Actually serve this connection.
292− -- bracket with closeConn above ensures the connection is closed.
293− when goingon $ serveConnection conn ii1 addr transport set app
294− where
295− closeConn (conn, _transport) = connClose conn
296
320
297 onOpen adr = increase counter >> settingsOnOpen set adr
321 onOpen adr = increase counter >> settingsOnOpen set adr
298 onClose adr _ = decrease counter >> settingsOnClose set adr
322 onClose adr _ = decrease counter >> settingsOnClose set adr
299
323
300serveConnection :: Connection
324serveConnection :: Connection
301− -> InternalInfo1
325+ -> InternalInfo
326+ -> T.Handle
302 -> SockAddr
327 -> SockAddr
303 -> Transport
328 -> Transport
304 -> Settings
329 -> Settings
305 -> Application
330 -> Application
306 -> IO ()
331 -> IO ()
307−serveConnection conn ii1 origAddr transport settings app = do
332+serveConnection conn ii th origAddr transport settings app = do
308 -- fixme: Upgrading to HTTP/2 should be supported.
333 -- fixme: Upgrading to HTTP/2 should be supported.
309 (h2,bs) <- if isHTTP2 transport then
334 (h2,bs) <- if isHTTP2 transport then
310 return (True, "")
335 return (True, "")
@@ -314,19 +339,39 @@ serveConnection conn ii1 origAddr transport settings app = do
314 return (True, bs0)
339 return (True, bs0)
315 else
340 else
316 return (False, bs0)
341 return (False, bs0)
342+ istatus <- newIORef False
317 if settingsHTTP2Enabled settings && h2 then do
343 if settingsHTTP2Enabled settings && h2 then do
318− recvN <- makeReceiveN bs (connRecv conn) (connRecvBuf conn)
344+ rawRecvN <- makeReceiveN bs (connRecv conn) (connRecvBuf conn)
345+ -- This thread becomes the sender in http2 library.
346+ -- In the case of event source, one request comes and one
347+ -- worker gets busy. But it is likely that the receiver does
348+ -- not receive any data at all while the sender is sending
349+ -- output data from the worker. It's not good enough to tickle
350+ -- the time handler in the receiver only. So, we should tickle
351+ -- the time handler in both the receiver and the sender.
352+ let recvN = wrappedRecvN th istatus (settingsSlowlorisSize settings) rawRecvN
353+ sendBS x = connSendAll conn x >> T.tickle th
319 -- fixme: origAddr
354 -- fixme: origAddr
320− http2 conn ii1 origAddr transport settings recvN app
355+ checkTLS
356+ setConnHTTP2 conn True
357+ http2 conn transport ii origAddr settings recvN sendBS app
321 else do
358 else do
322− istatus <- newIORef False
323 src <- mkSource (wrappedRecv conn th istatus (settingsSlowlorisSize settings))
359 src <- mkSource (wrappedRecv conn th istatus (settingsSlowlorisSize settings))
324 writeIORef istatus True
360 writeIORef istatus True
325 leftoverSource src bs
361 leftoverSource src bs
326 addr <- getProxyProtocolAddr src
362 addr <- getProxyProtocolAddr src
327− http1 addr istatus src `E.catch` \e -> do
363+ http1 True addr istatus src `E.catch` \e ->
328− sendErrorResponse addr istatus e
364+ case () of
329− throwIO (e :: SomeException)
365+ ()
366+ -- See comment below referencing
367+ -- https://github.com/yesodweb/wai/issues/618
368+ | Just NoKeepAliveRequest <- fromException e -> return ()
369+ -- No valid request
370+ | Just (BadFirstLine _) <- fromException e -> return ()
371+ | otherwise -> do
372+ _ <- sendErrorResponse (dummyreq addr) istatus e
373+ throwIO e
374+
330 where
375 where
331 getProxyProtocolAddr src =
376 getProxyProtocolAddr src =
332 case settingsProxyProtocol settings of
377 case settingsProxyProtocol settings of
@@ -368,36 +413,40 @@ serveConnection conn ii1 origAddr transport settings app = do
368
413
369 decodeAscii = map (chr . fromEnum) . S.unpack
414 decodeAscii = map (chr . fromEnum) . S.unpack
370
415
371− th = threadHandle1 ii1
372−
373 shouldSendErrorResponse se
416 shouldSendErrorResponse se
374 | Just ConnectionClosedByPeer <- fromException se = False
417 | Just ConnectionClosedByPeer <- fromException se = False
375 | otherwise = True
418 | otherwise = True
376
419
377− sendErrorResponse addr istatus e = do
420+ sendErrorResponse req istatus e = do
378 status <- readIORef istatus
421 status <- readIORef istatus
379− when (shouldSendErrorResponse e && status) $ do
422+ if shouldSendErrorResponse e && status
380− let ii = toInternalInfo ii1 0 -- dummy
423+ then do
381− dreq = dummyreq addr
424+ sendResponse settings conn ii th req defaultIndexRequestHeader (return S.empty) (errorResponse e)
382− void $ sendResponse settings conn ii dreq defaultIndexRequestHeader (return S.empty) (errorResponse e)
425+ else return False
383
426
384 dummyreq addr = defaultRequest { remoteHost = addr }
427 dummyreq addr = defaultRequest { remoteHost = addr }
385
428
386 errorResponse e = settingsOnExceptionResponse settings e
429 errorResponse e = settingsOnExceptionResponse settings e
387
430
388− http1 addr istatus src = do
431+ http1 firstRequest addr istatus src = do
389− (req', mremainingRef, idxhdr, nextBodyFlush, ii) <- recvRequest settings conn ii1 addr src
432+ (req, mremainingRef, idxhdr, nextBodyFlush) <- recvRequest firstRequest settings conn ii th addr src transport
390− let req = req' { isSecure = isTransportSecure transport }
433+ keepAlive <- processRequest istatus src req mremainingRef idxhdr nextBodyFlush
391− keepAlive <- processRequest istatus src req mremainingRef idxhdr nextBodyFlush ii
392 `E.catch` \e -> do
434 `E.catch` \e -> do
393− -- Call the user-supplied exception handlers, passing the request.
394− sendErrorResponse addr istatus e
395 settingsOnException settings (Just req) e
435 settingsOnException settings (Just req) e
396 -- Don't throw the error again to prevent calling settingsOnException twice.
436 -- Don't throw the error again to prevent calling settingsOnException twice.
397 return False
437 return False
398− when keepAlive $ http1 addr istatus src
399
438
400− processRequest istatus src req mremainingRef idxhdr nextBodyFlush ii = do
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
401 -- Let the application run for as long as it wants
450 -- Let the application run for as long as it wants
402 T.pause th
451 T.pause th
403
452
@@ -405,30 +454,38 @@ serveConnection conn ii1 origAddr transport settings app = do
405 -- creating the request, we need to make sure that we don't get
454 -- creating the request, we need to make sure that we don't get
406 -- an async exception before calling the ResponseSource.
455 -- an async exception before calling the ResponseSource.
407 keepAliveRef <- newIORef $ error "keepAliveRef not filled"
456 keepAliveRef <- newIORef $ error "keepAliveRef not filled"
408− _ <- app req $ \res -> do
457+ r <- E.try $ app req $ \res -> do
409 T.resume th
458 T.resume th
410 -- FIXME consider forcing evaluation of the res here to
459 -- FIXME consider forcing evaluation of the res here to
411 -- send more meaningful error messages to the user.
460 -- send more meaningful error messages to the user.
412 -- However, it may affect performance.
461 -- However, it may affect performance.
413 writeIORef istatus False
462 writeIORef istatus False
414− keepAlive <- sendResponse settings conn ii req idxhdr (readSource src) res
463+ keepAlive <- sendResponse settings conn ii th req idxhdr (readSource src) res
415 writeIORef keepAliveRef keepAlive
464 writeIORef keepAliveRef keepAlive
416 return ResponseReceived
465 return ResponseReceived
466+ case r of
467+ Right ResponseReceived -> return ()
468+ Left e@(SomeException _)
469+ | Just (ExceptionInsideResponseBody e') <- fromException e -> throwIO e'
470+ | otherwise -> do
471+ keepAlive <- sendErrorResponse req istatus e
472+ settingsOnException settings (Just req) e
473+ writeIORef keepAliveRef keepAlive
474+
417 keepAlive <- readIORef keepAliveRef
475 keepAlive <- readIORef keepAliveRef
418
476
419 -- We just send a Response and it takes a time to
477 -- We just send a Response and it takes a time to
420 -- receive a Request again. If we immediately call recv,
478 -- receive a Request again. If we immediately call recv,
421− -- it is likely to fail and the IO manager works.
479+ -- it is likely to fail and cause the IO manager to do some work.
422− -- It is very costly. So, we yield to another Haskell
480+ -- It is very costly, so we yield to another Haskell
423 -- thread hoping that the next Request will arrive
481 -- thread hoping that the next Request will arrive
424 -- when this Haskell thread will be re-scheduled.
482 -- when this Haskell thread will be re-scheduled.
425 -- This improves performance at least when
483 -- This improves performance at least when
426 -- the number of cores is small.
484 -- the number of cores is small.
427 Conc.yield
485 Conc.yield
428
486
429− if not keepAlive then
487+ if keepAlive
430− return False
488+ then
431− else
432 -- If there is an unknown or large amount of data to still be read
489 -- If there is an unknown or large amount of data to still be read
433 -- from the request body, simple drop this connection instead of
490 -- from the request body, simple drop this connection instead of
434 -- reading it all in to satisfy a keep-alive request.
491 -- reading it all in to satisfy a keep-alive request.
@@ -454,6 +511,21 @@ serveConnection conn ii1 origAddr transport settings app = do
454 else
511 else
455 return False
512 return False
456 Nothing -> tryKeepAlive
513 Nothing -> tryKeepAlive
514+ else
515+ return False
516+
517+ checkTLS = case transport of
518+ TCP -> return () -- direct
519+ tls -> unless (tls12orLater tls) $ goaway conn H2.InadequateSecurity "Weak TLS"
520+ tls12orLater tls = tlsMajorVersion tls == 3 && tlsMinorVersion tls >= 3
521+
522+-- connClose must not be called here since Run:fork calls it
523+goaway :: Connection -> H2.ErrorCodeId -> ByteString -> IO ()
524+goaway Connection{..} etype debugmsg = connSendAll bytestream
525+ where
526+ einfo = H2.encodeInfo id 0
527+ frame = H2.GoAwayFrame 0 etype debugmsg
528+ bytestream = H2.encodeFrame einfo frame
457
529
458flushEntireBody :: IO ByteString -> IO ()
530flushEntireBody :: IO ByteString -> IO ()
459flushEntireBody src =
531flushEntireBody src =
@@ -486,13 +558,42 @@ wrappedRecv Connection { connRecv = recv } th istatus slowlorisSize = do
486 when (S.length bs >= slowlorisSize) $ T.tickle th
558 when (S.length bs >= slowlorisSize) $ T.tickle th
487 return bs
559 return bs
488
560
561+wrappedRecvN :: T.Handle -> IORef Bool -> Int -> (BufSize -> IO ByteString) -> (BufSize -> IO ByteString)
562+wrappedRecvN th istatus slowlorisSize readN bufsize = do
563+ bs <- readN bufsize
564+ unless (S.null bs) $ do
565+ writeIORef istatus True
566+ -- TODO: think about the slowloris protection in HTTP2: current code
567+ -- might open a slow-loris attack vector. Rather than timing we should
568+ -- consider limiting the per-client connections assuming that in HTTP2
569+ -- we should allow only few connections per host (real-world
570+ -- deployments with large NATs may be trickier).
571+ when (S.length bs >= slowlorisSize || bufsize <= slowlorisSize) $ T.tickle th
572+ return bs
573+
574+-- | Set flag FileCloseOnExec flag on a socket (on Unix)
575+--
489-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
576-- Copied from: https://github.com/mzero/plush/blob/master/src/Plush/Server/Warp.hs
577+--
578+-- @since 3.2.17
490setSocketCloseOnExec :: Socket -> IO ()
579setSocketCloseOnExec :: Socket -> IO ()
491#if WINDOWS
580#if WINDOWS
492setSocketCloseOnExec _ = return ()
581setSocketCloseOnExec _ = return ()
493#else
582#else
494−setSocketCloseOnExec socket = F.setFileCloseOnExec $ fromIntegral $ fdSocket socket
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
495#endif
590#endif
496
591
497−gracefulShutdown :: Counter -> IO ()
592+gracefulShutdown :: Settings -> Counter -> IO ()
498−gracefulShutdown counter = waitForZero counter
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+4−8
@@ -9,22 +9,14 @@ module Network.Wai.Handler.Warp.SendFile (
9#endif
9#endif
10 ) where
10 ) where
11
11
12−import Control.Monad (void, when)
13−import Data.ByteString (ByteString)
14import qualified Data.ByteString as BS
12import qualified Data.ByteString as BS
15import Network.Socket (Socket)
13import Network.Socket (Socket)
16−import Network.Wai.Handler.Warp.Buffer
17−import Network.Wai.Handler.Warp.Types
18
14
19#ifdef WINDOWS
15#ifdef WINDOWS
20−import Data.ByteString.Internal (ByteString(..))
21import Foreign.ForeignPtr (newForeignPtr_)
16import Foreign.ForeignPtr (newForeignPtr_)
22import Foreign.Ptr (plusPtr)
17import Foreign.Ptr (plusPtr)
23import qualified System.IO as IO
18import qualified System.IO as IO
24#else
19#else
25−# if __GLASGOW_HASKELL__ < 709
26−import Control.Applicative ((<$>))
27−# endif
28import Control.Exception
20import Control.Exception
29import Foreign.C.Error (throwErrno)
21import Foreign.C.Error (throwErrno)
30import Foreign.C.Types
22import Foreign.C.Types
@@ -34,6 +26,10 @@ import Network.Wai.Handler.Warp.FdCache (openFile, closeFile)
34import System.Posix.Types
26import System.Posix.Types
35#endif
27#endif
36
28
29+import Network.Wai.Handler.Warp.Buffer
30+import Network.Wai.Handler.Warp.Imports
31+import Network.Wai.Handler.Warp.Types
32+
37----------------------------------------------------------------
33----------------------------------------------------------------
38
34
39-- | Function to send a file based on sendfile() for Linux\/Mac\/FreeBSD.
35-- | Function to send a file based on sendfile() for Linux\/Mac\/FreeBSD.
warp/Network/Wai/Handler/Warp/Settings.hs+70−18
@@ -6,26 +6,25 @@ module Network.Wai.Handler.Warp.Settings where
6
6
7import Control.Concurrent (forkIOWithUnmask)
7import Control.Concurrent (forkIOWithUnmask)
8import Control.Exception
8import Control.Exception
9−import Control.Monad (when, void)
10−import Data.ByteString (ByteString)
11−import qualified Data.ByteString.Char8 as S8
12import Data.ByteString.Builder (byteString)
9import Data.ByteString.Builder (byteString)
13−#if __GLASGOW_HASKELL__ < 709
10+import qualified Data.ByteString.Char8 as C8
14−import Data.Monoid (mappend)
11+import Data.ByteString.Lazy (fromStrict)
15−#endif
16import Data.Streaming.Network (HostPreference)
12import Data.Streaming.Network (HostPreference)
17import qualified Data.Text as T
13import qualified Data.Text as T
18import qualified Data.Text.IO as TIO
14import qualified Data.Text.IO as TIO
19import Data.Version (showVersion)
15import Data.Version (showVersion)
20import GHC.IO.Exception (IOErrorType(..))
16import GHC.IO.Exception (IOErrorType(..))
21import qualified Network.HTTP.Types as H
17import qualified Network.HTTP.Types as H
18+import Network.HTTP2( HTTP2Error (..), ErrorCodeId (..) )
22import Network.Socket (SockAddr)
19import Network.Socket (SockAddr)
23import Network.Wai
20import Network.Wai
24−import Network.Wai.Handler.Warp.Timeout
25−import Network.Wai.Handler.Warp.Types
26import qualified Paths_warp
21import qualified Paths_warp
27import System.IO (stderr)
22import System.IO (stderr)
28import System.IO.Error (ioeGetErrorType)
23import System.IO.Error (ioeGetErrorType)
24+import System.TimeManager
25+
26+import Network.Wai.Handler.Warp.Imports
27+import Network.Wai.Handler.Warp.Types
29
28
30-- | Various Warp server settings. This is purposely kept as an abstract data
29-- | Various Warp server settings. This is purposely kept as an abstract data
31-- type so that new settings can be added without breaking backwards
30-- type so that new settings can be added without breaking backwards
@@ -77,6 +76,13 @@ data Settings = Settings
77 --
76 --
78 -- Since 2.0.3
77 -- Since 2.0.3
79 , settingsInstallShutdownHandler :: IO () -> IO ()
78 , settingsInstallShutdownHandler :: IO () -> IO ()
79+ -- ^ An action to install a handler (e.g. Unix signal handler)
80+ -- to close a listen socket.
81+ -- The first argument is an action to close the listen socket.
82+ --
83+ -- Default: no action
84+ --
85+ -- Since 3.0.1
80 , settingsServerName :: ByteString
86 , settingsServerName :: ByteString
81 -- ^ Default server name if application does not set one.
87 -- ^ Default server name if application does not set one.
82 --
88 --
@@ -88,19 +94,44 @@ data Settings = Settings
88 , settingsProxyProtocol :: ProxyProtocol
94 , settingsProxyProtocol :: ProxyProtocol
89 -- ^ Specify usage of the PROXY protocol.
95 -- ^ Specify usage of the PROXY protocol.
90 --
96 --
91− -- Since 3.0.5.
97+ -- Since 3.0.5
92 , settingsSlowlorisSize :: Int
98 , settingsSlowlorisSize :: Int
93 -- ^ Size of bytes read to prevent Slowloris protection. Default value: 2048
99 -- ^ Size of bytes read to prevent Slowloris protection. Default value: 2048
94 --
100 --
95− -- Since 3.1.2.
101+ -- Since 3.1.2
96 , settingsHTTP2Enabled :: Bool
102 , settingsHTTP2Enabled :: Bool
97 -- ^ Whether to enable HTTP2 ALPN/upgrades. Default: True
103 -- ^ Whether to enable HTTP2 ALPN/upgrades. Default: True
98 --
104 --
99− -- Since 3.1.7.
105+ -- Since 3.1.7
100 , settingsLogger :: Request -> H.Status -> Maybe Integer -> IO ()
106 , settingsLogger :: Request -> H.Status -> Maybe Integer -> IO ()
101 -- ^ A log function. Default: no action.
107 -- ^ A log function. Default: no action.
102 --
108 --
103− -- Since 3.X.X.
109+ -- Since 3.1.10
110+ , settingsServerPushLogger :: Request -> ByteString -> Integer -> IO ()
111+ -- ^ A HTTP/2 server push log function. Default: no action.
112+ --
113+ -- Since 3.2.7
114+ , settingsGracefulShutdownTimeout :: Maybe Int
115+ -- ^ An optional timeout to limit the time (in seconds) waiting for
116+ -- a graceful shutdown of the web server.
117+ --
118+ -- Since 3.2.8
119+ , settingsGracefulCloseTimeout1 :: Int
120+ -- ^ A timeout to limit the time (in milliseconds) waiting for
121+ -- FIN for HTTP/1.x. 0 means uses immediate close.
122+ -- Default: 0.
123+ --
124+ -- Since 3.3.5
125+ , settingsGracefulCloseTimeout2 :: Int
126+ -- ^ A timeout to limit the time (in milliseconds) waiting for
127+ -- FIN for HTTP/2. 0 means uses immediate close.
128+ -- Default: 2000.
129+ --
130+ -- Since 3.3.5
131+ , settingsMaxTotalHeaderLength :: Int
132+ -- ^ Determines the maximum header size that Warp will tolerate when using HTTP/1.x.
133+ --
134+ -- Since 3.3.8
104 }
135 }
105
136
106-- | Specify usage of the PROXY protocol.
137-- | Specify usage of the PROXY protocol.
@@ -129,12 +160,17 @@ defaultSettings = Settings
129 , settingsFork = void . forkIOWithUnmask
160 , settingsFork = void . forkIOWithUnmask
130 , settingsNoParsePath = False
161 , settingsNoParsePath = False
131 , settingsInstallShutdownHandler = const $ return ()
162 , settingsInstallShutdownHandler = const $ return ()
132− , settingsServerName = S8.pack $ "Warp/" ++ showVersion Paths_warp.version
163+ , settingsServerName = C8.pack $ "Warp/" ++ showVersion Paths_warp.version
133 , settingsMaximumBodyFlush = Just 8192
164 , settingsMaximumBodyFlush = Just 8192
134 , settingsProxyProtocol = ProxyProtocolNone
165 , settingsProxyProtocol = ProxyProtocolNone
135 , settingsSlowlorisSize = 2048
166 , settingsSlowlorisSize = 2048
136 , settingsHTTP2Enabled = True
167 , settingsHTTP2Enabled = True
137 , settingsLogger = \_ _ _ -> return ()
168 , settingsLogger = \_ _ _ -> return ()
169+ , settingsServerPushLogger = \_ _ _ -> return ()
170+ , settingsGracefulShutdownTimeout = Nothing
171+ , settingsGracefulCloseTimeout1 = 0
172+ , settingsGracefulCloseTimeout2 = 2000
173+ , settingsMaxTotalHeaderLength = 50 * 1024
138 }
174 }
139
175
140-- | Apply the logic provided by 'defaultOnException' to determine if an
176-- | Apply the logic provided by 'defaultOnException' to determine if an
@@ -160,13 +196,29 @@ defaultOnException _ e =
160 when (defaultShouldDisplayException e)
196 when (defaultShouldDisplayException e)
161 $ TIO.hPutStrLn stderr $ T.pack $ show e
197 $ TIO.hPutStrLn stderr $ T.pack $ show e
162
198
163−-- | Sending 400 for bad requests. Sending 500 for internal server errors.
199+-- | Sending 400 for bad requests.
164−--
200+-- Sending 500 for internal server errors.
165-- Since: 3.1.0
201-- Since: 3.1.0
202+-- Sending 413 for too large payload.
203+-- Sending 431 for too large headers.
204+-- Since 3.2.27
166defaultOnExceptionResponse :: SomeException -> Response
205defaultOnExceptionResponse :: SomeException -> Response
167defaultOnExceptionResponse e
206defaultOnExceptionResponse e
168− | Just (_ :: InvalidRequest) <- fromException e = responseLBS H.badRequest400 [(H.hContentType, "text/plain; charset=utf-8")] "Bad Request"
207+ | Just (_ :: InvalidRequest) <-
169− | otherwise = responseLBS H.internalServerError500 [(H.hContentType, "text/plain; charset=utf-8")] "Something went wrong"
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"
170
222
171-- | Exception handler for the debugging purpose.
223-- | Exception handler for the debugging purpose.
172-- 500, text/plain, a showed exception.
224-- 500, text/plain, a showed exception.
@@ -176,4 +228,4 @@ exceptionResponseForDebug :: SomeException -> Response
176exceptionResponseForDebug e =
228exceptionResponseForDebug e =
177 responseBuilder H.internalServerError500
229 responseBuilder H.internalServerError500
178 [(H.hContentType, "text/plain; charset=utf-8")]
230 [(H.hContentType, "text/plain; charset=utf-8")]
179− $ byteString . S8.pack $ "Exception: " ++ show e
231+ $ byteString . C8.pack $ "Exception: " ++ show e
warp/Network/Wai/Handler/Warp/Types.hs+34−34
@@ -5,17 +5,18 @@
5module Network.Wai.Handler.Warp.Types where
5module Network.Wai.Handler.Warp.Types where
6
6
7import Control.Exception
7import Control.Exception
8−import Data.ByteString (ByteString)
9import qualified Data.ByteString as S
8import qualified Data.ByteString as S
10import Data.IORef (IORef, readIORef, writeIORef, newIORef)
9import Data.IORef (IORef, readIORef, writeIORef, newIORef)
11import Data.Typeable (Typeable)
10import Data.Typeable (Typeable)
12−import Data.Word (Word16, Word8)
11+import Data.X509
13import Foreign.Ptr (Ptr)
12import Foreign.Ptr (Ptr)
13+import System.Posix.Types (Fd)
14+import qualified System.TimeManager as T
15+
14import qualified Network.Wai.Handler.Warp.Date as D
16import qualified Network.Wai.Handler.Warp.Date as D
15import qualified Network.Wai.Handler.Warp.FdCache as F
17import qualified Network.Wai.Handler.Warp.FdCache as F
16import qualified Network.Wai.Handler.Warp.FileInfoCache as I
18import qualified Network.Wai.Handler.Warp.FileInfoCache as I
17−import qualified Network.Wai.Handler.Warp.Timeout as T
19+import Network.Wai.Handler.Warp.Imports
18−import System.Posix.Types (Fd)
19
20
20----------------------------------------------------------------
21----------------------------------------------------------------
21
22
@@ -52,6 +53,20 @@ instance Exception InvalidRequest
52
53
53----------------------------------------------------------------
54----------------------------------------------------------------
54
55
56+-- | Exception thrown if something goes wrong while in the midst of
57+-- sending a response, since the status code can't be altered at that
58+-- point.
59+--
60+-- Used to determine whether keeping the HTTP1.1 connection / HTTP2 stream alive is safe
61+-- or irrecoverable.
62+
63+newtype ExceptionInsideResponseBody = ExceptionInsideResponseBody SomeException
64+ deriving (Show, Typeable)
65+
66+instance Exception ExceptionInsideResponseBody
67+
68+----------------------------------------------------------------
69+
55-- | Data type to abstract file identifiers.
70-- | Data type to abstract file identifiers.
56-- On Unix, a file descriptor would be specified to make use of
71-- On Unix, a file descriptor would be specified to make use of
57-- the file descriptor cache.
72-- the file descriptor cache.
@@ -92,8 +107,13 @@ data Connection = Connection {
92 , connSendAll :: ByteString -> IO ()
107 , connSendAll :: ByteString -> IO ()
93 -- | The sending function for files in HTTP/1.1.
108 -- | The sending function for files in HTTP/1.1.
94 , connSendFile :: SendFile
109 , connSendFile :: SendFile
95− -- | The connection closing function.
110+ -- | The connection closing function. Warp guarantees it will only be
111+ -- called once. Other functions (like 'connRecv') may be called after
112+ -- 'connClose' is called.
96 , connClose :: IO ()
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 ()
97 -- | The connection receiving function. This returns "" for EOF.
117 -- | The connection receiving function. This returns "" for EOF.
98 , connRecv :: Recv
118 , connRecv :: Recv
99 -- | The connection receiving function. This tries to fill the buffer.
119 -- | The connection receiving function. This tries to fill the buffer.
@@ -103,46 +123,25 @@ data Connection = Connection {
103 , connWriteBuffer :: Buffer
123 , connWriteBuffer :: Buffer
104 -- | The size of the write buffer.
124 -- | The size of the write buffer.
105 , connBufferSize :: BufSize
125 , connBufferSize :: BufSize
126+ -- | Is this connection HTTP/2?
127+ , connHTTP2 :: IORef Bool
106 }
128 }
107
129
108−----------------------------------------------------------------
130+getConnHTTP2 :: Connection -> IO Bool
109−
131+getConnHTTP2 conn = readIORef (connHTTP2 conn)
110−type Hash = Int
111−
112−
113−data InternalInfo0 =
114− InternalInfo0 T.Manager
115− (IO D.GMTDate)
116− (Hash -> FilePath -> IO (Maybe F.Fd, F.Refresh))
117− (Hash -> FilePath -> IO I.FileInfo)
118
132
119−timeoutManager0 :: InternalInfo0 -> T.Manager
133+setConnHTTP2 :: Connection -> Bool -> IO ()
120−timeoutManager0 (InternalInfo0 tm _ _ _) = tm
134+setConnHTTP2 conn b = writeIORef (connHTTP2 conn) b
121
135
122−data InternalInfo1 =
136+----------------------------------------------------------------
123− InternalInfo1 T.Handle
124− T.Manager
125− (IO D.GMTDate)
126− (Hash -> FilePath -> IO (Maybe F.Fd, F.Refresh))
127− (Hash -> FilePath -> IO I.FileInfo)
128−
129−toInternalInfo1 :: InternalInfo0 -> T.Handle -> InternalInfo1
130−toInternalInfo1 (InternalInfo0 b c d e) a = InternalInfo1 a b c d e
131−
132−threadHandle1 :: InternalInfo1 -> T.Handle
133−threadHandle1 (InternalInfo1 th _ _ _ _) = th
134
137
135data InternalInfo = InternalInfo {
138data InternalInfo = InternalInfo {
136− threadHandle :: T.Handle
139+ timeoutManager :: T.Manager
137− , timeoutManager :: T.Manager
138 , getDate :: IO D.GMTDate
140 , getDate :: IO D.GMTDate
139 , getFd :: FilePath -> IO (Maybe F.Fd, F.Refresh)
141 , getFd :: FilePath -> IO (Maybe F.Fd, F.Refresh)
140 , getFileInfo :: FilePath -> IO I.FileInfo
142 , getFileInfo :: FilePath -> IO I.FileInfo
141 }
143 }
142
144
143−toInternalInfo :: InternalInfo1 -> Hash -> InternalInfo
144−toInternalInfo (InternalInfo1 a b c d e) h = InternalInfo a b c (d h) (e h)
145−
146----------------------------------------------------------------
145----------------------------------------------------------------
147
146
148-- | Type for input streaming.
147-- | Type for input streaming.
@@ -181,6 +180,7 @@ data Transport = TCP -- ^ Plain channel: TCP
181 , tlsMinorVersion :: Int
180 , tlsMinorVersion :: Int
182 , tlsNegotiatedProtocol :: Maybe ByteString -- ^ The result of Application Layer Protocol Negociation in RFC 7301
181 , tlsNegotiatedProtocol :: Maybe ByteString -- ^ The result of Application Layer Protocol Negociation in RFC 7301
183 , tlsChiperID :: Word16
182 , tlsChiperID :: Word16
183+ , tlsClientCertificate :: Maybe CertificateChain
184 } -- ^ Encrypted channel: TLS or SSL
184 } -- ^ Encrypted channel: TLS or SSL
185
185
186isTransportSecure :: Transport -> Bool
186isTransportSecure :: Transport -> Bool
warp/Network/Wai/Handler/Warp/Windows.hs+5−1
@@ -7,8 +7,12 @@ module Network.Wai.Handler.Warp.Windows
7import Control.Exception
7import Control.Exception
8import Control.Concurrent.MVar
8import Control.Concurrent.MVar
9import Control.Concurrent
9import Control.Concurrent
10−import Control.Monad
11
10
11+import Network.Wai.Handler.Warp.Imports
12+
13+-- | Allow main socket listening thread to be interrupted on Windows platform
14+--
15+-- @since 3.2.17
12windowsThreadBlockHack :: IO a -> IO a
16windowsThreadBlockHack :: IO a -> IO a
13windowsThreadBlockHack act = do
17windowsThreadBlockHack act = do
14 var <- newEmptyMVar :: IO (MVar (Either SomeException a))
18 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/bench/Parser.hs+21−16
@@ -1,3 +1,4 @@
1+{-# LANGUAGE CPP #-}
1{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE OverloadedStrings #-}
2{-# LANGUAGE BangPatterns #-}
3{-# LANGUAGE BangPatterns #-}
3
4
@@ -18,7 +19,11 @@ import Foreign.ForeignPtr
18import Foreign.Ptr
19import Foreign.Ptr
19import Foreign.Storable
20import Foreign.Storable
20
21
21−import Criterion.Main
22+#if MIN_VERSION_gauge(0, 2, 0)
23+import Gauge
24+#else
25+import Gauge.Main
26+#endif
22
27
23-- $setup
28-- $setup
24-- >>> :set -XOverloadedStrings
29-- >>> :set -XOverloadedStrings
@@ -32,15 +37,15 @@ main = do
32 defaultMain [
37 defaultMain [
33 bgroup "requestLine1" [
38 bgroup "requestLine1" [
34 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine1
39 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine1
35− , bench "parseRequestLine2" $ parseRequestLine2 requestLine1
40+ , bench "parseRequestLine2" $ whnfIO $ parseRequestLine2 requestLine1
36− , bench "parseRequestLine1" $ parseRequestLine1 requestLine1
41+ , bench "parseRequestLine1" $ whnfIO $ parseRequestLine1 requestLine1
37− , bench "parseRequestLine0" $ parseRequestLine0 requestLine1
42+ , bench "parseRequestLine0" $ whnfIO $ parseRequestLine0 requestLine1
38 ]
43 ]
39 , bgroup "requestLine2" [
44 , bgroup "requestLine2" [
40 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine2
45 bench "parseRequestLine3" $ whnf parseRequestLine3 requestLine2
41− , bench "parseRequestLine2" $ parseRequestLine2 requestLine2
46+ , bench "parseRequestLine2" $ whnfIO $ parseRequestLine2 requestLine2
42− , bench "parseRequestLine1" $ parseRequestLine1 requestLine2
47+ , bench "parseRequestLine1" $ whnfIO $ parseRequestLine1 requestLine2
43− , bench "parseRequestLine0" $ parseRequestLine0 requestLine2
48+ , bench "parseRequestLine0" $ whnfIO $ parseRequestLine0 requestLine2
44 ]
49 ]
45 ]
50 ]
46
51
@@ -63,15 +68,15 @@ parseRequestLine3 :: ByteString
63 ,H.HttpVersion)
68 ,H.HttpVersion)
64parseRequestLine3 requestLine = ret
69parseRequestLine3 requestLine = ret
65 where
70 where
66− (!method,!rest) = S.breakByte 32 requestLine -- ' '
71+ (!method,!rest) = S.break (== 32) requestLine -- ' '
67 (!pathQuery,!httpVer')
72 (!pathQuery,!httpVer')
68 | rest == "" = throw badmsg
73 | rest == "" = throw badmsg
69− | otherwise = S.breakByte 32 (S.drop 1 rest) -- ' '
74+ | otherwise = S.break (== 32) (S.drop 1 rest) -- ' '
70− (!path,!query) = S.breakByte 63 pathQuery -- '?'
75+ (!path,!query) = S.break (== 63) pathQuery -- '?'
71 !httpVer = S.drop 1 httpVer'
76 !httpVer = S.drop 1 httpVer'
72 (!http,!ver)
77 (!http,!ver)
73 | httpVer == "" = throw badmsg
78 | httpVer == "" = throw badmsg
74− | otherwise = S.breakByte 47 httpVer -- '/'
79+ | otherwise = S.break (== 47) httpVer -- '/'
75 !hv | http /= "HTTP" = throw NonHttp
80 !hv | http /= "HTTP" = throw NonHttp
76 | ver == "/1.1" = H.http11
81 | ver == "/1.1" = H.http11
77 | otherwise = H.http10
82 | otherwise = H.http10
@@ -169,13 +174,13 @@ parseRequestLine1 :: ByteString
169 ,ByteString -- Query
174 ,ByteString -- Query
170 ,H.HttpVersion)
175 ,H.HttpVersion)
171parseRequestLine1 requestLine = do
176parseRequestLine1 requestLine = do
172− let (!method,!rest) = S.breakByte 32 requestLine -- ' '
177+ let (!method,!rest) = S.break (== 32) requestLine -- ' '
173− (!pathQuery,!httpVer') = S.breakByte 32 (S.drop 1 rest) -- ' '
178+ (!pathQuery,!httpVer') = S.break (== 32) (S.drop 1 rest) -- ' '
174 !httpVer = S.drop 1 httpVer'
179 !httpVer = S.drop 1 httpVer'
175 when (rest == "" || httpVer == "") $
180 when (rest == "" || httpVer == "") $
176 throwIO $ BadFirstLine $ B.unpack requestLine
181 throwIO $ BadFirstLine $ B.unpack requestLine
177− let (!path,!query) = S.breakByte 63 pathQuery -- '?'
182+ let (!path,!query) = S.break (== 63) pathQuery -- '?'
178− (!http,!ver) = S.breakByte 47 httpVer -- '/'
183+ (!http,!ver) = S.break (== 47) httpVer -- '/'
179 when (http /= "HTTP") $ throwIO NonHttp
184 when (http /= "HTTP") $ throwIO NonHttp
180 let !hv | ver == "/1.1" = H.http11
185 let !hv | ver == "/1.1" = H.http11
181 | otherwise = H.http10
186 | otherwise = H.http10
@@ -205,7 +210,7 @@ parseRequestLine0 s =
205 !http' = S.concat http''
210 !http' = S.concat http''
206 (!hfirst, !hsecond) = S.splitAt 5 http'
211 (!hfirst, !hsecond) = S.splitAt 5 http'
207 if hfirst == "HTTP/"
212 if hfirst == "HTTP/"
208− then let (!rpath, !qstring) = S.breakByte 63 query -- '?'
213+ then let (!rpath, !qstring) = S.break (== 63) query -- '?'
209 !hv =
214 !hv =
210 case hsecond of
215 case hsecond of
211 "1.1" -> H.http11
216 "1.1" -> H.http11
warp/test/ExceptionSpec.hs+13−13
@@ -7,14 +7,14 @@ import Control.Applicative
7#endif
7#endif
8import Control.Monad
8import Control.Monad
9import Network.HTTP.Types hiding (Header)
9import Network.HTTP.Types hiding (Header)
10−import Network.Wai hiding (Response)
10+import Network.Wai hiding (Response, responseStatus)
11import Network.Wai.Internal (Request(..))
11import Network.Wai.Internal (Request(..))
12import Network.Wai.Handler.Warp
12import Network.Wai.Handler.Warp
13import Test.Hspec
13import Test.Hspec
14import Control.Exception
14import Control.Exception
15import qualified Data.Streaming.Network as N
15import qualified Data.Streaming.Network as N
16import Control.Concurrent.Async (withAsync)
16import Control.Concurrent.Async (withAsync)
17−import Network.Socket (sClose)
17+import Network.Socket (close)
18
18
19import HTTP
19import HTTP
20
20
@@ -24,7 +24,7 @@ main = hspec spec
24withTestServer :: (Int -> IO a) -> IO a
24withTestServer :: (Int -> IO a) -> IO a
25withTestServer inner = bracket
25withTestServer inner = bracket
26 (N.bindRandomPortTCP "127.0.0.1")
26 (N.bindRandomPortTCP "127.0.0.1")
27− (sClose . snd)
27+ (close . snd)
28 $ \(prt, lsocket) -> do
28 $ \(prt, lsocket) -> do
29 withAsync (runSettingsSocket defaultSettings lsocket testApp)
29 withAsync (runSettingsSocket defaultSettings lsocket testApp)
30 $ \_ -> inner prt
30 $ \_ -> inner prt
@@ -49,18 +49,18 @@ spec :: Spec
49spec = describe "responds even if there is an exception" $ do
49spec = describe "responds even if there is an exception" $ do
50 {- Disabling these tests. We can consider forcing evaluation in Warp.
50 {- Disabling these tests. We can consider forcing evaluation in Warp.
51 it "statusError" $ do
51 it "statusError" $ do
52− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/statusError"
52+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/statusError"
53− sc `shouldBe` (5,0,0)
53+ sc `shouldBe` internalServerError500
54 it "headersError" $ do
54 it "headersError" $ do
55− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headersError"
55+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headersError"
56− sc `shouldBe` (5,0,0)
56+ sc `shouldBe` internalServerError500
57 it "headerError" $ do
57 it "headerError" $ do
58− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/headerError"
58+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/headerError"
59− sc `shouldBe` (5,0,0)
59+ sc `shouldBe` internalServerError500
60 it "bodyError" $ do
60 it "bodyError" $ do
61− sc <- rspCode <$> sendGET "http://127.0.0.1:2345/bodyError"
61+ sc <- responseStatus <$> sendGET "http://127.0.0.1:2345/bodyError"
62− sc `shouldBe` (5,0,0)
62+ sc `shouldBe` internalServerError500
63 -}
63 -}
64 it "ioException" $ withTestServer $ \prt -> do
64 it "ioException" $ withTestServer $ \prt -> do
65− sc <- rspCode <$> sendGET ("http://127.0.0.1:" ++ show prt ++ "/ioException")
65+ sc <- responseStatus <$> sendGET ("http://127.0.0.1:" ++ show prt ++ "/ioException")
66− sc `shouldBe` (5,0,0)
66+ sc `shouldBe` internalServerError500
warp/test/FdCacheSpec.hs+1−1
@@ -17,7 +17,7 @@ spec = describe "withFdCache" $ do
17 it "clean up Fd" $ do
17 it "clean up Fd" $ do
18 ref <- newIORef (Fd (-1))
18 ref <- newIORef (Fd (-1))
19 withFdCache 30000000 $ \getFd -> do
19 withFdCache 30000000 $ \getFd -> do
20− (Just fd,_) <- getFd 0 "warp.cabal"
20+ (Just fd,_) <- getFd "warp.cabal"
21 writeIORef ref fd
21 writeIORef ref fd
22 nfd <- readIORef ref
22 nfd <- readIORef ref
23 fdRead nfd 1 `shouldThrow` anyIOException
23 fdRead nfd 1 `shouldThrow` anyIOException
warp/test/FileSpec.hs+1−1
@@ -21,7 +21,7 @@ testFileRange desc reqhs file ans = it desc $ do
21 let WithBody s hs off len = ans
21 let WithBody s hs off len = ans
22 hs' = ("Last-Modified",fileInfoDate finfo) : hs
22 hs' = ("Last-Modified",fileInfoDate finfo) : hs
23 ans' = WithBody s hs' off len
23 ans' = WithBody s hs' off len
24− conditionalRequest finfo [] (indexRequestHeader reqhs) `shouldBe` ans'
24+ conditionalRequest finfo [] (indexResponseHeader hs) (indexRequestHeader reqhs) `shouldBe` ans'
25
25
26spec :: Spec
26spec :: Spec
27spec = do
27spec = do
warp/test/HTTP.hs+26−28
@@ -1,43 +1,41 @@
1−{-# LANGUAGE StandaloneDeriving #-}
2−{-# OPTIONS_GHC -fno-warn-orphans #-}
3module HTTP (
1module HTTP (
4 sendGET
2 sendGET
5 , sendGETwH
3 , sendGETwH
6 , sendHEAD
4 , sendHEAD
7 , sendHEADwH
5 , sendHEADwH
8− , rspBody
6+ , responseBody
9− , rspCode
7+ , responseStatus
10− , rspHeaders
8+ , responseHeaders
11 , getHeaderValue
9 , getHeaderValue
12− , HeaderName(..)
10+ , HeaderName
13− , mkHeader
14 ) where
11 ) where
15
12
16−import Network.HTTP
13+import Network.HTTP.Client
17−import Network.Stream
14+import Network.HTTP.Types
15+import Data.ByteString
16+import qualified Data.ByteString.Lazy as BL
18
17
19−sendGET :: String -> IO (Response String)
18+sendGET :: String -> IO (Response BL.ByteString)
20sendGET url = sendGETwH url []
19sendGET url = sendGETwH url []
21
20
22−sendGETwH :: String -> [Header] -> IO (Response String)
21+sendGETwH :: String -> [Header] -> IO (Response BL.ByteString)
23−sendGETwH url hdr = unResult $ simpleHTTP $ (getRequest url) { rqHeaders = hdr }
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
24
28
25−sendHEAD :: String -> IO (Response String)
29+sendHEAD :: String -> IO (Response BL.ByteString)
26sendHEAD url = sendHEADwH url []
30sendHEAD url = sendHEADwH url []
27
31
28−sendHEADwH :: String -> [Header] -> IO (Response String)
32+sendHEADwH :: String -> [Header] -> IO (Response BL.ByteString)
29−sendHEADwH url hdr = unResult $ simpleHTTP $ (headRequest url) { rqHeaders = hdr }
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
30
39
31−unResult :: IO (Result (Response String)) -> IO (Response String)
40+getHeaderValue :: HeaderName -> [Header] -> Maybe ByteString
32−unResult action = do
41+getHeaderValue = lookup
33− res <- action
34− case res of
35− Right rsp -> return rsp
36− Left _ -> error "Connection error"
37−
38−getHeaderValue :: HasHeaders a => HeaderName -> a -> Maybe String
39−getHeaderValue key r = case retrieveHeaders key r of
40− [] -> Nothing
41− x:_ -> Just $ hdrValue x
42−
43−deriving instance Eq Header
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+11−7
@@ -7,6 +7,7 @@ module RequestSpec (main, spec) where
7import Network.Wai.Handler.Warp.File (parseByteRanges)
7import Network.Wai.Handler.Warp.File (parseByteRanges)
8import Network.Wai.Handler.Warp.Request
8import Network.Wai.Handler.Warp.Request
9import Network.Wai.Handler.Warp.Types
9import Network.Wai.Handler.Warp.Types
10+import Network.Wai.Handler.Warp.Settings (settingsMaxTotalHeaderLength, defaultSettings)
10import Test.Hspec
11import Test.Hspec
11import Test.Hspec.QuickCheck
12import Test.Hspec.QuickCheck
12import qualified Data.ByteString as S
13import qualified Data.ByteString as S
@@ -17,6 +18,9 @@ import Data.IORef
17main :: IO ()
18main :: IO ()
18main = hspec spec
19main = hspec spec
19
20
21+defaultMaxTotalHeaderLength :: Int
22+defaultMaxTotalHeaderLength = settingsMaxTotalHeaderLength defaultSettings
23+
20spec :: Spec
24spec :: Spec
21spec = do
25spec = do
22 describe "headerLines" $ do
26 describe "headerLines" $ do
@@ -63,29 +67,29 @@ spec = do
63 describe "headerLines" $ do
67 describe "headerLines" $ do
64 it "can handle a nomarl case" $ do
68 it "can handle a nomarl case" $ do
65 src <- mkSourceFunc ["Status: 200\r\nContent-Type: text/plain\r\n\r\n"] >>= mkSource
69 src <- mkSourceFunc ["Status: 200\r\nContent-Type: text/plain\r\n\r\n"] >>= mkSource
66− x <- headerLines src
70+ x <- headerLines defaultMaxTotalHeaderLength True src
67 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
71 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
68
72
69 it "can handle a nasty case (1)" $ do
73 it "can handle a nasty case (1)" $ do
70 src <- mkSourceFunc ["Status: 200", "\r\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
74 src <- mkSourceFunc ["Status: 200", "\r\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
71− x <- headerLines src
75+ x <- headerLines defaultMaxTotalHeaderLength True src
72 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
76 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
73
77
74 it "can handle a nasty case (1)" $ do
78 it "can handle a nasty case (1)" $ do
75 src <- mkSourceFunc ["Status: 200", "\r", "\nContent-Type: text/plain", "\r", "\n\r\n"] >>= mkSource
79 src <- mkSourceFunc ["Status: 200", "\r", "\nContent-Type: text/plain", "\r", "\n\r\n"] >>= mkSource
76− x <- headerLines src
80+ x <- headerLines defaultMaxTotalHeaderLength True src
77 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
81 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
78
82
79 it "can handle a nasty case (1)" $ do
83 it "can handle a nasty case (1)" $ do
80 src <- mkSourceFunc ["Status: 200", "\r", "\n", "Content-Type: text/plain", "\r", "\n", "\r", "\n"] >>= mkSource
84 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
82 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
86 x `shouldBe` ["Status: 200", "Content-Type: text/plain"]
83
87
84 it "can handle an illegal case (1)" $ do
88 it "can handle an illegal case (1)" $ do
85 src <- mkSourceFunc ["\nStatus:", "\n 200", "\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
89 src <- mkSourceFunc ["\nStatus:", "\n 200", "\nContent-Type: text/plain", "\r\n\r\n"] >>= mkSource
86− x <- headerLines src
90+ x <- headerLines defaultMaxTotalHeaderLength True src
87 x `shouldBe` []
91 x `shouldBe` []
88− y <- headerLines src
92+ y <- headerLines defaultMaxTotalHeaderLength True src
89 y `shouldBe` ["Status: 200", "Content-Type: text/plain"]
93 y `shouldBe` ["Status: 200", "Content-Type: text/plain"]
90
94
91 where
95 where
@@ -111,7 +115,7 @@ headerLinesList' orig = do
111 writeIORef ref z
115 writeIORef ref z
112 return y
116 return y
113 src' <- mkSource src
117 src' <- mkSource src
114− res <- headerLines src'
118+ res <- headerLines defaultMaxTotalHeaderLength True src'
115 return (res, src')
119 return (res, src')
116
120
117consumeLen :: Int -> Source -> IO S8.ByteString
121consumeLen :: Int -> Source -> IO S8.ByteString
warp/test/ResponseHeaderSpec.hs+25−5
@@ -5,24 +5,44 @@ module ResponseHeaderSpec (main, spec) where
5import Data.ByteString
5import Data.ByteString
6import qualified Network.HTTP.Types as H
6import qualified Network.HTTP.Types as H
7import Network.Wai.Handler.Warp.ResponseHeader
7import Network.Wai.Handler.Warp.ResponseHeader
8+import Network.Wai.Handler.Warp.Response
9+import Network.Wai.Handler.Warp.Header
8import Test.Hspec
10import Test.Hspec
9
11
10main :: IO ()
12main :: IO ()
11main = hspec spec
13main = hspec spec
12
14
13spec :: Spec
15spec :: Spec
14−spec = describe "composeHeader" $ do
16+spec = do
15− it "composes a HTTP header" $
17+ describe "composeHeader" $ do
16− composeHeader H.http11 H.ok200 headers `shouldReturn` composedHeader
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` []
17
37
18headers :: H.ResponseHeaders
38headers :: H.ResponseHeaders
19headers = [
39headers = [
20 ("Date", "Mon, 13 Aug 2012 04:22:55 GMT")
40 ("Date", "Mon, 13 Aug 2012 04:22:55 GMT")
21− , ("Content-Lenght", "151")
41+ , ("Content-Length", "151")
22 , ("Server", "Mighttpd/2.5.8")
42 , ("Server", "Mighttpd/2.5.8")
23 , ("Last-Modified", "Fri, 22 Jun 2012 01:18:08 GMT")
43 , ("Last-Modified", "Fri, 22 Jun 2012 01:18:08 GMT")
24 , ("Content-Type", "text/html")
44 , ("Content-Type", "text/html")
25 ]
45 ]
26
46
27composedHeader :: ByteString
47composedHeader :: 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+15−23
@@ -6,17 +6,13 @@ import Control.Concurrent (threadDelay)
6import qualified Data.ByteString as S
6import qualified Data.ByteString as S
7import qualified Data.ByteString.Char8 as S8
7import qualified Data.ByteString.Char8 as S8
8import Data.Maybe (mapMaybe)
8import Data.Maybe (mapMaybe)
9−import Network (connectTo, PortID (PortNumber))
10import Network.HTTP.Types
9import Network.HTTP.Types
11−import Network.Wai
10+import Network.Wai hiding (responseHeaders)
12import Network.Wai.Handler.Warp
11import Network.Wai.Handler.Warp
13import Network.Wai.Handler.Warp.Response
12import Network.Wai.Handler.Warp.Response
14−import RunSpec (withApp)
13+import RunSpec (withApp, msWrite, msRead, withMySocket)
15−import System.IO (hClose, hFlush)
16import Test.Hspec
14import Test.Hspec
17
15
18−import HTTP
19−
20main :: IO ()
16main :: IO ()
21main = hspec spec
17main = hspec spec
22
18
@@ -24,16 +20,13 @@ testRange :: S.ByteString -- ^ range value
24 -> String -- ^ expected output
20 -> String -- ^ expected output
25 -> Maybe String -- ^ expected content-range value
21 -> Maybe String -- ^ expected content-range value
26 -> Spec
22 -> Spec
27−testRange range out crange = it title $ withApp defaultSettings app $ \port -> do
23+testRange range out crange = it title $ withApp defaultSettings app $ withMySocket $ \ms -> do
28− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
24+ msWrite ms "GET / HTTP/1.0\r\n"
29− S.hPutStr handle "GET / HTTP/1.0\r\n"
25+ msWrite ms "Range: bytes="
30− S.hPutStr handle "Range: bytes="
26+ msWrite ms range
31− S.hPutStr handle range
27+ msWrite ms "\r\n\r\n"
32− S.hPutStr handle "\r\n\r\n"
33− hFlush handle
34 threadDelay 10000
28 threadDelay 10000
35− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
29+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
36− hClose handle
37 last bss `shouldBe` out
30 last bss `shouldBe` out
38 let hs = mapMaybe toHeader bss
31 let hs = mapMaybe toHeader bss
39 lookup "Content-Range" hs `shouldBe` fmap ("bytes " ++) crange
32 lookup "Content-Range" hs `shouldBe` fmap ("bytes " ++) crange
@@ -51,13 +44,10 @@ testPartial :: Integer -- ^ file size
51 -> Integer -- ^ byte count
44 -> Integer -- ^ byte count
52 -> String -- ^ expected output
45 -> String -- ^ expected output
53 -> Spec
46 -> Spec
54−testPartial size offset count out = it title $ withApp defaultSettings app $ \port -> do
47+testPartial size offset count out = it title $ withApp defaultSettings app $ withMySocket $ \ms -> do
55− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
48+ msWrite ms "GET / HTTP/1.0\r\n\r\n"
56− S.hPutStr handle "GET / HTTP/1.0\r\n\r\n"
57− hFlush handle
58 threadDelay 10000
49 threadDelay 10000
59− bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ S.hGetSome handle 1024
50+ bss <- fmap (lines . filter (/= '\r') . S8.unpack) $ msRead ms 1024
60− hClose handle
61 out `shouldBe` last bss
51 out `shouldBe` last bss
62 let hs = mapMaybe toHeader bss
52 let hs = mapMaybe toHeader bss
63 lookup "Content-Length" hs `shouldBe` Just (show $ length $ last bss)
53 lookup "Content-Length" hs `shouldBe` Just (show $ length $ last bss)
@@ -73,13 +63,15 @@ testPartial size offset count out = it title $ withApp defaultSettings app $ \po
73
63
74spec :: Spec
64spec :: Spec
75spec = do
65spec = do
66+{- http-client does not support this.
76 describe "preventing response splitting attack" $ do
67 describe "preventing response splitting attack" $ do
77 it "sanitizes header values" $ do
68 it "sanitizes header values" $ do
78 let app _ respond = respond $ responseLBS status200 [("foo", "foo\r\nbar")] "Hello"
69 let app _ respond = respond $ responseLBS status200 [("foo", "foo\r\nbar")] "Hello"
79 withApp defaultSettings app $ \port -> do
70 withApp defaultSettings app $ \port -> do
80 res <- sendGET $ "http://127.0.0.1:" ++ show port
71 res <- sendGET $ "http://127.0.0.1:" ++ show port
81− getHeaderValue (HdrCustom "foo") res `shouldBe`
72+ getHeaderValue "foo" (responseHeaders res) `shouldBe`
82 Just "foo bar" -- HTTP inserts two spaces for \r\n.
73 Just "foo bar" -- HTTP inserts two spaces for \r\n.
74+-}
83
75
84 describe "sanitizeHeaderValue" $ do
76 describe "sanitizeHeaderValue" $ do
85 it "doesn't alter valid multiline header values" $ do
77 it "doesn't alter valid multiline header values" $ do
@@ -91,7 +83,7 @@ spec = do
91 it "discards empty lines" $ do
83 it "discards empty lines" $ do
92 sanitizeHeaderValue "foo\r\n\r\nbar" `shouldBe` "foo\r\n bar"
84 sanitizeHeaderValue "foo\r\n\r\nbar" `shouldBe` "foo\r\n bar"
93
85
94− context "when sanitizing single occurences of \n" $ do
86+ context "when sanitizing single occurrences of \n" $ do
95 it "replaces \n with \r\n" $ do
87 it "replaces \n with \r\n" $ do
96 sanitizeHeaderValue "foo\n bar" `shouldBe` "foo\r\n bar"
88 sanitizeHeaderValue "foo\n bar" `shouldBe` "foo\r\n bar"
97
89
warp/test/RunSpec.hs+136−86
@@ -1,29 +1,28 @@
1−{-# LANGUAGE CPP #-}
2{-# LANGUAGE OverloadedStrings #-}
1{-# LANGUAGE OverloadedStrings #-}
3{-# LANGUAGE ScopedTypeVariables #-}
2{-# LANGUAGE ScopedTypeVariables #-}
4
3
5−module RunSpec (main, spec, withApp) where
4+module RunSpec (main, spec, withApp, MySocket, msWrite, msRead, withMySocket) where
6
5
7import Control.Concurrent (forkIO, killThread, threadDelay)
6import Control.Concurrent (forkIO, killThread, threadDelay)
8import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
7import Control.Concurrent.MVar (newEmptyMVar, takeMVar, putMVar)
8+import Control.Concurrent.STM
9import qualified Control.Exception as E
9import qualified Control.Exception as E
10import Control.Exception.Lifted (bracket, try, IOException, onException)
10import Control.Exception.Lifted (bracket, try, IOException, onException)
11import Control.Monad (forM_, replicateM_, unless)
11import Control.Monad (forM_, replicateM_, unless)
12import Control.Monad.IO.Class (MonadIO, liftIO)
12import Control.Monad.IO.Class (MonadIO, liftIO)
13−import Data.ByteString (ByteString, hPutStr, hGetSome)
13+import Data.ByteString (ByteString)
14import qualified Data.ByteString as S
14import qualified Data.ByteString as S
15import Data.ByteString.Builder (byteString)
15import Data.ByteString.Builder (byteString)
16import qualified Data.ByteString.Char8 as S8
16import qualified Data.ByteString.Char8 as S8
17import qualified Data.ByteString.Lazy as L
17import qualified Data.ByteString.Lazy as L
18import qualified Data.IORef as I
18import qualified Data.IORef as I
19import Data.Streaming.Network (bindPortTCP, getSocketTCP, safeRecv)
19import Data.Streaming.Network (bindPortTCP, getSocketTCP, safeRecv)
20−import Network (connectTo, PortID (PortNumber))
21import Network.HTTP.Types
20import Network.HTTP.Types
22−import Network.Socket (sClose)
21+import Network.Socket
23import Network.Socket.ByteString (sendAll)
22import Network.Socket.ByteString (sendAll)
24−import Network.Wai
23+import Network.Wai hiding (responseHeaders)
24+import Network.Wai.Internal (getRequestBodyChunk)
25import Network.Wai.Handler.Warp
25import Network.Wai.Handler.Warp
26−import System.IO (hFlush, hClose)
27import System.IO.Unsafe (unsafePerformIO)
26import System.IO.Unsafe (unsafePerformIO)
28import System.Timeout (timeout)
27import System.Timeout (timeout)
29import Test.Hspec
28import Test.Hspec
@@ -36,6 +35,52 @@ main = hspec spec
36type Counter = I.IORef (Either String Int)
35type Counter = I.IORef (Either String Int)
37type CounterApplication = Counter -> Application
36type CounterApplication = Counter -> Application
38
37
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+
39incr :: MonadIO m => Counter -> m ()
84incr :: MonadIO m => Counter -> m ()
40incr icount = liftIO $ I.atomicModifyIORef icount $ \ecount ->
85incr icount = liftIO $ I.atomicModifyIORef icount $ \ecount ->
41 ((case ecount of
86 ((case ecount of
@@ -47,7 +92,7 @@ err icount msg = liftIO $ I.writeIORef icount $ Left $ show msg
47
92
48readBody :: CounterApplication
93readBody :: CounterApplication
49readBody icount req f = do
94readBody icount req f = do
50− body <- consumeBody $ requestBody req
95+ body <- consumeBody $ getRequestBodyChunk req
51 case () of
96 case () of
52 ()
97 ()
53 | pathInfo req == ["hello"] && L.fromChunks body /= "Hello"
98 | pathInfo req == ["hello"] && L.fromChunks body /= "Hello"
@@ -68,8 +113,8 @@ ignoreBody icount req f = do
68
113
69doubleConnect :: CounterApplication
114doubleConnect :: CounterApplication
70doubleConnect icount req f = do
115doubleConnect icount req f = do
71− _ <- consumeBody $ requestBody req
116+ _ <- consumeBody $ getRequestBodyChunk req
72− _ <- consumeBody $ requestBody req
117+ _ <- consumeBody $ getRequestBodyChunk req
73 incr icount
118 incr icount
74 f $ responseLBS status200 [] "double connect"
119 f $ responseLBS status200 [] "double connect"
75
120
@@ -83,8 +128,8 @@ getPort = do
83 esocket <- try $ bindPortTCP port "127.0.0.1"
128 esocket <- try $ bindPortTCP port "127.0.0.1"
84 case esocket of
129 case esocket of
85 Left (_ :: IOException) -> RunSpec.getPort
130 Left (_ :: IOException) -> RunSpec.getPort
86− Right socket -> do
131+ Right sock -> do
87− sClose socket
132+ close sock
88 return port
133 return port
89
134
90withApp :: Settings -> Application -> (Int -> IO a) -> IO a
135withApp :: Settings -> Application -> (Int -> IO a) -> IO a
@@ -98,7 +143,13 @@ withApp settings app f = do
98 bracket
143 bracket
99 (forkIO $ runSettings settings' app `onException` putMVar baton ())
144 (forkIO $ runSettings settings' app `onException` putMVar baton ())
100 killThread
145 killThread
101− (const $ takeMVar baton >> f port)
146+ (const $ do
147+ takeMVar baton
148+ -- use timeout to make sure we don't take too long
149+ mres <- timeout (60 * 1000 * 1000) (f port)
150+ case mres of
151+ Nothing -> error "Timeout triggered, too slow!"
152+ Just a -> pure a)
102
153
103runTest :: Int -- ^ expected number of requests
154runTest :: Int -- ^ expected number of requests
104 -> CounterApplication
155 -> CounterApplication
@@ -106,10 +157,9 @@ runTest :: Int -- ^ expected number of requests
106 -> IO ()
157 -> IO ()
107runTest expected app chunks = do
158runTest expected app chunks = do
108 ref <- I.newIORef (Right 0)
159 ref <- I.newIORef (Right 0)
109− withApp defaultSettings (app ref) $ \port -> do
160+ withApp defaultSettings (app ref) $ withMySocket $ \ms -> do
110− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
161+ forM_ chunks $ \chunk -> msWrite ms chunk
111− forM_ chunks $ \chunk -> hPutStr handle chunk >> hFlush handle
162+ _ <- timeout 100000 $ replicateM_ expected $ msRead ms 4096
112− _ <- timeout 100000 $ replicateM_ expected $ hGetSome handle 4096
113 res <- I.readIORef ref
163 res <- I.readIORef ref
114 case res of
164 case res of
115 Left s -> error s
165 Left s -> error s
@@ -124,11 +174,9 @@ runTerminateTest :: InvalidRequest
124runTerminateTest expected input = do
174runTerminateTest expected input = do
125 ref <- I.newIORef Nothing
175 ref <- I.newIORef Nothing
126 let onExc _ = I.writeIORef ref . Just
176 let onExc _ = I.writeIORef ref . Just
127− withApp (setOnException onExc defaultSettings) dummyApp $ \port -> do
177+ withApp (setOnException onExc defaultSettings) dummyApp $ withMySocket $ \ms -> do
128− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
178+ msWrite ms input
129− hPutStr handle input
179+ msClose ms -- explicitly
130− hFlush handle
131− hClose handle
132 threadDelay 1000
180 threadDelay 1000
133 res <- I.readIORef ref
181 res <- I.readIORef ref
134 show res `shouldBe` show (Just expected)
182 show res `shouldBe` show (Just expected)
@@ -199,14 +247,11 @@ spec = do
199 let app req f = do
247 let app req f = do
200 liftIO $ I.writeIORef iheaders $ requestHeaders req
248 liftIO $ I.writeIORef iheaders $ requestHeaders req
201 f $ responseLBS status200 [] ""
249 f $ responseLBS status200 [] ""
202− withApp defaultSettings app $ \port -> do
250+ withApp defaultSettings app $ withMySocket $ \ms -> do
203− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
204 let input = S.concat
251 let input = S.concat
205 [ "GET / HTTP/1.1\r\nfoo: bar\r\n baz\r\n\tbin\r\n\r\n"
252 [ "GET / HTTP/1.1\r\nfoo: bar\r\n baz\r\n\tbin\r\n\r\n"
206 ]
253 ]
207− hPutStr handle input
254+ msWrite ms input
208− hFlush handle
209− hClose handle
210 threadDelay 1000
255 threadDelay 1000
211 headers <- I.readIORef iheaders
256 headers <- I.readIORef iheaders
212 headers `shouldBe`
257 headers `shouldBe`
@@ -217,14 +262,11 @@ spec = do
217 let app req f = do
262 let app req f = do
218 liftIO $ I.writeIORef iheaders $ requestHeaders req
263 liftIO $ I.writeIORef iheaders $ requestHeaders req
219 f $ responseLBS status200 [] ""
264 f $ responseLBS status200 [] ""
220− withApp defaultSettings app $ \port -> do
265+ withApp defaultSettings app $ withMySocket $ \ms -> do
221− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
222 let input = S.concat
266 let input = S.concat
223 [ "GET / HTTP/1.1\r\nfoo:bar\r\n\r\n"
267 [ "GET / HTTP/1.1\r\nfoo:bar\r\n\r\n"
224 ]
268 ]
225− hPutStr handle input
269+ msWrite ms input
226− hFlush handle
227− hClose handle
228 threadDelay 1000
270 threadDelay 1000
229 headers <- I.readIORef iheaders
271 headers <- I.readIORef iheaders
230 headers `shouldBe`
272 headers `shouldBe`
@@ -233,23 +275,24 @@ spec = do
233
275
234 describe "chunked bodies" $ do
276 describe "chunked bodies" $ do
235 it "works" $ do
277 it "works" $ do
278+ countVar <- newTVarIO (0 :: Int)
236 ifront <- I.newIORef id
279 ifront <- I.newIORef id
237 let app req f = do
280 let app req f = do
238− bss <- consumeBody $ requestBody req
281+ bss <- consumeBody $ getRequestBodyChunk req
239 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
282 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
283+ atomically $ modifyTVar countVar (+ 1)
240 f $ responseLBS status200 [] ""
284 f $ responseLBS status200 [] ""
241− withApp defaultSettings app $ \port -> do
285+ withApp defaultSettings app $ withMySocket $ \ms -> do
242− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
243 let input = S.concat
286 let input = S.concat
244 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
287 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
245 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n\r\n"
288 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n\r\n"
246 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
289 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
247 , "b\r\nHello World\r\n0\r\n\r\n"
290 , "b\r\nHello World\r\n0\r\n\r\n"
248 ]
291 ]
249− hPutStr handle input
292+ msWrite ms input
250− hFlush handle
293+ atomically $ do
251− hClose handle
294+ count <- readTVar countVar
252− threadDelay 1000
295+ check $ count == 2
253 front <- I.readIORef ifront
296 front <- I.readIORef ifront
254 front [] `shouldBe`
297 front [] `shouldBe`
255 [ "Hello World\nBye"
298 [ "Hello World\nBye"
@@ -257,38 +300,44 @@ spec = do
257 ]
300 ]
258 it "lots of chunks" $ do
301 it "lots of chunks" $ do
259 ifront <- I.newIORef id
302 ifront <- I.newIORef id
303+ countVar <- newTVarIO (0 :: Int)
260 let app req f = do
304 let app req f = do
261− bss <- consumeBody $ requestBody req
305+ bss <- consumeBody $ getRequestBodyChunk req
262 I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
306 I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
307+ atomically $ modifyTVar countVar (+ 1)
263 f $ responseLBS status200 [] ""
308 f $ responseLBS status200 [] ""
264− withApp defaultSettings app $ \port -> do
309+ withApp defaultSettings app $ withMySocket $ \ms -> do
265− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
266 let input = concat $ replicate 2 $
310 let input = concat $ replicate 2 $
267 ["POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"] ++
311 ["POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"] ++
268 (replicate 50 "5\r\n12345\r\n") ++
312 (replicate 50 "5\r\n12345\r\n") ++
269 ["0\r\n\r\n"]
313 ["0\r\n\r\n"]
270− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) input
314+ mapM_ (msWrite ms) input
271− hClose handle
315+ atomically $ do
272− threadDelay 100000 -- FIXME why does this delay need to be so high?
316+ count <- readTVar countVar
317+ check $ count == 2
273 front <- I.readIORef ifront
318 front <- I.readIORef ifront
274 front [] `shouldBe` replicate 2 (S.concat $ replicate 50 "12345")
319 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.
275 it "in chunks" $ do
322 it "in chunks" $ do
276 ifront <- I.newIORef id
323 ifront <- I.newIORef id
324+ countVar <- newTVarIO (0 :: Int)
277 let app req f = do
325 let app req f = do
278− bss <- consumeBody $ requestBody req
326+ bss <- consumeBody $ getRequestBodyChunk req
279 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
327 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
328+ atomically $ modifyTVar countVar (+ 1)
280 f $ responseLBS status200 [] ""
329 f $ responseLBS status200 [] ""
281− withApp defaultSettings app $ \port -> do
330+ withApp defaultSettings app $ withMySocket $ \ms -> do
282− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
283 let input = S.concat
331 let input = S.concat
284 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
332 [ "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
285 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n"
333 , "c\r\nHello World\n\r\n3\r\nBye\r\n0\r\n"
286 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
334 , "POST / HTTP/1.1\r\nTransfer-Encoding: Chunked\r\n\r\n"
287 , "b\r\nHello World\r\n0\r\n\r\n"
335 , "b\r\nHello World\r\n0\r\n\r\n"
288 ]
336 ]
289− mapM_ (\bs -> hPutStr handle bs >> hFlush handle) $ map S.singleton $ S.unpack input
337+ mapM_ (msWrite ms) $ map S.singleton $ S.unpack input
290− hClose handle
338+ atomically $ do
291− threadDelay 1000
339+ count <- readTVar countVar
340+ check $ count == 2
292 front <- I.readIORef ifront
341 front <- I.readIORef ifront
293 front [] `shouldBe`
342 front [] `shouldBe`
294 [ "Hello World\nBye"
343 [ "Hello World\nBye"
@@ -297,7 +346,7 @@ spec = do
297 it "timeout in request body" $ do
346 it "timeout in request body" $ do
298 ifront <- I.newIORef id
347 ifront <- I.newIORef id
299 let app req f = do
348 let app req f = do
300− bss <- (consumeBody $ requestBody req) `onException`
349+ bss <- (consumeBody $ getRequestBodyChunk req) `onException`
301 liftIO (I.atomicModifyIORef ifront (\front -> (front . ("consume interrupted":), ())))
350 liftIO (I.atomicModifyIORef ifront (\front -> (front . ("consume interrupted":), ())))
302 liftIO $ threadDelay 4000000 `E.catch` \e -> do
351 liftIO $ threadDelay 4000000 `E.catch` \e -> do
303 I.atomicModifyIORef ifront (\front ->
352 I.atomicModifyIORef ifront (\front ->
@@ -306,20 +355,18 @@ spec = do
306 E.throwIO (e :: E.SomeException)
355 E.throwIO (e :: E.SomeException)
307 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
356 liftIO $ I.atomicModifyIORef ifront $ \front -> (front . (S.concat bss:), ())
308 f $ responseLBS status200 [] ""
357 f $ responseLBS status200 [] ""
309− withApp (setTimeout 1 defaultSettings) app $ \port -> do
358+ withApp (setTimeout 1 defaultSettings) app $ withMySocket $ \ms -> do
310 let bs1 = S.replicate 2048 88
359 let bs1 = S.replicate 2048 88
311 bs2 = "This is short"
360 bs2 = "This is short"
312 bs = S.append bs1 bs2
361 bs = S.append bs1 bs2
313− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
362+ msWrite ms "POST / HTTP/1.1\r\n"
314− hPutStr handle "POST / HTTP/1.1\r\n"
363+ msWrite ms "content-length: "
315− hPutStr handle "content-length: "
364+ msWrite ms $ S8.pack $ show $ S.length bs
316− hPutStr handle $ S8.pack $ show $ S.length bs
365+ msWrite ms "\r\n\r\n"
317− hPutStr handle "\r\n\r\n"
318 threadDelay 100000
366 threadDelay 100000
319− hPutStr handle bs1
367+ msWrite ms bs1
320 threadDelay 100000
368 threadDelay 100000
321− hPutStr handle bs2
369+ msWrite ms bs2
322− hClose handle
323 threadDelay 5000000
370 threadDelay 5000000
324 front <- I.readIORef ifront
371 front <- I.readIORef ifront
325 S.concat (front []) `shouldBe` bs
372 S.concat (front []) `shouldBe` bs
@@ -335,39 +382,42 @@ spec = do
335 loop
382 loop
336 loop
383 loop
337 doubleBS = S.concatMap $ \w -> S.pack [w, w]
384 doubleBS = S.concatMap $ \w -> S.pack [w, w]
338− withApp defaultSettings app $ \port -> do
385+ withApp defaultSettings app $ withMySocket $ \ms -> do
339− handle <- connectTo "127.0.0.1" $ PortNumber $ fromIntegral port
386+ msWrite ms "POST / HTTP/1.1\r\n\r\n12345"
340− hPutStr handle "POST / HTTP/1.1\r\n\r\n12345"
387+ timeout 100000 (msRead ms 10) >>= (`shouldBe` Just "1122334455")
341− hFlush handle
388+ msWrite ms "67890"
342− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "1122334455")
389+ timeout 100000 (msRead ms 10) >>= (`shouldBe` Just "6677889900")
343− hPutStr handle "67890"
344− hFlush handle
345− timeout 100000 (S.hGet handle 10) >>= (`shouldBe` Just "6677889900")
346−
347 it "only one date and server header" $ do
390 it "only one date and server header" $ do
348 let app _ f = f $ responseLBS status200
391 let app _ f = f $ responseLBS status200
349 [ ("server", "server")
392 [ ("server", "server")
350 , ("date", "date")
393 , ("date", "date")
351 ] ""
394 ] ""
395+ getValues key = map snd
396+ . filter (\(key', _) -> key == key')
397+ . responseHeaders
352 withApp defaultSettings app $ \port -> do
398 withApp defaultSettings app $ \port -> do
353 res <- sendGET $ "http://127.0.0.1:" ++ show port
399 res <- sendGET $ "http://127.0.0.1:" ++ show port
354− getHeaderValue HdrServer res `shouldBe` Just "server"
400+ getValues hServer res `shouldBe` ["server"]
355− getHeaderValue HdrDate res `shouldBe` Just "date"
401+ getValues hDate res `shouldBe` ["date"]
356
402
357 it "streaming echo #249" $ do
403 it "streaming echo #249" $ do
404+ countVar <- newTVarIO (0 :: Int)
358 let app req f = f $ responseStream status200 [] $ \write _ -> do
405 let app req f = f $ responseStream status200 [] $ \write _ -> do
359− let loop = do
406+ let loop = do
360− bs <- requestBody req
407+ bs <- getRequestBodyChunk req
361 unless (S.null bs) $ do
408 unless (S.null bs) $ do
362 write $ byteString bs
409 write $ byteString bs
410+ atomically $ modifyTVar countVar (+ 1)
363 loop
411 loop
364− loop
412+ loop
365− withApp defaultSettings app $ \port -> do
413+ withApp defaultSettings app $ withMySocket $ \ms -> do
366− (socket, _addr) <- getSocketTCP "127.0.0.1" port
414+ msWrite ms "POST / HTTP/1.1\r\ntransfer-encoding: chunked\r\n\r\n"
367− sendAll socket "POST / HTTP/1.1\r\ntransfer-encoding: chunked\r\n\r\n"
368 threadDelay 10000
415 threadDelay 10000
369− sendAll socket "5\r\nhello\r\n0\r\n\r\n"
416+ msWrite ms "5\r\nhello\r\n0\r\n\r\n"
370− bs <- safeRecv socket 4096
417+ atomically $ do
418+ count <- readTVar countVar
419+ check $ count >= 1
420+ bs <- safeRecv (msSocket ms) 4096 -- must not use msRead
371 S.takeWhile (/= 13) bs `shouldBe` "HTTP/1.1 200 OK"
421 S.takeWhile (/= 13) bs `shouldBe` "HTTP/1.1 200 OK"
372
422
373 it "streaming response with length" $ do
423 it "streaming response with length" $ do
@@ -375,7 +425,7 @@ spec = do
375 replicateM_ 4 $ write $ byteString "Hello"
425 replicateM_ 4 $ write $ byteString "Hello"
376 withApp defaultSettings app $ \port -> do
426 withApp defaultSettings app $ \port -> do
377 res <- sendGET $ "http://127.0.0.1:" ++ show port
427 res <- sendGET $ "http://127.0.0.1:" ++ show port
378− rspBody res `shouldBe` "HelloHelloHelloHello"
428+ responseBody res `shouldBe` "HelloHelloHelloHello"
379
429
380 describe "head requests" $ do
430 describe "head requests" $ do
381 let fp = "test/head-response"
431 let fp = "test/head-response"
@@ -388,19 +438,19 @@ spec = do
388 _ -> error "invalid path"
438 _ -> error "invalid path"
389 it "builder" $ withApp defaultSettings app $ \port -> do
439 it "builder" $ withApp defaultSettings app $ \port -> do
390 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/builder"]
440 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/builder"]
391− rspBody res `shouldBe` ""
441+ responseBody res `shouldBe` ""
392 it "streaming" $ withApp defaultSettings app $ \port -> do
442 it "streaming" $ withApp defaultSettings app $ \port -> do
393 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/streaming"]
443 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/streaming"]
394− rspBody res `shouldBe` ""
444+ responseBody res `shouldBe` ""
395 it "file, no range" $ withApp defaultSettings app $ \port -> do
445 it "file, no range" $ withApp defaultSettings app $ \port -> do
396 bs <- S.readFile fp
446 bs <- S.readFile fp
397 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/file"]
447 res <- sendHEAD $ concat ["http://127.0.0.1:", show port, "/file"]
398− getHeaderValue HdrContentLength res `shouldBe` Just (show $ S.length bs)
448+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just (S8.pack $ show $ S.length bs)
399 it "file, with range" $ withApp defaultSettings app $ \port -> do
449 it "file, with range" $ withApp defaultSettings app $ \port -> do
400 res <- sendHEADwH
450 res <- sendHEADwH
401 (concat ["http://127.0.0.1:", show port, "/file"])
451 (concat ["http://127.0.0.1:", show port, "/file"])
402− [mkHeader HdrRange "bytes=0-1"]
452+ [(hRange, "bytes=0-1")]
403− getHeaderValue HdrContentLength res `shouldBe` Just "2"
453+ getHeaderValue hContentLength (responseHeaders res) `shouldBe` Just "2"
404
454
405consumeBody :: IO ByteString -> IO [ByteString]
455consumeBody :: IO ByteString -> IO [ByteString]
406consumeBody body =
456consumeBody body =
warp/test/WithApplicationSpec.hsnew file+45
@@ -0,0 +1,45 @@
1+{-# LANGUAGE OverloadedStrings #-}
2+
3+module WithApplicationSpec where
4+
5+import Control.Exception
6+import Network.HTTP.Types
7+import Network.Wai
8+import System.Environment
9+import System.Process
10+import Test.Hspec
11+
12+import Network.Wai.Handler.Warp.WithApplication
13+
14+spec :: Spec
15+spec = do
16+ runIO $ do
17+ unsetEnv "http_proxy"
18+ unsetEnv "https_proxy"
19+ describe "withApplication" $ do
20+ it "runs a wai Application while executing the given action" $ do
21+ let mkApp = return $ \ _request respond -> respond $ responseLBS ok200 [] "foo"
22+ withApplication mkApp $ \ port -> do
23+ output <- readProcess "curl" ["-s", "localhost:" ++ show port] ""
24+ output `shouldBe` "foo"
25+
26+ it "does not propagate exceptions from the server to the executing thread" $ do
27+ let mkApp = return $ \ _request _respond -> throwIO $ ErrorCall "foo"
28+ withApplication mkApp $ \ port -> do
29+ output <- readProcess "curl" ["-s", "localhost:" ++ show port] ""
30+ output `shouldContain` "Something went wron"
31+
32+ describe "testWithApplication" $ do
33+ it "propagates exceptions from the server to the executing thread" $ do
34+ let mkApp = return $ \ _request _respond -> throwIO $ ErrorCall "foo"
35+ (testWithApplication mkApp $ \ port -> do
36+ readProcess "curl" ["-s", "localhost:" ++ show port] "")
37+ `shouldThrow` (errorCall "foo")
38+
39+{- The future netwrok library will not export MkSocket.
40+ describe "withFreePort" $ do
41+ it "closes the socket before exiting" $ do
42+ MkSocket _ _ _ _ statusMVar <- withFreePort $ \ (_, sock) -> do
43+ return sock
44+ readMVar statusMVar `shouldReturn` Closed
45+-}
warp/warp.cabal+129−49
@@ -1,5 +1,5 @@
1Name: warp
1Name: warp
2−Version: 3.2.3
2+Version: 3.3.9
3Synopsis: A fast, light-weight web server for WAI applications.
3Synopsis: A fast, light-weight web server for WAI applications.
4License: MIT
4License: MIT
5License-file: LICENSE
5License-file: LICENSE
@@ -8,7 +8,7 @@ Maintainer: michael@snoyman.com
8Homepage: http://github.com/yesodweb/wai
8Homepage: http://github.com/yesodweb/wai
9Category: Web, Yesod
9Category: Web, Yesod
10Build-Type: Simple
10Build-Type: Simple
11−Cabal-Version: >=1.8
11+Cabal-Version: >= 1.10
12Stability: Stable
12Stability: Stable
13description: HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported.
13description: HTTP\/1.0, HTTP\/1.1 and HTTP\/2 are supported.
14 For HTTP\/2, Warp supports direct and ALPN (in TLS)
14 For HTTP\/2, Warp supports direct and ALPN (in TLS)
@@ -19,6 +19,7 @@ extra-source-files: attic/hex
19 ChangeLog.md
19 ChangeLog.md
20 README.md
20 README.md
21 test/head-response
21 test/head-response
22+ test/inputFile
22
23
23Flag network-bytestring
24Flag network-bytestring
24 Default: False
25 Default: False
@@ -32,28 +33,32 @@ Flag warp-debug
32 Default: False
33 Default: False
33
34
34Library
35Library
35− Build-Depends: base >= 3 && < 5
36+ Build-Depends: base >= 4.8 && < 5
36 , array
37 , array
38+ , async
37 , auto-update >= 0.1.3 && < 0.2
39 , auto-update >= 0.1.3 && < 0.2
38− , blaze-builder >= 0.4
40+ , bsb-http-chunked < 0.1
39 , bytestring >= 0.9.1.4
41 , bytestring >= 0.9.1.4
40− , bytestring-builder
41 , case-insensitive >= 0.2
42 , case-insensitive >= 0.2
42 , containers
43 , containers
43 , ghc-prim
44 , ghc-prim
44− , http-types >= 0.8.5
45+ , hashable
46+ , http-date
47+ , http-types >= 0.12
48+ , http2 >= 2.0 && < 2.1
45 , iproute >= 1.3.1
49 , iproute >= 1.3.1
46− , http2 >= 1.5 && < 1.6
47 , simple-sendfile >= 0.2.7 && < 0.3
50 , simple-sendfile >= 0.2.7 && < 0.3
48− , unix-compat >= 0.2
51+ , stm >= 2.3
49− , wai >= 3.2 && < 3.3
50− , text
51 , streaming-commons >= 0.1.10
52 , streaming-commons >= 0.1.10
53+ , text
54+ , time-manager
55+ , unix-compat >= 0.2
52 , vault >= 0.3
56 , vault >= 0.3
53− , stm >= 2.3
57+ , wai >= 3.2 && < 3.3
54 , word8
58 , word8
55− , hashable
59+ , x509
56− , http-date
60+ if impl(ghc < 8)
61+ Build-Depends: semigroups
57 if flag(network-bytestring)
62 if flag(network-bytestring)
58 Build-Depends: network >= 2.2.1.5 && < 2.2.3
63 Build-Depends: network >= 2.2.1.5 && < 2.2.3
59 , network-bytestring >= 0.1.3 && < 0.1.4
64 , network-bytestring >= 0.1.3 && < 0.1.4
@@ -70,17 +75,15 @@ Library
70 Network.Wai.Handler.Warp.FileInfoCache
75 Network.Wai.Handler.Warp.FileInfoCache
71 Network.Wai.Handler.Warp.HashMap
76 Network.Wai.Handler.Warp.HashMap
72 Network.Wai.Handler.Warp.HTTP2
77 Network.Wai.Handler.Warp.HTTP2
73− Network.Wai.Handler.Warp.HTTP2.EncodeFrame
78+ Network.Wai.Handler.Warp.HTTP2.File
74− Network.Wai.Handler.Warp.HTTP2.HPACK
79+ Network.Wai.Handler.Warp.HTTP2.PushPromise
75− Network.Wai.Handler.Warp.HTTP2.Manager
76− Network.Wai.Handler.Warp.HTTP2.Receiver
77 Network.Wai.Handler.Warp.HTTP2.Request
80 Network.Wai.Handler.Warp.HTTP2.Request
78− Network.Wai.Handler.Warp.HTTP2.Sender
81+ Network.Wai.Handler.Warp.HTTP2.Response
79 Network.Wai.Handler.Warp.HTTP2.Types
82 Network.Wai.Handler.Warp.HTTP2.Types
80− Network.Wai.Handler.Warp.HTTP2.Worker
81 Network.Wai.Handler.Warp.Header
83 Network.Wai.Handler.Warp.Header
82 Network.Wai.Handler.Warp.IO
84 Network.Wai.Handler.Warp.IO
83− Network.Wai.Handler.Warp.IORef
85+ Network.Wai.Handler.Warp.Imports
86+ Network.Wai.Handler.Warp.PackInt
84 Network.Wai.Handler.Warp.ReadInt
87 Network.Wai.Handler.Warp.ReadInt
85 Network.Wai.Handler.Warp.Recv
88 Network.Wai.Handler.Warp.Recv
86 Network.Wai.Handler.Warp.Request
89 Network.Wai.Handler.Warp.Request
@@ -90,9 +93,9 @@ Library
90 Network.Wai.Handler.Warp.Run
93 Network.Wai.Handler.Warp.Run
91 Network.Wai.Handler.Warp.SendFile
94 Network.Wai.Handler.Warp.SendFile
92 Network.Wai.Handler.Warp.Settings
95 Network.Wai.Handler.Warp.Settings
93− Network.Wai.Handler.Warp.Timeout
94 Network.Wai.Handler.Warp.Types
96 Network.Wai.Handler.Warp.Types
95 Network.Wai.Handler.Warp.Windows
97 Network.Wai.Handler.Warp.Windows
98+ Network.Wai.Handler.Warp.WithApplication
96 Paths_warp
99 Paths_warp
97 Ghc-Options: -Wall
100 Ghc-Options: -Wall
98
101
@@ -106,14 +109,23 @@ Library
106 else
109 else
107 Build-Depends: unix
110 Build-Depends: unix
108 Other-modules: Network.Wai.Handler.Warp.MultiMap
111 Other-modules: Network.Wai.Handler.Warp.MultiMap
112+ if impl(ghc >= 8)
113+ Default-Extensions: Strict StrictData
114+ Default-Language: Haskell2010
109
115
110Test-Suite doctest
116Test-Suite doctest
117+ buildable: False
111 Type: exitcode-stdio-1.0
118 Type: exitcode-stdio-1.0
112 HS-Source-Dirs: test
119 HS-Source-Dirs: test
113 Ghc-Options: -threaded -Wall
120 Ghc-Options: -threaded -Wall
114 Main-Is: doctests.hs
121 Main-Is: doctests.hs
115− Build-Depends: base
122+ Build-Depends: base >= 4.8 && < 5
116 , doctest >= 0.10.1
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
117
129
118Test-Suite spec
130Test-Suite spec
119 Main-Is: Spec.hs
131 Main-Is: Spec.hs
@@ -122,68 +134,136 @@ Test-Suite spec
122 ExceptionSpec
134 ExceptionSpec
123 FdCacheSpec
135 FdCacheSpec
124 FileSpec
136 FileSpec
125− MultiMapSpec
126 ReadIntSpec
137 ReadIntSpec
127 RequestSpec
138 RequestSpec
128 ResponseHeaderSpec
139 ResponseHeaderSpec
129 ResponseSpec
140 ResponseSpec
130 RunSpec
141 RunSpec
131 SendFileSpec
142 SendFileSpec
143+ WithApplicationSpec
132 HTTP
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+
133 Hs-Source-Dirs: test, .
179 Hs-Source-Dirs: test, .
134 Type: exitcode-stdio-1.0
180 Type: exitcode-stdio-1.0
135
181
136− Ghc-Options: -Wall
182+ Ghc-Options: -Wall -threaded
137− Build-Depends: base >= 4 && < 5
183+ Build-Depends: base >= 4.8 && < 5
184+ , HUnit
185+ , QuickCheck
138 , array
186 , array
187+ , async
139 , auto-update
188 , auto-update
140− , blaze-builder >= 0.4
189+ , bsb-http-chunked < 0.1
141 , bytestring >= 0.9.1.4
190 , bytestring >= 0.9.1.4
142− , bytestring-builder
143 , case-insensitive >= 0.2
191 , case-insensitive >= 0.2
192+ , containers
193+ , directory
144 , ghc-prim
194 , ghc-prim
145− , HTTP
195+ , hashable
146− , http-types >= 0.8.5
196+ , hspec >= 1.3
197+ , http-client
198+ , http-date
199+ , http-types >= 0.12
200+ , http2 >= 2.0 && < 2.1
147 , iproute >= 1.3.1
201 , iproute >= 1.3.1
148 , lifted-base >= 0.1
202 , lifted-base >= 0.1
149− , simple-sendfile >= 0.2.4 && < 0.3
150− , transformers >= 0.2.2
151− , unix-compat >= 0.2
152− , wai >= 3.2 && < 3.3
153 , network
203 , network
154− , HUnit
204+ , process
155− , QuickCheck
205+ , simple-sendfile >= 0.2.4 && < 0.3
156− , hspec >= 1.3
206+ , stm >= 2.3
157− , time
158− , text
159 , streaming-commons >= 0.1.10
207 , streaming-commons >= 0.1.10
160− , async
208+ , text
209+ , time
210+ , time-manager
211+ , unix-compat >= 0.2
161 , vault
212 , vault
162− , stm >= 2.3
213+ , wai >= 3.2 && < 3.3
163− , directory
164− , process
165− , containers
166− , http2 >= 1.5 && < 1.6
167 , word8
214 , word8
168− , hashable
215+ , x509
169− , http-date
216+ -- Build-Tool-Depends: hspec-discover:hspec-discover
217+ if impl(ghc < 8)
218+ Build-Depends: semigroups
219+ , transformers
170
220
171 if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
221 if (os(linux) || os(freebsd) || os(darwin)) && flag(allow-sendfilefd)
172 Cpp-Options: -DSENDFILEFD
222 Cpp-Options: -DSENDFILEFD
173 Build-Depends: unix
223 Build-Depends: unix
174 if os(windows)
224 if os(windows)
175− Cpp-Options: -DWINDOWS
225+ Cpp-Options: -DWINDOWS
226+ Build-Depends: time
227+ if impl(ghc >= 8)
228+ Default-Extensions: Strict StrictData
229+ Default-Language: Haskell2010
176
230
177Benchmark parser
231Benchmark parser
178 Type: exitcode-stdio-1.0
232 Type: exitcode-stdio-1.0
179 Main-Is: Parser.hs
233 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
180 HS-Source-Dirs: bench .
241 HS-Source-Dirs: bench .
181− Build-Depends: base
242+ Build-Depends: base >= 4.8 && < 5
243+ , auto-update
182 , bytestring
244 , bytestring
183− , criterion
245+ , containers
246+ , gauge
247+ , hashable
248+ , http-date
184 , http-types
249 , http-types
185 , network
250 , network
186 , network
251 , 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
187
267
188Source-Repository head
268Source-Repository head
189 Type: git
269 Type: git