@@ -1,67 +1,58 @@
1−{-# LANGUAGE ConstraintKinds #-}
21{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
42{-# LANGUAGE DefaultSignatures #-}
53{-# LANGUAGE DeriveGeneric #-}
64{-# LANGUAGE FlexibleContexts #-}
75{-# LANGUAGE FlexibleInstances #-}
86{-# LANGUAGE GeneralizedNewtypeDeriving #-}
97{-# LANGUAGE KindSignatures #-}
10−{-# LANGUAGE MultiParamTypeClasses #-}
118{-# LANGUAGE OverloadedStrings #-}
129{-# LANGUAGE PolyKinds #-}
1310{-# LANGUAGE ScopedTypeVariables #-}
1411{-# LANGUAGE TypeFamilies #-}
1512{-# LANGUAGE TypeOperators #-}
16−{-# LANGUAGE UndecidableInstances #-}
17−#include "overlapping-compat.h"
1813module Web.Internal.FormUrlEncoded where
1914
20−import Prelude ()
21−import Prelude.Compat
15+#if __GLASGOW_HASKELL__ < 710
16+import Control.Applicative
17+import Data.Traversable
18+#endif
2219
23−import Control.Applicative (Const(Const))
2420import Control.Arrow ((***))
2521import Control.Monad ((<=<))
26−import Data.ByteString.Builder (shortByteString, toLazyByteString)
22+import Data.ByteString.Builder (toLazyByteString, shortByteString)
2723import qualified Data.ByteString.Lazy as BSL
2824import qualified Data.ByteString.Lazy.Char8 as BSL8
29−import Data.Coerce (coerce)
3025import qualified Data.Foldable as F
31−import Data.Functor.Identity (Identity(Identity))
3226import Data.Hashable (Hashable)
3327import Data.HashMap.Strict (HashMap)
3428import qualified Data.HashMap.Strict as HashMap
35−import Data.Int (Int16, Int32, Int64, Int8)
29+import Data.Int
3630import Data.IntMap (IntMap)
3731import qualified Data.IntMap as IntMap
38−import Data.List (intersperse, sortBy)
32+import Data.List (intersperse)
3933import Data.Map (Map)
4034import qualified Data.Map as Map
41−import Data.Monoid (All (..), Any (..), Dual (..),
42− Product (..), Sum (..))
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 (..))
35+import Data.Monoid
36+
4837import Data.Text (Text)
4938import qualified Data.Text as Text
50−import qualified Data.Text.Encoding as Text
51−import Data.Text.Encoding.Error (lenientDecode)
5239import qualified Data.Text.Lazy as Lazy
53−import Data.Time.Compat (Day, LocalTime, NominalDiffTime,
54− UTCTime, ZonedTime)
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 (..))
40+import Data.Text.Encoding as Text
41+import Data.Text.Encoding.Error (lenientDecode)
42+
43+import Data.Time
44+import Data.Word
45+
46+#if MIN_VERSION_base(4,8,0)
47+import Data.Void
48+import Numeric.Natural
49+#endif
50+
51+import GHC.Exts (IsList (..))
6052import GHC.Generics
61−import GHC.TypeLits
62−import Network.HTTP.Types.URI (urlDecode, urlEncodeBuilder)
63−import Numeric.Natural (Natural)
64−import Web.Internal.HttpApiData
53+import URI.ByteString (urlEncodeQuery, urlDecodeQuery)
54+
55+import Web.Internal.HttpApiData
6556
6657-- $setup
6758-- >>> :set -XDeriveGeneric
@@ -70,20 +61,11 @@ import Web.Internal.HttpApiData
7061-- >>> :set -XFlexibleContexts
7162-- >>> :set -XScopedTypeVariables
7263-- >>> :set -XTypeFamilies
73−-- >>> import Data.Char (toLower)
74−--
64+-- >>> import Data.Either (isLeft)
65+-- >>> import Data.List (sort)
7566-- >>> data Person = Person { name :: String, age :: Int } deriving (Show, Generic)
7667-- >>> instance ToForm Person
7768-- >>> instance FromForm Person
78−--
79−-- >>> data Post = Post { title :: String, subtitle :: Maybe String, comments :: [String]} deriving (Generic, Show)
80−-- >>> instance ToForm Post
81−-- >>> instance FromForm Post
82−--
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
8769
8870-- | Typeclass for types that can be used as keys in a 'Form'-like container (like 'Map').
8971class ToFormKey k where
@@ -115,9 +97,6 @@ instance ToFormKey LocalTime where toFormKey = toQueryParam
11597instance ToFormKey ZonedTime where toFormKey = toQueryParam
11698instance ToFormKey UTCTime where toFormKey = toQueryParam
11799instance 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
121100
122101instance ToFormKey String where toFormKey = toQueryParam
123102instance ToFormKey Text where toFormKey = toQueryParam
@@ -126,26 +105,14 @@ instance ToFormKey Lazy.Text where toFormKey = toQueryParam
126105instance ToFormKey All where toFormKey = toQueryParam
127106instance ToFormKey Any where toFormKey = toQueryParam
128107
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)
132−
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)
137−
138−instance ToFormKey a => ToFormKey (Tagged b a) where toFormKey = coerce (toFormKey :: a -> Text)
139−
140−-- | @since 0.4.2
141−instance ToFormKey a => ToFormKey (Identity a) where toFormKey = coerce (toFormKey :: a -> Text)
142−
143−-- | @since 0.4.2
144−instance ToFormKey a => ToFormKey (Const a b) where
145− toFormKey = coerce (toFormKey :: a -> Text)
108+instance ToFormKey a => ToFormKey (Dual a) where toFormKey = toFormKey . getDual
109+instance ToFormKey a => ToFormKey (Sum a) where toFormKey = toFormKey . getSum
110+instance ToFormKey a => ToFormKey (Product a) where toFormKey = toFormKey . getProduct
146111
112+#if MIN_VERSION_base(4,8,0)
147113instance ToFormKey Void where toFormKey = toQueryParam
148114instance ToFormKey Natural where toFormKey = toQueryParam
115+#endif
149116
150117-- | Typeclass for types that can be parsed from keys of a 'Form'. This is the reverse of 'ToFormKey'.
151118class FromFormKey k where
@@ -177,9 +144,6 @@ instance FromFormKey LocalTime where parseFormKey = parseQueryParam
177144instance FromFormKey ZonedTime where parseFormKey = parseQueryParam
178145instance FromFormKey UTCTime where parseFormKey = parseQueryParam
179146instance 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
183147
184148instance FromFormKey String where parseFormKey = parseQueryParam
185149instance FromFormKey Text where parseFormKey = parseQueryParam
@@ -188,48 +152,30 @@ instance FromFormKey Lazy.Text where parseFormKey = parseQueryParam
188152instance FromFormKey All where parseFormKey = parseQueryParam
189153instance FromFormKey Any where parseFormKey = parseQueryParam
190154
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)
194−
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)
199−
200−instance FromFormKey a => FromFormKey (Tagged b a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
201−
202−-- | @since 0.4.2
203−instance FromFormKey a => FromFormKey (Identity a) where parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
204−
205−-- | @since 0.4.2
206−instance FromFormKey a => FromFormKey (Const a b) where
207− parseFormKey = coerce (parseFormKey :: Text -> Either Text a)
155+instance FromFormKey a => FromFormKey (Dual a) where parseFormKey = fmap Dual . parseFormKey
156+instance FromFormKey a => FromFormKey (Sum a) where parseFormKey = fmap Sum . parseFormKey
157+instance FromFormKey a => FromFormKey (Product a) where parseFormKey = fmap Product . parseFormKey
208158
159+#if MIN_VERSION_base(4,8,0)
209160instance FromFormKey Void where parseFormKey = parseQueryParam
210161instance FromFormKey Natural where parseFormKey = parseQueryParam
162+#endif
211163
212164-- | The contents of a form, not yet URL-encoded.
213165--
214166-- 'Form' can be URL-encoded with 'urlEncodeForm' and URL-decoded with 'urlDecodeForm'.
215167newtype Form = Form { unForm :: HashMap Text [Text] }
216− deriving (Eq, Read, Generic, Semigroup, Monoid)
168+ deriving (Eq, Read, Generic, Monoid)
217169
218170instance Show Form where
219171 showsPrec d form = showParen (d > 10) $
220− showString "fromList " . shows (toListStable form)
172+ showString "fromList " . shows (toList form)
221173
222−-- | _NOTE:_ 'toList' is unstable and may result in different key order (but not values).
223−-- For a stable conversion use 'toListStable'.
224174instance IsList Form where
225175 type Item Form = (Text, Text)
226176 fromList = Form . HashMap.fromListWith (flip (<>)) . fmap (\(k, v) -> (k, [v]))
227177 toList = concatMap (\(k, vs) -> map ((,) k) vs) . HashMap.toList . unForm
228178
229−-- | A stable version of 'toList'.
230−toListStable :: Form -> [(Text, Text)]
231−toListStable = sortOn fst . toList
232−
233179-- | Convert a value into 'Form'.
234180--
235181-- An example type and instance:
@@ -265,12 +211,12 @@ toListStable = sortOn fst . toList
265211-- instance 'ToForm' Person
266212-- @
267213--
268−-- The default implementation of 'toForm' is 'genericToForm'.
214+-- The default implementation will use 'toQueryParam' for each field's value.
269215class ToForm a where
270216 -- | Convert a value into 'Form'.
271217 toForm :: a -> Form
272− default toForm :: (Generic a, GToForm a (Rep a)) => a -> Form
273− toForm = genericToForm defaultFormOptions
218+ default toForm :: (Generic a, GToForm (Rep a)) => a -> Form
219+ toForm = genericToForm
274220
275221instance ToForm Form where toForm = id
276222
@@ -287,100 +233,30 @@ instance ToHttpApiData v => ToForm (IntMap [v]) where
287233 toForm = fromEntriesByKey . IntMap.toList
288234
289235-- | Convert a list of entries groupped by key into a 'Form'.
290−--
291−-- >>> fromEntriesByKey [("name",["Nick"]),("color",["red","blue"])]
292−-- fromList [("color","red"),("color","blue"),("name","Nick")]
293236fromEntriesByKey :: (ToFormKey k, ToHttpApiData v) => [(k, [v])] -> Form
294237fromEntriesByKey = Form . HashMap.fromListWith (<>) . map (toFormKey *** map toQueryParam)
295238
296−data Proxy3 a b c = Proxy3
297−
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" = ()
302−#else
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)." )
308−#endif
309−
310239-- | A 'Generic'-based implementation of 'toForm'.
311240-- This is used as a default implementation in 'ToForm'.
312−--
313−-- Note that this only works for records (i.e. product data types with named fields):
314−--
315−-- @
316−-- data Person = Person
317−-- { name :: String
318−-- , age :: Int
319−-- } deriving ('Generic')
320−-- @
321−--
322−-- In this implementation each field's value gets encoded using `toQueryParam`.
323−-- Two field types are exceptions:
324−--
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';
327−--
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';
330−--
331−-- Here's an example:
332−--
333−-- @
334−-- data Post = Post
335−-- { title :: String
336−-- , subtitle :: Maybe String
337−-- , comments :: [String]
338−-- } deriving ('Generic', 'Show')
339−--
340−-- instance 'ToForm' Post
341−-- @
342−--
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
346−genericToForm opts = gToForm (Proxy :: Proxy a) opts . from
241+genericToForm :: (Generic a, GToForm (Rep a)) => a -> Form
242+genericToForm = gToForm . from
347243
348−class GToForm t (f :: * -> *) where
349− gToForm :: Proxy t -> FormOptions -> f x -> Form
244+class GToForm (f :: * -> *) where
245+ gToForm :: f x -> Form
350246
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
247+instance (GToForm f, GToForm g) => GToForm (f :*: g) where
248+ gToForm (a :*: b) = gToForm a <> gToForm b
353249
354−instance (GToForm t f) => GToForm t (M1 D x f) where
355− gToForm p opts (M1 a) = gToForm p opts a
250+instance (GToForm f) => GToForm (M1 D x f) where
251+ gToForm (M1 a) = gToForm a
356252
357−instance (GToForm t f) => GToForm t (M1 C x f) where
358− gToForm p opts (M1 a) = gToForm p opts a
253+instance (GToForm f) => GToForm (M1 C x f) where
254+ gToForm (M1 a) = gToForm a
359255
360−instance OVERLAPPABLE_ (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i c)) where
361− gToForm _ opts (M1 (K1 c)) = fromList [(key, toQueryParam c)]
256+instance (Selector s, ToHttpApiData c) => GToForm (M1 S s (K1 i c)) where
257+ gToForm (M1 (K1 c)) = fromList [(key, toQueryParam c)]
362258 where
363− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
364−
365−instance (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i (Maybe c))) where
366− gToForm _ opts (M1 (K1 c)) =
367− case c of
368− Nothing -> mempty
369− Just x -> fromList [(key, toQueryParam x)]
370− where
371− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
372−
373−instance (Selector s, ToHttpApiData c) => GToForm t (M1 S s (K1 i [c])) where
374− gToForm _ opts (M1 (K1 cs)) = fromList (map (\c -> (key, toQueryParam c)) cs)
375− where
376− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
377−
378−instance OVERLAPPING_ (Selector s) => GToForm t (M1 S s (K1 i String)) where
379− gToForm _ opts (M1 (K1 c)) = fromList [(key, toQueryParam c)]
380− where
381− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
382−
383−instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToForm = error "impossible"
259+ key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
384260
385261-- | Parse 'Form' into a value.
386262--
@@ -392,9 +268,9 @@ instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToF
392268-- , age :: Int }
393269--
394270-- instance 'FromForm' Person where
395−-- 'fromForm' f = Person
396−-- '<$>' 'parseUnique' "name" f
397−-- '<*>' 'parseUnique' "age" f
271+-- 'fromForm' (Form m) = Person
272+-- '<$>' 'parseUnique' "name" m
273+-- '<*>' 'parseUnique' "age" m
398274-- @
399275--
400276-- Instead of manually writing @'FromForm'@ instances you can
@@ -415,17 +291,16 @@ instance NotSupported ToForm t "is a sum type" => GToForm t (f :+: g) where gToF
415291-- instance 'FromForm' Person
416292-- @
417293--
418−-- The default implementation of 'fromForm' is 'genericFromForm'.
419−-- It only works for records and it will use 'parseQueryParam' for each field's value.
294+-- The default implementation will use 'parseQueryParam' for each field's value.
420295class FromForm a where
421296 -- | Parse 'Form' into a value.
422297 fromForm :: Form -> Either Text a
423− default fromForm :: (Generic a, GFromForm a (Rep a)) => Form -> Either Text a
424− fromForm = genericFromForm defaultFormOptions
298+ default fromForm :: (Generic a, GFromForm (Rep a))
299+ => Form -> Either Text a
300+ fromForm = genericFromForm
425301
426302instance FromForm Form where fromForm = pure
427303
428−-- | _NOTE:_ this conversion is unstable and may result in different key order (but not values).
429304instance (FromFormKey k, FromHttpApiData v) => FromForm [(k, v)] where
430305 fromForm = fmap (concatMap (\(k, vs) -> map ((,) k) vs)) . toEntriesByKey
431306
@@ -439,143 +314,69 @@ instance FromHttpApiData v => FromForm (IntMap [v]) where
439314 fromForm = fmap (IntMap.fromListWith (<>)) . toEntriesByKey
440315
441316-- | Parse a 'Form' into a list of entries groupped by key.
442−--
443−-- _NOTE:_ this conversion is unstable and may result in different key order
444−-- (but not values). For a stable encoding see 'toEntriesByKeyStable'.
445317toEntriesByKey :: (FromFormKey k, FromHttpApiData v) => Form -> Either Text [(k, [v])]
446318toEntriesByKey = traverse parseGroup . HashMap.toList . unForm
447319 where
448320 parseGroup (k, vs) = (,) <$> parseFormKey k <*> traverse parseQueryParam vs
449321
450−-- | Parse a 'Form' into a list of entries groupped by key.
451−--
452−-- >>> toEntriesByKeyStable [("name", "Nick"), ("color", "red"), ("color", "white")] :: Either Text [(Text, [Text])]
453−-- Right [("color",["red","white"]),("name",["Nick"])]
454−--
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
458−
459322-- | A 'Generic'-based implementation of 'fromForm'.
460323-- This is used as a default implementation in 'FromForm'.
461−--
462−-- Note that this only works for records (i.e. product data types with named fields):
463−--
464−-- @
465−-- data Person = Person
466−-- { name :: String
467−-- , age :: Int
468−-- } deriving ('Generic')
469−-- @
470−--
471−-- In this implementation each field's value gets decoded using `parseQueryParam`.
472−-- Two field types are exceptions:
473−--
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';
476−--
477−-- - for values of type @[a]@ (except @['Char']@) all entries are parsed to produce a list of parsed values;
478−--
479−-- Here's an example:
480−--
481−-- @
482−-- data Post = Post
483−-- { title :: String
484−-- , subtitle :: Maybe String
485−-- , comments :: [String]
486−-- } deriving ('Generic', 'Show')
487−--
488−-- instance 'FromForm' Post
489−-- @
490−--
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
494−genericFromForm opts f = to <$> gFromForm (Proxy :: Proxy a) opts f
495−
496−class GFromForm t (f :: * -> *) where
497− gFromForm :: Proxy t -> FormOptions -> Form -> Either Text (f x)
498−
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
501−
502−instance GFromForm t f => GFromForm t (M1 D x f) where
503− gFromForm p opts f = M1 <$> gFromForm p opts f
324+genericFromForm :: (Generic a, GFromForm (Rep a))
325+ => Form -> Either Text a
326+genericFromForm f = to <$> gFromForm f
504327
505−instance GFromForm t f => GFromForm t (M1 C x f) where
506− gFromForm p opts f = M1 <$> gFromForm p opts f
507−
508−instance OVERLAPPABLE_ (Selector s, FromHttpApiData c) => GFromForm t (M1 S s (K1 i c)) where
509− gFromForm _ opts form = M1 . K1 <$> parseUnique key form
510− where
511− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
512−
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
515− where
516− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
328+class GFromForm (f :: * -> *) where
329+ gFromForm :: Form -> Either Text (f x)
517330
518−instance (Selector s, FromHttpApiData c) => GFromForm t (M1 S s (K1 i [c])) where
519− gFromForm _ opts form = M1 . K1 <$> parseAll key form
520− where
521− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
331+instance (GFromForm f, GFromForm g) => GFromForm (f :*: g) where
332+ gFromForm f = (:*:) <$> gFromForm f <*> gFromForm f
522333
523−instance OVERLAPPING_ (Selector s) => GFromForm t (M1 S s (K1 i String)) where
524− gFromForm _ opts form = M1 . K1 <$> parseUnique key form
334+instance (Selector s, FromHttpApiData f) => GFromForm (M1 S s (K1 i f)) where
335+ gFromForm form = M1 . K1 <$> parseUnique key form
525336 where
526− key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
337+ key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
527338
528−instance NotSupported FromForm t "is a sum type" => GFromForm t (f :+: g) where gFromForm = error "impossible"
339+instance (GFromForm f) => GFromForm (M1 D x f) where
340+ gFromForm f = M1 <$> gFromForm f
529341
530−-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
531−--
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
342+instance (GFromForm f) => GFromForm (M1 C x f) where
343+ gFromForm f = M1 <$> gFromForm f
536344
537345-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
538346--
539−-- For an unstable (but faster) encoding see 'urlEncodeForm'.
540−--
541347-- Key-value pairs get encoded to @key=value@ and separated by @&@:
542348--
543−-- >>> urlEncodeFormStable [("name", "Julian"), ("lastname", "Arni")]
349+-- >>> urlEncodeForm [("name", "Julian"), ("lastname", "Arni")]
544350-- "lastname=Arni&name=Julian"
545351--
546352-- Keys with empty values get encoded to just @key@ (without the @=@ sign):
547353--
548−-- >>> urlEncodeFormStable [("is_test", "")]
354+-- >>> urlEncodeForm [("is_test", "")]
549355-- "is_test"
550356--
551357-- Empty keys are allowed too:
552358--
553−-- >>> urlEncodeFormStable [("", "foobar")]
359+-- >>> urlEncodeForm [("", "foobar")]
554360-- "=foobar"
555361--
556−-- However, if both key and value are empty, the key-value pair is ignored.
557−-- (This prevents @'urlDecodeForm' . 'urlEncodeFormStable'@ from being a true isomorphism).
362+-- However, if not key and value are empty, the key-value pair is ignored.
363+-- (This prevents @'urlDecodeForm' . 'urlEncodeForm'@ from being a true isomorphism).
558364--
559−-- >>> urlEncodeFormStable [("", "")]
365+-- >>> urlEncodeForm [("", "")]
560366-- ""
561367--
562368-- Everything is escaped with @'escapeURIString' 'isUnreserved'@:
563369--
564−-- >>> urlEncodeFormStable [("fullname", "Andres Löh")]
370+-- >>> urlEncodeForm [("fullname", "Andres Löh")]
565371-- "fullname=Andres%20L%C3%B6h"
566−urlEncodeFormStable :: Form -> BSL.ByteString
567−urlEncodeFormStable = urlEncodeParams . sortOn fst . toList
568−
569−-- | Encode a list of key-value pairs to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
570−--
571−-- See also 'urlEncodeFormStable'.
572−urlEncodeParams :: [(Text, Text)] -> BSL.ByteString
573−urlEncodeParams = toLazyByteString . mconcat . intersperse (shortByteString "&") . map encodePair
372+urlEncodeForm :: Form -> BSL.ByteString
373+urlEncodeForm = toLazyByteString . mconcat . intersperse (shortByteString "&") . map encodePair . toList
574374 where
575− escape = urlEncodeBuilder True . Text.encodeUtf8
375+ escape = urlEncodeQuery . Text.encodeUtf8
576376
577377 encodePair (k, "") = escape k
578− encodePair (k, v) = escape k <> shortByteString "=" <> escape v
378+ encodePair (k, v) = escape k <> shortByteString "=" <> escape v
379+
579380
580381-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a 'Form'.
581382--
@@ -609,17 +410,11 @@ urlEncodeParams = toLazyByteString . mconcat . intersperse (shortByteString "&")
609410-- >>> urlDecodeForm "this=has=too=many=equals"
610411-- Left "not a valid pair: this=has=too=many=equals"
611412urlDecodeForm :: BSL.ByteString -> Either Text Form
612−urlDecodeForm = fmap toForm . urlDecodeParams
613−
614−-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a list of key-value pairs.
615−--
616−-- See also 'urlDecodeForm'.
617−urlDecodeParams :: BSL.ByteString -> Either Text [(Text, Text)]
618−urlDecodeParams bs = traverse parsePair pairs
413+urlDecodeForm bs = toForm <$> traverse parsePair pairs
619414 where
620415 pairs = map (BSL8.split '=') (BSL8.split '&' bs)
621416
622− unescape = Text.decodeUtf8With lenientDecode . urlDecode True . BSL.toStrict
417+ unescape = Text.decodeUtf8With lenientDecode . urlDecodeQuery . BSL.toStrict
623418
624419 parsePair p =
625420 case map unescape p of
@@ -627,6 +422,7 @@ urlDecodeParams bs = traverse parsePair pairs
627422 [k] -> return (k, "")
628423 xs -> Left $ "not a valid pair: " <> Text.intercalate "=" xs
629424
425+data Proxy3 a b c = Proxy3
630426
631427-- | This is a convenience function for decoding a
632428-- @application/x-www-form-urlencoded@ 'BSL.ByteString' directly to a datatype
@@ -645,48 +441,21 @@ urlDecodeAsForm = fromForm <=< urlDecodeForm
645441--
646442-- This is effectively @'urlEncodeForm' . 'toForm'@.
647443--
648−-- _NOTE:_ this encoding is unstable and may result in different key order
649−-- (but not values). For a stable encoding see 'urlEncodeAsFormStable'.
444+-- >>> urlEncodeAsForm Person {name = "Dennis", age = 22}
445+-- "age=22&name=Dennis"
650446urlEncodeAsForm :: ToForm a => a -> BSL.ByteString
651447urlEncodeAsForm = urlEncodeForm . toForm
652448
653−-- | This is a convenience function for encoding a datatype that has instance
654−-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
655−-- 'BSL.ByteString'.
656−--
657−-- This is effectively @'urlEncodeFormStable' . 'toForm'@.
658−--
659−-- >>> urlEncodeAsFormStable Person {name = "Dennis", age = 22}
660−-- "age=22&name=Dennis"
661−urlEncodeAsFormStable :: ToForm a => a -> BSL.ByteString
662−urlEncodeAsFormStable = urlEncodeFormStable . toForm
663−
664449-- | Find all values corresponding to a given key in a 'Form'.
665450--
666−-- >>> lookupAll "name" []
451+-- >>> lookupKey "name" []
667452-- []
668−-- >>> lookupAll "name" [("name", "Oleg")]
453+-- >>> lookupKey "name" [("name", "Oleg")]
669454-- ["Oleg"]
670−-- >>> lookupAll "name" [("name", "Oleg"), ("name", "David")]
455+-- >>> lookupKey "name" [("name", "Oleg"), ("name", "David")]
671456-- ["Oleg","David"]
672−lookupAll :: Text -> Form -> [Text]
673−lookupAll key = F.concat . HashMap.lookup key . unForm
674−
675−-- | Lookup an optional value for a key.
676−-- Fail if there is more than one value.
677−--
678−-- >>> lookupMaybe "name" []
679−-- Right Nothing
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
687− [] -> pure Nothing
688− [v] -> pure (Just v)
689− _ -> Left $ "Duplicate key " <> Text.pack (show key)
457+lookupKey :: Text -> Form -> [Text]
458+lookupKey key = F.concat . HashMap.lookup key . unForm
690459
691460-- | Lookup a unique value for a key.
692461-- Fail if there is zero or more than one value.
@@ -698,43 +467,13 @@ lookupMaybe key form =
698467-- >>> lookupUnique "name" [("name", "Oleg"), ("name", "David")]
699468-- Left "Duplicate key \"name\""
700469lookupUnique :: Text -> Form -> Either Text Text
701−lookupUnique key form = do
702− mv <- lookupMaybe key form
703− case mv of
704− Just v -> pure v
705− Nothing -> Left $ "Could not find key " <> Text.pack (show key)
706−
707−-- | Lookup all values for a given key in a 'Form' and parse them with 'parseQueryParams'.
708−--
709−-- >>> parseAll "age" [] :: Either Text [Word8]
710−-- Right []
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]
716−-- Right [12,25]
717−parseAll :: FromHttpApiData v => Text -> Form -> Either Text [v]
718−parseAll key = parseQueryParams . lookupAll key
719−
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.
722−--
723−-- >>> parseMaybe "age" [] :: Either Text (Maybe Word8)
724−-- Right Nothing
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)
732−-- Right (Just 7)
733−parseMaybe :: FromHttpApiData v => Text -> Form -> Either Text (Maybe v)
734−parseMaybe key = parseQueryParams <=< lookupMaybe key
470+lookupUnique key form =
471+ case lookupKey key form of
472+ [v] -> pure v
473+ [] -> Left $ "Could not find key " <> Text.pack (show key)
474+ _ -> Left $ "Duplicate key " <> Text.pack (show key)
735475
736476-- | 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.
738477--
739478-- >>> parseUnique "age" [] :: Either Text Word8
740479-- Left "Could not find key \"age\""
@@ -749,48 +488,16 @@ parseMaybe key = parseQueryParams <=< lookupMaybe key
749488parseUnique :: FromHttpApiData v => Text -> Form -> Either Text v
750489parseUnique key form = lookupUnique key form >>= parseQueryParam
751490
752−-- | 'Generic'-based deriving options for 'ToForm' and 'FromForm'.
753−--
754−-- A common use case for non-default 'FormOptions'
755−-- is to strip a prefix off of field labels:
756−--
757−-- @
758−-- data Project = Project
759−-- { projectName :: String
760−-- , projectSize :: Int
761−-- } deriving ('Generic', 'Show')
762−--
763−-- myOptions :: 'FormOptions'
764−-- myOptions = 'FormOptions'
765−-- { 'fieldLabelModifier' = 'map' 'toLower' . 'drop' ('length' \"project\") }
766−--
767−-- instance 'ToForm' Project where
768−-- 'toForm' = 'genericToForm' myOptions
769−--
770−-- instance 'FromForm' Project where
771−-- 'fromForm' = 'genericFromForm' myOptions
772−-- @
773−--
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
781− }
782−
783−-- | Default encoding 'FormOptions'.
491+-- | Lookup all values for a given key in a 'Form' and parse them with 'parseQueryParams'.
784492--
785−-- @
786−-- 'FormOptions'
787−-- { 'fieldLabelModifier' = id
788−-- }
789−-- @
790−defaultFormOptions :: FormOptions
791−defaultFormOptions = FormOptions
792− { fieldLabelModifier = id
793− }
493+-- >>> parseAll "age" [] :: Either Text [Word8]
494+-- Right []
495+-- >>> parseAll "age" [("age", "8"), ("age", "seven")] :: Either Text [Word8]
496+-- Left "could not parse: `seven' (input does not start with a digit)"
497+-- >>> parseAll "age" [("age", "8"), ("age", "777")] :: Either Text [Word8]
498+-- Left "out of bounds: `777' (should be between 0 and 255)"
499+-- >>> parseAll "age" [("age", "12"), ("age", "25")] :: Either Text [Word8]
500+-- Right [12,25]
501+parseAll :: FromHttpApiData v => Text -> Form -> Either Text [v]
502+parseAll key = parseQueryParams . lookupKey key
794503
795−sortOn :: Ord b => (a -> b) -> [a] -> [a]
796−sortOn f = sortBy (comparing f)