2 * Copyright © 2021 Damyan Ivanov.
3 * This file is part of MoLe.
4 * MoLe is free software: you can distribute it and/or modify it
5 * under the term of the GNU General Public License as published by
6 * the Free Software Foundation, either version 3 of the License, or
7 * (at your opinion), any later version.
9 * MoLe is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License terms for details.
14 * You should have received a copy of the GNU General Public License
15 * along with MoLe. If not, see <https://www.gnu.org/licenses/>.
18 package net.ktnx.mobileledger.async;
20 import android.annotation.SuppressLint;
21 import android.os.AsyncTask;
22 import android.os.OperationCanceledException;
24 import androidx.annotation.NonNull;
25 import androidx.room.Transaction;
27 import com.fasterxml.jackson.core.JsonParseException;
28 import com.fasterxml.jackson.databind.RuntimeJsonMappingException;
30 import net.ktnx.mobileledger.dao.AccountDAO;
31 import net.ktnx.mobileledger.dao.AccountValueDAO;
32 import net.ktnx.mobileledger.dao.TransactionAccountDAO;
33 import net.ktnx.mobileledger.dao.TransactionDAO;
34 import net.ktnx.mobileledger.db.Account;
35 import net.ktnx.mobileledger.db.AccountWithAmounts;
36 import net.ktnx.mobileledger.db.DB;
37 import net.ktnx.mobileledger.db.Option;
38 import net.ktnx.mobileledger.db.Profile;
39 import net.ktnx.mobileledger.db.TransactionAccount;
40 import net.ktnx.mobileledger.db.TransactionWithAccounts;
41 import net.ktnx.mobileledger.err.HTTPException;
42 import net.ktnx.mobileledger.json.API;
43 import net.ktnx.mobileledger.json.AccountListParser;
44 import net.ktnx.mobileledger.json.ApiNotSupportedException;
45 import net.ktnx.mobileledger.json.TransactionListParser;
46 import net.ktnx.mobileledger.model.Data;
47 import net.ktnx.mobileledger.model.LedgerAccount;
48 import net.ktnx.mobileledger.model.LedgerTransaction;
49 import net.ktnx.mobileledger.model.LedgerTransactionAccount;
50 import net.ktnx.mobileledger.ui.MainModel;
51 import net.ktnx.mobileledger.utils.Logger;
52 import net.ktnx.mobileledger.utils.NetworkUtil;
53 import net.ktnx.mobileledger.utils.Profiler;
55 import java.io.BufferedReader;
56 import java.io.IOException;
57 import java.io.InputStream;
58 import java.io.InputStreamReader;
59 import java.net.HttpURLConnection;
60 import java.net.MalformedURLException;
61 import java.net.URLDecoder;
62 import java.nio.charset.StandardCharsets;
63 import java.text.ParseException;
64 import java.util.ArrayList;
65 import java.util.Collections;
66 import java.util.Date;
67 import java.util.HashMap;
68 import java.util.List;
69 import java.util.Locale;
70 import java.util.Objects;
71 import java.util.regex.Matcher;
72 import java.util.regex.Pattern;
75 public class RetrieveTransactionsTask extends
76 AsyncTask<Void, RetrieveTransactionsTask.Progress, RetrieveTransactionsTask.Result> {
77 private static final int MATCHING_TRANSACTIONS_LIMIT = 150;
78 private static final Pattern reComment = Pattern.compile("^\\s*;");
79 private static final Pattern reTransactionStart = Pattern.compile(
80 "<tr class=\"title\" " + "id=\"transaction-(\\d+)" + "\"><td class=\"date" +
81 "\"[^\"]*>([\\d.-]+)</td>");
82 private static final Pattern reTransactionDescription =
83 Pattern.compile("<tr class=\"posting\" title=\"(\\S+)\\s(.+)");
84 private static final Pattern reTransactionDetails = Pattern.compile(
85 "^\\s+" + "([!*]\\s+)?" + "(\\S[\\S\\s]+\\S)\\s\\s+" + "(?:([^\\d\\s+\\-]+)\\s*)?" +
86 "([-+]?\\d[\\d,.]*)" + "(?:\\s*([^\\d\\s+\\-]+)\\s*$)?");
87 private static final Pattern reEnd = Pattern.compile("\\bid=\"addmodal\"");
88 private static final Pattern reDecimalPoint = Pattern.compile("\\.\\d\\d?$");
89 private static final Pattern reDecimalComma = Pattern.compile(",\\d\\d?$");
90 private static final String TAG = "RTT";
92 private final Pattern reAccountName =
93 Pattern.compile("/register\\?q=inacct%3A([a-zA-Z0-9%]+)\"");
94 private final Pattern reAccountValue = Pattern.compile(
95 "<span class=\"[^\"]*\\bamount\\b[^\"]*\">\\s*([-+]?[\\d.,]+)(?:\\s+(\\S+))?</span>");
96 private final MainModel mainModel;
97 private final Profile profile;
98 private int expectedPostingsCount = -1;
99 public RetrieveTransactionsTask(@NonNull MainModel mainModel, @NonNull Profile profile) {
100 this.mainModel = mainModel;
101 this.profile = profile;
103 private static void L(String msg) {
104 //debug("transaction-parser", msg);
106 static LedgerTransactionAccount parseTransactionAccountLine(String line) {
107 Matcher m = reTransactionDetails.matcher(line);
109 String postingStatus = m.group(1);
110 String acc_name = m.group(2);
111 String currencyPre = m.group(3);
112 String amount = Objects.requireNonNull(m.group(4));
113 String currencyPost = m.group(5);
115 String currency = null;
116 if ((currencyPre != null) && (currencyPre.length() > 0)) {
117 if ((currencyPost != null) && (currencyPost.length() > 0))
119 currency = currencyPre;
121 else if ((currencyPost != null) && (currencyPost.length() > 0)) {
122 currency = currencyPost;
125 amount = amount.replace(',', '.');
127 return new LedgerTransactionAccount(acc_name, Float.parseFloat(amount), currency, null);
134 protected void onProgressUpdate(Progress... values) {
135 super.onProgressUpdate(values);
136 Data.backgroundTaskProgress.postValue(values[0]);
139 protected void onPostExecute(Result result) {
140 super.onPostExecute(result);
141 Progress progress = new Progress();
142 progress.setState(ProgressState.FINISHED);
143 progress.setError(result.error);
144 onProgressUpdate(progress);
147 protected void onCancelled() {
149 Progress progress = new Progress();
150 progress.setState(ProgressState.FINISHED);
151 onProgressUpdate(progress);
153 private void retrieveTransactionListLegacy(List<LedgerAccount> accounts,
154 List<LedgerTransaction> transactions)
155 throws IOException, HTTPException {
156 Progress progress = Progress.indeterminate();
157 progress.setState(ProgressState.RUNNING);
158 progress.setTotal(expectedPostingsCount);
159 int maxTransactionId = -1;
160 HashMap<String, LedgerAccount> map = new HashMap<>();
161 LedgerAccount lastAccount = null;
162 ArrayList<LedgerAccount> syntheticAccounts = new ArrayList<>();
164 HttpURLConnection http = NetworkUtil.prepareConnection(profile, "journal");
165 http.setAllowUserInteraction(false);
166 publishProgress(progress);
167 if (http.getResponseCode() != 200)
168 throw new HTTPException(http.getResponseCode(), http.getResponseMessage());
170 try (InputStream resp = http.getInputStream()) {
171 if (http.getResponseCode() != 200)
172 throw new IOException(String.format("HTTP error %d", http.getResponseCode()));
174 int matchedTransactionsCount = 0;
176 ParserState state = ParserState.EXPECTING_ACCOUNT;
179 new BufferedReader(new InputStreamReader(resp, StandardCharsets.UTF_8));
181 int processedTransactionCount = 0;
182 int transactionId = 0;
183 LedgerTransaction transaction = null;
185 while ((line = buf.readLine()) != null) {
188 m = reComment.matcher(line);
190 // TODO: comments are ignored for now
191 // Log.v("transaction-parser", "Ignoring comment");
194 //L(String.format("State is %d", updating));
196 case EXPECTING_ACCOUNT:
197 if (line.equals("<h2>General Journal</h2>")) {
198 state = ParserState.EXPECTING_TRANSACTION;
199 L("→ expecting transaction");
202 m = reAccountName.matcher(line);
204 String acct_encoded = m.group(1);
205 String accName = URLDecoder.decode(acct_encoded, "UTF-8");
206 accName = accName.replace("\"", "");
207 L(String.format("found account: %s", accName));
209 lastAccount = map.get(accName);
210 if (lastAccount != null) {
211 L(String.format("ignoring duplicate account '%s'", accName));
214 String parentAccountName = LedgerAccount.extractParentName(accName);
215 LedgerAccount parentAccount;
216 if (parentAccountName != null) {
217 parentAccount = ensureAccountExists(parentAccountName, map,
221 parentAccount = null;
223 lastAccount = new LedgerAccount(accName, parentAccount);
225 accounts.add(lastAccount);
226 map.put(accName, lastAccount);
228 state = ParserState.EXPECTING_ACCOUNT_AMOUNT;
229 L("→ expecting account amount");
233 case EXPECTING_ACCOUNT_AMOUNT:
234 m = reAccountValue.matcher(line);
235 boolean match_found = false;
240 String value = Objects.requireNonNull(m.group(1));
241 String currency = m.group(2);
242 if (currency == null)
246 Matcher tmpM = reDecimalComma.matcher(value);
248 value = value.replace(".", "");
249 value = value.replace(',', '.');
252 tmpM = reDecimalPoint.matcher(value);
254 value = value.replace(",", "");
255 value = value.replace(" ", "");
258 L("curr=" + currency + ", value=" + value);
259 final float val = Float.parseFloat(value);
260 lastAccount.addAmount(val, currency);
261 for (LedgerAccount syn : syntheticAccounts) {
262 L(String.format(Locale.ENGLISH, "propagating %s %1.2f to %s",
263 currency, val, syn.getName()));
264 syn.addAmount(val, currency);
269 syntheticAccounts.clear();
270 state = ParserState.EXPECTING_ACCOUNT;
271 L("→ expecting account");
276 case EXPECTING_TRANSACTION:
277 if (!line.isEmpty() && (line.charAt(0) == ' '))
279 m = reTransactionStart.matcher(line);
281 transactionId = Integer.parseInt(Objects.requireNonNull(m.group(1)));
282 state = ParserState.EXPECTING_TRANSACTION_DESCRIPTION;
283 L(String.format(Locale.ENGLISH,
284 "found transaction %d → expecting description", transactionId));
285 progress.setProgress(++processedTransactionCount);
286 if (maxTransactionId < transactionId)
287 maxTransactionId = transactionId;
288 if ((progress.isIndeterminate()) ||
289 (progress.getTotal() < transactionId))
290 progress.setTotal(transactionId);
291 publishProgress(progress);
293 m = reEnd.matcher(line);
295 L("--- transaction value complete ---");
300 case EXPECTING_TRANSACTION_DESCRIPTION:
301 if (!line.isEmpty() && (line.charAt(0) == ' '))
303 m = reTransactionDescription.matcher(line);
305 if (transactionId == 0)
306 throw new TransactionParserException(
307 "Transaction Id is 0 while expecting description");
309 String date = Objects.requireNonNull(m.group(1));
311 int equalsIndex = date.indexOf('=');
312 if (equalsIndex >= 0)
313 date = date.substring(equalsIndex + 1);
315 new LedgerTransaction(transactionId, date, m.group(2));
317 catch (ParseException e) {
318 throw new TransactionParserException(
319 String.format("Error parsing date '%s'", date));
321 state = ParserState.EXPECTING_TRANSACTION_DETAILS;
322 L(String.format(Locale.ENGLISH,
323 "transaction %d created for %s (%s) →" + " expecting details",
324 transactionId, date, m.group(2)));
328 case EXPECTING_TRANSACTION_DETAILS:
329 if (line.isEmpty()) {
330 // transaction data collected
332 transaction.finishLoading();
333 transactions.add(transaction);
335 state = ParserState.EXPECTING_TRANSACTION;
336 L(String.format("transaction %s parsed → expecting transaction",
337 transaction.getLedgerId()));
339 // sounds like a good idea, but transaction-1 may not be the first one chronologically
340 // for example, when you add the initial seeding transaction after entering some others
341 // if (transactionId == 1) {
342 // L("This was the initial transaction.
349 LedgerTransactionAccount lta = parseTransactionAccountLine(line);
351 transaction.addAccount(lta);
352 L(String.format(Locale.ENGLISH, "%d: %s = %s",
353 transaction.getLedgerId(), lta.getAccountName(),
357 throw new IllegalStateException(
358 String.format("Can't parse transaction %d details: %s",
359 transactionId, line));
363 throw new RuntimeException(
364 String.format("Unknown parser updating %s", state.name()));
372 public LedgerAccount ensureAccountExists(String accountName, HashMap<String, LedgerAccount> map,
373 ArrayList<LedgerAccount> createdAccounts) {
374 LedgerAccount acc = map.get(accountName);
379 String parentName = LedgerAccount.extractParentName(accountName);
380 LedgerAccount parentAccount;
381 if (parentName != null) {
382 parentAccount = ensureAccountExists(parentName, map, createdAccounts);
385 parentAccount = null;
388 acc = new LedgerAccount(accountName, parentAccount);
389 createdAccounts.add(acc);
392 public void addNumberOfPostings(int number) {
393 expectedPostingsCount += number;
395 private List<LedgerAccount> retrieveAccountList()
396 throws IOException, HTTPException, ApiNotSupportedException {
397 final API apiVersion = API.valueOf(profile.getApiVersion());
398 if (apiVersion.equals(API.auto)) {
399 return retrieveAccountListAnyVersion();
401 else if (apiVersion.equals(API.html)) {
403 "Declining using JSON API for /accounts with configured legacy API version");
407 return retrieveAccountListForVersion(apiVersion);
410 private List<LedgerAccount> retrieveAccountListAnyVersion()
411 throws ApiNotSupportedException, IOException, HTTPException {
412 for (API ver : API.allVersions) {
414 return retrieveAccountListForVersion(ver);
416 catch (JsonParseException | RuntimeJsonMappingException e) {
418 String.format(Locale.US, "Error during account list retrieval using API %s",
419 ver.getDescription()), e);
424 throw new ApiNotSupportedException();
426 private List<LedgerAccount> retrieveAccountListForVersion(API version)
427 throws IOException, HTTPException {
428 HttpURLConnection http = NetworkUtil.prepareConnection(profile, "accounts");
429 http.setAllowUserInteraction(false);
430 switch (http.getResponseCode()) {
436 throw new HTTPException(http.getResponseCode(), http.getResponseMessage());
438 publishProgress(Progress.indeterminate());
439 ArrayList<LedgerAccount> list = new ArrayList<>();
440 HashMap<String, LedgerAccount> map = new HashMap<>();
442 try (InputStream resp = http.getInputStream()) {
444 if (http.getResponseCode() != 200)
445 throw new IOException(String.format("HTTP error %d", http.getResponseCode()));
447 AccountListParser parser = AccountListParser.forApiVersion(version, resp);
448 expectedPostingsCount = 0;
452 LedgerAccount acc = parser.nextAccount(this, map);
462 private List<LedgerTransaction> retrieveTransactionList()
463 throws ParseException, HTTPException, IOException, ApiNotSupportedException {
464 final API apiVersion = API.valueOf(profile.getApiVersion());
465 if (apiVersion.equals(API.auto)) {
466 return retrieveTransactionListAnyVersion();
468 else if (apiVersion.equals(API.html)) {
470 "Declining using JSON API for /accounts with configured legacy API version");
474 return retrieveTransactionListForVersion(apiVersion);
478 private List<LedgerTransaction> retrieveTransactionListAnyVersion()
479 throws ApiNotSupportedException {
480 for (API ver : API.allVersions) {
482 return retrieveTransactionListForVersion(ver);
484 catch (Exception e) {
486 String.format(Locale.US, "Error during account list retrieval using API %s",
487 ver.getDescription()));
492 throw new ApiNotSupportedException();
494 private List<LedgerTransaction> retrieveTransactionListForVersion(API apiVersion)
495 throws IOException, ParseException, HTTPException {
496 Progress progress = new Progress();
497 progress.setTotal(expectedPostingsCount);
499 HttpURLConnection http = NetworkUtil.prepareConnection(profile, "transactions");
500 http.setAllowUserInteraction(false);
501 publishProgress(progress);
502 switch (http.getResponseCode()) {
508 throw new HTTPException(http.getResponseCode(), http.getResponseMessage());
510 ArrayList<LedgerTransaction> trList = new ArrayList<>();
511 try (InputStream resp = http.getInputStream()) {
514 TransactionListParser parser = TransactionListParser.forApiVersion(apiVersion, resp);
516 int processedPostings = 0;
520 LedgerTransaction transaction = parser.nextTransaction();
522 if (transaction == null)
525 trList.add(transaction);
527 progress.setProgress(processedPostings += transaction.getAccounts()
529 // Logger.debug("trParser",
530 // String.format(Locale.US, "Parsed transaction %d - %s", transaction
532 // transaction.getDescription()));
533 // for (LedgerTransactionAccount acc : transaction.getAccounts()) {
534 // Logger.debug("trParser",
535 // String.format(Locale.US, " %s", acc.getAccountName()));
537 publishProgress(progress);
543 // json interface returns transactions if file order and the rest of the machinery
544 // expects them in reverse chronological order
545 Collections.sort(trList, (o1, o2) -> {
546 int res = o2.getDate()
547 .compareTo(o1.getDate());
550 return Long.compare(o2.getLedgerId(), o1.getLedgerId());
555 @SuppressLint("DefaultLocale")
557 protected Result doInBackground(Void... params) {
558 Data.backgroundTaskStarted();
559 List<LedgerAccount> accounts;
560 List<LedgerTransaction> transactions;
562 accounts = retrieveAccountList();
563 // accounts is null in API-version auto-detection and means
564 // requesting 'html' API version via the JSON classes
565 // this can't work, and the null results in the legacy code below
567 if (accounts == null)
570 transactions = retrieveTransactionList();
572 if (accounts == null || transactions == null) {
573 accounts = new ArrayList<>();
574 transactions = new ArrayList<>();
575 retrieveTransactionListLegacy(accounts, transactions);
578 storeAccountsAndTransactions(accounts, transactions);
580 mainModel.updateDisplayedTransactionsFromWeb(transactions);
582 return new Result(accounts, transactions);
584 catch (MalformedURLException e) {
586 return new Result("Invalid server URL");
588 catch (HTTPException e) {
591 String.format("HTTP error %d: %s", e.getResponseCode(), e.getMessage()));
593 catch (IOException e) {
595 return new Result(e.getLocalizedMessage());
597 catch (RuntimeJsonMappingException e) {
599 return new Result(Result.ERR_JSON_PARSER_ERROR);
601 catch (ParseException e) {
603 return new Result("Network error");
605 catch (OperationCanceledException e) {
607 return new Result("Operation cancelled");
609 catch (ApiNotSupportedException e) {
611 return new Result("Server version not supported");
614 Data.backgroundTaskFinished();
618 private void storeAccountsAndTransactions(List<LedgerAccount> accounts,
619 List<LedgerTransaction> transactions) {
620 AccountDAO accDao = DB.get()
622 TransactionDAO trDao = DB.get()
623 .getTransactionDAO();
624 TransactionAccountDAO trAccDao = DB.get()
625 .getTransactionAccountDAO();
626 AccountValueDAO valDao = DB.get()
627 .getAccountValueDAO();
629 Logger.debug(TAG, "Preparing account list");
630 final List<AccountWithAmounts> list = new ArrayList<>();
631 for (LedgerAccount acc : accounts) {
632 final AccountWithAmounts a = acc.toDBOWithAmounts();
633 Account existing = accDao.getByNameSync(profile.getId(), acc.getName());
634 if (existing != null) {
635 a.account.setExpanded(existing.isExpanded());
636 a.account.setAmountsExpanded(existing.isAmountsExpanded());
638 existing.getId()); // not strictly needed, but since we have it anyway...
643 Logger.debug(TAG, "Account list prepared. Storing");
644 accDao.storeAccountsSync(list, profile.getId());
645 Logger.debug(TAG, "Account list stored");
647 Profiler tranProfiler = new Profiler("transactions");
648 Profiler tranAccProfiler = new Profiler("transaction accounts");
650 Logger.debug(TAG, "Storing transactions");
651 long trGen = trDao.getGenerationSync(profile.getId());
652 for (LedgerTransaction tr : transactions) {
653 TransactionWithAccounts tran = tr.toDBO();
654 tran.transaction.setGeneration(trGen);
655 tran.transaction.setProfileId(profile.getId());
657 tranProfiler.opStart();
658 tran.transaction.setId(trDao.insertSync(tran.transaction));
659 tranProfiler.opEnd();
661 for (TransactionAccount trAcc : tran.accounts) {
662 trAcc.setGeneration(trGen);
663 trAcc.setTransactionId(tran.transaction.getId());
664 tranAccProfiler.opStart();
665 trAcc.setId(trAccDao.insertSync(trAcc));
666 tranAccProfiler.opEnd();
670 tranProfiler.dumpStats();
671 tranAccProfiler.dumpStats();
673 Logger.debug(TAG, "Transactions stored. Purging old");
674 trDao.purgeOldTransactionsSync(profile.getId(), trGen);
675 Logger.debug(TAG, "Old transactions purged");
679 .insertSync(new Option(profile.getId(), Option.OPT_LAST_SCRAPE,
680 String.valueOf((new Date()).getTime())));
682 public void throwIfCancelled() {
684 throw new OperationCanceledException(null);
686 private enum ParserState {
687 EXPECTING_ACCOUNT, EXPECTING_ACCOUNT_AMOUNT, EXPECTING_TRANSACTION,
688 EXPECTING_TRANSACTION_DESCRIPTION, EXPECTING_TRANSACTION_DETAILS
691 public enum ProgressState {STARTING, RUNNING, FINISHED}
693 public static class Progress {
694 private int progress;
696 private ProgressState state = ProgressState.RUNNING;
697 private String error = null;
698 private boolean indeterminate;
700 indeterminate = true;
702 Progress(int progress, int total) {
703 this.indeterminate = false;
704 this.progress = progress;
707 public static Progress indeterminate() {
708 return new Progress();
710 public static Progress finished(String error) {
711 Progress p = new Progress();
712 p.setState(ProgressState.FINISHED);
716 public int getProgress() {
717 ensureState(ProgressState.RUNNING);
720 protected void setProgress(int progress) {
721 this.progress = progress;
722 this.state = ProgressState.RUNNING;
724 public int getTotal() {
725 ensureState(ProgressState.RUNNING);
728 protected void setTotal(int total) {
730 state = ProgressState.RUNNING;
731 indeterminate = total == -1;
733 private void ensureState(ProgressState wanted) {
735 throw new IllegalStateException(
736 String.format("Bad state: %s, expected %s", state, wanted));
738 public ProgressState getState() {
741 public void setState(ProgressState state) {
744 public String getError() {
745 ensureState(ProgressState.FINISHED);
748 public void setError(String error) {
750 state = ProgressState.FINISHED;
752 public boolean isIndeterminate() {
753 return indeterminate;
755 public void setIndeterminate(boolean indeterminate) {
756 this.indeterminate = indeterminate;
760 private static class TransactionParserException extends IllegalStateException {
761 TransactionParserException(String message) {
766 public static class Result {
767 public static String ERR_JSON_PARSER_ERROR = "err_json_parser";
769 public List<LedgerAccount> accounts;
770 public List<LedgerTransaction> transactions;
771 Result(String error) {
774 Result(List<LedgerAccount> accounts, List<LedgerTransaction> transactions) {
775 this.accounts = accounts;
776 this.transactions = transactions;