2 * Copyright © 2019 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.model;
20 import android.content.res.Resources;
21 import android.database.Cursor;
22 import android.database.sqlite.SQLiteDatabase;
23 import android.util.SparseArray;
25 import androidx.annotation.NonNull;
26 import androidx.annotation.Nullable;
28 import net.ktnx.mobileledger.App;
29 import net.ktnx.mobileledger.R;
30 import net.ktnx.mobileledger.async.DbOpQueue;
31 import net.ktnx.mobileledger.async.SendTransactionTask;
32 import net.ktnx.mobileledger.utils.Globals;
33 import net.ktnx.mobileledger.utils.Logger;
34 import net.ktnx.mobileledger.utils.MLDB;
35 import net.ktnx.mobileledger.utils.Misc;
37 import java.util.ArrayList;
38 import java.util.Date;
39 import java.util.List;
40 import java.util.Locale;
41 import java.util.UUID;
43 import static net.ktnx.mobileledger.utils.Logger.debug;
45 public final class MobileLedgerProfile {
46 // N.B. when adding new fields, update the copy-constructor below
49 private boolean permitPosting;
50 private boolean showCommentsByDefault;
51 private boolean showCommodityByDefault;
52 private String defaultCommodity;
53 private String preferredAccountsFilter;
55 private boolean authEnabled;
56 private String authUserName;
57 private String authPassword;
59 private int orderNo = -1;
60 // N.B. when adding new fields, update the copy-constructor below
61 private FutureDates futureDates = FutureDates.None;
62 private SendTransactionTask.API apiVersion = SendTransactionTask.API.auto;
63 public MobileLedgerProfile() {
64 this.uuid = String.valueOf(UUID.randomUUID());
66 public MobileLedgerProfile(String uuid) {
69 public MobileLedgerProfile(MobileLedgerProfile origin) {
72 permitPosting = origin.permitPosting;
73 showCommentsByDefault = origin.showCommentsByDefault;
74 showCommodityByDefault = origin.showCommodityByDefault;
75 preferredAccountsFilter = origin.preferredAccountsFilter;
77 authEnabled = origin.authEnabled;
78 authUserName = origin.authUserName;
79 authPassword = origin.authPassword;
80 themeHue = origin.themeHue;
81 orderNo = origin.orderNo;
82 futureDates = origin.futureDates;
83 apiVersion = origin.apiVersion;
84 defaultCommodity = origin.defaultCommodity;
86 // loads all profiles into Data.profiles
87 // returns the profile with the given UUID
88 public static MobileLedgerProfile loadAllFromDB(String currentProfileUUID) {
89 MobileLedgerProfile result = null;
90 ArrayList<MobileLedgerProfile> list = new ArrayList<>();
91 SQLiteDatabase db = App.getDatabase();
92 try (Cursor cursor = db.rawQuery("SELECT uuid, name, url, use_authentication, auth_user, " +
93 "auth_password, permit_posting, theme, order_no, " +
94 "preferred_accounts_filter, future_dates, api_version, " +
95 "show_commodity_by_default, default_commodity, " +
96 "show_comments_by_default FROM " +
97 "profiles order by order_no", null))
99 while (cursor.moveToNext()) {
100 MobileLedgerProfile item = new MobileLedgerProfile(cursor.getString(0));
101 item.setName(cursor.getString(1));
102 item.setUrl(cursor.getString(2));
103 item.setAuthEnabled(cursor.getInt(3) == 1);
104 item.setAuthUserName(cursor.getString(4));
105 item.setAuthPassword(cursor.getString(5));
106 item.setPostingPermitted(cursor.getInt(6) == 1);
107 item.setThemeId(cursor.getInt(7));
108 item.orderNo = cursor.getInt(8);
109 item.setPreferredAccountsFilter(cursor.getString(9));
110 item.setFutureDates(cursor.getInt(10));
111 item.setApiVersion(cursor.getInt(11));
112 item.setShowCommodityByDefault(cursor.getInt(12) == 1);
113 item.setDefaultCommodity(cursor.getString(13));
114 item.setShowCommentsByDefault(cursor.getInt(14) == 1);
117 .equals(currentProfileUUID))
121 Data.profiles.setValue(list);
124 public static void storeProfilesOrder() {
125 SQLiteDatabase db = App.getDatabase();
126 db.beginTransactionNonExclusive();
129 for (MobileLedgerProfile p : Data.profiles.getValue()) {
130 db.execSQL("update profiles set order_no=? where uuid=?",
131 new Object[]{orderNo, p.getUuid()});
135 db.setTransactionSuccessful();
141 public boolean getShowCommentsByDefault() {
142 return showCommentsByDefault;
144 public void setShowCommentsByDefault(boolean newValue) {
145 this.showCommentsByDefault = newValue;
147 public boolean getShowCommodityByDefault() {
148 return showCommodityByDefault;
150 public void setShowCommodityByDefault(boolean showCommodityByDefault) {
151 this.showCommodityByDefault = showCommodityByDefault;
153 public String getDefaultCommodity() {
154 return defaultCommodity;
156 public void setDefaultCommodity(String defaultCommodity) {
157 this.defaultCommodity = defaultCommodity;
159 public void setDefaultCommodity(CharSequence defaultCommodity) {
160 if (defaultCommodity == null)
161 this.defaultCommodity = null;
163 this.defaultCommodity = String.valueOf(defaultCommodity);
165 public SendTransactionTask.API getApiVersion() {
168 public void setApiVersion(SendTransactionTask.API apiVersion) {
169 this.apiVersion = apiVersion;
171 public void setApiVersion(int apiVersion) {
172 this.apiVersion = SendTransactionTask.API.valueOf(apiVersion);
174 public FutureDates getFutureDates() {
177 public void setFutureDates(int anInt) {
178 futureDates = FutureDates.valueOf(anInt);
180 public void setFutureDates(FutureDates futureDates) {
181 this.futureDates = futureDates;
183 public String getPreferredAccountsFilter() {
184 return preferredAccountsFilter;
186 public void setPreferredAccountsFilter(String preferredAccountsFilter) {
187 this.preferredAccountsFilter = preferredAccountsFilter;
189 public void setPreferredAccountsFilter(CharSequence preferredAccountsFilter) {
190 setPreferredAccountsFilter(String.valueOf(preferredAccountsFilter));
192 public boolean isPostingPermitted() {
193 return permitPosting;
195 public void setPostingPermitted(boolean permitPosting) {
196 this.permitPosting = permitPosting;
198 public String getUuid() {
201 public String getName() {
204 public void setName(CharSequence text) {
205 setName(String.valueOf(text));
207 public void setName(String name) {
210 public String getUrl() {
213 public void setUrl(CharSequence text) {
214 setUrl(String.valueOf(text));
216 public void setUrl(String url) {
219 public boolean isAuthEnabled() {
222 public void setAuthEnabled(boolean authEnabled) {
223 this.authEnabled = authEnabled;
225 public String getAuthUserName() {
228 public void setAuthUserName(CharSequence text) {
229 setAuthUserName(String.valueOf(text));
231 public void setAuthUserName(String authUserName) {
232 this.authUserName = authUserName;
234 public String getAuthPassword() {
237 public void setAuthPassword(CharSequence text) {
238 setAuthPassword(String.valueOf(text));
240 public void setAuthPassword(String authPassword) {
241 this.authPassword = authPassword;
243 public void storeInDB() {
244 SQLiteDatabase db = App.getDatabase();
245 db.beginTransactionNonExclusive();
247 // debug("profiles", String.format("Storing profile in DB: uuid=%s, name=%s, " +
248 // "url=%s, permit_posting=%s, authEnabled=%s, " +
249 // "themeHue=%d", uuid, name, url,
250 // permitPosting ? "TRUE" : "FALSE", authEnabled ? "TRUE" : "FALSE", themeHue));
251 db.execSQL("REPLACE INTO profiles(uuid, name, permit_posting, url, " +
252 "use_authentication, auth_user, auth_password, theme, order_no, " +
253 "preferred_accounts_filter, future_dates, api_version, " +
254 "show_commodity_by_default, default_commodity, show_comments_by_default) " +
255 "VALUES(?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?)",
256 new Object[]{uuid, name, permitPosting, url, authEnabled,
257 authEnabled ? authUserName : null,
258 authEnabled ? authPassword : null, themeHue, orderNo,
259 preferredAccountsFilter, futureDates.toInt(), apiVersion.toInt(),
260 showCommodityByDefault, defaultCommodity, showCommentsByDefault
262 db.setTransactionSuccessful();
268 public void storeAccount(SQLiteDatabase db, LedgerAccount acc) {
269 // replace into is a bad idea because it would reset hidden to its default value
270 // we like the default, but for new accounts only
271 db.execSQL("update accounts set level = ?, keep = 1, hidden=?, expanded=? " +
272 "where profile=? and name = ?",
273 new Object[]{acc.getLevel(), acc.isHiddenByStar(), acc.isExpanded(), uuid,
276 db.execSQL("insert into accounts(profile, name, name_upper, parent_name, level, hidden, " +
277 "expanded, keep) " + "select ?,?,?,?,?,?,?,1 where (select changes() = 0)",
278 new Object[]{uuid, acc.getName(), acc.getName().toUpperCase(), acc.getParentName(),
279 acc.getLevel(), acc.isHiddenByStar(), acc.isExpanded()
281 // debug("accounts", String.format("Stored account '%s' in DB [%s]", acc.getName(), uuid));
283 public void storeAccountValue(SQLiteDatabase db, String name, String currency, Float amount) {
284 db.execSQL("replace into account_values(profile, account, " +
285 "currency, value, keep) values(?, ?, ?, ?, 1);",
286 new Object[]{uuid, name, Misc.emptyIsNull(currency), amount});
288 public void storeTransaction(SQLiteDatabase db, LedgerTransaction tr) {
290 db.execSQL("DELETE from transactions WHERE profile=? and id=?",
291 new Object[]{uuid, tr.getId()});
292 db.execSQL("DELETE from transaction_accounts WHERE profile = ? and transaction_id=?",
293 new Object[]{uuid, tr.getId()});
296 "INSERT INTO transactions(profile, id, date, description, comment, data_hash, " +
298 "values(?,?,?,?,?,?,1)",
299 new Object[]{uuid, tr.getId(), Globals.formatLedgerDate(tr.getDate()),
300 tr.getDescription(), tr.getComment(), tr.getDataHash()
303 for (LedgerTransactionAccount item : tr.getAccounts()) {
304 db.execSQL("INSERT INTO transaction_accounts(profile, transaction_id, " +
305 "account_name, amount, currency, comment) values(?, ?, ?, ?, ?, ?)",
306 new Object[]{uuid, tr.getId(), item.getAccountName(), item.getAmount(),
307 Misc.nullIsEmpty(item.getCurrency()), item.getComment()
310 // debug("profile", String.format("Transaction %d stored", tr.getId()));
312 public String getOption(String name, String default_value) {
313 SQLiteDatabase db = App.getDatabase();
314 try (Cursor cursor = db.rawQuery("select value from options where profile = ? and name=?",
315 new String[]{uuid, name}))
317 if (cursor.moveToFirst()) {
318 String result = cursor.getString(0);
320 if (result == null) {
321 debug("profile", "returning default value for " + name);
322 result = default_value;
325 debug("profile", String.format("option %s=%s", name, result));
330 return default_value;
332 catch (Exception e) {
333 debug("db", "returning default value for " + name, e);
334 return default_value;
337 public long getLongOption(String name, long default_value) {
339 String result = getOption(name, "");
340 if ((result == null) || result.isEmpty()) {
341 debug("profile", String.format("Returning default value for option %s", name));
342 longResult = default_value;
346 longResult = Long.parseLong(result);
347 debug("profile", String.format("option %s=%s", name, result));
349 catch (Exception e) {
350 debug("profile", String.format("Returning default value for option %s", name), e);
351 longResult = default_value;
357 public void setOption(String name, String value) {
358 debug("profile", String.format("setting option %s=%s", name, value));
359 DbOpQueue.add("insert or replace into options(profile, name, value) values(?, ?, ?);",
360 new String[]{uuid, name, value});
362 public void setLongOption(String name, long value) {
363 setOption(name, String.valueOf(value));
365 public void removeFromDB() {
366 SQLiteDatabase db = App.getDatabase();
367 debug("db", String.format("removing profile %s from DB", uuid));
368 db.beginTransactionNonExclusive();
370 Object[] uuid_param = new Object[]{uuid};
371 db.execSQL("delete from profiles where uuid=?", uuid_param);
372 db.execSQL("delete from accounts where profile=?", uuid_param);
373 db.execSQL("delete from account_values where profile=?", uuid_param);
374 db.execSQL("delete from transactions where profile=?", uuid_param);
375 db.execSQL("delete from transaction_accounts where profile=?", uuid_param);
376 db.execSQL("delete from options where profile=?", uuid_param);
377 db.setTransactionSuccessful();
384 public LedgerAccount loadAccount(String name) {
385 SQLiteDatabase db = App.getDatabase();
386 return loadAccount(db, name);
389 public LedgerAccount tryLoadAccount(String acct_name) {
390 SQLiteDatabase db = App.getDatabase();
391 return tryLoadAccount(db, acct_name);
394 public LedgerAccount loadAccount(SQLiteDatabase db, String accName) {
395 LedgerAccount acc = tryLoadAccount(db, accName);
398 throw new RuntimeException("Unable to load account with name " + accName);
403 public LedgerAccount tryLoadAccount(SQLiteDatabase db, String accName) {
404 try (Cursor cursor = db.rawQuery(
405 "SELECT a.hidden, a.expanded, (select 1 from accounts a2 " +
406 "where a2.profile = a.profile and a2.name like a.name||':%' limit 1) " +
407 "FROM accounts a WHERE a.profile = ? and a.name=?", new String[]{uuid, accName}))
409 if (cursor.moveToFirst()) {
410 LedgerAccount acc = new LedgerAccount(accName);
411 acc.setHiddenByStar(cursor.getInt(0) == 1);
412 acc.setExpanded(cursor.getInt(1) == 1);
413 acc.setHasSubAccounts(cursor.getInt(2) == 1);
415 try (Cursor c2 = db.rawQuery(
416 "SELECT value, currency FROM account_values WHERE profile = ? " +
417 "AND account = ?", new String[]{uuid, accName}))
419 while (c2.moveToNext()) {
420 acc.addAmount(c2.getFloat(0), c2.getString(1));
429 public LedgerTransaction loadTransaction(int transactionId) {
430 LedgerTransaction tr = new LedgerTransaction(transactionId, this.uuid);
431 tr.loadData(App.getDatabase());
435 public int getThemeHue() {
436 // debug("profile", String.format("Profile.getThemeHue() returning %d", themeHue));
437 return this.themeHue;
439 public void setThemeHue(Object o) {
440 setThemeId(Integer.parseInt(String.valueOf(o)));
442 public void setThemeId(int themeHue) {
443 // debug("profile", String.format("Profile.setThemeHue(%d) called", themeHue));
444 this.themeHue = themeHue;
446 public void markTransactionsAsNotPresent(SQLiteDatabase db) {
447 db.execSQL("UPDATE transactions set keep=0 where profile=?", new String[]{uuid});
450 public void markAccountsAsNotPresent(SQLiteDatabase db) {
451 db.execSQL("update account_values set keep=0 where profile=?;", new String[]{uuid});
452 db.execSQL("update accounts set keep=0 where profile=?;", new String[]{uuid});
455 public void deleteNotPresentAccounts(SQLiteDatabase db) {
456 db.execSQL("delete from account_values where keep=0 and profile=?", new String[]{uuid});
457 db.execSQL("delete from accounts where keep=0 and profile=?", new String[]{uuid});
459 public void markTransactionAsPresent(SQLiteDatabase db, LedgerTransaction transaction) {
460 db.execSQL("UPDATE transactions SET keep = 1 WHERE profile = ? and id=?",
461 new Object[]{uuid, transaction.getId()
464 public void markTransactionsBeforeTransactionAsPresent(SQLiteDatabase db,
465 LedgerTransaction transaction) {
466 db.execSQL("UPDATE transactions SET keep=1 WHERE profile = ? and id < ?",
467 new Object[]{uuid, transaction.getId()
471 public void deleteNotPresentTransactions(SQLiteDatabase db) {
472 db.execSQL("DELETE FROM transactions WHERE profile=? AND keep = 0", new String[]{uuid});
474 public void setLastUpdateStamp() {
475 debug("db", "Updating transaction value stamp");
476 Date now = new Date();
477 setLongOption(MLDB.OPT_LAST_SCRAPE, now.getTime());
478 Data.lastUpdateDate.postValue(now);
480 public List<LedgerAccount> loadChildAccountsOf(LedgerAccount acc) {
481 List<LedgerAccount> result = new ArrayList<>();
482 SQLiteDatabase db = App.getDatabase();
483 try (Cursor c = db.rawQuery(
484 "SELECT a.name FROM accounts a WHERE a.profile = ? and a.name like ?||':%'",
485 new String[]{uuid, acc.getName()}))
487 while (c.moveToNext()) {
488 LedgerAccount a = loadAccount(db, c.getString(0));
495 public List<LedgerAccount> loadVisibleChildAccountsOf(LedgerAccount acc) {
496 List<LedgerAccount> result = new ArrayList<>();
497 ArrayList<LedgerAccount> visibleList = new ArrayList<>();
498 visibleList.add(acc);
500 SQLiteDatabase db = App.getDatabase();
501 try (Cursor c = db.rawQuery(
502 "SELECT a.name FROM accounts a WHERE a.profile = ? and a.name like ?||':%'",
503 new String[]{uuid, acc.getName()}))
505 while (c.moveToNext()) {
506 LedgerAccount a = loadAccount(db, c.getString(0));
507 if (a.isVisible(visibleList)) {
516 public void wipeAllData() {
517 SQLiteDatabase db = App.getDatabase();
518 db.beginTransaction();
520 String[] pUuid = new String[]{uuid};
521 db.execSQL("delete from options where profile=?", pUuid);
522 db.execSQL("delete from accounts where profile=?", pUuid);
523 db.execSQL("delete from account_values where profile=?", pUuid);
524 db.execSQL("delete from transactions where profile=?", pUuid);
525 db.execSQL("delete from transaction_accounts where profile=?", pUuid);
526 db.setTransactionSuccessful();
527 Logger.debug("wipe", String.format(Locale.ENGLISH, "Profile %s wiped out", pUuid[0]));
533 public List<Currency> getCurrencies() {
534 SQLiteDatabase db = App.getDatabase();
536 ArrayList<Currency> result = new ArrayList<>();
538 try (Cursor c = db.rawQuery("SELECT c.id, c.name, c.position, c.has_gap FROM currencies c",
541 while (c.moveToNext()) {
542 Currency currency = new Currency(c.getInt(0), c.getString(1),
543 Currency.Position.valueOf(c.getInt(2)), c.getInt(3) == 1);
544 result.add(currency);
550 Currency loadCurrencyByName(String name) {
551 SQLiteDatabase db = App.getDatabase();
552 Currency result = tryLoadCurrencyByName(db, name);
554 throw new RuntimeException(String.format("Unable to load currency '%s'", name));
557 private Currency tryLoadCurrencyByName(SQLiteDatabase db, String name) {
558 try (Cursor cursor = db.rawQuery(
559 "SELECT c.id, c.name, c.position, c.has_gap FROM currencies c WHERE c.name=?",
562 if (cursor.moveToFirst()) {
563 return new Currency(cursor.getInt(0), cursor.getString(1),
564 Currency.Position.valueOf(cursor.getInt(2)), cursor.getInt(3) == 1);
569 public enum FutureDates {
570 None(0), OneWeek(7), TwoWeeks(14), OneMonth(30), TwoMonths(60), ThreeMonths(90),
571 SixMonths(180), OneYear(365), All(-1);
572 private static SparseArray<FutureDates> map = new SparseArray<>();
575 for (FutureDates item : FutureDates.values()) {
576 map.put(item.value, item);
581 FutureDates(int value) {
584 public static FutureDates valueOf(int i) {
585 return map.get(i, None);
590 public String getText(Resources resources) {
593 return resources.getString(R.string.future_dates_7);
595 return resources.getString(R.string.future_dates_14);
597 return resources.getString(R.string.future_dates_30);
599 return resources.getString(R.string.future_dates_60);
601 return resources.getString(R.string.future_dates_90);
603 return resources.getString(R.string.future_dates_180);
605 return resources.getString(R.string.future_dates_365);
607 return resources.getString(R.string.future_dates_all);
609 return resources.getString(R.string.future_dates_none);