X-Git-Url: http://git.cielonegro.org/gitweb.cgi?a=blobdiff_plain;f=Network%2FHTTP%2FLucu%2FResource%2FTree.hs;h=11d5b2b471c8fa6435dd3e8692c0896e5df010d6;hb=895341e;hp=660d8ff735bdc3f2fab18f7d42ab8a1f8951a091;hpb=195fd2318fb0ad21c2fd60f61e7df72a8f25d12c;p=Lucu.git diff --git a/Network/HTTP/Lucu/Resource/Tree.hs b/Network/HTTP/Lucu/Resource/Tree.hs index 660d8ff..11d5b2b 100644 --- a/Network/HTTP/Lucu/Resource/Tree.hs +++ b/Network/HTTP/Lucu/Resource/Tree.hs @@ -1,4 +1,9 @@ -{-# OPTIONS_HADDOCK prune #-} +{-# LANGUAGE + DoAndIfThenElse + , OverloadedStrings + , RecordWildCards + , UnicodeSyntax + #-} -- | Repository of the resources in httpd. module Network.HTTP.Lucu.Resource.Tree @@ -8,25 +13,31 @@ module Network.HTTP.Lucu.Resource.Tree , ResTree , FallbackHandler - , mkResTree -- [ ([String], ResourceDef) ] -> ResTree + , mkResTree - , findResource -- ResTree -> URI -> Maybe ([String], ResourceDef) - , runResource -- ResourceDef -> Interaction -> IO ThreadId + , findResource + , runResource ) where - +import Control.Arrow +import Control.Applicative +import Data.Ascii (Ascii) +import qualified Data.Ascii as A import Control.Concurrent import Control.Concurrent.STM import Control.Exception import Control.Monad -import qualified Data.ByteString.Char8 as C8 +import Data.Text (Text) +import qualified Data.Text as T +import qualified Data.Text.Lazy.Encoding as LT import Data.List import qualified Data.Map as M import Data.Map (Map) import Data.Maybe +import Data.Monoid.Unicode import Network.HTTP.Lucu.Abortion import Network.HTTP.Lucu.Config -import Network.HTTP.Lucu.Headers (emptyHeaders, fromHeaders) +import Network.HTTP.Lucu.Headers (fromHeaders) import Network.HTTP.Lucu.Request import Network.HTTP.Lucu.Resource import Network.HTTP.Lucu.Response @@ -35,15 +46,15 @@ import Network.HTTP.Lucu.Utils import Network.URI hiding (path) import System.IO import Prelude hiding (catch) +import Prelude.Unicode -- |'FallbackHandler' is an extra resource handler for resources which --- can't be statically located somewhere in the resource tree. The --- Lucu httpd first search for a resource in the tree, and then call +-- can't be statically located anywhere in the resource tree. The Lucu +-- httpd first searches for a resource in the tree, and then calls -- fallback handlers to ask them for a resource. If all of the --- handlers returned 'Prelude.Nothing', the httpd responds with 404 --- Not Found. -type FallbackHandler = [String] -> IO (Maybe ResourceDef) +-- handlers returned 'Nothing', the httpd responds with 404 Not Found. +type FallbackHandler = [Text] → IO (Maybe ResourceDef) -- "/aaa/bbb/ccc" にアクセスされた時、もし "/aaa/bbb" に貪欲なリソース @@ -51,15 +62,14 @@ type FallbackHandler = [String] -> IO (Maybe ResourceDef) -- "/aaa/bbb" が撰ばれる。"/aaa/bbb" のリソースが貪欲でなければ、それは -- 無視される。 --- | 'ResourceDef' is basically a set of --- 'Network.HTTP.Lucu.Resource.Resource' monads for each HTTP methods. +-- | 'ResourceDef' is basically a set of 'Resource' monads for each +-- HTTP methods. data ResourceDef = ResourceDef { - -- |Whether to run a 'Network.HTTP.Lucu.Resource.Resource' on a - -- native thread (spawned by 'Control.Concurrent.forkOS') or to - -- run it on a user thread (spanwed by - -- 'Control.Concurrent.forkIO'). Generally you don't need to set - -- this field to 'Prelude.True'. - resUsesNativeThread :: !Bool + -- |Whether to run a 'Resource' on a native thread (spawned by + -- 'forkOS') or to run it on a user thread (spanwed by + -- 'forkIO'). Generally you don't need to set this field to + -- 'True'. + resUsesNativeThread ∷ !Bool -- | Whether to be greedy or not. -- -- Say a client is trying to access \/aaa\/bbb\/ccc. If there is a @@ -67,37 +77,32 @@ data ResourceDef = ResourceDef { -- there is another resource at \/aaa\/bbb\/ccc. If the resource -- at \/aaa\/bbb is not greedy, it is just ignored. Greedy -- resources are like CGI scripts. - , resIsGreedy :: !Bool - -- | A 'Network.HTTP.Lucu.Resource.Resource' to be run when a GET - -- request comes for the resource path. If 'resGet' is Nothing, - -- the system responds \"405 Method Not Allowed\" for GET - -- requests. + , resIsGreedy ∷ !Bool + -- | A 'Resource' to be run when a GET request comes for the + -- resource path. If 'resGet' is Nothing, the system responds + -- \"405 Method Not Allowed\" for GET requests. -- -- It also runs for HEAD request if the 'resHead' is Nothing. In - -- this case 'Network.HTTP.Lucu.Resource.output' and such like - -- don't actually write a response body. - , resGet :: !(Maybe (Resource ())) - -- | A 'Network.HTTP.Lucu.Resource.Resource' to be run when a HEAD - -- request comes for the resource path. If 'resHead' is Nothing, - -- the system runs 'resGet' instead. If 'resGet' is also Nothing, - -- the system responds \"405 Method Not Allowed\" for HEAD - -- requests. - , resHead :: !(Maybe (Resource ())) - -- | A 'Network.HTTP.Lucu.Resource.Resource' to be run when a POST - -- request comes for the resource path. If 'resPost' is Nothing, - -- the system responds \"405 Method Not Allowed\" for POST - -- requests. - , resPost :: !(Maybe (Resource ())) - -- | A 'Network.HTTP.Lucu.Resource.Resource' to be run when a PUT - -- request comes for the resource path. If 'resPut' is Nothing, - -- the system responds \"405 Method Not Allowed\" for PUT - -- requests. - , resPut :: !(Maybe (Resource ())) - -- | A 'Network.HTTP.Lucu.Resource.Resource' to be run when a - -- DELETE request comes for the resource path. If 'resDelete' is - -- Nothing, the system responds \"405 Method Not Allowed\" for - -- DELETE requests. - , resDelete :: !(Maybe (Resource ())) + -- this case 'output' and such like don't actually write a + -- response body. + , resGet ∷ !(Maybe (Resource ())) + -- | A 'Resource' to be run when a HEAD request comes for the + -- resource path. If 'resHead' is Nothing, the system runs + -- 'resGet' instead. If 'resGet' is also Nothing, the system + -- responds \"405 Method Not Allowed\" for HEAD requests. + , resHead ∷ !(Maybe (Resource ())) + -- | A 'Resource' to be run when a POST request comes for the + -- resource path. If 'resPost' is Nothing, the system responds + -- \"405 Method Not Allowed\" for POST requests. + , resPost ∷ !(Maybe (Resource ())) + -- | A 'Resource' to be run when a PUT request comes for the + -- resource path. If 'resPut' is Nothing, the system responds + -- \"405 Method Not Allowed\" for PUT requests. + , resPut ∷ !(Maybe (Resource ())) + -- | A 'Resource' to be run when a DELETE request comes for the + -- resource path. If 'resDelete' is Nothing, the system responds + -- \"405 Method Not Allowed\" for DELETE requests. + , resDelete ∷ !(Maybe (Resource ())) } -- |'emptyResource' is a resource definition with no actual @@ -115,7 +120,7 @@ data ResourceDef = ResourceDef { -- , resDelete = Nothing -- } -- @ -emptyResource :: ResourceDef +emptyResource ∷ ResourceDef emptyResource = ResourceDef { resUsesNativeThread = False , resIsGreedy = False @@ -129,7 +134,7 @@ emptyResource = ResourceDef { -- |'ResTree' is an opaque structure which is a map from resource path -- to 'ResourceDef'. newtype ResTree = ResTree ResNode -- root だから Map ではない -type ResSubtree = Map String ResNode +type ResSubtree = Map Text ResNode data ResNode = ResNode (Maybe ResourceDef) ResSubtree -- |'mkResTree' converts a list of @(path, def)@ to a 'ResTree' e.g. @@ -139,18 +144,18 @@ data ResNode = ResNode (Maybe ResourceDef) ResSubtree -- , ([\"unistd\"], 'Network.HTTP.Lucu.StaticFile.staticFile' \"\/usr\/include\/unistd.h\") -- \/unistd -- ] -- @ -mkResTree :: [ ([String], ResourceDef) ] -> ResTree -mkResTree = processRoot . mapFirst canonicalisePath +-- +-- Note that the request path in an incoming HTTP request is always +-- treated as an URI-encoded UTF-8 string. +mkResTree ∷ [ ([Text], ResourceDef) ] → ResTree +mkResTree = processRoot ∘ map (first canonicalisePath) where - mapFirst :: (a -> a') -> [(a, b)] -> [(a', b)] - mapFirst f = map (\ (a, b) -> (f a, b)) - - canonicalisePath :: [String] -> [String] - canonicalisePath = filter (\ x -> x /= "") + canonicalisePath ∷ [Text] → [Text] + canonicalisePath = filter (≢ "") - processRoot :: [ ([String], ResourceDef) ] -> ResTree + processRoot ∷ [ ([Text], ResourceDef) ] → ResTree processRoot list - = let (roots, nonRoots) = partition (\ (path, _) -> path == []) list + = let (roots, nonRoots) = partition (\(path, _) → null path) list children = processNonRoot nonRoots in if null roots then @@ -163,12 +168,12 @@ mkResTree = processRoot . mapFirst canonicalisePath in ResTree (ResNode (Just def) children) - processNonRoot :: [ ([String], ResourceDef) ] -> ResSubtree + processNonRoot ∷ [ ([Text], ResourceDef) ] → ResSubtree processNonRoot list = let subtree = M.fromList [(name, node name) - | name <- childNames] - childNames = [name | (name:_, _) <- list] - node name = let defs = [def | (path, def) <- list, path == [name]] + | name ← childNames] + childNames = [name | (name:_, _) ← list] + node name = let defs = [def | (path, def) ← list, path ≡ [name]] in if null defs then -- No resources are defined @@ -179,89 +184,85 @@ mkResTree = processRoot . mapFirst canonicalisePath -- There is a resource here. ResNode (Just $ last defs) children children = processNonRoot [(path, def) - | (_:path, def) <- list] + | (_:path, def) ← list] in subtree - -findResource :: ResTree -> [FallbackHandler] -> URI -> IO (Maybe ([String], ResourceDef)) +findResource ∷ ResTree → [FallbackHandler] → URI → IO (Maybe ([Text], ResourceDef)) findResource (ResTree (ResNode rootDefM subtree)) fbs uri - = do let pathStr = uriPath uri - path = [unEscapeString x | x <- splitBy (== '/') pathStr, x /= ""] - haveGreedyRoot = case rootDefM of - Just def -> resIsGreedy def - Nothing -> False - foundInTree = if haveGreedyRoot || null path then - do def <- rootDefM + = do let path = splitPathInfo uri + hasGreedyRoot = maybe False resIsGreedy rootDefM + foundInTree = if hasGreedyRoot ∨ null path then + do def ← rootDefM return ([], def) else walkTree subtree path [] if isJust foundInTree then return foundInTree - else + else fallback path fbs where - walkTree :: ResSubtree -> [String] -> [String] -> Maybe ([String], ResourceDef) + walkTree ∷ ResSubtree → [Text] → [Text] → Maybe ([Text], ResourceDef) walkTree _ [] _ = error "Internal error: should not reach here." walkTree tree (name:[]) soFar - = case M.lookup name tree of - Nothing -> Nothing - Just (ResNode defM _) -> do def <- defM - return (soFar ++ [name], def) + = do ResNode defM _ ← M.lookup name tree + def ← defM + return (soFar ⧺ [name], def) walkTree tree (x:xs) soFar - = case M.lookup x tree of - Nothing -> Nothing - Just (ResNode defM children) -> case defM of - Just (ResourceDef { resIsGreedy = True }) - -> do def <- defM - return (soFar ++ [x], def) - _ -> walkTree children xs (soFar ++ [x]) + = do ResNode defM sub ← M.lookup x tree + case defM of + Just (ResourceDef { resIsGreedy = True }) + → do def ← defM + return (soFar ⧺ [x], def) + _ → walkTree sub xs (soFar ⧺ [x]) - fallback :: [String] -> [FallbackHandler] -> IO (Maybe ([String], ResourceDef)) + fallback ∷ [Text] → [FallbackHandler] → IO (Maybe ([Text], ResourceDef)) fallback _ [] = return Nothing - fallback path (x:xs) = do m <- x path + fallback path (x:xs) = do m ← x path case m of - Just def -> return $! Just ([], def) - Nothing -> fallback path xs + Just def → return $ Just ([], def) + Nothing → fallback path xs -runResource :: ResourceDef -> Interaction -> IO ThreadId -runResource def itr - = def `seq` itr `seq` - fork - $! catch ( runRes ( do req <- getRequest - fromMaybe notAllowed $ rsrc req - driftTo Done - ) itr - ) - processException +runResource ∷ ResourceDef → Interaction → IO ThreadId +runResource (ResourceDef {..}) itr@(Interaction {..}) + = fork $ run `catch` processException where - fork :: IO () -> IO ThreadId - fork = if resUsesNativeThread def - then forkOS - else forkIO + fork ∷ IO () → IO ThreadId + fork | resUsesNativeThread = forkOS + | otherwise = forkIO + + run ∷ IO () + run = flip runRes itr $ + do req ← getRequest + fromMaybe notAllowed $ rsrc req + driftTo Done - rsrc :: Request -> Maybe (Resource ()) + rsrc ∷ Request → Maybe (Resource ()) rsrc req = case reqMethod req of - GET -> resGet def - HEAD -> case resHead def of - Just r -> Just r - Nothing -> resGet def - POST -> resPost def - PUT -> resPut def - DELETE -> resDelete def - _ -> undefined + GET → resGet + HEAD → case resHead of + Just r → Just r + Nothing → resGet + POST → resPost + PUT → resPut + DELETE → resDelete + _ → error $ "Unknown request method: " ⧺ show (reqMethod req) - notAllowed :: Resource () - notAllowed = do setStatus MethodNotAllowed - setHeader (C8.pack "Allow") (C8.pack $ joinWith ", " allowedMethods) + notAllowed ∷ Resource () + notAllowed + = setStatus MethodNotAllowed + *> + (setHeader "Allow" $ A.fromAsciiBuilder + $ joinWith ", " + $ map A.toAsciiBuilder allowedMethods) - allowedMethods :: [String] + allowedMethods ∷ [Ascii] allowedMethods = nub $ concat [ methods resGet ["GET"] , methods resHead ["GET", "HEAD"] , methods resPost ["POST"] @@ -269,33 +270,32 @@ runResource def itr , methods resDelete ["DELETE"] ] - methods :: (ResourceDef -> Maybe a) -> [String] -> [String] - methods f xs = case f def of - Just _ -> xs - Nothing -> [] + methods ∷ Maybe a → [Ascii] → [Ascii] + methods m xs + | isJust m = xs + | otherwise = [] - toAbortion :: SomeException -> Abortion - toAbortion e = case fromException e of - Just abortion -> abortion - Nothing -> Abortion InternalServerError emptyHeaders (Just (show e)) + toAbortion ∷ SomeException → Abortion + toAbortion e + = case fromException e of + Just abortion → abortion + Nothing → Abortion InternalServerError (∅) (Just $ T.pack $ show e) - processException :: SomeException -> IO () + processException ∷ SomeException → IO () processException exc = do let abo = toAbortion exc - conf = itrConfig itr -- まだ DecidingHeader 以前の状態だったら、この途中終了 -- を應答に反映させる餘地がある。さうでなければ stderr -- にでも吐くしか無い。 - state <- atomically $ readItr itr itrState id - reqM <- atomically $ readItr itr itrRequest id - res <- atomically $ readItr itr itrResponse id - if state <= DecidingHeader then - flip runRes itr - $ do setStatus $ aboStatus abo - mapM_ (uncurry setHeader) $ fromHeaders $ aboHeaders abo - output $ abortPage conf reqM res abo - else - when (cnfDumpTooLateAbortionToStderr $ itrConfig itr) - $ hPutStrLn stderr $ show abo - - flip runRes itr $ driftTo Done + state ← atomically $ readTVar itrState + res ← atomically $ readTVar itrResponse + if state ≤ DecidingHeader then + flip runRes itr $ + do setStatus $ aboStatus abo + mapM_ (uncurry setHeader) $ fromHeaders $ aboHeaders abo + output $ LT.encodeUtf8 $ abortPage itrConfig itrRequest res abo + else + do when (cnfDumpTooLateAbortionToStderr itrConfig) + $ hPutStrLn stderr $ show abo + atomically $ writeTVar itrWillClose True + runRes (driftTo Done) itr