GI.Soup.Structs.Cookie

An HTTP cookie.

name and value will be set for all cookies. If the cookie is generated from a string that appears to have no name, then name will be the empty string.

domain and path give the host or domain, and path within that host/domain, to restrict this cookie to. If domain starts with ".", that indicates a domain (which matches the string after the ".", or any hostname that has domain as a suffix). Otherwise, it is a hostname and must match exactly.

expires will be non-Nothing if the cookie uses either the original "expires" attribute, or the newer "max-age" attribute. If expires is Nothing, it indicates that neither "expires" nor "max-age" was specified, and the cookie expires at the end of the session.

If httpOnly is set, the cookie should not be exposed to untrusted code (eg, javascript), so as to minimize the danger posed by cross-site scripting attacks.

Exported types

newtype Cookie

Constructors

Cookie (ManagedPtr Cookie)

Instances

BoxedObject Cookie

Methods

boxedType :: Cookie -> IO GType

(~) AttrOpTag tag AttrSet => Constructible Cookie tag

Methods

new :: MonadIO m => (ManagedPtr Cookie -> Cookie) -> [AttrOp Cookie tag] -> m Cookie

((~) * info (ResolveCookieMethod t Cookie), MethodInfo * info Cookie p) => IsLabel t (Cookie -> p)

Methods

fromLabel :: Proxy# Symbol t -> Cookie -> p

((~) * info (ResolveCookieMethod t Cookie), MethodInfo * info Cookie p) => IsLabelProxy t (Cookie -> p)

Methods

fromLabelProxy :: Proxy Symbol t -> Cookie -> p

HasAttributeList * Cookie

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieToSetCookieHeaderMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieToSetCookieHeaderMethodInfo Cookie -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieToCookieHeaderMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieToCookieHeaderMethodInfo Cookie -> signature -> s

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetValueMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetValueMethodInfo Cookie -> signature -> s

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * CookieSetSecureMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetSecureMethodInfo Cookie -> signature -> s

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetPathMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetPathMethodInfo Cookie -> signature -> s

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetNameMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetNameMethodInfo Cookie -> signature -> s

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * CookieSetMaxAgeMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetMaxAgeMethodInfo Cookie -> signature -> s

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * CookieSetHttpOnlyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetHttpOnlyMethodInfo Cookie -> signature -> s

((~) * signature (Date -> m ()), MonadIO m) => MethodInfo * CookieSetExpiresMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetExpiresMethodInfo Cookie -> signature -> s

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetDomainMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetDomainMethodInfo Cookie -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetValueMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetValueMethodInfo Cookie -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * CookieGetSecureMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetSecureMethodInfo Cookie -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetPathMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetPathMethodInfo Cookie -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetNameMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetNameMethodInfo Cookie -> signature -> s

((~) * signature (m Bool), MonadIO m) => MethodInfo * CookieGetHttpOnlyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetHttpOnlyMethodInfo Cookie -> signature -> s

((~) * signature (m Date), MonadIO m) => MethodInfo * CookieGetExpiresMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetExpiresMethodInfo Cookie -> signature -> s

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetDomainMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetDomainMethodInfo Cookie -> signature -> s

((~) * signature (m ()), MonadIO m) => MethodInfo * CookieFreeMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieFreeMethodInfo Cookie -> signature -> s

((~) * signature (Cookie -> m Bool), MonadIO m) => MethodInfo * CookieEqualMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieEqualMethodInfo Cookie -> signature -> s

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * CookieDomainMatchesMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieDomainMatchesMethodInfo Cookie -> signature -> s

((~) * signature (m Cookie), MonadIO m) => MethodInfo * CookieCopyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieCopyMethodInfo Cookie -> signature -> s

((~) * signature (URI -> m Bool), MonadIO m) => MethodInfo * CookieAppliesToUriMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieAppliesToUriMethodInfo Cookie -> signature -> s

type AttributeList Cookie

type AttributeList Cookie

newZeroCookie :: MonadIO m => m Cookie

Construct a Cookie struct initialized to zero.

noCookie :: Maybe Cookie

Methods

appliesToUri

data CookieAppliesToUriMethodInfo

Instances

((~) * signature (URI -> m Bool), MonadIO m) => MethodInfo * CookieAppliesToUriMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieAppliesToUriMethodInfo Cookie -> signature -> s

cookieAppliesToUri

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> URI

uri: a URI

-> m Bool

Returns: True if cookie should be sent to uri, False if not

Tests if cookie should be sent to uri.

(At the moment, this does not check that cookie's domain matches uri, because it assumes that the caller has already done that. But don't rely on that; it may change in the future.)

Since: 2.24

copy

data CookieCopyMethodInfo

Instances

((~) * signature (m Cookie), MonadIO m) => MethodInfo * CookieCopyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieCopyMethodInfo Cookie -> signature -> s

cookieCopy

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Cookie

Returns: a copy of cookie

Copies cookie.

Since: 2.24

domainMatches

data CookieDomainMatchesMethodInfo

Instances

((~) * signature (Text -> m Bool), MonadIO m) => MethodInfo * CookieDomainMatchesMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieDomainMatchesMethodInfo Cookie -> signature -> s

cookieDomainMatches

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Text

host: a URI

-> m Bool

Returns: True if the domains match, False otherwise

Checks if the cookie's domain and host match in the sense that cookie should be sent when making a request to host, or that cookie should be accepted when receiving a response from host.

Since: 2.30

equal

data CookieEqualMethodInfo

Instances

((~) * signature (Cookie -> m Bool), MonadIO m) => MethodInfo * CookieEqualMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieEqualMethodInfo Cookie -> signature -> s

cookieEqual

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie1: a Cookie

-> Cookie

cookie2: a Cookie

-> m Bool

Returns: whether the cookies are equal.

Tests if cookie1 and cookie2 are equal.

Note that currently, this does not check that the cookie domains match. This may change in the future.

Since: 2.24

free

data CookieFreeMethodInfo

Instances

((~) * signature (m ()), MonadIO m) => MethodInfo * CookieFreeMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieFreeMethodInfo Cookie -> signature -> s

cookieFree

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m ()

Frees cookie

Since: 2.24

getDomain

data CookieGetDomainMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetDomainMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetDomainMethodInfo Cookie -> signature -> s

cookieGetDomain

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: cookie's domain

Gets cookie's domain

Since: 2.32

getExpires

data CookieGetExpiresMethodInfo

Instances

((~) * signature (m Date), MonadIO m) => MethodInfo * CookieGetExpiresMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetExpiresMethodInfo Cookie -> signature -> s

cookieGetExpires

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Date

Returns: cookie's expiration time, which is owned by cookie and should not be modified or freed.

Gets cookie's expiration time

Since: 2.32

getHttpOnly

data CookieGetHttpOnlyMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * CookieGetHttpOnlyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetHttpOnlyMethodInfo Cookie -> signature -> s

cookieGetHttpOnly

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Bool

Returns: cookie's HttpOnly attribute

Gets cookie's HttpOnly attribute

Since: 2.32

getName

data CookieGetNameMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetNameMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetNameMethodInfo Cookie -> signature -> s

cookieGetName

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: cookie's name

Gets cookie's name

Since: 2.32

getPath

data CookieGetPathMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetPathMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetPathMethodInfo Cookie -> signature -> s

cookieGetPath

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: cookie's path

Gets cookie's path

Since: 2.32

getSecure

data CookieGetSecureMethodInfo

Instances

((~) * signature (m Bool), MonadIO m) => MethodInfo * CookieGetSecureMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetSecureMethodInfo Cookie -> signature -> s

cookieGetSecure

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Bool

Returns: cookie's secure attribute

Gets cookie's secure attribute

Since: 2.32

getValue

data CookieGetValueMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieGetValueMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieGetValueMethodInfo Cookie -> signature -> s

cookieGetValue

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: cookie's value

Gets cookie's value

Since: 2.32

new

cookieNew

Arguments

:: (HasCallStack, MonadIO m)

=> Text

name: cookie name

-> Text

value: cookie value

-> Text

domain: cookie domain or hostname

-> Text

path: cookie path, or Nothing

-> Int32

maxAge: max age of the cookie, or -1 for a session cookie

-> m Cookie

Returns: a new Cookie.

Creates a new Cookie with the given attributes. (Use cookieSetSecure and cookieSetHttpOnly if you need to set those attributes on the returned cookie.)

If domain starts with ".", that indicates a domain (which matches the string after the ".", or any hostname that has domain as a suffix). Otherwise, it is a hostname and must match exactly.

maxAge is used to set the "expires" attribute on the cookie; pass -1 to not include the attribute (indicating that the cookie expires with the current session), 0 for an already-expired cookie, or a lifetime in seconds. You can use the constants COOKIE_MAX_AGE_ONE_HOUR, COOKIE_MAX_AGE_ONE_DAY, COOKIE_MAX_AGE_ONE_WEEK and COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate this value. (If you really care about setting the exact time that the cookie will expire, use cookieSetExpires.)

Since: 2.24

parse

cookieParse

Arguments

:: (HasCallStack, MonadIO m)

=> Text

header: a cookie string (eg, the value of a Set-Cookie header)

-> URI

origin: origin of the cookie, or Nothing

-> m (Maybe Cookie)

Returns: a new Cookie, or Nothing if it could not be parsed, or contained an illegal "domain" attribute for a cookie originating from origin.

Parses header and returns a Cookie. (If header contains multiple cookies, only the first one will be parsed.)

If header does not have "path" or "domain" attributes, they will be defaulted from origin. If origin is Nothing, path will default to "/", but domain will be left as Nothing. Note that this is not a valid state for a Cookie, and you will need to fill in some appropriate string for the domain if you want to actually make use of the cookie.

Since: 2.24

setDomain

data CookieSetDomainMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetDomainMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetDomainMethodInfo Cookie -> signature -> s

cookieSetDomain

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Text

domain: the new domain

-> m ()

Sets cookie's domain to domain

Since: 2.24

setExpires

data CookieSetExpiresMethodInfo

Instances

((~) * signature (Date -> m ()), MonadIO m) => MethodInfo * CookieSetExpiresMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetExpiresMethodInfo Cookie -> signature -> s

cookieSetExpires

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Date

expires: the new expiration time, or Nothing

-> m ()

Sets cookie's expiration time to expires. If expires is Nothing, cookie will be a session cookie and will expire at the end of the client's session.

(This sets the same property as cookieSetMaxAge.)

Since: 2.24

setHttpOnly

data CookieSetHttpOnlyMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * CookieSetHttpOnlyMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetHttpOnlyMethodInfo Cookie -> signature -> s

cookieSetHttpOnly

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Bool

httpOnly: the new value for the HttpOnly attribute

-> m ()

Sets cookie's HttpOnly attribute to httpOnly. If True, cookie will be marked as "http only", meaning it should not be exposed to web page scripts or other untrusted code.

Since: 2.24

setMaxAge

data CookieSetMaxAgeMethodInfo

Instances

((~) * signature (Int32 -> m ()), MonadIO m) => MethodInfo * CookieSetMaxAgeMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetMaxAgeMethodInfo Cookie -> signature -> s

cookieSetMaxAge

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Int32

maxAge: the new max age

-> m ()

Sets cookie's max age to maxAge. If maxAge is -1, the cookie is a session cookie, and will expire at the end of the client's session. Otherwise, it is the number of seconds until the cookie expires. You can use the constants COOKIE_MAX_AGE_ONE_HOUR, COOKIE_MAX_AGE_ONE_DAY, COOKIE_MAX_AGE_ONE_WEEK and COOKIE_MAX_AGE_ONE_YEAR (or multiples thereof) to calculate this value. (A value of 0 indicates that the cookie should be considered already-expired.)

(This sets the same property as cookieSetExpires.)

Since: 2.24

setName

data CookieSetNameMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetNameMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetNameMethodInfo Cookie -> signature -> s

cookieSetName

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Text

name: the new name

-> m ()

Sets cookie's name to name

Since: 2.24

setPath

data CookieSetPathMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetPathMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetPathMethodInfo Cookie -> signature -> s

cookieSetPath

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Text

path: the new path

-> m ()

Sets cookie's path to path

Since: 2.24

setSecure

data CookieSetSecureMethodInfo

Instances

((~) * signature (Bool -> m ()), MonadIO m) => MethodInfo * CookieSetSecureMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetSecureMethodInfo Cookie -> signature -> s

cookieSetSecure

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Bool

secure: the new value for the secure attribute

-> m ()

Sets cookie's secure attribute to secure. If True, cookie will only be transmitted from the client to the server over secure (https) connections.

Since: 2.24

setValue

data CookieSetValueMethodInfo

Instances

((~) * signature (Text -> m ()), MonadIO m) => MethodInfo * CookieSetValueMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieSetValueMethodInfo Cookie -> signature -> s

cookieSetValue

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> Text

value: the new value

-> m ()

Sets cookie's value to value

Since: 2.24

toCookieHeader

data CookieToCookieHeaderMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieToCookieHeaderMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieToCookieHeaderMethodInfo Cookie -> signature -> s

cookieToCookieHeader

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: the header

Serializes cookie in the format used by the Cookie header (ie, for returning a cookie from a Session to a server).

Since: 2.24

toSetCookieHeader

data CookieToSetCookieHeaderMethodInfo

Instances

((~) * signature (m Text), MonadIO m) => MethodInfo * CookieToSetCookieHeaderMethodInfo Cookie signature

Methods

overloadedMethod :: MethodProxy CookieToSetCookieHeaderMethodInfo Cookie -> signature -> s

cookieToSetCookieHeader

Arguments

:: (HasCallStack, MonadIO m)

=> Cookie

cookie: a Cookie

-> m Text

Returns: the header

Serializes cookie in the format used by the Set-Cookie header (ie, for sending a cookie from a Server to a client).

Since: 2.24

Properties

domain

clearCookieDomain :: MonadIO m => Cookie -> m ()

cookie_domain :: AttrLabelProxy "domain"

getCookieDomain :: MonadIO m => Cookie -> m (Maybe Text)

setCookieDomain :: MonadIO m => Cookie -> CString -> m ()

expires

clearCookieExpires :: MonadIO m => Cookie -> m ()

cookie_expires :: AttrLabelProxy "expires"

getCookieExpires :: MonadIO m => Cookie -> m (Maybe Date)

setCookieExpires :: MonadIO m => Cookie -> Ptr Date -> m ()

httpOnly

cookie_httpOnly :: AttrLabelProxy "httpOnly"

getCookieHttpOnly :: MonadIO m => Cookie -> m Bool

setCookieHttpOnly :: MonadIO m => Cookie -> Bool -> m ()

name

clearCookieName :: MonadIO m => Cookie -> m ()

cookie_name :: AttrLabelProxy "name"

getCookieName :: MonadIO m => Cookie -> m (Maybe Text)

setCookieName :: MonadIO m => Cookie -> CString -> m ()

path

clearCookiePath :: MonadIO m => Cookie -> m ()

cookie_path :: AttrLabelProxy "path"

getCookiePath :: MonadIO m => Cookie -> m (Maybe Text)

setCookiePath :: MonadIO m => Cookie -> CString -> m ()

secure

cookie_secure :: AttrLabelProxy "secure"

getCookieSecure :: MonadIO m => Cookie -> m Bool

setCookieSecure :: MonadIO m => Cookie -> Bool -> m ()

value

clearCookieValue :: MonadIO m => Cookie -> m ()

cookie_value :: AttrLabelProxy "value"

getCookieValue :: MonadIO m => Cookie -> m (Maybe Text)

setCookieValue :: MonadIO m => Cookie -> CString -> m ()