Labcontrol/src/Lib/lablib.h

/*
 * Copyright 2014-2016 Markus Prasser
 *
 * 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"

extern std::unique_ptr< lc::Settings > settings;

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:
    /** Lablib's constructor
     *
     * @param argDebugMessagesTextEdit      A pointer to the debug messages text edit for verbose output
     * @param argParent                     This 'lcLablib' instance's parent QObject
     */
    Lablib( QPlainTextEdit *argDebugMessagesTextEdit, QObject *argParent = nullptr );
    /** Lablib's destructor
     */
    ~Lablib();
    /*! Returns the users who have administrative rights
     *
     * @return The users with administrative rights
     */
    QStringList *GetAdminUsers() const { return adminUsers; }
    /*! Returns the placeholder for anonymous receipts
     *
     * @return The placeholder for anonymous receipts
     */
    QString GetAnonymousReceiptsPlaceholder() const { return anonymousReceiptsPlaceholder; }
    /*! Returns the currently set port number of zTree
     *
     * @return The currently set port number for zTree
     */
    int GetChosenZTreePort() const { return chosenZTreePort; }
    /** Returns a pointer to the clients known to Lablib
     *
     * @return A QVector of pointers to the Client class instances
     */
    QVector< Client* > *GetClients () const { return clients; }
    /** Returns the default receipt index for the 'CBReceipts' combobox
     *
     * @return The default receipt index for the 'CBReceipts' combobox
     */
    int GetDefaultReceiptIndex () const { return defaultReceiptIndex; }
    /** Returns a pointer to the QString storing the default name for local zLeafs
     *
     * @return A pointer to the QString storing the default name for local zLeafs
     */
    QString GetLocalZLeafDefaultName() const { return settings->GetLocalzLeafName(); }
    /** 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
     */
    QVector<int> *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; }
    /** Returns true if receipts for local clients shall be printed
     *
     * @return True if receipts for local clients shall be printed
     */
    bool GetPrintReceiptsForLocalClients() const { return PrintReceiptsForLocalClients; }
    /** Returns a pointer to server's user's name
     *
     * @return A pointer to the server's user's name
     */
    QString GetUserNameOnServer () const { return userNameOnServer; }
    /** Returns a QStringList containing all available LaTeX headers of this system
     *
     * @return A pointer to a QStringList containing all available LaTeX headers
     */
    QStringList *GetInstalledLaTeXHeaders () const {return installedLaTeXHeaders; }
    /** Returns a QStringList containing all available zTree versions of this system
     *
     * @return A pointer to a QStringList containing all available zTree versions
     */
    QStringList *GetInstalledZTreeVersions () const { return InstalledZTreeVersions; }
    /** Returns a pointer to a QStringList containing all available webcams
     *
     * @return A pointer to a QStringList containing all available webcams
     */
    QStringList *GetWebcams () const { return webcams; }
    void SetAnonymousReceiptsPlaceholder( const QString &argPlaceHolder );
    void SetChosenLaTeXHeader( const QString &argLatexHeader );
    void SetChosenZTreeDataTargetPath( const QString &argZTreeDataTargetPath );
    void SetChosenZTreePort( const int &argPort );
    void SetChosenZTreeVersion( const QString &argZTreeVersion );
    //! Sets the default name of local zLeaf instances
    /**
     * @param argName   The default name local zLeaf instances shall have
     */
    void SetLocalZLeafDefaultName( const QString &argName );
    void SetPrintReceiptsForLocalClients( const bool &argPrintReceiptsForLocalClients );
    void SetUserNameOnServer( const QString &argUserName );
    void ShowOrsee();
    void ShowPreprints();

public slots:
    void StartNewZTreeInstance( QString argDataTargetPath, int argPort, QString argzTreeVersion,
                                bool argReceiptsForLocalClients, QString argAnonReceiptPlaceholder,
                                QString argChosenLatexHeader );

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();

    QStringList *adminUsers = nullptr;         //! Stores all users with administrative rights
    QString anonymousReceiptsPlaceholder;    //! The placeholder which shall substitute the client names on anonymous receipts (if != "")
    QString chosenLaTeXHeader;
    QString chosenZTreeDataTargetPath;
    int chosenZTreePort = 7000;               //! Stores the currently chosen port for new zTree instances
    QString chosenZTreeVersion;
    ClientHelpNotificationServer *clientHelpNotificationServer = nullptr;    //! A server to retrieve help requests from the clients
    unsigned short int clientHelpNotificationServerPort = 0;        //! The port the help requests shall be received on
    QMap< QString, Client* > * clientIPsToClientsMap = nullptr;    //! A map container storing ip-client pairs
    QVector<Client*> *clients = nullptr;            //! A QVector storing pointers to all Client instances
    QPlainTextEdit *debugMessagesTextEdit = nullptr;       //! This stores a pointer to the text edit in the debug tab to be able to write to it
    int defaultReceiptIndex = 0;                  //! Stores the index of the LaTeX header to be displayed by default
    QStringList *installedLaTeXHeaders = nullptr;
    QStringList *InstalledZTreeVersions = nullptr;
    QSettings labSettings;
    NetstatAgent *netstatAgent = nullptr;           //! Tries to detect active zLeaf connections from the clients
    QThread netstatThread;
    QTimer *netstatTimer = nullptr;                //! A timer for regular execution of the NetstatAgent instance's request mechanism
    QVector< int > *occupiedPorts = nullptr;
    bool PrintReceiptsForLocalClients = true;
    SessionsModel *sessionsModel = nullptr;        //! A derivation from QAbstractTableModel used to store the single Session instances
    QString userNameOnServer;         //! The user name on the server as extracted from the environment variables
    QStringList *webcams = nullptr;                 //! A QStringList containing all available stationary webcams in the laboratory
};

}

#endif // LABLIB_H