@@ -1,67 +1,39 @@
1−{-# LANGUAGE ConstraintKinds #-}
2{-# LANGUAGE CPP #-}
1{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
4{-# LANGUAGE DefaultSignatures #-}
2{-# LANGUAGE DefaultSignatures #-}
5{-# LANGUAGE DeriveGeneric #-}
3{-# LANGUAGE DeriveGeneric #-}
6{-# LANGUAGE FlexibleContexts #-}
4{-# LANGUAGE FlexibleContexts #-}
7{-# LANGUAGE FlexibleInstances #-}
5{-# LANGUAGE FlexibleInstances #-}
8{-# LANGUAGE GeneralizedNewtypeDeriving #-}
6{-# LANGUAGE GeneralizedNewtypeDeriving #-}
9{-# LANGUAGE KindSignatures #-}
7{-# LANGUAGE KindSignatures #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
11{-# LANGUAGE OverloadedStrings #-}
8{-# LANGUAGE OverloadedStrings #-}
12{-# LANGUAGE PolyKinds #-}
9{-# LANGUAGE PolyKinds #-}
13{-# LANGUAGE ScopedTypeVariables #-}
10{-# LANGUAGE ScopedTypeVariables #-}
14{-# LANGUAGE TypeFamilies #-}
11{-# LANGUAGE TypeFamilies #-}
15{-# LANGUAGE TypeOperators #-}
12{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
17−#include "overlapping-compat.h"
18module Web.Internal.FormUrlEncoded where
13module Web.Internal.FormUrlEncoded where
20−import Prelude ()
15+#if __GLASGOW_HASKELL__ < 710
21−import Prelude.Compat
16+import Control.Applicative
23−import Control.Applicative (Const(Const))
24−import Control.Arrow ((***))
25import Control.Monad ((<=<))
19import Control.Monad ((<=<))
26−import Data.ByteString.Builder (shortByteString, toLazyByteString)
27import qualified Data.ByteString.Lazy as BSL
20import qualified Data.ByteString.Lazy as BSL
28import qualified Data.ByteString.Lazy.Char8 as BSL8
21import qualified Data.ByteString.Lazy.Char8 as BSL8
29−import Data.Coerce (coerce)
30−import qualified Data.Foldable as F
31−import Data.Functor.Identity (Identity(Identity))
32−import Data.Hashable (Hashable)
33−import Data.HashMap.Strict (HashMap)
34−import qualified Data.HashMap.Strict as HashMap
35−import Data.Int (Int16, Int32, Int64, Int8)
36−import Data.IntMap (IntMap)
37−import qualified Data.IntMap as IntMap
38−import Data.List (intersperse, sortBy)
39import Data.Map (Map)
22import Data.Map (Map)
40import qualified Data.Map as Map
23import qualified Data.Map as Map
41−import Data.Monoid (All (..), Any (..), Dual (..),
24+import Data.Monoid
42− Product (..), Sum (..))
25+
43−import Data.Ord (comparing)
44−import Data.Proxy (Proxy (..))
45−import Data.Semigroup (Semigroup (..))
46−import qualified Data.Semigroup as Semi
47−import Data.Tagged (Tagged (..))
48import Data.Text (Text)
26import Data.Text (Text)
49import qualified Data.Text as Text
27import qualified Data.Text as Text
50−import qualified Data.Text.Encoding as Text
28+import Data.Text.Encoding as Text
51import Data.Text.Encoding.Error (lenientDecode)
29import Data.Text.Encoding.Error (lenientDecode)
52−import qualified Data.Text.Lazy as Lazy
30+
53−import Data.Time.Compat (Day, LocalTime, NominalDiffTime,
55−import Data.Time.Calendar.Month.Compat (Month)
56−import Data.Time.Calendar.Quarter.Compat (Quarter, QuarterOfYear (..))
57−import Data.Void (Void)
58−import Data.Word (Word16, Word32, Word64, Word8)
59−import GHC.Exts (Constraint, IsList (..))
31+import GHC.Exts (IsList (..))
60import GHC.Generics
32import GHC.Generics
61−import GHC.TypeLits
33+import Network.URI (escapeURIString, isUnreserved,
62−import Network.HTTP.Types.URI (urlDecode, urlEncodeBuilder)
34+ unEscapeString)
63−import Numeric.Natural (Natural)
35+
64−import Web.Internal.HttpApiData
36+import Web.Internal.HttpApiData
67-- >>> :set -XDeriveGeneric
39-- >>> :set -XDeriveGeneric
@@ -70,165 +42,26 @@ import Web.Internal.HttpApiData
70-- >>> :set -XFlexibleContexts
42-- >>> :set -XFlexibleContexts
71-- >>> :set -XScopedTypeVariables
43-- >>> :set -XScopedTypeVariables
72-- >>> :set -XTypeFamilies
44-- >>> :set -XTypeFamilies
73−-- >>> import Data.Char (toLower)
45+-- >>> import Data.Either (isLeft)
74−--
46+-- >>> import Data.List (sort)
75-- >>> data Person = Person { name :: String, age :: Int } deriving (Show, Generic)
47-- >>> data Person = Person { name :: String, age :: Int } deriving (Show, Generic)
76-- >>> instance ToForm Person
48-- >>> instance ToForm Person
77-- >>> instance FromForm Person
49-- >>> instance FromForm Person
79−-- >>> data Post = Post { title :: String, subtitle :: Maybe String, comments :: [String]} deriving (Generic, Show)
80−-- >>> instance ToForm Post
81−-- >>> instance FromForm Post
83−-- >>> data Project = Project { projectName :: String, projectSize :: Int } deriving (Generic, Show)
84−-- >>> let myOptions = FormOptions { fieldLabelModifier = map toLower . drop (length ("project" :: String)) }
85−-- >>> instance ToForm Project where toForm = genericToForm myOptions
86−-- >>> instance FromForm Project where fromForm = genericFromForm myOptions
88−-- | Typeclass for types that can be used as keys in a 'Form'-like container (like 'Map').
89−class ToFormKey k where
90− -- | Render a key for a 'Form'.
91− toFormKey :: k -> Text
93−instance ToFormKey () where toFormKey = toQueryParam
94−instance ToFormKey Char where toFormKey = toQueryParam
96−instance ToFormKey Bool where toFormKey = toQueryParam
97−instance ToFormKey Ordering where toFormKey = toQueryParam
99−instance ToFormKey Double where toFormKey = toQueryParam
100−instance ToFormKey Float where toFormKey = toQueryParam
101−instance ToFormKey Int where toFormKey = toQueryParam
102−instance ToFormKey Int8 where toFormKey = toQueryParam
103−instance ToFormKey Int16 where toFormKey = toQueryParam
104−instance ToFormKey Int32 where toFormKey = toQueryParam
105−instance ToFormKey Int64 where toFormKey = toQueryParam
106−instance ToFormKey Integer where toFormKey = toQueryParam
107−instance ToFormKey Word where toFormKey = toQueryParam
108−instance ToFormKey Word8 where toFormKey = toQueryParam
109−instance ToFormKey Word16 where toFormKey = toQueryParam
110−instance ToFormKey Word32 where toFormKey = toQueryParam
111−instance ToFormKey Word64 where toFormKey = toQueryParam
113−instance ToFormKey Day where toFormKey = toQueryParam
114−instance ToFormKey LocalTime where toFormKey = toQueryParam
115−instance ToFormKey ZonedTime where toFormKey = toQueryParam
116−instance ToFormKey UTCTime where toFormKey = toQueryParam
117−instance ToFormKey NominalDiffTime where toFormKey = toQueryParam
118−instance ToFormKey Quarter where toFormKey = toQueryParam
119−instance ToFormKey QuarterOfYear where toFormKey = toQueryParam
120−instance ToFormKey Month where toFormKey = toQueryParam
122−instance ToFormKey String where toFormKey = toQueryParam
123−instance ToFormKey Text where toFormKey = toQueryParam
124−instance ToFormKey Lazy.Text where toFormKey = toQueryParam
126−instance ToFormKey All where toFormKey = toQueryParam
127−instance ToFormKey Any where toFormKey = toQueryParam
129−instance ToFormKey a => ToFormKey (Dual a) where toFormKey = coerce (toFormKey :: a -> Text)
130−instance ToFormKey a => ToFormKey (Sum a) where toFormKey = coerce (toFormKey :: a -> Text)
131−instance ToFormKey a => ToFormKey (Product a) where toFormKey = coerce (toFormKey :: a -> Text)
133−instance ToFormKey a => ToFormKey (Semi.Min a) where toFormKey = coerce (toFormKey :: a -> Text)
134−instance ToFormKey a => ToFormKey (Semi.Max a) where toFormKey = coerce (toFormKey :: a -> Text)
135−instance ToFormKey a => ToFormKey (Semi.First a) where toFormKey = coerce (toFormKey :: a -> Text)
136−instance ToFormKey a => ToFormKey (Semi.Last a) where toFormKey = coerce (toFormKey :: a -> Text)
138−instance ToFormKey a => ToFormKey (Tagged b a) where toFormKey = coerce (toFormKey :: a -> Text)
141−instance ToFormKey a => ToFormKey (Identity a) where toFormKey = coerce (toFormKey :: a -> Text)
144−instance ToFormKey a => ToFormKey (Const a b) where
145− toFormKey = coerce (toFormKey :: a -> Text)
147−instance ToFormKey Void where toFormKey = toQueryParam
148−instance ToFormKey Natural where toFormKey = toQueryParam
150−-- | Typeclass for types that can be parsed from keys of a 'Form'. This is the reverse of 'ToFormKey'.
151−class FromFormKey k where
152− -- | Parse a key of a 'Form'.
153− parseFormKey :: Text -> Either Text k
155−instance FromFormKey () where parseFormKey = parseQueryParam
156−instance FromFormKey Char where parseFormKey = parseQueryParam
158−instance FromFormKey Bool where parseFormKey = parseQueryParam
159−instance FromFormKey Ordering where parseFormKey = parseQueryParam
161−instance FromFormKey Double where parseFormKey = parseQueryParam
162−instance FromFormKey Float where parseFormKey = parseQueryParam
163−instance FromFormKey Int where parseFormKey = parseQueryParam
164−instance FromFormKey Int8 where parseFormKey = parseQueryParam
165−instance FromFormKey Int16 where parseFormKey = parseQueryParam
166−instance FromFormKey Int32 where parseFormKey = parseQueryParam
167−instance FromFormKey Int64 where parseFormKey = parseQueryParam
168−instance FromFormKey Integer where parseFormKey = parseQueryParam
169−instance FromFormKey Word where parseFormKey = parseQueryParam
170−instance FromFormKey Word8 where parseFormKey = parseQueryParam
171−instance FromFormKey Word16 where parseFormKey = parseQueryParam
172−instance FromFormKey Word32 where parseFormKey = parseQueryParam
173−instance FromFormKey Word64 where parseFormKey = parseQueryParam
175−instance FromFormKey Day where parseFormKey = parseQueryParam
176−instance FromFormKey LocalTime where parseFormKey = parseQueryParam
177−instance FromFormKey ZonedTime where parseFormKey = parseQueryParam
178−instance FromFormKey UTCTime where parseFormKey = parseQueryParam
179−instance FromFormKey NominalDiffTime where parseFormKey = parseQueryParam
180−instance FromFormKey Quarter where parseFormKey = parseQueryParam
181−instance FromFormKey QuarterOfYear where parseFormKey = parseQueryParam
182−instance FromFormKey Month where parseFormKey = parseQueryParam
184−instance FromFormKey String where parseFormKey = parseQueryParam
185−instance FromFormKey Text where parseFormKey = parseQueryParam
186−instance FromFormKey Lazy.Text where parseFormKey = parseQueryParam
188−instance FromFormKey All where parseFormKey = parseQueryParam
189−instance FromFormKey Any where parseFormKey = parseQueryParam
191−instance FromFormKey a => FromFormKey (Dual a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
192−instance FromFormKey a => FromFormKey (Sum a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
193−instance FromFormKey a => FromFormKey (Product a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
195−instance FromFormKey a => FromFormKey (Semi.Min a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
196−instance FromFormKey a => FromFormKey (Semi.Max a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
197−instance FromFormKey a => FromFormKey (Semi.First a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
198−instance FromFormKey a => FromFormKey (Semi.Last a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
200−instance FromFormKey a => FromFormKey (Tagged b a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
203−instance FromFormKey a => FromFormKey (Identity a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
206−instance FromFormKey a => FromFormKey (Const a b) where
207− parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
209−instance FromFormKey Void where parseFormKey = parseQueryParam
210−instance FromFormKey Natural where parseFormKey = parseQueryParam
212-- | The contents of a form, not yet URL-encoded.
51-- | The contents of a form, not yet URL-encoded.
214−-- 'Form' can be URL-encoded with 'urlEncodeForm' and URL-decoded with 'urlDecodeForm'.
53+-- 'Form' can be URL-encoded with 'encodeForm' and URL-decoded with 'decodeForm'.
215−newtype Form = Form { unForm :: HashMap Text [Text] }
54+newtype Form = Form { unForm :: Map Text [Text] }
216− deriving (Eq, Read, Generic, Semigroup, Monoid)
55+ deriving (Eq, Read, Generic, Monoid)
218instance Show Form where
57instance Show Form where
219 showsPrec d form = showParen (d > 10) $
58 showsPrec d form = showParen (d > 10) $
220− showString "fromList " . shows (toListStable form)
59+ showString "fromList " . shows (toList form)
222−-- | _NOTE:_ 'toList' is unstable and may result in different key order (but not values).
223−-- For a stable conversion use 'toListStable'.
224instance IsList Form where
61instance IsList Form where
225 type Item Form = (Text, Text)
62 type Item Form = (Text, Text)
226− fromList = Form . HashMap.fromListWith (flip (<>)) . fmap (\(k, v) -> (k, [v]))
63+ fromList = Form . Map.fromListWith (flip (<>)) . fmap (\(k, v) -> (k, [v]))
227− toList = concatMap (\(k, vs) -> map ((,) k) vs) . HashMap.toList . unForm
64+ toList = concatMap (\(k, vs) -> map ((,) k) vs) . Map.toList . unForm
229−-- | A stable version of 'toList'.
230−toListStable :: Form -> [(Text, Text)]
231−toListStable = sortOn fst . toList
233-- | Convert a value into 'Form'.
66-- | Convert a value into 'Form'.
@@ -265,122 +98,42 @@ toListStable = sortOn fst . toList
265-- instance 'ToForm' Person
98-- instance 'ToForm' Person
268−-- The default implementation of 'toForm' is 'genericToForm'.
101+-- The default implementation will use 'toQueryParam' for each field's value.
269class ToForm a where
102class ToForm a where
270 -- | Convert a value into 'Form'.
103 -- | Convert a value into 'Form'.
271 toForm :: a -> Form
104 toForm :: a -> Form
272− default toForm :: (Generic a, GToForm a (Rep a)) => a -> Form
105+ default toForm :: (Generic a, GToForm (Rep a)) => a -> Form
273− toForm = genericToForm defaultFormOptions
106+ toForm = genericToForm
108+instance ToForm [(Text, Text)] where toForm = fromList
109+instance ToForm (Map Text [Text]) where toForm = Form . Map.filter (not . null)
275instance ToForm Form where toForm = id
110instance ToForm Form where toForm = id
277−instance (ToFormKey k, ToHttpApiData v) => ToForm [(k, v)] where
278− toForm = fromList . map (toFormKey *** toQueryParam)
280−instance (ToFormKey k, ToHttpApiData v) => ToForm (Map k [v]) where
281− toForm = fromEntriesByKey . Map.toList
283−instance (ToFormKey k, ToHttpApiData v) => ToForm (HashMap k [v]) where
284− toForm = fromEntriesByKey . HashMap.toList
286−instance ToHttpApiData v => ToForm (IntMap [v]) where
287− toForm = fromEntriesByKey . IntMap.toList
289−-- | Convert a list of entries groupped by key into a 'Form'.
291−-- >>> fromEntriesByKey [("name",["Nick"]),("color",["red","blue"])]
292−-- fromList [("color","red"),("color","blue"),("name","Nick")]
293−fromEntriesByKey :: (ToFormKey k, ToHttpApiData v) => [(k, [v])] -> Form
294−fromEntriesByKey = Form . HashMap.fromListWith (<>) . map (toFormKey *** map toQueryParam)
296−data Proxy3 a b c = Proxy3
298−type family NotSupported (cls :: k1) (a :: k2) (reason :: Symbol) :: Constraint where
299−#if __GLASGOW_HASKELL__ < 800
300− -- this is just a placeholder case for older GHCs to not freak out on an empty closed type family
301− NotSupported cls a "this type family is actually empty" = ()
303− NotSupported cls a reason = TypeError
304− ( 'Text "Cannot derive a Generic-based " ':<>: 'ShowType cls ':<>: 'Text " instance for " ':<>: 'ShowType a ':<>: 'Text "." ':$$:
305− 'ShowType a ':<>: 'Text " " ':<>: 'Text reason ':<>: 'Text "," ':$$:
306− 'Text "but Generic-based " ':<>: 'ShowType cls ':<>: 'Text " instances can be derived only for records" ':$$:
307− 'Text "(i.e. product types with named fields)." )
310-- | A 'Generic'-based implementation of 'toForm'.
112-- | A 'Generic'-based implementation of 'toForm'.
311-- This is used as a default implementation in 'ToForm'.
113-- This is used as a default implementation in 'ToForm'.
313−-- Note that this only works for records (i.e. product data types with named fields):
316−-- data Person = Person
319−-- } deriving ('Generic')
322−-- In this implementation each field's value gets encoded using `toQueryParam`.
323−-- Two field types are exceptions:
325−-- - for values of type @'Maybe' a@ an entry is added to the 'Form' only when it is @'Just' x@
326−-- and the encoded value is @'toQueryParam' x@; 'Nothing' values are omitted from the 'Form';
328−-- - for values of type @[a]@ (except @['Char']@) an entry is added for every item in the list;
329−-- if the list is empty no entries are added to the 'Form';
331−-- Here's an example:
336−-- , subtitle :: Maybe String
337−-- , comments :: [String]
338−-- } deriving ('Generic', 'Show')
340−-- instance 'ToForm' Post
343−-- >>> urlEncodeAsFormStable Post { title = "Test", subtitle = Nothing, comments = ["Nice post!", "+1"] }
344−-- "comments=Nice%20post%21&comments=%2B1&title=Test"
345−genericToForm :: forall a. (Generic a, GToForm a (Rep a)) => FormOptions -> a -> Form
114+genericToForm :: (Generic a, GToForm (Rep a)) => a -> Form
346−genericToForm opts = gToForm (Proxy :: Proxy a) opts . from
115+genericToForm = gToForm . from
348−class GToForm t (f :: * -> *) where
349− gToForm :: Proxy t -> FormOptions -> f x -> Form
351−instance (GToForm t f, GToForm t g) => GToForm t (f :*: g) where
352− gToForm p opts (a :*: b) = gToForm p opts a <> gToForm p opts b
354−instance (GToForm t f) => GToForm t (M1 D x f) where
117+class GToForm (f :: * -> *) where
355− gToForm p opts (M1 a) = gToForm p opts a
118+ gToForm :: f x -> Form
357−instance (GToForm t f) => GToForm t (M1 C x f) where
120+instance (GToForm f, GToForm g) => GToForm (f :*: g) where
358− gToForm p opts (M1 a) = gToForm p opts a
121+ gToForm (a :*: b) = gToForm a <> gToForm b
360−instance OVERLAPPABLE_ (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i c)) where
123+instance (GToForm f, GToForm g) => GToForm (f :+: g) where
361− gToForm _ opts (M1 (K1 c)) = fromList [(key, toQueryParam c)]
124+ gToForm (L1 a) = gToForm a
362− where
125+ gToForm (R1 a) = gToForm a
363− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
365−instance (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i (Maybe c))) where
127+instance (GToForm f) => GToForm (M1 D x f) where
366− gToForm _ opts (M1 (K1 c)) =
128+ gToForm (M1 a) = gToForm a
369− Just x -> fromList [(key, toQueryParam x)]
371− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
373−instance (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i [c])) where
130+instance (GToForm f) => GToForm (M1 C x f) where
374− gToForm _ opts (M1 (K1 cs)) = fromList (map (\c -> (key, toQueryParam c)) cs)
131+ gToForm (M1 a) = gToForm a
376− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
378−instance OVERLAPPING_ (Selector s) => GToForm t (M1 S s (K1 i String)) where
133+instance (Selector s, ToHttpApiData c) => GToForm (M1 S s (K1 i c)) where
379− gToForm _ opts (M1 (K1 c)) = fromList [(key, toQueryParam c)]
134+ gToForm (M1 (K1 c)) = fromList [(key, toQueryParam c)]
381− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
136+ key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
383−instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToForm = error "impossible"
385-- | Parse 'Form' into a value.
138-- | Parse 'Form' into a value.
@@ -392,9 +145,9 @@ instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToF
392-- , age :: Int }
145-- , age :: Int }
394-- instance 'FromForm' Person where
147-- instance 'FromForm' Person where
395−-- 'fromForm' f = Person
148+-- 'fromForm' (Form m) = Person
396−-- '<$>' 'parseUnique' "name" f
149+-- '\<$\>' maybe (Left "key \"name\" not found") 'parseQueryParam' (lookup "name" m)
397−-- '<*>' 'parseUnique' "age" f
150+-- '\<*\>' maybe (Left "key \"age\" not found") 'parseQueryParam' (lookup "name" m)
400-- Instead of manually writing @'FromForm'@ instances you can
153-- Instead of manually writing @'FromForm'@ instances you can
@@ -415,382 +168,154 @@ instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToF
415-- instance 'FromForm' Person
168-- instance 'FromForm' Person
418−-- The default implementation of 'fromForm' is 'genericFromForm'.
419−-- It only works for records and it will use 'parseQueryParam' for each field's value.
171+-- The default implementation will use 'parseQueryParam' for each field's value.
420class FromForm a where
172class FromForm a where
421 -- | Parse 'Form' into a value.
173 -- | Parse 'Form' into a value.
422 fromForm :: Form -> Either Text a
174 fromForm :: Form -> Either Text a
423− default fromForm :: (Generic a, GFromForm a (Rep a)) => Form -> Either Text a
175+ default fromForm :: (Generic a, GFromForm (Rep a))
176+ => Form -> Either Text a
424− fromForm = genericFromForm defaultFormOptions
177+ fromForm = genericFromForm
426−instance FromForm Form where fromForm = pure
428−-- | _NOTE:_ this conversion is unstable and may result in different key order (but not values).
429−instance (FromFormKey k, FromHttpApiData v) => FromForm [(k, v)] where
430− fromForm = fmap (concatMap (\(k, vs) -> map ((,) k) vs)) . toEntriesByKey
432−instance (Ord k, FromFormKey k, FromHttpApiData v) => FromForm (Map k [v]) where
433− fromForm = fmap (Map.fromListWith (<>)) . toEntriesByKey
435−instance (Eq k, Hashable k, FromFormKey k, FromHttpApiData v) => FromForm (HashMap k [v]) where
436− fromForm = fmap (HashMap.fromListWith (<>)) . toEntriesByKey
438−instance FromHttpApiData v => FromForm (IntMap [v]) where
439− fromForm = fmap (IntMap.fromListWith (<>)) . toEntriesByKey
441−-- | Parse a 'Form' into a list of entries groupped by key.
179+instance FromForm Form where fromForm = return
442−--
180+instance FromForm (Map Text [Text]) where fromForm = return . unForm
443−-- _NOTE:_ this conversion is unstable and may result in different key order
181+instance FromForm [(Text, Text)] where fromForm = return . toList
444−-- (but not values). For a stable encoding see 'toEntriesByKeyStable'.
445−toEntriesByKey :: (FromFormKey k, FromHttpApiData v) => Form -> Either Text [(k, [v])]
446−toEntriesByKey = traverse parseGroup . HashMap.toList . unForm
448− parseGroup (k, vs) = (,) <$> parseFormKey k <*> traverse parseQueryParam vs
450−-- | Parse a 'Form' into a list of entries groupped by key.
452−-- >>> toEntriesByKeyStable [("name", "Nick"), ("color", "red"), ("color", "white")] :: Either Text [(Text, [Text])]
453−-- Right [("color",["red","white"]),("name",["Nick"])]
455−-- For an unstable (but faster) conversion see 'toEntriesByKey'.
456−toEntriesByKeyStable :: (Ord k, FromFormKey k, FromHttpApiData v) => Form -> Either Text [(k, [v])]
457−toEntriesByKeyStable = fmap (sortOn fst) . toEntriesByKey
459-- | A 'Generic'-based implementation of 'fromForm'.
183-- | A 'Generic'-based implementation of 'fromForm'.
460-- This is used as a default implementation in 'FromForm'.
184-- This is used as a default implementation in 'FromForm'.
462−-- Note that this only works for records (i.e. product data types with named fields):
465−-- data Person = Person
468−-- } deriving ('Generic')
471−-- In this implementation each field's value gets decoded using `parseQueryParam`.
472−-- Two field types are exceptions:
474−-- - for values of type @'Maybe' a@ an entry is parsed if present in the 'Form'
475−-- and the is decoded with 'parseQueryParam'; if no entry is present result is 'Nothing';
477−-- - for values of type @[a]@ (except @['Char']@) all entries are parsed to produce a list of parsed values;
479−-- Here's an example:
484−-- , subtitle :: Maybe String
485−-- , comments :: [String]
486−-- } deriving ('Generic', 'Show')
488−-- instance 'FromForm' Post
491−-- >>> urlDecodeAsForm "comments=Nice%20post%21&comments=%2B1&title=Test" :: Either Text Post
492−-- Right (Post {title = "Test", subtitle = Nothing, comments = ["Nice post!","+1"]})
493−genericFromForm :: forall a. (Generic a, GFromForm a (Rep a)) => FormOptions -> Form -> Either Text a
185+genericFromForm :: (Generic a, GFromForm (Rep a))
186+ => Form -> Either Text a
494−genericFromForm opts f = to <$> gFromForm (Proxy :: Proxy a) opts f
187+genericFromForm f = to <$> gFromForm f
496−class GFromForm t (f :: * -> *) where
497− gFromForm :: Proxy t -> FormOptions -> Form -> Either Text (f x)
499−instance (GFromForm t f, GFromForm t g) => GFromForm t (f :*: g) where
500− gFromForm p opts f = (:*:) <$> gFromForm p opts f <*> gFromForm p opts f
502−instance GFromForm t f => GFromForm t (M1 D x f) where
503− gFromForm p opts f = M1 <$> gFromForm p opts f
505−instance GFromForm t f => GFromForm t (M1 C x f) where
189+class GFromForm (f :: * -> *) where
506− gFromForm p opts f = M1 <$> gFromForm p opts f
190+ gFromForm :: Form -> Either Text (f x)
508−instance OVERLAPPABLE_ (Selector s, FromHttpApiData c) => GFromForm t (M1 S s (K1 i c)) where
192+instance (GFromForm f, GFromForm g) => GFromForm (f :*: g) where
509− gFromForm _ opts form = M1 . K1 <$> parseUnique key form
193+ gFromForm f = (:*:) <$> gFromForm f <*> gFromForm f
511− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
513−instance (Selector s, FromHttpApiData c) => GFromForm t (M1 S s (K1 i (Maybe c))) where
514− gFromForm _ opts form = M1 . K1 <$> parseMaybe key form
516− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
518−instance (Selector s, FromHttpApiData c) => GFromForm t (M1 S s (K1 i [c])) where
195+instance (GFromForm f, GFromForm g) => GFromForm (f :+: g) where
519− gFromForm _ opts form = M1 . K1 <$> parseAll key form
196+ gFromForm f
197+ = fmap L1 (gFromForm f)
198+ <!> fmap R1 (gFromForm f)
521− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
200+ Left _ <!> y = y
523−instance OVERLAPPING_ (Selector s) => GFromForm t (M1 S s (K1 i String)) where
203+instance (Selector s, FromHttpApiData f) => GFromForm (M1 S s (K1 i f)) where
524− gFromForm _ opts form = M1 . K1 <$> parseUnique key form
204+ gFromForm f =
205+ case concat (Map.lookup key (unForm f)) of
206+ [v] -> M1 . K1 <$> parseQueryParam v
207+ [] -> Left $ "Could not find key " <> Text.pack (show key)
208+ _ -> Left $ "Duplicate key " <> Text.pack (show key)
526− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
210+ key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
528−instance NotSupported FromForm t "is a sum type" => GFromForm t (f :+: g) where gFromForm = error "impossible"
212+instance (GFromForm f) => GFromForm (M1 D x f) where
213+ gFromForm f = M1 <$> gFromForm f
530−-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
215+instance (GFromForm f) => GFromForm (M1 C x f) where
531−--
216+ gFromForm f = M1 <$> gFromForm f
532−-- _NOTE:_ this encoding is unstable and may result in different key order
533−-- (but not values). For a stable encoding see 'urlEncodeFormStable'.
534−urlEncodeForm :: Form -> BSL.ByteString
535−urlEncodeForm = urlEncodeParams . toList
537-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
218-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
539−-- For an unstable (but faster) encoding see 'urlEncodeForm'.
541-- Key-value pairs get encoded to @key=value@ and separated by @&@:
220-- Key-value pairs get encoded to @key=value@ and separated by @&@:
543−-- >>> urlEncodeFormStable [("name", "Julian"), ("lastname", "Arni")]
222+-- >>> encodeForm [("name", "Julian"), ("lastname", "Arni")]
544-- "lastname=Arni&name=Julian"
223-- "lastname=Arni&name=Julian"
546-- Keys with empty values get encoded to just @key@ (without the @=@ sign):
225-- Keys with empty values get encoded to just @key@ (without the @=@ sign):
548−-- >>> urlEncodeFormStable [("is_test", "")]
227+-- >>> encodeForm [("is_test", "")]
549-- "is_test"
228-- "is_test"
551-- Empty keys are allowed too:
230-- Empty keys are allowed too:
553−-- >>> urlEncodeFormStable [("", "foobar")]
232+-- >>> encodeForm [("", "foobar")]
554-- "=foobar"
233-- "=foobar"
556−-- However, if both key and value are empty, the key-value pair is ignored.
235+-- However, if not key and value are empty, the key-value pair is ignored.
557−-- (This prevents @'urlDecodeForm' . 'urlEncodeFormStable'@ from being a true isomorphism).
236+-- (This prevents @'decodeForm' . 'encodeForm'@ from being a true isomorphism).
559−-- >>> urlEncodeFormStable [("", "")]
238+-- >>> encodeForm [("", "")]
562-- Everything is escaped with @'escapeURIString' 'isUnreserved'@:
241-- Everything is escaped with @'escapeURIString' 'isUnreserved'@:
564−-- >>> urlEncodeFormStable [("fullname", "Andres Löh")]
243+-- >>> encodeForm [("fullname", "Andres Löh")]
565-- "fullname=Andres%20L%C3%B6h"
244-- "fullname=Andres%20L%C3%B6h"
566−urlEncodeFormStable :: Form -> BSL.ByteString
245+encodeForm :: Form -> BSL.ByteString
567−urlEncodeFormStable = urlEncodeParams . sortOn fst . toList
246+encodeForm xs = BSL.intercalate "&" $ map (BSL.fromStrict . encodePair) $ toList xs
569−-- | Encode a list of key-value pairs to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
571−-- See also 'urlEncodeFormStable'.
572−urlEncodeParams :: [(Text, Text)] -> BSL.ByteString
573−urlEncodeParams = toLazyByteString . mconcat . intersperse (shortByteString "&") . map encodePair
575− escape = urlEncodeBuilder True . Text.encodeUtf8
248+ escape = Text.encodeUtf8 . Text.pack . escapeURIString isUnreserved . Text.unpack
577 encodePair (k, "") = escape k
250 encodePair (k, "") = escape k
578− encodePair (k, v) = escape k <> shortByteString "=" <> escape v
251+ encodePair (k, v) = escape k <> "=" <> escape v
580-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a 'Form'.
254-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a 'Form'.
582-- Key-value pairs get decoded normally:
256-- Key-value pairs get decoded normally:
584−-- >>> urlDecodeForm "name=Greg&lastname=Weber"
258+-- >>> decodeForm "name=Greg&lastname=Weber"
585-- Right (fromList [("lastname","Weber"),("name","Greg")])
259-- Right (fromList [("lastname","Weber"),("name","Greg")])
587-- Keys with no values get decoded to pairs with empty values.
261-- Keys with no values get decoded to pairs with empty values.
589−-- >>> urlDecodeForm "is_test"
263+-- >>> decodeForm "is_test"
590-- Right (fromList [("is_test","")])
264-- Right (fromList [("is_test","")])
592-- Empty keys are allowed:
266-- Empty keys are allowed:
594−-- >>> urlDecodeForm "=foobar"
268+-- >>> decodeForm "=foobar"
595-- Right (fromList [("","foobar")])
269-- Right (fromList [("","foobar")])
597-- The empty string gets decoded into an empty 'Form':
271-- The empty string gets decoded into an empty 'Form':
599−-- >>> urlDecodeForm ""
273+-- >>> decodeForm ""
600-- Right (fromList [])
274-- Right (fromList [])
602-- Everything is un-escaped with 'unEscapeString':
276-- Everything is un-escaped with 'unEscapeString':
604−-- >>> urlDecodeForm "fullname=Andres%20L%C3%B6h"
278+-- >>> decodeForm "fullname=Andres%20L%C3%B6h"
605-- Right (fromList [("fullname","Andres L\246h")])
279-- Right (fromList [("fullname","Andres L\246h")])
607-- Improperly formed strings result in an error:
281-- Improperly formed strings result in an error:
609−-- >>> urlDecodeForm "this=has=too=many=equals"
283+-- >>> decodeForm "this=has=too=many=equals"
610-- Left "not a valid pair: this=has=too=many=equals"
284-- Left "not a valid pair: this=has=too=many=equals"
611−urlDecodeForm :: BSL.ByteString -> Either Text Form
285+decodeForm :: BSL.ByteString -> Either Text Form
612−urlDecodeForm = fmap toForm . urlDecodeParams
614−-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a list of key-value pairs.
616−-- See also 'urlDecodeForm'.
617−urlDecodeParams :: BSL.ByteString -> Either Text [(Text, Text)]
618−urlDecodeParams bs = traverse parsePair pairs
286+decodeForm bs = toForm <$> traverse parsePair pairs
620− pairs = map (BSL8.split '=') (BSL8.split '&' bs)
288+ pairs = map (Text.decodeUtf8With lenientDecode . BSL.toStrict) (BSL8.split '&' bs)
622− unescape = Text.decodeUtf8With lenientDecode . urlDecode True . BSL.toStrict
290+ unescape = Text.pack . unEscapeString . Text.unpack . Text.replace "+" "%20"
292+ parsePair :: Text -> Either Text (Text, Text)
624 parsePair p =
293 parsePair p =
625− case map unescape p of
294+ case Text.splitOn "=" p of
626− [k, v] -> return (k, v)
295+ [k, v] -> return (unescape k, unescape v)
627− [k] -> return (k, "")
296+ [k] -> return (unescape k, "" )
628− xs -> Left $ "not a valid pair: " <> Text.intercalate "=" xs
297+ _ -> Left $ "not a valid pair: " <> p
299+data Proxy3 a b c = Proxy3
631-- | This is a convenience function for decoding a
301-- | This is a convenience function for decoding a
632-- @application/x-www-form-urlencoded@ 'BSL.ByteString' directly to a datatype
302-- @application/x-www-form-urlencoded@ 'BSL.ByteString' directly to a datatype
633-- that has an instance of 'FromForm'.
303-- that has an instance of 'FromForm'.
635−-- This is effectively @'fromForm' '<=<' 'urlDecodeForm'@.
305+-- This is effectively @'fromForm' '<=<' 'decodeForm'@.
637−-- >>> urlDecodeAsForm "name=Dennis&age=22" :: Either Text Person
307+-- >>> decodeAsForm "name=Dennis&age=22" :: Either Text Person
638-- Right (Person {name = "Dennis", age = 22})
308-- Right (Person {name = "Dennis", age = 22})
639−urlDecodeAsForm :: FromForm a => BSL.ByteString -> Either Text a
309+decodeAsForm :: FromForm a => BSL.ByteString -> Either Text a
640−urlDecodeAsForm = fromForm <=< urlDecodeForm
310+decodeAsForm = fromForm <=< decodeForm
642−-- | This is a convenience function for encoding a datatype that has instance
643−-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
646−-- This is effectively @'urlEncodeForm' . 'toForm'@.
648−-- _NOTE:_ this encoding is unstable and may result in different key order
649−-- (but not values). For a stable encoding see 'urlEncodeAsFormStable'.
650−urlEncodeAsForm :: ToForm a => a -> BSL.ByteString
651−urlEncodeAsForm = urlEncodeForm . toForm
653-- | This is a convenience function for encoding a datatype that has instance
312-- | This is a convenience function for encoding a datatype that has instance
654-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
313-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
655-- 'BSL.ByteString'.
314-- 'BSL.ByteString'.
657−-- This is effectively @'urlEncodeFormStable' . 'toForm'@.
316+-- This is effectively @'encodeForm' . 'toForm'@.
659−-- >>> urlEncodeAsFormStable Person {name = "Dennis", age = 22}
318+-- >>> encodeAsForm Person {name = "Dennis", age = 22}
660-- "age=22&name=Dennis"
319-- "age=22&name=Dennis"
661−urlEncodeAsFormStable :: ToForm a => a -> BSL.ByteString
320+encodeAsForm :: ToForm a => a -> BSL.ByteString
662−urlEncodeAsFormStable = urlEncodeFormStable . toForm
321+encodeAsForm = encodeForm . toForm
664−-- | Find all values corresponding to a given key in a 'Form'.
666−-- >>> lookupAll "name" []
668−-- >>> lookupAll "name" [("name", "Oleg")]
670−-- >>> lookupAll "name" [("name", "Oleg"), ("name", "David")]
672−lookupAll :: Text -> Form -> [Text]
673−lookupAll key = F.concat . HashMap.lookup key . unForm
675−-- | Lookup an optional value for a key.
676−-- Fail if there is more than one value.
678−-- >>> lookupMaybe "name" []
680−-- >>> lookupMaybe "name" [("name", "Oleg")]
681−-- Right (Just "Oleg")
682−-- >>> lookupMaybe "name" [("name", "Oleg"), ("name", "David")]
683−-- Left "Duplicate key \"name\""
684−lookupMaybe :: Text -> Form -> Either Text (Maybe Text)
685−lookupMaybe key form =
686− case lookupAll key form of
688− [v] -> pure (Just v)
689− _ -> Left $ "Duplicate key " <> Text.pack (show key)
691−-- | Lookup a unique value for a key.
692−-- Fail if there is zero or more than one value.
694−-- >>> lookupUnique "name" []
695−-- Left "Could not find key \"name\""
696−-- >>> lookupUnique "name" [("name", "Oleg")]
698−-- >>> lookupUnique "name" [("name", "Oleg"), ("name", "David")]
699−-- Left "Duplicate key \"name\""
700−lookupUnique :: Text -> Form -> Either Text Text
701−lookupUnique key form = do
702− mv <- lookupMaybe key form
705− Nothing -> Left $ "Could not find key " <> Text.pack (show key)
707−-- | Lookup all values for a given key in a 'Form' and parse them with 'parseQueryParams'.
709−-- >>> parseAll "age" [] :: Either Text [Word8]
711−-- >>> parseAll "age" [("age", "8"), ("age", "seven")] :: Either Text [Word8]
712−-- Left "could not parse: `seven' (input does not start with a digit)"
713−-- >>> parseAll "age" [("age", "8"), ("age", "777")] :: Either Text [Word8]
714−-- Left "out of bounds: `777' (should be between 0 and 255)"
715−-- >>> parseAll "age" [("age", "12"), ("age", "25")] :: Either Text [Word8]
717−parseAll :: FromHttpApiData v => Text -> Form -> Either Text [v]
718−parseAll key = parseQueryParams . lookupAll key
720−-- | Lookup an optional value for a given key and parse it with 'parseQueryParam'.
721−-- Fail if there is more than one value for the key.
723−-- >>> parseMaybe "age" [] :: Either Text (Maybe Word8)
725−-- >>> parseMaybe "age" [("age", "12"), ("age", "25")] :: Either Text (Maybe Word8)
726−-- Left "Duplicate key \"age\""
727−-- >>> parseMaybe "age" [("age", "seven")] :: Either Text (Maybe Word8)
728−-- Left "could not parse: `seven' (input does not start with a digit)"
729−-- >>> parseMaybe "age" [("age", "777")] :: Either Text (Maybe Word8)
730−-- Left "out of bounds: `777' (should be between 0 and 255)"
731−-- >>> parseMaybe "age" [("age", "7")] :: Either Text (Maybe Word8)
733−parseMaybe :: FromHttpApiData v => Text -> Form -> Either Text (Maybe v)
734−parseMaybe key = parseQueryParams <=< lookupMaybe key
736−-- | Lookup a unique value for a given key and parse it with 'parseQueryParam'.
737−-- Fail if there is zero or more than one value for the key.
739−-- >>> parseUnique "age" [] :: Either Text Word8
740−-- Left "Could not find key \"age\""
741−-- >>> parseUnique "age" [("age", "12"), ("age", "25")] :: Either Text Word8
742−-- Left "Duplicate key \"age\""
743−-- >>> parseUnique "age" [("age", "seven")] :: Either Text Word8
744−-- Left "could not parse: `seven' (input does not start with a digit)"
745−-- >>> parseUnique "age" [("age", "777")] :: Either Text Word8
746−-- Left "out of bounds: `777' (should be between 0 and 255)"
747−-- >>> parseUnique "age" [("age", "7")] :: Either Text Word8
749−parseUnique :: FromHttpApiData v => Text -> Form -> Either Text v
750−parseUnique key form = lookupUnique key form >>= parseQueryParam
752−-- | 'Generic'-based deriving options for 'ToForm' and 'FromForm'.
754−-- A common use case for non-default 'FormOptions'
755−-- is to strip a prefix off of field labels:
758−-- data Project = Project
759−-- { projectName :: String
760−-- , projectSize :: Int
761−-- } deriving ('Generic', 'Show')
763−-- myOptions :: 'FormOptions'
764−-- myOptions = 'FormOptions'
765−-- { 'fieldLabelModifier' = 'map' 'toLower' . 'drop' ('length' \"project\") }
767−-- instance 'ToForm' Project where
768−-- 'toForm' = 'genericToForm' myOptions
770−-- instance 'FromForm' Project where
771−-- 'fromForm' = 'genericFromForm' myOptions
774−-- >>> urlEncodeAsFormStable Project { projectName = "http-api-data", projectSize = 172 }
775−-- "name=http-api-data&size=172"
776−-- >>> urlDecodeAsForm "name=http-api-data&size=172" :: Either Text Project
777−-- Right (Project {projectName = "http-api-data", projectSize = 172})
778−data FormOptions = FormOptions
779− { -- | Function applied to field labels. Handy for removing common record prefixes for example.
780− fieldLabelModifier :: String -> String
783−-- | Default encoding 'FormOptions'.
787−-- { 'fieldLabelModifier' = id
790−defaultFormOptions :: FormOptions
791−defaultFormOptions = FormOptions
792− { fieldLabelModifier = id
795−sortOn :: Ord b => (a -> b) -> [a] -> [a]
796−sortOn f = sortBy (comparing f)