1 // Copyright (c) 2006-2008 by Martin Stubenschrott <stubenschrott@vimperator.org>
2 // Copyright (c) 2007-2011 by Doug Kearns <dougkearns@gmail.com>
3 // Copyright (c) 2008-2011 by Kris Maglione <maglione.k@gmail.com>
5 // This work is licensed for reuse under an MIT license. Details are
6 // given in the LICENSE.txt file included with this file.
9 // also includes methods for dealing with keywords and search engines
10 var Bookmarks = Module("bookmarks", {
12 this.timer = Timer(0, 100, function () {
13 this.checkBookmarked(buffer.uri);
16 storage.addObserver("bookmark-cache", function (key, event, arg) {
17 if (["add", "change", "remove"].indexOf(event) >= 0)
18 autocommands.trigger("Bookmark" + event[0].toUpperCase() + event.substr(1),
21 toString: function () "bookmarkcache.bookmarks[" + arg.id + "]",
22 valueOf: function () arg
25 bookmarks.timer.tell();
30 "browser.locationChange": function (webProgress, request, uri) {
31 statusline.bookmarked = false;
32 this.checkBookmarked(uri);
38 title: ["URL", "Info"],
39 keys: { text: "url", description: "title", icon: "icon", extra: "extra", tags: "tags", isURI: function () true },
40 process: [template.icon, template.bookmarkDescription]
43 // TODO: why is this a filter? --djk
44 get: function get(filter, tags, maxItems, extra) {
45 return completion.runCompleter("bookmark", filter, maxItems, tags, extra);
49 * Adds a new bookmark. The first parameter should be an object with
50 * any of the following properties:
52 * @param {boolean} unfiled If true, the bookmark is added to the
53 * Unfiled Bookmarks Folder.
54 * @param {string} title The title of the new bookmark.
55 * @param {string} url The URL of the new bookmark.
56 * @param {string} keyword The keyword of the new bookmark.
58 * @param {[string]} tags The tags for the new bookmark.
60 * @param {boolean} force If true, a new bookmark is always added.
61 * Otherwise, if a bookmark for the given URL exists it is
64 * @returns {boolean} True if the bookmark was updated, false if a
65 * new bookmark was added.
67 add: function add(unfiled, title, url, keyword, tags, force) {
69 if (isObject(unfiled))
70 var { id, unfiled, title, url, keyword, tags, post, charset, force } = unfiled;
72 let uri = util.createURI(url);
74 var bmark = bookmarkcache.bookmarks[id];
76 if (keyword && Set.has(bookmarkcache.keywords, keyword))
77 bmark = bookmarkcache.keywords[keyword];
78 else if (bookmarkcache.isBookmarked(uri))
79 for (bmark in bookmarkcache)
80 if (bmark.url == uri.spec)
85 PlacesUtils.tagging.untagURI(uri, null);
86 PlacesUtils.tagging.tagURI(uri, tags);
89 let updated = !!bmark;
90 if (bmark == undefined)
91 bmark = bookmarkcache.bookmarks[
92 services.bookmarks.insertBookmark(
93 services.bookmarks[unfiled ? "unfiledBookmarksFolder" : "bookmarksMenuFolder"],
94 uri, -1, title || url)];
98 if (!uri.equals(bmark.uri))
104 if (charset !== undefined)
105 bmark.charset = charset;
106 if (post !== undefined)
109 bmark.keyword = keyword;
115 * Opens the command line in Ex mode pre-filled with a :bmark
116 * command to add a new search keyword for the given form element.
118 * @param {Element} elem A form element for which to add a keyword.
120 addSearchKeyword: function addSearchKeyword(elem) {
121 if (elem instanceof HTMLFormElement || elem.form)
122 var { url, postData, charset } = DOM(elem).formData;
124 var [url, postData, charset] = [elem.href || elem.src, null, elem.ownerDocument.characterSet];
126 let options = { "-title": "Search " + elem.ownerDocument.title };
127 if (postData != null)
128 options["-post"] = postData;
129 if (charset != null && charset !== "UTF-8")
130 options["-charset"] = charset;
132 CommandExMode().open(
133 commands.commandToString({ command: "bmark", options: options, arguments: [url] }) + " -keyword ");
136 checkBookmarked: function checkBookmarked(uri) {
137 if (PlacesUtils.asyncGetBookmarkIds)
138 PlacesUtils.asyncGetBookmarkIds(uri, function (ids) {
139 statusline.bookmarked = ids.length;
142 this.timeout(function () {
143 statusline.bookmarked = bookmarkcache.isBookmarked(uri);
148 * Toggles the bookmarked state of the given URL. If the URL is
149 * bookmarked, all bookmarks for said URL are removed.
150 * If it is not, a new bookmark is added to the Unfiled Bookmarks
151 * Folder. The new bookmark has the title of the current buffer if
152 * its URL is identical to *url*, otherwise its title will be the
155 * @param {string} url The URL of the bookmark to toggle.
157 toggle: function toggle(url) {
161 let count = this.remove(url);
163 dactyl.echomsg({ domains: [util.getHost(url)], message: _("bookmark.removed", url) });
165 let title = buffer.uri.spec == url && buffer.title || url;
168 extra = " (" + title + ")";
170 this.add({ unfiled: true, title: title, url: url });
171 dactyl.echomsg({ domains: [util.getHost(url)], message: _("bookmark.added", url + extra) });
175 isBookmarked: deprecated("bookmarkcache.isBookmarked", { get: function isBookmarked() bookmarkcache.closure.isBookmarked }),
178 * Remove a bookmark or bookmarks. If *ids* is an array, removes the
179 * bookmarks with those IDs. If it is a string, removes all
180 * bookmarks whose URLs match that string.
182 * @param {string|[number]} ids The IDs or URL of the bookmarks to
184 * @returns {number} The number of bookmarks removed.
186 remove: function remove(ids) {
189 let uri = util.newURI(ids);
190 ids = services.bookmarks
191 .getBookmarkIdsForURI(uri, {})
192 .filter(bookmarkcache.closure.isRegularBookmark);
194 ids.forEach(function (id) {
195 let bmark = bookmarkcache.bookmarks[id];
197 PlacesUtils.tagging.untagURI(bmark.uri, null);
198 bmark.charset = null;
200 services.bookmarks.removeItem(id);
205 dactyl.reportError(e, true);
210 getSearchEngines: deprecated("bookmarks.searchEngines", function getSearchEngines() this.searchEngines),
212 * Returns a list of all visible search engines in the search
213 * services, augmented with keyword, title, and icon properties for
214 * use in completion functions.
216 get searchEngines() {
217 let searchEngines = [];
219 return iter(services.browserSearch.getVisibleEngines({})).map(function ([, engine]) {
220 let alias = engine.alias;
221 if (!alias || !/^[a-z0-9-]+$/.test(alias))
222 alias = engine.name.replace(/[^a-z0-9]+/gi, "-").replace(/^-|-$/, "").toLowerCase();
224 alias = "search"; // for search engines which we can't find a suitable alias
226 if (Set.has(aliases, alias))
227 alias += ++aliases[alias];
231 return [alias, { keyword: alias, __proto__: engine, title: engine.description, icon: engine.iconURI && engine.iconURI.spec }];
236 * Retrieves a list of search suggestions from the named search
237 * engine based on the given *query*. The results are always in the
238 * form of an array of strings. If *callback* is provided, the
239 * request is executed asynchronously and *callback* is called on
240 * completion. Otherwise, the request is executed synchronously and
241 * the results are returned.
243 * @param {string} engineName The name of the search engine from
244 * which to request suggestions.
245 * @param {string} query The query string for which to request
247 * @param {function([string])} callback The function to call when
248 * results are returned.
249 * @returns {[string] | null}
251 getSuggestions: function getSuggestions(engineName, query, callback) {
252 const responseType = "application/x-suggestions+json";
254 if (Set.has(this.suggestionProviders, engineName))
255 return this.suggestionProviders[engineName](query, callback);
257 let engine = Set.has(this.searchEngines, engineName) && this.searchEngines[engineName];
258 if (engine && engine.supportsResponseType(responseType))
259 var queryURI = engine.getSubmission(query, responseType).uri.spec;
261 return (callback || util.identity)([]);
263 function parse(req) JSON.parse(req.responseText)[1].filter(isString);
264 return this.makeSuggestions(queryURI, parse, callback);
268 * Given a query URL, response parser, and optionally a callback,
269 * fetch and parse search query results for {@link getSuggestions}.
271 * @param {string} url The URL to fetch.
272 * @param {function(XMLHttpRequest):[string]} parser The function which
273 * parses the response.
275 makeSuggestions: function makeSuggestions(url, parser, callback) {
276 function process(req) {
279 results = parser(req);
285 return callback(results);
289 let req = util.httpGet(url, callback && process);
295 suggestionProviders: {},
298 * Returns an array containing a search URL and POST data for the
299 * given search string. If *useDefsearch* is true, the string is
300 * always passed to the default search engine. If it is not, the
301 * search engine name is retrieved from the first space-separated
302 * token of the given string.
304 * Returns null if no search engine is found for the passed string.
306 * @param {string} text The text for which to retrieve a search URL.
307 * @param {boolean} useDefsearch Whether to use the default search
309 * @returns {[string, string | null] | null}
311 getSearchURL: function getSearchURL(text, useDefsearch) {
312 let query = (useDefsearch ? options["defsearch"] + " " : "") + text;
314 // ripped from Firefox
317 var offset = query.indexOf(" ");
319 keyword = query.substr(0, offset);
320 param = query.substr(offset + 1);
323 var engine = Set.has(bookmarks.searchEngines, keyword) && bookmarks.searchEngines[keyword];
325 if (engine.searchForm && !param)
326 return engine.searchForm;
327 let submission = engine.getSubmission(param, null);
328 return [submission.uri.spec, submission.postData];
331 let [url, postData] = PlacesUtils.getURLAndPostDataForKeyword(keyword);
335 let data = window.unescape(postData || "");
336 if (/%s/i.test(url) || /%s/i.test(data)) {
338 var matches = url.match(/^(.*)\&mozcharset=([a-zA-Z][_\-a-zA-Z0-9]+)\s*$/);
340 [, url, charset] = matches;
343 charset = services.history.getCharsetForURI(util.newURI(url));
348 var encodedParam = escape(window.convertFromUnicode(charset, param));
350 encodedParam = bookmarkcache.keywords[keyword].encodeURIComponent(param);
352 url = url.replace(/%s/g, encodedParam).replace(/%S/g, param);
353 if (/%s/i.test(data))
354 postData = window.getPostDataStream(data, param, encodedParam, "application/x-www-form-urlencoded");
360 return [url, postData];
365 * Lists all bookmarks whose URLs match *filter*, tags match *tags*,
366 * and other properties match the properties of *extra*. If
367 * *openItems* is true, the items are opened in tabs rather than
370 * @param {string} filter A URL filter string which the URLs of all
371 * matched items must contain.
372 * @param {[string]} tags An array of tags each of which all matched
373 * items must contain.
374 * @param {boolean} openItems If true, items are opened rather than
376 * @param {object} extra Extra properties which must be matched.
378 list: function list(filter, tags, openItems, maxItems, extra) {
379 // FIXME: returning here doesn't make sense
380 // Why the hell doesn't it make sense? --Kris
381 // Because it unconditionally bypasses the final error message
382 // block and does so only when listing items, not opening them. In
383 // short it breaks the :bmarks command which doesn't make much
384 // sense to me but I'm old-fashioned. --djk
386 return completion.listCompleter("bookmark", filter, maxItems, tags, extra);
387 let items = completion.runCompleter("bookmark", filter, maxItems, tags, extra);
390 return dactyl.open(items.map(function (i) i.url), dactyl.NEW_TAB);
392 if (filter.length > 0 && tags.length > 0)
393 dactyl.echoerr(_("bookmark.noMatching", tags.map(String.quote), filter.quote()));
394 else if (filter.length > 0)
395 dactyl.echoerr(_("bookmark.noMatchingString", filter.quote()));
396 else if (tags.length > 0)
397 dactyl.echoerr(_("bookmark.noMatchingTags", tags.map(String.quote)));
399 dactyl.echoerr(_("bookmark.none"));
404 commands: function () {
405 // TODO: Clean this up.
407 names: ["-tags", "-T"],
408 description: "A comma-separated list of tags",
409 completer: function tags(context, args) {
410 context.generate = function () array(b.tags for (b in bookmarkcache) if (b.tags)).flatten().uniq().array;
411 context.keys = { text: util.identity, description: util.identity };
413 type: CommandOption.LIST
417 names: ["-title", "-t"],
418 description: "Bookmark page title or description",
419 completer: function title(context, args) {
420 let frames = buffer.allFrames();
423 [win.document.title, frames.length == 1 ? /*L*/"Current Location" : /*L*/"Frame: " + win.location.href]
424 for ([, win] in Iterator(frames))];
425 context.keys.text = "title";
426 context.keys.description = "url";
427 return bookmarks.get(args.join(" "), args["-tags"], null, { keyword: args["-keyword"], title: context.filter });
429 type: CommandOption.STRING
433 names: ["-post", "-p"],
434 description: "Bookmark POST data",
435 completer: function post(context, args) {
436 context.keys.text = "post";
437 context.keys.description = "url";
438 return bookmarks.get(args.join(" "), args["-tags"], null, { keyword: args["-keyword"], post: context.filter });
440 type: CommandOption.STRING
444 names: ["-keyword", "-k"],
445 description: "Keyword by which this bookmark may be opened (:open {keyword})",
446 completer: function keyword(context, args) {
447 context.keys.text = "keyword";
448 return bookmarks.get(args.join(" "), args["-tags"], null, { keyword: context.filter, title: args["-title"] });
450 type: CommandOption.STRING,
451 validator: bind("test", /^\S+$/)
454 commands.add(["bma[rk]"],
457 dactyl.assert(!args.bang || args["-id"] == null,
458 _("bookmark.bangOrID"));
464 keyword: args["-keyword"] || null,
465 charset: args["-charset"],
467 tags: args["-tags"] || [],
468 title: args["-title"] || (args.length === 0 ? buffer.title : null),
469 url: args.length === 0 ? buffer.uri.spec : args[0]
472 let updated = bookmarks.add(opts);
473 let action = updated ? "updated" : "added";
475 let extra = (opts.title == opts.url) ? "" : " (" + opts.title + ")";
477 dactyl.echomsg({ domains: [util.getHost(opts.url)], message: _("bookmark." + action, opts.url + extra) },
478 1, commandline.FORCE_SINGLELINE);
482 completer: function (context, args) {
484 context.title = ["Page URL"];
485 let frames = buffer.allFrames();
486 context.completions = [
487 [win.document.documentURI, frames.length == 1 ? /*L*/"Current Location" : /*L*/"Frame: " + win.document.title]
488 for ([, win] in Iterator(frames))];
491 completion.bookmark(context, args["-tags"], { keyword: args["-keyword"], title: args["-title"] });
493 options: [keyword, title, tags, post,
495 names: ["-charset", "-c"],
496 description: "The character encoding of the bookmark",
497 type: CommandOption.STRING,
498 completer: function (context) completion.charset(context),
499 validator: Option.validateCompleter
503 description: "The ID of the bookmark to update",
504 type: CommandOption.INT
509 commands.add(["bmarks"],
510 "List or open multiple bookmarks",
512 bookmarks.list(args.join(" "), args["-tags"] || [], args.bang, args["-max"],
513 { keyword: args["-keyword"], title: args["-title"] });
517 completer: function completer(context, args) {
518 context.filter = args.join(" ");
519 completion.bookmark(context, args["-tags"], { keyword: args["-keyword"], title: args["-title"] });
521 options: [tags, keyword, title,
523 names: ["-max", "-m"],
524 description: "The maximum number of items to list or open",
525 type: CommandOption.INT
528 // Not privateData, since we don't treat bookmarks as private
531 commands.add(["delbm[arks]"],
535 commandline.input(_("bookmark.prompt.deleteAll") + " ",
537 if (resp && resp.match(/^y(es)?$/i)) {
538 bookmarks.remove(Object.keys(bookmarkcache.bookmarks));
539 dactyl.echomsg(_("bookmark.allDeleted"));
543 if (!(args.length || args["-tags"] || args["-keyword"] || args["-title"]))
544 var deletedCount = bookmarks.remove(buffer.uri.spec);
546 let context = CompletionContext(args.join(" "));
547 context.fork("bookmark", 0, completion, "bookmark",
548 args["-tags"], { keyword: args["-keyword"], title: args["-title"] });
549 deletedCount = bookmarks.remove(context.allItems.items.map(function (item) item.item.id));
552 dactyl.echomsg({ message: _("bookmark.deleted", deletedCount) });
559 completer: function completer(context, args)
560 completion.bookmark(context, args["-tags"], { keyword: args["-keyword"], title: args["-title"] }),
561 domains: function (args) array.compact(args.map(util.getHost)),
563 options: [tags, title, keyword],
567 mappings: function () {
568 var myModes = config.browserModes;
570 mappings.add(myModes, ["a"],
571 "Open a prompt to bookmark the current URL",
575 let url = buffer.uri.spec;
576 let bmarks = bookmarks.get(url).filter(function (bmark) bmark.url == url);
578 if (bmarks.length == 1) {
579 let bmark = bmarks[0];
581 options["-id"] = bmark.id;
582 options["-title"] = bmark.title;
584 options["-charset"] = bmark.charset;
586 options["-keyword"] = bmark.keyword;
588 options["-post"] = bmark.post;
589 if (bmark.tags.length > 0)
590 options["-tags"] = bmark.tags;
593 if (buffer.title != buffer.uri.spec)
594 options["-title"] = buffer.title;
595 if (content.document.characterSet !== "UTF-8")
596 options["-charset"] = content.document.characterSet;
599 CommandExMode().open(
600 commands.commandToString({ command: "bmark", options: options, arguments: [buffer.uri.spec] }));
603 mappings.add(myModes, ["A"],
604 "Toggle bookmarked state of current URL",
605 function () { bookmarks.toggle(buffer.uri.spec); });
607 options: function () {
608 options.add(["defsearch", "ds"],
609 "The default search engine",
612 completer: function completer(context) {
613 completion.search(context, true);
614 context.completions = [{ keyword: "", title: "Don't perform searches by default" }].concat(context.completions);
618 options.add(["suggestengines"],
619 "Search engines used for search suggestions",
620 "stringlist", "google",
621 { completer: function completer(context) completion.searchEngine(context, true), });
624 completion: function () {
625 completion.bookmark = function bookmark(context, tags, extra) {
626 context.title = ["Bookmark", "Title"];
627 context.format = bookmarks.format;
628 iter(extra || {}).forEach(function ([k, v]) {
630 context.filters.push(function (item) item.item[k] != null && this.matchString(v, item.item[k]));
632 context.generate = function () values(bookmarkcache.bookmarks);
633 completion.urls(context, tags);
636 completion.search = function search(context, noSuggest) {
637 let [, keyword, space, args] = context.filter.match(/^\s*(\S*)(\s*)(.*)$/);
638 let keywords = bookmarkcache.keywords;
639 let engines = bookmarks.searchEngines;
641 context.title = ["Search Keywords"];
642 context.completions = iter(values(keywords), values(engines));
643 context.keys = { text: "keyword", description: "title", icon: "icon" };
645 if (!space || noSuggest)
648 context.fork("suggest", keyword.length + space.length, this, "searchEngineSuggest",
651 let item = keywords[keyword];
652 if (item && item.url.indexOf("%s") > -1)
653 context.fork("keyword/" + keyword, keyword.length + space.length, null, function (context) {
654 context.format = history.format;
655 context.title = [/*L*/keyword + " Quick Search"];
656 context.keys = { text: "url", description: "title", icon: "icon" };
657 // context.background = true;
658 context.compare = CompletionContext.Sort.unsorted;
659 context.generate = function () {
660 let [begin, end] = item.url.split("%s");
662 return history.get({ uri: util.newURI(begin), uriIsPrefix: true }).map(function (item) {
663 let rest = item.url.length - end.length;
664 let query = item.url.substring(begin.length, rest);
665 if (item.url.substr(rest) == end && query.indexOf("&") == -1)
667 item.url = decodeURIComponent(query.replace(/#.*/, "").replace(/\+/g, " "));
672 }).filter(util.identity);
677 completion.searchEngine = function searchEngine(context, suggest) {
678 context.title = ["Suggest Engine", "Description"];
679 context.keys = { text: "keyword", description: "title", icon: "icon" };
680 context.completions = values(bookmarks.searchEngines);
682 context.filters.push(function ({ item }) item.supportsResponseType("application/x-suggestions+json"));
686 completion.searchEngineSuggest = function searchEngineSuggest(context, engineAliases, kludge) {
690 let engineList = (engineAliases || options["suggestengines"].join(",") || "google").split(",");
692 engineList.forEach(function (name) {
694 let engine = bookmarks.searchEngines[name];
696 var desc = engine.description;
697 else if (!Set.has(bookmarks.suggestionProviders, name))
700 let [, word] = /^\s*(\S+)/.exec(context.filter) || [];
701 if (!kludge && word == name) // FIXME: Check for matching keywords
703 let ctxt = context.fork(name, 0);
705 ctxt.title = [/*L*/desc + " Suggestions"];
706 ctxt.keys = { text: util.identity, description: function () "" };
707 ctxt.compare = CompletionContext.Sort.unsorted;
708 ctxt.filterFunc = null;
710 let words = ctxt.filter.toLowerCase().split(/\s+/g);
711 ctxt.completions = ctxt.completions.filter(function (i) words.every(function (w) i.toLowerCase().indexOf(w) >= 0));
713 ctxt.hasItems = ctxt.completions.length;
714 ctxt.incomplete = true;
715 ctxt.cache.request = bookmarks.getSuggestions(name, ctxt.filter, function (compl) {
716 ctxt.incomplete = false;
717 ctxt.completions = array.uniq(ctxt.completions.filter(function (c) compl.indexOf(c) >= 0)
718 .concat(compl), true);
723 completion.addUrlCompleter("suggestion", "Search engine suggestions", completion.searchEngineSuggest);
724 completion.addUrlCompleter("bookmark", "Bookmarks", completion.bookmark);
725 completion.addUrlCompleter("search", "Search engines and keyword URLs", completion.search);
729 // vim: set fdm=marker sw=4 ts=4 et: