ftp.h

Go to the documentation of this file.

// -*- Mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; tab-width: 2; -*-
/*  This file is part of the KDE libraries
    Copyright (C) 2000 David Faure <faure@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 of the License, or (at your option) any later version.

    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 KDELIBS_FTP_H
#define KDELIBS_FTP_H

#include <config.h>

#include <sys/types.h>
#include <sys/socket.h>

#include <kurl.h>
#include <kio/slavebase.h>

class QTcpServer;
class QTcpSocket;
class QNetworkProxy;
class QAuthenticator;

struct FtpEntry
{
  QString name;
  QString owner;
  QString group;
  QString link;

  KIO::filesize_t size;
  mode_t type;
  mode_t access;
  time_t date;
};

//===============================================================================
// Ftp
//===============================================================================
class Ftp : public QObject, public KIO::SlaveBase
{
  Q_OBJECT

public:
  Ftp( const QByteArray &pool, const QByteArray &app );
  virtual ~Ftp();

  virtual void setHost( const QString& host, quint16 port, const QString& user, const QString& pass );

  virtual void openConnection();

  virtual void closeConnection();

  virtual void stat( const KUrl &url );

  virtual void listDir( const KUrl & url );
  virtual void mkdir( const KUrl & url, int permissions );
  virtual void rename( const KUrl & src, const KUrl & dst, KIO::JobFlags flags );
  virtual void del( const KUrl & url, bool isfile );
  virtual void chmod( const KUrl & url, int permissions );

  virtual void get( const KUrl& url );
  virtual void put( const KUrl& url, int permissions, KIO::JobFlags flags );
  //virtual void mimetype( const KUrl& url );

  virtual void slave_status();

  virtual void copy( const KUrl &src, const KUrl &dest, int permissions, KIO::JobFlags flags );

private:
  // ------------------------------------------------------------------------
  // All the methods named ftpXyz are lowlevel methods that are not exported.
  // The implement functionality used by the public high-level methods. Some
  // low-level methods still use error() to emit errors. This behaviour is not
  // recommended - please return a boolean status or an error code instead!
  // ------------------------------------------------------------------------

  typedef enum {
    statusSuccess,
    statusClientError,
    statusServerError
  } StatusCode;

  typedef enum {
    loginDefered,
    loginExplicit,
    loginImplicit
  } LoginMode;

  bool ftpOpenConnection (LoginMode loginMode);

  void ftpAutoLoginMacro ();

  bool ftpLogin(bool* userChanged = 0);

  bool ftpSendCmd( const QByteArray& cmd, int maxretries = 1 );

  bool ftpSize( const QString & path, char mode );

  const char* ftpSendSizeCmd(const QString& path);

  bool ftpFileExists(const QString& path);

  bool ftpFolder(const QString& path, bool bReportError);

  bool ftpOpenCommand( const char *command, const QString & path, char mode,
                       int errorcode, KIO::fileoffset_t offset = 0 );

  bool ftpCloseCommand();

  bool ftpDataMode(char cMode);

  //void ftpAbortTransfer();

  int ftpOpenDataConnection();

  void ftpCloseDataConnection();

  int ftpOpenPASVDataConnection();
  int ftpOpenEPSVDataConnection();
  int ftpOpenPortDataConnection();

  bool ftpChmod( const QString & path, int permissions );

  // used by listDir
  bool ftpOpenDir( const QString & path );
  bool ftpReadDir(FtpEntry& ftpEnt);

  void ftpCreateUDSEntry( const QString & filename, const FtpEntry& ftpEnt, KIO::UDSEntry& entry, bool isDir );

  void ftpShortStatAnswer( const QString& filename, bool isDir );

  void ftpStatAnswerNotFound( const QString & path, const QString & filename );

  bool ftpRename( const QString & src, const QString & dst, KIO::JobFlags flags );

  bool ftpOpenControlConnection();
  bool ftpOpenControlConnection( const QString & host, int port );

  void ftpCloseControlConnection();

  const char* ftpResponse(int iOffset);

  StatusCode ftpGet(int& iError, int iCopyFile, const KUrl& url, KIO::fileoffset_t hCopyOffset);

  StatusCode ftpPut(int& iError, int iCopyFile, const KUrl& url, int permissions, KIO::JobFlags flags);

  StatusCode ftpCopyPut(int& iError, int& iCopyFile, const QString &sCopyFile, const KUrl& url, int permissions, KIO::JobFlags flags);

  StatusCode ftpCopyGet(int& iError, int& iCopyFile, const QString &sCopyFile, const KUrl& url, int permissions, KIO::JobFlags flags);

  StatusCode ftpSendMimeType(int& iError, const KUrl& url);

  void fixupEntryName(FtpEntry* ftpEnt);

  bool maybeEmitStatEntry(FtpEntry& ftpEnt, const QString& search, const QString& filename, bool isDir);

private Q_SLOTS:
  void proxyAuthentication(const QNetworkProxy&, QAuthenticator*);
  void saveProxyAuthentication();

private: // data members

  QString m_host;
  int m_port;
  QString m_user;
  QString m_pass;
  QString m_initialPath;
  KUrl m_proxyURL;
  QStringList m_proxyUrls;

  QString m_currentPath;

  int  m_iRespCode;

  int  m_iRespType;

  char m_cDataMode;

  bool m_bLoggedOn;

  bool m_bTextMode;

  bool m_bBusy;

  bool m_bPasv;

  KIO::filesize_t m_size;
  static KIO::filesize_t UnknownSize;

  enum
  {
    epsvUnknown = 0x01,
    epsvAllUnknown = 0x02,
    eprtUnknown = 0x04,
    epsvAllSent = 0x10,
    pasvUnknown = 0x20,
    chmodUnknown = 0x100
  };
  int m_extControl;

  QTcpSocket  *m_control;
  QByteArray m_lastControlLine;

  QTcpSocket  *m_data;

  QTcpServer *m_server;

  QAuthenticator* m_socketProxyAuth;
};

#endif // KDELIBS_FTP_H