]> gitweb @ CieloNegro.org - Lucu.git/blobdiff - Network/HTTP/Lucu/Utils.hs
Unfoldable Dispatcher
[Lucu.git] / Network / HTTP / Lucu / Utils.hs
index d92516ee15875a6791fc912b8d11ebe1eb765ffb..1070d66f28042193a0337b02f1e9d858d63c9403 100644 (file)
--- |Utility functions used internally in the Lucu httpd. These
--- functions may be useful too for something else.
+{-# LANGUAGE
+    FlexibleContexts
+  , OverloadedStrings
+  , UnicodeSyntax
+  #-}
+-- |Utility functions used internally in this package.
 module Network.HTTP.Lucu.Utils
     ( splitBy
-    , joinWith
-    , trim
-    , noCaseEq
-    , noCaseEq'
-    , isWhiteSpace
     , quoteStr
     , parseWWWFormURLEncoded
+    , uriPathSegments
+    , trim
+
+    , (⊲)
+    , (⊳)
+    , (⋈)
+    , mapM
+
+    , getLastModified
     )
     where
-
+import Control.Applicative hiding (empty)
+import Control.Monad hiding (mapM)
+import Data.Ascii (Ascii, AsciiBuilder)
+import qualified Data.Ascii as A
+import Data.ByteString (ByteString)
+import qualified Data.ByteString.Char8 as Strict
 import Data.Char
-import Data.List
+import Data.Collections
+import Data.Collections.BaseInstances ()
+import Data.Monoid.Unicode
+import Data.Ratio
+import Data.Time
+import Data.Time.Clock.POSIX
 import Network.URI
+import Prelude hiding (last, mapM, null, reverse)
+import Prelude.Unicode
+import System.Directory
+import System.Time (ClockTime(..))
 
--- |> splitBy (== ':') "ab:c:def"
---  > ==> ["ab", "c", "def"]
-splitBy :: (a -> Bool) -> [a] -> [[a]]
-splitBy isSeparator src
-    = isSeparator `seq`
-      case break isSeparator src
-      of (last , []      ) -> last  : []
-         (first, sep:rest) -> first : splitBy isSeparator rest
+-- |>>> splitBy (== ':') "ab:c:def"
+-- ["ab", "c", "def"]
+splitBy ∷ (a → Bool) → [a] → [[a]]
+{-# INLINEABLE splitBy #-}
+splitBy isSep src
+    = case break isSep src of
+        (last , []       ) → [last]
+        (first, _sep:rest) → first : splitBy isSep rest
 
--- |> joinWith ":" ["ab", "c", "def"]
---  > ==> "ab:c:def"
-joinWith :: [a] -> [[a]] -> [a]
-joinWith separator xs
-    = separator `seq` xs `seq`
-      foldr (++) [] $! intersperse separator xs
+-- |>>> quoteStr "abc"
+-- "\"abc\""
+--
+-- >>> quoteStr "ab\"c"
+-- "\"ab\\\"c\""
+quoteStr ∷ Ascii → AsciiBuilder
+quoteStr str = A.toAsciiBuilder "\"" ⊕
+               go (A.toByteString str) (∅) ⊕
+               A.toAsciiBuilder "\""
+    where
+      go ∷ Strict.ByteString → AsciiBuilder → AsciiBuilder
+      go bs ab
+          = case Strict.break (≡ '"') bs of
+              (x, y)
+                  | Strict.null y
+                      → ab ⊕ b2ab x
+                  | otherwise
+                      → go (Strict.tail y)
+                           (ab ⊕ b2ab x ⊕ A.toAsciiBuilder "\\\"")
+
+      b2ab ∷ Strict.ByteString → AsciiBuilder
+      b2ab = A.toAsciiBuilder ∘ A.unsafeFromByteString
 
--- |> trim (== '_') "__ab_c__def___"
---  > ==> "ab_c__def"
-trim :: (a -> Bool) -> [a] -> [a]
-trim p = p `seq` trimTail . trimHead
+-- |>>> parseWWWFormURLEncoded "aaa=bbb&ccc=ddd"
+-- [("aaa", "bbb"), ("ccc", "ddd")]
+parseWWWFormURLEncoded ∷ Ascii → [(ByteString, ByteString)]
+parseWWWFormURLEncoded src
+    -- THINKME: We could gain some performance by using attoparsec
+    -- here.
+    | src ≡ ""  = []
+    | otherwise = do pairStr ← splitBy (\ c → c ≡ ';' ∨ c ≡ '&') (A.toString src)
+                     let (key, value) = break (≡ '=') pairStr
+                     return ( unescape key
+                            , unescape $ case value of
+                                           ('=':val) → val
+                                           val       → val
+                            )
     where
-      trimHead = dropWhile p
-      trimTail = reverse . trimHead . reverse
+      unescape ∷ String → ByteString
+      unescape = Strict.pack ∘ unEscapeString ∘ (plusToSpace <$>)
 
--- |@'noCaseEq' a b@ is equivalent to @(map toLower a) == (map toLower
--- b)@. See 'noCaseEq''.
-noCaseEq :: String -> String -> Bool
-noCaseEq a b
-    = (map toLower a) == (map toLower b)
-{-# INLINE noCaseEq #-}
+      plusToSpace ∷ Char → Char
+      plusToSpace '+' = ' '
+      plusToSpace c   = c
 
--- |@'noCaseEq'' a b@ is a variant of 'noCaseEq' which first checks
--- the length of two strings to avoid possibly unnecessary comparison.
-noCaseEq' :: String -> String -> Bool
-noCaseEq' a b
-    | length a /= length b = False
-    | otherwise            = noCaseEq a b
-{-# INLINE noCaseEq' #-}
+-- |>>> uriPathSegments "http://example.com/foo/bar"
+-- ["foo", "bar"]
+uriPathSegments ∷ URI → [ByteString]
+uriPathSegments uri
+    = let reqPathStr = uriPath uri
+          reqPath    = [unEscapeString x | x ← splitBy (≡ '/') reqPathStr, (¬) (null x)]
+      in
+        Strict.pack <$> reqPath
 
--- |@'isWhiteSpace' c@ is True iff c is one of SP, HT, CR and LF.
-isWhiteSpace :: Char -> Bool
-isWhiteSpace ' '  = True
-isWhiteSpace '\t' = True
-isWhiteSpace '\r' = True
-isWhiteSpace '\n' = True
-isWhiteSpace _    = False
-{-# INLINE isWhiteSpace #-}
+-- |>>> trim "  ab c d "
+-- "ab c d"
+trim ∷ String → String
+trim = reverse ∘ f ∘ reverse ∘ f
+    where
+      f = dropWhile isSpace
 
--- |> quoteStr "abc"
---  > ==> "\"abc\""
+infixr 5 ⊲
+-- | (&#22B2;) = ('<|')
 --
---  > quoteStr "ab\"c"
---  > ==> "\"ab\\\"c\""
-quoteStr :: String -> String
-quoteStr str = str `seq`
-               foldr (++) "" (["\""] ++ map quote str ++ ["\""])
-    where
-      quote :: Char -> String
-      quote '"' = "\\\""
-      quote c   = [c]
+-- U+22B2, NORMAL SUBGROUP OF
+(⊲) ∷ Sequence α a ⇒ a → α → α
+(⊲) = (<|)
 
+infixl 5 ⊳
+-- | (&#22B3;) = ('|>')
+--
+-- U+22B3, CONTAINS AS NORMAL SUBGROUP
+(⊳) ∷ Sequence α a ⇒ α → a → α
+(⊳) = (|>)
 
--- |> parseWWWFormURLEncoded "aaa=bbb&ccc=ddd"
---  > ==> [("aaa", "bbb"), ("ccc", "ddd")]
-parseWWWFormURLEncoded :: String -> [(String, String)]
-parseWWWFormURLEncoded src
-    | src == "" = []
-    | otherwise = do pairStr <- splitBy (\ c -> c == ';' || c == '&') src
-                     let (key, value) = break (== '=') pairStr
-                     return ( unEscapeString key
-                            , unEscapeString $ case value of
-                                                 ('=':val) -> val
-                                                 ""        -> ""
-                            )
+infixr 5 ⋈
+-- | (&#22C8;) = ('><')
+--
+-- U+22C8, BOWTIE
+(⋈) ∷ Sequence α a ⇒ α → α → α
+(⋈) = (><)
+
+-- |Generalised @mapM@ from any 'Foldable' to 'Unfoldable'. Why isn't
+-- this in the @collections-api@?
+mapM ∷ (Foldable α a, Unfoldable β b, Functor m, Monad m)
+     ⇒ (a → m b) → α → m β
+{-# INLINE mapM #-}
+mapM = flip foldrM empty ∘ (flip ((<$>) ∘ flip insert) ∘)
+
+-- |Get the modification time of a given file.
+getLastModified ∷ FilePath → IO UTCTime
+getLastModified = (clockTimeToUTC <$>) ∘ getModificationTime
+    where
+      clockTimeToUTC ∷ ClockTime → UTCTime
+      clockTimeToUTC (TOD sec picoSec)
+          = posixSecondsToUTCTime ∘ fromRational
+            $ sec % 1 + picoSec % (1000 ⋅ 1000 ⋅ 1000 ⋅ 1000)