+{-# LANGUAGE
+ OverloadedStrings
+ , UnicodeSyntax
+ #-}
+-- |Configurations for the Lucu httpd like a port to listen.
module Network.HTTP.Lucu.Config
( Config(..)
- , defaultConfig -- Config
+ , SSLConfig(..)
+ , defaultConfig
)
where
-
+import Data.Ascii (Ascii)
+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
+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.
data Config = Config {
- cnfServerPort :: PortID
- , cnfMaxPipelineDepth :: Int
- , cnfMaxEntityLength :: Integer
- , cnfMaxURILength :: Int
+
+ -- |A string which will be sent to clients as \"Server\" field.
+ cnfServerSoftware ∷ !Ascii
+
+ -- |The host name of the server. This value will be used in
+ -- built-in pages like \"404 Not Found\".
+ , cnfServerHost ∷ !Text
+
+ -- |A port number (or 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)
+
+ -- |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 way to assign separate ports to IPv4
+ -- and IPv6 server sockets.
+ , cnfServerV6Addr ∷ !(Maybe HostName)
+
+ -- |Configuration for HTTPS connections. Set this 'Nothing' to
+ -- disable HTTPS.
+ , cnfSSLConfig ∷ !(Maybe SSLConfig)
+
+ -- |The maximum number of requests to accept in one connection
+ -- simultaneously. 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
+
+ -- |The maximum length of request entity to accept in bytes. Note
+ -- that this is nothing but a default value which is used when
+ -- 'Network.HTTP.Lucu.Resource.getForm' 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
+
+ -- | Whether to dump too late abortion to the stderr or not. See
+ -- 'Network.HTTP.Lucu.Abortion.abort'.
+ , 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.
+ --
+ -- 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
+ -- (<http://developer.gnome.org/doc/API/2.0/gnome-vfs-2.0/>)
+ -- instead of vanilla FS.
+ , cnfExtToMIMEType ∷ !ExtMap
}
+-- |Configuration record for HTTPS connections.
+data SSLConfig
+ = SSLConfig {
+ -- |A port ID 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.
+ , sslContext ∷ !SSLContext
+ }
+
+-- |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 {
- cnfServerPort = Service "http"
- , cnfMaxPipelineDepth = 100
- , cnfMaxEntityLength = 16 * 1024 * 1024 -- 16 MiB
- , cnfMaxURILength = 4 * 1024 -- 4 KiB
- }
\ No newline at end of file
+ cnfServerSoftware = "Lucu/1.0"
+ , cnfServerHost = T.pack (unsafePerformIO getHostName)
+ , cnfServerPort = "http"
+ , cnfServerV4Addr = Just "0.0.0.0"
+ , cnfServerV6Addr = Just "::"
+ , cnfSSLConfig = Nothing
+ , cnfMaxPipelineDepth = 100
+ , cnfMaxEntityLength = 16 * 1024 * 1024 -- 16 MiB
+ , cnfDumpTooLateAbortionToStderr = True
+ , cnfExtToMIMEType = defaultExtensionMap
+ }