Satellites.hpp

/*
 * Copyright (C) 2009, 2012 Matthew Gates
 * Copyright (C) 2015 Nick Fedoseev (Iridium flares)
 *
 * 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 _SATELLITES_HPP_
#define _SATELLITES_HPP_ 1

#include "StelObjectModule.hpp"
#include "Satellite.hpp"
#include "StelFader.hpp"
#include "StelGui.hpp"
#include "StelDialog.hpp"
#include "StelLocation.hpp"

#include <QDateTime>
#include <QFile>
#include <QDir>
#include <QUrl>
#include <QVariantMap>

class StelButton;
class Planet;
class QNetworkAccessManager;
class QNetworkReply;
class QSettings;
class QTimer;

class SatellitesDialog;
class SatellitesListModel;

struct TleData
{
    QString id;
    QString name;
    QString first;
    QString second;
    int status;
    bool addThis;
};

typedef QList<TleData> TleDataList;
typedef QHash<QString, TleData> TleDataHash ;

struct TleSource
{
    QUrl url;
    QFile* file;
    bool addNew;
};

typedef QList<TleSource> TleSourceList;

struct IridiumFlaresPrediction
{
    QString datetime;
    QString satellite;
    float azimuth;      // radians
    float altitude;     // radians
    float magnitude;
};

typedef QList<IridiumFlaresPrediction> IridiumFlaresPredictionList;

class Satellites : public StelObjectModule
{
    Q_OBJECT
    Q_PROPERTY(bool hintsVisible
               READ getFlagHints
           WRITE setFlagHints
           NOTIFY hintsVisibleChanged)
    Q_PROPERTY(bool labelsVisible
               READ getFlagLabels
           WRITE setFlagLabels
           NOTIFY labelsVisibleChanged)
    Q_PROPERTY(bool autoAddEnabled
               READ isAutoAddEnabled
               WRITE enableAutoAdd
               NOTIFY settingsChanged)
    Q_PROPERTY(bool autoRemoveEnabled
               READ isAutoRemoveEnabled
               WRITE enableAutoRemove
               NOTIFY settingsChanged)
    Q_PROPERTY(bool realisticMode
           READ getFlagRealisticMode
           WRITE setFlagRelisticMode)
    
public:
    enum UpdateState
    {
        Updating,             
        CompleteNoUpdates,    
        CompleteUpdates,      
        DownloadError,        
        OtherError            
    };

    enum Status
    {
        Visible,
        NotVisible,
        Both,
        NewlyAdded,
        OrbitError
    };

    Satellites();
    virtual ~Satellites();

    // Methods defined in the StelModule class
    virtual void init();
    virtual void deinit();
    virtual void update(double deltaTime);
    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;
    
    StelObjectP searchByNoradNumber(const QString& noradNumber) const;

    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 "Satellites"; }

    virtual bool configureGui(bool show=true);

    void restoreDefaults(void);

    void loadSettings();

    void saveSettings();

    QSet<QString> getGroups() const;
    QStringList getGroupIdList() const;
    void addGroup(const QString& groupId);

    QHash<QString,QString> getSatellites(const QString& group=QString(), Status vis=Both);
    SatellitesListModel* getSatellitesListModel();

    SatelliteP getById(const QString& id);
    
    QStringList listAllIds();
    
    void add(const TleDataList& newSatellites);
    
    void remove(const QStringList& idList);

    bool getUpdatesEnabled(void) {return updatesEnabled;}

    QDateTime getLastUpdate(void) {return lastUpdate;}

    int getUpdateFrequencyHours(void) {return updateFrequencyHours;}

    int getSecondsToUpdate(void);

    //void setUpdateFrequencyHours(int hours);

    UpdateState getUpdateState(void) {return updateState;}

    QStringList getTleSources(void) {return updateUrls;}

    void setTleSources(QStringList tleSources);
    
    void saveTleSources(const QStringList& urls);
    
    void updateFromFiles(QStringList paths, bool deleteFiles=false);
    
    void updateSatellites(TleDataHash& newTleSets);
    
    static void parseTleFile(QFile& openFile,
                             TleDataHash& tleList,
                             bool addFlagValue = false);

    void parseQSMagFile(QString qsMagFile);
    
    bool getFlagHints() {return hintFader;}
    int getLabelFontSize() {return labelFont.pixelSize();}
    bool getFlagLabels();
    bool getFlagRealisticMode();
    bool getOrbitLinesFlag();
    bool isAutoAddEnabled() const { return autoAddEnabled; }
    bool isAutoRemoveEnabled() const { return autoRemoveEnabled; }  

    int getIridiumFlaresPredictionDepth(void) { return iridiumFlaresPredictionDepth; }

    IridiumFlaresPredictionList getIridiumFlaresPrediction();

signals:
    void hintsVisibleChanged(bool b);
    void labelsVisibleChanged(bool b);

    void settingsChanged();
    
    void updateStateChanged(Satellites::UpdateState state);

    void tleUpdateComplete(int updated, int total, int added, int missing);

public slots:
    // FIXME: Put back the getter functions - for scripts? --BM
    
    void enableInternetUpdates(bool enabled = true);
    
    void enableAutoAdd(bool enabled = true);
    
    void enableAutoRemove(bool enabled = true);
    
    void setFlagHints(bool b);
    
    void setFlagLabels(bool b);

    void setFlagRelisticMode(bool b);
    
    void setLabelFontSize(int size);
    
    void setUpdateFrequencyHours(int hours);
    
    void updateFromOnlineSources();

    void setOrbitLinesFlag(bool b);

    void recalculateOrbitLines(void);

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

    void saveCatalog(QString path=QString());

    void setIridiumFlaresPredictionDepth(int depth) { iridiumFlaresPredictionDepth=depth; }

private slots:

private:
    bool add(const TleData& tleData);
    
    void restoreDefaultSettings();
    void restoreDefaultCatalog();
    void loadCatalog();
    bool backupCatalog(bool deleteOriginal=false);
    const QString readCatalogVersion();
    void restoreDefaultQSMagFile();

    bool isValidRangeDates() const;

    bool saveDataMap(const QVariantMap& map, QString path=QString());
    QVariantMap loadDataMap(QString path=QString());
    void setDataMap(const QVariantMap& map);
    QVariantMap createDataMap();
    
    void markLastUpdate();

    bool checkJsonFileFormat();
    
    static void translations();

    QString qsMagFilePath;
    QString catalogPath;
    QDir dataDir;
    
    QList<SatelliteP> satellites;
    SatellitesListModel* satelliteListModel;

    QHash<QString, double> qsMagList;
    
    QSet<QString> groups;
    
    LinearFader hintFader;
    StelTextureSP texPointer;
    

    StelButton* toolbarButton;  
    // FIXME: Possible bug with the Solar System recreated by the SSEditor.
    QSharedPointer<Planet> earth;
    Vec3f defaultHintColor;
    Vec3f defaultOrbitColor;
    QFont labelFont;
    

    UpdateState updateState;
    QNetworkAccessManager* downloadMgr;
    QStringList updateUrls;
    TleSourceList updateSources;
    class StelProgressController* progressBar;
    int numberDownloadsComplete;
    QTimer* updateTimer;
    bool updatesEnabled;
    bool autoAddEnabled;
    bool autoRemoveEnabled;
    QDateTime lastUpdate;
    int updateFrequencyHours;
    

    QTimer* messageTimer;
    QList<int> messageIDs;

    int iridiumFlaresPredictionDepth;

    // GUI
    SatellitesDialog* configDialog; 

private slots:
    void checkForUpdate(void);
    void saveDownloadedUpdate(QNetworkReply* reply);
    void updateObserverLocation(StelLocation loc);
};



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

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

#endif /*_SATELLITES_HPP_*/