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.room.Database;
26 import androidx.room.Room;
27 import androidx.room.RoomDatabase;
28 import androidx.room.migration.Migration;
29 import androidx.sqlite.db.SupportSQLiteDatabase;
31 import net.ktnx.mobileledger.App;
32 import net.ktnx.mobileledger.dao.AccountDAO;
33 import net.ktnx.mobileledger.dao.AccountValueDAO;
34 import net.ktnx.mobileledger.dao.CurrencyDAO;
35 import net.ktnx.mobileledger.dao.DescriptionHistoryDAO;
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.regex.Matcher;
50 import java.util.regex.Pattern;
52 import static net.ktnx.mobileledger.utils.Logger.debug;
54 @Database(version = DB.REVISION,
55 entities = {TemplateHeader.class, TemplateAccount.class, Currency.class, Account.class,
56 Profile.class, Option.class, AccountValue.class, DescriptionHistory.class,
57 Transaction.class, TransactionAccount.class
59 abstract public class DB extends RoomDatabase {
60 public static final int REVISION = 59;
61 public static final String DB_NAME = "MoLe.db";
62 private static DB instance;
63 public static DB get() {
66 synchronized (DB.class) {
70 return instance = Room.databaseBuilder(App.instance, DB.class, DB_NAME)
71 .addMigrations(new Migration[]{singleVersionMigration(17),
72 singleVersionMigration(18),
73 singleVersionMigration(19),
74 singleVersionMigration(20),
75 multiVersionMigration(20, 22),
76 multiVersionMigration(22, 30),
77 multiVersionMigration(30, 32),
78 multiVersionMigration(32, 34),
79 multiVersionMigration(34, 40),
80 singleVersionMigration(41),
81 multiVersionMigration(41, 58),
82 singleVersionMigration(59)
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;");
96 private static Migration singleVersionMigration(int toVersion) {
97 return new Migration(toVersion - 1, toVersion) {
99 public void migrate(@NonNull SupportSQLiteDatabase db) {
100 String fileName = String.format(Locale.US, "db_%d", toVersion);
102 applyRevisionFile(db, fileName);
104 // when migrating to version 59, migrate profile/theme options to the
106 if (toVersion == 59) {
107 try (Cursor c = db.query(
108 "SELECT p.id, p.theme_hue FROM profiles p WHERE p.id=(SELECT o.value " +
109 "FROM options WHERE o.profile_uid IS NULL AND o.name=?",
110 new Object[]{"profile_id"}))
112 if (c.moveToFirst()) {
113 long currentProfileId = c.getLong(0);
114 int currentTheme = c.getInt(1);
116 if (currentProfileId >= 0 && currentTheme >= 0) {
117 App.storeStartupProfileAndTheme(currentProfileId, currentTheme);
125 private static Migration dummyVersionMigration(int toVersion) {
126 return new Migration(toVersion - 1, toVersion) {
128 public void migrate(@NonNull SupportSQLiteDatabase db) {
130 String.format(Locale.ROOT, "Dummy DB migration to version %d", toVersion));
134 private static Migration multiVersionMigration(int fromVersion, int toVersion) {
135 return new Migration(fromVersion, toVersion) {
137 public void migrate(@NonNull SupportSQLiteDatabase db) {
138 String fileName = String.format(Locale.US, "db_%d_%d", fromVersion, toVersion);
140 applyRevisionFile(db, fileName);
144 public static void applyRevisionFile(@NonNull SupportSQLiteDatabase db, String fileName) {
145 final Resources rm = App.instance.getResources();
146 int res_id = rm.getIdentifier(fileName, "raw", App.instance.getPackageName());
148 throw new SQLException(String.format(Locale.US, "No resource for %s", fileName));
150 try (InputStream res = rm.openRawResource(res_id)) {
151 debug("db", "Applying " + fileName);
152 InputStreamReader isr = new InputStreamReader(res);
153 BufferedReader reader = new BufferedReader(isr);
155 Pattern endOfStatement = Pattern.compile(";\\s*(?:--.*)?$");
158 String sqlStatement = null;
160 while ((line = reader.readLine()) != null) {
162 if (line.startsWith("--"))
167 if (sqlStatement == null)
170 sqlStatement = sqlStatement.concat(" " + line);
172 Matcher m = endOfStatement.matcher(line);
177 db.execSQL(sqlStatement);
180 catch (Exception e) {
181 throw new RuntimeException(
182 String.format("Error applying %s, line %d, statement: %s", fileName,
183 lineNo, sqlStatement), e);
187 if (sqlStatement != null)
188 throw new RuntimeException(String.format(
189 "Error applying %s: EOF after continuation. Line %s, Incomplete " +
190 "statement: %s", fileName, lineNo, sqlStatement));
193 catch (IOException e) {
194 throw new RuntimeException(String.format("Error opening raw resource for %s", fileName),
198 public abstract TemplateHeaderDAO getTemplateDAO();
200 public abstract TemplateAccountDAO getTemplateAccountDAO();
202 public abstract CurrencyDAO getCurrencyDAO();
204 public abstract AccountDAO getAccountDAO();
206 public abstract AccountValueDAO getAccountValueDAO();
208 public abstract TransactionDAO getTransactionDAO();
210 public abstract TransactionAccountDAO getTransactionAccountDAO();
212 public abstract OptionDAO getOptionDAO();
214 public abstract DescriptionHistoryDAO getDescriptionHistoryDAO();
216 public abstract ProfileDAO getProfileDAO();