app/src/main/java/net/ktnx/mobileledger/utils/MobileLedgerDatabase.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.utils;
  19
  20 import android.app.Application;
  21 import android.content.res.Resources;
  22 import android.database.SQLException;
  23 import android.database.sqlite.SQLiteDatabase;
  24 import android.database.sqlite.SQLiteOpenHelper;
  25
  26 import androidx.lifecycle.MutableLiveData;
  27
  28 import net.ktnx.mobileledger.BuildConfig;
  29 import net.ktnx.mobileledger.db.DB;
  30
  31 import java.io.BufferedReader;
  32 import java.io.IOException;
  33 import java.io.InputStream;
  34 import java.io.InputStreamReader;
  35 import java.util.Locale;
  36 import java.util.regex.Matcher;
  37 import java.util.regex.Pattern;
  38
  39 import static net.ktnx.mobileledger.utils.Logger.debug;
  40
  41 public class MobileLedgerDatabase extends SQLiteOpenHelper {
  42     public static final MutableLiveData<Boolean> initComplete = new MutableLiveData<>(false);
  43     public static final String DB_NAME = "MoLe.db";
  44     private static final int LATEST_REVISION = 58;
  45     private static final String CREATE_DB_SQL = "create_db";
  46     private final Application mContext;
  47     @Override
  48     public void onOpen(SQLiteDatabase db) {
  49         super.onOpen(db);
  50         // force a check by Room to ensure everything is OK
  51         // TODO: remove when all DB structure manipulation is via Room
  52         DB.get()
  53           .compileStatement("SELECT COUNT(*) FROM profiles");
  54     }
  55     public MobileLedgerDatabase(Application context) {
  56         super(context, DB_NAME, null, LATEST_REVISION);
  57         debug("db", "creating helper instance");
  58         mContext = context;
  59         super.setWriteAheadLoggingEnabled(true);
  60     }
  61
  62     @Override
  63     public void onCreate(SQLiteDatabase db) {
  64         debug("db", "onCreate called");
  65         applyRevisionFile(db, CREATE_DB_SQL);
  66     }
  67
  68     @Override
  69     public void onConfigure(SQLiteDatabase db) {
  70         super.onConfigure(db);
  71         db.execSQL("pragma case_sensitive_like=ON;");
  72         if (BuildConfig.DEBUG)
  73             db.execSQL("PRAGMA foreign_keys=ON");
  74     }
  75     @Override
  76     public void onUpgrade(SQLiteDatabase db, int oldVersion, int newVersion) {
  77         debug("db",
  78                 String.format(Locale.US, "needs upgrade from version %d to version %d", oldVersion,
  79                         newVersion));
  80         for (int i = oldVersion + 1; i <= newVersion; i++)
  81             applyRevision(db, i);
  82     }
  83     private void applyRevision(SQLiteDatabase db, int rev_no) {
  84         String rev_file = String.format(Locale.US, "sql_%d", rev_no);
  85
  86         applyRevisionFile(db, rev_file);
  87     }
  88     private void applyRevisionFile(SQLiteDatabase db, String revFile) {
  89         final Resources rm = mContext.getResources();
  90         int res_id = rm.getIdentifier(revFile, "raw", mContext.getPackageName());
  91         if (res_id == 0)
  92             throw new SQLException(String.format(Locale.US, "No resource for %s", revFile));
  93
  94         try (InputStream res = rm.openRawResource(res_id)) {
  95             debug("db", "Applying " + revFile);
  96             InputStreamReader isr = new InputStreamReader(res);
  97             BufferedReader reader = new BufferedReader(isr);
  98
  99             Pattern endOfStatement = Pattern.compile(";\\s*(?:--.*)?$");
 100
 101             String line;
 102             String sqlStatement = null;
 103             int lineNo = 0;
 104             while ((line = reader.readLine()) != null) {
 105                 lineNo++;
 106                 if (line.startsWith("--"))
 107                     continue;
 108                 if (line.isEmpty())
 109                     continue;
 110
 111                 if (sqlStatement == null)
 112                     sqlStatement = line;
 113                 else
 114                     sqlStatement = sqlStatement.concat(line);
 115
 116                 Matcher m = endOfStatement.matcher(line);
 117                 if (!m.find())
 118                     continue;
 119
 120                 try {
 121                     db.execSQL(sqlStatement);
 122                     sqlStatement = null;
 123                 }
 124                 catch (Exception e) {
 125                     throw new RuntimeException(
 126                             String.format("Error applying %s, line %d, statement: %s", revFile,
 127                                     lineNo, sqlStatement), e);
 128                 }
 129             }
 130
 131             if (sqlStatement != null)
 132                 throw new RuntimeException(String.format(
 133                         "Error applying %s: EOF after continuation. Line %s, Incomplete " +
 134                         "statement: %s", revFile, lineNo, sqlStatement));
 135
 136         }
 137         catch (IOException e) {
 138             throw new RuntimeException(String.format("Error opening raw resource for %s", revFile),
 139                     e);
 140         }
 141     }
 142 }