/*
 * Copyright 2014-2018 Markus Prasser, Tobias Weiss
 *
 * This file is part of Labcontrol.
 *
 *  Labcontrol 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 3 of the License, or
 *  (at your option) any later version.
 *
 *  Labcontrol 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 Labcontrol.  If not, see <http://www.gnu.org/licenses/>.
 */

#ifndef LABLIB_H
#define LABLIB_H

#include <list>
#include <memory>

#include <QDir>
#include <QItemSelectionModel>
#include <QList>
#include <QMainWindow>
#include <QMap>
#include <QModelIndexList>
#include <QPlainTextEdit>
#include <QProcess>
#include <QSettings>
#include <QString>
#include <QTableView>
#include <QVector>
#include <QXmlStreamReader>

#include "client.h"
#include "clienthelpnotificationserver.h"
#include "global.h"
#include "netstatagent.h"
#include "session.h"
#include "sessionsmodel.h"
#include "settings.h"

namespace lc {

//! This class represents the entire lab and running sessions.
/*!
  This class contains elements and functions needed to represent the lab and running sessions.
*/
class Lablib : public QObject
{
    Q_OBJECT

public:
    /*!
     * \brief Lablib's constructor
     * \param[in] argParent This 'lcLablib' instance's parent QObject
     */
    Lablib(Settings *const argSettings, QObject *argParent = nullptr);
    /** Lablib's destructor
     */
    ~Lablib() override;
    /*!
     * \brief CheckIfUserIsAdmin checks if the account with the passed user name has administrative rights
     * \param argUserName The account name which shall checked for administrative rights
     * \return True, if the account has administrative rights; false, otherwise
     */
    bool CheckIfUserIsAdmin() const;
    /** Returns a pointer to a QVector<unsigned int> containing all by sessions occupied ports
     *
     * @return A pointer to a QVector<unsigned int> containing all occupied ports
     */
    const QVector<quint16> &GetOccupiedPorts () const
    {
        return occupiedPorts;
    }
    /** Returns a pointer to the QAbstractTableModel storing the Session instances
     *
     * @return A pointer to the QAbstractTableModel storing the Session instances
     */
    SessionsModel *GetSessionsModel () const
    {
        return sessionsModel;
    }
    //! Sets the default name of local zLeaf instances
    /**
     * @param argName   The default name local zLeaf instances shall have
     */
    void SetLocalZLeafDefaultName(const QString &argName);
    void ShowOrsee();
    void ShowPreprints();
    void StartNewSession(QVector<Client *> argAssocCl, QString argParticipNameReplacement,
                         bool argPrintLocalReceipts, QString argReceiptsHeader,
                         QString argzTreeDataTargetPath, quint16 argzTreePort,
                         QString argzTreeVersion);

    /*!
    * \brief Returns the commandline to issue on the client(s) in order to start zLeaf
    * @param sessionPort The port zLeaf shall connect to
    * @param zLeafVersion zLeaf Version to start
    */
    QStringList getzLeafArgs(int sessionPort, QString zleafVersion);


public slots:

signals:
    void ZLEAF_RUNNING(QString argClientIP);

private slots:
    //! Gets the output from NetstatAgent
    void GotNetstatQueryResult(QStringList *argActiveZLeafConnections);

private:
    //! Detects installed zTree version and LaTeX headers
    void DetectInstalledZTreeVersionsAndLaTeXHeaders();
    /** Reads all settings from the QSettings 'labSettings' object.
     */
    void ReadSettings();

    //! A server to retrieve help requests from the clients
    ClientHelpNotificationServer *clientHelpNotificationServer = nullptr;
    QSettings labSettings;
    //! Tries to detect active zLeaf connections from the clients
    NetstatAgent *netstatAgent = nullptr;
    QThread netstatThread;
    //! A timer for regular execution of the NetstatAgent instance's request mechanism
    QTimer *netstatTimer = nullptr;
    QVector< quint16 > occupiedPorts;
    //! A derivation from QAbstractTableModel used to store the single Session instances
    SessionsModel *sessionsModel = nullptr;
    Settings *const settings = nullptr;
};

} // namespace lc

#endif // LABLIB_H