mobidev-thelounge
Version:
The self-hosted Web IRC client
194 lines (193 loc) • 8.34 kB
JavaScript
;
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const log_1 = __importDefault(require("../../log"));
const path_1 = __importDefault(require("path"));
const fs_1 = __importDefault(require("fs"));
const config_1 = __importDefault(require("../../config"));
const msg_1 = __importDefault(require("../../models/msg"));
// TODO; type
let sqlite3;
try {
sqlite3 = require("sqlite3");
}
catch (e) {
config_1.default.values.messageStorage = config_1.default.values.messageStorage.filter((item) => item !== "sqlite");
log_1.default.error("Unable to load sqlite3 module. See https://github.com/mapbox/node-sqlite3/wiki/Binaries");
}
const currentSchemaVersion = 1520239200;
const schema = [
// Schema version #1
"CREATE TABLE IF NOT EXISTS options (name TEXT, value TEXT, CONSTRAINT name_unique UNIQUE (name))",
"CREATE TABLE IF NOT EXISTS messages (network TEXT, channel TEXT, time INTEGER, type TEXT, msg TEXT)",
"CREATE INDEX IF NOT EXISTS network_channel ON messages (network, channel)",
"CREATE INDEX IF NOT EXISTS time ON messages (time)",
];
class SqliteMessageStorage {
client;
isEnabled;
database;
constructor(client) {
this.client = client;
this.isEnabled = false;
}
enable() {
const logsPath = config_1.default.getUserLogsPath();
const sqlitePath = path_1.default.join(logsPath, `${this.client.name}.sqlite3`);
try {
fs_1.default.mkdirSync(logsPath, { recursive: true });
}
catch (e) {
log_1.default.error("Unable to create logs directory", String(e));
return;
}
this.isEnabled = true;
this.database = new sqlite3.Database(sqlitePath);
this.database.serialize(() => {
schema.forEach((line) => this.database.run(line));
this.database.get("SELECT value FROM options WHERE name = 'schema_version'", (err, row) => {
if (err) {
return log_1.default.error(`Failed to retrieve schema version: ${err.toString()}`);
}
// New table
if (row === undefined) {
this.database.serialize(() => this.database.run("INSERT INTO options (name, value) VALUES ('schema_version', ?)", currentSchemaVersion));
return;
}
const storedSchemaVersion = parseInt(row.value, 10);
if (storedSchemaVersion === currentSchemaVersion) {
return;
}
if (storedSchemaVersion > currentSchemaVersion) {
return log_1.default.error(`sqlite messages schema version is higher than expected (${storedSchemaVersion} > ${currentSchemaVersion}). Is The Lounge out of date?`);
}
log_1.default.info(`sqlite messages schema version is out of date (${storedSchemaVersion} < ${currentSchemaVersion}). Running migrations if any.`);
this.database.serialize(() => this.database.run("UPDATE options SET value = ? WHERE name = 'schema_version'", currentSchemaVersion));
});
});
}
close(callback) {
if (!this.isEnabled) {
return;
}
this.isEnabled = false;
this.database.close((err) => {
if (err) {
log_1.default.error(`Failed to close sqlite database: ${err.message}`);
}
if (callback) {
callback(err);
}
});
}
index(network, channel, msg) {
if (!this.isEnabled) {
return;
}
const clonedMsg = Object.keys(msg).reduce((newMsg, prop) => {
// id is regenerated when messages are retrieved
// previews are not stored because storage is cleared on lounge restart
// type and time are stored in a separate column
if (prop !== "id" && prop !== "previews" && prop !== "type" && prop !== "time") {
newMsg[prop] = msg[prop];
}
return newMsg;
}, {});
this.database.serialize(() => this.database.run("INSERT INTO messages(network, channel, time, type, msg) VALUES(?, ?, ?, ?, ?)", network.uuid, channel.name.toLowerCase(), msg.time.getTime(), msg.type, JSON.stringify(clonedMsg)));
}
deleteChannel(network, channel) {
if (!this.isEnabled) {
return;
}
this.database.serialize(() => this.database.run("DELETE FROM messages WHERE network = ? AND channel = ?", network.uuid, channel.name.toLowerCase()));
}
/**
* Load messages for given channel on a given network and resolve a promise with loaded messages.
*
* @param Network network - Network object where the channel is
* @param Chan channel - Channel object for which to load messages for
*/
getMessages(network, channel) {
if (!this.isEnabled || config_1.default.values.maxHistory === 0) {
return Promise.resolve([]);
}
// If unlimited history is specified, load 100k messages
const limit = config_1.default.values.maxHistory < 0 ? 100000 : config_1.default.values.maxHistory;
return new Promise((resolve, reject) => {
this.database.serialize(() => this.database.all("SELECT msg, type, time FROM messages WHERE network = ? AND channel = ? ORDER BY time DESC LIMIT ?", [network.uuid, channel.name.toLowerCase(), limit], (err, rows) => {
if (err) {
return reject(err);
}
resolve(rows.reverse().map((row) => {
const msg = JSON.parse(row.msg);
msg.time = row.time;
msg.type = row.type;
const newMsg = new msg_1.default(msg);
newMsg.id = this.client.idMsg++;
return newMsg;
}));
}));
});
}
search(query) {
if (!this.isEnabled) {
// this should never be hit as messageProvider is checked in client.search()
return Promise.resolve([]);
}
// Using the '@' character to escape '%' and '_' in patterns.
const escapedSearchTerm = query.searchTerm.replace(/([%_@])/g, "@$1");
let select = 'SELECT msg, type, time, network, channel FROM messages WHERE type = "message" AND json_extract(msg, "$.text") LIKE ? ESCAPE \'@\'';
const params = [`%${escapedSearchTerm}%`];
if (query.networkUuid) {
select += " AND network = ? ";
params.push(query.networkUuid);
}
if (query.channelName) {
select += " AND channel = ? ";
params.push(query.channelName.toLowerCase());
}
const maxResults = 100;
select += " ORDER BY time DESC LIMIT ? OFFSET ? ";
params.push(maxResults.toString());
query.offset = parseInt(query.offset, 10) || 0;
params.push(String(query.offset));
return new Promise((resolve, reject) => {
this.database.all(select, params, (err, rows) => {
if (err) {
reject(err);
}
else {
const response = {
searchTerm: query.searchTerm,
target: query.channelName,
networkUuid: query.networkUuid,
offset: query.offset,
results: parseSearchRowsToMessages(query.offset, rows).reverse(),
};
resolve(response);
}
});
});
}
canProvideMessages() {
return this.isEnabled;
}
}
exports.default = SqliteMessageStorage;
// TODO: type any
function parseSearchRowsToMessages(id, rows) {
const messages = [];
for (const row of rows) {
const msg = JSON.parse(row.msg);
msg.time = row.time;
msg.type = row.type;
msg.networkUuid = row.network;
msg.channelName = row.channel;
msg.id = id;
messages.push(new msg_1.default(msg));
id += 1;
}
return messages;
}