Bug 458683 - Backup only uri nodes into tag containers (for mak77@bonardo.net, r=dietrich, a=dveditz)

git-svn-id: svn://10.0.0.236/trunk@255094 18797224-902f-48f8-a5cc-f745e15eee43
This commit is contained in:
dietrich%mozilla.com 2008-11-18 17:34:01 +00:00
parent 44e7305321
commit 569c5928ae
3 changed files with 226 additions and 9 deletions

View File

@ -242,8 +242,14 @@ TaggingService.prototype = {
tagNode.QueryInterface(Ci.nsINavHistoryContainerResultNode);
tagNode.containerOpen = true;
var cc = tagNode.childCount;
for (var i=0; i < cc; i++)
uris.push(gIoService.newURI(tagNode.getChild(i).uri, null, null));
for (var i = 0; i < cc; i++) {
try {
uris.push(gIoService.newURI(tagNode.getChild(i).uri, null, null));
} catch (ex) {
// This is an invalid node, tags should only contain valid uri nodes.
// continue to next node.
}
}
tagNode.containerOpen = false;
}
return uris;

View File

@ -1084,11 +1084,26 @@ var PlacesUtils = {
// remove tags via the tagging service
var tags = this._utils.tagging.allTags;
var uris = [];
var bogusTagContainer = false;
for (let i in tags) {
var tagURIs = this._utils.tagging.getURIsForTag(tags[i]);
var tagURIs = [];
// skip empty tags since getURIsForTag would throw
if (tags[i])
tagURIs = this._utils.tagging.getURIsForTag(tags[i]);
if (!tagURIs.length) {
// This is a bogus tag container, empty tags should be removed
// automatically, but this does not work if they contain some
// not-uri node, so we remove them manually.
// XXX this is a temporary workaround until we implement
// preventive database maintainance in bug 431558.
bogusTagContainer = true;
}
for (let j in tagURIs)
this._utils.tagging.untagURI(tagURIs[j], [tags[i]]);
}
if (bogusTagContainer)
this._utils.bookmarks.removeFolderChildren(rootItemId);
}
else if ([this._utils.toolbarFolderId,
this._utils.unfiledBookmarksFolderId,
@ -1172,7 +1187,11 @@ var PlacesUtils = {
if (aContainer == PlacesUtils.bookmarks.tagsFolder) {
if (aData.children) {
aData.children.forEach(function(aChild) {
this.tagging.tagURI(this._uri(aChild.uri), [aData.title]);
try {
this.tagging.tagURI(this._uri(aChild.uri), [aData.title]);
} catch (ex) {
// invalid tag child, skip it
}
}, this);
return [folderIdMap, searchIds];
}
@ -1430,9 +1449,9 @@ var PlacesUtils = {
var childNode = aSourceNode.getChild(i);
if (aExcludeItems && aExcludeItems.indexOf(childNode.itemId) != -1)
continue;
if (i != 0)
var written = serializeNodeToJSONStream(aSourceNode.getChild(i), i);
if (written && i < cc - 1)
aStream.write(",", 1);
serializeNodeToJSONStream(aSourceNode.getChild(i), i);
}
if (!wasOpen)
aSourceNode.containerOpen = false;
@ -1453,26 +1472,44 @@ var PlacesUtils = {
addGenericProperties(bNode, node);
var parent = bNode.parent;
var grandParent = parent ? parent.parent : null;
if (self.nodeIsURI(bNode)) {
// Tag root accept only folder nodes
if (parent && parent.itemId == self.tagsFolderId)
return false;
// Check for url validity, since we can't halt while writing a backup.
// This will throw if we try to serialize an invalid url and it does
// not make sense saving a wrong or corrupt uri node.
try {
self._uri(bNode.uri);
} catch (ex) {
return;
return false;
}
addURIProperties(bNode, node);
}
else if (self.nodeIsContainer(bNode))
else if (self.nodeIsContainer(bNode)) {
// Tag containers accept only uri nodes
if (grandParent && grandParent.itemId == self.tagsFolderId)
return false;
addContainerProperties(bNode, node);
else if (self.nodeIsSeparator(bNode))
}
else if (self.nodeIsSeparator(bNode)) {
// Tag root accept only folder nodes
// Tag containers accept only uri nodes
if ((parent && parent.itemId == self.tagsFolderId) ||
(grandParent && grandParent.itemId == self.tagsFolderId))
return false;
addSeparatorProperties(bNode, node);
}
if (!node.feedURI && node.type == self.TYPE_X_MOZ_PLACE_CONTAINER)
writeComplexNode(aStream, node, bNode);
else
writeScalarNode(aStream, node);
return true;
}
// serialize to stream

View File

@ -0,0 +1,174 @@
/* -*- Mode: Java; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim:set ts=2 sw=2 sts=2 et: */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Bug 458683 code.
*
* The Initial Developer of the Original Code is Mozilla Corp.
* Portions created by the Initial Developer are Copyright (C) 2008
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Marco Bonardo <mak77@bonardo.net> (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* either the GNU General Public License Version 2 or later (the "GPL"), or
* the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
Components.utils.import("resource://gre/modules/utils.js");
var tests = [];
// Get database connection
try {
var mDBConn = PlacesUtils.history.QueryInterface(Ci.nsPIPlacesDatabase)
.DBConnection;
}
catch(ex) {
do_throw("Could not get database connection\n");
}
/*
This test is:
- don't block while doing backup and restore if tag containers contain
bogus items (separators, folders)
*/
var invalidTagChildTest = {
_itemTitle: "invalid uri",
_itemUrl: "http://test.mozilla.org/",
_itemId: -1,
_tag: "testTag",
_tagItemId: -1,
populate: function () {
// add a valid bookmark
this._itemId = PlacesUtils.bookmarks
.insertBookmark(PlacesUtils.toolbarFolderId,
PlacesUtils._uri(this._itemUrl),
PlacesUtils.bookmarks.DEFAULT_INDEX,
this._itemTitle);
// create a tag
PlacesUtils.tagging.tagURI(PlacesUtils._uri(this._itemUrl), [this._tag]);
// get tag folder id
var options = PlacesUtils.history.getNewQueryOptions();
var query = PlacesUtils.history.getNewQuery();
query.setFolders([PlacesUtils.bookmarks.tagsFolder], 1);
var result = PlacesUtils.history.executeQuery(query, options);
var tagRoot = result.root;
tagRoot.containerOpen = true;
do_check_eq(tagRoot.childCount, 1);
var tagNode = tagRoot.getChild(0)
.QueryInterface(Ci.nsINavHistoryContainerResultNode);
this._tagItemId = tagNode.itemId;
tagRoot.containerOpen = false;
// add a separator and a folder inside tag folder
PlacesUtils.bookmarks.insertSeparator(this._tagItemId,
PlacesUtils.bookmarks.DEFAULT_INDEX);
PlacesUtils.bookmarks.createFolder(this._tagItemId,
"test folder",
PlacesUtils.bookmarks.DEFAULT_INDEX);
// add a separator and a folder inside tag root
PlacesUtils.bookmarks.insertSeparator(PlacesUtils.bookmarks.tagsFolder,
PlacesUtils.bookmarks.DEFAULT_INDEX);
PlacesUtils.bookmarks.createFolder(PlacesUtils.bookmarks.tagsFolder,
"test tags root folder",
PlacesUtils.bookmarks.DEFAULT_INDEX);
},
clean: function () {
PlacesUtils.tagging.untagURI(PlacesUtils._uri(this._itemUrl), [this._tag]);
PlacesUtils.bookmarks.removeItem(this._itemId);
},
validate: function () {
var query = PlacesUtils.history.getNewQuery();
query.setFolders([PlacesUtils.bookmarks.toolbarFolder], 1);
var options = PlacesUtils.history.getNewQueryOptions();
var result = PlacesUtils.history.executeQuery(query, options);
var toolbar = result.root;
toolbar.containerOpen = true;
// test for our bookmark
do_check_eq(toolbar.childCount, 1);
for (var i = 0; i < toolbar.childCount; i++) {
var folderNode = toolbar.getChild(0);
do_check_eq(folderNode.type, folderNode.RESULT_TYPE_URI);
do_check_eq(folderNode.title, this._itemTitle);
}
toolbar.containerOpen = false;
// test for our tag
var tags = PlacesUtils.tagging.getTagsForURI(PlacesUtils._uri(this._itemUrl), {});
do_check_eq(tags.length, 1);
do_check_eq(tags[0], this._tag);
}
}
tests.push(invalidTagChildTest);
function run_test() {
do_check_eq(typeof PlacesUtils, "object");
// make json file
var jsonFile = dirSvc.get("ProfD", Ci.nsILocalFile);
jsonFile.append("bookmarks.json");
if (jsonFile.exists())
jsonFile.remove(false);
jsonFile.create(Ci.nsILocalFile.NORMAL_FILE_TYPE, 0600);
if (!jsonFile.exists())
do_throw("couldn't create file: bookmarks.exported.json");
// populate db
tests.forEach(function(aTest) {
aTest.populate();
// sanity
aTest.validate();
});
// export json to file
try {
PlacesUtils.backupBookmarksToFile(jsonFile);
} catch(ex) { do_throw("couldn't export to file: " + ex); }
// clean
tests.forEach(function(aTest) {
aTest.clean();
});
// restore json file
try {
PlacesUtils.restoreBookmarksFromJSONFile(jsonFile);
} catch(ex) { do_throw("couldn't import the exported file: " + ex); }
// validate
tests.forEach(function(aTest) {
aTest.validate();
});
// clean up
jsonFile.remove(false);
}