-
Notifications
You must be signed in to change notification settings - Fork 762
/
import-backend.cpp
1156 lines (994 loc) · 40.2 KB
/
import-backend.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/********************************************************************\
* This program is free software; you can redistribute it and/or *
* modify it under the terms of the GNU General Public License as *
* published by the Free Software Foundation; either version 2 of *
* the License, or (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License*
* along with this program; if not, contact: *
* *
* Free Software Foundation Voice: +1-617-542-5942 *
* 51 Franklin Street, Fifth Floor Fax: +1-617-542-2652 *
* Boston, MA 02110-1301, USA gnu@gnu.org *
\********************************************************************/
/** @addtogroup Import_Export
@{ */
/** @internal
@file import-backend.c
@brief import-backend.c: Generic importer backend implementation (duplicate matching algorithm, action handling, etc.)
@author Copyright (C) 2002 Benoit Grégoire
@author Christian Stimming
@author Copyright (c) 2006 David Hampton <hampton@employees.org>
*/
#include <config.h>
#include <gtk/gtk.h>
#include <glib/gi18n.h>
#include <stdlib.h>
#include <math.h>
#include <errno.h>
#include "import-backend.h"
#include "import-utilities.h"
#include "Account.h"
#include "Query.h"
#include "gnc-engine.h"
#include "engine-helpers.h"
#include "gnc-prefs.h"
#include "gnc-ui-util.h"
#include <algorithm>
#define GNCIMPORT_DESC "desc"
#define GNCIMPORT_MEMO "memo"
#define GNCIMPORT_PAYEE "payee"
/********************************************************************\
* Constants *
\********************************************************************/
static QofLogModule log_module = GNC_MOD_IMPORT;
/********************************************************************\
* Forward declared prototypes *
\********************************************************************/
static void matchmap_store_destination(Account* base_acc,
GNCImportTransInfo* trans_info,
gboolean use_match);
static void trans_info_calculate_dest_amount (GNCImportTransInfo *info);
/********************************************************************\
* Structures passed between the functions *
\********************************************************************/
struct _selected_match_info
{
GNCImportMatchInfo *selected_match;
gboolean selected_manually;
};
struct _transactioninfo
{
Transaction * trans;
Split * first_split;
/* GList of GNCImportMatchInfo's, one for each possible duplicate match. */
GList * match_list;
GNCImportSelectedMatchInfo selected_match_info;
GNCImportAction action;
GNCImportAction previous_action;
/* A list of tokenized strings to use for bayesian matching purposes */
GList * match_tokens;
/* In case of a single destination account it is stored here. */
Account *dest_acc;
gboolean dest_acc_selected_manually;
/* Reference id to link gnc transaction to external object. E.g. aqbanking job id. */
guint32 ref_id;
/* When updating a matched transaction, append Description and Notes instead of replacing */
gboolean append_text;
/* Extra data we can use to build the balancing split. It may be passed on by the
* code that calls the generic importer */
gnc_numeric lsplit_price;
char *lsplit_action;
char *lsplit_memo;
char lsplit_rec_state;
time64 lsplit_rec_date;
gnc_numeric lsplit_value;
/* Amount for the balancing split. This may be passed by the import front-
* ends or calculated. The latter is only possible when
* the destination account is known and may require an exchange rate
* if that account is not in the same commodity as the transaction. */
gnc_numeric lsplit_amount;
gboolean lsplit_amount_selected_manually;
};
/* Some simple getters and setters for the above data types. */
GList *
gnc_import_TransInfo_get_match_list (const GNCImportTransInfo *info)
{
g_assert (info);
return info->match_list;
}
void
gnc_import_TransInfo_remove_top_match (GNCImportTransInfo *info)
{
g_return_if_fail (info);
info->match_list = g_list_remove (info->match_list, static_cast<gpointer>(info->match_list->data));
if (info->match_list)
info->selected_match_info.selected_match = static_cast<GNCImportMatchInfo*>(info->match_list->data);
else
{
info->selected_match_info.selected_match = nullptr;
gnc_import_TransInfo_set_action (info, GNCImport_ADD);
};
}
Transaction *
gnc_import_TransInfo_get_trans (const GNCImportTransInfo *info)
{
g_assert (info);
return info->trans;
}
gboolean
gnc_import_TransInfo_is_balanced (const GNCImportTransInfo *info)
{
g_assert (info);
return gnc_numeric_zero_p(xaccTransGetImbalanceValue(gnc_import_TransInfo_get_trans(info)));
}
Split *
gnc_import_TransInfo_get_fsplit (const GNCImportTransInfo *info)
{
g_assert (info);
return info->first_split;
}
GNCImportMatchInfo *
gnc_import_TransInfo_get_selected_match (const GNCImportTransInfo *info)
{
g_assert (info);
return info->selected_match_info.selected_match;
}
void
gnc_import_TransInfo_set_selected_match_info (GNCImportTransInfo *info,
GNCImportMatchInfo *match,
gboolean selected_manually)
{
g_assert (info);
info->selected_match_info.selected_match = match;
info->selected_match_info.selected_manually = selected_manually;
}
gboolean
gnc_import_TransInfo_get_match_selected_manually (const GNCImportTransInfo *info)
{
g_assert (info);
return info->selected_match_info.selected_manually;
}
GNCImportAction
gnc_import_TransInfo_get_action (const GNCImportTransInfo *info)
{
g_assert (info);
return info->action;
}
void
gnc_import_TransInfo_set_action (GNCImportTransInfo *info,
GNCImportAction action)
{
g_assert (info);
if (action != info->action)
{
info->previous_action = info->action;
info->action = action;
}
}
Account *
gnc_import_TransInfo_get_destacc (const GNCImportTransInfo *info)
{
g_assert (info);
return info->dest_acc;
}
void gnc_import_TransInfo_set_destacc (GNCImportTransInfo *info,
Account *acc,
gboolean selected_manually)
{
g_assert (info);
info->dest_acc = acc;
info->dest_acc_selected_manually = selected_manually;
/* Store the mapping to the other account in the MatchMap. */
if (selected_manually)
matchmap_store_destination (nullptr, info, false);
trans_info_calculate_dest_amount (info);
}
gboolean
gnc_import_TransInfo_get_destacc_selected_manually (const GNCImportTransInfo *info)
{
g_assert (info);
return info->dest_acc_selected_manually;
}
guint32
gnc_import_TransInfo_get_ref_id (const GNCImportTransInfo *info)
{
g_assert (info);
return info->ref_id;
}
void
gnc_import_TransInfo_set_ref_id (GNCImportTransInfo *info,
guint32 ref_id)
{
g_assert (info);
info->ref_id = ref_id;
}
gnc_numeric
gnc_import_TransInfo_get_price (const GNCImportTransInfo *info)
{
g_assert (info);
return info->lsplit_price;
}
void
gnc_import_TransInfo_set_price (GNCImportTransInfo *info,
gnc_numeric lprice)
{
g_assert (info);
info->lsplit_price = lprice;
/* if a valid price is explicitly set, assume the user wants to
* use it to calculate balance split amount.
* Ensure this gets recalculated */
if (gnc_numeric_check (lprice) == 0)
{
info->lsplit_amount_selected_manually = false;
trans_info_calculate_dest_amount(info);
}
}
gnc_numeric
gnc_import_TransInfo_get_dest_amount (const GNCImportTransInfo *info)
{
g_assert (info);
return info->lsplit_amount;
}
gnc_numeric
gnc_import_TransInfo_get_dest_value (const GNCImportTransInfo *info)
{
g_assert (info);
return info->lsplit_value;
}
void
gnc_import_TransInfo_set_last_split_info (GNCImportTransInfo *info,
GNCImportLastSplitInfo *lsplit)
{
g_assert (info);
if (lsplit)
{
info->lsplit_price = lsplit->price;
info->lsplit_action = g_strdup(lsplit->action);
info->lsplit_memo = g_strdup(lsplit->memo);
if (gnc_numeric_check (lsplit->amount) == 0)
{
info->lsplit_amount = lsplit->amount;
info->lsplit_amount_selected_manually = true;
}
/* Bayesian matching may have already set a candidate destination
* account. However if the csv data also provides one, the one from the
* csv data is preferred. */
if (lsplit->account)
info->dest_acc = lsplit->account;
info->lsplit_rec_state = lsplit->rec_state;
info->lsplit_rec_date = lsplit->rec_date;
}
}
void
gnc_import_TransInfo_set_append_text (GNCImportTransInfo *info,
gboolean append_text)
{
g_assert (info);
info->append_text = append_text;
}
Split *
gnc_import_MatchInfo_get_split (const GNCImportMatchInfo * info)
{
g_assert (info);
return info->split;
}
gint
gnc_import_MatchInfo_get_probability (const GNCImportMatchInfo * info)
{
if (info)
return info->probability;
else
return 0;
}
void gnc_import_TransInfo_delete (GNCImportTransInfo *info)
{
if (info)
{
g_list_free (info->match_list);
/*If the transaction exists and is still open, it must be destroyed*/
if (xaccTransIsOpen(info->trans))
{
xaccTransDestroy(info->trans);
xaccTransCommitEdit(info->trans);
}
g_list_free_full (info->match_tokens, g_free);
g_free(info->lsplit_action);
g_free(info->lsplit_memo);
g_free(info);
}
}
GdkPixbuf* gen_probability_pixbuf(gint score_original, GNCImportSettings *settings, GtkWidget * widget)
{
constexpr gint height = 15;
constexpr gint width_each_bar = 7;
constexpr gint width_first_bar = 1;
constexpr gint num_colors = 5;
gchar * xpm[2 + num_colors + height];
g_assert(settings);
g_assert(widget);
auto score = std::max (0, score_original);
/* Add size definition to xpm */
xpm[0] = g_strdup_printf("%d%s%d%s%d%s", (width_each_bar * score) + width_first_bar/*width*/, " ", height, " ", num_colors, " 1"/*characters per pixel*/);
/* Define used colors */
xpm[1] = g_strdup(" c None");
xpm[2] = g_strdup("g c green");
xpm[3] = g_strdup("y c yellow");
xpm[4] = g_strdup("r c red");
xpm[5] = g_strdup("b c black");
auto add_threshold = gnc_import_Settings_get_add_threshold(settings);
auto clear_threshold = gnc_import_Settings_get_clear_threshold(settings);
for (int i = 0; i < height; i++)
{
xpm[num_colors+1+i] = g_new0(char, (width_each_bar * score) + width_first_bar + 1);
for (int j = 0; j <= score; j++)
{
if (j == 0)
strcat(xpm[num_colors+1+i], "b");
else if (i == 0 || i == height - 1)
strcat(xpm[num_colors+1+i], "bbbbbb ");
else if (j <= add_threshold)
strcat(xpm[num_colors+1+i], "brrrrb ");
else if (j >= clear_threshold)
strcat(xpm[num_colors+1+i], "bggggb ");
else
strcat(xpm[num_colors+1+i], "byyyyb ");
}
}
auto retval = gdk_pixbuf_new_from_xpm_data((const gchar **)xpm);
for (int i = 0; i <= num_colors + height; i++)
g_free(xpm[i]);
return retval;
}
/*************************************************************************
* MatchMap related functions (storing and retrieving)
*/
/* Tokenize a string and append the tokens to an existing GList
* (or an empty GList)
*/
static GList*
tokenize_string(GList* existing_tokens, const char *string)
{
char **tokenized_strings = g_strsplit(string, " ", 0);
char **stringpos = tokenized_strings;
/* add each unique non-empty token to the token GList */
while (stringpos && *stringpos)
{
if ((strlen(*stringpos) > 0) &&
(!g_list_find_custom (existing_tokens, *stringpos, (GCompareFunc)g_strcmp0)))
existing_tokens = g_list_prepend(existing_tokens, g_strdup(*stringpos));
stringpos++;
}
/* free up the strings that g_strsplit() created */
g_strfreev(tokenized_strings);
return existing_tokens;
}
/* create and return a list of tokens for a given transaction info. */
static GList*
TransactionGetTokens(GNCImportTransInfo *info)
{
g_return_val_if_fail (info, nullptr);
if (info->match_tokens) return info->match_tokens;
auto transaction = gnc_import_TransInfo_get_trans(info);
g_assert(transaction);
/* make tokens from the transaction description */
auto text = xaccTransGetDescription(transaction);
GList *tokens = nullptr;
tokens = tokenize_string(tokens, text);
/* The day of week the transaction occurred is a good indicator of
* what account this transaction belongs in. Get the date and convert
* it to day of week as a token
*/
auto transtime = xaccTransGetDate(transaction);
auto tm_struct = gnc_gmtime(&transtime);
char local_day_of_week[16];
if (!qof_strftime(local_day_of_week, sizeof(local_day_of_week), "%A", tm_struct))
PERR("TransactionGetTokens: error, strftime failed\n");
gnc_tm_free (tm_struct);
/* we cannot add a locally allocated string to this array, dup it so
* it frees the same way the rest do
*/
tokens = g_list_prepend(tokens, g_strdup(local_day_of_week));
/* make tokens from the memo of each split of this transaction */
for (GList *node=xaccTransGetSplitList (transaction); node; node=node->next)
{
text = xaccSplitGetMemo(static_cast<Split*>(node->data));
tokens = tokenize_string(tokens, text);
}
info->match_tokens = tokens;
return tokens;
}
/* searches using the GNCImportTransInfo through all existing transactions
* if there is an exact match of the description and memo
*/
static Account *
matchmap_find_destination (Account *base_acc, GNCImportTransInfo *info)
{
g_assert (info);
auto orig_acc = (base_acc ? base_acc : xaccSplitGetAccount
(gnc_import_TransInfo_get_fsplit (info)));
Account *result = nullptr;
if (gnc_prefs_get_bool (GNC_PREFS_GROUP_IMPORT, GNC_PREF_USE_BAYES))
{
/* get the tokens for this transaction* */
GList* tokens = TransactionGetTokens(info);
/* try to find the destination account for this transaction from its tokens */
result = gnc_account_imap_find_account_bayes(orig_acc, tokens);
}
else
result = gnc_account_imap_find_account
(orig_acc, GNCIMPORT_DESC,
xaccTransGetDescription (gnc_import_TransInfo_get_trans (info)));
return result;
}
/** Store the destination account from trans_info in the matchmap. If
'use_match' is true, the destination account of the selected
matching/duplicate transaction is used; otherwise, the stored
destination_acc pointer is used. */
static void
matchmap_store_destination (Account *base_acc,
GNCImportTransInfo *trans_info,
gboolean use_match)
{
g_assert (trans_info);
/* This will store the destination account of the selected match if
the reconcile match selected has only two splits. */
Account *dest = nullptr;
if (use_match)
dest = xaccSplitGetAccount
(xaccSplitGetOtherSplit
(gnc_import_MatchInfo_get_split
(gnc_import_TransInfo_get_selected_match (trans_info))));
else
dest = gnc_import_TransInfo_get_destacc (trans_info);
if (!dest)
return;
auto orig_acc = (base_acc ? base_acc : xaccSplitGetAccount
(gnc_import_TransInfo_get_fsplit (trans_info)));
if (gnc_prefs_get_bool (GNC_PREFS_GROUP_IMPORT, GNC_PREF_USE_BAYES))
{
/* tokenize this transaction */
auto tokens = TransactionGetTokens(trans_info);
/* add the tokens to the imap with the given destination account */
gnc_account_imap_add_account_bayes(orig_acc, tokens, dest);
}
else
{
auto desc = xaccTransGetDescription
(gnc_import_TransInfo_get_trans (trans_info));
auto memo = xaccSplitGetMemo
(gnc_import_TransInfo_get_fsplit (trans_info));
if (desc && *desc)
gnc_account_imap_add_account (orig_acc, GNCIMPORT_DESC, desc, dest);
if (memo && *memo)
gnc_account_imap_add_account (orig_acc, GNCIMPORT_MEMO, memo, dest);
}
}
/** @brief The transaction matching heuristics are here.
*/
void split_find_match (GNCImportTransInfo * trans_info,
Split * split,
gint display_threshold,
gint date_threshold,
gint date_not_threshold,
double fuzzy_amount_difference)
{
gint prob = 0;
auto new_trans = gnc_import_TransInfo_get_trans (trans_info);
auto new_trans_fsplit = gnc_import_TransInfo_get_fsplit (trans_info);
/* Matching heuristics */
/* Amount heuristics */
auto downloaded_split_amount =
gnc_numeric_to_double (xaccSplitGetAmount(new_trans_fsplit));
/*DEBUG(" downloaded_split_amount=%f", downloaded_split_amount);*/
auto match_split_amount = gnc_numeric_to_double(xaccSplitGetAmount(split));
/*DEBUG(" match_split_amount=%f", match_split_amount);*/
if (fabs(downloaded_split_amount - match_split_amount) < 1e-6)
/* bug#347791: Double type shouldn't be compared for exact
equality, so we're using fabs() instead. */
/*if (gnc_numeric_equal(xaccSplitGetAmount
(new_trans_fsplit),
xaccSplitGetAmount(split)))
-- gnc_numeric_equal is an expensive function call */
{
prob = prob + 3;
/*DEBUG("heuristics: probability + 3 (amount)");*/
}
else if (fabs (downloaded_split_amount - match_split_amount) <=
fuzzy_amount_difference)
{
/* ATM fees are sometimes added directly in the transaction.
So you withdraw 100$ and get charged 101,25$ in the same
transaction */
prob = prob + 2;
/*DEBUG("heuristics: probability + 2 (amount)");*/
}
else
{
/* If a transaction's amount doesn't match within the
threshold, it's very unlikely to be the same transaction
so we give it an extra -5 penalty */
prob = prob - 5;
/* DEBUG("heuristics: probability - 1 (amount)"); */
}
/* Date heuristics */
auto match_time = xaccTransGetDate (xaccSplitGetParent (split));
auto download_time = xaccTransGetDate (new_trans);
auto datediff_day = llabs(match_time - download_time) / 86400;
/* Sorry, there are not really functions around at all that
provide for less hacky calculation of days of date
differences. Whatever. On the other hand, the difference
calculation itself will work regardless of month/year
turnarounds. */
/*DEBUG("diff day %d", datediff_day);*/
if (datediff_day == 0)
{
prob = prob + 3;
/*DEBUG("heuristics: probability + 3 (date)");*/
}
else if (datediff_day <= date_threshold)
{
prob = prob + 2;
/*DEBUG("heuristics: probability + 2 (date)");*/
}
else if (datediff_day > date_not_threshold)
{
/* Extra penalty if that split lies awfully far away from
the given one. */
prob = prob - 5;
/*DEBUG("heuristics: probability - 5 (date)"); */
/* Changed 2005-02-21: Revert the hard-limiting behaviour
back to the previous large penalty. (Changed 2004-11-27:
The penalty is so high that we can forget about this
split anyway and skip the rest of the tests.) */
}
/* Check if date and amount are identical */
auto update_proposed = (prob < 6);
/* Check number heuristics */
auto new_trans_str = gnc_get_num_action(new_trans, new_trans_fsplit);
if (new_trans_str && *new_trans_str)
{
char *endptr;
auto conversion_ok = true;
/* To distinguish success/failure after strtol call */
errno = 0;
auto new_trans_number = strtol(new_trans_str, &endptr, 10);
/* Possible addressed problems: over/underflow, only non
numbers on string and string empty */
conversion_ok = !(errno || endptr == new_trans_str);
auto split_str = gnc_get_num_action (xaccSplitGetParent (split), split);
errno = 0;
auto split_number = strtol(split_str, &endptr, 10);
conversion_ok = !(errno || endptr == split_str);
if ( (conversion_ok && (split_number == new_trans_number)) ||
(g_strcmp0(new_trans_str, split_str) == 0) )
{
/* An exact match of the Check number gives a +4 */
prob += 4;
/*DEBUG("heuristics: probability + 4 (Check number)");*/
}
else if (strlen(new_trans_str) > 0 && strlen(split_str) > 0)
{
/* If both number are not empty yet do not match, add a
little extra penalty */
prob -= 2;
}
}
/* Memo heuristics */
auto memo = xaccSplitGetMemo(new_trans_fsplit);
if (memo && *memo)
{
if (safe_strcasecmp(memo, xaccSplitGetMemo(split)) == 0)
{
/* An exact match of memo gives a +2 */
prob = prob + 2;
/* DEBUG("heuristics: probability + 2 (memo)"); */
}
else if ((strncasecmp(memo, xaccSplitGetMemo(split),
strlen(xaccSplitGetMemo(split)) / 2) == 0))
{
/* Very primitive fuzzy match worth +1. This matches the
first 50% of the strings to skip annoying transaction
number some banks seem to include in the memo but someone
should write something more sophisticated */
prob = prob + 1;
/*DEBUG("heuristics: probability + 1 (memo)"); */
}
}
/* Description heuristics */
auto descr = xaccTransGetDescription(new_trans);
if (descr && *descr)
{
if (safe_strcasecmp(descr,
xaccTransGetDescription(xaccSplitGetParent(split))) == 0)
{
/*An exact match of Description gives a +2 */
prob = prob + 2;
/*DEBUG("heuristics: probability + 2 (description)");*/
}
else if ((strncasecmp(descr,
xaccTransGetDescription (xaccSplitGetParent(split)),
strlen(xaccTransGetDescription (new_trans)) / 2) == 0))
{
/* Very primitive fuzzy match worth +1. This matches the
first 50% of the strings to skip annoying transaction
number some banks seem to include in the description but someone
should write something more sophisticated */
prob = prob + 1;
/*DEBUG("heuristics: probability + 1 (description)"); */
}
}
/* Is the probability high enough? Otherwise do nothing and return. */
if (prob < display_threshold)
return;
/* The probability is high enough, so allocate an object
here. Allocating it only when it's actually being used is
probably quite some performance gain. */
auto match_info = g_new0(GNCImportMatchInfo, 1);
match_info->probability = prob;
match_info->update_proposed = update_proposed;
match_info->split = split;
match_info->trans = xaccSplitGetParent(split);
/* Append that to the list. Do not use g_list_append because
it is slow. The list is sorted afterwards anyway. */
trans_info->match_list = g_list_prepend(trans_info->match_list, match_info);
}
/***********************************************************************
*/
static char*
maybe_append_string (const char* match_string, const char* imp_string)
{
if (!(match_string && *match_string))
return g_strdup(imp_string);
if (!(imp_string && *imp_string))
return nullptr;
auto norm_match_string = g_utf8_normalize (match_string, -1, G_NORMALIZE_NFC);
auto norm_imp_string = g_utf8_normalize (imp_string, -1, G_NORMALIZE_NFC);
char *retval = nullptr;
if (g_utf8_strlen (norm_imp_string, -1) > g_utf8_strlen (norm_match_string, -1) ||
!strstr (norm_match_string, norm_imp_string))
retval = g_strconcat(match_string, "|", imp_string, nullptr);
g_free (norm_match_string);
g_free (norm_imp_string);
return retval;
}
/* Append or replace transaction description and notes
* depending on the Append checkbox
*/
static void
update_desc_and_notes (const GNCImportTransInfo* trans_info)
{
auto selected_match = gnc_import_TransInfo_get_selected_match (trans_info);
auto imp_trans = gnc_import_TransInfo_get_trans (trans_info);
if (trans_info->append_text)
{
auto match_trans = selected_match->trans;
auto repl_str =
maybe_append_string (xaccTransGetDescription(match_trans),
xaccTransGetDescription(imp_trans));
if (repl_str)
xaccTransSetDescription(match_trans, repl_str);
g_free (repl_str);
repl_str =
maybe_append_string (xaccTransGetNotes(match_trans),
xaccTransGetNotes(imp_trans));
if (repl_str)
xaccTransSetNotes (match_trans, repl_str);
g_free (repl_str);
}
else
{
xaccTransSetDescription (selected_match->trans,
xaccTransGetDescription (imp_trans));
xaccTransSetNotes (selected_match->trans,
xaccTransGetNotes (imp_trans));
}
}
static void
process_reconcile(Account *base_acc,
GNCImportTransInfo *trans_info,
GNCImportMatchInfo *selected_match)
{
/* Reconcile the matching transaction */
/*DEBUG("BeginEdit selected_match")*/
xaccTransBeginEdit(selected_match->trans);
if (xaccSplitGetReconcile(selected_match->split) == NREC)
xaccSplitSetReconcile(selected_match->split, CREC);
/* Set reconcile date to today */
xaccSplitSetDateReconciledSecs(selected_match->split, gnc_time (nullptr));
/* Copy the online id to the reconciled transaction, so
* the match will be remembered */
auto online_id = gnc_import_get_split_online_id(trans_info->first_split);
if (online_id && *online_id)
gnc_import_set_split_online_id(selected_match->split, online_id);
g_free (online_id);
/* Done editing. */
/*DEBUG("CommitEdit selected_match")*/
xaccTransCommitEdit(selected_match->trans);
/* Store the mapping to the other account in the MatchMap. */
matchmap_store_destination(base_acc, trans_info, true);
/* Erase the downloaded transaction */
xaccTransDestroy(trans_info->trans);
/*DEBUG("CommitEdit trans")*/
xaccTransCommitEdit(trans_info->trans);
/* Very important: Make sure the freed transaction is not freed again! */
trans_info->trans = nullptr;
}
/** /brief -- Processes one match
according to its selected action. */
gboolean
gnc_import_process_trans_item (Account *base_acc,
GNCImportTransInfo *trans_info)
{
g_assert (trans_info);
/*DEBUG("Iteration %d, action %d, split %s", i,
trans_info->action,
xaccTransGetDescription (gnc_import_TransInfo_get_trans
(trans_info)))*/
switch (gnc_import_TransInfo_get_action (trans_info))
{
case GNCImport_SKIP:
return false;
case GNCImport_ADD:
/* Transaction gets imported. */
if (!gnc_import_TransInfo_is_balanced(trans_info)
&& gnc_import_TransInfo_get_destacc(trans_info))
{
/* Create the 'other' split. */
auto trans = gnc_import_TransInfo_get_trans (trans_info);
auto acct = gnc_import_TransInfo_get_destacc (trans_info);
auto split = xaccMallocSplit (gnc_account_get_book (acct));
xaccTransAppendSplit (trans, split);
xaccAccountInsertSplit (acct, split);
xaccSplitSetValue (split, trans_info->lsplit_value);
if (!gnc_numeric_zero_p (trans_info->lsplit_amount))
xaccSplitSetAmount (split, trans_info->lsplit_amount);
else
{
/* Bad! user asked to create a balancing split in an account with
* different currency/commodit than the transaction but didn't provide
* an exchange rate.
* Continue anyway pretenting split is in transaction currency. */
xaccSplitSetAmount (split, trans_info->lsplit_value);
PWARN("Missing exchange rate while adding transaction '%s', will assume rate of 1",
xaccTransGetDescription (gnc_import_TransInfo_get_trans (trans_info)));
}
}
xaccSplitSetReconcile(gnc_import_TransInfo_get_fsplit (trans_info), CREC);
/*Set reconcile date to today*/
xaccSplitSetDateReconciledSecs(gnc_import_TransInfo_get_fsplit (trans_info),
gnc_time (nullptr));
/* Done editing. */
xaccTransCommitEdit(trans_info->trans);
xaccTransRecordPrice(trans_info->trans, PRICE_SOURCE_SPLIT_IMPORT);
return true;
case GNCImport_UPDATE:
{
auto selected_match = gnc_import_TransInfo_get_selected_match(trans_info);
/* If there is no selection, ignore this transaction. */
if (!selected_match)
{
PWARN("No matching transaction to be cleared was chosen. Imported transaction will be ignored.");
break;
}
/* Transaction gets not imported but the matching one gets
updated and reconciled. */
if (!gnc_import_MatchInfo_get_split(selected_match))
PERR("The split I am trying to update and reconcile is nullptr, shouldn't happen!");
else
{
/* Update and reconcile the matching transaction */
/*DEBUG("BeginEdit selected_match")*/
xaccTransBeginEdit(selected_match->trans);
auto fsplit = gnc_import_TransInfo_get_fsplit(trans_info);
xaccTransSetDatePostedSecsNormalized(selected_match->trans,
xaccTransGetDate(xaccSplitGetParent(fsplit)));
auto match_split_amount = xaccSplitGetAmount(selected_match->split);
xaccSplitSetAmount(selected_match->split, xaccSplitGetAmount(fsplit));
xaccSplitSetValue(selected_match->split, xaccSplitGetValue(fsplit));
auto imbalance_value = gnc_import_TransInfo_get_dest_value(trans_info);
auto other_split = xaccSplitGetOtherSplit(selected_match->split);
if (!gnc_numeric_zero_p(imbalance_value) && other_split)
{
if (xaccSplitGetReconcile(other_split) == NREC)
{
xaccSplitSetValue(other_split, imbalance_value);
auto new_amt = gnc_import_TransInfo_get_dest_value(trans_info);
if (gnc_numeric_zero_p(new_amt))
{
auto other_split_amount = xaccSplitGetAmount(other_split);
auto price = gnc_numeric_div(match_split_amount, other_split_amount,
GNC_DENOM_AUTO,
GNC_HOW_RND_ROUND_HALF_UP);
new_amt = gnc_numeric_mul(xaccSplitGetAmount(fsplit), price,
GNC_DENOM_AUTO,
GNC_HOW_RND_ROUND_HALF_UP);;
}
xaccSplitSetAmount(other_split, new_amt);
}
else
{
/* else GC will automatically insert a split to equity
to balance the transaction */
PWARN("Updated transaction '%s', but not other split.",
xaccTransGetDescription(selected_match->trans));
}
}
auto fs_memo = xaccSplitGetMemo (trans_info->first_split);
if (fs_memo && *fs_memo)
xaccSplitSetMemo(selected_match->split, fs_memo);
update_desc_and_notes(trans_info);
/*DEBUG("CommitEdit selected_match")*/
xaccTransCommitEdit(selected_match->trans);
process_reconcile (base_acc, trans_info, selected_match);
}
}
return true;
case GNCImport_CLEAR:
{
auto selected_match = gnc_import_TransInfo_get_selected_match (trans_info);
/* If there is no selection, ignore this transaction. */
if (!selected_match)
{
PWARN("No matching translaction to be cleared was chosen. Imported transaction will be ignored.");
break;
}
/* Transaction gets not imported but the matching one gets
reconciled. */
if (!gnc_import_MatchInfo_get_split (selected_match))
PERR("The split I am trying to reconcile is nullptr, shouldn't happen!");
else
{
/* Reconcile the matching transaction */
process_reconcile(base_acc, trans_info, selected_match);
}
}
return true;
default:
DEBUG("Invalid GNCImportAction for this imported transaction.");
break;
}
/*DEBUG("End");*/
return false;
}
static GHashTable*
hash_account_online_ids (Account *account)
{
auto acct_hash = g_hash_table_new_full
(g_str_hash, g_str_equal, g_free, nullptr);
for (GList *n = xaccAccountGetSplitList (account) ; n; n = n->next)
{