@@ -1,44 +1,67 @@
1+{-# LANGUAGE ConstraintKinds #-}
12{-# LANGUAGE CPP #-}
3+{-# LANGUAGE DataKinds #-}
24{-# LANGUAGE DefaultSignatures #-}
35{-# LANGUAGE DeriveGeneric #-}
46{-# LANGUAGE FlexibleContexts #-}
57{-# LANGUAGE FlexibleInstances #-}
68{-# LANGUAGE GeneralizedNewtypeDeriving #-}
79{-# LANGUAGE KindSignatures #-}
10+{-# LANGUAGE MultiParamTypeClasses #-}
811{-# LANGUAGE OverloadedStrings #-}
912{-# LANGUAGE PolyKinds #-}
1013{-# LANGUAGE ScopedTypeVariables #-}
1114{-# LANGUAGE TypeFamilies #-}
1215{-# LANGUAGE TypeOperators #-}
16+{-# LANGUAGE UndecidableInstances #-}
17+#include "overlapping-compat.h"
1318module Web.Internal.FormUrlEncoded where
1419
15−#if __GLASGOW_HASKELL__ < 710
16−import Control.Applicative
17−#endif
20+import Prelude ()
21+import Prelude.Compat
1822
23+import Control.Applicative (Const(Const))
24+import Control.Arrow ((***))
1925import Control.Monad ((<=<))
26+import Data.ByteString.Builder (shortByteString, toLazyByteString)
2027import qualified Data.ByteString.Lazy as BSL
2128import qualified Data.ByteString.Lazy.Char8 as BSL8
22−import Data.Int
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)
2339import Data.Map (Map)
2440import qualified Data.Map as Map
25−import Data.Monoid
26−
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 (..))
2748import Data.Text (Text)
2849import qualified Data.Text as Text
29−import qualified Data.Text.Lazy as Lazy
30−import Data.Text.Encoding as Text
50+import qualified Data.Text.Encoding as Text
3151import Data.Text.Encoding.Error (lenientDecode)
32−
33−import Data.Time
34−import Data.Word
35−
36−import GHC.Exts (IsList (..))
52+import 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 (..))
3760import GHC.Generics
38−import Network.URI (escapeURIString, isUnreserved,
39− unEscapeString)
40−
41−import Web.Internal.HttpApiData
61+import GHC.TypeLits
62+import Network.HTTP.Types.URI (urlDecode, urlEncodeBuilder)
63+import Numeric.Natural (Natural)
64+import Web.Internal.HttpApiData
4265
4366-- $setup
4467-- >>> :set -XDeriveGeneric
@@ -47,11 +70,20 @@ import Web.Internal.HttpApiData
4770-- >>> :set -XFlexibleContexts
4871-- >>> :set -XScopedTypeVariables
4972-- >>> :set -XTypeFamilies
50−-- >>> import Data.Either (isLeft)
51−-- >>> import Data.List (sort)
73+-- >>> import Data.Char (toLower)
74+--
5275-- >>> data Person = Person { name :: String, age :: Int } deriving (Show, Generic)
5376-- >>> instance ToForm Person
5477-- >>> 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
5587
5688-- | Typeclass for types that can be used as keys in a 'Form'-like container (like 'Map').
5789class ToFormKey k where
@@ -83,6 +115,9 @@ instance ToFormKey LocalTime where toFormKey = toQueryParam
83115instance ToFormKey ZonedTime where toFormKey = toQueryParam
84116instance ToFormKey UTCTime where toFormKey = toQueryParam
85117instance 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
86121
87122instance ToFormKey String where toFormKey = toQueryParam
88123instance ToFormKey Text where toFormKey = toQueryParam
@@ -91,9 +126,26 @@ instance ToFormKey Lazy.Text where toFormKey = toQueryParam
91126instance ToFormKey All where toFormKey = toQueryParam
92127instance ToFormKey Any where toFormKey = toQueryParam
93128
94−instance ToFormKey a => ToFormKey (Dual a) where toFormKey = toFormKey . getDual
95−instance ToFormKey a => ToFormKey (Sum a) where toFormKey = toFormKey . getSum
96−instance ToFormKey a => ToFormKey (Product a) where toFormKey = toFormKey . getProduct
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)
146+
147+instance ToFormKey Void where toFormKey = toQueryParam
148+instance ToFormKey Natural where toFormKey = toQueryParam
97149
98150-- | Typeclass for types that can be parsed from keys of a 'Form'. This is the reverse of 'ToFormKey'.
99151class FromFormKey k where
@@ -125,6 +177,9 @@ instance FromFormKey LocalTime where parseFormKey = parseQueryParam
125177instance FromFormKey ZonedTime where parseFormKey = parseQueryParam
126178instance FromFormKey UTCTime where parseFormKey = parseQueryParam
127179instance 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
128183
129184instance FromFormKey String where parseFormKey = parseQueryParam
130185instance FromFormKey Text where parseFormKey = parseQueryParam
@@ -133,24 +188,47 @@ instance FromFormKey Lazy.Text where parseFormKey = parseQueryParam
133188instance FromFormKey All where parseFormKey = parseQueryParam
134189instance FromFormKey Any where parseFormKey = parseQueryParam
135190
136−instance FromFormKey a => FromFormKey (Dual a) where parseFormKey = fmap Dual . parseFormKey
137−instance FromFormKey a => FromFormKey (Sum a) where parseFormKey = fmap Sum . parseFormKey
138−instance FromFormKey a => FromFormKey (Product a) where parseFormKey = fmap Product . parseFormKey
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)
208+
209+instance FromFormKey Void where parseFormKey = parseQueryParam
210+instance FromFormKey Natural where parseFormKey = parseQueryParam
139211
140212-- | The contents of a form, not yet URL-encoded.
141213--
142−-- 'Form' can be URL-encoded with 'encodeForm' and URL-decoded with 'decodeForm'.
143−newtype Form = Form { unForm :: Map Text [Text] }
144− deriving (Eq, Read, Generic, Monoid)
214+-- 'Form' can be URL-encoded with 'urlEncodeForm' and URL-decoded with 'urlDecodeForm'.
215+newtype Form = Form { unForm :: HashMap Text [Text] }
216+ deriving (Eq, Read, Generic, Semigroup, Monoid)
145217
146218instance Show Form where
147219 showsPrec d form = showParen (d > 10) $
148− showString "fromList " . shows (toList form)
220+ showString "fromList " . shows (toListStable form)
149221
222+-- | _NOTE:_ 'toList' is unstable and may result in different key order (but not values).
223+-- For a stable conversion use 'toListStable'.
150224instance IsList Form where
151225 type Item Form = (Text, Text)
152− fromList = Form . Map.fromListWith (flip (<>)) . fmap (\(k, v) -> (k, [v]))
153− toList = concatMap (\(k, vs) -> map ((,) k) vs) . Map.toList . unForm
226+ fromList = Form . HashMap.fromListWith (flip (<>)) . fmap (\(k, v) -> (k, [v]))
227+ toList = concatMap (\(k, vs) -> map ((,) k) vs) . HashMap.toList . unForm
228+
229+-- | A stable version of 'toList'.
230+toListStable :: Form -> [(Text, Text)]
231+toListStable = sortOn fst . toList
154232
155233-- | Convert a value into 'Form'.
156234--
@@ -187,42 +265,122 @@ instance IsList Form where
187265-- instance 'ToForm' Person
188266-- @
189267--
190−-- The default implementation will use 'toQueryParam' for each field's value.
268+-- The default implementation of 'toForm' is 'genericToForm'.
191269class ToForm a where
192270 -- | Convert a value into 'Form'.
193271 toForm :: a -> Form
194− default toForm :: (Generic a, GToForm (Rep a)) => a -> Form
195− toForm = genericToForm
272+ default toForm :: (Generic a, GToForm a (Rep a)) => a -> Form
273+ toForm = genericToForm defaultFormOptions
196274
197−instance ToForm [(Text, Text)] where toForm = fromList
198−instance ToForm (Map Text [Text]) where toForm = Form . Map.filter (not . null)
199275instance ToForm Form where toForm = id
200276
277+instance (ToFormKey k, ToHttpApiData v) => ToForm [(k, v)] where
278+ toForm = fromList . map (toFormKey *** toQueryParam)
279+
280+instance (ToFormKey k, ToHttpApiData v) => ToForm (Map k [v]) where
281+ toForm = fromEntriesByKey . Map.toList
282+
283+instance (ToFormKey k, ToHttpApiData v) => ToForm (HashMap k [v]) where
284+ toForm = fromEntriesByKey . HashMap.toList
285+
286+instance ToHttpApiData v => ToForm (IntMap [v]) where
287+ toForm = fromEntriesByKey . IntMap.toList
288+
289+-- | 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")]
293+fromEntriesByKey :: (ToFormKey k, ToHttpApiData v) => [(k, [v])] -> Form
294+fromEntriesByKey = Form . HashMap.fromListWith (<>) . map (toFormKey *** map toQueryParam)
295+
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+
201310-- | A 'Generic'-based implementation of 'toForm'.
202311-- This is used as a default implementation in 'ToForm'.
203−genericToForm :: (Generic a, GToForm (Rep a)) => a -> Form
204−genericToForm = gToForm . from
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
205347
206−class GToForm (f :: * -> *) where
207− gToForm :: f x -> Form
348+class GToForm t (f :: * -> *) where
349+ gToForm :: Proxy t -> FormOptions -> f x -> Form
208350
209−instance (GToForm f, GToForm g) => GToForm (f :*: g) where
210− gToForm (a :*: b) = gToForm a <> gToForm b
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
211353
212−instance (GToForm f, GToForm g) => GToForm (f :+: g) where
213− gToForm (L1 a) = gToForm a
214− gToForm (R1 a) = gToForm a
354+instance (GToForm t f) => GToForm t (M1 D x f) where
355+ gToForm p opts (M1 a) = gToForm p opts a
356+
357+instance (GToForm t f) => GToForm t (M1 C x f) where
358+ gToForm p opts (M1 a) = gToForm p opts a
359+
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)]
362+ where
363+ key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
215364
216−instance (GToForm f) => GToForm (M1 D x f) where
217− gToForm (M1 a) = gToForm a
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)
218372
219−instance (GToForm f) => GToForm (M1 C x f) where
220− gToForm (M1 a) = gToForm a
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)
221377
222−instance (Selector s, ToHttpApiData c) => GToForm (M1 S s (K1 i c)) where
223− gToForm (M1 (K1 c)) = fromList [(key, toQueryParam c)]
378+instance OVERLAPPING_ (Selector s) => GToForm t (M1 S s (K1 i String)) where
379+ gToForm _ opts (M1 (K1 c)) = fromList [(key, toQueryParam c)]
224380 where
225− key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
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"
226384
227385-- | Parse 'Form' into a value.
228386--
@@ -234,9 +392,9 @@ instance (Selector s, ToHttpApiData c) => GToForm (M1 S s (K1 i c)) where
234392-- , age :: Int }
235393--
236394-- instance 'FromForm' Person where
237−-- 'fromForm' (Form m) = Person
238−-- '\<$\>' maybe (Left "key \"name\" not found") 'parseQueryParam' (lookup "name" m)
239−-- '\<*\>' maybe (Left "key \"age\" not found") 'parseQueryParam' (lookup "name" m)
395+-- 'fromForm' f = Person
396+-- '<$>' 'parseUnique' "name" f
397+-- '<*>' 'parseUnique' "age" f
240398-- @
241399--
242400-- Instead of manually writing @'FromForm'@ instances you can
@@ -257,154 +415,382 @@ instance (Selector s, ToHttpApiData c) => GToForm (M1 S s (K1 i c)) where
257415-- instance 'FromForm' Person
258416-- @
259417--
260−-- The default implementation will use 'parseQueryParam' for each field's value.
418+-- The default implementation of 'fromForm' is 'genericFromForm'.
419+-- It only works for records and it will use 'parseQueryParam' for each field's value.
261420class FromForm a where
262421 -- | Parse 'Form' into a value.
263422 fromForm :: Form -> Either Text a
264− default fromForm :: (Generic a, GFromForm (Rep a))
265− => Form -> Either Text a
266− fromForm = genericFromForm
423+ default fromForm :: (Generic a, GFromForm a (Rep a)) => Form -> Either Text a
424+ fromForm = genericFromForm defaultFormOptions
425+
426+instance FromForm Form where fromForm = pure
427+
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
431+
432+instance (Ord k, FromFormKey k, FromHttpApiData v) => FromForm (Map k [v]) where
433+ fromForm = fmap (Map.fromListWith (<>)) . toEntriesByKey
434+
435+instance (Eq k, Hashable k, FromFormKey k, FromHttpApiData v) => FromForm (HashMap k [v]) where
436+ fromForm = fmap (HashMap.fromListWith (<>)) . toEntriesByKey
267437
268−instance FromForm Form where fromForm = return
269−instance FromForm (Map Text [Text]) where fromForm = return . unForm
270−instance FromForm [(Text, Text)] where fromForm = return . toList
438+instance FromHttpApiData v => FromForm (IntMap [v]) where
439+ fromForm = fmap (IntMap.fromListWith (<>)) . toEntriesByKey
440+
441+-- | 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'.
445+toEntriesByKey :: (FromFormKey k, FromHttpApiData v) => Form -> Either Text [(k, [v])]
446+toEntriesByKey = traverse parseGroup . HashMap.toList . unForm
447+ where
448+ parseGroup (k, vs) = (,) <$> parseFormKey k <*> traverse parseQueryParam vs
449+
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
271458
272459-- | A 'Generic'-based implementation of 'fromForm'.
273460-- This is used as a default implementation in 'FromForm'.
274−genericFromForm :: (Generic a, GFromForm (Rep a))
275− => Form -> Either Text a
276−genericFromForm f = to <$> gFromForm f
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)
277498
278−class GFromForm (f :: * -> *) where
279− gFromForm :: 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
280501
281−instance (GFromForm f, GFromForm g) => GFromForm (f :*: g) where
282− gFromForm f = (:*:) <$> gFromForm f <*> gFromForm f
502+instance GFromForm t f => GFromForm t (M1 D x f) where
503+ gFromForm p opts f = M1 <$> gFromForm p opts f
283504
284−instance (GFromForm f, GFromForm g) => GFromForm (f :+: g) where
285− gFromForm f
286− = fmap L1 (gFromForm f)
287− <!> fmap R1 (gFromForm f)
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
288510 where
289− Left _ <!> y = y
290− x <!> _ = x
291−
292−instance (Selector s, FromHttpApiData f) => GFromForm (M1 S s (K1 i f)) where
293− gFromForm f =
294− case concat (Map.lookup key (unForm f)) of
295− [v] -> M1 . K1 <$> parseQueryParam v
296− [] -> Left $ "Could not find key " <> Text.pack (show key)
297− _ -> Left $ "Duplicate key " <> Text.pack (show key)
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
298515 where
299− key = Text.pack $ selName (Proxy3 :: Proxy3 s g p)
516+ key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
300517
301−instance (GFromForm f) => GFromForm (M1 D x f) where
302− gFromForm f = M1 <$> gFromForm f
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)
522+
523+instance OVERLAPPING_ (Selector s) => GFromForm t (M1 S s (K1 i String)) where
524+ gFromForm _ opts form = M1 . K1 <$> parseUnique key form
525+ where
526+ key = Text.pack $ fieldLabelModifier opts $ selName (Proxy3 :: Proxy3 s g p)
303527
304−instance (GFromForm f) => GFromForm (M1 C x f) where
305− gFromForm f = M1 <$> gFromForm f
528+instance NotSupported FromForm t "is a sum type" => GFromForm t (f :+: g) where gFromForm = error "impossible"
306529
307530-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
308531--
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
536+
537+-- | Encode a 'Form' to an @application/x-www-form-urlencoded@ 'BSL.ByteString'.
538+--
539+-- For an unstable (but faster) encoding see 'urlEncodeForm'.
540+--
309541-- Key-value pairs get encoded to @key=value@ and separated by @&@:
310542--
311−-- >>> encodeForm [("name", "Julian"), ("lastname", "Arni")]
543+-- >>> urlEncodeFormStable [("name", "Julian"), ("lastname", "Arni")]
312544-- "lastname=Arni&name=Julian"
313545--
314546-- Keys with empty values get encoded to just @key@ (without the @=@ sign):
315547--
316−-- >>> encodeForm [("is_test", "")]
548+-- >>> urlEncodeFormStable [("is_test", "")]
317549-- "is_test"
318550--
319551-- Empty keys are allowed too:
320552--
321−-- >>> encodeForm [("", "foobar")]
553+-- >>> urlEncodeFormStable [("", "foobar")]
322554-- "=foobar"
323555--
324−-- However, if not key and value are empty, the key-value pair is ignored.
325−-- (This prevents @'decodeForm' . 'encodeForm'@ from being a true isomorphism).
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).
326558--
327−-- >>> encodeForm [("", "")]
559+-- >>> urlEncodeFormStable [("", "")]
328560-- ""
329561--
330562-- Everything is escaped with @'escapeURIString' 'isUnreserved'@:
331563--
332−-- >>> encodeForm [("fullname", "Andres Löh")]
564+-- >>> urlEncodeFormStable [("fullname", "Andres Löh")]
333565-- "fullname=Andres%20L%C3%B6h"
334−encodeForm :: Form -> BSL.ByteString
335−encodeForm xs = BSL.intercalate "&" $ map (BSL.fromStrict . encodePair) $ toList xs
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
336574 where
337− escape = Text.encodeUtf8 . Text.pack . escapeURIString isUnreserved . Text.unpack
575+ escape = urlEncodeBuilder True . Text.encodeUtf8
338576
339577 encodePair (k, "") = escape k
340− encodePair (k, v) = escape k <> "=" <> escape v
341−
578+ encodePair (k, v) = escape k <> shortByteString "=" <> escape v
342579
343580-- | Decode an @application/x-www-form-urlencoded@ 'BSL.ByteString' to a 'Form'.
344581--
345582-- Key-value pairs get decoded normally:
346583--
347−-- >>> decodeForm "name=Greg&lastname=Weber"
584+-- >>> urlDecodeForm "name=Greg&lastname=Weber"
348585-- Right (fromList [("lastname","Weber"),("name","Greg")])
349586--
350587-- Keys with no values get decoded to pairs with empty values.
351588--
352−-- >>> decodeForm "is_test"
589+-- >>> urlDecodeForm "is_test"
353590-- Right (fromList [("is_test","")])
354591--
355592-- Empty keys are allowed:
356593--
357−-- >>> decodeForm "=foobar"
594+-- >>> urlDecodeForm "=foobar"
358595-- Right (fromList [("","foobar")])
359596--
360597-- The empty string gets decoded into an empty 'Form':
361598--
362−-- >>> decodeForm ""
599+-- >>> urlDecodeForm ""
363600-- Right (fromList [])
364601--
365602-- Everything is un-escaped with 'unEscapeString':
366603--
367−-- >>> decodeForm "fullname=Andres%20L%C3%B6h"
604+-- >>> urlDecodeForm "fullname=Andres%20L%C3%B6h"
368605-- Right (fromList [("fullname","Andres L\246h")])
369606--
370607-- Improperly formed strings result in an error:
371608--
372−-- >>> decodeForm "this=has=too=many=equals"
609+-- >>> urlDecodeForm "this=has=too=many=equals"
373610-- Left "not a valid pair: this=has=too=many=equals"
374−decodeForm :: BSL.ByteString -> Either Text Form
375−decodeForm bs = toForm <$> traverse parsePair pairs
611+urlDecodeForm :: 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
376619 where
377− pairs = map (Text.decodeUtf8With lenientDecode . BSL.toStrict) (BSL8.split '&' bs)
620+ pairs = map (BSL8.split '=') (BSL8.split '&' bs)
378621
379− unescape = Text.pack . unEscapeString . Text.unpack . Text.replace "+" "%20"
622+ unescape = Text.decodeUtf8With lenientDecode . urlDecode True . BSL.toStrict
380623
381− parsePair :: Text -> Either Text (Text, Text)
382624 parsePair p =
383− case Text.splitOn "=" p of
384− [k, v] -> return (unescape k, unescape v)
385− [k] -> return (unescape k, "" )
386− _ -> Left $ "not a valid pair: " <> p
625+ case map unescape p of
626+ [k, v] -> return (k, v)
627+ [k] -> return (k, "")
628+ xs -> Left $ "not a valid pair: " <> Text.intercalate "=" xs
387629
388−data Proxy3 a b c = Proxy3
389630
390631-- | This is a convenience function for decoding a
391632-- @application/x-www-form-urlencoded@ 'BSL.ByteString' directly to a datatype
392633-- that has an instance of 'FromForm'.
393634--
394−-- This is effectively @'fromForm' '<=<' 'decodeForm'@.
635+-- This is effectively @'fromForm' '<=<' 'urlDecodeForm'@.
395636--
396−-- >>> decodeAsForm "name=Dennis&age=22" :: Either Text Person
637+-- >>> urlDecodeAsForm "name=Dennis&age=22" :: Either Text Person
397638-- Right (Person {name = "Dennis", age = 22})
398−decodeAsForm :: FromForm a => BSL.ByteString -> Either Text a
399−decodeAsForm = fromForm <=< decodeForm
639+urlDecodeAsForm :: FromForm a => BSL.ByteString -> Either Text a
640+urlDecodeAsForm = fromForm <=< urlDecodeForm
641+
642+-- | This is a convenience function for encoding a datatype that has instance
643+-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
644+-- 'BSL.ByteString'.
645+--
646+-- This is effectively @'urlEncodeForm' . 'toForm'@.
647+--
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
400652
401653-- | This is a convenience function for encoding a datatype that has instance
402654-- of 'ToForm' directly to a @application/x-www-form-urlencoded@
403655-- 'BSL.ByteString'.
404656--
405−-- This is effectively @'encodeForm' . 'toForm'@.
657+-- This is effectively @'urlEncodeFormStable' . 'toForm'@.
406658--
407−-- >>> encodeAsForm Person {name = "Dennis", age = 22}
659+-- >>> urlEncodeAsFormStable Person {name = "Dennis", age = 22}
408660-- "age=22&name=Dennis"
409−encodeAsForm :: ToForm a => a -> BSL.ByteString
410−encodeAsForm = encodeForm . toForm
661+urlEncodeAsFormStable :: ToForm a => a -> BSL.ByteString
662+urlEncodeAsFormStable = urlEncodeFormStable . toForm
663+
664+-- | Find all values corresponding to a given key in a 'Form'.
665+--
666+-- >>> lookupAll "name" []
667+-- []
668+-- >>> lookupAll "name" [("name", "Oleg")]
669+-- ["Oleg"]
670+-- >>> lookupAll "name" [("name", "Oleg"), ("name", "David")]
671+-- ["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)
690+
691+-- | Lookup a unique value for a key.
692+-- Fail if there is zero or more than one value.
693+--
694+-- >>> lookupUnique "name" []
695+-- Left "Could not find key \"name\""
696+-- >>> lookupUnique "name" [("name", "Oleg")]
697+-- Right "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
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
735+
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.
738+--
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
748+-- Right 7
749+parseUnique :: FromHttpApiData v => Text -> Form -> Either Text v
750+parseUnique key form = lookupUnique key form >>= parseQueryParam
751+
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'.
784+--
785+-- @
786+-- 'FormOptions'
787+-- { 'fieldLabelModifier' = id
788+-- }
789+-- @
790+defaultFormOptions :: FormOptions
791+defaultFormOptions = FormOptions
792+ { fieldLabelModifier = id
793+ }
794+
795+sortOn :: Ord b => (a -> b) -> [a] -> [a]
796+sortOn f = sortBy (comparing f)