common/content/bookmarks.js

   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>
   4 //
   5 // This work is licensed for reuse under an MIT license. Details are
   6 // given in the LICENSE.txt file included with this file.
   7 /* use strict */
   8
   9 // also includes methods for dealing with keywords and search engines
  10 var Bookmarks = Module("bookmarks", {
  11     init: function () {
  12         this.timer = Timer(0, 100, function () {
  13             this.checkBookmarked(buffer.uri);
  14         }, this);
  15
  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),
  19                      iter({
  20                          bookmark: {
  21                              toString: function () "bookmarkcache.bookmarks[" + arg.id + "]",
  22                              valueOf: function () arg
  23                          }
  24                      }, arg));
  25             bookmarks.timer.tell();
  26         }, window);
  27     },
  28
  29     signals: {
  30         "browser.locationChange": function (webProgress, request, uri) {
  31             statusline.bookmarked = false;
  32             this.checkBookmarked(uri);
  33         }
  34     },
  35
  36     get format() ({
  37         anchored: false,
  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]
  41     }),
  42
  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);
  46     },
  47
  48     /**
  49      * Adds a new bookmark. The first parameter should be an object with
  50      * any of the following properties:
  51      *
  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.
  57      *      @optional
  58      * @param {[string]} tags The tags for the new bookmark.
  59      *      @optional
  60      * @param {boolean} force If true, a new bookmark is always added.
  61      *      Otherwise, if a bookmark for the given URL exists it is
  62      *      updated instead.
  63      *      @optional
  64      * @returns {boolean} True if the bookmark was updated, false if a
  65      *      new bookmark was added.
  66      */
  67     add: function add(unfiled, title, url, keyword, tags, force) {
  68         // FIXME
  69         if (isObject(unfiled))
  70             var { id, unfiled, title, url, keyword, tags, post, charset, force } = unfiled;
  71
  72         let uri = util.createURI(url);
  73         if (id != null)
  74             var bmark = bookmarkcache.bookmarks[id];
  75         else if (!force) {
  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)
  81                         break;
  82         }
  83
  84         if (tags) {
  85             PlacesUtils.tagging.untagURI(uri, null);
  86             PlacesUtils.tagging.tagURI(uri, tags);
  87         }
  88
  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)];
  95         else {
  96             if (title)
  97                 bmark.title = title;
  98             if (!uri.equals(bmark.uri))
  99                 bmark.uri = uri;
 100         }
 101
 102         util.assert(bmark);
 103
 104         if (charset !== undefined)
 105             bmark.charset = charset;
 106         if (post !== undefined)
 107             bmark.post = post;
 108         if (keyword)
 109             bmark.keyword = keyword;
 110
 111         return updated;
 112     },
 113
 114     /**
 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.
 117      *
 118      * @param {Element} elem A form element for which to add a keyword.
 119      */
 120     addSearchKeyword: function addSearchKeyword(elem) {
 121         if (elem instanceof HTMLFormElement || elem.form)
 122             var { url, postData, charset } = DOM(elem).formData;
 123         else
 124             var [url, postData, charset] = [elem.href || elem.src, null, elem.ownerDocument.characterSet];
 125
 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;
 131
 132         CommandExMode().open(
 133             commands.commandToString({ command: "bmark", options: options, arguments: [url] }) + " -keyword ");
 134     },
 135
 136     checkBookmarked: function checkBookmarked(uri) {
 137         if (PlacesUtils.asyncGetBookmarkIds)
 138             PlacesUtils.asyncGetBookmarkIds(uri, function (ids) {
 139                 statusline.bookmarked = ids.length;
 140             });
 141         else
 142             this.timeout(function () {
 143                 statusline.bookmarked = bookmarkcache.isBookmarked(uri);
 144             });
 145     },
 146
 147     /**
 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
 153      * value of *url*.
 154      *
 155      * @param {string} url The URL of the bookmark to toggle.
 156      */
 157     toggle: function toggle(url) {
 158         if (!url)
 159             return;
 160
 161         let count = this.remove(url);
 162         if (count > 0)
 163             dactyl.echomsg({ domains: [util.getHost(url)], message: _("bookmark.removed", url) });
 164         else {
 165             let title = buffer.uri.spec == url && buffer.title || url;
 166             let extra = "";
 167             if (title != url)
 168                 extra = " (" + title + ")";
 169
 170             this.add({ unfiled: true, title: title, url: url });
 171             dactyl.echomsg({ domains: [util.getHost(url)], message: _("bookmark.added", url + extra) });
 172         }
 173     },
 174
 175     isBookmarked: deprecated("bookmarkcache.isBookmarked", { get: function isBookmarked() bookmarkcache.closure.isBookmarked }),
 176
 177     /**
 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.
 181      *
 182      * @param {string|[number]} ids The IDs or URL of the bookmarks to
 183      *      remove.
 184      * @returns {number} The number of bookmarks removed.
 185      */
 186     remove: function remove(ids) {
 187         try {
 188             if (!isArray(ids)) {
 189                 let uri = util.newURI(ids);
 190                 ids = services.bookmarks
 191                               .getBookmarkIdsForURI(uri, {})
 192                               .filter(bookmarkcache.closure.isRegularBookmark);
 193             }
 194             ids.forEach(function (id) {
 195                 let bmark = bookmarkcache.bookmarks[id];
 196                 if (bmark) {
 197                     PlacesUtils.tagging.untagURI(bmark.uri, null);
 198                     bmark.charset = null;
 199                 }
 200                 services.bookmarks.removeItem(id);
 201             });
 202             return ids.length;
 203         }
 204         catch (e) {
 205             dactyl.reportError(e, true);
 206             return 0;
 207         }
 208     },
 209
 210     getSearchEngines: deprecated("bookmarks.searchEngines", function getSearchEngines() this.searchEngines),
 211     /**
 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.
 215      */
 216     get searchEngines() {
 217         let searchEngines = [];
 218         let aliases = {};
 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();
 223             if (!alias)
 224                 alias = "search"; // for search engines which we can't find a suitable alias
 225
 226             if (Set.has(aliases, alias))
 227                 alias += ++aliases[alias];
 228             else
 229                 aliases[alias] = 0;
 230
 231             return [alias, { keyword: alias, __proto__: engine, title: engine.description, icon: engine.iconURI && engine.iconURI.spec }];
 232         }).toObject();
 233     },
 234
 235     /**
 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.
 242      *
 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
 246      *      suggestions.
 247      * @param {function([string])} callback The function to call when
 248      *      results are returned.
 249      * @returns {[string] | null}
 250      */
 251     getSuggestions: function getSuggestions(engineName, query, callback) {
 252         const responseType = "application/x-suggestions+json";
 253
 254         if (Set.has(this.suggestionProviders, engineName))
 255             return this.suggestionProviders[engineName](query, callback);
 256
 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;
 260         if (!queryURI)
 261             return (callback || util.identity)([]);
 262
 263         function parse(req) JSON.parse(req.responseText)[1].filter(isString);
 264         return this.makeSuggestions(queryURI, parse, callback);
 265     },
 266
 267     /**
 268      * Given a query URL, response parser, and optionally a callback,
 269      * fetch and parse search query results for {@link getSuggestions}.
 270      *
 271      * @param {string} url The URL to fetch.
 272      * @param {function(XMLHttpRequest):[string]} parser The function which
 273      *      parses the response.
 274      */
 275     makeSuggestions: function makeSuggestions(url, parser, callback) {
 276         function process(req) {
 277             let results = [];
 278             try {
 279                 results = parser(req);
 280             }
 281             catch (e) {
 282                 util.reportError(e);
 283             }
 284             if (callback)
 285                 return callback(results);
 286             return results;
 287         }
 288
 289         let req = util.httpGet(url, callback && process);
 290         if (callback)
 291             return req;
 292         return process(req);
 293     },
 294
 295     suggestionProviders: {},
 296
 297     /**
 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.
 303      *
 304      * Returns null if no search engine is found for the passed string.
 305      *
 306      * @param {string} text The text for which to retrieve a search URL.
 307      * @param {boolean} useDefsearch Whether to use the default search
 308      *      engine.
 309      * @returns {[string, string | null] | null}
 310      */
 311     getSearchURL: function getSearchURL(text, useDefsearch) {
 312         let query = (useDefsearch ? options["defsearch"] + " " : "") + text;
 313
 314         // ripped from Firefox
 315         var keyword = query;
 316         var param = "";
 317         var offset = query.indexOf(" ");
 318         if (offset > 0) {
 319             keyword = query.substr(0, offset);
 320             param = query.substr(offset + 1);
 321         }
 322
 323         var engine = Set.has(bookmarks.searchEngines, keyword) && bookmarks.searchEngines[keyword];
 324         if (engine) {
 325             if (engine.searchForm && !param)
 326                 return engine.searchForm;
 327             let submission = engine.getSubmission(param, null);
 328             return [submission.uri.spec, submission.postData];
 329         }
 330
 331         let [url, postData] = PlacesUtils.getURLAndPostDataForKeyword(keyword);
 332         if (!url)
 333             return null;
 334
 335         let data = window.unescape(postData || "");
 336         if (/%s/i.test(url) || /%s/i.test(data)) {
 337             var charset = "";
 338             var matches = url.match(/^(.*)\&mozcharset=([a-zA-Z][_\-a-zA-Z0-9]+)\s*$/);
 339             if (matches)
 340                 [, url, charset] = matches;
 341             else
 342                 try {
 343                     charset = services.history.getCharsetForURI(util.newURI(url));
 344                 }
 345                 catch (e) {}
 346
 347             if (charset)
 348                 var encodedParam = escape(window.convertFromUnicode(charset, param));
 349             else
 350                 encodedParam = bookmarkcache.keywords[keyword].encodeURIComponent(param);
 351
 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");
 355         }
 356         else if (param)
 357             postData = null;
 358
 359         if (postData)
 360             return [url, postData];
 361         return url;
 362     },
 363
 364     /**
 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
 368      * listed.
 369      *
 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
 375      *      listed.
 376      * @param {object} extra Extra properties which must be matched.
 377      */
 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
 385         if (!openItems)
 386             return completion.listCompleter("bookmark", filter, maxItems, tags, extra);
 387         let items = completion.runCompleter("bookmark", filter, maxItems, tags, extra);
 388
 389         if (items.length)
 390             return dactyl.open(items.map(function (i) i.url), dactyl.NEW_TAB);
 391
 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)));
 398         else
 399             dactyl.echoerr(_("bookmark.none"));
 400         return null;
 401     }
 402 }, {
 403 }, {
 404     commands: function () {
 405         // TODO: Clean this up.
 406         const tags = {
 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 };
 412             },
 413             type: CommandOption.LIST
 414         };
 415
 416         const title = {
 417             names: ["-title", "-t"],
 418             description: "Bookmark page title or description",
 419             completer: function title(context, args) {
 420                 let frames = buffer.allFrames();
 421                 if (!args.bang)
 422                     return [
 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 });
 428             },
 429             type: CommandOption.STRING
 430         };
 431
 432         const post = {
 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 });
 439             },
 440             type: CommandOption.STRING
 441         };
 442
 443         const keyword = {
 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"] });
 449             },
 450             type: CommandOption.STRING,
 451             validator: bind("test", /^\S+$/)
 452         };
 453
 454         commands.add(["bma[rk]"],
 455             "Add a bookmark",
 456             function (args) {
 457                 dactyl.assert(!args.bang || args["-id"] == null,
 458                               _("bookmark.bangOrID"));
 459
 460                 let opts = {
 461                     force: args.bang,
 462                     unfiled: false,
 463                     id: args["-id"],
 464                     keyword: args["-keyword"] || null,
 465                     charset: args["-charset"],
 466                     post: args["-post"],
 467                     tags: args["-tags"] || [],
 468                     title: args["-title"] || (args.length === 0 ? buffer.title : null),
 469                     url: args.length === 0 ? buffer.uri.spec : args[0]
 470                 };
 471
 472                 let updated = bookmarks.add(opts);
 473                 let action  = updated ? "updated" : "added";
 474
 475                 let extra   = (opts.title == opts.url) ? "" : " (" + opts.title + ")";
 476
 477                 dactyl.echomsg({ domains: [util.getHost(opts.url)], message: _("bookmark." + action, opts.url + extra) },
 478                                1, commandline.FORCE_SINGLELINE);
 479             }, {
 480                 argCount: "?",
 481                 bang: true,
 482                 completer: function (context, args) {
 483                     if (!args.bang) {
 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))];
 489                         return;
 490                     }
 491                     completion.bookmark(context, args["-tags"], { keyword: args["-keyword"], title: args["-title"] });
 492                 },
 493                 options: [keyword, title, tags, post,
 494                     {
 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
 500                     },
 501                     {
 502                         names: ["-id"],
 503                         description: "The ID of the bookmark to update",
 504                         type: CommandOption.INT
 505                     }
 506                 ]
 507             });
 508
 509         commands.add(["bmarks"],
 510             "List or open multiple bookmarks",
 511             function (args) {
 512                 bookmarks.list(args.join(" "), args["-tags"] || [], args.bang, args["-max"],
 513                                { keyword: args["-keyword"], title: args["-title"] });
 514             },
 515             {
 516                 bang: true,
 517                 completer: function completer(context, args) {
 518                     context.filter = args.join(" ");
 519                     completion.bookmark(context, args["-tags"], { keyword: args["-keyword"], title: args["-title"] });
 520                 },
 521                 options: [tags, keyword, title,
 522                     {
 523                         names: ["-max", "-m"],
 524                         description: "The maximum number of items to list or open",
 525                         type: CommandOption.INT
 526                     }
 527                 ]
 528                 // Not privateData, since we don't treat bookmarks as private
 529             });
 530
 531         commands.add(["delbm[arks]"],
 532             "Delete a bookmark",
 533             function (args) {
 534                 if (args.bang)
 535                     commandline.input(_("bookmark.prompt.deleteAll") + " ",
 536                         function (resp) {
 537                             if (resp && resp.match(/^y(es)?$/i)) {
 538                                 bookmarks.remove(Object.keys(bookmarkcache.bookmarks));
 539                                 dactyl.echomsg(_("bookmark.allDeleted"));
 540                             }
 541                         });
 542                 else {
 543                     if (!(args.length || args["-tags"] || args["-keyword"] || args["-title"]))
 544                         var deletedCount = bookmarks.remove(buffer.uri.spec);
 545                     else {
 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));
 550                     }
 551
 552                     dactyl.echomsg({ message: _("bookmark.deleted", deletedCount) });
 553                 }
 554
 555             },
 556             {
 557                 argCount: "?",
 558                 bang: true,
 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)),
 562                 literal: 0,
 563                 options: [tags, title, keyword],
 564                 privateData: true
 565             });
 566     },
 567     mappings: function () {
 568         var myModes = config.browserModes;
 569
 570         mappings.add(myModes, ["a"],
 571             "Open a prompt to bookmark the current URL",
 572             function () {
 573                 let options = {};
 574
 575                 let url = buffer.uri.spec;
 576                 let bmarks = bookmarks.get(url).filter(function (bmark) bmark.url == url);
 577
 578                 if (bmarks.length == 1) {
 579                     let bmark = bmarks[0];
 580
 581                     options["-id"] = bmark.id;
 582                     options["-title"] = bmark.title;
 583                     if (bmark.charset)
 584                         options["-charset"] = bmark.charset;
 585                     if (bmark.keyword)
 586                         options["-keyword"] = bmark.keyword;
 587                     if (bmark.post)
 588                         options["-post"] = bmark.post;
 589                     if (bmark.tags.length > 0)
 590                         options["-tags"] = bmark.tags;
 591                 }
 592                 else {
 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;
 597                 }
 598
 599                 CommandExMode().open(
 600                     commands.commandToString({ command: "bmark", options: options, arguments: [buffer.uri.spec] }));
 601             });
 602
 603         mappings.add(myModes, ["A"],
 604             "Toggle bookmarked state of current URL",
 605             function () { bookmarks.toggle(buffer.uri.spec); });
 606     },
 607     options: function () {
 608         options.add(["defsearch", "ds"],
 609             "The default search engine",
 610             "string", "google",
 611             {
 612                 completer: function completer(context) {
 613                     completion.search(context, true);
 614                     context.completions = [{ keyword: "", title: "Don't perform searches by default" }].concat(context.completions);
 615                 }
 616             });
 617
 618         options.add(["suggestengines"],
 619              "Search engines used for search suggestions",
 620              "stringlist", "google",
 621              { completer: function completer(context) completion.searchEngine(context, true), });
 622     },
 623
 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]) {
 629                 if (v != null)
 630                     context.filters.push(function (item) item.item[k] != null && this.matchString(v, item.item[k]));
 631             });
 632             context.generate = function () values(bookmarkcache.bookmarks);
 633             completion.urls(context, tags);
 634         };
 635
 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;
 640
 641             context.title = ["Search Keywords"];
 642             context.completions = iter(values(keywords), values(engines));
 643             context.keys = { text: "keyword", description: "title", icon: "icon" };
 644
 645             if (!space || noSuggest)
 646                 return;
 647
 648             context.fork("suggest", keyword.length + space.length, this, "searchEngineSuggest",
 649                          keyword, true);
 650
 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");
 661
 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)
 666                                 try {
 667                                     item.url = decodeURIComponent(query.replace(/#.*/, "").replace(/\+/g, " "));
 668                                     return item;
 669                                 }
 670                                 catch (e) {}
 671                             return null;
 672                         }).filter(util.identity);
 673                     };
 674                 });
 675         };
 676
 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);
 681              if (suggest)
 682                  context.filters.push(function ({ item }) item.supportsResponseType("application/x-suggestions+json"));
 683
 684         };
 685
 686         completion.searchEngineSuggest = function searchEngineSuggest(context, engineAliases, kludge) {
 687             if (!context.filter)
 688                 return;
 689
 690             let engineList = (engineAliases || options["suggestengines"].join(",") || "google").split(",");
 691
 692             engineList.forEach(function (name) {
 693                 var desc = name;
 694                 let engine = bookmarks.searchEngines[name];
 695                 if (engine)
 696                     var desc = engine.description;
 697                 else if (!Set.has(bookmarks.suggestionProviders, name))
 698                     return;
 699
 700                 let [, word] = /^\s*(\S+)/.exec(context.filter) || [];
 701                 if (!kludge && word == name) // FIXME: Check for matching keywords
 702                     return;
 703                 let ctxt = context.fork(name, 0);
 704
 705                 ctxt.title = [/*L*/desc + " Suggestions"];
 706                 ctxt.keys = { text: util.identity, description: function () "" };
 707                 ctxt.compare = CompletionContext.Sort.unsorted;
 708                 ctxt.filterFunc = null;
 709
 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));
 712
 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);
 719                 });
 720             });
 721         };
 722
 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);
 726     }
 727 });
 728
 729 // vim: set fdm=marker sw=4 ts=4 et: