2 * (C) Copyright 2004-2007 Shawn Betts
3 * (C) Copyright 2007-2008 John J. Foerch
4 * (C) Copyright 2007-2008 Jeremy Maitin-Shepard
6 * Use, modification, and distribution are subject to the terms specified in the
12 define_keywords("$completer", "$description", "$argument", "$alternative",
14 function define_webjump (key, handler) {
16 var argument = arguments.$argument;
17 let alternative = arguments.$alternative;
18 var post_data = arguments.$post_data;
20 // handler may be a function or a string. An alternative url may
21 // be passed using the $alternative keyword; it is used in place
22 // of the handler when no arguments are supplied by the user when
23 // invoking the webjump (see get_webjump). For string webjumps
24 // that contain %s and for which no alternative is provided, an
25 // alternative is autogenerated by trimming the path from the url.
26 // A webjump can thus function both as a way to invoke a search
29 // When the handler is a string and post_data is given the webjump
30 // will result in a POST. A '%s' element in post_data will be
31 // replaced by the webjump argument and the alternative is the
32 // same as the handler (but as a GET).
34 // The argument property may be false (no arguments will be
35 // accepted for the webjump), true (arguments are required for the
36 // webjump) or 'optional' (arguments are accepted but not
37 // required). If the property is not specified, a sensible default
38 // is chosen depending on the type of the handler and whether an
39 // alternative is specified. If the property is false, then
40 // completing on the name of the webjump in the minibuffer will
41 // not result in a space being appended.
43 if (typeof(handler) == "function") {
44 if (argument == null && alternative == null)
46 } else if (typeof(handler) == "string") {
47 if (post_data && alternative == null)
48 alternative = handler;
49 else if (handler.indexOf('%s') == -1)
51 else if (alternative == null)
52 alternative = url_path_trim(handler);
54 if (alternative && argument == null)
55 argument = 'optional';
57 function make_string_handler (template) {
58 var b = template.indexOf('%s');
59 return function (arg) {
61 // Just return the same string if it doesn't contain a %s
64 return template.substr(0,b) + encodeURIComponent(arg) + template.substring(a);
68 function make_post_handler (uri, post_data) {
69 return function (arg) {
72 post_data: make_post_data(post_data.map(function (pair) {
74 return [pair[0], arg];
82 if (typeof(handler) == "string") {
84 handler = make_post_handler(handler, post_data);
86 handler = make_string_handler(handler);
89 webjumps[key] = { key: key,
91 completer: arguments.$completer,
92 description: arguments.$description,
94 alternative: alternative};
97 function clear_webjumps () {
101 define_variable("webjump_partial_match", true,
102 "When entering a url, if the input is not a webjump, " +
103 "but would uniquely complete to a webjump, then accept " +
104 "that webjump only if this is true.");
106 function match_webjump (str) {
107 var sp = str.indexOf(' ');
114 key = str.substring(0, sp);
115 arg = str.substring(sp + 1);
116 if (/^\s*$/.test(arg))
120 // Look for an exact match
121 var match = webjumps[key];
123 // Look for a partial match
124 if (!match && webjump_partial_match) {
125 for (let [k,v] in Iterator(webjumps)) {
126 if (String(k).substring(0, key.length) == key) {
128 // key is not a unique prefix, as there are multiple partial matches
137 if (arg == null && match.argument == true)
138 throw interactive_error('Webjump '+key+' requires an argument.');
139 return [match, key, arg];
145 function get_webjump (value) {
146 var res = match_webjump(value);
149 let [match,key,arg] = res;
150 if (arg == null && match.alternative)
151 return match.alternative;
152 return match.handler(arg);
155 function get_url_or_webjump (input) {
156 var url = get_webjump(input);
163 function webjump_completer () {
164 let base_completer = prefix_completer(
165 $completions = [ v for ([k,v] in Iterator(webjumps)) ],
166 $get_string = function (x) { return x.key + (x.argument ? " " : ""); },
167 $get_description = function (x) { return x.description || ""; });
168 return function (input, pos, conservative) {
169 let str = input.substring(0,pos);
171 try { res = match_webjump(str); }
172 catch (e) { res = null; }
174 let [match, key, arg] = res;
175 if (arg != null) { // If there is no argument yet, we use the base completer
176 if (match.completer) {
177 let c = yield match.completer.call(null, arg, pos - key.length - 1, conservative);
178 yield co_return(nest_completions(c, match.key + " "));
180 yield co_return(null);
183 yield co_return(base_completer(input, pos, conservative));
192 function define_delicious_webjumps (username) {
193 define_webjump("delicious", "http://www.delicious.com/" + username + "/%s",
194 $alternative = "http://www.delicious.com/" + username);
195 define_webjump("adelicious", "javascript:location.href='http://www.delicious.com/save"+
196 "?v=2&url='+encodeURIComponent(location.href)+'&title='+"+
197 "encodeURIComponent(document.title);");
198 define_webjump("sdelicious", "http://www.delicious.com/search?p=%s&u="+username+
199 "&chk=&context=userposts&fr=del_icio_us&lc=1");
200 define_webjump("sadelicious", "http://www.delicious.com/search/all?search=%s");
203 function define_lastfm_webjumps (username) {
204 if (! username) username = "";
205 define_webjump("lastfm", "http://www.last.fm/user/"+username);
206 define_webjump("lastfm-user", "http://www.last.fm/user/%s");
207 define_webjump("lastfm-music", "http://www.last.fm/search?m=all&q=%s");
208 define_webjump("lastfm-group", "http://www.last.fm/users/groups?s_bio=%s");
209 define_webjump("lastfm-tag", "http://www.last.fm/search?m=tag&q=%s");
210 define_webjump("lastfm-label", "http://www.last.fm/search?m=label&q=%s");
211 define_webjump("lastfm-event", "http://www.last.fm/events?by=artists&q=%s");
214 function define_default_webjumps () {
215 define_webjump("conkerorwiki",
216 "http://conkeror.org/?action=fullsearch&context=60&value=%s&fullsearch=Text");
217 define_webjump("lucky", "http://www.google.com/search?q=%s&btnI=I'm Feeling Lucky");
218 define_webjump("maps", "http://maps.google.com/?q=%s");
219 define_webjump("scholar", "http://scholar.google.com/scholar?q=%s");
220 define_webjump("slang", "http://www.urbandictionary.com/define.php?term=%s");
221 define_webjump("dictionary", "http://dictionary.reference.com/search?q=%s");
222 define_webjump("image", "http://images.google.com/images?q=%s");
223 define_webjump("clhs",
224 "http://www.xach.com/clhs?q=%s",
225 $alternative = "http://www.lispworks.com/documentation/HyperSpec/Front/index.htm");
226 define_webjump("cliki", "http://www.cliki.net/admin/search?words=%s");
227 define_webjump("ratpoisonwiki", "http://ratpoison.antidesktop.net/?search=%s");
228 define_webjump("stumpwmwiki", "http://stumpwm.antidesktop.net/wiki?search=%s");
229 define_webjump("savannah",
230 "http://savannah.gnu.org/search/?words=%s&type_of_search=soft&Search=Search&exact=1");
231 define_webjump("sourceforge", "http://sourceforge.net/search/?words=%s");
232 define_webjump("freshmeat", "http://freshmeat.net/search/?q=%s");
233 define_webjump("slashdot", "http://slashdot.org/search.pl?query=%s");
234 define_webjump("kuro5hin", "http://www.kuro5hin.org/?op=search&string=%s");
237 define_default_webjumps();