///////////////////////////////////////////////////////////////////////////////
// 
//  Copyright (2013) Alexander Stukowski
//
//  This file is part of OVITO (Open Visualization Tool).
//
//  OVITO is free software; you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation; either version 2 of the License, or
//  (at your option) any later version.
//
//  OVITO 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 program.  If not, see <http://www.gnu.org/licenses/>.
//
///////////////////////////////////////////////////////////////////////////////

/** 
 * \file SftpJob.h
 * \brief Contains the definition of the Ovito::SftpJob class.
 */

#ifndef __OVITO_SFTP_JOB_H
#define __OVITO_SFTP_JOB_H

#include <core/Core.h>
#include <core/utilities/concurrent/Future.h>

// QSsh library:
#include <sshconnection.h>
#include <sshconnectionmanager.h>
#include <sftpchannel.h>

namespace Ovito {

/**
 * \brief Base class for background jobs that access remote files and directories via SFTP.
 */
class SftpJob : public QObject
{
	Q_OBJECT

public:

	/// Constructor.
	SftpJob(const QUrl& url, const std::shared_ptr<FutureInterfaceBase>& futureInterface);

	/// Destructor.
	virtual ~SftpJob() {
		OVITO_ASSERT(_sftpChannel == nullptr);
		OVITO_ASSERT(_connection == nullptr);
	}

protected:

	/// Opens the SSH connection.
	Q_INVOKABLE void start();

	/// Closes the SSH connection.
	virtual void shutdown(bool success);

protected Q_SLOTS:

	/// Handles SSH connection errors.
	void onSshConnectionError(QSsh::SshError error);

	/// Is called when the SSH connection has been established.
    void onSshConnectionEstablished();

    /// Is called when the SFTP channel could not be created.
    void onSftpChannelInitializationFailed(const QString& reason);

    /// Is called when the SFTP channel has been created.
	virtual void onSftpChannelInitialized() = 0;

protected:

	/// The URL of the file or directory.
	QUrl _url;

	/// The SSH connection.
	QSsh::SshConnection* _connection;

	/// The SFTP channel.
    QSsh::SftpChannel::Ptr _sftpChannel;

    /// The associated future interface of the job.
    std::shared_ptr<FutureInterfaceBase> _futureInterface;

    /// Indicates whether this SFTP job is currently active.
    bool _isActive;

    /// List SFTP jobs that are waiting to be executed.
    static QQueue<SftpJob*> _queuedJobs;

    /// Keeps track of how many SFTP jobs are currently active.
    static int _numActiveJobs;
};

/**
 * \brief A background jobs that downloads a remote file via SFTP.
 */
class SftpDownloadJob : public SftpJob
{
	Q_OBJECT

public:

	/// Constructor.
	SftpDownloadJob(const QUrl& url, const std::shared_ptr<FutureInterface<QString>>& futureInterface) :
		SftpJob(url, futureInterface), _timerId(0) {}

protected:

	/// Closes the SSH connection.
	virtual void shutdown(bool success) override;

    /// Is called when the SFTP channel has been created.
	virtual void onSftpChannelInitialized() override;

	/// Is invoked when the QObject's timer fires.
    void timerEvent(QTimerEvent* event) override;

protected Q_SLOTS:

	/// Is called after the file has been downloaded.
	void onSftpJobFinished(QSsh::SftpJobId jobId, const QString& errorMessage);

	/// Is called when the file info for the requested file arrived.
	void onFileInfoAvailable(QSsh::SftpJobId job, const QList<QSsh::SftpFileInfo>& fileInfoList);

private:

    /// The local copy of the file.
    QScopedPointer<QTemporaryFile> _localFile;

    /// The SFTP file download job.
    QSsh::SftpJobId _downloadJob;

    /// The progress monitor timer.
    int _timerId;
};

/**
 * \brief A background jobs that lists the files in a remote directory, which is accessed via SFTP.
 */
class SftpListDirectoryJob : public SftpJob
{
	Q_OBJECT

public:

	/// Constructor.
	SftpListDirectoryJob(const QUrl& url, const std::shared_ptr<FutureInterface<QStringList>>& futureInterface) :
		SftpJob(url, futureInterface) {}

protected:

    /// Is called when the SFTP channel has been created.
	virtual void onSftpChannelInitialized() override;

protected Q_SLOTS:

	/// Is called after the file has been downloaded.
	void onSftpJobFinished(QSsh::SftpJobId jobId, const QString& errorMessage);

	/// Is called when the file info for the requested file arrived.
	void onFileInfoAvailable(QSsh::SftpJobId job, const QList<QSsh::SftpFileInfo>& fileInfoList);

private:

    /// The list of files.
    QStringList _fileList;

    /// The SFTP job.
    QSsh::SftpJobId _listingJob;
};

}; 	// End of namespace

#endif // __OVITO_SFTP_JOB_H
