Novae.hpp

/*
 * Copyright (C) 2013 Alexander Wolf
 *
 * This program 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.
 *
 * This program 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Suite 500, Boston, MA  02110-1335, USA.
 */

#ifndef _NOVAE_HPP_
#define _NOVAE_HPP_

#include "StelObjectModule.hpp"
#include "StelObject.hpp"
#include "StelFader.hpp"
#include "Nova.hpp"
#include "StelTextureTypes.hpp"
#include <QFont>
#include <QVariantMap>
#include <QDateTime>
#include <QList>
#include <QSharedPointer>
#include <QHash>

class QNetworkAccessManager;
class QNetworkReply;
class QSettings;
class QTimer;
class NovaeDialog;
class StelPainter;

typedef QSharedPointer<Nova> NovaP;

class Novae : public StelObjectModule
{
    Q_OBJECT
public: 
    enum UpdateState {
        Updating,       
        CompleteNoUpdates,  
        CompleteUpdates,    
        DownloadError,      
        OtherError      
    };

    Novae();
    virtual ~Novae();

    // Methods defined in the StelModule class
    virtual void init();
    virtual void update(double) {;}
    virtual void draw(StelCore* core);
    virtual void drawPointer(StelCore* core, StelPainter& painter);
    virtual double getCallOrder(StelModuleActionName actionName) const;

    // Methods defined in StelObjectManager class
    virtual QList<StelObjectP> searchAround(const Vec3d& v, double limitFov, const StelCore* core) const;

    virtual StelObjectP searchByNameI18n(const QString& nameI18n) const;

    virtual StelObjectP searchByName(const QString& name) const;

    virtual StelObjectP searchByID(const QString &id) const
    {
        return qSharedPointerCast<StelObject>(getByID(id));
    }

    virtual QStringList listMatchingObjects(const QString& objPrefix, int maxNbItem=5, bool useStartOfWords=false, bool inEnglish=false) const;
    virtual QStringList listAllObjects(bool inEnglish) const;
    virtual QString getName() const { return "Bright Novae"; }
    virtual QString getStelObjectType() const { return Nova::NOVA_TYPE; }

    NovaP getByID(const QString& id) const;

    virtual bool configureGui(bool show=true);

    void restoreDefaults(void);

    void readSettingsFromConfig(void);

    void saveSettingsToConfig(void);

    bool getUpdatesEnabled(void) {return updatesEnabled;}
    void setUpdatesEnabled(bool b) {updatesEnabled=b;}

    QDateTime getLastUpdate(void) const {return lastUpdate;}

    int getUpdateFrequencyDays(void) const {return updateFrequencyDays;}
    void setUpdateFrequencyDays(int days) {updateFrequencyDays = days;}

    int getSecondsToUpdate(void);

    UpdateState getUpdateState(void) const {return updateState;}

    QString getNovaeList();

    float getLowerLimitBrightness();

    int getCountNovae(void) const {return NovaCnt;}

signals:
    void updateStateChanged(Novae::UpdateState state);

    void jsonUpdateComplete(void);

public slots:
    // FIXME: Add functions for scripting support

    void updateJSON(void);

    void displayMessage(const QString& message, const QString hexColor="#999999");
    void messageTimeout(void) const;

    void reloadCatalog(void);

private:
    // Font used for displaying our text
    QFont font;

    // if existing, delete Novae section in main config.ini, then create with default values
    void restoreDefaultConfigIni(void);

    void restoreDefaultJsonFile(void);

    void readJsonFile(void);

    bool backupJsonFile(bool deleteOriginal=false);

    int getJsonFileVersion(void) const;

    bool checkJsonFileFormat(void) const;

    QVariantMap loadNovaeMap(QString path=QString());

    void setNovaeMap(const QVariantMap& map);

    QString novaeJsonPath;

    int NovaCnt;

    StelTextureSP texPointer;
    QList<NovaP> nova;
    QHash<QString, double> novalist;

    // variables and functions for the updater
    UpdateState updateState;
    QNetworkAccessManager* downloadMgr;
    QString updateUrl;
    class StelProgressController* progressBar;
    QTimer* updateTimer;
    QTimer* messageTimer;
    QList<int> messageIDs;
    bool updatesEnabled;
    QDateTime lastUpdate;
    int updateFrequencyDays;

    QSettings* conf;

    // GUI
    NovaeDialog* configDialog;  

private slots:
    void checkForUpdate(void);
    void updateDownloadComplete(QNetworkReply* reply);

};


#include <QObject>
#include "StelPluginInterface.hpp"

class NovaeStelPluginInterface : public QObject, public StelPluginInterface
{
    Q_OBJECT
    Q_PLUGIN_METADATA(IID StelPluginInterface_iid)
    Q_INTERFACES(StelPluginInterface)
public:
    virtual StelModule* getStelModule() const;
    virtual StelPluginInfo getPluginInfo() const;
    virtual QObjectList getExtensionList() const { return QObjectList(); }
};

#endif /*_NOVAE_HPP_*/