1
0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2025-08-07 06:14:44 +00:00

Use SQLite's AUTOINCREMENT to give us tiddler version identifiers

This commit fixes sync within hosted wikis
This commit is contained in:
Jeremy Ruston 2024-01-21 18:18:29 +00:00
parent 4f9ba11489
commit dc8692044c
7 changed files with 45 additions and 26 deletions

View File

@ -23,15 +23,15 @@ exports.handler = function(request,response,state) {
var bag_name = $tw.utils.decodeURIComponentSafe(state.params[0]), var bag_name = $tw.utils.decodeURIComponentSafe(state.params[0]),
bag_name_2 = $tw.utils.decodeURIComponentSafe(state.params[1]), bag_name_2 = $tw.utils.decodeURIComponentSafe(state.params[1]),
title = $tw.utils.decodeURIComponentSafe(state.params[2]), title = $tw.utils.decodeURIComponentSafe(state.params[2]),
tiddler = bag_name === bag_name_2 && $tw.sqlTiddlerStore.getBagTiddler(title,bag_name); result = bag_name === bag_name_2 && $tw.sqlTiddlerStore.getBagTiddler(title,bag_name);
if(bag_name === bag_name_2 && tiddler) { if(bag_name === bag_name_2 && result) {
// If application/json is requested then this is an API request, and gets the response in JSON // If application/json is requested then this is an API request, and gets the response in JSON
if(request.headers.accept && request.headers.accept.indexOf("application/json") !== -1) { if(request.headers.accept && request.headers.accept.indexOf("application/json") !== -1) {
var tiddlerFields = {}, var tiddlerFields = {},
knownFields = [ knownFields = [
"bag", "created", "creator", "modified", "modifier", "permissions", "recipe", "revision", "tags", "text", "title", "type", "uri" "bag", "created", "creator", "modified", "modifier", "permissions", "recipe", "revision", "tags", "text", "title", "type", "uri"
]; ];
$tw.utils.each(tiddler,function(value,name) { $tw.utils.each(result.tiddler,function(value,name) {
if(knownFields.indexOf(name) !== -1) { if(knownFields.indexOf(name) !== -1) {
tiddlerFields[name] = value; tiddlerFields[name] = value;
} else { } else {
@ -39,17 +39,17 @@ exports.handler = function(request,response,state) {
tiddlerFields.fields[name] = value; tiddlerFields.fields[name] = value;
} }
}); });
tiddlerFields.revision = "0"; tiddlerFields.revision = "" + result.tiddler_id;
tiddlerFields.bag = bag_name; tiddlerFields.bag = bag_name;
tiddlerFields.type = tiddlerFields.type || "text/vnd.tiddlywiki"; tiddlerFields.type = tiddlerFields.type || "text/vnd.tiddlywiki";
state.sendResponse(200,{"Content-Type": "application/json"},JSON.stringify(tiddlerFields),"utf8"); state.sendResponse(200,{"Content-Type": "application/json"},JSON.stringify(tiddlerFields),"utf8");
} else { } else {
// This is not a JSON API request, we should return the raw tiddler content // This is not a JSON API request, we should return the raw tiddler content
var type = tiddler.type || "text/plain"; var type = result.tiddler.type || "text/plain";
response.writeHead(200, "OK",{ response.writeHead(200, "OK",{
"Content-Type": type "Content-Type": type
}); });
response.write(tiddler.text || "",($tw.config.contentTypeInfo[type] ||{encoding: "utf8"}).encoding); response.write(result.tiddler.text || "",($tw.config.contentTypeInfo[type] ||{encoding: "utf8"}).encoding);
response.end();; response.end();;
} }
} else { } else {

View File

@ -39,7 +39,7 @@ exports.handler = function(request,response,state) {
tiddlerFields.fields[name] = value; tiddlerFields.fields[name] = value;
} }
}); });
tiddlerFields.revision = "0"; tiddlerFields.revision = "" + tiddlerInfo.tiddler_id;
tiddlerFields.bag = tiddlerInfo.bag_name; tiddlerFields.bag = tiddlerInfo.bag_name;
tiddlerFields.type = tiddlerFields.type || "text/vnd.tiddlywiki"; tiddlerFields.type = tiddlerFields.type || "text/vnd.tiddlywiki";
state.sendResponse(200,{"Content-Type": "application/json"},JSON.stringify(tiddlerFields),"utf8"); state.sendResponse(200,{"Content-Type": "application/json"},JSON.stringify(tiddlerFields),"utf8");

View File

@ -29,7 +29,7 @@ exports.handler = function(request,response,state) {
var tiddlers = []; var tiddlers = [];
$tw.utils.each(recipeTiddlers,function(recipeTiddlerInfo) { $tw.utils.each(recipeTiddlers,function(recipeTiddlerInfo) {
var tiddlerInfo = $tw.sqlTiddlerStore.getRecipeTiddler(recipeTiddlerInfo.title,recipe_name); var tiddlerInfo = $tw.sqlTiddlerStore.getRecipeTiddler(recipeTiddlerInfo.title,recipe_name);
tiddlers.push(Object.assign({},tiddlerInfo.tiddler,{text: undefined, revision: "0", bag: recipeTiddlerInfo.bag_name})); tiddlers.push(Object.assign({},tiddlerInfo.tiddler,{text: undefined, revision: "" + tiddlerInfo.tiddler_id, bag: recipeTiddlerInfo.bag_name}));
}); });
var text = JSON.stringify(tiddlers); var text = JSON.stringify(tiddlers);
state.sendResponse(200,{"Content-Type": "application/json"},text,"utf8"); state.sendResponse(200,{"Content-Type": "application/json"},text,"utf8");

View File

@ -53,14 +53,14 @@ exports.handler = function(request,response,state) {
var tiddlerInfo = $tw.sqlTiddlerStore.getRecipeTiddler(recipeTiddlerInfo.title,recipe_name); var tiddlerInfo = $tw.sqlTiddlerStore.getRecipeTiddler(recipeTiddlerInfo.title,recipe_name);
if((tiddlerInfo.tiddler.text || "").length > 10 * 1024 * 1024) { if((tiddlerInfo.tiddler.text || "").length > 10 * 1024 * 1024) {
response.write(JSON.stringify(Object.assign({},tiddlerInfo.tiddler,{ response.write(JSON.stringify(Object.assign({},tiddlerInfo.tiddler,{
revision: "0", revision: "" + tiddlerInfo.tiddler_id,
bag: recipeTiddlerInfo.bag_name, bag: recipeTiddlerInfo.bag_name,
text: undefined, text: undefined,
_canonical_uri: `/wiki/${recipe_name}/recipes/${recipe_name}/tiddlers/${title}` _canonical_uri: `/wiki/${recipe_name}/recipes/${recipe_name}/tiddlers/${title}`
}))); })));
} else { } else {
response.write(JSON.stringify(Object.assign({},tiddlerInfo.tiddler,{ response.write(JSON.stringify(Object.assign({},tiddlerInfo.tiddler,{
revision: "0", revision: "" + tiddlerInfo.tiddler_id,
bag: recipeTiddlerInfo.bag_name bag: recipeTiddlerInfo.bag_name
}))); })));
} }

View File

@ -39,9 +39,9 @@ exports.handler = function(request,response,state) {
}); });
// Require the recipe names to match // Require the recipe names to match
if(recipe_name === recipe_name_2) { if(recipe_name === recipe_name_2) {
var bag_name = $tw.sqlTiddlerStore.saveRecipeTiddler(fields,recipe_name); var result = $tw.sqlTiddlerStore.saveRecipeTiddler(fields,recipe_name);
response.writeHead(204, "OK",{ response.writeHead(204, "OK",{
Etag: "\"" + bag_name + "/" + encodeURIComponent(title) + "/" + 2222 + ":\"", Etag: "\"" + result.bag_name + "/" + encodeURIComponent(title) + "/" + result.tiddler_id + ":\"",
"Content-Type": "text/plain" "Content-Type": "text/plain"
}); });
response.end(); response.end();

View File

@ -32,7 +32,7 @@ SqlTiddlerStore.prototype.close = function() {
SqlTiddlerStore.prototype.runStatement = function(sql,params) { SqlTiddlerStore.prototype.runStatement = function(sql,params) {
params = params || {}; params = params || {};
const statement = this.db.prepare(sql); const statement = this.db.prepare(sql);
statement.run(params); return statement.run(params);
}; };
SqlTiddlerStore.prototype.runStatementGet = function(sql,params) { SqlTiddlerStore.prototype.runStatementGet = function(sql,params) {
@ -81,14 +81,14 @@ SqlTiddlerStore.prototype.createTables = function() {
this.runStatements([` this.runStatements([`
-- Bags have names and access control settings -- Bags have names and access control settings
CREATE TABLE IF NOT EXISTS bags ( CREATE TABLE IF NOT EXISTS bags (
bag_id INTEGER PRIMARY KEY, bag_id INTEGER PRIMARY KEY AUTOINCREMENT,
bag_name TEXT UNIQUE, bag_name TEXT UNIQUE,
accesscontrol TEXT accesscontrol TEXT
) )
`,` `,`
-- Recipes have names... -- Recipes have names...
CREATE TABLE IF NOT EXISTS recipes ( CREATE TABLE IF NOT EXISTS recipes (
recipe_id INTEGER PRIMARY KEY, recipe_id INTEGER PRIMARY KEY AUTOINCREMENT,
recipe_name TEXT UNIQUE recipe_name TEXT UNIQUE
) )
`,` `,`
@ -104,7 +104,7 @@ SqlTiddlerStore.prototype.createTables = function() {
`,` `,`
-- Tiddlers are contained in bags and have titles -- Tiddlers are contained in bags and have titles
CREATE TABLE IF NOT EXISTS tiddlers ( CREATE TABLE IF NOT EXISTS tiddlers (
tiddler_id INTEGER PRIMARY KEY, tiddler_id INTEGER PRIMARY KEY AUTOINCREMENT,
bag_id INTEGER, bag_id INTEGER,
title TEXT, title TEXT,
FOREIGN KEY (bag_id) REFERENCES bags(bag_id) ON UPDATE CASCADE ON DELETE CASCADE, FOREIGN KEY (bag_id) REFERENCES bags(bag_id) ON UPDATE CASCADE ON DELETE CASCADE,
@ -212,9 +212,12 @@ SqlTiddlerStore.prototype.createRecipe = function(recipename,bagnames) {
}); });
}; };
/*
Returns {tiddler_id:}
*/
SqlTiddlerStore.prototype.saveBagTiddler = function(tiddlerFields,bagname) { SqlTiddlerStore.prototype.saveBagTiddler = function(tiddlerFields,bagname) {
// Update the tiddlers table // Update the tiddlers table
this.runStatement(` var info = this.runStatement(`
INSERT OR REPLACE INTO tiddlers (bag_id, title) INSERT OR REPLACE INTO tiddlers (bag_id, title)
VALUES ( VALUES (
(SELECT bag_id FROM bags WHERE bag_name = $bag_name), (SELECT bag_id FROM bags WHERE bag_name = $bag_name),
@ -246,8 +249,14 @@ SqlTiddlerStore.prototype.saveBagTiddler = function(tiddlerFields,bagname) {
bag_name: bagname, bag_name: bagname,
field_values: JSON.stringify(Object.assign({},tiddlerFields,{title: undefined})) field_values: JSON.stringify(Object.assign({},tiddlerFields,{title: undefined}))
}); });
return {
tiddler_id: info.lastInsertRowid
}
}; };
/*
Returns {tiddler_id:,bag_name:}
*/
SqlTiddlerStore.prototype.saveRecipeTiddler = function(tiddlerFields,recipename) { SqlTiddlerStore.prototype.saveRecipeTiddler = function(tiddlerFields,recipename) {
// Find the topmost bag in the recipe // Find the topmost bag in the recipe
var row = this.runStatementGet(` var row = this.runStatementGet(`
@ -269,8 +278,11 @@ SqlTiddlerStore.prototype.saveRecipeTiddler = function(tiddlerFields,recipename)
recipe_name: recipename recipe_name: recipename
}); });
// Save the tiddler to the topmost bag // Save the tiddler to the topmost bag
this.saveBagTiddler(tiddlerFields,row.bag_name); var info = this.saveBagTiddler(tiddlerFields,row.bag_name);
return row.bag_name; return {
tiddler_id: info.tiddler_id,
bag_name: row.bag_name
};
}; };
SqlTiddlerStore.prototype.deleteTiddler = function(title,bagname) { SqlTiddlerStore.prototype.deleteTiddler = function(title,bagname) {
@ -300,9 +312,12 @@ SqlTiddlerStore.prototype.deleteTiddler = function(title,bagname) {
}); });
}; };
/*
returns {tiddler_id:,tiddler:}
*/
SqlTiddlerStore.prototype.getBagTiddler = function(title,bagname) { SqlTiddlerStore.prototype.getBagTiddler = function(title,bagname) {
const rows = this.runStatementGetAll(` const rows = this.runStatementGetAll(`
SELECT field_name, field_value SELECT field_name, field_value, tiddler_id
FROM fields FROM fields
WHERE tiddler_id = ( WHERE tiddler_id = (
SELECT t.tiddler_id SELECT t.tiddler_id
@ -317,15 +332,18 @@ SqlTiddlerStore.prototype.getBagTiddler = function(title,bagname) {
if(rows.length === 0) { if(rows.length === 0) {
return null; return null;
} else { } else {
return rows.reduce((accumulator,value) => { return {
accumulator[value["field_name"]] = value.field_value; tiddler_id: rows[0].tiddler_id,
return accumulator; tiddler: rows.reduce((accumulator,value) => {
},{title: title}); accumulator[value["field_name"]] = value.field_value;
return accumulator;
},{title: title})
};
} }
}; };
/* /*
Returns {bag_name:, tiddler: {fields}} Returns {bag_name:, tiddler: {fields}, tiddler_id:}
*/ */
SqlTiddlerStore.prototype.getRecipeTiddler = function(title,recipename) { SqlTiddlerStore.prototype.getRecipeTiddler = function(title,recipename) {
const rowTiddlerId = this.runStatementGet(` const rowTiddlerId = this.runStatementGet(`
@ -356,6 +374,7 @@ SqlTiddlerStore.prototype.getRecipeTiddler = function(title,recipename) {
}); });
return { return {
bag_name: rowTiddlerId.bag_name, bag_name: rowTiddlerId.bag_name,
tiddler_id: rowTiddlerId.tiddler_id,
tiddler: rows.reduce((accumulator,value) => { tiddler: rows.reduce((accumulator,value) => {
accumulator[value["field_name"]] = value.field_value; accumulator[value["field_name"]] = value.field_value;
return accumulator; return accumulator;

View File

@ -71,7 +71,7 @@ describe("SQL tiddler store", function() {
expect(sqlTiddlerStore.getRecipeTiddlers("recipe-rho")).toEqual([ { title: 'Hello There', bag_name: 'bag-alpha' } ]); expect(sqlTiddlerStore.getRecipeTiddlers("recipe-rho")).toEqual([ { title: 'Hello There', bag_name: 'bag-alpha' } ]);
expect(sqlTiddlerStore.getRecipeTiddlers("recipe-sigma")).toEqual([ { title: 'Hello There', bag_name: 'bag-gamma' } ]); expect(sqlTiddlerStore.getRecipeTiddlers("recipe-sigma")).toEqual([ { title: 'Hello There', bag_name: 'bag-gamma' } ]);
// Save a recipe tiddler // Save a recipe tiddler
sqlTiddlerStore.saveRecipeTiddler({title: "More", text: "None"},"recipe-rho"); expect(sqlTiddlerStore.saveRecipeTiddler({title: "More", text: "None"},"recipe-rho")).toEqual({tiddler_id: 5, bag_name: 'bag-beta'});
expect(sqlTiddlerStore.getRecipeTiddler("More","recipe-rho").tiddler).toEqual({title: "More", text: "None"}); expect(sqlTiddlerStore.getRecipeTiddler("More","recipe-rho").tiddler).toEqual({title: "More", text: "None"});
}); });