]> git.ktnx.net Git - mobile-ledger.git/blobdiff - app/src/main/java/net/ktnx/mobileledger/async/RetrieveTransactionsTask.java
a step towards API-independent JSON parsing of accounts
[mobile-ledger.git] / app / src / main / java / net / ktnx / mobileledger / async / RetrieveTransactionsTask.java
index 5360cd006e694acef276612afed88724e56d14c6..85f7665146b556303edfbe8435738b740394e50b 100644 (file)
@@ -27,8 +27,6 @@ import androidx.annotation.NonNull;
 import net.ktnx.mobileledger.App;
 import net.ktnx.mobileledger.err.HTTPException;
 import net.ktnx.mobileledger.json.v1_15.AccountListParser;
-import net.ktnx.mobileledger.json.v1_15.ParsedBalance;
-import net.ktnx.mobileledger.json.v1_15.ParsedLedgerAccount;
 import net.ktnx.mobileledger.json.v1_15.ParsedLedgerTransaction;
 import net.ktnx.mobileledger.json.v1_15.TransactionListParser;
 import net.ktnx.mobileledger.model.Data;
@@ -36,29 +34,30 @@ import net.ktnx.mobileledger.model.LedgerAccount;
 import net.ktnx.mobileledger.model.LedgerTransaction;
 import net.ktnx.mobileledger.model.LedgerTransactionAccount;
 import net.ktnx.mobileledger.model.MobileLedgerProfile;
-import net.ktnx.mobileledger.ui.activity.MainActivity;
+import net.ktnx.mobileledger.ui.MainModel;
 import net.ktnx.mobileledger.utils.NetworkUtil;
 
 import java.io.BufferedReader;
 import java.io.IOException;
 import java.io.InputStream;
 import java.io.InputStreamReader;
-import java.lang.ref.WeakReference;
 import java.net.HttpURLConnection;
 import java.net.MalformedURLException;
 import java.net.URLDecoder;
 import java.nio.charset.StandardCharsets;
 import java.text.ParseException;
 import java.util.ArrayList;
+import java.util.Collections;
 import java.util.HashMap;
+import java.util.List;
 import java.util.Locale;
 import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 
-public class RetrieveTransactionsTask
-        extends AsyncTask<Void, RetrieveTransactionsTask.Progress, String> {
+public class RetrieveTransactionsTask extends
+        AsyncTask<Void, RetrieveTransactionsTask.Progress, RetrieveTransactionsTask.Result> {
     private static final int MATCHING_TRANSACTIONS_LIMIT = 150;
     private static final Pattern reComment = Pattern.compile("^\\s*;");
     private static final Pattern reTransactionStart = Pattern.compile(
@@ -72,16 +71,21 @@ public class RetrieveTransactionsTask
     private static final Pattern reEnd = Pattern.compile("\\bid=\"addmodal\"");
     private static final Pattern reDecimalPoint = Pattern.compile("\\.\\d\\d?$");
     private static final Pattern reDecimalComma = Pattern.compile(",\\d\\d?$");
-    private WeakReference<MainActivity> contextRef;
     // %3A is '='
-    private Pattern reAccountName = Pattern.compile("/register\\?q=inacct%3A([a-zA-Z0-9%]+)\"");
-    private Pattern reAccountValue = Pattern.compile(
+    private final Pattern reAccountName =
+            Pattern.compile("/register\\?q=inacct%3A([a-zA-Z0-9%]+)\"");
+    private final Pattern reAccountValue = Pattern.compile(
             "<span class=\"[^\"]*\\bamount\\b[^\"]*\">\\s*([-+]?[\\d.,]+)(?:\\s+(\\S+))?</span>");
-    private MobileLedgerProfile profile;
-    public RetrieveTransactionsTask(WeakReference<MainActivity> contextRef,
-                                    @NonNull MobileLedgerProfile profile) {
-        this.contextRef = contextRef;
+    private final MainModel mainModel;
+    private final MobileLedgerProfile profile;
+    private final List<LedgerAccount> prevAccounts;
+    private int expectedPostingsCount = -1;
+    public RetrieveTransactionsTask(@NonNull MainModel mainModel,
+                                    @NonNull MobileLedgerProfile profile,
+                                    List<LedgerAccount> accounts) {
+        this.mainModel = mainModel;
         this.profile = profile;
+        this.prevAccounts = accounts;
     }
     private static void L(String msg) {
         //debug("transaction-parser", msg);
@@ -113,45 +117,37 @@ public class RetrieveTransactionsTask
             return null;
         }
     }
+    public MobileLedgerProfile getProfile() {
+        return profile;
+    }
     @Override
     protected void onProgressUpdate(Progress... values) {
         super.onProgressUpdate(values);
-        MainActivity context = getContext();
-        if (context == null)
-            return;
-        context.onRetrieveProgress(values[0]);
-    }
-    @Override
-    protected void onPreExecute() {
-        super.onPreExecute();
-        MainActivity context = getContext();
-        if (context == null)
-            return;
-        context.onRetrieveStart();
+        Data.backgroundTaskProgress.postValue(values[0]);
     }
     @Override
-    protected void onPostExecute(String error) {
-        super.onPostExecute(error);
-        MainActivity context = getContext();
-        if (context == null)
-            return;
-        context.onRetrieveDone(error);
+    protected void onPostExecute(Result result) {
+        super.onPostExecute(result);
+        Progress progress = new Progress();
+        progress.setState(ProgressState.FINISHED);
+        progress.setError(result.error);
+        onProgressUpdate(progress);
     }
     @Override
     protected void onCancelled() {
         super.onCancelled();
-        MainActivity context = getContext();
-        if (context == null)
-            return;
-        context.onRetrieveDone(null);
-    }
-    private String retrieveTransactionListLegacy() throws IOException, HTTPException {
         Progress progress = new Progress();
-        int maxTransactionId = Progress.INDETERMINATE;
-        ArrayList<LedgerAccount> list = new ArrayList<>();
+        progress.setState(ProgressState.FINISHED);
+        onProgressUpdate(progress);
+    }
+    private void retrieveTransactionListLegacy(List<LedgerAccount> accounts,
+                                               List<LedgerTransaction> transactions)
+            throws IOException, HTTPException {
+        Progress progress = Progress.indeterminate();
+        progress.setState(ProgressState.RUNNING);
+        progress.setTotal(expectedPostingsCount);
+        int maxTransactionId = -1;
         HashMap<String, LedgerAccount> map = new HashMap<>();
-        ArrayList<LedgerAccount> displayed = new ArrayList<>();
-        ArrayList<LedgerTransaction> transactions = new ArrayList<>();
         LedgerAccount lastAccount = null;
         ArrayList<LedgerAccount> syntheticAccounts = new ArrayList<>();
 
@@ -216,7 +212,7 @@ public class RetrieveTransactionsTask
                             }
                             lastAccount = new LedgerAccount(profile, accName, parentAccount);
 
-                            list.add(lastAccount);
+                            accounts.add(lastAccount);
                             map.put(accName, lastAccount);
 
                             state = ParserState.EXPECTING_ACCOUNT_AMOUNT;
@@ -279,7 +275,7 @@ public class RetrieveTransactionsTask
                             progress.setProgress(++processedTransactionCount);
                             if (maxTransactionId < transactionId)
                                 maxTransactionId = transactionId;
-                            if ((progress.getTotal() == Progress.INDETERMINATE) ||
+                            if ((progress.isIndeterminate()) ||
                                 (progress.getTotal() < transactionId))
                                 progress.setTotal(transactionId);
                             publishProgress(progress);
@@ -298,7 +294,7 @@ public class RetrieveTransactionsTask
                         if (m.find()) {
                             if (transactionId == 0)
                                 throw new TransactionParserException(
-                                        "Transaction Id is 0 while expecting " + "description");
+                                        "Transaction Id is 0 while expecting description");
 
                             String date = Objects.requireNonNull(m.group(1));
                             try {
@@ -309,8 +305,8 @@ public class RetrieveTransactionsTask
                                         new LedgerTransaction(transactionId, date, m.group(2));
                             }
                             catch (ParseException e) {
-                                e.printStackTrace();
-                                return String.format("Error parsing date '%s'", date);
+                                throw new TransactionParserException(
+                                        String.format("Error parsing date '%s'", date));
                             }
                             state = ParserState.EXPECTING_TRANSACTION_DETAILS;
                             L(String.format(Locale.ENGLISH,
@@ -359,15 +355,11 @@ public class RetrieveTransactionsTask
             }
 
             throwIfCancelled();
-
-            profile.setAndStoreAccountAndTransactionListFromWeb(list, transactions);
-
-            return null;
         }
     }
-    private @NonNull
-    LedgerAccount ensureAccountExists(String accountName, HashMap<String, LedgerAccount> map,
-                                      ArrayList<LedgerAccount> createdAccounts) {
+    @NonNull
+    public LedgerAccount ensureAccountExists(String accountName, HashMap<String, LedgerAccount> map,
+                                             ArrayList<LedgerAccount> createdAccounts) {
         LedgerAccount acc = map.get(accountName);
 
         if (acc != null)
@@ -386,81 +378,42 @@ public class RetrieveTransactionsTask
         createdAccounts.add(acc);
         return acc;
     }
-    private boolean retrieveAccountList() throws IOException, HTTPException {
-        Progress progress = new Progress();
-
+    public void addNumberOfPostings(int number) {
+        expectedPostingsCount += number;
+    }
+    private List<LedgerAccount> retrieveAccountList() throws IOException, HTTPException {
         HttpURLConnection http = NetworkUtil.prepareConnection(profile, "accounts");
         http.setAllowUserInteraction(false);
         switch (http.getResponseCode()) {
             case 200:
                 break;
             case 404:
-                return false;
+                return null;
             default:
                 throw new HTTPException(http.getResponseCode(), http.getResponseMessage());
         }
-        publishProgress(progress);
+        publishProgress(Progress.indeterminate());
         SQLiteDatabase db = App.getDatabase();
         ArrayList<LedgerAccount> list = new ArrayList<>();
         HashMap<String, LedgerAccount> map = new HashMap<>();
         HashMap<String, LedgerAccount> currentMap = new HashMap<>();
-        for (LedgerAccount acc : Objects.requireNonNull(profile.getAllAccounts()))
+        for (LedgerAccount acc : prevAccounts)
             currentMap.put(acc.getName(), acc);
+        throwIfCancelled();
         try (InputStream resp = http.getInputStream()) {
+            throwIfCancelled();
             if (http.getResponseCode() != 200)
                 throw new IOException(String.format("HTTP error %d", http.getResponseCode()));
 
             AccountListParser parser = new AccountListParser(resp);
+            expectedPostingsCount = 0;
 
             while (true) {
                 throwIfCancelled();
-                ParsedLedgerAccount parsedAccount = parser.nextAccount();
-                if (parsedAccount == null) {
+                LedgerAccount acc = parser.nextLedgerAccount(this, map);
+                if (acc == null)
                     break;
-                }
-
-                final String accName = parsedAccount.getAname();
-                LedgerAccount acc = map.get(accName);
-                if (acc != null)
-                    throw new RuntimeException(
-                            String.format("Account '%s' already present", acc.getName()));
-                String parentName = LedgerAccount.extractParentName(accName);
-                ArrayList<LedgerAccount> createdParents = new ArrayList<>();
-                LedgerAccount parent;
-                if (parentName == null) {
-                    parent = null;
-                }
-                else {
-                    parent = ensureAccountExists(parentName, map, createdParents);
-                    parent.setHasSubAccounts(true);
-                }
-                acc = new LedgerAccount(profile, accName, parent);
                 list.add(acc);
-                map.put(accName, acc);
-
-                String lastCurrency = null;
-                float lastCurrencyAmount = 0;
-                for (ParsedBalance b : parsedAccount.getAibalance()) {
-                    throwIfCancelled();
-                    final String currency = b.getAcommodity();
-                    final float amount = b.getAquantity()
-                                          .asFloat();
-                    if (currency.equals(lastCurrency)) {
-                        lastCurrencyAmount += amount;
-                    }
-                    else {
-                        if (lastCurrency != null) {
-                            acc.addAmount(lastCurrencyAmount, lastCurrency);
-                        }
-                        lastCurrency = currency;
-                        lastCurrencyAmount = amount;
-                    }
-                }
-                if (lastCurrency != null) {
-                    acc.addAmount(lastCurrencyAmount, lastCurrency);
-                }
-                for (LedgerAccount p : createdParents)
-                    acc.propagateAmountsTo(p);
             }
             throwIfCancelled();
         }
@@ -474,12 +427,12 @@ public class RetrieveTransactionsTask
             }
         }
 
-        profile.setAndStoreAccountListFromWeb(list);
-        return true;
+        return list;
     }
-    private boolean retrieveTransactionList() throws IOException, ParseException, HTTPException {
+    private List<LedgerTransaction> retrieveTransactionList()
+            throws IOException, ParseException, HTTPException {
         Progress progress = new Progress();
-        int maxTransactionId = Data.transactions.size();
+        progress.setTotal(expectedPostingsCount);
 
         HttpURLConnection http = NetworkUtil.prepareConnection(profile, "transactions");
         http.setAllowUserInteraction(false);
@@ -488,17 +441,17 @@ public class RetrieveTransactionsTask
             case 200:
                 break;
             case 404:
-                return false;
+                return null;
             default:
                 throw new HTTPException(http.getResponseCode(), http.getResponseMessage());
         }
+        ArrayList<LedgerTransaction> trList = new ArrayList<>();
         try (InputStream resp = http.getInputStream()) {
             throwIfCancelled();
-            ArrayList<LedgerTransaction> trList = new ArrayList<>();
 
             TransactionListParser parser = new TransactionListParser(resp);
 
-            int processedTransactionCount = 0;
+            int processedPostings = 0;
 
             while (true) {
                 throwIfCancelled();
@@ -510,54 +463,81 @@ public class RetrieveTransactionsTask
                 LedgerTransaction transaction = parsedTransaction.asLedgerTransaction();
                 trList.add(transaction);
 
-                progress.setProgress(++processedTransactionCount);
+                progress.setProgress(processedPostings += transaction.getAccounts()
+                                                                     .size());
+//                Logger.debug("trParser",
+//                        String.format(Locale.US, "Parsed transaction %d - %s", transaction
+//                        .getId(),
+//                                transaction.getDescription()));
+//                for (LedgerTransactionAccount acc : transaction.getAccounts()) {
+//                    Logger.debug("trParser",
+//                            String.format(Locale.US, "  %s", acc.getAccountName()));
+//                }
                 publishProgress(progress);
             }
 
             throwIfCancelled();
-            profile.setAndStoreTransactionList(trList);
         }
 
-        return true;
+        // json interface returns transactions if file order and the rest of the machinery
+        // expects them in reverse chronological order
+        Collections.sort(trList, (o1, o2) -> {
+            int res = o2.getDate()
+                        .compareTo(o1.getDate());
+            if (res != 0)
+                return res;
+            return Integer.compare(o2.getId(), o1.getId());
+        });
+        return trList;
     }
 
     @SuppressLint("DefaultLocale")
     @Override
-    protected String doInBackground(Void... params) {
+    protected Result doInBackground(Void... params) {
         Data.backgroundTaskStarted();
+        List<LedgerAccount> accounts;
+        List<LedgerTransaction> transactions;
         try {
-            if (!retrieveAccountList() || !retrieveTransactionList())
-                return retrieveTransactionListLegacy();
-            return null;
+            accounts = retrieveAccountList();
+            if (accounts == null)
+                transactions = null;
+            else
+                transactions = retrieveTransactionList();
+            if (accounts == null || transactions == null) {
+                accounts = new ArrayList<>();
+                transactions = new ArrayList<>();
+                retrieveTransactionListLegacy(accounts, transactions);
+            }
+            mainModel.setAndStoreAccountAndTransactionListFromWeb(accounts, transactions);
+
+            return new Result(accounts, transactions);
         }
         catch (MalformedURLException e) {
             e.printStackTrace();
-            return "Invalid server URL";
+            return new Result("Invalid server URL");
         }
         catch (HTTPException e) {
             e.printStackTrace();
-            return String.format("HTTP error %d: %s", e.getResponseCode(), e.getResponseMessage());
+            return new Result(String.format("HTTP error %d: %s", e.getResponseCode(),
+                    e.getResponseMessage()));
         }
         catch (IOException e) {
             e.printStackTrace();
-            return e.getLocalizedMessage();
+            return new Result(e.getLocalizedMessage());
         }
         catch (ParseException e) {
             e.printStackTrace();
-            return "Network error";
+            return new Result("Network error");
         }
         catch (OperationCanceledException e) {
             e.printStackTrace();
-            return "Operation cancelled";
+            return new Result("Operation cancelled");
         }
         finally {
             Data.backgroundTaskFinished();
         }
     }
-    private MainActivity getContext() {
-        return contextRef.get();
-    }
-    private void throwIfCancelled() {
+    public void throwIfCancelled() {
         if (isCancelled())
             throw new OperationCanceledException(null);
     }
@@ -566,28 +546,72 @@ public class RetrieveTransactionsTask
         EXPECTING_TRANSACTION_DESCRIPTION, EXPECTING_TRANSACTION_DETAILS
     }
 
+    public enum ProgressState {STARTING, RUNNING, FINISHED}
+
     public static class Progress {
-        public static final int INDETERMINATE = -1;
         private int progress;
         private int total;
+        private ProgressState state = ProgressState.RUNNING;
+        private String error = null;
+        private boolean indeterminate;
         Progress() {
-            this(INDETERMINATE, INDETERMINATE);
+            indeterminate = true;
         }
         Progress(int progress, int total) {
+            this.indeterminate = false;
             this.progress = progress;
             this.total = total;
         }
+        public static Progress indeterminate() {
+            return new Progress();
+        }
+        public static Progress finished(String error) {
+            Progress p = new Progress();
+            p.setState(ProgressState.FINISHED);
+            p.setError(error);
+            return p;
+        }
         public int getProgress() {
+            ensureState(ProgressState.RUNNING);
             return progress;
         }
         protected void setProgress(int progress) {
             this.progress = progress;
+            this.state = ProgressState.RUNNING;
         }
         public int getTotal() {
+            ensureState(ProgressState.RUNNING);
             return total;
         }
         protected void setTotal(int total) {
             this.total = total;
+            state = ProgressState.RUNNING;
+            indeterminate = total == -1;
+        }
+        private void ensureState(ProgressState wanted) {
+            if (state != wanted)
+                throw new IllegalStateException(
+                        String.format("Bad state: %s, expected %s", state, wanted));
+        }
+        public ProgressState getState() {
+            return state;
+        }
+        public void setState(ProgressState state) {
+            this.state = state;
+        }
+        public String getError() {
+            ensureState(ProgressState.FINISHED);
+            return error;
+        }
+        public void setError(String error) {
+            this.error = error;
+            state = ProgressState.FINISHED;
+        }
+        public boolean isIndeterminate() {
+            return indeterminate;
+        }
+        public void setIndeterminate(boolean indeterminate) {
+            this.indeterminate = indeterminate;
         }
     }
 
@@ -596,4 +620,17 @@ public class RetrieveTransactionsTask
             super(message);
         }
     }
+
+    public static class Result {
+        public String error;
+        public List<LedgerAccount> accounts;
+        public List<LedgerTransaction> transactions;
+        Result(String error) {
+            this.error = error;
+        }
+        Result(List<LedgerAccount> accounts, List<LedgerTransaction> transactions) {
+            this.accounts = accounts;
+            this.transactions = transactions;
+        }
+    }
 }