adatabase.h

/*
 *openPilotLog - A FOSS Pilot Logbook Application
 *Copyright (C) 2020-2021 Felix Turowsky
 *
 *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 3 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, see <https://www.gnu.org/licenses/>.
 */
#ifndef ADATABASE_H
#define ADATABASE_H
 
#include <QPair>
#include <QHash>
#include <QString>
#include <QDir>
#include <QSqlDatabase>
#include <QSqlDriver>
#include <QSqlQuery>
#include <QSqlError>
#include <QSqlTableModel>
#include <QSqlQuery>
#include <QSqlRecord>
#include <QSqlField>
 
#include "src/database/adatabasetypes.h"
#include "src/classes/aentry.h"
#include "src/classes/apilotentry.h"
#include "src/classes/atailentry.h"
#include "src/classes/aaircraftentry.h"
#include "src/classes/aflightentry.h"
#include "src/classes/astandardpaths.h"
#include "src/classes/acurrencyentry.h"
 
#define SQLITE_DRIVER QStringLiteral("QSQLITE")
 
#define aDB ADatabase::instance()
 
enum class ADatabaseTarget
{
    airport_identifier_icao,
    airport_identifier_iata,
    airport_identifier_all,
    airport_names,
    registrations,
    companies,
    tails,
    pilots,
    aircraft
};
 
enum class ADatabaseTable
{
    tails,
    flights,
    currencies,
    aircraft,
    pilots,
};
 
enum class ADatabaseSummaryKey {
    total_flights,
    total_tails,
    total_pilots,
    last_flight,
    total_time,
};
 
struct UserDataState {
 
    UserDataState(){numTails = 0; numPilots = 0;}
    UserDataState(int numTails_, int numPilots_)
        : numTails(numTails_), numPilots(numPilots_){}
 
    bool operator==(const UserDataState& other)
    {
        return numTails == other.numTails && numPilots == other.numPilots;
    }
    bool operator!=(const UserDataState& other)
    {
        return numTails != other.numTails || numPilots != other.numPilots;
    }
 
    int numTails;
    int numPilots;
};
 
class ADatabaseError : public QSqlError {
public:
    ADatabaseError() = default;
    ADatabaseError(QString msg);
    QString text() const;
    ADatabaseError(QSqlError);
};
 
class ADatabase : public QObject {
    Q_OBJECT
 
private:
    static ADatabase* self;
    TableNames_T tableNames;
    TableColumns_T tableColumns;
    int databaseRevision;
 
    ADatabase();
    int checkDbVersion() const;
 
    const static QStringList userTableNames;
    const static QStringList templateTableNames;
    const static int minimumDatabaseRevision;
public:
    QSqlError lastError;
 
    const QFileInfo databaseFile;
 
    // Ensure DB is not copiable or assignable
    ADatabase(const ADatabase&) = delete;
    void operator=(const ADatabase&) = delete;
    static ADatabase* instance();
 
    int dbRevision() const;
 
    const TableNames_T getTableNames() const;
 
    const ColumnNames_T getTableColumns(TableName_T table_name) const;
 
    void updateLayout();
 
    const QString sqliteVersion() const;
 
    bool connect();
 
    void disconnect();
 
    static QSqlDatabase database();
 
    QVector<QVariant> customQuery(QString statement, int return_values);
 
    bool exists(const AEntry &entry);
    bool exists(DataPosition data_position);
 
    bool clear();
 
    bool commit(const AEntry &entry);
 
    bool insert(const AEntry &new_entry);
 
    bool update(const AEntry &updated_entry);
 
    bool remove(const AEntry &entry);
 
    bool removeMany(QList<DataPosition>);
 
    RowData_T getEntryData(DataPosition data_position);
 
    AEntry getEntry(DataPosition data_position);
 
    APilotEntry getPilotEntry(RowId_T row_id);
 
    ATailEntry getTailEntry(RowId_T row_id);
 
    AAircraftEntry getAircraftEntry(RowId_T row_id);
 
    AFlightEntry getFlightEntry(RowId_T row_id);
 
    ACurrencyEntry getCurrencyEntry(ACurrencyEntry::CurrencyName currency_name);
 
    const QStringList getCompletionList(ADatabaseTarget target);
 
    const QHash<RowId_T, QString> getIdMap(ADatabaseTarget target);
 
    RowId_T getLastEntry(ADatabaseTable table);
 
    QList<RowId_T> getForeignKeyConstraints(RowId_T foreign_row_id, ADatabaseTable target);
 
    APilotEntry resolveForeignPilot(RowId_T foreign_key);
 
    ATailEntry resolveForeignTail(RowId_T foreign_key);
 
    QMap<ADatabaseSummaryKey, QString> databaseSummary(const QString& db_path);
 
    const QString databaseSummaryString(const QString& db_path);
 
    bool restoreBackup(const QString& backup_file);
    bool createBackup(const QString& dest_file);
 
    QVector<RowData_T> getTable(ADatabaseTable table_name);
 
    QStringList getUserTableNames();
 
    QStringList getTemplateTableNames();
 
    UserDataState getUserDataState();
 
    static int getMinimumDatabaseRevision();
 
signals:
    void dataBaseUpdated();
    void connectionReset();
};
 
#endif // ADATABASE_H