X-Git-Url: http://git.cielonegro.org/gitweb.cgi?p=Lucu.git;a=blobdiff_plain;f=Network%2FHTTP%2FLucu%2FConfig.hs;h=366a63cb1aab9bad37f96cd9eb4f5d701fff01e6;hp=d2b0f60eea84a8adf33946df02163285f54e1e53;hb=67f9e87;hpb=f504167b85561373b4c444e2d37a513e0ab504a9 diff --git a/Network/HTTP/Lucu/Config.hs b/Network/HTTP/Lucu/Config.hs index d2b0f60..366a63c 100644 --- a/Network/HTTP/Lucu/Config.hs +++ b/Network/HTTP/Lucu/Config.hs @@ -1,96 +1,122 @@ --- |Configurations for the Lucu httpd like a port to listen. +{-# LANGUAGE + CPP + , OverloadedStrings + , UnicodeSyntax + #-} +-- |Configurations for the Lucu httpd. module Network.HTTP.Lucu.Config ( Config(..) +#if defined(HAVE_SSL) , SSLConfig(..) - , defaultConfig +#endif ) where +import Data.Ascii (Ascii) +import Data.CaseInsensitive (CI) +import qualified Data.CaseInsensitive as CI +import Data.Default +import Data.Text (Text) +import qualified Data.Text as T +import Network +import Network.BSD +import Network.HTTP.Lucu.MIMEType.Guess +import Network.HTTP.Lucu.MIMEType.DefaultExtensionMap +#if defined(HAVE_SSL) +import OpenSSL.Session +#endif +import Prelude.Unicode +import System.IO.Unsafe -import qualified Data.ByteString as Strict (ByteString) -import qualified Data.ByteString.Char8 as C8 hiding (ByteString) -import Network -import Network.BSD -import Network.HTTP.Lucu.MIMEType.Guess -import Network.HTTP.Lucu.MIMEType.DefaultExtensionMap -import OpenSSL.Session -import System.IO.Unsafe - --- |Configuration record for the Lucu httpd. You need to use --- 'defaultConfig' or setup your own configuration to run the httpd. +-- |Configuration record for to run the httpd. data Config = Config { - -- |A string which will be sent to clients as \"Server\" field. - cnfServerSoftware :: !Strict.ByteString + -- |A banner string to be sent to clients with \"Server\" response + -- header field. + cnfServerSoftware ∷ !Ascii -- |The host name of the server. This value will be used in -- built-in pages like \"404 Not Found\". - , cnfServerHost :: !Strict.ByteString + , cnfServerHost ∷ !(CI Text) + + -- |A port number (or a service name) to listen to HTTP clients. + , cnfServerPort ∷ !ServiceName + + -- |Local IPv4 address to listen to both HTTP and HTTPS + -- clients. Set this to @('Just' "0.0.0.0")@ if you want to accept + -- any IPv4 connections. Set this to 'Nothing' to disable IPv4. + , cnfServerV4Addr ∷ !(Maybe HostName) - -- |A port ID to listen to HTTP clients. - , cnfServerPort :: !PortID + -- |Local IPv6 address to listen to both HTTP and HTTPS + -- clients. Set this to @('Just' "::")@ if you want to accept any + -- IPv6 connections. Set this to 'Nothing' to disable IPv6. Note + -- that there is currently no ways to assign separate ports to + -- IPv4 and IPv6 server sockets (but I don't think that will be a + -- problem.) + , cnfServerV6Addr ∷ !(Maybe HostName) +#if defined(HAVE_SSL) -- |Configuration for HTTPS connections. Set this 'Nothing' to -- disable HTTPS. - , cnfSSLConfig :: !(Maybe SSLConfig) + , cnfSSLConfig ∷ !(Maybe SSLConfig) +#endif - -- |The maximum number of requests to accept in one connection - -- simultaneously. If a client exceeds this limitation, its last + -- |The maximum number of requests to simultaneously accept in one + -- connection. If a client exceeds this limitation, its last -- request won't be processed until a response for its earliest -- pending request is sent back to the client. - , cnfMaxPipelineDepth :: !Int + , cnfMaxPipelineDepth ∷ !Int - -- |The maximum length of request entity to accept in bytes. Note - -- that this is nothing but the default value which is used when - -- 'Network.HTTP.Lucu.Resource.input' and such like are applied to - -- 'Network.HTTP.Lucu.Resource.defaultLimit', so there is no - -- guarantee that this value always constrains all the requests. - , cnfMaxEntityLength :: !Int + -- |The maximum length of request entity to accept in octets. Note + -- that this is nothing but a default value used by + -- 'Network.HTTP.Lucu.Resource.getForm' and such when they are + -- applied to 'Nothing', so there is no guarantee that this value + -- always constrains all the requests. + , cnfMaxEntityLength ∷ !Int - -- |The maximum length of chunk to output. This value is used by - -- 'Network.HTTP.Lucu.Resource.output' and such like to limit the - -- chunk length so you can safely output an infinite string (like - -- a lazy stream of \/dev\/random) using those actions. - , cnfMaxOutputChunkLength :: !Int - - -- | Whether to dump too late abortion to the stderr or not. See + -- |Whether to dump too late abortions to the stderr or not. See -- 'Network.HTTP.Lucu.Abortion.abort'. - , cnfDumpTooLateAbortionToStderr :: !Bool + , cnfDumpTooLateAbortionToStderr ∷ !Bool - -- |A mapping from extension to MIME Type. This value is used by - -- 'Network.HTTP.Lucu.StaticFile.staticFile' to guess the MIME - -- Type of static files. Note that MIME Types are currently - -- guessed only by file name. + -- |A mapping table from file extensions to MIME Types. This value + -- is used by 'Network.HTTP.Lucu.StaticFile.staticFile' to guess + -- the MIME Type of static files. Note that MIME Types are + -- currently guessed only by file name. -- - -- Guessing by file magic is indeed a wonderful idea but that is - -- not implemented (yet). But, don't you think it's better a file - -- system got a MIME Type as a part of inode? Or it might be a - -- good idea to use GnomeVFS - -- () - -- instead of vanilla FS. - , cnfExtToMIMEType :: !ExtMap + -- Guessing by file magic might be a good idea but that's not + -- implemented (yet). + , cnfExtToMIMEType ∷ !ExtMap } +#if defined(HAVE_SSL) -- |Configuration record for HTTPS connections. data SSLConfig = SSLConfig { - -- |A port ID to listen to HTTPS clients. - sslServerPort :: !PortID - -- |An SSL context for accepting connections. - , sslContext :: !SSLContext + -- |A port number (or a service name) to listen to HTTPS + -- clients. Local addresses (both for IPv4 and IPv6) will be + -- derived from the parent 'Config'. + sslServerPort ∷ !ServiceName + + -- |An SSL context for accepting connections. You must set it + -- up yourself with at least a server certification. + , sslContext ∷ !SSLContext } +#endif -- |The default configuration. Generally you can use this value as-is, -- or possibly you just want to replace the 'cnfServerSoftware' and -- 'cnfServerPort'. SSL connections are disabled by default. -defaultConfig :: Config -defaultConfig = Config { - cnfServerSoftware = C8.pack "Lucu/1.0" - , cnfServerHost = C8.pack (unsafePerformIO getHostName) - , cnfServerPort = Service "http" - , cnfSSLConfig = Nothing - , cnfMaxPipelineDepth = 100 - , cnfMaxEntityLength = 16 * 1024 * 1024 -- 16 MiB - , cnfMaxOutputChunkLength = 5 * 1024 * 1024 -- 5 MiB - , cnfDumpTooLateAbortionToStderr = True - , cnfExtToMIMEType = defaultExtensionMap - } +instance Default Config where + def = Config { + cnfServerSoftware = "Lucu/1.0" + , cnfServerHost = CI.mk ∘ T.pack $ unsafePerformIO getHostName + , cnfServerPort = "http" + , cnfServerV4Addr = Just "0.0.0.0" + , cnfServerV6Addr = Just "::" +#if defined(HAVE_SSL) + , cnfSSLConfig = Nothing +#endif + , cnfMaxPipelineDepth = 100 + , cnfMaxEntityLength = 16 * 1024 * 1024 -- 16 MiB + , cnfDumpTooLateAbortionToStderr = True + , cnfExtToMIMEType = defaultExtensionMap + }