31#include <glib/gi18n.h>
45#include <boost/regex.hpp>
46#include <boost/regex/icu.hpp>
49#include "gnc-imp-props-tx.hpp"
54G_GNUC_UNUSED
static QofLogModule log_module = GNC_MOD_IMPORT;
56const int num_currency_formats = 3;
57const gchar* currency_format_user[] = {N_(
"Locale"),
58 N_(
"Period: 123,456.78"),
59 N_(
"Comma: 123.456,78")
70 m_skip_errors =
false;
89 if (
m_tokenizer && m_settings.m_file_format == format)
92 auto new_encoding = std::string(
"UTF-8");
93 auto new_imp_file = std::string();
100 if (
file_format() == GncImpFileFormat::FIXED_WIDTH)
103 if (!fwtok->get_columns().empty())
104 m_settings.m_column_widths = fwtok->get_columns();
108 m_settings.m_file_format = format;
109 m_tokenizer = gnc_tokenizer_factory(m_settings.m_file_format);
119 if (!m_settings.m_separators.empty())
120 separators (m_settings.m_separators);
121 enable_escape (m_settings.m_enable_escape);
123 else if ((
file_format() == GncImpFileFormat::FIXED_WIDTH)
124 && !m_settings.m_column_widths.empty())
127 fwtok->columns (m_settings.m_column_widths);
134 return m_settings.m_file_format;
150 auto trans_prop_seen =
false;
151 m_settings.m_multi_split = multi_split;
152 for (uint32_t i = 0; i < m_settings.m_column_types.size(); i++)
154 auto old_prop = m_settings.m_column_types[i];
155 auto is_trans_prop = ((old_prop > GncTransPropType::NONE)
156 && (old_prop <= GncTransPropType::TRANS_PROPS));
157 auto san_prop = sanitize_trans_prop (old_prop, m_settings.m_multi_split);
158 if (san_prop != old_prop)
159 set_column_type (i, san_prop);
160 else if (is_trans_prop && !trans_prop_seen)
161 set_column_type (i, old_prop,
true);
162 trans_prop_seen |= is_trans_prop;
165 if (m_settings.m_multi_split)
166 m_settings.m_base_account =
nullptr;
169bool GncTxImport::multi_split () {
return m_settings.m_multi_split; }
182 if (m_settings.m_multi_split)
184 m_settings.m_base_account =
nullptr;
188 auto base_account_is_new = m_settings.m_base_account ==
nullptr;
189 m_settings.m_base_account = base_account;
191 if (m_settings.m_base_account)
193 auto col_type_it = std::find (m_settings.m_column_types.begin(),
194 m_settings.m_column_types.end(), GncTransPropType::ACCOUNT);
195 if (col_type_it != m_settings.m_column_types.end())
196 set_column_type(col_type_it - m_settings.m_column_types.begin(),
197 GncTransPropType::NONE);
199 if (base_account_is_new)
203 std::get<PL_PRESPLIT>(line)->set_account (m_settings.m_base_account);
211Account *GncTxImport::base_account () {
return m_settings.m_base_account; }
213void GncTxImport::reset_formatted_column (std::vector<GncTransPropType>& col_types)
215 for (
auto col_type: col_types)
217 auto col = std::find (m_settings.m_column_types.begin(),
218 m_settings.m_column_types.end(), col_type);
219 if (col != m_settings.m_column_types.end())
220 set_column_type (col - m_settings.m_column_types.begin(), col_type,
true);
227void GncTxImport::currency_format (
int currency_format)
229 m_settings.m_currency_format = currency_format;
232 std::vector<GncTransPropType> commodities = {
233 GncTransPropType::AMOUNT,
234 GncTransPropType::AMOUNT_NEG,
235 GncTransPropType::TAMOUNT,
236 GncTransPropType::TAMOUNT_NEG,
237 GncTransPropType::PRICE};
238 reset_formatted_column (commodities);
240int GncTxImport::currency_format () {
return m_settings.m_currency_format; }
242void GncTxImport::date_format (
int date_format)
244 m_settings.m_date_format = date_format;
247 std::vector<GncTransPropType> dates = { GncTransPropType::DATE,
248 GncTransPropType::REC_DATE,
249 GncTransPropType::TREC_DATE};
250 reset_formatted_column (dates);
252int GncTxImport::date_format () {
return m_settings.m_date_format; }
274 m_settings.m_encoding = encoding;
277std::string GncTxImport::encoding () {
return m_settings.m_encoding; }
279void GncTxImport::update_skipped_lines(std::optional<uint32_t> start, std::optional<uint32_t> end,
280 std::optional<bool> alt, std::optional<bool> errors)
283 m_settings.m_skip_start_lines = *start;
285 m_settings.m_skip_end_lines = *end;
287 m_settings.m_skip_alt_lines = *alt;
289 m_skip_errors = *errors;
294 ((i < skip_start_lines()) ||
296 (((i - skip_start_lines()) % 2 == 1) &&
298 (m_skip_errors && !std::get<PL_ERROR>(
m_parsed_lines[i]).empty()));
302uint32_t GncTxImport::skip_start_lines () {
return m_settings.m_skip_start_lines; }
303uint32_t GncTxImport::skip_end_lines () {
return m_settings.m_skip_end_lines; }
304bool GncTxImport::skip_alt_lines () {
return m_settings.m_skip_alt_lines; }
305bool GncTxImport::skip_err_lines () {
return m_skip_errors; }
307void GncTxImport::separators (std::string separators)
312 m_settings.m_separators = separators;
314 csvtok->set_separators (separators);
317std::string GncTxImport::separators () {
return m_settings.m_separators; }
319void GncTxImport::enable_escape(
bool enable)
323 m_settings.m_enable_escape = enable;
325 csvtok->set_enable_escape (enable);
327bool GncTxImport::enable_escape() {
return m_settings.m_enable_escape; }
334 m_settings = settings;
341 separators (m_settings.m_separators);
342 enable_escape (m_settings.m_enable_escape);
344 else if (
file_format() == GncImpFileFormat::FIXED_WIDTH)
347 fwtok->columns (m_settings.m_column_widths);
359 std::copy_n (settings.m_column_types.begin(),
360 std::min (m_settings.m_column_types.size(), settings.m_column_types.size()),
361 m_settings.m_column_types.begin());
365bool GncTxImport::save_settings ()
375 if (
file_format() == GncImpFileFormat::FIXED_WIDTH)
378 m_settings.m_column_widths = fwtok->get_columns();
381 return m_settings.
save();
384void GncTxImport::settings_name (std::string name) { m_settings.m_name = name; }
385std::string GncTxImport::settings_name () {
return m_settings.m_name; }
402 catch (std::ifstream::failure& ios_err)
405 PWARN (
"Error: %s", ios_err.what());
426 uint32_t max_cols = 0;
429 for (
auto tokenized_line :
m_tokenizer->get_tokens())
431 auto length = tokenized_line.size();
434 auto pretrans = std::make_shared<GncPreTrans>(date_format(), m_settings.m_multi_split);
435 auto presplit = std::make_shared<GncPreSplit>(date_format(), currency_format());
436 presplit->set_pre_trans (std::move (pretrans));
437 m_parsed_lines.push_back (std::make_tuple (tokenized_line, ErrMap(),
438 presplit->get_pre_trans(), std::move (presplit),
false));
440 if (length > max_cols)
447 throw (std::range_error (N_(
"There was an error parsing the file.")));
451 m_settings.m_column_types.resize(max_cols, GncTransPropType::NONE);
454 for (uint32_t i = 0; i < m_settings.m_column_types.size(); i++)
455 set_column_type (i, m_settings.m_column_types[i],
true);
456 if (m_settings.m_base_account)
459 std::get<PL_PRESPLIT>(line)->set_account (m_settings.m_base_account);
474 void add_error (std::string msg);
480void ErrorList::add_error (std::string msg)
482 m_error.emplace_back (msg);
485std::string ErrorList::str()
487 auto err_msg = std::string();
488 if (!m_error.empty())
490 auto add_bullet_item = [](std::string& a, std::string& b)->std::string {
return std::move(a) +
"\n• " + b; };
491 err_msg = std::accumulate (m_error.begin(), m_error.end(), std::move (err_msg), add_bullet_item);
492 err_msg.erase (0, 1);
503void GncTxImport::verify_column_selections (
ErrorList& error_msg)
508 if (!check_for_column_type(GncTransPropType::DATE))
509 error_msg.add_error(
_(
"Please select a date column."));
514 if (!check_for_column_type(GncTransPropType::ACCOUNT))
516 if (m_settings.m_multi_split)
517 error_msg.add_error(
_(
"Please select an account column."));
518 else if (!m_settings.m_base_account)
519 error_msg.add_error(
_(
"Please select an account column or set a base account in the Account field."));
524 if (!check_for_column_type(GncTransPropType::DESCRIPTION))
525 error_msg.add_error(
_(
"Please select a description column."));
529 if (!check_for_column_type(GncTransPropType::AMOUNT) &&
530 !check_for_column_type(GncTransPropType::AMOUNT_NEG))
531 error_msg.add_error(
_(
"Please select a (negated) amount column."));
542 if (m_multi_currency)
544 if (m_settings.m_multi_split &&
545 !check_for_column_type(GncTransPropType::PRICE) &&
546 !check_for_column_type(GncTransPropType::VALUE) &&
547 !check_for_column_type(GncTransPropType::VALUE_NEG))
548 error_msg.add_error(
_(
"The current account selections will generate multi-currency transactions. Please select one of the following columns: price, (negated) value."));
549 else if (!m_settings.m_multi_split &&
550 !check_for_column_type(GncTransPropType::PRICE) &&
551 !check_for_column_type(GncTransPropType::TAMOUNT) &&
552 !check_for_column_type(GncTransPropType::TAMOUNT_NEG) &&
553 !check_for_column_type(GncTransPropType::VALUE) &&
554 !check_for_column_type(GncTransPropType::VALUE_NEG))
555 error_msg.add_error(
_(
"The current account selections will generate multi-currency transactions. Please select one of the following columns: price, (negated) value, (negated) transfer amount."));
568std::string GncTxImport::verify (
bool with_acct_errors)
570 auto newline = std::string();
576 error_msg.add_error(
_(
"No valid data found in the selected file. It may be empty or the selected encoding is wrong."));
577 return error_msg.str();
581 auto skip_alt_offset = m_settings.m_skip_alt_lines ? 1 : 0;
582 if (m_settings.m_skip_start_lines + m_settings.m_skip_end_lines + skip_alt_offset >=
m_parsed_lines.size())
584 error_msg.add_error(
_(
"No lines are selected for importing. Please reduce the number of lines to skip."));
585 return error_msg.str();
588 verify_column_selections (error_msg);
590 update_skipped_lines (std::nullopt, std::nullopt, std::nullopt, std::nullopt);
592 auto have_line_errors =
false;
595 auto errors = std::get<PL_ERROR>(line);
596 if (std::get<PL_SKIP>(line))
598 if (with_acct_errors && !errors.empty())
600 have_line_errors =
true;
603 auto non_acct_error = [](ErrPair curr_err)
605 return !((curr_err.first == GncTransPropType::ACCOUNT) ||
606 (curr_err.first == GncTransPropType::TACCOUNT));
608 if (!with_acct_errors &&
609 std::any_of(errors.cbegin(), errors.cend(), non_acct_error))
611 have_line_errors =
true;
616 if (have_line_errors)
617 error_msg.add_error(
_(
"Not all fields could be parsed. Please correct the issues reported for each line or adjust the lines to skip."));
619 return error_msg.str();
629std::shared_ptr<DraftTransaction> GncTxImport::trans_properties_to_trans (std::vector<parse_line_t>::iterator& parsed_line)
631 auto created_trans =
false;
632 std::shared_ptr<GncPreSplit> split_props;
633 std::tie(std::ignore, std::ignore, std::ignore, split_props, std::ignore) = *parsed_line;
634 auto trans_props = split_props->get_pre_trans();
635 auto account = split_props->get_account();
637 QofBook* book = gnc_account_get_book (account);
642 auto draft_trans = trans_props->create_trans (book, currency);
649 if (m_current_draft && m_current_draft->void_reason)
657 xaccTransVoid (m_current_draft->trans, m_current_draft->void_reason->c_str());
659 m_current_draft = draft_trans;
660 m_current_draft->void_reason = trans_props->get_void_reason();
661 created_trans =
true;
663 else if (m_settings.m_multi_split)
664 draft_trans = m_current_draft;
666 throw std::invalid_argument (
"Failed to create transaction from selected columns.");
671 split_props->create_split (draft_trans);
677 return created_trans ? m_current_draft :
nullptr;
680void GncTxImport::create_transaction (std::vector<parse_line_t>::iterator& parsed_line)
683 std::shared_ptr<GncPreSplit> split_props =
nullptr;
684 bool skip_line =
false;
685 std::tie(std::ignore, errors, std::ignore, split_props, skip_line) = *parsed_line;
686 auto trans_props = split_props->get_pre_trans();
694 auto error_message =
_(
"Current line still has parse errors.\n"
695 "This should never happen. Please report this as a bug.");
700 auto line_acct = split_props->get_account();
705 auto error_message =
_(
"No account column selected and no base account specified either.\n"
706 "This should never happen. Please report this as a bug.");
707 PINFO(
"User warning: %s", error_message);
708 auto errs = ErrMap { ErrPair { GncTransPropType::NONE, error_message},};
716 auto draft_trans = trans_properties_to_trans (parsed_line);
720 m_transactions.insert (std::pair<
time64, std::shared_ptr<DraftTransaction>>(trans_date,std::move(draft_trans)));
723 catch (
const std::invalid_argument& e)
725 auto err_str =
_(
"Problem creating preliminary transaction");
726 PINFO(
"%s: %s", err_str, e.what());
727 auto errs = ErrMap { ErrPair { GncTransPropType::NONE, err_str},};
743 auto verify_result = verify (
true);
744 if (!verify_result.empty())
745 throw std::invalid_argument (verify_result);
758 if ((std::get<PL_SKIP>(*parsed_lines_it)))
762 create_transaction (parsed_lines_it);
768GncTxImport::check_for_column_type (GncTransPropType type)
770 return (std::find (m_settings.m_column_types.begin(),
771 m_settings.m_column_types.end(), type)
772 != m_settings.m_column_types.end());
776void GncTxImport::update_pre_split_multi_col_prop (
parse_line_t& parsed_line, GncTransPropType col_type)
778 if (!is_multi_col_prop(col_type))
781 auto input_vec = std::get<PL_INPUT>(parsed_line);
782 auto split_props = std::get<PL_PRESPLIT> (parsed_line);
787 for (
auto col_it = m_settings.m_column_types.cbegin();
788 col_it < m_settings.m_column_types.cend();
790 if (*col_it == col_type)
792 auto value = std::string();
793 auto col_num =
static_cast<uint32_t
>(col_it - m_settings.m_column_types.cbegin());
795 if (col_num < input_vec.size())
796 value = input_vec.at(col_num);
797 split_props->add (col_type, value);
801void GncTxImport::update_pre_trans_props (
parse_line_t& parsed_line, uint32_t col, GncTransPropType old_type, GncTransPropType new_type)
803 auto input_vec = std::get<PL_INPUT>(parsed_line);
804 auto trans_props = std::get<PL_PRETRANS> (parsed_line);
808 trans_props->set_date_format (m_settings.m_date_format);
809 trans_props->set_multi_split (m_settings.m_multi_split);
811 if ((old_type > GncTransPropType::NONE) && (old_type <= GncTransPropType::TRANS_PROPS))
812 trans_props->reset (old_type);
813 if ((new_type > GncTransPropType::NONE) && (new_type <= GncTransPropType::TRANS_PROPS))
815 auto value = std::string();
817 if (col < input_vec.size())
818 value = input_vec.at(col);
820 trans_props->set(new_type, value);
827 if ((old_type == GncTransPropType::ACCOUNT) || (new_type == GncTransPropType::ACCOUNT))
828 trans_props->reset_cross_split_counters();
831void GncTxImport::update_pre_split_props (
parse_line_t& parsed_line, uint32_t col, GncTransPropType old_type, GncTransPropType new_type)
843 auto split_props = std::get<PL_PRESPLIT> (parsed_line);
844 auto trans_props = std::get<PL_PRETRANS> (parsed_line);
847 split_props->set_date_format (m_settings.m_date_format);
848 if (m_settings.m_multi_split && trans_props->is_part_of( m_parent))
849 split_props->set_pre_trans (m_parent);
852 split_props->set_pre_trans (trans_props);
853 m_parent = trans_props;
856 if ((old_type > GncTransPropType::TRANS_PROPS) && (old_type <= GncTransPropType::SPLIT_PROPS))
858 split_props->reset (old_type);
859 if (is_multi_col_prop(old_type))
860 update_pre_split_multi_col_prop (parsed_line, old_type);
863 if ((new_type > GncTransPropType::TRANS_PROPS) && (new_type <= GncTransPropType::SPLIT_PROPS))
865 if (is_multi_col_prop(new_type))
867 split_props->reset(new_type);
868 update_pre_split_multi_col_prop (parsed_line, new_type);
872 auto input_vec = std::get<PL_INPUT>(parsed_line);
873 auto value = std::string();
874 if (col < input_vec.size())
875 value = input_vec.at(col);
876 split_props->set(new_type, value);
879 m_multi_currency |= split_props->get_pre_trans()->is_multi_currency();
882 auto all_errors = split_props->get_pre_trans()->errors();
883 all_errors.merge (split_props->errors());
884 std::get<PL_ERROR>(parsed_line) = std::move(all_errors);
889GncTxImport::set_column_type (uint32_t position, GncTransPropType type,
bool force)
891 if (position >= m_settings.m_column_types.size())
894 auto old_type = m_settings.m_column_types[position];
895 if ((type == old_type) && !force)
900 if (!is_multi_col_prop(type))
901 std::replace(m_settings.m_column_types.begin(), m_settings.m_column_types.end(),
902 type, GncTransPropType::NONE);
904 m_settings.m_column_types.at (position) = type;
907 if (type == GncTransPropType::ACCOUNT)
912 m_multi_currency =
false;
915 update_pre_trans_props (parsed_lines_it, position, old_type, type);
916 update_pre_split_props (parsed_lines_it, position, old_type, type);
920std::vector<GncTransPropType> GncTxImport::column_types ()
922 return m_settings.m_column_types;
926GncTxImport::accounts ()
928 auto accts = std::set<std::string>();
929 auto acct_col_it = std::find (m_settings.m_column_types.begin(),
930 m_settings.m_column_types.end(), GncTransPropType::ACCOUNT);
931 uint32_t acct_col = acct_col_it - m_settings.m_column_types.begin();
932 auto tacct_col_it = std::find (m_settings.m_column_types.begin(),
933 m_settings.m_column_types.end(), GncTransPropType::TACCOUNT);
934 uint32_t tacct_col = tacct_col_it - m_settings.m_column_types.begin();
940 if ((std::get<PL_SKIP>(parsed_line)))
943 auto col_strs = std::get<PL_INPUT>(parsed_line);
944 if ((acct_col_it != m_settings.m_column_types.end()) &&
945 (acct_col < col_strs.size()) &&
946 !col_strs[acct_col].empty())
947 accts.insert(col_strs[acct_col]);
948 if ((tacct_col_it != m_settings.m_column_types.end()) &&
949 (tacct_col < col_strs.size()) &&
950 !col_strs[tacct_col].empty())
951 accts.insert(col_strs[tacct_col]);
~GncTxImport()
Destructor for GncTxImport.
void tokenize(bool guessColTypes)
Splits a file into cells.
void create_transactions()
This function will attempt to convert all tokenized lines into transactions using the column types th...
void encoding(const std::string &encoding)
Converts raw file data using a new encoding.
std::unique_ptr< GncTokenizer > m_tokenizer
Will handle file loading/encoding conversion/splitting into fields.
void multi_split(bool multi_split)
Toggles the multi-split state of the importer and will subsequently sanitize the column_types list.
std::vector< parse_line_t > m_parsed_lines
source file parsed into a two-dimensional array of strings.
void load_file(const std::string &filename)
Loads a file into a GncTxImport.
GncTxImport(GncImpFileFormat format=GncImpFileFormat::UNKNOWN)
Constructor for GncTxImport.
std::multimap< time64, std::shared_ptr< DraftTransaction > > m_transactions
map of transaction objects created from parsed_lines and column_types, ordered by date
void file_format(GncImpFileFormat format)
Sets the file format for the file to import, which may cause the file to be reloaded as well if the p...
void base_account(Account *base_account)
Sets a base account.
bool preset_is_reserved_name(const std::string &name)
Check whether name can be used as a preset name.
std::tuple< StrVec, std::string, std::shared_ptr< GncImportPrice >, bool > parse_line_t
Tuple to hold.
Class to import transactions from CSV or fixed width files.
Class to convert a csv file into vector of string vectors.
Class convert a file with fixed with delimited contents into vector of string vectors.
GncImpFileFormat
Enumeration for file formats supported by this importer.
gnc_commodity * gnc_account_get_currency_or_parent(const Account *account)
Returns a gnc_commodity that is a currency, suitable for being a Transaction's currency.
gnc_commodity * xaccAccountGetCommodity(const Account *acc)
Get the account's commodity
gboolean gnc_commodity_is_currency(const gnc_commodity *cm)
Checks to see if the specified commodity is an ISO 4217 recognized currency or a legacy currency.
gint64 time64
Most systems that are currently maintained, including Microsoft Windows, BSD-derived Unixes and Linux...
void xaccTransCommitEdit(Transaction *trans)
The xaccTransCommitEdit() method indicates that the changes to the transaction and its splits are com...
void xaccTransVoid(Transaction *trans, const char *reason)
xaccTransVoid voids a transaction.
time64 xaccTransGetDate(const Transaction *trans)
Retrieve the posted date of the transaction.
#define PINFO(format, args...)
Print an informational note.
#define PWARN(format, args...)
Log a warning.
bool save(void)
Save the gathered widget properties to a key File.
Exception that will be thrown whenever a parsing error is encountered.