mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-11-05 08:35:26 +00:00
3402 lines
116 KiB
JavaScript
3402 lines
116 KiB
JavaScript
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* ***** 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 the Places Command Controller.
|
|
*
|
|
* The Initial Developer of the Original Code is Google Inc.
|
|
* Portions created by the Initial Developer are Copyright (C) 2005
|
|
* the Initial Developer. All Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
* Ben Goodger <beng@google.com>
|
|
* Myk Melez <myk@mozilla.org>
|
|
* Asaf Romano <mano@mozilla.com>
|
|
* Sungjoon Steve Won <stevewon@gmail.com>
|
|
* Dietrich Ayala <dietrich@mozilla.com>
|
|
* Marco Bonardo <mak77@bonardo.net>
|
|
*
|
|
* 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 ***** */
|
|
|
|
const EXPORTED_SYMBOLS = [
|
|
"PlacesUtils"
|
|
, "PlacesAggregatedTransaction"
|
|
, "PlacesCreateFolderTransaction"
|
|
, "PlacesCreateBookmarkTransaction"
|
|
, "PlacesCreateSeparatorTransaction"
|
|
, "PlacesCreateLivemarkTransaction"
|
|
, "PlacesMoveItemTransaction"
|
|
, "PlacesRemoveItemTransaction"
|
|
, "PlacesEditItemTitleTransaction"
|
|
, "PlacesEditBookmarkURITransaction"
|
|
, "PlacesSetItemAnnotationTransaction"
|
|
, "PlacesSetPageAnnotationTransaction"
|
|
, "PlacesEditBookmarkKeywordTransaction"
|
|
, "PlacesEditBookmarkPostDataTransaction"
|
|
, "PlacesEditLivemarkSiteURITransaction"
|
|
, "PlacesEditLivemarkFeedURITransaction"
|
|
, "PlacesEditItemDateAddedTransaction"
|
|
, "PlacesEditItemLastModifiedTransaction"
|
|
, "PlacesSortFolderByNameTransaction"
|
|
, "PlacesTagURITransaction"
|
|
, "PlacesUntagURITransaction"
|
|
];
|
|
|
|
const Ci = Components.interfaces;
|
|
const Cc = Components.classes;
|
|
const Cr = Components.results;
|
|
const Cu = Components.utils;
|
|
|
|
Cu.import("resource://gre/modules/XPCOMUtils.jsm");
|
|
|
|
XPCOMUtils.defineLazyGetter(this, "Services", function() {
|
|
Cu.import("resource://gre/modules/Services.jsm");
|
|
return Services;
|
|
});
|
|
|
|
XPCOMUtils.defineLazyGetter(this, "NetUtil", function() {
|
|
Cu.import("resource://gre/modules/NetUtil.jsm");
|
|
return NetUtil;
|
|
});
|
|
|
|
// The minimum amount of transactions before starting a batch. Usually we do
|
|
// do incremental updates, a batch will cause views to completely
|
|
// refresh instead.
|
|
const MIN_TRANSACTIONS_FOR_BATCH = 5;
|
|
|
|
// The RESTORE_*_NSIOBSERVER_TOPIC constants should match the #defines of the
|
|
// same names in browser/components/places/src/nsPlacesImportExportService.cpp
|
|
const RESTORE_BEGIN_NSIOBSERVER_TOPIC = "bookmarks-restore-begin";
|
|
const RESTORE_SUCCESS_NSIOBSERVER_TOPIC = "bookmarks-restore-success";
|
|
const RESTORE_FAILED_NSIOBSERVER_TOPIC = "bookmarks-restore-failed";
|
|
const RESTORE_NSIOBSERVER_DATA = "json";
|
|
|
|
#ifdef XP_MACOSX
|
|
// On Mac OSX, the transferable system converts "\r\n" to "\n\n", where we
|
|
// really just want "\n".
|
|
const NEWLINE= "\n";
|
|
#else
|
|
// On other platforms, the transferable system converts "\r\n" to "\n".
|
|
const NEWLINE = "\r\n";
|
|
#endif
|
|
|
|
function QI_node(aNode, aIID) {
|
|
var result = null;
|
|
try {
|
|
result = aNode.QueryInterface(aIID);
|
|
}
|
|
catch (e) {
|
|
}
|
|
return result;
|
|
}
|
|
function asVisit(aNode) QI_node(aNode, Ci.nsINavHistoryVisitResultNode);
|
|
function asFullVisit(aNode) QI_node(aNode, Ci.nsINavHistoryFullVisitResultNode);
|
|
function asContainer(aNode) QI_node(aNode, Ci.nsINavHistoryContainerResultNode);
|
|
function asQuery(aNode) QI_node(aNode, Ci.nsINavHistoryQueryResultNode);
|
|
|
|
var PlacesUtils = {
|
|
// Place entries that are containers, e.g. bookmark folders or queries.
|
|
TYPE_X_MOZ_PLACE_CONTAINER: "text/x-moz-place-container",
|
|
// Place entries that are bookmark separators.
|
|
TYPE_X_MOZ_PLACE_SEPARATOR: "text/x-moz-place-separator",
|
|
// Place entries that are not containers or separators
|
|
TYPE_X_MOZ_PLACE: "text/x-moz-place",
|
|
// Place entries in shortcut url format (url\ntitle)
|
|
TYPE_X_MOZ_URL: "text/x-moz-url",
|
|
// Place entries formatted as HTML anchors
|
|
TYPE_HTML: "text/html",
|
|
// Place entries as raw URL text
|
|
TYPE_UNICODE: "text/unicode",
|
|
// Used to track the action that populated the clipboard.
|
|
TYPE_X_MOZ_PLACE_ACTION: "text/x-moz-place-action",
|
|
|
|
EXCLUDE_FROM_BACKUP_ANNO: "places/excludeFromBackup",
|
|
GUID_ANNO: "placesInternal/GUID",
|
|
LMANNO_FEEDURI: "livemark/feedURI",
|
|
LMANNO_SITEURI: "livemark/siteURI",
|
|
LMANNO_EXPIRATION: "livemark/expiration",
|
|
LMANNO_LOADFAILED: "livemark/loadfailed",
|
|
LMANNO_LOADING: "livemark/loading",
|
|
POST_DATA_ANNO: "bookmarkProperties/POSTData",
|
|
READ_ONLY_ANNO: "placesInternal/READ_ONLY",
|
|
|
|
TOPIC_SHUTDOWN: "places-shutdown",
|
|
TOPIC_INIT_COMPLETE: "places-init-complete",
|
|
TOPIC_DATABASE_LOCKED: "places-database-locked",
|
|
TOPIC_EXPIRATION_FINISHED: "places-expiration-finished",
|
|
TOPIC_FEEDBACK_UPDATED: "places-autocomplete-feedback-updated",
|
|
TOPIC_FAVICONS_EXPIRED: "places-favicons-expired",
|
|
TOPIC_VACUUM_STARTING: "places-vacuum-starting",
|
|
|
|
asVisit: function(aNode) asVisit(aNode),
|
|
asFullVisit: function(aNode) asFullVisit(aNode),
|
|
asContainer: function(aNode) asContainer(aNode),
|
|
asQuery: function(aNode) asQuery(aNode),
|
|
|
|
endl: NEWLINE,
|
|
|
|
/**
|
|
* Makes a URI from a spec.
|
|
* @param aSpec
|
|
* The string spec of the URI
|
|
* @returns A URI object for the spec.
|
|
*/
|
|
_uri: function PU__uri(aSpec) {
|
|
return NetUtil.newURI(aSpec);
|
|
},
|
|
|
|
/**
|
|
* Wraps a string in a nsISupportsString wrapper.
|
|
* @param aString
|
|
* The string to wrap.
|
|
* @returns A nsISupportsString object containing a string.
|
|
*/
|
|
toISupportsString: function PU_toISupportsString(aString) {
|
|
let s = Cc["@mozilla.org/supports-string;1"].
|
|
createInstance(Ci.nsISupportsString);
|
|
s.data = aString;
|
|
return s;
|
|
},
|
|
|
|
getFormattedString: function PU_getFormattedString(key, params) {
|
|
return bundle.formatStringFromName(key, params, params.length);
|
|
},
|
|
|
|
getString: function PU_getString(key) {
|
|
return bundle.GetStringFromName(key);
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a Bookmark folder.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a Bookmark folder, false otherwise
|
|
*/
|
|
nodeIsFolder: function PU_nodeIsFolder(aNode) {
|
|
return (aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER ||
|
|
aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER_SHORTCUT);
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode represents a bookmarked URI.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node represents a bookmarked URI, false otherwise
|
|
*/
|
|
nodeIsBookmark: function PU_nodeIsBookmark(aNode) {
|
|
return aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_URI &&
|
|
aNode.itemId != -1;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a Bookmark separator.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a Bookmark separator, false otherwise
|
|
*/
|
|
nodeIsSeparator: function PU_nodeIsSeparator(aNode) {
|
|
|
|
return (aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_SEPARATOR);
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a visit item.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a visit item, false otherwise
|
|
*/
|
|
nodeIsVisit: function PU_nodeIsVisit(aNode) {
|
|
var type = aNode.type;
|
|
return type == Ci.nsINavHistoryResultNode.RESULT_TYPE_VISIT ||
|
|
type == Ci.nsINavHistoryResultNode.RESULT_TYPE_FULL_VISIT;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a URL item.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a URL item, false otherwise
|
|
*/
|
|
uriTypes: [Ci.nsINavHistoryResultNode.RESULT_TYPE_URI,
|
|
Ci.nsINavHistoryResultNode.RESULT_TYPE_VISIT,
|
|
Ci.nsINavHistoryResultNode.RESULT_TYPE_FULL_VISIT],
|
|
nodeIsURI: function PU_nodeIsURI(aNode) {
|
|
return this.uriTypes.indexOf(aNode.type) != -1;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a Query item.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a Query item, false otherwise
|
|
*/
|
|
nodeIsQuery: function PU_nodeIsQuery(aNode) {
|
|
return aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY;
|
|
},
|
|
|
|
/**
|
|
* Generator for a node's ancestors.
|
|
* @param aNode
|
|
* A result node
|
|
*/
|
|
nodeAncestors: function PU_nodeAncestors(aNode) {
|
|
let node = aNode.parent;
|
|
while (node) {
|
|
yield node;
|
|
node = node.parent;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Cache array of read-only item IDs.
|
|
*
|
|
* The first time this property is called:
|
|
* - the cache is filled with all ids with the RO annotation
|
|
* - an annotation observer is added
|
|
* - a shutdown observer is added
|
|
*
|
|
* When the annotation observer detects annotations added or
|
|
* removed that are the RO annotation name, it adds/removes
|
|
* the ids from the cache.
|
|
*
|
|
* At shutdown, the annotation and shutdown observers are removed.
|
|
*/
|
|
get _readOnly() {
|
|
// Add annotations observer.
|
|
this.annotations.addObserver(this, false);
|
|
this.registerShutdownFunction(function () {
|
|
this.annotations.removeObserver(this);
|
|
});
|
|
|
|
var readOnly = this.annotations.getItemsWithAnnotation(this.READ_ONLY_ANNO);
|
|
this.__defineGetter__("_readOnly", function() readOnly);
|
|
return this._readOnly;
|
|
},
|
|
|
|
QueryInterface: XPCOMUtils.generateQI([
|
|
Ci.nsIAnnotationObserver
|
|
, Ci.nsIObserver
|
|
, Ci.nsITransactionListener
|
|
]),
|
|
|
|
_shutdownFunctions: [],
|
|
registerShutdownFunction: function PU_registerShutdownFunction(aFunc)
|
|
{
|
|
// If this is the first registered function, add the shutdown observer.
|
|
if (this._shutdownFunctions.length == 0) {
|
|
Services.obs.addObserver(this, this.TOPIC_SHUTDOWN, false);
|
|
}
|
|
this._shutdownFunctions.push(aFunc);
|
|
},
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
//// nsIObserver
|
|
observe: function PU_observe(aSubject, aTopic, aData)
|
|
{
|
|
if (aTopic == this.TOPIC_SHUTDOWN) {
|
|
Services.obs.removeObserver(this, this.TOPIC_SHUTDOWN);
|
|
this._shutdownFunctions.forEach(function (aFunc) aFunc.apply(this), this);
|
|
}
|
|
},
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
//// nsIAnnotationObserver
|
|
|
|
onItemAnnotationSet: function PU_onItemAnnotationSet(aItemId, aAnnotationName)
|
|
{
|
|
if (aAnnotationName == this.READ_ONLY_ANNO &&
|
|
this._readOnly.indexOf(aItemId) == -1)
|
|
this._readOnly.push(aItemId);
|
|
},
|
|
|
|
onItemAnnotationRemoved:
|
|
function PU_onItemAnnotationRemoved(aItemId, aAnnotationName)
|
|
{
|
|
var index = this._readOnly.indexOf(aItemId);
|
|
if (aAnnotationName == this.READ_ONLY_ANNO && index > -1)
|
|
delete this._readOnly[index];
|
|
},
|
|
|
|
onPageAnnotationSet: function() {},
|
|
onPageAnnotationRemoved: function() {},
|
|
|
|
|
|
//////////////////////////////////////////////////////////////////////////////
|
|
//// nsITransactionListener
|
|
|
|
didDo: function PU_didDo(aManager, aTransaction, aDoResult)
|
|
{
|
|
updateCommandsOnActiveWindow();
|
|
},
|
|
|
|
didUndo: function PU_didUndo(aManager, aTransaction, aUndoResult)
|
|
{
|
|
updateCommandsOnActiveWindow();
|
|
},
|
|
|
|
didRedo: function PU_didRedo(aManager, aTransaction, aRedoResult)
|
|
{
|
|
updateCommandsOnActiveWindow();
|
|
},
|
|
|
|
didBeginBatch: function PU_didBeginBatch(aManager, aResult)
|
|
{
|
|
// A no-op transaction is pushed to the stack, in order to make safe and
|
|
// easy to implement "Undo" an unknown number of transactions (including 0),
|
|
// "above" beginBatch and endBatch. Otherwise,implementing Undo that way
|
|
// head to dataloss: for example, if no changes were done in the
|
|
// edit-item panel, the last transaction on the undo stack would be the
|
|
// initial createItem transaction, or even worse, the batched editing of
|
|
// some other item.
|
|
// DO NOT MOVE this to the window scope, that would leak (bug 490068)!
|
|
this.transactionManager.doTransaction({ doTransaction: function() {},
|
|
undoTransaction: function() {},
|
|
redoTransaction: function() {},
|
|
isTransient: false,
|
|
merge: function() { return false; }
|
|
});
|
|
},
|
|
|
|
willDo: function PU_willDo() {},
|
|
willUndo: function PU_willUndo() {},
|
|
willRedo: function PU_willRedo() {},
|
|
willBeginBatch: function PU_willBeginBatch() {},
|
|
willEndBatch: function PU_willEndBatch() {},
|
|
didEndBatch: function PU_didEndBatch() {},
|
|
willMerge: function PU_willMerge() {},
|
|
didMerge: function PU_didMerge() {},
|
|
|
|
|
|
/**
|
|
* Determines if a node is read only (children cannot be inserted, sometimes
|
|
* they cannot be removed depending on the circumstance)
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is readonly, false otherwise
|
|
*/
|
|
nodeIsReadOnly: function PU_nodeIsReadOnly(aNode) {
|
|
if (this.nodeIsFolder(aNode) || this.nodeIsDynamicContainer(aNode)) {
|
|
if (this._readOnly.indexOf(aNode.itemId) != -1)
|
|
return true;
|
|
}
|
|
else if (this.nodeIsQuery(aNode) &&
|
|
asQuery(aNode).queryOptions.resultType !=
|
|
Ci.nsINavHistoryQueryOptions.RESULTS_AS_TAG_CONTENTS)
|
|
return aNode.childrenReadOnly;
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a host container.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a host container, false otherwise
|
|
*/
|
|
nodeIsHost: function PU_nodeIsHost(aNode) {
|
|
return aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY &&
|
|
aNode.parent &&
|
|
asQuery(aNode.parent).queryOptions.resultType ==
|
|
Ci.nsINavHistoryQueryOptions.RESULTS_AS_SITE_QUERY;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a day container.
|
|
* @param node
|
|
* A NavHistoryResultNode
|
|
* @returns true if the node is a day container, false otherwise
|
|
*/
|
|
nodeIsDay: function PU_nodeIsDay(aNode) {
|
|
var resultType;
|
|
return aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY &&
|
|
aNode.parent &&
|
|
((resultType = asQuery(aNode.parent).queryOptions.resultType) ==
|
|
Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_QUERY ||
|
|
resultType == Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_SITE_QUERY);
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a result-node is a tag container.
|
|
* @param aNode
|
|
* A result-node
|
|
* @returns true if the node is a tag container, false otherwise
|
|
*/
|
|
nodeIsTagQuery: function PU_nodeIsTagQuery(aNode) {
|
|
return aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY &&
|
|
asQuery(aNode).queryOptions.resultType ==
|
|
Ci.nsINavHistoryQueryOptions.RESULTS_AS_TAG_CONTENTS;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is a container.
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a container item, false otherwise
|
|
*/
|
|
containerTypes: [Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER,
|
|
Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER_SHORTCUT,
|
|
Ci.nsINavHistoryResultNode.RESULT_TYPE_QUERY,
|
|
Ci.nsINavHistoryResultNode.RESULT_TYPE_DYNAMIC_CONTAINER],
|
|
nodeIsContainer: function PU_nodeIsContainer(aNode) {
|
|
return this.containerTypes.indexOf(aNode.type) != -1;
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a ResultNode is an history related container.
|
|
* @param node
|
|
* A result node
|
|
* @returns true if the node is an history related container, false otherwise
|
|
*/
|
|
nodeIsHistoryContainer: function PU_nodeIsHistoryContainer(aNode) {
|
|
var resultType;
|
|
return this.nodeIsQuery(aNode) &&
|
|
((resultType = asQuery(aNode).queryOptions.resultType) ==
|
|
Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_SITE_QUERY ||
|
|
resultType == Ci.nsINavHistoryQueryOptions.RESULTS_AS_DATE_QUERY ||
|
|
resultType == Ci.nsINavHistoryQueryOptions.RESULTS_AS_SITE_QUERY ||
|
|
this.nodeIsDay(aNode) ||
|
|
this.nodeIsHost(aNode));
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a result-node is a dynamic-container item.
|
|
* The dynamic container result node type is for dynamically created
|
|
* containers (e.g. for the file browser service where you get your folders
|
|
* in bookmark menus).
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a dynamic container item, false otherwise
|
|
*/
|
|
nodeIsDynamicContainer: function PU_nodeIsDynamicContainer(aNode) {
|
|
if (aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_DYNAMIC_CONTAINER)
|
|
return true;
|
|
return false;
|
|
},
|
|
|
|
/**
|
|
* Determines if a container item id is a livemark.
|
|
* @param aItemId
|
|
* The id of the potential livemark.
|
|
* @returns true if the item is a livemark.
|
|
*/
|
|
itemIsLivemark: function PU_itemIsLivemark(aItemId) {
|
|
// If the Livemark service hasn't yet been initialized then
|
|
// use the annotations service directly to avoid instanciating
|
|
// it on startup. (bug 398300)
|
|
if (Object.getOwnPropertyDescriptor(this, "livemarks").value === undefined)
|
|
return this.annotations.itemHasAnnotation(aItemId, this.LMANNO_FEEDURI);
|
|
// If the livemark service has already been instanciated, use it.
|
|
return this.livemarks.isLivemark(aItemId);
|
|
},
|
|
|
|
/**
|
|
* Determines whether a result node is a livemark container.
|
|
* @param aNode
|
|
* A result Node
|
|
* @returns true if the node is a livemark container item
|
|
*/
|
|
nodeIsLivemarkContainer: function PU_nodeIsLivemarkContainer(aNode) {
|
|
return this.nodeIsFolder(aNode) && this.itemIsLivemark(aNode.itemId);
|
|
},
|
|
|
|
/**
|
|
* Determines whether a result node is a live-bookmark item
|
|
* @param aNode
|
|
* A result node
|
|
* @returns true if the node is a livemark container item
|
|
*/
|
|
nodeIsLivemarkItem: function PU_nodeIsLivemarkItem(aNode) {
|
|
return aNode.parent && this.nodeIsLivemarkContainer(aNode.parent);
|
|
},
|
|
|
|
/**
|
|
* Determines whether or not a node is a readonly folder.
|
|
* @param aNode
|
|
* The node to test.
|
|
* @returns true if the node is a readonly folder.
|
|
*/
|
|
isReadonlyFolder: function(aNode) {
|
|
return this.nodeIsFolder(aNode) &&
|
|
this.bookmarks.getFolderReadonly(asQuery(aNode).folderItemId);
|
|
},
|
|
|
|
/**
|
|
* Gets the concrete item-id for the given node. Generally, this is just
|
|
* node.itemId, but for folder-shortcuts that's node.folderItemId.
|
|
*/
|
|
getConcreteItemId: function PU_getConcreteItemId(aNode) {
|
|
if (aNode.type == Ci.nsINavHistoryResultNode.RESULT_TYPE_FOLDER_SHORTCUT)
|
|
return asQuery(aNode).folderItemId;
|
|
else if (PlacesUtils.nodeIsTagQuery(aNode)) {
|
|
// RESULTS_AS_TAG_CONTENTS queries are similar to folder shortcuts
|
|
// so we can still get the concrete itemId for them.
|
|
var queries = aNode.getQueries();
|
|
var folders = queries[0].getFolders();
|
|
return folders[0];
|
|
}
|
|
return aNode.itemId;
|
|
},
|
|
|
|
/**
|
|
* String-wraps a result node according to the rules of the specified
|
|
* content type.
|
|
* @param aNode
|
|
* The Result node to wrap (serialize)
|
|
* @param aType
|
|
* The content type to serialize as
|
|
* @param [optional] aOverrideURI
|
|
* Used instead of the node's URI if provided.
|
|
* This is useful for wrapping a container as TYPE_X_MOZ_URL,
|
|
* TYPE_HTML or TYPE_UNICODE.
|
|
* @param aForceCopy
|
|
* Does a full copy, resolving folder shortcuts.
|
|
* @returns A string serialization of the node
|
|
*/
|
|
wrapNode: function PU_wrapNode(aNode, aType, aOverrideURI, aForceCopy) {
|
|
// when wrapping a node, we want all the items, even if the original
|
|
// query options are excluding them.
|
|
// this can happen when copying from the left hand pane of the bookmarks
|
|
// organizer
|
|
// @return [node, shouldClose]
|
|
function convertNode(cNode) {
|
|
if (PlacesUtils.nodeIsFolder(cNode) &&
|
|
asQuery(cNode).queryOptions.excludeItems) {
|
|
let concreteId = PlacesUtils.getConcreteItemId(cNode);
|
|
return [PlacesUtils.getFolderContents(concreteId, false, true).root, true];
|
|
}
|
|
|
|
// If we didn't create our own query, do not alter the node's open state.
|
|
return [cNode, false];
|
|
}
|
|
|
|
switch (aType) {
|
|
case this.TYPE_X_MOZ_PLACE:
|
|
case this.TYPE_X_MOZ_PLACE_SEPARATOR:
|
|
case this.TYPE_X_MOZ_PLACE_CONTAINER: {
|
|
let writer = {
|
|
value: "",
|
|
write: function PU_wrapNode__write(aStr, aLen) {
|
|
this.value += aStr;
|
|
}
|
|
};
|
|
|
|
let [node, shouldClose] = convertNode(aNode);
|
|
this.serializeNodeAsJSONToOutputStream(node, writer, true, aForceCopy);
|
|
if (shouldClose)
|
|
node.containerOpen = false;
|
|
|
|
return writer.value;
|
|
}
|
|
case this.TYPE_X_MOZ_URL: {
|
|
function gatherDataUrl(bNode) {
|
|
if (PlacesUtils.nodeIsLivemarkContainer(bNode)) {
|
|
let uri = PlacesUtils.livemarks.getSiteURI(bNode.itemId) ||
|
|
PlacesUtils.livemarks.getFeedURI(bNode.itemId);
|
|
return uri.spec + NEWLINE + bNode.title;
|
|
}
|
|
if (PlacesUtils.nodeIsURI(bNode))
|
|
return (aOverrideURI || bNode.uri) + NEWLINE + bNode.title;
|
|
// ignore containers and separators - items without valid URIs
|
|
return "";
|
|
}
|
|
|
|
let [node, shouldClose] = convertNode(aNode);
|
|
let dataUrl = gatherDataUrl(node);
|
|
if (shouldClose)
|
|
node.containerOpen = false;
|
|
|
|
return dataUrl;
|
|
}
|
|
case this.TYPE_HTML: {
|
|
function gatherDataHtml(bNode) {
|
|
function htmlEscape(s) {
|
|
s = s.replace(/&/g, "&");
|
|
s = s.replace(/>/g, ">");
|
|
s = s.replace(/</g, "<");
|
|
s = s.replace(/"/g, """);
|
|
s = s.replace(/'/g, "'");
|
|
return s;
|
|
}
|
|
// escape out potential HTML in the title
|
|
let escapedTitle = bNode.title ? htmlEscape(bNode.title) : "";
|
|
if (PlacesUtils.nodeIsLivemarkContainer(bNode)) {
|
|
let uri = PlacesUtils.livemarks.getSiteURI(bNode.itemId) ||
|
|
PlacesUtils.livemarks.getFeedURI(bNode.itemId);
|
|
return "<A HREF=\"" + uri.spec + "\">" + escapedTitle + "</A>" + NEWLINE;
|
|
}
|
|
if (PlacesUtils.nodeIsContainer(bNode)) {
|
|
asContainer(bNode);
|
|
let wasOpen = bNode.containerOpen;
|
|
if (!wasOpen)
|
|
bNode.containerOpen = true;
|
|
|
|
let childString = "<DL><DT>" + escapedTitle + "</DT>" + NEWLINE;
|
|
let cc = bNode.childCount;
|
|
for (let i = 0; i < cc; ++i)
|
|
childString += "<DD>"
|
|
+ NEWLINE
|
|
+ gatherDataHtml(bNode.getChild(i))
|
|
+ "</DD>"
|
|
+ NEWLINE;
|
|
bNode.containerOpen = wasOpen;
|
|
return childString + "</DL>" + NEWLINE;
|
|
}
|
|
if (PlacesUtils.nodeIsURI(bNode))
|
|
return "<A HREF=\"" + bNode.uri + "\">" + escapedTitle + "</A>" + NEWLINE;
|
|
if (PlacesUtils.nodeIsSeparator(bNode))
|
|
return "<HR>" + NEWLINE;
|
|
return "";
|
|
}
|
|
|
|
let [node, shouldClose] = convertNode(aNode);
|
|
let dataHtml = gatherDataHtml(node);
|
|
if (shouldClose)
|
|
node.containerOpen = false;
|
|
|
|
return dataHtml;
|
|
}
|
|
}
|
|
|
|
// Otherwise, we wrap as TYPE_UNICODE.
|
|
function gatherDataText(bNode) {
|
|
if (PlacesUtils.nodeIsLivemarkContainer(bNode))
|
|
return PlacesUtils.livemarks.getSiteURI(bNode.itemId) ||
|
|
PlacesUtils.livemarks.getFeedURI(bNode.itemId);
|
|
if (PlacesUtils.nodeIsContainer(bNode)) {
|
|
asContainer(bNode);
|
|
let wasOpen = bNode.containerOpen;
|
|
if (!wasOpen)
|
|
bNode.containerOpen = true;
|
|
|
|
let childString = bNode.title + NEWLINE;
|
|
let cc = bNode.childCount;
|
|
for (let i = 0; i < cc; ++i) {
|
|
let child = bNode.getChild(i);
|
|
let suffix = i < (cc - 1) ? NEWLINE : "";
|
|
childString += gatherDataText(child) + suffix;
|
|
}
|
|
bNode.containerOpen = wasOpen;
|
|
return childString;
|
|
}
|
|
if (PlacesUtils.nodeIsURI(bNode))
|
|
return (aOverrideURI || bNode.uri);
|
|
if (PlacesUtils.nodeIsSeparator(bNode))
|
|
return "--------------------";
|
|
return "";
|
|
}
|
|
|
|
let [node, shouldClose] = convertNode(aNode);
|
|
let dataText = gatherDataText(node);
|
|
// Convert node could pass an open container node.
|
|
if (shouldClose)
|
|
node.containerOpen = false;
|
|
|
|
return dataText;
|
|
},
|
|
|
|
/**
|
|
* Unwraps data from the Clipboard or the current Drag Session.
|
|
* @param blob
|
|
* A blob (string) of data, in some format we potentially know how
|
|
* to parse.
|
|
* @param type
|
|
* The content type of the blob.
|
|
* @returns An array of objects representing each item contained by the source.
|
|
*/
|
|
unwrapNodes: function PU_unwrapNodes(blob, type) {
|
|
// We split on "\n" because the transferable system converts "\r\n" to "\n"
|
|
var nodes = [];
|
|
switch(type) {
|
|
case this.TYPE_X_MOZ_PLACE:
|
|
case this.TYPE_X_MOZ_PLACE_SEPARATOR:
|
|
case this.TYPE_X_MOZ_PLACE_CONTAINER:
|
|
var json = Cc["@mozilla.org/dom/json;1"].createInstance(Ci.nsIJSON);
|
|
// Old profiles (pre-Firefox 4) may contain bookmarks.json files with
|
|
// trailing commas, which we once accepted but no longer do -- except
|
|
// when decoded using the legacy decoder. This can be reverted to
|
|
// json.decode (better yet, to the ECMA-standard JSON.parse) when we no
|
|
// longer support upgrades from pre-Firefox 4 profiles.
|
|
nodes = json.legacyDecode("[" + blob + "]");
|
|
break;
|
|
case this.TYPE_X_MOZ_URL:
|
|
var parts = blob.split("\n");
|
|
// data in this type has 2 parts per entry, so if there are fewer
|
|
// than 2 parts left, the blob is malformed and we should stop
|
|
// but drag and drop of files from the shell has parts.length = 1
|
|
if (parts.length != 1 && parts.length % 2)
|
|
break;
|
|
for (var i = 0; i < parts.length; i=i+2) {
|
|
var uriString = parts[i];
|
|
var titleString = "";
|
|
if (parts.length > i+1)
|
|
titleString = parts[i+1];
|
|
else {
|
|
// for drag and drop of files, try to use the leafName as title
|
|
try {
|
|
titleString = this._uri(uriString).QueryInterface(Ci.nsIURL)
|
|
.fileName;
|
|
}
|
|
catch (e) {}
|
|
}
|
|
// note: this._uri() will throw if uriString is not a valid URI
|
|
if (this._uri(uriString)) {
|
|
nodes.push({ uri: uriString,
|
|
title: titleString ? titleString : uriString ,
|
|
type: this.TYPE_X_MOZ_URL });
|
|
}
|
|
}
|
|
break;
|
|
case this.TYPE_UNICODE:
|
|
var parts = blob.split("\n");
|
|
for (var i = 0; i < parts.length; i++) {
|
|
var uriString = parts[i];
|
|
// text/uri-list is converted to TYPE_UNICODE but it could contain
|
|
// comments line prepended by #, we should skip them
|
|
if (uriString.substr(0, 1) == '\x23')
|
|
continue;
|
|
// note: this._uri() will throw if uriString is not a valid URI
|
|
if (uriString != "" && this._uri(uriString))
|
|
nodes.push({ uri: uriString,
|
|
title: uriString,
|
|
type: this.TYPE_X_MOZ_URL });
|
|
}
|
|
break;
|
|
default:
|
|
throw Cr.NS_ERROR_INVALID_ARG;
|
|
}
|
|
return nodes;
|
|
},
|
|
|
|
/**
|
|
* Generates a nsINavHistoryResult for the contents of a folder.
|
|
* @param folderId
|
|
* The folder to open
|
|
* @param [optional] excludeItems
|
|
* True to hide all items (individual bookmarks). This is used on
|
|
* the left places pane so you just get a folder hierarchy.
|
|
* @param [optional] expandQueries
|
|
* True to make query items expand as new containers. For managing,
|
|
* you want this to be false, for menus and such, you want this to
|
|
* be true.
|
|
* @returns A nsINavHistoryResult containing the contents of the
|
|
* folder. The result.root is guaranteed to be open.
|
|
*/
|
|
getFolderContents:
|
|
function PU_getFolderContents(aFolderId, aExcludeItems, aExpandQueries) {
|
|
var query = this.history.getNewQuery();
|
|
query.setFolders([aFolderId], 1);
|
|
var options = this.history.getNewQueryOptions();
|
|
options.excludeItems = aExcludeItems;
|
|
options.expandQueries = aExpandQueries;
|
|
|
|
var result = this.history.executeQuery(query, options);
|
|
result.root.containerOpen = true;
|
|
return result;
|
|
},
|
|
|
|
/**
|
|
* Fetch all annotations for a URI, including all properties of each
|
|
* annotation which would be required to recreate it.
|
|
* @param aURI
|
|
* The URI for which annotations are to be retrieved.
|
|
* @return Array of objects, each containing the following properties:
|
|
* name, flags, expires, mimeType, type, value
|
|
*/
|
|
getAnnotationsForURI: function PU_getAnnotationsForURI(aURI) {
|
|
var annosvc = this.annotations;
|
|
var annos = [], val = null;
|
|
var annoNames = annosvc.getPageAnnotationNames(aURI);
|
|
for (var i = 0; i < annoNames.length; i++) {
|
|
var flags = {}, exp = {}, mimeType = {}, storageType = {};
|
|
annosvc.getPageAnnotationInfo(aURI, annoNames[i], flags, exp, mimeType, storageType);
|
|
if (storageType.value == annosvc.TYPE_BINARY) {
|
|
var data = {}, length = {}, mimeType = {};
|
|
annosvc.getPageAnnotationBinary(aURI, annoNames[i], data, length, mimeType);
|
|
val = data.value;
|
|
}
|
|
else
|
|
val = annosvc.getPageAnnotation(aURI, annoNames[i]);
|
|
|
|
annos.push({name: annoNames[i],
|
|
flags: flags.value,
|
|
expires: exp.value,
|
|
mimeType: mimeType.value,
|
|
type: storageType.value,
|
|
value: val});
|
|
}
|
|
return annos;
|
|
},
|
|
|
|
/**
|
|
* Fetch all annotations for an item, including all properties of each
|
|
* annotation which would be required to recreate it.
|
|
* @param aItemId
|
|
* The identifier of the itme for which annotations are to be
|
|
* retrieved.
|
|
* @return Array of objects, each containing the following properties:
|
|
* name, flags, expires, mimeType, type, value
|
|
*/
|
|
getAnnotationsForItem: function PU_getAnnotationsForItem(aItemId) {
|
|
var annosvc = this.annotations;
|
|
var annos = [], val = null;
|
|
var annoNames = annosvc.getItemAnnotationNames(aItemId);
|
|
for (var i = 0; i < annoNames.length; i++) {
|
|
var flags = {}, exp = {}, mimeType = {}, storageType = {};
|
|
annosvc.getItemAnnotationInfo(aItemId, annoNames[i], flags, exp, mimeType, storageType);
|
|
if (storageType.value == annosvc.TYPE_BINARY) {
|
|
var data = {}, length = {}, mimeType = {};
|
|
annosvc.geItemAnnotationBinary(aItemId, annoNames[i], data, length, mimeType);
|
|
val = data.value;
|
|
}
|
|
else
|
|
val = annosvc.getItemAnnotation(aItemId, annoNames[i]);
|
|
|
|
annos.push({name: annoNames[i],
|
|
flags: flags.value,
|
|
expires: exp.value,
|
|
mimeType: mimeType.value,
|
|
type: storageType.value,
|
|
value: val});
|
|
}
|
|
return annos;
|
|
},
|
|
|
|
/**
|
|
* Annotate a URI with a batch of annotations.
|
|
* @param aURI
|
|
* The URI for which annotations are to be set.
|
|
* @param aAnnotations
|
|
* Array of objects, each containing the following properties:
|
|
* name, flags, expires, type, mimeType (only used for binary
|
|
* annotations) value.
|
|
* If the value for an annotation is not set it will be removed.
|
|
*/
|
|
setAnnotationsForURI: function PU_setAnnotationsForURI(aURI, aAnnos) {
|
|
var annosvc = this.annotations;
|
|
aAnnos.forEach(function(anno) {
|
|
if (!anno.value) {
|
|
annosvc.removePageAnnotation(aURI, anno.name);
|
|
return;
|
|
}
|
|
var flags = ("flags" in anno) ? anno.flags : 0;
|
|
var expires = ("expires" in anno) ?
|
|
anno.expires : Ci.nsIAnnotationService.EXPIRE_NEVER;
|
|
if (anno.type == annosvc.TYPE_BINARY) {
|
|
annosvc.setPageAnnotationBinary(aURI, anno.name, anno.value,
|
|
anno.value.length, anno.mimeType,
|
|
flags, expires);
|
|
}
|
|
else
|
|
annosvc.setPageAnnotation(aURI, anno.name, anno.value, flags, expires);
|
|
});
|
|
},
|
|
|
|
/**
|
|
* Annotate an item with a batch of annotations.
|
|
* @param aItemId
|
|
* The identifier of the item for which annotations are to be set
|
|
* @param aAnnotations
|
|
* Array of objects, each containing the following properties:
|
|
* name, flags, expires, type, mimeType (only used for binary
|
|
* annotations) value.
|
|
* If the value for an annotation is not set it will be removed.
|
|
*/
|
|
setAnnotationsForItem: function PU_setAnnotationsForItem(aItemId, aAnnos) {
|
|
var annosvc = this.annotations;
|
|
|
|
aAnnos.forEach(function(anno) {
|
|
if (!anno.value) {
|
|
annosvc.removeItemAnnotation(aItemId, anno.name);
|
|
return;
|
|
}
|
|
var flags = ("flags" in anno) ? anno.flags : 0;
|
|
var expires = ("expires" in anno) ?
|
|
anno.expires : Ci.nsIAnnotationService.EXPIRE_NEVER;
|
|
if (anno.type == annosvc.TYPE_BINARY) {
|
|
annosvc.setItemAnnotationBinary(aItemId, anno.name, anno.value,
|
|
anno.value.length, anno.mimeType,
|
|
flags, expires);
|
|
}
|
|
else {
|
|
annosvc.setItemAnnotation(aItemId, anno.name, anno.value, flags,
|
|
expires);
|
|
}
|
|
});
|
|
},
|
|
|
|
// Identifier getters for special folders.
|
|
// You should use these everywhere PlacesUtils is available to avoid XPCOM
|
|
// traversal just to get roots' ids.
|
|
get placesRootId() {
|
|
delete this.placesRootId;
|
|
return this.placesRootId = this.bookmarks.placesRoot;
|
|
},
|
|
|
|
get bookmarksMenuFolderId() {
|
|
delete this.bookmarksMenuFolderId;
|
|
return this.bookmarksMenuFolderId = this.bookmarks.bookmarksMenuFolder;
|
|
},
|
|
|
|
get toolbarFolderId() {
|
|
delete this.toolbarFolderId;
|
|
return this.toolbarFolderId = this.bookmarks.toolbarFolder;
|
|
},
|
|
|
|
get tagsFolderId() {
|
|
delete this.tagsFolderId;
|
|
return this.tagsFolderId = this.bookmarks.tagsFolder;
|
|
},
|
|
|
|
get unfiledBookmarksFolderId() {
|
|
delete this.unfiledBookmarksFolderId;
|
|
return this.unfiledBookmarksFolderId = this.bookmarks.unfiledBookmarksFolder;
|
|
},
|
|
|
|
/**
|
|
* Checks if aItemId is a root.
|
|
*
|
|
* @param aItemId
|
|
* item id to look for.
|
|
* @returns true if aItemId is a root, false otherwise.
|
|
*/
|
|
isRootItem: function PU_isRootItem(aItemId) {
|
|
return aItemId == PlacesUtils.bookmarksMenuFolderId ||
|
|
aItemId == PlacesUtils.toolbarFolderId ||
|
|
aItemId == PlacesUtils.unfiledBookmarksFolderId ||
|
|
aItemId == PlacesUtils.tagsFolderId ||
|
|
aItemId == PlacesUtils.placesRootId;
|
|
},
|
|
|
|
/**
|
|
* Set the POST data associated with a bookmark, if any.
|
|
* Used by POST keywords.
|
|
* @param aBookmarkId
|
|
* @returns string of POST data
|
|
*/
|
|
setPostDataForBookmark: function PU_setPostDataForBookmark(aBookmarkId, aPostData) {
|
|
const annos = this.annotations;
|
|
if (aPostData)
|
|
annos.setItemAnnotation(aBookmarkId, this.POST_DATA_ANNO, aPostData,
|
|
0, Ci.nsIAnnotationService.EXPIRE_NEVER);
|
|
else if (annos.itemHasAnnotation(aBookmarkId, this.POST_DATA_ANNO))
|
|
annos.removeItemAnnotation(aBookmarkId, this.POST_DATA_ANNO);
|
|
},
|
|
|
|
/**
|
|
* Get the POST data associated with a bookmark, if any.
|
|
* @param aBookmarkId
|
|
* @returns string of POST data if set for aBookmarkId. null otherwise.
|
|
*/
|
|
getPostDataForBookmark: function PU_getPostDataForBookmark(aBookmarkId) {
|
|
const annos = this.annotations;
|
|
if (annos.itemHasAnnotation(aBookmarkId, this.POST_DATA_ANNO))
|
|
return annos.getItemAnnotation(aBookmarkId, this.POST_DATA_ANNO);
|
|
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* Get the URI (and any associated POST data) for a given keyword.
|
|
* @param aKeyword string keyword
|
|
* @returns an array containing a string URL and a string of POST data
|
|
*/
|
|
getURLAndPostDataForKeyword: function PU_getURLAndPostDataForKeyword(aKeyword) {
|
|
var url = null, postdata = null;
|
|
try {
|
|
var uri = this.bookmarks.getURIForKeyword(aKeyword);
|
|
if (uri) {
|
|
url = uri.spec;
|
|
var bookmarks = this.bookmarks.getBookmarkIdsForURI(uri);
|
|
for (let i = 0; i < bookmarks.length; i++) {
|
|
var bookmark = bookmarks[i];
|
|
var kw = this.bookmarks.getKeywordForBookmark(bookmark);
|
|
if (kw == aKeyword) {
|
|
postdata = this.getPostDataForBookmark(bookmark);
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
} catch(ex) {}
|
|
return [url, postdata];
|
|
},
|
|
|
|
/**
|
|
* Get all bookmarks for a URL, excluding items under tag or livemark
|
|
* containers.
|
|
*/
|
|
getBookmarksForURI:
|
|
function PU_getBookmarksForURI(aURI) {
|
|
var bmkIds = this.bookmarks.getBookmarkIdsForURI(aURI);
|
|
|
|
// filter the ids list
|
|
return bmkIds.filter(function(aID) {
|
|
var parentId = this.bookmarks.getFolderIdForItem(aID);
|
|
// Livemark child
|
|
if (this.itemIsLivemark(parentId))
|
|
return false;
|
|
var grandparentId = this.bookmarks.getFolderIdForItem(parentId);
|
|
// item under a tag container
|
|
if (grandparentId == this.tagsFolderId)
|
|
return false;
|
|
return true;
|
|
}, this);
|
|
},
|
|
|
|
/**
|
|
* Get the most recently added/modified bookmark for a URL, excluding items
|
|
* under tag or livemark containers.
|
|
*
|
|
* @param aURI
|
|
* nsIURI of the page we will look for.
|
|
* @returns itemId of the found bookmark, or -1 if nothing is found.
|
|
*/
|
|
getMostRecentBookmarkForURI:
|
|
function PU_getMostRecentBookmarkForURI(aURI) {
|
|
var bmkIds = this.bookmarks.getBookmarkIdsForURI(aURI);
|
|
for (var i = 0; i < bmkIds.length; i++) {
|
|
// Find the first folder which isn't a tag container
|
|
var itemId = bmkIds[i];
|
|
var parentId = this.bookmarks.getFolderIdForItem(itemId);
|
|
// Optimization: if this is a direct child of a root we don't need to
|
|
// check if its grandparent is a tag.
|
|
if (parentId == this.unfiledBookmarksFolderId ||
|
|
parentId == this.toolbarFolderId ||
|
|
parentId == this.bookmarksMenuFolderId)
|
|
return itemId;
|
|
|
|
var grandparentId = this.bookmarks.getFolderIdForItem(parentId);
|
|
if (grandparentId != this.tagsFolderId &&
|
|
!this.itemIsLivemark(parentId))
|
|
return itemId;
|
|
}
|
|
return -1;
|
|
},
|
|
|
|
/**
|
|
* Get the most recent folder item id for a feed URI.
|
|
*
|
|
* @param aURI
|
|
* nsIURI of the feed we will look for.
|
|
* @returns folder item id of the found livemark, or -1 if nothing is found.
|
|
*/
|
|
getMostRecentFolderForFeedURI:
|
|
function PU_getMostRecentFolderForFeedURI(aFeedURI) {
|
|
// If the Livemark service hasn't yet been initialized then
|
|
// use the annotations service directly to avoid instanciating
|
|
// it on startup. (bug 398300)
|
|
if (Object.getOwnPropertyDescriptor(this, "livemarks").value === undefined) {
|
|
var feedSpec = aFeedURI.spec
|
|
var annosvc = this.annotations;
|
|
var livemarks = annosvc.getItemsWithAnnotation(this.LMANNO_FEEDURI);
|
|
for (var i = 0; i < livemarks.length; i++) {
|
|
if (annosvc.getItemAnnotation(livemarks[i], this.LMANNO_FEEDURI) == feedSpec)
|
|
return livemarks[i];
|
|
}
|
|
}
|
|
else {
|
|
// If the livemark service has already been instanciated, use it.
|
|
return this.livemarks.getLivemarkIdForFeedURI(aFeedURI);
|
|
}
|
|
|
|
return -1;
|
|
},
|
|
|
|
/**
|
|
* Returns a nsNavHistoryContainerResultNode with forced excludeItems and
|
|
* expandQueries.
|
|
* @param aNode
|
|
* The node to convert
|
|
* @param [optional] excludeItems
|
|
* True to hide all items (individual bookmarks). This is used on
|
|
* the left places pane so you just get a folder hierarchy.
|
|
* @param [optional] expandQueries
|
|
* True to make query items expand as new containers. For managing,
|
|
* you want this to be false, for menus and such, you want this to
|
|
* be true.
|
|
* @returns A nsINavHistoryContainerResultNode containing the unfiltered
|
|
* contents of the container.
|
|
* @note The returned container node could be open or closed, we don't
|
|
* guarantee its status.
|
|
*/
|
|
getContainerNodeWithOptions:
|
|
function PU_getContainerNodeWithOptions(aNode, aExcludeItems, aExpandQueries) {
|
|
if (!this.nodeIsContainer(aNode))
|
|
throw Cr.NS_ERROR_INVALID_ARG;
|
|
|
|
// excludeItems is inherited by child containers in an excludeItems view.
|
|
var excludeItems = asQuery(aNode).queryOptions.excludeItems ||
|
|
asQuery(aNode.parentResult.root).queryOptions.excludeItems;
|
|
// expandQueries is inherited by child containers in an expandQueries view.
|
|
var expandQueries = asQuery(aNode).queryOptions.expandQueries &&
|
|
asQuery(aNode.parentResult.root).queryOptions.expandQueries;
|
|
|
|
// If our options are exactly what we expect, directly return the node.
|
|
if (excludeItems == aExcludeItems && expandQueries == aExpandQueries)
|
|
return aNode;
|
|
|
|
// Otherwise, get contents manually.
|
|
var queries = {}, options = {};
|
|
this.history.queryStringToQueries(aNode.uri, queries, {}, options);
|
|
options.value.excludeItems = aExcludeItems;
|
|
options.value.expandQueries = aExpandQueries;
|
|
return this.history.executeQueries(queries.value,
|
|
queries.value.length,
|
|
options.value).root;
|
|
},
|
|
|
|
/**
|
|
* Returns true if a container has uri nodes in its first level.
|
|
* Has better performance than (getURLsForContainerNode(node).length > 0).
|
|
* @param aNode
|
|
* The container node to search through.
|
|
* @returns true if the node contains uri nodes, false otherwise.
|
|
*/
|
|
hasChildURIs: function PU_hasChildURIs(aNode) {
|
|
if (!this.nodeIsContainer(aNode))
|
|
return false;
|
|
|
|
let root = this.getContainerNodeWithOptions(aNode, false, true);
|
|
let result = root.parentResult;
|
|
let didSuppressNotifications = false;
|
|
let wasOpen = root.containerOpen;
|
|
if (!wasOpen) {
|
|
didSuppressNotifications = result.suppressNotifications;
|
|
if (!didSuppressNotifications)
|
|
result.suppressNotifications = true;
|
|
|
|
root.containerOpen = true;
|
|
}
|
|
|
|
let found = false;
|
|
for (let i = 0; i < root.childCount && !found; i++) {
|
|
let child = root.getChild(i);
|
|
if (this.nodeIsURI(child))
|
|
found = true;
|
|
}
|
|
|
|
if (!wasOpen) {
|
|
root.containerOpen = false;
|
|
if (!didSuppressNotifications)
|
|
result.suppressNotifications = false;
|
|
}
|
|
return found;
|
|
},
|
|
|
|
/**
|
|
* Returns an array containing all the uris in the first level of the
|
|
* passed in container.
|
|
* If you only need to know if the node contains uris, use hasChildURIs.
|
|
* @param aNode
|
|
* The container node to search through
|
|
* @returns array of uris in the first level of the container.
|
|
*/
|
|
getURLsForContainerNode: function PU_getURLsForContainerNode(aNode) {
|
|
let urls = [];
|
|
if (!this.nodeIsContainer(aNode))
|
|
return urls;
|
|
|
|
let root = this.getContainerNodeWithOptions(aNode, false, true);
|
|
let result = root.parentResult;
|
|
let wasOpen = root.containerOpen;
|
|
let didSuppressNotifications = false;
|
|
if (!wasOpen) {
|
|
didSuppressNotifications = result.suppressNotifications;
|
|
if (!didSuppressNotifications)
|
|
result.suppressNotifications = true;
|
|
|
|
root.containerOpen = true;
|
|
}
|
|
|
|
for (let i = 0; i < root.childCount; ++i) {
|
|
let child = root.getChild(i);
|
|
if (this.nodeIsURI(child))
|
|
urls.push({uri: child.uri, isBookmark: this.nodeIsBookmark(child)});
|
|
}
|
|
|
|
if (!wasOpen) {
|
|
root.containerOpen = false;
|
|
if (!didSuppressNotifications)
|
|
result.suppressNotifications = false;
|
|
}
|
|
return urls;
|
|
},
|
|
|
|
/**
|
|
* Import bookmarks from a JSON string.
|
|
* Note: any item annotated with "places/excludeFromBackup" won't be removed
|
|
* before executing the restore.
|
|
*
|
|
* @param aString
|
|
* JSON string of serialized bookmark data.
|
|
* @param aReplace
|
|
* Boolean if true, replace existing bookmarks, else merge.
|
|
*/
|
|
restoreBookmarksFromJSONString:
|
|
function PU_restoreBookmarksFromJSONString(aString, aReplace) {
|
|
// convert string to JSON
|
|
var nodes = this.unwrapNodes(aString, this.TYPE_X_MOZ_PLACE_CONTAINER);
|
|
|
|
if (nodes.length == 0 || !nodes[0].children ||
|
|
nodes[0].children.length == 0)
|
|
return; // nothing to restore
|
|
|
|
// ensure tag folder gets processed last
|
|
nodes[0].children.sort(function sortRoots(aNode, bNode) {
|
|
return (aNode.root && aNode.root == "tagsFolder") ? 1 :
|
|
(bNode.root && bNode.root == "tagsFolder") ? -1 : 0;
|
|
});
|
|
|
|
var batch = {
|
|
nodes: nodes[0].children,
|
|
runBatched: function restore_runBatched() {
|
|
if (aReplace) {
|
|
// Get roots excluded from the backup, we will not remove them
|
|
// before restoring.
|
|
var excludeItems = PlacesUtils.annotations.getItemsWithAnnotation(
|
|
PlacesUtils.EXCLUDE_FROM_BACKUP_ANNO
|
|
);
|
|
// delete existing children of the root node, excepting:
|
|
// 1. special folders: delete the child nodes
|
|
// 2. tags folder: untag via the tagging api
|
|
var query = PlacesUtils.history.getNewQuery();
|
|
query.setFolders([PlacesUtils.placesRootId], 1);
|
|
var options = PlacesUtils.history.getNewQueryOptions();
|
|
options.expandQueries = false;
|
|
var root = PlacesUtils.history.executeQuery(query, options).root;
|
|
root.containerOpen = true;
|
|
var childIds = [];
|
|
for (var i = 0; i < root.childCount; i++) {
|
|
var childId = root.getChild(i).itemId;
|
|
if (excludeItems.indexOf(childId) == -1 &&
|
|
childId != PlacesUtils.tagsFolderId)
|
|
childIds.push(childId);
|
|
}
|
|
root.containerOpen = false;
|
|
|
|
for (var i = 0; i < childIds.length; i++) {
|
|
var rootItemId = childIds[i];
|
|
if (PlacesUtils.isRootItem(rootItemId))
|
|
PlacesUtils.bookmarks.removeFolderChildren(rootItemId);
|
|
else
|
|
PlacesUtils.bookmarks.removeItem(rootItemId);
|
|
}
|
|
}
|
|
|
|
var searchIds = [];
|
|
var folderIdMap = [];
|
|
|
|
this.nodes.forEach(function(node) {
|
|
if (!node.children || node.children.length == 0)
|
|
return; // nothing to restore for this root
|
|
|
|
if (node.root) {
|
|
var container = this.placesRootId; // default to places root
|
|
switch (node.root) {
|
|
case "bookmarksMenuFolder":
|
|
container = this.bookmarksMenuFolderId;
|
|
break;
|
|
case "tagsFolder":
|
|
container = this.tagsFolderId;
|
|
break;
|
|
case "unfiledBookmarksFolder":
|
|
container = this.unfiledBookmarksFolderId;
|
|
break;
|
|
case "toolbarFolder":
|
|
container = this.toolbarFolderId;
|
|
break;
|
|
}
|
|
|
|
// insert the data into the db
|
|
node.children.forEach(function(child) {
|
|
var index = child.index;
|
|
var [folders, searches] = this.importJSONNode(child, container, index);
|
|
for (var i = 0; i < folders.length; i++) {
|
|
if (folders[i])
|
|
folderIdMap[i] = folders[i];
|
|
}
|
|
searchIds = searchIds.concat(searches);
|
|
}, this);
|
|
}
|
|
else
|
|
this.importJSONNode(node, this.placesRootId, node.index);
|
|
|
|
}, PlacesUtils);
|
|
|
|
// fixup imported place: uris that contain folders
|
|
searchIds.forEach(function(aId) {
|
|
var oldURI = this.bookmarks.getBookmarkURI(aId);
|
|
var uri = this._fixupQuery(this.bookmarks.getBookmarkURI(aId),
|
|
folderIdMap);
|
|
if (!uri.equals(oldURI))
|
|
this.bookmarks.changeBookmarkURI(aId, uri);
|
|
}, PlacesUtils);
|
|
}
|
|
};
|
|
|
|
this.bookmarks.runInBatchMode(batch, null);
|
|
},
|
|
|
|
/**
|
|
* Takes a JSON-serialized node and inserts it into the db.
|
|
*
|
|
* @param aData
|
|
* The unwrapped data blob of dropped or pasted data.
|
|
* @param aContainer
|
|
* The container the data was dropped or pasted into
|
|
* @param aIndex
|
|
* The index within the container the item was dropped or pasted at
|
|
* @returns an array containing of maps of old folder ids to new folder ids,
|
|
* and an array of saved search ids that need to be fixed up.
|
|
* eg: [[[oldFolder1, newFolder1]], [search1]]
|
|
*/
|
|
importJSONNode: function PU_importJSONNode(aData, aContainer, aIndex) {
|
|
var folderIdMap = [];
|
|
var searchIds = [];
|
|
var id = -1;
|
|
switch (aData.type) {
|
|
case this.TYPE_X_MOZ_PLACE_CONTAINER:
|
|
if (aContainer == PlacesUtils.tagsFolderId) {
|
|
// node is a tag
|
|
if (aData.children) {
|
|
aData.children.forEach(function(aChild) {
|
|
try {
|
|
this.tagging.tagURI(this._uri(aChild.uri), [aData.title]);
|
|
} catch (ex) {
|
|
// invalid tag child, skip it
|
|
}
|
|
}, this);
|
|
return [folderIdMap, searchIds];
|
|
}
|
|
}
|
|
else if (aData.livemark && aData.annos) {
|
|
// node is a livemark
|
|
var feedURI = null;
|
|
var siteURI = null;
|
|
aData.annos = aData.annos.filter(function(aAnno) {
|
|
switch (aAnno.name) {
|
|
case this.LMANNO_FEEDURI:
|
|
feedURI = this._uri(aAnno.value);
|
|
return false;
|
|
case this.LMANNO_SITEURI:
|
|
siteURI = this._uri(aAnno.value);
|
|
return false;
|
|
case this.LMANNO_EXPIRATION:
|
|
case this.LMANNO_LOADING:
|
|
case this.LMANNO_LOADFAILED:
|
|
return false;
|
|
default:
|
|
return true;
|
|
}
|
|
}, this);
|
|
|
|
if (feedURI) {
|
|
id = this.livemarks.createLivemarkFolderOnly(aContainer,
|
|
aData.title,
|
|
siteURI, feedURI,
|
|
aIndex);
|
|
}
|
|
}
|
|
else {
|
|
id = this.bookmarks.createFolder(aContainer, aData.title, aIndex);
|
|
folderIdMap[aData.id] = id;
|
|
// process children
|
|
if (aData.children) {
|
|
aData.children.forEach(function(aChild, aIndex) {
|
|
var [folders, searches] = this.importJSONNode(aChild, id, aIndex);
|
|
for (var i = 0; i < folders.length; i++) {
|
|
if (folders[i])
|
|
folderIdMap[i] = folders[i];
|
|
}
|
|
searchIds = searchIds.concat(searches);
|
|
}, this);
|
|
}
|
|
}
|
|
break;
|
|
case this.TYPE_X_MOZ_PLACE:
|
|
id = this.bookmarks.insertBookmark(aContainer, this._uri(aData.uri),
|
|
aIndex, aData.title);
|
|
if (aData.keyword)
|
|
this.bookmarks.setKeywordForBookmark(id, aData.keyword);
|
|
if (aData.tags) {
|
|
var tags = aData.tags.split(", ");
|
|
if (tags.length)
|
|
this.tagging.tagURI(this._uri(aData.uri), tags);
|
|
}
|
|
if (aData.charset)
|
|
this.history.setCharsetForURI(this._uri(aData.uri), aData.charset);
|
|
if (aData.uri.substr(0, 6) == "place:")
|
|
searchIds.push(id);
|
|
if (aData.icon) {
|
|
try {
|
|
// Create a fake faviconURI to use (FIXME: bug 523932)
|
|
let faviconURI = this._uri("fake-favicon-uri:" + aData.uri);
|
|
this.favicons.setFaviconUrlForPage(this._uri(aData.uri), faviconURI);
|
|
this.favicons.setFaviconDataFromDataURL(faviconURI, aData.icon, 0);
|
|
} catch (ex) {
|
|
Components.utils.reportError("Failed to import favicon data:" + ex);
|
|
}
|
|
}
|
|
if (aData.iconUri) {
|
|
try {
|
|
this.favicons.setAndLoadFaviconForPage(this._uri(aData.uri),
|
|
this._uri(aData.iconUri),
|
|
false);
|
|
} catch (ex) {
|
|
Components.utils.reportError("Failed to import favicon URI:" + ex);
|
|
}
|
|
}
|
|
break;
|
|
case this.TYPE_X_MOZ_PLACE_SEPARATOR:
|
|
id = this.bookmarks.insertSeparator(aContainer, aIndex);
|
|
break;
|
|
default:
|
|
// Unknown node type
|
|
}
|
|
|
|
// set generic properties, valid for all nodes
|
|
if (id != -1) {
|
|
if (aData.dateAdded)
|
|
this.bookmarks.setItemDateAdded(id, aData.dateAdded);
|
|
if (aData.lastModified)
|
|
this.bookmarks.setItemLastModified(id, aData.lastModified);
|
|
if (aData.annos && aData.annos.length)
|
|
this.setAnnotationsForItem(id, aData.annos);
|
|
}
|
|
|
|
return [folderIdMap, searchIds];
|
|
},
|
|
|
|
/**
|
|
* Replaces imported folder ids with their local counterparts in a place: URI.
|
|
*
|
|
* @param aURI
|
|
* A place: URI with folder ids.
|
|
* @param aFolderIdMap
|
|
* An array mapping old folder id to new folder ids.
|
|
* @returns the fixed up URI if all matched. If some matched, it returns
|
|
* the URI with only the matching folders included. If none matched it
|
|
* returns the input URI unchanged.
|
|
*/
|
|
_fixupQuery: function PU__fixupQuery(aQueryURI, aFolderIdMap) {
|
|
function convert(str, p1, offset, s) {
|
|
return "folder=" + aFolderIdMap[p1];
|
|
}
|
|
var stringURI = aQueryURI.spec.replace(/folder=([0-9]+)/g, convert);
|
|
return this._uri(stringURI);
|
|
},
|
|
|
|
/**
|
|
* Serializes the given node (and all its descendents) as JSON
|
|
* and writes the serialization to the given output stream.
|
|
*
|
|
* @param aNode
|
|
* An nsINavHistoryResultNode
|
|
* @param aStream
|
|
* An nsIOutputStream. NOTE: it only uses the write(str, len)
|
|
* method of nsIOutputStream. The caller is responsible for
|
|
* closing the stream.
|
|
* @param aIsUICommand
|
|
* Boolean - If true, modifies serialization so that each node self-contained.
|
|
* For Example, tags are serialized inline with each bookmark.
|
|
* @param aResolveShortcuts
|
|
* Converts folder shortcuts into actual folders.
|
|
* @param aExcludeItems
|
|
* An array of item ids that should not be written to the backup.
|
|
*/
|
|
serializeNodeAsJSONToOutputStream:
|
|
function PU_serializeNodeAsJSONToOutputStream(aNode, aStream, aIsUICommand,
|
|
aResolveShortcuts,
|
|
aExcludeItems) {
|
|
function addGenericProperties(aPlacesNode, aJSNode) {
|
|
aJSNode.title = aPlacesNode.title;
|
|
aJSNode.id = aPlacesNode.itemId;
|
|
if (aJSNode.id != -1) {
|
|
var parent = aPlacesNode.parent;
|
|
if (parent)
|
|
aJSNode.parent = parent.itemId;
|
|
var dateAdded = aPlacesNode.dateAdded;
|
|
if (dateAdded)
|
|
aJSNode.dateAdded = dateAdded;
|
|
var lastModified = aPlacesNode.lastModified;
|
|
if (lastModified)
|
|
aJSNode.lastModified = lastModified;
|
|
|
|
// XXX need a hasAnnos api
|
|
var annos = [];
|
|
try {
|
|
annos = PlacesUtils.getAnnotationsForItem(aJSNode.id).filter(function(anno) {
|
|
// XXX should whitelist this instead, w/ a pref for
|
|
// backup/restore of non-whitelisted annos
|
|
// XXX causes JSON encoding errors, so utf-8 encode
|
|
//anno.value = unescape(encodeURIComponent(anno.value));
|
|
if (anno.name == PlacesUtils.LMANNO_FEEDURI)
|
|
aJSNode.livemark = 1;
|
|
if (anno.name == PlacesUtils.READ_ONLY_ANNO && aResolveShortcuts) {
|
|
// When copying a read-only node, remove the read-only annotation.
|
|
return false;
|
|
}
|
|
return true;
|
|
});
|
|
} catch(ex) {}
|
|
if (annos.length != 0)
|
|
aJSNode.annos = annos;
|
|
}
|
|
// XXXdietrich - store annos for non-bookmark items
|
|
}
|
|
|
|
function addURIProperties(aPlacesNode, aJSNode) {
|
|
aJSNode.type = PlacesUtils.TYPE_X_MOZ_PLACE;
|
|
aJSNode.uri = aPlacesNode.uri;
|
|
if (aJSNode.id && aJSNode.id != -1) {
|
|
// harvest bookmark-specific properties
|
|
var keyword = PlacesUtils.bookmarks.getKeywordForBookmark(aJSNode.id);
|
|
if (keyword)
|
|
aJSNode.keyword = keyword;
|
|
}
|
|
|
|
var tags = aIsUICommand ? aPlacesNode.tags : null;
|
|
if (tags)
|
|
aJSNode.tags = tags;
|
|
|
|
// last character-set
|
|
var uri = PlacesUtils._uri(aPlacesNode.uri);
|
|
var lastCharset = PlacesUtils.history.getCharsetForURI(uri);
|
|
if (lastCharset)
|
|
aJSNode.charset = lastCharset;
|
|
}
|
|
|
|
function addSeparatorProperties(aPlacesNode, aJSNode) {
|
|
aJSNode.type = PlacesUtils.TYPE_X_MOZ_PLACE_SEPARATOR;
|
|
}
|
|
|
|
function addContainerProperties(aPlacesNode, aJSNode) {
|
|
var concreteId = PlacesUtils.getConcreteItemId(aPlacesNode);
|
|
if (concreteId != -1) {
|
|
// This is a bookmark or a tag container.
|
|
if (PlacesUtils.nodeIsQuery(aPlacesNode) ||
|
|
(concreteId != aPlacesNode.itemId && !aResolveShortcuts)) {
|
|
aJSNode.type = PlacesUtils.TYPE_X_MOZ_PLACE;
|
|
aJSNode.uri = aPlacesNode.uri;
|
|
// folder shortcut
|
|
if (aIsUICommand)
|
|
aJSNode.concreteId = concreteId;
|
|
}
|
|
else { // Bookmark folder or a shortcut we should convert to folder.
|
|
aJSNode.type = PlacesUtils.TYPE_X_MOZ_PLACE_CONTAINER;
|
|
|
|
// Mark root folders.
|
|
if (aJSNode.id == PlacesUtils.placesRootId)
|
|
aJSNode.root = "placesRoot";
|
|
else if (aJSNode.id == PlacesUtils.bookmarksMenuFolderId)
|
|
aJSNode.root = "bookmarksMenuFolder";
|
|
else if (aJSNode.id == PlacesUtils.tagsFolderId)
|
|
aJSNode.root = "tagsFolder";
|
|
else if (aJSNode.id == PlacesUtils.unfiledBookmarksFolderId)
|
|
aJSNode.root = "unfiledBookmarksFolder";
|
|
else if (aJSNode.id == PlacesUtils.toolbarFolderId)
|
|
aJSNode.root = "toolbarFolder";
|
|
}
|
|
}
|
|
else {
|
|
// This is a grouped container query, generated on the fly.
|
|
aJSNode.type = PlacesUtils.TYPE_X_MOZ_PLACE;
|
|
aJSNode.uri = aPlacesNode.uri;
|
|
}
|
|
}
|
|
|
|
function appendConvertedComplexNode(aNode, aSourceNode, aArray) {
|
|
var repr = {};
|
|
|
|
for (let [name, value] in Iterator(aNode))
|
|
repr[name] = value;
|
|
|
|
// write child nodes
|
|
var children = repr.children = [];
|
|
if (!aNode.livemark) {
|
|
asContainer(aSourceNode);
|
|
var wasOpen = aSourceNode.containerOpen;
|
|
if (!wasOpen)
|
|
aSourceNode.containerOpen = true;
|
|
var cc = aSourceNode.childCount;
|
|
for (var i = 0; i < cc; ++i) {
|
|
var childNode = aSourceNode.getChild(i);
|
|
if (aExcludeItems && aExcludeItems.indexOf(childNode.itemId) != -1)
|
|
continue;
|
|
appendConvertedNode(aSourceNode.getChild(i), i, children);
|
|
}
|
|
if (!wasOpen)
|
|
aSourceNode.containerOpen = false;
|
|
}
|
|
|
|
aArray.push(repr);
|
|
return true;
|
|
}
|
|
|
|
function appendConvertedNode(bNode, aIndex, aArray) {
|
|
var node = {};
|
|
|
|
// set index in order received
|
|
// XXX handy shortcut, but are there cases where we don't want
|
|
// to export using the sorting provided by the query?
|
|
if (aIndex)
|
|
node.index = aIndex;
|
|
|
|
addGenericProperties(bNode, node);
|
|
|
|
var parent = bNode.parent;
|
|
var grandParent = parent ? parent.parent : null;
|
|
|
|
if (PlacesUtils.nodeIsURI(bNode)) {
|
|
// Tag root accept only folder nodes
|
|
if (parent && parent.itemId == PlacesUtils.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 {
|
|
PlacesUtils._uri(bNode.uri);
|
|
} catch (ex) {
|
|
return false;
|
|
}
|
|
|
|
addURIProperties(bNode, node);
|
|
}
|
|
else if (PlacesUtils.nodeIsContainer(bNode)) {
|
|
// Tag containers accept only uri nodes
|
|
if (grandParent && grandParent.itemId == PlacesUtils.tagsFolderId)
|
|
return false;
|
|
|
|
addContainerProperties(bNode, node);
|
|
}
|
|
else if (PlacesUtils.nodeIsSeparator(bNode)) {
|
|
// Tag root accept only folder nodes
|
|
// Tag containers accept only uri nodes
|
|
if ((parent && parent.itemId == PlacesUtils.tagsFolderId) ||
|
|
(grandParent && grandParent.itemId == PlacesUtils.tagsFolderId))
|
|
return false;
|
|
|
|
addSeparatorProperties(bNode, node);
|
|
}
|
|
|
|
if (!node.feedURI && node.type == PlacesUtils.TYPE_X_MOZ_PLACE_CONTAINER)
|
|
return appendConvertedComplexNode(node, bNode, aArray);
|
|
|
|
aArray.push(node);
|
|
return true;
|
|
}
|
|
|
|
// serialize to stream
|
|
var array = [];
|
|
if (appendConvertedNode(aNode, null, array)) {
|
|
var json = JSON.stringify(array[0]);
|
|
aStream.write(json, json.length);
|
|
}
|
|
else {
|
|
throw Cr.NS_ERROR_UNEXPECTED;
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Serialize a JS object to JSON
|
|
*/
|
|
toJSONString: function PU_toJSONString(aObj) {
|
|
return JSON.stringify(aObj);
|
|
},
|
|
|
|
/**
|
|
* Restores bookmarks and tags from a JSON file.
|
|
* WARNING: This method *removes* any bookmarks in the collection before
|
|
* restoring from the file.
|
|
*
|
|
* @param aFile
|
|
* nsIFile of bookmarks in JSON format to be restored.
|
|
*/
|
|
restoreBookmarksFromJSONFile:
|
|
function PU_restoreBookmarksFromJSONFile(aFile) {
|
|
let failed = false;
|
|
Services.obs.notifyObservers(null,
|
|
RESTORE_BEGIN_NSIOBSERVER_TOPIC,
|
|
RESTORE_NSIOBSERVER_DATA);
|
|
|
|
try {
|
|
// open file stream
|
|
var stream = Cc["@mozilla.org/network/file-input-stream;1"].
|
|
createInstance(Ci.nsIFileInputStream);
|
|
stream.init(aFile, 0x01, 0, 0);
|
|
var converted = Cc["@mozilla.org/intl/converter-input-stream;1"].
|
|
createInstance(Ci.nsIConverterInputStream);
|
|
converted.init(stream, "UTF-8", 8192,
|
|
Ci.nsIConverterInputStream.DEFAULT_REPLACEMENT_CHARACTER);
|
|
|
|
// read in contents
|
|
var str = {};
|
|
var jsonStr = "";
|
|
while (converted.readString(8192, str) != 0)
|
|
jsonStr += str.value;
|
|
converted.close();
|
|
|
|
if (jsonStr.length == 0)
|
|
return; // empty file
|
|
|
|
this.restoreBookmarksFromJSONString(jsonStr, true);
|
|
}
|
|
catch (exc) {
|
|
failed = true;
|
|
Services.obs.notifyObservers(null,
|
|
RESTORE_FAILED_NSIOBSERVER_TOPIC,
|
|
RESTORE_NSIOBSERVER_DATA);
|
|
Cu.reportError("Bookmarks JSON restore failed: " + exc);
|
|
throw exc;
|
|
}
|
|
finally {
|
|
if (!failed) {
|
|
Services.obs.notifyObservers(null,
|
|
RESTORE_SUCCESS_NSIOBSERVER_TOPIC,
|
|
RESTORE_NSIOBSERVER_DATA);
|
|
}
|
|
}
|
|
},
|
|
|
|
/**
|
|
* Serializes bookmarks using JSON, and writes to the supplied file.
|
|
*
|
|
* @see backups.saveBookmarksToJSONFile(aFile)
|
|
*/
|
|
backupBookmarksToFile: function PU_backupBookmarksToFile(aFile) {
|
|
this.backups.saveBookmarksToJSONFile(aFile);
|
|
},
|
|
|
|
/**
|
|
* Creates a dated backup in <profile>/bookmarkbackups.
|
|
* Stores the bookmarks using JSON.
|
|
*
|
|
* @see backups.create(aMaxBackups, aForceBackup)
|
|
*/
|
|
archiveBookmarksFile:
|
|
function PU_archiveBookmarksFile(aMaxBackups, aForceBackup) {
|
|
this.backups.create(aMaxBackups, aForceBackup);
|
|
},
|
|
|
|
/**
|
|
* Helper to create and manage backups.
|
|
*/
|
|
backups: {
|
|
|
|
get _filenamesRegex() {
|
|
// Get the localized backup filename, will be used to clear out
|
|
// old backups with a localized name (bug 445704).
|
|
let localizedFilename =
|
|
PlacesUtils.getFormattedString("bookmarksArchiveFilename", [new Date()]);
|
|
let localizedFilenamePrefix =
|
|
localizedFilename.substr(0, localizedFilename.indexOf("-"));
|
|
delete this._filenamesRegex;
|
|
return this._filenamesRegex =
|
|
new RegExp("^(bookmarks|" + localizedFilenamePrefix + ")-([0-9-]+)\.(json|html)");
|
|
},
|
|
|
|
get folder() {
|
|
let bookmarksBackupDir = Services.dirsvc.get("ProfD", Ci.nsILocalFile);
|
|
bookmarksBackupDir.append("bookmarkbackups");
|
|
if (!bookmarksBackupDir.exists()) {
|
|
bookmarksBackupDir.create(Ci.nsIFile.DIRECTORY_TYPE, 0700);
|
|
if (!bookmarksBackupDir.exists())
|
|
throw("Unable to create bookmarks backup folder");
|
|
}
|
|
delete this.folder;
|
|
return this.folder = bookmarksBackupDir;
|
|
},
|
|
|
|
/**
|
|
* Cache current backups in a sorted (by date DESC) array.
|
|
*/
|
|
get entries() {
|
|
delete this.entries;
|
|
this.entries = [];
|
|
let files = this.folder.directoryEntries;
|
|
while (files.hasMoreElements()) {
|
|
let entry = files.getNext().QueryInterface(Ci.nsIFile);
|
|
// A valid backup is any file that matches either the localized or
|
|
// not-localized filename (bug 445704).
|
|
let matches = entry.leafName.match(this._filenamesRegex);
|
|
if (!entry.isHidden() && matches) {
|
|
// Remove bogus backups in future dates.
|
|
if (this.getDateForFile(entry) > new Date()) {
|
|
entry.remove(false);
|
|
continue;
|
|
}
|
|
this.entries.push(entry);
|
|
}
|
|
}
|
|
this.entries.sort(function compare(a, b) {
|
|
let aDate = PlacesUtils.backups.getDateForFile(a);
|
|
let bDate = PlacesUtils.backups.getDateForFile(b);
|
|
return aDate < bDate ? 1 : aDate > bDate ? -1 : 0;
|
|
});
|
|
return this.entries;
|
|
},
|
|
|
|
/**
|
|
* Creates a filename for bookmarks backup files.
|
|
*
|
|
* @param [optional] aDateObj
|
|
* Date object used to build the filename.
|
|
* Will use current date if empty.
|
|
* @return A bookmarks backup filename.
|
|
*/
|
|
getFilenameForDate:
|
|
function PU_B_getFilenameForDate(aDateObj) {
|
|
let dateObj = aDateObj || new Date();
|
|
// Use YYYY-MM-DD (ISO 8601) as it doesn't contain illegal characters
|
|
// and makes the alphabetical order of multiple backup files more useful.
|
|
return "bookmarks-" + dateObj.toLocaleFormat("%Y-%m-%d") + ".json";
|
|
},
|
|
|
|
/**
|
|
* Creates a Date object from a backup file. The date is the backup
|
|
* creation date.
|
|
*
|
|
* @param aBackupFile
|
|
* nsIFile of the backup.
|
|
* @return A Date object for the backup's creation time.
|
|
*/
|
|
getDateForFile:
|
|
function PU_B_getDateForFile(aBackupFile) {
|
|
let filename = aBackupFile.leafName;
|
|
let matches = filename.match(this._filenamesRegex);
|
|
if (!matches)
|
|
do_throw("Invalid backup file name: " + filename);
|
|
return new Date(matches[2].replace(/-/g, "/"));
|
|
},
|
|
|
|
/**
|
|
* Get the most recent backup file.
|
|
*
|
|
* @param [optional] aFileExt
|
|
* Force file extension. Either "html" or "json".
|
|
* Will check for both if not defined.
|
|
* @returns nsIFile backup file
|
|
*/
|
|
getMostRecent:
|
|
function PU__B_getMostRecent(aFileExt) {
|
|
let fileExt = aFileExt || "(json|html)";
|
|
for (let i = 0; i < this.entries.length; i++) {
|
|
let rx = new RegExp("\." + fileExt + "$");
|
|
if (this.entries[i].leafName.match(rx))
|
|
return this.entries[i];
|
|
}
|
|
return null;
|
|
},
|
|
|
|
/**
|
|
* saveBookmarksToJSONFile()
|
|
*
|
|
* Serializes bookmarks using JSON, and writes to the supplied file.
|
|
* Note: any item that should not be backed up must be annotated with
|
|
* "places/excludeFromBackup".
|
|
*
|
|
* @param aFile
|
|
* nsIFile where to save JSON backup.
|
|
*/
|
|
saveBookmarksToJSONFile:
|
|
function PU_B_saveBookmarksToFile(aFile) {
|
|
if (!aFile.exists())
|
|
aFile.create(Ci.nsIFile.NORMAL_FILE_TYPE, 0600);
|
|
if (!aFile.exists() || !aFile.isWritable()) {
|
|
Cu.reportError("Unable to create bookmarks backup file: " + aFile.leafName);
|
|
return;
|
|
}
|
|
|
|
this._writeBackupFile(aFile);
|
|
|
|
if (aFile.parent.equals(this.folder)) {
|
|
// Update internal cache.
|
|
this.entries.push(aFile);
|
|
}
|
|
else {
|
|
// If we are saving to a folder different than our backups folder, then
|
|
// we also want to copy this new backup to it.
|
|
// This way we ensure the latest valid backup is the same saved by the
|
|
// user. See bug 424389.
|
|
var latestBackup = this.getMostRecent("json");
|
|
if (!latestBackup || latestBackup != aFile) {
|
|
let name = this.getFilenameForDate();
|
|
let file = this.folder.clone();
|
|
file.append(name);
|
|
if (file.exists())
|
|
file.remove(false);
|
|
else {
|
|
// Update internal cache if we are not replacing an existing
|
|
// backup file.
|
|
this.entries.push(file);
|
|
}
|
|
aFile.copyTo(this.folder, name);
|
|
}
|
|
}
|
|
},
|
|
|
|
_writeBackupFile:
|
|
function PU_B__writeBackupFile(aFile) {
|
|
// Init stream.
|
|
let stream = Cc["@mozilla.org/network/file-output-stream;1"].
|
|
createInstance(Ci.nsIFileOutputStream);
|
|
stream.init(aFile, 0x02 | 0x08 | 0x20, 0600, 0);
|
|
|
|
// UTF-8 converter stream.
|
|
let converter = Cc["@mozilla.org/intl/converter-output-stream;1"].
|
|
createInstance(Ci.nsIConverterOutputStream);
|
|
converter.init(stream, "UTF-8", 0, 0x0000);
|
|
|
|
// Weep over stream interface variance.
|
|
let streamProxy = {
|
|
converter: converter,
|
|
write: function(aData, aLen) {
|
|
this.converter.writeString(aData);
|
|
}
|
|
};
|
|
|
|
// Get list of itemIds that must be excluded from the backup.
|
|
let excludeItems =
|
|
PlacesUtils.annotations.getItemsWithAnnotation(PlacesUtils.EXCLUDE_FROM_BACKUP_ANNO);
|
|
|
|
// Query the Places root.
|
|
let options = PlacesUtils.history.getNewQueryOptions();
|
|
options.expandQueries = false;
|
|
let query = PlacesUtils.history.getNewQuery();
|
|
query.setFolders([PlacesUtils.placesRootId], 1);
|
|
let root = PlacesUtils.history.executeQuery(query, options).root;
|
|
root.containerOpen = true;
|
|
// Serialize to JSON and write to stream.
|
|
PlacesUtils.serializeNodeAsJSONToOutputStream(root, streamProxy,
|
|
false, false, excludeItems);
|
|
root.containerOpen = false;
|
|
|
|
// Close converter and stream.
|
|
converter.close();
|
|
stream.close();
|
|
},
|
|
|
|
/**
|
|
* create()
|
|
*
|
|
* Creates a dated backup in <profile>/bookmarkbackups.
|
|
* Stores the bookmarks using JSON.
|
|
* Note: any item that should not be backed up must be annotated with
|
|
* "places/excludeFromBackup".
|
|
*
|
|
* @param [optional] int aMaxBackups
|
|
* The maximum number of backups to keep.
|
|
*
|
|
* @param [optional] bool aForceBackup
|
|
* Forces creating a backup even if one was already
|
|
* created that day (overwrites).
|
|
*/
|
|
create:
|
|
function PU_B_create(aMaxBackups, aForceBackup) {
|
|
// Construct the new leafname.
|
|
let newBackupFilename = this.getFilenameForDate();
|
|
let mostRecentBackupFile = this.getMostRecent();
|
|
|
|
if (!aForceBackup) {
|
|
let numberOfBackupsToDelete = 0;
|
|
if (aMaxBackups !== undefined && aMaxBackups > -1)
|
|
numberOfBackupsToDelete = this.entries.length - aMaxBackups;
|
|
|
|
if (numberOfBackupsToDelete > 0) {
|
|
// If we don't have today's backup, remove one more so that
|
|
// the total backups after this operation does not exceed the
|
|
// number specified in the pref.
|
|
if (!mostRecentBackupFile ||
|
|
mostRecentBackupFile.leafName != newBackupFilename)
|
|
numberOfBackupsToDelete++;
|
|
|
|
while (numberOfBackupsToDelete--) {
|
|
let oldestBackup = this.entries.pop();
|
|
oldestBackup.remove(false);
|
|
}
|
|
}
|
|
|
|
// Do nothing if we already have this backup or we don't want backups.
|
|
if (aMaxBackups === 0 ||
|
|
(mostRecentBackupFile &&
|
|
mostRecentBackupFile.leafName == newBackupFilename))
|
|
return;
|
|
}
|
|
|
|
let newBackupFile = this.folder.clone();
|
|
newBackupFile.append(newBackupFilename);
|
|
|
|
if (aForceBackup && newBackupFile.exists())
|
|
newBackupFile.remove(false);
|
|
|
|
if (newBackupFile.exists())
|
|
return;
|
|
|
|
this.saveBookmarksToJSONFile(newBackupFile);
|
|
}
|
|
|
|
},
|
|
|
|
/**
|
|
* Given a uri returns list of itemIds associated to it.
|
|
*
|
|
* @param aURI
|
|
* nsIURI or spec of the page.
|
|
* @param aCallback
|
|
* Function to be called when done.
|
|
* The function will receive an array of itemIds associated to aURI and
|
|
* aURI itself.
|
|
* @param aScope
|
|
* Scope for the callback.
|
|
*
|
|
* @return A object with a .cancel() method allowing to cancel the request.
|
|
*
|
|
* @note Children of live bookmarks folders are excluded. The callback function is
|
|
* not invoked if the request is cancelled or hits an error.
|
|
*/
|
|
asyncGetBookmarkIds: function PU_asyncGetBookmarkIds(aURI, aCallback, aScope)
|
|
{
|
|
if (!this._asyncGetBookmarksStmt) {
|
|
let db = this.history.QueryInterface(Ci.nsPIPlacesDatabase).DBConnection;
|
|
this._asyncGetBookmarksStmt = db.createAsyncStatement(
|
|
"SELECT b.id "
|
|
+ "FROM moz_bookmarks b "
|
|
+ "JOIN moz_places h on h.id = b.fk "
|
|
+ "WHERE h.url = :url "
|
|
+ "AND NOT EXISTS( "
|
|
+ "SELECT 1 FROM moz_items_annos a "
|
|
+ "JOIN moz_anno_attributes n ON a.anno_attribute_id = n.id "
|
|
+ "WHERE a.item_id = b.parent AND n.name = :name "
|
|
+ ") "
|
|
);
|
|
this.registerShutdownFunction(function () {
|
|
this._asyncGetBookmarksStmt.finalize();
|
|
});
|
|
}
|
|
|
|
let url = aURI instanceof Ci.nsIURI ? aURI.spec : aURI;
|
|
this._asyncGetBookmarksStmt.params.url = url;
|
|
this._asyncGetBookmarksStmt.params.name = this.LMANNO_FEEDURI;
|
|
|
|
// Storage does not guarantee that invoking cancel() on a statement
|
|
// will cause a REASON_CANCELED. Thus we wrap the statement.
|
|
let stmt = new AsyncStatementCancelWrapper(this._asyncGetBookmarksStmt);
|
|
return stmt.executeAsync({
|
|
_itemIds: [],
|
|
handleResult: function(aResultSet) {
|
|
for (let row; (row = aResultSet.getNextRow());) {
|
|
this._itemIds.push(row.getResultByIndex(0));
|
|
}
|
|
},
|
|
handleCompletion: function(aReason)
|
|
{
|
|
if (aReason == Ci.mozIStorageStatementCallback.REASON_FINISHED) {
|
|
aCallback.apply(aScope, [this._itemIds, aURI]);
|
|
}
|
|
}
|
|
});
|
|
}
|
|
};
|
|
|
|
/**
|
|
* Wraps the provided statement so that invoking cancel() on the pending
|
|
* statement object will always cause a REASON_CANCELED.
|
|
*/
|
|
function AsyncStatementCancelWrapper(aStmt) {
|
|
this._stmt = aStmt;
|
|
}
|
|
AsyncStatementCancelWrapper.prototype = {
|
|
_canceled: false,
|
|
_cancel: function() {
|
|
this._canceled = true;
|
|
this._pendingStmt.cancel();
|
|
},
|
|
handleResult: function(aResultSet) {
|
|
this._callback.handleResult(aResultSet);
|
|
},
|
|
handleError: function(aError) {
|
|
Cu.reportError("Async statement execution returned (" + aError.result +
|
|
"): " + aError.message);
|
|
},
|
|
handleCompletion: function(aReason)
|
|
{
|
|
let reason = this._canceled ?
|
|
Ci.mozIStorageStatementCallback.REASON_CANCELED :
|
|
aReason;
|
|
this._callback.handleCompletion(reason);
|
|
},
|
|
executeAsync: function(aCallback) {
|
|
this._pendingStmt = this._stmt.executeAsync(this);
|
|
this._callback = aCallback;
|
|
let self = this;
|
|
return { cancel: function () { self._cancel(); } }
|
|
}
|
|
}
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "history",
|
|
"@mozilla.org/browser/nav-history-service;1",
|
|
"nsINavHistoryService");
|
|
|
|
XPCOMUtils.defineLazyGetter(PlacesUtils, "bhistory", function() {
|
|
return PlacesUtils.history.QueryInterface(Ci.nsIBrowserHistory);
|
|
});
|
|
|
|
XPCOMUtils.defineLazyGetter(PlacesUtils, "ghistory2", function() {
|
|
return PlacesUtils.history.QueryInterface(Ci.nsIGlobalHistory2);
|
|
});
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "favicons",
|
|
"@mozilla.org/browser/favicon-service;1",
|
|
"nsIFaviconService");
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "bookmarks",
|
|
"@mozilla.org/browser/nav-bookmarks-service;1",
|
|
"nsINavBookmarksService");
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "annotations",
|
|
"@mozilla.org/browser/annotation-service;1",
|
|
"nsIAnnotationService");
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "tagging",
|
|
"@mozilla.org/browser/tagging-service;1",
|
|
"nsITaggingService");
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(PlacesUtils, "livemarks",
|
|
"@mozilla.org/browser/livemark-service;2",
|
|
"nsILivemarkService");
|
|
|
|
XPCOMUtils.defineLazyGetter(PlacesUtils, "transactionManager", function() {
|
|
let tm = Cc["@mozilla.org/transactionmanager;1"].
|
|
getService(Ci.nsITransactionManager);
|
|
tm.AddListener(PlacesUtils);
|
|
this.registerShutdownFunction(function () {
|
|
// Clear all references to local transactions in the transaction manager,
|
|
// this prevents from leaking it.
|
|
this.transactionManager.RemoveListener(this);
|
|
this.transactionManager.clear();
|
|
});
|
|
return tm;
|
|
});
|
|
|
|
XPCOMUtils.defineLazyGetter(this, "bundle", function() {
|
|
const PLACES_STRING_BUNDLE_URI = "chrome://places/locale/places.properties";
|
|
return Cc["@mozilla.org/intl/stringbundle;1"].
|
|
getService(Ci.nsIStringBundleService).
|
|
createBundle(PLACES_STRING_BUNDLE_URI);
|
|
});
|
|
|
|
XPCOMUtils.defineLazyServiceGetter(this, "focusManager",
|
|
"@mozilla.org/focus-manager;1",
|
|
"nsIFocusManager");
|
|
|
|
////////////////////////////////////////////////////////////////////////////////
|
|
//// Transactions handlers.
|
|
|
|
/**
|
|
* Updates commands in the undo group of the active window commands.
|
|
* Inactive windows commands will be updated on focus.
|
|
*/
|
|
function updateCommandsOnActiveWindow()
|
|
{
|
|
let win = focusManager.activeWindow;
|
|
if (win && win instanceof Ci.nsIDOMWindow) {
|
|
// Updating "undo" will cause a group update including "redo".
|
|
win.updateCommands("undo");
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* Base transaction implementation.
|
|
*
|
|
* @note used internally, DO NOT EXPORT.
|
|
*/
|
|
|
|
function BaseTransaction() {}
|
|
|
|
BaseTransaction.prototype = {
|
|
doTransaction: function BTXN_doTransaction() {},
|
|
redoTransaction: function BTXN_redoTransaction() this.doTransaction(),
|
|
undoTransaction: function BTXN_undoTransaction() {},
|
|
merge: function BTXN_merge() false,
|
|
get isTransient() false,
|
|
QueryInterface: XPCOMUtils.generateQI([
|
|
Ci.nsITransaction
|
|
]),
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for performing several Places Transactions in a single batch.
|
|
*
|
|
* @param aName
|
|
* title of the aggregate transactions
|
|
* @param aTransactions
|
|
* an array of transactions to perform
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesAggregatedTransaction(aName, aTransactions)
|
|
{
|
|
// Copy the transactions array to decouple it from its prototype, which
|
|
// otherwise keeps alive its associated global object.
|
|
this._transactions = Array.slice(aTransactions);
|
|
this._name = aName;
|
|
this.container = -1;
|
|
|
|
// Check child transactions number. We will batch if we have more than
|
|
// MIN_TRANSACTIONS_FOR_BATCH total number of transactions.
|
|
let countTransactions = function(aTransactions, aTxnCount)
|
|
{
|
|
for (let i = 0;
|
|
i < aTransactions.length && aTxnCount < MIN_TRANSACTIONS_FOR_BATCH;
|
|
++i, ++aTxnCount) {
|
|
let txn = aTransactions[i];
|
|
if (txn && txn.childTransactions && txn.childTransactions.length)
|
|
aTxnCount = countTransactions(txn.childTransactions, aTxnCount);
|
|
}
|
|
return aTxnCount;
|
|
}
|
|
|
|
let txnCount = countTransactions(this._transactions, 0);
|
|
this._useBatch = txnCount >= MIN_TRANSACTIONS_FOR_BATCH;
|
|
}
|
|
|
|
PlacesAggregatedTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function ATXN_doTransaction()
|
|
{
|
|
this._isUndo = false;
|
|
if (this._useBatch)
|
|
PlacesUtils.bookmarks.runInBatchMode(this, null);
|
|
else
|
|
this.runBatched(false);
|
|
},
|
|
|
|
undoTransaction: function ATXN_undoTransaction()
|
|
{
|
|
this._isUndo = true;
|
|
if (this._useBatch)
|
|
PlacesUtils.bookmarks.runInBatchMode(this, null);
|
|
else
|
|
this.runBatched(true);
|
|
},
|
|
|
|
runBatched: function ATXN_runBatched()
|
|
{
|
|
// Use a copy of the transactions array, so we won't reverse the original
|
|
// one on undoing.
|
|
let transactions = this._transactions.slice(0);
|
|
if (this._isUndo)
|
|
transactions.reverse();
|
|
for (let i = 0; i < transactions.length; ++i) {
|
|
let txn = transactions[i];
|
|
if (this.container > -1)
|
|
txn.container = this.container;
|
|
if (this._isUndo)
|
|
txn.undoTransaction();
|
|
else
|
|
txn.doTransaction();
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for creating a new folder item.
|
|
*
|
|
* @param aName
|
|
* the name of the new folder
|
|
* @param aContainerId
|
|
* the identifier of the folder in which the new folder should be
|
|
* added.
|
|
* @param [optional] aIndex
|
|
* the index of the item in aContainer, pass -1 or nothing to create
|
|
* the item at the end of aContainer.
|
|
* @param [optional] aAnnotations
|
|
* the annotations to set for the new folder.
|
|
* @param [optional] aChildItemsTransactions
|
|
* array of transactions for items to be created under the new folder.
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesCreateFolderTransaction(aName, aContainer, aIndex, aAnnotations,
|
|
aChildItemsTransactions)
|
|
{
|
|
this._name = aName;
|
|
this._container = aContainer;
|
|
this._index = typeof(aIndex) == "number" ? aIndex : -1;
|
|
this._id = null;
|
|
// Copy the array to decouple it from its prototype, which otherwise keeps
|
|
// alive its associated global object.
|
|
this._annotations = aAnnotations ? Array.slice(aAnnotations) : [];
|
|
this.childTransactions = aChildItemsTransactions ?
|
|
Array.slice(aChildItemsTransactions) : [];
|
|
}
|
|
|
|
PlacesCreateFolderTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// childItemsTransaction support
|
|
get container() this._container,
|
|
set container(val) this._container = val,
|
|
|
|
doTransaction: function CFTXN_doTransaction()
|
|
{
|
|
this._id = PlacesUtils.bookmarks.createFolder(this._container,
|
|
this._name, this._index);
|
|
if (this._annotations && this._annotations.length > 0)
|
|
PlacesUtils.setAnnotationsForItem(this._id, this._annotations);
|
|
|
|
if (this.childTransactions.length) {
|
|
// Set the new container id into child transactions.
|
|
for (let i = 0; i < this.childTransactions.length; ++i) {
|
|
this.childTransactions[i].container = this._id;
|
|
}
|
|
|
|
let txn = new PlacesAggregatedTransaction("Create folder childTxn",
|
|
this.childTransactions);
|
|
txn.doTransaction();
|
|
}
|
|
|
|
if (this._GUID)
|
|
PlacesUtils.bookmarks.setItemGUID(this._id, this._GUID);
|
|
},
|
|
|
|
undoTransaction: function CFTXN_undoTransaction()
|
|
{
|
|
if (this.childTransactions.length) {
|
|
let txn = new PlacesAggregatedTransaction("Create folder childTxn",
|
|
this.childTransactions);
|
|
txn.undoTransaction();
|
|
}
|
|
|
|
// If a GUID exists for this item, preserve it before removing the item.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this._id, PlacesUtils.GUID_ANNO))
|
|
this._GUID = PlacesUtils.bookmarks.getItemGUID(this._id);
|
|
|
|
// Remove item only after all child transactions have been reverted.
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for creating a new bookmark item
|
|
*
|
|
* @param aURI
|
|
* the uri of the new bookmark (nsIURI)
|
|
* @param aContainerId
|
|
* the identifier of the folder in which the bookmark should be added.
|
|
* @param [optional] aIndex
|
|
* the index of the item in aContainer, pass -1 or nothing to create
|
|
* the item at the end of aContainer.
|
|
* @param [optional] aTitle
|
|
* the title of the new bookmark.
|
|
* @param [optional] aKeyword
|
|
* the keyword of the new bookmark.
|
|
* @param [optional] aAnnotations
|
|
* the annotations to set for the new bookmark.
|
|
* @param [optional] aChildTransactions
|
|
* child transactions to commit after creating the bookmark. Prefer
|
|
* using any of the arguments above if possible. In general, a child
|
|
* transations should be used only if the change it does has to be
|
|
* reverted manually when removing the bookmark item.
|
|
* a child transaction must support setting its bookmark-item
|
|
* identifier via an "id" js setter.
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesCreateBookmarkTransaction(aURI, aContainer, aIndex, aTitle,
|
|
aKeyword, aAnnotations,
|
|
aChildTransactions)
|
|
{
|
|
this._uri = aURI;
|
|
this._container = aContainer;
|
|
this._index = typeof(aIndex) == "number" ? aIndex : -1;
|
|
this._title = aTitle;
|
|
this._keyword = aKeyword;
|
|
// Copy the array to decouple it from its prototype, which otherwise keeps
|
|
// alive its associated global object.
|
|
this._annotations = aAnnotations ? Array.slice(aAnnotations) : [];
|
|
this.childTransactions = aChildTransactions ? Array.slice(aChildTransactions) : [];
|
|
}
|
|
|
|
PlacesCreateBookmarkTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// childItemsTransactions support for the create-folder transaction
|
|
get container() this._container,
|
|
set container(val) this._container = val,
|
|
|
|
doTransaction: function CITXN_doTransaction()
|
|
{
|
|
this._id = PlacesUtils.bookmarks.insertBookmark(this.container, this._uri,
|
|
this._index, this._title);
|
|
if (this._keyword)
|
|
PlacesUtils.bookmarks.setKeywordForBookmark(this._id, this._keyword);
|
|
if (this._annotations && this._annotations.length > 0)
|
|
PlacesUtils.setAnnotationsForItem(this._id, this._annotations);
|
|
|
|
if (this.childTransactions.length) {
|
|
// Set the new item id into child transactions.
|
|
for (let i = 0; i < this.childTransactions.length; ++i) {
|
|
this.childTransactions[i].id = this._id;
|
|
}
|
|
let txn = new PlacesAggregatedTransaction("Create item childTxn",
|
|
this.childTransactions);
|
|
txn.doTransaction();
|
|
}
|
|
if (this._GUID)
|
|
PlacesUtils.bookmarks.setItemGUID(this._id, this._GUID);
|
|
},
|
|
|
|
undoTransaction: function CITXN_undoTransaction()
|
|
{
|
|
if (this.childTransactions.length) {
|
|
// Undo transactions should always be done in reverse order.
|
|
let txn = new PlacesAggregatedTransaction("Create item childTxn",
|
|
this.childTransactions);
|
|
txn.undoTransaction();
|
|
}
|
|
|
|
// If a GUID exists for this item, preserve it before removing the item.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this._id, PlacesUtils.GUID_ANNO))
|
|
this._GUID = PlacesUtils.bookmarks.getItemGUID(this._id);
|
|
|
|
// Remove item only after all child transactions have been reverted.
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for creating a new separator item
|
|
*
|
|
* @param aContainerId
|
|
* the identifier of the folder in which the separator should be
|
|
* added.
|
|
* @param [optional] aIndex
|
|
* the index of the item in aContainer, pass -1 or nothing to create
|
|
* the separator at the end of aContainer.
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesCreateSeparatorTransaction(aContainer, aIndex)
|
|
{
|
|
this._container = aContainer;
|
|
this._index = typeof(aIndex) == "number" ? aIndex : -1;
|
|
this._id = null;
|
|
}
|
|
|
|
PlacesCreateSeparatorTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// childItemsTransaction support
|
|
get container() this._container,
|
|
set container(val) this._container = val,
|
|
|
|
doTransaction: function CSTXN_doTransaction()
|
|
{
|
|
this._id = PlacesUtils.bookmarks
|
|
.insertSeparator(this.container, this._index);
|
|
if (this._GUID)
|
|
PlacesUtils.bookmarks.setItemGUID(this._id, this._GUID);
|
|
},
|
|
|
|
undoTransaction: function CSTXN_undoTransaction()
|
|
{
|
|
// If a GUID exists for this item, preserve it before removing the item.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this._id, PlacesUtils.GUID_ANNO))
|
|
this._GUID = PlacesUtils.bookmarks.getItemGUID(this._id);
|
|
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for creating a new live-bookmark item.
|
|
*
|
|
* @see nsILivemarksService::createLivemark for documentation regarding the
|
|
* first three arguments.
|
|
*
|
|
* @param aContainerId
|
|
* the identifier of the folder in which the live-bookmark should be
|
|
* added.
|
|
* @param [optional] aIndex
|
|
* the index of the item in aContainer, pass -1 or nothing to create
|
|
* the item at the end of aContainer.
|
|
* @param [optional] aAnnotations
|
|
* the annotations to set for the new live-bookmark.
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesCreateLivemarkTransaction(aFeedURI, aSiteURI, aName, aContainer,
|
|
aIndex, aAnnotations)
|
|
{
|
|
this._feedURI = aFeedURI;
|
|
this._siteURI = aSiteURI;
|
|
this._name = aName;
|
|
this._container = aContainer;
|
|
this._index = typeof(aIndex) == "number" ? aIndex : -1;
|
|
// Copy the array to decouple it from its prototype, which otherwise keeps
|
|
// alive its associated global object.
|
|
this._annotations = aAnnotations ? Array.slice(aAnnotations) : [];
|
|
}
|
|
|
|
PlacesCreateLivemarkTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// childItemsTransaction support
|
|
get container() this._container,
|
|
set container(val) this._container = val,
|
|
|
|
doTransaction: function CLTXN_doTransaction()
|
|
{
|
|
this._id = PlacesUtils.livemarks.createLivemark(this._container, this._name,
|
|
this._siteURI, this._feedURI,
|
|
this._index);
|
|
if (this._annotations && this._annotations.length > 0)
|
|
PlacesUtils.setAnnotationsForItem(this._id, this._annotations);
|
|
if (this._GUID)
|
|
PlacesUtils.bookmarks.setItemGUID(this._id, this._GUID);
|
|
},
|
|
|
|
undoTransaction: function CLTXN_undoTransaction()
|
|
{
|
|
// If a GUID exists for this item, preserve it before removing the item.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this._id, PlacesUtils.GUID_ANNO))
|
|
this._GUID = PlacesUtils.bookmarks.getItemGUID(this._id);
|
|
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for removing a live-bookmark item.
|
|
*
|
|
* @param aFolderId
|
|
* the identifier of the folder for the live-bookmark.
|
|
* @returns nsITransaction object
|
|
* @note used internally by PlacesRemoveItemTransaction, DO NOT EXPORT.
|
|
*/
|
|
|
|
function PlacesRemoveLivemarkTransaction(aFolderId)
|
|
{
|
|
this._id = aFolderId;
|
|
this._title = PlacesUtils.bookmarks.getItemTitle(this._id);
|
|
this._container = PlacesUtils.bookmarks.getFolderIdForItem(this._id);
|
|
let annos = PlacesUtils.getAnnotationsForItem(this._id);
|
|
// Exclude livemark service annotations, those will be recreated automatically
|
|
let annosToExclude = [PlacesUtils.LMANNO_FEEDURI,
|
|
PlacesUtils.LMANNO_SITEURI,
|
|
PlacesUtils.LMANNO_EXPIRATION,
|
|
PlacesUtils.LMANNO_LOADFAILED,
|
|
PlacesUtils.LMANNO_LOADING];
|
|
this._annotations = annos.filter(function(aValue, aIndex, aArray) {
|
|
return annosToExclude.indexOf(aValue.name) == -1;
|
|
});
|
|
this._feedURI = PlacesUtils.livemarks.getFeedURI(this._id);
|
|
this._siteURI = PlacesUtils.livemarks.getSiteURI(this._id);
|
|
this._dateAdded = PlacesUtils.bookmarks.getItemDateAdded(this._id);
|
|
this._lastModified = PlacesUtils.bookmarks.getItemLastModified(this._id);
|
|
}
|
|
|
|
PlacesRemoveLivemarkTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function RLTXN_doTransaction()
|
|
{
|
|
this._index = PlacesUtils.bookmarks.getItemIndex(this._id);
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
},
|
|
|
|
undoTransaction: function RLTXN_undoTransaction()
|
|
{
|
|
this._id = PlacesUtils.livemarks.createLivemark(this._container,
|
|
this._title,
|
|
this._siteURI,
|
|
this._feedURI,
|
|
this._index);
|
|
PlacesUtils.bookmarks.setItemDateAdded(this._id, this._dateAdded);
|
|
PlacesUtils.bookmarks.setItemLastModified(this._id, this._lastModified);
|
|
// Restore annotations
|
|
PlacesUtils.setAnnotationsForItem(this._id, this._annotations);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for moving an Item.
|
|
*
|
|
* @param aItemId
|
|
* the id of the item to move
|
|
* @param aNewContainerId
|
|
* id of the new container to move to
|
|
* @param aNewIndex
|
|
* index of the new position to move to
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesMoveItemTransaction(aItemId, aNewContainer, aNewIndex)
|
|
{
|
|
this._id = aItemId;
|
|
this._oldContainer = PlacesUtils.bookmarks.getFolderIdForItem(this._id);
|
|
this._newContainer = aNewContainer;
|
|
this._newIndex = aNewIndex;
|
|
}
|
|
|
|
PlacesMoveItemTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function MITXN_doTransaction()
|
|
{
|
|
this._oldIndex = PlacesUtils.bookmarks.getItemIndex(this._id);
|
|
PlacesUtils.bookmarks.moveItem(this._id, this._newContainer, this._newIndex);
|
|
this._undoIndex = PlacesUtils.bookmarks.getItemIndex(this._id);
|
|
},
|
|
|
|
undoTransaction: function MITXN_undoTransaction()
|
|
{
|
|
// moving down in the same container takes in count removal of the item
|
|
// so to revert positions we must move to oldIndex + 1
|
|
if (this._newContainer == this._oldContainer &&
|
|
this._oldIndex > this._undoIndex)
|
|
PlacesUtils.bookmarks.moveItem(this._id, this._oldContainer, this._oldIndex + 1);
|
|
else
|
|
PlacesUtils.bookmarks.moveItem(this._id, this._oldContainer, this._oldIndex);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for removing an Item
|
|
*
|
|
* @param aItemId
|
|
* id of the item to remove
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesRemoveItemTransaction(aItemId)
|
|
{
|
|
if (PlacesUtils.isRootItem(aItemId))
|
|
throw Cr.NS_ERROR_INVALID_ARG;
|
|
|
|
// if the item lives within a tag container, use the tagging transactions
|
|
let parent = PlacesUtils.bookmarks.getFolderIdForItem(aItemId);
|
|
let grandparent = PlacesUtils.bookmarks.getFolderIdForItem(parent);
|
|
if (grandparent == PlacesUtils.tagsFolderId) {
|
|
let uri = PlacesUtils.bookmarks.getBookmarkURI(aItemId);
|
|
return new PlacesUntagURITransaction(uri, [parent]);
|
|
}
|
|
|
|
// if the item is a livemark container we will not save its children and
|
|
// will use createLivemark to undo.
|
|
if (PlacesUtils.itemIsLivemark(aItemId))
|
|
return new PlacesRemoveLivemarkTransaction(aItemId);
|
|
|
|
this._id = aItemId;
|
|
this._itemType = PlacesUtils.bookmarks.getItemType(this._id);
|
|
if (this._itemType == Ci.nsINavBookmarksService.TYPE_FOLDER) {
|
|
this.childTransactions = this._getFolderContentsTransactions();
|
|
// Remove this folder itself.
|
|
let txn = PlacesUtils.bookmarks.getRemoveFolderTransaction(this._id);
|
|
this.childTransactions.push(txn);
|
|
}
|
|
else if (this._itemType == Ci.nsINavBookmarksService.TYPE_BOOKMARK) {
|
|
this._uri = PlacesUtils.bookmarks.getBookmarkURI(this._id);
|
|
this._keyword = PlacesUtils.bookmarks.getKeywordForBookmark(this._id);
|
|
}
|
|
|
|
if (this._itemType != Ci.nsINavBookmarksService.TYPE_SEPARATOR)
|
|
this._title = PlacesUtils.bookmarks.getItemTitle(this._id);
|
|
|
|
this._oldContainer = PlacesUtils.bookmarks.getFolderIdForItem(this._id);
|
|
this._annotations = PlacesUtils.getAnnotationsForItem(this._id);
|
|
this._dateAdded = PlacesUtils.bookmarks.getItemDateAdded(this._id);
|
|
this._lastModified = PlacesUtils.bookmarks.getItemLastModified(this._id);
|
|
}
|
|
|
|
PlacesRemoveItemTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function RITXN_doTransaction()
|
|
{
|
|
this._oldIndex = PlacesUtils.bookmarks.getItemIndex(this._id);
|
|
|
|
if (this._itemType == Ci.nsINavBookmarksService.TYPE_FOLDER) {
|
|
let txn = new PlacesAggregatedTransaction("Remove item childTxn",
|
|
this.childTransactions);
|
|
txn.doTransaction();
|
|
}
|
|
else {
|
|
// Before removing the bookmark, save its tags.
|
|
let tags = this._uri ? PlacesUtils.tagging.getTagsForURI(this._uri) : null;
|
|
|
|
PlacesUtils.bookmarks.removeItem(this._id);
|
|
|
|
// If this was the last bookmark (excluding tag-items and livemark
|
|
// children) for this url, persist the tags.
|
|
if (tags && PlacesUtils.getMostRecentBookmarkForURI(this._uri) == -1) {
|
|
this._tags = tags;
|
|
}
|
|
}
|
|
},
|
|
|
|
undoTransaction: function RITXN_undoTransaction()
|
|
{
|
|
if (this._itemType == Ci.nsINavBookmarksService.TYPE_BOOKMARK) {
|
|
this._id = PlacesUtils.bookmarks.insertBookmark(this._oldContainer,
|
|
this._uri,
|
|
this._oldIndex,
|
|
this._title);
|
|
if (this._tags && this._tags.length > 0)
|
|
PlacesUtils.tagging.tagURI(this._uri, this._tags);
|
|
if (this._keyword)
|
|
PlacesUtils.bookmarks.setKeywordForBookmark(this._id, this._keyword);
|
|
}
|
|
else if (this._itemType == Ci.nsINavBookmarksService.TYPE_FOLDER) {
|
|
let txn = new PlacesAggregatedTransaction("Remove item childTxn",
|
|
this.childTransactions);
|
|
txn.undoTransaction();
|
|
}
|
|
else // TYPE_SEPARATOR
|
|
this._id = PlacesUtils.bookmarks.insertSeparator(this._oldContainer, this._oldIndex);
|
|
|
|
if (this._annotations.length > 0)
|
|
PlacesUtils.setAnnotationsForItem(this._id, this._annotations);
|
|
|
|
PlacesUtils.bookmarks.setItemDateAdded(this._id, this._dateAdded);
|
|
PlacesUtils.bookmarks.setItemLastModified(this._id, this._lastModified);
|
|
},
|
|
|
|
/**
|
|
* Returns a flat, ordered list of transactions for a depth-first recreation
|
|
* of items within this folder.
|
|
*/
|
|
_getFolderContentsTransactions:
|
|
function RITXN__getFolderContentsTransactions()
|
|
{
|
|
let transactions = [];
|
|
let contents =
|
|
PlacesUtils.getFolderContents(this._id, false, false).root;
|
|
for (let i = 0; i < contents.childCount; ++i) {
|
|
let txn = new PlacesRemoveItemTransaction(contents.getChild(i).itemId);
|
|
transactions.push(txn);
|
|
}
|
|
contents.containerOpen = false;
|
|
// Reverse transactions to preserve parent-child relationship.
|
|
return transactions.reverse();
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editting a bookmark's title.
|
|
*
|
|
* @param aItemId
|
|
* id of the item to edit
|
|
* @param aNewTitle
|
|
* new title for the item to edit
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditItemTitleTransaction(id, newTitle)
|
|
{
|
|
this._id = id;
|
|
this._newTitle = newTitle;
|
|
this._oldTitle = "";
|
|
}
|
|
|
|
PlacesEditItemTitleTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function EITTXN_doTransaction()
|
|
{
|
|
this._oldTitle = PlacesUtils.bookmarks.getItemTitle(this._id);
|
|
PlacesUtils.bookmarks.setItemTitle(this._id, this._newTitle);
|
|
},
|
|
|
|
undoTransaction: function EITTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.bookmarks.setItemTitle(this._id, this._oldTitle);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing a bookmark's uri.
|
|
*
|
|
* @param aBookmarkId
|
|
* id of the bookmark to edit
|
|
* @param aNewURI
|
|
* new uri for the bookmark
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditBookmarkURITransaction(aBookmarkId, aNewURI) {
|
|
this._id = aBookmarkId;
|
|
this._newURI = aNewURI;
|
|
}
|
|
|
|
PlacesEditBookmarkURITransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function EBUTXN_doTransaction()
|
|
{
|
|
this._oldURI = PlacesUtils.bookmarks.getBookmarkURI(this._id);
|
|
PlacesUtils.bookmarks.changeBookmarkURI(this._id, this._newURI);
|
|
// move tags from old URI to new URI
|
|
this._tags = PlacesUtils.tagging.getTagsForURI(this._oldURI);
|
|
if (this._tags.length != 0) {
|
|
// only untag the old URI if this is the only bookmark
|
|
if (PlacesUtils.getBookmarksForURI(this._oldURI, {}).length == 0)
|
|
PlacesUtils.tagging.untagURI(this._oldURI, this._tags);
|
|
PlacesUtils.tagging.tagURI(this._newURI, this._tags);
|
|
}
|
|
},
|
|
|
|
undoTransaction: function EBUTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.bookmarks.changeBookmarkURI(this._id, this._oldURI);
|
|
// move tags from new URI to old URI
|
|
if (this._tags.length != 0) {
|
|
// only untag the new URI if this is the only bookmark
|
|
if (PlacesUtils.getBookmarksForURI(this._newURI, {}).length == 0)
|
|
PlacesUtils.tagging.untagURI(this._newURI, this._tags);
|
|
PlacesUtils.tagging.tagURI(this._oldURI, this._tags);
|
|
}
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for setting/unsetting an item annotation
|
|
*
|
|
* @param aItemId
|
|
* id of the item where to set annotation
|
|
* @param aAnnotationObject
|
|
* Object representing an annotation, containing the following
|
|
* properties: name, flags, expires, type, mimeType (only used for
|
|
* binary annotations), value.
|
|
* If value is null the annotation will be removed
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesSetItemAnnotationTransaction(aItemId, aAnnotationObject)
|
|
{
|
|
this.id = aItemId;
|
|
this._anno = aAnnotationObject;
|
|
// create an empty old anno
|
|
this._oldAnno = { name: this._anno.name,
|
|
type: Ci.nsIAnnotationService.TYPE_STRING,
|
|
flags: 0,
|
|
value: null,
|
|
expires: Ci.nsIAnnotationService.EXPIRE_NEVER };
|
|
}
|
|
|
|
PlacesSetItemAnnotationTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function SIATXN_doTransaction()
|
|
{
|
|
// Since this can be used as a child transaction this.id will be known
|
|
// only at this point, after the external caller has set it.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this.id, this._anno.name)) {
|
|
// Save the old annotation if it is set.
|
|
let flags = {}, expires = {}, mimeType = {}, type = {};
|
|
PlacesUtils.annotations.getItemAnnotationInfo(this.id, this._anno.name,
|
|
flags, expires, mimeType,
|
|
type);
|
|
this._oldAnno.flags = flags.value;
|
|
this._oldAnno.expires = expires.value;
|
|
this._oldAnno.mimeType = mimeType.value;
|
|
this._oldAnno.type = type.value;
|
|
this._oldAnno.value = PlacesUtils.annotations
|
|
.getItemAnnotation(this.id,
|
|
this._anno.name);
|
|
}
|
|
|
|
PlacesUtils.setAnnotationsForItem(this.id, [this._anno]);
|
|
},
|
|
|
|
undoTransaction: function SIATXN_undoTransaction()
|
|
{
|
|
PlacesUtils.setAnnotationsForItem(this.id, [this._oldAnno]);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for setting/unsetting a page annotation
|
|
*
|
|
* @param aURI
|
|
* URI of the page where to set annotation
|
|
* @param aAnnotationObject
|
|
* Object representing an annotation, containing the following
|
|
* properties: name, flags, expires, type, mimeType (only used for
|
|
* binary annotations), value.
|
|
* If value is null the annotation will be removed
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesSetPageAnnotationTransaction(aURI, aAnnotationObject)
|
|
{
|
|
this._uri = aURI;
|
|
this._anno = aAnnotationObject;
|
|
// create an empty old anno
|
|
this._oldAnno = { name: this._anno.name,
|
|
type: Ci.nsIAnnotationService.TYPE_STRING,
|
|
flags: 0,
|
|
value: null,
|
|
expires: Ci.nsIAnnotationService.EXPIRE_NEVER };
|
|
|
|
if (PlacesUtils.annotations.pageHasAnnotation(this._uri, this._anno.name)) {
|
|
// fill the old anno if it is set
|
|
let flags = {}, expires = {}, mimeType = {}, type = {};
|
|
PlacesUtils.annotations.getPageAnnotationInfo(this._uri, this._anno.name,
|
|
flags, expires, mimeType, type);
|
|
this._oldAnno.flags = flags.value;
|
|
this._oldAnno.expires = expires.value;
|
|
this._oldAnno.mimeType = mimeType.value;
|
|
this._oldAnno.type = type.value;
|
|
this._oldAnno.value = PlacesUtils.annotations
|
|
.getPageAnnotation(this._uri, this._anno.name);
|
|
}
|
|
|
|
}
|
|
|
|
PlacesSetPageAnnotationTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function SPATXN_doTransaction()
|
|
{
|
|
PlacesUtils.setAnnotationsForURI(this._uri, [this._anno]);
|
|
},
|
|
|
|
undoTransaction: function SPATXN_undoTransaction()
|
|
{
|
|
PlacesUtils.setAnnotationsForURI(this._uri, [this._oldAnno]);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing a bookmark's keyword.
|
|
*
|
|
* @param aBookmarkId
|
|
* id of the bookmark to edit
|
|
* @param aNewKeyword
|
|
* new keyword for the bookmark
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditBookmarkKeywordTransaction(id, newKeyword) {
|
|
this.id = id;
|
|
this._newKeyword = newKeyword;
|
|
this._oldKeyword = "";
|
|
|
|
}
|
|
|
|
PlacesEditBookmarkKeywordTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function EBKTXN_doTransaction()
|
|
{
|
|
this._oldKeyword = PlacesUtils.bookmarks.getKeywordForBookmark(this.id);
|
|
PlacesUtils.bookmarks.setKeywordForBookmark(this.id, this._newKeyword);
|
|
},
|
|
|
|
undoTransaction: function EBKTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.bookmarks.setKeywordForBookmark(this.id, this._oldKeyword);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing the post data associated with a bookmark.
|
|
*
|
|
* @param aBookmarkId
|
|
* id of the bookmark to edit
|
|
* @param aPostData
|
|
* post data
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditBookmarkPostDataTransaction(aItemId, aPostData)
|
|
{
|
|
this.id = aItemId;
|
|
this._newPostData = aPostData;
|
|
this._oldPostData = null;
|
|
}
|
|
|
|
PlacesEditBookmarkPostDataTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function EBPDTXN_doTransaction()
|
|
{
|
|
this._oldPostData = PlacesUtils.getPostDataForBookmark(this.id);
|
|
PlacesUtils.setPostDataForBookmark(this.id, this._newPostData);
|
|
},
|
|
|
|
undoTransaction: function EBPDTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.setPostDataForBookmark(this.id, this._oldPostData);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing a live bookmark's site URI.
|
|
*
|
|
* @param aLivemarkId
|
|
* id of the livemark
|
|
* @param aURI
|
|
* new site uri
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditLivemarkSiteURITransaction(folderId, uri)
|
|
{
|
|
this._folderId = folderId;
|
|
this._newURI = uri;
|
|
this._oldURI = null;
|
|
}
|
|
|
|
PlacesEditLivemarkSiteURITransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function ELSUTXN_doTransaction()
|
|
{
|
|
this._oldURI = PlacesUtils.livemarks.getSiteURI(this._folderId);
|
|
PlacesUtils.livemarks.setSiteURI(this._folderId, this._newURI);
|
|
},
|
|
|
|
undoTransaction: function ELSUTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.livemarks.setSiteURI(this._folderId, this._oldURI);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editting a live bookmark's feed URI.
|
|
*
|
|
* @param aLivemarkId
|
|
* id of the livemark
|
|
* @param aURI
|
|
* new feed uri
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditLivemarkFeedURITransaction(folderId, uri)
|
|
{
|
|
this._folderId = folderId;
|
|
this._newURI = uri;
|
|
this._oldURI = null;
|
|
}
|
|
|
|
PlacesEditLivemarkFeedURITransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function ELFUTXN_doTransaction()
|
|
{
|
|
this._oldURI = PlacesUtils.livemarks.getFeedURI(this._folderId);
|
|
PlacesUtils.livemarks.setFeedURI(this._folderId, this._newURI);
|
|
PlacesUtils.livemarks.reloadLivemarkFolder(this._folderId);
|
|
},
|
|
|
|
undoTransaction: function ELFUTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.livemarks.setFeedURI(this._folderId, this._oldURI);
|
|
PlacesUtils.livemarks.reloadLivemarkFolder(this._folderId);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing an item's date added property.
|
|
*
|
|
* @param aItemId
|
|
* id of the item to edit
|
|
* @param aNewDateAdded
|
|
* new date added for the item
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditItemDateAddedTransaction(id, newDateAdded)
|
|
{
|
|
this.id = id;
|
|
this._newDateAdded = newDateAdded;
|
|
this._oldDateAdded = null;
|
|
}
|
|
|
|
PlacesEditItemDateAddedTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// to support folders as well
|
|
get container() this.id,
|
|
set container(val) this.id = val,
|
|
|
|
doTransaction: function EIDATXN_doTransaction()
|
|
{
|
|
this._oldDateAdded = PlacesUtils.bookmarks.getItemDateAdded(this.id);
|
|
PlacesUtils.bookmarks.setItemDateAdded(this.id, this._newDateAdded);
|
|
},
|
|
|
|
undoTransaction: function EIDATXN_undoTransaction()
|
|
{
|
|
PlacesUtils.bookmarks.setItemDateAdded(this.id, this._oldDateAdded);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for editing an item's last modified time.
|
|
*
|
|
* @param aItemId
|
|
* id of the item to edit
|
|
* @param aNewLastModified
|
|
* new last modified date for the item
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesEditItemLastModifiedTransaction(id, newLastModified)
|
|
{
|
|
this.id = id;
|
|
this._newLastModified = newLastModified;
|
|
this._oldLastModified = null;
|
|
}
|
|
|
|
PlacesEditItemLastModifiedTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
// to support folders as well
|
|
get container() this.id,
|
|
set container(val) this.id = val,
|
|
|
|
doTransaction:
|
|
function EILMTXN_doTransaction()
|
|
{
|
|
this._oldLastModified = PlacesUtils.bookmarks.getItemLastModified(this.id);
|
|
PlacesUtils.bookmarks.setItemLastModified(this.id, this._newLastModified);
|
|
},
|
|
|
|
undoTransaction:
|
|
function EILMTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.bookmarks.setItemLastModified(this.id, this._oldLastModified);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for sorting a folder by name
|
|
*
|
|
* @param aFolderId
|
|
* id of the folder to sort
|
|
* @returns nsITransaction object
|
|
*/
|
|
|
|
function PlacesSortFolderByNameTransaction(aFolderId)
|
|
{
|
|
this._folderId = aFolderId;
|
|
this._oldOrder = null;
|
|
}
|
|
|
|
PlacesSortFolderByNameTransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function SFBNTXN_doTransaction()
|
|
{
|
|
this._oldOrder = [];
|
|
|
|
let contents =
|
|
PlacesUtils.getFolderContents(this._folderId, false, false).root;
|
|
let count = contents.childCount;
|
|
|
|
// sort between separators
|
|
let newOrder = [];
|
|
let preSep = []; // temporary array for sorting each group of items
|
|
let sortingMethod =
|
|
function (a, b) {
|
|
if (PlacesUtils.nodeIsContainer(a) && !PlacesUtils.nodeIsContainer(b))
|
|
return -1;
|
|
if (!PlacesUtils.nodeIsContainer(a) && PlacesUtils.nodeIsContainer(b))
|
|
return 1;
|
|
return a.title.localeCompare(b.title);
|
|
};
|
|
|
|
for (let i = 0; i < count; ++i) {
|
|
let item = contents.getChild(i);
|
|
this._oldOrder[item.itemId] = i;
|
|
if (PlacesUtils.nodeIsSeparator(item)) {
|
|
if (preSep.length > 0) {
|
|
preSep.sort(sortingMethod);
|
|
newOrder = newOrder.concat(preSep);
|
|
preSep.splice(0, preSep.length);
|
|
}
|
|
newOrder.push(item);
|
|
}
|
|
else
|
|
preSep.push(item);
|
|
}
|
|
contents.containerOpen = false;
|
|
|
|
if (preSep.length > 0) {
|
|
preSep.sort(sortingMethod);
|
|
newOrder = newOrder.concat(preSep);
|
|
}
|
|
|
|
// set the nex indexes
|
|
let callback = {
|
|
runBatched: function() {
|
|
for (let i = 0; i < newOrder.length; ++i) {
|
|
PlacesUtils.bookmarks.setItemIndex(newOrder[i].itemId, i);
|
|
}
|
|
}
|
|
};
|
|
PlacesUtils.bookmarks.runInBatchMode(callback, null);
|
|
},
|
|
|
|
undoTransaction: function SFBNTXN_undoTransaction()
|
|
{
|
|
let callback = {
|
|
_self: this,
|
|
runBatched: function() {
|
|
for (item in this._self._oldOrder)
|
|
PlacesUtils.bookmarks.setItemIndex(item, this._self._oldOrder[item]);
|
|
}
|
|
};
|
|
PlacesUtils.bookmarks.runInBatchMode(callback, null);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for tagging a URL with the given set of tags. Current tags set
|
|
* for the URL persist. It's the caller's job to check whether or not aURI
|
|
* was already tagged by any of the tags in aTags, undoing this tags
|
|
* transaction removes them all from aURL!
|
|
*
|
|
* @param aURI
|
|
* the URL to tag.
|
|
* @param aTags
|
|
* Array of tags to set for the given URL.
|
|
*/
|
|
|
|
function PlacesTagURITransaction(aURI, aTags)
|
|
{
|
|
this._uri = aURI;
|
|
this._unfiledItemId = -1;
|
|
// Copy the array to decouple it from its prototype, which otherwise keeps
|
|
// alive its associated global object.
|
|
this._tags = Array.slice(aTags);
|
|
}
|
|
|
|
PlacesTagURITransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function TUTXN_doTransaction()
|
|
{
|
|
if (PlacesUtils.getMostRecentBookmarkForURI(this._uri) == -1) {
|
|
// Force an unfiled bookmark first
|
|
this._unfiledItemId =
|
|
PlacesUtils.bookmarks
|
|
.insertBookmark(PlacesUtils.unfiledBookmarksFolderId,
|
|
this._uri,
|
|
PlacesUtils.bookmarks.DEFAULT_INDEX,
|
|
PlacesUtils.history.getPageTitle(this._uri));
|
|
if (this._GUID)
|
|
PlacesUtils.bookmarks.setItemGUID(this._unfiledItemId, this._GUID);
|
|
}
|
|
PlacesUtils.tagging.tagURI(this._uri, this._tags);
|
|
},
|
|
|
|
undoTransaction: function TUTXN_undoTransaction()
|
|
{
|
|
if (this._unfiledItemId != -1) {
|
|
// If a GUID exists for this item, preserve it before removing the item.
|
|
if (PlacesUtils.annotations.itemHasAnnotation(this._unfiledItemId, PlacesUtils.GUID_ANNO)) {
|
|
this._GUID = PlacesUtils.bookmarks.getItemGUID(this._unfiledItemId);
|
|
}
|
|
PlacesUtils.bookmarks.removeItem(this._unfiledItemId);
|
|
this._unfiledItemId = -1;
|
|
}
|
|
PlacesUtils.tagging.untagURI(this._uri, this._tags);
|
|
}
|
|
};
|
|
|
|
|
|
/**
|
|
* Transaction for removing tags from a URL. It's the caller's job to check
|
|
* whether or not aURI isn't tagged by any of the tags in aTags, undoing this
|
|
* tags transaction adds them all to aURL!
|
|
*
|
|
* @param aURI
|
|
* the URL to un-tag.
|
|
* @param aTags
|
|
* Array of tags to unset. pass null to remove all tags from the given
|
|
* url.
|
|
*/
|
|
|
|
function PlacesUntagURITransaction(aURI, aTags)
|
|
{
|
|
this._uri = aURI;
|
|
if (aTags) {
|
|
// Copy the array to decouple it from its prototype, which otherwise keeps
|
|
// alive its associated global object.
|
|
this._tags = Array.slice(aTags);
|
|
|
|
// Within this transaction, we cannot rely on tags given by itemId
|
|
// since the tag containers may be gone after we call untagURI.
|
|
// Thus, we convert each tag given by its itemId to name.
|
|
for (let i = 0; i < this._tags.length; ++i) {
|
|
if (typeof(this._tags[i]) == "number")
|
|
this._tags[i] = PlacesUtils.bookmarks.getItemTitle(this._tags[i]);
|
|
}
|
|
}
|
|
else {
|
|
this._tags = PlacesUtils.tagging.getTagsForURI(this._uri);
|
|
}
|
|
}
|
|
|
|
PlacesUntagURITransaction.prototype = {
|
|
__proto__: BaseTransaction.prototype,
|
|
|
|
doTransaction: function UTUTXN_doTransaction()
|
|
{
|
|
PlacesUtils.tagging.untagURI(this._uri, this._tags);
|
|
},
|
|
|
|
undoTransaction: function UTUTXN_undoTransaction()
|
|
{
|
|
PlacesUtils.tagging.tagURI(this._uri, this._tags);
|
|
}
|
|
};
|