Status.hs

{-# LANGUAGE DeriveDataTypeable #-}
{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE OverloadedStrings #-}

-- | Types and constants to describe HTTP status codes.
--
-- At the bottom are some functions to check if a given 'Status' is from a certain category. (i.e. @1XX@, @2XX@, etc.)
module Network.HTTP.Types.Status (
    -- * HTTP Status

    -- If we ever want to deprecate the 'Status' data constructor:
    -- #if __GLASGOW_HASKELL__ >= 908
    --   {-# DEPRECATED "Use 'mkStatus' when constructing a 'Status'" #-} Status(Status)
    -- #else
    Status (Status),
    -- #endif
    statusCode,
    statusMessage,
    mkStatus,

    -- * Common statuses
    status100,
    continue100,
    status101,
    switchingProtocols101,
    status200,
    ok200,
    status201,
    created201,
    status202,
    accepted202,
    status203,
    nonAuthoritative203,
    status204,
    noContent204,
    status205,
    resetContent205,
    status206,
    partialContent206,
    status300,
    multipleChoices300,
    status301,
    movedPermanently301,
    status302,
    found302,
    status303,
    seeOther303,
    status304,
    notModified304,
    status305,
    useProxy305,
    status307,
    temporaryRedirect307,
    status308,
    permanentRedirect308,
    status400,
    badRequest400,
    status401,
    unauthorized401,
    status402,
    paymentRequired402,
    status403,
    forbidden403,
    status404,
    notFound404,
    status405,
    methodNotAllowed405,
    status406,
    notAcceptable406,
    status407,
    proxyAuthenticationRequired407,
    status408,
    requestTimeout408,
    status409,
    conflict409,
    status410,
    gone410,
    status411,
    lengthRequired411,
    status412,
    preconditionFailed412,
    status413,
    requestEntityTooLarge413,
    status414,
    requestURITooLong414,
    status415,
    unsupportedMediaType415,
    status416,
    requestedRangeNotSatisfiable416,
    status417,
    expectationFailed417,
    status418,
    imATeapot418,
    status422,
    unprocessableEntity422,
    status426,
    upgradeRequired426,
    status428,
    preconditionRequired428,
    status429,
    tooManyRequests429,
    status431,
    requestHeaderFieldsTooLarge431,
    status451,
    unavailableForLegalReasons451,
    status500,
    internalServerError500,
    status501,
    notImplemented501,
    status502,
    badGateway502,
    status503,
    serviceUnavailable503,
    status504,
    gatewayTimeout504,
    status505,
    httpVersionNotSupported505,
    status511,
    networkAuthenticationRequired511,

    -- * Checking status code category
    statusIsInformational,
    statusIsSuccessful,
    statusIsRedirection,
    statusIsClientError,
    statusIsServerError,
) where

import Data.ByteString as B (ByteString, empty)
import Data.Data (Data)
import GHC.Generics (Generic)

-- | HTTP Status.
--
-- Only the 'statusCode' is used for comparisons.
--
-- /Please use 'mkStatus' to create status codes from code and message, or the 'Enum' instance or the/
-- /status code constants (like 'ok200'). There might be additional record members in the future./
--
-- Note that the 'Show' instance is only for debugging.
data Status = Status
    { statusCode :: Int
    -- ^ The 3-digit code of a 'Status'
    --
    -- For example: "200" in a @200 OK@ status
    , statusMessage :: B.ByteString
    -- ^ The textual message of a 'Status'
    --
    -- For example: "Not Found" in a @404 Not Found@ status
    }
    deriving
        ( Show
        , -- | @since 0.12.4
          Data
        , -- | @since 0.12.4
          Generic
        )

-- FIXME: If the data constructor of 'Status' is ever deprecated, we should define
-- a pattern synonym to minimize any breakage. This also involves changing the
-- name of the constructor, so that it doesn't clash with the new pattern synonym
-- that's replacing it.
--
-- > data Status = MkStatus ...
-- > pattern Status code msg = MkStatus code msg

-- | A 'Status' is equal to another 'Status' if the status codes are equal.
instance Eq Status where
    Status{statusCode = a} == Status{statusCode = b} = a == b

-- | 'Status'es are ordered according to their status codes only.
instance Ord Status where
    compare Status{statusCode = a} Status{statusCode = b} = a `compare` b

-- | Be advised, that when using the \"enumFrom*\" family of methods or
-- ranges in lists, it will generate all possible status codes.
--
-- E.g. @[status100 .. status200]@ generates 'Status'es of @100, 101, 102 .. 198, 199, 200@
--
-- The statuses not included in this library will have an empty message.
--
-- @since 0.7.3
instance Enum Status where
    fromEnum = statusCode
    toEnum 100 = status100
    toEnum 101 = status101
    toEnum 200 = status200
    toEnum 201 = status201
    toEnum 202 = status202
    toEnum 203 = status203
    toEnum 204 = status204
    toEnum 205 = status205
    toEnum 206 = status206
    toEnum 300 = status300
    toEnum 301 = status301
    toEnum 302 = status302
    toEnum 303 = status303
    toEnum 304 = status304
    toEnum 305 = status305
    toEnum 307 = status307
    toEnum 308 = status308
    toEnum 400 = status400
    toEnum 401 = status401
    toEnum 402 = status402
    toEnum 403 = status403
    toEnum 404 = status404
    toEnum 405 = status405
    toEnum 406 = status406
    toEnum 407 = status407
    toEnum 408 = status408
    toEnum 409 = status409
    toEnum 410 = status410
    toEnum 411 = status411
    toEnum 412 = status412
    toEnum 413 = status413
    toEnum 414 = status414
    toEnum 415 = status415
    toEnum 416 = status416
    toEnum 417 = status417
    toEnum 418 = status418
    toEnum 422 = status422
    toEnum 426 = status426
    toEnum 428 = status428
    toEnum 429 = status429
    toEnum 431 = status431
    toEnum 451 = status451
    toEnum 500 = status500
    toEnum 501 = status501
    toEnum 502 = status502
    toEnum 503 = status503
    toEnum 504 = status504
    toEnum 505 = status505
    toEnum 511 = status511
    toEnum c = mkStatus c B.empty

-- | @since 0.11
instance Bounded Status where
    minBound = status100
    maxBound = status511

-- | Create a 'Status' from a status code and message.
--
-- @since 0.7.3
mkStatus :: Int -> B.ByteString -> Status
mkStatus = Status

-- | Continue 100
--
-- @since 0.6.6
status100 :: Status
status100 = mkStatus 100 "Continue"

-- | Continue 100
--
-- @since 0.6.6
continue100 :: Status
continue100 = status100

-- | Switching Protocols 101
--
-- @since 0.6.6
status101 :: Status
status101 = mkStatus 101 "Switching Protocols"

-- | Switching Protocols 101
--
-- @since 0.6.6
switchingProtocols101 :: Status
switchingProtocols101 = status101

-- | OK 200
status200 :: Status
status200 = mkStatus 200 "OK"

-- | OK 200
ok200 :: Status
ok200 = status200

-- | Created 201
status201 :: Status
status201 = mkStatus 201 "Created"

-- | Created 201
created201 :: Status
created201 = status201

-- | Accepted 202
--
-- @since 0.6.6
status202 :: Status
status202 = mkStatus 202 "Accepted"

-- | Accepted 202
--
-- @since 0.6.6
accepted202 :: Status
accepted202 = status202

-- | Non-Authoritative Information 203
--
-- @since 0.6.6
status203 :: Status
status203 = mkStatus 203 "Non-Authoritative Information"

-- | Non-Authoritative Information 203
--
-- @since 0.6.6
nonAuthoritative203 :: Status
nonAuthoritative203 = status203

-- | No Content 204
--
-- @since 0.6.6
status204 :: Status
status204 = mkStatus 204 "No Content"

-- | No Content 204
--
-- @since 0.6.6
noContent204 :: Status
noContent204 = status204

-- | Reset Content 205
--
-- @since 0.6.6
status205 :: Status
status205 = mkStatus 205 "Reset Content"

-- | Reset Content 205
--
-- @since 0.6.6
resetContent205 :: Status
resetContent205 = status205

-- | Partial Content 206
--
-- @since 0.5.1
status206 :: Status
status206 = mkStatus 206 "Partial Content"

-- | Partial Content 206
--
-- @since 0.5.1
partialContent206 :: Status
partialContent206 = status206

-- | Multiple Choices 300
status300 :: Status
status300 = mkStatus 300 "Multiple Choices"

-- | Multiple Choices 300
multipleChoices300 :: Status
multipleChoices300 = status300

-- | Moved Permanently 301
status301 :: Status
status301 = mkStatus 301 "Moved Permanently"

-- | Moved Permanently 301
movedPermanently301 :: Status
movedPermanently301 = status301

-- | Found 302
status302 :: Status
status302 = mkStatus 302 "Found"

-- | Found 302
found302 :: Status
found302 = status302

-- | See Other 303
status303 :: Status
status303 = mkStatus 303 "See Other"

-- | See Other 303
seeOther303 :: Status
seeOther303 = status303

-- | Not Modified 304
--
-- @since 0.6.1
status304 :: Status
status304 = mkStatus 304 "Not Modified"

-- | Not Modified 304
--
-- @since 0.6.1
notModified304 :: Status
notModified304 = status304

-- | Use Proxy 305
--
-- @since 0.6.6
status305 :: Status
status305 = mkStatus 305 "Use Proxy"

-- | Use Proxy 305
--
-- @since 0.6.6
useProxy305 :: Status
useProxy305 = status305

-- | Temporary Redirect 307
--
-- @since 0.6.6
status307 :: Status
status307 = mkStatus 307 "Temporary Redirect"

-- | Temporary Redirect 307
--
-- @since 0.6.6
temporaryRedirect307 :: Status
temporaryRedirect307 = status307

-- | Permanent Redirect 308
--
-- @since 0.9
status308 :: Status
status308 = mkStatus 308 "Permanent Redirect"

-- | Permanent Redirect 308
--
-- @since 0.9
permanentRedirect308 :: Status
permanentRedirect308 = status308

-- | Bad Request 400
status400 :: Status
status400 = mkStatus 400 "Bad Request"

-- | Bad Request 400
badRequest400 :: Status
badRequest400 = status400

-- | Unauthorized 401
status401 :: Status
status401 = mkStatus 401 "Unauthorized"

-- | Unauthorized 401
unauthorized401 :: Status
unauthorized401 = status401

-- | Payment Required 402
--
-- @since 0.6.6
status402 :: Status
status402 = mkStatus 402 "Payment Required"

-- | Payment Required 402
--
-- @since 0.6.6
paymentRequired402 :: Status
paymentRequired402 = status402

-- | Forbidden 403
status403 :: Status
status403 = mkStatus 403 "Forbidden"

-- | Forbidden 403
forbidden403 :: Status
forbidden403 = status403

-- | Not Found 404
status404 :: Status
status404 = mkStatus 404 "Not Found"

-- | Not Found 404
notFound404 :: Status
notFound404 = status404

-- | Method Not Allowed 405
status405 :: Status
status405 = mkStatus 405 "Method Not Allowed"

-- | Method Not Allowed 405
methodNotAllowed405 :: Status
methodNotAllowed405 = status405

-- | Not Acceptable 406
--
-- @since 0.6.6
status406 :: Status
status406 = mkStatus 406 "Not Acceptable"

-- | Not Acceptable 406
--
-- @since 0.6.6
notAcceptable406 :: Status
notAcceptable406 = status406

-- | Proxy Authentication Required 407
--
-- @since 0.6.6
status407 :: Status
status407 = mkStatus 407 "Proxy Authentication Required"

-- | Proxy Authentication Required 407
--
-- @since 0.6.6
proxyAuthenticationRequired407 :: Status
proxyAuthenticationRequired407 = status407

-- | Request Timeout 408
--
-- @since 0.6.6
status408 :: Status
status408 = mkStatus 408 "Request Timeout"

-- | Request Timeout 408
--
-- @since 0.6.6
requestTimeout408 :: Status
requestTimeout408 = status408

-- | Conflict 409
--
-- @since 0.6.6
status409 :: Status
status409 = mkStatus 409 "Conflict"

-- | Conflict 409
--
-- @since 0.6.6
conflict409 :: Status
conflict409 = status409

-- | Gone 410
--
-- @since 0.6.6
status410 :: Status
status410 = mkStatus 410 "Gone"

-- | Gone 410
--
-- @since 0.6.6
gone410 :: Status
gone410 = status410

-- | Length Required 411
--
-- @since 0.6.6
status411 :: Status
status411 = mkStatus 411 "Length Required"

-- | Length Required 411
--
-- @since 0.6.6
lengthRequired411 :: Status
lengthRequired411 = status411

-- | Precondition Failed 412
--
-- @since 0.6.1
status412 :: Status
status412 = mkStatus 412 "Precondition Failed"

-- | Precondition Failed 412
--
-- @since 0.6.1
preconditionFailed412 :: Status
preconditionFailed412 = status412

-- | Request Entity Too Large 413
--
-- @since 0.6.6
status413 :: Status
status413 = mkStatus 413 "Request Entity Too Large"

-- | Request Entity Too Large 413
--
-- @since 0.6.6
requestEntityTooLarge413 :: Status
requestEntityTooLarge413 = status413

-- | Request-URI Too Long 414
--
-- @since 0.6.6
status414 :: Status
status414 = mkStatus 414 "Request-URI Too Long"

-- | Request-URI Too Long 414
--
-- @since 0.6.6
requestURITooLong414 :: Status
requestURITooLong414 = status414

-- | Unsupported Media Type 415
--
-- @since 0.6.6
status415 :: Status
status415 = mkStatus 415 "Unsupported Media Type"

-- | Unsupported Media Type 415
--
-- @since 0.6.6
unsupportedMediaType415 :: Status
unsupportedMediaType415 = status415

-- | Requested Range Not Satisfiable 416
--
-- @since 0.6.1
status416 :: Status
status416 = mkStatus 416 "Requested Range Not Satisfiable"

-- | Requested Range Not Satisfiable 416
--
-- @since 0.6.1
requestedRangeNotSatisfiable416 :: Status
requestedRangeNotSatisfiable416 = status416

-- | Expectation Failed 417
--
-- @since 0.6.6
status417 :: Status
status417 = mkStatus 417 "Expectation Failed"

-- | Expectation Failed 417
--
-- @since 0.6.6
expectationFailed417 :: Status
expectationFailed417 = status417

-- FIXME: RFC 7168 updates the message to "I'm a Teapot" (capital T)
-- Should we update this?

-- | I'm a teapot 418
--
-- @since 0.6.6
status418 :: Status
status418 = mkStatus 418 "I'm a teapot"

-- | I'm a teapot 418
--
-- @since 0.6.6
imATeapot418 :: Status
imATeapot418 = status418

-- | Unprocessable Entity 422
-- (<https://tools.ietf.org/html/rfc4918 RFC 4918>)
--
-- @since 0.9.1
status422 :: Status
status422 = mkStatus 422 "Unprocessable Entity"

-- | Unprocessable Entity 422
-- (<https://tools.ietf.org/html/rfc4918 RFC 4918>)
--
-- @since 0.9.1
unprocessableEntity422 :: Status
unprocessableEntity422 = status422

-- | Upgrade Required 426
-- (<https://tools.ietf.org/html/rfc7231#section-6.5.15 RFC 7231>)
--
-- @since 0.10
status426 :: Status
status426 = mkStatus 426 "Upgrade Required"

-- | Upgrade Required 426
-- (<https://tools.ietf.org/html/rfc7231#section-6.5.15 RFC 7231>)
--
-- @since 0.10
upgradeRequired426 :: Status
upgradeRequired426 = status426

-- | Precondition Required 428
-- (<https://tools.ietf.org/html/rfc6585#section-3 RFC 6585>)
--
-- @since 0.8.5
status428 :: Status
status428 = mkStatus 428 "Precondition Required"

-- | Precondition Required 428
-- (<https://tools.ietf.org/html/rfc6585#section-3 RFC 6585>)
--
-- @since 0.8.5
preconditionRequired428 :: Status
preconditionRequired428 = status428

-- | Too Many Requests 429
-- (<https://tools.ietf.org/html/rfc6585#section-4 RFC 6585>)
--
-- @since 0.8.5
status429 :: Status
status429 = mkStatus 429 "Too Many Requests"

-- | Too Many Requests 429
-- (<https://tools.ietf.org/html/rfc6585#section-4 RFC 6585>)
--
-- @since 0.8.5
tooManyRequests429 :: Status
tooManyRequests429 = status429

-- | Request Header Fields Too Large 431
-- (<https://tools.ietf.org/html/rfc6585#section-5 RFC 6585>)
--
-- @since 0.8.5
status431 :: Status
status431 = mkStatus 431 "Request Header Fields Too Large"

-- | Request Header Fields Too Large 431
-- (<https://tools.ietf.org/html/rfc6585#section-5 RFC 6585>)
--
-- @since 0.8.5
requestHeaderFieldsTooLarge431 :: Status
requestHeaderFieldsTooLarge431 = status431

-- | Unavailable For Legal Reasons 451
-- (<https://tools.ietf.org/html/rfc7725 RFC 7725>)
--
-- @since 0.12.5
status451 :: Status
status451 = mkStatus 451 "Unavailable For Legal Reasons"

-- | Unavailable For Legal Reasons 451
-- (<https://tools.ietf.org/html/rfc7725 RFC 7725>)
--
-- @since 0.12.5
unavailableForLegalReasons451 :: Status
unavailableForLegalReasons451 = status451

-- | Internal Server Error 500
status500 :: Status
status500 = mkStatus 500 "Internal Server Error"

-- | Internal Server Error 500
internalServerError500 :: Status
internalServerError500 = status500

-- | Not Implemented 501
--
-- @since 0.6.1
status501 :: Status
status501 = mkStatus 501 "Not Implemented"

-- | Not Implemented 501
--
-- @since 0.6.1
notImplemented501 :: Status
notImplemented501 = status501

-- | Bad Gateway 502
--
-- @since 0.6.6
status502 :: Status
status502 = mkStatus 502 "Bad Gateway"

-- | Bad Gateway 502
--
-- @since 0.6.6
badGateway502 :: Status
badGateway502 = status502

-- | Service Unavailable 503
--
-- @since 0.6.6
status503 :: Status
status503 = mkStatus 503 "Service Unavailable"

-- | Service Unavailable 503
--
-- @since 0.6.6
serviceUnavailable503 :: Status
serviceUnavailable503 = status503

-- | Gateway Timeout 504
--
-- @since 0.6.6
status504 :: Status
status504 = mkStatus 504 "Gateway Timeout"

-- | Gateway Timeout 504
--
-- @since 0.6.6
gatewayTimeout504 :: Status
gatewayTimeout504 = status504

-- | HTTP Version Not Supported 505
--
-- @since 0.6.6
status505 :: Status
status505 = mkStatus 505 "HTTP Version Not Supported"

-- | HTTP Version Not Supported 505
--
-- @since 0.6.6
httpVersionNotSupported505 :: Status
httpVersionNotSupported505 = status505

-- | Network Authentication Required 511
-- (<https://tools.ietf.org/html/rfc6585#section-6 RFC 6585>)
--
-- @since 0.8.5
status511 :: Status
status511 = mkStatus 511 "Network Authentication Required"

-- | Network Authentication Required 511
-- (<https://tools.ietf.org/html/rfc6585#section-6 RFC 6585>)
--
-- @since 0.8.5
networkAuthenticationRequired511 :: Status
networkAuthenticationRequired511 = status511

-- | Informational class
--
-- Checks if the status is in the 1XX range.
--
-- @since 0.8.0
statusIsInformational :: Status -> Bool
statusIsInformational (Status{statusCode = code}) = code >= 100 && code < 200

-- | Successful class
--
-- Checks if the status is in the 2XX range.
--
-- @since 0.8.0
statusIsSuccessful :: Status -> Bool
statusIsSuccessful (Status{statusCode = code}) = code >= 200 && code < 300

-- | Redirection class
--
-- Checks if the status is in the 3XX range.
--
-- @since 0.8.0
statusIsRedirection :: Status -> Bool
statusIsRedirection (Status{statusCode = code}) = code >= 300 && code < 400

-- | Client Error class
--
-- Checks if the status is in the 4XX range.
--
-- @since 0.8.0
statusIsClientError :: Status -> Bool
statusIsClientError (Status{statusCode = code}) = code >= 400 && code < 500

-- | Server Error class
--
-- Checks if the status is in the 5XX range.
--
-- @since 0.8.0
statusIsServerError :: Status -> Bool
statusIsServerError (Status{statusCode = code}) = code >= 500 && code < 600