keepassxc/src/core/Entry.h

/*
 *  Copyright (C) 2010 Felix Geyer <debfx@fobos.de>
 *
 *  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 or (at your option)
 *  version 3 of the License.
 *
 *  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 <http://www.gnu.org/licenses/>.
 */

#ifndef KEEPASSX_ENTRY_H
#define KEEPASSX_ENTRY_H

#include <QtCore/QMap>
#include <QtCore/QPointer>
#include <QtCore/QSet>
#include <QtCore/QUrl>
#include <QtGui/QColor>
#include <QtGui/QImage>
#include <QtGui/QPixmap>
#include <QtGui/QPixmapCache>

#include "core/TimeInfo.h"
#include "core/Uuid.h"

class Database;
class Group;

struct AutoTypeAssociation
{
    QString window;
    QString sequence;
};

class Entry : public QObject
{
    Q_OBJECT

public:
    Entry();
    ~Entry();
    Uuid uuid() const;
    QImage icon() const;
    QPixmap iconPixmap() const;
    int iconNumber() const;
    Uuid iconUuid() const;
    QColor foregroundColor() const;
    QColor backgroundColor() const;
    QString overrideUrl() const;
    QString tags() const;
    TimeInfo timeInfo() const;
    bool autoTypeEnabled() const;
    int autoTypeObfuscation() const;
    QString defaultAutoTypeSequence() const;
    const QList<AutoTypeAssociation>& autoTypeAssociations() const;
    const QList<QString> attributes() const;
    QString attributeValue(const QString& key) const;
    const QList<QString> attachments() const;
    QByteArray attachmentValue(const QString& key) const;
    bool isAttributeProtected(const QString& key) const;
    bool isAttachmentProtected(const QString& key) const;
    QString title() const;
    QString url() const;
    QString username() const;
    QString password() const;
    QString notes() const;

    void setUuid(const Uuid& uuid);
    void setIcon(int iconNumber);
    void setIcon(const Uuid& uuid);
    void setForegroundColor(const QColor& color);
    void setBackgroundColor(const QColor& color);
    void setOverrideUrl(const QString& url);
    void setTags(const QString& tags);
    void setTimeInfo(const TimeInfo& timeInfo);
    void setAutoTypeEnabled(bool enable);
    void setAutoTypeObfuscation(int obfuscation);
    void setDefaultAutoTypeSequence(const QString& sequence);
    void addAutoTypeAssociation(const AutoTypeAssociation& assoc);
    void setAttribute(const QString& key, const QString& value, bool protect = false);
    void removeAttribute(const QString& key);
    void setAttachment(const QString& key, const QByteArray& value, bool protect = false);
    void removeAttachment(const QString& key);
    void setTitle(const QString& title);
    void setUrl(const QString& url);
    void setUsername(const QString& username);
    void setPassword(const QString& password);
    void setNotes(const QString& notes);

    QList<Entry*> historyItems();
    const QList<Entry*>& historyItems() const;
    void addHistoryItem(Entry* entry);

    Group* group();
    void setGroup(Group* group);

    static bool isDefaultAttribute(const QString& key);

Q_SIGNALS:
    /**
     * Emitted when a default attribute has been changed.
     */
    void dataChanged(Entry* entry);

    void attributeChanged(QString key);
    void attributeAboutToBeAdded(QString key);
    void attributeAdded(QString key);
    void attributeAboutToBeRemoved(QString key);
    void attributeRemoved(QString key);

    void attachmentChanged(QString key);
    void attachmentAboutToBeAdded(QString key);
    void attachmentAdded(QString key);
    void attachmentAboutToBeRemoved(QString key);
    void attachmentRemoved(QString key);

private:
    Uuid m_uuid;
    int m_iconNumber;
    Uuid m_customIcon;
    QColor m_foregroundColor;
    QColor m_backgroundColor;
    QString m_overrideUrl;
    QString m_tags;
    TimeInfo m_timeInfo;
    bool m_autoTypeEnabled;
    int m_autoTypeObfuscation;
    QString m_defaultAutoTypeSequence;
    QList<AutoTypeAssociation> m_autoTypeAssociations;
    QMap<QString, QString> m_attributes;
    QMap<QString, QByteArray> m_binaries;
    QSet<QString> m_protectedAttributes;
    QSet<QString> m_protectedAttachments;

    QList<Entry*> m_history;
    QPointer<Group> m_group;
    const Database* m_db;
    QPixmapCache::Key m_pixmapCacheKey;
    const static QStringList m_defaultAttibutes;
};

#endif // KEEPASSX_ENTRY_H