X-Git-Url: http://git.cielonegro.org/gitweb.cgi?p=Lucu.git;a=blobdiff_plain;f=Network%2FHTTP%2FLucu%2FResource%2FInternal.hs;h=d5a14117f267a781d75908619de76592a3ab74c7;hp=f8ea1b2aaf5b3b35edad73d7b3da2731d4b08d18;hb=1ead053df6a792edafa9d714c4c038a8a9c3ad16;hpb=545053db37e71ed18ca59c12467a8ecb10bf5f83 diff --git a/Network/HTTP/Lucu/Resource/Internal.hs b/Network/HTTP/Lucu/Resource/Internal.hs index f8ea1b2..d5a1411 100644 --- a/Network/HTTP/Lucu/Resource/Internal.hs +++ b/Network/HTTP/Lucu/Resource/Internal.hs @@ -7,10 +7,10 @@ , UnicodeSyntax #-} module Network.HTTP.Lucu.Resource.Internal - ( Resource - , ResourceDef(..) + ( Rsrc + , Resource(..) , emptyResource - , spawnResource + , spawnRsrc , getConfig , getRemoteAddr @@ -66,25 +66,20 @@ import Prelude hiding (catch, concat, mapM_, tail) import Prelude.Unicode import System.IO --- |The 'Resource' monad. This monad implements 'MonadIO' so it can do +-- |The resource monad. This monad implements 'MonadIO' so it can do -- any 'IO' actions. -newtype Resource a - = Resource { - unResource ∷ ReaderT NormalInteraction IO a +newtype Rsrc a + = Rsrc { + unRsrc ∷ ReaderT NormalInteraction IO a } deriving (Applicative, Functor, Monad, MonadIO) -runResource ∷ Resource a → NormalInteraction → IO a -runResource = runReaderT ∘ unResource - --- |'ResourceDef' is basically a set of 'Resource' monads for each --- HTTP methods. -data ResourceDef = ResourceDef { - -- |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 +runRsrc ∷ Rsrc a → NormalInteraction → IO a +runRsrc = runReaderT ∘ unRsrc + +-- |'Resource' is basically a set of 'Rsrc' monadic computations for +-- each HTTP methods. +data Resource = Resource { -- | Whether to be greedy or not. -- -- Say a client is trying to access \/aaa\/bbb\/ccc. If there is a @@ -92,40 +87,40 @@ 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 'Resource' to be run when a GET request comes for the + resIsGreedy ∷ !Bool + -- |A 'Rsrc' 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 -- that case 'putChunk' and such don't actually write a response -- body. - , resGet ∷ !(Maybe (Resource ())) - -- |A 'Resource' to be run when a HEAD request comes for the + , resGet ∷ !(Maybe (Rsrc ())) + -- |A 'Rsrc' 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 + , resHead ∷ !(Maybe (Rsrc ())) + -- |A 'Rsrc' 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 + , resPost ∷ !(Maybe (Rsrc ())) + -- |A 'Rsrc' 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 + , resPut ∷ !(Maybe (Rsrc ())) + -- |A 'Rsrc' 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 ())) + , resDelete ∷ !(Maybe (Rsrc ())) } -- |'emptyResource' is a resource definition with no actual --- handlers. You can construct a 'ResourceDef' by selectively --- overriding 'emptyResource'. It is defined as follows: +-- handlers. You can construct a 'Resource' by selectively overriding +-- 'emptyResource'. It is defined as follows: -- -- @ --- emptyResource = ResourceDef { +-- emptyResource = Resource { -- resUsesNativeThread = False -- , resIsGreedy = False -- , resGet = Nothing @@ -135,10 +130,9 @@ data ResourceDef = ResourceDef { -- , resDelete = Nothing -- } -- @ -emptyResource ∷ ResourceDef -emptyResource = ResourceDef { - resUsesNativeThread = False - , resIsGreedy = False +emptyResource ∷ Resource +emptyResource = Resource { + resIsGreedy = False , resGet = Nothing , resHead = Nothing , resPost = Nothing @@ -146,21 +140,17 @@ emptyResource = ResourceDef { , resDelete = Nothing } -spawnResource ∷ ResourceDef → NormalInteraction → IO ThreadId -spawnResource (ResourceDef {..}) ni@(NI {..}) - = fork $ run `catch` processException +spawnRsrc ∷ Resource → NormalInteraction → IO ThreadId +spawnRsrc (Resource {..}) ni@(NI {..}) + = forkIO $ run `catch` processException where - fork ∷ IO () → IO ThreadId - fork | resUsesNativeThread = forkOS - | otherwise = forkIO - run ∷ IO () - run = flip runResource ni $ + run = flip runRsrc ni $ do req ← getRequest fromMaybe notAllowed $ rsrc req driftTo Done - rsrc ∷ Request → Maybe (Resource ()) + rsrc ∷ Request → Maybe (Rsrc ()) rsrc req = case reqMethod req of GET → resGet @@ -172,7 +162,7 @@ spawnResource (ResourceDef {..}) ni@(NI {..}) DELETE → resDelete _ → error $ "Unknown request method: " ⧺ show (reqMethod req) - notAllowed ∷ Resource () + notAllowed ∷ Rsrc () notAllowed = do setStatus MethodNotAllowed setHeader "Allow" $ A.fromAsciiBuilder @@ -207,7 +197,7 @@ spawnResource (ResourceDef {..}) ni@(NI {..}) if state ≤ DecidingHeader then -- We still have a chance to reflect this abortion -- in the response. Hooray! - flip runResource ni $ + flip runRsrc ni $ do setStatus $ aboStatus abo mapM_ (uncurry setHeader) (aboHeaders abo) setHeader "Content-Type" defaultPageContentType @@ -216,7 +206,7 @@ spawnResource (ResourceDef {..}) ni@(NI {..}) else when (cnfDumpTooLateAbortionToStderr niConfig) $ dumpAbortion abo - runResource (driftTo Done) ni + runRsrc (driftTo Done) ni dumpAbortion ∷ Abortion → IO () dumpAbortion abo @@ -226,15 +216,15 @@ dumpAbortion abo , " ", show abo, "\n" ] -getInteraction ∷ Resource NormalInteraction -getInteraction = Resource ask +getInteraction ∷ Rsrc NormalInteraction +getInteraction = Rsrc ask -- |Get the 'Config' value for this httpd. -getConfig ∷ Resource Config +getConfig ∷ Rsrc Config getConfig = niConfig <$> getInteraction -- |Get the 'SockAddr' of the remote host. -getRemoteAddr ∷ Resource SockAddr +getRemoteAddr ∷ Rsrc SockAddr getRemoteAddr = niRemoteAddr <$> getInteraction #if defined(HAVE_SSL) @@ -247,18 +237,18 @@ getRemoteAddr = niRemoteAddr <$> getInteraction -- * The 'OpenSSL.Session.VerificationMode' of -- 'OpenSSL.Session.SSLContext' in 'SSLConfig' has not been set to -- 'OpenSSL.Session.VerifyPeer'. -getRemoteCertificate ∷ Resource (Maybe X509) +getRemoteCertificate ∷ Rsrc (Maybe X509) getRemoteCertificate = niRemoteCert <$> getInteraction #endif -- |Return the 'Request' value representing the request header. You -- usually don't need to call this function directly. -getRequest ∷ Resource Request +getRequest ∷ Rsrc Request getRequest = niRequest <$> getInteraction --- |Get the path of this 'Resource' (to be exact, 'ResourceDef') in --- the 'Network.HTTP.Lucu.Resource.Tree.ResTree'. The result of this --- action is the exact path in the tree even when the 'ResourceDef' is +-- |Get the path of this 'Rsrc' (to be exact, 'Resource') in the +-- 'Network.HTTP.Lucu.Resource.Tree.ResTree'. The result of this +-- action is the exact path in the tree even when the 'Resource' is -- greedy. -- -- Example: @@ -276,18 +266,18 @@ getRequest = niRequest <$> getInteraction -- > -- pathInfo == ["bar", "baz"] -- > ... -- > } -getResourcePath ∷ Resource [Strict.ByteString] +getResourcePath ∷ Rsrc [Strict.ByteString] getResourcePath = niResourcePath <$> getInteraction -- |@'getChunk' n@ attempts to read a chunk of request body up to @n@ -- bytes. You can incrementally read the request body by repeatedly -- calling this function. If there is nothing to be read anymore, --- 'getChunk' returns 'Strict.empty' and makes 'Resource' transit to +-- 'getChunk' returns 'Strict.empty' and makes 'Rsrc' transit to -- the /Deciding Header/ state. -getChunk ∷ Int → Resource Strict.ByteString +getChunk ∷ Int → Rsrc Strict.ByteString getChunk = (driftTo ReceivingBody *>) ∘ getChunk' -getChunk' ∷ Int → Resource Strict.ByteString +getChunk' ∷ Int → Rsrc Strict.ByteString getChunk' n | n < 0 = fail ("getChunk: n must not be negative: " ⧺ show n) | n ≡ 0 = return (∅) @@ -297,7 +287,7 @@ getChunk' n else driftTo DecidingHeader *> return (∅) where - askForInput ∷ NormalInteraction → Resource Strict.ByteString + askForInput ∷ NormalInteraction → Rsrc Strict.ByteString askForInput (NI {..}) = do -- Ask the RequestReader to get a chunk. liftIO $ atomically @@ -313,7 +303,7 @@ getChunk' n -- |Declare the response status code. If you don't call this function, -- the status code will be defaulted to \"200 OK\". -setStatus ∷ StatusCode sc ⇒ sc → Resource () +setStatus ∷ StatusCode sc ⇒ sc → Rsrc () setStatus sc = do ni ← getInteraction liftIO $ atomically @@ -338,7 +328,7 @@ setStatus sc -- case the client shall only accept the first 10 bytes of response -- body and thinks that the residual 10 bytes is a part of the header -- of the next response. -setHeader ∷ CIAscii → Ascii → Resource () +setHeader ∷ CIAscii → Ascii → Rsrc () setHeader name value = liftIO ∘ atomically ∘ go =≪ getInteraction where go ∷ NormalInteraction → STM () @@ -353,7 +343,7 @@ setHeader name value = liftIO ∘ atomically ∘ go =≪ getInteraction -- |@'deleteHeader' name@ deletes a response header @name@ if -- any. This function is not intended to be used so frequently. -deleteHeader ∷ CIAscii → Resource () +deleteHeader ∷ CIAscii → Rsrc () deleteHeader name = liftIO ∘ atomically ∘ go =≪ getInteraction where go ∷ NormalInteraction → STM () @@ -373,7 +363,7 @@ deleteHeader name = liftIO ∘ atomically ∘ go =≪ getInteraction -- Note that you must first declare the response header -- \"Content-Type\" before applying this function. See: -- 'setContentType' -putBuilder ∷ Builder → Resource () +putBuilder ∷ Builder → Rsrc () putBuilder b = liftIO ∘ atomically ∘ go =≪ getInteraction where -- FIXME: should see if resCanHaveBody. @@ -387,7 +377,7 @@ putBuilder b = liftIO ∘ atomically ∘ go =≪ getInteraction "putBuilder: Content-Type has not been set." putTMVar niBodyToSend b -driftTo ∷ InteractionState → Resource () +driftTo ∷ InteractionState → Rsrc () driftTo = (getInteraction ≫=) ∘ ((liftIO ∘ atomically) ∘) ∘ flip driftTo' driftTo' ∷ NormalInteraction → InteractionState → STM ()