uptime-kuma/server/database.js

169 lines
5.3 KiB
JavaScript
Raw Normal View History

2021-07-21 18:02:35 +00:00
const fs = require("fs");
2021-08-21 18:07:10 +00:00
const { sleep, debug, isDev } = require("../src/util");
2021-07-30 04:24:46 +00:00
const { R } = require("redbean-node");
2021-08-06 11:12:49 +00:00
const { setSetting, setting } = require("./util-server");
const knex = require("knex");
const sqlite3 = require("@louislam/sqlite3");
2021-07-21 18:02:35 +00:00
class Database {
static templatePath = "./db/kuma.db"
static path = "./data/kuma.db";
2021-08-22 22:05:48 +00:00
static latestVersion = 7;
2021-07-21 18:02:35 +00:00
static noReject = true;
static sqliteInstance = null;
2021-07-21 18:02:35 +00:00
2021-08-09 05:34:44 +00:00
static async connect() {
if (! this.sqliteInstance) {
this.sqliteInstance = new sqlite3.Database(Database.path);
2021-08-17 10:18:41 +00:00
this.sqliteInstance.run("PRAGMA journal_mode = WAL");
}
const Dialect = require("knex/lib/dialects/sqlite3/index.js");
Dialect.prototype._driver = () => sqlite3;
2021-08-21 18:07:10 +00:00
if (isDev) {
Dialect.prototype.acquireConnectionOrg = Dialect.prototype.acquireConnection;
Dialect.prototype.acquireConnection = async function () {
let a = await this.acquireConnectionOrg();
debug("acquired Connection");
return a;
};
}
2021-08-21 18:07:10 +00:00
// Always return same connection.
Dialect.prototype.acquireRawConnection = async function () {
return Database.sqliteInstance;
};
Dialect.prototype.destroyRawConnection = async () => { }
const knexInstance = knex({
client: Dialect,
2021-08-21 18:07:10 +00:00
connection: { }, // Do not remove, Leave it empty is ok
useNullAsDefault: true,
2021-08-21 18:07:10 +00:00
pool: {
min: 1,
max: 1,
2021-08-21 18:07:10 +00:00
idleTimeoutMillis: 30000,
}
});
2021-08-21 18:07:10 +00:00
console.log( knexInstance.pool)
console.log("pool size")
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-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");
} 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);
2021-08-19 09:49:19 +00:00
const shmPath = Database.path + "-shm";
if (fs.existsSync(shmPath)) {
fs.copyFileSync(shmPath, shmPath + ".bak" + version);
}
const walPath = Database.path + "-wal";
if (fs.existsSync(walPath)) {
fs.copyFileSync(walPath, walPath + ".bak" + version);
}
2021-07-21 18:02:35 +00:00
// 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() {
if (this.sqliteInstance) {
this.sqliteInstance.close();
2021-07-21 18:02:35 +00:00
}
console.log("Stopped database");
2021-07-21 18:02:35 +00:00
}
}
module.exports = Database;