adatabase.h

/*
 *openPilot Log - A FOSS Pilot Logbook Application
 *Copyright (C) 2020  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 __DB_H__
#define __DB_H__
 
#include <QPair>
#include <QMap>
#include <QString>
#include <QSqlQuery>
#include <QSqlError>
#include <QSqlTableModel>
#include "src/database/dbinfo.h"
#include "src/testing/adebug.h"
 
#include "aentry.h"
#include "apilotentry.h"
#include "atailentry.h"
#include "aaircraftentry.h"
#include "aflightentry.h"
 
namespace experimental {
 
 
// [G]: Suspicious documentation -,O
enum class ADatabaseTarget
{
    airport_identifier_icao,
    airport_identifier_iata,
    airport_identifier_all,
    airport_names,
    pilots,
    registrations,
    aircraft,
    companies,
    tails
};
 
// [G]: This is how we should handle custom "events" in the program.
// In this case a custom error doesnt need to be built from scratch.
// Find the type of error you want and extend it with a few tweaks.
class ADatabaseError : public QSqlError {
public:
  ADatabaseError() = default;
  ADatabaseError(QString msg);
  QString text() const;
};
 
class ADatabase : public QObject {
    Q_OBJECT
private:
    TableNames tableNames;
    TableColumns tableColumns;
    static ADatabase* instance;
    ADatabase() = default;
public:
    // Ensure DB is not copiable or assignable
    ADatabase(const ADatabase&) = delete;
    void operator=(const ADatabase&) = delete;
    static ADatabase* getInstance();
    ADatabaseError lastError;
 
    bool connect();
 
    void disconnect();
 
    static QSqlDatabase database();
 
    QVector<QString> customQuery(QString statement, int return_values);
 
    bool exists(AEntry entry);
    bool exists(DataPosition data_position);
 
    bool commit(AEntry entry);
 
    bool insert(AEntry new_entry);
 
    bool update(AEntry updated_entry);
 
    bool remove(AEntry entry);
 
    bool removeMany(QList<DataPosition>);
 
    TableData getEntryData(DataPosition data_position);
 
    AEntry getEntry(DataPosition data_position);
 
    APilotEntry getPilotEntry(RowId row_id);
 
    ATailEntry getTailEntry(RowId row_id);
 
    AAircraftEntry getAircraftEntry(RowId row_id);
 
    AFlightEntry getFlightEntry(RowId row_id);
 
    const QStringList getCompletionList(ADatabaseTarget);
 
    const QMap<QString, int> getIdMap(ADatabaseTarget);
 
    int getLastEntry(ADatabaseTarget);
 
    QList<int> getForeignKeyConstraints(int foreign_row_id, ADatabaseTarget target);
 
signals:
    void dataBaseUpdated();
};
 
ADatabase* aDB();
 
}  // namespace experimental
 
#endif