Network.CGI.Cookie

TODO

• Add client side stuff (basically parsing Set-Cookie: value)
• Update for RFC2109 http://www.ietf.org/rfc/rfc2109.txt

Documentation

data Cookie

Contains all information about a cookie set by the server.

Constructors

Cookie

Fields

• cookieName :: String

  Name of the cookie.

• cookieValue :: String

  Value of the cookie.

• cookieExpires :: Maybe CalendarTime

  Expiry date of the cookie. If Nothing, the cookie expires when the browser sessions ends. If the date is in the past, the client should delete the cookie immediately.

• cookieDomain :: Maybe String

  The domain suffix to which this cookie will be sent.

• cookiePath :: Maybe String

  The path to which this cookie will be sent.

• cookieSecure :: Bool

  True if this cookie should only be sent using secure means.

Instances

Eq Cookie

Methods

(==) :: Cookie -> Cookie -> Bool

(/=) :: Cookie -> Cookie -> Bool

Ord Cookie

Methods

compare :: Cookie -> Cookie -> Ordering

(<) :: Cookie -> Cookie -> Bool

(<=) :: Cookie -> Cookie -> Bool

(>) :: Cookie -> Cookie -> Bool

(>=) :: Cookie -> Cookie -> Bool

max :: Cookie -> Cookie -> Cookie

min :: Cookie -> Cookie -> Cookie

Read Cookie

Methods

readsPrec :: Int -> ReadS Cookie

readList :: ReadS [Cookie]

readPrec :: ReadPrec Cookie

readListPrec :: ReadPrec [Cookie]

Show Cookie

Methods

showsPrec :: Int -> Cookie -> ShowS

show :: Cookie -> String

showList :: [Cookie] -> ShowS

newCookie

Arguments

:: String

Name

-> String

Value

-> Cookie

Cookie

Construct a cookie with only name and value set. This client will expire when the browser sessions ends, will only be sent to the server and path which set it and may be sent using any means.

findCookie

Arguments

:: String

Cookie name

-> String

Semicolon separated list of name-value pairs

-> Maybe String

Cookie value, if found

Get the value of a cookie from a string on the form "cookieName1=cookieValue1;...;cookieName2=cookieValue2". This is the format of the Cookie HTTP header.

deleteCookie

Arguments

:: Cookie

Cookie to delete. The only fields that matter are cookieName, cookieDomain and cookiePath

-> Cookie

Delete a cookie from the client by setting the cookie expiry date to a date in the past.

showCookie :: Cookie -> String

Show a cookie on the format used as the value of the Set-Cookie header.

readCookies

Arguments

:: String

String to parse

-> [(String, String)]

Cookie name - cookie value pairs

Gets all the cookies from a Cookie: header value