2021-07-21 18:02:35 +00:00
|
|
|
const fs = require("fs");
|
2021-07-30 04:24:46 +00:00
|
|
|
const { sleep } = require("../src/util");
|
|
|
|
const { R } = require("redbean-node");
|
2021-08-06 11:12:49 +00:00
|
|
|
const { setSetting, setting } = require("./util-server");
|
2021-08-06 11:09:00 +00:00
|
|
|
const knex = require("knex");
|
2021-08-17 07:59:23 +00:00
|
|
|
const sqlite3 = require("@louislam/sqlite3");
|
2021-07-21 18:02:35 +00:00
|
|
|
|
|
|
|
class Database {
|
|
|
|
|
|
|
|
static templatePath = "./db/kuma.db"
|
2021-07-28 12:52:49 +00:00
|
|
|
static path = "./data/kuma.db";
|
2021-08-05 11:04:38 +00:00
|
|
|
static latestVersion = 6;
|
2021-07-21 18:02:35 +00:00
|
|
|
static noReject = true;
|
2021-08-17 07:59:23 +00:00
|
|
|
static sqliteInstance = null;
|
2021-07-21 18:02:35 +00:00
|
|
|
|
2021-08-09 05:34:44 +00:00
|
|
|
static async connect() {
|
2021-08-17 07:59:23 +00:00
|
|
|
|
|
|
|
if (! this.sqliteInstance) {
|
|
|
|
this.sqliteInstance = new sqlite3.Database(Database.path);
|
|
|
|
}
|
|
|
|
|
2021-08-06 11:09:00 +00:00
|
|
|
const Dialect = require("knex/lib/dialects/sqlite3/index.js");
|
2021-08-17 07:59:23 +00:00
|
|
|
Dialect.prototype._driver = () => sqlite3;
|
|
|
|
|
|
|
|
// Disable Pool by overriding acquireConnection()
|
|
|
|
Dialect.prototype.acquireConnection = async () => {
|
|
|
|
return this.sqliteInstance;
|
|
|
|
}
|
|
|
|
Dialect.prototype.releaseConnection = async () => { }
|
2021-08-06 11:09:00 +00:00
|
|
|
|
2021-08-17 07:59:23 +00:00
|
|
|
const knexInstance = knex({
|
2021-08-06 11:09:00 +00:00
|
|
|
client: Dialect,
|
|
|
|
connection: {
|
|
|
|
filename: Database.path,
|
|
|
|
},
|
|
|
|
useNullAsDefault: true,
|
2021-08-17 07:59:23 +00:00
|
|
|
});
|
|
|
|
|
|
|
|
R.setup(knexInstance);
|
2021-08-09 05:34:44 +00:00
|
|
|
|
2021-08-16 18:09:40 +00:00
|
|
|
if (process.env.SQL_LOG === "1") {
|
|
|
|
R.debug(true);
|
|
|
|
}
|
|
|
|
|
2021-08-09 05:34:44 +00:00
|
|
|
// Auto map the model to a bean object
|
|
|
|
R.freeze(true)
|
|
|
|
await R.autoloadModels("./server/model");
|
2021-08-06 11:09:00 +00:00
|
|
|
}
|
|
|
|
|
2021-07-21 18:02:35 +00:00
|
|
|
static async patch() {
|
|
|
|
let version = parseInt(await setting("database_version"));
|
|
|
|
|
|
|
|
if (! version) {
|
|
|
|
version = 0;
|
|
|
|
}
|
|
|
|
|
|
|
|
console.info("Your database version: " + version);
|
|
|
|
console.info("Latest database version: " + this.latestVersion);
|
|
|
|
|
|
|
|
if (version === this.latestVersion) {
|
|
|
|
console.info("Database no need to patch");
|
2021-08-08 07:04:20 +00:00
|
|
|
} else if (version > this.latestVersion) {
|
|
|
|
console.info("Warning: Database version is newer than expected");
|
2021-07-21 18:02:35 +00:00
|
|
|
} else {
|
|
|
|
console.info("Database patch is needed")
|
|
|
|
|
|
|
|
console.info("Backup the db")
|
|
|
|
const backupPath = "./data/kuma.db.bak" + version;
|
|
|
|
fs.copyFileSync(Database.path, backupPath);
|
|
|
|
|
|
|
|
// Try catch anything here, if gone wrong, restore the backup
|
|
|
|
try {
|
|
|
|
for (let i = version + 1; i <= this.latestVersion; i++) {
|
|
|
|
const sqlFile = `./db/patch${i}.sql`;
|
|
|
|
console.info(`Patching ${sqlFile}`);
|
|
|
|
await Database.importSQLFile(sqlFile);
|
|
|
|
console.info(`Patched ${sqlFile}`);
|
|
|
|
await setSetting("database_version", i);
|
|
|
|
}
|
|
|
|
console.log("Database Patched Successfully");
|
|
|
|
} catch (ex) {
|
|
|
|
await Database.close();
|
|
|
|
console.error("Patch db failed!!! Restoring the backup")
|
|
|
|
fs.copyFileSync(backupPath, Database.path);
|
|
|
|
console.error(ex)
|
|
|
|
|
|
|
|
console.error("Start Uptime-Kuma failed due to patch db failed")
|
|
|
|
console.error("Please submit the bug report if you still encounter the problem after restart: https://github.com/louislam/uptime-kuma/issues")
|
|
|
|
process.exit(1);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Sadly, multi sql statements is not supported by many sqlite libraries, I have to implement it myself
|
|
|
|
* @param filename
|
|
|
|
* @returns {Promise<void>}
|
|
|
|
*/
|
|
|
|
static async importSQLFile(filename) {
|
|
|
|
|
|
|
|
await R.getCell("SELECT 1");
|
|
|
|
|
|
|
|
let text = fs.readFileSync(filename).toString();
|
|
|
|
|
|
|
|
// Remove all comments (--)
|
|
|
|
let lines = text.split("\n");
|
|
|
|
lines = lines.filter((line) => {
|
|
|
|
return ! line.startsWith("--")
|
|
|
|
});
|
|
|
|
|
|
|
|
// Split statements by semicolon
|
|
|
|
// Filter out empty line
|
|
|
|
text = lines.join("\n")
|
|
|
|
|
|
|
|
let statements = text.split(";")
|
|
|
|
.map((statement) => {
|
|
|
|
return statement.trim();
|
|
|
|
})
|
|
|
|
.filter((statement) => {
|
|
|
|
return statement !== "";
|
|
|
|
})
|
|
|
|
|
|
|
|
for (let statement of statements) {
|
|
|
|
await R.exec(statement);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Special handle, because tarn.js throw a promise reject that cannot be caught
|
|
|
|
* @returns {Promise<void>}
|
|
|
|
*/
|
|
|
|
static async close() {
|
2021-08-17 07:59:23 +00:00
|
|
|
if (this.sqliteInstance) {
|
|
|
|
this.sqliteInstance.close();
|
2021-07-21 18:02:35 +00:00
|
|
|
}
|
2021-08-17 07:59:23 +00:00
|
|
|
console.log("Stopped database");
|
2021-07-21 18:02:35 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
module.exports = Database;
|