cgi-3001.1.8.5: A library for writing CGI programs

Portabilityportable General server side HTTP cookie library. Based on <http://wp.netscape.com/newsref/std/cookie_spec.html>
Stabilityexperimental
MaintainerAnders Kaseorg <andersk@mit.edu>
Safe HaskellSafe-Inferred

Network.CGI.Cookie

Description

TODO

Synopsis

Documentation

data Cookie Source

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.

newCookieSource

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.

findCookieSource

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.

deleteCookieSource

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 -> StringSource

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

readCookiesSource

Arguments

:: String

String to parse

-> [(String, String)]

Cookie name - cookie value pairs

Gets all the cookies from a Cookie: header value