scriptoriumadmin/zotero
1
0
Fork 0
mirror of https://github.com/zotero/zotero.git synced 2026-08-28 05:25:31 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Add DBConnection hooks for auxiliary attached databases

Browse source 
Code that attaches its own database to the main connection needs to hook
into that connection's lifecycle. Add onIdle() to run maintenance (e.g.,
vacuuming) during the main database's idle maintenance, and
addCorruptionHandler() to handle a corruption error for the attached
database (after confirming that the main database is actually corrupt,
so a corrupt attached database doesn't trigger main-database recovery).
This commit is contained in:
Dan Stillman 2026-07-14 12:01:09 -04:00 • committed by Dan Stillman
parent ae46954167
commit e2536ba299
1 changed files with 63 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

65
chrome/content/zotero/xpcom/db.js
View file

@ -105,6 +105,9 @@ Zotero.DBConnection = function (dbNameOrPath) {
}
};
this._dbIsCorrupt = null
this._checkingCorruption = false;
this._corruptionHandlers = [];
this._idleCallbacks = [];
this._onlineBackupInProgress = false;
this._onConnectCallbacks = [];
this._loadedExtensions = new Set();
@ -910,6 +913,16 @@ Zotero.DBConnection.prototype.observe = async function (subject, topic, data) {
try {
await this.backUpDatabase({ online: true });
await this.vacuum();
// The main vacuum covers only the main database, so let callers reclaim space in
// their own attached databases (e.g., the full-text index) here too
for (let callback of this._idleCallbacks) {
try {
await callback();
}
catch (e) {
Zotero.logError(e);
}
}
}
catch (e) {
Zotero.logError(e);
@ -1095,6 +1108,26 @@ Zotero.DBConnection.prototype.isCorruptionError = function (e) {
};
/**
* Register a callback to run when a corruption error occurs but the main database checks out,
* meaning an attached database (e.g., the rebuildable full-text index) is corrupt. The callback
* can rebuild it. Run deferred, after the failing operation unwinds.
*/
Zotero.DBConnection.prototype.addCorruptionHandler = function (handler) {
this._corruptionHandlers.push(handler);
};
/**
* Register a callback to run during the database's idle maintenance, after the periodic backup and
* vacuum. Lets code with its own attached database do maintenance (e.g., vacuuming) on the same
* idle trigger.
*/
Zotero.DBConnection.prototype.onIdle = function (callback) {
this._idleCallbacks.push(callback);
};
/**
* Close the database
* @param {Boolean} [permanent] If true, throw an error instead of
@ -1516,10 +1549,38 @@ Zotero.DBConnection.prototype._getConnectionAsync = async function () {
Zotero.DBConnection.prototype._checkException = async function (e) {
if (this._externalDB || !this.isCorruptionError(e)) {
if (this._externalDB || !this.isCorruptionError(e) || this._checkingCorruption) {
return true;
}
// A "malformed" error can come from an attached database (e.g., the rebuildable full-text
// index) rather than the main file, so confirm the main database is actually corrupt before
// offering to restore it. That way a disposable attached DB's corruption doesn't trigger
// main-database recovery; the attaching code detects and rebuilds it instead.
var mainOK = false;
this._checkingCorruption = true;
try {
mainOK = (await this.valueQueryAsync("PRAGMA main.quick_check(1)")) == 'ok';
}
catch (checkError) {
Zotero.logError(checkError);
}
finally {
this._checkingCorruption = false;
}
if (mainOK) {
Zotero.logError(e);
Zotero.debug("Corruption error but the main database passed a check -- skipping "
+ "main-database recovery", 1);
// Let owners of attached databases (e.g., the full-text index) rebuild them. Deferred so it
// runs after the failing operation unwinds -- a rebuild may need to DETACH, which can't run
// inside the transaction the error may have come from.
for (let handler of this._corruptionHandlers) {
Zotero.Promise.delay(0).then(handler).catch(err => Zotero.logError(err));
}
return true;
}
const supportURL = 'https://zotero.org/support/kb/corrupted_database';
var filename = PathUtils.filename(this._dbPath);