Branch data Line data Source code
1 : : /********************************************************************\
2 : : * Account.c -- Account data structure implementation *
3 : : * Copyright (C) 1997 Robin D. Clark *
4 : : * Copyright (C) 1997-2003 Linas Vepstas <linas@linas.org> *
5 : : * Copyright (C) 2007 David Hampton <hampton@employees.org> *
6 : : * *
7 : : * This program is free software; you can redistribute it and/or *
8 : : * modify it under the terms of the GNU General Public License as *
9 : : * published by the Free Software Foundation; either version 2 of *
10 : : * the License, or (at your option) any later version. *
11 : : * *
12 : : * This program is distributed in the hope that it will be useful, *
13 : : * but WITHOUT ANY WARRANTY; without even the implied warranty of *
14 : : * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
15 : : * GNU General Public License for more details. *
16 : : * *
17 : : * You should have received a copy of the GNU General Public License*
18 : : * along with this program; if not, contact: *
19 : : * *
20 : : * Free Software Foundation Voice: +1-617-542-5942 *
21 : : * 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
22 : : * Boston, MA 02110-1301, USA gnu@gnu.org *
23 : : * *
24 : : \********************************************************************/
25 : :
26 : : #include <config.h>
27 : :
28 : : #include "gnc-prefs.h"
29 : :
30 : : #include <glib.h>
31 : : #include <glib/gi18n.h>
32 : : #include <stdlib.h>
33 : : #include <stdint.h>
34 : : #include <string.h>
35 : :
36 : : #include "AccountP.hpp"
37 : : #include "Account.hpp"
38 : : #include "Split.h"
39 : : #include "Transaction.h"
40 : : #include "TransactionP.hpp"
41 : : #include "gnc-event.h"
42 : : #include "gnc-glib-utils.h"
43 : : #include "gnc-lot.h"
44 : : #include "gnc-pricedb.h"
45 : : #include "qofevent.h"
46 : : #include "qofinstance-p.h"
47 : : #include "gnc-features.h"
48 : : #include "guid.hpp"
49 : :
50 : : #include <numeric>
51 : : #include <map>
52 : : #include <unordered_set>
53 : : #include <algorithm>
54 : :
55 : : static QofLogModule log_module = GNC_MOD_ACCOUNT;
56 : :
57 : : /* The Canonical Account Separator. Pre-Initialized. */
58 : : static gchar account_separator[8] = ".";
59 : : static gunichar account_uc_separator = ':';
60 : :
61 : : static bool imap_convert_bayes_to_flat_run = false;
62 : :
63 : : /* Predefined KVP paths */
64 : : static const std::string KEY_ASSOC_INCOME_ACCOUNT("ofx/associated-income-account");
65 : : static const std::string KEY_RECONCILE_INFO("reconcile-info");
66 : : static const std::string KEY_INCLUDE_CHILDREN("include-children");
67 : : static const std::string KEY_POSTPONE("postpone");
68 : : static const std::string KEY_LOT_MGMT("lot-mgmt");
69 : : static const std::string KEY_ONLINE_ID("online_id");
70 : : static const std::string KEY_IMP_APPEND_TEXT("import-append-text");
71 : : static const std::string AB_KEY("hbci");
72 : : static const std::string AB_ACCOUNT_ID("account-id");
73 : : static const std::string AB_ACCOUNT_UID("account-uid");
74 : : static const std::string AB_BANK_CODE("bank-code");
75 : : static const std::string AB_TRANS_RETRIEVAL("trans-retrieval");
76 : :
77 : : static const std::string KEY_BALANCE_LIMIT("balance-limit");
78 : : static const std::string KEY_BALANCE_HIGHER_LIMIT_VALUE("higher-value");
79 : : static const std::string KEY_BALANCE_LOWER_LIMIT_VALUE("lower-value");
80 : : static const std::string KEY_BALANCE_INCLUDE_SUB_ACCTS("inlude-sub-accts");
81 : :
82 : : using FinalProbabilityVec=std::vector<std::pair<std::string, int32_t>>;
83 : : using ProbabilityVec=std::vector<std::pair<std::string, struct AccountProbability>>;
84 : : using FlatKvpEntry=std::pair<std::string, KvpValue*>;
85 : :
86 : : enum
87 : : {
88 : : LAST_SIGNAL
89 : : };
90 : :
91 : : enum
92 : : {
93 : : PROP_0,
94 : : PROP_NAME, /* Table */
95 : : PROP_FULL_NAME, /* Constructed */
96 : : PROP_CODE, /* Table */
97 : : PROP_DESCRIPTION, /* Table */
98 : : PROP_COLOR, /* KVP */
99 : : PROP_NOTES, /* KVP */
100 : : PROP_TYPE, /* Table */
101 : :
102 : : // PROP_PARENT, /* Table, Not a property */
103 : : PROP_COMMODITY, /* Table */
104 : : PROP_COMMODITY_SCU, /* Table */
105 : : PROP_NON_STD_SCU, /* Table */
106 : : PROP_END_BALANCE, /* Constructed */
107 : : PROP_END_NOCLOSING_BALANCE, /* Constructed */
108 : : PROP_END_CLEARED_BALANCE, /* Constructed */
109 : : PROP_END_RECONCILED_BALANCE, /* Constructed */
110 : :
111 : : PROP_TAX_RELATED, /* KVP */
112 : : PROP_TAX_CODE, /* KVP */
113 : : PROP_TAX_SOURCE, /* KVP */
114 : : PROP_TAX_COPY_NUMBER, /* KVP */
115 : :
116 : : PROP_HIDDEN, /* Table slot exists, but in KVP in memory & xml */
117 : : PROP_PLACEHOLDER, /* Table slot exists, but in KVP in memory & xml */
118 : : PROP_AUTO_INTEREST,
119 : : PROP_FILTER, /* KVP */
120 : : PROP_SORT_ORDER, /* KVP */
121 : : PROP_SORT_REVERSED,
122 : :
123 : : PROP_LOT_NEXT_ID, /* KVP */
124 : : PROP_ONLINE_ACCOUNT, /* KVP */
125 : : PROP_IMP_APPEND_TEXT, /* KVP */
126 : : PROP_IS_OPENING_BALANCE, /* KVP */
127 : : PROP_OFX_INCOME_ACCOUNT, /* KVP */
128 : : PROP_AB_ACCOUNT_ID, /* KVP */
129 : : PROP_AB_ACCOUNT_UID, /* KVP */
130 : : PROP_AB_BANK_CODE, /* KVP */
131 : : PROP_AB_TRANS_RETRIEVAL, /* KVP */
132 : :
133 : : PROP_RUNTIME_0,
134 : : PROP_POLICY, /* Cached Value */
135 : : PROP_MARK, /* Runtime Value */
136 : : PROP_SORT_DIRTY, /* Runtime Value */
137 : : PROP_BALANCE_DIRTY, /* Runtime Value */
138 : : PROP_START_BALANCE, /* Runtime Value */
139 : : PROP_START_NOCLOSING_BALANCE, /* Runtime Value */
140 : : PROP_START_CLEARED_BALANCE, /* Runtime Value */
141 : : PROP_START_RECONCILED_BALANCE, /* Runtime Value */
142 : : };
143 : :
144 : : #define GET_PRIVATE(o) \
145 : : ((AccountPrivate*)gnc_account_get_instance_private((Account*)o))
146 : :
147 : : /* This map contains a set of strings representing the different column types. */
148 : : static const std::map<GNCAccountType, const char*> gnc_acct_debit_strs = {
149 : : { ACCT_TYPE_NONE, N_("Funds In") },
150 : : { ACCT_TYPE_BANK, N_("Deposit") },
151 : : { ACCT_TYPE_CASH, N_("Receive") },
152 : : { ACCT_TYPE_CREDIT, N_("Payment") },
153 : : { ACCT_TYPE_ASSET, N_("Increase") },
154 : : { ACCT_TYPE_LIABILITY, N_("Decrease") },
155 : : { ACCT_TYPE_STOCK, N_("Buy") },
156 : : { ACCT_TYPE_MUTUAL, N_("Buy") },
157 : : { ACCT_TYPE_CURRENCY, N_("Buy") },
158 : : { ACCT_TYPE_INCOME, N_("Charge") },
159 : : { ACCT_TYPE_EXPENSE, N_("Expense") },
160 : : { ACCT_TYPE_PAYABLE, N_("Payment") },
161 : : { ACCT_TYPE_RECEIVABLE, N_("Invoice") },
162 : : { ACCT_TYPE_TRADING, N_("Decrease") },
163 : : { ACCT_TYPE_EQUITY, N_("Decrease") },
164 : : };
165 : : static const char* dflt_acct_debit_str = N_("Debit");
166 : :
167 : : /* This map contains a set of strings representing the different column types. */
168 : : static const std::map<GNCAccountType, const char*> gnc_acct_credit_strs = {
169 : : { ACCT_TYPE_NONE, N_("Funds Out") },
170 : : { ACCT_TYPE_BANK, N_("Withdrawal") },
171 : : { ACCT_TYPE_CASH, N_("Spend") },
172 : : { ACCT_TYPE_CREDIT, N_("Charge") },
173 : : { ACCT_TYPE_ASSET, N_("Decrease") },
174 : : { ACCT_TYPE_LIABILITY, N_("Increase") },
175 : : { ACCT_TYPE_STOCK, N_("Sell") },
176 : : { ACCT_TYPE_MUTUAL, N_("Sell") },
177 : : { ACCT_TYPE_CURRENCY, N_("Sell") },
178 : : { ACCT_TYPE_INCOME, N_("Income") },
179 : : { ACCT_TYPE_EXPENSE, N_("Rebate") },
180 : : { ACCT_TYPE_PAYABLE, N_("Bill") },
181 : : { ACCT_TYPE_RECEIVABLE, N_("Payment") },
182 : : { ACCT_TYPE_TRADING, N_("Increase") },
183 : : { ACCT_TYPE_EQUITY, N_("Increase") },
184 : : };
185 : : static const char* dflt_acct_credit_str = N_("Credit");
186 : :
187 : : /********************************************************************\
188 : : * Because I can't use C++ for this project, doesn't mean that I *
189 : : * can't pretend to! These functions perform actions on the *
190 : : * account data structure, in order to encapsulate the knowledge *
191 : : * of the internals of the Account in one file. *
192 : : \********************************************************************/
193 : :
194 : : static void xaccAccountBringUpToDate (Account *acc);
195 : :
196 : :
197 : : /********************************************************************\
198 : : * gnc_get_account_separator *
199 : : * returns the current account separator character *
200 : : * *
201 : : * Args: none *
202 : : * Returns: account separator character *
203 : : \*******************************************************************/
204 : : const gchar *
205 : 23 : gnc_get_account_separator_string (void)
206 : : {
207 : 23 : return account_separator;
208 : : }
209 : :
210 : : gunichar
211 : 3 : gnc_get_account_separator (void)
212 : : {
213 : 3 : return account_uc_separator;
214 : : }
215 : :
216 : : void
217 : 36 : gnc_set_account_separator (const gchar *separator)
218 : : {
219 : : gunichar uc;
220 : : gint count;
221 : :
222 : 36 : uc = g_utf8_get_char_validated(separator, -1);
223 : 36 : if ((uc == (gunichar) - 2) || (uc == (gunichar) - 1) || g_unichar_isalnum(uc))
224 : : {
225 : 1 : account_uc_separator = ':';
226 : 1 : strcpy(account_separator, ":");
227 : 1 : return;
228 : : }
229 : :
230 : 35 : account_uc_separator = uc;
231 : 35 : count = g_unichar_to_utf8(uc, account_separator);
232 : 35 : account_separator[count] = '\0';
233 : : }
234 : :
235 : 3 : gchar *gnc_account_name_violations_errmsg (const gchar *separator, GList* invalid_account_names)
236 : : {
237 : 3 : gchar *message = nullptr;
238 : :
239 : 3 : if ( !invalid_account_names )
240 : 2 : return nullptr;
241 : :
242 : 1 : auto account_list {gnc_g_list_stringjoin (invalid_account_names, "\n")};
243 : :
244 : : /* Translators: The first %s will be the account separator character,
245 : : the second %s is a list of account names.
246 : : The resulting string will be displayed to the user if there are
247 : : account names containing the separator character. */
248 : 1 : message = g_strdup_printf(
249 : 1 : _("The separator character \"%s\" is used in one or more account names.\n\n"
250 : : "This will result in unexpected behaviour. "
251 : : "Either change the account names or choose another separator character.\n\n"
252 : : "Below you will find the list of invalid account names:\n"
253 : : "%s"), separator, account_list );
254 : 1 : g_free ( account_list );
255 : 1 : return message;
256 : : }
257 : :
258 : : struct ViolationData
259 : : {
260 : : GList *list;
261 : : const gchar *separator;
262 : : };
263 : :
264 : : static void
265 : 3 : check_acct_name (Account *acct, gpointer user_data)
266 : : {
267 : 3 : auto cb {static_cast<ViolationData*>(user_data)};
268 : 3 : auto name {xaccAccountGetName (acct)};
269 : 3 : if (g_strstr_len (name, -1, cb->separator))
270 : 2 : cb->list = g_list_prepend (cb->list, g_strdup (name));
271 : 3 : }
272 : :
273 : 4 : GList *gnc_account_list_name_violations (QofBook *book, const gchar *separator)
274 : : {
275 : 4 : g_return_val_if_fail (separator != nullptr, nullptr);
276 : 2 : if (!book) return nullptr;
277 : 1 : ViolationData cb = { nullptr, separator };
278 : 1 : gnc_account_foreach_descendant (gnc_book_get_root_account (book),
279 : : (AccountCb)check_acct_name, &cb);
280 : 1 : return cb.list;
281 : : }
282 : :
283 : : /********************************************************************\
284 : : \********************************************************************/
285 : :
286 : : static inline void mark_account (Account *acc);
287 : : void
288 : 16323 : mark_account (Account *acc)
289 : : {
290 : 16323 : qof_instance_set_dirty(&acc->inst);
291 : 16323 : }
292 : :
293 : : /********************************************************************\
294 : : \********************************************************************/
295 : :
296 : : /* GObject Initialization */
297 : 1199427 : G_DEFINE_TYPE_WITH_PRIVATE(Account, gnc_account, QOF_TYPE_INSTANCE)
298 : :
299 : : static void
300 : 4895 : gnc_account_init(Account* acc)
301 : : {
302 : : AccountPrivate *priv;
303 : :
304 : 4895 : priv = GET_PRIVATE(acc);
305 : 4895 : priv->parent = nullptr;
306 : :
307 : 4895 : priv->accountName = qof_string_cache_insert("");
308 : 4895 : priv->accountCode = qof_string_cache_insert("");
309 : 4895 : priv->description = qof_string_cache_insert("");
310 : :
311 : 4895 : priv->type = ACCT_TYPE_NONE;
312 : :
313 : 4895 : priv->mark = 0;
314 : :
315 : 4895 : priv->policy = xaccGetFIFOPolicy();
316 : 4895 : priv->lots = nullptr;
317 : :
318 : 4895 : priv->commodity = nullptr;
319 : 4895 : priv->commodity_scu = 0;
320 : 4895 : priv->non_standard_scu = FALSE;
321 : :
322 : 4895 : priv->balance = gnc_numeric_zero();
323 : 4895 : priv->noclosing_balance = gnc_numeric_zero();
324 : 4895 : priv->cleared_balance = gnc_numeric_zero();
325 : 4895 : priv->reconciled_balance = gnc_numeric_zero();
326 : 4895 : priv->starting_balance = gnc_numeric_zero();
327 : 4895 : priv->starting_noclosing_balance = gnc_numeric_zero();
328 : 4895 : priv->starting_cleared_balance = gnc_numeric_zero();
329 : 4895 : priv->starting_reconciled_balance = gnc_numeric_zero();
330 : 4895 : priv->balance_dirty = FALSE;
331 : :
332 : 4895 : new (&priv->children) AccountVec ();
333 : 4895 : new (&priv->splits) SplitsVec ();
334 : 4895 : priv->splits_hash = g_hash_table_new (g_direct_hash, g_direct_equal);
335 : 4895 : priv->sort_dirty = FALSE;
336 : 4895 : }
337 : :
338 : : static void
339 : 2257 : gnc_account_dispose (GObject *acctp)
340 : : {
341 : 2257 : G_OBJECT_CLASS(gnc_account_parent_class)->dispose(acctp);
342 : 2257 : }
343 : :
344 : : static void
345 : 2257 : gnc_account_finalize(GObject* acctp)
346 : : {
347 : 2257 : G_OBJECT_CLASS(gnc_account_parent_class)->finalize(acctp);
348 : 2257 : }
349 : :
350 : : /* Note that g_value_set_object() refs the object, as does
351 : : * g_object_get(). But g_object_get() only unrefs once when it disgorges
352 : : * the object, leaving an unbalanced ref, which leaks. So instead of
353 : : * using g_value_set_object(), use g_value_take_object() which doesn't
354 : : * ref the object when used in get_property().
355 : : */
356 : : static void
357 : 637 : gnc_account_get_property (GObject *object,
358 : : guint prop_id,
359 : : GValue *value,
360 : : GParamSpec *pspec)
361 : : {
362 : : Account *account;
363 : : AccountPrivate *priv;
364 : :
365 : 637 : g_return_if_fail(GNC_IS_ACCOUNT(object));
366 : :
367 : 637 : account = GNC_ACCOUNT(object);
368 : 637 : priv = GET_PRIVATE(account);
369 : 637 : switch (prop_id)
370 : : {
371 : 92 : case PROP_NAME:
372 : 92 : g_value_set_string(value, priv->accountName);
373 : 92 : break;
374 : 1 : case PROP_FULL_NAME:
375 : 1 : g_value_take_string(value, gnc_account_get_full_name(account));
376 : 1 : break;
377 : 79 : case PROP_CODE:
378 : 79 : g_value_set_string(value, priv->accountCode);
379 : 79 : break;
380 : 71 : case PROP_DESCRIPTION:
381 : 71 : g_value_set_string(value, priv->description);
382 : 71 : break;
383 : 1 : case PROP_COLOR:
384 : 1 : g_value_set_string(value, xaccAccountGetColor(account));
385 : 1 : break;
386 : 1 : case PROP_NOTES:
387 : 1 : g_value_set_string(value, xaccAccountGetNotes(account));
388 : 1 : break;
389 : 35 : case PROP_TYPE:
390 : : // NEED TO BE CONVERTED TO A G_TYPE_ENUM
391 : 35 : g_value_set_int(value, priv->type);
392 : 35 : break;
393 : 37 : case PROP_COMMODITY:
394 : 37 : g_value_take_object(value, priv->commodity);
395 : 37 : break;
396 : 37 : case PROP_COMMODITY_SCU:
397 : 37 : g_value_set_int(value, priv->commodity_scu);
398 : 37 : break;
399 : 37 : case PROP_NON_STD_SCU:
400 : 37 : g_value_set_boolean(value, priv->non_standard_scu);
401 : 37 : break;
402 : 9 : case PROP_SORT_DIRTY:
403 : 9 : g_value_set_boolean(value, priv->sort_dirty);
404 : 9 : break;
405 : 9 : case PROP_BALANCE_DIRTY:
406 : 9 : g_value_set_boolean(value, priv->balance_dirty);
407 : 9 : break;
408 : 3 : case PROP_START_BALANCE:
409 : 3 : g_value_set_boxed(value, &priv->starting_balance);
410 : 3 : break;
411 : 0 : case PROP_START_NOCLOSING_BALANCE:
412 : 0 : g_value_set_boxed(value, &priv->starting_noclosing_balance);
413 : 0 : break;
414 : 1 : case PROP_START_CLEARED_BALANCE:
415 : 1 : g_value_set_boxed(value, &priv->starting_cleared_balance);
416 : 1 : break;
417 : 1 : case PROP_START_RECONCILED_BALANCE:
418 : 1 : g_value_set_boxed(value, &priv->starting_reconciled_balance);
419 : 1 : break;
420 : 3 : case PROP_END_BALANCE:
421 : 3 : g_value_set_boxed(value, &priv->balance);
422 : 3 : break;
423 : 0 : case PROP_END_NOCLOSING_BALANCE:
424 : 0 : g_value_set_boxed(value, &priv->noclosing_balance);
425 : 0 : break;
426 : 1 : case PROP_END_CLEARED_BALANCE:
427 : 1 : g_value_set_boxed(value, &priv->cleared_balance);
428 : 1 : break;
429 : 1 : case PROP_END_RECONCILED_BALANCE:
430 : 1 : g_value_set_boxed(value, &priv->reconciled_balance);
431 : 1 : break;
432 : 1 : case PROP_POLICY:
433 : : /* MAKE THIS A BOXED VALUE */
434 : 1 : g_value_set_pointer(value, priv->policy);
435 : 1 : break;
436 : 1 : case PROP_MARK:
437 : 1 : g_value_set_int(value, priv->mark);
438 : 1 : break;
439 : 1 : case PROP_TAX_RELATED:
440 : 1 : g_value_set_boolean(value, xaccAccountGetTaxRelated(account));
441 : 1 : break;
442 : 1 : case PROP_TAX_CODE:
443 : 1 : g_value_set_string(value, xaccAccountGetTaxUSCode(account));
444 : 1 : break;
445 : 1 : case PROP_TAX_SOURCE:
446 : 1 : g_value_set_string(value,
447 : : xaccAccountGetTaxUSPayerNameSource(account));
448 : 1 : break;
449 : 1 : case PROP_TAX_COPY_NUMBER:
450 : 1 : g_value_set_int64(value,
451 : : xaccAccountGetTaxUSCopyNumber(account));
452 : 1 : break;
453 : 37 : case PROP_HIDDEN:
454 : 37 : g_value_set_boolean(value, xaccAccountGetHidden(account));
455 : 37 : break;
456 : 0 : case PROP_AUTO_INTEREST:
457 : 0 : g_value_set_boolean (value, xaccAccountGetAutoInterest (account));
458 : 0 : break;
459 : 1 : case PROP_IS_OPENING_BALANCE:
460 : 1 : g_value_set_boolean(value, xaccAccountGetIsOpeningBalance(account));
461 : 1 : break;
462 : 37 : case PROP_PLACEHOLDER:
463 : 37 : g_value_set_boolean(value, xaccAccountGetPlaceholder(account));
464 : 37 : break;
465 : 0 : case PROP_FILTER:
466 : 0 : g_value_set_string(value, xaccAccountGetFilter(account));
467 : 0 : break;
468 : 0 : case PROP_SORT_ORDER:
469 : 0 : g_value_set_string(value, xaccAccountGetSortOrder(account));
470 : 0 : break;
471 : 0 : case PROP_SORT_REVERSED:
472 : 0 : g_value_set_boolean(value, xaccAccountGetSortReversed(account));
473 : 0 : break;
474 : 54 : case PROP_LOT_NEXT_ID:
475 : : /* Pre-set the value in case the frame is empty */
476 : 54 : g_value_set_int64 (value, 0);
477 : 216 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {KEY_LOT_MGMT, "next-id"});
478 : 54 : break;
479 : 76 : case PROP_ONLINE_ACCOUNT:
480 : 228 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {KEY_ONLINE_ID});
481 : 76 : break;
482 : 0 : case PROP_IMP_APPEND_TEXT:
483 : 0 : g_value_set_boolean(value, xaccAccountGetAppendText(account));
484 : 0 : break;
485 : 1 : case PROP_OFX_INCOME_ACCOUNT:
486 : 3 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {KEY_ASSOC_INCOME_ACCOUNT});
487 : 1 : break;
488 : 1 : case PROP_AB_ACCOUNT_ID:
489 : 4 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_ACCOUNT_ID});
490 : 1 : break;
491 : 1 : case PROP_AB_ACCOUNT_UID:
492 : 4 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_ACCOUNT_UID});
493 : 1 : break;
494 : 1 : case PROP_AB_BANK_CODE:
495 : 4 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_BANK_CODE});
496 : 1 : break;
497 : 3 : case PROP_AB_TRANS_RETRIEVAL:
498 : 12 : qof_instance_get_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_TRANS_RETRIEVAL});
499 : 3 : break;
500 : 0 : default:
501 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
502 : 0 : break;
503 : : }
504 : 245 : }
505 : :
506 : : static void
507 : 69787 : gnc_account_set_property (GObject *object,
508 : : guint prop_id,
509 : : const GValue *value,
510 : : GParamSpec *pspec)
511 : : {
512 : : Account *account;
513 : : gnc_numeric *number;
514 : 69787 : g_return_if_fail(GNC_IS_ACCOUNT(object));
515 : 69787 : account = GNC_ACCOUNT(object);
516 : 69787 : if (prop_id < PROP_RUNTIME_0)
517 : 420 : g_assert (qof_instance_get_editlevel(account));
518 : :
519 : 69787 : switch (prop_id)
520 : : {
521 : 42 : case PROP_NAME:
522 : 42 : xaccAccountSetName(account, g_value_get_string(value));
523 : 42 : break;
524 : 38 : case PROP_CODE:
525 : 38 : xaccAccountSetCode(account, g_value_get_string(value));
526 : 38 : break;
527 : 34 : case PROP_DESCRIPTION:
528 : 34 : xaccAccountSetDescription(account, g_value_get_string(value));
529 : 34 : break;
530 : 0 : case PROP_COLOR:
531 : 0 : xaccAccountSetColor(account, g_value_get_string(value));
532 : 0 : break;
533 : 0 : case PROP_NOTES:
534 : 0 : xaccAccountSetNotes(account, g_value_get_string(value));
535 : 0 : break;
536 : 21 : case PROP_TYPE:
537 : : // NEED TO BE CONVERTED TO A G_TYPE_ENUM
538 : 21 : xaccAccountSetType(account, static_cast<GNCAccountType>(g_value_get_int(value)));
539 : 21 : break;
540 : 25 : case PROP_COMMODITY:
541 : 25 : xaccAccountSetCommodity(account, static_cast<gnc_commodity*>(g_value_get_object(value)));
542 : 25 : break;
543 : 34 : case PROP_COMMODITY_SCU:
544 : 34 : xaccAccountSetCommoditySCU(account, g_value_get_int(value));
545 : 34 : break;
546 : 34 : case PROP_NON_STD_SCU:
547 : 34 : xaccAccountSetNonStdSCU(account, g_value_get_boolean(value));
548 : 34 : break;
549 : 34683 : case PROP_SORT_DIRTY:
550 : 34683 : gnc_account_set_sort_dirty(account);
551 : 34683 : break;
552 : 34683 : case PROP_BALANCE_DIRTY:
553 : 34683 : gnc_account_set_balance_dirty(account);
554 : 34683 : break;
555 : 1 : case PROP_START_BALANCE:
556 : 1 : number = static_cast<gnc_numeric*>(g_value_get_boxed(value));
557 : 1 : gnc_account_set_start_balance(account, *number);
558 : 1 : break;
559 : 0 : case PROP_START_CLEARED_BALANCE:
560 : 0 : number = static_cast<gnc_numeric*>(g_value_get_boxed(value));
561 : 0 : gnc_account_set_start_cleared_balance(account, *number);
562 : 0 : break;
563 : 0 : case PROP_START_RECONCILED_BALANCE:
564 : 0 : number = static_cast<gnc_numeric*>(g_value_get_boxed(value));
565 : 0 : gnc_account_set_start_reconciled_balance(account, *number);
566 : 0 : break;
567 : 0 : case PROP_POLICY:
568 : 0 : gnc_account_set_policy(account, static_cast<GNCPolicy*>(g_value_get_pointer(value)));
569 : 0 : break;
570 : 0 : case PROP_MARK:
571 : 0 : xaccAccountSetMark(account, g_value_get_int(value));
572 : 0 : break;
573 : 0 : case PROP_TAX_RELATED:
574 : 0 : xaccAccountSetTaxRelated(account, g_value_get_boolean(value));
575 : 0 : break;
576 : 0 : case PROP_TAX_CODE:
577 : 0 : xaccAccountSetTaxUSCode(account, g_value_get_string(value));
578 : 0 : break;
579 : 0 : case PROP_TAX_SOURCE:
580 : 0 : xaccAccountSetTaxUSPayerNameSource(account,
581 : : g_value_get_string(value));
582 : 0 : break;
583 : 0 : case PROP_TAX_COPY_NUMBER:
584 : 0 : xaccAccountSetTaxUSCopyNumber(account,
585 : : g_value_get_int64(value));
586 : 0 : break;
587 : 34 : case PROP_HIDDEN:
588 : 34 : xaccAccountSetHidden(account, g_value_get_boolean(value));
589 : 34 : break;
590 : 0 : case PROP_AUTO_INTEREST:
591 : 0 : xaccAccountSetAutoInterest (account, g_value_get_boolean (value));
592 : 0 : break;
593 : 0 : case PROP_IS_OPENING_BALANCE:
594 : 0 : xaccAccountSetIsOpeningBalance (account, g_value_get_boolean (value));
595 : 0 : break;
596 : 34 : case PROP_PLACEHOLDER:
597 : 34 : xaccAccountSetPlaceholder(account, g_value_get_boolean(value));
598 : 34 : break;
599 : 0 : case PROP_FILTER:
600 : 0 : xaccAccountSetFilter(account, g_value_get_string(value));
601 : 0 : break;
602 : 0 : case PROP_SORT_ORDER:
603 : 0 : xaccAccountSetSortOrder(account, g_value_get_string(value));
604 : 0 : break;
605 : 0 : case PROP_SORT_REVERSED:
606 : 0 : xaccAccountSetSortReversed(account, g_value_get_boolean(value));
607 : 0 : break;
608 : 54 : case PROP_LOT_NEXT_ID:
609 : 216 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {KEY_LOT_MGMT, "next-id"});
610 : 54 : break;
611 : 64 : case PROP_ONLINE_ACCOUNT:
612 : 192 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {KEY_ONLINE_ID});
613 : 64 : break;
614 : 0 : case PROP_IMP_APPEND_TEXT:
615 : 0 : xaccAccountSetAppendText(account, g_value_get_boolean(value));
616 : 0 : break;
617 : 1 : case PROP_OFX_INCOME_ACCOUNT:
618 : 3 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {KEY_ASSOC_INCOME_ACCOUNT});
619 : 1 : break;
620 : 1 : case PROP_AB_ACCOUNT_ID:
621 : 4 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_ACCOUNT_ID});
622 : 1 : break;
623 : 1 : case PROP_AB_ACCOUNT_UID:
624 : 4 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_ACCOUNT_UID});
625 : 1 : break;
626 : 1 : case PROP_AB_BANK_CODE:
627 : 4 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_BANK_CODE});
628 : 1 : break;
629 : 2 : case PROP_AB_TRANS_RETRIEVAL:
630 : 8 : qof_instance_set_path_kvp (QOF_INSTANCE (account), value, {AB_KEY, AB_TRANS_RETRIEVAL});
631 : 2 : break;
632 : 0 : default:
633 : 0 : G_OBJECT_WARN_INVALID_PROPERTY_ID(object, prop_id, pspec);
634 : 0 : break;
635 : : }
636 : 232 : }
637 : :
638 : : static void
639 : 66 : gnc_account_class_init (AccountClass *klass)
640 : : {
641 : 66 : GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
642 : :
643 : 66 : gobject_class->dispose = gnc_account_dispose;
644 : 66 : gobject_class->finalize = gnc_account_finalize;
645 : 66 : gobject_class->set_property = gnc_account_set_property;
646 : 66 : gobject_class->get_property = gnc_account_get_property;
647 : :
648 : : g_object_class_install_property
649 : 66 : (gobject_class,
650 : : PROP_NAME,
651 : : g_param_spec_string ("name",
652 : : "Account Name",
653 : : "The accountName is an arbitrary string "
654 : : "assigned by the user. It is intended to "
655 : : "a short, 5 to 30 character long string "
656 : : "that is displayed by the GUI as the "
657 : : "account mnemonic. Account names may be "
658 : : "repeated. but no two accounts that share "
659 : : "a parent may have the same name.",
660 : : nullptr,
661 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
662 : :
663 : : g_object_class_install_property
664 : 66 : (gobject_class,
665 : : PROP_FULL_NAME,
666 : : g_param_spec_string ("fullname",
667 : : "Full Account Name",
668 : : "The name of the account concatenated with "
669 : : "all its parent account names to indicate "
670 : : "a unique account.",
671 : : nullptr,
672 : : static_cast<GParamFlags>(G_PARAM_READABLE)));
673 : :
674 : : g_object_class_install_property
675 : 66 : (gobject_class,
676 : : PROP_CODE,
677 : : g_param_spec_string ("code",
678 : : "Account Code",
679 : : "The account code is an arbitrary string "
680 : : "assigned by the user. It is intended to "
681 : : "be reporting code that is a synonym for "
682 : : "the accountName.",
683 : : nullptr,
684 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
685 : :
686 : : g_object_class_install_property
687 : 66 : (gobject_class,
688 : : PROP_DESCRIPTION,
689 : : g_param_spec_string ("description",
690 : : "Account Description",
691 : : "The account description is an arbitrary "
692 : : "string assigned by the user. It is intended "
693 : : "to be a longer, 1-5 sentence description of "
694 : : "what this account is all about.",
695 : : nullptr,
696 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
697 : :
698 : : g_object_class_install_property
699 : 66 : (gobject_class,
700 : : PROP_COLOR,
701 : : g_param_spec_string ("color",
702 : : "Account Color",
703 : : "The account color is a color string assigned "
704 : : "by the user. It is intended to highlight the "
705 : : "account based on the users wishes.",
706 : : nullptr,
707 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
708 : :
709 : : g_object_class_install_property
710 : 66 : (gobject_class,
711 : : PROP_NOTES,
712 : : g_param_spec_string ("notes",
713 : : "Account Notes",
714 : : "The account notes is an arbitrary provided "
715 : : "for the user to attach any other text that "
716 : : "they would like to associate with the account.",
717 : : nullptr,
718 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
719 : :
720 : : g_object_class_install_property
721 : 66 : (gobject_class,
722 : : PROP_TYPE,
723 : : g_param_spec_int ("type",
724 : : "Account Type",
725 : : "The account type, picked from the enumerated list "
726 : : "that includes ACCT_TYPE_BANK, ACCT_TYPE_STOCK, "
727 : : "ACCT_TYPE_CREDIT, ACCT_TYPE_INCOME, etc.",
728 : : ACCT_TYPE_NONE,
729 : : NUM_ACCOUNT_TYPES - 1,
730 : : ACCT_TYPE_BANK,
731 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
732 : :
733 : : g_object_class_install_property
734 : 66 : (gobject_class,
735 : : PROP_COMMODITY,
736 : : g_param_spec_object ("commodity",
737 : : "Commodity",
738 : : "The commodity field denotes the kind of "
739 : : "'stuff' stored in this account, whether "
740 : : "it is USD, gold, stock, etc.",
741 : : GNC_TYPE_COMMODITY,
742 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
743 : :
744 : : g_object_class_install_property
745 : 66 : (gobject_class,
746 : : PROP_COMMODITY_SCU,
747 : : g_param_spec_int ("commodity-scu",
748 : : "Commodity SCU",
749 : : "The smallest fraction of the commodity that is "
750 : : "tracked. This number is used as the denominator "
751 : : "value in 1/x, so a value of 100 says that the "
752 : : "commodity can be divided into hundredths. E.G."
753 : : "1 USD can be divided into 100 cents.",
754 : : 0,
755 : : G_MAXINT32,
756 : : GNC_COMMODITY_MAX_FRACTION,
757 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
758 : :
759 : : g_object_class_install_property
760 : 66 : (gobject_class,
761 : : PROP_NON_STD_SCU,
762 : : g_param_spec_boolean ("non-std-scu",
763 : : "Non-std SCU",
764 : : "TRUE if the account SCU doesn't match "
765 : : "the commodity SCU. This indicates a case "
766 : : "where the two were accidentally set to "
767 : : "mismatched values in older versions of "
768 : : "GnuCash.",
769 : : FALSE,
770 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
771 : :
772 : : g_object_class_install_property
773 : 66 : (gobject_class,
774 : : PROP_SORT_DIRTY,
775 : : g_param_spec_boolean("sort-dirty",
776 : : "Sort Dirty",
777 : : "TRUE if the splits in the account needs to be "
778 : : "resorted. This flag is set by the accounts "
779 : : "code for certain internal modifications, or "
780 : : "when external code calls the engine to say a "
781 : : "split has been modified in a way that may "
782 : : "affect the sort order of the account. Note: "
783 : : "This value can only be set to TRUE.",
784 : : FALSE,
785 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
786 : :
787 : : g_object_class_install_property
788 : 66 : (gobject_class,
789 : : PROP_BALANCE_DIRTY,
790 : : g_param_spec_boolean("balance-dirty",
791 : : "Balance Dirty",
792 : : "TRUE if the running balances in the account "
793 : : "needs to be recalculated. This flag is set "
794 : : "by the accounts code for certain internal "
795 : : "modifications, or when external code calls "
796 : : "the engine to say a split has been modified. "
797 : : "Note: This value can only be set to TRUE.",
798 : : FALSE,
799 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
800 : :
801 : : g_object_class_install_property
802 : 66 : (gobject_class,
803 : : PROP_START_BALANCE,
804 : : g_param_spec_boxed("start-balance",
805 : : "Starting Balance",
806 : : "The starting balance for the account. This "
807 : : "parameter is intended for use with backends that "
808 : : "do not return the complete list of splits for an "
809 : : "account, but rather return a partial list. In "
810 : : "such a case, the backend will typically return "
811 : : "all of the splits after some certain date, and "
812 : : "the 'starting balance' will represent the "
813 : : "summation of the splits up to that date.",
814 : : GNC_TYPE_NUMERIC,
815 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
816 : :
817 : : g_object_class_install_property
818 : 66 : (gobject_class,
819 : : PROP_START_NOCLOSING_BALANCE,
820 : : g_param_spec_boxed("start-noclosing-balance",
821 : : "Starting No-closing Balance",
822 : : "The starting balance for the account, ignoring closing."
823 : : "This parameter is intended for use with backends "
824 : : "that do not return the complete list of splits "
825 : : "for an account, but rather return a partial "
826 : : "list. In such a case, the backend will "
827 : : "typically return all of the splits after "
828 : : "some certain date, and the 'starting noclosing "
829 : : "balance' will represent the summation of the "
830 : : "splits up to that date, ignoring closing splits.",
831 : : GNC_TYPE_NUMERIC,
832 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
833 : :
834 : : g_object_class_install_property
835 : 66 : (gobject_class,
836 : : PROP_START_CLEARED_BALANCE,
837 : : g_param_spec_boxed("start-cleared-balance",
838 : : "Starting Cleared Balance",
839 : : "The starting cleared balance for the account. "
840 : : "This parameter is intended for use with backends "
841 : : "that do not return the complete list of splits "
842 : : "for an account, but rather return a partial "
843 : : "list. In such a case, the backend will "
844 : : "typically return all of the splits after "
845 : : "some certain date, and the 'starting cleared "
846 : : "balance' will represent the summation of the "
847 : : "splits up to that date.",
848 : : GNC_TYPE_NUMERIC,
849 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
850 : :
851 : : g_object_class_install_property
852 : 66 : (gobject_class,
853 : : PROP_START_RECONCILED_BALANCE,
854 : : g_param_spec_boxed("start-reconciled-balance",
855 : : "Starting Reconciled Balance",
856 : : "The starting reconciled balance for the "
857 : : "account. This parameter is intended for use "
858 : : "with backends that do not return the complete "
859 : : "list of splits for an account, but rather return "
860 : : "a partial list. In such a case, the backend "
861 : : "will typically return all of the splits after "
862 : : "some certain date, and the 'starting reconciled "
863 : : "balance' will represent the summation of the "
864 : : "splits up to that date.",
865 : : GNC_TYPE_NUMERIC,
866 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
867 : :
868 : : g_object_class_install_property
869 : 66 : (gobject_class,
870 : : PROP_END_BALANCE,
871 : : g_param_spec_boxed("end-balance",
872 : : "Ending Account Balance",
873 : : "This is the current ending balance for the "
874 : : "account. It is computed from the sum of the "
875 : : "starting balance and all splits in the account.",
876 : : GNC_TYPE_NUMERIC,
877 : : G_PARAM_READABLE));
878 : :
879 : : g_object_class_install_property
880 : 66 : (gobject_class,
881 : : PROP_END_NOCLOSING_BALANCE,
882 : : g_param_spec_boxed("end-noclosing-balance",
883 : : "Ending Account Noclosing Balance",
884 : : "This is the current ending no-closing balance for "
885 : : "the account. It is computed from the sum of the "
886 : : "starting balance and all cleared splits in the "
887 : : "account.",
888 : : GNC_TYPE_NUMERIC,
889 : : G_PARAM_READABLE));
890 : :
891 : : g_object_class_install_property
892 : 66 : (gobject_class,
893 : : PROP_END_CLEARED_BALANCE,
894 : : g_param_spec_boxed("end-cleared-balance",
895 : : "Ending Account Cleared Balance",
896 : : "This is the current ending cleared balance for "
897 : : "the account. It is computed from the sum of the "
898 : : "starting balance and all cleared splits in the "
899 : : "account.",
900 : : GNC_TYPE_NUMERIC,
901 : : G_PARAM_READABLE));
902 : :
903 : : g_object_class_install_property
904 : 66 : (gobject_class,
905 : : PROP_END_RECONCILED_BALANCE,
906 : : g_param_spec_boxed("end-reconciled-balance",
907 : : "Ending Account Reconciled Balance",
908 : : "This is the current ending reconciled balance "
909 : : "for the account. It is computed from the sum of "
910 : : "the starting balance and all reconciled splits "
911 : : "in the account.",
912 : : GNC_TYPE_NUMERIC,
913 : : static_cast<GParamFlags>(G_PARAM_READABLE)));
914 : :
915 : : g_object_class_install_property
916 : 66 : (gobject_class,
917 : : PROP_POLICY,
918 : : g_param_spec_pointer ("policy",
919 : : "Policy",
920 : : "The account lots policy.",
921 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
922 : :
923 : : g_object_class_install_property
924 : 66 : (gobject_class,
925 : : PROP_MARK,
926 : : g_param_spec_int ("acct-mark",
927 : : "Account Mark",
928 : : "Ipsum Lorem",
929 : : 0,
930 : : G_MAXINT16,
931 : : 0,
932 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
933 : :
934 : : g_object_class_install_property
935 : 66 : (gobject_class,
936 : : PROP_TAX_RELATED,
937 : : g_param_spec_boolean ("tax-related",
938 : : "Tax Related",
939 : : "Whether the account maps to an entry on an "
940 : : "income tax document.",
941 : : FALSE,
942 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
943 : :
944 : : g_object_class_install_property
945 : 66 : (gobject_class,
946 : : PROP_IS_OPENING_BALANCE,
947 : : g_param_spec_boolean ("opening-balance",
948 : : "Opening Balance",
949 : : "Whether the account holds opening balances",
950 : : FALSE,
951 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
952 : :
953 : : g_object_class_install_property
954 : 66 : (gobject_class,
955 : : PROP_TAX_CODE,
956 : : g_param_spec_string ("tax-code",
957 : : "Tax Code",
958 : : "This is the code for mapping an account to a "
959 : : "specific entry on a taxable document. In the "
960 : : "United States it is used to transfer totals "
961 : : "into tax preparation software.",
962 : : nullptr,
963 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
964 : :
965 : : g_object_class_install_property
966 : 66 : (gobject_class,
967 : : PROP_TAX_SOURCE,
968 : : g_param_spec_string ("tax-source",
969 : : "Tax Source",
970 : : "This specifies where exported name comes from.",
971 : : nullptr,
972 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
973 : :
974 : : g_object_class_install_property
975 : 66 : (gobject_class,
976 : : PROP_TAX_COPY_NUMBER,
977 : : g_param_spec_int64 ("tax-copy-number",
978 : : "Tax Copy Number",
979 : : "This specifies the copy number of the tax "
980 : : "form/schedule.",
981 : : (gint64)1,
982 : : G_MAXINT64,
983 : : (gint64)1,
984 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
985 : :
986 : : g_object_class_install_property
987 : 66 : (gobject_class,
988 : : PROP_HIDDEN,
989 : : g_param_spec_boolean ("hidden",
990 : : "Hidden",
991 : : "Whether the account should be hidden in the "
992 : : "account tree.",
993 : : FALSE,
994 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
995 : :
996 : : g_object_class_install_property
997 : 66 : (gobject_class,
998 : : PROP_AUTO_INTEREST,
999 : : g_param_spec_boolean ("auto-interest-transfer",
1000 : : "Auto Interest",
1001 : : "Whether an interest transfer should be automatically "
1002 : : "added before reconcile.",
1003 : : FALSE,
1004 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1005 : :
1006 : : g_object_class_install_property
1007 : 66 : (gobject_class,
1008 : : PROP_PLACEHOLDER,
1009 : : g_param_spec_boolean ("placeholder",
1010 : : "Placeholder",
1011 : : "Whether the account is a placeholder account which does not "
1012 : : "allow transactions to be created, edited or deleted.",
1013 : : FALSE,
1014 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1015 : :
1016 : : g_object_class_install_property
1017 : 66 : (gobject_class,
1018 : : PROP_FILTER,
1019 : : g_param_spec_string ("filter",
1020 : : "Account Filter",
1021 : : "The account filter is a value saved to allow "
1022 : : "filters to be recalled.",
1023 : : nullptr,
1024 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1025 : :
1026 : : g_object_class_install_property
1027 : 66 : (gobject_class,
1028 : : PROP_SORT_ORDER,
1029 : : g_param_spec_string ("sort-order",
1030 : : "Account Sort Order",
1031 : : "The account sort order is a value saved to allow "
1032 : : "the sort order to be recalled.",
1033 : : nullptr,
1034 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1035 : :
1036 : : g_object_class_install_property
1037 : 66 : (gobject_class,
1038 : : PROP_SORT_REVERSED,
1039 : : g_param_spec_boolean ("sort-reversed",
1040 : : "Account Sort Reversed",
1041 : : "Parameter to store whether the sort order is reversed or not.",
1042 : : FALSE,
1043 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1044 : :
1045 : : g_object_class_install_property
1046 : 66 : (gobject_class,
1047 : : PROP_LOT_NEXT_ID,
1048 : : g_param_spec_int64 ("lot-next-id",
1049 : : "Lot Next ID",
1050 : : "Tracks the next id to use in gnc_lot_make_default.",
1051 : : (gint64)1,
1052 : : G_MAXINT64,
1053 : : (gint64)1,
1054 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1055 : :
1056 : : g_object_class_install_property
1057 : 66 : (gobject_class,
1058 : : PROP_ONLINE_ACCOUNT,
1059 : : g_param_spec_string ("online-id",
1060 : : "Online Account ID",
1061 : : "The online account which corresponds to this "
1062 : : "account for OFX import",
1063 : : nullptr,
1064 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1065 : :
1066 : : g_object_class_install_property
1067 : 66 : (gobject_class,
1068 : : PROP_IMP_APPEND_TEXT,
1069 : : g_param_spec_boolean ("import-append-text",
1070 : : "Import Append Text",
1071 : : "Saved state of Append checkbox for setting initial "
1072 : : "value next time this account is imported.",
1073 : : FALSE,
1074 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1075 : :
1076 : 66 : g_object_class_install_property(
1077 : : gobject_class,
1078 : : PROP_OFX_INCOME_ACCOUNT,
1079 : : g_param_spec_boxed("ofx-income-account",
1080 : : "Associated income account",
1081 : : "Used by the OFX importer.",
1082 : : GNC_TYPE_GUID,
1083 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1084 : :
1085 : : g_object_class_install_property
1086 : 66 : (gobject_class,
1087 : : PROP_AB_ACCOUNT_ID,
1088 : : g_param_spec_string ("ab-account-id",
1089 : : "AQBanking Account ID",
1090 : : "The AqBanking account which corresponds to this "
1091 : : "account for AQBanking import",
1092 : : nullptr,
1093 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1094 : : g_object_class_install_property
1095 : 66 : (gobject_class,
1096 : : PROP_AB_BANK_CODE,
1097 : : g_param_spec_string ("ab-bank-code",
1098 : : "AQBanking Bank Code",
1099 : : "The online account which corresponds to this "
1100 : : "account for AQBanking import",
1101 : : nullptr,
1102 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1103 : :
1104 : : g_object_class_install_property
1105 : 66 : (gobject_class,
1106 : : PROP_AB_ACCOUNT_UID,
1107 : : g_param_spec_int64 ("ab-account-uid",
1108 : : "AQBanking Account UID",
1109 : : "Tracks the next id to use in gnc_lot_make_default.",
1110 : : (gint64)1,
1111 : : G_MAXINT64,
1112 : : (gint64)1,
1113 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1114 : :
1115 : : g_object_class_install_property
1116 : 66 : (gobject_class,
1117 : : PROP_AB_TRANS_RETRIEVAL,
1118 : : g_param_spec_boxed("ab-trans-retrieval",
1119 : : "AQBanking Last Transaction Retrieval",
1120 : : "The time of the last transaction retrieval for this "
1121 : : "account.",
1122 : : GNC_TYPE_TIME64,
1123 : : static_cast<GParamFlags>(G_PARAM_READWRITE)));
1124 : :
1125 : 66 : }
1126 : :
1127 : : static void
1128 : 4893 : xaccInitAccount (Account * acc, QofBook *book)
1129 : : {
1130 : 4893 : ENTER ("book=%p\n", book);
1131 : 4893 : qof_instance_init_data (&acc->inst, GNC_ID_ACCOUNT, book);
1132 : :
1133 : 4893 : LEAVE ("account=%p\n", acc);
1134 : 4893 : }
1135 : :
1136 : : /********************************************************************\
1137 : : \********************************************************************/
1138 : :
1139 : : void
1140 : 1395 : gnc_account_foreach_split (const Account *acc, std::function<void(Split*)> func)
1141 : : {
1142 : 1395 : if (!GNC_IS_ACCOUNT (acc))
1143 : 0 : return;
1144 : :
1145 : 1395 : auto& splits{GET_PRIVATE(acc)->splits};
1146 : 1395 : std::for_each (splits.begin(), splits.end(), func);
1147 : : }
1148 : :
1149 : : void
1150 : 6588 : gnc_account_foreach_split_until_date (const Account *acc, time64 end_date,
1151 : : std::function<void(Split*)> f)
1152 : : {
1153 : 6588 : if (!GNC_IS_ACCOUNT (acc))
1154 : 0 : return;
1155 : :
1156 : 7801 : auto after_date = [](time64 end_date, auto s) -> bool
1157 : 7801 : { return (xaccTransGetDate (xaccSplitGetParent (s)) > end_date); };
1158 : :
1159 : 6588 : auto& splits{GET_PRIVATE(acc)->splits};
1160 : 6588 : auto after_date_iter = std::upper_bound (splits.begin(), splits.end(), end_date, after_date);
1161 : 6588 : std::for_each (splits.begin(), after_date_iter, f);
1162 : : }
1163 : :
1164 : :
1165 : : Split*
1166 : 2981 : gnc_account_find_split (const Account *acc, std::function<bool(const Split*)> predicate,
1167 : : bool reverse)
1168 : : {
1169 : 2981 : if (!GNC_IS_ACCOUNT (acc))
1170 : 0 : return nullptr;
1171 : :
1172 : 2981 : const auto& splits{GET_PRIVATE(acc)->splits};
1173 : 2981 : if (reverse)
1174 : : {
1175 : 2933 : auto latest = std::find_if(splits.rbegin(), splits.rend(), predicate);
1176 : 2933 : return (latest == splits.rend()) ? nullptr : *latest;
1177 : : }
1178 : : else
1179 : : {
1180 : 48 : auto earliest = std::find_if(splits.begin(), splits.end(), predicate);
1181 : 48 : return (earliest == splits.end()) ? nullptr : *earliest;
1182 : : }
1183 : : }
1184 : :
1185 : : /********************************************************************\
1186 : : \********************************************************************/
1187 : :
1188 : : QofBook *
1189 : 1067 : gnc_account_get_book(const Account *account)
1190 : : {
1191 : 1067 : if (!account) return nullptr;
1192 : 1067 : return qof_instance_get_book(QOF_INSTANCE(account));
1193 : : }
1194 : :
1195 : : /********************************************************************\
1196 : : \********************************************************************/
1197 : :
1198 : : static Account *
1199 : 2728 : gnc_coll_get_root_account (QofCollection *col)
1200 : : {
1201 : 2728 : if (!col) return nullptr;
1202 : 2728 : return static_cast<Account*>(qof_collection_get_data (col));
1203 : : }
1204 : :
1205 : : static void
1206 : 313 : gnc_coll_set_root_account (QofCollection *col, Account *root)
1207 : : {
1208 : : AccountPrivate *rpriv;
1209 : : Account *old_root;
1210 : 313 : if (!col) return;
1211 : :
1212 : 313 : old_root = gnc_coll_get_root_account (col);
1213 : 313 : if (old_root == root) return;
1214 : :
1215 : : /* If the new root is already linked into the tree somewhere, then
1216 : : * remove it from its current position before adding it at the
1217 : : * top. */
1218 : 312 : rpriv = GET_PRIVATE(root);
1219 : 312 : if (rpriv->parent)
1220 : : {
1221 : 20 : xaccAccountBeginEdit(root);
1222 : 20 : gnc_account_remove_child(rpriv->parent, root);
1223 : 20 : xaccAccountCommitEdit(root);
1224 : : }
1225 : :
1226 : 312 : qof_collection_set_data (col, root);
1227 : :
1228 : 312 : if (old_root)
1229 : : {
1230 : 21 : xaccAccountBeginEdit (old_root);
1231 : 21 : xaccAccountDestroy (old_root);
1232 : : }
1233 : : }
1234 : :
1235 : : Account *
1236 : 2415 : gnc_book_get_root_account (QofBook *book)
1237 : : {
1238 : : QofCollection *col;
1239 : : Account *root;
1240 : :
1241 : 2415 : if (!book) return nullptr;
1242 : 2414 : col = qof_book_get_collection (book, GNC_ID_ROOT_ACCOUNT);
1243 : 2414 : root = gnc_coll_get_root_account (col);
1244 : 2414 : if (root == nullptr && !qof_book_shutting_down(book))
1245 : 188 : root = gnc_account_create_root(book);
1246 : 2414 : return root;
1247 : : }
1248 : :
1249 : : void
1250 : 314 : gnc_book_set_root_account (QofBook *book, Account *root)
1251 : : {
1252 : : QofCollection *col;
1253 : 314 : if (!book) return;
1254 : :
1255 : 314 : if (root && gnc_account_get_book(root) != book)
1256 : : {
1257 : 1 : PERR ("cannot mix and match books freely!");
1258 : 1 : return;
1259 : : }
1260 : :
1261 : 313 : col = qof_book_get_collection (book, GNC_ID_ROOT_ACCOUNT);
1262 : 313 : gnc_coll_set_root_account (col, root);
1263 : : }
1264 : :
1265 : : /********************************************************************\
1266 : : \********************************************************************/
1267 : :
1268 : : Account *
1269 : 4892 : xaccMallocAccount (QofBook *book)
1270 : : {
1271 : : Account *acc;
1272 : :
1273 : 4892 : g_return_val_if_fail (book, nullptr);
1274 : :
1275 : 4892 : acc = static_cast<Account*>(g_object_new (GNC_TYPE_ACCOUNT, nullptr));
1276 : 4892 : xaccInitAccount (acc, book);
1277 : 4892 : qof_event_gen (&acc->inst, QOF_EVENT_CREATE, nullptr);
1278 : :
1279 : 4892 : return acc;
1280 : : }
1281 : :
1282 : : Account *
1283 : 270 : gnc_account_create_root (QofBook *book)
1284 : : {
1285 : : Account *root;
1286 : : AccountPrivate *rpriv;
1287 : :
1288 : 270 : root = xaccMallocAccount(book);
1289 : 270 : rpriv = GET_PRIVATE(root);
1290 : 270 : xaccAccountBeginEdit(root);
1291 : 270 : rpriv->type = ACCT_TYPE_ROOT;
1292 : 270 : rpriv->accountName = qof_string_cache_replace(rpriv->accountName, "Root Account");
1293 : 270 : mark_account (root);
1294 : 270 : xaccAccountCommitEdit(root);
1295 : 270 : gnc_book_set_root_account(book, root);
1296 : 270 : return root;
1297 : : }
1298 : :
1299 : : Account *
1300 : 3 : xaccCloneAccount(const Account *from, QofBook *book)
1301 : : {
1302 : : Account *ret;
1303 : : AccountPrivate *from_priv, *priv;
1304 : :
1305 : 3 : g_return_val_if_fail(GNC_IS_ACCOUNT(from), nullptr);
1306 : 2 : g_return_val_if_fail(QOF_IS_BOOK(book), nullptr);
1307 : :
1308 : 1 : ENTER (" ");
1309 : 1 : ret = static_cast<Account*>(g_object_new (GNC_TYPE_ACCOUNT, nullptr));
1310 : 1 : g_return_val_if_fail (ret, nullptr);
1311 : :
1312 : 1 : from_priv = GET_PRIVATE(from);
1313 : 1 : priv = GET_PRIVATE(ret);
1314 : 1 : xaccInitAccount (ret, book);
1315 : :
1316 : : /* Do not Begin/CommitEdit() here; give the caller
1317 : : * a chance to fix things up, and let them do it.
1318 : : * Also let caller issue the generate_event (EVENT_CREATE) */
1319 : 1 : priv->type = from_priv->type;
1320 : :
1321 : 1 : priv->accountName = qof_string_cache_replace(priv->accountName, from_priv->accountName);
1322 : 1 : priv->accountCode = qof_string_cache_replace(priv->accountCode, from_priv->accountCode);
1323 : 1 : priv->description = qof_string_cache_replace(priv->description, from_priv->description);
1324 : :
1325 : 1 : qof_instance_copy_kvp (QOF_INSTANCE (ret), QOF_INSTANCE (from));
1326 : :
1327 : : /* The new book should contain a commodity that matches
1328 : : * the one in the old book. Find it, use it. */
1329 : 1 : priv->commodity = gnc_commodity_obtain_twin(from_priv->commodity, book);
1330 : 1 : gnc_commodity_increment_usage_count(priv->commodity);
1331 : :
1332 : 1 : priv->commodity_scu = from_priv->commodity_scu;
1333 : 1 : priv->non_standard_scu = from_priv->non_standard_scu;
1334 : :
1335 : 1 : qof_instance_set_dirty(&ret->inst);
1336 : 1 : LEAVE (" ");
1337 : 1 : return ret;
1338 : : }
1339 : :
1340 : : /********************************************************************\
1341 : : \********************************************************************/
1342 : :
1343 : : static void
1344 : 358 : xaccFreeOneChildAccount (Account *acc)
1345 : : {
1346 : : /* FIXME: this code is kind of hacky. actually, all this code
1347 : : * seems to assume that the account edit levels are all 1. */
1348 : 358 : if (qof_instance_get_editlevel(acc) == 0)
1349 : 337 : xaccAccountBeginEdit(acc);
1350 : 358 : xaccAccountDestroy(acc);
1351 : 358 : }
1352 : :
1353 : : static void
1354 : 2102 : xaccFreeAccountChildren (Account *acc)
1355 : : {
1356 : 2102 : auto priv{GET_PRIVATE(acc)};
1357 : : /* Copy the list since it will be modified */
1358 : 2102 : auto children = priv->children;
1359 : 2102 : std::for_each (children.begin(), children.end(), xaccFreeOneChildAccount);
1360 : :
1361 : : /* The foreach should have removed all the children already. */
1362 : 2102 : priv->children.clear();
1363 : 2102 : }
1364 : :
1365 : : /* The xaccFreeAccount() routine releases memory associated with the
1366 : : * account. It should never be called directly from user code;
1367 : : * instead, the xaccAccountDestroy() routine should be used (because
1368 : : * xaccAccountDestroy() has the correct commit semantics). */
1369 : : static void
1370 : 2101 : xaccFreeAccount (Account *acc)
1371 : : {
1372 : : AccountPrivate *priv;
1373 : : GList *lp;
1374 : :
1375 : 2101 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
1376 : :
1377 : 2101 : priv = GET_PRIVATE(acc);
1378 : 2101 : qof_event_gen (&acc->inst, QOF_EVENT_DESTROY, nullptr);
1379 : :
1380 : : /* Otherwise the lists below get munged while we're iterating
1381 : : * them, possibly crashing.
1382 : : */
1383 : 2101 : if (!qof_instance_get_destroying (acc))
1384 : 1 : qof_instance_set_destroying(acc, TRUE);
1385 : :
1386 : 2101 : if (!priv->children.empty())
1387 : : {
1388 : 1 : PERR (" instead of calling xaccFreeAccount(), please call\n"
1389 : : " xaccAccountBeginEdit(); xaccAccountDestroy();\n");
1390 : :
1391 : : /* First, recursively free children, also frees list */
1392 : 1 : xaccFreeAccountChildren(acc);
1393 : : }
1394 : :
1395 : : /* remove lots -- although these should be gone by now. */
1396 : 2101 : if (priv->lots)
1397 : : {
1398 : 1 : PERR (" instead of calling xaccFreeAccount(), please call\n"
1399 : : " xaccAccountBeginEdit(); xaccAccountDestroy();\n");
1400 : :
1401 : 4 : for (lp = priv->lots; lp; lp = lp->next)
1402 : : {
1403 : 3 : GNCLot *lot = static_cast<GNCLot*>(lp->data);
1404 : 3 : gnc_lot_destroy (lot);
1405 : : }
1406 : 1 : g_list_free (priv->lots);
1407 : 1 : priv->lots = nullptr;
1408 : : }
1409 : :
1410 : : /* Next, clean up the splits */
1411 : : /* NB there shouldn't be any splits by now ... they should
1412 : : * have been all been freed by CommitEdit(). We can remove this
1413 : : * check once we know the warning isn't occurring any more. */
1414 : 2101 : if (!priv->splits.empty())
1415 : : {
1416 : 2 : PERR (" instead of calling xaccFreeAccount(), please call\n"
1417 : : " xaccAccountBeginEdit(); xaccAccountDestroy();\n");
1418 : :
1419 : 2 : qof_instance_reset_editlevel(acc);
1420 : :
1421 : 8 : for (auto s : priv->splits)
1422 : : {
1423 : 6 : g_assert(xaccSplitGetAccount(s) == acc);
1424 : 6 : xaccSplitDestroy (s);
1425 : : }
1426 : : /* Nothing here (or in xaccAccountCommitEdit) nullptrs priv->splits, so this asserts every time.
1427 : : g_assert(priv->splits == nullptr);
1428 : : */
1429 : : }
1430 : :
1431 : 2101 : qof_string_cache_remove(priv->accountName);
1432 : 2101 : qof_string_cache_remove(priv->accountCode);
1433 : 2101 : qof_string_cache_remove(priv->description);
1434 : 2101 : priv->accountName = priv->accountCode = priv->description = nullptr;
1435 : :
1436 : : /* zero out values, just in case stray
1437 : : * pointers are pointing here. */
1438 : :
1439 : 2101 : priv->last_num = nullptr;
1440 : 2101 : priv->tax_us_code = nullptr;
1441 : 2101 : priv->tax_us_pns = nullptr;
1442 : 2101 : priv->color = nullptr;
1443 : 2101 : priv->sort_order = nullptr;
1444 : 2101 : priv->notes = nullptr;
1445 : 2101 : priv->filter = nullptr;
1446 : :
1447 : 2101 : priv->parent = nullptr;
1448 : :
1449 : 2101 : priv->balance = gnc_numeric_zero();
1450 : 2101 : priv->noclosing_balance = gnc_numeric_zero();
1451 : 2101 : priv->cleared_balance = gnc_numeric_zero();
1452 : 2101 : priv->reconciled_balance = gnc_numeric_zero();
1453 : :
1454 : 2101 : priv->type = ACCT_TYPE_NONE;
1455 : 2101 : gnc_commodity_decrement_usage_count(priv->commodity);
1456 : 2101 : priv->commodity = nullptr;
1457 : :
1458 : 2101 : priv->balance_dirty = FALSE;
1459 : 2101 : priv->sort_dirty = FALSE;
1460 : 2101 : priv->splits.~SplitsVec();
1461 : 2101 : priv->children.~AccountVec();
1462 : 2101 : g_hash_table_destroy (priv->splits_hash);
1463 : :
1464 : : /* qof_instance_release (&acc->inst); */
1465 : 2101 : g_object_unref(acc);
1466 : : }
1467 : :
1468 : : /********************************************************************\
1469 : : * transactional routines
1470 : : \********************************************************************/
1471 : :
1472 : : void
1473 : 33851 : xaccAccountBeginEdit (Account *acc)
1474 : : {
1475 : 33851 : g_return_if_fail(acc);
1476 : 33851 : qof_begin_edit(&acc->inst);
1477 : : }
1478 : :
1479 : 12232 : static void on_done(QofInstance *inst)
1480 : : {
1481 : : /* old event style */
1482 : 12232 : qof_event_gen (inst, QOF_EVENT_MODIFY, nullptr);
1483 : 12232 : }
1484 : :
1485 : 0 : static void on_err (QofInstance *inst, QofBackendError errcode)
1486 : : {
1487 : 0 : PERR("commit error: %d", errcode);
1488 : 0 : gnc_engine_signal_commit_error( errcode );
1489 : 0 : }
1490 : :
1491 : 2100 : static void acc_free (QofInstance *inst)
1492 : : {
1493 : : AccountPrivate *priv;
1494 : 2100 : Account *acc = (Account *) inst;
1495 : :
1496 : 2100 : priv = GET_PRIVATE(acc);
1497 : 2100 : if (priv->parent)
1498 : 1729 : gnc_account_remove_child(priv->parent, acc);
1499 : 2100 : xaccFreeAccount(acc);
1500 : 2100 : }
1501 : :
1502 : : static void
1503 : 63 : destroy_pending_splits_for_account(QofInstance *ent, gpointer acc)
1504 : : {
1505 : 63 : Transaction *trans = (Transaction *) ent;
1506 : : Split *split;
1507 : :
1508 : 63 : if (xaccTransIsOpen(trans))
1509 : 8 : while ((split = xaccTransFindSplitByAccount(trans, static_cast<Account*>(acc))))
1510 : 4 : xaccSplitDestroy(split);
1511 : 63 : }
1512 : :
1513 : : void
1514 : 33126 : xaccAccountCommitEdit (Account *acc)
1515 : : {
1516 : : AccountPrivate *priv;
1517 : : QofBook *book;
1518 : :
1519 : 33126 : g_return_if_fail(acc);
1520 : 33126 : if (!qof_commit_edit(&acc->inst)) return;
1521 : :
1522 : : /* If marked for deletion, get rid of subaccounts first,
1523 : : * and then the splits ... */
1524 : 14332 : priv = GET_PRIVATE(acc);
1525 : 14332 : if (qof_instance_get_destroying(acc))
1526 : : {
1527 : : QofCollection *col;
1528 : :
1529 : 2100 : qof_instance_increase_editlevel(acc);
1530 : :
1531 : : /* First, recursively free children */
1532 : 2100 : xaccFreeAccountChildren(acc);
1533 : :
1534 : 2100 : PINFO ("freeing splits for account %p (%s)",
1535 : : acc, priv->accountName ? priv->accountName : "(null)");
1536 : :
1537 : 2100 : book = qof_instance_get_book(acc);
1538 : :
1539 : : /* If book is shutting down, just clear the split list. The splits
1540 : : themselves will be destroyed by the transaction code */
1541 : 2100 : if (!qof_book_shutting_down(book))
1542 : : {
1543 : : // We need to delete in reverse order so that the vector's iterators aren't invalidated.
1544 : 500 : for_each(priv->splits.rbegin(), priv->splits.rend(), [](Split *s) {
1545 : 3 : xaccSplitDestroy (s); });
1546 : : }
1547 : : else
1548 : : {
1549 : 1600 : priv->splits.clear();
1550 : 1600 : g_hash_table_remove_all (priv->splits_hash);
1551 : : }
1552 : :
1553 : : /* It turns out there's a case where this assertion does not hold:
1554 : : When the user tries to delete an Imbalance account, while also
1555 : : deleting all the splits in it. The splits will just get
1556 : : recreated and put right back into the same account!
1557 : :
1558 : : g_assert(priv->splits == nullptr || qof_book_shutting_down(acc->inst.book));
1559 : : */
1560 : :
1561 : 2100 : if (!qof_book_shutting_down(book))
1562 : : {
1563 : 500 : col = qof_book_get_collection(book, GNC_ID_TRANS);
1564 : 500 : qof_collection_foreach(col, destroy_pending_splits_for_account, acc);
1565 : :
1566 : : /* the lots should be empty by now */
1567 : 503 : for (auto lp = priv->lots; lp; lp = lp->next)
1568 : : {
1569 : 3 : GNCLot *lot = static_cast<GNCLot*>(lp->data);
1570 : 3 : gnc_lot_destroy (lot);
1571 : : }
1572 : : }
1573 : 2100 : g_list_free(priv->lots);
1574 : 2100 : priv->lots = nullptr;
1575 : :
1576 : 2100 : qof_instance_set_dirty(&acc->inst);
1577 : 2100 : qof_instance_decrease_editlevel(acc);
1578 : : }
1579 : : else
1580 : : {
1581 : 12232 : xaccAccountBringUpToDate(acc);
1582 : : }
1583 : :
1584 : 14332 : qof_commit_edit_part2(&acc->inst, on_err, on_done, acc_free);
1585 : : }
1586 : :
1587 : : void
1588 : 2155 : xaccAccountDestroy (Account *acc)
1589 : : {
1590 : 2155 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
1591 : :
1592 : 2155 : qof_instance_set_destroying(acc, TRUE);
1593 : :
1594 : 2155 : xaccAccountCommitEdit (acc);
1595 : : }
1596 : :
1597 : : void
1598 : 0 : xaccAccountDestroyAllTransactions(Account *acc)
1599 : : {
1600 : 0 : auto priv = GET_PRIVATE(acc);
1601 : 0 : std::vector<Transaction*> transactions;
1602 : 0 : transactions.reserve(priv->splits.size());
1603 : 0 : std::transform(priv->splits.begin(), priv->splits.end(),
1604 : : back_inserter(transactions),
1605 : 0 : [](auto split) { return split->parent; });
1606 : 0 : std::stable_sort(transactions.begin(), transactions.end());
1607 : 0 : transactions.erase(std::unique(transactions.begin(), transactions.end()),
1608 : 0 : transactions.end());
1609 : 0 : qof_event_suspend();
1610 : 0 : std::for_each(transactions.rbegin(), transactions.rend(),
1611 : 0 : [](auto trans) { xaccTransDestroy (trans); });
1612 : 0 : qof_event_resume();
1613 : 0 : }
1614 : :
1615 : : /********************************************************************\
1616 : : \********************************************************************/
1617 : :
1618 : : static gboolean
1619 : 42 : xaccAcctChildrenEqual(const AccountVec& na,
1620 : : const AccountVec& nb,
1621 : : gboolean check_guids)
1622 : : {
1623 : 42 : if (na.size() != nb.size())
1624 : : {
1625 : 0 : PINFO ("Accounts have different numbers of children");
1626 : 0 : return (FALSE);
1627 : : }
1628 : :
1629 : 57 : for (auto aa : na)
1630 : : {
1631 : 15 : auto it_b = std::find_if (nb.begin(), nb.end(), [aa](auto ab) -> bool
1632 : : {
1633 : 28 : if (!aa) return (!ab);
1634 : 28 : if (!ab) return false;
1635 : 28 : auto code_a{GET_PRIVATE(aa)->accountCode};
1636 : 28 : auto code_b{GET_PRIVATE(ab)->accountCode};
1637 : 28 : if ((code_a && *code_a) || (code_b && *code_b)) return !g_strcmp0 (code_a, code_b);
1638 : 24 : return !g_strcmp0 (GET_PRIVATE(aa)->accountName, GET_PRIVATE(ab)->accountName);
1639 : : });
1640 : :
1641 : 15 : if (it_b == nb.end())
1642 : : {
1643 : 0 : PINFO ("Unable to find matching child account.");
1644 : 0 : return FALSE;
1645 : : }
1646 : 15 : else if (auto ab = *it_b; !xaccAccountEqual(aa, ab, check_guids))
1647 : : {
1648 : : char sa[GUID_ENCODING_LENGTH + 1];
1649 : : char sb[GUID_ENCODING_LENGTH + 1];
1650 : :
1651 : 0 : guid_to_string_buff (xaccAccountGetGUID (aa), sa);
1652 : 0 : guid_to_string_buff (xaccAccountGetGUID (ab), sb);
1653 : :
1654 : 0 : PWARN ("accounts %s and %s differ", sa, sb);
1655 : :
1656 : 0 : return(FALSE);
1657 : : }
1658 : : }
1659 : :
1660 : 42 : return(TRUE);
1661 : : }
1662 : :
1663 : : gboolean
1664 : 43 : xaccAccountEqual(const Account *aa, const Account *ab, gboolean check_guids)
1665 : : {
1666 : : AccountPrivate *priv_aa, *priv_ab;
1667 : :
1668 : 43 : if (!aa && !ab) return TRUE;
1669 : :
1670 : 42 : g_return_val_if_fail(GNC_IS_ACCOUNT(aa), FALSE);
1671 : 42 : g_return_val_if_fail(GNC_IS_ACCOUNT(ab), FALSE);
1672 : :
1673 : 42 : priv_aa = GET_PRIVATE(aa);
1674 : 42 : priv_ab = GET_PRIVATE(ab);
1675 : 42 : if (priv_aa->type != priv_ab->type)
1676 : : {
1677 : 0 : PWARN ("types differ: %d vs %d", priv_aa->type, priv_ab->type);
1678 : 0 : return FALSE;
1679 : : }
1680 : :
1681 : 42 : if (g_strcmp0(priv_aa->accountName, priv_ab->accountName) != 0)
1682 : : {
1683 : 0 : PWARN ("names differ: %s vs %s", priv_aa->accountName, priv_ab->accountName);
1684 : 0 : return FALSE;
1685 : : }
1686 : :
1687 : 42 : if (g_strcmp0(priv_aa->accountCode, priv_ab->accountCode) != 0)
1688 : : {
1689 : 0 : PWARN ("codes differ: %s vs %s", priv_aa->accountCode, priv_ab->accountCode);
1690 : 0 : return FALSE;
1691 : : }
1692 : :
1693 : 42 : if (g_strcmp0(priv_aa->description, priv_ab->description) != 0)
1694 : : {
1695 : 0 : PWARN ("descriptions differ: %s vs %s", priv_aa->description, priv_ab->description);
1696 : 0 : return FALSE;
1697 : : }
1698 : :
1699 : 42 : if (!gnc_commodity_equal(priv_aa->commodity, priv_ab->commodity))
1700 : : {
1701 : 0 : PWARN ("commodities differ");
1702 : 0 : return FALSE;
1703 : : }
1704 : :
1705 : 42 : if (check_guids)
1706 : : {
1707 : 24 : if (qof_instance_guid_compare(aa, ab) != 0)
1708 : : {
1709 : 0 : PWARN ("GUIDs differ");
1710 : 0 : return FALSE;
1711 : : }
1712 : : }
1713 : :
1714 : 42 : if (qof_instance_compare_kvp (QOF_INSTANCE (aa), QOF_INSTANCE (ab)) != 0)
1715 : : {
1716 : : char *frame_a;
1717 : : char *frame_b;
1718 : :
1719 : 0 : frame_a = qof_instance_kvp_as_string (QOF_INSTANCE (aa));
1720 : 0 : frame_b = qof_instance_kvp_as_string (QOF_INSTANCE (ab));
1721 : :
1722 : 0 : PWARN ("kvp frames differ:\n%s\n\nvs\n\n%s", frame_a, frame_b);
1723 : :
1724 : 0 : g_free (frame_a);
1725 : 0 : g_free (frame_b);
1726 : :
1727 : 0 : return FALSE;
1728 : : }
1729 : :
1730 : 42 : if (!gnc_numeric_equal(priv_aa->starting_balance, priv_ab->starting_balance))
1731 : : {
1732 : : char *str_a;
1733 : : char *str_b;
1734 : :
1735 : 0 : str_a = gnc_numeric_to_string(priv_aa->starting_balance);
1736 : 0 : str_b = gnc_numeric_to_string(priv_ab->starting_balance);
1737 : :
1738 : 0 : PWARN ("starting balances differ: %s vs %s", str_a, str_b);
1739 : :
1740 : 0 : g_free (str_a);
1741 : 0 : g_free (str_b);
1742 : :
1743 : 0 : return FALSE;
1744 : : }
1745 : :
1746 : 42 : if (!gnc_numeric_equal(priv_aa->starting_noclosing_balance,
1747 : : priv_ab->starting_noclosing_balance))
1748 : : {
1749 : : char *str_a;
1750 : : char *str_b;
1751 : :
1752 : 0 : str_a = gnc_numeric_to_string(priv_aa->starting_noclosing_balance);
1753 : 0 : str_b = gnc_numeric_to_string(priv_ab->starting_noclosing_balance);
1754 : :
1755 : 0 : PWARN ("starting noclosing balances differ: %s vs %s", str_a, str_b);
1756 : :
1757 : 0 : g_free (str_a);
1758 : 0 : g_free (str_b);
1759 : :
1760 : 0 : return FALSE;
1761 : : }
1762 : 42 : if (!gnc_numeric_equal(priv_aa->starting_cleared_balance,
1763 : : priv_ab->starting_cleared_balance))
1764 : : {
1765 : : char *str_a;
1766 : : char *str_b;
1767 : :
1768 : 0 : str_a = gnc_numeric_to_string(priv_aa->starting_cleared_balance);
1769 : 0 : str_b = gnc_numeric_to_string(priv_ab->starting_cleared_balance);
1770 : :
1771 : 0 : PWARN ("starting cleared balances differ: %s vs %s", str_a, str_b);
1772 : :
1773 : 0 : g_free (str_a);
1774 : 0 : g_free (str_b);
1775 : :
1776 : 0 : return FALSE;
1777 : : }
1778 : :
1779 : 42 : if (!gnc_numeric_equal(priv_aa->starting_reconciled_balance,
1780 : : priv_ab->starting_reconciled_balance))
1781 : : {
1782 : : char *str_a;
1783 : : char *str_b;
1784 : :
1785 : 0 : str_a = gnc_numeric_to_string(priv_aa->starting_reconciled_balance);
1786 : 0 : str_b = gnc_numeric_to_string(priv_ab->starting_reconciled_balance);
1787 : :
1788 : 0 : PWARN ("starting reconciled balances differ: %s vs %s", str_a, str_b);
1789 : :
1790 : 0 : g_free (str_a);
1791 : 0 : g_free (str_b);
1792 : :
1793 : 0 : return FALSE;
1794 : : }
1795 : :
1796 : 42 : if (!gnc_numeric_equal(priv_aa->balance, priv_ab->balance))
1797 : : {
1798 : : char *str_a;
1799 : : char *str_b;
1800 : :
1801 : 0 : str_a = gnc_numeric_to_string(priv_aa->balance);
1802 : 0 : str_b = gnc_numeric_to_string(priv_ab->balance);
1803 : :
1804 : 0 : PWARN ("balances differ: %s vs %s", str_a, str_b);
1805 : :
1806 : 0 : g_free (str_a);
1807 : 0 : g_free (str_b);
1808 : :
1809 : 0 : return FALSE;
1810 : : }
1811 : :
1812 : 42 : if (!gnc_numeric_equal(priv_aa->noclosing_balance, priv_ab->noclosing_balance))
1813 : : {
1814 : : char *str_a;
1815 : : char *str_b;
1816 : :
1817 : 0 : str_a = gnc_numeric_to_string(priv_aa->noclosing_balance);
1818 : 0 : str_b = gnc_numeric_to_string(priv_ab->noclosing_balance);
1819 : :
1820 : 0 : PWARN ("noclosing balances differ: %s vs %s", str_a, str_b);
1821 : :
1822 : 0 : g_free (str_a);
1823 : 0 : g_free (str_b);
1824 : :
1825 : 0 : return FALSE;
1826 : : }
1827 : 42 : if (!gnc_numeric_equal(priv_aa->cleared_balance, priv_ab->cleared_balance))
1828 : : {
1829 : : char *str_a;
1830 : : char *str_b;
1831 : :
1832 : 0 : str_a = gnc_numeric_to_string(priv_aa->cleared_balance);
1833 : 0 : str_b = gnc_numeric_to_string(priv_ab->cleared_balance);
1834 : :
1835 : 0 : PWARN ("cleared balances differ: %s vs %s", str_a, str_b);
1836 : :
1837 : 0 : g_free (str_a);
1838 : 0 : g_free (str_b);
1839 : :
1840 : 0 : return FALSE;
1841 : : }
1842 : :
1843 : 42 : if (!gnc_numeric_equal(priv_aa->reconciled_balance, priv_ab->reconciled_balance))
1844 : : {
1845 : : char *str_a;
1846 : : char *str_b;
1847 : :
1848 : 0 : str_a = gnc_numeric_to_string(priv_aa->reconciled_balance);
1849 : 0 : str_b = gnc_numeric_to_string(priv_ab->reconciled_balance);
1850 : :
1851 : 0 : PWARN ("reconciled balances differ: %s vs %s", str_a, str_b);
1852 : :
1853 : 0 : g_free (str_a);
1854 : 0 : g_free (str_b);
1855 : :
1856 : 0 : return FALSE;
1857 : : }
1858 : :
1859 : : /* no parent; always compare downwards. */
1860 : :
1861 : 42 : if (!std::equal (priv_aa->splits.begin(), priv_aa->splits.end(),
1862 : : priv_ab->splits.begin(), priv_ab->splits.end(),
1863 : 15 : [check_guids](auto sa, auto sb)
1864 : 15 : { return xaccSplitEqual(sa, sb, check_guids, true, false); }))
1865 : : {
1866 : 0 : PWARN ("splits differ");
1867 : 0 : return false;
1868 : : }
1869 : :
1870 : 42 : if (!xaccAcctChildrenEqual(priv_aa->children, priv_ab->children, check_guids))
1871 : : {
1872 : 0 : PWARN ("children differ");
1873 : 0 : return FALSE;
1874 : : }
1875 : :
1876 : 42 : return(TRUE);
1877 : : }
1878 : :
1879 : : /********************************************************************\
1880 : : \********************************************************************/
1881 : : void
1882 : 34683 : gnc_account_set_sort_dirty (Account *acc)
1883 : : {
1884 : : AccountPrivate *priv;
1885 : :
1886 : 34683 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
1887 : :
1888 : 34683 : if (qof_instance_get_destroying(acc))
1889 : 0 : return;
1890 : :
1891 : 34683 : priv = GET_PRIVATE(acc);
1892 : 34683 : priv->sort_dirty = TRUE;
1893 : : }
1894 : :
1895 : : void
1896 : 34683 : gnc_account_set_balance_dirty (Account *acc)
1897 : : {
1898 : : AccountPrivate *priv;
1899 : :
1900 : 34683 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
1901 : :
1902 : 34683 : if (qof_instance_get_destroying(acc))
1903 : 0 : return;
1904 : :
1905 : 34683 : priv = GET_PRIVATE(acc);
1906 : 34683 : priv->balance_dirty = TRUE;
1907 : : }
1908 : :
1909 : 0 : void gnc_account_set_defer_bal_computation (Account *acc, gboolean defer)
1910 : : {
1911 : : AccountPrivate *priv;
1912 : :
1913 : 0 : g_return_if_fail (GNC_IS_ACCOUNT (acc));
1914 : :
1915 : 0 : if (qof_instance_get_destroying (acc))
1916 : 0 : return;
1917 : :
1918 : 0 : priv = GET_PRIVATE (acc);
1919 : 0 : priv->defer_bal_computation = defer;
1920 : : }
1921 : :
1922 : 0 : gboolean gnc_account_get_defer_bal_computation (Account *acc)
1923 : : {
1924 : : AccountPrivate *priv;
1925 : 0 : if (!acc)
1926 : 0 : return false;
1927 : 0 : priv = GET_PRIVATE (acc);
1928 : 0 : return priv->defer_bal_computation;
1929 : : }
1930 : :
1931 : :
1932 : : /********************************************************************\
1933 : : \********************************************************************/
1934 : :
1935 : 561415 : static bool split_cmp_less (const Split* a, const Split* b)
1936 : : {
1937 : 561415 : return xaccSplitOrder (a, b) < 0;
1938 : : }
1939 : :
1940 : : gboolean
1941 : 7295 : gnc_account_insert_split (Account *acc, Split *s)
1942 : : {
1943 : : AccountPrivate *priv;
1944 : :
1945 : 7295 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
1946 : 7294 : g_return_val_if_fail(GNC_IS_SPLIT(s), FALSE);
1947 : :
1948 : 7293 : priv = GET_PRIVATE(acc);
1949 : 7293 : if (!g_hash_table_add (priv->splits_hash, s))
1950 : 2 : return false;
1951 : :
1952 : 7291 : priv->splits.push_back (s);
1953 : :
1954 : 7291 : if (qof_instance_get_editlevel(acc) == 0)
1955 : 5359 : std::sort (priv->splits.begin(), priv->splits.end(), split_cmp_less);
1956 : : else
1957 : 1932 : priv->sort_dirty = true;
1958 : :
1959 : : //FIXME: find better event
1960 : 7291 : qof_event_gen (&acc->inst, QOF_EVENT_MODIFY, nullptr);
1961 : : /* Also send an event based on the account */
1962 : 7291 : qof_event_gen(&acc->inst, GNC_EVENT_ITEM_ADDED, s);
1963 : :
1964 : 7291 : priv->balance_dirty = TRUE;
1965 : : // DRH: Should the below be added? It is present in the delete path.
1966 : : // xaccAccountRecomputeBalance(acc);
1967 : 7291 : return TRUE;
1968 : : }
1969 : :
1970 : : gboolean
1971 : 9852 : gnc_account_remove_split (Account *acc, Split *s)
1972 : : {
1973 : : AccountPrivate *priv;
1974 : :
1975 : 9852 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
1976 : 9852 : g_return_val_if_fail(GNC_IS_SPLIT(s), FALSE);
1977 : :
1978 : 9852 : priv = GET_PRIVATE(acc);
1979 : :
1980 : 9852 : if (!g_hash_table_remove (priv->splits_hash, s))
1981 : 4867 : return false;
1982 : :
1983 : : // shortcut pruning the last element. this is the most common
1984 : : // remove_split operation during UI or book shutdown.
1985 : 4985 : if (s == priv->splits.back())
1986 : 4948 : priv->splits.pop_back();
1987 : : else
1988 : 37 : priv->splits.erase (std::remove (priv->splits.begin(), priv->splits.end(), s),
1989 : 74 : priv->splits.end());
1990 : :
1991 : : //FIXME: find better event type
1992 : 4985 : qof_event_gen(&acc->inst, QOF_EVENT_MODIFY, nullptr);
1993 : : // And send the account-based event, too
1994 : 4985 : qof_event_gen(&acc->inst, GNC_EVENT_ITEM_REMOVED, s);
1995 : :
1996 : 4985 : priv->balance_dirty = TRUE;
1997 : 4985 : xaccAccountRecomputeBalance(acc);
1998 : 4985 : return TRUE;
1999 : : }
2000 : :
2001 : : void
2002 : 15255 : xaccAccountSortSplits (Account *acc, gboolean force)
2003 : : {
2004 : : AccountPrivate *priv;
2005 : :
2006 : 15255 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2007 : :
2008 : 15255 : priv = GET_PRIVATE(acc);
2009 : 15255 : if (!priv->sort_dirty || (!force && qof_instance_get_editlevel(acc) > 0))
2010 : 11631 : return;
2011 : 3624 : std::sort (priv->splits.begin(), priv->splits.end(), split_cmp_less);
2012 : 3624 : priv->sort_dirty = FALSE;
2013 : 3624 : priv->balance_dirty = TRUE;
2014 : : }
2015 : :
2016 : : static void
2017 : 12232 : xaccAccountBringUpToDate(Account *acc)
2018 : : {
2019 : 12232 : if (!acc) return;
2020 : :
2021 : : /* if a re-sort happens here, then everything will update, so the
2022 : : cost basis and balance calls are no-ops */
2023 : 12232 : xaccAccountSortSplits(acc, FALSE);
2024 : 12232 : xaccAccountRecomputeBalance(acc);
2025 : : }
2026 : :
2027 : : /********************************************************************\
2028 : : \********************************************************************/
2029 : :
2030 : : void
2031 : 1308 : xaccAccountSetGUID (Account *acc, const GncGUID *guid)
2032 : : {
2033 : 1308 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2034 : 1308 : g_return_if_fail(guid);
2035 : :
2036 : : /* XXX this looks fishy and weird to me ... */
2037 : 1308 : PINFO("acct=%p", acc);
2038 : 1308 : xaccAccountBeginEdit (acc);
2039 : 1308 : qof_instance_set_guid (&acc->inst, guid);
2040 : 1308 : qof_instance_set_dirty(&acc->inst);
2041 : 1308 : xaccAccountCommitEdit (acc);
2042 : : }
2043 : :
2044 : : /********************************************************************\
2045 : : \********************************************************************/
2046 : :
2047 : : Account *
2048 : 4423 : xaccAccountLookup (const GncGUID *guid, QofBook *book)
2049 : : {
2050 : : QofCollection *col;
2051 : 4423 : if (!guid || !book) return nullptr;
2052 : 4423 : col = qof_book_get_collection (book, GNC_ID_ACCOUNT);
2053 : 4423 : return (Account *) qof_collection_lookup_entity (col, guid);
2054 : : }
2055 : :
2056 : : /********************************************************************\
2057 : : \********************************************************************/
2058 : :
2059 : : void
2060 : 0 : xaccAccountSetMark (Account *acc, short m)
2061 : : {
2062 : : AccountPrivate *priv;
2063 : :
2064 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2065 : :
2066 : 0 : priv = GET_PRIVATE(acc);
2067 : 0 : priv->mark = m;
2068 : : }
2069 : :
2070 : : void
2071 : 0 : xaccClearMark (Account *acc, short val)
2072 : : {
2073 : : Account *root;
2074 : :
2075 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2076 : :
2077 : 0 : root = gnc_account_get_root(acc);
2078 : 0 : xaccClearMarkDown(root ? root : acc, val);
2079 : : }
2080 : :
2081 : : void
2082 : 0 : xaccClearMarkDown (Account *acc, short val)
2083 : : {
2084 : : AccountPrivate *priv;
2085 : :
2086 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2087 : :
2088 : 0 : priv = GET_PRIVATE(acc);
2089 : 0 : priv->mark = val;
2090 : 0 : std::for_each (priv->children.begin(), priv->children.end(),
2091 : 0 : [val](auto acc){ xaccClearMarkDown(acc, val); });
2092 : : }
2093 : :
2094 : : /********************************************************************\
2095 : : \********************************************************************/
2096 : :
2097 : : GNCPolicy *
2098 : 339 : gnc_account_get_policy (Account *acc)
2099 : : {
2100 : 339 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
2101 : :
2102 : 339 : return GET_PRIVATE(acc)->policy;
2103 : : }
2104 : :
2105 : : void
2106 : 0 : gnc_account_set_policy (Account *acc, GNCPolicy *policy)
2107 : : {
2108 : : AccountPrivate *priv;
2109 : :
2110 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2111 : :
2112 : 0 : priv = GET_PRIVATE(acc);
2113 : 0 : priv->policy = policy ? policy : xaccGetFIFOPolicy();
2114 : : }
2115 : :
2116 : : /********************************************************************\
2117 : : \********************************************************************/
2118 : :
2119 : : void
2120 : 122 : xaccAccountRemoveLot (Account *acc, GNCLot *lot)
2121 : : {
2122 : : AccountPrivate *priv;
2123 : :
2124 : 122 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2125 : 122 : g_return_if_fail(GNC_IS_LOT(lot));
2126 : :
2127 : 122 : priv = GET_PRIVATE(acc);
2128 : 122 : g_return_if_fail(priv->lots);
2129 : :
2130 : 122 : ENTER ("(acc=%p, lot=%p)", acc, lot);
2131 : 122 : priv->lots = g_list_remove(priv->lots, lot);
2132 : 122 : qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_REMOVE, nullptr);
2133 : 122 : qof_event_gen (&acc->inst, QOF_EVENT_MODIFY, nullptr);
2134 : 122 : LEAVE ("(acc=%p, lot=%p)", acc, lot);
2135 : : }
2136 : :
2137 : : void
2138 : 223 : xaccAccountInsertLot (Account *acc, GNCLot *lot)
2139 : : {
2140 : : AccountPrivate *priv, *opriv;
2141 : 223 : Account * old_acc = nullptr;
2142 : : Account* lot_account;
2143 : :
2144 : : /* errors */
2145 : 223 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2146 : 223 : g_return_if_fail(GNC_IS_LOT(lot));
2147 : :
2148 : : /* optimizations */
2149 : 223 : lot_account = gnc_lot_get_account(lot);
2150 : 223 : if (lot_account == acc)
2151 : 1 : return;
2152 : :
2153 : 222 : ENTER ("(acc=%p, lot=%p)", acc, lot);
2154 : :
2155 : : /* pull it out of the old account */
2156 : 222 : if (lot_account)
2157 : : {
2158 : 1 : old_acc = lot_account;
2159 : 1 : opriv = GET_PRIVATE(old_acc);
2160 : 1 : opriv->lots = g_list_remove(opriv->lots, lot);
2161 : : }
2162 : :
2163 : 222 : priv = GET_PRIVATE(acc);
2164 : 222 : priv->lots = g_list_prepend(priv->lots, lot);
2165 : 222 : gnc_lot_set_account(lot, acc);
2166 : :
2167 : : /* Don't move the splits to the new account. The caller will do this
2168 : : * if appropriate, and doing it here will not work if we are being
2169 : : * called from gnc_book_close_period since xaccAccountInsertSplit
2170 : : * will try to balance capital gains and things aren't ready for that. */
2171 : :
2172 : 222 : qof_event_gen (QOF_INSTANCE(lot), QOF_EVENT_ADD, nullptr);
2173 : 222 : qof_event_gen (&acc->inst, QOF_EVENT_MODIFY, nullptr);
2174 : :
2175 : 222 : LEAVE ("(acc=%p, lot=%p)", acc, lot);
2176 : : }
2177 : :
2178 : : /********************************************************************\
2179 : : \********************************************************************/
2180 : : static void
2181 : 0 : xaccPreSplitMove (Split *split)
2182 : : {
2183 : 0 : xaccTransBeginEdit (xaccSplitGetParent (split));
2184 : 0 : }
2185 : :
2186 : : static void
2187 : 0 : xaccPostSplitMove (Split *split, Account *accto)
2188 : : {
2189 : : Transaction *trans;
2190 : :
2191 : 0 : xaccSplitSetAccount(split, accto);
2192 : 0 : xaccSplitSetAmount(split, split->amount);
2193 : 0 : trans = xaccSplitGetParent (split);
2194 : 0 : xaccTransCommitEdit (trans);
2195 : 0 : }
2196 : :
2197 : : void
2198 : 0 : xaccAccountMoveAllSplits (Account *accfrom, Account *accto)
2199 : : {
2200 : : AccountPrivate *from_priv;
2201 : :
2202 : : /* errors */
2203 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(accfrom));
2204 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(accto));
2205 : :
2206 : : /* optimizations */
2207 : 0 : from_priv = GET_PRIVATE(accfrom);
2208 : 0 : if (from_priv->splits.empty() || accfrom == accto)
2209 : 0 : return;
2210 : :
2211 : : /* check for book mix-up */
2212 : 0 : g_return_if_fail (qof_instance_books_equal(accfrom, accto));
2213 : 0 : ENTER ("(accfrom=%p, accto=%p)", accfrom, accto);
2214 : :
2215 : 0 : xaccAccountBeginEdit(accfrom);
2216 : 0 : xaccAccountBeginEdit(accto);
2217 : : /* Begin editing both accounts and all transactions in accfrom. */
2218 : 0 : std::for_each (from_priv->splits.begin(), from_priv->splits.end(), xaccPreSplitMove);
2219 : :
2220 : : /* Concatenate accfrom's lists of splits and lots to accto's lists. */
2221 : : //to_priv->splits = g_list_concat(to_priv->splits, from_priv->splits);
2222 : : //to_priv->lots = g_list_concat(to_priv->lots, from_priv->lots);
2223 : :
2224 : : /* Set appropriate flags. */
2225 : : //from_priv->balance_dirty = TRUE;
2226 : : //from_priv->sort_dirty = FALSE;
2227 : : //to_priv->balance_dirty = TRUE;
2228 : : //to_priv->sort_dirty = TRUE;
2229 : :
2230 : : /*
2231 : : * Change each split's account back pointer to accto.
2232 : : * Convert each split's amount to accto's commodity.
2233 : : * Commit to editing each transaction.
2234 : : */
2235 : 0 : auto splits = from_priv->splits;
2236 : 0 : std::for_each (splits.begin(), splits.end(), [accto](auto s){ xaccPostSplitMove (s, accto); });
2237 : :
2238 : : /* Finally empty accfrom. */
2239 : 0 : g_assert(from_priv->splits.empty());
2240 : 0 : g_assert(from_priv->lots == nullptr);
2241 : 0 : xaccAccountCommitEdit(accfrom);
2242 : 0 : xaccAccountCommitEdit(accto);
2243 : :
2244 : 0 : LEAVE ("(accfrom=%p, accto=%p)", accfrom, accto);
2245 : 0 : }
2246 : :
2247 : :
2248 : : /********************************************************************\
2249 : : * xaccAccountRecomputeBalance *
2250 : : * recomputes the partial balances and the current balance for *
2251 : : * this account. *
2252 : : * *
2253 : : * The way the computation is done depends on whether the partial *
2254 : : * balances are for a monetary account (bank, cash, etc.) or a *
2255 : : * certificate account (stock portfolio, mutual fund). For bank *
2256 : : * accounts, the invariant amount is the dollar amount. For share *
2257 : : * accounts, the invariant amount is the number of shares. For *
2258 : : * share accounts, the share price fluctuates, and the current *
2259 : : * value of such an account is the number of shares times the *
2260 : : * current share price. *
2261 : : * *
2262 : : * Part of the complexity of this computation stems from the fact *
2263 : : * xacc uses a double-entry system, meaning that one transaction *
2264 : : * appears in two accounts: one account is debited, and the other *
2265 : : * is credited. When the transaction represents a sale of shares, *
2266 : : * or a purchase of shares, some care must be taken to compute *
2267 : : * balances correctly. For a sale of shares, the stock account must*
2268 : : * be debited in shares, but the bank account must be credited *
2269 : : * in dollars. Thus, two different mechanisms must be used to *
2270 : : * compute balances, depending on account type. *
2271 : : * *
2272 : : * Args: account -- the account for which to recompute balances *
2273 : : * Return: void *
2274 : : \********************************************************************/
2275 : :
2276 : : void
2277 : 34298 : xaccAccountRecomputeBalance (Account * acc)
2278 : : {
2279 : : AccountPrivate *priv;
2280 : : gnc_numeric balance;
2281 : : gnc_numeric noclosing_balance;
2282 : : gnc_numeric cleared_balance;
2283 : : gnc_numeric reconciled_balance;
2284 : :
2285 : 56009 : if (nullptr == acc) return;
2286 : :
2287 : 33475 : priv = GET_PRIVATE(acc);
2288 : 33475 : if (qof_instance_get_editlevel(acc) > 0) return;
2289 : 31107 : if (!priv->balance_dirty || priv->defer_bal_computation) return;
2290 : 21034 : if (qof_instance_get_destroying(acc)) return;
2291 : 21034 : if (qof_book_shutting_down(qof_instance_get_book(acc))) return;
2292 : :
2293 : 11764 : balance = priv->starting_balance;
2294 : 11764 : noclosing_balance = priv->starting_noclosing_balance;
2295 : 11764 : cleared_balance = priv->starting_cleared_balance;
2296 : 11764 : reconciled_balance = priv->starting_reconciled_balance;
2297 : :
2298 : 11764 : PINFO ("acct=%s starting baln=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT,
2299 : : priv->accountName, balance.num, balance.denom);
2300 : 110407 : for (auto split : priv->splits)
2301 : : {
2302 : 98643 : gnc_numeric amt = xaccSplitGetAmount (split);
2303 : :
2304 : 98643 : balance = gnc_numeric_add_fixed(balance, amt);
2305 : :
2306 : 98643 : if (NREC != split->reconciled)
2307 : : {
2308 : 9957 : cleared_balance = gnc_numeric_add_fixed(cleared_balance, amt);
2309 : : }
2310 : :
2311 : 98643 : if (YREC == split->reconciled ||
2312 : 96711 : FREC == split->reconciled)
2313 : : {
2314 : : reconciled_balance =
2315 : 3723 : gnc_numeric_add_fixed(reconciled_balance, amt);
2316 : : }
2317 : :
2318 : 98643 : if (!(xaccTransGetIsClosingTxn (split->parent)))
2319 : 98318 : noclosing_balance = gnc_numeric_add_fixed(noclosing_balance, amt);
2320 : :
2321 : 98643 : split->balance = balance;
2322 : 98643 : split->noclosing_balance = noclosing_balance;
2323 : 98643 : split->cleared_balance = cleared_balance;
2324 : 98643 : split->reconciled_balance = reconciled_balance;
2325 : :
2326 : : }
2327 : :
2328 : 11764 : priv->balance = balance;
2329 : 11764 : priv->noclosing_balance = noclosing_balance;
2330 : 11764 : priv->cleared_balance = cleared_balance;
2331 : 11764 : priv->reconciled_balance = reconciled_balance;
2332 : 11764 : priv->balance_dirty = FALSE;
2333 : : }
2334 : :
2335 : : /********************************************************************\
2336 : : \********************************************************************/
2337 : :
2338 : : /* The sort order is used to implicitly define an
2339 : : * order for report generation */
2340 : :
2341 : : static int typeorder[NUM_ACCOUNT_TYPES] =
2342 : : {
2343 : : ACCT_TYPE_BANK, ACCT_TYPE_STOCK, ACCT_TYPE_MUTUAL, ACCT_TYPE_CURRENCY,
2344 : : ACCT_TYPE_CASH, ACCT_TYPE_ASSET, ACCT_TYPE_RECEIVABLE,
2345 : : ACCT_TYPE_CREDIT, ACCT_TYPE_LIABILITY, ACCT_TYPE_PAYABLE,
2346 : : ACCT_TYPE_INCOME, ACCT_TYPE_EXPENSE, ACCT_TYPE_EQUITY, ACCT_TYPE_TRADING
2347 : : };
2348 : :
2349 : : static int revorder[NUM_ACCOUNT_TYPES] =
2350 : : {
2351 : : -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1
2352 : : };
2353 : :
2354 : :
2355 : : int
2356 : 14450 : xaccAccountOrder (const Account *aa, const Account *ab)
2357 : : {
2358 : : AccountPrivate *priv_aa, *priv_ab;
2359 : : const char *da, *db;
2360 : : int ta, tb, result;
2361 : :
2362 : 14450 : if (aa == ab) return 0;
2363 : 14448 : if (!ab) return -1;
2364 : 14447 : if (!aa) return +1;
2365 : :
2366 : 14446 : priv_aa = GET_PRIVATE(aa);
2367 : 14446 : priv_ab = GET_PRIVATE(ab);
2368 : :
2369 : : /* sort on accountCode strings */
2370 : 14446 : da = priv_aa->accountCode;
2371 : 14446 : db = priv_ab->accountCode;
2372 : :
2373 : : /* Otherwise do a string sort */
2374 : 14446 : result = g_strcmp0 (da, db);
2375 : 14446 : if (result)
2376 : 40 : return result;
2377 : :
2378 : : /* if account-type-order array not initialized, initialize it */
2379 : : /* this will happen at most once during program invocation */
2380 : 14406 : if (-1 == revorder[0])
2381 : : {
2382 : : int i;
2383 : 384 : for (i = 0; i < NUM_ACCOUNT_TYPES; i++)
2384 : : {
2385 : 360 : revorder [typeorder[i]] = i;
2386 : : }
2387 : : }
2388 : :
2389 : : /* otherwise, sort on account type */
2390 : 14406 : ta = priv_aa->type;
2391 : 14406 : tb = priv_ab->type;
2392 : 14406 : ta = revorder[ta];
2393 : 14406 : tb = revorder[tb];
2394 : 14406 : if (ta < tb) return -1;
2395 : 13211 : if (ta > tb) return +1;
2396 : :
2397 : : /* otherwise, sort on accountName strings */
2398 : 8052 : da = priv_aa->accountName;
2399 : 8052 : db = priv_ab->accountName;
2400 : 8052 : result = safe_utf8_collate(da, db);
2401 : 8052 : if (result)
2402 : 7945 : return result;
2403 : :
2404 : : /* guarantee a stable sort */
2405 : 107 : return qof_instance_guid_compare(aa, ab);
2406 : : }
2407 : :
2408 : : static int
2409 : 0 : qof_xaccAccountOrder (const Account **aa, const Account **ab)
2410 : : {
2411 : 0 : return xaccAccountOrder(*aa, *ab);
2412 : : }
2413 : :
2414 : : /********************************************************************\
2415 : : \********************************************************************/
2416 : :
2417 : : void
2418 : 4248 : xaccAccountSetType (Account *acc, GNCAccountType tip)
2419 : : {
2420 : : AccountPrivate *priv;
2421 : :
2422 : : /* errors */
2423 : 4248 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2424 : 4248 : g_return_if_fail(tip < NUM_ACCOUNT_TYPES);
2425 : :
2426 : : /* optimizations */
2427 : 4248 : priv = GET_PRIVATE(acc);
2428 : 4248 : if (priv->type == tip)
2429 : 60 : return;
2430 : :
2431 : 4188 : xaccAccountBeginEdit(acc);
2432 : 4188 : priv->type = tip;
2433 : 4188 : priv->balance_dirty = TRUE; /* new type may affect balance computation */
2434 : 4188 : mark_account(acc);
2435 : 4188 : xaccAccountCommitEdit(acc);
2436 : : }
2437 : :
2438 : : void
2439 : 5227 : xaccAccountSetName (Account *acc, const char *str)
2440 : : {
2441 : : AccountPrivate *priv;
2442 : :
2443 : : /* errors */
2444 : 5227 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2445 : 5227 : g_return_if_fail(str);
2446 : :
2447 : : /* optimizations */
2448 : 5227 : priv = GET_PRIVATE(acc);
2449 : 5227 : if (g_strcmp0(str, priv->accountName) == 0)
2450 : 10 : return;
2451 : :
2452 : 5217 : xaccAccountBeginEdit(acc);
2453 : 5217 : priv->accountName = qof_string_cache_replace(priv->accountName, str);
2454 : 5217 : mark_account (acc);
2455 : 5217 : xaccAccountCommitEdit(acc);
2456 : : }
2457 : :
2458 : : void
2459 : 1236 : xaccAccountSetCode (Account *acc, const char *str)
2460 : : {
2461 : : AccountPrivate *priv;
2462 : :
2463 : : /* errors */
2464 : 1236 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2465 : :
2466 : : /* optimizations */
2467 : 1236 : priv = GET_PRIVATE(acc);
2468 : 1236 : if (g_strcmp0(str, priv->accountCode) == 0)
2469 : 81 : return;
2470 : :
2471 : 1155 : xaccAccountBeginEdit(acc);
2472 : 1155 : priv->accountCode = qof_string_cache_replace(priv->accountCode, str ? str : "");
2473 : 1155 : mark_account (acc);
2474 : 1155 : xaccAccountCommitEdit(acc);
2475 : : }
2476 : :
2477 : : void
2478 : 2157 : xaccAccountSetDescription (Account *acc, const char *str)
2479 : : {
2480 : : AccountPrivate *priv;
2481 : :
2482 : : /* errors */
2483 : 2157 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2484 : :
2485 : : /* optimizations */
2486 : 2157 : priv = GET_PRIVATE(acc);
2487 : 2157 : if (g_strcmp0(str, priv->description) == 0)
2488 : 630 : return;
2489 : :
2490 : 1527 : xaccAccountBeginEdit(acc);
2491 : 1527 : priv->description = qof_string_cache_replace(priv->description, str ? str : "");
2492 : 1527 : mark_account (acc);
2493 : 1527 : xaccAccountCommitEdit(acc);
2494 : : }
2495 : :
2496 : : static void
2497 : 6 : set_kvp_gnc_numeric_path (Account *acc, const std::vector<std::string>& path,
2498 : : std::optional<gnc_numeric> value)
2499 : : {
2500 : 6 : xaccAccountBeginEdit(acc);
2501 : 6 : qof_instance_set_path_kvp<gnc_numeric> (QOF_INSTANCE(acc), value, path);
2502 : 6 : xaccAccountCommitEdit(acc);
2503 : 6 : }
2504 : :
2505 : : static std::optional<gnc_numeric>
2506 : 11 : get_kvp_gnc_numeric_path (const Account *acc, const Path& path)
2507 : : {
2508 : 11 : return qof_instance_get_path_kvp<gnc_numeric> (QOF_INSTANCE(acc), path);
2509 : : }
2510 : :
2511 : : static void
2512 : 1802 : set_kvp_string_path (Account *acc, std::vector<std::string> const & path,
2513 : : const char *value)
2514 : : {
2515 : 1802 : std::optional<const char*> val;
2516 : 1802 : if (value && *value)
2517 : 35 : val = g_strdup(value);
2518 : :
2519 : 1802 : xaccAccountBeginEdit(acc);
2520 : 1802 : qof_instance_set_path_kvp<const char*> (QOF_INSTANCE(acc), val, path);
2521 : 1802 : xaccAccountCommitEdit(acc);
2522 : 1802 : }
2523 : :
2524 : : static const char*
2525 : 2777 : get_kvp_string_path (const Account *acc, const Path& path)
2526 : : {
2527 : 2777 : auto rv{qof_instance_get_path_kvp<const char*> (QOF_INSTANCE(acc), path)};
2528 : 5554 : return rv ? *rv : nullptr;
2529 : : }
2530 : :
2531 : : static void
2532 : 81 : set_kvp_account_path (Account* acc, const Path& path, const Account* kvp_account)
2533 : : {
2534 : 81 : std::optional<GncGUID*> val;
2535 : 81 : if (kvp_account)
2536 : 80 : val = guid_copy(xaccAccountGetGUID (kvp_account));
2537 : :
2538 : 81 : xaccAccountBeginEdit(acc);
2539 : 81 : qof_instance_set_path_kvp<GncGUID*> (QOF_INSTANCE(acc), val, path);
2540 : 81 : xaccAccountCommitEdit(acc);
2541 : 81 : }
2542 : :
2543 : : static Account*
2544 : 15 : get_kvp_account_path (const Account *acc, const Path& path)
2545 : : {
2546 : 15 : auto val{qof_instance_get_path_kvp<GncGUID*> (QOF_INSTANCE(acc), path)};
2547 : 30 : return val ? xaccAccountLookup (*val, gnc_account_get_book (acc)) : nullptr;
2548 : : }
2549 : :
2550 : : static void
2551 : 157 : set_kvp_boolean_path (Account *acc, const Path& path, gboolean option)
2552 : : {
2553 : 157 : set_kvp_string_path (acc, path, option ? "true" : nullptr);
2554 : 157 : }
2555 : :
2556 : : static gboolean
2557 : 253 : get_kvp_boolean_path (const Account *acc, const Path& path)
2558 : : {
2559 : 253 : auto slot{QOF_INSTANCE(acc)->kvp_data->get_slot(path)};
2560 : 253 : if (!slot) return false;
2561 : 10 : switch (slot->get_type())
2562 : : {
2563 : 1 : case KvpValueImpl::Type::INT64:
2564 : 1 : return slot->get<int64_t>() != 0;
2565 : 9 : case KvpValueImpl::Type::STRING:
2566 : 9 : return g_strcmp0 (slot->get<const char*>(), "true") == 0;
2567 : 0 : default:
2568 : 0 : return false;
2569 : : }
2570 : : }
2571 : :
2572 : : static void
2573 : 19 : set_kvp_int64_path (Account *acc, const Path& path, std::optional<gint64> value)
2574 : : {
2575 : 19 : xaccAccountBeginEdit(acc);
2576 : 19 : qof_instance_set_path_kvp<int64_t> (QOF_INSTANCE(acc), value, path);
2577 : 19 : xaccAccountCommitEdit(acc);
2578 : 19 : }
2579 : :
2580 : : static const std::optional<gint64>
2581 : 21 : get_kvp_int64_path (const Account *acc, const Path& path)
2582 : : {
2583 : 21 : return qof_instance_get_path_kvp<int64_t> (QOF_INSTANCE(acc), path);
2584 : : }
2585 : :
2586 : : void
2587 : 707 : xaccAccountSetColor (Account *acc, const char *str)
2588 : : {
2589 : 1414 : set_kvp_string_path (acc, {"color"}, str);
2590 : 707 : }
2591 : :
2592 : : void
2593 : 5 : xaccAccountSetFilter (Account *acc, const char *str)
2594 : : {
2595 : 10 : set_kvp_string_path (acc, {"filter"}, str);
2596 : 5 : }
2597 : :
2598 : : void
2599 : 5 : xaccAccountSetSortOrder (Account *acc, const char *str)
2600 : : {
2601 : 10 : set_kvp_string_path (acc, {"sort-order"}, str);
2602 : 5 : }
2603 : :
2604 : : void
2605 : 2 : xaccAccountSetSortReversed (Account *acc, gboolean sortreversed)
2606 : : {
2607 : 4 : set_kvp_boolean_path (acc, {"sort-reversed"}, sortreversed);
2608 : 2 : }
2609 : :
2610 : : static void
2611 : 1 : qofAccountSetParent (Account *acc, QofInstance *parent)
2612 : : {
2613 : : Account *parent_acc;
2614 : :
2615 : 1 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2616 : 1 : g_return_if_fail(GNC_IS_ACCOUNT(parent));
2617 : :
2618 : 1 : parent_acc = GNC_ACCOUNT(parent);
2619 : 1 : xaccAccountBeginEdit(acc);
2620 : 1 : xaccAccountBeginEdit(parent_acc);
2621 : 1 : gnc_account_append_child(parent_acc, acc);
2622 : 1 : mark_account (parent_acc);
2623 : 1 : mark_account (acc);
2624 : 1 : xaccAccountCommitEdit(acc);
2625 : 1 : xaccAccountCommitEdit(parent_acc);
2626 : : }
2627 : :
2628 : : void
2629 : 521 : xaccAccountSetNotes (Account *acc, const char *str)
2630 : : {
2631 : 1042 : set_kvp_string_path (acc, {"notes"}, str);
2632 : 521 : }
2633 : :
2634 : :
2635 : : void
2636 : 71 : xaccAccountSetAssociatedAccount (Account *acc, const char *tag, const Account* assoc_acct)
2637 : : {
2638 : 71 : g_return_if_fail (GNC_IS_ACCOUNT(acc));
2639 : 70 : g_return_if_fail (tag && *tag);
2640 : :
2641 : 276 : set_kvp_account_path (acc, {"associated-account", tag}, assoc_acct);
2642 : 207 : }
2643 : :
2644 : : void
2645 : 3305 : xaccAccountSetCommodity (Account * acc, gnc_commodity * com)
2646 : : {
2647 : : AccountPrivate *priv;
2648 : :
2649 : : /* errors */
2650 : 3305 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2651 : 3305 : g_return_if_fail(GNC_IS_COMMODITY(com));
2652 : :
2653 : : /* optimizations */
2654 : 3110 : priv = GET_PRIVATE(acc);
2655 : 3110 : if (com == priv->commodity)
2656 : 47 : return;
2657 : :
2658 : 3063 : xaccAccountBeginEdit(acc);
2659 : 3063 : gnc_commodity_decrement_usage_count(priv->commodity);
2660 : 3063 : priv->commodity = com;
2661 : 3063 : gnc_commodity_increment_usage_count(com);
2662 : 3063 : priv->commodity_scu = gnc_commodity_get_fraction(com);
2663 : 3063 : priv->non_standard_scu = FALSE;
2664 : :
2665 : : /* iterate over splits */
2666 : 3072 : for (auto s : priv->splits)
2667 : : {
2668 : 9 : Transaction *trans = xaccSplitGetParent (s);
2669 : :
2670 : 9 : xaccTransBeginEdit (trans);
2671 : 9 : xaccSplitSetAmount (s, xaccSplitGetAmount(s));
2672 : 9 : xaccTransCommitEdit (trans);
2673 : : }
2674 : :
2675 : 3063 : priv->sort_dirty = TRUE; /* Not needed. */
2676 : 3063 : priv->balance_dirty = TRUE;
2677 : 3063 : mark_account (acc);
2678 : :
2679 : 3063 : xaccAccountCommitEdit(acc);
2680 : : }
2681 : :
2682 : : /*
2683 : : * Set the account scu and then check to see if it is the same as the
2684 : : * commodity scu. This function is called when parsing the data file
2685 : : * and is designed to catch cases where the two were accidentally set
2686 : : * to mismatched values in the past.
2687 : : */
2688 : : void
2689 : 897 : xaccAccountSetCommoditySCU (Account *acc, int scu)
2690 : : {
2691 : : AccountPrivate *priv;
2692 : :
2693 : 897 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2694 : :
2695 : 897 : priv = GET_PRIVATE(acc);
2696 : 897 : xaccAccountBeginEdit(acc);
2697 : 897 : priv->commodity_scu = scu;
2698 : 897 : if (scu != gnc_commodity_get_fraction(priv->commodity))
2699 : 100 : priv->non_standard_scu = TRUE;
2700 : 897 : mark_account(acc);
2701 : 897 : xaccAccountCommitEdit(acc);
2702 : : }
2703 : :
2704 : : int
2705 : 706 : xaccAccountGetCommoditySCUi (const Account * acc)
2706 : : {
2707 : 706 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), 0);
2708 : 706 : return GET_PRIVATE(acc)->commodity_scu;
2709 : : }
2710 : :
2711 : : int
2712 : 17984 : xaccAccountGetCommoditySCU (const Account * acc)
2713 : : {
2714 : : AccountPrivate *priv;
2715 : :
2716 : 17984 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), 0);
2717 : :
2718 : 17984 : priv = GET_PRIVATE(acc);
2719 : 17984 : if (priv->non_standard_scu || !priv->commodity)
2720 : 1805 : return priv->commodity_scu;
2721 : 16179 : return gnc_commodity_get_fraction(priv->commodity);
2722 : : }
2723 : :
2724 : : void
2725 : 38 : xaccAccountSetNonStdSCU (Account *acc, gboolean flag)
2726 : : {
2727 : : AccountPrivate *priv;
2728 : :
2729 : 38 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
2730 : :
2731 : 38 : priv = GET_PRIVATE(acc);
2732 : 38 : if (priv->non_standard_scu == flag)
2733 : 34 : return;
2734 : 4 : xaccAccountBeginEdit(acc);
2735 : 4 : priv->non_standard_scu = flag;
2736 : 4 : mark_account (acc);
2737 : 4 : xaccAccountCommitEdit(acc);
2738 : : }
2739 : :
2740 : : gboolean
2741 : 251 : xaccAccountGetNonStdSCU (const Account * acc)
2742 : : {
2743 : 251 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), 0);
2744 : 251 : return GET_PRIVATE(acc)->non_standard_scu;
2745 : : }
2746 : :
2747 : : /********************************************************************\
2748 : : \********************************************************************/
2749 : : /* below follow the old, deprecated currency/security routines. */
2750 : :
2751 : : void
2752 : 0 : DxaccAccountSetCurrency (Account * acc, gnc_commodity * currency)
2753 : : {
2754 : 0 : if ((!acc) || (!currency)) return;
2755 : :
2756 : 0 : auto s = gnc_commodity_get_unique_name (currency);
2757 : 0 : set_kvp_string_path (acc, {"old-currency"}, s);
2758 : :
2759 : 0 : auto book = qof_instance_get_book(acc);
2760 : 0 : auto table = gnc_commodity_table_get_table (book);
2761 : 0 : auto commodity = gnc_commodity_table_lookup_unique (table, s);
2762 : :
2763 : 0 : if (!commodity)
2764 : 0 : gnc_commodity_table_insert (table, currency);
2765 : : }
2766 : :
2767 : : /********************************************************************\
2768 : : \********************************************************************/
2769 : :
2770 : : void
2771 : 18093 : gnc_account_foreach_descendant (const Account *acc, std::function<void(Account*)> account_cb)
2772 : : {
2773 : 18093 : g_return_if_fail (GNC_IS_ACCOUNT(acc));
2774 : :
2775 : : // children must be a vector copy instead of reference because
2776 : : // some callers e.g. xaccAccountTreeScrubLots will modify the
2777 : : // children
2778 : 18093 : auto children = GET_PRIVATE(acc)->children;
2779 : 34645 : for (auto child : children)
2780 : : {
2781 : 16552 : account_cb (child);
2782 : 16552 : gnc_account_foreach_descendant (child, account_cb);
2783 : : }
2784 : 18093 : }
2785 : :
2786 : : static void
2787 : 13064 : account_foreach_descendant_sorted (const Account *acc, std::function<void(Account*)> account_cb)
2788 : : {
2789 : 13064 : g_return_if_fail (GNC_IS_ACCOUNT(acc));
2790 : :
2791 : 13064 : auto children = GET_PRIVATE(acc)->children;
2792 : 13064 : std::sort (children.begin(), children.end(),
2793 : 13288 : [](auto a, auto b) { return xaccAccountOrder (a, b) < 0; });
2794 : :
2795 : 23759 : for (auto child : children)
2796 : : {
2797 : 10695 : account_cb (child);
2798 : 10695 : account_foreach_descendant_sorted (child, account_cb);
2799 : : }
2800 : 13064 : }
2801 : :
2802 : : void
2803 : 4269 : gnc_account_append_child (Account *new_parent, Account *child)
2804 : : {
2805 : : AccountPrivate *ppriv, *cpriv;
2806 : : Account *old_parent;
2807 : : QofCollection *col;
2808 : :
2809 : : /* errors */
2810 : 4269 : g_assert(GNC_IS_ACCOUNT(new_parent));
2811 : 4269 : g_assert(GNC_IS_ACCOUNT(child));
2812 : :
2813 : : /* optimizations */
2814 : 4269 : ppriv = GET_PRIVATE(new_parent);
2815 : 4269 : cpriv = GET_PRIVATE(child);
2816 : 4269 : old_parent = cpriv->parent;
2817 : 4269 : if (old_parent == new_parent)
2818 : 385 : return;
2819 : :
2820 : : // xaccAccountBeginEdit(new_parent);
2821 : 3884 : xaccAccountBeginEdit(child);
2822 : 3884 : if (old_parent)
2823 : : {
2824 : 16 : gnc_account_remove_child(old_parent, child);
2825 : :
2826 : 16 : if (!qof_instance_books_equal(old_parent, new_parent))
2827 : : {
2828 : : /* hack alert -- this implementation is not exactly correct.
2829 : : * If the entity tables are not identical, then the 'from' book
2830 : : * may have a different backend than the 'to' book. This means
2831 : : * that we should get the 'from' backend to destroy this account,
2832 : : * and the 'to' backend to save it. Right now, this is broken.
2833 : : *
2834 : : * A 'correct' implementation similar to this is in Period.c
2835 : : * except its for transactions ...
2836 : : *
2837 : : * Note also, we need to reparent the children to the new book as well.
2838 : : */
2839 : 1 : PWARN ("reparenting accounts across books is not correctly supported\n");
2840 : :
2841 : 1 : qof_event_gen (&child->inst, QOF_EVENT_DESTROY, nullptr);
2842 : 1 : col = qof_book_get_collection (qof_instance_get_book(new_parent),
2843 : : GNC_ID_ACCOUNT);
2844 : 1 : qof_collection_insert_entity (col, &child->inst);
2845 : 1 : qof_event_gen (&child->inst, QOF_EVENT_CREATE, nullptr);
2846 : : }
2847 : : }
2848 : 3884 : cpriv->parent = new_parent;
2849 : 3884 : ppriv->children.push_back (child);
2850 : 3884 : qof_instance_set_dirty(&new_parent->inst);
2851 : 3884 : qof_instance_set_dirty(&child->inst);
2852 : :
2853 : : /* Send events data. Warning: The call to commit_edit is also going
2854 : : * to send a MODIFY event. If the gtktreemodelfilter code gets the
2855 : : * MODIFY before it gets the ADD, it gets very confused and thinks
2856 : : * that two nodes have been added. */
2857 : 3884 : qof_event_gen (&child->inst, QOF_EVENT_ADD, nullptr);
2858 : : // qof_event_gen (&new_parent->inst, QOF_EVENT_MODIFY, nullptr);
2859 : :
2860 : 3884 : xaccAccountCommitEdit (child);
2861 : : // xaccAccountCommitEdit(new_parent);
2862 : : }
2863 : :
2864 : : void
2865 : 1777 : gnc_account_remove_child (Account *parent, Account *child)
2866 : : {
2867 : : AccountPrivate *ppriv, *cpriv;
2868 : : GncEventData ed;
2869 : :
2870 : 1778 : if (!child) return;
2871 : :
2872 : : /* Note this routine might be called on accounts which
2873 : : * are not yet parented. */
2874 : 1777 : if (!parent) return;
2875 : :
2876 : 1777 : ppriv = GET_PRIVATE(parent);
2877 : 1777 : cpriv = GET_PRIVATE(child);
2878 : :
2879 : 1777 : if (cpriv->parent != parent)
2880 : : {
2881 : 1 : PERR ("account not a child of parent");
2882 : 1 : return;
2883 : : }
2884 : :
2885 : : /* Gather event data */
2886 : 1776 : ed.node = parent;
2887 : 1776 : ed.idx = gnc_account_child_index (parent, child);
2888 : :
2889 : 1776 : ppriv->children.erase (std::remove (ppriv->children.begin(), ppriv->children.end(), child),
2890 : 1776 : ppriv->children.end());
2891 : :
2892 : : /* Now send the event. */
2893 : 1776 : qof_event_gen(&child->inst, QOF_EVENT_REMOVE, &ed);
2894 : :
2895 : : /* clear the account's parent pointer after REMOVE event generation. */
2896 : 1776 : cpriv->parent = nullptr;
2897 : :
2898 : 1776 : qof_event_gen (&parent->inst, QOF_EVENT_MODIFY, nullptr);
2899 : : }
2900 : :
2901 : : Account *
2902 : 37426 : gnc_account_get_parent (const Account *acc)
2903 : : {
2904 : 37426 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
2905 : 37426 : return GET_PRIVATE(acc)->parent;
2906 : : }
2907 : :
2908 : : Account *
2909 : 1603 : gnc_account_get_root (Account *acc)
2910 : : {
2911 : 1603 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
2912 : :
2913 : 4093 : while (auto parent = gnc_account_get_parent (acc))
2914 : 2490 : acc = parent;
2915 : :
2916 : 1603 : return acc;
2917 : : }
2918 : :
2919 : : gboolean
2920 : 39689 : gnc_account_is_root (const Account *account)
2921 : : {
2922 : 39689 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), FALSE);
2923 : 39689 : return (GET_PRIVATE(account)->parent == nullptr);
2924 : : }
2925 : :
2926 : : GList *
2927 : 3018 : gnc_account_get_children (const Account *account)
2928 : : {
2929 : 3018 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), nullptr);
2930 : 3018 : auto& children = GET_PRIVATE(account)->children;
2931 : 6036 : return std::accumulate (children.rbegin(), children.rend(), static_cast<GList*>(nullptr),
2932 : 3018 : g_list_prepend);
2933 : : }
2934 : :
2935 : : GList *
2936 : 1442 : gnc_account_get_children_sorted (const Account *account)
2937 : : {
2938 : 1442 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), nullptr);
2939 : 1442 : return g_list_sort(gnc_account_get_children (account), (GCompareFunc)xaccAccountOrder);
2940 : : }
2941 : :
2942 : : gint
2943 : 0 : gnc_account_n_children (const Account *account)
2944 : : {
2945 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), 0);
2946 : 0 : return GET_PRIVATE(account)->children.size();
2947 : : }
2948 : :
2949 : : gint
2950 : 1779 : gnc_account_child_index (const Account *parent, const Account *child)
2951 : : {
2952 : 1779 : g_return_val_if_fail(GNC_IS_ACCOUNT(parent), -1);
2953 : 1779 : g_return_val_if_fail(GNC_IS_ACCOUNT(child), -1);
2954 : 1779 : auto& children = GET_PRIVATE(parent)->children;
2955 : 1779 : auto find_it = std::find (children.begin(), children.end(), child);
2956 : 3556 : return find_it == children.end() ? -1 : std::distance (children.begin(), find_it);
2957 : : }
2958 : :
2959 : : Account *
2960 : 0 : gnc_account_nth_child (const Account *parent, gint num)
2961 : : {
2962 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(parent), nullptr);
2963 : 0 : if ((size_t)num >= GET_PRIVATE(parent)->children.size())
2964 : 0 : return nullptr;
2965 : 0 : return static_cast<Account*>(GET_PRIVATE(parent)->children.at (num));
2966 : : }
2967 : :
2968 : : gint
2969 : 25 : gnc_account_n_descendants (const Account *account)
2970 : : {
2971 : 25 : int count {0};
2972 : 25 : gnc_account_foreach_descendant (account, [&count](auto acc){ count++; });
2973 : 25 : return count;
2974 : : }
2975 : :
2976 : : gint
2977 : 549 : gnc_account_get_current_depth (const Account *account)
2978 : : {
2979 : : AccountPrivate *priv;
2980 : 549 : int depth = 0;
2981 : :
2982 : 549 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), 0);
2983 : :
2984 : 549 : priv = GET_PRIVATE(account);
2985 : 2263 : while (priv->parent && (priv->type != ACCT_TYPE_ROOT))
2986 : : {
2987 : 1714 : account = priv->parent;
2988 : 1714 : priv = GET_PRIVATE(account);
2989 : 1714 : depth++;
2990 : : }
2991 : :
2992 : 549 : return depth;
2993 : : }
2994 : :
2995 : : gint
2996 : 644 : gnc_account_get_tree_depth (const Account *account)
2997 : : {
2998 : : AccountPrivate *priv;
2999 : 644 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), 0);
3000 : :
3001 : 644 : priv = GET_PRIVATE(account);
3002 : 644 : if (!priv->children.size())
3003 : 412 : return 1;
3004 : :
3005 : 232 : return 1 + std::accumulate (priv->children.begin(), priv->children.end(),
3006 : 556 : 0, [](auto a, auto b)
3007 : 788 : { return std::max (a, gnc_account_get_tree_depth (b)); });
3008 : : }
3009 : :
3010 : : GList *
3011 : 755 : gnc_account_get_descendants (const Account *account)
3012 : : {
3013 : 755 : GList* list = nullptr;
3014 : 12679 : gnc_account_foreach_descendant (account, [&list](auto a){ list = g_list_prepend (list, a); });
3015 : 1510 : return g_list_reverse (list);
3016 : : }
3017 : :
3018 : : GList *
3019 : 2369 : gnc_account_get_descendants_sorted (const Account *account)
3020 : : {
3021 : 2369 : GList* list = nullptr;
3022 : 13064 : account_foreach_descendant_sorted (account, [&list](auto a){ list = g_list_prepend (list, a); });
3023 : 4738 : return g_list_reverse (list);
3024 : : }
3025 : :
3026 : : // because gnc_account_lookup_by_name and gnc_account_lookup_by_code
3027 : : // are described in Account.h searching breadth-first until 4.6, and
3028 : : // accidentally modified to search depth-first from 4.7
3029 : : // onwards. Restore breath-first searching in 4.11 onwards to match
3030 : : // previous behaviour and function description in Account.h
3031 : : static gpointer
3032 : 3925 : account_foreach_descendant_breadthfirst_until (const Account *acc,
3033 : : AccountCb2 thunk,
3034 : : gpointer user_data)
3035 : : {
3036 : 3925 : g_return_val_if_fail (GNC_IS_ACCOUNT(acc), nullptr);
3037 : 3925 : g_return_val_if_fail (thunk, nullptr);
3038 : :
3039 : 3925 : auto& children{GET_PRIVATE(acc)->children};
3040 : :
3041 : 8043 : for (auto acc : children)
3042 : 4386 : if (auto result = thunk (acc, user_data))
3043 : 268 : return result;
3044 : :
3045 : 6875 : for (auto acc: children)
3046 : 3652 : if (auto result = account_foreach_descendant_breadthfirst_until (acc, thunk, user_data))
3047 : 434 : return result;
3048 : :
3049 : 3223 : return nullptr;
3050 : : }
3051 : :
3052 : : static gpointer
3053 : 4355 : is_acct_name (Account *account, gpointer user_data)
3054 : : {
3055 : 4355 : auto name {static_cast<gchar*>(user_data)};
3056 : 4355 : return (g_strcmp0 (name, xaccAccountGetName (account)) ? nullptr : account);
3057 : : }
3058 : :
3059 : : Account *
3060 : 265 : gnc_account_lookup_by_name (const Account *parent, const char * name)
3061 : : {
3062 : 265 : return (Account*)account_foreach_descendant_breadthfirst_until (parent, is_acct_name, (char*)name);
3063 : : }
3064 : :
3065 : : static gpointer
3066 : 31 : is_acct_code (Account *account, gpointer user_data)
3067 : : {
3068 : 31 : auto name {static_cast<gchar*>(user_data)};
3069 : 31 : return (g_strcmp0 (name, xaccAccountGetCode (account)) ? nullptr : account);
3070 : : }
3071 : :
3072 : : Account *
3073 : 8 : gnc_account_lookup_by_code (const Account *parent, const char * code)
3074 : : {
3075 : 8 : return (Account*)account_foreach_descendant_breadthfirst_until (parent, is_acct_code, (char*)code);
3076 : : }
3077 : :
3078 : : static gpointer
3079 : 0 : is_opening_balance_account (Account* account, gpointer data)
3080 : : {
3081 : 0 : gnc_commodity* commodity = GNC_COMMODITY(data);
3082 : 0 : if (xaccAccountGetIsOpeningBalance(account) && gnc_commodity_equiv(commodity, xaccAccountGetCommodity(account)))
3083 : 0 : return account;
3084 : 0 : return nullptr;
3085 : : }
3086 : :
3087 : : Account*
3088 : 0 : gnc_account_lookup_by_opening_balance (Account* account, gnc_commodity* commodity)
3089 : : {
3090 : 0 : return (Account *)gnc_account_foreach_descendant_until (account, is_opening_balance_account, commodity);
3091 : : }
3092 : :
3093 : : /********************************************************************\
3094 : : * Fetch an account, given its full name *
3095 : : \********************************************************************/
3096 : :
3097 : : static Account *
3098 : 43 : gnc_account_lookup_by_full_name_helper (const Account *parent,
3099 : : gchar **names)
3100 : : {
3101 : 43 : g_return_val_if_fail(GNC_IS_ACCOUNT(parent), nullptr);
3102 : 43 : g_return_val_if_fail(names, nullptr);
3103 : :
3104 : : /* Look for the first name in the children. */
3105 : 117 : for (auto account : GET_PRIVATE(parent)->children)
3106 : : {
3107 : 104 : auto priv = GET_PRIVATE(account);
3108 : 104 : if (g_strcmp0(priv->accountName, names[0]) == 0)
3109 : : {
3110 : : /* We found an account. If the next entry is nullptr, there is
3111 : : * nothing left in the name, so just return the account. */
3112 : 35 : if (names[1] == nullptr)
3113 : 30 : return account;
3114 : :
3115 : : /* No children? We're done. */
3116 : 22 : if (priv->children.empty())
3117 : 0 : return nullptr;
3118 : :
3119 : : /* There's stuff left to search for. Search recursively. */
3120 : 22 : if (auto found = gnc_account_lookup_by_full_name_helper(account, &names[1]))
3121 : 17 : return found;
3122 : : }
3123 : : }
3124 : :
3125 : 13 : return nullptr;
3126 : : }
3127 : :
3128 : :
3129 : : Account *
3130 : 18 : gnc_account_lookup_by_full_name (const Account *any_acc,
3131 : : const gchar *name)
3132 : : {
3133 : : const AccountPrivate *rpriv;
3134 : : const Account *root;
3135 : : Account *found;
3136 : : gchar **names;
3137 : :
3138 : 18 : g_return_val_if_fail(GNC_IS_ACCOUNT(any_acc), nullptr);
3139 : 18 : g_return_val_if_fail(name, nullptr);
3140 : :
3141 : 18 : root = any_acc;
3142 : 18 : rpriv = GET_PRIVATE(root);
3143 : 30 : while (rpriv->parent)
3144 : : {
3145 : 12 : root = rpriv->parent;
3146 : 12 : rpriv = GET_PRIVATE(root);
3147 : : }
3148 : 18 : names = g_strsplit(name, gnc_get_account_separator_string(), -1);
3149 : 18 : found = gnc_account_lookup_by_full_name_helper(root, names);
3150 : 18 : g_strfreev(names);
3151 : 18 : return found;
3152 : : }
3153 : :
3154 : : GList*
3155 : 143 : gnc_account_lookup_by_type_and_commodity (Account* root,
3156 : : const char* name,
3157 : : GNCAccountType acctype,
3158 : : gnc_commodity* commodity)
3159 : : {
3160 : 143 : GList *retval{};
3161 : 143 : auto rpriv{GET_PRIVATE(root)};
3162 : 224 : for (auto account : rpriv->children)
3163 : : {
3164 : 81 : if (xaccAccountGetType (account) == acctype)
3165 : : {
3166 : 96 : if (commodity &&
3167 : 48 : !gnc_commodity_equiv(xaccAccountGetCommodity (account),
3168 : : commodity))
3169 : 10 : continue;
3170 : :
3171 : 38 : if (name && strcmp(name, xaccAccountGetName(account)))
3172 : 22 : continue;
3173 : :
3174 : 16 : retval = g_list_prepend(retval, account);
3175 : : }
3176 : : }
3177 : :
3178 : 143 : if (!retval) // Recurse through the children
3179 : 175 : for (auto account : rpriv->children)
3180 : : {
3181 : 48 : auto result = gnc_account_lookup_by_type_and_commodity(account,
3182 : : name,
3183 : : acctype,
3184 : : commodity);
3185 : 48 : if (result)
3186 : 0 : retval = g_list_concat(result, retval);
3187 : : }
3188 : 143 : return retval;
3189 : : }
3190 : :
3191 : : void
3192 : 150 : gnc_account_foreach_child (const Account *acc,
3193 : : AccountCb thunk,
3194 : : gpointer user_data)
3195 : : {
3196 : 150 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
3197 : 150 : g_return_if_fail(thunk);
3198 : 150 : std::for_each (GET_PRIVATE(acc)->children.begin(), GET_PRIVATE(acc)->children.end(),
3199 : 53 : [user_data, thunk](auto a){ thunk (a, user_data); });
3200 : : }
3201 : :
3202 : : void
3203 : 707 : gnc_account_foreach_descendant (const Account *acc,
3204 : : AccountCb thunk,
3205 : : gpointer user_data)
3206 : : {
3207 : 3547 : gnc_account_foreach_descendant (acc, [&](auto acc){ thunk (acc, user_data); });
3208 : 707 : }
3209 : :
3210 : : gpointer
3211 : 91 : gnc_account_foreach_descendant_until (const Account *acc,
3212 : : AccountCb2 thunk,
3213 : : gpointer user_data)
3214 : : {
3215 : 91 : gpointer result {nullptr};
3216 : :
3217 : 91 : g_return_val_if_fail (GNC_IS_ACCOUNT(acc), nullptr);
3218 : 91 : g_return_val_if_fail (thunk, nullptr);
3219 : :
3220 : 156 : for (auto child : GET_PRIVATE(acc)->children)
3221 : : {
3222 : 87 : result = thunk (child, user_data);
3223 : 87 : if (result) break;
3224 : :
3225 : 80 : result = gnc_account_foreach_descendant_until (child, thunk, user_data);
3226 : 80 : if (result) break;
3227 : : }
3228 : :
3229 : 91 : return result;
3230 : : }
3231 : :
3232 : :
3233 : : GNCAccountType
3234 : 16141 : xaccAccountGetType (const Account *acc)
3235 : : {
3236 : 16141 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), ACCT_TYPE_NONE);
3237 : 16141 : return GET_PRIVATE(acc)->type;
3238 : : }
3239 : :
3240 : : static const char*
3241 : 36 : qofAccountGetTypeString (const Account *acc)
3242 : : {
3243 : 36 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3244 : 36 : return xaccAccountTypeEnumAsString(GET_PRIVATE(acc)->type);
3245 : : }
3246 : :
3247 : : static void
3248 : 34 : qofAccountSetType (Account *acc, const char *type_string)
3249 : : {
3250 : 34 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
3251 : 34 : g_return_if_fail(type_string);
3252 : 34 : xaccAccountSetType(acc, xaccAccountStringToEnum(type_string));
3253 : : }
3254 : :
3255 : : const char *
3256 : 73507 : xaccAccountGetName (const Account *acc)
3257 : : {
3258 : 73507 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3259 : 73507 : return GET_PRIVATE(acc)->accountName;
3260 : : }
3261 : :
3262 : : std::vector<const Account*>
3263 : 10592 : gnc_account_get_all_parents (const Account *account)
3264 : : {
3265 : 10592 : std::vector<const Account*> rv;
3266 : 39442 : for (auto a = account; !gnc_account_is_root (a); a = gnc_account_get_parent (a))
3267 : 28850 : rv.push_back (a);
3268 : 10592 : return rv;
3269 : 0 : }
3270 : :
3271 : : gchar *
3272 : 10411 : gnc_account_get_full_name(const Account *account)
3273 : : {
3274 : : /* So much for hardening the API. Too many callers to this function don't
3275 : : * bother to check if they have a non-nullptr pointer before calling. */
3276 : 10411 : if (nullptr == account)
3277 : 1 : return g_strdup("");
3278 : :
3279 : : /* errors */
3280 : 10410 : g_return_val_if_fail(GNC_IS_ACCOUNT(account), g_strdup(""));
3281 : :
3282 : 10410 : auto path{gnc_account_get_all_parents (account)};
3283 : 10410 : auto seps_size{path.empty() ? 0 : strlen (account_separator) * (path.size() - 1)};
3284 : 10410 : auto alloc_size{std::accumulate (path.begin(), path.end(), seps_size,
3285 : 28435 : [](auto sum, auto acc)
3286 : 28435 : { return sum + strlen (xaccAccountGetName (acc)); })};
3287 : 10410 : auto rv = g_new (char, alloc_size + 1);
3288 : 10410 : auto p = rv;
3289 : :
3290 : 10410 : std::for_each (path.rbegin(), path.rend(),
3291 : 28435 : [&p, rv](auto a)
3292 : : {
3293 : 28435 : if (p != rv)
3294 : 18027 : p = stpcpy (p, account_separator);
3295 : 28435 : p = stpcpy (p, xaccAccountGetName (a));
3296 : 28435 : });
3297 : 10410 : *p = '\0';
3298 : :
3299 : 10410 : return rv;
3300 : 10410 : }
3301 : :
3302 : : const char *
3303 : 1982 : xaccAccountGetCode (const Account *acc)
3304 : : {
3305 : 1982 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3306 : 1982 : return GET_PRIVATE(acc)->accountCode;
3307 : : }
3308 : :
3309 : : const char *
3310 : 1699 : xaccAccountGetDescription (const Account *acc)
3311 : : {
3312 : 1699 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3313 : 1699 : return GET_PRIVATE(acc)->description;
3314 : : }
3315 : :
3316 : : const char *
3317 : 8 : xaccAccountGetColor (const Account *acc)
3318 : : {
3319 : 24 : return get_kvp_string_path (acc, {"color"});
3320 : : }
3321 : :
3322 : : const char *
3323 : 6 : xaccAccountGetFilter (const Account *acc)
3324 : : {
3325 : 18 : return get_kvp_string_path (acc, {"filter"});
3326 : : }
3327 : :
3328 : : const char *
3329 : 6 : xaccAccountGetSortOrder (const Account *acc)
3330 : : {
3331 : 18 : return get_kvp_string_path (acc, {"sort-order"});
3332 : : }
3333 : :
3334 : : gboolean
3335 : 3 : xaccAccountGetSortReversed (const Account *acc)
3336 : : {
3337 : 9 : return get_kvp_boolean_path (acc, {"sort-reversed"});
3338 : : }
3339 : :
3340 : : const char *
3341 : 1339 : xaccAccountGetNotes (const Account *acc)
3342 : : {
3343 : 4017 : return get_kvp_string_path (acc, {"notes"});
3344 : : }
3345 : :
3346 : : Account*
3347 : 3 : xaccAccountGetAssociatedAccount (const Account *acc, const char *tag)
3348 : : {
3349 : 3 : g_return_val_if_fail (tag && *tag, nullptr);
3350 : :
3351 : 12 : return get_kvp_account_path (acc, {"associated-account", tag});
3352 : 9 : }
3353 : :
3354 : :
3355 : : gnc_commodity *
3356 : 1363 : DxaccAccountGetCurrency (const Account *acc)
3357 : : {
3358 : 4089 : if (auto s = get_kvp_string_path (acc, {"old-currency"}))
3359 : : {
3360 : 0 : auto table = gnc_commodity_table_get_table (qof_instance_get_book(acc));
3361 : 0 : return gnc_commodity_table_lookup_unique (table, s);
3362 : : }
3363 : :
3364 : 1363 : return nullptr;
3365 : : }
3366 : :
3367 : : gnc_commodity *
3368 : 84157 : xaccAccountGetCommodity (const Account *acc)
3369 : : {
3370 : 84157 : if (!GNC_IS_ACCOUNT(acc))
3371 : 0 : return nullptr;
3372 : 84157 : return GET_PRIVATE(acc)->commodity;
3373 : : }
3374 : :
3375 : 426 : gnc_commodity * gnc_account_get_currency_or_parent(const Account* account)
3376 : : {
3377 : 426 : g_return_val_if_fail (GNC_IS_ACCOUNT (account), nullptr);
3378 : :
3379 : 855 : for (auto acc = account; acc; acc = gnc_account_get_parent (acc))
3380 : 852 : if (auto comm = xaccAccountGetCommodity (acc); gnc_commodity_is_currency (comm))
3381 : 423 : return comm;
3382 : :
3383 : 3 : return nullptr; // no suitable commodity found.
3384 : : }
3385 : :
3386 : : /********************************************************************\
3387 : : \********************************************************************/
3388 : : void
3389 : 1 : gnc_account_set_start_balance (Account *acc, const gnc_numeric start_baln)
3390 : : {
3391 : : AccountPrivate *priv;
3392 : :
3393 : 1 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
3394 : :
3395 : 1 : priv = GET_PRIVATE(acc);
3396 : 1 : priv->starting_balance = start_baln;
3397 : 1 : priv->balance_dirty = TRUE;
3398 : : }
3399 : :
3400 : : void
3401 : 0 : gnc_account_set_start_cleared_balance (Account *acc,
3402 : : const gnc_numeric start_baln)
3403 : : {
3404 : : AccountPrivate *priv;
3405 : :
3406 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
3407 : :
3408 : 0 : priv = GET_PRIVATE(acc);
3409 : 0 : priv->starting_cleared_balance = start_baln;
3410 : 0 : priv->balance_dirty = TRUE;
3411 : : }
3412 : :
3413 : : void
3414 : 0 : gnc_account_set_start_reconciled_balance (Account *acc,
3415 : : const gnc_numeric start_baln)
3416 : : {
3417 : : AccountPrivate *priv;
3418 : :
3419 : 0 : g_return_if_fail(GNC_IS_ACCOUNT(acc));
3420 : :
3421 : 0 : priv = GET_PRIVATE(acc);
3422 : 0 : priv->starting_reconciled_balance = start_baln;
3423 : 0 : priv->balance_dirty = TRUE;
3424 : : }
3425 : :
3426 : : gnc_numeric
3427 : 66 : xaccAccountGetBalance (const Account *acc)
3428 : : {
3429 : 66 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3430 : 66 : return GET_PRIVATE(acc)->balance;
3431 : : }
3432 : :
3433 : : gnc_numeric
3434 : 38 : xaccAccountGetClearedBalance (const Account *acc)
3435 : : {
3436 : 38 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3437 : 38 : return GET_PRIVATE(acc)->cleared_balance;
3438 : : }
3439 : :
3440 : : gnc_numeric
3441 : 20 : xaccAccountGetReconciledBalance (const Account *acc)
3442 : : {
3443 : 20 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3444 : 20 : return GET_PRIVATE(acc)->reconciled_balance;
3445 : : }
3446 : :
3447 : : gnc_numeric
3448 : 2 : xaccAccountGetProjectedMinimumBalance (const Account *acc)
3449 : : {
3450 : 2 : auto today{gnc_time64_get_today_end()};
3451 : 2 : std::optional<gnc_numeric> minimum;
3452 : :
3453 : 6 : auto before_today_end = [&minimum, today](const Split *s) -> bool
3454 : : {
3455 : 6 : auto bal{xaccSplitGetBalance(s)};
3456 : 6 : if (!minimum || gnc_numeric_compare (bal, *minimum) < 0)
3457 : 3 : minimum = bal;
3458 : 12 : return (xaccTransGetDate(xaccSplitGetParent(s)) < today);
3459 : 2 : };
3460 : : // scan to find today's split, but we're really interested in the
3461 : : // minimum balance
3462 : 2 : [[maybe_unused]] auto todays_split = gnc_account_find_split (acc, before_today_end, true);
3463 : 4 : return minimum ? *minimum : gnc_numeric_zero();
3464 : : }
3465 : :
3466 : :
3467 : : /********************************************************************\
3468 : : \********************************************************************/
3469 : :
3470 : : static gnc_numeric
3471 : 2929 : GetBalanceAsOfDate (Account *acc, time64 date, std::function<gnc_numeric(Split*)> split_to_numeric)
3472 : : {
3473 : 2929 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3474 : :
3475 : 2929 : xaccAccountSortSplits (acc, TRUE); /* just in case, normally a noop */
3476 : 2929 : xaccAccountRecomputeBalance (acc); /* just in case, normally a noop */
3477 : :
3478 : 4197 : auto is_before_date = [date](auto s) -> bool
3479 : 4197 : { return xaccTransGetDate(xaccSplitGetParent(s)) < date; };
3480 : :
3481 : 2929 : auto latest_split{gnc_account_find_split (acc, is_before_date, true)};
3482 : 2929 : return latest_split ? split_to_numeric (latest_split) : gnc_numeric_zero();
3483 : : }
3484 : :
3485 : : gnc_numeric
3486 : 367 : xaccAccountGetBalanceAsOfDate (Account *acc, time64 date)
3487 : : {
3488 : 367 : return GetBalanceAsOfDate (acc, date, xaccSplitGetBalance);
3489 : : }
3490 : :
3491 : : static gnc_numeric
3492 : 0 : xaccAccountGetNoclosingBalanceAsOfDate (Account *acc, time64 date)
3493 : : {
3494 : 0 : return GetBalanceAsOfDate (acc, date, xaccSplitGetNoclosingBalance);
3495 : : }
3496 : :
3497 : : gnc_numeric
3498 : 0 : xaccAccountGetReconciledBalanceAsOfDate (Account *acc, time64 date)
3499 : : {
3500 : 0 : return GetBalanceAsOfDate (acc, date, xaccSplitGetReconciledBalance);
3501 : : }
3502 : :
3503 : : /*
3504 : : * Originally gsr_account_present_balance in gnc-split-reg.c
3505 : : */
3506 : : gnc_numeric
3507 : 1 : xaccAccountGetPresentBalance (const Account *acc)
3508 : : {
3509 : 1 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3510 : :
3511 : 1 : return xaccAccountGetBalanceAsOfDate (GNC_ACCOUNT (acc),
3512 : 1 : gnc_time64_get_today_end ());
3513 : : }
3514 : :
3515 : :
3516 : : /********************************************************************\
3517 : : \********************************************************************/
3518 : : /* XXX TODO: These 'GetBal' routines should be moved to some
3519 : : * utility area outside of the core account engine area.
3520 : : */
3521 : :
3522 : : /*
3523 : : * Convert a balance from one currency to another.
3524 : : */
3525 : : gnc_numeric
3526 : 0 : xaccAccountConvertBalanceToCurrency(const Account *acc, /* for book */
3527 : : gnc_numeric balance,
3528 : : const gnc_commodity *balance_currency,
3529 : : const gnc_commodity *new_currency)
3530 : : {
3531 : : QofBook *book;
3532 : : GNCPriceDB *pdb;
3533 : :
3534 : 0 : if (gnc_numeric_zero_p (balance) ||
3535 : 0 : gnc_commodity_equiv (balance_currency, new_currency))
3536 : 0 : return balance;
3537 : :
3538 : 0 : book = gnc_account_get_book (acc);
3539 : 0 : pdb = gnc_pricedb_get_db (book);
3540 : :
3541 : 0 : balance = gnc_pricedb_convert_balance_latest_price(
3542 : : pdb, balance, balance_currency, new_currency);
3543 : :
3544 : 0 : return balance;
3545 : : }
3546 : :
3547 : : /*
3548 : : * Convert a balance from one currency to another with price of
3549 : : * a given date.
3550 : : */
3551 : : gnc_numeric
3552 : 732 : xaccAccountConvertBalanceToCurrencyAsOfDate(const Account *acc, /* for book */
3553 : : gnc_numeric balance,
3554 : : const gnc_commodity *balance_currency,
3555 : : const gnc_commodity *new_currency,
3556 : : time64 date)
3557 : : {
3558 : : QofBook *book;
3559 : : GNCPriceDB *pdb;
3560 : :
3561 : 884 : if (gnc_numeric_zero_p (balance) ||
3562 : 152 : gnc_commodity_equiv (balance_currency, new_currency))
3563 : 732 : return balance;
3564 : :
3565 : 0 : book = gnc_account_get_book (acc);
3566 : 0 : pdb = gnc_pricedb_get_db (book);
3567 : :
3568 : 0 : balance = gnc_pricedb_convert_balance_nearest_before_price_t64 (
3569 : : pdb, balance, balance_currency, new_currency, date);
3570 : :
3571 : 0 : return balance;
3572 : : }
3573 : :
3574 : : /*
3575 : : * Given an account and a GetBalanceFn pointer, extract the requested
3576 : : * balance from the account and then convert it to the desired
3577 : : * currency.
3578 : : */
3579 : : static gnc_numeric
3580 : 0 : xaccAccountGetXxxBalanceInCurrency (const Account *acc,
3581 : : xaccGetBalanceFn fn,
3582 : : const gnc_commodity *report_currency)
3583 : : {
3584 : : AccountPrivate *priv;
3585 : : gnc_numeric balance;
3586 : :
3587 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3588 : 0 : g_return_val_if_fail(fn, gnc_numeric_zero());
3589 : 0 : g_return_val_if_fail(GNC_IS_COMMODITY(report_currency), gnc_numeric_zero());
3590 : :
3591 : 0 : priv = GET_PRIVATE(acc);
3592 : 0 : balance = fn(acc);
3593 : 0 : balance = xaccAccountConvertBalanceToCurrency(acc, balance,
3594 : 0 : priv->commodity,
3595 : : report_currency);
3596 : 0 : return balance;
3597 : : }
3598 : :
3599 : : static gnc_numeric
3600 : 0 : xaccAccountGetXxxBalanceAsOfDateInCurrency(Account *acc, time64 date,
3601 : : xaccGetBalanceAsOfDateFn fn,
3602 : : const gnc_commodity *report_commodity)
3603 : : {
3604 : : AccountPrivate *priv;
3605 : :
3606 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), gnc_numeric_zero());
3607 : 0 : g_return_val_if_fail(fn, gnc_numeric_zero());
3608 : 0 : g_return_val_if_fail(GNC_IS_COMMODITY(report_commodity), gnc_numeric_zero());
3609 : :
3610 : 0 : priv = GET_PRIVATE(acc);
3611 : 0 : return xaccAccountConvertBalanceToCurrencyAsOfDate(
3612 : 0 : acc, fn(acc, date), priv->commodity, report_commodity, date);
3613 : : }
3614 : :
3615 : : /*
3616 : : * Data structure used to pass various arguments into the following fn.
3617 : : */
3618 : : typedef struct
3619 : : {
3620 : : const gnc_commodity *currency;
3621 : : gnc_numeric balance;
3622 : : xaccGetBalanceFn fn;
3623 : : xaccGetBalanceAsOfDateFn asOfDateFn;
3624 : : time64 date;
3625 : : } CurrencyBalance;
3626 : :
3627 : :
3628 : : /*
3629 : : * A helper function for iterating over all the accounts in a list or
3630 : : * tree. This function is called once per account, and sums up the
3631 : : * values of all these accounts.
3632 : : */
3633 : : static void
3634 : 0 : xaccAccountBalanceHelper (Account *acc, gpointer data)
3635 : : {
3636 : 0 : CurrencyBalance *cb = static_cast<CurrencyBalance*>(data);
3637 : : gnc_numeric balance;
3638 : :
3639 : 0 : if (!cb->fn || !cb->currency)
3640 : 0 : return;
3641 : 0 : balance = xaccAccountGetXxxBalanceInCurrency (acc, cb->fn, cb->currency);
3642 : 0 : cb->balance = gnc_numeric_add (cb->balance, balance,
3643 : 0 : gnc_commodity_get_fraction (cb->currency),
3644 : : GNC_HOW_RND_ROUND_HALF_UP);
3645 : : }
3646 : :
3647 : : static void
3648 : 0 : xaccAccountBalanceAsOfDateHelper (Account *acc, gpointer data)
3649 : : {
3650 : 0 : CurrencyBalance *cb = static_cast<CurrencyBalance*>(data);
3651 : : gnc_numeric balance;
3652 : :
3653 : 0 : g_return_if_fail (cb->asOfDateFn && cb->currency);
3654 : :
3655 : 0 : balance = xaccAccountGetXxxBalanceAsOfDateInCurrency (
3656 : : acc, cb->date, cb->asOfDateFn, cb->currency);
3657 : 0 : cb->balance = gnc_numeric_add (cb->balance, balance,
3658 : 0 : gnc_commodity_get_fraction (cb->currency),
3659 : : GNC_HOW_RND_ROUND_HALF_UP);
3660 : : }
3661 : :
3662 : :
3663 : :
3664 : : /*
3665 : : * Common function that iterates recursively over all accounts below
3666 : : * the specified account. It uses xaccAccountBalanceHelper to sum up
3667 : : * the balances of all its children, and uses the specified function
3668 : : * 'fn' for extracting the balance. This function may extract the
3669 : : * current value, the reconciled value, etc.
3670 : : *
3671 : : * If 'report_commodity' is nullptr, just use the account's commodity.
3672 : : * If 'include_children' is FALSE, this function doesn't recurse at all.
3673 : : */
3674 : : static gnc_numeric
3675 : 0 : xaccAccountGetXxxBalanceInCurrencyRecursive (const Account *acc,
3676 : : xaccGetBalanceFn fn,
3677 : : const gnc_commodity *report_commodity,
3678 : : gboolean include_children)
3679 : : {
3680 : : gnc_numeric balance;
3681 : :
3682 : 0 : if (!acc) return gnc_numeric_zero ();
3683 : 0 : if (!report_commodity)
3684 : 0 : report_commodity = xaccAccountGetCommodity (acc);
3685 : 0 : if (!report_commodity)
3686 : 0 : return gnc_numeric_zero();
3687 : :
3688 : 0 : balance = xaccAccountGetXxxBalanceInCurrency (acc, fn, report_commodity);
3689 : :
3690 : : /* If needed, sum up the children converting to the *requested*
3691 : : commodity. */
3692 : 0 : if (include_children)
3693 : : {
3694 : : #ifdef _MSC_VER
3695 : : /* MSVC compiler: Somehow, the struct initialization containing a
3696 : : gnc_numeric doesn't work. As an exception, we hand-initialize
3697 : : that member afterwards. */
3698 : : CurrencyBalance cb = { report_commodity, { 0 }, fn, nullptr, 0 };
3699 : : cb.balance = balance;
3700 : : #else
3701 : 0 : CurrencyBalance cb = { report_commodity, balance, fn, nullptr, 0 };
3702 : : #endif
3703 : :
3704 : 0 : gnc_account_foreach_descendant (acc, xaccAccountBalanceHelper, &cb);
3705 : 0 : balance = cb.balance;
3706 : : }
3707 : :
3708 : 0 : return balance;
3709 : : }
3710 : :
3711 : : static gnc_numeric
3712 : 0 : xaccAccountGetXxxBalanceAsOfDateInCurrencyRecursive (
3713 : : Account *acc, time64 date, xaccGetBalanceAsOfDateFn fn,
3714 : : const gnc_commodity *report_commodity, gboolean include_children)
3715 : : {
3716 : : gnc_numeric balance;
3717 : :
3718 : 0 : g_return_val_if_fail(acc, gnc_numeric_zero());
3719 : 0 : if (!report_commodity)
3720 : 0 : report_commodity = xaccAccountGetCommodity (acc);
3721 : 0 : if (!report_commodity)
3722 : 0 : return gnc_numeric_zero();
3723 : :
3724 : 0 : balance = xaccAccountGetXxxBalanceAsOfDateInCurrency(
3725 : : acc, date, fn, report_commodity);
3726 : :
3727 : : /* If needed, sum up the children converting to the *requested*
3728 : : commodity. */
3729 : 0 : if (include_children)
3730 : : {
3731 : : #ifdef _MSC_VER
3732 : : /* MSVC compiler: Somehow, the struct initialization containing a
3733 : : gnc_numeric doesn't work. As an exception, we hand-initialize
3734 : : that member afterwards. */
3735 : : CurrencyBalance cb = { report_commodity, 0, nullptr, fn, date };
3736 : : cb.balance = balance;
3737 : : #else
3738 : 0 : CurrencyBalance cb = { report_commodity, balance, nullptr, fn, date };
3739 : : #endif
3740 : :
3741 : 0 : gnc_account_foreach_descendant (acc, xaccAccountBalanceAsOfDateHelper, &cb);
3742 : 0 : balance = cb.balance;
3743 : : }
3744 : :
3745 : 0 : return balance;
3746 : : }
3747 : :
3748 : : gnc_numeric
3749 : 0 : xaccAccountGetBalanceInCurrency (const Account *acc,
3750 : : const gnc_commodity *report_commodity,
3751 : : gboolean include_children)
3752 : : {
3753 : : gnc_numeric rc;
3754 : 0 : rc = xaccAccountGetXxxBalanceInCurrencyRecursive (
3755 : : acc, xaccAccountGetBalance, report_commodity, include_children);
3756 : 0 : PINFO(" baln=%" G_GINT64_FORMAT "/%" G_GINT64_FORMAT, rc.num, rc.denom);
3757 : 0 : return rc;
3758 : : }
3759 : :
3760 : :
3761 : : gnc_numeric
3762 : 0 : xaccAccountGetClearedBalanceInCurrency (const Account *acc,
3763 : : const gnc_commodity *report_commodity,
3764 : : gboolean include_children)
3765 : : {
3766 : 0 : return xaccAccountGetXxxBalanceInCurrencyRecursive (
3767 : : acc, xaccAccountGetClearedBalance, report_commodity,
3768 : 0 : include_children);
3769 : : }
3770 : :
3771 : : gnc_numeric
3772 : 0 : xaccAccountGetReconciledBalanceInCurrency (const Account *acc,
3773 : : const gnc_commodity *report_commodity,
3774 : : gboolean include_children)
3775 : : {
3776 : 0 : return xaccAccountGetXxxBalanceInCurrencyRecursive (
3777 : : acc, xaccAccountGetReconciledBalance, report_commodity,
3778 : 0 : include_children);
3779 : : }
3780 : :
3781 : : gnc_numeric
3782 : 0 : xaccAccountGetPresentBalanceInCurrency (const Account *acc,
3783 : : const gnc_commodity *report_commodity,
3784 : : gboolean include_children)
3785 : : {
3786 : 0 : return xaccAccountGetXxxBalanceAsOfDateInCurrencyRecursive (
3787 : : (Account*)acc, gnc_time64_get_today_end (), xaccAccountGetBalanceAsOfDate,
3788 : : report_commodity,
3789 : 0 : include_children);
3790 : : }
3791 : :
3792 : : gnc_numeric
3793 : 0 : xaccAccountGetProjectedMinimumBalanceInCurrency (
3794 : : const Account *acc,
3795 : : const gnc_commodity *report_commodity,
3796 : : gboolean include_children)
3797 : : {
3798 : 0 : return xaccAccountGetXxxBalanceInCurrencyRecursive (
3799 : : acc, xaccAccountGetProjectedMinimumBalance, report_commodity,
3800 : 0 : include_children);
3801 : : }
3802 : :
3803 : : gnc_numeric
3804 : 0 : xaccAccountGetBalanceAsOfDateInCurrency(
3805 : : Account *acc, time64 date, gnc_commodity *report_commodity,
3806 : : gboolean include_children)
3807 : : {
3808 : 0 : return xaccAccountGetXxxBalanceAsOfDateInCurrencyRecursive (
3809 : : acc, date, xaccAccountGetBalanceAsOfDate, report_commodity,
3810 : 0 : include_children);
3811 : : }
3812 : :
3813 : : gnc_numeric
3814 : 0 : xaccAccountGetNoclosingBalanceAsOfDateInCurrency(
3815 : : Account *acc, time64 date, gnc_commodity *report_commodity,
3816 : : gboolean include_children)
3817 : : {
3818 : : return xaccAccountGetXxxBalanceAsOfDateInCurrencyRecursive
3819 : 0 : (acc, date, xaccAccountGetNoclosingBalanceAsOfDate,
3820 : 0 : report_commodity, include_children);
3821 : : }
3822 : :
3823 : : gnc_numeric
3824 : 0 : xaccAccountGetBalanceChangeForPeriod (Account *acc, time64 t1, time64 t2,
3825 : : gboolean recurse)
3826 : : {
3827 : : gnc_numeric b1, b2;
3828 : :
3829 : 0 : b1 = xaccAccountGetBalanceAsOfDateInCurrency(acc, t1, nullptr, recurse);
3830 : 0 : b2 = xaccAccountGetBalanceAsOfDateInCurrency(acc, t2, nullptr, recurse);
3831 : 0 : return gnc_numeric_sub(b2, b1, GNC_DENOM_AUTO, GNC_HOW_DENOM_FIXED);
3832 : : }
3833 : :
3834 : : gnc_numeric
3835 : 0 : xaccAccountGetNoclosingBalanceChangeForPeriod (Account *acc, time64 t1,
3836 : : time64 t2, gboolean recurse)
3837 : : {
3838 : : gnc_numeric b1, b2;
3839 : :
3840 : 0 : b1 = xaccAccountGetNoclosingBalanceAsOfDateInCurrency(acc, t1, nullptr, recurse);
3841 : 0 : b2 = xaccAccountGetNoclosingBalanceAsOfDateInCurrency(acc, t2, nullptr, recurse);
3842 : 0 : return gnc_numeric_sub(b2, b1, GNC_DENOM_AUTO, GNC_HOW_DENOM_FIXED);
3843 : : }
3844 : :
3845 : : typedef struct
3846 : : {
3847 : : const gnc_commodity *currency;
3848 : : gnc_numeric balanceChange;
3849 : : time64 t1;
3850 : : time64 t2;
3851 : : } CurrencyBalanceChange;
3852 : :
3853 : : static void
3854 : 732 : xaccAccountBalanceChangeHelper (Account *acc, gpointer data)
3855 : : {
3856 : 732 : CurrencyBalanceChange *cbdiff = static_cast<CurrencyBalanceChange*>(data);
3857 : :
3858 : : gnc_numeric b1, b2;
3859 : 732 : b1 = GetBalanceAsOfDate(acc, cbdiff->t1, xaccSplitGetNoclosingBalance);
3860 : 732 : b2 = GetBalanceAsOfDate(acc, cbdiff->t2, xaccSplitGetNoclosingBalance);
3861 : 732 : gnc_numeric balanceChange = gnc_numeric_sub(b2, b1, GNC_DENOM_AUTO, GNC_HOW_DENOM_FIXED);
3862 : 732 : gnc_numeric balanceChange_conv = xaccAccountConvertBalanceToCurrencyAsOfDate(acc, balanceChange, xaccAccountGetCommodity(acc), cbdiff->currency, cbdiff->t2);
3863 : 732 : cbdiff->balanceChange = gnc_numeric_add (cbdiff->balanceChange, balanceChange_conv,
3864 : 732 : gnc_commodity_get_fraction (cbdiff->currency),
3865 : : GNC_HOW_RND_ROUND_HALF_UP);
3866 : 732 : }
3867 : :
3868 : : gnc_numeric
3869 : 549 : xaccAccountGetNoclosingBalanceChangeInCurrencyForPeriod (Account *acc, time64 t1,
3870 : : time64 t2, gboolean recurse)
3871 : : {
3872 : :
3873 : :
3874 : : gnc_numeric b1, b2;
3875 : 549 : b1 = GetBalanceAsOfDate(acc, t1, xaccSplitGetNoclosingBalance);
3876 : 549 : b2 = GetBalanceAsOfDate(acc, t2, xaccSplitGetNoclosingBalance);
3877 : 549 : gnc_numeric balanceChange = gnc_numeric_sub(b2, b1, GNC_DENOM_AUTO, GNC_HOW_DENOM_FIXED);
3878 : :
3879 : 549 : gnc_commodity *report_commodity = xaccAccountGetCommodity(acc);
3880 : 549 : CurrencyBalanceChange cbdiff = { report_commodity, balanceChange, t1, t2 };
3881 : :
3882 : 549 : if(recurse)
3883 : : {
3884 : 549 : gnc_account_foreach_descendant (acc, xaccAccountBalanceChangeHelper, &cbdiff);
3885 : 549 : balanceChange = cbdiff.balanceChange;
3886 : : }
3887 : 549 : return balanceChange;
3888 : : }
3889 : :
3890 : : /********************************************************************\
3891 : : \********************************************************************/
3892 : :
3893 : : const SplitsVec&
3894 : 931 : xaccAccountGetSplits (const Account *account)
3895 : : {
3896 : 931 : static const SplitsVec empty;
3897 : 931 : g_return_val_if_fail (GNC_IS_ACCOUNT(account), empty);
3898 : 931 : return GET_PRIVATE(account)->splits;
3899 : : }
3900 : :
3901 : : SplitList *
3902 : 1 : xaccAccountGetSplitList (const Account *acc)
3903 : : {
3904 : 1 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3905 : 1 : auto priv{GET_PRIVATE(acc)};
3906 : 2 : return std::accumulate (priv->splits.rbegin(), priv->splits.rend(),
3907 : 1 : static_cast<GList*>(nullptr), g_list_prepend);
3908 : : }
3909 : :
3910 : : size_t
3911 : 23 : xaccAccountGetSplitsSize (const Account *account)
3912 : : {
3913 : 23 : g_return_val_if_fail (GNC_IS_ACCOUNT(account), 0);
3914 : 23 : return GNC_IS_ACCOUNT(account) ? GET_PRIVATE(account)->splits.size() : 0;
3915 : : }
3916 : :
3917 : 0 : gboolean gnc_account_and_descendants_empty (Account *acc)
3918 : : {
3919 : 0 : g_return_val_if_fail (GNC_IS_ACCOUNT (acc), FALSE);
3920 : 0 : auto priv = GET_PRIVATE (acc);
3921 : 0 : if (!priv->splits.empty()) return FALSE;
3922 : 0 : return std::all_of (priv->children.begin(), priv->children.end(),
3923 : 0 : gnc_account_and_descendants_empty);
3924 : : }
3925 : :
3926 : : LotList *
3927 : 464 : xaccAccountGetLotList (const Account *acc)
3928 : : {
3929 : 464 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3930 : 464 : return g_list_copy(GET_PRIVATE(acc)->lots);
3931 : : }
3932 : :
3933 : : LotList *
3934 : 5 : xaccAccountFindOpenLots (const Account *acc,
3935 : : gboolean (*match_func)(GNCLot *lot,
3936 : : gpointer user_data),
3937 : : gpointer user_data, GCompareFunc sort_func)
3938 : : {
3939 : : AccountPrivate *priv;
3940 : : GList *lot_list;
3941 : 5 : GList *retval = nullptr;
3942 : :
3943 : 5 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3944 : :
3945 : 5 : priv = GET_PRIVATE(acc);
3946 : 18 : for (lot_list = priv->lots; lot_list; lot_list = lot_list->next)
3947 : : {
3948 : 13 : GNCLot *lot = static_cast<GNCLot*>(lot_list->data);
3949 : :
3950 : : /* If this lot is closed, then ignore it */
3951 : 13 : if (gnc_lot_is_closed (lot))
3952 : 5 : continue;
3953 : :
3954 : 8 : if (match_func && !(match_func)(lot, user_data))
3955 : 2 : continue;
3956 : :
3957 : : /* Ok, this is a valid lot. Add it to our list of lots */
3958 : 6 : retval = g_list_prepend (retval, lot);
3959 : : }
3960 : :
3961 : 5 : if (sort_func)
3962 : 1 : retval = g_list_sort (retval, sort_func);
3963 : :
3964 : 5 : return retval;
3965 : : }
3966 : :
3967 : : gpointer
3968 : 62 : xaccAccountForEachLot(const Account *acc,
3969 : : gpointer (*proc)(GNCLot *lot, void *data), void *data)
3970 : : {
3971 : 62 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), nullptr);
3972 : 62 : g_return_val_if_fail(proc, nullptr);
3973 : :
3974 : 821 : for (auto node = GET_PRIVATE(acc)->lots; node; node = node->next)
3975 : 760 : if (auto result = proc(GNC_LOT(node->data), data))
3976 : 1 : return result;
3977 : :
3978 : 61 : return nullptr;
3979 : : }
3980 : :
3981 : :
3982 : : /********************************************************************\
3983 : : \********************************************************************/
3984 : :
3985 : : /* These functions use interchange gint64 and gboolean. Is that right? */
3986 : : gboolean
3987 : 1 : xaccAccountGetTaxRelated (const Account *acc)
3988 : : {
3989 : 3 : return get_kvp_boolean_path(acc, {"tax-related"});
3990 : : }
3991 : :
3992 : : void
3993 : 0 : xaccAccountSetTaxRelated (Account *acc, gboolean tax_related)
3994 : : {
3995 : 0 : set_kvp_boolean_path(acc, {"tax-related"}, tax_related);
3996 : 0 : }
3997 : :
3998 : : const char *
3999 : 7 : xaccAccountGetTaxUSCode (const Account *acc)
4000 : : {
4001 : 21 : return get_kvp_string_path (acc, {"tax-US", "code"});
4002 : : }
4003 : :
4004 : : void
4005 : 5 : xaccAccountSetTaxUSCode (Account *acc, const char *code)
4006 : : {
4007 : 10 : set_kvp_string_path (acc, {"tax-US", "code"}, code);
4008 : 5 : }
4009 : :
4010 : : const char *
4011 : 7 : xaccAccountGetTaxUSPayerNameSource (const Account *acc)
4012 : : {
4013 : 21 : return get_kvp_string_path (acc, {"tax-US", "payer-name-source"});
4014 : : }
4015 : :
4016 : : void
4017 : 5 : xaccAccountSetTaxUSPayerNameSource (Account *acc, const char *source)
4018 : : {
4019 : 10 : set_kvp_string_path (acc, {"tax-US", "payer-name-source"}, source);
4020 : 5 : }
4021 : :
4022 : : gint64
4023 : 1 : xaccAccountGetTaxUSCopyNumber (const Account *acc)
4024 : : {
4025 : 2 : auto copy_number = get_kvp_int64_path (acc, {"tax-US", "copy-number"});
4026 : 2 : return (copy_number && (*copy_number != 0)) ? *copy_number : 1;
4027 : : }
4028 : :
4029 : : void
4030 : 0 : xaccAccountSetTaxUSCopyNumber (Account *acc, gint64 copy_number)
4031 : : {
4032 : 0 : if (copy_number != 0)
4033 : 0 : set_kvp_int64_path (acc, {"tax-US", "copy-number"}, copy_number);
4034 : : else
4035 : : /* deletes KVP if it exists */
4036 : 0 : set_kvp_int64_path (acc, {"tax-US", "copy-number"}, std::nullopt);
4037 : 0 : }
4038 : :
4039 : : /*********************************************************************\
4040 : : \ ********************************************************************/
4041 : :
4042 : :
4043 : 11 : const char *gnc_account_get_debit_string (GNCAccountType acct_type)
4044 : : {
4045 : 11 : if (gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL, GNC_PREF_ACCOUNTING_LABELS))
4046 : 0 : return _(dflt_acct_debit_str);
4047 : :
4048 : 11 : auto result = gnc_acct_debit_strs.find(acct_type);
4049 : 11 : if (result != gnc_acct_debit_strs.end())
4050 : 11 : return _(result->second);
4051 : : else
4052 : 0 : return _(dflt_acct_debit_str);
4053 : : }
4054 : :
4055 : 11 : const char *gnc_account_get_credit_string (GNCAccountType acct_type)
4056 : : {
4057 : 11 : if (gnc_prefs_get_bool(GNC_PREFS_GROUP_GENERAL, GNC_PREF_ACCOUNTING_LABELS))
4058 : 0 : return _(dflt_acct_credit_str);
4059 : :
4060 : 11 : auto result = gnc_acct_credit_strs.find(acct_type);
4061 : 11 : if (result != gnc_acct_credit_strs.end())
4062 : 11 : return _(result->second);
4063 : : else
4064 : 0 : return _(dflt_acct_credit_str);
4065 : : }
4066 : :
4067 : : /********************************************************************\
4068 : : \********************************************************************/
4069 : :
4070 : : gboolean
4071 : 205 : xaccAccountGetPlaceholder (const Account *acc)
4072 : : {
4073 : 615 : return get_kvp_boolean_path(acc, {"placeholder"});
4074 : : }
4075 : :
4076 : : void
4077 : 115 : xaccAccountSetPlaceholder (Account *acc, gboolean val)
4078 : : {
4079 : 230 : set_kvp_boolean_path(acc, {"placeholder"}, val);
4080 : 115 : }
4081 : :
4082 : : gboolean
4083 : 0 : xaccAccountGetAppendText (const Account *acc)
4084 : : {
4085 : 0 : return get_kvp_boolean_path(acc, {"import-append-text"});
4086 : : }
4087 : :
4088 : : void
4089 : 0 : xaccAccountSetAppendText (Account *acc, gboolean val)
4090 : : {
4091 : 0 : set_kvp_boolean_path(acc, {"import-append-text"}, val);
4092 : 0 : }
4093 : :
4094 : : gboolean
4095 : 4 : xaccAccountGetIsOpeningBalance (const Account *acc)
4096 : : {
4097 : 4 : g_return_val_if_fail (GNC_IS_ACCOUNT(acc), false);
4098 : 4 : if (GET_PRIVATE(acc)->type != ACCT_TYPE_EQUITY)
4099 : 1 : return false;
4100 : :
4101 : 9 : return !g_strcmp0 (get_kvp_string_path (acc, {"equity-type"}), "opening-balance");
4102 : : }
4103 : :
4104 : : void
4105 : 2 : xaccAccountSetIsOpeningBalance (Account *acc, gboolean val)
4106 : : {
4107 : 2 : g_return_if_fail (GNC_IS_ACCOUNT(acc));
4108 : 2 : if (GET_PRIVATE(acc)->type != ACCT_TYPE_EQUITY)
4109 : 0 : return;
4110 : 6 : set_kvp_string_path(acc, {"equity-type"}, val ? "opening-balance" : nullptr);
4111 : : }
4112 : :
4113 : : GNCPlaceholderType
4114 : 0 : xaccAccountGetDescendantPlaceholder (const Account *acc)
4115 : : {
4116 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), PLACEHOLDER_NONE);
4117 : 0 : if (xaccAccountGetPlaceholder(acc)) return PLACEHOLDER_THIS;
4118 : :
4119 : 0 : return gnc_account_foreach_descendant_until (acc, (AccountCb2)xaccAccountGetPlaceholder, nullptr)
4120 : 0 : ? PLACEHOLDER_CHILD : PLACEHOLDER_NONE;
4121 : : }
4122 : :
4123 : : /********************************************************************\
4124 : : \********************************************************************/
4125 : :
4126 : : gboolean
4127 : 0 : xaccAccountGetAutoInterest (const Account *acc)
4128 : : {
4129 : 0 : return get_kvp_boolean_path (acc, {KEY_RECONCILE_INFO, "auto-interest-transfer"});
4130 : 0 : }
4131 : :
4132 : : void
4133 : 0 : xaccAccountSetAutoInterest (Account *acc, gboolean val)
4134 : : {
4135 : 0 : set_kvp_boolean_path (acc, {KEY_RECONCILE_INFO, "auto-interest-transfer"}, val);
4136 : 0 : }
4137 : :
4138 : : /********************************************************************\
4139 : : \********************************************************************/
4140 : :
4141 : : gboolean
4142 : 39 : xaccAccountGetHidden (const Account *acc)
4143 : : {
4144 : 117 : return get_kvp_boolean_path (acc, {"hidden"});
4145 : : }
4146 : :
4147 : : void
4148 : 38 : xaccAccountSetHidden (Account *acc, gboolean val)
4149 : : {
4150 : 76 : set_kvp_boolean_path (acc, {"hidden"}, val);
4151 : 38 : }
4152 : :
4153 : : gboolean
4154 : 0 : xaccAccountIsHidden (const Account *acc)
4155 : : {
4156 : : AccountPrivate *priv;
4157 : :
4158 : 0 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
4159 : :
4160 : 0 : if (xaccAccountGetHidden(acc))
4161 : 0 : return TRUE;
4162 : 0 : priv = GET_PRIVATE(acc);
4163 : 0 : while ((acc = priv->parent) != nullptr)
4164 : : {
4165 : 0 : priv = GET_PRIVATE(acc);
4166 : 0 : if (xaccAccountGetHidden(acc))
4167 : 0 : return TRUE;
4168 : : }
4169 : 0 : return FALSE;
4170 : : }
4171 : :
4172 : : /********************************************************************\
4173 : : \********************************************************************/
4174 : :
4175 : : gboolean
4176 : 3 : xaccAccountHasAncestor (const Account *acc, const Account * ancestor)
4177 : : {
4178 : : const Account *parent;
4179 : :
4180 : 3 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
4181 : 3 : g_return_val_if_fail(GNC_IS_ACCOUNT(ancestor), FALSE);
4182 : :
4183 : 3 : parent = acc;
4184 : 13 : while (parent && parent != ancestor)
4185 : 10 : parent = GET_PRIVATE(parent)->parent;
4186 : :
4187 : 3 : return (parent == ancestor);
4188 : : }
4189 : :
4190 : : /********************************************************************\
4191 : : \********************************************************************/
4192 : :
4193 : : /* You must edit the functions in this block in tandem. KEEP THEM IN
4194 : : SYNC! */
4195 : :
4196 : : #define GNC_RETURN_ENUM_AS_STRING(x) case (ACCT_TYPE_ ## x): return #x;
4197 : :
4198 : : const char *
4199 : 310 : xaccAccountTypeEnumAsString(GNCAccountType type)
4200 : : {
4201 : 310 : switch (type)
4202 : : {
4203 : 1 : GNC_RETURN_ENUM_AS_STRING(NONE);
4204 : 24 : GNC_RETURN_ENUM_AS_STRING(BANK);
4205 : 6 : GNC_RETURN_ENUM_AS_STRING(CASH);
4206 : 4 : GNC_RETURN_ENUM_AS_STRING(CREDIT);
4207 : 13 : GNC_RETURN_ENUM_AS_STRING(ASSET);
4208 : 16 : GNC_RETURN_ENUM_AS_STRING(LIABILITY);
4209 : 2 : GNC_RETURN_ENUM_AS_STRING(STOCK);
4210 : 4 : GNC_RETURN_ENUM_AS_STRING(MUTUAL);
4211 : 4 : GNC_RETURN_ENUM_AS_STRING(CURRENCY);
4212 : 26 : GNC_RETURN_ENUM_AS_STRING(INCOME);
4213 : 164 : GNC_RETURN_ENUM_AS_STRING(EXPENSE);
4214 : 11 : GNC_RETURN_ENUM_AS_STRING(EQUITY);
4215 : 4 : GNC_RETURN_ENUM_AS_STRING(RECEIVABLE);
4216 : 3 : GNC_RETURN_ENUM_AS_STRING(PAYABLE);
4217 : 22 : GNC_RETURN_ENUM_AS_STRING(ROOT);
4218 : 1 : GNC_RETURN_ENUM_AS_STRING(TRADING);
4219 : 1 : GNC_RETURN_ENUM_AS_STRING(CHECKING);
4220 : 1 : GNC_RETURN_ENUM_AS_STRING(SAVINGS);
4221 : 1 : GNC_RETURN_ENUM_AS_STRING(MONEYMRKT);
4222 : 1 : GNC_RETURN_ENUM_AS_STRING(CREDITLINE);
4223 : 1 : default:
4224 : 1 : PERR ("asked to translate unknown account type %d.\n", type);
4225 : 1 : break;
4226 : : }
4227 : 1 : return(nullptr);
4228 : : }
4229 : :
4230 : : #undef GNC_RETURN_ENUM_AS_STRING
4231 : :
4232 : : #define GNC_RETURN_ON_MATCH(x) \
4233 : : if(g_strcmp0(#x, (str)) == 0) { *type = ACCT_TYPE_ ## x; return(TRUE); }
4234 : :
4235 : : gboolean
4236 : 1285 : xaccAccountStringToType(const char* str, GNCAccountType *type)
4237 : : {
4238 : :
4239 : 1285 : GNC_RETURN_ON_MATCH(NONE);
4240 : 1284 : GNC_RETURN_ON_MATCH(BANK);
4241 : 1198 : GNC_RETURN_ON_MATCH(CASH);
4242 : 1182 : GNC_RETURN_ON_MATCH(CREDIT);
4243 : 1165 : GNC_RETURN_ON_MATCH(ASSET);
4244 : 1087 : GNC_RETURN_ON_MATCH(LIABILITY);
4245 : 1023 : GNC_RETURN_ON_MATCH(STOCK);
4246 : 985 : GNC_RETURN_ON_MATCH(MUTUAL);
4247 : 958 : GNC_RETURN_ON_MATCH(CURRENCY);
4248 : 949 : GNC_RETURN_ON_MATCH(INCOME);
4249 : 802 : GNC_RETURN_ON_MATCH(EXPENSE);
4250 : 137 : GNC_RETURN_ON_MATCH(EQUITY);
4251 : 95 : GNC_RETURN_ON_MATCH(RECEIVABLE);
4252 : 87 : GNC_RETURN_ON_MATCH(PAYABLE);
4253 : 82 : GNC_RETURN_ON_MATCH(ROOT);
4254 : 7 : GNC_RETURN_ON_MATCH(TRADING);
4255 : 6 : GNC_RETURN_ON_MATCH(CHECKING);
4256 : 5 : GNC_RETURN_ON_MATCH(SAVINGS);
4257 : 4 : GNC_RETURN_ON_MATCH(MONEYMRKT);
4258 : 3 : GNC_RETURN_ON_MATCH(CREDITLINE);
4259 : :
4260 : 2 : PERR("asked to translate unknown account type string %s.\n",
4261 : : str ? str : "(null)");
4262 : :
4263 : 2 : return(FALSE);
4264 : : }
4265 : :
4266 : : #undef GNC_RETURN_ON_MATCH
4267 : :
4268 : : /* impedance mismatch is a source of loss */
4269 : : GNCAccountType
4270 : 54 : xaccAccountStringToEnum(const char* str)
4271 : : {
4272 : : GNCAccountType type;
4273 : : gboolean rc;
4274 : 54 : rc = xaccAccountStringToType(str, &type);
4275 : 54 : if (FALSE == rc) return ACCT_TYPE_INVALID;
4276 : 54 : return type;
4277 : : }
4278 : :
4279 : : /********************************************************************\
4280 : : \********************************************************************/
4281 : :
4282 : : static char const *
4283 : : account_type_name[NUM_ACCOUNT_TYPES] =
4284 : : {
4285 : : N_("Bank"),
4286 : : N_("Cash"),
4287 : : N_("Asset"),
4288 : : N_("Credit Card"),
4289 : : N_("Liability"),
4290 : : N_("Stock"),
4291 : : N_("Mutual Fund"),
4292 : : N_("Currency"),
4293 : : N_("Income"),
4294 : : N_("Expense"),
4295 : : N_("Equity"),
4296 : : N_("A/Receivable"),
4297 : : N_("A/Payable"),
4298 : : N_("Root"),
4299 : : N_("Trading")
4300 : : /*
4301 : : N_("Checking"),
4302 : : N_("Savings"),
4303 : : N_("Money Market"),
4304 : : N_("Credit Line")
4305 : : */
4306 : : };
4307 : :
4308 : : const char *
4309 : 1399 : xaccAccountGetTypeStr(GNCAccountType type)
4310 : : {
4311 : 1399 : if (type < 0 || NUM_ACCOUNT_TYPES <= type ) return "";
4312 : 1399 : return _(account_type_name [type]);
4313 : : }
4314 : :
4315 : : /********************************************************************\
4316 : : \********************************************************************/
4317 : :
4318 : : guint32
4319 : 14 : xaccAccountTypesCompatibleWith (GNCAccountType type)
4320 : : {
4321 : 14 : switch (type)
4322 : : {
4323 : 8 : case ACCT_TYPE_BANK:
4324 : : case ACCT_TYPE_CASH:
4325 : : case ACCT_TYPE_ASSET:
4326 : : case ACCT_TYPE_CREDIT:
4327 : : case ACCT_TYPE_LIABILITY:
4328 : : case ACCT_TYPE_INCOME:
4329 : : case ACCT_TYPE_EXPENSE:
4330 : : case ACCT_TYPE_EQUITY:
4331 : : return
4332 : : (1 << ACCT_TYPE_BANK) |
4333 : : (1 << ACCT_TYPE_CASH) |
4334 : : (1 << ACCT_TYPE_ASSET) |
4335 : : (1 << ACCT_TYPE_CREDIT) |
4336 : : (1 << ACCT_TYPE_LIABILITY) |
4337 : : (1 << ACCT_TYPE_INCOME) |
4338 : : (1 << ACCT_TYPE_EXPENSE) |
4339 : 8 : (1 << ACCT_TYPE_EQUITY);
4340 : 3 : case ACCT_TYPE_STOCK:
4341 : : case ACCT_TYPE_MUTUAL:
4342 : : case ACCT_TYPE_CURRENCY:
4343 : : return
4344 : : (1 << ACCT_TYPE_STOCK) |
4345 : : (1 << ACCT_TYPE_MUTUAL) |
4346 : 3 : (1 << ACCT_TYPE_CURRENCY);
4347 : 1 : case ACCT_TYPE_RECEIVABLE:
4348 : 1 : return (1 << ACCT_TYPE_RECEIVABLE);
4349 : 1 : case ACCT_TYPE_PAYABLE:
4350 : 1 : return (1 << ACCT_TYPE_PAYABLE);
4351 : 1 : case ACCT_TYPE_TRADING:
4352 : 1 : return (1 << ACCT_TYPE_TRADING);
4353 : 0 : default:
4354 : 0 : PERR("bad account type: %d", type);
4355 : 0 : return 0;
4356 : : }
4357 : : }
4358 : : guint32
4359 : 282 : xaccParentAccountTypesCompatibleWith (GNCAccountType type)
4360 : : {
4361 : 282 : switch (type)
4362 : : {
4363 : 200 : case ACCT_TYPE_BANK:
4364 : : case ACCT_TYPE_CASH:
4365 : : case ACCT_TYPE_ASSET:
4366 : : case ACCT_TYPE_STOCK:
4367 : : case ACCT_TYPE_MUTUAL:
4368 : : case ACCT_TYPE_CURRENCY:
4369 : : case ACCT_TYPE_CREDIT:
4370 : : case ACCT_TYPE_LIABILITY:
4371 : : case ACCT_TYPE_RECEIVABLE:
4372 : : case ACCT_TYPE_PAYABLE:
4373 : : return
4374 : : (1 << ACCT_TYPE_BANK) |
4375 : : (1 << ACCT_TYPE_CASH) |
4376 : : (1 << ACCT_TYPE_ASSET) |
4377 : : (1 << ACCT_TYPE_STOCK) |
4378 : : (1 << ACCT_TYPE_MUTUAL) |
4379 : : (1 << ACCT_TYPE_CURRENCY) |
4380 : : (1 << ACCT_TYPE_CREDIT) |
4381 : : (1 << ACCT_TYPE_LIABILITY) |
4382 : : (1 << ACCT_TYPE_RECEIVABLE) |
4383 : : (1 << ACCT_TYPE_PAYABLE) |
4384 : 200 : (1 << ACCT_TYPE_ROOT);
4385 : 40 : case ACCT_TYPE_INCOME:
4386 : : case ACCT_TYPE_EXPENSE:
4387 : : return
4388 : : (1 << ACCT_TYPE_INCOME) |
4389 : : (1 << ACCT_TYPE_EXPENSE) |
4390 : 40 : (1 << ACCT_TYPE_ROOT);
4391 : 20 : case ACCT_TYPE_EQUITY:
4392 : : return
4393 : : (1 << ACCT_TYPE_EQUITY) |
4394 : 20 : (1 << ACCT_TYPE_ROOT);
4395 : 20 : case ACCT_TYPE_TRADING:
4396 : : return
4397 : : (1 << ACCT_TYPE_TRADING) |
4398 : 20 : (1 << ACCT_TYPE_ROOT);
4399 : 2 : default:
4400 : 2 : PERR("bad account type: %d", type);
4401 : 2 : return 0;
4402 : : }
4403 : : }
4404 : :
4405 : : gboolean
4406 : 280 : xaccAccountTypesCompatible (GNCAccountType parent_type,
4407 : : GNCAccountType child_type)
4408 : : {
4409 : : /* ACCT_TYPE_NONE isn't compatible with anything, even ACCT_TYPE_NONE. */
4410 : 280 : if (parent_type == ACCT_TYPE_NONE || child_type == ACCT_TYPE_NONE)
4411 : 14 : return FALSE;
4412 : :
4413 : : /* ACCT_TYPE_ROOT can't have a parent account, and asking will raise
4414 : : * an error. */
4415 : 266 : if (child_type == ACCT_TYPE_ROOT)
4416 : 0 : return FALSE;
4417 : :
4418 : 266 : return ((xaccParentAccountTypesCompatibleWith (child_type) &
4419 : 266 : (1 << parent_type))
4420 : 266 : != 0);
4421 : : }
4422 : :
4423 : : guint32
4424 : 0 : xaccAccountTypesValid(void)
4425 : : {
4426 : 0 : guint32 mask = (1 << NUM_ACCOUNT_TYPES) - 1;
4427 : 0 : mask &= ~((1 << ACCT_TYPE_CURRENCY) | /* DEPRECATED */
4428 : : (1 << ACCT_TYPE_ROOT)); /* ROOT */
4429 : :
4430 : 0 : return mask;
4431 : : }
4432 : :
4433 : 0 : gboolean xaccAccountIsAssetLiabType(GNCAccountType t)
4434 : : {
4435 : 0 : switch (t)
4436 : : {
4437 : 0 : case ACCT_TYPE_RECEIVABLE:
4438 : : case ACCT_TYPE_PAYABLE:
4439 : 0 : return FALSE;
4440 : 0 : default:
4441 : 0 : return (xaccAccountTypesCompatible(ACCT_TYPE_ASSET, t)
4442 : 0 : || xaccAccountTypesCompatible(ACCT_TYPE_LIABILITY, t));
4443 : : }
4444 : : }
4445 : :
4446 : : GNCAccountType
4447 : 0 : xaccAccountTypeGetFundamental (GNCAccountType t)
4448 : : {
4449 : 0 : switch (t)
4450 : : {
4451 : 0 : case ACCT_TYPE_BANK:
4452 : : case ACCT_TYPE_STOCK:
4453 : : case ACCT_TYPE_MONEYMRKT:
4454 : : case ACCT_TYPE_CHECKING:
4455 : : case ACCT_TYPE_SAVINGS:
4456 : : case ACCT_TYPE_MUTUAL:
4457 : : case ACCT_TYPE_CURRENCY:
4458 : : case ACCT_TYPE_CASH:
4459 : : case ACCT_TYPE_ASSET:
4460 : : case ACCT_TYPE_RECEIVABLE:
4461 : 0 : return ACCT_TYPE_ASSET;
4462 : 0 : case ACCT_TYPE_CREDIT:
4463 : : case ACCT_TYPE_LIABILITY:
4464 : : case ACCT_TYPE_PAYABLE:
4465 : : case ACCT_TYPE_CREDITLINE:
4466 : 0 : return ACCT_TYPE_LIABILITY;
4467 : 0 : case ACCT_TYPE_INCOME:
4468 : 0 : return ACCT_TYPE_INCOME;
4469 : 0 : case ACCT_TYPE_EXPENSE:
4470 : 0 : return ACCT_TYPE_EXPENSE;
4471 : 0 : case ACCT_TYPE_EQUITY:
4472 : 0 : return ACCT_TYPE_EQUITY;
4473 : 0 : case ACCT_TYPE_TRADING:
4474 : : default:
4475 : 0 : return ACCT_TYPE_NONE;
4476 : : }
4477 : : }
4478 : :
4479 : 306 : gboolean xaccAccountIsAPARType(GNCAccountType t)
4480 : : {
4481 : 306 : switch (t)
4482 : : {
4483 : 122 : case ACCT_TYPE_RECEIVABLE:
4484 : : case ACCT_TYPE_PAYABLE:
4485 : 122 : return TRUE;
4486 : 184 : default:
4487 : 184 : return FALSE;
4488 : : }
4489 : : }
4490 : :
4491 : 0 : gboolean xaccAccountIsEquityType(GNCAccountType t)
4492 : : {
4493 : 0 : switch (t)
4494 : : {
4495 : 0 : case ACCT_TYPE_EQUITY:
4496 : 0 : return TRUE;
4497 : 0 : default:
4498 : 0 : return FALSE;
4499 : : }
4500 : : }
4501 : :
4502 : : gboolean
4503 : 543 : xaccAccountIsPriced(const Account *acc)
4504 : : {
4505 : : AccountPrivate *priv;
4506 : :
4507 : 543 : g_return_val_if_fail(GNC_IS_ACCOUNT(acc), FALSE);
4508 : :
4509 : 543 : priv = GET_PRIVATE(acc);
4510 : 1023 : return (priv->type == ACCT_TYPE_STOCK || priv->type == ACCT_TYPE_MUTUAL ||
4511 : 1023 : priv->type == ACCT_TYPE_CURRENCY);
4512 : : }
4513 : :
4514 : : /********************************************************************\
4515 : : \********************************************************************/
4516 : :
4517 : : gboolean
4518 : 1 : xaccAccountGetReconcileLastDate (const Account *acc, time64 *last_date)
4519 : : {
4520 : 1 : gboolean retval = FALSE;
4521 : 4 : auto date = get_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-date"});
4522 : :
4523 : 1 : if (date)
4524 : : {
4525 : 1 : if (last_date)
4526 : 1 : *last_date = *date;
4527 : 1 : retval = TRUE;
4528 : : }
4529 : 1 : return retval;
4530 : 3 : }
4531 : :
4532 : : /********************************************************************\
4533 : : \********************************************************************/
4534 : :
4535 : : void
4536 : 1 : xaccAccountSetReconcileLastDate (Account *acc, time64 last_date)
4537 : : {
4538 : 5 : set_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-date"}, last_date);
4539 : 3 : }
4540 : :
4541 : : /********************************************************************\
4542 : : \********************************************************************/
4543 : :
4544 : : gboolean
4545 : 2 : xaccAccountGetReconcileLastInterval (const Account *acc,
4546 : : int *months, int *days)
4547 : : {
4548 : 2 : if (!acc) return FALSE;
4549 : 10 : auto m{get_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-interval", "months"})};
4550 : 10 : auto d{get_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-interval", "days"})};
4551 : 2 : if (m && d)
4552 : : {
4553 : 1 : if (months)
4554 : 1 : *months = *m;
4555 : 1 : if (days)
4556 : 1 : *days = *d;
4557 : 1 : return true;
4558 : : }
4559 : 1 : return false;
4560 : 10 : }
4561 : :
4562 : : /********************************************************************\
4563 : : \********************************************************************/
4564 : :
4565 : : void
4566 : 1 : xaccAccountSetReconcileLastInterval (Account *acc, int months, int days)
4567 : : {
4568 : 6 : set_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-interval", "months"}, months);
4569 : 5 : set_kvp_int64_path (acc, {KEY_RECONCILE_INFO, "last-interval", "days"}, days);
4570 : 5 : }
4571 : :
4572 : : /********************************************************************\
4573 : : \********************************************************************/
4574 : :
4575 : : gboolean
4576 : 1 : xaccAccountGetReconcilePostponeDate (const Account *acc, time64 *postpone_date)
4577 : : {
4578 : 6 : if (auto date = get_kvp_int64_path (acc, {KEY_RECONCILE_INFO, KEY_POSTPONE, "date"}))
4579 : : {
4580 : 1 : if (postpone_date)
4581 : 1 : *postpone_date = *date;
4582 : 1 : return true;
4583 : : }
4584 : 0 : return false;
4585 : 3 : }
4586 : :
4587 : : /********************************************************************\
4588 : : \********************************************************************/
4589 : :
4590 : : void
4591 : 1 : xaccAccountSetReconcilePostponeDate (Account *acc, time64 postpone_date)
4592 : : {
4593 : 6 : set_kvp_int64_path (acc, {KEY_RECONCILE_INFO, KEY_POSTPONE, "date"}, postpone_date);
4594 : 3 : }
4595 : :
4596 : : /********************************************************************\
4597 : : \********************************************************************/
4598 : :
4599 : : gboolean
4600 : 3 : xaccAccountGetReconcilePostponeBalance (const Account *acc,
4601 : : gnc_numeric *balance)
4602 : : {
4603 : 18 : if (auto bal = get_kvp_gnc_numeric_path (acc, {KEY_RECONCILE_INFO, KEY_POSTPONE, "balance"}))
4604 : : {
4605 : 1 : if (balance)
4606 : 1 : *balance = *bal;
4607 : 1 : return true;
4608 : : }
4609 : 2 : return false;
4610 : 9 : }
4611 : :
4612 : : /********************************************************************\
4613 : : \********************************************************************/
4614 : :
4615 : : void
4616 : 1 : xaccAccountSetReconcilePostponeBalance (Account *acc, gnc_numeric balance)
4617 : : {
4618 : 6 : set_kvp_gnc_numeric_path (acc, {KEY_RECONCILE_INFO, KEY_POSTPONE, "balance"}, balance);
4619 : 3 : }
4620 : :
4621 : : /********************************************************************\
4622 : :
4623 : : \********************************************************************/
4624 : :
4625 : : void
4626 : 1 : xaccAccountClearReconcilePostpone (Account *acc)
4627 : : {
4628 : 5 : set_kvp_gnc_numeric_path (acc, {KEY_RECONCILE_INFO, KEY_POSTPONE}, {});
4629 : 2 : }
4630 : :
4631 : : /********************************************************************\
4632 : : \********************************************************************/
4633 : :
4634 : : const char *
4635 : 6 : xaccAccountGetLastNum (const Account *acc)
4636 : : {
4637 : 18 : return get_kvp_string_path (acc, {"last-num"});
4638 : : }
4639 : :
4640 : : /********************************************************************\
4641 : : \********************************************************************/
4642 : :
4643 : : void
4644 : 385 : xaccAccountSetLastNum (Account *acc, const char *num)
4645 : : {
4646 : 770 : set_kvp_string_path (acc, {"last-num"}, num);
4647 : 385 : }
4648 : :
4649 : :
4650 : : /********************************************************************\
4651 : : \********************************************************************/
4652 : :
4653 : : static bool
4654 : 8 : get_balance_limit (const Account* acc, const std::string& key, gnc_numeric* balance)
4655 : : {
4656 : 32 : auto limit = get_kvp_gnc_numeric_path (acc, {KEY_BALANCE_LIMIT, key});
4657 : 8 : if (limit)
4658 : 4 : *balance = gnc_numeric_create (limit->num, limit->denom);
4659 : 16 : return limit.has_value();
4660 : 8 : }
4661 : :
4662 : : static void
4663 : 6 : set_balance_limit (Account *acc, const std::string& key, std::optional<gnc_numeric> balance)
4664 : : {
4665 : 6 : if (balance && gnc_numeric_check (*balance))
4666 : 2 : return;
4667 : 16 : set_kvp_gnc_numeric_path (acc, {KEY_BALANCE_LIMIT, key}, balance);
4668 : 4 : }
4669 : :
4670 : : gboolean
4671 : 4 : xaccAccountGetHigherBalanceLimit (const Account *acc,
4672 : : gnc_numeric *balance)
4673 : : {
4674 : 4 : return get_balance_limit (acc, KEY_BALANCE_HIGHER_LIMIT_VALUE, balance);
4675 : : }
4676 : :
4677 : : gboolean
4678 : 4 : xaccAccountGetLowerBalanceLimit (const Account *acc,
4679 : : gnc_numeric *balance)
4680 : : {
4681 : 4 : return get_balance_limit (acc, KEY_BALANCE_LOWER_LIMIT_VALUE, balance);
4682 : : }
4683 : :
4684 : : void
4685 : 2 : xaccAccountSetHigherBalanceLimit (Account *acc, gnc_numeric balance)
4686 : : {
4687 : 2 : set_balance_limit (acc, KEY_BALANCE_HIGHER_LIMIT_VALUE, balance);
4688 : 2 : }
4689 : :
4690 : : void
4691 : 2 : xaccAccountSetLowerBalanceLimit (Account *acc, gnc_numeric balance)
4692 : : {
4693 : 2 : set_balance_limit (acc, KEY_BALANCE_LOWER_LIMIT_VALUE, balance);
4694 : 2 : }
4695 : :
4696 : : void
4697 : 1 : xaccAccountClearHigherBalanceLimit (Account *acc)
4698 : : {
4699 : 1 : set_balance_limit (acc, KEY_BALANCE_HIGHER_LIMIT_VALUE, {});
4700 : 1 : }
4701 : :
4702 : : void
4703 : 1 : xaccAccountClearLowerBalanceLimit (Account *acc)
4704 : : {
4705 : 1 : set_balance_limit (acc, KEY_BALANCE_LOWER_LIMIT_VALUE, {});
4706 : 1 : }
4707 : :
4708 : : gboolean
4709 : 3 : xaccAccountGetIncludeSubAccountBalances (const Account *acc)
4710 : : {
4711 : 12 : return get_kvp_boolean_path (acc, {KEY_BALANCE_LIMIT, KEY_BALANCE_INCLUDE_SUB_ACCTS});
4712 : 3 : }
4713 : :
4714 : : void
4715 : 2 : xaccAccountSetIncludeSubAccountBalances (Account *acc, gboolean inc_sub)
4716 : : {
4717 : 8 : set_kvp_boolean_path (acc, {KEY_BALANCE_LIMIT, KEY_BALANCE_INCLUDE_SUB_ACCTS}, inc_sub);
4718 : 4 : }
4719 : :
4720 : : /********************************************************************\
4721 : : \********************************************************************/
4722 : :
4723 : : static Account *
4724 : 5 : GetOrMakeOrphanAccount (Account *root, gnc_commodity * currency)
4725 : : {
4726 : : char * accname;
4727 : : Account * acc;
4728 : :
4729 : 5 : g_return_val_if_fail (root, nullptr);
4730 : :
4731 : : /* build the account name */
4732 : 5 : if (!currency)
4733 : : {
4734 : 0 : PERR ("No currency specified!");
4735 : 0 : return nullptr;
4736 : : }
4737 : :
4738 : 5 : accname = g_strconcat (_("Orphaned Gains"), "-",
4739 : : gnc_commodity_get_mnemonic (currency), nullptr);
4740 : :
4741 : : /* See if we've got one of these going already ... */
4742 : 5 : acc = gnc_account_lookup_by_name(root, accname);
4743 : :
4744 : 5 : if (acc == nullptr)
4745 : : {
4746 : : /* Guess not. We'll have to build one. */
4747 : 3 : acc = xaccMallocAccount (gnc_account_get_book(root));
4748 : 3 : xaccAccountBeginEdit (acc);
4749 : 3 : xaccAccountSetName (acc, accname);
4750 : 3 : xaccAccountSetCommodity (acc, currency);
4751 : 3 : xaccAccountSetType (acc, ACCT_TYPE_INCOME);
4752 : 3 : xaccAccountSetDescription (acc, _("Realized Gain/Loss"));
4753 : 3 : xaccAccountSetNotes (acc,
4754 : 3 : _("Realized Gains or Losses from "
4755 : : "Commodity or Trading Accounts "
4756 : : "that haven't been recorded elsewhere."));
4757 : :
4758 : : /* Hang the account off the root. */
4759 : 3 : gnc_account_append_child (root, acc);
4760 : 3 : xaccAccountCommitEdit (acc);
4761 : : }
4762 : :
4763 : 5 : g_free (accname);
4764 : :
4765 : 5 : return acc;
4766 : : }
4767 : :
4768 : : Account *
4769 : 6 : xaccAccountGainsAccount (Account *acc, gnc_commodity *curr)
4770 : : {
4771 : 30 : Path path {KEY_LOT_MGMT, "gains-acct", gnc_commodity_get_unique_name (curr)};
4772 : 12 : auto gains_account = get_kvp_account_path (acc, path);
4773 : :
4774 : 6 : if (gains_account == nullptr) /* No gains account for this currency */
4775 : : {
4776 : 5 : gains_account = GetOrMakeOrphanAccount (gnc_account_get_root (acc), curr);
4777 : 5 : set_kvp_account_path (acc, path, gains_account);
4778 : : }
4779 : :
4780 : 6 : return gains_account;
4781 : 24 : }
4782 : :
4783 : : /********************************************************************\
4784 : : \********************************************************************/
4785 : :
4786 : : void
4787 : 16 : dxaccAccountSetPriceSrc(Account *acc, const char *src)
4788 : : {
4789 : 16 : if (!acc) return;
4790 : :
4791 : 16 : if (xaccAccountIsPriced(acc))
4792 : 15 : set_kvp_string_path (acc, {"old-price-source"}, src);
4793 : : }
4794 : :
4795 : : /********************************************************************\
4796 : : \********************************************************************/
4797 : :
4798 : : const char*
4799 : 428 : dxaccAccountGetPriceSrc(const Account *acc)
4800 : : {
4801 : : static char *source = nullptr;
4802 : 428 : if (!acc) return nullptr;
4803 : :
4804 : 428 : if (!xaccAccountIsPriced(acc)) return nullptr;
4805 : :
4806 : 19 : g_free (source);
4807 : :
4808 : 57 : return get_kvp_string_path (acc, {"old-price-source"});
4809 : : }
4810 : :
4811 : : /********************************************************************\
4812 : : \********************************************************************/
4813 : :
4814 : : void
4815 : 16 : dxaccAccountSetQuoteTZ(Account *acc, const char *tz)
4816 : : {
4817 : 16 : if (!acc) return;
4818 : 16 : if (!xaccAccountIsPriced(acc)) return;
4819 : 15 : set_kvp_string_path (acc, {"old-quote-tz"}, tz);
4820 : : }
4821 : :
4822 : : /********************************************************************\
4823 : : \********************************************************************/
4824 : :
4825 : : const char*
4826 : 4 : dxaccAccountGetQuoteTZ(const Account *acc)
4827 : : {
4828 : 4 : if (!acc) return nullptr;
4829 : 4 : if (!xaccAccountIsPriced(acc)) return nullptr;
4830 : 12 : return get_kvp_string_path (acc, {"old-quote-tz"});
4831 : : }
4832 : :
4833 : : /********************************************************************\
4834 : : \********************************************************************/
4835 : :
4836 : : void
4837 : 1 : xaccAccountSetReconcileChildrenStatus(Account *acc, gboolean status)
4838 : : {
4839 : : /* Would have been nice to use G_TYPE_BOOLEAN, but the other
4840 : : * boolean kvps save the value as "true" or "false" and that would
4841 : : * be file-incompatible with this.
4842 : : */
4843 : 5 : set_kvp_int64_path (acc, {KEY_RECONCILE_INFO, KEY_INCLUDE_CHILDREN}, status);
4844 : 2 : }
4845 : :
4846 : : /********************************************************************\
4847 : : \********************************************************************/
4848 : :
4849 : : gboolean
4850 : 2 : xaccAccountGetReconcileChildrenStatus(const Account *acc)
4851 : : {
4852 : : /* access the account's kvp-data for status and return that, if no value
4853 : : * is found then we can assume not to include the children, that being
4854 : : * the default behaviour
4855 : : */
4856 : 8 : return get_kvp_boolean_path (acc, {KEY_RECONCILE_INFO, KEY_INCLUDE_CHILDREN});
4857 : 2 : }
4858 : :
4859 : : /********************************************************************\
4860 : : \********************************************************************/
4861 : :
4862 : : Split *
4863 : 2 : xaccAccountFindSplitByDesc(const Account *acc, const char *description)
4864 : : {
4865 : 10 : auto has_description = [description](const Split* s) -> bool
4866 : 10 : { return !g_strcmp0 (description, xaccTransGetDescription (xaccSplitGetParent (s))); };
4867 : 2 : return gnc_account_find_split (acc, has_description, true);
4868 : : }
4869 : :
4870 : : /* This routine is for finding a matching transaction in an account by
4871 : : * matching on the description field. [CAS: The rest of this comment
4872 : : * seems to belong somewhere else.] This routine is used for
4873 : : * auto-filling in registers with a default leading account. The
4874 : : * dest_trans is a transaction used for currency checking. */
4875 : : Transaction *
4876 : 1 : xaccAccountFindTransByDesc(const Account *acc, const char *description)
4877 : : {
4878 : 1 : auto split = xaccAccountFindSplitByDesc (acc, description);
4879 : 1 : return split ? xaccSplitGetParent (split) : nullptr;
4880 : : }
4881 : :
4882 : : /* ================================================================ */
4883 : : /* Concatenation, Merging functions */
4884 : :
4885 : : void
4886 : 1 : gnc_account_join_children (Account *to_parent, Account *from_parent)
4887 : : {
4888 : :
4889 : : /* errors */
4890 : 1 : g_return_if_fail(GNC_IS_ACCOUNT(to_parent));
4891 : 1 : g_return_if_fail(GNC_IS_ACCOUNT(from_parent));
4892 : :
4893 : : /* optimizations */
4894 : 1 : auto from_priv = GET_PRIVATE(from_parent);
4895 : 1 : if (from_priv->children.empty())
4896 : 0 : return;
4897 : :
4898 : 1 : ENTER (" ");
4899 : 1 : auto children = from_priv->children;
4900 : 3 : for (auto child : children)
4901 : 2 : gnc_account_append_child(to_parent, child);
4902 : 1 : LEAVE (" ");
4903 : 1 : }
4904 : : /********************************************************************\
4905 : : \********************************************************************/
4906 : :
4907 : : void
4908 : 3 : gnc_account_merge_children (Account *parent)
4909 : : {
4910 : 3 : g_return_if_fail(GNC_IS_ACCOUNT(parent));
4911 : :
4912 : 3 : auto ppriv = GET_PRIVATE(parent);
4913 : 12 : for (auto it_a = ppriv->children.begin(); it_a != ppriv->children.end(); it_a++)
4914 : : {
4915 : 9 : auto acc_a = *it_a;
4916 : 9 : auto priv_a = GET_PRIVATE(acc_a);
4917 : 23 : for (auto it_b = std::next(it_a); it_b != ppriv->children.end(); it_b++)
4918 : : {
4919 : 14 : auto acc_b = *it_b;
4920 : 14 : auto priv_b = GET_PRIVATE(acc_b);
4921 : 14 : if (0 != null_strcmp(priv_a->accountName, priv_b->accountName))
4922 : 13 : continue;
4923 : 1 : if (0 != null_strcmp(priv_a->accountCode, priv_b->accountCode))
4924 : 0 : continue;
4925 : 1 : if (0 != null_strcmp(priv_a->description, priv_b->description))
4926 : 0 : continue;
4927 : 1 : if (0 != null_strcmp(xaccAccountGetColor(acc_a),
4928 : : xaccAccountGetColor(acc_b)))
4929 : 0 : continue;
4930 : 1 : if (!gnc_commodity_equiv(priv_a->commodity, priv_b->commodity))
4931 : 0 : continue;
4932 : 1 : if (0 != null_strcmp(xaccAccountGetNotes(acc_a),
4933 : : xaccAccountGetNotes(acc_b)))
4934 : 0 : continue;
4935 : 1 : if (priv_a->type != priv_b->type)
4936 : 0 : continue;
4937 : :
4938 : : /* consolidate children */
4939 : 1 : if (!priv_b->children.empty())
4940 : : {
4941 : 1 : auto work = priv_b->children;
4942 : 3 : for (auto w : work)
4943 : 2 : gnc_account_append_child (acc_a, w);
4944 : :
4945 : 1 : qof_event_gen (&acc_a->inst, QOF_EVENT_MODIFY, nullptr);
4946 : 1 : qof_event_gen (&acc_b->inst, QOF_EVENT_MODIFY, nullptr);
4947 : 1 : }
4948 : :
4949 : : /* recurse to do the children's children */
4950 : 1 : gnc_account_merge_children (acc_a);
4951 : :
4952 : : /* consolidate transactions */
4953 : 1 : while (!priv_b->splits.empty())
4954 : 0 : xaccSplitSetAccount (priv_b->splits.front(), acc_a);
4955 : :
4956 : : /* move back one before removal. next iteration around the loop
4957 : : * will get the node after node_b */
4958 : 1 : it_b--;
4959 : :
4960 : : /* The destroy function will remove from list -- node_a is ok,
4961 : : * it's before node_b */
4962 : 1 : xaccAccountBeginEdit (acc_b);
4963 : 1 : xaccAccountDestroy (acc_b);
4964 : : }
4965 : : }
4966 : : }
4967 : :
4968 : : /* ================================================================ */
4969 : : /* Transaction Traversal functions */
4970 : :
4971 : :
4972 : : static void
4973 : 23 : xaccSplitsBeginStagedTransactionTraversals (SplitsVec& splits)
4974 : : {
4975 : 57 : for (auto s : splits)
4976 : : {
4977 : 34 : Transaction *trans = s->parent;
4978 : :
4979 : 34 : if (trans)
4980 : 34 : trans->marker = 0;
4981 : : }
4982 : 23 : }
4983 : :
4984 : : /* original function */
4985 : : void
4986 : 23 : xaccAccountBeginStagedTransactionTraversals (const Account *account)
4987 : : {
4988 : 23 : if (!account)
4989 : 0 : return;
4990 : 23 : xaccSplitsBeginStagedTransactionTraversals(GET_PRIVATE (account)->splits);
4991 : : }
4992 : :
4993 : : gboolean
4994 : 0 : xaccTransactionTraverse (Transaction *trans, int stage)
4995 : : {
4996 : 0 : if (trans == nullptr) return FALSE;
4997 : :
4998 : 0 : if (trans->marker < stage)
4999 : : {
5000 : 0 : trans->marker = stage;
5001 : 0 : return TRUE;
5002 : : }
5003 : :
5004 : 0 : return FALSE;
5005 : : }
5006 : :
5007 : : /* Replacement for xaccGroupBeginStagedTransactionTraversals */
5008 : : void
5009 : 54 : gnc_account_tree_begin_staged_transaction_traversals (Account *account)
5010 : : {
5011 : 1258 : auto do_one_account = [](auto acc)
5012 : 1258 : { gnc_account_foreach_split (acc, [](auto s){ s->parent->marker = 0; }); };
5013 : 54 : gnc_account_foreach_descendant (account, do_one_account);
5014 : 54 : }
5015 : :
5016 : : int
5017 : 23 : xaccAccountStagedTransactionTraversal (const Account *acc,
5018 : : unsigned int stage,
5019 : : TransactionCallback thunk,
5020 : : void *cb_data)
5021 : : {
5022 : 23 : if (!acc) return 0;
5023 : :
5024 : : // iterate on copy of splits. some callers modify the splitsvec.
5025 : 23 : auto splits = GET_PRIVATE(acc)->splits;
5026 : 50 : for (auto s : splits)
5027 : : {
5028 : 28 : auto trans = s->parent;
5029 : 28 : if (trans && (trans->marker < stage))
5030 : : {
5031 : 20 : trans->marker = stage;
5032 : 20 : if (thunk)
5033 : : {
5034 : 20 : auto retval = thunk(trans, cb_data);
5035 : 20 : if (retval) return retval;
5036 : : }
5037 : : }
5038 : : }
5039 : :
5040 : 22 : return 0;
5041 : 23 : }
5042 : :
5043 : : int
5044 : 1304 : gnc_account_tree_staged_transaction_traversal (const Account *acc,
5045 : : unsigned int stage,
5046 : : TransactionCallback thunk,
5047 : : void *cb_data)
5048 : : {
5049 : : const AccountPrivate *priv;
5050 : : Transaction *trans;
5051 : : int retval;
5052 : :
5053 : 1304 : if (!acc) return 0;
5054 : :
5055 : : /* depth first traversal */
5056 : 1304 : priv = GET_PRIVATE(acc);
5057 : 2551 : for (auto acc_p : priv->children)
5058 : : {
5059 : 1250 : retval = gnc_account_tree_staged_transaction_traversal(acc_p, stage, thunk, cb_data);
5060 : 1250 : if (retval) return retval;
5061 : : }
5062 : :
5063 : : /* Now this account */
5064 : 3387 : for (auto s : priv->splits)
5065 : : {
5066 : 2087 : trans = s->parent;
5067 : 2087 : if (trans && (trans->marker < stage))
5068 : : {
5069 : 1011 : trans->marker = stage;
5070 : 1011 : if (thunk)
5071 : : {
5072 : 1011 : retval = thunk(trans, cb_data);
5073 : 1011 : if (retval) return retval;
5074 : : }
5075 : : }
5076 : : }
5077 : :
5078 : 1300 : return 0;
5079 : : }
5080 : :
5081 : : time64
5082 : 0 : gnc_account_get_earliest_date (const Account* account)
5083 : : {
5084 : 0 : g_return_val_if_fail (GNC_IS_ACCOUNT(account), INT64_MAX);
5085 : 0 : const auto& splits = xaccAccountGetSplits (account);
5086 : 0 : return splits.empty() ? INT64_MAX : xaccTransGetDate (xaccSplitGetParent (splits.front()));
5087 : : }
5088 : :
5089 : : /********************************************************************\
5090 : : \********************************************************************/
5091 : :
5092 : : int
5093 : 54 : xaccAccountTreeForEachTransaction (Account *acc,
5094 : : int (*proc)(Transaction *t, void *data),
5095 : : void *data)
5096 : : {
5097 : 54 : if (!acc || !proc) return 0;
5098 : :
5099 : 54 : gnc_account_tree_begin_staged_transaction_traversals (acc);
5100 : 54 : return gnc_account_tree_staged_transaction_traversal (acc, 42, proc, data);
5101 : : }
5102 : :
5103 : :
5104 : : gint
5105 : 23 : xaccAccountForEachTransaction(const Account *acc, TransactionCallback proc,
5106 : : void *data)
5107 : : {
5108 : 23 : if (!acc || !proc) return 0;
5109 : 23 : xaccAccountBeginStagedTransactionTraversals (acc);
5110 : 23 : return xaccAccountStagedTransactionTraversal(acc, 42, proc, data);
5111 : : }
5112 : :
5113 : : /* ================================================================ */
5114 : : /* The following functions are used by
5115 : : * src/import-export/import-backend.c to manipulate the contra-account
5116 : : * matching data. See src/import-export/import-backend.c for explanations.
5117 : : */
5118 : :
5119 : : #define IMAP_FRAME "import-map"
5120 : : #define IMAP_FRAME_BAYES "import-map-bayes"
5121 : :
5122 : : /* Look up an Account in the map */
5123 : : Account*
5124 : 7 : gnc_account_imap_find_account (Account *acc,
5125 : : const char *category,
5126 : : const char *key)
5127 : : {
5128 : 7 : if (!acc || !key) return nullptr;
5129 : 18 : std::vector<std::string> path {IMAP_FRAME};
5130 : 6 : if (category)
5131 : 8 : path.push_back (category);
5132 : 6 : path.push_back (key);
5133 : 6 : return get_kvp_account_path (acc, path);
5134 : 24 : }
5135 : :
5136 : : Account*
5137 : 0 : gnc_account_imap_find_any (QofBook *book, const char* category, const char *key)
5138 : : {
5139 : 0 : Account *account = nullptr;
5140 : :
5141 : : /* Get list of Accounts */
5142 : 0 : auto root = gnc_book_get_root_account (book);
5143 : 0 : auto accts = gnc_account_get_descendants_sorted (root);
5144 : :
5145 : : /* Go through list of accounts */
5146 : 0 : for (auto ptr = accts; ptr; ptr = g_list_next (ptr))
5147 : : {
5148 : 0 : auto tmp_acc = static_cast<Account*> (ptr->data);
5149 : :
5150 : 0 : if (gnc_account_imap_find_account (tmp_acc, category, key))
5151 : : {
5152 : 0 : account = tmp_acc;
5153 : 0 : break;
5154 : : }
5155 : : }
5156 : 0 : g_list_free (accts);
5157 : :
5158 : 0 : return account;
5159 : : }
5160 : :
5161 : : /* Store an Account in the map */
5162 : : void
5163 : 9 : gnc_account_imap_add_account (Account *acc,
5164 : : const char *category,
5165 : : const char *key,
5166 : : Account *added_acc)
5167 : : {
5168 : 9 : if (!acc || !key || !added_acc || !*key) return;
5169 : :
5170 : 42 : auto path = category ? Path{IMAP_FRAME, category, key} : Path{IMAP_FRAME, key};
5171 : :
5172 : 7 : set_kvp_account_path (acc, path, added_acc);
5173 : 35 : }
5174 : :
5175 : : /* Remove a reference to an Account in the map */
5176 : : void
5177 : 4 : gnc_account_imap_delete_account (Account *acc,
5178 : : const char *category,
5179 : : const char *key)
5180 : : {
5181 : 4 : if (!acc || !key) return;
5182 : :
5183 : 18 : auto path = category ? Path{IMAP_FRAME, category, key} : Path{IMAP_FRAME, key};
5184 : 3 : if (qof_instance_has_path_slot (QOF_INSTANCE (acc), path))
5185 : : {
5186 : 3 : qof_instance_slot_path_delete (QOF_INSTANCE (acc), path);
5187 : 3 : if (category)
5188 : 8 : qof_instance_slot_path_delete_if_empty (QOF_INSTANCE (acc), {IMAP_FRAME, category});
5189 : 9 : qof_instance_slot_path_delete_if_empty (QOF_INSTANCE (acc), {IMAP_FRAME});
5190 : : }
5191 : 3 : qof_instance_set_dirty (QOF_INSTANCE (acc));
5192 : 24 : }
5193 : :
5194 : : /*--------------------------------------------------------------------------
5195 : : Below here is the bayes transaction to account matching system
5196 : : --------------------------------------------------------------------------*/
5197 : :
5198 : :
5199 : : /** intermediate values used to calculate the bayes probability of a given account
5200 : : where p(AB) = (a*b)/[a*b + (1-a)(1-b)], product is (a*b),
5201 : : product_difference is (1-a) * (1-b)
5202 : : */
5203 : : struct AccountProbability
5204 : : {
5205 : : double product; /* product of probabilities */
5206 : : double product_difference; /* product of (1-probabilities) */
5207 : : };
5208 : :
5209 : : struct AccountTokenCount
5210 : : {
5211 : : std::string account_guid;
5212 : : int64_t token_count; /** occurrences of a given token for this account_guid */
5213 : : };
5214 : :
5215 : : /** total_count and the token_count for a given account let us calculate the
5216 : : * probability of a given account with any single token
5217 : : */
5218 : : struct TokenAccountsInfo
5219 : : {
5220 : : std::vector<AccountTokenCount> accounts;
5221 : : int64_t total_count;
5222 : : };
5223 : :
5224 : : /** holds an account guid and its corresponding integer probability
5225 : : the integer probability is some factor of 10
5226 : : */
5227 : : struct AccountInfo
5228 : : {
5229 : : std::string account_guid;
5230 : : int32_t probability;
5231 : : };
5232 : :
5233 : : static void
5234 : 11 : build_token_info(char const * suffix, KvpValue * value, TokenAccountsInfo & tokenInfo)
5235 : : {
5236 : 11 : if (strlen(suffix) == GUID_ENCODING_LENGTH)
5237 : : {
5238 : 10 : tokenInfo.total_count += value->get<int64_t>();
5239 : : /*By convention, the key ends with the account GUID.*/
5240 : 30 : tokenInfo.accounts.emplace_back(AccountTokenCount{std::string{suffix}, value->get<int64_t>()});
5241 : : }
5242 : 11 : }
5243 : :
5244 : : /** We scale the probability values by probability_factor.
5245 : : ie. with probability_factor of 100000, 10% would be
5246 : : 0.10 * 100000 = 10000 */
5247 : : static constexpr int probability_factor = 100000;
5248 : :
5249 : : static FinalProbabilityVec
5250 : 8 : build_probabilities(ProbabilityVec const & first_pass)
5251 : : {
5252 : 8 : FinalProbabilityVec ret;
5253 : 16 : for (auto const & first_pass_prob : first_pass)
5254 : : {
5255 : 8 : auto const & account_probability = first_pass_prob.second;
5256 : : /* P(AB) = A*B / [A*B + (1-A)*(1-B)]
5257 : : * NOTE: so we only keep track of a running product(A*B*C...)
5258 : : * and product difference ((1-A)(1-B)...)
5259 : : */
5260 : 8 : int32_t probability = (account_probability.product /
5261 : 8 : (account_probability.product + account_probability.product_difference)) * probability_factor;
5262 : 8 : ret.push_back({first_pass_prob.first, probability});
5263 : : }
5264 : 8 : return ret;
5265 : 0 : }
5266 : :
5267 : : static AccountInfo
5268 : 8 : highest_probability(FinalProbabilityVec const & probabilities)
5269 : : {
5270 : 16 : AccountInfo ret {"", std::numeric_limits<int32_t>::min()};
5271 : 16 : for (auto const & prob : probabilities)
5272 : 8 : if (prob.second > ret.probability)
5273 : 8 : ret = AccountInfo {prob.first, prob.second};
5274 : 8 : return ret;
5275 : 0 : }
5276 : :
5277 : : static ProbabilityVec
5278 : 9 : get_first_pass_probabilities(Account* acc, GList * tokens)
5279 : : {
5280 : 9 : ProbabilityVec ret;
5281 : : /* find the probability for each account that contains any of the tokens
5282 : : * in the input tokens list. */
5283 : 21 : for (auto current_token = tokens; current_token; current_token = current_token->next)
5284 : : {
5285 : 12 : TokenAccountsInfo tokenInfo{};
5286 : 24 : auto path = std::string{IMAP_FRAME_BAYES "/"} + static_cast <char const *> (current_token->data) + "/";
5287 : 12 : qof_instance_foreach_slot_prefix (QOF_INSTANCE (acc), path, &build_token_info, tokenInfo);
5288 : 22 : for (auto const & current_account_token : tokenInfo.accounts)
5289 : : {
5290 : 10 : auto item = std::find_if(ret.begin(), ret.end(), [¤t_account_token]
5291 : : (std::pair<std::string, AccountProbability> const & a) {
5292 : 2 : return current_account_token.account_guid == a.first;
5293 : : });
5294 : 10 : if (item != ret.end())
5295 : : {/* This account is already in the map */
5296 : 6 : item->second.product = ((double)current_account_token.token_count /
5297 : 2 : (double)tokenInfo.total_count) * item->second.product;
5298 : 2 : item->second.product_difference = ((double)1 - ((double)current_account_token.token_count /
5299 : 2 : (double)tokenInfo.total_count)) * item->second.product_difference;
5300 : : }
5301 : : else
5302 : : {
5303 : : /* add a new entry */
5304 : : AccountProbability new_probability;
5305 : 8 : new_probability.product = ((double)current_account_token.token_count /
5306 : 8 : (double)tokenInfo.total_count);
5307 : 8 : new_probability.product_difference = 1 - (new_probability.product);
5308 : 8 : ret.push_back({current_account_token.account_guid, std::move(new_probability)});
5309 : : }
5310 : : } /* for all accounts in tokenInfo */
5311 : 12 : }
5312 : 9 : return ret;
5313 : 0 : }
5314 : :
5315 : : static std::string
5316 : 5 : look_for_old_separator_descendants (Account *root, std::string const & full_name, const gchar *separator)
5317 : : {
5318 : : GList *top_accounts, *ptr;
5319 : 5 : gint found_len = 0;
5320 : : gchar found_sep;
5321 : 5 : top_accounts = gnc_account_get_descendants (root);
5322 : 5 : PINFO("Incoming full_name is '%s', current separator is '%s'", full_name.c_str (), separator);
5323 : : /* Go through list of top level accounts */
5324 : 40 : for (ptr = top_accounts; ptr; ptr = g_list_next (ptr))
5325 : : {
5326 : 35 : const gchar *name = xaccAccountGetName (static_cast <Account const *> (ptr->data));
5327 : : // we are looking for the longest top level account that matches
5328 : 35 : if (g_str_has_prefix (full_name.c_str (), name))
5329 : : {
5330 : 6 : gint name_len = strlen (name);
5331 : 6 : const gchar old_sep = full_name[name_len];
5332 : 6 : if (!g_ascii_isalnum (old_sep)) // test for non alpha numeric
5333 : : {
5334 : 6 : if (name_len > found_len)
5335 : : {
5336 : 6 : found_sep = full_name[name_len];
5337 : 6 : found_len = name_len;
5338 : : }
5339 : : }
5340 : : }
5341 : : }
5342 : 5 : g_list_free (top_accounts); // Free the List
5343 : 5 : std::string new_name {full_name};
5344 : 5 : if (found_len > 1)
5345 : 5 : std::replace (new_name.begin (), new_name.end (), found_sep, *separator);
5346 : 5 : PINFO ("Return full_name is '%s'", new_name.c_str ());
5347 : 10 : return new_name;
5348 : 0 : }
5349 : :
5350 : : static std::string
5351 : 6 : get_guid_from_account_name (Account * root, std::string const & name)
5352 : : {
5353 : 6 : auto map_account = gnc_account_lookup_by_full_name (root, name.c_str ());
5354 : 6 : if (!map_account)
5355 : : {
5356 : : auto temp_account_name = look_for_old_separator_descendants (root, name,
5357 : 5 : gnc_get_account_separator_string ());
5358 : 5 : map_account = gnc_account_lookup_by_full_name (root, temp_account_name.c_str ());
5359 : 5 : }
5360 : 6 : auto temp_guid = gnc::GUID {*xaccAccountGetGUID (map_account)};
5361 : 12 : return temp_guid.to_string ();
5362 : : }
5363 : :
5364 : : static FlatKvpEntry
5365 : 7 : convert_entry (KvpEntry entry, Account* root)
5366 : : {
5367 : : /*We need to make a copy here.*/
5368 : 7 : auto account_name = entry.first.back();
5369 : 7 : if (!gnc::GUID::is_valid_guid (account_name))
5370 : : {
5371 : : /* Earlier version stored the account name in the import map, and
5372 : : * there were early beta versions of 2.7 that stored a GUID.
5373 : : * If there is no GUID, we assume it's an account name. */
5374 : : /* Take off the account name and replace it with the GUID */
5375 : 6 : entry.first.pop_back();
5376 : 6 : auto guid_str = get_guid_from_account_name (root, account_name);
5377 : 6 : entry.first.emplace_back (guid_str);
5378 : 6 : }
5379 : 7 : std::string new_key {std::accumulate (entry.first.begin(), entry.first.end(), std::string {})};
5380 : 7 : new_key = IMAP_FRAME_BAYES + new_key;
5381 : 14 : return {new_key, entry.second};
5382 : 7 : }
5383 : :
5384 : : static std::vector<FlatKvpEntry>
5385 : 2 : get_flat_imap (Account * acc)
5386 : : {
5387 : 2 : auto frame = qof_instance_get_slots (QOF_INSTANCE (acc));
5388 : 4 : auto slot = frame->get_slot ({IMAP_FRAME_BAYES});
5389 : 2 : if (!slot)
5390 : 1 : return {};
5391 : 1 : auto imap_frame = slot->get<KvpFrame*> ();
5392 : 1 : auto flat_kvp = imap_frame->flatten_kvp ();
5393 : 1 : auto root = gnc_account_get_root (acc);
5394 : 1 : std::vector <FlatKvpEntry> ret;
5395 : 8 : for (auto const & flat_entry : flat_kvp)
5396 : : {
5397 : 7 : auto converted_entry = convert_entry (flat_entry, root);
5398 : : /*If the entry was invalid, we don't perpetuate it.*/
5399 : 7 : if (converted_entry.first.size())
5400 : 7 : ret.emplace_back (converted_entry);
5401 : 7 : }
5402 : 1 : return ret;
5403 : 1 : }
5404 : :
5405 : : static bool
5406 : 14 : convert_imap_account_bayes_to_flat (Account *acc)
5407 : : {
5408 : 14 : auto frame = qof_instance_get_slots (QOF_INSTANCE (acc));
5409 : 14 : if (!frame->get_keys().size())
5410 : 12 : return false;
5411 : 2 : auto flat_imap = get_flat_imap(acc);
5412 : 2 : if (!flat_imap.size ())
5413 : 1 : return false;
5414 : 1 : xaccAccountBeginEdit(acc);
5415 : 2 : frame->set({IMAP_FRAME_BAYES}, nullptr);
5416 : 1 : std::for_each(flat_imap.begin(), flat_imap.end(),
5417 : 7 : [&frame] (FlatKvpEntry const & entry) {
5418 : 21 : frame->set({entry.first.c_str()}, entry.second);
5419 : 21 : });
5420 : 1 : qof_instance_set_dirty (QOF_INSTANCE (acc));
5421 : 1 : xaccAccountCommitEdit(acc);
5422 : 1 : return true;
5423 : 2 : }
5424 : :
5425 : : /*
5426 : : * Checks for import map data and converts them when found.
5427 : : */
5428 : : static bool
5429 : 2 : imap_convert_bayes_to_flat (QofBook * book)
5430 : : {
5431 : 2 : auto root = gnc_book_get_root_account (book);
5432 : 2 : auto accts = gnc_account_get_descendants_sorted (root);
5433 : 2 : bool ret = false;
5434 : 16 : for (auto ptr = accts; ptr; ptr = g_list_next (ptr))
5435 : : {
5436 : 14 : Account *acc = static_cast <Account*> (ptr->data);
5437 : 14 : if (convert_imap_account_bayes_to_flat (acc))
5438 : : {
5439 : 1 : ret = true;
5440 : 1 : gnc_features_set_used (book, GNC_FEATURE_GUID_FLAT_BAYESIAN);
5441 : : }
5442 : : }
5443 : 2 : g_list_free (accts);
5444 : 2 : return ret;
5445 : : }
5446 : :
5447 : : void
5448 : 1 : gnc_account_reset_convert_bayes_to_flat (void)
5449 : : {
5450 : 1 : imap_convert_bayes_to_flat_run = false;
5451 : 1 : }
5452 : :
5453 : : /*
5454 : : * Here we check to see the state of import map data.
5455 : : *
5456 : : * If the GUID_FLAT_BAYESIAN feature flag is set, everything
5457 : : * should be fine.
5458 : : *
5459 : : * If it is not set, there are two possibilities: import data
5460 : : * are present from a previous version or not. If they are,
5461 : : * they are converted, and the feature flag set. If there are
5462 : : * no previous data, nothing is done.
5463 : : */
5464 : : static void
5465 : 21 : check_import_map_data (QofBook *book)
5466 : : {
5467 : 21 : if (gnc_features_check_used (book, GNC_FEATURE_GUID_FLAT_BAYESIAN) ||
5468 : : imap_convert_bayes_to_flat_run)
5469 : 19 : return;
5470 : :
5471 : : /* This function will set GNC_FEATURE_GUID_FLAT_BAYESIAN if necessary.*/
5472 : 2 : imap_convert_bayes_to_flat (book);
5473 : 2 : imap_convert_bayes_to_flat_run = true;
5474 : : }
5475 : :
5476 : : static constexpr double threshold = .90 * probability_factor; /* 90% */
5477 : :
5478 : : /** Look up an Account in the map */
5479 : : Account*
5480 : 9 : gnc_account_imap_find_account_bayes (Account *acc, GList *tokens)
5481 : : {
5482 : 9 : if (!acc)
5483 : 0 : return nullptr;
5484 : 9 : auto book = gnc_account_get_book(acc);
5485 : 9 : check_import_map_data (book);
5486 : 9 : auto first_pass = get_first_pass_probabilities(acc, tokens);
5487 : 9 : if (!first_pass.size())
5488 : 1 : return nullptr;
5489 : 8 : auto final_probabilities = build_probabilities(first_pass);
5490 : 8 : if (!final_probabilities.size())
5491 : 0 : return nullptr;
5492 : 8 : auto best = highest_probability(final_probabilities);
5493 : 8 : if (best.account_guid == "")
5494 : 0 : return nullptr;
5495 : 8 : if (best.probability < threshold)
5496 : 0 : return nullptr;
5497 : : gnc::GUID guid;
5498 : : try {
5499 : 8 : guid = gnc::GUID::from_string(best.account_guid);
5500 : 0 : } catch (gnc::guid_syntax_exception&) {
5501 : 0 : return nullptr;
5502 : 0 : }
5503 : 8 : auto account = xaccAccountLookup (reinterpret_cast<GncGUID*>(&guid), book);
5504 : 8 : return account;
5505 : 9 : }
5506 : :
5507 : : static void
5508 : 14 : change_imap_entry (Account *acc, std::string const & path, int64_t token_count)
5509 : : {
5510 : 14 : PINFO("Source Account is '%s', Count is '%" G_GINT64_FORMAT "'",
5511 : : xaccAccountGetName (acc), token_count);
5512 : :
5513 : : // check for existing guid entry
5514 : 42 : if (auto existing_token_count = get_kvp_int64_path (acc, {path}))
5515 : : {
5516 : 5 : PINFO("found existing value of '%" G_GINT64_FORMAT "'", *existing_token_count);
5517 : 5 : token_count += *existing_token_count;
5518 : : }
5519 : :
5520 : : // Add or Update the entry based on guid
5521 : 56 : set_kvp_int64_path (acc, {path}, token_count);
5522 : 42 : }
5523 : :
5524 : : /** Updates the imap for a given account using a list of tokens */
5525 : : void
5526 : 11 : gnc_account_imap_add_account_bayes (Account *acc,
5527 : : GList *tokens,
5528 : : Account *added_acc)
5529 : : {
5530 : : GList *current_token;
5531 : : gint64 token_count;
5532 : : char *account_fullname;
5533 : : char *guid_string;
5534 : :
5535 : 11 : ENTER(" ");
5536 : 11 : if (!acc)
5537 : : {
5538 : 0 : LEAVE(" ");
5539 : 0 : return;
5540 : : }
5541 : 11 : check_import_map_data (gnc_account_get_book(acc));
5542 : :
5543 : 11 : g_return_if_fail (added_acc != nullptr);
5544 : 10 : account_fullname = gnc_account_get_full_name(added_acc);
5545 : 10 : xaccAccountBeginEdit (acc);
5546 : :
5547 : 10 : PINFO("account name: '%s'", account_fullname);
5548 : :
5549 : 10 : guid_string = guid_to_string (xaccAccountGetGUID (added_acc));
5550 : :
5551 : : /* process each token in the list */
5552 : 24 : for (current_token = g_list_first(tokens); current_token;
5553 : 14 : current_token = current_token->next)
5554 : : {
5555 : 14 : char* token = static_cast<char*>(current_token->data);
5556 : : /* Jump to next iteration if the pointer is not valid or if the
5557 : : string is empty. In HBCI import we almost always get an empty
5558 : : string, which doesn't work in the kvp loopkup later. So we
5559 : : skip this case here. */
5560 : 14 : if (!token || !token[0])
5561 : 0 : continue;
5562 : : /* start off with one token for this account */
5563 : 14 : token_count = 1;
5564 : 14 : PINFO("adding token '%s'", token);
5565 : 14 : auto path = std::string {IMAP_FRAME_BAYES} + '/' + token + '/' + guid_string;
5566 : : /* change the imap entry for the account */
5567 : 14 : change_imap_entry (acc, path, token_count);
5568 : 14 : }
5569 : : /* free up the account fullname and guid string */
5570 : 10 : xaccAccountCommitEdit (acc);
5571 : 10 : gnc_features_set_used (gnc_account_get_book(acc), GNC_FEATURE_GUID_FLAT_BAYESIAN);
5572 : 10 : g_free (account_fullname);
5573 : 10 : g_free (guid_string);
5574 : 10 : LEAVE(" ");
5575 : : }
5576 : :
5577 : : /*******************************************************************************/
5578 : :
5579 : : static void
5580 : 0 : build_non_bayes (const char *key, const GValue *value, gpointer user_data)
5581 : : {
5582 : 0 : if (!G_VALUE_HOLDS_BOXED (value))
5583 : 0 : return;
5584 : : QofBook *book;
5585 : 0 : GncGUID *guid = nullptr;
5586 : 0 : gchar *guid_string = nullptr;
5587 : 0 : auto imapInfo = (GncImapInfo*)user_data;
5588 : : // Get the book
5589 : 0 : book = qof_instance_get_book (imapInfo->source_account);
5590 : :
5591 : 0 : guid = (GncGUID*)g_value_get_boxed (value);
5592 : 0 : guid_string = guid_to_string (guid);
5593 : :
5594 : 0 : PINFO("build_non_bayes: match string '%s', match account guid: '%s'",
5595 : : (char*)key, guid_string);
5596 : :
5597 : 0 : auto imapInfo_node = static_cast <GncImapInfo*> (g_malloc(sizeof(GncImapInfo)));
5598 : :
5599 : 0 : imapInfo_node->source_account = imapInfo->source_account;
5600 : 0 : imapInfo_node->map_account = xaccAccountLookup (guid, book);
5601 : 0 : imapInfo_node->head = g_strdup (imapInfo->head);
5602 : 0 : imapInfo_node->match_string = g_strdup (key);
5603 : 0 : imapInfo_node->category = g_strdup (imapInfo->category);
5604 : 0 : imapInfo_node->count = g_strdup (" ");
5605 : :
5606 : 0 : imapInfo->list = g_list_prepend (imapInfo->list, imapInfo_node);
5607 : :
5608 : 0 : g_free (guid_string);
5609 : : }
5610 : :
5611 : : static void
5612 : 1 : build_bayes (const char *suffix, KvpValue * value, GncImapInfo & imapInfo)
5613 : : {
5614 : 1 : size_t guid_start = strlen(suffix) - GUID_ENCODING_LENGTH;
5615 : 2 : std::string account_guid {&suffix[guid_start]};
5616 : : GncGUID guid;
5617 : : try
5618 : : {
5619 : 1 : guid = gnc::GUID::from_string (account_guid);
5620 : : }
5621 : 0 : catch (const gnc::guid_syntax_exception& err)
5622 : : {
5623 : 0 : PWARN("Invalid GUID string from %s%s", IMAP_FRAME_BAYES, suffix);
5624 : 0 : }
5625 : 1 : auto map_account = xaccAccountLookup (&guid, gnc_account_get_book (imapInfo.source_account));
5626 : 1 : auto imap_node = static_cast <GncImapInfo*> (g_malloc (sizeof (GncImapInfo)));
5627 : 1 : auto count = value->get <int64_t> ();
5628 : 1 : imap_node->source_account = imapInfo.source_account;
5629 : 1 : imap_node->map_account = map_account;
5630 : 1 : imap_node->head = g_strdup_printf ("%s%s", IMAP_FRAME_BAYES, suffix);
5631 : 1 : imap_node->match_string = g_strndup (&suffix[1], guid_start - 2);
5632 : 1 : imap_node->category = g_strdup(" ");
5633 : 1 : imap_node->count = g_strdup_printf ("%" G_GINT64_FORMAT, count);
5634 : 1 : imapInfo.list = g_list_prepend (imapInfo.list, imap_node);
5635 : 1 : }
5636 : :
5637 : 1 : void gnc_account_imap_info_destroy (GncImapInfo* imapInfo)
5638 : : {
5639 : 1 : g_free (imapInfo->head);
5640 : 1 : g_free (imapInfo->category);
5641 : 1 : g_free (imapInfo->match_string);
5642 : 1 : g_free (imapInfo->count);
5643 : 1 : g_free (imapInfo);
5644 : 1 : }
5645 : :
5646 : : GList *
5647 : 1 : gnc_account_imap_get_info_bayes (Account *acc)
5648 : : {
5649 : 1 : check_import_map_data (gnc_account_get_book (acc));
5650 : : /* A dummy object which is used to hold the specified account, and the list
5651 : : * of data about which we care. */
5652 : 1 : GncImapInfo imapInfo {acc, nullptr};
5653 : 2 : qof_instance_foreach_slot_prefix (QOF_INSTANCE (acc), IMAP_FRAME_BAYES, &build_bayes, imapInfo);
5654 : 2 : return g_list_reverse(imapInfo.list);
5655 : : }
5656 : :
5657 : : GList *
5658 : 0 : gnc_account_imap_get_info (Account *acc, const char *category)
5659 : : {
5660 : 0 : GList *list = nullptr;
5661 : :
5662 : : GncImapInfo imapInfo;
5663 : :
5664 : 0 : std::vector<std::string> path {IMAP_FRAME};
5665 : 0 : if (category)
5666 : 0 : path.emplace_back (category);
5667 : :
5668 : 0 : imapInfo.source_account = acc;
5669 : 0 : imapInfo.list = list;
5670 : :
5671 : 0 : imapInfo.head = g_strdup (IMAP_FRAME);
5672 : 0 : imapInfo.category = g_strdup (category);
5673 : :
5674 : 0 : if (qof_instance_has_path_slot (QOF_INSTANCE (acc), path))
5675 : : {
5676 : 0 : qof_instance_foreach_slot (QOF_INSTANCE(acc), IMAP_FRAME, category,
5677 : : build_non_bayes, &imapInfo);
5678 : : }
5679 : 0 : g_free (imapInfo.head);
5680 : 0 : g_free (imapInfo.category);
5681 : 0 : return g_list_reverse(imapInfo.list);
5682 : 0 : }
5683 : :
5684 : : /*******************************************************************************/
5685 : :
5686 : : gchar *
5687 : 9 : gnc_account_get_map_entry (Account *acc, const char *head, const char *category)
5688 : : {
5689 : 69 : return g_strdup (category ?
5690 : : get_kvp_string_path (acc, {head, category}) :
5691 : : get_kvp_string_path (acc, {head}));
5692 : 45 : }
5693 : :
5694 : :
5695 : : void
5696 : 0 : gnc_account_delete_map_entry (Account *acc, char *head, char *category,
5697 : : char *match_string, gboolean empty)
5698 : : {
5699 : 0 : if (acc != nullptr)
5700 : : {
5701 : 0 : std::vector<std::string> path {head};
5702 : 0 : if (category)
5703 : 0 : path.emplace_back (category);
5704 : 0 : if (match_string)
5705 : 0 : path.emplace_back (match_string);
5706 : :
5707 : 0 : if (qof_instance_has_path_slot (QOF_INSTANCE (acc), path))
5708 : : {
5709 : 0 : xaccAccountBeginEdit (acc);
5710 : 0 : if (empty)
5711 : 0 : qof_instance_slot_path_delete_if_empty (QOF_INSTANCE(acc), path);
5712 : : else
5713 : 0 : qof_instance_slot_path_delete (QOF_INSTANCE(acc), path);
5714 : 0 : PINFO("Account is '%s', head is '%s', category is '%s', match_string is'%s'",
5715 : : xaccAccountGetName (acc), head, category, match_string);
5716 : 0 : qof_instance_set_dirty (QOF_INSTANCE(acc));
5717 : 0 : xaccAccountCommitEdit (acc);
5718 : : }
5719 : 0 : }
5720 : 0 : }
5721 : :
5722 : : void
5723 : 0 : gnc_account_delete_all_bayes_maps (Account *acc)
5724 : : {
5725 : 0 : if (acc != nullptr)
5726 : : {
5727 : 0 : auto slots = qof_instance_get_slots_prefix (QOF_INSTANCE (acc), IMAP_FRAME_BAYES);
5728 : 0 : if (!slots.size()) return;
5729 : 0 : xaccAccountBeginEdit (acc);
5730 : 0 : for (auto const & entry : slots)
5731 : : {
5732 : 0 : qof_instance_slot_path_delete (QOF_INSTANCE (acc), {entry.first});
5733 : : }
5734 : 0 : qof_instance_set_dirty (QOF_INSTANCE(acc));
5735 : 0 : xaccAccountCommitEdit (acc);
5736 : 0 : }
5737 : 0 : }
5738 : :
5739 : : /* ================================================================ */
5740 : : /* QofObject function implementation and registration */
5741 : :
5742 : : static void
5743 : 1347 : destroy_all_child_accounts (Account *acc, gpointer data)
5744 : : {
5745 : 1347 : xaccAccountBeginEdit (acc);
5746 : 1347 : xaccAccountDestroy (acc);
5747 : 1347 : }
5748 : :
5749 : : static void
5750 : 154 : gnc_account_book_end(QofBook* book)
5751 : : {
5752 : 154 : Account *root_account = gnc_book_get_root_account (book);
5753 : : GList *accounts;
5754 : :
5755 : 154 : if (!root_account)
5756 : 63 : return;
5757 : :
5758 : 91 : accounts = gnc_account_get_descendants (root_account);
5759 : :
5760 : 91 : if (accounts)
5761 : : {
5762 : 90 : accounts = g_list_reverse (accounts);
5763 : 90 : g_list_foreach (accounts, (GFunc)destroy_all_child_accounts, nullptr);
5764 : 90 : g_list_free (accounts);
5765 : : }
5766 : 91 : xaccAccountBeginEdit (root_account);
5767 : 91 : xaccAccountDestroy (root_account);
5768 : : }
5769 : :
5770 : : #ifdef _MSC_VER
5771 : : /* MSVC compiler doesn't have C99 "designated initializers"
5772 : : * so we wrap them in a macro that is empty on MSVC. */
5773 : : # define DI(x) /* */
5774 : : #else
5775 : : # define DI(x) x
5776 : : #endif
5777 : : static QofObject account_object_def =
5778 : : {
5779 : : DI(.interface_version = ) QOF_OBJECT_VERSION,
5780 : : DI(.e_type = ) GNC_ID_ACCOUNT,
5781 : : DI(.type_label = ) "Account",
5782 : : DI(.create = ) (void*(*)(QofBook*)) xaccMallocAccount,
5783 : : DI(.book_begin = ) nullptr,
5784 : : DI(.book_end = ) gnc_account_book_end,
5785 : : DI(.is_dirty = ) qof_collection_is_dirty,
5786 : : DI(.mark_clean = ) qof_collection_mark_clean,
5787 : : DI(.foreach = ) qof_collection_foreach,
5788 : : DI(.printable = ) (const char * (*)(gpointer)) xaccAccountGetName,
5789 : : DI(.version_cmp = ) (int (*)(gpointer, gpointer)) qof_instance_version_cmp,
5790 : : };
5791 : :
5792 : 82 : gboolean xaccAccountRegister (void)
5793 : : {
5794 : : static QofParam params[] =
5795 : : {
5796 : : {
5797 : : ACCOUNT_NAME_, QOF_TYPE_STRING,
5798 : : (QofAccessFunc) xaccAccountGetName,
5799 : : (QofSetterFunc) xaccAccountSetName
5800 : : },
5801 : : {
5802 : : ACCOUNT_CODE_, QOF_TYPE_STRING,
5803 : : (QofAccessFunc) xaccAccountGetCode,
5804 : : (QofSetterFunc) xaccAccountSetCode
5805 : : },
5806 : : {
5807 : : ACCOUNT_DESCRIPTION_, QOF_TYPE_STRING,
5808 : : (QofAccessFunc) xaccAccountGetDescription,
5809 : : (QofSetterFunc) xaccAccountSetDescription
5810 : : },
5811 : : {
5812 : : ACCOUNT_COLOR_, QOF_TYPE_STRING,
5813 : : (QofAccessFunc) xaccAccountGetColor,
5814 : : (QofSetterFunc) xaccAccountSetColor
5815 : : },
5816 : : {
5817 : : ACCOUNT_FILTER_, QOF_TYPE_STRING,
5818 : : (QofAccessFunc) xaccAccountGetFilter,
5819 : : (QofSetterFunc) xaccAccountSetFilter
5820 : : },
5821 : : {
5822 : : ACCOUNT_SORT_ORDER_, QOF_TYPE_STRING,
5823 : : (QofAccessFunc) xaccAccountGetSortOrder,
5824 : : (QofSetterFunc) xaccAccountSetSortOrder
5825 : : },
5826 : : {
5827 : : ACCOUNT_SORT_REVERSED_, QOF_TYPE_BOOLEAN,
5828 : : (QofAccessFunc) xaccAccountGetSortReversed,
5829 : : (QofSetterFunc) xaccAccountSetSortReversed
5830 : : },
5831 : : {
5832 : : ACCOUNT_NOTES_, QOF_TYPE_STRING,
5833 : : (QofAccessFunc) xaccAccountGetNotes,
5834 : : (QofSetterFunc) xaccAccountSetNotes
5835 : : },
5836 : : {
5837 : : ACCOUNT_PRESENT_, QOF_TYPE_NUMERIC,
5838 : : (QofAccessFunc) xaccAccountGetPresentBalance, nullptr
5839 : : },
5840 : : {
5841 : : ACCOUNT_BALANCE_, QOF_TYPE_NUMERIC,
5842 : : (QofAccessFunc) xaccAccountGetBalance, nullptr
5843 : : },
5844 : : {
5845 : : ACCOUNT_CLEARED_, QOF_TYPE_NUMERIC,
5846 : : (QofAccessFunc) xaccAccountGetClearedBalance, nullptr
5847 : : },
5848 : : {
5849 : : ACCOUNT_RECONCILED_, QOF_TYPE_NUMERIC,
5850 : : (QofAccessFunc) xaccAccountGetReconciledBalance, nullptr
5851 : : },
5852 : : {
5853 : : ACCOUNT_TYPE_, QOF_TYPE_STRING,
5854 : : (QofAccessFunc) qofAccountGetTypeString,
5855 : : (QofSetterFunc) qofAccountSetType
5856 : : },
5857 : : {
5858 : : ACCOUNT_FUTURE_MINIMUM_, QOF_TYPE_NUMERIC,
5859 : : (QofAccessFunc) xaccAccountGetProjectedMinimumBalance, nullptr
5860 : : },
5861 : : {
5862 : : ACCOUNT_TAX_RELATED, QOF_TYPE_BOOLEAN,
5863 : : (QofAccessFunc) xaccAccountGetTaxRelated,
5864 : : (QofSetterFunc) xaccAccountSetTaxRelated
5865 : : },
5866 : : {
5867 : : ACCOUNT_OPENING_BALANCE_, QOF_TYPE_BOOLEAN,
5868 : : (QofAccessFunc) xaccAccountGetIsOpeningBalance,
5869 : : (QofSetterFunc) xaccAccountSetIsOpeningBalance
5870 : : },
5871 : : {
5872 : : ACCOUNT_SCU, QOF_TYPE_INT32,
5873 : : (QofAccessFunc) xaccAccountGetCommoditySCU,
5874 : : (QofSetterFunc) xaccAccountSetCommoditySCU
5875 : : },
5876 : : {
5877 : : ACCOUNT_NSCU, QOF_TYPE_BOOLEAN,
5878 : : (QofAccessFunc) xaccAccountGetNonStdSCU,
5879 : : (QofSetterFunc) xaccAccountSetNonStdSCU
5880 : : },
5881 : : {
5882 : : ACCOUNT_PARENT, GNC_ID_ACCOUNT,
5883 : : (QofAccessFunc) gnc_account_get_parent,
5884 : : (QofSetterFunc) qofAccountSetParent
5885 : : },
5886 : : {
5887 : : QOF_PARAM_BOOK, QOF_ID_BOOK,
5888 : : (QofAccessFunc) qof_instance_get_book, nullptr
5889 : : },
5890 : : {
5891 : : QOF_PARAM_GUID, QOF_TYPE_GUID,
5892 : : (QofAccessFunc) qof_instance_get_guid, nullptr
5893 : : },
5894 : : { nullptr },
5895 : : };
5896 : :
5897 : 82 : qof_class_register (GNC_ID_ACCOUNT, (QofSortFunc) qof_xaccAccountOrder, params);
5898 : :
5899 : 82 : return qof_object_register (&account_object_def);
5900 : : }
5901 : :
5902 : : /* ======================= UNIT TESTING ACCESS =======================
5903 : : * The following functions are for unit testing use only.
5904 : : */
5905 : : static AccountPrivate*
5906 : 11 : utest_account_get_private (Account *acc)
5907 : : {
5908 : 11 : return GET_PRIVATE (acc);
5909 : : }
5910 : :
5911 : : AccountTestFunctions*
5912 : 44 : _utest_account_fill_functions(void)
5913 : : {
5914 : 44 : AccountTestFunctions* func = g_new(AccountTestFunctions, 1);
5915 : :
5916 : 44 : func->get_private = utest_account_get_private;
5917 : 44 : func->coll_get_root_account = gnc_coll_get_root_account;
5918 : 44 : func->xaccFreeAccountChildren = xaccFreeAccountChildren;
5919 : 44 : func->xaccFreeAccount = xaccFreeAccount;
5920 : 44 : func->qofAccountSetParent = qofAccountSetParent;
5921 : 44 : func->gnc_account_lookup_by_full_name_helper =
5922 : : gnc_account_lookup_by_full_name_helper;
5923 : :
5924 : 44 : return func;
5925 : : }
5926 : : /* ======================= END OF FILE =========================== */
|
