kprotocolmanager.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1999 Torben Weis <weis@kde.org>
   Copyright (C) 2000- Waldo Bastain <bastain@kde.org>
   Copyright (C) 2000- Dawit Alemayehu <adawit@kde.org>
   Copyright (C) 2008 Jarosław Staniek <staniek@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 version 2 as published by the Free Software Foundation.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
#ifndef KPROTOCOLMANAGER_H
#define KPROTOCOLMANAGER_H

#include <QtCore/QStringList>

#include <kio/global.h>
#include "kprotocolinfo.h"

class KSharedConfig;
template<class T>
class KSharedPtr;
typedef KSharedPtr<KSharedConfig> KSharedConfigPtr;
namespace KIO
{
    class SlaveConfigPrivate;
} // namespace KIO

class KIO_EXPORT KProtocolManager
{
public:


/*=========================== USER-AGENT SETTINGS ===========================*/


  static QString defaultUserAgent();

  static QString defaultUserAgent(const QString &keys);

  static QString userAgentForApplication( const QString &appName, const QString& appVersion,
    const QStringList& extraInfo = QStringList() );

  static QString userAgentForHost( const QString &hostname );

  /*
   * Returns system name, version and machine type, for example "Windows", "5.1", "i686".
   * This information can be used for constructing custom user-agent strings.
   *
   * @param systemName system name
   * @param systemVersion system version
   * @param machine machine type

   * @return true if system name, version and machine type has been provided
   *
   * @since 4.1
   */
  static bool getSystemNameVersionAndMachine(
    QString& systemName, QString& systemVersion, QString& machine );


/*=========================== TIMEOUT CONFIG ================================*/


  static int readTimeout();

  static int connectTimeout();

  static int proxyConnectTimeout();

  static int responseTimeout();


/*=============================== PROXY CONFIG ==============================*/


  static bool useProxy();

  static bool useReverseProxy();

  enum ProxyType
  {
      NoProxy,
      ManualProxy,
      PACProxy,
      WPADProxy,
      EnvVarProxy
  };

  static ProxyType proxyType();

  enum ProxyAuthMode
  {
      Prompt,
      Automatic
  };

  static ProxyAuthMode proxyAuthMode();

  static QString noProxyFor();

  static QString proxyFor( const QString& protocol );

  static QString proxyForUrl( const KUrl& url );

  static QStringList proxiesForUrl( const KUrl& url );

  static void badProxy( const QString & proxy );

  static QString proxyConfigScript();


/*========================== CACHE CONFIG ===================================*/


  static bool useCache();

  static int maxCacheAge();

  static int maxCacheSize(); // Maximum cache size in Kb.

  static QString cacheDir();

  static KIO::CacheControl cacheControl();


/*============================ DOWNLOAD CONFIG ==============================*/

  static bool autoResume();

  static bool markPartial();

  static int minimumKeepSize();


  /*============================ NETWORK CONNECTIONS ==========================*/
  static bool persistentProxyConnection();

  static bool persistentConnections();


  /*===================== PROTOCOL CAPABILITIES ===============================*/

  static bool supportsListing( const KUrl &url );

  static bool supportsReading( const KUrl &url );

  static bool supportsWriting( const KUrl &url );

  static bool supportsMakeDir( const KUrl &url );

  static bool supportsDeleting( const KUrl &url );

  static bool supportsLinking( const KUrl &url );

  static bool supportsMoving( const KUrl &url );

  static bool supportsOpening( const KUrl &url );

  static bool canCopyFromFile( const KUrl &url );

  static bool canCopyToFile( const KUrl &url );

  static bool canRenameFromFile( const KUrl &url );

  static bool canRenameToFile( const KUrl &url );

  static bool canDeleteRecursive( const KUrl &url );

  static KProtocolInfo::FileNameUsedForCopying fileNameUsedForCopying( const KUrl &url );

  static QString defaultMimetype( const KUrl& url );

  static KProtocolInfo::Type inputType( const KUrl &url );

  static KProtocolInfo::Type outputType( const KUrl &url );

  static QStringList listing( const KUrl &url );


  static bool isSourceProtocol( const KUrl &url );

  static QString protocolForArchiveMimetype( const QString& mimeType );

  /*=============================== OTHERS ====================================*/


  static void reparseConfiguration();

  static QString slaveProtocol(const KUrl &url, QString &proxy);

  static QString slaveProtocol(const KUrl &url, QStringList &proxy);

  static QString acceptLanguagesHeader();

  static QString charsetFor(const KUrl& url);

private:
  friend class KIO::SlaveConfigPrivate;

  KDE_NO_EXPORT static KSharedConfigPtr config();
};
#endif