kcookiejar.h

/*
    This file is part of the KDE File Manager
 
    Copyright (C) 1998 Waldo Bastian (bastian@kde.org)
 
    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU General Public License
    version 2 as published by the Free Software Foundation.
 
    This software is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    General Public License for more details.
 
    You should have received a copy of the GNU General Public License
    along with this library; see the file COPYING. If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/
//----------------------------------------------------------------------------
//
// KDE File Manager -- HTTP Cookies
// $Id$
 
#ifndef KCOOKIEJAR_H
#define KCOOKIEJAR_H
 
#include <tqstring.h>
#include <tqstringlist.h>
#include <tqdict.h>
#include <tqptrlist.h>
#include <time.h>
 
class TDEConfig;
class KCookieJar;
class KHttpCookie;
class KHttpCookieList;
 
typedef KHttpCookie *KHttpCookiePtr;
 
enum KCookieAdvice
{
    KCookieDunno=0,
    KCookieAccept,
    KCookieReject,
    KCookieAsk
};
 
class KHttpCookie
{
    friend class KCookieJar;
    friend class KHttpCookieList;
 
protected:
    TQString mHost;
    TQString mDomain;
    TQString mPath;
    TQString mName;
    TQString mValue;
    time_t  mExpireDate;
    int     mProtocolVersion;
    bool    mSecure;
    bool    mCrossDomain;
    bool    mHttpOnly;
    bool    mExplicitPath;
    TQValueList<long> mWindowIds;
 
    TQString cookieStr(bool useDOMFormat);
 
public:
    KHttpCookie(const TQString &_host=TQString::null,
                const TQString &_domain=TQString::null,
                const TQString &_path=TQString::null,
                const TQString &_name=TQString::null,
                const TQString &_value=TQString::null,
                time_t _expireDate=0,
                int _protocolVersion=0,
                bool _secure = false,
                bool _httpOnly = false,
                bool _explicitPath = false);
 
    TQString domain(void) { return mDomain; }
    TQString host(void) { return mHost; }
    TQString path(void) { return mPath; }
    TQString name(void) { return mName; }
    TQString value(void) { return mValue; }
    TQValueList<long> &windowIds(void) { return mWindowIds; }
    void    fixDomain(const TQString &domain) { mDomain = domain; }
    time_t  expireDate(void) { return mExpireDate; }
    int     protocolVersion(void) { return mProtocolVersion; }
    bool    isSecure(void) { return mSecure; }
    bool    isExpired(time_t currentDate);
    bool    isCrossDomain(void) { return mCrossDomain; }
    bool    isHttpOnly(void) { return mHttpOnly; }
    bool    hasExplicitPath(void) { return mExplicitPath; }
    bool    match(const TQString &fqdn, const TQStringList &domainList, const TQString &path);
};
 
class KHttpCookieList : public TQPtrList<KHttpCookie>
{
public:
    KHttpCookieList() : TQPtrList<KHttpCookie>(), advice( KCookieDunno )
    { }
    virtual ~KHttpCookieList() { }
 
    virtual int compareItems( void * item1, void * item2);
    KCookieAdvice getAdvice(void) { return advice; }
    void setAdvice(KCookieAdvice _advice) { advice = _advice; }
 
private:
    KCookieAdvice advice;
};
 
class KCookieJar
{
public:
    KCookieJar();
 
    ~KCookieJar();
 
    bool changed() const { return m_cookiesChanged || m_configChanged; }
 
    bool saveCookies(const TQString &_filename);
 
    bool loadCookies(const TQString &_filename);
 
    void saveConfig(TDEConfig *_config);
 
    void loadConfig(TDEConfig *_config, bool reparse = false);
 
    TQString findCookies(const TQString &_url, bool useDOMFormat, long windowId, KHttpCookieList *pendingCookies=0);
 
    KHttpCookieList makeCookies(const TQString &_url, const TQCString &cookie_headers, long windowId);
 
    KHttpCookieList makeDOMCookies(const TQString &_url, const TQCString &cookie_domstr, long windowId);
 
    void addCookie(KHttpCookiePtr &cookiePtr);
 
    KCookieAdvice cookieAdvice(KHttpCookiePtr cookiePtr);
 
    KCookieAdvice getDomainAdvice(const TQString &_domain);
 
    void setDomainAdvice(const TQString &_domain, KCookieAdvice _advice);
 
    void setDomainAdvice(KHttpCookiePtr _cookie, KCookieAdvice _advice);
 
    KCookieAdvice getGlobalAdvice() { return m_globalAdvice; }
 
    void setGlobalAdvice(KCookieAdvice _advice);
 
    const TQStringList& getDomainList();
 
    const KHttpCookieList *getCookieList(const TQString & _domain,
                                         const TQString& _fqdn );
 
    void eatCookie(KHttpCookiePtr cookiePtr);
 
    void eatCookiesForDomain(const TQString &domain);
 
    void eatAllCookies();
 
    void eatSessionCookies( long windowId );
 
    void eatSessionCookies( const TQString& fqdn, long windowId, bool isFQDN = true );
 
    static bool parseURL(const TQString &_url,
                         TQString &_fqdn,
                         TQString &_path);
 
    void extractDomains(const TQString &_fqdn,
                        TQStringList &_domainList);
 
    static TQString adviceToStr(KCookieAdvice _advice);
    static KCookieAdvice strToAdvice(const TQString &_str);
 
    int preferredDefaultPolicy() const { return m_preferredPolicy; }
 
    bool showCookieDetails () const { return m_showCookieDetails; }
 
     void setPreferredDefaultPolicy (int value) { m_preferredPolicy = value; }
 
     void setShowCookieDetails (bool value) { m_showCookieDetails = value; }
 
protected:
     void stripDomain(const TQString &_fqdn, TQString &_domain);
     TQString stripDomain( KHttpCookiePtr cookiePtr);
 
protected:
    TQStringList m_domainList;
    KCookieAdvice m_globalAdvice;
    TQDict<KHttpCookieList> m_cookieDomains;
    TQDict<int> m_twoLevelTLD;
 
    bool m_configChanged;
    bool m_cookiesChanged;
    bool m_showCookieDetails;
    bool m_rejectCrossDomainCookies;
    bool m_autoAcceptSessionCookies;
    bool m_ignoreCookieExpirationDate;
 
    int m_preferredPolicy;
};
#endif