kcookieserver.h

Go to the documentation of this file.

/*
    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 Library General Public License
    as published by the Free Software Foundation; either
    version 2, or (at your option) version 3.

    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 Cookie Server

#ifndef KCOOKIESERVER_H
#define KCOOKIESERVER_H

#include <QtCore/QStringList>
#include <kdedmodule.h>
#include <QtDBus/QtDBus>
#include <QtDBus/QDBusContext>

class KHttpCookieList;
class KCookieJar;
class KHttpCookie;
class QTimer;
class RequestList;
class KConfig;

class KCookieServer : public KDEDModule, protected QDBusContext
{
    Q_OBJECT
    Q_CLASSINFO("D-Bus Interface", "org.kde.KCookieServer")
public:
    KCookieServer(QObject* parent, const QList<QVariant>&);
    ~KCookieServer();

public Q_SLOTS:
    // KDE5 TODO: don't overload names here, it prevents calling e.g. findCookies from the command-line using qdbus.
  QString listCookies(const QString &url);
  QString findCookies(const QString &url, qlonglong windowId);
  QStringList findDomains();
    // KDE5: rename
  QStringList findCookies(const QList<int> &fields,const QString &domain,const QString& fqdn,const QString &path, const QString &name);
  QString findDOMCookies(const QString &url);
  QString findDOMCookies(const QString &url, qlonglong windowId); // KDE5: merge with above, using default value (windowId = 0)
  void addCookies(const QString &url, const QByteArray &cookieHeader, qlonglong windowId);
  void deleteCookie(const QString &domain, const QString &fqdn, const QString &path, const QString &name);
  void deleteCookiesFromDomain(const QString &domain);
  void deleteSessionCookies(qlonglong windowId);
  void deleteSessionCookiesFor(const QString &fqdn, qlonglong windowId);
  void deleteAllCookies();
  void addDOMCookies(const QString &url, const QByteArray &cookieHeader, qlonglong windowId);
  bool setDomainAdvice(const QString &url, const QString &advice);
  QString getDomainAdvice(const QString &url);
  void reloadPolicy();
  void shutdown();

public:
  bool cookiesPending(const QString &url, KHttpCookieList *cookieList=0);
  void addCookies(const QString &url, const QByteArray &cookieHeader,
                  qlonglong windowId, bool useDOMFormat);
  void checkCookies(KHttpCookieList *cookieList);
  // TODO: KDE5 merge with above function and make all these public functions
  // private since they are not used externally.
  void checkCookies(KHttpCookieList *cookieList, qlonglong windowId);

private Q_SLOTS:
  void slotSave();
  void slotDeleteSessionCookies(qlonglong windowId);

private:
  KCookieJar *mCookieJar;
  KHttpCookieList *mPendingCookies;
  RequestList *mRequestList;
  QTimer *mTimer;
  bool mAdvicePending;
  KConfig *mConfig;

private:
  virtual int newInstance(QList<QByteArray>) { return 0; }
  bool cookieMatches(const KHttpCookie&, const QString&, const QString&, const QString&, const QString&);
  void putCookie(QStringList&, const KHttpCookie&, const QList<int>&);
  void saveCookieJar();
};

#endif