qtwebapp::HttpCookie Class Reference

#include <httpcookie.h>

Public Member Functions
	HttpCookie ()
	HttpCookie (const QByteArray name, const QByteArray value, const int maxAge, const QByteArray path="/", const QByteArray comment=QByteArray(), const QByteArray domain=QByteArray(), const bool secure=false, const bool httpOnly=false)
	HttpCookie (const QByteArray source)
QByteArray	toByteArray () const
void	setName (const QByteArray name)
void	setValue (const QByteArray value)
void	setComment (const QByteArray comment)
void	setDomain (const QByteArray domain)
void	setMaxAge (const int maxAge)
void	setPath (const QByteArray path)
void	setSecure (const bool secure)
void	setHttpOnly (const bool httpOnly)
QByteArray	getName () const
QByteArray	getValue () const
QByteArray	getComment () const
QByteArray	getDomain () const
int	getMaxAge () const
QByteArray	getPath () const
bool	getSecure () const
bool	getHttpOnly () const
int	getVersion () const

Static Public Member Functions
static QList< QByteArray >	splitCSV (const QByteArray source)

Private Attributes
QByteArray	name
QByteArray	value
QByteArray	comment
QByteArray	domain
int	maxAge
QByteArray	path
bool	secure
bool	httpOnly
int	version

Detailed Description

HTTP cookie as defined in RFC 2109. This class can also parse RFC 2965 cookies, but skips fields that are not defined in RFC 2109.

Definition at line 23 of file httpcookie.h.

Constructor & Destructor Documentation

HttpCookie() [1/3]

HttpCookie::HttpCookie

(

)

Creates an empty cookie

Definition at line 10 of file httpcookie.cpp.

References httpOnly, maxAge, secure, and version.

{
    version=1;
    maxAge=0;
    secure=false;
    httpOnly=false;
}

HttpCookie() [2/3]

HttpCookie::HttpCookie	(	const QByteArray	name,
		const QByteArray	value,
		const int	maxAge,
		const QByteArray	path = "/",
		const QByteArray	comment = QByteArray(),
		const QByteArray	domain = QByteArray(),
		const bool	secure = false,
		const bool	httpOnly = false
	)

Create a cookie and set name/value pair.

Parameters

name	name of the cookie
value	value of the cookie
maxAge	maximum age of the cookie in seconds. 0=discard immediately
path	Path for that the cookie will be sent, default="/" which means the whole domain
comment	Optional comment, may be displayed by the web browser somewhere
domain	Optional domain for that the cookie will be sent. Defaults to the current domain
secure	If true, the cookie will be sent by the browser to the server only on secure connections
httpOnly	If true, the browser does not allow client-side scripts to access the cookie

Definition at line 18 of file httpcookie.cpp.

References comment, domain, httpOnly, maxAge, name, path, secure, value, and version.

{
    this->name=name;
    this->value=value;
    this->maxAge=maxAge;
    this->path=path;
    this->comment=comment;
    this->domain=domain;
    this->secure=secure;
    this->httpOnly=httpOnly;
    this->version=1;
}

HttpCookie() [3/3]

HttpCookie::HttpCookie

(

const QByteArray

source

)

Create a cookie from a string.

Parameters

source

String as received in a HTTP Cookie2 header.

Definition at line 31 of file httpcookie.cpp.

References comment, domain, httpOnly, maxAge, name, path, secure, splitCSV(), value, and version.

{
    version=1;
    maxAge=0;
    secure=false;
    QList<QByteArray> list=splitCSV(source);
    foreach(QByteArray part, list)
    {

        // Split the part into name and value
        QByteArray name;
        QByteArray value;
        int posi=part.indexOf('=');
        if (posi)
        {
            name=part.left(posi).trimmed();
            value=part.mid(posi+1).trimmed();
        }
        else
        {
            name=part.trimmed();
            value="";
        }

        // Set fields
        if (name=="Comment")
        {
            comment=value;
        }
        else if (name=="Domain")
        {
            domain=value;
        }
        else if (name=="Max-Age")
        {
            maxAge=value.toInt();
        }
        else if (name=="Path")
        {
            path=value;
        }
        else if (name=="Secure")
        {
            secure=true;
        }
        else if (name=="HttpOnly")
        {
            httpOnly=true;
        }
        else if (name=="Version")
        {
            version=value.toInt();
        }
        else {
            if (this->name.isEmpty())
            {
                this->name=name;
                this->value=value;
            }
            else
            {
                qWarning("HttpCookie::HttpCookie: Ignoring unknown %s=%s",name.data(),value.data());
            }
        }
    }
}

Here is the call graph for this function:

Member Function Documentation

getComment()

QByteArray HttpCookie::getComment

(

)

const

Get the comment of this cookie

Definition at line 184 of file httpcookie.cpp.

References comment.

{
    return comment;
}

getDomain()

QByteArray HttpCookie::getDomain

(

)

const

Get the domain of this cookie

Definition at line 189 of file httpcookie.cpp.

References domain.

{
    return domain;
}

getHttpOnly()

bool HttpCookie::getHttpOnly

(

)

const

Get the HTTP-only flag of this cookie

Definition at line 209 of file httpcookie.cpp.

References httpOnly.

{
    return httpOnly;
}

getMaxAge()

int HttpCookie::getMaxAge

(

)

const

Get the maximum age of this cookie in seconds.

Definition at line 194 of file httpcookie.cpp.

References maxAge.

{
    return maxAge;
}

getName()

QByteArray HttpCookie::getName

(

)

const

Get the name of this cookie

Definition at line 174 of file httpcookie.cpp.

References name.

Referenced by qtwebapp::HttpResponse::setCookie().

{
    return name;
}

Here is the caller graph for this function:

getPath()

QByteArray HttpCookie::getPath

(

)

const

Set the path of this cookie

Definition at line 199 of file httpcookie.cpp.

References path.

{
    return path;
}

getSecure()

bool HttpCookie::getSecure

(

)

const

Get the secure flag of this cookie

Definition at line 204 of file httpcookie.cpp.

References secure.

{
    return secure;
}

getValue()

QByteArray HttpCookie::getValue

(

)

const

Get the value of this cookie

Definition at line 179 of file httpcookie.cpp.

References value.

{
    return value;
}

getVersion()

int HttpCookie::getVersion

(

)

const

Returns always 1

Definition at line 214 of file httpcookie.cpp.

References version.

{
    return version;
}

setComment()

void HttpCookie::setComment

(

const QByteArray

comment

)

Set the comment of this cookie

Definition at line 144 of file httpcookie.cpp.

References comment.

{
    this->comment=comment;
}

setDomain()

void HttpCookie::setDomain

(

const QByteArray

domain

)

Set the domain of this cookie

Definition at line 149 of file httpcookie.cpp.

References domain.

{
    this->domain=domain;
}

setHttpOnly()

void HttpCookie::setHttpOnly

(

const bool

httpOnly

)

Set HTTP-only mode, so that he browser does not allow client-side scripts to access the cookie

Definition at line 169 of file httpcookie.cpp.

References httpOnly.

{
    this->httpOnly=httpOnly;
}

setMaxAge()

void HttpCookie::setMaxAge

(

const int

maxAge

)

Set the maximum age of this cookie in seconds. 0=discard immediately

Definition at line 154 of file httpcookie.cpp.

References maxAge.

{
    this->maxAge=maxAge;
}

setName()

void HttpCookie::setName

(

const QByteArray

name

)

Set the name of this cookie

Definition at line 134 of file httpcookie.cpp.

References name.

{
    this->name=name;
}

setPath()

void HttpCookie::setPath

(

const QByteArray

path

)

Set the path for that the cookie will be sent, default="/" which means the whole domain

Definition at line 159 of file httpcookie.cpp.

References path.

{
    this->path=path;
}

setSecure()

void HttpCookie::setSecure

(

const bool

secure

)

Set secure mode, so that the cookie will be sent by the browser to the server only on secure connections

Definition at line 164 of file httpcookie.cpp.

References secure.

{
    this->secure=secure;
}

setValue()

void HttpCookie::setValue

(

const QByteArray

value

)

Set the value of this cookie

Definition at line 139 of file httpcookie.cpp.

References value.

{
    this->value=value;
}

splitCSV()

QList< QByteArray > HttpCookie::splitCSV ( const QByteArray  source )

static

Split a string list into parts, where each part is delimited by semicolon. Semicolons within double quotes are skipped. Double quotes are removed.

Definition at line 219 of file httpcookie.cpp.

References i.

Referenced by qtwebapp::HttpRequest::extractCookies(), and HttpCookie().

{
    bool inString=false;
    QList<QByteArray> list;
    QByteArray buffer;
    for (int i=0; i<source.size(); ++i)
    {
        char c=source.at(i);
        if (inString==false)
        {
            if (c=='\"')
            {
                inString=true;
            }
            else if (c==';')
            {
                QByteArray trimmed=buffer.trimmed();
                if (!trimmed.isEmpty())
                {
                    list.append(trimmed);
                }
                buffer.clear();
            }
            else
            {
                buffer.append(c);
            }
        }
        else
        {
            if (c=='\"')
            {
                inString=false;
            }
            else {
                buffer.append(c);
            }
        }
    }
    QByteArray trimmed=buffer.trimmed();
    if (!trimmed.isEmpty())
    {
        list.append(trimmed);
    }
    return list;
}

Here is the caller graph for this function:

toByteArray()

QByteArray HttpCookie::toByteArray

(

)

const

Convert this cookie to a string that may be used in a Set-Cookie header.

Definition at line 98 of file httpcookie.cpp.

References comment, domain, httpOnly, maxAge, name, path, secure, value, and version.

Referenced by qtwebapp::HttpResponse::writeHeaders().

{
    QByteArray buffer(name);
    buffer.append('=');
    buffer.append(value);
    if (!comment.isEmpty())
    {
        buffer.append("; Comment=");
        buffer.append(comment);
    }
    if (!domain.isEmpty())
    {
        buffer.append("; Domain=");
        buffer.append(domain);
    }
    if (maxAge!=0)
    {
        buffer.append("; Max-Age=");
        buffer.append(QByteArray::number(maxAge));
    }
    if (!path.isEmpty())
    {
        buffer.append("; Path=");
        buffer.append(path);
    }
    if (secure) {
        buffer.append("; Secure");
    }
    if (httpOnly) {
        buffer.append("; HttpOnly");
    }
    buffer.append("; Version=");
    buffer.append(QByteArray::number(version));
    return buffer;
}

Here is the caller graph for this function:

Member Data Documentation

comment

QByteArray qtwebapp::HttpCookie::comment

private

Definition at line 113 of file httpcookie.h.

Referenced by getComment(), HttpCookie(), setComment(), and toByteArray().

domain

QByteArray qtwebapp::HttpCookie::domain

private

Definition at line 114 of file httpcookie.h.

Referenced by getDomain(), HttpCookie(), setDomain(), and toByteArray().

httpOnly

bool qtwebapp::HttpCookie::httpOnly

private

Definition at line 118 of file httpcookie.h.

Referenced by getHttpOnly(), HttpCookie(), setHttpOnly(), and toByteArray().

maxAge

int qtwebapp::HttpCookie::maxAge

private

Definition at line 115 of file httpcookie.h.

Referenced by getMaxAge(), HttpCookie(), setMaxAge(), and toByteArray().

name

QByteArray qtwebapp::HttpCookie::name

private

Definition at line 111 of file httpcookie.h.

Referenced by getName(), HttpCookie(), setName(), and toByteArray().

path

QByteArray qtwebapp::HttpCookie::path

private

Definition at line 116 of file httpcookie.h.

Referenced by getPath(), HttpCookie(), setPath(), and toByteArray().

secure

bool qtwebapp::HttpCookie::secure

private

Definition at line 117 of file httpcookie.h.

Referenced by getSecure(), HttpCookie(), setSecure(), and toByteArray().

value

QByteArray qtwebapp::HttpCookie::value

private

Definition at line 112 of file httpcookie.h.

Referenced by getValue(), HttpCookie(), setValue(), and toByteArray().

version

int qtwebapp::HttpCookie::version

private

Definition at line 119 of file httpcookie.h.

Referenced by getVersion(), HttpCookie(), and toByteArray().

---

The documentation for this class was generated from the following files:

• httpserver/httpcookie.h
• httpserver/httpcookie.cpp