mirror of
https://github.com/Jermolene/TiddlyWiki5
synced 2024-12-26 01:50:28 +00:00
8a9d48e055
* Do not remove localstorage items while looping While looping over all the browser storage items by index, the items should not be removed because removing alters the index positions. The item following the removed one will be skipped by the loop. Instead, accumulate a list of keys to remove and remove them after the loop. * Implement full delete support for browser storage plugin Before, deletes only worked for tiddlers which are only present in the localstorage. Now deleted tiddlers are marked in localstorage using an empty string value. At startup, the localstorage tiddlers with empty strings will be deleted from the wiki if they are still present. If they are already gone from the wiki, then the blank localstorage entry will be deleted. * Document drawbacks to using '[all[]]' and provide an alternative
95 lines
2.9 KiB
JavaScript
95 lines
2.9 KiB
JavaScript
/*\
|
|
title: $:/plugins/tiddlywiki/browser-storage/rawmarkup.js
|
|
type: application/javascript
|
|
module-type: library
|
|
|
|
Startup code injected as raw markup
|
|
|
|
\*/
|
|
|
|
(function() {
|
|
|
|
// Need to initialise these because we run before bootprefix.js and boot.js
|
|
$tw = window.$tw || Object.create(null);
|
|
$tw.hooks = $tw.hooks || { names: {}};
|
|
$tw.boot = $tw.boot || {};
|
|
$tw.boot.preloadDirty = $tw.boot.preloadDirty || [];
|
|
|
|
// Hook the point in the startup process when the tiddlers have been loaded but plugins not unpacked
|
|
var hookName = "th-boot-tiddlers-loaded";
|
|
if(Object.prototype.hasOwnProperty.call($tw.hooks.names,hookName)) {
|
|
$tw.hooks.names[hookName].push(hookBootTiddlersLoaded);
|
|
} else {
|
|
$tw.hooks.names[hookName] = [hookBootTiddlersLoaded];
|
|
}
|
|
|
|
// Load tiddlers from browser storage
|
|
function hookBootTiddlersLoaded() {
|
|
var url = window.location.pathname,
|
|
keysToDelete = [],
|
|
log = [];
|
|
// Check that browser storage is available
|
|
try {
|
|
window.localStorage;
|
|
} catch(e) {
|
|
return;
|
|
}
|
|
// Step through each browsder storage item
|
|
for(var index=0; index<window.localStorage.length; index++) {
|
|
var key = window.localStorage.key(index),
|
|
parts = key.split("#");
|
|
// If it's ours
|
|
if(parts[0] === "tw5" && parts[1] === url) {
|
|
// Read it as JSON
|
|
var jsonString = window.localStorage.getItem(key),
|
|
jsonData;
|
|
if(jsonString) {
|
|
try {
|
|
jsonData = JSON.parse(jsonString);
|
|
} catch(e) {}
|
|
if(jsonData) {
|
|
// Convert it to a tiddler
|
|
var incomingTiddler = new $tw.Tiddler(jsonData);
|
|
if(incomingTiddler) {
|
|
// Get any existing tiddler
|
|
var title = incomingTiddler.fields.title,
|
|
existingTiddler = $tw.wiki.getTiddler(title);
|
|
if(existingTiddler && existingTiddler.isEqual(incomingTiddler)) {
|
|
// If the incoming tiddler is the same as the existing then we can delete the local storage version
|
|
// Defer deletion until after this loop, since deleting will shift the index and cause the
|
|
// index+1 item to be skipped.
|
|
keysToDelete.push(key);
|
|
} else {
|
|
$tw.wiki.addTiddler(incomingTiddler);
|
|
log.push(title);
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
// Empty value means the tiddler is marked as deleted
|
|
var title = parts.slice(2).join("#"),
|
|
existingTiddler = $tw.wiki.getTiddler(title);
|
|
if(existingTiddler) {
|
|
// The tiddler still exists in the wiki. Delete it so it won't be visible.
|
|
$tw.wiki.deleteTiddler(title);
|
|
} else {
|
|
// The tiddler is already missing from the wiki, so delete the blank local storage entry
|
|
keysToDelete.push(key);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
$tw.utils.each(keysToDelete,function(key) {
|
|
window.localStorage.removeItem(key);
|
|
});
|
|
// Make sure that all the tiddlers we've loaded are marked as dirty at startup
|
|
Array.prototype.push.apply($tw.boot.preloadDirty,log);
|
|
// Save the log
|
|
$tw.wiki.addTiddler({
|
|
title: "$:/temp/BrowserStorage/Log",
|
|
text: $tw.utils.stringifyList(log)
|
|
});
|
|
}
|
|
|
|
})();
|