PasswordDB.h

/***************************************************************************
 *   Copyright (C) 2021--2026 by Stefan Kebekus                            *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   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, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QHash>
#include <QQmlEngine>
 
#include "GlobalObject.h"
 
namespace Traffic {
 

class PasswordDB : public QObject {
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    PasswordDB(QObject* parent=nullptr);
 
    // No default constructor, important for QML singleton
    explicit PasswordDB() = delete;
 
    ~PasswordDB() override = default;
 
    // factory function for QML singleton
    static Traffic::PasswordDB* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
    {
        return GlobalObject::passwordDB();
    }
 
 
    //
    // Properties
    //

    Q_PROPERTY(bool empty READ empty NOTIFY emptyChanged)
 
    
    [[nodiscard]] auto empty() const -> bool
    {
        return m_empty;
    }
 
 
    //
    // Methods
    //

    Q_INVOKABLE void clear();

    [[nodiscard]] Q_INVOKABLE bool contains(const QString& key) const
    {
        return m_passwordDB.contains(key);
    }

    [[nodiscard]] Q_INVOKABLE QString password(const QString& key) const
    {
        return m_passwordDB.value(key);
    }

    Q_INVOKABLE void removePassword(const QString& key);

    Q_INVOKABLE void setPassword(const QString& key, const QString& password);
 
signals:
    void emptyChanged();
 
private:
    Q_DISABLE_COPY_MOVE(PasswordDB)
 
    // Update the property 'empty' and emit the notifier signal, if appropriate
    void updateEmpty();
 
    // Save database to disk. Returns true on success; on failure logs a warning
    // and returns false (the existing on-disk file is left untouched).
    bool save();
 
    // Property empty
    bool m_empty = true;
 
    // Password database
    QString passwordDBFileName;
 
    QHash<QString, QString> m_passwordDB;
};
 
} // namespace Traffic