app/src/main/java/net/ktnx/mobileledger/db/DB.java

   1 /*
   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.
   8  *
   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.
  13  *
  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/>.
  16  */
  17
  18 package net.ktnx.mobileledger.db;
  19
  20 import android.content.res.Resources;
  21 import android.database.Cursor;
  22 import android.database.SQLException;
  23
  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;
  31
  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;
  43
  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;
  51
  52 import static net.ktnx.mobileledger.utils.Logger.debug;
  53
  54 @Database(version = DB.REVISION,
  55           entities = {TemplateHeader.class, TemplateAccount.class, Currency.class, Account.class,
  56                       Profile.class, Option.class, AccountValue.class, Transaction.class,
  57                       TransactionAccount.class
  58           })
  59 abstract public class DB extends RoomDatabase {
  60     public static final int REVISION = 60;
  61     public static final String DB_NAME = "MoLe.db";
  62     public static final MutableLiveData<Boolean> initComplete = new MutableLiveData<>(false);
  63     private static DB instance;
  64     public static DB get() {
  65         if (instance != null)
  66             return instance;
  67         synchronized (DB.class) {
  68             if (instance != null)
  69                 return instance;
  70
  71             RoomDatabase.Builder<DB> builder =
  72                     Room.databaseBuilder(App.instance, DB.class, DB_NAME);
  73             builder.addMigrations(
  74                     new Migration[]{singleVersionMigration(17), singleVersionMigration(18),
  75                                     singleVersionMigration(19), singleVersionMigration(20),
  76                                     multiVersionMigration(20, 22), multiVersionMigration(22, 30),
  77                                     multiVersionMigration(30, 32), multiVersionMigration(32, 34),
  78                                     multiVersionMigration(34, 40), singleVersionMigration(41),
  79                                     multiVersionMigration(41, 58), singleVersionMigration(59),
  80                                     singleVersionMigration(60)
  81                     })
  82                    .addCallback(new Callback() {
  83                        @Override
  84                        public void onOpen(@NonNull SupportSQLiteDatabase db) {
  85                            super.onOpen(db);
  86                            db.execSQL("PRAGMA foreign_keys = ON");
  87                            db.execSQL("pragma case_sensitive_like" + "=ON;");
  88
  89                        }
  90                    });
  91
  92 //            if (BuildConfig.DEBUG)
  93 //                builder.setQueryCallback(((sqlQuery, bindArgs) -> Logger.debug("room", sqlQuery)),
  94 //                        Executors.newSingleThreadExecutor());
  95
  96             return instance = builder.build();
  97         }
  98     }
  99     private static Migration singleVersionMigration(int toVersion) {
 100         return new Migration(toVersion - 1, toVersion) {
 101             @Override
 102             public void migrate(@NonNull SupportSQLiteDatabase db) {
 103                 String fileName = String.format(Locale.US, "db_%d", toVersion);
 104
 105                 applyRevisionFile(db, fileName);
 106
 107                 // when migrating to version 59, migrate profile/theme options to the
 108                 // SharedPreferences
 109                 if (toVersion == 59) {
 110                     try (Cursor c = db.query(
 111                             "SELECT p.id, p.theme FROM profiles p WHERE p.id=(SELECT o.value " +
 112                             "FROM options o WHERE o.profile_id=0 AND o.name=?)",
 113                             new Object[]{"profile_id"}))
 114                     {
 115                         if (c.moveToFirst()) {
 116                             long currentProfileId = c.getLong(0);
 117                             int currentTheme = c.getInt(1);
 118
 119                             if (currentProfileId >= 0 && currentTheme >= 0) {
 120                                 App.storeStartupProfileAndTheme(currentProfileId, currentTheme);
 121                             }
 122                         }
 123                     }
 124                 }
 125             }
 126         };
 127     }
 128     private static Migration dummyVersionMigration(int toVersion) {
 129         return new Migration(toVersion - 1, toVersion) {
 130             @Override
 131             public void migrate(@NonNull SupportSQLiteDatabase db) {
 132                 Logger.debug("db",
 133                         String.format(Locale.ROOT, "Dummy DB migration to version %d", toVersion));
 134             }
 135         };
 136     }
 137     private static Migration multiVersionMigration(int fromVersion, int toVersion) {
 138         return new Migration(fromVersion, toVersion) {
 139             @Override
 140             public void migrate(@NonNull SupportSQLiteDatabase db) {
 141                 String fileName = String.format(Locale.US, "db_%d_%d", fromVersion, toVersion);
 142
 143                 applyRevisionFile(db, fileName);
 144             }
 145         };
 146     }
 147     public static void applyRevisionFile(@NonNull SupportSQLiteDatabase db, String fileName) {
 148         final Resources rm = App.instance.getResources();
 149         int res_id = rm.getIdentifier(fileName, "raw", App.instance.getPackageName());
 150         if (res_id == 0)
 151             throw new SQLException(String.format(Locale.US, "No resource for %s", fileName));
 152
 153         try (InputStream res = rm.openRawResource(res_id)) {
 154             debug("db", "Applying " + fileName);
 155             InputStreamReader isr = new InputStreamReader(res);
 156             BufferedReader reader = new BufferedReader(isr);
 157
 158             Pattern endOfStatement = Pattern.compile(";\\s*(?:--.*)?$");
 159
 160             String line;
 161             String sqlStatement = null;
 162             int lineNo = 0;
 163             while ((line = reader.readLine()) != null) {
 164                 lineNo++;
 165                 if (line.startsWith("--"))
 166                     continue;
 167                 if (line.isEmpty())
 168                     continue;
 169
 170                 if (sqlStatement == null)
 171                     sqlStatement = line;
 172                 else
 173                     sqlStatement = sqlStatement.concat(" " + line);
 174
 175                 Matcher m = endOfStatement.matcher(line);
 176                 if (!m.find())
 177                     continue;
 178
 179                 try {
 180                     db.execSQL(sqlStatement);
 181                     sqlStatement = null;
 182                 }
 183                 catch (Exception e) {
 184                     throw new RuntimeException(
 185                             String.format("Error applying %s, line %d, statement: %s", fileName,
 186                                     lineNo, sqlStatement), e);
 187                 }
 188             }
 189
 190             if (sqlStatement != null)
 191                 throw new RuntimeException(String.format(
 192                         "Error applying %s: EOF after continuation. Line %s, Incomplete " +
 193                         "statement: %s", fileName, lineNo, sqlStatement));
 194
 195         }
 196         catch (IOException e) {
 197             throw new RuntimeException(String.format("Error opening raw resource for %s", fileName),
 198                     e);
 199         }
 200     }
 201     public abstract TemplateHeaderDAO getTemplateDAO();
 202
 203     public abstract TemplateAccountDAO getTemplateAccountDAO();
 204
 205     public abstract CurrencyDAO getCurrencyDAO();
 206
 207     public abstract AccountDAO getAccountDAO();
 208
 209     public abstract AccountValueDAO getAccountValueDAO();
 210
 211     public abstract TransactionDAO getTransactionDAO();
 212
 213     public abstract TransactionAccountDAO getTransactionAccountDAO();
 214
 215     public abstract OptionDAO getOptionDAO();
 216
 217     public abstract ProfileDAO getProfileDAO();
 218 }