@@ -13,67 +13,70 @@
1313-- such as URL pieces, headers and query parameters.
1414module Web.Internal.HttpApiData where
1515
16−#if __GLASGOW_HASKELL__ < 710
17−import Control.Applicative
18−import Data.Foldable (Foldable)
19−import Data.Traversable (Traversable (traverse))
20−#endif
16+import Prelude ()
17+import Prelude.Compat
2118
2219import Control.Arrow (left, (&&&))
2320import Control.Monad ((<=<))
24−
21+import qualified Data.Attoparsec.Text as Atto
22+import qualified Data.Attoparsec.Time as Atto
2523import Data.ByteString (ByteString)
2624import qualified Data.ByteString as BS
25+import qualified Data.ByteString.Builder as BS
2726import qualified Data.ByteString.Lazy as LBS
28−import Data.Monoid
29−
27+import Data.Coerce (coerce)
28+import Data.Data (Data)
3029import qualified Data.Fixed as F
31−import Data.Int
32−import Data.Word
33−
30+import Data.Int (Int16, Int32, Int64, Int8)
31+import Data.Monoid (All (..), Any (..), Dual (..),
32+ First (..), Last (..),
33+ Product (..), Sum (..))
34+import Data.Semigroup (Semigroup (..))
35+import qualified Data.Semigroup as Semi
36+import Data.Tagged (Tagged (..))
3437import Data.Text (Text)
3538import qualified Data.Text as T
36−import Data.Text.Encoding (decodeUtf8With, decodeUtf8', encodeUtf8)
39+import Data.Text.Encoding (decodeUtf8', decodeUtf8With,
40+ encodeUtf8)
3741import Data.Text.Encoding.Error (lenientDecode)
3842import qualified Data.Text.Lazy as L
3943import Data.Text.Read (Reader, decimal, rational,
4044 signed)
41−
42−import Data.Time
43−#if __GLASGOW_HASKELL__ < 710
44−import Data.Time.Locale.Compat
45−#endif
46−import Data.Version
47−
48−#if MIN_VERSION_base(4,8,0)
49−import Data.Void
50−import Numeric.Natural
51−#endif
52−
45+import Data.Time (Day, FormatTime, LocalTime,
46+ NominalDiffTime, TimeOfDay,
47+ UTCTime, ZonedTime, formatTime)
48+import Data.Time.Locale.Compat (defaultTimeLocale,
49+ iso8601DateFormat)
50+import Data.Typeable (Typeable)
51+import qualified Data.UUID.Types as UUID
52+import Data.Version (Version, parseVersion,
53+ showVersion)
54+import Data.Void (Void, absurd)
55+import Data.Word (Word16, Word32, Word64, Word8)
56+import qualified Network.HTTP.Types as H
57+import Numeric.Natural (Natural)
5358import Text.ParserCombinators.ReadP (readP_to_S)
5459import Text.Read (readMaybe)
60+import Web.Cookie (SetCookie, parseSetCookie,
61+ renderSetCookie)
62+
63+#if MIN_VERSION_time(1,9,1)
64+import Data.Time (nominalDiffTimeToSeconds,
65+ secondsToNominalDiffTime)
66+#endif
5567
5668#if USE_TEXT_SHOW
5769import TextShow (TextShow, showt)
5870#endif
5971
60−import qualified Data.UUID.Types as UUID
6172
62−import qualified Data.ByteString.Builder as BS
63−import Data.Data (Data)
64−import Data.Typeable (Typeable)
65−import qualified Network.HTTP.Types as H
66−
67−import qualified Data.Attoparsec.Text as Atto
68−import qualified Data.Attoparsec.Time as Atto
69−
70−import Web.Cookie (SetCookie, parseSetCookie,
71− renderSetCookie)
7273
7374
7475-- $setup
7576-- >>> data BasicAuthToken = BasicAuthToken Text deriving (Show)
7677-- >>> instance FromHttpApiData BasicAuthToken where parseHeader h = BasicAuthToken <$> parseHeaderWithPrefix "Basic " h; parseQueryParam p = BasicAuthToken <$> parseQueryParam p
78+-- >>> import Data.Time
79+-- >>> import Data.Version
7780
7881-- | Convert value to HTTP API data.
7982--
@@ -432,10 +435,8 @@ instance ToHttpApiData Version where
432435 toUrlPiece = T.pack . showVersion
433436 toEncodedUrlPiece = unsafeToEncodedUrlPiece
434437
435−#if MIN_VERSION_base(4,8,0)
436438instance ToHttpApiData Void where toUrlPiece = absurd
437439instance ToHttpApiData Natural where toUrlPiece = showt; toEncodedUrlPiece = unsafeToEncodedUrlPiece
438−#endif
439440
440441instance ToHttpApiData Bool where toUrlPiece = showTextData; toEncodedUrlPiece = unsafeToEncodedUrlPiece
441442instance ToHttpApiData Ordering where toUrlPiece = showTextData; toEncodedUrlPiece = unsafeToEncodedUrlPiece
@@ -494,36 +495,77 @@ instance ToHttpApiData UTCTime where
494495 toUrlPiece = timeToUrlPiece "%H:%M:%S%QZ"
495496 toEncodedUrlPiece = unsafeToEncodedUrlPiece
496497
498+-- The CPP in both this function and the function after it are to avoid
499+-- exporting @nominalDiffTimeToSeconds@ and @secondsToNominalDiffTime@,
500+-- since these names are already used by @Data.Time@ from the @time@ library
501+-- starting in version @1.9.1@.
502+nominalDiffTimeToSecs :: NominalDiffTime -> F.Pico
503+nominalDiffTimeToSecs =
504+#if !MIN_VERSION_time(1,9,1)
505+ realToFrac
506+#else
507+ nominalDiffTimeToSeconds
508+#endif
509+
510+secsToNominalDiffTime :: F.Pico -> NominalDiffTime
511+secsToNominalDiffTime =
512+#if !MIN_VERSION_time(1,9,1)
513+ realToFrac
514+#else
515+ secondsToNominalDiffTime
516+#endif
517+
497518instance ToHttpApiData NominalDiffTime where
498− toUrlPiece = toUrlPiece . (floor :: NominalDiffTime -> Integer)
519+ toUrlPiece = toUrlPiece . nominalDiffTimeToSecs
499520 toEncodedUrlPiece = unsafeToEncodedUrlPiece
500521
501522instance ToHttpApiData String where toUrlPiece = T.pack
502523instance ToHttpApiData Text where toUrlPiece = id
503524instance ToHttpApiData L.Text where toUrlPiece = L.toStrict
504525
505−instance ToHttpApiData All where toUrlPiece = toUrlPiece . getAll; toEncodedUrlPiece = toEncodedUrlPiece . getAll
506−instance ToHttpApiData Any where toUrlPiece = toUrlPiece . getAny; toEncodedUrlPiece = toEncodedUrlPiece . getAny
526+instance ToHttpApiData All where
527+ toUrlPiece = coerce (toUrlPiece :: Bool -> Text)
528+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: Bool -> BS.Builder)
529+
530+instance ToHttpApiData Any where
531+ toUrlPiece = coerce (toUrlPiece :: Bool -> Text)
532+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: Bool -> BS.Builder)
507533
508534instance ToHttpApiData a => ToHttpApiData (Dual a) where
509− toUrlPiece = toUrlPiece . getDual
510− toEncodedUrlPiece = toEncodedUrlPiece . getDual
535+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
536+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
511537
512538instance ToHttpApiData a => ToHttpApiData (Sum a) where
513− toUrlPiece = toUrlPiece . getSum
514− toEncodedUrlPiece = toEncodedUrlPiece . getSum
539+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
540+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
515541
516542instance ToHttpApiData a => ToHttpApiData (Product a) where
517− toUrlPiece = toUrlPiece . getProduct
518− toEncodedUrlPiece = toEncodedUrlPiece . getProduct
543+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
544+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
519545
520546instance ToHttpApiData a => ToHttpApiData (First a) where
521− toUrlPiece = toUrlPiece . getFirst
522− toEncodedUrlPiece = toEncodedUrlPiece . getFirst
547+ toUrlPiece = coerce (toUrlPiece :: Maybe a -> Text)
548+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: Maybe a -> BS.Builder)
523549
524550instance ToHttpApiData a => ToHttpApiData (Last a) where
525− toUrlPiece = toUrlPiece . getLast
526− toEncodedUrlPiece = toEncodedUrlPiece . getLast
551+ toUrlPiece = coerce (toUrlPiece :: Maybe a -> Text)
552+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: Maybe a -> BS.Builder)
553+
554+instance ToHttpApiData a => ToHttpApiData (Semi.Min a) where
555+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
556+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
557+
558+instance ToHttpApiData a => ToHttpApiData (Semi.Max a) where
559+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
560+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
561+
562+instance ToHttpApiData a => ToHttpApiData (Semi.First a) where
563+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
564+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
565+
566+instance ToHttpApiData a => ToHttpApiData (Semi.Last a) where
567+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
568+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
527569
528570-- |
529571-- >>> toUrlPiece (Just "Hello")
@@ -555,6 +597,12 @@ instance ToHttpApiData SetCookie where
555597 toHeader = LBS.toStrict . BS.toLazyByteString . renderSetCookie
556598 -- toEncodedUrlPiece = renderSetCookie -- doesn't do things.
557599
600+instance ToHttpApiData a => ToHttpApiData (Tagged b a) where
601+ toUrlPiece = coerce (toUrlPiece :: a -> Text)
602+ toHeader = coerce (toHeader :: a -> ByteString)
603+ toQueryParam = coerce (toQueryParam :: a -> Text)
604+ toEncodedUrlPiece = coerce (toEncodedUrlPiece :: a -> BS.Builder)
605+
558606-- |
559607-- >>> parseUrlPiece "_" :: Either Text ()
560608-- Right ()
@@ -566,7 +614,7 @@ instance FromHttpApiData Char where
566614 parseUrlPiece s =
567615 case T.uncons s of
568616 Just (c, s') | T.null s' -> pure c
569− _ -> defaultParseError s
617+ _ -> defaultParseError s
570618
571619-- |
572620-- >>> showVersion <$> parseUrlPiece "1.2.3"
@@ -577,7 +625,6 @@ instance FromHttpApiData Version where
577625 ((x, ""):_) -> pure x
578626 _ -> defaultParseError s
579627
580−#if MIN_VERSION_base(4,8,0)
581628-- | Parsing a @'Void'@ value is always an error, considering @'Void'@ as a data type with no constructors.
582629instance FromHttpApiData Void where
583630 parseUrlPiece _ = Left "Void cannot be parsed!"
@@ -588,7 +635,6 @@ instance FromHttpApiData Natural where
588635 if n < 0
589636 then Left ("underflow: " <> s <> " (should be a non-negative integer)")
590637 else Right (fromInteger n)
591−#endif
592638
593639instance FromHttpApiData Bool where parseUrlPiece = parseBoundedUrlPiece
594640instance FromHttpApiData Ordering where parseUrlPiece = parseBoundedUrlPiece
@@ -640,16 +686,21 @@ instance FromHttpApiData ZonedTime where parseUrlPiece = runAtto Atto.zonedTime
640686-- Right 2015-10-03 00:14:24 UTC
641687instance FromHttpApiData UTCTime where parseUrlPiece = runAtto Atto.utcTime
642688
643−instance FromHttpApiData NominalDiffTime where parseUrlPiece = fmap fromInteger . parseUrlPiece
689+instance FromHttpApiData NominalDiffTime where parseUrlPiece = fmap secsToNominalDiffTime . parseUrlPiece
690+
691+instance FromHttpApiData All where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text Bool)
692+instance FromHttpApiData Any where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text Bool)
644693
645−instance FromHttpApiData All where parseUrlPiece = fmap All . parseUrlPiece
646−instance FromHttpApiData Any where parseUrlPiece = fmap Any . parseUrlPiece
694+instance FromHttpApiData a => FromHttpApiData (Dual a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
695+instance FromHttpApiData a => FromHttpApiData (Sum a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
696+instance FromHttpApiData a => FromHttpApiData (Product a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
697+instance FromHttpApiData a => FromHttpApiData (First a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text (Maybe a))
698+instance FromHttpApiData a => FromHttpApiData (Last a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text (Maybe a))
647699
648−instance FromHttpApiData a => FromHttpApiData (Dual a) where parseUrlPiece = fmap Dual . parseUrlPiece
649−instance FromHttpApiData a => FromHttpApiData (Sum a) where parseUrlPiece = fmap Sum . parseUrlPiece
650−instance FromHttpApiData a => FromHttpApiData (Product a) where parseUrlPiece = fmap Product . parseUrlPiece
651−instance FromHttpApiData a => FromHttpApiData (First a) where parseUrlPiece = fmap First . parseUrlPiece
652−instance FromHttpApiData a => FromHttpApiData (Last a) where parseUrlPiece = fmap Last . parseUrlPiece
700+instance FromHttpApiData a => FromHttpApiData (Semi.Min a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
701+instance FromHttpApiData a => FromHttpApiData (Semi.Max a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
702+instance FromHttpApiData a => FromHttpApiData (Semi.First a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
703+instance FromHttpApiData a => FromHttpApiData (Semi.Last a) where parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
653704
654705-- |
655706-- >>> parseUrlPiece "Just 123" :: Either Text (Maybe Int)
@@ -700,6 +751,11 @@ instance FromHttpApiData SetCookie where
700751 parseUrlPiece = parseHeader . encodeUtf8
701752 parseHeader = Right . parseSetCookie
702753
754+instance FromHttpApiData a => FromHttpApiData (Tagged b a) where
755+ parseUrlPiece = coerce (parseUrlPiece :: Text -> Either Text a)
756+ parseHeader = coerce (parseHeader :: ByteString -> Either Text a)
757+ parseQueryParam = coerce (parseQueryParam :: Text -> Either Text a)
758+
703759-------------------------------------------------------------------------------
704760-- Attoparsec helpers
705761-------------------------------------------------------------------------------
@@ -708,3 +764,5 @@ runAtto :: Atto.Parser a -> Text -> Either Text a
708764runAtto p t = case Atto.parseOnly (p <* Atto.endOfInput) t of
709765 Left err -> Left (T.pack err)
710766 Right x -> Right x
767+
768+