Differential D14756 Diff 39619 kmymoney/plugins/xml/xmlstorageupdater.cpp

Changeset View

Standalone View

kmymoney/plugins/xml/xmlstorageupdater.cpp

This file was added.

1		/*
2		* Copyright 2018 Łukasz Wojniłowicz <lukasz.wojnilowicz@gmail.com>
3		*
4		* This program is free software; you can redistribute it and/or
5		* modify it under the terms of the GNU General Public License as
6		* published by the Free Software Foundation; either version 2 of
7		* the License, or (at your option) any later version.
8		*
9		* This program is distributed in the hope that it will be useful,
10		* but WITHOUT ANY WARRANTY; without even the implied warranty of
11		* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12		* GNU General Public License for more details.
13		*
14		* You should have received a copy of the GNU General Public License
15		* along with this program. If not, see <http://www.gnu.org/licenses/>.
16		*/
17
18		#include "xmlstorageupdater.h"
19
20		// ----------------------------------------------------------------------------
21		// QT Includes
22
23		#include <QIODevice>
24		#include <QDomDocument>
25		#include <QDebug>
26		#include <QFile>
27
28		// ----------------------------------------------------------------------------
29		// KDE Includes
30
31		// ----------------------------------------------------------------------------
32		// Project Includes
33
34		#include "mymoneyenums.h"
35
36		namespace XMLStorageUpdater
37		{
38
39		/**
40		* @brief updateVersion1Fix5
41		* @param doc as parsed document
42		* Changes (2018-08-19):
43		* 1) make two separate transactions out of two matched transactions
44		* 2) create a new tramsaction as a result of matching
45		* 3) add origin (imported, typed, matched) of transaction
46		* 4) add kmm-match-transaction containing two matched transaction IDs to every matched split
47		* 5) add kmm-match-split containing two matched split IDs to every matched split
48		* @return true if upgrade is successful
49		*/
50
51		bool upgradeVersion1Fix5(QDomDocument &doc)
52		{
53		auto transactionsNodes = doc.elementsByTagName("TRANSACTIONS");
54
55		// no transactions = no problem
56		if (transactionsNodes.isEmpty())
57		return true;
58
59		auto transactionsNode = transactionsNodes.item(0);
60		auto transactionNodes = transactionsNode.childNodes();
61		if (transactionNodes.isEmpty())
62		return true;
63
64		// we need to know the highest unoccupied ID to know what IDs can we assign to new (reorganized) transactions
65		QStringList transactionIDs;
66		ulong lastTransactionID = 0;
67		for (auto i = 0; i < transactionNodes.length(); ++i) {
68		auto transationElement = transactionNodes.item(i).toElement();
69		transactionIDs.append(transationElement.attribute("id"));
70		}
71		std::sort(transactionIDs.begin(), transactionIDs.end());
72		lastTransactionID = transactionIDs.last().mid(1).toUInt();
73
74		for (auto i = 0; i < transactionNodes.length(); ++i) {
75		auto transactionElement = transactionNodes.item(i).toElement();
76
77		// search if the transaction is imported in order to set its origin properly
78		auto transactionOriginAttribute = static_cast<eMyMoney::Transaction::Origin>(transactionElement.attribute("origin").toInt());
79		auto transactionKVPElement = transactionNodes.item(i).namedItem("KEYVALUEPAIRS").toElement();
80		auto transactionPairNodes = transactionKVPElement.elementsByTagName("PAIR");
81		for (auto k = 0; k < transactionPairNodes.length() ; ++k) {
82		auto pairNodeElement = transactionPairNodes.item(k).toElement();
83		if (pairNodeElement.attribute("key").compare("Imported", Qt::CaseInsensitive) == 0) {
84		transactionKVPElement.removeChild(pairNodeElement);
85		transactionOriginAttribute = static_cast<eMyMoney::Transaction::Origin>(transactionOriginAttribute \| eMyMoney::Transaction::Origin::Imported);
86		break;
87		}
88		}
89
90		// if transaction isn't imported then it has been manually typed
91		if (!(transactionOriginAttribute & eMyMoney::Transaction::Origin::Imported))
92		transactionOriginAttribute = static_cast<eMyMoney::Transaction::Origin>(transactionOriginAttribute \| eMyMoney::Transaction::Origin::Typed);
93
94		auto splitsNode = transactionElement.elementsByTagName("SPLITS").item(0);
95		auto splitNodes = splitsNode.childNodes();
96		for (auto j = 0; j < splitNodes.length(); ++j) {
97		auto splitElement = splitNodes.item(j).toElement();
98		auto splitKVPElement = splitElement.elementsByTagName("KEYVALUEPAIRS").item(0).toElement();
99		auto splitPairNodes = splitKVPElement.elementsByTagName("PAIR");
100
101		// get a map of all key-value pairs out of a split for convenient usage
102		QMap<QString, QString> keyValueMap;
103		for (auto k = 0; k < splitPairNodes.length() ; ++k) {
104		auto pairNodeElement = splitPairNodes.item(k).toElement();
105		keyValueMap.insert(pairNodeElement.attribute("key"), pairNodeElement.attribute("value"));
106		}
107
108		// act on splits that embedded imported transaction
109		if (keyValueMap.contains("kmm-matched-tx")) {
110		// unembedd imported transaction
111		auto embeddedTransactionXML = keyValueMap.value("kmm-matched-tx");
112		embeddedTransactionXML.replace(QLatin1String("<"), QLatin1String("<"));
113		QDomDocument embeddedTransactionDoc;
114		QDomNode embeddedTransactionNode;
115		embeddedTransactionDoc.setContent(embeddedTransactionXML);
116		embeddedTransactionNode = embeddedTransactionDoc.documentElement().firstChild().cloneNode();
117		auto embeddedTransactionElement = embeddedTransactionNode.toElement();
118
119		// assign free transaction id
120		auto embeddedTransactionID = QString::fromLatin1("T%1").arg(QString::number(++lastTransactionID).rightJustified(18 , '0'));
121		embeddedTransactionElement.setAttribute("id", embeddedTransactionID);
122
123		// at this point we only know that it's an input for matching
124		auto embeddedTransactionOrigin = eMyMoney::Transaction::Origin::None;
125		embeddedTransactionOrigin = static_cast<eMyMoney::Transaction::Origin>(embeddedTransactionOrigin \| eMyMoney::Transaction::Origin::MatchingInput);
126		embeddedTransactionElement.setAttribute("origin", embeddedTransactionOrigin);
127
128		// we don't need those attributes anymore and their values have been stored earlier
129		const QVector<QString> backupValuesToBeRemoved {"kmm-orig-postdate",
130		"kmm-orig-payee",
131		"kmm-orig-memo",
132		"kmm-matched-tx",
133		"kmm-match-split"};
134		for (auto k = splitPairNodes.length() - 1; k >= 0; --k) {
135		auto pairNodeElement = splitPairNodes.item(k).toElement();
136		if (backupValuesToBeRemoved.contains(pairNodeElement.attribute("key")))
137		splitKVPElement.removeChild(splitPairNodes.item(k));
138		}
139
140		// we had two tranactions: matched and imported,
141		// and now we have three: matched (result of matching) , imported (input for matching), typed (input for matching)
142		auto sourceTransactionNode = transactionElement.cloneNode();
143
144		// assign free transaction id
145		auto sourceTransactionElement = sourceTransactionNode.toElement();
146		auto sourceTransactionID = QString::fromLatin1("T%1").arg(QString::number(++lastTransactionID).rightJustified(18 , '0'));
147		sourceTransactionElement.setAttribute("id", sourceTransactionID);
148
149		// at this point we only know that it's an input for matching
150		auto sourceTransactionOrigin = eMyMoney::Transaction::Origin::None;
151		sourceTransactionOrigin = static_cast<eMyMoney::Transaction::Origin>(sourceTransactionOrigin \| eMyMoney::Transaction::Origin::MatchingInput);
152		sourceTransactionElement.setAttribute("origin", sourceTransactionOrigin);
153
154		// previous matching changed input transaction a little bit, so restore its values to the original ones
155		if (keyValueMap.contains("kmm-orig-postdate"))
156		sourceTransactionElement.setAttribute("postdate", keyValueMap.value("kmm-orig-postdate"));
157
158		auto sourceTransactionSplitsNode = sourceTransactionElement.elementsByTagName("SPLITS").item(0);
159		auto sourceTransactionSplitNodes = sourceTransactionSplitsNode.childNodes();
160		for (auto k = 0; k < sourceTransactionSplitNodes.length(); ++k) {
161		auto sourceTransactionSplitElement = sourceTransactionSplitNodes.item(k).toElement();
162		auto sourceTransactionSplitID = sourceTransactionSplitElement.attribute("id");
163		if (sourceTransactionSplitID == keyValueMap.value("kmm-match-split")) {
164		if (keyValueMap.contains("kmm-orig-payee"))
165		sourceTransactionSplitElement.setAttribute("payee", keyValueMap.value("kmm-orig-payee"));
166		if (keyValueMap.contains("kmm-orig-memo"))
167		sourceTransactionSplitElement.setAttribute("memo", keyValueMap.value("kmm-orig-memo"));
168		break;
169		}
170		}
171
172		// matched transaction has information about transactions (their IDs) that were input for matching
173		// example "T000000000000000001;T000000000000000002"
174		auto matchedTransactionKeyValuePair = doc.createElement("PAIR");
175		matchedTransactionKeyValuePair.setAttribute("key", "kmm-match-transaction");
176		matchedTransactionKeyValuePair.setAttribute("value", QString::fromLatin1("%1;%2").arg(sourceTransactionID, embeddedTransactionID));
177		splitKVPElement.appendChild(matchedTransactionKeyValuePair);
178
179		// matched transaction has information about splits (their IDs) that were matched during matching
180		// example "S0001;S0001"
181		auto matchedSplitKeyValuePair = doc.createElement("PAIR");
182		matchedSplitKeyValuePair.setAttribute("key", "kmm-match-split");
183		matchedSplitKeyValuePair.setAttribute("value", QString::fromLatin1("%1;%2").arg(splitElement.attribute("id"), keyValueMap.value("kmm-match-split")));
184		splitKVPElement.appendChild(matchedSplitKeyValuePair);
185
186		// append new transactions now so that they will get picked by this loop
187		// and their origin could be established at the beggining of this loop
188		transactionsNode.appendChild(embeddedTransactionNode);
189		transactionsNode.appendChild(sourceTransactionElement);
190
191		// we know that it's and output of matching
192		transactionOriginAttribute = static_cast<eMyMoney::Transaction::Origin>(transactionOriginAttribute \| eMyMoney::Transaction::Origin::MatchingOutput);
193		}
194
195		transactionElement.setAttribute("origin", transactionOriginAttribute);
196		}
197		}
198		return true;
199		}
200
201		bool updateFile(QIODevice* pXMLDevice)
202		{
203		QDomDocument doc;
204		auto ret = doc.setContent(pXMLDevice);
205		if (!ret)
206		return false;
207
208		auto fixVersionElement = doc.elementsByTagName("FIXVERSION").item(0).toElement();
209		const auto fixVersion = fixVersionElement.attribute("id").toUInt();
210		auto versionElement = doc.elementsByTagName("VERSION").item(0).toElement();
211		const auto version = versionElement.attribute("id").toUInt();
212
213		auto isUpdateSuccessful = true;
214
215		switch (version) {
216		case 1:
217		switch (fixVersion) {
218		case 1:
	tbaumgartUnsubmitted Not Done What about the existing fixes? Don't they need to be called here in a loop before the new one can be executed? tbaumgart: What about the existing fixes? Don't they need to be called here in a loop before the new one…
	wojnilowiczAuthorUnsubmitted Not Done Existing fixes don't touch a file but MyMoneyStorageMgr after the file is loaded, so IMO they are useless if MyMoneyStorageMgr changes. I thought about dropping them because: they are old, they are useless with our changing code. wojnilowicz: Existing fixes don't touch a file but MyMoneyStorageMgr after the file is loaded, so IMO they…
219		case 2:
220		case 3:
	tbaumgartUnsubmitted Done no need of this comment here, multiple case statements in a row are no problem. tbaumgart: no need of this comment here, multiple case statements in a row are no problem.
221		case 4:
222		isUpdateSuccessful \|= upgradeVersion1Fix5(doc);
223		// intentional fall through
224		case 5:
225		break;
226		default:
227		break;
228		}
229		// intentional fall through
230		default:
231		break;
232		}
233
234		if (!(version == 1 && fixVersion < 4)) {
235		versionElement.setAttribute("id", "1");
236		fixVersionElement.setAttribute("id", "5");
237		}
238
239		if (isUpdateSuccessful) {
240		pXMLDevice->close();
241		pXMLDevice->open(QIODevice::ReadWrite \| QIODevice::Truncate);
242		pXMLDevice->write(doc.toByteArray());
243		}
244
245		return isUpdateSuccessful;
246		}
247
248		}