src/globalsearch/sshconnection.h

/**********************************************************************
  SSHConnection - Connection to an ssh server for execution, sftp, etc.

  Copyright (C) 2010-2012 by David C. Lonie

  This source code is released under the New BSD License, (the "License").

  Unless required by applicable law or agreed to in writing, software
  distributed under the License is distributed on an "AS IS" BASIS,
  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  See the License for the specific language governing permissions and
  limitations under the License.
 ***********************************************************************/

#ifndef SSHCONNECTION_H
#define SSHCONNECTION_H

#ifdef ENABLE_SSH

#include <QtCore/QObject>
#include <QtCore/QString>

namespace GlobalSearch {
  class OptBase;
  class SSHManager;

  class SSHConnection : public QObject
  {
    Q_OBJECT

  public:
    enum SSHConnectionException {
      SSH_CONNECTION_ERROR = 1,
      SSH_UNKNOWN_HOST_ERROR,
      SSH_BAD_PASSWORD_ERROR,
      SSH_UNKNOWN_ERROR
    };

    explicit SSHConnection(SSHManager *parent = 0);

    virtual ~SSHConnection();

    QString getUser() {return m_user;};
    QString getHost() {return m_host;};
    int getPort() {return m_port;};

  public slots:
    virtual void setLoginDetails(const QString &host,
                                 const QString &user = "",
                                 const QString &pass = "",
                                 int port = 22);

    virtual bool execute(const QString &command,
                         QString &stdout_str,
                         QString &stderr_str,
                         int &exitcode) = 0;

    virtual bool copyFileToServer(const QString & localpath,
                                  const QString & remotepath) = 0;

    virtual bool copyFileFromServer(const QString & remotepath,
                                    const QString & localpath) = 0;

    virtual bool readRemoteFile(const QString &filename,
                                QString &contents) = 0;

    virtual bool removeRemoteFile(const QString &filename) = 0;

    virtual bool copyDirectoryToServer(const QString & localpath,
                                       const QString & remotepath) = 0;

    virtual bool copyDirectoryFromServer(const QString & remotepath,
                                         const QString & localpath) = 0;

    virtual bool readRemoteDirectoryContents(const QString & remotepath,
                                             QStringList & contents) = 0;

    virtual bool removeRemoteDirectory(const QString & remotepath,
                                       bool onlyDeleteContents = false) = 0;

  protected:
    QString m_host;
    QString m_user;
    QString m_pass;
    int m_port;
  };

} // end namespace GlobalSearch


#endif // ENABLE_SSH
#endif // SSHCONNECTION_H

---