Change the Entry attributes/attachment API to provide a stable key order.

This commit is contained in:
Felix Geyer 2012-04-06 19:33:29 +02:00
parent b3063c6fc8
commit d527e63f1f
6 changed files with 73 additions and 35 deletions

View File

@ -135,14 +135,24 @@ const QList<AutoTypeAssociation>& Entry::autoTypeAssociations() const
return m_autoTypeAssociations; return m_autoTypeAssociations;
} }
const QHash<QString, QString>& Entry::attributes() const const QList<QString>& Entry::attributes() const
{ {
return m_attributes; return m_attributesKeys;
} }
const QHash<QString, QByteArray>& Entry::attachments() const QString Entry::attributeValue(const QString& key) const
{ {
return m_binaries; return m_attributes.value(key);
}
const QList<QString>& Entry::attachments() const
{
return m_binariesKeys;
}
QByteArray Entry::attachmentValue(const QString& key) const
{
return m_binaries.value(key);
} }
bool Entry::isAttributeProtected(const QString& key) const bool Entry::isAttributeProtected(const QString& key) const
@ -254,7 +264,12 @@ void Entry::addAutoTypeAssociation(const AutoTypeAssociation& assoc)
void Entry::setAttribute(const QString& key, const QString& value, bool protect) void Entry::setAttribute(const QString& key, const QString& value, bool protect)
{ {
if (!m_attributes.contains(key)) {
m_attributesKeys.append(key);
}
m_attributes.insert(key, value); m_attributes.insert(key, value);
if (protect) { if (protect) {
m_protectedAttributes.insert(key); m_protectedAttributes.insert(key);
} }
@ -271,13 +286,19 @@ void Entry::removeAttribute(const QString& key)
{ {
Q_ASSERT(!isDefaultAttribute(key)); Q_ASSERT(!isDefaultAttribute(key));
m_attributesKeys.removeOne(key);
m_attributes.remove(key); m_attributes.remove(key);
m_protectedAttributes.remove(key); m_protectedAttributes.remove(key);
} }
void Entry::setAttachment(const QString& key, const QByteArray& value, bool protect) void Entry::setAttachment(const QString& key, const QByteArray& value, bool protect)
{ {
if (!m_binaries.contains(key)) {
m_binariesKeys.append(key);
}
m_binaries.insert(key, value); m_binaries.insert(key, value);
if (protect) { if (protect) {
m_protectedAttachments.insert(key); m_protectedAttachments.insert(key);
} }
@ -288,6 +309,7 @@ void Entry::setAttachment(const QString& key, const QByteArray& value, bool prot
void Entry::removeAttachment(const QString& key) void Entry::removeAttachment(const QString& key)
{ {
m_binariesKeys.removeOne(key);
m_binaries.remove(key); m_binaries.remove(key);
m_protectedAttachments.remove(key); m_protectedAttachments.remove(key);
} }

View File

@ -60,8 +60,10 @@ public:
int autoTypeObfuscation() const; int autoTypeObfuscation() const;
QString defaultAutoTypeSequence() const; QString defaultAutoTypeSequence() const;
const QList<AutoTypeAssociation>& autoTypeAssociations() const; const QList<AutoTypeAssociation>& autoTypeAssociations() const;
const QHash<QString, QString>& attributes() const; const QList<QString>& attributes() const;
const QHash<QString, QByteArray>& attachments() 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 isAttributeProtected(const QString& key) const;
bool isAttachmentProtected(const QString& key) const; bool isAttachmentProtected(const QString& key) const;
QString title() const; QString title() const;
@ -121,7 +123,9 @@ private:
QString m_defaultAutoTypeSequence; QString m_defaultAutoTypeSequence;
QList<AutoTypeAssociation> m_autoTypeAssociations; QList<AutoTypeAssociation> m_autoTypeAssociations;
QHash<QString, QString> m_attributes; QHash<QString, QString> m_attributes;
QList<QString> m_attributesKeys;
QHash<QString, QByteArray> m_binaries; QHash<QString, QByteArray> m_binaries;
QList<QString> m_binariesKeys;
QSet<QString> m_protectedAttributes; QSet<QString> m_protectedAttributes;
QSet<QString> m_protectedAttachments; QSet<QString> m_protectedAttachments;

View File

@ -253,7 +253,7 @@ void KeePass2XmlWriter::writeEntry(const Entry* entry)
writeString("Tags", entry->tags()); writeString("Tags", entry->tags());
writeTimes(entry->timeInfo()); writeTimes(entry->timeInfo());
Q_FOREACH (const QString& key, entry->attributes().keys()) { Q_FOREACH (const QString& key, entry->attributes()) {
m_xml.writeStartElement("String"); m_xml.writeStartElement("String");
bool protect = ( ((key == "Title") && m_meta->protectTitle()) || bool protect = ( ((key == "Title") && m_meta->protectTitle()) ||
@ -271,11 +271,11 @@ void KeePass2XmlWriter::writeEntry(const Entry* entry)
if (protect) { if (protect) {
m_xml.writeAttribute("Protected", "True"); m_xml.writeAttribute("Protected", "True");
QByteArray rawData = m_randomStream->process(entry->attributes().value(key).toUtf8()); QByteArray rawData = m_randomStream->process(entry->attributeValue(key).toUtf8());
value = QString::fromAscii(rawData.toBase64()); value = QString::fromAscii(rawData.toBase64());
} }
else { else {
value = entry->attributes().value(key); value = entry->attributeValue(key);
} }
m_xml.writeCharacters(value); m_xml.writeCharacters(value);
@ -284,7 +284,7 @@ void KeePass2XmlWriter::writeEntry(const Entry* entry)
m_xml.writeEndElement(); m_xml.writeEndElement();
} }
Q_FOREACH (const QString& key, entry->attachments().keys()) { Q_FOREACH (const QString& key, entry->attachments()) {
m_xml.writeStartElement("Binary"); m_xml.writeStartElement("Binary");
bool protect = entry->isAttachmentProtected(key) && m_randomStream; bool protect = entry->isAttachmentProtected(key) && m_randomStream;
@ -296,11 +296,11 @@ void KeePass2XmlWriter::writeEntry(const Entry* entry)
if (protect) { if (protect) {
m_xml.writeAttribute("Protected", "True"); m_xml.writeAttribute("Protected", "True");
QByteArray rawData = m_randomStream->process(entry->attachments().value(key)); QByteArray rawData = m_randomStream->process(entry->attachmentValue(key));
value = QString::fromAscii(rawData.toBase64()); value = QString::fromAscii(rawData.toBase64());
} }
else { else {
value = entry->attachments().value(key); value = entry->attachmentValue(key);
} }
m_xml.writeCharacters(value); m_xml.writeCharacters(value);

View File

@ -79,8 +79,8 @@ void TestKeePass2Reader::testProtectedStrings()
QCOMPARE(entry->title(), QString("Sample Entry")); QCOMPARE(entry->title(), QString("Sample Entry"));
QCOMPARE(entry->username(), QString("Protected User Name")); QCOMPARE(entry->username(), QString("Protected User Name"));
QCOMPARE(entry->password(), QString("ProtectedPassword")); QCOMPARE(entry->password(), QString("ProtectedPassword"));
QCOMPARE(entry->attributes().value("TestProtected"), QString("ABC")); QCOMPARE(entry->attributeValue("TestProtected"), QString("ABC"));
QCOMPARE(entry->attributes().value("TestUnprotected"), QString("DEF")); QCOMPARE(entry->attributeValue("TestUnprotected"), QString("DEF"));
QVERIFY(!db->metadata()->protectTitle()); QVERIFY(!db->metadata()->protectTitle());
QVERIFY(db->metadata()->protectUsername()); QVERIFY(db->metadata()->protectUsername());

View File

@ -75,7 +75,7 @@ void TestKeePass2Writer::testProtectedAttributes()
{ {
QCOMPARE(m_dbTest->rootGroup()->entries().size(), 1); QCOMPARE(m_dbTest->rootGroup()->entries().size(), 1);
Entry* entry = m_dbTest->rootGroup()->entries().at(0); Entry* entry = m_dbTest->rootGroup()->entries().at(0);
QCOMPARE(entry->attributes().value("test"), QString("protectedTest")); QCOMPARE(entry->attributeValue("test"), QString("protectedTest"));
QCOMPARE(entry->isAttributeProtected("test"), true); QCOMPARE(entry->isAttributeProtected("test"), true);
} }

View File

@ -214,19 +214,24 @@ void TestKeePass2XmlReader::testEntry1()
QCOMPARE(ti.usageCount(), 8); QCOMPARE(ti.usageCount(), 8);
QCOMPARE(ti.locationChanged(), genDT(2010, 8, 25, 16, 13, 54)); QCOMPARE(ti.locationChanged(), genDT(2010, 8, 25, 16, 13, 54));
QHash<QString,QString> attrs = entry->attributes(); QList<QString> attrs = entry->attributes();
QCOMPARE(attrs.take("Notes"), QString("Notes")); QCOMPARE(entry->attributeValue("Notes"), QString("Notes"));
QCOMPARE(attrs.take("Password"), QString("Password")); QVERIFY(attrs.removeOne("Notes"));
QCOMPARE(attrs.take("Title"), QString("Sample Entry 1")); QCOMPARE(entry->attributeValue("Password"), QString("Password"));
QCOMPARE(attrs.take("URL"), QString("")); QVERIFY(attrs.removeOne("Password"));
QCOMPARE(attrs.take("UserName"), QString("User Name")); QCOMPARE(entry->attributeValue("Title"), QString("Sample Entry 1"));
QVERIFY(attrs.removeOne("Title"));
QCOMPARE(entry->attributeValue("URL"), QString(""));
QVERIFY(attrs.removeOne("URL"));
QCOMPARE(entry->attributeValue("UserName"), QString("User Name"));
QVERIFY(attrs.removeOne("UserName"));
QVERIFY(attrs.isEmpty()); QVERIFY(attrs.isEmpty());
QCOMPARE(entry->title(), entry->attributes().value("Title")); QCOMPARE(entry->title(), entry->attributeValue("Title"));
QCOMPARE(entry->url(), entry->attributes().value("URL")); QCOMPARE(entry->url(), entry->attributeValue("URL"));
QCOMPARE(entry->username(), entry->attributes().value("UserName")); QCOMPARE(entry->username(), entry->attributeValue("UserName"));
QCOMPARE(entry->password(), entry->attributes().value("Password")); QCOMPARE(entry->password(), entry->attributeValue("Password"));
QCOMPARE(entry->notes(), entry->attributes().value("Notes")); QCOMPARE(entry->notes(), entry->attributeValue("Notes"));
QCOMPARE(entry->attachments().size(), 0); QCOMPARE(entry->attachments().size(), 0);
QCOMPARE(entry->autoTypeEnabled(), false); QCOMPARE(entry->autoTypeEnabled(), false);
@ -253,18 +258,25 @@ void TestKeePass2XmlReader::testEntry2()
const TimeInfo ti = entry->timeInfo(); const TimeInfo ti = entry->timeInfo();
QCOMPARE(ti.usageCount(), 7); QCOMPARE(ti.usageCount(), 7);
QHash<QString,QString> attrs = entry->attributes(); QList<QString> attrs = entry->attributes();
QCOMPARE(attrs.take("CustomString"), QString("isavalue")); QCOMPARE(entry->attributeValue("CustomString"), QString("isavalue"));
QCOMPARE(attrs.take("Notes"), QString("")); QVERIFY(attrs.removeOne("CustomString"));
QCOMPARE(attrs.take("Password"), QString("Jer60Hz8o9XHvxBGcRqT")); QCOMPARE(entry->attributeValue("Notes"), QString(""));
QCOMPARE(attrs.take("Protected String"), QString("y")); // TODO should have a protection attribute QVERIFY(attrs.removeOne("Notes"));
QCOMPARE(attrs.take("Title"), QString("Sample Entry 2")); QCOMPARE(entry->attributeValue("Password"), QString("Jer60Hz8o9XHvxBGcRqT"));
QCOMPARE(attrs.take("URL"), QString("http://www.keepassx.org/")); QVERIFY(attrs.removeOne("Password"));
QCOMPARE(attrs.take("UserName"), QString("notDEFUSERNAME")); QCOMPARE(entry->attributeValue("Protected String"), QString("y")); // TODO should have a protection attribute
QVERIFY(attrs.removeOne("Protected String"));
QCOMPARE(entry->attributeValue("Title"), QString("Sample Entry 2"));
QVERIFY(attrs.removeOne("Title"));
QCOMPARE(entry->attributeValue("URL"), QString("http://www.keepassx.org/"));
QVERIFY(attrs.removeOne("URL"));
QCOMPARE(entry->attributeValue("UserName"), QString("notDEFUSERNAME"));
QVERIFY(attrs.removeOne("UserName"));
QVERIFY(attrs.isEmpty()); QVERIFY(attrs.isEmpty());
QCOMPARE(entry->attachments().size(), 1); QCOMPARE(entry->attachments().size(), 1);
QCOMPARE(QString(entry->attachments().value("testattach.txt")), QString("42")); QCOMPARE(QString(entry->attachmentValue("testattach.txt")), QString("42"));
QCOMPARE(entry->autoTypeEnabled(), true); QCOMPARE(entry->autoTypeEnabled(), true);
QCOMPARE(entry->autoTypeObfuscation(), 1); QCOMPARE(entry->autoTypeObfuscation(), 1);