KCookieJar Class Reference
List of all members.Detailed Description
Definition at line 114 of file kcookiejar.h.
Public Member Functions | |
KCookieJar () | |
~KCookieJar () | |
bool | changed () const |
bool | saveCookies (const QString &_filename) |
bool | loadCookies (const QString &_filename) |
void | saveConfig (KConfig *_config) |
void | loadConfig (KConfig *_config, bool reparse=false) |
QString | findCookies (const QString &_url, bool useDOMFormat, long windowId, KHttpCookieList *pendingCookies=0) |
KHttpCookieList | makeCookies (const QString &_url, const QCString &cookie_headers, long windowId) |
KHttpCookieList | makeDOMCookies (const QString &_url, const QCString &cookie_domstr, long windowId) |
void | addCookie (KHttpCookiePtr &cookiePtr) |
KCookieAdvice | cookieAdvice (KHttpCookiePtr cookiePtr) |
KCookieAdvice | getDomainAdvice (const QString &_domain) |
void | setDomainAdvice (const QString &_domain, KCookieAdvice _advice) |
void | setDomainAdvice (KHttpCookiePtr _cookie, KCookieAdvice _advice) |
KCookieAdvice | getGlobalAdvice () |
void | setGlobalAdvice (KCookieAdvice _advice) |
const QStringList & | getDomainList () |
const KHttpCookieList * | getCookieList (const QString &_domain, const QString &_fqdn) |
void | eatCookie (KHttpCookiePtr cookiePtr) |
void | eatCookiesForDomain (const QString &domain) |
void | eatAllCookies () |
void | eatSessionCookies (long windowId) |
void | eatSessionCookies (const QString &fqdn, long windowId, bool isFQDN=true) |
void | extractDomains (const QString &_fqdn, QStringList &_domainList) |
int | preferredDefaultPolicy () const |
bool | showCookieDetails () const |
void | setPreferredDefaultPolicy (int value) |
void | setShowCookieDetails (bool value) |
Static Public Member Functions | |
static bool | parseURL (const QString &_url, QString &_fqdn, QString &_path) |
static QString | adviceToStr (KCookieAdvice _advice) |
static KCookieAdvice | strToAdvice (const QString &_str) |
Protected Member Functions | |
void | stripDomain (const QString &_fqdn, QString &_domain) |
QString | stripDomain (KHttpCookiePtr cookiePtr) |
Protected Attributes | |
QStringList | m_domainList |
KCookieAdvice | m_globalAdvice |
QDict< KHttpCookieList > | m_cookieDomains |
QDict< int > | m_twoLevelTLD |
bool | m_configChanged |
bool | m_cookiesChanged |
bool | m_showCookieDetails |
bool | m_rejectCrossDomainCookies |
bool | m_autoAcceptSessionCookies |
bool | m_ignoreCookieExpirationDate |
int | m_preferredPolicy |
Constructor & Destructor Documentation
KCookieJar::KCookieJar | ( | ) |
Constructs a new cookie jar.
One jar should be enough for all cookies.
Definition at line 251 of file kcookiejar.cpp.
KCookieJar::~KCookieJar | ( | ) |
Destructs the cookie jar.
Poor little cookies, they will all be eaten by the cookie monster!
Definition at line 272 of file kcookiejar.cpp.
Member Function Documentation
void KCookieJar::addCookie | ( | KHttpCookiePtr & | cookiePtr | ) |
This function hands a KHttpCookie object over to the cookie jar.
On return cookiePtr is set to 0.
Definition at line 920 of file kcookiejar.cpp.
bool KCookieJar::changed | ( | ) | const [inline] |
KCookieAdvice KCookieJar::cookieAdvice | ( | KHttpCookiePtr | cookiePtr | ) |
This function advices whether a single KHttpCookie object should be added to the cookie jar.
Possible return values are:
- KCookieAccept, the cookie should be added
- KCookieReject, the cookie should not be added
- KCookieAsk, the user should decide what to do
Definition at line 982 of file kcookiejar.cpp.
void KCookieJar::eatAllCookies | ( | ) |
void KCookieJar::eatCookie | ( | KHttpCookiePtr | cookiePtr | ) |
Remove & delete a cookie from the jar.
cookiePtr should be one of the entries in a KHttpCookieList. Update your KHttpCookieList by calling getCookieList after calling this function.
Definition at line 1161 of file kcookiejar.cpp.
void KCookieJar::eatCookiesForDomain | ( | const QString & | domain | ) |
void KCookieJar::eatSessionCookies | ( | const QString & | fqdn, | |
long | windowId, | |||
bool | isFQDN = true | |||
) |
Removes all end of session cookies set by the session windId
.
Definition at line 1219 of file kcookiejar.cpp.
void KCookieJar::eatSessionCookies | ( | long | windowId | ) |
Removes all end of session cookies set by the session windId
.
Definition at line 1198 of file kcookiejar.cpp.
void KCookieJar::extractDomains | ( | const QString & | _fqdn, | |
QStringList & | _domainList | |||
) |
Returns a list of domains in _domainList
relevant for this host.
The list is sorted with the FQDN listed first and the top-most domain listed last
Definition at line 611 of file kcookiejar.cpp.
QString KCookieJar::findCookies | ( | const QString & | _url, | |
bool | useDOMFormat, | |||
long | windowId, | |||
KHttpCookieList * | pendingCookies = 0 | |||
) |
Looks for cookies in the cookie jar which are appropriate for _url.
Returned is a string containing all appropriate cookies in a format which can be added to a HTTP-header without any additional processing.
If useDOMFormat
is true, the string is formatted in a format in compliance with the DOM standard. pendingCookies
contains a list of cookies that have not been approved yet by the user but that will be included in the result none the less.
Definition at line 327 of file kcookiejar.cpp.
const KHttpCookieList * KCookieJar::getCookieList | ( | const QString & | _domain, | |
const QString & | _fqdn | |||
) |
Get a list of all cookies in the cookie jar originating from _domain.
Definition at line 1144 of file kcookiejar.cpp.
KCookieAdvice KCookieJar::getDomainAdvice | ( | const QString & | _domain | ) |
This function gets the advice for all cookies originating from _domain.
- KCookieDunno, no specific advice for _domain
- KCookieAccept, accept all cookies for _domain
- KCookieReject, reject all cookies for _domain
- KCookieAsk, the user decides what to do with cookies for _domain
Definition at line 1050 of file kcookiejar.cpp.
const QStringList & KCookieJar::getDomainList | ( | ) |
Get a list of all domains known to the cookie jar.
A domain is known to the cookie jar if:
- It has a cookie originating from the domain
- It has a specific advice set for the domain
Definition at line 1136 of file kcookiejar.cpp.
KCookieAdvice KCookieJar::getGlobalAdvice | ( | ) | [inline] |
Get the global advice for cookies.
The returned advice can have the following values:
- KCookieAccept, accept cookies
- KCookieReject, reject cookies
- KCookieAsk, the user decides what to do with cookies
The global advice is used if the domain has no advice set.
Definition at line 252 of file kcookiejar.h.
void KCookieJar::loadConfig | ( | KConfig * | _config, | |
bool | reparse = false | |||
) |
bool KCookieJar::loadCookies | ( | const QString & | _filename | ) |
Load all the cookies from file and add them to the cookie jar.
Definition at line 1367 of file kcookiejar.cpp.
KHttpCookieList KCookieJar::makeCookies | ( | const QString & | _url, | |
const QCString & | cookie_headers, | |||
long | windowId | |||
) |
This function parses cookie_headers and returns a linked list of valid KHttpCookie objects for all cookies found in cookie_headers.
If no cookies could be found 0 is returned.
cookie_headers should be a concatenation of all lines of a HTTP-header which start with "Set-Cookie". The lines should be separated by '
's.
Definition at line 690 of file kcookiejar.cpp.
KHttpCookieList KCookieJar::makeDOMCookies | ( | const QString & | _url, | |
const QCString & | cookie_domstr, | |||
long | windowId | |||
) |
This function parses cookie_headers and returns a linked list of valid KHttpCookie objects for all cookies found in cookie_headers.
If no cookies could be found 0 is returned.
cookie_domstr should be a concatenation of "name=value" pairs, separated by a semicolon ';'.
Definition at line 855 of file kcookiejar.cpp.
Parses _url and returns the FQDN (_fqdn) and path (_path).
Definition at line 573 of file kcookiejar.cpp.
int KCookieJar::preferredDefaultPolicy | ( | ) | const [inline] |
void KCookieJar::saveConfig | ( | KConfig * | _config | ) |
bool KCookieJar::saveCookies | ( | const QString & | _filename | ) |
void KCookieJar::setDomainAdvice | ( | KHttpCookiePtr | _cookie, | |
KCookieAdvice | _advice | |||
) |
This function sets the advice for all cookies originating from the same domain as _cookie.
_advice can have the following values:
- KCookieDunno, no specific advice for _domain
- KCookieAccept, accept all cookies for _domain
- KCookieReject, reject all cookies for _domain
- KCookieAsk, the user decides what to do with cookies for _domain
Definition at line 1115 of file kcookiejar.cpp.
void KCookieJar::setDomainAdvice | ( | const QString & | _domain, | |
KCookieAdvice | _advice | |||
) |
This function sets the advice for all cookies originating from _domain.
_advice can have the following values:
- KCookieDunno, no specific advice for _domain
- KCookieAccept, accept all cookies for _domain
- KCookieReject, reject all cookies for _domain
- KCookieAsk, the user decides what to do with cookies for _domain
Definition at line 1071 of file kcookiejar.cpp.
void KCookieJar::setGlobalAdvice | ( | KCookieAdvice | _advice | ) |
This function sets the global advice for cookies.
_advice can have the following values:
- KCookieAccept, accept cookies
- KCookieReject, reject cookies
- KCookieAsk, the user decides what to do with cookies
The global advice is used if the domain has no advice set.
Definition at line 1126 of file kcookiejar.cpp.
void KCookieJar::setPreferredDefaultPolicy | ( | int | value | ) | [inline] |
void KCookieJar::setShowCookieDetails | ( | bool | value | ) | [inline] |
Sets the user's preference of level of detail displayed by the cookie dialog.
Definition at line 344 of file kcookiejar.h.
bool KCookieJar::showCookieDetails | ( | ) | const [inline] |
The documentation for this class was generated from the following files: