src/globalsearch/sshconnection_libssh.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 SSHCONNECTIONLIBSSH_H
#define SSHCONNECTIONLIBSSH_H

#ifdef ENABLE_SSH

extern "C" {
#include <libssh/libssh.h>
#include <libssh/sftp.h>
}

#include <globalsearch/sshconnection.h>

#include <globalsearch/sshmanager_libssh.h>

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

#define LIBSSH_BUFFER_SIZE 20480

namespace GlobalSearch {

  class SSHConnectionLibSSH : public SSHConnection
  {
    Q_OBJECT

  public:

    explicit SSHConnectionLibSSH(SSHManagerLibSSH *parent = 0);

    virtual ~SSHConnectionLibSSH();

  public slots:
    void setUsed(bool b) {m_inUse = b;};

    bool inUse() {return m_inUse;};

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

    bool copyFileToServer(const QString & localpath,
                          const QString & remotepath);

    bool copyFileFromServer(const QString & remotepath,
                            const QString & localpath);

    bool readRemoteFile(const QString &filename,
                        QString &contents);

    bool removeRemoteFile(const QString &filename);

    bool copyDirectoryToServer(const QString & localpath,
                               const QString & remotepath);

    bool copyDirectoryFromServer(const QString & remotepath,
                                 const QString & localpath);

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

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


    bool isValid() {return m_isValid;};

    bool isConnected();

    bool connectSession(bool throwExceptions = false);

    bool reconnectSession(bool throwExceptions = false);

    bool disconnectSession();

    bool reconnectIfNeeded() {if (!isConnected()) return reconnectSession(false);
      return true;};

    static bool addKeyToKnownHosts(const QString &host, unsigned int port = 22);

  signals:
    void unknownHostKey(const QString &hexa);

  protected:
    // Disable doxygen parsing
    sftp_session _openSFTP();
    bool _execute(const QString &command,
                  QString &stdout_err,
                  QString &stderr_err,
                  int &exitcode);
    bool _copyFileToServer(const QString & localpath,
                           const QString & remotepath);
    bool _copyFileFromServer(const QString & remotepath,
                             const QString & localpath);
    bool _readRemoteFile(const QString &filename,
                         QString &contents);
    bool _removeRemoteFile(const QString &filename);
    bool _copyDirectoryToServer(const QString & localpath,
                                const QString & remotepath);
    bool _copyDirectoryFromServer(const QString & remotepath,
                                  const QString & localpath);
    bool _readRemoteDirectoryContents(const QString & remotepath,
                                      QStringList & contents);
    bool _removeRemoteDirectory(const QString & remotepath,
                                bool onlyDeleteContents = false);

    ssh_session m_session;
    ssh_channel m_shell;

    bool m_isValid;
    bool m_inUse;
    QMutex m_lock;

    // Resume doxygen parsing
  };

} // end namespace GlobalSearch


#endif // ENABLE_SSH
#endif // SSHCONNECTIONLIBSSH_H

---