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.db;
20 import android.content.res.Resources;
21 import android.database.Cursor;
22 import android.database.SQLException;
24 import androidx.annotation.NonNull;
25 import androidx.lifecycle.MutableLiveData;
26 import androidx.room.Database;
27 import androidx.room.Room;
28 import androidx.room.RoomDatabase;
29 import androidx.room.migration.Migration;
30 import androidx.sqlite.db.SupportSQLiteDatabase;
32 import net.ktnx.mobileledger.App;
33 import net.ktnx.mobileledger.dao.AccountDAO;
34 import net.ktnx.mobileledger.dao.AccountValueDAO;
35 import net.ktnx.mobileledger.dao.CurrencyDAO;
36 import net.ktnx.mobileledger.dao.OptionDAO;
37 import net.ktnx.mobileledger.dao.ProfileDAO;
38 import net.ktnx.mobileledger.dao.TemplateAccountDAO;
39 import net.ktnx.mobileledger.dao.TemplateHeaderDAO;
40 import net.ktnx.mobileledger.dao.TransactionAccountDAO;
41 import net.ktnx.mobileledger.dao.TransactionDAO;
42 import net.ktnx.mobileledger.utils.Logger;
44 import java.io.BufferedReader;
45 import java.io.IOException;
46 import java.io.InputStream;
47 import java.io.InputStreamReader;
48 import java.util.Locale;
49 import java.util.UUID;
50 import java.util.regex.Matcher;
51 import java.util.regex.Pattern;
53 import static net.ktnx.mobileledger.utils.Logger.debug;
55 @Database(version = DB.REVISION,
56 entities = {TemplateHeader.class, TemplateAccount.class, Currency.class, Account.class,
57 Profile.class, Option.class, AccountValue.class, Transaction.class,
58 TransactionAccount.class
60 abstract public class DB extends RoomDatabase {
61 public static final int REVISION = 63;
62 public static final String DB_NAME = "MoLe.db";
63 public static final MutableLiveData<Boolean> initComplete = new MutableLiveData<>(false);
64 private static DB instance;
65 public static DB get() {
68 synchronized (DB.class) {
72 RoomDatabase.Builder<DB> builder =
73 Room.databaseBuilder(App.instance, DB.class, DB_NAME);
74 builder.addMigrations(
75 new Migration[]{singleVersionMigration(17), singleVersionMigration(18),
76 singleVersionMigration(19), singleVersionMigration(20),
77 multiVersionMigration(20, 22), multiVersionMigration(22, 30),
78 multiVersionMigration(30, 32), multiVersionMigration(32, 34),
79 multiVersionMigration(34, 40), singleVersionMigration(41),
80 multiVersionMigration(41, 58), singleVersionMigration(59),
81 singleVersionMigration(60), singleVersionMigration(61),
82 singleVersionMigration(62), singleVersionMigration(63)
84 .addCallback(new Callback() {
86 public void onOpen(@NonNull SupportSQLiteDatabase db) {
88 db.execSQL("PRAGMA foreign_keys = ON");
89 db.execSQL("pragma case_sensitive_like" + "=ON;");
94 // if (BuildConfig.DEBUG)
95 // builder.setQueryCallback(((sqlQuery, bindArgs) -> Logger.debug("room", sqlQuery)),
96 // Executors.newSingleThreadExecutor());
98 return instance = builder.build();
101 private static Migration singleVersionMigration(int toVersion) {
102 return new Migration(toVersion - 1, toVersion) {
104 public void migrate(@NonNull SupportSQLiteDatabase db) {
105 String fileName = String.format(Locale.US, "db_%d", toVersion);
107 applyRevisionFile(db, fileName);
109 // when migrating to version 59, migrate profile/theme options to the
111 if (toVersion == 59) {
112 try (Cursor c = db.query(
113 "SELECT p.id, p.theme FROM profiles p WHERE p.id=(SELECT o.value " +
114 "FROM options o WHERE o.profile_id=0 AND o.name=?)",
115 new Object[]{"profile_id"}))
117 if (c.moveToFirst()) {
118 long currentProfileId = c.getLong(0);
119 int currentTheme = c.getInt(1);
121 if (currentProfileId >= 0 && currentTheme >= 0) {
122 App.storeStartupProfileAndTheme(currentProfileId, currentTheme);
127 if (toVersion == 63) {
128 try (Cursor c = db.query("SELECT id FROM templates")) {
129 while (c.moveToNext()) {
130 db.execSQL("UPDATE templates SET uuid=? WHERE id=?",
131 new Object[]{UUID.randomUUID().toString(), c.getLong(0)});
138 private static Migration dummyVersionMigration(int toVersion) {
139 return new Migration(toVersion - 1, toVersion) {
141 public void migrate(@NonNull SupportSQLiteDatabase db) {
143 String.format(Locale.ROOT, "Dummy DB migration to version %d", toVersion));
147 private static Migration multiVersionMigration(int fromVersion, int toVersion) {
148 return new Migration(fromVersion, toVersion) {
150 public void migrate(@NonNull SupportSQLiteDatabase db) {
151 String fileName = String.format(Locale.US, "db_%d_%d", fromVersion, toVersion);
153 applyRevisionFile(db, fileName);
157 public static void applyRevisionFile(@NonNull SupportSQLiteDatabase db, String fileName) {
158 final Resources rm = App.instance.getResources();
159 int res_id = rm.getIdentifier(fileName, "raw", App.instance.getPackageName());
161 throw new SQLException(String.format(Locale.US, "No resource for %s", fileName));
163 try (InputStream res = rm.openRawResource(res_id)) {
164 debug("db", "Applying " + fileName);
165 InputStreamReader isr = new InputStreamReader(res);
166 BufferedReader reader = new BufferedReader(isr);
168 Pattern endOfStatement = Pattern.compile(";\\s*(?:--.*)?$");
171 String sqlStatement = null;
173 while ((line = reader.readLine()) != null) {
175 if (line.startsWith("--"))
180 if (sqlStatement == null)
183 sqlStatement = sqlStatement.concat(" " + line);
185 Matcher m = endOfStatement.matcher(line);
190 db.execSQL(sqlStatement);
193 catch (Exception e) {
194 throw new RuntimeException(
195 String.format("Error applying %s, line %d, statement: %s", fileName,
196 lineNo, sqlStatement), e);
200 if (sqlStatement != null)
201 throw new RuntimeException(String.format(
202 "Error applying %s: EOF after continuation. Line %s, Incomplete " +
203 "statement: %s", fileName, lineNo, sqlStatement));
206 catch (IOException e) {
207 throw new RuntimeException(String.format("Error opening raw resource for %s", fileName),
211 public abstract TemplateHeaderDAO getTemplateDAO();
213 public abstract TemplateAccountDAO getTemplateAccountDAO();
215 public abstract CurrencyDAO getCurrencyDAO();
217 public abstract AccountDAO getAccountDAO();
219 public abstract AccountValueDAO getAccountValueDAO();
221 public abstract TransactionDAO getTransactionDAO();
223 public abstract TransactionAccountDAO getTransactionAccountDAO();
225 public abstract OptionDAO getOptionDAO();
227 public abstract ProfileDAO getProfileDAO();