getSecurityList() {\n return securityList;\n }\n\n public boolean isInvestmentAccount() {\n\n boolean result = false;\n\n for (final E transaction : getTransactions()) {\n if (transaction.isInvestmentTransaction()) {\n result = true;\n break;\n }\n }\n\n return result;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ImportFilter.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2021 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat;\n\nimport jgnash.engine.Engine;\nimport jgnash.engine.EngineFactory;\nimport jgnash.util.EncodeDecode;\nimport jgnash.util.FileUtils;\nimport jgnash.util.NotNull;\nimport jgnash.resource.util.OS;\n\nimport javax.script.Invocable;\nimport javax.script.ScriptEngine;\nimport javax.script.ScriptEngineManager;\nimport javax.script.ScriptException;\nimport java.io.IOException;\nimport java.io.InputStreamReader;\nimport java.io.Reader;\nimport java.io.UnsupportedEncodingException;\nimport java.net.URLDecoder;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.Locale;\nimport java.util.Objects;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.stream.Collectors;\n\nimport static jgnash.util.FileUtils.SEPARATOR;\n\n/**\n * Transaction Import filter.\n * \n * This class is responsible for calling the supplied javascript file.\n *\n * @author Craig Cavanaugh\n */\npublic class ImportFilter {\n\n private final static String ENABLED_FILTERS = \"enabledFilters\";\n\n private final static String IMPORT_SCRIPT_DIRECTORY_NAME = \"importScripts\";\n\n private static final String JS_REGEX_PATTERN = \".*.js\";\n\n private static final Logger logger = Logger.getLogger(ImportFilter.class.getName());\n\n private static final String[] KNOWN_SCRIPTS = {\"/jgnash/convert/scripts/tidy.js\"};\n\n private final ScriptEngine scriptEngine;\n\n private final String script;\n\n ImportFilter(final String script) {\n scriptEngine = new ScriptEngineManager().getEngineByName(\"nashorn\");\n this.script = script;\n evalScript();\n }\n\n public static List getImportFilters() {\n final List importFilterList = new ArrayList<>();\n\n // known filters first\n for (String knownScript : KNOWN_SCRIPTS) {\n importFilterList.add(new ImportFilter(knownScript));\n }\n\n for (final Path path : FileUtils.getDirectoryListing(getUserImportScriptDirectory(), JS_REGEX_PATTERN)) {\n importFilterList.add(new ImportFilter(path.toString()));\n }\n\n final String activeDatabase = EngineFactory.getActiveDatabase();\n if (activeDatabase != null && !activeDatabase.startsWith(EngineFactory.REMOTE_PREFIX)) {\n for (final Path path : FileUtils.getDirectoryListing(getBaseFileImportScriptDirectory(Paths.get(activeDatabase)), JS_REGEX_PATTERN)) {\n importFilterList.add(new ImportFilter(path.toString()));\n }\n }\n\n return importFilterList;\n }\n\n public static List getEnabledImportFilters() {\n List filterList = new ArrayList<>();\n\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n for (final String string : EncodeDecode.decodeStringCollection(engine.getPreference(ENABLED_FILTERS))) {\n filterList.add(new ImportFilter(string));\n }\n\n return filterList;\n }\n\n public static void saveEnabledImportFilters(final List filters) {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n if (filters != null && filters.size() > 0) {\n final List scripts = filters.stream().map(ImportFilter::getScript).collect(Collectors.toList());\n engine.setPreference(ENABLED_FILTERS, EncodeDecode.encodeStringCollection(scripts));\n } else {\n engine.setPreference(ENABLED_FILTERS, null);\n }\n }\n\n private static Path getUserImportScriptDirectory() {\n\n String scriptDirectory = System.getProperty(\"user.home\");\n\n // decode to correctly handle spaces, etc. in the returned path\n try {\n scriptDirectory = URLDecoder.decode(scriptDirectory, StandardCharsets.UTF_8.name());\n } catch (final UnsupportedEncodingException ex) {\n logger.log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n }\n\n if (OS.isSystemWindows()) {\n scriptDirectory += SEPARATOR + \"AppData\" + SEPARATOR + \"Local\" + SEPARATOR\n + \"jgnash\" + SEPARATOR + IMPORT_SCRIPT_DIRECTORY_NAME;\n } else { // unix, osx\n scriptDirectory += SEPARATOR + \".jgnash\" + SEPARATOR + IMPORT_SCRIPT_DIRECTORY_NAME;\n }\n\n logger.log(Level.INFO, \"Import Script path: {0}\", scriptDirectory);\n\n\n return Paths.get(scriptDirectory);\n }\n\n private static Path getBaseFileImportScriptDirectory(@NotNull final Path baseFile) {\n if (baseFile.getParent() != null) {\n return Paths.get(baseFile.getParent() + SEPARATOR + IMPORT_SCRIPT_DIRECTORY_NAME);\n }\n\n return null;\n }\n\n public String getScript() {\n return script;\n }\n\n private void evalScript() {\n try (final Reader reader = getReader()) {\n scriptEngine.eval(reader);\n } catch (final ScriptException | IOException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n }\n\n public String processMemo(final String memo) {\n try {\n final Invocable invocable = (Invocable) scriptEngine;\n\n final Object result = invocable.invokeFunction(\"processMemo\", memo);\n\n return result.toString();\n } catch (final ScriptException | NoSuchMethodException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n return memo;\n }\n\n public String processPayee(final String payee) {\n try {\n final Invocable invocable = (Invocable) scriptEngine;\n\n final Object result = invocable.invokeFunction(\"processPayee\", payee);\n\n return result.toString();\n } catch (final ScriptException | NoSuchMethodException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n return payee;\n }\n\n public String getDescription() {\n try {\n final Invocable invocable = (Invocable) scriptEngine;\n\n final Object result = invocable.invokeFunction(\"getDescription\", Locale.getDefault());\n\n return result.toString();\n } catch (final ScriptException | NoSuchMethodException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n return \"\";\n }\n\n public void acceptTransaction(final ImportTransaction importTransaction) {\n try {\n final Invocable invocable = (Invocable) scriptEngine;\n\n invocable.invokeFunction(\"acceptTransaction\", importTransaction);\n\n } catch (final ScriptException | NoSuchMethodException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n }\n\n private Reader getReader() throws IOException {\n if (Files.exists(Paths.get(script))) {\n return Files.newBufferedReader(Paths.get(script));\n }\n\n return new InputStreamReader(\n Objects.requireNonNull(ImportFilter.class.getResourceAsStream(script)), StandardCharsets.UTF_8);\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ImportSecurity.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.Optional;\n\nimport jgnash.engine.SecurityNode;\n\n/**\n * Security Import Object\n *\n * @author Craig Cavanaugh\n */\npublic class ImportSecurity {\n\n private String ticker;\n private String securityName;\n private BigDecimal unitPrice;\n private LocalDate localDate;\n private String id;\n public String idType;\n private String currency;\n private BigDecimal currencyRate;\n\n private SecurityNode securityNode;\n\n @Override\n public String toString() {\n StringBuilder b = new StringBuilder();\n\n b.append(\"ticker: \").append(getTicker()).append('\\n');\n b.append(\"securityName: \").append(securityName).append('\\n');\n b.append(\"unitPrice: \").append(unitPrice).append('\\n');\n b.append(\"localDate: \").append(localDate).append('\\n');\n\n if (id != null) {\n b.append(\"id: \").append(id).append('\\n');\n }\n\n if (idType != null) {\n b.append(\"idType: \").append(idType).append('\\n');\n }\n\n getCurrency().ifPresent(currency -> b.append(\"currency: \").append(currency).append('\\n'));\n\n getCurrencyRate().ifPresent(rate -> b.append(\"currencyRate: \").append(rate).append('\\n'));\n\n return b.toString();\n }\n\n public Optional getId() {\n return Optional.ofNullable(id);\n }\n\n public void setId(String id) {\n this.id = id;\n }\n\n Optional getSecurityName() {\n return Optional.ofNullable(securityName);\n }\n\n public void setSecurityName(final String securityName) {\n this.securityName = securityName;\n }\n\n Optional getUnitPrice() {\n return Optional.ofNullable(unitPrice);\n }\n\n public void setUnitPrice(final BigDecimal unitPrice) {\n this.unitPrice = unitPrice;\n }\n\n public Optional getLocalDate() {\n return Optional.ofNullable(localDate);\n }\n\n public void setLocalDate(final LocalDate localDate) {\n this.localDate = localDate;\n }\n\n public void setCurrencyRate(final BigDecimal unitPrice) {\n this.currencyRate = unitPrice;\n }\n\n public Optional getCurrencyRate() {\n return Optional.ofNullable(currencyRate);\n }\n\n public void setCurrency(final String currency) {\n this.currency = currency;\n }\n\n public Optional getCurrency() {\n return Optional.ofNullable(currency);\n }\n\n /**\n * Reference to the security node linked to this imported security node\n */\n public SecurityNode getSecurityNode() {\n return securityNode;\n }\n\n public void setSecurityNode(SecurityNode securityNode) {\n this.securityNode = securityNode;\n }\n\n public String getTicker() {\n return ticker;\n }\n\n public void setTicker(final String ticker) {\n this.ticker = ticker;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ImportState.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat;\n\n/**\n * @author Craig Cavanaugh\n */\npublic enum ImportState {\n NEW,\n EQUAL,\n IGNORE,\n NOT_EQUAL\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ImportTransaction.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.Objects;\nimport java.util.UUID;\n\nimport jgnash.engine.Account;\nimport jgnash.engine.TransactionType;\nimport jgnash.util.NotNull;\nimport jgnash.util.Nullable;\n\n/**\n * Common interface for importing transactions from OFX, QIF, and mt940\n *\n * @author Craig Cavanaugh\n * @author Arnout Engelen\n * @author Nicolas Bouillon\n */\npublic class ImportTransaction implements Comparable {\n\n private final String uuid = UUID.randomUUID().toString();\n\n /**\n * The destination account\n */\n private Account account;\n\n /**\n * Account for dividends and gains/losses from an investment transaction\n */\n private Account gainsAccount;\n\n /**\n * Account for investment expenses\n */\n private Account feesAccount;\n\n private BigDecimal amount = BigDecimal.ZERO;\n\n private String checkNumber = \"\"; // check number (?)\n\n @NotNull\n private LocalDate datePosted = LocalDate.now();\n\n @Nullable\n private LocalDate dateUser = null;\n\n private String memo = \"\"; // memo\n\n @NotNull\n private String payee = \"\";\n\n // OFX\n private String payeeId;\n\n private ImportState state = ImportState.NEW;\n\n // OFX, Financial Institution transaction ID\n private String FITID;\n\n // OFX\n private String securityId;\n\n // OFX\n private String securityType;\n\n private BigDecimal units = BigDecimal.ZERO;\n\n private BigDecimal unitPrice = BigDecimal.ZERO;\n\n private BigDecimal commission = BigDecimal.ZERO;\n\n private BigDecimal fees = BigDecimal.ZERO;\n\n // OFX, Type of income for investment transaction\n private String incomeType;\n\n private boolean taxExempt = false;\n\n // OFX\n private TransactionType transactionType = TransactionType.SINGLENTRY; // single entry by default\n\n // OFX\n private String transactionTypeDescription;\n\n // OFX\n private String SIC;\n\n // OFX\n private String refNum;\n\n // OFX\n private String subAccount;\n\n private String currency;\n\n // OFX, transfer account id\n private String accountTo;\n\n /**\n * @return returns the destination account\n */\n public Account getAccount() {\n return account;\n }\n\n public void setAccount(final Account account) {\n this.account = account;\n }\n\n /**\n * Depending on the implementation a unique ID may be provided that can be used to detect\n * duplication of prior imported transactions.\n *\n * @return transaction id\n */\n public String getFITID() {\n return FITID;\n }\n\n public void setFITID(String FITID) {\n this.FITID = FITID;\n }\n\n /**\n * Deposits get positive 'amounts', withdrawals negative\n *\n * @return transaction amount\n */\n public BigDecimal getAmount() {\n return amount;\n }\n\n public void setAmount(BigDecimal amount) {\n this.amount = amount;\n }\n\n @NotNull\n public LocalDate getDatePosted() {\n return datePosted;\n }\n\n public void setDatePosted(@NotNull LocalDate datePosted) {\n this.datePosted = datePosted;\n }\n\n /**\n * Date user initiated the transaction, optional, may be null\n *\n * @return date transaction was initiated\n */\n @Nullable\n public LocalDate getDateUser() {\n return dateUser;\n }\n\n public void setDateUser(@Nullable LocalDate dateUser) {\n this.dateUser = dateUser;\n }\n\n public String getCheckNumber() {\n return checkNumber;\n }\n\n public void setCheckNumber(final String checkNumber) {\n this.checkNumber = checkNumber;\n }\n\n public String getMemo() {\n return memo;\n }\n\n public void setMemo(String memo) {\n this.memo = memo;\n }\n\n public ImportState getState() {\n return state;\n }\n\n public void setState(ImportState state) {\n this.state = state;\n }\n\n @NotNull\n public String getPayee() {\n return payee;\n }\n\n public void setPayee(@NotNull String payee) {\n Objects.requireNonNull(payee);\n\n this.payee = payee;\n }\n\n public String getSecurityId() {\n return securityId;\n }\n\n public void setSecurityId(String securityId) {\n this.securityId = securityId;\n }\n\n @Override\n public int compareTo(@NotNull final ImportTransaction importTransaction) {\n if (importTransaction == this) {\n return 0;\n }\n\n int result = getDatePosted().compareTo(importTransaction.getDatePosted());\n if (result != 0) {\n return result;\n }\n\n result = payee.compareTo(importTransaction.payee);\n if (result != 0) {\n return result;\n }\n\n return Integer.compare(hashCode(), importTransaction.hashCode());\n }\n\n @Override\n public boolean equals(final Object that) {\n if (this == that) {\n return true;\n }\n\n if (that == null || getClass() != that.getClass()) {\n return false;\n }\n\n return Objects.equals(uuid, ((ImportTransaction) that).uuid);\n }\n\n @Override\n public int hashCode() {\n return Objects.hash(uuid);\n }\n\n /**\n * Investment transaction units\n */\n public BigDecimal getUnits() {\n return units;\n }\n\n public void setUnits(final BigDecimal units) {\n this.units = units;\n }\n\n /**\n * Investment transaction unit price\n */\n public BigDecimal getUnitPrice() {\n return unitPrice;\n }\n\n public void setUnitPrice(final BigDecimal unitPrice) {\n this.unitPrice = unitPrice;\n }\n\n /**\n * Investment transaction commission\n */\n public BigDecimal getCommission() {\n return commission;\n }\n\n public void setCommission(final BigDecimal commission) {\n this.commission = commission;\n }\n\n public boolean isTaxExempt() {\n return taxExempt;\n }\n\n public void setTaxExempt(boolean taxExempt) {\n this.taxExempt = taxExempt;\n }\n\n public String getSecurityType() {\n return securityType;\n }\n\n public void setSecurityType(final String securityType) {\n this.securityType = securityType;\n }\n\n public boolean isInvestmentTransaction() {\n return getSecurityId() != null;\n }\n\n public String getIncomeType() {\n return incomeType;\n }\n\n public void setIncomeType(String incomeType) {\n this.incomeType = incomeType;\n }\n\n @NotNull public BigDecimal getFees() {\n return fees;\n }\n\n public void setFees(@NotNull final BigDecimal fees) {\n this.fees = fees;\n }\n\n /**\n * The parser may establish a transaction type when imported.\n *\n * @return {@code TransactionType}\n */\n @NotNull\n public TransactionType getTransactionType() {\n return transactionType;\n }\n\n public void setTransactionType(@NotNull final TransactionType transactionType) {\n this.transactionType = transactionType;\n }\n\n /**\n * OFX defines descriptive transaction types\n */\n public String getTransactionTypeDescription() {\n return transactionTypeDescription;\n }\n\n public void setTransactionTypeDescription(final String transactionTypeDescription) {\n this.transactionTypeDescription = transactionTypeDescription;\n }\n\n /**\n * Standard Industry Code\n * \n * Could be use used for automatic expense and income assignment. Typically a 4 digit numeric, but OFX allows 6\n */\n public String getSIC() {\n return SIC;\n }\n\n public void setSIC(String SIC) {\n this.SIC = SIC;\n }\n\n /**\n * Reference number that uniquely identifies the transaction. May be used in\n * addition to or instead of a {@link #getCheckNumber()}\n */\n public String getRefNum() {\n return refNum;\n }\n\n public void setRefNum(String refNum) {\n this.refNum = refNum;\n }\n\n /**\n * Some OFX based systems will assign an ID to a Payee.\n *
\n * The ID would correspond to a Payee List identified by (not implemented)\n */\n public String getPayeeId() {\n return payeeId;\n }\n\n public void setPayeeId(String payeeId) {\n this.payeeId = payeeId;\n }\n\n /**\n * The sub-account for cash transfer, typically CASH, but could be MARGIN, SHORT, or OTHER\n * \n * , , , \n */\n public String getSubAccount() {\n return subAccount;\n }\n\n public void setSubAccount(String subAccount) {\n this.subAccount = subAccount;\n }\n\n public String getCurrency() {\n return currency;\n }\n\n public void setCurrency(String currency) {\n this.currency = currency;\n }\n\n /**\n * Account for gains or losses from an investment transaction\n */\n public Account getGainsAccount() {\n return gainsAccount;\n }\n\n public void setGainsAccount(final Account gainsAccount) {\n this.gainsAccount = gainsAccount;\n }\n\n /**\n * Account for investment expenses\n */\n public Account getFeesAccount() {\n return feesAccount;\n }\n\n public void setFeesAccount(Account feesAccount) {\n this.feesAccount = feesAccount;\n }\n\n @NotNull\n public String getToolTip() {\n if (isInvestmentTransaction()) {\n return units.toString() + \" @ \" + unitPrice.toString();\n }\n return \"\";\n }\n\n @Override\n public String toString() {\n return getTransactionTypeDescription() + \", \" +\n getTransactionType() + \", \" +\n getDatePosted() + \", \" +\n getAmount() + \", \" +\n getFITID() + \", \" +\n getSIC() + \", \" +\n getPayee() + \", \" +\n\n getMemo() + \", \" +\n getCheckNumber() + \", \" +\n getRefNum() + \", \" +\n getPayeeId() + \", \" +\n getCurrency();\n }\n\n public String getAccountTo() {\n return accountTo;\n }\n\n public void setAccountTo(String accountTo) {\n this.accountTo = accountTo;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ImportUtils.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat;\n\nimport java.util.Objects;\nimport java.util.Optional;\n\nimport jgnash.engine.Account;\nimport jgnash.engine.AccountType;\nimport jgnash.engine.CurrencyNode;\nimport jgnash.engine.Engine;\nimport jgnash.engine.EngineFactory;\nimport jgnash.engine.SecurityNode;\n\n/**\n * Various utility methods used when importing transactions\n *\n * @author Craig Cavanaugh\n */\npublic class ImportUtils {\n\n private ImportUtils() {\n }\n\n public static Account getRootExpenseAccount() {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n return searchForRootType(engine.getRootAccount(), AccountType.EXPENSE);\n }\n\n public static Account getRootIncomeAccount() {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n return searchForRootType(engine.getRootAccount(), AccountType.INCOME);\n }\n\n /**\n * Matches an ImportTransaction to an Account based on an AccountTo tag if it exists\n * @param importTransaction Import transaction to test\n * @return Account if found, null otherwise\n */\n public static Account matchAccount(final ImportTransaction importTransaction) {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n final String number = importTransaction.getAccountTo();\n\n Account account = null;\n\n if (number != null) {\n for (final Account a : engine.getAccountList()) {\n if (a.getAccountNumber().equals(number)) {\n account = a;\n break;\n }\n }\n }\n\n return account;\n }\n\n private static Account searchForRootType(final Account account, final AccountType accountType) {\n Account result = null;\n\n // search immediate top level accounts\n for (Account a : account.getChildren()) {\n if (a.getAccountType().equals(accountType)) {\n return a;\n }\n }\n\n // recursive search\n for (Account a : account.getChildren()) {\n result = searchForRootType(a, accountType);\n if (result != null) {\n break;\n }\n }\n\n return result;\n }\n\n static Optional matchSecurity(final ImportSecurity security) {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n for (final SecurityNode securityNode : engine.getSecurities()) {\n if (securityNode.getSymbol().equals(security.getTicker())) {\n return Optional.of(securityNode);\n }\n }\n return Optional.empty();\n }\n\n static SecurityNode createSecurityNode(final ImportSecurity security, final CurrencyNode currencyNode) {\n final SecurityNode securityNode = new SecurityNode(currencyNode);\n\n securityNode.setSymbol(security.getTicker());\n securityNode.setScale(currencyNode.getScale());\n\n security.getSecurityName().ifPresent(securityNode::setDescription);\n security.getId().ifPresent(securityNode::setISIN);\n\n return securityNode;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ofx/OfxBank.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.ofx;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\n\nimport jgnash.convert.importat.ImportBank;\nimport jgnash.convert.importat.ImportSecurity;\nimport jgnash.convert.importat.ImportTransaction;\nimport jgnash.util.Nullable;\n\n/**\n * OFX Bank Object\n *\n * @author Craig Cavanaugh\n * @author Nicolas Bouillon\n */\npublic class OfxBank extends ImportBank {\n\n public String currency;\n\n String bankId;\n\n /**\n * Branch identifier. May be required for some non-US banks\n */\n String branchId;\n\n public String accountId;\n\n String accountType;\n\n LocalDate dateStart;\n\n LocalDate dateEnd;\n\n BigDecimal ledgerBalance;\n\n LocalDate ledgerBalanceDate;\n\n BigDecimal availBalance;\n\n LocalDate availBalanceDate;\n\n int statusCode;\n\n String statusSeverity;\n\n @Nullable\n String statusMessage;\n\n @Override\n public String toString() {\n StringBuilder b = new StringBuilder();\n\n b.append(\"statusCode: \").append(statusCode).append('\\n');\n b.append(\"statusSeverity: \").append(statusSeverity).append('\\n');\n b.append(\"statusMessage: \").append(statusMessage).append('\\n');\n b.append(\"currency: \").append(currency).append('\\n');\n b.append(\"bankId: \").append(bankId).append('\\n');\n b.append(\"branchId: \").append(branchId).append('\\n');\n b.append(\"accountId: \").append(accountId).append('\\n');\n b.append(\"accountType: \").append(accountType).append('\\n');\n b.append(\"dateStart: \").append(dateStart).append('\\n');\n b.append(\"dateEnd: \").append(dateEnd).append('\\n');\n b.append(\"ledgerBalance: \").append(ledgerBalance).append('\\n');\n b.append(\"ledgerBalanceDate: \").append(ledgerBalanceDate).append('\\n');\n\n if (availBalance != null) {\n b.append(\"availBalance: \").append(availBalance).append('\\n');\n }\n\n if (availBalanceDate != null) {\n b.append(\"availBalanceDate: \").append(availBalanceDate).append('\\n');\n }\n\n for (final ImportTransaction t : getTransactions()) {\n b.append(t).append('\\n');\n }\n\n for (final ImportSecurity importSecurity : securityList) {\n b.append(importSecurity.toString()).append('\\n');\n }\n\n return b.toString();\n }\n\n /* USD\n \n 074914229\n 10076164\n CHECKING\n \n */\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ofx/OfxImport.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.ofx;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.Objects;\n\nimport jgnash.convert.common.OfxTags;\nimport jgnash.convert.importat.ImportSecurity;\nimport jgnash.convert.importat.ImportState;\nimport jgnash.convert.importat.ImportTransaction;\nimport jgnash.engine.Account;\nimport jgnash.engine.AccountGroup;\nimport jgnash.engine.CurrencyNode;\nimport jgnash.engine.Engine;\nimport jgnash.engine.EngineFactory;\nimport jgnash.engine.InvestmentTransaction;\nimport jgnash.engine.SecurityNode;\nimport jgnash.engine.Transaction;\nimport jgnash.engine.TransactionEntry;\nimport jgnash.engine.TransactionFactory;\nimport jgnash.engine.TransactionTag;\n\n/**\n * OfxImport utility methods\n *\n * @author Craig Cavanaugh\n */\npublic class OfxImport {\n\n /**\n * Private constructor, utility class\n */\n private OfxImport() {\n }\n\n public static void importTransactions(final OfxBank ofxBank, final Account baseAccount) {\n Objects.requireNonNull(ofxBank.getTransactions());\n Objects.requireNonNull(baseAccount);\n\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n for (final ImportTransaction tran : ofxBank.getTransactions()) {\n\n // do not import matched transactions\n if (tran.getState() == ImportState.NEW || tran.getState() == ImportState.NOT_EQUAL) {\n Transaction transaction = null;\n\n if (tran.isInvestmentTransaction()) {\n if (baseAccount.getAccountType().getAccountGroup() == AccountGroup.INVEST) {\n transaction = importInvestmentTransaction(ofxBank, tran, baseAccount);\n\n if (transaction != null) {\n\n // check and add the security node to the account if not present\n if (!baseAccount.containsSecurity(((InvestmentTransaction) transaction).getSecurityNode())) {\n engine.addAccountSecurity(((InvestmentTransaction) transaction).getInvestmentAccount(),\n ((InvestmentTransaction) transaction).getSecurityNode());\n }\n }\n\n } else { // Signal an error\n System.out.println(\"Base account was not an investment account type\");\n }\n } else {\n if (baseAccount.equals(tran.getAccount())) { // single entry oTran\n transaction = TransactionFactory.generateSingleEntryTransaction(baseAccount, tran.getAmount(),\n tran.getDatePosted(), tran.getMemo(), tran.getPayee(), tran.getCheckNumber());\n } else { // double entry\n if (tran.getAmount().signum() >= 0) {\n transaction = TransactionFactory.generateDoubleEntryTransaction(baseAccount, tran.getAccount(),\n tran.getAmount().abs(), tran.getDatePosted(), tran.getMemo(), tran.getPayee(),\n tran.getCheckNumber());\n } else {\n transaction = TransactionFactory.generateDoubleEntryTransaction(tran.getAccount(), baseAccount,\n tran.getAmount().abs(), tran.getDatePosted(), tran.getMemo(), tran.getPayee(),\n tran.getCheckNumber());\n }\n }\n }\n\n // add the new transaction\n if (transaction != null) {\n transaction.setFitid(tran.getFITID());\n engine.addTransaction(transaction);\n }\n }\n }\n }\n\n private static InvestmentTransaction importInvestmentTransaction(final OfxBank ofxBank, final ImportTransaction ofxTransaction,\n final Account investmentAccount) {\n\n final SecurityNode securityNode = matchSecurity(ofxBank, ofxTransaction.getSecurityId());\n final String memo = ofxTransaction.getMemo();\n final LocalDate datePosted = ofxTransaction.getDatePosted();\n\n final BigDecimal units = ofxTransaction.getUnits();\n final BigDecimal unitPrice = ofxTransaction.getUnitPrice();\n\n final Account incomeAccount = ofxTransaction.getGainsAccount();\n final Account fessAccount = ofxTransaction.getFeesAccount();\n\n Account cashAccount = ofxTransaction.getAccount();\n\n // force use of cash balance\n if (OfxTags.CASH.equals(ofxTransaction.getSubAccount())) {\n cashAccount = investmentAccount;\n }\n\n final List fees = new ArrayList<>();\n final List gains = new ArrayList<>();\n\n if (ofxTransaction.getCommission().compareTo(BigDecimal.ZERO) != 0) {\n final TransactionEntry transactionEntry = new TransactionEntry(fessAccount, ofxTransaction.getCommission().negate());\n transactionEntry.setTransactionTag(TransactionTag.INVESTMENT_FEE);\n fees.add(transactionEntry);\n }\n\n if (ofxTransaction.getFees().compareTo(BigDecimal.ZERO) != 0) {\n final TransactionEntry transactionEntry = new TransactionEntry(fessAccount, ofxTransaction.getFees().negate());\n transactionEntry.setTransactionTag(TransactionTag.INVESTMENT_FEE);\n fees.add(transactionEntry);\n }\n\n InvestmentTransaction transaction = null;\n\n if (securityNode != null) {\n switch (ofxTransaction.getTransactionType()) {\n case DIVIDEND:\n final BigDecimal dividend = ofxTransaction.getAmount();\n\n transaction = TransactionFactory.generateDividendXTransaction(incomeAccount, investmentAccount, cashAccount,\n securityNode, dividend, dividend, dividend, datePosted, memo);\n break;\n case REINVESTDIV:\n // Create a gains entry of an account other than the investment account has been selected\n if (incomeAccount != investmentAccount) {\n final TransactionEntry gainsEntry = TransactionFactory.createTransactionEntry(incomeAccount,\n investmentAccount, ofxTransaction.getAmount().negate(), memo, TransactionTag.GAIN_LOSS);\n gains.add(gainsEntry);\n }\n\n transaction = TransactionFactory.generateReinvestDividendXTransaction(investmentAccount, securityNode,\n unitPrice, units, datePosted, memo, fees, gains);\n break;\n case BUYSHARE:\n transaction = TransactionFactory.generateBuyXTransaction(cashAccount, investmentAccount, securityNode,\n unitPrice, units, BigDecimal.ONE, datePosted, memo, fees);\n break;\n case SELLSHARE:\n transaction = TransactionFactory.generateSellXTransaction(cashAccount, investmentAccount, securityNode,\n unitPrice, units, BigDecimal.ONE, datePosted, memo, fees, gains);\n break;\n default:\n }\n }\n\n return transaction;\n }\n\n private static SecurityNode matchSecurity(final OfxBank ofxBank, final String securityId) {\n\n SecurityNode securityNode = null;\n\n for (final ImportSecurity importSecurity : ofxBank.getSecurityList()) {\n if (importSecurity.getId().isPresent()) {\n if (importSecurity.getId().get().equals(securityId)) {\n securityNode = importSecurity.getSecurityNode();\n break;\n }\n }\n }\n\n return securityNode;\n }\n\n public static Account matchAccount(final OfxBank bank) {\n final Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n Objects.requireNonNull(engine);\n\n final String number = bank.accountId;\n final CurrencyNode node = engine.getCurrency(bank.currency);\n\n Account account = null;\n\n if (node != null) {\n for (Account a : engine.getAccountList()) {\n if (a.getAccountNumber() != null && a.getAccountNumber().equals(number) && a.getCurrencyNode().equals(node)) {\n account = a;\n break;\n }\n }\n } else if (number != null) {\n for (Account a : engine.getAccountList()) {\n if (a.getAccountNumber().equals(number)) {\n account = a;\n break;\n }\n }\n }\n\n return account;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ofx/OfxV1ToV2.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.ofx;\n\nimport java.io.BufferedInputStream;\nimport java.io.BufferedReader;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.io.InputStreamReader;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.List;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport jgnash.util.FileMagic;\n\nimport static jgnash.util.LogUtil.logSevere;\nimport static jgnash.convert.importat.ofx.Sanitize.sanitize;\n\n/**\n * Utility class to convert OFX version 1 (SGML) to OFX version 2 (XML)\n *\n * @author Craig Cavanaugh\n */\nclass OfxV1ToV2 {\n\n private static final int READ_AHEAD_LIMIT = 2048;\n\n /*\n public static void main(final String[] args) {\n if (args.length == 2) {\n Path input = Paths.get(args[0]);\n Path output = Paths.get(args[1]);\n\n if (Files.exists(input)) {\n try {\n Files.write(output, convertToXML(input).getBytes());\n } catch (final IOException e) {\n e.printStackTrace();\n }\n }\n }\n }*/\n\n static String convertToXML(final Path path) {\n String encoding = FileMagic.getOfxV1Encoding(path);\n\n Logger.getLogger(OfxV1ToV2.class.getName()).log(Level.INFO, \"OFX Version 1 file encoding was {0}\", encoding);\n\n return convertSgmlToXML(readFile(path, encoding));\n }\n\n static String convertToXML(final InputStream stream) {\n return convertSgmlToXML(readFile(stream, System.getProperty(\"file.encoding\")));\n }\n\n private static String convertSgmlToXML(final String sgml) {\n StringBuilder xml = new StringBuilder(sgml);\n\n int readPos = 0;\n int tagEnd = 0;\n\n while (readPos < xml.length() && readPos != -1) {\n String tag;\n\n readPos = xml.indexOf(\"<\", tagEnd);\n\n if (readPos != -1) {\n tagEnd = xml.indexOf(\">\", readPos);\n\n if (tagEnd != -1) {\n tag = xml.substring(readPos + 1, tagEnd);\n\n if (!tag.startsWith(\"/\")) {\n if (xml.indexOf(\"\", tagEnd) == -1) {\n\n readPos = xml.indexOf(\"<\", tagEnd);\n xml.insert(readPos, \"\");\n }\n }\n } else {\n readPos = -1;\n }\n }\n }\n\n return sanitize(xml.toString());\n }\n\n private static String concat(final Collection strings) {\n StringBuilder b = new StringBuilder();\n\n for (String s : strings) {\n b.append(s.trim());\n }\n\n return b.toString();\n }\n\n /**\n * Munch through the header one character at a time. Do not assume clean\n * formatting or EOL characters.\n *\n * @param reader {@code BufferedReader}\n * @throws IOException thrown if IO error occurs\n */\n private static void consumeHeader(final BufferedReader reader) throws IOException {\n\n Logger logger = Logger.getLogger(OfxV1ToV2.class.getName());\n\n while (true) {\n reader.mark(READ_AHEAD_LIMIT);\n\n int character = reader.read();\n\n if (character >= 0) {\n if (character == '<') {\n reader.reset();\n logger.info(\"readHeader() Complete\");\n break;\n }\n } else {\n break;\n }\n }\n }\n\n /**\n * Reads a file, strips the header and reads the SGML content into one large\n * string\n *\n * @param stream input stream\n * @param characterSet assumed character set for the file being converted\n * @return a String with the SGML content and header removed\n */\n private static String readFile(final InputStream stream, final String characterSet) {\n\n if (stream == null) {\n logSevere(OfxV1ToV2.class, \"InputStream was null\");\n return null;\n }\n\n List strings = new ArrayList<>();\n\n try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream, characterSet))) {\n // consume the Ofx1 header\n consumeHeader(reader);\n\n String line = reader.readLine();\n\n while (line != null) {\n\n line = line.trim();\n\n if (!line.isEmpty()) {\n strings.add(line);\n }\n\n line = reader.readLine();\n }\n } catch (final IOException e) {\n logSevere(OfxV1ToV2.class, e);\n }\n\n return concat(strings);\n }\n\n private static String readFile(final Path path, final String characterSet) {\n \ttry (final InputStream stream = new BufferedInputStream(Files.newInputStream(path))) {\n \t\treturn readFile(stream, characterSet);\n \t} catch (final IOException e) {\n logSevere(OfxV1ToV2.class, e);\n return \"\";\n\t\t} \t \t \n }\n\n private OfxV1ToV2() {\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ofx/OfxV2Parser.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.ofx;\n\nimport java.io.BufferedInputStream;\nimport java.io.BufferedReader;\nimport java.io.ByteArrayInputStream;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.io.InputStreamReader;\nimport java.io.UnsupportedEncodingException;\nimport java.math.BigDecimal;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.text.DecimalFormat;\nimport java.text.NumberFormat;\nimport java.text.ParseException;\nimport java.time.LocalDate;\nimport java.util.Iterator;\nimport java.util.List;\nimport java.util.Locale;\nimport java.util.logging.FileHandler;\nimport java.util.logging.Handler;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.logging.SimpleFormatter;\nimport java.util.regex.Pattern;\nimport java.util.stream.Collectors;\n\nimport javax.xml.namespace.QName;\nimport javax.xml.stream.XMLInputFactory;\nimport javax.xml.stream.XMLStreamConstants;\nimport javax.xml.stream.XMLStreamException;\nimport javax.xml.stream.XMLStreamReader;\n\nimport jgnash.convert.common.OfxTags;\nimport jgnash.convert.importat.ImportSecurity;\nimport jgnash.convert.importat.ImportTransaction;\nimport jgnash.engine.TransactionType;\nimport jgnash.resource.util.ResourceUtils;\nimport jgnash.util.FileMagic;\nimport jgnash.util.NotNull;\n\nimport static jgnash.convert.importat.ofx.Sanitize.sanitize;\n\n/**\n * StAX based parser for 2.x OFX (XML) files.\n * \n * This parser will intentionally absorb higher level elements and drop through to simplify and reduce code.\n *\n * @author Craig Cavanaugh\n */\npublic class OfxV2Parser implements OfxTags {\n\n private static final Logger logger = Logger.getLogger(\"OfxV2Parser\");\n\n private static final String EXTRA_SPACE_REGEX = \"\\\\s+\";\n\n private static final String ENCODING = StandardCharsets.UTF_8.name();\n\n private OfxBank bank;\n\n /**\n * Default language is assumed to be English unless the import file defines it\n */\n private String language = \"ENG\";\n\n private int statusCode;\n\n private String statusSeverity;\n\n /**\n * Status message from sign-on process\n */\n private String statusMessage;\n\n private final Pattern extraSpaceRegex = Pattern.compile(EXTRA_SPACE_REGEX);\n\n /**\n * Support class\n */\n private static class AccountInfo {\n String bankId;\n String accountId;\n String accountType;\n String branchId;\n }\n\n static void enableDetailedLogFile() {\n try {\n final Handler fh = new FileHandler(\"%t/jgnash-ofx.log\", false);\n fh.setFormatter(new SimpleFormatter());\n logger.addHandler(fh);\n logger.setLevel(Level.ALL);\n } catch (final IOException ioe) {\n logger.severe(ResourceUtils.getString(\"Message.Error.LogFileHandler\"));\n }\n }\n\n public static OfxBank parse(@NotNull final Path file) throws Exception {\n\n final OfxV2Parser parser = new OfxV2Parser();\n\n if (FileMagic.isOfxV1(file)) {\n logger.info(\"Parsing OFX Version 1 file\");\n parser.parse(OfxV1ToV2.convertToXML(file), FileMagic.getOfxV1Encoding(file));\n } else if (FileMagic.isOfxV2(file)) {\n logger.info(\"Parsing OFX Version 2 file\");\n parser.parseFile(file);\n } else {\n logger.info(\"Unknown OFX Version\");\n }\n\n if (parser.getBank() == null) {\n throw new Exception(\"Bank import failed\");\n }\n\n return postProcess(parser.getBank());\n }\n\n /**\n * Post processes the OFX transactions for import. Income transactions with a reinvestment transaction will be\n * stripped out. jGnash has a reinvested dividend transaction that reduces overall transaction count.\n *\n * @param ofxBank OfxBank to process\n * @return OfxBank with post processed transactions\n */\n private static OfxBank postProcess(final OfxBank ofxBank) {\n // Clone the original list\n final List importTransactions = ofxBank.getTransactions();\n\n // Create a list of Reinvested dividends\n final List reinvestedDividends = importTransactions.stream()\n .filter(importTransaction -> importTransaction.getTransactionType() == TransactionType.REINVESTDIV)\n .collect(Collectors.toList());\n\n // Search through the list and remove matching income transactions\n for (final ImportTransaction reinvestDividend : reinvestedDividends) {\n\n final Iterator iterator = importTransactions.iterator();\n\n while (iterator.hasNext()) {\n final ImportTransaction otherTran = iterator.next();\n\n // if this was OFX income and the securities match and the amount match, remove the transaction\n if (reinvestDividend != otherTran && OfxTags.INCOME.equals(otherTran.getTransactionTypeDescription())) {\n if (otherTran.getAmount().compareTo(reinvestDividend.getAmount().abs()) == 0) {\n if (otherTran.getSecurityId().equals(reinvestDividend.getSecurityId())) {\n iterator.remove(); // remove it\n // reverse sign\n reinvestDividend.setAmount(reinvestDividend.getAmount().abs());\n }\n }\n }\n }\n }\n\n return ofxBank;\n }\n\n /**\n * Parse a date. Time zone and seconds are ignored\n * \n * YYYYMMDDHHMMSS.XXX [gmt offset:tz name]\n *\n * @param date String form of the date\n * @return parsed date\n */\n private static LocalDate parseDate(final String date) {\n int year = Integer.parseInt(date.substring(0, 4)); // year\n int month = Integer.parseInt(date.substring(4, 6)); // month\n int day = Integer.parseInt(date.substring(6, 8)); // day\n\n return LocalDate.of(year, month, day);\n }\n\n private static BigDecimal parseAmount(final String amount) {\n\n /* Must trim the amount for a clean parse\n * Some banks leave extra spaces before the value\n */\n\n try {\n return new BigDecimal(amount.trim());\n } catch (final NumberFormatException e) {\n if (amount.contains(\",\")) { // OFX file in not valid and uses commas for decimal separators\n\n // Use the French locale as it uses commas for decimal separators\n DecimalFormat df = (DecimalFormat) NumberFormat.getInstance(Locale.FRENCH);\n df.setParseBigDecimal(true); // force return value of BigDecimal\n\n try {\n return (BigDecimal) df.parseObject(amount.trim());\n } catch (final ParseException pe) {\n logger.log(Level.INFO, \"Parse amount was: {0}\", amount);\n logger.log(Level.SEVERE, e.getLocalizedMessage(), pe);\n }\n }\n\n return BigDecimal.ZERO; // give up at this point\n }\n }\n\n private static boolean parseBoolean(final String bool) {\n return !bool.isEmpty() && bool.startsWith(\"T\");\n }\n\n /**\n * Parses an InputStream and assumes UTF-8 encoding\n *
\n * Illegal characters are corrected automatically if found\n *\n * @param stream InputStream to parse\n */\n public void parse(final InputStream stream) {\n\n final StringBuilder stringBuilder = new StringBuilder();\n\n try (final BufferedReader reader = new BufferedReader(new InputStreamReader(stream, ENCODING))) {\n String line;\n\n while ((line = reader.readLine()) != null) {\n stringBuilder.append(line);\n }\n\n parse(sanitize(stringBuilder.toString()), ENCODING);\n } catch (final IOException e) {\n logger.log(Level.SEVERE, e.toString(), e);\n }\n }\n\n /**\n * Parses an InputStream using a specified encoding\n *\n * @param stream InputStream to parse\n * @param encoding encoding to use\n */\n private void parse(final InputStream stream, final String encoding) {\n logger.entering(OfxV2Parser.class.getName(), \"parse\");\n\n bank = new OfxBank();\n\n final XMLInputFactory inputFactory = XMLInputFactory.newInstance();\n inputFactory.setProperty(XMLInputFactory.IS_SUPPORTING_EXTERNAL_ENTITIES, false);\n inputFactory.setProperty(XMLInputFactory.SUPPORT_DTD, false);\n\n try (final InputStream input = new BufferedInputStream(stream)) {\n XMLStreamReader reader = inputFactory.createXMLStreamReader(input, encoding);\n readOfx(reader);\n } catch (IOException | XMLStreamException e) {\n logger.log(Level.SEVERE, e.toString(), e);\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parse\");\n }\n\n private void parseFile(final Path path) {\n\n try (final InputStream stream = new BufferedInputStream(Files.newInputStream(path))) {\n parse(stream);\n } catch (final IOException e) {\n logger.log(Level.SEVERE, e.toString(), e);\n }\n }\n\n public void parse(final String string, final String encoding) throws UnsupportedEncodingException {\n parse(new ByteArrayInputStream(string.getBytes(encoding)), encoding);\n }\n\n private void readOfx(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"readOfx\");\n\n while (reader.hasNext()) {\n\n final int event = reader.next();\n\n if (event == XMLStreamConstants.START_ELEMENT) {\n switch (reader.getLocalName()) {\n case OFX: // consume the OFX header here\n break;\n case SIGNONMSGSRSV1:\n parseSignOnMessageSet(reader);\n break;\n case BANKMSGSRSV1:\n parseBankMessageSet(reader);\n break;\n case CREDITCARDMSGSRSV1:\n parseCreditCardMessageSet(reader);\n break;\n case INVSTMTMSGSRSV1:\n parseInvestmentAccountMessageSet(reader);\n break;\n case SECLISTMSGSRSV1:\n parseSecuritesMessageSet(reader);\n break;\n default:\n logger.log(Level.WARNING, \"Unknown message set {0}\", reader.getLocalName());\n break;\n }\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"readOfx\");\n }\n\n private void parseInvestmentAccountMessageSet(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseInvestmentAccountMessageSet\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case STATUS:\n parseStatementStatus(reader);\n break;\n case CURDEF:\n bank.currency = reader.getElementText();\n break;\n case INVACCTFROM:\n parseAccountInfo(bank, parseAccountInfo(reader));\n break;\n case INVTRANLIST:\n parseInvestmentTransactionList(reader);\n break;\n case INVSTMTRS: // consume the statement download\n break;\n case INVPOSLIST: // consume the securities position list; TODO: Use for reconcile\n case INV401KBAL: // consume 401k balance aggregate\n case INV401K: // consume 401k account info aggregate\n case INVBAL: // consume the investment account balance; TODO: Use for reconcile\n case INVOOLIST: // consume open orders\n consumeElement(reader);\n break;\n case INVSTMTTRNRS:\n case TRNUID:\n case DTASOF: // statement date\n break;\n default:\n logger.log(Level.WARNING, \"Unknown INVSTMTMSGSRSV1 element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the investment account message set aggregate\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseInvestmentAccountMessageSet\");\n }\n\n /**\n * Parses a BANKMSGSRSV1 element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseBankMessageSet(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseBankMessageSet\");\n\n final QName parsingElement = reader.getName();\n\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case STATUS:\n parseStatementStatus(reader);\n break;\n case CURDEF:\n bank.currency = reader.getElementText();\n break;\n case LEDGERBAL:\n parseLedgerBalance(reader);\n break;\n case AVAILBAL:\n parseAvailableBalance(reader);\n break;\n case BANKACCTFROM:\n parseAccountInfo(bank, parseAccountInfo(reader));\n break;\n case BANKTRANLIST:\n parseBankTransactionList(reader);\n break;\n case STMTTRNRS: // consume it\n case TRNUID:\n case STMTRS:\n break;\n default:\n logger.log(Level.WARNING, \"Unknown BANKMSGSRSV1 element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the bank message set aggregate\");\n break;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseBankMessageSet\");\n }\n\n /**\n * Parses a CREDITCARDMSGSRSV1 element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseCreditCardMessageSet(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseCreditCardMessageSet\");\n\n final QName parsingElement = reader.getName();\n\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case STATUS:\n parseStatementStatus(reader);\n break;\n case CURDEF:\n bank.currency = reader.getElementText();\n break;\n case LEDGERBAL:\n parseLedgerBalance(reader);\n break;\n case AVAILBAL:\n parseAvailableBalance(reader);\n break;\n case CCACCTFROM:\n parseAccountInfo(bank, parseAccountInfo(reader));\n break;\n case BANKTRANLIST:\n parseBankTransactionList(reader);\n break;\n default:\n logger.log(Level.WARNING, \"Unknown CREDITCARDMSGSRSV1 element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the credit card message set aggregate\");\n break;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseCreditCardMessageSet\");\n }\n\n /**\n * Parses a SECLISTMSGSRSV1 element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseSecuritesMessageSet(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSecuritesMessageSet\");\n\n final QName parsingElement = reader.getName();\n\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n if (SECLIST.equals(reader.getLocalName())) {\n parseSecuritiesList(reader);\n } else {\n logger.log(Level.WARNING, \"Unknown SECLISTMSGSRSV1 element: {0}\", reader.getLocalName());\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the sercurites set\");\n break;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseSecuritesMessageSet\");\n }\n\n private void parseSecuritiesList(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSecuritiesList\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case ASSETCLASS:\n case OPTTYPE:\n case STRIKEPRICE:\n case DTEXPIRE:\n case SHPERCTRCT:\n case YIELD:\n break; // just consume it, not used\n case SECID: // underlying stock for an Option. Not used, so consume it here\n case UNIQUEID:\n case UNIQUEIDTYPE:\n break;\n case SECINFO:\n parseSecurity(reader);\n break;\n case MFINFO: // just consume it\n case OPTINFO:\n case STOCKINFO:\n break;\n default:\n logger.log(Level.WARNING, \"Unknown SECLIST element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the securities list\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseSecuritiesList\");\n }\n\n private void parseSecurity(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSecurity\");\n\n final QName parsingElement = reader.getName();\n\n final ImportSecurity importSecurity = new ImportSecurity();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case FIID:\n case SECID: // consume it:\n break;\n case UNIQUEIDTYPE:\n importSecurity.idType = reader.getElementText().trim();\n break;\n case UNIQUEID:\n importSecurity.setId(reader.getElementText().trim());\n break;\n case SECNAME:\n importSecurity.setSecurityName(reader.getElementText().trim());\n break;\n case TICKER:\n importSecurity.setTicker(reader.getElementText().trim());\n break;\n case UNITPRICE:\n importSecurity.setUnitPrice(parseAmount(reader.getElementText()));\n break;\n case DTASOF:\n importSecurity.setLocalDate(parseDate(reader.getElementText()));\n break;\n case CURRENCY: // consume the currency aggregate for unit price and handle here\n case ORIGCURRENCY:\n break;\n case RATING: // consume, not used\n break;\n case CURSYM:\n importSecurity.setCurrency(reader.getElementText().trim());\n break;\n case CURRATE:\n importSecurity.setCurrencyRate(parseAmount(reader.getElementText()));\n break;\n default:\n logger.log(Level.WARNING, \"Unknown SECINFO element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the security info\");\n break parse;\n }\n default:\n }\n }\n\n bank.addSecurity(importSecurity);\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseSecurity\");\n }\n\n /**\n * Parses a BANKTRANLIST element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseBankTransactionList(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseBankTransactionList\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case DTSTART:\n bank.dateStart = parseDate(reader.getElementText());\n break;\n case DTEND:\n bank.dateEnd = parseDate(reader.getElementText());\n break;\n case STMTTRN:\n parseBankTransaction(reader);\n break;\n default:\n logger.log(Level.WARNING, \"Unknown BANKTRANLIST element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the bank transaction list\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseBankTransactionList\");\n }\n\n private void parseInvestmentTransactionList(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseInvestmentTransactionList\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case DTSTART:\n bank.dateStart = parseDate(reader.getElementText());\n break;\n case DTEND:\n bank.dateEnd = parseDate(reader.getElementText());\n break;\n case BUYSTOCK:\n case BUYMF:\n case BUYOTHER:\n case INCOME:\n case REINVEST:\n case SELLSTOCK:\n parseInvestmentTransaction(reader);\n break;\n case INVBANKTRAN:\n parseBankTransaction(reader);\n break;\n default:\n logger.log(Level.WARNING, \"Unknown INVTRANLIST element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the investment transaction list\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseInvestmentTransactionList\");\n }\n\n private void parseInvestmentTransaction(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseInvestmentTransaction\");\n\n final QName parsingElement = reader.getName();\n\n final ImportTransaction tran = new ImportTransaction();\n\n // set the descriptive transaction type text as well\n tran.setTransactionTypeDescription(parsingElement.toString());\n\n // extract the investment transaction type from the element name\n switch (parsingElement.toString()) {\n case BUYMF:\n case BUYOTHER:\n case BUYSTOCK:\n tran.setTransactionType(TransactionType.BUYSHARE);\n break;\n case SELLMF:\n case SELLOTHER:\n case SELLSTOCK:\n tran.setTransactionType(TransactionType.SELLSHARE);\n break;\n case INCOME: // dividend\n tran.setTransactionType(TransactionType.DIVIDEND);\n break;\n case REINVEST:\n tran.setTransactionType(TransactionType.REINVESTDIV);\n break;\n default:\n logger.log(Level.WARNING, \"Unknown investment transaction type: {0}\", parsingElement.toString());\n break;\n }\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case DTSETTLE:\n tran.setDatePosted(parseDate(reader.getElementText()));\n break;\n case DTTRADE:\n tran.setDateUser(parseDate(reader.getElementText()));\n break;\n case TOTAL: // total of the investment transaction\n tran.setAmount(parseAmount(reader.getElementText()));\n break;\n case FITID:\n tran.setFITID(reader.getElementText());\n break;\n case UNIQUEID: // the security for the transaction\n tran.setSecurityId(reader.getElementText());\n break;\n case UNIQUEIDTYPE: // the type of security for the transaction\n tran.setSecurityType(reader.getElementText());\n break;\n case UNITS:\n tran.setUnits(parseAmount(reader.getElementText()));\n break;\n case UNITPRICE:\n tran.setUnitPrice(parseAmount(reader.getElementText()));\n break;\n case FEES: // investment fees\n tran.setFees(parseAmount(reader.getElementText()));\n break;\n case COMMISSION: // investment commission\n tran.setCommission(parseAmount(reader.getElementText()));\n break;\n case INCOMETYPE:\n tran.setIncomeType(reader.getElementText());\n break;\n case SUBACCTSEC:\n case SUBACCTFROM:\n case SUBACCTTO:\n case SUBACCTFUND:\n tran.setSubAccount(reader.getElementText());\n break;\n case CHECKNUM:\n tran.setCheckNumber(reader.getElementText());\n break;\n case NAME:\n case PAYEE: // either PAYEE or NAME will be used\n tran.setPayee(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case MEMO:\n tran.setMemo(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case CATEGORY: // Chase bank mucking up the OFX standard\n break;\n case SIC:\n tran.setSIC(reader.getElementText());\n break;\n case REFNUM:\n tran.setRefNum(reader.getElementText());\n break;\n case PAYEEID:\n tran.setPayeeId(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case CURRENCY: // currency used for the transaction\n //tran.currency = reader.getElementText();\n consumeElement(reader);\n break;\n case ORIGCURRENCY:\n tran.setCurrency(reader.getElementText());\n break;\n case TAXEXEMPT:\n tran.setTaxExempt(parseBoolean(reader.getElementText()));\n break;\n case BUYTYPE:\n case INVBUY: // consume\n case INVTRAN:\n case SECID:\n break;\n case LOANID: // consume 401k loan information\n case LOANPRINCIPAL:\n case LOANINTEREST:\n break;\n case INV401KSOURCE: // consume 401k information\n case DTPAYROLL:\n case PRIORYEARCONTRIB:\n break;\n default:\n logger.log(Level.WARNING, \"Unknown investment transaction element: {0}\",\n reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n //logger.fine(\"Found the end of the investment transaction\");\n break parse;\n }\n default:\n }\n }\n\n bank.addTransaction(tran);\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseInvestmentTransaction\");\n }\n\n private String removeExtraWhiteSpace(final String string) {\n return extraSpaceRegex.matcher(string).replaceAll(\" \").trim();\n }\n\n /**\n * Parses a STMTTRN element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseBankTransaction(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseBankTransaction\");\n\n final QName parsingElement = reader.getName();\n\n final ImportTransaction tran = new ImportTransaction();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case TRNTYPE:\n tran.setTransactionTypeDescription(reader.getElementText());\n break;\n case DTPOSTED:\n tran.setDatePosted(parseDate(reader.getElementText()));\n break;\n case DTUSER:\n tran.setDateUser(parseDate(reader.getElementText()));\n break;\n case TRNAMT:\n tran.setAmount(parseAmount(reader.getElementText()));\n break;\n case FITID:\n tran.setFITID(reader.getElementText());\n break;\n case CHECKNUM:\n tran.setCheckNumber(reader.getElementText());\n break;\n case NAME:\n case PAYEE: // either PAYEE or NAME will be used\n tran.setPayee(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case MEMO:\n tran.setMemo(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case CATEGORY: // Chase bank mucking up the OFX standard\n break;\n case SIC:\n tran.setSIC(reader.getElementText());\n break;\n case REFNUM:\n tran.setRefNum(reader.getElementText());\n break;\n case PAYEEID:\n tran.setPayeeId(removeExtraWhiteSpace(reader.getElementText()));\n break;\n case CURRENCY:\n case ORIGCURRENCY:\n tran.setCurrency(reader.getElementText());\n break;\n case SUBACCTFUND: // transfer into / out off an investment account\n tran.setSubAccount(reader.getElementText());\n break;\n case STMTTRN: // consume, occurs with an investment account transfer\n break;\n case BANKACCTTO:\n case CCACCTTO:\n case INVACCTTO:\n parseAccountInfo(tran, parseAccountInfo(reader));\n break;\n default:\n logger.log(Level.WARNING, \"Unknown STMTTRN element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the bank transaction\");\n break parse;\n }\n default:\n }\n }\n\n bank.addTransaction(tran);\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseBankTransaction\");\n }\n\n private static void parseAccountInfo(final ImportTransaction importTransaction, final AccountInfo accountInfo) {\n importTransaction.setAccountTo(accountInfo.accountId);\n }\n\n /**\n * Parses a BANKACCTFROM element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private static AccountInfo parseAccountInfo(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseAccountInfo\");\n\n final QName parsingElement = reader.getName();\n\n final AccountInfo accountInfo = new AccountInfo();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case BANKID:\n case BROKERID: // normally a URL per the OFX specification\n accountInfo.bankId = reader.getElementText();\n break;\n case ACCTID:\n accountInfo.accountId = reader.getElementText();\n break;\n case ACCTTYPE:\n accountInfo.accountType = reader.getElementText();\n break;\n case BRANCHID:\n accountInfo.branchId = reader.getElementText();\n break;\n default:\n logger.log(Level.WARNING, \"Unknown BANKACCTFROM element: {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the bank and account info aggregate\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseAccountInfo\");\n\n return accountInfo;\n }\n\n private static void parseAccountInfo(final OfxBank ofxBank, final AccountInfo accountInfo) {\n ofxBank.bankId = accountInfo.bankId;\n ofxBank.branchId = accountInfo.branchId;\n ofxBank.accountId = accountInfo.accountId;\n ofxBank.accountType = accountInfo.accountType;\n }\n\n /**\n * Parses a LEDGERBAL element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseLedgerBalance(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseLedgerBalance\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case BALAMT:\n bank.ledgerBalance = parseAmount(reader.getElementText());\n break;\n case DTASOF:\n bank.ledgerBalanceDate = parseDate(reader.getElementText());\n break;\n default:\n logger.log(Level.WARNING, \"Unknown ledger balance information {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the ledger balance aggregate\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseLedgerBalance\");\n }\n\n /**\n * Parses a AVAILBAL element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseAvailableBalance(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseAvailableBalance\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case BALAMT:\n bank.availBalance = parseAmount(reader.getElementText());\n break;\n case DTASOF:\n bank.availBalanceDate = parseDate(reader.getElementText());\n break;\n default:\n logger.log(Level.WARNING, \"Unknown AVAILBAL element {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the available balance aggregate\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseAvailableBalance\");\n }\n\n /**\n * Parses a SIGNONMSGSRSV1 element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseSignOnMessageSet(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSignOnMessageSet\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case LANGUAGE:\n language = reader.getElementText();\n break;\n case STATUS:\n parseSignOnStatus(reader);\n break;\n case FI:\n case FID:\n case ORG:\n case INTUBID:\n case INTUUSERID:\n default:\n break;\n }\n\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the sign-on message set aggregate\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseSignOnMessageSet\");\n }\n\n /**\n * Parses a STATUS element from the SignOn element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseSignOnStatus(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSignOnStatus\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case CODE:\n try {\n statusCode = Integer.parseInt(reader.getElementText());\n } catch (final NumberFormatException ex) {\n logger.log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n }\n break;\n case SEVERITY:\n statusSeverity = reader.getElementText();\n break;\n case MESSAGE: // consume it, not used\n statusMessage = reader.getElementText();\n break;\n default:\n logger.log(Level.WARNING, \"Unknown STATUS element {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the statusCode response\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseSignOnStatus\");\n }\n\n /**\n * Parses a STATUS element from the statement element\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private void parseStatementStatus(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"parseSignOnStatus\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n switch (reader.getLocalName()) {\n case CODE:\n try {\n bank.statusCode = Integer.parseInt(reader.getElementText());\n } catch (final NumberFormatException ex) {\n logger.log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n }\n break;\n case SEVERITY:\n bank.statusSeverity = reader.getElementText();\n break;\n case MESSAGE:\n bank.statusMessage = reader.getElementText();\n break;\n default:\n logger.log(Level.WARNING, \"Unknown STATUS element {0}\", reader.getLocalName());\n break;\n }\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.fine(\"Found the end of the statement status response\");\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"parseStatementStatus\");\n }\n\n /**\n * Consumes an element that will not be used\n *\n * @param reader shared XMLStreamReader\n * @throws XMLStreamException XML parsing error has occurred\n */\n private static void consumeElement(final XMLStreamReader reader) throws XMLStreamException {\n logger.entering(OfxV2Parser.class.getName(), \"consumeElement\");\n\n final QName parsingElement = reader.getName();\n\n parse:\n while (reader.hasNext()) {\n final int event = reader.next();\n\n switch (event) {\n case XMLStreamConstants.START_ELEMENT:\n reader.getLocalName();\n\n break;\n case XMLStreamConstants.END_ELEMENT:\n if (reader.getName().equals(parsingElement)) {\n logger.log(Level.FINEST, \"Found the end of consumed element {0}\", reader.getName());\n break parse;\n }\n default:\n }\n }\n\n logger.exiting(OfxV2Parser.class.getName(), \"consumeElement\");\n }\n\n public OfxBank getBank() {\n logger.log(Level.INFO, \"OFX Status was: {0}\", statusCode);\n logger.log(Level.INFO, \"Status Level was: {0}\", statusSeverity);\n logger.log(Level.INFO, \"File language was: {0}\", language);\n\n return bank;\n }\n\n int getStatusCode() {\n return statusCode;\n }\n\n String getStatusSeverity() {\n return statusSeverity;\n }\n\n public String getLanguage() {\n return language;\n }\n\n String getStatusMessage() {\n return statusMessage;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/ofx/Sanitize.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.ofx;\n\n/**\n * Utility class for handling OFX files with invalid characters\n *\n * @author Craig Cavanaugh\n */\nclass Sanitize {\n\n private Sanitize() {\n // utility class\n }\n\n\n /**\n * Replaces illegal XML characters with escaped characters\n *\n * @param xml String to process\n * @return valid string\n */\n static String sanitize(final String xml) {\n String ugly = xml;\n\n // remove all XML declarations as they are not needed\n ugly = ugly.replaceAll(\"<\\\\?xml.*\\\\?>\", \"\");\n\n ugly = ugly.replaceAll(\"&(?!(?:amp);)\", \"&\");\n ugly = ugly.replaceAll(\"\\\"\", \""\");\n ugly = ugly.replaceAll(\"'\", \"'\");\n\n return ugly;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifAccount.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.util.List;\nimport java.util.Objects;\n\nimport jgnash.convert.importat.DateFormat;\nimport jgnash.convert.importat.ImportBank;\n\n/**\n * @author Craig Cavanaugh\n */\npublic class QifAccount extends ImportBank {\n\n public String name;\n\n public String type;\n\n public String description = \"\";\n\n private DateFormat dateFormat = null;\n\n @Override\n public List getTransactions() {\n\n if (dateFormat == null) {\n setDateFormat(QifTransaction.determineDateFormat(super.getTransactions()));\n }\n\n reparseDates(getDateFormat()); // reparse the dates before returning\n\n return super.getTransactions();\n }\n\n public QifTransaction get(final int index) {\n return super.getTransactions().get(index);\n }\n\n @Override\n public String toString() {\n return \"Name: \" + name + '\\n' + \"Type: \" + type + '\\n' + \"Description: \" + description + '\\n';\n }\n\n public void reparseDates(final DateFormat dateFormat) {\n Objects.requireNonNull(dateFormat);\n\n setDateFormat(dateFormat);\n\n for (final QifTransaction transaction: super.getTransactions()) {\n transaction.setDatePosted(QifTransaction.parseDate(transaction.oDate, dateFormat));\n }\n }\n\n public DateFormat getDateFormat() {\n if (dateFormat == null) {\n return DateFormat.US;\n }\n\n return dateFormat;\n }\n\n public void setDateFormat(final DateFormat dateFormat) {\n Objects.requireNonNull(dateFormat);\n\n this.dateFormat = dateFormat;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifCategory.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\n/**\n * @author Craig Cavanaugh\n */\nclass QifCategory {\n\n public String name;\n\n public String description;\n\n public String type;\n\n public QifCategory() {\n type = \"E\";\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifImport.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.io.File;\nimport java.io.IOException;\nimport java.util.HashMap;\nimport java.util.Iterator;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.stream.Collectors;\n\nimport jgnash.convert.importat.DateFormat;\nimport jgnash.convert.importat.ImportUtils;\nimport jgnash.engine.Account;\nimport jgnash.engine.AccountType;\nimport jgnash.engine.CurrencyNode;\nimport jgnash.engine.Engine;\nimport jgnash.engine.EngineFactory;\nimport jgnash.engine.ReconcileManager;\nimport jgnash.engine.ReconciledState;\nimport jgnash.engine.Transaction;\nimport jgnash.engine.TransactionEntry;\nimport jgnash.engine.TransactionFactory;\n\n/**\n * QifImport takes a couple of simple steps to prevent importing a duplicate account. Other than that, duplicate\n * transactions will be imported. At this time, it would require a lot of extra and normally unused data to be stored\n * with each transaction and account to prevent duplication. This import utility is ideal for importing an existing data\n * set, but not for importing monthly bank statements. A more specialized import utility may be useful/required for more\n * advanced in\n *\n * @author Craig Cavanaugh\n */\npublic class QifImport {\n\n /**\n * Default for a QIF import\n */\n private static final String FITID = \"qif\";\n\n private QifParser parser;\n\n private final Engine engine;\n\n private final HashMap expenseMap = new HashMap<>();\n\n private final HashMap incomeMap = new HashMap<>();\n\n private final HashMap accountMap = new HashMap<>();\n\n private boolean partialImport = false;\n\n private static final Logger logger = Logger.getLogger(\"qifimport\");\n\n public QifImport() {\n engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n }\n\n public QifParser getParser() {\n return parser;\n }\n\n public void doFullParse(final File file, final DateFormat dateFormat) throws IOException {\n if (file != null) {\n parser = new QifParser(dateFormat);\n parser.parseFullFile(file);\n logger.info(\"*** Parsing Complete ***\");\n }\n }\n\n public void doFullImport() {\n if (parser != null) {\n\n importCategories();\n importAccounts();\n\n logger.info(\"*** Importing Complete ***\");\n }\n }\n\n public boolean doPartialParse(final File file) {\n if (file != null) {\n partialImport = true;\n\n parser = new QifParser(DateFormat.US);\n return parser.parsePartialFile(file);\n }\n\n return false;\n }\n\n public void dumpStats() {\n if (parser != null) {\n parser.dumpStats();\n }\n }\n\n private void importCategories() {\n logger.info(\"*** Importing Categories ***\");\n\n loadCategoryMap(engine.getExpenseAccountList(), expenseMap);\n loadCategoryMap(engine.getIncomeAccountList(), incomeMap);\n reduceCategories();\n addCategories();\n }\n\n private void importAccounts() {\n loadAccountMap();\n addAccounts();\n }\n\n private static void loadCategoryMap(final List list, final Map map) {\n if (list != null) { // protect against a failed load on a new account\n for (Account aList : list) {\n loadCategoryMap(aList, map);\n }\n }\n }\n\n private static void loadCategoryMap(final Account acc, final Map map) {\n String pathName = acc.getPathName();\n int index = pathName.indexOf(':');\n if (index != -1) {\n map.put(pathName.substring(index + 1), acc);\n }\n }\n\n /**\n * Returns a list of all accounts excluding the rootAccount and IncomeAccounts and ExpenseAccounts\n *\n * @return List of bank accounts\n */\n private List getBankAccountList() {\n\n final List list = engine.getAccountList();\n\n return list.stream().filter(a -> a.getAccountType() == AccountType.BANK\n || a.getAccountType() == AccountType.CASH).collect(Collectors.toList());\n }\n\n private void loadAccountMap() {\n List list = getBankAccountList();\n list.forEach(this::loadAccountMap);\n }\n\n private void loadAccountMap(final Account acc) {\n String pathName = acc.getPathName();\n int index = pathName.indexOf(':');\n if (index != -1) {\n accountMap.put(pathName.substring(index + 1), acc);\n }\n }\n\n /**\n * All of the accounts must be added before the transactions are added because the category (account) must exist\n * first\n */\n private void addAccounts() {\n\n logger.info(\"*** Importing Accounts ***\");\n\n List list = parser.accountList;\n // add all of the accounts first\n for (QifAccount qAcc : list) {\n Account acc;\n if (!accountMap.containsKey(qAcc.name)) { // add the account if it does not exist\n acc = generateAccount(qAcc);\n if (acc != null) {\n engine.addAccount(engine.getRootAccount(), acc);\n loadAccountMap(acc);\n }\n }\n }\n\n logger.info(\"*** Importing Transactions ***\");\n\n // go back and add the transactions;\n for (QifAccount qAcc : list) {\n Account acc = accountMap.get(qAcc.name);\n\n // try and match the closest\n if (acc == null) {\n acc = engine.getAccountByName(qAcc.name);\n }\n\n // TODO Correct import of investment transactions\n if (acc != null && acc.getAccountType() != AccountType.INVEST) {\n addTransactions(qAcc, acc);\n } else {\n if (acc != null) {\n logger.severe(\"Investment transactions not fully supported\");\n } else {\n logger.log(Level.SEVERE, \"Lost the account: {0}\", qAcc.name);\n }\n }\n }\n }\n\n private void addTransactions(final QifAccount qAcc, final Account acc) {\n if (qAcc.getTransactions().isEmpty()) {\n return;\n }\n List list = qAcc.getTransactions();\n for (QifTransaction aList : list) {\n Transaction tran;\n\n /*if (acc.getAccountType().equals(AccountType.INVEST)) {\n //tran = generateInvestmentTransaction(aList, acc);\n tran = generateTransaction(aList, acc);\n } else {\n tran = generateTransaction(aList, acc);\n }*/\n\n tran = generateTransaction(aList, acc);\n\n if (tran != null) {\n if (partialImport) {\n tran.setFitid(FITID); // importing a bank statement, flag as imported\n }\n engine.addTransaction(tran);\n } else {\n logger.warning(\"Null Transaction!\");\n }\n }\n }\n\n private void addCategories() {\n List list = parser.categories;\n Map map;\n for (QifCategory cat : list) {\n Account acc = generateAccount(cat);\n if (acc.getAccountType() == AccountType.EXPENSE) {\n map = expenseMap;\n } else {\n map = incomeMap;\n }\n Account parent = findBestParent(cat, map);\n engine.addAccount(parent, acc);\n loadCategoryMap(acc, map);\n }\n }\n\n /**\n * Returns the Account of the best possible parent account for the supplied QifCategory\n *\n * @param cat imported QifCategory to match\n * @param map cached account map\n * @return best Account match\n */\n private Account findBestParent(final QifCategory cat, final Map map) {\n int i = cat.name.lastIndexOf(':');\n if (i != -1) {\n String pathName = cat.name.substring(0, i);\n while (true) {\n if (map.containsKey(pathName)) {\n return map.get(pathName);\n }\n int j = pathName.lastIndexOf(':');\n if (j != -1) {\n pathName = pathName.substring(0, j);\n } else {\n break;\n }\n }\n }\n Account parent;\n\n if (cat.type.equals(\"E\")) {\n parent = ImportUtils.getRootExpenseAccount();\n } else {\n parent = ImportUtils.getRootIncomeAccount();\n }\n\n if (parent != null) {\n return parent;\n }\n\n return engine.getRootAccount();\n }\n\n /**\n * Returns the best matching account\n *\n * @param category QIF category\n * @return Best matching account\n */\n private Account findBestAccount(final String category) {\n Account acc = null;\n\n // nulls can happen and don't search on an empty category\n if (category != null && !category.isEmpty()) {\n String name = category;\n\n if (isAccount(name)) { // account\n name = category.substring(1, category.length() - 1);\n logger.log(Level.FINEST, \"Looking for bank account: {0}\", name);\n acc = accountMap.get(name);\n }\n\n if (acc == null) { // income or expense account\n // strip any category tags\n name = QifUtils.stripCategoryTags(name);\n\n acc = expenseMap.get(name);\n if (acc == null) {\n acc = incomeMap.get(name);\n }\n }\n\n if (acc == null) {\n logger.log(Level.WARNING, \"No account match for: {0}\", name);\n }\n }\n return acc;\n }\n\n /**\n * Determines if the supplied String represents a QIF account\n *\n * @param category category string to validate\n * @return true if this is suppose to be an account\n */\n private static boolean isAccount(final String category) {\n return category.startsWith(\"[\") && category.endsWith(\"]\");\n }\n\n /*\n * Removes duplicate categories from a supplied list\n */\n private void reduceCategories() {\n QifCategory cat;\n String path;\n List list = parser.categories;\n Iterator i = list.iterator();\n while (i.hasNext()) {\n cat = i.next();\n path = cat.name;\n if (cat.type.equals(\"E\") && expenseMap.containsKey(path)) {\n i.remove();\n } else if (cat.type.equals(\"I\") && incomeMap.containsKey(path)) {\n i.remove();\n }\n }\n }\n\n /*\n * Creates and returns an Account of the correct type given a QifCategory\n */\n private Account generateAccount(final QifCategory cat) {\n Account account;\n CurrencyNode defaultCurrency = engine.getDefaultCurrency();\n if (cat.type.equals(\"E\")) {\n account = new Account(AccountType.EXPENSE, defaultCurrency);\n // account.setTaxRelated(cat.taxRelated);\n // account.setTaxSchedule(cat.taxSchedule);\n } else {\n account = new Account(AccountType.INCOME, defaultCurrency);\n // account.setTaxRelated(cat.taxRelated);\n // account.setTaxSchedule(cat.taxSchedule);\n }\n\n // trim off the leading parent account\n int index = cat.name.lastIndexOf(':');\n\n if (index != -1) {\n account.setName(cat.name.substring(index + 1));\n } else {\n account.setName(cat.name);\n }\n\n account.setDescription(cat.description);\n return account;\n }\n\n private Account generateAccount(final QifAccount acc) {\n Account account;\n CurrencyNode defaultCurrency = engine.getDefaultCurrency();\n\n switch (acc.type) {\n case \"Bank\":\n account = new Account(AccountType.BANK, defaultCurrency);\n break;\n case \"CCard\":\n account = new Account(AccountType.CREDIT, defaultCurrency);\n break;\n case \"Cash\":\n account = new Account(AccountType.CASH, defaultCurrency);\n break;\n case \"Invst\":\n case \"Port\":\n account = new Account(AccountType.INVEST, defaultCurrency);\n break;\n case \"Oth A\":\n account = new Account(AccountType.ASSET, defaultCurrency);\n break;\n case \"Oth L\":\n account = new Account(AccountType.LIABILITY, defaultCurrency);\n break;\n default:\n logger.log(Level.SEVERE, \"Could not generate an account for:\\n{0}\", acc.toString());\n return null;\n }\n account.setName(acc.name);\n account.setDescription(acc.description);\n return account;\n }\n\n /**\n * Generates a transaction\n * \n * Notes: If a QifTransaction does not specify an account, then assume it is a single\n * entry transaction for the supplied Account. The transaction most likely came from a online banking source.\n *\n * @param qTran Qif transaction to generate Transaction for\n * @param acc base Account\n * @return new Transaction\n */\n private Transaction generateTransaction(final QifTransaction qTran, final Account acc) {\n Objects.requireNonNull(acc);\n\n boolean reconciled = \"x\".equalsIgnoreCase(qTran.status);\n\n Transaction tran;\n Account cAcc;\n if (qTran.getAccount() != null) {\n cAcc = qTran.getAccount();\n } else {\n cAcc = findBestAccount(qTran.category);\n }\n\n if (qTran.hasSplits()) {\n tran = new Transaction();\n // create a double entry transaction with splits\n List splits = qTran.splits;\n\n for (QifSplitTransaction splitTransaction : splits) {\n TransactionEntry split = generateSplitTransaction(splitTransaction, acc);\n\n Objects.requireNonNull(split); // should not be null, throw an exception\n tran.addTransactionEntry(split);\n }\n\n ReconcileManager.reconcileTransaction(acc, tran, reconciled ? ReconciledState.RECONCILED : ReconciledState.NOT_RECONCILED);\n } else if (acc == cAcc && !qTran.hasSplits() || cAcc == null) {\n // create single entry transaction without splits\n tran = TransactionFactory.generateSingleEntryTransaction(acc, qTran.getAmount(), qTran.getDatePosted(), qTran.getMemo(),\n qTran.getPayee(), qTran.getCheckNumber());\n\n ReconcileManager.reconcileTransaction(acc, tran, reconciled ? ReconciledState.RECONCILED : ReconciledState.NOT_RECONCILED);\n } else if (!qTran.hasSplits()) { // && cAcc != null\n // create a double entry transaction without splits\n if (qTran.getAmount().signum() == -1) {\n tran = TransactionFactory.generateDoubleEntryTransaction(cAcc, acc, qTran.getAmount(), qTran.getDatePosted(),\n qTran.getMemo(), qTran.getPayee(), qTran.getCheckNumber());\n } else {\n tran = TransactionFactory.generateDoubleEntryTransaction(acc, cAcc, qTran.getAmount(), qTran.getDatePosted(),\n qTran.getMemo(), qTran.getPayee(), qTran.getCheckNumber());\n }\n\n ReconcileManager.reconcileTransaction(cAcc, tran, reconciled ? ReconciledState.RECONCILED : ReconciledState.NOT_RECONCILED);\n ReconcileManager.reconcileTransaction(acc, tran, reconciled ? ReconciledState.RECONCILED : ReconciledState.NOT_RECONCILED);\n\n if (isAccount(qTran.category)) {\n removeMirrorTransaction(qTran, acc); // remove the mirror transaction\n }\n } else {\n // could not find the account this transaction belongs to\n logger.log(Level.WARNING, \"Could not create following transaction:\" + \"\\n{0}\", qTran.toString());\n return null;\n }\n tran.setDate(qTran.getDatePosted());\n tran.setPayee(qTran.getPayee());\n tran.setNumber(qTran.getCheckNumber());\n\n return tran;\n }\n\n private Account unassignedExpense = null;\n\n private Account unassignedIncome = null;\n\n /**\n * Generates a Transaction given a QifSplitTransaction\n *\n * @param qTran split qif transaction to convert\n * @param acc base Account\n * @return generated TransactionEntry\n */\n private TransactionEntry generateSplitTransaction(final QifSplitTransaction qTran, final Account acc) {\n TransactionEntry tran = new TransactionEntry();\n\n Account account = findBestAccount(qTran.category);\n\n /* Verify that the splits category is not assigned to the parent account. This is\n * allowed within Quicken, but violates double entry and is not allowed in jGnash.\n * Wipe the resulting account and default to the unassigned accounts to maintain\n * integrity.\n */\n if (account == acc) {\n logger.warning(\"Detected an invalid split transactions entry, correcting problem\");\n account = null;\n }\n\n /* If a valid account is found at this point, then it should have a duplicate\n * entry in another account that needs to be removed\n */\n if (account != null && isAccount(qTran.category)) {\n removeMirrorSplitTransaction(qTran);\n }\n\n if (account == null) { // unassigned split transaction.... fix it with a default\n if (qTran.amount.signum() == -1) { // need an expense account\n if (unassignedExpense == null) {\n unassignedExpense = new Account(AccountType.EXPENSE, engine.getDefaultCurrency());\n unassignedExpense.setName(\"** QIF Import - Unassigned Expense Account\");\n unassignedExpense.setDescription(\"Fix transactions and delete this account\");\n engine.addAccount(engine.getRootAccount(), unassignedExpense);\n logger.info(\"Created an account for unassigned expense account\");\n }\n account = unassignedExpense;\n } else {\n if (unassignedIncome == null) {\n unassignedIncome = new Account(AccountType.INCOME, engine.getDefaultCurrency());\n unassignedIncome.setName(\"** QIF Import - Unassigned Income Account\");\n unassignedIncome.setDescription(\"Fix transactions and delete this account\");\n engine.addAccount(engine.getRootAccount(), unassignedIncome);\n logger.info(\"Created an account for unassigned income account\");\n }\n account = unassignedIncome;\n }\n }\n\n if (qTran.amount.signum() == -1) {\n tran.setDebitAccount(acc);\n tran.setCreditAccount(account);\n } else {\n tran.setDebitAccount(account);\n tran.setCreditAccount(acc);\n }\n tran.setAmount(qTran.amount.abs());\n tran.setMemo(qTran.memo);\n\n return tran;\n }\n\n /* Cannot check against check number and payee because Quicken allows for the\n * different payees at each side of the transaction and does not include the\n * check number on both sides.\n *\n * The date, amount, and account/category is checked to determine if the match is valid\n */\n private void removeMirrorTransaction(final QifTransaction qTran, final Account acc) {\n String name = qTran.category.substring(1, qTran.category.length() - 1);\n List list = parser.accountList;\n\n for (QifAccount qAcc : list) {\n if (qAcc.name.equals(name)) {\n List items = qAcc.getTransactions();\n Iterator i = items.iterator();\n QifTransaction tran;\n while (i.hasNext()) {\n tran = i.next();\n if (tran.getAmount().compareTo(qTran.getAmount().negate()) == 0 && tran.getDatePosted().equals(qTran.getDatePosted()) && tran.category.contains(acc.getName())) {\n i.remove();\n logger.finest(\"Removed mirror transaction\");\n\n return;\n }\n }\n }\n }\n }\n\n private void removeMirrorSplitTransaction(final QifSplitTransaction qTran) {\n String name = qTran.category.substring(1, qTran.category.length() - 1);\n logger.log(Level.FINE, \"Category name is: {0}\", name);\n List list = parser.accountList;\n\n for (QifAccount qAcc : list) {\n if (qAcc.name.equals(name)) {\n List items = qAcc.getTransactions();\n Iterator i = items.iterator();\n QifTransaction tran;\n while (i.hasNext()) {\n tran = i.next();\n if (tran != null) {\n if (tran.getAmount().compareTo(qTran.amount.negate()) == 0 && tran.getMemo().equals(qTran.memo)) {\n i.remove();\n logger.finest(\"Removed mirror split transaction\");\n return;\n }\n } else { // should not occur anymore\n logger.log(Level.SEVERE, \"There was a null QifTransaction in QifAccount: \\n{0}\", qAcc.toString());\n }\n }\n }\n }\n\n // could be a split into a bank account... look a level higher\n // TODO add check against the base account... should point at each other..\n // qTran's category same as tran category?\n for (QifAccount qAcc : list) {\n if (qAcc.name.equals(name)) {\n List items = qAcc.getTransactions();\n Iterator i = items.iterator();\n QifTransaction tran;\n while (i.hasNext()) {\n tran = i.next();\n // is the match an account and the opposite value and does not have any splits?\n // is this a valid method? \n if (tran.getAmount().compareTo(qTran.amount.negate()) == 0 && isAccount(tran.category) && !tran.hasSplits()) {\n logger.log(Level.FINE, \"Found a match:\\n{0}\", tran.toString());\n i.remove();\n return;\n }\n }\n }\n }\n\n logger.log(Level.WARNING, \"Did not find matching mirror:\" + \"\\n{0}\", qTran.toString());\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifParser.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.io.File;\nimport java.io.FileNotFoundException;\nimport java.io.IOException;\nimport java.nio.charset.Charset;\nimport java.nio.file.Files;\nimport java.nio.file.Paths;\nimport java.util.ArrayList;\nimport java.util.Objects;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\nimport jgnash.convert.importat.DateFormat;\nimport jgnash.util.FileMagic;\nimport jgnash.util.NotNull;\n\n/**\n * The QIF format seems to be very broken. Various applications and services\n * export it differently, some have even extended an already broken format to\n * add even more confusion. To make matters worse, the format has changed over\n * time with no indication of what \"version\" the QIF file is.\n * \n * This parses through the QIF file using brute force, no fancy parser or\n * tricks. The QIF file is broken enough that it's easier to find problems with\n * the parser when it's easy to step through the code.\n *
\n * The !Option:AutoSwitch and !Clear:AutoSwitch headers do not appear to be used\n * correctly, even by the \"creator\" of the QIF file format. There seems to be\n * confusion as to it's purpose. The best thing to do is ignore AutoSwitch\n * completely and make an educated guess about the data.\n *
\n * I'm not very happy with this code, but I'm not sure there is a clean solution\n * to parsing QIF files\n *\n * @author Craig Cavanaugh\n */\npublic final class QifParser {\n\n private DateFormat dateFormat = DateFormat.US;\n\n final ArrayList categories = new ArrayList<>();\n\n private final ArrayList classes = new ArrayList<>();\n\n public final ArrayList accountList = new ArrayList<>();\n\n private final ArrayList securities = new ArrayList<>();\n\n private static final Logger logger = Logger.getLogger(QifParser.class.getName());\n\n QifParser(final DateFormat dateFormat) {\n setDateFormat(dateFormat);\n }\n\n public QifAccount getBank() {\n return accountList.get(0);\n }\n\n /**\n * Tests if the source string starts with the prefix string. Case is\n * ignored.\n *\n * @param source the source String.\n * @param prefix the prefix String.\n * @return true, if the source starts with the prefix string.\n */\n private static boolean startsWith(final String source, final String prefix) {\n return prefix.length() <= source.length() && source.regionMatches(true, 0, prefix, 0, prefix.length());\n }\n\n private void setDateFormat(@NotNull final DateFormat dateFormat) {\n Objects.requireNonNull(dateFormat);\n this.dateFormat = dateFormat;\n }\n\n void parseFullFile(final File file) throws IOException {\n parseFullFile(file.getAbsolutePath());\n }\n\n boolean parsePartialFile(final File file) {\n return parsePartialFile(file.getAbsolutePath());\n }\n\n private void parseFullFile(final String fileName) throws IOException {\n\n boolean accountFound = true;\n\n final Charset charset = FileMagic.detectCharset(fileName);\n\n try (final QifReader in = new QifReader(Files.newBufferedReader(Paths.get(fileName), charset))) {\n\n String line = in.readLine();\n\n while (line != null) {\n if (startsWith(line, \"!Type:Class\")) {\n parseClassList(in);\n } else if (startsWith(line, \"!Type:Cat\")) {\n parseCategoryList(in);\n } else if (startsWith(line, \"!Account\")) {\n parseAccount(in);\n } else if (startsWith(line, \"!Type:Memorized\")) {\n parseMemorizedTransactions(in);\n } else if (startsWith(line, \"!Type:Security\")) {\n parseSecurity(in);\n } else if (startsWith(line, \"!Type:Prices\")) {\n parsePrice(in);\n } else if (startsWith(line, \"!Type:Bank\")) { // QIF from an online bank statement... assumes the account is known \n accountFound = false;\n break;\n } else if (startsWith(line, \"!Type:CCard\")) { // QIF from an online credit card statement\n accountFound = false;\n break;\n } else if (startsWith(line, \"!Type:Oth\")) { // QIF from an online credit card statement\n accountFound = false;\n break;\n } else if (startsWith(line, \"!Type:Cash\")) { // Partial QIF export\n accountFound = false;\n break;\n } else if (startsWith(line, \"!Option:AutoSwitch\")) {\n logger.info(\"Consuming !Option:AutoSwitch\");\n } else if (startsWith(line, \"!Clear:AutoSwitch\")) {\n logger.info(\"Consuming !Clear:AutoSwitch\");\n } else {\n System.out.println(\"Error: \" + line);\n }\n line = in.readLine();\n }\n } catch (final FileNotFoundException e) {\n logger.log(Level.WARNING, \"Could not find file: {0}\", fileName);\n } catch (final IOException e) {\n logger.log(Level.SEVERE, null, e);\n }\n\n if (!accountFound) {\n throw new IOException(\"The account was not found\");\n }\n\n // re-parse the dates\n for (final QifAccount account : accountList) {\n account.reparseDates(QifTransaction.determineDateFormat(account.getTransactions()));\n }\n }\n\n private boolean parsePartialFile(final String fileName) {\n\n final Charset charset = FileMagic.detectCharset(fileName);\n\n try (QifReader in = new QifReader(Files.newBufferedReader(Paths.get(fileName), charset))) {\n String peek = in.peekLine();\n if (startsWith(peek, \"!Type:\")) {\n final QifAccount acc = new QifAccount(); // \"unknown\" holding account\n if (parseAccountTransactions(in, acc)) {\n accountList.add(acc);\n\n logger.finest(\"*** Added account ***\");\n\n // re-parse the dates\n acc.reparseDates(QifTransaction.determineDateFormat(acc.getTransactions()));\n\n return true; // only look for transactions for one account\n }\n System.err.println(\"parseAccountTransactions: error\");\n }\n\n } catch (final FileNotFoundException fne) {\n logger.log(Level.WARNING, \"Could not find file: {0}\", fileName);\n } catch (final IOException ioe) {\n logger.log(Level.SEVERE, null, ioe);\n }\n return false;\n }\n\n private void parseAccount(final QifReader in) throws IOException {\n logger.entering(this.getClass().getName(), \"parseAccount\", in);\n\n String line;\n QifAccount acc = new QifAccount();\n\n boolean result = false;\n\n line = in.readLine();\n while (line != null) {\n if (line.startsWith(\"N\")) {\n acc.name = line.substring(1);\n } else if (line.startsWith(\"T\")) {\n acc.type = line.substring(1);\n } else if (line.startsWith(\"D\")) {\n acc.description = line.substring(1);\n } else if (line.startsWith(\"L\")) {\n logger.finest(\"Ignoring credit limit\");\n } else if (line.startsWith(\"/\")) {\n logger.finest(\"statement balance date\");\n } else if (line.startsWith(\"$\")) {\n logger.finest(\"Ignoring statement balance\");\n } else if (line.startsWith(\"X\")) {\n // must be GnuCashToQIF... not sure what it is??? ignore it.\n logger.warning(\"Ignoring 'X' attribute\");\n } else if (line.startsWith(\"^\")) {\n String peek = in.peekLine();\n if (peek == null) { // end of the file in empty account list\n accountList.add(acc);\n result = true;\n break;\n }\n if (startsWith(peek, \"!Account\")) {\n // must be in an account list, no transaction data here\n accountList.add(acc);\n acc = new QifAccount();\n in.readLine(); // eat the line since we only peeked at it\n } else if (startsWith(peek, \"!Type:Memor\")) {\n accountList.add(acc);\n result = true;\n break;\n } else if (startsWith(peek, \"!Type:Invst\")) { // investment transactions follow\n logger.fine(\"Found investment transactions\");\n /* Search for a duplicate account generated by the account list and\n * use it if possible. Qif out will output a list of empty accounts\n * and then follow up with the same account and it's transactions\n */\n QifAccount dup = searchForDuplicate(acc);\n if (dup != null) {\n acc = dup; // trade for the duplicate already existing in the list\n }\n\n if (parseInvestmentAccountTransactions(in, acc)) {\n if (dup == null) {\n accountList.add(acc); // only add if not a duplicate\n }\n logger.finest(\"Added Qif Account\");\n result = true;\n break; // exit here, the outer loop will catch the next account if it exists\n }\n acc = new QifAccount();\n } else if (startsWith(peek, \"!Type:Prices\")) { // security prices, jump out\n logger.fine(\"Found commodity price; jump out\");\n result = true;\n break;\n } else if (startsWith(peek, \"!Type:\")) {\n // must be transactions that follow\n logger.fine(\"Found bank transactions\");\n\n /* Search for a duplicate account generated by the account list and\n * use it if possible. Qif out will output a list of empty accounts\n * and then follow up with the same account and it's transactions\n */\n QifAccount dup = searchForDuplicate(acc);\n if (dup != null) {\n acc = dup; // trade for the duplicate already existing in the list\n }\n\n if (parseAccountTransactions(in, acc)) {\n if (dup == null) {\n accountList.add(acc); // only add if not a duplicate\n }\n logger.finest(\"Added Qif Account\");\n result = true;\n break; // exit here, the outer loop will catch the next account if it exists\n }\n acc = new QifAccount();\n } else if (startsWith(peek, \"!Clear:Auto\")) {\n in.readLine(); // the broken AutoSwitch.... eat the line\n accountList.add(acc);\n result = true;\n break;\n } else if (startsWith(peek, \"!\")) {\n // something weird, assume in empty account list\n accountList.add(acc);\n result = true;\n break;\n } else {\n // must be in an account list using AutoSwitch\n accountList.add(acc);\n acc = new QifAccount();\n }\n } else {\n break;\n }\n\n line = in.readLine();\n }\n\n logger.exiting(this.getClass().getName(), \"parseAccount\", result);\n }\n\n private QifAccount searchForDuplicate(final QifAccount acc) {\n String name = acc.name;\n String type = acc.type;\n String description = acc.description; // assume non-null description\n\n Objects.requireNonNull(description);\n\n if (name == null || type == null) {\n logger.log(Level.SEVERE, \"Invalid account: \\n{0}\", acc.toString());\n return null;\n }\n\n /* Investment account types are not consistent in Quicken export.... buggy software.\n * A Type of \"Invst\" is used as a generic when listing the transactions in the\n * investment account.\n * TODO \"Port\" is only one type.... need to discover other types\n */\n if (type.equals(\"Invst\") || type.equals(\"Port\")) {\n for (QifAccount a : accountList) {\n if (a.name.equals(name) && a.description.equals(description)) {\n logger.fine(\"Matched a duplicate account\");\n return a;\n }\n }\n } else {\n for (QifAccount a : accountList) {\n if (a.name.equals(name) && a.type.equals(type) && a.description.equals(description)) {\n logger.fine(\"Matched a duplicate account\");\n return a;\n }\n }\n }\n return null;\n }\n\n // TODO strip out investment account transaction checks\n private static boolean parseAccountTransactions(final QifReader in, final QifAccount acc) {\n\n String line;\n QifTransaction tran = new QifTransaction();\n try {\n line = in.readLine();\n while (line != null) {\n if (startsWith(line, \"!Type:\")) {\n if (startsWith(line, \"!Type:Invst\")) {\n tran.setTransactionTypeDescription(line.substring(1));\n tran.setTransactionTypeDescription(line.substring(1));\n } else if (startsWith(line, \"!Type:Memor\")) {\n in.reset();\n return true;\n } else {\n tran.setTransactionTypeDescription(line.substring(1));\n }\n } else if (line.startsWith(\"D\")) {\n /* Preserve the original unparsed date so that it may be\n * reevaluated at a later time. */\n tran.oDate = line.substring(1);\n //tran.datePosted = QifTransaction.parseDate(tran.oDate, dateFormat);\n } else if (line.startsWith(\"U\")) {\n logger.finest(\"Ignoring U\");\n } else if (line.startsWith(\"T\")) {\n tran.setAmount(QifUtils.parseMoney(line.substring(1)));\n } else if (line.startsWith(\"C\")) {\n tran.status = line.substring(1);\n } else if (line.startsWith(\"P\")) {\n tran.setPayee(line.substring(1));\n } else if (line.startsWith(\"L\")) {\n tran.category = line.substring(1);\n } else if (line.startsWith(\"N\")) {\n tran.setCheckNumber(line.substring(1));\n } else if (line.startsWith(\"M\")) {\n tran.setMemo(line.substring(1));\n } else if (line.startsWith(\"A\")) {\n logger.log(Level.INFO, \"Ignored address line: {0}\", line.substring(1));\n } else if (line.startsWith(\"I\")) {\n tran.price = line.substring(1);\n } else if (line.startsWith(\"^\")) {\n acc.addTransaction(tran);\n logger.finest(\"*** Added a Transaction ***\");\n tran = new QifTransaction();\n } else if (startsWith(line, \"!Account\")) {\n in.reset();\n return true;\n } else if (startsWith(line, \"!Type:Prices\")) { // fund prices... jump out\n in.reset();\n return true;\n } else if (line.charAt(0) == 'S' || line.charAt(0) == 'E' || line.charAt(0) == '$'\n || line.charAt(0) == '%') {\n // doing a split transaction\n in.reset();\n QifSplitTransaction split = parseSplitTransaction(in);\n if (split != null) {\n tran.addSplit(split);\n logger.finest(\"*** Added a Split Transaction ***\");\n }\n } else {\n logger.log(Level.SEVERE, \"Unknown field: {0}\", line);\n }\n in.mark();\n line = in.readLine();\n }\n } catch (IOException e) {\n return false;\n }\n return true;\n }\n\n private boolean parseInvestmentAccountTransactions(final QifReader in, final QifAccount acc) {\n\n boolean result = true;\n\n logger.entering(this.getClass().getName(), \"parseInvestmentAccountTransactions\", acc);\n String line;\n QifTransaction tran = new QifTransaction();\n try {\n line = in.readLine();\n while (line != null) {\n if (startsWith(line, \"!Type:Invst\")) { // TODO Bogus check?\n tran.setTransactionTypeDescription(line.substring(1));\n } else if (startsWith(line, \"!Type:Memor\")) {\n in.reset();\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Prices\")) { // fund prices... jump out\n logger.fine(\"Found commodity prices; jumping out\");\n in.reset();\n result = true;\n break;\n } else if (line.startsWith(\"D\")) {\n /* Preserve the original unparsed date so that it may be\n * reevaluated at a later time. */\n tran.oDate = line.substring(1);\n tran.setDatePosted(QifTransaction.parseDate(tran.oDate, dateFormat));\n } else if (line.startsWith(\"U\")) {\n //tran.U = line.substring(1);\n logger.finest(\"Ignoring U\");\n } else if (line.startsWith(\"T\")) {\n tran.setAmount(QifUtils.parseMoney(line.substring(1)));\n } else if (line.startsWith(\"C\")) {\n tran.status = line.substring(1);\n } else if (line.startsWith(\"P\")) {\n tran.setPayee(line.substring(1));\n } else if (line.startsWith(\"L\")) {\n tran.category = line.substring(1);\n } else if (line.startsWith(\"N\")) { // trans type for inv accounts\n tran.setCheckNumber(line.substring(1));\n } else if (line.startsWith(\"M\")) {\n tran.setMemo(line.substring(1));\n } else if (line.startsWith(\"A\")) {\n logger.log(Level.INFO, \"Ignored address line: {0}\", line.substring(1));\n } else if (line.startsWith(\"Y\")) {\n tran.security = line.substring(1);\n } else if (line.startsWith(\"I\")) {\n tran.price = line.substring(1);\n } else if (line.startsWith(\"Q\")) {\n tran.quantity = line.substring(1);\n } else if (line.charAt(0) == '$') { // must check before split trans checks... Does Quicken allow for split investment transactions?\n tran.amountTrans = line.substring(1);\n } else if (line.startsWith(\"^\")) {\n acc.addTransaction(tran);\n logger.finest(\"*** Added an investment transaction ***\");\n tran = new QifTransaction();\n } else if (startsWith(line, \"!Account\")) {\n in.reset();\n result = true;\n break;\n } else if (line.charAt(0) == 'S' || line.charAt(0) == 'E' || line.charAt(0) == '$'\n || line.charAt(0) == '%') {\n // doing a split transaction\n in.reset();\n QifSplitTransaction split = parseSplitTransaction(in);\n if (split != null) {\n tran.addSplit(split);\n logger.fine(\"*** Added a Split Transaction ***\");\n }\n } else {\n logger.log(Level.SEVERE, \"Unknown field: {0}\", line);\n }\n in.mark();\n line = in.readLine();\n }\n } catch (IOException e) {\n result = false;\n }\n\n logger.exiting(this.getClass().getName(), \"parseInvestmentAccountTransactions\", result);\n return result;\n }\n\n private static QifSplitTransaction parseSplitTransaction(final QifReader in) {\n boolean category = false;\n boolean memo = false;\n boolean amount = false;\n boolean percentage = false;\n String line;\n QifSplitTransaction split = new QifSplitTransaction();\n try {\n line = in.readLine();\n while (line != null) {\n if (line.startsWith(\"S\")) {\n if (category) {\n in.reset();\n return split;\n }\n category = true;\n split.category = line.substring(1);\n } else if (line.startsWith(\"E\")) {\n if (memo) {\n in.reset();\n return split;\n }\n memo = true;\n split.memo = line.substring(1);\n } else if (line.startsWith(\"$\")) {\n if (amount) {\n in.reset();\n return split;\n }\n amount = true;\n split.amount = QifUtils.parseMoney(line.substring(1));\n } else if (line.startsWith(\"%\")) {\n if (percentage) {\n in.reset();\n return split;\n }\n percentage = true;\n // split.percentage = line.substring(1);\n } else if (line.startsWith(\"^\")) {\n in.reset();\n return split;\n } else {\n in.reset();\n return null;\n }\n in.mark();\n line = in.readLine();\n }\n return null;\n } catch (IOException e) {\n return null;\n }\n }\n\n /**\n * Just eats the memorized transaction data. Will not try to convert to jGnash entities\n *\n * @param in {@code QifReader}\n */\n private static void parseMemorizedTransactions(final QifReader in) throws IOException {\n logger.finest(\"*** Start: parseMemorizedTransactions ***\");\n\n String line = in.readLine();\n\n while (line != null) {\n if (line.startsWith(\"K\")) {\n // munch until all of them are gone\n line = in.readLine();\n if (line != null && line.charAt(0) == '^') {\n String peek = in.peekLine();\n if (peek == null) {\n return;\n } else if (!peek.startsWith(\"K\")) {\n break;\n }\n }\n\n } else {\n in.reset();\n return;\n }\n in.mark();\n line = in.readLine();\n }\n }\n\n private void parseCategoryList(final QifReader in) throws IOException {\n boolean result = false;\n\n QifCategory cat = new QifCategory();\n\n String line = in.readLine();\n\n while (line != null) {\n if (line.startsWith(\"N\")) {\n cat.name = line.substring(1);\n } else if (line.startsWith(\"D\")) {\n cat.description = line.substring(1);\n } else if (line.startsWith(\"T\")) {\n logger.finest(\"Ignoring tax related flag\");\n } else if (line.startsWith(\"I\")) {\n cat.type = \"I\";\n } else if (line.startsWith(\"E\")) {\n cat.type = \"E\";\n } else if (line.startsWith(\"B\")) {\n logger.finest(\"Ignoring budget amount\");\n } else if (line.startsWith(\"R\")) {\n logger.finest(\"Ignoring tax schedule\");\n } else if (line.startsWith(\"^\")) { // a complete category item\n categories.add(cat); // add it to the list\n cat = new QifCategory(); // start a new one\n in.mark(); // next line might be end of list\n } else if (line.startsWith(\"!\")) { // done with category list\n in.reset(); // give the line back\n result = true; // a good return\n break;\n } else {\n System.out.println(\"Error: \" + line);\n result = false;\n }\n line = in.readLine();\n }\n\n logger.exiting(this.getClass().getName(), \"parseCategoryList\", result);\n }\n\n private void parseClassList(final QifReader in) throws IOException {\n\n QifClassItem classItem = new QifClassItem();\n\n String line = in.readLine();\n\n while (line != null) {\n if (line.startsWith(\"N\")) {\n classItem.name = line.substring(1);\n } else if (line.startsWith(\"D\")) {\n classItem.description = line.substring(1);\n } else if (line.startsWith(\"^\")) { // end of a class item\n classes.add(classItem); // add it to the list\n classItem = new QifClassItem(); // start a new one\n in.mark(); // next line might be end of the list\n } else if (line.startsWith(\"!\")) { // done with the class list\n in.reset(); // give the line back\n return;\n } else {\n throw new IOException(\"Error: \" + line);\n }\n line = in.readLine();\n }\n\n }\n\n /**\n * So far, I haven't see a security as part of a list, but it is supported\n * just in case there is another \"variation\" of the format\n *\n * @param in {@code QifReader}\n */\n private void parseSecurity(final QifReader in) throws IOException {\n boolean result = false;\n\n QifSecurity sec = new QifSecurity();\n\n String line = in.readLine();\n\n while (line != null) {\n if (line.startsWith(\"N\")) {\n sec.name = line.substring(1);\n } else if (line.startsWith(\"D\")) {\n sec.description = line.substring(1);\n } else if (line.startsWith(\"T\")) {\n sec.type = line.substring(1);\n } else if (line.startsWith(\"S\")) {\n sec.symbol = line.substring(1);\n } else if (line.startsWith(\"^\")) {\n securities.add(sec);\n sec = new QifSecurity();\n in.mark();\n } else if (line.startsWith(\"!\")) { // end of securities\n in.reset();\n result = true;\n break;\n } else {\n System.out.println(\"Error: \" + line);\n break;\n }\n line = in.readLine();\n }\n\n logger.exiting(this.getClass().getName(), \"parseSecurity\", result);\n }\n\n /**\n * Price data in QIF file is not very informative.... ignore it for now\n *\n * @param in {@code QifReader}\n */\n private void parsePrice(final QifReader in) throws IOException {\n logger.entering(this.getClass().getName(), \"parsePrice\");\n\n boolean result = false;\n\n String line = in.readLine();\n\n while (line != null) {\n if (line.startsWith(\"^\")) {\n result = true;\n break;\n }\n line = in.readLine();\n }\n\n logger.exiting(this.getClass().getName(), \"parsePrice\", result);\n }\n\n void dumpStats() {\n System.out.println(\"Num Classes :\" + classes.size());\n System.out.println(\"Num Categories :\" + categories.size());\n System.out.println(\"Num Securities :\" + securities.size());\n System.out.println(\"Num Accounts :\" + accountList.size());\n\n int count = accountList.size();\n for (int i = 0; i < count; i++) {\n QifAccount acc = accountList.get(i);\n System.out.println(\"Account \" + (i + 1) + \" \" + acc.name);\n int size = acc.getTransactions().size();\n System.out.println(\" Num Transactions :\" + size);\n for (int j = 0; j < size; j++) {\n QifTransaction tran = acc.getTransactions().get(j);\n System.out.println(\" Transaction \" + (j + 1) + \" \" + tran.getPayee());\n System.out.println(\" Num Splits :\" + tran.splits.size());\n for (int k = 0; k < tran.splits.size(); k++) {\n System.out.println(\" Split \" + (k + 1) + \" \" + tran.splits.get(k).memo);\n }\n }\n }\n }\n\n static class QifSecurity {\n\n String name;\n\n String description;\n\n String symbol;\n\n String type;\n\n }\n\n static class QifClassItem {\n\n String name;\n\n String description;\n\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifReader.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.io.IOException;\nimport java.io.LineNumberReader;\nimport java.io.Reader;\n\n/**\n * An extended LineNumberReader to help ease the pain of parsing\n * a QIF file\n *\n * @author Craig Cavanaugh\n */\nclass QifReader extends LineNumberReader {\n\n private static final boolean debug = false;\n\n QifReader(Reader in) {\n super(in, 8192);\n }\n\n void mark() throws IOException {\n super.mark(256);\n }\n\n @Override\n public void reset() throws IOException {\n super.reset();\n if (debug) {\n System.out.println(\"Reset\");\n }\n }\n\n /**\n * Takes a peek at the next line and eats and empty line if found\n *\n * @return next readable line, null if at the end of the file\n * @throws IOException IO exception\n */\n String peekLine() throws IOException {\n String peek;\n while (true) {\n mark();\n peek = readLine();\n if (peek != null) {\n peek = peek.trim();\n reset();\n if (peek.isEmpty()) {\n readLine(); // eat the empty line\n if (debug) {\n System.out.println(\"*EMPTY LINE*\");\n }\n } else {\n return peek.trim();\n }\n } else {\n return null;\n }\n }\n }\n\n @Override\n public String readLine() throws IOException {\n while (true) {\n try {\n String line = super.readLine().trim();\n if (debug) {\n System.out.println(\"Line \" + getLineNumber() + \": \" + line);\n }\n if (!line.isEmpty()) {\n return line;\n }\n if (debug) {\n System.out.println(\"*EMPTY LINE*\");\n }\n } catch (NullPointerException e) {\n return null;\n }\n }\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifSplitTransaction.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.math.BigDecimal;\n\n/**\n * Class for QIF split transaction import\n * \n * @author Craig Cavanaugh\n */\nclass QifSplitTransaction {\n\n public String category;\n\n public String memo = \"\";\n\n public BigDecimal amount;\n\n //public String percentage;\n\n public QifSplitTransaction() {\n amount = BigDecimal.ZERO;\n }\n\n @Override\n public String toString() {\n StringBuilder buf = new StringBuilder();\n buf.append(\"Memo: \").append(memo).append('\\n');\n buf.append(\"Category: \").append(category).append('\\n');\n if (amount != null) {\n buf.append(\"Amount:\").append(amount).append('\\n');\n }\n return buf.toString();\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifTransaction.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.Objects;\nimport java.util.logging.Logger;\nimport java.util.regex.Pattern;\n\nimport jgnash.convert.importat.DateFormat;\nimport jgnash.convert.importat.ImportTransaction;\n\n/**\n * Transaction object for a QIF transaction\n *\n * @author Craig Cavanaugh\n */\npublic class QifTransaction extends ImportTransaction {\n\n private static final Pattern DATE_DELIMITER_PATTERN = Pattern.compile(\"[/'.-]\");\n\n /**\n * Original date before conversion\n */\n String oDate;\n\n String status = null;\n\n public String category = null;\n\n String security;\n String price;\n String quantity;\n String amountTrans;\n\n public final ArrayList splits = new ArrayList<>();\n\n void addSplit(QifSplitTransaction split) {\n splits.add(split);\n }\n\n boolean hasSplits() {\n return !splits.isEmpty();\n }\n\n @Override\n public String toString() {\n StringBuilder buf = new StringBuilder();\n buf.append(\"Payee: \").append(getPayee()).append('\\n');\n buf.append(\"Memo: \").append(getMemo()).append('\\n');\n buf.append(\"Category: \").append(category).append('\\n');\n if (getAmount() != null) {\n buf.append(\"Amount:\").append(getAmount()).append('\\n');\n }\n\n buf.append(\"Date: \").append(getDatePosted()).append('\\n');\n return buf.toString();\n }\n\n static DateFormat determineDateFormat(final Collection transactions) {\n Objects.requireNonNull(transactions);\n\n DateFormat dateFormat = DateFormat.US; // US date is assumed\n\n for (final QifTransaction transaction : transactions) {\n\n // protect against a transaction missing a date Github issue #30\n if (transaction.oDate != null) {\n int zero;\n int one;\n //int two;\n\n final String[] chunks = QifTransaction.DATE_DELIMITER_PATTERN.split(transaction.oDate);\n\n zero = Integer.parseInt(chunks[0].trim());\n one = Integer.parseInt(chunks[1].trim());\n //two = Integer.parseInt(chunks[2].trim());\n\n if (zero > 12 && one <= 12) { // must have a EU date format\n dateFormat = DateFormat.EU;\n break;\n }\n }\n }\n\n return dateFormat;\n }\n\n /**\n * Converts a string into a data object\n * \n * {@code\n * \"6/21' 1\" -> 6/21/2001\n * \"6/21'01\" -> 6/21/2001\n * \"9/18'2001 -> 9/18/2001\n * \"06/21/2001\" -> \"06/21/01\"\n * \"3.26.03\" -> German version of quicken format \"03-26-2003\"\n * MSMoney format \"1.1.2005\"\n * kmymoney2 20.1.94\n * European dd/mm/yyyy\n * 21/2/07 -> 02/21/2007 UK\n * Quicken 2007 D15/2/07\n * }``\n *\n * @param sDate String QIF date to parse\n * @param format String identifier of format to parse\n * @return Returns parsed date and current date if an error occurs\n */\n static LocalDate parseDate(final String sDate, final DateFormat format) throws java.time.DateTimeException {\n\n int month = 0;\n int day = 0;\n int year = 0;\n\n final String[] chunks = DATE_DELIMITER_PATTERN.split(sDate);\n\n try {\n switch (format) {\n case US:\n month = Integer.parseInt(chunks[0].trim());\n day = Integer.parseInt(chunks[1].trim());\n year = Integer.parseInt(chunks[2].trim());\n break;\n case EU:\n day = Integer.parseInt(chunks[0].trim());\n month = Integer.parseInt(chunks[1].trim());\n year = Integer.parseInt(chunks[2].trim());\n break;\n }\n } catch (final NumberFormatException e) {\n Logger.getLogger(QifUtils.class.getName()).severe(e.toString());\n }\n\n if (year < 100) {\n if (year < 29) {\n year += 2000;\n } else {\n year += 1900;\n }\n }\n\n try {\n return LocalDate.of(year, month, day);\n } catch (Exception e) {\n Logger.getLogger(QifUtils.class.getName()).severe(\"Invalid date format specified\");\n return LocalDate.now();\n }\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/java/jgnash/convert/importat/qif/QifUtils.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.convert.importat.qif;\n\nimport java.io.File;\nimport java.io.FileNotFoundException;\nimport java.io.IOException;\nimport java.math.BigDecimal;\nimport java.nio.charset.Charset;\nimport java.nio.file.Files;\nimport java.text.NumberFormat;\nimport java.text.ParseException;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.regex.Pattern;\n\nimport jgnash.engine.MathConstants;\nimport jgnash.util.FileMagic;\n\n/**\n * Various helper methods for importing QIF files\n *\n * @author Craig Cavanaugh\n * @author Navneet Karnani\n */\npublic class QifUtils {\n\n private static final Pattern MONEY_PREFIX_PATTERN = Pattern.compile(\"\\\\D\");\n\n private static final Pattern CATEGORY_DELIMITER_PATTERN = Pattern.compile(\"/\");\n\n private QifUtils() {\n }\n\n static BigDecimal parseMoney(final String money) {\n String sMoney = money;\n\n if (sMoney != null) {\n sMoney = sMoney.trim(); // to be safe\n try {\n return new BigDecimal(sMoney);\n } catch (NumberFormatException e) {\n /* there must be commas, etc in the number. Need to look for them\n * and remove them first, and then try BigDecimal again. If that\n * fails, then give up and use NumberFormat and scale it down\n * */\n\n String[] split = MONEY_PREFIX_PATTERN.split(sMoney);\n if (split.length > 2) {\n StringBuilder buf = new StringBuilder();\n if (sMoney.startsWith(\"-\")) {\n buf.append('-');\n }\n for (int i = 0; i < split.length - 1; i++) {\n buf.append(split[i]);\n }\n buf.append('.');\n buf.append(split[split.length - 1]);\n try {\n return new BigDecimal(buf.toString());\n } catch (final NumberFormatException e2) {\n Logger l = Logger.getLogger(QifUtils.class.getName());\n l.info(\"second parse attempt failed\");\n l.info(buf.toString());\n l.info(\"falling back to rounding\");\n }\n }\n NumberFormat formatter = NumberFormat.getNumberInstance();\n try {\n Number num = formatter.parse(sMoney);\n BigDecimal bd = BigDecimal.valueOf(num.floatValue());\n if (bd.scale() > 6) {\n Logger l = Logger.getLogger(QifUtils.class.getName());\n l.warning(\"-Warning-\");\n l.warning(\"Large scale detected in QifUtils.parseMoney\");\n l.warning(\"Truncating scale to 2 places\");\n l.warning(bd.toString());\n bd = bd.setScale(2, MathConstants.roundingMode);\n l.warning(bd.toString());\n }\n return bd;\n } catch (ParseException ignored) {\n Logger.getLogger(QifUtils.class.getName())\n .log(Level.SEVERE, \"poorly formatted number: {0}\", sMoney);\n }\n }\n }\n return BigDecimal.ZERO;\n }\n\n public static boolean isFullFile(final File file) {\n\n boolean result = false;\n\n final Charset charset = FileMagic.detectCharset(file.getPath());\n\n try (final QifReader in = new QifReader(Files.newBufferedReader(file.toPath(), charset))) {\n String line = in.readLine();\n\n while (line != null) {\n if (startsWith(line, \"!Type:Class\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Cat\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Account\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Memorized\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Security\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Prices\")) {\n result = true;\n break;\n } else if (startsWith(line, \"!Type:Bank\")) { // QIF from an online bank statement... assumes the account is known\n break;\n } else if (startsWith(line, \"!Type:CCard\")) { // QIF from an online credit card statement\n break;\n } else if (startsWith(line, \"!Type:Oth\")) { // QIF from an online credit card statement\n break;\n } else if (startsWith(line, \"!Type:Cash\")) { // Partial QIF export\n break;\n } else if (startsWith(line, \"!Option:AutoSwitch\")) {\n Logger.getLogger(QifUtils.class.getName()).fine(\"!Option:AutoSwitch\");\n } else if (startsWith(line, \"!Clear:AutoSwitch\")) {\n Logger.getLogger(QifUtils.class.getName()).fine(\"!Clear:AutoSwitch\");\n } else {\n System.out.println(\"Error: \" + line);\n break;\n }\n line = in.readLine();\n }\n in.close();\n return result;\n } catch (FileNotFoundException e) {\n Logger.getLogger(QifUtils.class.getName()).log(Level.SEVERE, \"Could not find file: {0}\",\n file.getAbsolutePath());\n\n return false;\n } catch (IOException e) {\n Logger.getLogger(QifUtils.class.getName()).log(Level.SEVERE, null, e);\n return false;\n }\n }\n\n /**\n * Tests if the source string starts with the prefix string. Case is\n * ignored.\n *\n * @param source the source String.\n * @param prefix the prefix String.\n * @return true, if the source starts with the prefix string.\n */\n private static boolean startsWith(final String source, final String prefix) {\n return prefix.length() <= source.length() && source.regionMatches(true, 0, prefix, 0, prefix.length());\n }\n\n /**\n * Strip any category tags from the category name... found when parsing\n * transactions\n *\n * @param category string to strip\n * @return the stripped string\n */\n static String stripCategoryTags(final String category) {\n // Auto:Gas/matrix:Vacation > Auto:Gas\n\n if (category != null && category.contains(\"/\")) {\n return CATEGORY_DELIMITER_PATTERN.split(category)[0];\n }\n\n return category;\n }\n}\n"
},
{
"path": "jgnash-convert/src/main/resources/jgnash/convert/scripts/tidy.js",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\n\n/*\nThis scripts normalizes the case of the payee and memo fields\n*/\n\nvar importTransaction; // place holder for the passed ImportTransaction\n\n/* This will be called first and passed the ImportTransaction */\nfunction acceptTransaction(transaction) {\n importTransaction = transaction; // do nothing with it in this script\n}\n\nfunction processMemo(memo) {\n return capitalizeFirstLetter(memo.toLocaleLowerCase());\n}\n\nfunction processPayee(payee) {\n return titleCase(payee.toLocaleLowerCase());\n}\n\nfunction getDescription(locale) {\n\n var Locale = Packages.java.util.Locale;\n\n switch (locale) {\n case Locale.ENGLISH:\n return \"Tidy Memo and Payee fields\";\n default:\n return \"Tidy Memo and Payee fields\";\n }\n}\n\nfunction capitalizeFirstLetter(str) {\n return str.charAt(0).toUpperCase() + str.slice(1);\n}\n\nfunction titleCase(str) {\n return str.replace(/(^|\\s)[a-z]/g,function(f){return f.toUpperCase();});\n}"
},
{
"path": "jgnash-core/build.gradle.kts",
"content": "description = \"jGnash Core\"\n\nvar moduleName = \"jgnash.core\"\n\nval commonsCollectionsVersion: String by project\nval commonsCsvVersion: String by project\nval commonsLangVersion: String by project\nval commonsMathVersion: String by project\n\nval slf4jVersion: String by project\nval hibernateVersion: String by project\nval hikariVersion: String by project\nval h2Version: String by project\nval hsqldbVersion: String by project\nval xstreamVersion: String by project\nval nettyVersion: String by project\n\nplugins {\n `java-library`\n}\n\ndependencies {\n implementation(project(\":jgnash-resources\"))\n\n // required for HikariCP, override with modular version\n implementation(\"org.slf4j:slf4j-api:$slf4jVersion\")\n implementation(\"org.slf4j:slf4j-jdk14:$slf4jVersion\")\n\n api(\"org.hibernate:hibernate-entitymanager:$hibernateVersion\")\n implementation(\"org.hibernate:hibernate-hikaricp:$hibernateVersion\")\n implementation(\"com.zaxxer:HikariCP:$hikariVersion\")\n\n implementation(\"com.h2database:h2:$h2Version\")\n implementation(\"org.hsqldb:hsqldb:$hsqldbVersion\")\n\n implementation(\"com.thoughtworks.xstream:xstream:$xstreamVersion\") {\n exclude(module = \"xmlpull\")\n exclude(module = \"xpp3_min\")\n }\n\n implementation(\"com.thoughtworks.xstream:xstream-hibernate:$xstreamVersion\") {\n exclude(module = \"xmlpull\")\n exclude(module = \"xpp3_min\")\n }\n\n implementation(\"io.netty:netty-codec:$nettyVersion\")\n\n implementation(\"org.apache.commons:commons-collections4:$commonsCollectionsVersion\")\n implementation(\"org.apache.commons:commons-csv:$commonsCsvVersion\")\n implementation(\"org.apache.commons:commons-lang3:$commonsLangVersion\")\n implementation(\"org.apache.commons:commons-math3:$commonsMathVersion\")\n}\n\ntasks.jar {\n manifest.attributes[\"Automatic-Module-Name\"] = moduleName\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AbstractInvestmentTransactionEntry.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\n\nimport javax.persistence.Column;\nimport javax.persistence.Entity;\nimport javax.persistence.ManyToOne;\n\nimport jgnash.util.NotNull;\n\n/**\n * Investment Transaction Entry.\n *\n * @author Craig Cavanaugh\n */\n@Entity\npublic abstract class AbstractInvestmentTransactionEntry extends TransactionEntry {\n\n /**\n * Security for this entry.\n */\n @ManyToOne\n private SecurityNode securityNode;\n\n /**\n * share price.\n */\n @Column(precision = 26, scale = 8)\n private BigDecimal price;\n\n /**\n * number of shares.\n */\n @Column(precision = 26, scale = 8)\n private BigDecimal quantity;\n\n /**\n * Creates a new instance of InvestmentTransactionEntry.\n */\n protected AbstractInvestmentTransactionEntry() {\n setTransactionTag(TransactionTag.INVESTMENT);\n }\n\n /**\n * Calculates the total of the value of the shares, gains, fees, etc. as it\n * pertains to an account.\n *
\n * Not intended for use to calculate account balances\n *\n * @return total resulting total for this entry\n * @see InvestmentTransaction#getTotal(jgnash.engine.Account)\n */\n public BigDecimal getTotal() {\n return getQuantity().multiply(getPrice());\n }\n\n public SecurityNode getSecurityNode() {\n return securityNode;\n }\n\n void setSecurityNode(final SecurityNode securityNode) {\n this.securityNode = securityNode;\n }\n\n public BigDecimal getPrice() {\n return price;\n }\n\n void setPrice(final BigDecimal price) {\n this.price = price;\n }\n\n /**\n * Assigns the number of shares for this transaction. The value should be\n * always be a positive value.\n *\n * @param quantity the quantity of securities to assign to this account\n * @see #getSignedQuantity()\n */\n void setQuantity(final BigDecimal quantity) {\n this.quantity = quantity;\n }\n\n /**\n * Returns the number of shares assigned to this transaction.\n *\n * @return the quantity of securities for this transaction\n * @see #getSignedQuantity()\n */\n public BigDecimal getQuantity() {\n return quantity;\n }\n\n /**\n * Returns the number of shares as it would impact the sum of the investment\n * accounts shares. Useful for summing share quantities\n *\n * @return the quantity of securities for this transaction\n */\n public abstract BigDecimal getSignedQuantity();\n\n /**\n * Returns the type of this transaction entry.\n *\n * @return the transaction type\n */\n @NotNull public abstract TransactionType getTransactionType();\n\n @Override\n public String toString() {\n\n return super.toString() + \"Security: \" + getSecurityNode().getSymbol()\n + System.lineSeparator() + \"Quantity: \" + getQuantity().toPlainString()\n + System.lineSeparator() + \"Price: \" + getPrice().toPlainString()\n + System.lineSeparator();\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/Account.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received account copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.Comparator;\nimport java.util.HashMap;\nimport java.util.HashSet;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.Set;\nimport java.util.TreeSet;\nimport java.util.concurrent.locks.Lock;\nimport java.util.concurrent.locks.ReadWriteLock;\nimport java.util.concurrent.locks.ReentrantReadWriteLock;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.regex.Pattern;\nimport java.util.stream.Collectors;\n\nimport javax.persistence.CascadeType;\nimport javax.persistence.Column;\nimport javax.persistence.ElementCollection;\nimport javax.persistence.Entity;\nimport javax.persistence.EnumType;\nimport javax.persistence.Enumerated;\nimport javax.persistence.FetchType;\nimport javax.persistence.JoinColumn;\nimport javax.persistence.JoinTable;\nimport javax.persistence.ManyToMany;\nimport javax.persistence.ManyToOne;\nimport javax.persistence.OneToMany;\nimport javax.persistence.OneToOne;\nimport javax.persistence.OrderBy;\nimport javax.persistence.PostLoad;\nimport javax.persistence.Transient;\n\nimport jgnash.time.DateUtils;\nimport jgnash.util.NotNull;\nimport jgnash.util.Nullable;\n\n/**\n * Account object. The {@code Account} object is mutable. Changes should be made using the {@code Engine} to\n * ensure correct state and persistence.\n *\n * @author Craig Cavanaugh\n * @author Jeff Prickett prickett@users.sourceforge.net\n */\n@Entity\npublic class Account extends StoredObject implements Comparable {\n\n static final int MAX_ATTRIBUTE_LENGTH = 8192;\n\n /**\n * Attribute key for the last attempted reconciliation date.\n */\n public static final String RECONCILE_LAST_ATTEMPT_DATE = \"Reconcile.LastAttemptDate\";\n\n /**\n * Attribute key for the last successful reconciliation date.\n */\n public static final String RECONCILE_LAST_SUCCESS_DATE = \"Reconcile.LastSuccessDate\";\n\n /**\n * Attribute key for the last reconciliation statement date.\n */\n public static final String RECONCILE_LAST_STATEMENT_DATE = \"Reconcile.LastStatementDate\";\n\n /**\n * Attribute key for the last reconciliation opening balance.\n */\n public static final String RECONCILE_LAST_OPENING_BALANCE = \"Reconcile.LastOpeningBalance\";\n\n /**\n * Attribute key for the last reconciliation closing balance.\n */\n public static final String RECONCILE_LAST_CLOSING_BALANCE = \"Reconcile.LastClosingBalance\";\n\n private static final Pattern numberPattern = Pattern.compile(\"\\\\d+\");\n\n private static final Logger logger = Logger.getLogger(Account.class.getName());\n\n /**\n * String delimiter for reported account structure.\n */\n private static String accountSeparator = \":\";\n\n @ManyToOne\n Account parentAccount;\n\n /**\n * List of transactions for this account.\n */\n @JoinTable\n @OrderBy(\"date, number, timestamp\")\n @ManyToMany(cascade = {CascadeType.ALL}, fetch = FetchType.EAGER)\n final Set transactions = new HashSet<>();\n\n /**\n * List of securities if this is an investment account.\n */\n @JoinColumn()\n @OrderBy(\"symbol\")\n @ManyToMany(cascade = {CascadeType.REFRESH, CascadeType.PERSIST, CascadeType.MERGE}, fetch = FetchType.EAGER)\n private final Set securities = new HashSet<>();\n\n @Enumerated(EnumType.STRING)\n private AccountType accountType;\n\n private boolean placeHolder = false;\n\n private boolean locked = false;\n\n private boolean visible = true;\n\n private boolean excludedFromBudget = false;\n\n private String name = \"\";\n\n private String description = \"\";\n\n @Column(columnDefinition = \"VARCHAR(8192)\")\n private String notes = \"\";\n\n /**\n * CurrencyNode for this account.\n */\n @ManyToOne\n private CurrencyNode currencyNode;\n\n /**\n * Sorted list of child accounts.\n */\n @OrderBy(\"name\")\n @OneToMany(cascade = {CascadeType.ALL}, fetch = FetchType.EAGER)\n private final Set children = new HashSet<>();\n\n /**\n * Cached list of sorted transactions that is not persisted. This prevents concurrency issues when using a JPA backend\n */\n @Transient\n private transient List cachedSortedTransactionList;\n\n\n /**\n * Cached list of sorted accounts this is not persisted. This prevents concurrency issues when using a JPA backend\n */\n @Transient\n private transient List cachedSortedChildren;\n\n /**\n * Balance of the account.\n *\n * Cached balances cannot be persisted to do nature of JPA\n */\n @Transient\n private transient BigDecimal accountBalance;\n\n /**\n * Reconciled balance of the account.\n *\n * Cached balances cannot be persisted to do nature of JPA\n */\n @Transient\n private transient BigDecimal reconciledBalance;\n\n /**\n * User definable account number.\n */\n private String accountNumber = \"\";\n\n /**\n * User definable bank id. Useful for OFX import\n */\n private String bankId;\n\n /**\n * User definable account code. This will control sort order\n */\n @Column(nullable = false, columnDefinition = \"int default 0\")\n private int accountCode;\n\n @OneToOne(orphanRemoval = true, cascade = {CascadeType.ALL})\n private AmortizeObject amortizeObject;\n\n /**\n * User definable attributes.\n */\n @ElementCollection\n @Column(columnDefinition = \"varchar(8192)\")\n private final Map attributes = new HashMap<>(); // maps from attribute name to value\n\n private transient ReadWriteLock transactionLock;\n\n private transient ReadWriteLock childLock;\n\n private transient ReadWriteLock securitiesLock;\n\n private transient ReadWriteLock attributesLock;\n\n private transient AccountProxy proxy;\n\n /**\n * No argument public constructor for reflection purposes.\n *\n * Do not use to create account new instance\n */\n public Account() {\n transactionLock = new ReentrantReadWriteLock(true);\n childLock = new ReentrantReadWriteLock(true);\n securitiesLock = new ReentrantReadWriteLock(true);\n attributesLock = new ReentrantReadWriteLock(true);\n\n // CopyOnWrite is used as an alternative to defensive copies\n cachedSortedChildren = new ArrayList<>();\n }\n\n public Account(@NotNull final AccountType type, @NotNull final CurrencyNode node) {\n this();\n\n Objects.requireNonNull(type);\n Objects.requireNonNull(node);\n\n setAccountType(type);\n setCurrencyNode(node);\n }\n\n private static String getAccountSeparator() {\n return accountSeparator;\n }\n\n static void setAccountSeparator(final String separator) {\n accountSeparator = separator;\n }\n\n ReadWriteLock getTransactionLock() {\n return transactionLock;\n }\n\n private AccountProxy getProxy() {\n if (proxy == null) {\n proxy = getAccountType().getProxy(this);\n }\n return proxy;\n }\n\n /**\n * Clear cached account balances so they will be recalculated.\n */\n void clearCachedBalances() {\n accountBalance = null;\n reconciledBalance = null;\n }\n\n /**\n * Adds account transaction in chronological order.\n *\n * @param tran the {@code Transaction} to be added\n * @return true the transaction was added successful false the transaction was already attached\n * to this account\n */\n boolean addTransaction(final Transaction tran) {\n if (placeHolder) {\n logger.severe(\"Tried to add transaction to a place holder account\");\n return false;\n }\n\n transactionLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (!contains(tran)) {\n\n transactions.add(tran);\n\n /* The cached list may already contain the transaction if it has not been initialized yet */\n if (!getCachedSortedTransactionList().contains(tran)) {\n getCachedSortedTransactionList().add(tran);\n Collections.sort(getCachedSortedTransactionList());\n }\n\n clearCachedBalances();\n\n result = true;\n } else {\n logger.log(Level.SEVERE, \"Account: {0}({1}){2}Already have transaction ID: {3}\", new Object[]{getName(),\n hashCode(), System.lineSeparator(), tran.hashCode()});\n }\n\n return result;\n } finally {\n transactionLock.writeLock().unlock();\n }\n }\n\n /**\n * Removes the specified transaction from this account.\n *\n * @param tran the {@code Transaction} to be removed\n * @return {@code true} the transaction removal was successful {@code false} the transaction could not be found\n * within this account\n */\n boolean removeTransaction(final Transaction tran) {\n transactionLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (contains(tran)) {\n transactions.remove(tran);\n getCachedSortedTransactionList().remove(tran);\n clearCachedBalances();\n\n result = true;\n } else {\n Logger.getLogger(Account.class.toString()).log(Level.SEVERE, \"Account: {0}({1}){2}Did not contain transaction ID: {3}\", new Object[]{getName(), getUuid(), System.lineSeparator(), tran.getUuid()});\n }\n\n return result;\n } finally {\n transactionLock.writeLock().unlock();\n }\n }\n\n /**\n * Determines if the specified transaction is attach to this account.\n *\n * @param tran the {@code Transaction} to look for\n * @return {@code true} the transaction is attached to this account {@code false} the transaction is not attached\n * to this account\n */\n public boolean contains(final Transaction tran) {\n transactionLock.readLock().lock();\n\n try {\n return transactions.contains(tran);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Determine if the supplied account is a child of this account.\n *\n * @param account to check\n * @return true if the supplied account is a child of this account\n */\n public boolean contains(final Account account) {\n childLock.readLock().lock();\n\n try {\n return cachedSortedChildren.contains(account);\n } finally {\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns a sorted list of transactions for this account that is unmodifiable.\n *\n * @return List of transactions\n */\n @NotNull\n public List getSortedTransactionList() {\n transactionLock.readLock().lock();\n\n try {\n return Collections.unmodifiableList(getCachedSortedTransactionList());\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the transaction at the specified index.\n *\n * @param index the index of the transaction to return.\n * @return the transaction at the specified index.\n * @throws IndexOutOfBoundsException if the index is out of bounds\n */\n @NotNull\n public Transaction getTransactionAt(final int index) {\n transactionLock.readLock().lock();\n\n try {\n return getCachedSortedTransactionList().get(index);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the number of transactions attached to this account.\n *\n * @return the number of transactions attached to this account.\n */\n public int getTransactionCount() {\n transactionLock.readLock().lock();\n\n try {\n return transactions.size();\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Searches through the transactions and determines the next largest\n * transaction number.\n *\n * @return The next check number; and empty String if numbers are not found\n */\n @NotNull\n public String getNextTransactionNumber() {\n transactionLock.readLock().lock();\n\n try {\n int number = 0;\n\n for (final Transaction tran : transactions) {\n if (numberPattern.matcher(tran.getNumber()).matches()) {\n try {\n number = Math.max(number, Integer.parseInt(tran.getNumber()));\n } catch (NumberFormatException e) {\n logger.log(Level.INFO, \"Number regex failed\", e);\n }\n }\n }\n\n if (number == 0) {\n return \"\";\n }\n\n return Integer.toString(number + 1);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Add account child account given it's reference.\n *\n * @param child The child account to add to this account.\n * @return {@code true} if the account was added successfully, {@code false} otherwise.\n */\n boolean addChild(final Account child) {\n childLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (!children.contains(child) && child != this) {\n if (child.setParent(this)) {\n children.add(child);\n result = true;\n\n cachedSortedChildren.add(child);\n Collections.sort(cachedSortedChildren);\n }\n }\n\n return result;\n } finally {\n childLock.writeLock().unlock();\n }\n }\n\n /**\n * Removes account child account. The reference to the parent(this) is left so that the parent can be discovered.\n *\n * @param child The child account to remove.\n * @return {@code true} if the specific account was account child of this account, {@code false} otherwise.\n */\n boolean removeChild(final Account child) {\n childLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (children.remove(child)) {\n result = true;\n\n cachedSortedChildren.remove(child);\n }\n return result;\n } finally {\n childLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns a sorted list of the children. A protective copy is returned to protect against concurrency issues.\n *\n * @return List of children\n */\n public List getChildren() {\n childLock.readLock().lock();\n\n try {\n return new ArrayList<>(cachedSortedChildren);\n } finally {\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns a sorted list of the children. A protective copy is returned to protect against concurrency issues.\n *\n * @param comparator {@code Comparator} to use\n * @return List of children\n */\n public List getChildren(final Comparator comparator) {\n List accountChildren = getChildren();\n accountChildren.sort(comparator);\n\n return accountChildren;\n }\n\n /**\n * Returns the index of the specified {@code Transaction} within this {@code Account}.\n *\n * @param tran the {@code Transaction} to look for\n * @return The index of the {@code Transaction}, -1 if this\n * {@code Account} does not contain the {@code Transaction}.\n */\n public int indexOf(final Transaction tran) {\n transactionLock.readLock().lock();\n\n try {\n return getCachedSortedTransactionList().indexOf(tran);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the number of children this account has.\n *\n * @return the number of children this account has.\n */\n public int getChildCount() {\n childLock.readLock().lock();\n\n try {\n return cachedSortedChildren.size();\n } finally {\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the parent account.\n *\n * @return the parent of this account, null is this account is not account child\n */\n public Account getParent() {\n childLock.readLock().lock();\n\n try {\n return parentAccount;\n } finally {\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Sets the parent of this {@code Account}.\n *\n * @param account The new parent {@code Account}\n * @return {@code true} is successful\n */\n public boolean setParent(final Account account) {\n childLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (account != this) {\n parentAccount = account;\n result = true;\n }\n\n return result;\n } finally {\n childLock.writeLock().unlock();\n }\n }\n\n /**\n * Determines is this {@code Account} has any child{@code Account}.\n *\n * @return {@code true} is this {@code Account} has children, {@code false} otherwise.\n */\n public boolean isParent() {\n childLock.readLock().lock();\n\n try {\n return !cachedSortedChildren.isEmpty();\n } finally {\n childLock.readLock().unlock();\n }\n }\n\n /**\n * The account balance is cached to improve performance and reduce thrashing\n * of the GC system. The accountBalance is reset when transactions are added\n * and removed and lazily recalculated.\n *\n * @return the balance of this account\n */\n public BigDecimal getBalance() {\n transactionLock.readLock().lock();\n\n try {\n if (accountBalance != null) {\n return accountBalance;\n }\n return accountBalance = getProxy().getBalance();\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * The account balance is cached to improve performance and reduce thrashing\n * of the GC system. The accountBalance is rest when transactions are added\n * and removed and lazily recalculated.\n *\n * @param node CurrencyNode to get balance against\n * @return the balance of this account\n */\n private BigDecimal getBalance(final CurrencyNode node) {\n transactionLock.readLock().lock();\n\n try {\n return adjustForExchangeRate(getBalance(), node);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Get the account balance up to the specified index using the natural\n * transaction sort order.\n *\n * @param index the balance of this account at the specified index.\n * @return the balance of this account at the specified index.\n */\n private BigDecimal getBalanceAt(final int index) {\n transactionLock.readLock().lock();\n\n try {\n return getProxy().getBalanceAt(index);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Get the account balance up to the specified transaction using the natural\n * transaction sort order.\n *\n * @param transaction reference transaction for running balance. Must be contained within the account\n * @return the balance of this account at the specified transaction\n */\n public BigDecimal getBalanceAt(final Transaction transaction) {\n transactionLock.readLock().lock();\n\n try {\n final int index = indexOf(transaction);\n\n if (index >= 0) {\n return getBalanceAt(index);\n }\n\n return BigDecimal.ZERO;\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * The reconciled balance is cached to improve performance and reduce\n * thrashing of the GC system. The reconciledBalance is reset when\n * transactions are added and removed and lazily recalculated.\n *\n * @return the reconciled balance of this account\n */\n public BigDecimal getReconciledBalance() {\n transactionLock.readLock().lock();\n\n try {\n if (reconciledBalance != null) {\n return reconciledBalance;\n }\n\n return reconciledBalance = getProxy().getReconciledBalance();\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n private BigDecimal getReconciledBalance(final CurrencyNode node) {\n return adjustForExchangeRate(getReconciledBalance(), node);\n }\n\n private BigDecimal adjustForExchangeRate(final BigDecimal amount, final CurrencyNode node) {\n if (node.equals(getCurrencyNode())) { // child has the same commodity type\n return amount;\n }\n\n // the account has a different currency, use the last known exchange rate\n return amount.multiply(getCurrencyNode().getExchangeRate(node));\n }\n\n /**\n * Returns the date of the first unreconciled transaction.\n *\n * @return Date of first unreconciled transaction\n */\n public LocalDate getFirstUnreconciledTransactionDate() {\n transactionLock.readLock().lock();\n\n try {\n LocalDate date = null;\n\n for (final Transaction transaction : getSortedTransactionList()) {\n if (transaction.getReconciled(this) != ReconciledState.RECONCILED) {\n date = transaction.getLocalDate();\n break;\n }\n }\n\n if (date == null) {\n date = getCachedSortedTransactionList().get(getTransactionCount() - 1).getLocalDate();\n }\n\n return date;\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Get the default opening balance for reconciling the account.\n *\n * @return Opening balance for reconciling the account\n * @see AccountProxy#getOpeningBalanceForReconcile()\n */\n public BigDecimal getOpeningBalanceForReconcile() {\n return getProxy().getOpeningBalanceForReconcile();\n }\n\n /**\n * Returns the balance of the account plus any child accounts.\n *\n * @return the balance of this account including the balance of any child\n * accounts.\n */\n public BigDecimal getTreeBalance() {\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal balance = getBalance();\n\n for (final Account child : cachedSortedChildren) {\n balance = balance.add(child.getTreeBalance(getCurrencyNode()));\n }\n\n return balance;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the balance of the account plus any child accounts.\n *\n * @param endDate The inclusive end date\n * @param node The commodity to convert balance to\n *\n * @return the balance of this account including the balance of any child\n * accounts.\n */\n public BigDecimal getTreeBalance(final LocalDate endDate, final CurrencyNode node) {\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal balance = getBalance(endDate, node);\n\n for (final Account child : cachedSortedChildren) {\n balance = balance.add(child.getTreeBalance(endDate, node));\n }\n\n return balance;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the balance of the account plus any child accounts. The balance\n * is adjusted to the current exchange rate of the supplied commodity if\n * needed.\n *\n * @param node The commodity to convert balance to\n * @return the balance of this account including the balance of any child\n * accounts.\n */\n private BigDecimal getTreeBalance(final CurrencyNode node) {\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal balance = getBalance(node);\n\n for (final Account child : cachedSortedChildren) {\n balance = balance.add(child.getTreeBalance(node));\n }\n return balance;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the reconciled balance of the account plus any child accounts.\n * The balance is adjusted to the current exchange rate of the supplied\n * commodity if needed.\n *\n * @param node The commodity to convert balance to\n * @return the balance of this account including the balance of any child\n * accounts.\n */\n private BigDecimal getReconciledTreeBalance(final CurrencyNode node) {\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal balance = getReconciledBalance(node);\n\n for (final Account child : cachedSortedChildren) {\n balance = balance.add(child.getReconciledTreeBalance(node));\n }\n return balance;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the reconciled balance of the account plus any child accounts.\n *\n * @return the balance of this account including the balance of any child\n * accounts.\n */\n public BigDecimal getReconciledTreeBalance() {\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal balance = getReconciledBalance();\n\n for (final Account child : cachedSortedChildren) {\n balance = balance.add(child.getReconciledTreeBalance(getCurrencyNode()));\n }\n return balance;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the balance of the transactions inclusive of the start and end\n * dates.\n *\n * @param start The inclusive start date\n * @param end The inclusive end date\n * @return The ending balance\n */\n public BigDecimal getBalance(final LocalDate start, final LocalDate end) {\n Objects.requireNonNull(start);\n Objects.requireNonNull(end);\n\n transactionLock.readLock().lock();\n\n try {\n return getProxy().getBalance(start, end);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the account balance up to and inclusive of the supplied date. The\n * returned balance is converted to the specified commodity.\n *\n * @param startDate start date\n * @param endDate end date\n * @param node The commodity to convert balance to\n * @return the account balance\n */\n public BigDecimal getBalance(final LocalDate startDate, final LocalDate endDate, final CurrencyNode node) {\n transactionLock.readLock().lock();\n\n try {\n return adjustForExchangeRate(getBalance(startDate, endDate), node);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the full inclusive ancestry of this\n * {@code Account}.\n *\n * @return {@code List} of accounts\n */\n public List getAncestors() {\n List list = new ArrayList<>();\n list.add(this);\n\n Account parent = getParent();\n\n while (parent != null) {\n list.add(parent);\n parent = parent.getParent();\n }\n\n return list;\n }\n\n /**\n * Returns the the balance of the account plus any child accounts inclusive\n * of the start and end dates.\n *\n * @param start start date\n * @param end end date\n * @param node CurrencyNode to use for balance\n * @return account balance\n */\n public BigDecimal getTreeBalance(final LocalDate start, final LocalDate end, final CurrencyNode node) {\n Objects.requireNonNull(start);\n Objects.requireNonNull(end);\n\n transactionLock.readLock().lock();\n childLock.readLock().lock();\n\n try {\n BigDecimal returnValue = getBalance(start, end, node);\n\n for (final Account child : cachedSortedChildren) {\n returnValue = returnValue.add(child.getTreeBalance(start, end, node));\n }\n return returnValue;\n } finally {\n transactionLock.readLock().unlock();\n childLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the account balance up to and inclusive of the supplied localDate.\n *\n * @param localDate The inclusive ending localDate\n * @return The ending balance\n */\n public BigDecimal getBalance(final LocalDate localDate) {\n transactionLock.readLock().lock();\n\n try {\n return getProxy().getBalance(localDate);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the account balance up to and inclusive of the supplied date. The\n * returned balance is converted to the specified commodity.\n *\n * @param node The commodity to convert balance to\n * @param date The inclusive ending date\n * @return The ending balance\n */\n public BigDecimal getBalance(final LocalDate date, final CurrencyNode node) {\n transactionLock.readLock().lock();\n\n try {\n return adjustForExchangeRate(getBalance(date), node);\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns a {@code List} of {@code Transaction} that occur during the specified period.\n * The specified dates are inclusive.\n *\n * @param startDate starting date\n * @param endDate ending date\n * @return a {@code List} of transactions that occurred within the specified dates\n */\n public List getTransactions(final LocalDate startDate, final LocalDate endDate) {\n transactionLock.readLock().lock();\n\n try {\n return transactions.parallelStream().filter(transaction\n -> DateUtils.after(transaction.getLocalDate(), startDate)\n && DateUtils.before(transaction.getLocalDate(), endDate)).sorted().collect(Collectors.toList());\n } finally {\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the commodity node for this account\n *\n * Note: method may not be final for Hibernate.\n *\n * @return the commodity node for this account.\n */\n public CurrencyNode getCurrencyNode() {\n return currencyNode;\n }\n\n /**\n * Sets the commodity node for this account.\n *\n * Note: method may not be final for Hibernate\n *\n * @param node The new commodity node for this account.\n */\n void setCurrencyNode(@NotNull final CurrencyNode node) {\n Objects.requireNonNull(node);\n\n if (!node.equals(currencyNode)) {\n currencyNode = node;\n\n clearCachedBalances(); // cached balances will need to be recalculated\n }\n }\n\n public boolean isLocked() {\n return locked;\n }\n\n public void setLocked(final boolean locked) {\n this.locked = locked;\n }\n\n public boolean isPlaceHolder() {\n return placeHolder;\n }\n\n public void setPlaceHolder(final boolean placeHolder) {\n this.placeHolder = placeHolder;\n }\n\n public String getDescription() {\n return description;\n }\n\n public void setDescription(final String desc) {\n description = desc;\n }\n\n public synchronized String getName() {\n return name;\n }\n\n public synchronized void setName(final String newName) {\n if (!newName.equals(name)) {\n name = newName;\n }\n }\n\n public synchronized String getPathName() {\n final Account parent = getParent();\n\n if (parent != null && parent.getAccountType() != AccountType.ROOT) {\n return parent.getPathName() + getAccountSeparator() + getName();\n }\n\n return getName(); // this account is at the root level\n }\n\n public AccountType getAccountType() {\n return accountType;\n }\n\n /**\n * Sets the account type\n *\n * Note: method may not be final for Hibernate\n *\n * @param type new account type\n */\n void setAccountType(final AccountType type) {\n Objects.requireNonNull(type);\n\n if (accountType != null && !accountType.isMutable()) {\n throw new EngineException(\"Immutable account type\");\n }\n\n accountType = type;\n\n proxy = null; // proxy will need to change\n }\n\n /**\n * Returns the visibility of the account.\n *\n * @return boolean is this account is visible, false otherwise\n */\n public boolean isVisible() {\n return visible;\n }\n\n /**\n * Changes the visibility of the account.\n *\n * @param visible the new account visibility\n */\n public void setVisible(final boolean visible) {\n this.visible = visible;\n }\n\n /**\n * Returns the notes for this account.\n *\n * @return the notes for this account\n */\n public String getNotes() {\n return notes;\n }\n\n /**\n * Sets the notes for this account.\n *\n * @param notes the notes for this account\n */\n public void setNotes(final String notes) {\n this.notes = notes;\n }\n\n /**\n * Compares two Account for ordering. Returned sort order is consistent with JPA order.\n * The account name, and then account UUID is used1\n *\n * @param acc the {@code Account} to be compared.\n * @return the value {@code 0} if the argument Account is equal to this Account; account\n * value less than {@code 0} if this Account is before the Account argument; and\n * account value greater than {@code 0} if this Account is after the Account argument.\n */\n @Override\n public int compareTo(@NotNull final Account acc) {\n\n // Sort by name\n int result = getName().compareToIgnoreCase(acc.getName());\n if (result != 0) {\n return result;\n }\n\n // Sort of uuid after everything else fails.\n return getUuid().compareTo(acc.getUuid());\n }\n\n @Override\n public String toString() {\n return name;\n }\n\n @Override\n public boolean equals(final Object other) {\n return this == other || other instanceof Account && getUuid().equals(((Account) other).getUuid());\n }\n\n /**\n * User definable account code. This can be used to manage sort order\n * \n * @return the user defined account code\n */\n public int getAccountCode() {\n return accountCode;\n }\n\n public void setAccountCode(final int accountCode) {\n this.accountCode = accountCode;\n }\n\n /**\n * Returns the account number. A non-null value is guaranteed\n *\n * @return the account number\n */\n public String getAccountNumber() {\n return accountNumber;\n }\n\n public void setAccountNumber(final String account) {\n accountNumber = account;\n }\n\n /**\n * Adds account commodity to the list and ensures duplicates are not added.\n * The list is sorted according to numeric code\n *\n * @param node SecurityNode to add\n * @return true if successful\n */\n boolean addSecurity(final SecurityNode node) {\n boolean result = false;\n\n if (node != null && memberOf(AccountGroup.INVEST) && !containsSecurity(node)) {\n securities.add(node);\n\n result = true;\n }\n\n return result;\n }\n\n /**\n * Removes a {@code SecurityNode} from the account. If the {@code SecurityNode} is in use by transactions,\n * removal will be prohibited.\n *\n * @param node {@code SecurityNode} to remove\n * @return {@code true} if successful, {@code false} if used by a transaction or not an active {@code SecurityNode}\n */\n boolean removeSecurity(final SecurityNode node) {\n securitiesLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (!getUsedSecurities().contains(node) && containsSecurity(node)) {\n securities.remove(node);\n result = true;\n }\n\n return result;\n } finally {\n securitiesLock.writeLock().unlock();\n }\n }\n\n public boolean containsSecurity(final SecurityNode node) {\n securitiesLock.readLock().lock();\n\n try {\n return securities.contains(node);\n } finally {\n securitiesLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the market value of this account.\n *\n * @return market value of the account\n */\n public BigDecimal getMarketValue() {\n return getProxy().getMarketValue();\n }\n\n /**\n * Returns a defensive copy of the security set.\n *\n * @return a sorted set\n */\n public Set getSecurities() {\n securitiesLock.readLock().lock();\n\n try {\n return new TreeSet<>(securities);\n } finally {\n securitiesLock.readLock().unlock();\n }\n }\n\n /**\n * Returns a set of used SecurityNodes.\n *\n * @return a set of used SecurityNodes\n */\n public Set getUsedSecurities() {\n transactionLock.readLock().lock();\n securitiesLock.readLock().lock();\n\n try {\n return transactions.parallelStream().filter(t -> t instanceof InvestmentTransaction).map(t ->\n ((InvestmentTransaction) t).getSecurityNode()).collect(Collectors.toCollection(TreeSet::new));\n } finally {\n securitiesLock.readLock().unlock();\n transactionLock.readLock().unlock();\n }\n }\n\n /**\n * Returns the cash balance of this account.\n *\n * @return Cash balance of the account\n */\n public BigDecimal getCashBalance() {\n Lock l = transactionLock.readLock();\n l.lock();\n\n try {\n return getProxy().getCashBalance();\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the depth of the account relative to the {@code RootAccount}.\n *\n * @return depth relative to the root\n */\n public int getDepth() {\n int depth = 0;\n\n Account parent = getParent();\n\n while (parent != null) {\n depth++;\n parent = parent.getParent();\n }\n\n return depth;\n }\n\n /**\n * Shortcut method to check account type.\n *\n * @param type AccountType to compare against\n * @return true if supplied AccountType match\n */\n public final boolean instanceOf(final AccountType type) {\n return getAccountType() == type;\n }\n\n /**\n * Shortcut method to check account group membership.\n *\n * @param group AccountGroup to compare against\n * @return true if this account belongs to the supplied group\n */\n public final boolean memberOf(final AccountGroup group) {\n return getAccountType().getAccountGroup() == group;\n }\n\n public String getBankId() {\n return bankId;\n }\n\n public void setBankId(final String bankId) {\n this.bankId = bankId;\n }\n\n public boolean isExcludedFromBudget() {\n return excludedFromBudget;\n }\n\n public void setExcludedFromBudget(boolean excludeFromBudget) {\n this.excludedFromBudget = excludeFromBudget;\n }\n\n /**\n * Amortization object for loan payments.\n *\n * @return {@code AmortizeObject} if not null\n */\n @Nullable\n public AmortizeObject getAmortizeObject() {\n return amortizeObject;\n }\n\n void setAmortizeObject(final AmortizeObject amortizeObject) {\n this.amortizeObject = amortizeObject;\n }\n\n /**\n * Sets an attribute for the {@code Account}.\n *\n * @param key the attribute key\n * @param value the value. If null, the attribute will be removed\n */\n void setAttribute(@NotNull final String key, @Nullable final String value) {\n attributesLock.writeLock().lock();\n\n try {\n if (key.isEmpty()) {\n throw new EngineException(\"Attribute key may not be empty or null\");\n }\n\n if (value == null) {\n attributes.remove(key);\n } else {\n attributes.put(key, value);\n }\n } finally {\n attributesLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns an {@code Account} attribute.\n *\n * @param key the attribute key\n * @return the attribute if found\n * @see Engine#setAccountAttribute\n */\n @Nullable\n String getAttribute(@NotNull final String key) {\n attributesLock.readLock().lock();\n\n try {\n if (key.isEmpty()) {\n throw new EngineException(\"Attribute key may not be empty or null\");\n }\n\n return attributes.get(key);\n } finally {\n attributesLock.readLock().unlock();\n }\n }\n\n /**\n * Provides access to a cached and sorted list of transactions. Direct access to the list\n * is for internal use only.\n *\n * @return List of sorted transactions\n * @see #getSortedTransactionList\n */\n private List getCachedSortedTransactionList() {\n\n // Lazy initialization\n if (cachedSortedTransactionList == null) {\n cachedSortedTransactionList = new ArrayList<>(transactions);\n Collections.sort(cachedSortedTransactionList);\n }\n\n return cachedSortedTransactionList;\n }\n\n /**\n * Required by XStream for proper initialization.\n *\n * @return Properly initialized Account\n */\n protected Object readResolve() {\n postLoad();\n return this;\n }\n\n @PostLoad\n private void postLoad() {\n transactionLock = new ReentrantReadWriteLock(true);\n childLock = new ReentrantReadWriteLock(true);\n securitiesLock = new ReentrantReadWriteLock(true);\n attributesLock = new ReentrantReadWriteLock(true);\n\n cachedSortedChildren = new ArrayList<>(children);\n Collections.sort(cachedSortedChildren); // JPA will be naturally sorted, but XML files will not\n }\n\n /**\n * Accounts should not be cloned.\n *\n * @return will result in a CloneNotSupportedException\n * @throws java.lang.CloneNotSupportedException will always occur\n */\n @Override\n public Object clone() throws CloneNotSupportedException {\n super.clone();\n throw new CloneNotSupportedException(\"Accounts may not be cloned\");\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AccountGroup.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport jgnash.resource.util.ResourceUtils;\n\n/**\n * Account Group class. Helps to categorize account types to make reporting easier and consistent.\n * \n * @author Craig Cavanaugh\n */\npublic enum AccountGroup {\n\n ASSET(ResourceUtils.getString(\"AccountType.Asset\")),\n EQUITY(ResourceUtils.getString(\"AccountType.Equity\")),\n EXPENSE(ResourceUtils.getString(\"AccountType.Expense\")),\n INCOME(ResourceUtils.getString(\"AccountType.Income\")),\n INVEST(ResourceUtils.getString(\"AccountType.Investment\")),\n LIABILITY(ResourceUtils.getString(\"AccountType.Liability\")),\n ROOT(ResourceUtils.getString(\"AccountType.Root\")),\n SIMPLEINVEST(ResourceUtils.getString(\"AccountType.SimpleInvestment\")); // CD's, Treasuries, Etc.\n\n private final transient String description;\n\n AccountGroup(final String description) {\n this.description = description;\n }\n\n @Override\n public String toString() {\n return description;\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AccountProxy.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.List;\nimport java.util.concurrent.locks.Lock;\n\nimport jgnash.time.DateUtils;\n\n/**\n * Proxy class to locate account balance behaviors. Depending on account type, summation of transaction types are\n * handled differently.\n *\n * @author Craig Cavanaugh\n */\nclass AccountProxy {\n\n final Account account;\n\n AccountProxy(final Account account) {\n this.account = account;\n }\n\n /**\n * Get the balance of all account transactions.\n *\n * @return the balance of this account\n */\n public BigDecimal getBalance() {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal balance = BigDecimal.ZERO;\n\n for (Transaction transaction : account.getSortedTransactionList()) {\n balance = balance.add(transaction.getAmount(account));\n }\n\n return balance;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Get the account balance up to a specified index.\n *\n * @param index the balance of this account at the specified index.\n * @return the balance of this account at the specified index.\n */\n public BigDecimal getBalanceAt(final int index) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal balance = BigDecimal.ZERO;\n\n List transactions = account.getSortedTransactionList();\n\n for (int i = 0; i <= index; i++) {\n balance = balance.add(transactions.get(i).getAmount(account));\n }\n return balance;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the balance of the transactions inclusive of the start and end dates.\n *\n * @param start The inclusive start date\n * @param end The inclusive end date\n * @return The ending balance\n */\n public BigDecimal getBalance(final LocalDate start, final LocalDate end) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal balance = BigDecimal.ZERO;\n\n for (final Transaction t : account.getSortedTransactionList()) {\n final LocalDate d = t.getLocalDate();\n\n if (DateUtils.after(d, start) && DateUtils.before(d, end)) {\n balance = balance.add(t.getAmount(account));\n }\n }\n\n return balance;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the account balance up to and inclusive of the supplied date.\n *\n * @param date The inclusive ending date\n * @return The ending balance\n */\n public BigDecimal getBalance(final LocalDate date) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal balance = BigDecimal.ZERO;\n\n if (!account.transactions.isEmpty()) {\n balance = getBalance(account.getSortedTransactionList().get(0).getLocalDate(), date);\n }\n\n return balance;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the cash balance of this account.\n *\n * @return exception thrown\n */\n public BigDecimal getCashBalance() {\n throw new UnsupportedOperationException();\n }\n\n /**\n * Returns the market value of this account.\n *\n * @return exception thrown\n */\n public BigDecimal getMarketValue() {\n throw new UnsupportedOperationException();\n }\n\n /**\n * Calculates the reconciled balance of the account.\n *\n * @return the reconciled balance of this account\n */\n public BigDecimal getReconciledBalance() {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal balance = BigDecimal.ZERO;\n\n // Use the cached list to avoid ConcurrentModificationException with JPA\n for (final Transaction t : account.getSortedTransactionList()) {\n if (t.getReconciled(account) == ReconciledState.RECONCILED) {\n balance = balance.add(t.getAmount(account));\n }\n }\n\n return balance;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Get the default opening balance for reconciling the account.\n *\n * @return Opening balance for reconciling the account\n */\n public BigDecimal getOpeningBalanceForReconcile() {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n final LocalDate date = account.getFirstUnreconciledTransactionDate();\n\n final List transactions = account.getSortedTransactionList();\n\n BigDecimal balance = BigDecimal.ZERO;\n\n for (int i = 0; i < transactions.size(); i++) {\n if (transactions.get(i).getLocalDate().equals(date)) {\n if (i > 0) {\n balance = getBalanceAt(i - 1);\n }\n break;\n }\n }\n return balance;\n } finally {\n l.unlock();\n }\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AccountTreeXMLFactory.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport com.thoughtworks.xstream.XStream;\nimport com.thoughtworks.xstream.converters.reflection.PureJavaReflectionProvider;\nimport com.thoughtworks.xstream.hibernate.converter.HibernatePersistentCollectionConverter;\nimport com.thoughtworks.xstream.hibernate.converter.HibernatePersistentMapConverter;\nimport com.thoughtworks.xstream.hibernate.converter.HibernateProxyConverter;\nimport com.thoughtworks.xstream.hibernate.mapper.HibernateMapper;\nimport com.thoughtworks.xstream.io.xml.PrettyPrintWriter;\nimport com.thoughtworks.xstream.io.xml.StaxDriver;\nimport com.thoughtworks.xstream.mapper.MapperWrapper;\nimport com.thoughtworks.xstream.security.ArrayTypePermission;\nimport com.thoughtworks.xstream.security.NoTypePermission;\nimport com.thoughtworks.xstream.security.PrimitiveTypePermission;\nimport com.thoughtworks.xstream.security.WildcardTypePermission;\n\nimport java.io.BufferedReader;\nimport java.io.IOException;\nimport java.io.InputStream;\nimport java.io.InputStreamReader;\nimport java.io.ObjectInputStream;\nimport java.io.ObjectOutputStream;\nimport java.io.Reader;\nimport java.io.Writer;\nimport java.nio.charset.Charset;\nimport java.nio.charset.StandardCharsets;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.HashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.ResourceBundle;\nimport java.util.Set;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\nimport jgnash.engine.xstream.XStreamJVM9;\nimport jgnash.resource.util.ClassPathUtils;\nimport jgnash.resource.util.ResourceUtils;\n\n/**\n * Import and export a tree of accounts using XML files.\n *\n * @author Craig Cavanaugh\n */\npublic class AccountTreeXMLFactory {\n private static final Charset ENCODING = StandardCharsets.UTF_8;\n\n private static final String RESOURCE_ROOT_PATH = \"/jgnash/resource/account\";\n\n private AccountTreeXMLFactory() {\n }\n \n private static XStream getStream() {\n\n final XStreamJVM9 xstream = new XStreamJVM9(new PureJavaReflectionProvider(), new StaxDriver()) {\n\n @Override\n protected MapperWrapper wrapMapper(final MapperWrapper next) {\n return new HibernateMapper(next);\n }\n };\n\n // configure XStream security\n xstream.addPermission(NoTypePermission.NONE);\n xstream.addPermission(PrimitiveTypePermission.PRIMITIVES);\n xstream.addPermission(ArrayTypePermission.ARRAYS);\n xstream.addPermission(new WildcardTypePermission(new String[] {\"java.**\", \"jgnash.engine.**\"}));\n\n xstream.ignoreUnknownElements(); // gracefully ignore fields in the file that do not have object members\n\n xstream.setMode(XStream.ID_REFERENCES);\n\n xstream.alias(\"date\", LocalDate.class); // use date instead of local-date by default\n\n xstream.alias(\"Account\", Account.class);\n xstream.alias(\"RootAccount\", RootAccount.class);\n xstream.alias(\"CurrencyNode\", CurrencyNode.class);\n xstream.alias(\"SecurityNode\", SecurityNode.class);\n\n xstream.useAttributeFor(Account.class, \"placeHolder\");\n xstream.useAttributeFor(Account.class, \"locked\");\n xstream.useAttributeFor(Account.class, \"visible\");\n xstream.useAttributeFor(Account.class, \"name\");\n xstream.useAttributeFor(Account.class, \"description\");\n\n xstream.useAttributeFor(CommodityNode.class, \"symbol\");\n xstream.useAttributeFor(CommodityNode.class, \"scale\");\n xstream.useAttributeFor(CommodityNode.class, \"prefix\");\n xstream.useAttributeFor(CommodityNode.class, \"suffix\");\n xstream.useAttributeFor(CommodityNode.class, \"description\");\n\n xstream.omitField(StoredObject.class, \"uuid\");\n xstream.omitField(StoredObject.class, \"markedForRemoval\");\n\n // Ignore fields required for JPA\n xstream.omitField(StoredObject.class, \"version\");\n\n xstream.omitField(Account.class, \"transactions\");\n xstream.omitField(Account.class, \"accountBalance\");\n xstream.omitField(Account.class, \"reconciledBalance\");\n xstream.omitField(Account.class, \"attributes\");\n xstream.omitField(Account.class, \"propertyMap\");\n xstream.omitField(Account.class, \"amortizeObject\");\n\n xstream.omitField(SecurityNode.class, \"historyNodes\");\n xstream.omitField(SecurityNode.class, \"securityHistoryEvents\");\n\n // Filters out the hibernate\n xstream.registerConverter(new HibernateProxyConverter());\n xstream.registerConverter(new HibernatePersistentCollectionConverter(xstream.getMapper()));\n xstream.registerConverter(new HibernatePersistentMapConverter(xstream.getMapper()));\n \n \n //xstream.registerConverter(new HibernatePersistentSortedMapConverter(xstream.getMapper()));\n //xstream.registerConverter(new HibernatePersistentSortedSetConverter(xstream.getMapper()));\n\n return xstream;\n }\n\n public static void exportAccountTree(final Engine engine, final Path file) {\n RootAccount account = engine.getRootAccount();\n\n XStream xstream = getStream();\n\n try (final Writer writer = Files.newBufferedWriter(file, ENCODING);\n final ObjectOutputStream out = xstream.createObjectOutputStream(new PrettyPrintWriter(writer))) {\n out.writeObject(account);\n } catch (IOException e) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n }\n\n /**\n * Load an account tree given a reader.\n *\n * @param reader Reader to use\n * @return RootAccount if reader is valid\n */\n private static RootAccount loadAccountTree(final Reader reader) {\n RootAccount account = null;\n\n XStream xstream = getStream();\n\n try (final ObjectInputStream in = xstream.createObjectInputStream(reader)) {\n final Object o = in.readObject();\n\n if (o instanceof RootAccount) {\n account = (RootAccount) o;\n }\n } catch (IOException | ClassNotFoundException ex) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, null, ex);\n }\n\n return account;\n }\n\n /**\n * Load an account tree given a reader.\n *\n * @param file file name to use\n * @return RootAccount if file name is valid\n */\n public static RootAccount loadAccountTree(final Path file) {\n RootAccount account = null;\n\n try (final Reader reader = Files.newBufferedReader(file, ENCODING)) {\n account = loadAccountTree(reader);\n } catch (IOException ex) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, null, ex);\n }\n\n return account;\n }\n\n /**\n * Load an account tree given an InputStream.\n *\n * @param stream InputStream to use\n * @return RootAccount if stream is valid\n */\n private static RootAccount loadAccountTree(final InputStream stream) {\n try (Reader reader = new InputStreamReader(stream, ENCODING)) {\n return loadAccountTree(reader);\n } catch (IOException ex) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, null, ex);\n }\n\n return null;\n }\n\n /**\n * Imports an account tree into the existing account tree. Account\n * currencies are forced to the engine's default\n *\n * @param engine current engine to merge into\n * @param root root of account structure to merge\n */\n public static void importAccountTree(final Engine engine, final RootAccount root) {\n AccountImport accountImport = new AccountImport();\n accountImport.importAccountTree(engine, root);\n }\n\n /**\n * Merges an account tree into the existing account tree. Duplicate\n * currencies are prevented\n *\n * @param engine current engine to merge into\n * @param root root of account structure to merge\n */\n public static void mergeAccountTree(final Engine engine, final RootAccount root) {\n AccountImport accountImport = new AccountImport();\n accountImport.mergeAccountTree(engine, root);\n }\n\n public static Collection getLocalizedAccountSet() {\n final List files = new ArrayList<>();\n\n for (final String string : getAccountSetList()) {\n\n try (final InputStream stream = AccountTreeXMLFactory.class.getResourceAsStream(string)) {\n final RootAccount account = AccountTreeXMLFactory.loadAccountTree(stream);\n files.add(account);\n } catch (final IOException e) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, null, e);\n }\n }\n\n return files;\n }\n\n private static List getAccountSetList() {\n final String path = ClassPathUtils.getLocalizedPath(RESOURCE_ROOT_PATH);\n\n final List set = new ArrayList<>();\n\n if (path != null) {\n try (final InputStream stream = AccountTreeXMLFactory.class.getResourceAsStream(path + \"/set.txt\");\n final BufferedReader r = new BufferedReader(new InputStreamReader(stream, ENCODING))) {\n\n String line = r.readLine();\n\n while (line != null) {\n set.add(path + \"/\" + line);\n line = r.readLine();\n }\n } catch (final IOException ex) {\n Logger.getLogger(AccountTreeXMLFactory.class.getName()).log(Level.SEVERE, null, ex);\n }\n }\n return set;\n }\n\n private static class AccountImport {\n\n // merge map for accounts\n private final Map mergeMap = new HashMap<>();\n\n private void importAccountTree(final Engine engine, final RootAccount root) {\n forceCurrency(engine, root);\n\n for (Account child : root.getChildren()) {\n importChildren(engine, child);\n }\n }\n\n private void mergeAccountTree(final Engine engine, final RootAccount root) {\n fixCurrencies(engine, root);\n\n for (final Account child : root.getChildren()) {\n importChildren(engine, child);\n }\n }\n\n /**\n * Ensures that duplicate currencies are not created when the accounts are merged.\n *\n * @param engine Engine with existing currencies\n * @param account account to correct\n */\n private static void fixCurrencies(final Engine engine, final Account account) {\n\n // If an existing currency matches, assign it to the account\n engine.getCurrencies().stream().filter(currencyNode -> account.getCurrencyNode()\n .matches(currencyNode)).forEach(account::setCurrencyNode);\n\n // Need to persist the currency before the account if it does not exist within the database\n if (!engine.getCurrencies().contains(account.getCurrencyNode())) {\n engine.addCurrency(account.getCurrencyNode());\n }\n\n // match SecurityNodes to prevent duplicates\n if (account.memberOf(AccountGroup.INVEST)) {\n final Set nodes = account.getSecurities();\n\n for (final SecurityNode node : nodes) {\n SecurityNode sNode = engine.getSecurity(node.getSymbol());\n\n if (sNode == null) { // no match found\n try {\n sNode = (SecurityNode) node.clone();\n\n for (final CurrencyNode currencyNode : engine.getCurrencies()) {\n if (sNode.getReportedCurrencyNode().matches(currencyNode)) {\n sNode.setReportedCurrencyNode(currencyNode);\n }\n }\n if (!engine.addSecurity(sNode)) {\n final ResourceBundle rb = ResourceUtils.getBundle();\n Logger.getLogger(AccountImport.class.getName()).log(Level.SEVERE,\n rb.getString(\"Message.Error.SecurityAdd\"), sNode.getSymbol());\n }\n } catch (final CloneNotSupportedException e) {\n Logger.getLogger(AccountImport.class.getName()).log(Level.SEVERE,\n e.getLocalizedMessage(), e);\n }\n }\n\n account.removeSecurity(node);\n account.addSecurity(sNode);\n }\n }\n\n for (Account child : account.getChildren()) {\n fixCurrencies(engine, child);\n }\n }\n\n /**\n * Ensures that duplicate currencies are not created when the accounts are merged.\n *\n * @param engine Engine with existing currencies\n * @param account account to correct\n */\n private static void forceCurrency(final Engine engine, final Account account) {\n\n account.setCurrencyNode(engine.getDefaultCurrency());\n\n // match SecurityNodes to prevent duplicates\n if (account.memberOf(AccountGroup.INVEST)) {\n final Set nodes = account.getSecurities();\n\n for (final SecurityNode node : nodes) {\n SecurityNode sNode = engine.getSecurity(node.getSymbol());\n\n if (sNode == null) { // no match found\n try {\n sNode = (SecurityNode) node.clone();\n\n sNode.setReportedCurrencyNode(engine.getDefaultCurrency());\n\n if (!engine.addSecurity(sNode)) {\n final ResourceBundle rb = ResourceUtils.getBundle();\n Logger.getLogger(AccountImport.class.getName()).log(Level.SEVERE,\n rb.getString(\"Message.Error.SecurityAdd\"), sNode.getSymbol());\n }\n } catch (final CloneNotSupportedException e) {\n Logger.getLogger(AccountImport.class.getName()).log(Level.SEVERE, e.toString(), e);\n }\n }\n\n account.removeSecurity(node);\n account.addSecurity(sNode);\n }\n }\n\n for (Account child : account.getChildren()) {\n forceCurrency(engine, child);\n }\n }\n\n private void importChildren(final Engine engine, final Account account) {\n\n // fix the exchange rate DAO if needed\n engine.attachCurrencyNode(account.getCurrencyNode());\n\n // match RootAccount special case\n if (account.getParent() instanceof RootAccount) {\n mergeMap.put(account.getParent(), engine.getRootAccount());\n }\n\n // search for a pre-existing match\n Account match = AccountUtils.searchTree(engine.getRootAccount(), account.getName(),\n account.getAccountType(), account.getDepth());\n\n if (match != null && match.getParent().equals(mergeMap.get(account.getParent()))) { // found a match\n mergeMap.put(account, match);\n } else { // the account is unique\n\n // place in the merge map\n mergeMap.put(account, account);\n\n Account parent = mergeMap.get(account.getParent());\n engine.addAccount(parent, account);\n }\n\n for (final Account child : account.getChildren()) {\n importChildren(engine, child);\n }\n }\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AccountType.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.lang.reflect.Constructor;\nimport java.lang.reflect.InvocationTargetException;\nimport java.util.EnumSet;\nimport java.util.Set;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\nimport jgnash.resource.util.ResourceUtils;\n\n/**\n * Account type enumeration.\n * \n * @author Craig Cavanaugh\n */\npublic enum AccountType {\n\n ASSET(ResourceUtils.getString(\"AccountType.Asset\"), AccountGroup.ASSET, AccountProxy.class, true),\n BANK(ResourceUtils.getString(\"AccountType.Bank\"), AccountGroup.ASSET, AccountProxy.class, true),\n CASH(ResourceUtils.getString(\"AccountType.Cash\"), AccountGroup.ASSET, AccountProxy.class, true),\n CHECKING(ResourceUtils.getString(\"AccountType.Checking\"), AccountGroup.ASSET, AccountProxy.class, true),\n CREDIT(ResourceUtils.getString(\"AccountType.Credit\"), AccountGroup.LIABILITY, AccountProxy.class, true),\n EQUITY(ResourceUtils.getString(\"AccountType.Equity\"), AccountGroup.EQUITY, AccountProxy.class, true),\n EXPENSE(ResourceUtils.getString(\"AccountType.Expense\"), AccountGroup.EXPENSE, AccountProxy.class, true),\n INCOME(ResourceUtils.getString(\"AccountType.Income\"), AccountGroup.INCOME, AccountProxy.class, true),\n INVEST(ResourceUtils.getString(\"AccountType.Investment\"), AccountGroup.INVEST, InvestmentAccountProxy.class, false),\n SIMPLEINVEST(ResourceUtils.getString(\"AccountType.SimpleInvestment\"), AccountGroup.SIMPLEINVEST, AccountProxy.class, true),\n LIABILITY(ResourceUtils.getString(\"AccountType.Liability\"), AccountGroup.LIABILITY, AccountProxy.class, true),\n MONEYMKRT(ResourceUtils.getString(\"AccountType.MoneyMarket\"), AccountGroup.ASSET, AccountProxy.class, true),\n MUTUAL(ResourceUtils.getString(\"AccountType.Mutual\"), AccountGroup.INVEST, InvestmentAccountProxy.class, false),\n ROOT(ResourceUtils.getString(\"AccountType.Root\"), AccountGroup.ROOT, AccountProxy.class, true);\n\n private final transient String description;\n\n private final transient AccountGroup accountGroup;\n\n private final transient Class accountProxy;\n\n private final transient boolean mutable;\n\n AccountType(final String description, final AccountGroup accountGroup, final Class accountProxy, final boolean mutable) {\n this.description = description;\n this.accountGroup = accountGroup;\n this.accountProxy = accountProxy;\n this.mutable = mutable;\n }\n\n /**\n * Returns all AccountTypes that fit the supplied AccountGroup.\n * \n * @param group AccountGroup to match\n * @return array of AccountTypes that fit the supplied group\n */\n public static Set getAccountTypes(final AccountGroup group) {\n final Set list = getAccountTypeSet();\n\n list.removeIf(accountType -> accountType.getAccountGroup() != group);\n\n return list;\n }\n\n @Override\n public String toString() {\n return description;\n }\n\n public AccountGroup getAccountGroup() {\n return accountGroup;\n }\n\n public boolean isMutable() {\n return mutable;\n }\n\n private static Set getAccountTypeSet() {\n Set set = EnumSet.allOf(AccountType.class);\n\n set.remove(AccountType.ROOT);\n return set;\n }\n\n AccountProxy getProxy(final Account account) {\n try {\n Class[] constParams = new Class[] { Account.class };\n Constructor accConst = accountProxy.getDeclaredConstructor(constParams);\n Object[] params = new Object[] { account };\n return (AccountProxy) accConst.newInstance(params);\n } catch (final InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException | NoSuchMethodException | SecurityException ex) {\n Logger.getLogger(AccountType.class.getName()).log(Level.SEVERE, null, ex);\n }\n return null; // unable to create object\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AccountUtils.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received account copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\n/**\n * Static account utilities.\n * \n * @author Craig Cavanaugh\n */\nclass AccountUtils {\n\n /**\n * Searches an account tree given the supplied parameters.\n * \n * @param root Base account\n * @param name Account name\n * @param type Account type\n * @param depth Account depth\n * @return matched account if it exists\n */\n static Account searchTree(final Account root, final String name, final AccountType type, final int depth) {\n Account match = null;\n\n for (final Account a : root.getChildren()) {\n if (a.getName().equals(name) && a.getAccountType() == type && a.getDepth() == depth) {\n match = a;\n } else if (a.getChildCount() > 0) {\n match = searchTree(a, name, type, depth);\n }\n\n if (match != null) {\n break;\n }\n }\n return match;\n }\n\n private AccountUtils() {\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AmortizeObject.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.io.Serializable;\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.Objects;\n\nimport javax.persistence.Entity;\nimport javax.persistence.GeneratedValue;\nimport javax.persistence.GenerationType;\nimport javax.persistence.Id;\nimport javax.persistence.ManyToOne;\nimport javax.persistence.SequenceGenerator;\n\nimport jgnash.resource.util.ResourceUtils;\nimport jgnash.util.NotNull;\nimport jgnash.util.Nullable;\n\n/**\n * This class is used to calculate loan payments.\n * \n * Because BigDecimal is lacking methods of exponents, calculations are\n * performed using StrictMath to maintain portability. Results are returned as\n * doubles. Results will need to be scaled and rounded.\n *\n * @author Craig Cavanaugh\n */\n@Entity\n@SequenceGenerator(name = \"sequence\", allocationSize = 10)\npublic class AmortizeObject implements Serializable {\n\n @SuppressWarnings(\"unused\")\n @Id\n @GeneratedValue(generator = \"sequence\", strategy = GenerationType.SEQUENCE)\n private long id;\n\n @ManyToOne\n private Account interestAccount; // account for interest payment\n\n @ManyToOne\n private Account bankAccount; // account for principal account\n\n // (normally the liability account)\n @ManyToOne\n private Account feesAccount; // account to place non interest fees\n\n /**\n * Controls the type of transaction automatically generated\n */\n @SuppressWarnings(\"unused\")\n private Integer transactionType;\n\n /**\n * the number of payments per year.\n */\n private int numPayments;\n\n /**\n * length of loan in months.\n */\n private int length;\n\n /**\n * the number of compounding periods per year.\n */\n private int numCompPeriods;\n\n /**\n * annual interest rate, APR (ex 6.75).\n */\n private BigDecimal interestRate;\n\n /**\n * original balance of the loan.\n */\n private BigDecimal originalBalance;\n\n /**\n * PMI, escrow, etc.\n */\n private BigDecimal fees = BigDecimal.ZERO;\n\n /**\n * the payee to use.\n */\n private String payee;\n\n /**\n * the memo to use.\n */\n private String memo;\n\n // private String checkNumber; // check number to use\n\n /**\n * origination date.\n */\n private LocalDate date = LocalDate.now();\n\n /**\n * calculate interest based on daily periodic rate.\n */\n private boolean useDailyRate;\n\n /**\n * the number of days per year for daily periodic rate.\n */\n private BigDecimal daysPerYear;\n\n /**\n * Empty constructor to keep reflection happy.\n */\n public AmortizeObject() {\n }\n\n public void setDate(final LocalDate localDate) {\n date = localDate;\n }\n\n public LocalDate getDate() {\n return date;\n }\n\n public void setPaymentPeriods(final int periods) {\n numPayments = periods;\n }\n\n public int getPaymentPeriods() {\n return numPayments;\n }\n\n /**\n * Sets the length of the loan (in months).\n *\n * @param months length of loan\n */\n public void setLength(final int months) {\n this.length = months;\n }\n\n /**\n * Gets the length of the loan in months.\n *\n * @return length of loan in months\n */\n public int getLength() {\n return length;\n }\n\n /**\n * Determines if interest will be calculate based on a daily periodic rate,\n * or if it is assumed that the interest is paid exactly on the due date.\n *\n * @param daily true if interest should be calculated using a daily rate\n */\n public void setUseDailyRate(final boolean daily) {\n useDailyRate = daily;\n }\n\n /**\n * Returns how interest will be calculated.\n *\n * @return true if interest is calculated using the daily periodic rate\n */\n public boolean getUseDailyRate() {\n return useDailyRate;\n }\n\n /**\n * Sets the number of days per year used to calculate the daily periodic\n * interest rate. The value can be a decimal.\n *\n * @param days The number of days in a year\n */\n public void setDaysPerYear(final BigDecimal days) {\n daysPerYear = days;\n }\n\n /**\n * Returns the number of days per year used to calculate a daily periodic\n * interest rate.\n *\n * @return The number of days per year\n */\n public BigDecimal getDaysPerYear() {\n return daysPerYear;\n }\n\n public void setRate(final BigDecimal rate) {\n interestRate = rate;\n }\n\n public BigDecimal getRate() {\n return interestRate;\n }\n\n public void setPrincipal(final BigDecimal principal) {\n originalBalance = principal;\n }\n\n public BigDecimal getPrincipal() {\n return originalBalance;\n }\n\n public void setInterestPeriods(final int periods) {\n numCompPeriods = periods;\n }\n\n public int getInterestPeriods() {\n return numCompPeriods;\n }\n\n public void setFees(final BigDecimal fees) {\n this.fees = Objects.requireNonNullElse(fees, BigDecimal.ZERO);\n }\n\n public BigDecimal getFees() {\n return fees;\n }\n\n /**\n * Set the id of the interest account.\n *\n * @param id the id of the interest account\n */\n public void setInterestAccount(final Account id) {\n interestAccount = id;\n }\n\n /**\n * Returns the id of the interest account.\n *\n * @return the id of the interest account\n */\n public Account getInterestAccount() {\n return interestAccount;\n }\n\n /**\n * Set the id of the principal account.\n *\n * @param id the id of the principal account\n */\n public void setBankAccount(final Account id) {\n bankAccount = id;\n }\n\n /**\n * Returns the id of the principal account.\n *\n * @return the id of the principal account\n */\n public Account getBankAccount() {\n return bankAccount;\n }\n\n /**\n * Set the id of the fees account.\n *\n * @param id the id of the fees account\n */\n public void setFeesAccount(final Account id) {\n feesAccount = id;\n }\n\n /**\n * Returns the id of the fees account.\n *\n * @return the id of the fees account\n */\n public Account getFeesAccount() {\n return feesAccount;\n }\n\n public void setPayee(final String payee) {\n this.payee = payee;\n }\n\n public String getPayee() {\n return payee;\n }\n\n public void setMemo(String memo) {\n this.memo = memo;\n }\n\n public String getMemo() {\n return memo;\n }\n\n /**\n * Calculates the effective interest rate.
\n * Ie = (1 + i/m)^(m/n) - 1
\n * n = payments per period m = number of times compounded per period\n *\n * @return effective interest rate\n */\n private double getEffectiveInterestRate() {\n if (interestRate != null && numPayments > 0 && numCompPeriods > 0) {\n double i = interestRate.doubleValue() / 100.0;\n return StrictMath.pow(1.0 + i / numCompPeriods, (double) numCompPeriods / (double) numPayments) - 1.0;\n }\n return 0.0;\n }\n\n /**\n * Calculates the daily interest rate.
\n * This works for US, can't find any information on Canada\n *\n * @return periodic interest rate\n */\n private double getDailyPeriodicInterestRate() {\n if (interestRate != null && numPayments > 0 && numCompPeriods > 0 && daysPerYear != null) {\n double rate = getEffectiveInterestRate();\n rate = rate * numPayments;\n return rate / daysPerYear.doubleValue();\n }\n return 0.0;\n }\n\n // /**\n // * Calculates the sum of compounded interest and principal\n // * S = P(1+Ie)^n*term\n // *\n // * @return sum with interest\n // */\n // double getSumWithInterest() {\n // return getPIPayment() * length;\n // }\n\n // public double getTotalInterestPaid() {\n // return getSumWithInterest() - originalBalance.doubleValue();\n // }\n\n /**\n * Calculates the principal and interest payment of an equal payment series\n * M = P * ( Ie / (1 - (1 + Ie) ^ -N)) N = total number of periods the loan\n * is amortized over.\n *\n * @return P and I\n */\n private double getPIPayment() {\n\n // zero interest loan\n if ((interestRate == null || interestRate.compareTo(BigDecimal.ZERO) == 0) && length > 0 && numPayments > 0\n && originalBalance != null) {\n\n return originalBalance.doubleValue() / ((length / 12.0) * numPayments);\n }\n\n if (length > 0 && numPayments > 0 && numCompPeriods > 0 && originalBalance != null) {\n double i = getEffectiveInterestRate();\n double p = originalBalance.doubleValue();\n\n return p * (i / (1.0 - StrictMath.pow(1.0 + i, length * -1.0)));\n }\n return 0.0;\n }\n\n /**\n * Calculates the principal and interest plus finance charges.\n *\n * @return the payment\n */\n private double getPayment() {\n return getPIPayment() + fees.doubleValue();\n }\n\n /**\n * Calculates the interest portion of the next loan payment given the\n * remaining loan balance.\n *\n * @param balance remaining balance\n * @return interest\n */\n private double getIPayment(final BigDecimal balance) {\n if (balance != null) {\n double i = getEffectiveInterestRate();\n return i * balance.doubleValue();\n }\n return 0.0;\n }\n\n /**\n * Calculates the interest portion of the next loan payment given the\n * remaining loan balance and the dates between payments.\n *\n * @param balance balance\n * @param start start date\n * @param end end date\n * @return interest\n */\n private double getIPayment(final BigDecimal balance, final LocalDate start, final LocalDate end) {\n if (balance != null) {\n\n int dayEnd = end.getDayOfYear();\n int dayStart = start.getDayOfYear();\n\n int days = Math.abs(dayEnd - dayStart);\n\n double i = getDailyPeriodicInterestRate();\n return i * days * balance.doubleValue();\n }\n return 0.0;\n }\n\n //\t/**\n // * Calculates the principal portion of the next loan payment given the\n // * remaining loan balance\n // *\n // * @param balance balance\n // * @return principal\n // */\n //\tpublic double getPPayment(BigDecimal balance) {\n //\t\treturn getPIPayment() - getIPayment(balance);\n //\t}\n\n @Nullable\n public Transaction generateTransaction(@NotNull final Account account, @NotNull final LocalDate date, final String number) {\n\n BigDecimal balance = account.getBalance().abs();\n double payment = getPayment();\n\n double interest;\n\n if (getUseDailyRate()) {\n\n LocalDate last;\n\n if (account.getTransactionCount() > 0) {\n last = account.getTransactionAt(account.getTransactionCount() - 1).getLocalDate();\n } else {\n last = date;\n }\n\n interest = getIPayment(balance, last, date); // get the interest portion\n\n } else {\n interest = getIPayment(balance); // get the interest portion\n }\n\n // get debit account\n final Account bank = getBankAccount();\n\n if (bank != null) {\n CommodityNode n = bank.getCurrencyNode();\n\n Transaction transaction = new Transaction();\n transaction.setDate(date);\n transaction.setNumber(number);\n transaction.setPayee(getPayee());\n\n // transaction is made relative to the debit/checking account\n\n TransactionEntry entry = new TransactionEntry();\n\n // this entry is the principal payment\n entry.setCreditAccount(account);\n entry.setDebitAccount(bank);\n entry.setAmount(n.round(payment - interest));\n entry.setMemo(getMemo());\n\n transaction.addTransactionEntry(entry);\n\n // handle interest portion of the payment\n Account i = getInterestAccount();\n if (i != null && interest != 0.0) {\n entry = new TransactionEntry();\n entry.setCreditAccount(i);\n entry.setDebitAccount(bank);\n entry.setAmount(n.round(interest));\n entry.setMemo(ResourceUtils.getString(\"Word.Interest\"));\n transaction.addTransactionEntry(entry);\n }\n\n // a fee has been assigned\n if (getFees().compareTo(BigDecimal.ZERO) != 0) {\n Account f = getFeesAccount();\n if (f != null) {\n entry = new TransactionEntry();\n entry.setCreditAccount(f);\n entry.setDebitAccount(bank);\n entry.setAmount(getFees());\n entry.setMemo(ResourceUtils.getString(\"Word.Fees\"));\n transaction.addTransactionEntry(entry);\n }\n }\n\n return transaction;\n }\n\n return null;\n }\n\n\n //Creates a payment transaction relative to the liability account\n /*\n private void paymentActionLiability() {\n\n AmortizeObject ao = ((LiabilityAccount)account).getAmortizeObject();\n Transaction tran = null;\n\n if (ao != null) {\n DateChkNumberDialog d = new DateChkNumberDialog(null, engine.getAccount(ao.getInterestAccount()));\n d.show();\n\n if (!d.getResult()) {\n return;\n }\n\n BigDecimal balance = account.getBalance().abs();\n BigDecimal fees = ao.getFees();\n double payment = ao.getPayment();\n\n double interest;\n\n if (ao.getUseDailyRate()) {\n Date today = d.getDate();\n Date last = account.getTransactionAt(account.getTransactionCount() - 1).getDate();\n interest = ao.getIPayment(balance, last, today); // get the interest portion\n } else {\n interest = ao.getIPayment(balance); // get the interest portion\n }\n\n Account b = engine.getAccount(ao.getBankAccount());\n if (b != null) {\n CommodityNode n = b.getCommodityNode();\n SplitEntryTransaction e;\n\n SplitTransaction t = new SplitTransaction(b.getCommodityNode());\n t.setAccount(b);\n t.setMemo(ao.getMemo());\n t.setPayee(ao.getPayee());\n t.setNumber(d.getNumber());\n t.setDate(d.getDate());\n\n // this entry is the complete payment\n e = new SplitEntryTransaction(n);\n e.setCreditAccount(account);\n e.setDebitAccount(b);\n e.setAmount(n.round(payment));\n e.setMemo(ao.getMemo());\n t.addSplit(e);\n\n try { // maintain transaction order (stretch time)\n Thread.sleep(2);\n } catch (Exception ie) {}\n\n // handle interest portion of the payment\n Account i = engine.getAccount(ao.getInterestAccount());\n if (i != null) {\n e = new SplitEntryTransaction(n);\n e.setCreditAccount(i);\n e.setDebitAccount(account);\n e.setAmount(n.round(interest));\n e.setMemo(rb.getString(\"Word.Interest\"));\n t.addSplit(e);\n }\n\n try { // maintain transaction order (stretch time)\n Thread.sleep(2);\n } catch (Exception ie) {}\n\n // a fee has been assigned\n if (ao.getFees().compareTo(new BigDecimal(\"0\")) != 0) {\n Account f = engine.getAccount(ao.getFeesAccount());\n if (f != null) {\n e = new SplitEntryTransaction(n);\n e.setCreditAccount(f);\n e.setDebitAccount(account);\n e.setAmount(ao.getFees());\n e.setMemo(rb.getString(\"Word.Fees\"));\n t.addSplit(e);\n }\n }\n\n // the total should be the debit to the checking account\n tran = t;\n }\n }\n\n if (tran != null) {// display the transaction in the register\n newTransaction(tran);\n } else { // could not generate the transaction\n if (ao == null) {\n Logger.getLogger(\"jgnashEngine\").warning(\"Please configure amortization\");\n } else {\n Logger.getLogger(\"jgnashEngine\").warning(\"Not enough information\");\n }\n }\n }*/\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/AttachmentUtils.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport jgnash.util.FileUtils;\nimport jgnash.util.NotNull;\n\nimport java.io.IOException;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.Objects;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\n/**\n * Support methods for handling attachments.\n *\n * @author Craig Cavanaugh\n */\npublic class AttachmentUtils {\n\n private static final String ATTACHMENT_BASE = \"attachments\";\n\n /**\n * Utility class.\n */\n private AttachmentUtils() {\n }\n\n /**\n * Creates the attachment directory for the active database.\n * \n * @param baseFile base directory for file attachments\n * @return {@code true} if and only if the directory was created or if\n * it already exists; {@code false} otherwise\n */\n public static boolean createAttachmentDirectory(final Path baseFile) {\n boolean result = false;\n\n final Path attachmentPath = getAttachmentDirectory(baseFile);\n\n if (attachmentPath != null && Files.notExists(attachmentPath)) {\n try {\n Files.createDirectories(attachmentPath);\n result = true;\n } catch (IOException e) {\n Logger.getLogger(AttachmentUtils.class.getName()).log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n } else {\n result = true;\n }\n\n return result;\n }\n\n /**\n * Returns the default attachment directory for the given base file.\n *\n * @param baseFile base file for attachment directory\n * @return directory for all attachments\n */\n public static Path getAttachmentDirectory(@NotNull final Path baseFile) {\n Objects.requireNonNull(baseFile);\n\n if (baseFile.getParent() != null) {\n return Paths.get(baseFile.getParent() + FileUtils.SEPARATOR + ATTACHMENT_BASE);\n }\n\n return null;\n }\n\n public static Path getAttachmentPath() {\n return getAttachmentDirectory(Paths.get(EngineFactory.getActiveDatabase()));\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/CashFlow.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.List;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\nimport static java.lang.Math.abs;\nimport static java.time.temporal.ChronoUnit.DAYS;\n\n/**\n * Stores a history of cash flow items and calculates their internal rate of\n * return. It assumes 365 days per year (Actual/365 Fixed day count convention)\n * and uses a simple iterative solver.\n *\n * @author t-pa\n * @author Craig Cavanaugh\n */\npublic class CashFlow {\n\n private static final double DAYS_PER_YEAR = 365;\n private static final int MAX_ITERATIONS = 1000;\n private static final double CONVERGENCE = 1.e-5;\n\n private static final Logger logger = Logger.getLogger(CashFlow.class.getName());\n\n private static class CashFlowItem {\n final LocalDate date;\n final BigDecimal amount;\n\n CashFlowItem(final LocalDate date, final BigDecimal amount) {\n this.date = date;\n this.amount = amount;\n }\n\n @Override\n public String toString() {\n return String.format(\"[%s, %f]\", date.toString(), amount);\n }\n }\n\n private final List cashFlows = new ArrayList<>();\n\n /**\n * Add an item to the history of cash flows.\n *\n * @param date the date of the cash flow\n * @param amount the amount; negative for an investment, positive for a payout\n */\n public void add(final LocalDate date, final BigDecimal amount) {\n cashFlows.add(new CashFlowItem(date, amount));\n }\n\n /**\n * Calculate the internal rate of return of the cash flow. If the iterative\n * solution does not converge, NaN is returned.\n *\n * @return an approximation of the (annualized) internal rate of return\n */\n public double internalRateOfReturn() {\n if (cashFlows.isEmpty()) {\n return 0.0;\n }\n\n // the reference date is arbitrary, but for better numerical accuracy,\n // use one of the actual dates in the cash flow history\n LocalDate referenceDate = cashFlows.get(0).date;\n\n double lastRate = 0.0;\n double lastNPV = netPresentValue(referenceDate, lastRate);\n\n double rate = (lastNPV > 0) ? 0.05 : -0.05;\n\n // iteratively calculate the IRR with the secant method\n int i = 0;\n boolean hasConverged = false;\n\n do {\n double npv = netPresentValue(referenceDate, rate);\n double newRate = rate - npv * (rate - lastRate) / (npv - lastNPV);\n\n lastRate = rate;\n lastNPV = npv;\n rate = newRate;\n\n i++;\n\n if (Double.isNaN(rate)) { // check for failure to converge\n break;\n } else if (rate != 0 || lastRate != 0) {\n hasConverged = abs(rate - lastRate) / (abs(rate) + abs(lastRate)) < CONVERGENCE;\n } else {\n hasConverged = true;\n }\n } while (!hasConverged && i < MAX_ITERATIONS);\n\n if (!hasConverged) {\n rate = Double.NaN;\n logger.log(Level.INFO, \"IRR calculation did not converge. Data: {0}\", cashFlows);\n }\n\n return rate;\n }\n\n /**\n * Calculate the net present value of the cash flow.\n *\n * @param referenceDate the NPV is relative to this date\n * @param rate the discount rate\n * @return the net present value\n */\n private double netPresentValue(final LocalDate referenceDate, final double rate) {\n double npv = 0;\n\n for (final CashFlowItem item : cashFlows) {\n double timeDifference = referenceDate.until(item.date, DAYS) / DAYS_PER_YEAR;\n npv += item.amount.doubleValue() / StrictMath.pow(1 + rate, timeDifference);\n }\n\n return npv;\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/CommodityNode.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport javax.persistence.Entity;\nimport java.math.BigDecimal;\n\nimport jgnash.util.NotNull;\n\n/**\n * Abstract class for representing a commodity.\n * \n * @author Craig Cavanaugh\n */\n@Entity\npublic abstract class CommodityNode extends StoredObject implements Comparable {\n\n private String symbol;\n\n private byte scale = 2;\n\n private String prefix = \"\";\n\n private String suffix = \"\";\n\n private String description;\n\n public void setScale(final byte scale) {\n this.scale = scale;\n }\n\n public byte getScale() {\n return scale;\n }\n\n public void setSymbol(final String symbol) {\n this.symbol = symbol;\n }\n\n public String getSymbol() {\n return symbol;\n }\n\n public void setDescription(final String description) {\n this.description = description;\n }\n\n public String getDescription() {\n return description;\n }\n\n public void setPrefix(final String prefix) {\n this.prefix = prefix;\n }\n\n public String getPrefix() {\n return prefix;\n }\n\n public void setSuffix(final String suffix) {\n this.suffix = suffix;\n }\n\n public String getSuffix() {\n return suffix;\n }\n\n @Override\n public String toString() {\n if (description != null) {\n return symbol + \" (\" + description + ')';\n }\n return symbol;\n }\n\n @Override\n public int compareTo(@NotNull final CommodityNode node) {\n return symbol.compareTo(node.symbol);\n }\n\n @Override\n public boolean equals(final Object other) {\n return this == other || other instanceof CommodityNode && getUuid().equals(((CommodityNode) other).getUuid());\n }\n\n /**\n * Determines if given node matches this node.\n * \n * The UUID is not used for comparison if equals fails.\n * \n * @param other CurrencyNode to compare against\n * @return true if objects match\n */\n public boolean matches(final CommodityNode other) {\n boolean result = equals(other);\n\n if (!result) {\n result = getSymbol().equals(other.getSymbol());\n }\n return result;\n }\n\n /**\n * Rounds a supplied double to the correct scale and returns a BigDecimal.\n * \n * @param value double to round\n * @return properly scaled BigDecimal\n */\n public BigDecimal round(final double value) {\n return new BigDecimal(value).setScale(scale, MathConstants.roundingMode);\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/Comparators.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.io.Serializable;\nimport java.time.LocalDate;\nimport java.util.*;\n\n/**\n * Utility class consisting of {@code Comparators} useful for sorting lists of {@code StoredObject}\n * with the same and mixed inheritance.\n *\n * @author Craig Cavanaugh\n */\npublic class Comparators {\n\n public static Comparator getAccountByCode() {\n return new AccountByCode();\n }\n\n public static Comparator getAccountByName() {\n return new AccountByName();\n }\n\n public static Comparator getAccountByPathName() {\n return new AccountByPathName();\n }\n\n public static Comparator getAccountByBalance(LocalDate startDate, LocalDate endDate, CurrencyNode currency, boolean ascending) {\n return new AccountByBalance(startDate, endDate, currency, ascending);\n }\n\n /**\n * Sort {@code Account}s according to their position in the account tree. Parent accounts are\n * sorted before their children.\n *\n * @param subComparator defines the sort order of accounts which have the same parent account\n * @return the {@code Comparator}\n */\n public static Comparator getAccountByTreePosition(Comparator subComparator) {\n return new AccountByTreePosition(subComparator);\n }\n\n private static class AccountByCode implements Comparator, Serializable {\n\n @Override\n public int compare(final Account a1, final Account a2) {\n\n // Sort by account code first\n int result = Integer.compare(a1.getAccountCode(), a2.getAccountCode());\n if (result != 0) {\n return result;\n }\n\n return a1.getName().compareTo(a2.getName());\n }\n }\n\n private static class AccountByName implements Comparator, Serializable {\n\n @Override\n public int compare(final Account a1, final Account a2) {\n return a1.getName().compareTo(a2.getName());\n }\n }\n\n private static class AccountByPathName implements Comparator, Serializable {\n\n @Override\n public int compare(Account a1, Account a2) {\n return a1.getPathName().compareTo(a2.getPathName());\n }\n }\n\n private static class AccountByBalance implements Comparator, Serializable {\n\n private final LocalDate startDate;\n\n private final LocalDate endDate;\n\n private final boolean ascending;\n\n private final CurrencyNode currency;\n\n AccountByBalance(final LocalDate startDate, final LocalDate endDate, CurrencyNode currency, boolean ascending) {\n this.startDate = startDate;\n this.endDate = endDate;\n this.currency = currency;\n this.ascending = ascending;\n }\n\n @Override\n public int compare(Account a1, Account a2) {\n int result = a1.getBalance(startDate, endDate, currency)\n .compareTo(a2.getBalance(startDate, endDate, currency));\n if (!ascending) {\n result *= -1;\n }\n return result;\n }\n }\n\n private static class AccountByTreePosition implements Comparator, Serializable {\n\n private final Comparator subComparator;\n\n AccountByTreePosition(final Comparator subComparator) {\n this.subComparator = subComparator;\n }\n\n private static Deque accountPath(Account acc) {\n final Deque path = new LinkedList<>();\n\n while (acc != null) {\n path.addFirst(acc);\n acc = acc.getParent();\n }\n return path;\n }\n\n @Override\n public int compare(final Account a1, final Account a2) {\n final Deque path1 = accountPath(a1);\n final Deque path2 = accountPath(a2);\n\n // find the first non-common ancestors\n Account pa1, pa2;\n\n do {\n pa1 = path1.pollFirst();\n pa2 = path2.pollFirst();\n } while (pa1 != null && pa1.equals(pa2));\n\n if (pa1 == null && pa2 == null) {\n // this can only happen if a1 equals a2\n return 0;\n }\n\n // if one of the paths ended, this is an ancestor of the other one, so sort it first;\n // otherwise, let the subComparator decide on the same-level ancestors\n return (pa1 == null) ? -1 : (pa2 == null) ? 1 : subComparator.compare(pa1, pa2);\n }\n\n }\n\n /**\n * Explicit order Comparator.\n *\n * @param object type that is being sorted\n */\n public static class ExplicitComparator implements Comparator, Serializable {\n\n final List order = new ArrayList<>();\n\n @SafeVarargs\n public ExplicitComparator(final T... objects) {\n Collections.addAll(order, objects);\n }\n\n @Override\n public int compare(final T t1, final T t2) {\n return Integer.compare(order.indexOf(t1), order.indexOf(t2));\n }\n }\n\n private Comparators() {\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/Config.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.time.LocalDateTime;\nimport java.util.ArrayList;\nimport java.util.HashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.ResourceBundle;\nimport java.util.concurrent.locks.ReadWriteLock;\nimport java.util.concurrent.locks.ReentrantReadWriteLock;\n\nimport javax.persistence.CascadeType;\nimport javax.persistence.Column;\nimport javax.persistence.ElementCollection;\nimport javax.persistence.Entity;\nimport javax.persistence.ManyToOne;\nimport javax.persistence.PostLoad;\n\nimport jgnash.resource.util.ResourceUtils;\nimport jgnash.util.NotNull;\nimport jgnash.util.Nullable;\n\n/**\n * A general configuration class so that global configuration information may be stored inside the database.\n *\n * @author Craig Cavanaugh\n */\n@Entity\npublic class Config extends StoredObject {\n\n private static final String CREATE_BACKUPS = \"CreateBackups\";\n\n private static final String MAX_BACKUPS = \"MaxBackups\";\n\n private static final String REMOVE_BACKUPS = \"RemoveBackups\";\n\n private static final String LAST_SECURITIES_UPDATE_TIMESTAMP = \"LastSecuritiesUpdateTimestamp\";\n\n private static final int MAX_BACKUPS_DEFAULT = 5;\n\n @ManyToOne(cascade = CascadeType.PERSIST)\n private CurrencyNode defaultCurrency;\n\n private String accountSeparator = \":\";\n\n /**\n * Current file format\n */\n private String fileFormat = Engine.CURRENT_MAJOR_VERSION + \".\" + Engine.CURRENT_MINOR_VERSION;\n\n private transient ReadWriteLock preferencesLock;\n\n /**\n * Contains a list a items to display in the transaction number combo.\n */\n @ElementCollection\n private final List transactionNumberItems = new ArrayList<>();\n\n /**\n * {@code Map} for file based operation preferences.\n * \n * GUI locations, last used accounts, etc\n * should not be stored here as they will be dependent on the user.\n * Only values required for operation consistency should be stored here.\n */\n @ElementCollection\n @Column(columnDefinition = \"varchar(8192)\")\n private final Map preferences = new HashMap<>();\n\n public Config() {\n preferencesLock = new ReentrantReadWriteLock(true);\n }\n\n void initialize() {\n Account.setAccountSeparator(getAccountSeparator());\n }\n\n public String getFileFormat() {\n return fileFormat;\n }\n\n int getMajorFileFormatVersion() {\n return Integer.parseInt(getFileFormat().split(\"\\\\.\")[0]);\n }\n\n int getMinorFileFormatVersion() {\n return Integer.parseInt(getFileFormat().split(\"\\\\.\")[1]);\n }\n\n void updateFileVersion() {\n this.fileFormat = Engine.CURRENT_MAJOR_VERSION + \".\" + Engine.CURRENT_MINOR_VERSION;\n }\n\n void setDefaultCurrency(final CurrencyNode defaultCurrency) {\n this.defaultCurrency = defaultCurrency;\n }\n\n CurrencyNode getDefaultCurrency() {\n return defaultCurrency;\n }\n\n void setAccountSeparator(final String accountSeparator) {\n this.accountSeparator = accountSeparator;\n Account.setAccountSeparator(this.accountSeparator);\n }\n\n String getAccountSeparator() {\n return accountSeparator;\n }\n\n void setTransactionNumberList(final List transactionNumberItems) {\n if (transactionNumberItems != null) {\n this.transactionNumberItems.clear();\n this.transactionNumberItems.addAll(transactionNumberItems);\n }\n }\n\n List getTransactionNumberList() {\n if (transactionNumberItems.isEmpty()) {\n final ResourceBundle rb = ResourceUtils.getBundle();\n\n transactionNumberItems.add(rb.getString(\"Item.EFT\"));\n transactionNumberItems.add(rb.getString(\"Item.Trans\"));\n }\n return new ArrayList<>(transactionNumberItems);\n }\n\n void setPreference(@NotNull final String key, @Nullable final String value) {\n\n preferencesLock.writeLock().lock();\n\n try {\n if (key.isEmpty()) {\n throw new RuntimeException(ResourceUtils.getString(\"Message.Error.EmptyKey\"));\n }\n\n if (value == null) { // find and remove\n preferences.remove(key);\n } else {\n preferences.put(key, value);\n }\n } finally {\n preferencesLock.writeLock().unlock();\n }\n }\n\n @Nullable\n String getPreference(@NotNull final String key) {\n preferencesLock.readLock().lock();\n\n try {\n if (key.isEmpty()) {\n throw new RuntimeException(ResourceUtils.getString(\"Message.Error.EmptyKey\"));\n }\n\n return preferences.get(key);\n } finally {\n preferencesLock.readLock().unlock();\n }\n }\n\n boolean createBackups() {\n final String result = getPreference(CREATE_BACKUPS);\n\n return result == null || Boolean.parseBoolean(result);\n }\n\n void setCreateBackups(final boolean createBackups) {\n setPreference(CREATE_BACKUPS, Boolean.toString(createBackups));\n }\n\n int getRetainedBackupLimit() {\n final String result = getPreference(MAX_BACKUPS);\n\n if (result != null) {\n return Integer.parseInt(result);\n }\n\n return MAX_BACKUPS_DEFAULT;\n }\n\n void setRetainedBackupLimit(final int retainedBackupLimit) {\n setPreference(MAX_BACKUPS, Integer.toString(retainedBackupLimit));\n }\n\n boolean removeOldBackups() {\n final String result = getPreference(REMOVE_BACKUPS);\n\n return result == null || Boolean.parseBoolean(result);\n }\n\n void setRemoveOldBackups(final boolean removeOldBackups) {\n setPreference(REMOVE_BACKUPS, Boolean.toString(removeOldBackups));\n }\n\n void setLastSecuritiesUpdateTimestamp(@NotNull final LocalDateTime localDateTime) {\n setPreference(LAST_SECURITIES_UPDATE_TIMESTAMP, localDateTime.toString());\n }\n\n @NotNull\n LocalDateTime getLastSecuritiesUpdateTimestamp() {\n final String result = getPreference(LAST_SECURITIES_UPDATE_TIMESTAMP);\n\n if (result != null) {\n return LocalDateTime.parse(result);\n }\n\n return LocalDateTime.MIN;\n }\n\n /**\n * Required by XStream for proper initialization.\n *\n * @return Properly initialized Config object\n */\n protected Object readResolve() {\n postLoad();\n return this;\n }\n\n @PostLoad\n private void postLoad() {\n preferencesLock = new ReentrantReadWriteLock(true);\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/CurrencyNode.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.util.logging.Logger;\n\nimport javax.persistence.Entity;\n\n/**\n * Class for representing currency nodes.\n * \n * @author Craig Cavanaugh\n */\n@Entity\npublic class CurrencyNode extends CommodityNode {\n\n private transient ExchangeRateDAO exchangeRateDAO;\n\n public CurrencyNode() {\n }\n\n /**\n * Returns the {@code ExchangeRateDAO}.\n *\n * @return the exchangeRateStore\n */\n synchronized private ExchangeRateDAO getExchangeRateDAO() {\n return exchangeRateDAO;\n }\n\n /**\n * Sets the {@code ExchangeRateDAO}.\n *\n * @param exchangeRateStore the exchangeRateStore to set\n */\n synchronized void setExchangeRateDAO(final ExchangeRateDAO exchangeRateStore) {\n this.exchangeRateDAO = exchangeRateStore;\n }\n\n /**\n * Returns an exchange rate given a currency to convert to.\n * \n * @param exchangeCurrency currency to convert to\n * @return exchange rate\n */\n synchronized public BigDecimal getExchangeRate(final CurrencyNode exchangeCurrency) {\n\n if (exchangeCurrency == null) {\n Logger.getLogger(CurrencyNode.class.getName()).severe(\"exchangeCurrency was null\");\n return BigDecimal.ONE;\n }\n\n if (exchangeCurrency.equals(this)) {\n return BigDecimal.ONE;\n }\n\n BigDecimal rate = getExchangeRateDAO().getExchangeRateNode(this, exchangeCurrency).getRate();\n\n if (getSymbol().compareToIgnoreCase(exchangeCurrency.getSymbol()) < 0) {\n rate = BigDecimal.ONE.divide(rate, MathConstants.mathContext);\n }\n\n return rate;\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/DataStore.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.io.IOException;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.util.Collection;\nimport java.util.function.DoubleConsumer;\n\nimport jgnash.util.NotNull;\n\n/**\n * Interface for data storage backends.\n *\n * @author Craig Cavanaugh\n */\npublic interface DataStore {\n\n /**\n * Close the engine instance if open.\n */\n void closeEngine();\n\n /**\n * Create an engine instance connected to a remote server.\n * \n * @param host host name or IP address\n * @param port connection port\n * @param password user password\n * @param engineName unique name to give the engine instance\n * @return Engine instance if a successful connection is made\n */\n Engine getClientEngine(final String host, final int port, final char[] password, final String engineName);\n\n /**\n * Create an engine instance that uses a file.\n * \n * @param fileName full path to the file\n * @param engineName unique name to give the engine instance\n * @param password user password\n * @return Engine instance. A new file will be created if it does not exist\n */\n Engine getLocalEngine(final String fileName, final String engineName, final char[] password);\n\n /**\n * Returns the default file extension for this DataStore.\n * \n * @return file extension\n */\n @NotNull\n String getFileExt();\n\n /**\n * Returns the full path to the file the DataStore is using.\n * \n * @return full path to the file, null if this is a remotely connected DataStore\n */\n String getFileName();\n\n /**\n * Returns this DataStores type.\n *\n * @return type of data store\n */\n DataStoreType getType();\n\n /**\n * Local / Remote connection indicator.\n * \n * @return false if connected to a remote server\n */\n boolean isLocal();\n\n /**\n * Saves a Collection of StoredObjects to a file other than what is currently open.\n * \n * The currently open file will not be closed.\n * @param path full path to the file to save the database to\n * @param objects Collection of StoredObjects to save\n * @param percentComplete callback to report the percent complete\n */\n void saveAs(Path path, Collection objects, DoubleConsumer percentComplete);\n\n /**\n * Renames a datastore.\n *\n * @param fileName name of the datastore to rename\n * @param newFileName the new filename\n * @throws java.io.IOException if an I/O error occurs\n */\n default void rename(final String fileName, final String newFileName) throws IOException {\n final Path path = Paths.get(fileName);\n\n if (Files.exists(path)) {\n Files.move(path, Paths.get(newFileName));\n }\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/DataStoreType.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport jgnash.engine.jpa.JpaH2DataStore;\nimport jgnash.engine.jpa.JpaH2MvDataStore;\nimport jgnash.engine.jpa.JpaHsqlDataStore;\nimport jgnash.engine.xstream.BinaryXStreamDataStore;\nimport jgnash.engine.xstream.XMLDataStore;\nimport jgnash.resource.util.ResourceUtils;\n\nimport java.lang.reflect.InvocationTargetException;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\n/**\n * Storage type enumeration.\n *\n * @author Craig Cavanaugh\n */\npublic enum DataStoreType {\n\n BINARY_XSTREAM(\n ResourceUtils.getString(\"DataStoreType.Bxds\"),\n false,\n BinaryXStreamDataStore.class),\n H2_DATABASE (\n ResourceUtils.getString(\"DataStoreType.H2\") + \" (1.3)\",\n true,\n JpaH2DataStore.class),\n H2MV_DATABASE (\n ResourceUtils.getString(\"DataStoreType.H2\") + \" (1.4)\",\n true,\n JpaH2MvDataStore.class),\n HSQL_DATABASE (\n ResourceUtils.getString(\"DataStoreType.HSQL\"),\n true,\n JpaHsqlDataStore.class),\n XML(\n ResourceUtils.getString(\"DataStoreType.XML\"),\n false,\n XMLDataStore.class);\n\n\n /* If true, then this DataStoreType can support remote connections */\n public final transient boolean supportsRemote;\n\n private final transient String description;\n\n private final transient Class dataStore;\n\n DataStoreType(final String description, final boolean supportsRemote, final Class dataStore) {\n this.description = description;\n this.supportsRemote = supportsRemote;\n this.dataStore = dataStore;\n }\n\n public DataStore getDataStore() {\n try {\n return dataStore.getDeclaredConstructor().newInstance();\n } catch (InstantiationException | IllegalAccessException | IllegalArgumentException | InvocationTargetException\n | NoSuchMethodException | SecurityException ex) {\n Logger.getLogger(DataStoreType.class.getName()).log(Level.SEVERE, null, ex);\n\n throw new RuntimeException(ex);\n }\n }\n\n @Override\n public String toString() {\n return description;\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/DefaultCurrencies.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2021 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.text.DecimalFormatSymbols;\nimport java.text.NumberFormat;\nimport java.util.Currency;\nimport java.util.Locale;\nimport java.util.Set;\nimport java.util.TreeSet;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\n/**\n * Static methods for currency generation and discovery.\n * \n * These are known to not show up because Java 1.4.2 and older does not have\n * a default NumberFormat defined for the currency:\n *
\n * {@code\n * \"SGD\"\n * \"MYR\"\n * }\n *\n * @author Craig Cavanaugh\n */\npublic class DefaultCurrencies {\n\n /**\n * Private Constructor, use static methods only.\n */\n private DefaultCurrencies() {\n }\n\n /**\n * Generates an array of default currency nodes that Java knows about.\n *\n * @return An array of default CurrencyNodes\n */\n public static Set generateCurrencies() {\n TreeSet set = new TreeSet<>();\n\n for (Locale locale : NumberFormat.getAvailableLocales()) {\n\n // only try if a valid county length is returned\n if (locale.getCountry().length() == 2) {\n try {\n if (Currency.getInstance(locale) != null) {\n set.add(buildNode(locale));\n }\n } catch (final IllegalArgumentException ignored) {\n // ignored, locale is not a supported ISO 3166 country code\n } catch (final Exception ex) {\n Logger.getLogger(DefaultCurrencies.class.getName()).log(Level.SEVERE, null, ex);\n }\n }\n }\n\n return set;\n }\n\n /**\n * Creates a custom CurrencyNode given an ISO code. If the ISO code is\n * not valid, then a node will be generated using the supplied code. The\n * locale is assumed to be the default locale.\n *\n * @param ISOCode The custom currency to generate\n * @return The custom CurrencyNode\n */\n public static CurrencyNode buildCustomNode(final String ISOCode) {\n final CurrencyNode node = new CurrencyNode();\n Currency c;\n\n try {\n c = Currency.getInstance(ISOCode);\n node.setSymbol(c.getCurrencyCode());\n } catch (Exception e) {\n node.setSymbol(ISOCode);\n Logger.getLogger(DefaultCurrencies.class.getName()).log(Level.FINE, null, e);\n } finally {\n node.setDescription(Locale.getDefault().toString());\n }\n return node;\n }\n\n /**\n * Creates a valid CurrencyNode given a locale.\n *\n * @param locale Locale to create a CurrencyNode for\n * @return The new CurrencyNode\n */\n public static CurrencyNode buildNode(final Locale locale) {\n DecimalFormatSymbols symbols = new DecimalFormatSymbols(locale);\n Currency c = symbols.getCurrency();\n\n CurrencyNode node = new CurrencyNode();\n node.setSymbol(c.getCurrencyCode());\n node.setPrefix(symbols.getCurrencySymbol());\n\n byte scale = (byte) c.getDefaultFractionDigits();\n\n if (scale == -1) { // The JVM may return a negative value for some Locales\n scale = 0; // scale may be -1, but this is not allowed for CurrencyNodes\n }\n\n node.setScale(scale);\n\n return node;\n }\n\n /**\n * Generates the default CurrencyNode for the current locale.\n *\n * @return The new CurrencyNode\n */\n public static CurrencyNode getDefault() {\n try {\n return buildNode(Locale.getDefault());\n } catch (final Exception e) {\n return buildNode(Locale.US);\n }\n }\n}"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/Engine.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.io.IOException;\nimport java.math.BigDecimal;\nimport java.nio.file.Path;\nimport java.time.DayOfWeek;\nimport java.time.LocalDate;\nimport java.time.LocalDateTime;\nimport java.time.temporal.ChronoUnit;\nimport java.util.ArrayList;\nimport java.util.Collection;\nimport java.util.Collections;\nimport java.util.HashSet;\nimport java.util.List;\nimport java.util.Objects;\nimport java.util.Optional;\nimport java.util.ResourceBundle;\nimport java.util.Set;\nimport java.util.UUID;\nimport java.util.concurrent.Callable;\nimport java.util.concurrent.CompletionService;\nimport java.util.concurrent.ExecutionException;\nimport java.util.concurrent.ExecutorCompletionService;\nimport java.util.concurrent.ExecutorService;\nimport java.util.concurrent.Future;\nimport java.util.concurrent.RejectedExecutionException;\nimport java.util.concurrent.ScheduledThreadPoolExecutor;\nimport java.util.concurrent.TimeUnit;\nimport java.util.concurrent.atomic.AtomicInteger;\nimport java.util.concurrent.locks.ReentrantReadWriteLock;\nimport java.util.function.Function;\nimport java.util.logging.Handler;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.stream.Collectors;\nimport java.util.stream.Stream;\n\nimport jgnash.engine.attachment.AttachmentManager;\nimport jgnash.engine.budget.Budget;\nimport jgnash.engine.budget.BudgetGoal;\nimport jgnash.engine.concurrent.LockManager;\nimport jgnash.engine.dao.AccountDAO;\nimport jgnash.engine.dao.BudgetDAO;\nimport jgnash.engine.dao.CommodityDAO;\nimport jgnash.engine.dao.ConfigDAO;\nimport jgnash.engine.dao.EngineDAO;\nimport jgnash.engine.dao.RecurringDAO;\nimport jgnash.engine.dao.TransactionDAO;\nimport jgnash.engine.dao.TrashDAO;\nimport jgnash.engine.message.ChannelEvent;\nimport jgnash.engine.message.Message;\nimport jgnash.engine.message.MessageBus;\nimport jgnash.engine.message.MessageChannel;\nimport jgnash.engine.message.MessageProperty;\nimport jgnash.engine.recurring.MonthlyReminder;\nimport jgnash.engine.recurring.PendingReminder;\nimport jgnash.engine.recurring.RecurringIterator;\nimport jgnash.engine.recurring.Reminder;\nimport jgnash.net.currency.CurrencyUpdateFactory;\nimport jgnash.net.security.UpdateFactory;\nimport jgnash.resource.util.ResourceUtils;\nimport jgnash.time.DateUtils;\nimport jgnash.util.DefaultDaemonThreadFactory;\nimport jgnash.util.NotNull;\nimport jgnash.util.Nullable;\n\nimport org.apache.commons.collections4.ListUtils;\n\n/**\n * Engine class\n * \n * When objects are removed, they are wrapped in a TrashObject so they may still be referenced for messaging and cleanup\n * operations. After a predefined period of time, they are permanently removed.\n *\n * @author Craig Cavanaugh\n */\npublic class Engine {\n\n /**\n * Current version for the file format.\n */\n public static final int CURRENT_MAJOR_VERSION = 3;\n\n public static final int CURRENT_MINOR_VERSION = 6;\n\n // Lock name\n private static final String BIG_LOCK = \"bigLock\";\n\n private static final Logger logger = Logger.getLogger(Engine.class.getName());\n\n private static final long MAXIMUM_TRASH_AGE = 2L * 60L * 1000L; // 2 minutes\n\n /**\n * The maximum number of network errors before scheduled tasks are stopped.\n */\n private static final short MAX_ERRORS = 2;\n\n /**\n * Time in seconds to delay start of background updates.\n */\n private static final int SCHEDULED_DELAY = 30;\n\n /**\n * Time is seconds for a forced shutdown of background services\n */\n private static final int FORCED_SHUTDOWN_TIMEOUT = 15;\n\n private static final String MESSAGE_ACCOUNT_MODIFY = \"Message.AccountModify\";\n\n private static final String COMMODITY = \"Commodity \";\n\n static {\n logger.setLevel(Level.ALL);\n }\n\n private final ResourceBundle rb = ResourceUtils.getBundle();\n\n /**\n * Primary lock for any operation that alters or reads data\n */\n private final ReentrantReadWriteLock dataLock;\n\n private final AtomicInteger backGroundCounter = new AtomicInteger();\n /**\n * Named identifier for this engine instance.\n */\n private final String name;\n /**\n * Unique identifier for this engine instance.\n * Used by this distributed lock manager to keep track of who has a lock\n */\n private final String uuid = UUID.randomUUID().toString();\n\n private final EngineDAO eDAO;\n\n private final AttachmentManager attachmentManager;\n\n /**\n * Background executor service for trash management and currency / security updates\n */\n private final ScheduledThreadPoolExecutor backgroundExecutorService;\n\n /**\n * All engine instances will share the same message bus.\n */\n private final MessageBus messageBus;\n\n /**\n * Cached for performance.\n */\n private Config config;\n\n /**\n * Cached for performance.\n */\n private RootAccount rootAccount;\n\n private ExchangeRateDAO exchangeRateDAO;\n\n /**\n * Cached for performance.\n */\n private String accountSeparator = null;\n\n public Engine(final EngineDAO eDAO, final LockManager lockManager, final AttachmentManager attachmentManager, final String name) {\n Objects.requireNonNull(name, \"The engine name may not be null\");\n Objects.requireNonNull(eDAO, \"The engineDAO may not be null\");\n\n logger.log(Level.INFO, \"Release {0}.{1}\", new Object[]{CURRENT_MAJOR_VERSION, CURRENT_MINOR_VERSION});\n\n this.attachmentManager = attachmentManager;\n this.eDAO = eDAO;\n this.name = name;\n\n // Generate lock\n dataLock = lockManager.getLock(BIG_LOCK);\n\n messageBus = MessageBus.getInstance(name);\n\n initialize();\n\n checkAndCorrect();\n\n backgroundExecutorService = new ScheduledThreadPoolExecutor(1,\n new DefaultDaemonThreadFactory(\"Engine Background Executor\"));\n backgroundExecutorService.setRemoveOnCancelPolicy(true);\n backgroundExecutorService.setExecuteExistingDelayedTasksAfterShutdownPolicy(false);\n\n // run trash cleanup every 5 minutes 45 seconds after startup\n backgroundExecutorService.scheduleWithFixedDelay(() -> {\n if (!Thread.currentThread().isInterrupted()) {\n emptyTrash();\n }\n }, 45, 5L * 60L, TimeUnit.SECONDS);\n\n backgroundExecutorService.schedule(() -> {\n if (UpdateFactory.getUpdateOnStartup()) {\n // don't update on weekends unless needed\n if (UpdateFactory.shouldAutomaticUpdateOccur(getConfig().getLastSecuritiesUpdateTimestamp())) {\n startSecuritiesUpdate(SCHEDULED_DELAY);\n }\n }\n }, 30, TimeUnit.SECONDS);\n\n backgroundExecutorService.schedule(() -> {\n if (CurrencyUpdateFactory.getUpdateOnStartup()) {\n startExchangeRateUpdate(SCHEDULED_DELAY);\n }\n }, 30, TimeUnit.SECONDS);\n }\n\n boolean isFileDirty() {\n return eDAO.isDirty() || getAccountDAO().isDirty() || getBudgetDAO().isDirty() || getCommodityDAO().isDirty()\n || getConfigDAO().isDirty() || getReminderDAO().isDirty() || getTransactionDAO().isDirty()\n || getTrashDAO().isDirty();\n }\n\n /**\n * Registers a {@code Handler} with the class logger.\n * This also ensures the static logger is initialized.\n *\n * @param handler {@code Handler} to register\n */\n public static void addLogHandler(final Handler handler) {\n logger.addHandler(handler);\n }\n\n /**\n * Returns the most current known market price for a requested date. The {@code SecurityNode} history will be\n * searched for an exact match first. If an exact match is not found, investment transactions will be searched\n * for the closest requested date. {@code SecurityHistoryNode} history values will take precedent over\n * a transaction with the same closest or matching date.\n *\n * @param transactions Collection of transactions utilizing the requested investment\n * @param node {@code SecurityNode} we want a price for\n * @param baseCurrency {@code CurrencyNode} reporting currency\n * @param localDate {@code LocalDate} we want a market price for\n * @return The best market price or a value of 0 if no history or transactions exist\n */\n public static BigDecimal getMarketPrice(final Collection transactions, final SecurityNode node,\n final CurrencyNode baseCurrency, final LocalDate localDate) {\n\n // Search for the exact history node record\n Optional optional = node.getHistoryNode(localDate);\n\n // not null, must be an exact match, return the value because it has precedence\n if (optional.isPresent()) {\n return node.getMarketPrice(localDate, baseCurrency);\n }\n\n // Nothing found yet, continue searching for something better\n LocalDate priceDate = LocalDate.ofEpochDay(0);\n BigDecimal price = BigDecimal.ZERO;\n\n optional = node.getClosestHistoryNode(localDate);\n\n if (optional.isPresent()) { // Closest option so far\n price = optional.get().getPrice();\n priceDate = optional.get().getLocalDate();\n }\n\n // Compare against transactions\n for (final Transaction t : transactions) {\n if (t instanceof InvestmentTransaction && ((InvestmentTransaction) t).getSecurityNode() == node) {\n\n // The transaction date must be closer than the history node, but not newer than the request date\n if ((t.getLocalDate().isAfter(priceDate) && t.getLocalDate().isBefore(localDate)) || t.getLocalDate().equals(localDate)) {\n\n // Check for a dividend, etc that may have returned a price of zero\n final BigDecimal p = ((InvestmentTransaction) t).getPrice();\n\n if (p != null && p.compareTo(BigDecimal.ZERO) > 0) {\n price = p;\n priceDate = t.getLocalDate();\n }\n }\n }\n }\n\n // Get the current exchange rate for the security node\n final BigDecimal rate = node.getReportedCurrencyNode().getExchangeRate(baseCurrency);\n\n // return the price and factor in the exchange rate\n return price.multiply(rate);\n }\n\n static String buildExchangeRateId(final CurrencyNode baseCurrency, final CurrencyNode exchangeCurrency) {\n\n String rateId;\n if (baseCurrency.getSymbol().compareToIgnoreCase(exchangeCurrency.getSymbol()) > 0) {\n rateId = baseCurrency.getSymbol() + exchangeCurrency.getSymbol();\n } else {\n rateId = exchangeCurrency.getSymbol() + baseCurrency.getSymbol();\n }\n return rateId;\n }\n\n /**\n * Returns the engine logger.\n *\n * @return the engine logger\n */\n public static Logger getLogger() {\n return logger;\n }\n\n /**\n * Log a informational message.\n *\n * @param message message to display\n */\n private static void logInfo(final String message) {\n logger.log(Level.INFO, message);\n }\n\n /**\n * Log a warning message.\n *\n * @param message message to display\n */\n private static void logWarning(final String message) {\n logger.warning(message);\n }\n\n /**\n * Log a severe message.\n *\n * @param message message to display\n */\n private static void logSevere(final String message) {\n logger.severe(message);\n }\n\n private static void shutDownAndWait(final ExecutorService executorService) {\n executorService.shutdownNow();\n\n try {\n if (!executorService.awaitTermination(FORCED_SHUTDOWN_TIMEOUT, TimeUnit.SECONDS)) {\n\n if (!executorService.awaitTermination(FORCED_SHUTDOWN_TIMEOUT, TimeUnit.SECONDS)) {\n logSevere(\"Unable to shutdown background service\");\n }\n }\n\n } catch (final InterruptedException e) {\n executorService.shutdownNow();\n Thread.currentThread().interrupt();\n\n logger.log(Level.FINEST, e.getLocalizedMessage(), e);\n }\n }\n\n /**\n * Initiates a background exchange rate update with a given start delay.\n *\n * @param delay delay in seconds\n */\n public void startExchangeRateUpdate(final int delay) {\n backgroundExecutorService.schedule(new BackgroundCallable(new CurrencyUpdateFactory.UpdateExchangeRatesCallable()), delay,\n TimeUnit.SECONDS);\n }\n\n /**\n * Initiates a background securities history update with a given start delay.\n *\n * @param delay delay in seconds\n */\n public void startSecuritiesUpdate(final int delay) {\n final List callables = new ArrayList<>();\n\n getSecurities().stream().filter(securityNode ->\n securityNode.getQuoteSource() != QuoteSource.NONE).forEach(securityNode -> { // failure will occur if source is not defined\n\n callables.add(new BackgroundCallable(new UpdateFactory.UpdateSecurityNodeCallable(securityNode)));\n callables.add(new BackgroundCallable(new UpdateFactory.UpdateSecurityNodeEventsCallable(securityNode)));\n });\n\n // Cleanup thread that monitors for excess network connection failures\n new SecuritiesUpdateRunnable(callables, delay).start();\n\n // Save the last update\n config.setLastSecuritiesUpdateTimestamp(LocalDateTime.now());\n }\n\n /**\n * Creates a RootAccount and default currency only if necessary.\n */\n private void initialize() {\n\n dataLock.writeLock().lock();\n\n try {\n\n // ask the Config object to perform any needed configuration\n getConfig().initialize();\n\n // build the exchange rate storage object\n exchangeRateDAO = new ExchangeRateDAO(getCommodityDAO());\n\n // assign the exchange rate store to the currencies\n for (final CurrencyNode node : getCurrencies()) {\n node.setExchangeRateDAO(exchangeRateDAO);\n }\n\n // obtain or establish the root account\n RootAccount root = getRootAccount();\n\n if (root == null) {\n CurrencyNode node = getDefaultCurrency();\n\n if (node == null) {\n node = DefaultCurrencies.getDefault();\n node.setExchangeRateDAO(exchangeRateDAO);\n\n addCurrency(node); // force the node to persisted\n }\n\n root = new RootAccount(node);\n root.setName(rb.getString(\"Name.Root\"));\n root.setDescription(rb.getString(\"Name.Root\"));\n\n logInfo(\"Creating RootAccount\");\n\n if (!getAccountDAO().addRootAccount(root)) {\n logSevere(\"Was not able to add the root account\");\n throw new EngineException(\"Was not able to add the root account\");\n }\n\n if (getDefaultCurrency() == null) {\n setDefaultCurrency(node);\n }\n }\n\n } finally {\n dataLock.writeLock().unlock();\n }\n\n logInfo(\"Engine initialization is complete\");\n }\n\n /**\n * Corrects minor issues with a database that may occur because of prior bugs or file format upgrades.\n */\n private void checkAndCorrect() {\n dataLock.writeLock().lock();\n\n try {\n // check and correct multiple root accounts from old files... there are still a few.\n List accountList = getAccountList().stream().filter(account -> account.getAccountType()\n .equals(AccountType.ROOT)).collect(Collectors.toList());\n\n if (accountList.size() > 1) {\n for (Account account : accountList) {\n if (account.getChildCount() == 0) {\n removeAccount(account);\n logWarning(\"Removed an extra / empty root account\");\n }\n }\n }\n\n final List list = eDAO.getStoredObjects(Config.class);\n if (list.size() > 1) {\n // Delete all but the first found config object\n for (int i = 1; i < list.size(); i++) {\n logWarning(\"Removed an extra Config object\");\n moveObjectToTrash(list.get(i));\n }\n }\n\n // Transaction timestamps were updated for release 2.25\n if (getConfig().getMinorFileFormatVersion() < 25 && getConfig().getMajorFileFormatVersion() < 3) {\n // Update transactions in chunks of 200\n ListUtils.partition(getTransactions(), 200).forEach(eDAO::bulkUpdate);\n }\n\n // update the file version if it is not current\n if (getConfig().getMajorFileFormatVersion() != CURRENT_MAJOR_VERSION\n || getConfig().getMinorFileFormatVersion() != CURRENT_MINOR_VERSION) {\n\n final Config localConfig = getConfig();\n localConfig.updateFileVersion();\n getConfigDAO().update(localConfig);\n }\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n private void clearObsoleteExchangeRates() {\n getCommodityDAO().getExchangeRates().stream()\n .filter(rate -> getBaseCurrencies(rate.getRateId()).length == 0)\n .forEach(this::removeExchangeRate);\n }\n\n private void removeExchangeRate(final ExchangeRate rate) {\n dataLock.writeLock().lock();\n\n try {\n for (final ExchangeRateHistoryNode node : rate.getHistory()) {\n removeExchangeRateHistory(rate, node);\n }\n moveObjectToTrash(rate);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n void stopBackgroundServices() {\n logInfo(\"Controlled engine shutdown initiated\");\n\n shutDownAndWait(backgroundExecutorService);\n\n logInfo(\"Background services have been stopped\");\n }\n\n void shutdown() {\n eDAO.shutdown();\n }\n\n public String getName() {\n return name;\n }\n\n private AccountDAO getAccountDAO() {\n return eDAO.getAccountDAO();\n }\n\n private BudgetDAO getBudgetDAO() {\n return eDAO.getBudgetDAO();\n }\n\n private CommodityDAO getCommodityDAO() {\n return eDAO.getCommodityDAO();\n }\n\n private ConfigDAO getConfigDAO() {\n return eDAO.getConfigDAO();\n }\n\n private RecurringDAO getReminderDAO() {\n return eDAO.getRecurringDAO();\n }\n\n private TransactionDAO getTransactionDAO() {\n return eDAO.getTransactionDAO();\n }\n\n private TrashDAO getTrashDAO() {\n return eDAO.getTrashDAO();\n }\n\n private boolean moveObjectToTrash(final Object object) {\n boolean result = false;\n\n dataLock.writeLock().lock();\n\n try {\n if (object instanceof StoredObject) {\n getTrashDAO().add(new TrashObject((StoredObject) object));\n } else { // simple object with an annotated JPA entity id of type long is assumed\n getTrashDAO().addEntityTrash(object);\n }\n result = true;\n } catch (final Exception ex) {\n logger.log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n } finally {\n dataLock.writeLock().unlock();\n }\n\n return result;\n }\n\n /**\n * Empty the trash if any objects are older than the defined time.\n */\n private void emptyTrash() {\n if (backGroundCounter.incrementAndGet() == 1) {\n messageBus.fireEvent(new Message(MessageChannel.SYSTEM, ChannelEvent.BACKGROUND_PROCESS_STARTED,\n Engine.this));\n }\n\n dataLock.writeLock().lock();\n\n try {\n logger.info(\"Checking for trash\");\n\n final List trash = getTrashDAO().getTrashObjects();\n\n /* always sort by the timestamp of the trash object to prevent\n * foreign key removal exceptions when multiple related accounts\n * or objects are removed */\n Collections.sort(trash);\n\n if (trash.isEmpty()) {\n logger.info(\"No trash was found\");\n }\n\n trash.stream().filter(o -> ChronoUnit.MILLIS.between(o.getDate(), LocalDateTime.now()) >= MAXIMUM_TRASH_AGE)\n .forEach(o -> getTrashDAO().remove(o));\n } finally {\n dataLock.writeLock().unlock();\n\n if (backGroundCounter.decrementAndGet() == 0) {\n messageBus.fireEvent(new Message(MessageChannel.SYSTEM, ChannelEvent.BACKGROUND_PROCESS_STOPPED,\n Engine.this));\n }\n }\n }\n\n /**\n * Creates a default reminder given a transaction and the primary account. The Reminder will need to persisted.\n *\n * @param transaction Transaction for the reminder. The transaction will be cloned\n * @param account primary account\n * @return new default {@code MonthlyReminder}\n */\n public static Reminder createDefaultReminder(final Transaction transaction, final Account account) {\n final Reminder reminder = new MonthlyReminder();\n\n try {\n reminder.setAccount(account);\n reminder.setStartDate(transaction.getLocalDate().plusMonths(1));\n reminder.setTransaction((Transaction) transaction.clone());\n reminder.setDescription(transaction.getPayee());\n reminder.setNotes(transaction.getMemo());\n } catch (final CloneNotSupportedException e) {\n logSevere(e.getLocalizedMessage());\n }\n return reminder;\n }\n\n public boolean addReminder(final Reminder reminder) {\n Objects.requireNonNull(reminder.getUuid());\n\n boolean result = false;\n\n // make sure the description has been set\n if (reminder.getDescription() != null && !reminder.getDescription().isBlank()) {\n result = getReminderDAO().addReminder(reminder);\n }\n\n Message message;\n if (result) {\n message = new Message(MessageChannel.REMINDER, ChannelEvent.REMINDER_ADD, this);\n } else {\n message = new Message(MessageChannel.REMINDER, ChannelEvent.REMINDER_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.REMINDER, reminder);\n messageBus.fireEvent(message);\n\n return result;\n }\n\n public boolean removeReminder(final Reminder reminder) {\n boolean result = false;\n\n if (moveObjectToTrash(reminder)) {\n\n if (reminder.getTransaction() != null) {\n moveObjectToTrash(reminder.getTransaction());\n reminder.setTransaction(null);\n }\n\n Message message = new Message(MessageChannel.REMINDER, ChannelEvent.REMINDER_REMOVE, this);\n\n message.setObject(MessageProperty.REMINDER, reminder);\n messageBus.fireEvent(message);\n\n result = true;\n }\n\n return result;\n }\n\n /**\n * Returns a list of reminders.\n *\n * @return List of reminders\n */\n public List getReminders() {\n return getReminderDAO().getReminderList();\n }\n\n public Reminder getReminderByUuid(final UUID uuid) {\n return getReminderDAO().getReminderByUuid(uuid);\n }\n\n public List getPendingReminders() {\n final ArrayList pendingList = new ArrayList<>();\n final List list = getReminders();\n final LocalDate now = LocalDate.now(); // today's date\n\n for (final Reminder r : list) {\n if (r.isEnabled()) {\n final RecurringIterator ri = r.getIterator();\n LocalDate next = ri.next();\n\n while (next != null) {\n LocalDate date = next;\n\n if (r.isAutoCreate()) {\n date = date.minusDays(r.getDaysAdvance());\n }\n\n if (DateUtils.before(date, now)) { // need to fire this reminder\n pendingList.add(new PendingReminder(r, next));\n next = ri.next();\n } else {\n next = null;\n }\n }\n }\n }\n\n return pendingList;\n }\n\n public static PendingReminder getPendingReminder(@NotNull Reminder reminder) {\n final RecurringIterator ri = reminder.getIterator();\n LocalDate next = ri.next();\n\n if (next != null) {\n return new PendingReminder(reminder, next);\n }\n\n return null;\n }\n\n public void processPendingReminders(final Collection pendingReminders) {\n pendingReminders.stream().filter(PendingReminder::isApproved).forEach(pending -> {\n final Reminder reminder = pending.getReminder();\n\n if (reminder.getTransaction() != null) { // add the transaction\n final Transaction t = reminder.getTransaction();\n\n // Update to the commit date (commit date can be modified)\n t.setDate(pending.getCommitDate());\n addTransaction(t);\n }\n // update the last fired date... date returned from the iterator\n reminder.setLastDate(); // mark as complete\n if (!updateReminder(reminder)) {\n logSevere(rb.getString(\"Message.Error.ReminderUpdate\"));\n }\n });\n }\n\n public T getStoredObjectByUuid(final Class tClass, final UUID uuid) {\n return eDAO.getObjectByUuid(tClass, uuid);\n }\n\n /**\n * Returns a {@code Collection} of all {@code StoredObjects} in a consistent order.\n * {@code StoredObjects} marked for removal and {@code TrashObjects} are filtered from the collection.\n *\n * @return {@code Collection} of {@code StoredObjects}\n * @see Collection\n * @see StoredObjectComparator\n */\n public Collection getStoredObjects() {\n dataLock.readLock().lock();\n\n try {\n\n List objects = eDAO.getStoredObjects();\n\n // Filter out objects to be removed\n objects.removeIf(TrashObject.class::isInstance);\n\n objects.sort(new StoredObjectComparator());\n\n return objects;\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Validate a CommodityNode for correctness.\n *\n * @param node CommodityNode to validate\n * @return true if valid\n */\n private boolean isCommodityNodeValid(final CommodityNode node) {\n boolean result = true;\n\n if (node.getUuid() == null) {\n result = false;\n logSevere(\"Commodity uuid was not valid\");\n }\n\n if (node.getSymbol() == null || node.getSymbol().isEmpty()) {\n result = false;\n logSevere(\"Commodity symbol was not valid\");\n }\n\n if (node.getScale() < 0) {\n result = false;\n logSevere(COMMODITY + node + \" had a scale less than zero\");\n }\n\n if (node instanceof SecurityNode && ((SecurityNode) node).getReportedCurrencyNode() == null) {\n result = false;\n logSevere(COMMODITY + node + \" was not assigned a currency\");\n }\n\n // ensure the UUID being used is unique\n if (eDAO.getObjectByUuid(CommodityNode.class, node.getUuid()) != null) {\n result = false;\n logSevere(COMMODITY + node + \" was not unique\");\n }\n\n return result;\n }\n\n /**\n * Adds a new CurrencyNode to the data set.\n * \n * Checks and prevents the addition of a duplicate Currencies.\n *\n * @param node new CurrencyNode to add\n * @return {@code true} if the add it successful\n */\n public boolean addCurrency(final CurrencyNode node) {\n dataLock.writeLock().lock();\n\n try {\n boolean status = isCommodityNodeValid(node);\n\n if (status) {\n node.setExchangeRateDAO(exchangeRateDAO);\n\n if (getCurrency(node.getSymbol()) != null) {\n logger.log(Level.INFO, \"Prevented addition of a duplicate CurrencyNode: {0}\", node.getSymbol());\n status = false;\n }\n }\n\n if (status) {\n status = getCommodityDAO().addCommodity(node);\n logger.log(Level.FINE, \"Adding: {0}\", node);\n }\n\n Message message;\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_ADD, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Links the {@code CurrencyNode} to the exchange DAO.\n * Support method to be used during import operations\n *\n * @param currencyNode {@code CurrencyNode} to link\n */\n void attachCurrencyNode(final CurrencyNode currencyNode) {\n currencyNode.setExchangeRateDAO(exchangeRateDAO);\n }\n\n /**\n * Adds a new SecurityNode to the data set.\n *
\n * Checks and prevents the addition of a duplicate SecurityNode.\n *\n * @param node new SecurityNode to add\n * @return {@code true} if the add it successful\n */\n public boolean addSecurity(final SecurityNode node) {\n dataLock.writeLock().lock();\n\n try {\n boolean status = isCommodityNodeValid(node);\n\n if (status) {\n if (getSecurity(node.getSymbol()) != null) {\n logger.log(Level.INFO, \"Prevented addition of a duplicate SecurityNode: {0}\", node.getSymbol());\n status = false;\n }\n }\n\n if (status) {\n status = getCommodityDAO().addCommodity(node);\n logger.log(Level.FINE, \"Adding: {0}\", node);\n }\n\n Message message;\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_ADD, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Add a SecurityHistoryNode node to a SecurityNode. If the SecurityNode already contains\n * an equivalent SecurityHistoryNode, the old SecurityHistoryNode is removed first.\n *\n * @param node SecurityNode to add to\n * @param hNode SecurityHistoryNode to add\n * @return true if successful\n */\n public boolean addSecurityHistory(@NotNull final SecurityNode node, @NotNull final SecurityHistoryNode hNode) {\n dataLock.writeLock().lock();\n\n try {\n // Remove old history of the same date if it exists\n if (node.contains(hNode.getLocalDate())) {\n if (!removeSecurityHistory(node, hNode.getLocalDate())) {\n logSevere(ResourceUtils.getString(\"Message.Error.HistRemoval\", hNode.getLocalDate(), node.getSymbol()));\n return false;\n }\n }\n\n boolean status = node.addHistoryNode(hNode);\n\n if (status) {\n status = getCommodityDAO().addSecurityHistory(node, hNode);\n }\n\n Message message;\n\n if (status) {\n clearCachedAccountBalance(node);\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_ADD, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Add a SecurityHistoryNode node to a SecurityNode. If the SecurityNode already contains\n * an equivalent SecurityHistoryNode, the old SecurityHistoryNode is removed first.\n *\n * @param node SecurityNode to add to\n * @param historyEvent SecurityHistoryNode to add\n * @return true if successful\n */\n public boolean addSecurityHistoryEvent(@NotNull final SecurityNode node, @NotNull final SecurityHistoryEvent historyEvent) {\n dataLock.writeLock().lock();\n\n try {\n\n // Remove old history event if it exists, equality is used to work around hibernate optimizations\n // A defensive copy of the old events is used to prevent concurrent modification errors\n new HashSet<>(node.getHistoryEvents()).stream().filter(event -> event.equals(historyEvent))\n .forEach(event -> removeSecurityHistoryEvent(node, historyEvent));\n\n boolean status = node.addSecurityHistoryEvent(historyEvent);\n\n if (status) {\n status = getCommodityDAO().addSecurityHistoryEvent(node, historyEvent);\n }\n\n Message message;\n\n if (status) {\n clearCachedAccountBalance(node);\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_EVENT_ADD, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_EVENT_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns a list of investment accounts that use the given security node.\n *\n * @param node security node\n * @return list of investment accounts\n */\n private Set getInvestmentAccountList(final SecurityNode node) {\n return getInvestmentAccountList().parallelStream()\n .filter(account -> account.containsSecurity(node)).collect(Collectors.toSet());\n }\n\n /**\n * Forces all investment accounts containing the security to clear the cached account balance and reconciled account\n * balance and recalculate when queried.\n *\n * @param node SecurityNode that was changed\n */\n private void clearCachedAccountBalance(final SecurityNode node) {\n getInvestmentAccountList(node).forEach(this::clearCachedAccountBalance);\n }\n\n /**\n * Clears an {@code Accounts} cached balance and recursively works up the tree to the root.\n *\n * @param account {@code Account} to clear\n */\n private void clearCachedAccountBalance(final Account account) {\n\n dataLock.writeLock().lock();\n\n try {\n account.clearCachedBalances();\n\n // force a persistence update if working as a client / server\n if (eDAO.isRemote()) {\n getAccountDAO().updateAccount(account);\n }\n } finally {\n dataLock.writeLock().unlock();\n }\n\n if (account.getParent() != null && account.getParent().getAccountType() != AccountType.ROOT) {\n clearCachedAccountBalance(account.getParent());\n }\n }\n\n private CurrencyNode[] getBaseCurrencies(final String exchangeRateId) {\n dataLock.readLock().lock();\n\n try {\n final List currencies = getCurrencies();\n\n Collections.sort(currencies);\n Collections.reverse(currencies);\n\n for (final CurrencyNode node1 : currencies) {\n for (final CurrencyNode node2 : currencies) {\n if (node1 != node2 && buildExchangeRateId(node1, node2).equals(exchangeRateId)) {\n return new CurrencyNode[]{node1, node2};\n }\n }\n }\n return new CurrencyNode[0];\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Returns an array of currencies being used in accounts.\n *\n * @return Set of CurrencyNodes\n */\n public Set getActiveCurrencies() {\n dataLock.readLock().lock();\n\n try {\n return getCommodityDAO().getActiveCurrencies();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Returns a CurrencyNode given the symbol. This will not generate a new CurrencyNode. It must be explicitly created\n * and added.\n *\n * @param symbol Currency symbol\n * @return null if the CurrencyNode as not been defined\n */\n public CurrencyNode getCurrency(final String symbol) {\n dataLock.readLock().lock();\n\n try {\n CurrencyNode rNode = null;\n\n for (CurrencyNode node : getCurrencies()) {\n if (node.getSymbol().equals(symbol)) {\n rNode = node;\n break;\n }\n }\n return rNode;\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public List getCurrencies() {\n dataLock.readLock().lock();\n\n try {\n return getCommodityDAO().getCurrencies();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public CurrencyNode getCurrencyNodeByUuid(final UUID uuid) {\n return getCommodityDAO().getCurrencyByUuid(uuid);\n }\n\n public ExchangeRate getExchangeRate(final CurrencyNode baseCurrency, final CurrencyNode exchangeCurrency) {\n dataLock.readLock().lock();\n\n try {\n return exchangeRateDAO.getExchangeRateNode(baseCurrency, exchangeCurrency);\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public ExchangeRate getExchangeRateByUuid(final UUID uuid) {\n return getCommodityDAO().getExchangeRateByUuid(uuid);\n }\n\n @NotNull\n public List getSecurities() {\n dataLock.readLock().lock();\n\n try {\n return getCommodityDAO().getSecurities();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Find a SecurityNode given it's symbol.\n *\n * @param symbol symbol of security to find\n * @return null if not found\n */\n public SecurityNode getSecurity(final String symbol) {\n dataLock.readLock().lock();\n\n try {\n List list = getSecurities();\n\n SecurityNode sNode = null;\n\n for (SecurityNode node : list) {\n if (node.getSymbol().equals(symbol)) {\n sNode = node;\n break;\n }\n }\n return sNode;\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public SecurityNode getSecurityNodeByUuid(final UUID uuid) {\n return getCommodityDAO().getSecurityByUuid(uuid);\n }\n\n private boolean isCommodityNodeUsed(final CommodityNode node) {\n dataLock.readLock().lock();\n\n try {\n List list = getAccountList();\n\n for (Account a : list) {\n if (a.getCurrencyNode().equals(node)) {\n return true;\n }\n\n if (a.getAccountType() == AccountType.INVEST || a.getAccountType() == AccountType.MUTUAL) {\n for (SecurityNode j : a.getSecurities()) {\n if (j.equals(node) || j.getReportedCurrencyNode().equals(node)) {\n return true;\n }\n }\n }\n }\n\n List sList = getSecurities();\n\n for (SecurityNode sNode : sList) {\n if (sNode.getReportedCurrencyNode().equals(node)) {\n return true;\n }\n }\n\n } finally {\n dataLock.readLock().unlock();\n }\n\n return false;\n }\n\n public boolean removeCommodity(final CurrencyNode node) {\n boolean status = true;\n\n dataLock.writeLock().lock();\n\n try {\n if (isCommodityNodeUsed(node)) {\n status = false;\n } else {\n clearObsoleteExchangeRates();\n moveObjectToTrash(node);\n }\n\n Message message;\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_REMOVE, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_REMOVE_FAILED, this);\n }\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public boolean removeSecurity(final SecurityNode node) {\n boolean status = true;\n\n dataLock.writeLock().lock();\n\n try {\n if (isCommodityNodeUsed(node)) {\n status = false;\n } else {\n // Remove all history nodes first so they are not left behind\n\n // A copy is made to prevent a concurrent modification error to the underlying list, Bug #208\n final List hNodes = new ArrayList<>(node.getHistoryNodes());\n\n hNodes.stream()\n .filter(hNode -> !removeSecurityHistory(node, hNode.getLocalDate()))\n .forEach(hNode -> logSevere(ResourceUtils.getString(\"Message.Error.HistRemoval\",\n hNode.getLocalDate(), node.getSymbol())));\n moveObjectToTrash(node);\n }\n\n Message message;\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_REMOVE, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_REMOVE_FAILED, this);\n }\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Remove a {@code SecurityHistoryNode} given a {@code Date}.\n *\n * @param node {@code SecurityNode} to remove history from\n * @param date the search {@code Date}\n * @return {@code true} if a {@code SecurityHistoryNode} was found and removed\n */\n public boolean removeSecurityHistory(@NotNull final SecurityNode node, @NotNull final LocalDate date) {\n dataLock.writeLock().lock();\n\n boolean status = false;\n\n try {\n final Optional optional = node.getHistoryNode(date);\n\n if (optional.isPresent()) {\n status = node.removeHistoryNode(date);\n\n if (status) { // removal was a success, make sure we cleanup properly\n moveObjectToTrash(optional.get());\n status = getCommodityDAO().removeSecurityHistory(node, optional.get());\n\n logInfo(ResourceUtils.getString(\"Message.RemovingSecurityHistory\", date, node.getSymbol()));\n }\n }\n\n Message message;\n\n if (status) {\n clearCachedAccountBalance(node);\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_REMOVE, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_REMOVE_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Remove a {@code SecurityHistoryEvent} from a {@code SecurityNode}.\n *\n * @param node {@code SecurityNode} to remove history from\n * @param historyEvent the {@code SecurityHistoryEvent} to remove\n * @return {@code true} if the {@code SecurityHistoryEvent} was found and removed\n */\n public boolean removeSecurityHistoryEvent(@NotNull final SecurityNode node, @NotNull final SecurityHistoryEvent historyEvent) {\n dataLock.writeLock().lock();\n\n boolean status;\n\n try {\n status = node.removeSecurityHistoryEvent(historyEvent);\n\n if (status) { // removal was a success, make sure we cleanup properly\n moveObjectToTrash(historyEvent);\n status = getCommodityDAO().removeSecurityHistoryEvent(node, historyEvent);\n }\n\n Message message;\n\n if (status) {\n clearCachedAccountBalance(node);\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_EVENT_REMOVE, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_HISTORY_EVENT_REMOVE_FAILED, this);\n }\n\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n private Config getConfig() {\n\n dataLock.readLock().lock();\n\n try {\n if (config == null) {\n config = getConfigDAO().getDefaultConfig();\n }\n return config;\n\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public CurrencyNode getDefaultCurrency() {\n\n dataLock.readLock().lock();\n\n try {\n CurrencyNode node = getConfig().getDefaultCurrency();\n\n if (node == null) {\n logger.warning(\"No default currency assigned\");\n }\n\n return node;\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public void setDefaultCurrency(final CurrencyNode defaultCurrency) {\n\n // make sure the new default is persisted if it has not been\n if (!isStored(defaultCurrency)) {\n addCurrency(defaultCurrency);\n }\n\n dataLock.writeLock().lock();\n\n try {\n final Config currencyConfig = getConfig();\n currencyConfig.setDefaultCurrency(defaultCurrency);\n getConfigDAO().update(currencyConfig);\n\n logInfo(\"Setting default currency: \" + defaultCurrency);\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, currencyConfig);\n messageBus.fireEvent(message);\n\n Account root = getRootAccount();\n\n // The root account holds a reference to the default currency\n root.setCurrencyNode(defaultCurrency);\n getAccountDAO().updateAccount(root);\n\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, root);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public void setExchangeRate(final CurrencyNode baseCurrency, final CurrencyNode exchangeCurrency,\n final BigDecimal rate) {\n setExchangeRate(baseCurrency, exchangeCurrency, rate, LocalDate.now());\n }\n\n public void setExchangeRate(final CurrencyNode baseCurrency, final CurrencyNode exchangeCurrency,\n final BigDecimal rate, final LocalDate localDate) {\n Objects.requireNonNull(rate);\n\n if (rate.compareTo(BigDecimal.ZERO) < 1) {\n throw new EngineException(\"Rate must be greater than zero\");\n }\n\n if (baseCurrency.equals(exchangeCurrency)) {\n return;\n }\n\n // find the correct ExchangeRate and create if needed\n ExchangeRate exchangeRate = getExchangeRate(baseCurrency, exchangeCurrency);\n\n if (exchangeRate == null) {\n exchangeRate = new ExchangeRate(buildExchangeRateId(baseCurrency, exchangeCurrency));\n getCommodityDAO().addExchangeRate(exchangeRate);\n }\n\n // Remove old history of the same date if it exists\n if (exchangeRate.contains(localDate)) {\n removeExchangeRateHistory(exchangeRate, exchangeRate.getHistory(localDate));\n }\n\n dataLock.writeLock().lock();\n\n try {\n // create the new history node\n ExchangeRateHistoryNode historyNode;\n\n if (baseCurrency.getSymbol().compareToIgnoreCase(exchangeCurrency.getSymbol()) > 0) {\n historyNode = new ExchangeRateHistoryNode(localDate, rate);\n } else {\n historyNode = new ExchangeRateHistoryNode(localDate, BigDecimal.ONE.divide(rate, MathConstants.mathContext));\n }\n\n final Message message;\n\n boolean result = false;\n\n if (exchangeRate.addHistoryNode(historyNode)) {\n result = getCommodityDAO().addExchangeRateHistory(exchangeRate);\n }\n\n if (result) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.EXCHANGE_RATE_ADD, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.EXCHANGE_RATE_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.EXCHANGE_RATE, exchangeRate);\n\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public void removeExchangeRateHistory(final ExchangeRate exchangeRate, final ExchangeRateHistoryNode history) {\n\n dataLock.writeLock().lock();\n\n try {\n final Message message;\n\n boolean result = false;\n\n if (exchangeRate.contains(history)) {\n if (exchangeRate.removeHistoryNode(history)) {\n moveObjectToTrash(history);\n result = getCommodityDAO().removeExchangeRateHistory(exchangeRate);\n }\n }\n\n if (result) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.EXCHANGE_RATE_REMOVE, this);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.EXCHANGE_RATE_REMOVE_FAILED, this);\n }\n\n message.setObject(MessageProperty.EXCHANGE_RATE, exchangeRate);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Modifies an existing currency node in place. The supplied node should not be a reference to the original\n *\n * @param oldNode old CommodityNode\n * @param templateNode template CommodityNode\n * @return true if successful\n */\n public boolean updateCommodity(final CommodityNode oldNode, final CommodityNode templateNode) {\n Objects.requireNonNull(oldNode);\n Objects.requireNonNull(templateNode);\n\n if (oldNode == templateNode) {\n throw new EngineException(\"node were the same\");\n }\n\n dataLock.writeLock().lock();\n\n try {\n boolean status;\n\n if (oldNode.getClass().equals(templateNode.getClass())) {\n\n oldNode.setDescription(templateNode.getDescription());\n oldNode.setPrefix(templateNode.getPrefix());\n oldNode.setScale(templateNode.getScale());\n oldNode.setSuffix(templateNode.getSuffix());\n\n if (templateNode instanceof SecurityNode) {\n oldNode.setSymbol(templateNode.getSymbol()); // allow symbol to change\n\n ((SecurityNode) oldNode).setReportedCurrencyNode(((SecurityNode) templateNode).getReportedCurrencyNode());\n\n ((SecurityNode) oldNode).setQuoteSource(((SecurityNode) templateNode).getQuoteSource());\n\n ((SecurityNode) oldNode).setISIN(((SecurityNode) templateNode).getISIN());\n }\n\n status = getCommodityDAO().updateCommodityNode(oldNode);\n } else {\n status = false;\n logger.warning(\"Template object class did not match old object class\");\n }\n\n final Message message;\n\n if (templateNode instanceof SecurityNode) {\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_MODIFY, this);\n message.setObject(MessageProperty.COMMODITY, oldNode);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.SECURITY_MODIFY_FAILED, this);\n message.setObject(MessageProperty.COMMODITY, templateNode);\n }\n } else {\n if (status) {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_MODIFY, this);\n message.setObject(MessageProperty.COMMODITY, oldNode);\n } else {\n message = new Message(MessageChannel.COMMODITY, ChannelEvent.CURRENCY_MODIFY_FAILED, this);\n message.setObject(MessageProperty.COMMODITY, templateNode);\n }\n }\n\n messageBus.fireEvent(message);\n return status;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n private boolean updateReminder(final Reminder reminder) {\n final boolean result = getReminderDAO().updateReminder(reminder);\n\n final Message message;\n\n if (result) {\n message = new Message(MessageChannel.REMINDER, ChannelEvent.REMINDER_UPDATE, this);\n } else {\n message = new Message(MessageChannel.REMINDER, ChannelEvent.REMINDER_UPDATE_FAILED, this);\n }\n\n message.setObject(MessageProperty.REMINDER, reminder);\n\n messageBus.fireEvent(message);\n\n return result;\n }\n\n public String getAccountSeparator() {\n\n dataLock.readLock().lock();\n\n try {\n if (accountSeparator == null) {\n accountSeparator = getConfig().getAccountSeparator();\n }\n return accountSeparator;\n\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public void setAccountSeparator(final String separator) {\n\n dataLock.writeLock().lock();\n\n try {\n accountSeparator = separator;\n Config localConfig = getConfig();\n\n localConfig.setAccountSeparator(separator);\n\n getConfigDAO().update(localConfig);\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, localConfig);\n\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns a list of all Accounts excluding the rootAccount.\n *\n * @return List of accounts\n */\n public List getAccountList() {\n final List accounts = getAccountDAO().getAccountList();\n accounts.remove(getRootAccount());\n\n return accounts;\n }\n\n public Account getAccountByUuid(final UUID id) {\n return getAccountDAO().getAccountByUuid(id);\n }\n\n /**\n * Search for an account with a matching account name.\n *\n * @param accountName Account name to search for. Must not be null\n * @return The matching account. {@code null} if not found.\n */\n public Account getAccountByName(@NotNull final String accountName) {\n Objects.requireNonNull(accountName);\n\n final List list = getAccountList();\n\n // sort for consistent search order\n Collections.sort(list);\n\n for (final Account account : list) {\n if (accountName.equals(account.getName())) {\n return account;\n }\n }\n return null;\n }\n\n /**\n * Returns a list of IncomeAccounts excluding the rootIncomeAccount.\n *\n * @return List of income accounts\n */\n @NotNull\n public List getIncomeAccountList() {\n return getAccountDAO().getIncomeAccountList();\n }\n\n /**\n * Returns a list of ExpenseAccounts excluding the rootExpenseAccount.\n *\n * @return List if expense accounts\n */\n @NotNull\n public List getExpenseAccountList() {\n return getAccountDAO().getExpenseAccountList();\n }\n\n /**\n * Returns a list of all accounts excluding the rootAccount and IncomeAccounts and ExpenseAccounts.\n *\n * @return List of investment accounts\n */\n public List getInvestmentAccountList() {\n\n return getAccountDAO().getInvestmentAccountList();\n }\n\n public void refresh(final StoredObject object) {\n eDAO.refresh(object);\n }\n\n /**\n * Adds a new account.\n *\n * @param parent The parent account\n * @param child A new Account object\n * @return true if successful\n */\n public boolean addAccount(final Account parent, final Account child) {\n Objects.requireNonNull(child);\n Objects.requireNonNull(child.getUuid());\n\n if (child.getAccountType() == AccountType.ROOT) {\n throw new IllegalArgumentException(\"Invalid Account\");\n }\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n boolean result;\n\n result = parent.addChild(child);\n\n if (result) {\n result = getAccountDAO().addAccount(parent, child);\n }\n\n if (result) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_ADD, this);\n message.setObject(MessageProperty.ACCOUNT, child);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(\"Message.AccountAdd\"));\n result = true;\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_ADD_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, child);\n messageBus.fireEvent(message);\n result = false;\n }\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Return the root account.\n *\n * @return RootAccount\n */\n public RootAccount getRootAccount() {\n\n dataLock.readLock().lock();\n\n try {\n if (rootAccount == null) {\n rootAccount = getAccountDAO().getRootAccount();\n }\n return rootAccount;\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Move an account to a new parent account..\n *\n * @param account account to move\n * @param newParent the new parent account\n * @return true if successful\n */\n public boolean moveAccount(final Account account, final Account newParent) {\n Objects.requireNonNull(account);\n Objects.requireNonNull(newParent);\n\n dataLock.writeLock().lock();\n\n try {\n // cannot invert the child/parent relationship of an account\n if (account.contains(newParent)) {\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(\"Message.AccountMoveFailed\"));\n\n return false;\n }\n\n Account oldParent = account.getParent();\n\n if (oldParent != null) { // check for detached account\n\n oldParent.removeChild(account);\n\n getAccountDAO().updateAccount(account);\n getAccountDAO().updateAccount(oldParent);\n\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, oldParent);\n\n messageBus.fireEvent(message);\n }\n\n newParent.addChild(account);\n\n getAccountDAO().updateAccount(account);\n getAccountDAO().updateAccount(newParent);\n\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, newParent);\n\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(MESSAGE_ACCOUNT_MODIFY));\n\n return true;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Changes an Account's code.\n *\n * @param account Account to change\n * @param code new code\n * @return true is successful\n */\n public boolean setAccountCode(final Account account, final int code) {\n account.setAccountCode(code);\n\n boolean result = getAccountDAO().updateAccount(account);\n\n if (result) {\n final Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(MESSAGE_ACCOUNT_MODIFY));\n } else {\n final Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n }\n\n return result;\n }\n\n /**\n * Modifies an existing account given an account as a template. The type of the account cannot be changed.\n *\n * @param template The Account object to use as a template\n * @param account The existing account\n * @return true if successful\n */\n public boolean modifyAccount(final Account template, final Account account) {\n\n boolean result;\n Message message;\n\n dataLock.writeLock().lock();\n\n try {\n account.setName(template.getName());\n account.setDescription(template.getDescription());\n account.setNotes(template.getNotes());\n\n account.setLocked(template.isLocked());\n account.setPlaceHolder(template.isPlaceHolder());\n account.setVisible(template.isVisible());\n account.setExcludedFromBudget(template.isExcludedFromBudget());\n account.setAccountNumber(template.getAccountNumber());\n account.setBankId(template.getBankId());\n account.setAccountCode(template.getAccountCode());\n\n if (account.getAccountType().isMutable()) {\n account.setAccountType(template.getAccountType());\n }\n\n // allow allow a change if the account does not contain transactions\n if (account.getTransactionCount() == 0) {\n account.setCurrencyNode(template.getCurrencyNode());\n }\n\n result = getAccountDAO().updateAccount(account);\n\n if (result) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(MESSAGE_ACCOUNT_MODIFY));\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n }\n\n /* Check to see if the account needs to be moved */\n if (account.parentAccount != template.parentAccount && template.parentAccount != null && result) {\n if (!moveAccount(account, template.parentAccount)) {\n logWarning(rb.getString(\"Message.Error.MoveAccount\"));\n result = false;\n }\n }\n\n // Force clearing of any budget goals if an empty account has been changed to become a place holder\n if (account.isPlaceHolder()) {\n purgeBudgetGoal(account);\n }\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Purges any {@code BudgetGoal} associated with an account.\n *\n * @param account {@code Account} to remove all associated budget goal history\n */\n private void purgeBudgetGoal(@NotNull final Account account) {\n // clear budget history\n for (final Budget budget : getBudgetList()) {\n budget.removeBudgetGoal(account);\n if (!updateBudget(budget)) {\n logWarning(\"Unable to remove account goals from the budget\");\n }\n }\n }\n\n /**\n * Sets the account number of an account.\n *\n * @param account account to change\n * @param number new account number\n */\n public void setAccountNumber(final Account account, final String number) {\n\n dataLock.writeLock().lock();\n\n try {\n account.setAccountNumber(number);\n getAccountDAO().updateAccount(account);\n\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(MESSAGE_ACCOUNT_MODIFY));\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Sets an attribute for an {@code Account}. The key and values are string based\n *\n * @param account {@code Account} to add or update an attribute\n * @param key the key for the attribute\n * @param value the value of the attribute\n */\n public void setAccountAttribute(final Account account, @NotNull final String key, @Nullable final String value) {\n // Throw an error if the value exceeds the maximum length\n if (value != null && value.length() > Account.MAX_ATTRIBUTE_LENGTH) {\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_MODIFY_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(\"The maximum length of the attribute was exceeded\");\n\n return;\n }\n\n dataLock.writeLock().lock();\n\n try {\n account.setAttribute(key, value);\n getAccountDAO().updateAccount(account);\n\n Message message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_ATTRIBUTE_MODIFY, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(MESSAGE_ACCOUNT_MODIFY));\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns an {@code Account} attribute.\n *\n * @param account account to extract attribute from\n * @param key the attribute key\n * @return the attribute if found\n * @see #setAccountAttribute\n */\n public static String getAccountAttribute(@NotNull final Account account, @NotNull final String key) {\n return account.getAttribute(key);\n }\n\n /**\n * Removes an existing account given it's ID.\n *\n * @param account The account to remove\n * @return true if successful\n */\n public boolean removeAccount(final Account account) {\n\n dataLock.writeLock().lock();\n\n try {\n boolean result = false;\n\n if (account.getTransactionCount() == 0 && account.getChildCount() == 0) {\n Account parent = account.getParent();\n\n if (parent != null) {\n result = parent.removeChild(account);\n\n if (result) {\n getAccountDAO().updateAccount(parent);\n\n // clear budget history\n purgeBudgetGoal(account);\n }\n }\n\n moveObjectToTrash(account);\n }\n\n Message message;\n\n if (result) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_REMOVE, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n\n logInfo(rb.getString(\"Message.AccountRemove\"));\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_REMOVE_FAILED, this);\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n }\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public Future getAttachment(final String attachment) {\n return attachmentManager.getAttachment(attachment);\n }\n\n public boolean addAttachment(final Path path, final boolean copy) {\n boolean result = false;\n\n try {\n result = attachmentManager.addAttachment(path, copy);\n } catch (IOException e) {\n logSevere(e.getLocalizedMessage());\n }\n\n return result;\n }\n\n public boolean removeAttachment(final String attachment) {\n return attachmentManager.removeAttachment(attachment);\n }\n\n /**\n * Sets the amortize object of an account.\n *\n * @param account The Liability account to change\n * @param amortizeObject the new AmortizeObject\n * @return true if successful\n */\n public boolean setAmortizeObject(final Account account, final AmortizeObject amortizeObject) {\n\n dataLock.writeLock().lock();\n\n try {\n if (account != null && amortizeObject != null && account.getAccountType() == AccountType.LIABILITY) {\n\n account.setAmortizeObject(amortizeObject);\n\n if (!getAccountDAO().updateAccount(account)) {\n logSevere(\"Was not able to save the amortize object\");\n }\n\n return true;\n }\n return false;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Toggles the visibility of an account given its ID.\n *\n * @param account The account to toggle visibility\n */\n public void toggleAccountVisibility(final Account account) {\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n\n account.setVisible(!account.isVisible());\n\n if (getAccountDAO().toggleAccountVisibility(account)) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_VISIBILITY_CHANGE, this);\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_VISIBILITY_CHANGE_FAILED, this);\n }\n\n message.setObject(MessageProperty.ACCOUNT, account);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Adds a SecurityNode from a InvestmentAccount.\n *\n * @param account destination account\n * @param node SecurityNode to add\n * @return true if add was successful\n */\n public boolean addAccountSecurity(final Account account, final SecurityNode node) {\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n\n boolean result = account.addSecurity(node);\n\n if (result) {\n result = getAccountDAO().addAccountSecurity(account, node);\n }\n\n if (result) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_SECURITY_ADD, this);\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_SECURITY_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.ACCOUNT, account);\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return result;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Removes a SecurityNode from an InvestmentAccount.\n *\n * @param account Account to remove SecurityNode from\n * @param node SecurityNode to remove\n * @return true if successful\n */\n private boolean removeAccountSecurity(final Account account, final SecurityNode node) {\n Objects.requireNonNull(node);\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n boolean result = account.removeSecurity(node);\n\n if (result) {\n getAccountDAO().updateAccount(account);\n }\n\n if (result) {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_SECURITY_REMOVE, this);\n } else {\n message = new Message(MessageChannel.ACCOUNT, ChannelEvent.ACCOUNT_SECURITY_REMOVE_FAILED, this);\n }\n\n message.setObject(MessageProperty.ACCOUNT, account);\n message.setObject(MessageProperty.COMMODITY, node);\n messageBus.fireEvent(message);\n\n return result;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Update an account's securities list. This compares the old list of securities and the supplied list and adds or\n * removes securities to make sure the lists are the same.\n *\n * @param acc Destination account\n * @param list Collection of SecurityNodes\n * @return true if successful\n */\n public boolean updateAccountSecurities(final Account acc, final Collection list) {\n\n boolean result = true;\n\n if (acc.memberOf(AccountGroup.INVEST)) {\n dataLock.writeLock().lock();\n\n try {\n final Collection oldList = acc.getSecurities();\n\n for (SecurityNode node : oldList) {\n if (!list.contains(node)) {\n if (!removeAccountSecurity(acc, node)) {\n logWarning(ResourceUtils.getString(\"Message.Error.SecurityAccountRemove\", node.toString(),\n acc.getName()));\n result = false;\n }\n }\n }\n\n for (SecurityNode node : list) {\n if (!oldList.contains(node)) {\n if (!addAccountSecurity(acc, node)) {\n logWarning(ResourceUtils.getString(\"Message.Error.SecurityAccountRemove\", node.toString(),\n acc.getName()));\n result = false;\n }\n }\n }\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n return result;\n }\n\n public boolean addBudget(final Budget budget) {\n\n boolean result;\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n\n result = getBudgetDAO().add(budget);\n\n if (result) {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_ADD, this);\n } else {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_ADD_FAILED, this);\n }\n\n message.setObject(MessageProperty.BUDGET, budget);\n messageBus.fireEvent(message);\n\n return result;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public boolean removeBudget(final Budget budget) {\n\n boolean result = false;\n\n dataLock.writeLock().lock();\n\n try {\n moveObjectToTrash(budget);\n\n Message message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_REMOVE, this);\n\n message.setObject(MessageProperty.BUDGET, budget);\n messageBus.fireEvent(message);\n\n result = true;\n } catch (final Exception ex) {\n logger.log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n } finally {\n dataLock.writeLock().unlock();\n }\n\n return result;\n }\n\n public void updateBudgetGoals(final Budget budget, final Account account, final BudgetGoal newGoals) {\n dataLock.writeLock().lock();\n\n try {\n BudgetGoal oldGoals = budget.getBudgetGoal(account);\n\n budget.setBudgetGoal(account, newGoals);\n\n moveObjectToTrash(oldGoals); // need to keep the old goal around, will be cleaned up later, orphan removal causes refresh issues\n\n updateBudgetGoals(budget, account);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n private void updateBudgetGoals(final Budget budget, final Account account) {\n dataLock.writeLock().lock();\n\n try {\n Message message;\n\n boolean result = getBudgetDAO().update(budget);\n\n if (result) {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_GOAL_UPDATE, this);\n } else {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_GOAL_UPDATE_FAILED, this);\n }\n\n message.setObject(MessageProperty.BUDGET, budget);\n message.setObject(MessageProperty.ACCOUNT, account);\n\n messageBus.fireEvent(message);\n\n logger.log(Level.FINE, \"Budget goal updated for {0}\", account.getPathName());\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public boolean updateBudget(final Budget budget) {\n\n boolean result;\n\n dataLock.writeLock().lock();\n\n try {\n Message message;\n\n result = getBudgetDAO().update(budget);\n\n if (result) {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_UPDATE, this);\n } else {\n message = new Message(MessageChannel.BUDGET, ChannelEvent.BUDGET_UPDATE_FAILED, this);\n }\n\n message.setObject(MessageProperty.BUDGET, budget);\n messageBus.fireEvent(message);\n\n logger.log(Level.FINE, \"Budget updated\");\n\n return result;\n\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public List getBudgetList() {\n\n dataLock.readLock().lock();\n\n try {\n return getBudgetDAO().getBudgets();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public Budget getBudgetByUuid(final UUID uuid) {\n return getBudgetDAO().getBudgetByUuid(uuid);\n }\n\n public boolean isTransactionValid(final Transaction transaction) {\n\n for (final Account a : transaction.getAccounts()) {\n if (a.isLocked()) {\n logWarning(rb.getString(\"Message.TransactionAccountLocked\"));\n return false;\n }\n }\n\n if (transaction.isMarkedForRemoval()) {\n logger.log(Level.SEVERE, \"Transaction already marked for removal\", new Throwable());\n return false;\n }\n\n if (eDAO.getObjectByUuid(Transaction.class, transaction.getUuid()) != null) {\n logger.log(Level.WARNING, \"Transaction UUID was not unique\");\n return false;\n }\n\n if (transaction.size() < 1) {\n logger.log(Level.WARNING, \"Invalid Transaction\");\n return false;\n }\n\n for (final TransactionEntry e : transaction.getTransactionEntries()) {\n if (e == null) {\n logger.log(Level.WARNING, \"Null TransactionEntry\");\n return false;\n }\n }\n\n for (final TransactionEntry e : transaction.getTransactionEntries()) {\n if (e.getTransactionTag() == null) {\n logger.log(Level.WARNING, \"Null TransactionTag\");\n return false;\n }\n }\n\n for (final TransactionEntry e : transaction.getTransactionEntries()) {\n if (e.getCreditAccount() == null) {\n logger.log(Level.WARNING, \"Null Credit Account\");\n return false;\n }\n\n if (e.getDebitAccount() == null) {\n logger.log(Level.WARNING, \"Null Debit Account\");\n return false;\n }\n\n if (e.getCreditAmount() == null) {\n logger.log(Level.WARNING, \"Null Credit Amount\");\n return false;\n }\n\n if (e.getDebitAmount() == null) {\n logger.log(Level.WARNING, \"Null Debit Amount\");\n return false;\n }\n }\n\n if (transaction.getTransactionType() == TransactionType.SPLITENTRY && transaction.getCommonAccount() == null) {\n logger.log(Level.WARNING, \"Entries do not share a common account\");\n return false;\n }\n\n if (transaction instanceof InvestmentTransaction) {\n final InvestmentTransaction investmentTransaction = (InvestmentTransaction) transaction;\n\n if (!investmentTransaction.getInvestmentAccount().containsSecurity(investmentTransaction.getSecurityNode())) {\n logger.log(Level.WARNING, \"Investment Account is missing the security\");\n return false;\n }\n }\n\n return transaction.getTransactionType() != TransactionType.INVALID;\n }\n\n /**\n * Determine if a StoredObject is persisted in the database.\n *\n * @param object StoredObject to check\n * @return true if persisted\n */\n public boolean isStored(final StoredObject object) {\n return eDAO.getObjectByUuid(StoredObject.class, object.getUuid()) != null;\n }\n\n public boolean addTransaction(final Transaction transaction) {\n\n dataLock.writeLock().lock();\n\n try {\n boolean result = isTransactionValid(transaction);\n\n if (result) {\n /* Add the transaction to each account */\n transaction.getAccounts().stream()\n .filter(account -> !account.addTransaction(transaction))\n .forEach(account -> logSevere(\"Failed to add the Transaction\"));\n result = getTransactionDAO().addTransaction(transaction);\n\n logInfo(rb.getString(\"Message.TransactionAdd\"));\n\n /* If successful, extract and enter a default exchange rate for the transaction date if a rate has not been set */\n if (result) {\n // no rate for the date has been set\n transaction.getTransactionEntries().stream()\n .filter(TransactionEntry::isMultiCurrency)\n .forEach(entry -> {\n final ExchangeRate rate = getExchangeRate(entry.getDebitAccount().getCurrencyNode(),\n entry.getCreditAccount().getCurrencyNode());\n\n if (rate.getRate(transaction.getLocalDate()).compareTo(BigDecimal.ZERO) == 0) { // no rate for the date has been set\n final BigDecimal exchangeRate = entry.getDebitAmount().abs()\n .divide(entry.getCreditAmount().abs(),\n MathConstants.mathContext);\n\n setExchangeRate(entry.getCreditAccount().getCurrencyNode(),\n entry.getDebitAccount().getCurrencyNode(), exchangeRate, transaction.getLocalDate());\n }\n });\n }\n }\n\n postTransactionAdd(transaction, result);\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public boolean removeTransaction(final Transaction transaction) {\n\n dataLock.writeLock().lock();\n\n try {\n for (final Account account : transaction.getAccounts()) {\n if (account.isLocked()) {\n logWarning(rb.getString(\"Message.TransactionRemoveLocked\"));\n return false;\n }\n }\n\n /* Remove the transaction from each account */\n transaction.getAccounts().stream()\n .filter(account -> !account.removeTransaction(transaction))\n .forEach(account -> logSevere(\"Failed to remove the Transaction\"));\n\n logInfo(rb.getString(\"Message.TransactionRemove\"));\n\n boolean result = getTransactionDAO().removeTransaction(transaction);\n\n // move transactions into the trash\n if (result) {\n moveObjectToTrash(transaction);\n }\n\n postTransactionRemove(transaction, result);\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Changes the reconciled state of a transaction.\n *\n * @param transaction transaction to change\n * @param account account to change state for\n * @param state new reconciled state\n */\n public void setTransactionReconciled(final Transaction transaction, final Account account, final ReconciledState state) {\n dataLock.writeLock().lock(); // hold a write lock to ensure nothing slips in between the remove and add\n\n try {\n final Transaction newTransaction = (Transaction) transaction.clone();\n\n ReconcileManager.reconcileTransaction(account, newTransaction, state);\n\n if (removeTransaction(transaction)) {\n addTransaction(newTransaction);\n }\n } catch (final CloneNotSupportedException e) {\n logger.log(Level.SEVERE, \"Failed to reconcile the Transaction\", e);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public List getTransactionNumberList() {\n dataLock.readLock().lock();\n\n try {\n return getConfig().getTransactionNumberList();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public void setTransactionNumberList(final List list) {\n dataLock.writeLock().lock();\n\n try {\n final Config transactionConfig = getConfig();\n\n transactionConfig.setTransactionNumberList(list);\n getConfigDAO().update(transactionConfig);\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, transactionConfig);\n\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Get all transactions.\n *\n * @return List of transactions that may be altered without concern of side effects\n */\n public List getTransactions() {\n return getTransactionDAO().getTransactions();\n }\n\n /**\n * Returns a list of transactions with external links.\n *\n * @return List of transactions that may be altered without concern of side effects\n */\n public List getTransactionsWithAttachments() {\n return getTransactionDAO().getTransactionsWithAttachments();\n }\n\n public Transaction getTransactionByUuid(final UUID uuid) {\n return getTransactionDAO().getTransactionByUuid(uuid);\n }\n\n private void postTransactionAdd(final Transaction transaction, final boolean result) {\n\n for (Account a : transaction.getAccounts()) {\n Message message;\n\n if (result) {\n message = new Message(MessageChannel.TRANSACTION, ChannelEvent.TRANSACTION_ADD, this);\n } else {\n message = new Message(MessageChannel.TRANSACTION, ChannelEvent.TRANSACTION_ADD_FAILED, this);\n }\n message.setObject(MessageProperty.ACCOUNT, a);\n message.setObject(MessageProperty.TRANSACTION, transaction);\n\n messageBus.fireEvent(message);\n }\n }\n\n private void postTransactionRemove(final Transaction transaction, final boolean result) {\n\n for (Account a : transaction.getAccounts()) {\n Message message;\n\n if (result) {\n message = new Message(MessageChannel.TRANSACTION, ChannelEvent.TRANSACTION_REMOVE, this);\n } else {\n message = new Message(MessageChannel.TRANSACTION, ChannelEvent.TRANSACTION_REMOVE_FAILED, this);\n }\n message.setObject(MessageProperty.ACCOUNT, a);\n message.setObject(MessageProperty.TRANSACTION, transaction);\n\n messageBus.fireEvent(message);\n }\n }\n\n /**\n * Adds a new Tag\n *\n * @param tag Tag to add\n * @return true is successful\n */\n public boolean addTag(@NotNull Tag tag) {\n Objects.requireNonNull(tag);\n\n dataLock.writeLock().lock();\n\n try {\n boolean result = eDAO.getTagDAO().add(tag);\n\n final Message message = new Message(MessageChannel.TAG, result ? ChannelEvent.TAG_ADD\n : ChannelEvent.TAG_ADD_FAILED, this);\n message.setObject(MessageProperty.TAG, tag);\n messageBus.fireEvent(message);\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Updates an existing Tag\n *\n * @param tag Tag to update\n * @return true is successful\n */\n public boolean updateTag(@NotNull Tag tag) {\n Objects.requireNonNull(tag);\n\n dataLock.writeLock().lock();\n\n try {\n boolean result = eDAO.getTagDAO().update(tag);\n\n final Message message = new Message(MessageChannel.TAG, result ? ChannelEvent.TAG_MODIFY\n : ChannelEvent.TAG_MODIFY_FAILED, this);\n message.setObject(MessageProperty.TAG, tag);\n messageBus.fireEvent(message);\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Retrieves all Tags\n *\n * @return a Set of Tags.\n */\n @NotNull\n public Set getTags() {\n dataLock.readLock().lock();\n\n try {\n return eDAO.getTagDAO().getTags();\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Retrieves the Tags that are in use\n *\n * @return a Set of Tags.\n */\n @NotNull\n public Set getTagsInUse() {\n dataLock.readLock().lock();\n\n try {\n return getTransactions()\n .parallelStream()\n .flatMap((Function>) transaction -> transaction.getTags().stream())\n .collect(Collectors.toSet());\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n /**\n * Removes a Tag from the database.\n * \n * The removal will fail if the Tag is in use.\n *\n * @param tag Tag to remove\n * @return true if successful\n */\n public boolean removeTag(@NotNull Tag tag) {\n Objects.requireNonNull(tag);\n\n dataLock.writeLock().lock();\n\n try {\n boolean result = !getTagsInUse().contains(tag); // make sure the tag is not used\n\n if (result) {\n result = moveObjectToTrash(tag);\n }\n\n final Message message = new Message(MessageChannel.TAG, result ? ChannelEvent.TAG_REMOVE\n : ChannelEvent.TAG_REMOVE_FAILED, this);\n message.setObject(MessageProperty.TAG, tag);\n messageBus.fireEvent(message);\n\n return result;\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Returns the unique identifier for this engine instance.\n *\n * @return uuid\n */\n public String getUuid() {\n return uuid;\n }\n\n public void setPreference(@NotNull final String key, @Nullable final String value) {\n dataLock.writeLock().lock();\n\n try {\n getConfig().setPreference(key, value);\n getConfigDAO().update(getConfig());\n\n config = null; // clear stale cached reference\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, getConfig());\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n @Nullable\n public String getPreference(@NotNull final String key) {\n dataLock.readLock().lock();\n\n try {\n return getConfig().getPreference(key);\n } finally {\n dataLock.readLock().unlock();\n }\n }\n\n public boolean getBoolean(@NotNull final String key, final boolean defaultValue) {\n boolean value = defaultValue;\n\n final String stringResult = getPreference(key);\n\n if (stringResult != null && !stringResult.isEmpty()) {\n value = Boolean.parseBoolean(stringResult);\n }\n\n return value;\n }\n\n public void putBoolean(@NotNull final String key, final boolean value) {\n setPreference(key, Boolean.toString(value));\n }\n\n public boolean createBackups() {\n return getConfig().createBackups();\n }\n\n public void setCreateBackups(final boolean createBackups) {\n dataLock.writeLock().lock();\n\n try {\n final Config backupConfig = getConfig();\n\n backupConfig.setCreateBackups(createBackups);\n getConfigDAO().update(backupConfig);\n\n config = null; // clear stale cached reference\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, backupConfig);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public int getRetainedBackupLimit() {\n return getConfig().getRetainedBackupLimit();\n }\n\n public void setRetainedBackupLimit(final int retainedBackupLimit) {\n dataLock.writeLock().lock();\n\n try {\n final Config backupConfig = getConfig();\n\n backupConfig.setRetainedBackupLimit(retainedBackupLimit);\n getConfigDAO().update(backupConfig);\n\n config = null; // clear stale cached reference\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, backupConfig);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n public boolean removeOldBackups() {\n return getConfig().removeOldBackups();\n }\n\n public void setRemoveOldBackups(final boolean removeOldBackups) {\n dataLock.writeLock().lock();\n\n try {\n final Config backupConfig = getConfig();\n\n backupConfig.setRemoveOldBackups(removeOldBackups);\n getConfigDAO().update(backupConfig);\n\n config = null; // clear stale cached reference\n\n Message message = new Message(MessageChannel.CONFIG, ChannelEvent.CONFIG_MODIFY, this);\n message.setObject(MessageProperty.CONFIG, backupConfig);\n messageBus.fireEvent(message);\n } finally {\n dataLock.writeLock().unlock();\n }\n }\n\n /**\n * Handles Background removal of {@code SecurityNode} history. This can an expensive operation that block normal\n * operations, so the removal is partitioned into small events to prevent stalling.\n *\n * @param securityNode SecurityNode being processed\n * @param daysOfWeek Collection of {code DayOfWeek} to remove\n */\n public void removeSecurityHistoryByDayOfWeek(final SecurityNode securityNode, final Collection daysOfWeek) {\n\n final Thread thread = new Thread(() -> {\n long delay = 0;\n\n for (final SecurityHistoryNode historyNode : new ArrayList<>(securityNode.getHistoryNodes())) {\n for (final DayOfWeek dayOfWeek : daysOfWeek) {\n if (historyNode.getLocalDate().getDayOfWeek() == dayOfWeek) {\n\n backgroundExecutorService.schedule(new BackgroundCallable(() -> {\n removeSecurityHistory(securityNode, historyNode.getLocalDate());\n return true;\n }), delay, TimeUnit.MILLISECONDS);\n\n delay += 750;\n }\n }\n }\n });\n\n thread.setDaemon(true);\n thread.setPriority(Thread.MIN_PRIORITY);\n thread.start();\n }\n\n /**\n * Thread to monitor background update of securities and terminate is network errors are occurring\n */\n private class SecuritiesUpdateRunnable extends Thread {\n\n private final List backgroundCallables;\n private final int delay;\n\n SecuritiesUpdateRunnable(final List callables, final int delay) {\n this.backgroundCallables = callables;\n this.delay = delay;\n }\n\n @Override\n public void run() {\n\n try {\n TimeUnit.SECONDS.sleep(delay); // for controlled delay at startup\n } catch (final InterruptedException ignored) {\n return;\n }\n\n int errors = 0;\n\n final CompletionService completionService = new ExecutorCompletionService<>(backgroundExecutorService);\n\n // submit the callables\n for (final BackgroundCallable backgroundCallable : backgroundCallables) {\n try {\n completionService.submit(backgroundCallable);\n } catch (final RejectedExecutionException ignored) {\n // ignore, race to shut down the executor was won\n }\n }\n\n // poll until complete or there have been too many errors\n while (errors < MAX_ERRORS && !Thread.currentThread().isInterrupted()) {\n try {\n final Future future = completionService.poll(1, TimeUnit.MINUTES);\n\n if (future == null) { // all done, no issues\n break;\n }\n\n errors += future.get() ? 0 : 1;\n\n } catch (final InterruptedException | ExecutionException e) {\n errors = Integer.MAX_VALUE;\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n }\n }\n\n // if there are too many errors, force cancellation\n if (errors > MAX_ERRORS || Thread.currentThread().isInterrupted()) {\n for (final BackgroundCallable backgroundCallable : backgroundCallables) {\n backgroundCallable.cancel = true; // stop all other callables\n }\n }\n }\n }\n\n /**\n * Decorates a Callable to indicate background engine activity is occurring.\n */\n private class BackgroundCallable implements Callable {\n\n private final Callable callable;\n\n volatile boolean cancel = false; // may be set to true to interrupt operation\n\n BackgroundCallable(@NotNull final Callable callable) {\n this.callable = callable;\n }\n\n @Override\n public Boolean call() throws Exception {\n\n if (!cancel) {\n if (backGroundCounter.incrementAndGet() == 1) {\n messageBus.fireEvent(new Message(MessageChannel.SYSTEM, ChannelEvent.BACKGROUND_PROCESS_STARTED,\n Engine.this));\n }\n\n try {\n return callable.call();\n } finally {\n if (backGroundCounter.decrementAndGet() == 0) {\n messageBus.fireEvent(new Message(MessageChannel.SYSTEM, ChannelEvent.BACKGROUND_PROCESS_STOPPED,\n Engine.this));\n }\n }\n }\n return false;\n }\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/EngineException.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\n/**\n * Unchecked Engine Exception\n */\npublic class EngineException extends RuntimeException {\n\n public EngineException(final String message) {\n super(message);\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/EngineFactory.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.io.IOException;\nimport java.nio.file.Files;\nimport java.nio.file.Path;\nimport java.nio.file.Paths;\nimport java.time.Instant;\nimport java.time.LocalDateTime;\nimport java.time.format.DateTimeFormatter;\nimport java.time.temporal.ChronoUnit;\nimport java.util.Collection;\nimport java.util.HashMap;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.UUID;\nimport java.util.function.DoubleConsumer;\nimport java.util.logging.Handler;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\nimport java.util.prefs.Preferences;\n\nimport jgnash.engine.jpa.JpaNetworkServer;\nimport jgnash.engine.jpa.SqlUtils;\nimport jgnash.engine.message.ChannelEvent;\nimport jgnash.engine.message.Message;\nimport jgnash.engine.message.MessageBus;\nimport jgnash.engine.message.MessageChannel;\nimport jgnash.engine.xstream.BinaryXStreamDataStore;\nimport jgnash.engine.xstream.XMLDataStore;\nimport jgnash.resource.util.OS;\nimport jgnash.resource.util.ResourceUtils;\nimport jgnash.util.FileMagic;\nimport jgnash.util.FileMagic.FileType;\nimport jgnash.util.FileUtils;\nimport jgnash.util.Nullable;\n\n/**\n * Factory class for obtaining an engine instance.\n * \n * The filename of the database or remote server must be explicitly set before an Engine instance will be returned\n *\n * @author Craig Cavanaugh\n */\npublic class EngineFactory {\n\n public static final char[] EMPTY_PASSWORD = new char[]{};\n\n public static final String LOCALHOST = \"localhost\";\n\n public static final String DEFAULT = \"default\";\n\n public static final String REMOTE_PREFIX = \"@\";\n\n private static final String LAST_DATABASE = \"LastDatabase\";\n\n private static final String LAST_HOST = \"LastHost\";\n\n private static final String LAST_PORT = \"LastPort\";\n\n private static final String USED_PASSWORD = \"LastUsedPassword\";\n\n private static final String LAST_REMOTE = \"LastRemote\";\n\n /**\n * Default directory for jGnash data. To be located in the default user\n * directory\n */\n private static final String DEFAULT_DIR = \"jGnash\";\n\n private static final Logger logger = Logger.getLogger(EngineFactory.class.getName());\n\n private static final Map engineMap = new HashMap<>();\n\n private static final Map dataStoreMap = new HashMap<>();\n\n private EngineFactory() {\n }\n\n /**\n * Registers a {@code Handler} with the class logger.\n * This also ensures the static logger is initialized.\n *\n * @param handler {@code Handler} to register\n */\n public static void addLogHandler(final Handler handler) {\n logger.addHandler(handler);\n }\n\n public static boolean doesDatabaseExist(final String database, final DataStoreType type) {\n if (FileUtils.fileHasExtension(database)) {\n return Files.isReadable(Paths.get(database));\n }\n\n return Files.isReadable(Paths.get(database + type.getDataStore().getFileExt()));\n }\n\n public static boolean deleteDatabase(final String database) {\n try {\n return Files.deleteIfExists(Paths.get(database));\n } catch (final IOException e) {\n logger.warning(e.getLocalizedMessage());\n return false;\n }\n }\n\n /**\n * Returns the engine with the given name.\n *\n * @param name engine name to look for\n * @return returns {@code null} if it does not exist\n */\n @Nullable\n public static synchronized Engine getEngine(final String name) {\n return engineMap.get(name);\n }\n\n private static void exportCompressedXML(final String engineName) {\n final Engine oldEngine = engineMap.get(engineName);\n final DataStore oldDataStore = dataStoreMap.get(engineName);\n\n exportCompressedXML(oldDataStore.getFileName(), oldEngine.getStoredObjects());\n }\n\n public static void exportCompressedXML(final String fileName, final Collection objects) {\n final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ofPattern(\"yyyyMMdd-HHmm\");\n\n final DataStore xmlDataStore = new XMLDataStore();\n\n Path xmlFile = Paths.get(FileUtils.stripFileExtension(fileName) + \"-\" + dateTimeFormatter.format(LocalDateTime.now())\n + xmlDataStore.getFileExt());\n\n // push the intermediary file to the temporary directory\n xmlFile = Paths.get(System.getProperty(\"java.io.tmpdir\") + xmlFile.getFileSystem().getSeparator()\n + xmlFile.getFileName().toString());\n\n xmlDataStore.saveAs(xmlFile, objects, ignored -> { });\n\n Path zipFile = Paths.get(FileUtils.stripFileExtension(fileName) + \"-\" + dateTimeFormatter.format(LocalDateTime.now())\n + \".zip\");\n\n FileUtils.compressFile(xmlFile, zipFile);\n\n try {\n Files.delete(xmlFile);\n } catch (final IOException e) {\n logger.log(Level.SEVERE, e.getLocalizedMessage(), e);\n logger.log(Level.WARNING, \"Was not able to delete the temporary file: {0}\", xmlFile);\n }\n }\n\n public static void removeOldCompressedXML(final String fileName, final int limit) {\n final Path path = Paths.get(fileName);\n\n String baseFile = FileUtils.stripFileExtension(path.toString());\n\n // '\\' on Windows platform must be replaced with '\\\\' to prevent an exception\n if (OS.isSystemWindows()) {\n baseFile = baseFile.replace(\"\\\\\",\"\\\\\\\\\");\n }\n\n // old files use the base file name plus a '-' and a 8 digit date plus a '-' and a 4 digit time stamp\n final List fileList = FileUtils.getDirectoryListing(path.getParent(), baseFile + \"-\\\\d{8}-\\\\d{4}.zip\");\n\n if (fileList.size() > limit) {\n for (int i = 0; i < fileList.size() - limit; i++) {\n try {\n Files.delete(fileList.get(i));\n } catch (final IOException e) {\n logger.log(Level.WARNING, \"Unable to delete the file: {0}\", fileList.get(i));\n }\n }\n }\n }\n\n public static synchronized void closeEngine(final String engineName) {\n Engine oldEngine = engineMap.get(engineName);\n DataStore oldDataStore = dataStoreMap.get(engineName);\n\n if (oldEngine != null) {\n\n // stop and wait for all working background services to complete\n oldEngine.stopBackgroundServices();\n\n // Post a message so the GUI knows what is going on\n final Message message = new Message(MessageChannel.SYSTEM, ChannelEvent.FILE_CLOSING, oldEngine);\n MessageBus.getInstance(engineName).fireBlockingEvent(message); // block until event has been completely processed\n\n if (oldEngine.isFileDirty()) { // should a backup file be created?\n // Dump an XML backup\n if (oldEngine.createBackups() && oldDataStore.isLocal()) {\n exportCompressedXML(engineName);\n }\n\n // Purge old backups\n if (oldEngine.removeOldBackups() && oldDataStore.isLocal()) {\n removeOldCompressedXML(oldDataStore.getFileName(), oldEngine.getRetainedBackupLimit());\n }\n } else {\n logger.info(\"File was not dirty\");\n }\n\n // Initiate a complete shutdown\n oldEngine.shutdown();\n\n MessageBus.getInstance(engineName).setLocal();\n\n oldDataStore.closeEngine();\n\n engineMap.remove(engineName);\n dataStoreMap.remove(engineName);\n }\n }\n\n /**\n * Boots a local Engine for a preexisting file. The API determines the\n * correct file type and uses the correct DataStoreType for engine\n * initialization. If successful, a new\n * {@code Engine} instance will be returned.\n *\n * @param fileName filename to load\n * @param engineName engine identifier\n * @param password connection password\n * @return new {@code Engine} instance if successful, null otherwise\n * @see Engine\n */\n public static synchronized Engine bootLocalEngine(final String fileName, final String engineName,\n final char[] password) {\n final DataStoreType type = getDataStoreByType(fileName);\n\n Engine engine = null;\n\n if (type != null) {\n engine = bootLocalEngine(fileName, engineName, password, type);\n }\n\n return engine;\n }\n\n /**\n * Boots a local Engine for a file. If the file does not exist, it will be created. Otherwise it will be loaded.\n * If successful, a new {@code Engine} instance will be returned.\n *\n * @param fileName filename to load or create\n * @param engineName engine identifier\n * @param password password for the file\n * @param type {@code DataStoreType} type to use for storage\n * @return new {@code Engine} instance if successful\n * @see Engine\n * @see DataStoreType\n */\n public static synchronized Engine bootLocalEngine(final String fileName, final String engineName,\n final char[] password, final DataStoreType type) {\n\n Instant start = Instant.now();\n\n MessageBus.getInstance(engineName).setLocal();\n\n final DataStore dataStore = type.getDataStore();\n\n final Engine engine = dataStore.getLocalEngine(fileName, engineName, password);\n\n if (engine != null) {\n logger.info(ResourceUtils.getString(\"Message.EngineStart\"));\n engineMap.put(engineName, engine);\n dataStoreMap.put(engineName, dataStore);\n\n Message message = new Message(MessageChannel.SYSTEM, ChannelEvent.FILE_LOAD_SUCCESS, engine);\n MessageBus.getInstance(engineName).fireEvent(message);\n\n if (engineName.equals(EngineFactory.DEFAULT)) {\n Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n pref.putBoolean(USED_PASSWORD, password.length > 0);\n pref.put(LAST_DATABASE, fileName);\n pref.putBoolean(LAST_REMOTE, false);\n }\n\n logger.log(Level.INFO, \"Boot time was {0} milliseconds\",\n ChronoUnit.MILLIS.between(start, Instant.now()));\n }\n return engine;\n }\n\n public static synchronized Engine bootClientEngine(final String host, final int port, final char[] password,\n final String engineName) {\n\n if (engineMap.get(engineName) != null) {\n throw new EngineException(\"A stale engine was found in the map\");\n }\n\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n Engine engine = null;\n\n // start the client message bus\n if (MessageBus.getInstance(engineName).setRemote(host, port + JpaNetworkServer.MESSAGE_SERVER_INCREMENT,\n password)) {\n\n pref.putInt(LAST_PORT, port);\n pref.put(LAST_HOST, host);\n pref.putBoolean(LAST_REMOTE, true);\n\n final MessageBus messageBus = MessageBus.getInstance(engineName);\n\n // after starting the remote message bus, it should receive the path on the server\n final String remoteDataBasePath = messageBus.getRemoteDataBasePath();\n final DataStoreType dataStoreType = messageBus.getRemoteDataStoreType();\n\n if (remoteDataBasePath == null || remoteDataBasePath.isEmpty() || dataStoreType == null) {\n throw new EngineException(\"Invalid connection wih the message bus\");\n }\n\n logger.log(Level.INFO, \"Remote path was {0}\", remoteDataBasePath);\n logger.log(Level.INFO, \"Remote data store was {0}\", dataStoreType.name());\n logger.log(Level.INFO, \"Engine name was {0}\", engineName);\n\n DataStore dataStore = dataStoreType.getDataStore();\n\n // connect to the remote server\n engine = dataStore.getClientEngine(host, port, password, remoteDataBasePath);\n\n if (engine != null) {\n logger.info(ResourceUtils.getString(\"Message.EngineStart\"));\n\n engineMap.put(engineName, engine);\n dataStoreMap.put(engineName, dataStore);\n\n // remember if the user used a password for the last session\n pref.putBoolean(USED_PASSWORD, password.length > 0);\n\n final Message message = new Message(MessageChannel.SYSTEM, ChannelEvent.FILE_LOAD_SUCCESS, engine);\n MessageBus.getInstance(engineName).fireEvent(message);\n }\n }\n\n return engine;\n }\n\n private static DataStoreType getDataStoreByType(final Path file) {\n final FileType type = FileMagic.magic(file);\n\n switch (type) {\n case jGnash2XML:\n return DataStoreType.XML;\n case BinaryXStream:\n return DataStoreType.BINARY_XSTREAM;\n case h2:\n return DataStoreType.H2_DATABASE;\n case h2mv:\n return DataStoreType.H2MV_DATABASE;\n case hsql:\n return DataStoreType.HSQL_DATABASE;\n default: \t\n \tbreak;\n }\n\n return null;\n }\n\n public static DataStoreType getDataStoreByType(final String fileName) {\n return getDataStoreByType(Paths.get(fileName));\n }\n\n public static float getFileVersion(final Path file, final char[] password) {\n float version = 0;\n\n final FileType type = FileMagic.magic(file);\n\n switch (type) {\n case jGnash2XML:\n version = XMLDataStore.getFileVersion(file);\n break;\n case BinaryXStream:\n version = BinaryXStreamDataStore.getFileVersion(file);\n break;\n case h2:\n case h2mv:\n case hsql:\n try {\n version = SqlUtils.getFileVersion(file.toString(), password);\n } catch (final Exception e) {\n version = 0;\n }\n break;\n default:\n \tbreak;\n }\n\n return version;\n }\n\n /**\n * Returns the default path to the database without a file extension.\n *\n * @return Default path to the database\n */\n public static synchronized String getDefaultDatabase() {\n final String base = System.getProperty(\"user.home\");\n final String userName = System.getProperty(\"user.name\");\n\n return base + FileUtils.SEPARATOR + DEFAULT_DIR + FileUtils.SEPARATOR + userName;\n }\n\n /**\n * Returns the last open database. If a database has not been opened, then\n * the default database will be returned.\n *\n * @return Last open or default database\n */\n public static synchronized String getLastDatabase() {\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n return pref.get(LAST_DATABASE, getDefaultDatabase());\n }\n\n public static synchronized String getActiveDatabase() {\n if (getLastRemote()) {\n return REMOTE_PREFIX + getLastHost();\n }\n\n return getLastDatabase();\n }\n\n /**\n * Returns the host of the last remote database connection. If a remote\n * database has not been opened, then the default host will be returned.\n *\n * @return Last remote database host or default\n */\n public static synchronized String getLastHost() {\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n return pref.get(LAST_HOST, EngineFactory.LOCALHOST);\n }\n\n /**\n * Returns the port of the last remote database connection. If a remote\n * database has not been opened, then the default port will be returned.\n *\n * @return Last remote database port or default\n */\n public static synchronized int getLastPort() {\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n return pref.getInt(LAST_PORT, JpaNetworkServer.DEFAULT_PORT);\n }\n\n /**\n * Returns true if the last connection was made to a remote host.\n *\n * @return true if the last connection was made to a remote host\n */\n public static synchronized boolean getLastRemote() {\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n return pref.getBoolean(LAST_REMOTE, false);\n }\n\n public static synchronized boolean usedPassword() {\n final Preferences pref = Preferences.userNodeForPackage(EngineFactory.class);\n\n return pref.getBoolean(USED_PASSWORD, false);\n }\n\n /**\n * Saves the active database as a new file/format\n *\n * @param destination new file\n * @param percentCompleteConsumer progress consumer\n * @throws IOException IO error\n */\n public static void saveAs(final String destination, final DoubleConsumer percentCompleteConsumer) throws IOException {\n\n final String fileExtension = \".\" + FileUtils.getFileExtension(destination);\n DataStoreType newFileType = DataStoreType.BINARY_XSTREAM; // default for a new file\n\n if (fileExtension.length() > 1) { // should have more than just the period in it\n for (final DataStoreType type : DataStoreType.values()) {\n if (type.getDataStore().getFileExt().equalsIgnoreCase(fileExtension)) {\n newFileType = type;\n break;\n }\n }\n }\n\n final Path newFile = Paths.get(FileUtils.stripFileExtension(destination)\n + newFileType.getDataStore().getFileExt());\n\n final Path current = Paths.get(EngineFactory.getActiveDatabase());\n\n // don't perform the save if the destination is going to overwrite the current database\n if (!current.equals(newFile)) {\n final DataStoreType currentType = dataStoreMap.get(EngineFactory.DEFAULT).getType();\n\n // Need to create an interim copy when converting a relational database\n if (currentType.supportsRemote && newFileType.supportsRemote) {\n final Path tempFile = Files.createTempFile(\"jgnash-tmp\", BinaryXStreamDataStore.FILE_EXT);\n\n Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n\n if (engine != null) {\n // Get collection of object to persist\n Collection objects = engine.getStoredObjects();\n\n // Write everything to a temporary file\n DataStoreType.BINARY_XSTREAM.getDataStore().saveAs(tempFile, objects, value -> {\n percentCompleteConsumer.accept(value * 0.5); // doing it twice\n });\n\n // Close the current file\n EngineFactory.closeEngine(EngineFactory.DEFAULT);\n\n // Boot the engine using the temporary file\n EngineFactory.bootLocalEngine(tempFile.toString(), EngineFactory.DEFAULT,\n EngineFactory.EMPTY_PASSWORD);\n\n engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n\n if (engine != null) {\n\n // Get collection of object to persist\n objects = engine.getStoredObjects();\n\n // Write everything to the new file and close\n newFileType.getDataStore().saveAs(newFile, objects,\n value -> percentCompleteConsumer.accept(0.5 + value * 0.5));\n EngineFactory.closeEngine(EngineFactory.DEFAULT);\n\n percentCompleteConsumer.accept(1);\n\n // Boot the engine with the new file\n EngineFactory.bootLocalEngine(newFile.toString(), EngineFactory.DEFAULT,\n EngineFactory.EMPTY_PASSWORD);\n }\n\n try {\n Files.delete(tempFile);\n } catch (final IOException ioe) {\n Logger.getLogger(EngineFactory.class.getName())\n .info(ResourceUtils.getString(\"Message.Error.RemoveTempFile\"));\n }\n }\n } else { // Simple\n Engine engine = EngineFactory.getEngine(EngineFactory.DEFAULT);\n\n if (engine != null) {\n final Collection objects = engine.getStoredObjects();\n newFileType.getDataStore().saveAs(newFile, objects, percentCompleteConsumer);\n EngineFactory.closeEngine(EngineFactory.DEFAULT);\n\n EngineFactory.bootLocalEngine(newFile.toString(), EngineFactory.DEFAULT,\n EngineFactory.EMPTY_PASSWORD);\n }\n }\n }\n }\n\n /**\n * Saves a closed database as a new file/format\n *\n * @param fileName file to save a copy of\n * @param newFileName new file\n * @param password password\n * @param percentCompleteConsumer progress consumer\n * \n * @throws IOException IO error\n */\n public static void saveAs(final String fileName, final String newFileName, final char[] password,\n final DoubleConsumer percentCompleteConsumer) throws IOException {\n\n Objects.requireNonNull(fileName);\n Objects.requireNonNull(newFileName);\n Objects.requireNonNull(password);\n\n final String ENGINE = UUID.randomUUID().toString(); // create a temporary engine ID for utility use only\n\n final String fileExtension = \".\" + FileUtils.getFileExtension(newFileName);\n\n DataStoreType newFileType = DataStoreType.BINARY_XSTREAM; // default for a new file\n\n // Determine the data store type given the file extension\n if (fileExtension.length() > 1) { // should have more than just the period in it\n for (final DataStoreType type : DataStoreType.values()) {\n if (type.getDataStore().getFileExt().equalsIgnoreCase(fileExtension)) {\n newFileType = type;\n break;\n }\n }\n }\n\n final Path newFile = Paths.get(FileUtils.stripFileExtension(newFileName)\n + newFileType.getDataStore().getFileExt());\n\n final Path current = Paths.get(fileName);\n\n // don't perform the save if the destination is going to overwrite the current database\n if (!current.equals(newFile)) {\n\n // Need to know the data store type for correct behavior\n final DataStoreType currentType = EngineFactory.getDataStoreByType(fileName);\n\n Objects.requireNonNull(currentType); // fail if type is null\n\n // Create a utility engine instead of using the default\n Engine engine = EngineFactory.bootLocalEngine(fileName, ENGINE, password);\n\n if (currentType.supportsRemote && newFileType.supportsRemote) { // Relational database\n final Path tempFile = Files.createTempFile(\"jgnash\", BinaryXStreamDataStore.FILE_EXT);\n\n if (engine != null) {\n // Get collection of object to persist\n Collection objects = engine.getStoredObjects();\n\n // Write everything to a temporary file\n DataStoreType.BINARY_XSTREAM.getDataStore().saveAs(tempFile, objects, value -> {\n percentCompleteConsumer.accept(value * 0.5); // doing it twice\n });\n EngineFactory.closeEngine(ENGINE);\n\n // Boot the engine with the temporary file\n engine = EngineFactory.bootLocalEngine(tempFile.toString(), ENGINE, EngineFactory.EMPTY_PASSWORD);\n\n if (engine != null) {\n\n // Get collection of object to persist\n objects = engine.getStoredObjects();\n\n // Write everything to the new file\n newFileType.getDataStore().saveAs(newFile, objects,\n value -> percentCompleteConsumer.accept(0.5 + value * 0.5));\n EngineFactory.closeEngine(ENGINE);\n\n // reset the password\n SqlUtils.changePassword(newFileName, EngineFactory.EMPTY_PASSWORD, password);\n percentCompleteConsumer.accept(1);\n }\n\n try {\n Files.delete(tempFile);\n } catch (final IOException ioe) {\n Logger.getLogger(EngineFactory.class.getName())\n .info(ResourceUtils.getString(\"Message.Error.RemoveTempFile\"));\n }\n }\n } else { // Simple\n if (engine != null) {\n final Collection objects = engine.getStoredObjects();\n newFileType.getDataStore().saveAs(newFile, objects, percentCompleteConsumer);\n EngineFactory.closeEngine(ENGINE);\n }\n }\n }\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/ExchangeRate.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.HashSet;\nimport java.util.List;\nimport java.util.Set;\nimport java.util.concurrent.locks.ReadWriteLock;\nimport java.util.concurrent.locks.ReentrantReadWriteLock;\nimport java.util.logging.Level;\nimport java.util.logging.Logger;\n\nimport javax.persistence.CascadeType;\nimport javax.persistence.Entity;\nimport javax.persistence.JoinTable;\nimport javax.persistence.OneToMany;\nimport javax.persistence.OrderBy;\nimport javax.persistence.PostLoad;\n\nimport jgnash.util.Nullable;\n\n/**\n * Exchange rate object.\n *\n * @author Craig Cavanaugh\n */\n@Entity\npublic class ExchangeRate extends StoredObject {\n\n @JoinTable\n @OrderBy(\"date\") //applying a sort order prevents refresh issues\n @OneToMany(cascade = {CascadeType.ALL})\n private final Set historyNodes = new HashSet<>();\n\n /**\n * Cache the last exchange rate.\n */\n transient private BigDecimal lastRate;\n\n /**\n * Identifier for the ExchangeRate object.\n */\n private String rateId;\n\n /**\n * ReadWrite lock.\n */\n private transient ReadWriteLock lock = new ReentrantReadWriteLock();\n\n /**\n * No argument constructor for reflection purposes.\n * \n * Do not use to create a new instance\n */\n @SuppressWarnings(\"unused\")\n public ExchangeRate() {\n }\n\n ExchangeRate(final String rateId) {\n this.rateId = rateId;\n }\n\n public boolean contains(final ExchangeRateHistoryNode node) {\n\n lock.readLock().lock();\n\n try {\n return historyNodes.contains(node);\n } finally {\n lock.readLock().unlock();\n }\n }\n\n public boolean contains(final LocalDate localDate) {\n\n lock.readLock().lock();\n\n boolean result = false;\n\n try {\n for (final ExchangeRateHistoryNode node : historyNodes) {\n if (localDate.compareTo(node.getLocalDate()) == 0) {\n result = true;\n break;\n }\n }\n } finally {\n lock.readLock().unlock();\n }\n\n return result;\n }\n\n public List getHistory() {\n // return a defensive copy\n List nodes = new ArrayList<>(historyNodes);\n Collections.sort(nodes);\n\n return nodes;\n }\n\n boolean addHistoryNode(final ExchangeRateHistoryNode node) {\n boolean result = false;\n\n lock.writeLock().lock();\n\n try {\n historyNodes.add(node);\n\n lastRate = null; // force an update\n\n result = true;\n } catch (final Exception ex) {\n Logger.getLogger(ExchangeRate.class.getName()).log(Level.SEVERE, ex.getLocalizedMessage(), ex);\n } finally {\n lock.writeLock().unlock();\n }\n\n return result;\n }\n\n @Nullable\n ExchangeRateHistoryNode getHistory(final LocalDate localDate) {\n ExchangeRateHistoryNode node = null;\n\n lock.readLock().lock();\n\n try {\n for (final ExchangeRateHistoryNode historyNode : historyNodes) {\n if (localDate.compareTo(historyNode.getLocalDate()) == 0) {\n node = historyNode;\n break;\n }\n }\n } finally {\n lock.readLock().unlock();\n }\n\n return node;\n }\n\n boolean removeHistoryNode(final ExchangeRateHistoryNode hNode) {\n\n lock.writeLock().lock();\n\n try {\n final boolean result = historyNodes.remove(hNode);\n\n if (result) {\n lastRate = null; // force an update\n }\n\n return result;\n } finally {\n lock.writeLock().unlock();\n }\n }\n\n public String getRateId() {\n return rateId;\n }\n\n public BigDecimal getRate() {\n lock.readLock().lock();\n\n try {\n if (lastRate == null) {\n if (!historyNodes.isEmpty()) {\n\n List nodes = getHistory();\n\n lastRate = nodes.get(nodes.size() - 1).getRate();\n } else {\n lastRate = BigDecimal.ONE;\n }\n }\n } finally {\n lock.readLock().unlock();\n }\n\n return lastRate;\n }\n\n /**\n * Returns the exchange rate for a given {@code LocalDate}.\n * \n * If a rate has not be set, {@code BigDecimal.ZERO} is returned\n *\n * @param localDate {@code LocalDate} for exchange\n * @return the exchange rate if known, otherwise {@code BigDecimal.ZERO}\n */\n BigDecimal getRate(final LocalDate localDate) {\n lock.readLock().lock();\n\n BigDecimal rate = BigDecimal.ZERO;\n\n try {\n for (ExchangeRateHistoryNode historyNode : historyNodes) {\n if (localDate.equals(historyNode.getLocalDate())) {\n rate = historyNode.getRate();\n break;\n }\n }\n } finally {\n lock.readLock().unlock();\n }\n\n return rate;\n }\n\n @Override\n public boolean equals(final Object other) {\n return this == other || other instanceof ExchangeRate && rateId.equals(((ExchangeRate) other).rateId);\n }\n\n @Override\n public int hashCode() {\n return super.hashCode() * 67 + rateId.hashCode();\n }\n\n /**\n * Required by XStream for proper initialization.\n *\n * @return Properly initialized ExchangeRate\n */\n protected Object readResolve() {\n postLoad();\n return this;\n }\n\n @PostLoad\n private void postLoad() {\n lock = new ReentrantReadWriteLock(true);\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/ExchangeRateDAO.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport jgnash.engine.dao.CommodityDAO;\n\n/**\n * DAO for exchange rate access.\n *\n * @author Craig Cavanaugh\n *\n */\nclass ExchangeRateDAO {\n\n private final CommodityDAO commodityDAO;\n\n ExchangeRateDAO(final CommodityDAO commodityDAO) {\n this.commodityDAO = commodityDAO;\n }\n\n ExchangeRate getExchangeRateNode(final CurrencyNode baseCurrency, final CurrencyNode exchangeCurrency) {\n if (baseCurrency.equals(exchangeCurrency)) {\n return null;\n }\n\n final String rateId = Engine.buildExchangeRateId(baseCurrency, exchangeCurrency);\n\n ExchangeRate node = commodityDAO.getExchangeNode(rateId);\n\n if (node == null) {\n node = new ExchangeRate(Engine.buildExchangeRateId(baseCurrency, exchangeCurrency));\n commodityDAO.addExchangeRate(node);\n }\n\n return node;\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/ExchangeRateHistoryNode.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport jgnash.util.NotNull;\n\nimport javax.persistence.Column;\nimport javax.persistence.Entity;\nimport javax.persistence.GeneratedValue;\nimport javax.persistence.GenerationType;\nimport javax.persistence.Id;\nimport javax.persistence.SequenceGenerator;\nimport java.io.Serializable;\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.Objects;\n\n/**\n * Exchange rate history node for a {@code ExchangeRate}.\n * {@code ExchangeRateHistoryNode} objects are immutable.\n *\n * @author Craig Cavanaugh\n */\n@Entity\n@SequenceGenerator(name = \"sequence\", allocationSize = 10)\npublic class ExchangeRateHistoryNode implements Comparable, Serializable {\n\n @SuppressWarnings(\"UnusedDeclaration\")\n @Id\n @GeneratedValue(generator = \"sequence\", strategy = GenerationType.SEQUENCE)\n public long id;\n\n @Column(precision = 20, scale = 8)\n private BigDecimal rate = BigDecimal.ZERO;\n\n private LocalDate date = LocalDate.now();\n\n /**\n * No argument constructor for reflection purposes.\n * Do not use to create a new instance\n */\n @SuppressWarnings(\"unused\")\n protected ExchangeRateHistoryNode() {\n }\n\n /**\n * Constructor.\n *\n * @param localDate date for this history node. The date will be trimmed\n * @param rate exchange rate for the given date\n */\n ExchangeRateHistoryNode(final LocalDate localDate, final BigDecimal rate) {\n Objects.requireNonNull(date);\n Objects.requireNonNull(rate);\n\n this.date = localDate;\n this.rate = rate;\n }\n\n public LocalDate getLocalDate() {\n return date;\n }\n\n @Override\n public int compareTo(@NotNull final ExchangeRateHistoryNode node) {\n return getLocalDate().compareTo(node.getLocalDate());\n }\n\n @Override\n public boolean equals(final Object o) {\n return this == o || o instanceof ExchangeRateHistoryNode\n && date.equals(((ExchangeRateHistoryNode) o).date);\n }\n\n @Override\n public int hashCode() {\n return date.hashCode();\n }\n\n public BigDecimal getRate() {\n return rate;\n }\n}"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/InvestmentAccountProxy.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.time.LocalDate;\nimport java.util.HashMap;\nimport java.util.List;\nimport java.util.concurrent.locks.Lock;\n\n/**\n * Investment Account Proxy class.\n *\n * @author Craig Cavanaugh\n */\nclass InvestmentAccountProxy extends AccountProxy {\n\n public InvestmentAccountProxy(final Account account) {\n super(account);\n }\n\n @Override\n public BigDecimal getBalance(final LocalDate start, final LocalDate end) {\n return getCashBalance(start, end).add(getMarketValue(start, end));\n }\n\n /**\n * Returns the cash balance plus the market value of the shares.\n *\n * @return cash balance\n */\n @Override\n public BigDecimal getBalance() {\n return getCashBalance().add(getMarketValue());\n }\n\n @Override\n public BigDecimal getBalance(final LocalDate date) {\n return getCashBalance(date).add(getMarketValue(date));\n }\n\n /**\n * Returns the cash balance of this account. Cash balance may be referred to as the \"sweep\" account where\n * the money market fund (cash) does not have it's own account number and the user see's it as a cash balance\n * in their account statements.\n * \n * @return cash balance of the account\n */\n @Override\n public BigDecimal getCashBalance() {\n return super.getBalance();\n }\n\n /**\n * Get the account's cash balance up to a specified index.\n *\n * @param index the balance of the account at the specified index.\n * @return the balance of the account at the specified index.\n */\n private BigDecimal getCashBalanceAt(final int index) {\n return super.getBalanceAt(index);\n }\n\n /**\n * Returns the balance of the transactions inclusive of the start and end dates.\n * \n * The balance includes the cash transactions and is based on the current market value.\n *\n * @param start The inclusive start date\n * @param end The inclusive end date\n * @return The ending balance\n */\n private BigDecimal getCashBalance(final LocalDate start, final LocalDate end) {\n return super.getBalance(start, end);\n }\n\n /**\n * Returns the cash account balance up to and inclusive of the supplied date.\n *\n * @param end The inclusive ending date\n * @return The ending cash balance\n */\n private BigDecimal getCashBalance(final LocalDate end) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n return !account.transactions.isEmpty()\n ? getCashBalance(account.getSortedTransactionList().get(0).getLocalDate(), end) : BigDecimal.ZERO;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns a market price for the supplied {@code SecurityNode} that is closest to the supplied date without\n * exceeding it. The history of the {@code SecurityNode} is searched as well as the account's transaction\n * history to find the closest market price without exceeding the supplied date.\n *\n * @param node security to search against\n * @param date date to search against\n * @return market price\n */\n private BigDecimal getMarketPrice(final SecurityNode node, final LocalDate date) {\n account.getTransactionLock().readLock().lock();\n\n try {\n return Engine.getMarketPrice(account.getSortedTransactionList(), node, account.getCurrencyNode(), date);\n } finally {\n account.getTransactionLock().readLock().unlock();\n }\n }\n\n /**\n * Returns the market value of this account.\n *\n * @return the market value of the account\n */\n @Override\n public BigDecimal getMarketValue() {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n\n BigDecimal marketValue = BigDecimal.ZERO;\n\n int count = account.getTransactionCount();\n\n if (count > 0) {\n LocalDate lastDate = account.getSortedTransactionList().get(count - 1).getLocalDate();\n\n /*\n * If the user was to enter a date value greater than the current date, then\n * \"new Date()\" is not sufficient to pick up the last transaction. If the\n * current date is greater, than it is used to force use of the latest\n * security price.\n */\n\n final LocalDate startDate = account.getSortedTransactionList().get(0).getLocalDate();\n\n if (lastDate.compareTo(LocalDate.now()) >= 0) {\n marketValue = getMarketValue(startDate, lastDate);\n } else {\n marketValue = getMarketValue(startDate, LocalDate.now());\n }\n }\n\n return marketValue;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the market value of the account at a specified date. The closest market price is used and only investment\n * transactions earlier and inclusive of the specified date are considered.\n *\n * @param date the end date to calculate the market value\n * @return the ending balance\n */\n private BigDecimal getMarketValue(final LocalDate date) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n BigDecimal marketValue = BigDecimal.ZERO;\n\n if (account.getTransactionCount() > 0) {\n marketValue = getMarketValue(account.getSortedTransactionList().get(0).getLocalDate(), date);\n }\n\n return marketValue;\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Returns the market value for an account.\n *\n * @param start inclusive start date\n * @param end inclusive end date\n * @return market value\n */\n private BigDecimal getMarketValue(final LocalDate start, final LocalDate end) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n final HashMap priceMap = new HashMap<>();\n\n // build lookup map for market prices\n for (final SecurityNode node : account.getSecurities()) {\n priceMap.put(node, getMarketPrice(node, end));\n }\n\n BigDecimal balance = BigDecimal.ZERO;\n\n // Get a defensive copy, JPA lazy updates can have side effects\n List transactions = account.getSortedTransactionList();\n\n for (final Transaction t : transactions) {\n if (t.getLocalDate().compareTo(start) >= 0 && t.getLocalDate().compareTo(end) <= 0) {\n if (t instanceof InvestmentTransaction) {\n balance = balance.add(((InvestmentTransaction) t).getMarketValue(priceMap.get(((InvestmentTransaction) t).getSecurityNode())));\n }\n }\n }\n\n return round(balance);\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Calculates the accounts market value based on the latest security price.\n *\n * @param index index to calculate the balance to\n * @return market value\n */\n private BigDecimal getMarketValueAt(final int index) {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n final HashMap priceMap = new HashMap<>();\n\n LocalDate today = LocalDate.now();\n\n // build lookup map for market prices\n for (final SecurityNode node : account.getSecurities()) {\n priceMap.put(node, getMarketPrice(node, today));\n }\n\n BigDecimal balance = BigDecimal.ZERO;\n\n for (int i = 0; i <= index; i++) {\n Transaction t = account.getTransactionAt(i);\n\n if (t instanceof InvestmentTransaction) {\n balance = balance.add(((InvestmentTransaction) t).getMarketValue(priceMap.get(((InvestmentTransaction) t).getSecurityNode())));\n }\n }\n\n return round(balance);\n } finally {\n l.unlock();\n }\n }\n\n private BigDecimal getReconciledMarketValue() {\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n final HashMap priceMap = new HashMap<>();\n\n // build lookup map for market prices\n for (final SecurityNode node :account.getSecurities()) {\n priceMap.put(node, getMarketPrice(node, LocalDate.now()));\n }\n\n BigDecimal balance = BigDecimal.ZERO;\n\n // Get a defensive copy, JPA lazy updates can have side effects\n List transactions = account.getSortedTransactionList();\n\n for (final Transaction t : transactions) {\n if (t instanceof InvestmentTransaction && t.getReconciled(account) == ReconciledState.RECONCILED) {\n balance = balance.add(((InvestmentTransaction) t).getMarketValue(priceMap.get(((InvestmentTransaction) t).getSecurityNode())));\n }\n }\n\n return round(balance);\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Calculates the reconciled balance of the account.\n *\n * @return the reconciled balance of this account\n */\n @Override\n public BigDecimal getReconciledBalance() {\n return super.getReconciledBalance().add(getReconciledMarketValue());\n }\n\n /**\n * Get the default opening balance for reconciling the account.\n *\n * @return Opening balance for reconciling the account\n */\n @Override\n public BigDecimal getOpeningBalanceForReconcile() {\n\n final Lock l = account.getTransactionLock().readLock();\n l.lock();\n\n try {\n final LocalDate date = account.getFirstUnreconciledTransactionDate();\n\n BigDecimal balance = BigDecimal.ZERO;\n\n final List transactions = account.getSortedTransactionList();\n\n for (int i = 0; i < transactions.size(); i++) {\n if (transactions.get(i).getLocalDate().equals(date)) {\n if (i > 0) {\n balance = getCashBalanceAt(i - 1).add(getMarketValueAt(i - 1));\n }\n break;\n }\n }\n\n return round(balance);\n } finally {\n l.unlock();\n }\n }\n\n /**\n * Scales / Rounds a given value to the scale of the accounts currency. Calculating Market value will result\n * in minor discrepancies. Use this before returning values for consistent calculations.\n *\n * @param value value to round\n * @return rounded value\n */\n private BigDecimal round(final BigDecimal value) {\n return value.setScale(account.getCurrencyNode().getScale(), MathConstants.roundingMode);\n }\n}\n"
},
{
"path": "jgnash-core/src/main/java/jgnash/engine/InvestmentPerformanceSummary.java",
"content": "/*\n * jGnash, a personal finance application\n * Copyright (C) 2001-2020 Craig Cavanaugh\n *\n * This program is free software: you can redistribute it and/or modify\n * it under the terms of the GNU General Public License as published by\n * the Free Software Foundation, either version 3 of the License, or\n * (at your option) any later version.\n *\n * This program is distributed in the hope that it will be useful,\n * but WITHOUT ANY WARRANTY; without even the implied warranty of\n * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\n * GNU General Public License for more details.\n *\n * You should have received a copy of the GNU General Public License\n * along with this program. If not, see .\n */\npackage jgnash.engine;\n\nimport java.math.BigDecimal;\nimport java.text.NumberFormat;\nimport java.time.LocalDate;\nimport java.util.ArrayList;\nimport java.util.Collections;\nimport java.util.List;\nimport java.util.Map;\nimport java.util.Objects;\nimport java.util.Set;\nimport java.util.TreeMap;\n\nimport org.apache.commons.lang3.tuple.ImmutablePair;\nimport org.apache.commons.lang3.tuple.Pair;\n\n/**\n * Investment Performance Summary Class.\n * \n * @author Craig Cavanaugh\n */\npublic class InvestmentPerformanceSummary {\n\n private final Account account;\n\n private LocalDate startDate;\n\n private LocalDate endDate;\n\n private final Map performanceData = new TreeMap<>();\n \n private final List
![\"jGnash](\"https://jgnash.github.io/img/jgnash-logo.png\"){kind=logo}
![\"PayPal\"](\"https://img.shields.io/badge/Donate-PayPal-green.svg\"){kind=icon}
![\"Download](\"https://img.shields.io/sourceforge/dt/jgnash.svg\")
![\"Build](\"https://travis-ci.org/ccavanaugh/jgnash.svg?branch=master\")
![\"IntelliJIDEA](\"https://github.com/jGnash/jgnash.github.io/blob/master/img/logo_IntelliJIDEA.png\"){kind=logo}