path: root/common/modules/bookmarkcache.jsm

// Copyright ©2008-2015 Kris Maglione <maglione.k at Gmail>
//
// This work is licensed for reuse under an MIT license. Details are
// given in the LICENSE.txt file included with this file.
"use strict";

defineModule("bookmarkcache", {
    exports: ["Bookmark", "BookmarkCache", "Keyword", "bookmarkcache"],
    require: ["services", "util"]
});

this.lazyRequire("storage", ["storage"]);

function newURI(url, charset, base) {
    try {
        return services.io.newURI(url, charset, base);
    }
    catch (e) {
        throw Error(e);
    }
}

var Bookmark = Struct("url", "title", "icon", "post", "keyword", "tags", "charset", "id");
var Keyword = Struct("keyword", "title", "icon", "url");
Bookmark.defaultValue("icon", function () BookmarkCache.getFavicon(this.url));
update(Bookmark.prototype, {
    get extra() [
        ["keyword", this.keyword,         "Keyword"],
        ["tags",    this.tags.join(", "), "Tag"]
    ].filter(item => item[1]),

    get uri() newURI(this.url),
    set uri(uri) {
        let tags = this.tags;
        this.tags = null;
        services.bookmarks.changeBookmarkURI(this.id, uri);
        this.tags = tags;
    },

    encodeURIComponent: function _encodeURIComponent(str) {
        if (!this.charset || this.charset === "UTF-8")
            return encodeURIComponent(str);
        let conv = services.CharsetConv(this.charset);
        return escape(conv.ConvertFromUnicode(str) + conv.Finish()).replace(/\+/g, encodeURIComponent);
    },

    get folder() {
        let res = [];
        res.toString = function () this.join("/");

        let id = this.id, title;
        while ((id    = services.bookmarks.getFolderIdForItem(id)) &&
               (title = services.bookmarks.getItemTitle(id)))
            res.push(title);

        return res.reverse();
    }
})
Bookmark.prototype.members.uri = Bookmark.prototype.members.url;
Bookmark.setter = function (key, func) this.prototype.__defineSetter__(key, func);
Bookmark.setter("url", function (val) { this.uri = isString(val) ? newURI(val) : val; });
Bookmark.setter("title", function (val) { services.bookmarks.setItemTitle(this.id, val); });
Bookmark.setter("post", function (val) { bookmarkcache.annotate(this.id, bookmarkcache.POST, val); });
Bookmark.setter("charset", function (val) { bookmarkcache.annotate(this.id, bookmarkcache.CHARSET, val); });
Bookmark.setter("keyword", function (val) { services.bookmarks.setKeywordForBookmark(this.id, val); });
Bookmark.setter("tags", function (val) {
    services.tagging.untagURI(this.uri, null);
    if (val)
        services.tagging.tagURI(this.uri, val);
});

var name = "bookmark-cache";

var BookmarkCache = Module("BookmarkCache", XPCOM(Ci.nsINavBookmarkObserver), {
    POST: "bookmarkProperties/POSTData",
    CHARSET: "dactyl/charset",

    init: function init() {
        services.bookmarks.addObserver(this, false);
    },

    cleanup: function cleanup() {
        services.bookmarks.removeObserver(this);
    },

    "@@iterator": function () values(bookmarkcache.bookmarks),

    bookmarks: Class.Memoize(function () this.load()),

    keywords: Class.Memoize(function () Ary.toObject([[b.keyword, b]
                                                      for (b of this)
                                                      if (b.keyword)])),

    rootFolders: ["toolbarFolder", "bookmarksMenuFolder", "unfiledBookmarksFolder"]
        .map(s => services.bookmarks[s]),

    _deleteBookmark: function deleteBookmark(id) {
        let result = this.bookmarks[id] || null;
        delete this.bookmarks[id];
        return result;
    },

    _loadBookmark: function loadBookmark(node) {
        if (node.uri == null) // How does this happen?
            return false;

        let uri = newURI(node.uri);
        let keyword = services.bookmarks.getKeywordForBookmark(node.itemId);

        let tags = "tags" in node ? (node.tags ? node.tags.split(/, /g) : [])
                                  : services.tagging.getTagsForURI(uri, {}) || [];

        let post = BookmarkCache.getAnnotation(node.itemId, this.POST);
        let charset = BookmarkCache.getAnnotation(node.itemId, this.CHARSET);
        return Bookmark(node.uri, node.title, node.icon && node.icon.spec, post, keyword, tags, charset, node.itemId);
    },

    annotate: function (id, key, val, timespan) {
        if (val)
            services.annotation.setItemAnnotation(id, key, val, 0,
                                                  timespan || services.annotation.EXPIRE_NEVER);
        else if (services.annotation.itemHasAnnotation(id, key))
            services.annotation.removeItemAnnotation(id, key);
    },

    get: function (url) {
        let ids = services.bookmarks.getBookmarkIdsForURI(newURI(url), {});
        for (let id of values(ids))
            if (id in this.bookmarks)
                return this.bookmarks[id];
        return null;
    },

    readBookmark: function readBookmark(id) ({
        itemId: id,
        uri:    services.bookmarks.getBookmarkURI(id).spec,
        title:  services.bookmarks.getItemTitle(id)
    }),

    findRoot: function findRoot(id) {
        do {
            var root = id;
            id = services.bookmarks.getFolderIdForItem(id);
        } while (id != services.bookmarks.placesRoot && id != root);
        return root;
    },

    isBookmark: function (id) this.rootFolders.indexOf(this.findRoot(id)) >= 0,

    /**
     * Returns true if the given URL is bookmarked and that bookmark is
     * not a Live Bookmark.
     *
     * @param {nsIURI|string} url The URL of which to check the bookmarked
     *     state.
     * @returns {boolean}
     */
    isBookmarked: function isBookmarked(uri) {
        if (isString(uri))
            uri = newURI(uri);

        try {
            return services.bookmarks
                           .getBookmarkIdsForURI(uri, {})
                           .some(this.bound.isRegularBookmark);
        }
        catch (e) {
            return false;
        }
    },

    isRegularBookmark: function isRegularBookmark(id) {
        do {
            var root = id;
            if (services.livemark && services.livemark.isLivemark(id))
                return false;
            id = services.bookmarks.getFolderIdForItem(id);
        } while (id != services.bookmarks.placesRoot && id != root);
        return this.rootFolders.indexOf(root) >= 0;
    },

    load: function load() {
        let bookmarks = {};

        let query = services.history.getNewQuery();
        let options = services.history.getNewQueryOptions();
        options.queryType = options.QUERY_TYPE_BOOKMARKS;
        try {
            // https://bugzil.la/702639
            options.excludeItemIfParentHasAnnotation = "livemark/feedURI";
        }
        catch (e) {}

        let { root } = services.history.executeQuery(query, options);
        root.containerOpen = true;
        try {
            // iterate over the immediate children of this folder
            for (let i = 0; i < root.childCount; i++) {
                let node = root.getChild(i);
                if (node.type == node.RESULT_TYPE_URI) // bookmark
                    bookmarks[node.itemId] = this._loadBookmark(node);
            }
        }
        finally {
            root.containerOpen = false;
        }

        return bookmarks;
    },

    onItemAdded: function onItemAdded(itemId, folder, index) {
        if (services.bookmarks.getItemType(itemId) == services.bookmarks.TYPE_BOOKMARK) {
            if (this.isBookmark(itemId)) {
                let bmark = this._loadBookmark(this.readBookmark(itemId));
                this.bookmarks[bmark.id] = bmark;
                storage.fireEvent(name, "add", bmark);
                delete this.keywords;
            }
        }
    },
    onItemRemoved: function onItemRemoved(itemId, folder, index) {
        let result = this._deleteBookmark(itemId);
        delete this.keywords;
        if (result)
            storage.fireEvent(name, "remove", result);
    },
    onItemChanged: function onItemChanged(itemId, property, isAnnotation, value) {
        if (isAnnotation)
            if (property === this.POST)
                [property, value] = ["post", BookmarkCache.getAnnotation(itemId, property)];
            else if (property === this.CHARSET)
                [property, value] = ["charset", BookmarkCache.getAnnotation(itemId, property)];
            else
                return;

        let bookmark = this.bookmarks[itemId];
        if (bookmark) {
            if (property == "keyword")
                delete this.keywords;
            if (property == "tags")
                value = services.tagging.getTagsForURI(bookmark.uri, {});
            if (property in bookmark) {
                bookmark[bookmark.members[property]] = value;
                storage.fireEvent(name, "change", { __proto__: bookmark, changed: property });
            }
        }
    }
}, {
    DEFAULT_FAVICON: "chrome://mozapps/skin/places/defaultFavicon.png",

    getAnnotation: function getAnnotation(item, anno)
        services.annotation.itemHasAnnotation(item, anno) ?
        services.annotation.getItemAnnotation(item, anno) : null,

    getFavicon: function getFavicon(uri) {
        try {
            return services.favicon.getFaviconImageForPage(newURI(uri)).spec;
        }
        catch (e) {
            return "";
        }
    }
});

endModule();

// vim: set fdm=marker sw=4 sts=4 ts=8 et ft=javascript: