399394 - Sumo should offer a search plugin

Status: VERIFIED FIXED

(support.mozilla.org :: General, defect, P4)

Description

[Chris Ilias [:cilias]]

As per <http://support.mozilla.com/kb/Search+bar#While_visiting_a_web_site>, sumo should offer a search plugin, that Firefox users can add to their Firefox search bar. It would be the same search as the one offered on the support.mozilla.com top page.

Comment 1

[myles7897]

according to mycroft, there is two <http://mycroft.mozdev.org/download.html?name=support.mozilla.com&sherlock=yes&opensearch=yes&submitform=Search>

I created one, and AndrewB created one.  Personally I like his better, but it needs to be updated to the favicon, that is being created.

Comment 2

[Chris Ilias [:cilias]]

For clarification, this about offering the plugin, as per <http://developer.mozilla.org/en/Creating_OpenSearch_plugins_for_Firefox>.

Comment 3

[David Tenser [:djst]]

Chris, that doesn't clarify things for me. See comment 1 for an example of such a plugin. What exactly are you requesting?

Comment 4

[Chris Ilias [:cilias]]

When someone visits support.mozilla.com using Firefox, the search should glow blue. If the user clicks on the search bar icon, there should be an item at the bottom of the list, offering to "Add Firefox Support".

Comment 5

[David Tenser [:djst]]

This seems like something very few people would use. It's not useless, but e.g. having an integrated search box in the Help menu of Firefox itself would be a much cooler and useful idea.

Comment 6

[Chris Ilias [:cilias]]

I can understand it being low priority, but wontfix? The plugin itself was lready created. The only thing holding this back is having a favicon. Other than that, it's just a matter of adding one line of code to the web site head.

Comment 7

[David Tenser [:djst]]

My bad. I even marked is milestone as Future, but forgot that I first resolved it.

Comment 8

[Laura Thomson :laura]

Wil, since you are the master of all search addons, can you take care of getting this done and on AMO?

Comment 9

[Wil Clouser [:clouserw]]

What do you need help with?  It looks like a search engine already exists in comment 1.  You should use a <link rel="search" /> on SUMO to get Firefox to realize it exists.

As far as putting it on AMO - I don't want to just steal AndrewB's work - if he's around he should upload it.  If not, it's true, they are easy to make, but has anyone tried talking to him?

Comment 10

[Tanner Filip [:tanner]]

Ricmacas (on #sumo) has made this already, its called Sumo Search.

Comment 11

[Chris Ilias [:cilias]]

This looks like it <https://addons.mozilla.org/en-US/firefox/addon/11966>! It uses the SUMO favicon and new search! 
Ricmacas, is it okay if we use it?

Comment 12

[Tom Ellins [:TMZ]]

Ricmacas has given permission for SUMO to use this.

Comment 13

[Wil Clouser [:clouserw]]

Cool.  I'm not sure who should have this but on SUMO's side. ->nobody

Comment 16

[James Socol [:jsocol, :james]]

Attachment: simple search plugin

This took me 5 minutes while the internet was down this morning. I'll add it too Kitsune. (Technically 1.5.4.) (We don't have suggestions at the moment, but that's a nice but to file in the future.)

This plugin uses the Kitsune search and will execute searches based on the Accept-Language header. If we don't mind waiting a while longer, I can create locale-specific search plugins that are automatically generated. Or we can use this now and then update it? Whatever you guys want to do.

Comment 17

[Kadir Topal [:atopal]]

Hey, pretty nice :)

but not sure if I understand: If this searches based on the Accep-Language header, why would we need locale specific search plugins?

Comment 18

[James Socol [:jsocol, :james]]

(In reply to comment #17)
> but not sure if I understand: If this searches based on the Accep-Language
> header, why would we need locale specific search plugins?

So the search has two methods of specifying the language to search:
1) Use the /%LOCALE%/ part of the URL.
2) Use the ``language=`` part of the query string.

Since there's no way to specify the language in the query string in the search plugin--or, we could specify it, but not it would be fixed to one value, like en-US, for everyone--that means we fall back to method (1).

Method (1) depends on the Accept-Language header of the browser: when you go to /search, you will be redirected to /%LOCALE%/search based on the header. After the redirect, the search uses that %LOCALE% value to filter.

Basically, via this search plugin, searches will default to whatever language the browser prefers.

If I were to make it dynamic, eg: based on whatever language you're currently viewing, then I could make automatically generate a search plugin that didn't look at /search, but instead looked at /%LOCALE%/search, meaning no redirection would happen, and that plugin would always search that language.

It's more complex and I don't have time to do it now, but it's not terribly difficult, either.

Comment 19

[Kadir Topal [:atopal]]

Thanks for clarifying, James.

Then I would say we take this now and take care of the edge cases (having an accept-language header different from the favored language) later.

Comment 20

[James Socol [:jsocol, :james]]

-> 1.5.4. I'll check it in next week.

Comment 21

[James Socol [:jsocol, :james]]

Comment on attachment 439293 [details]
simple search plugin

This is a very easy patch. There will be a one-liner in the Kitsune source, as well, to add the same <link/> tag in the templates there.

Comment 22

[James Socol [:jsocol, :james]]

Paul: r? http://github.com/jsocol/kitsune/commit/4464b2033a4c5ce079034dabdafed808e0bcfc51

Comment 23

[Paul Craciunoiu [:paulc]]

Comment on attachment 439293 [details]
simple search plugin

WFM. Very nice James!

Comment 24

[Paul Craciunoiu [:paulc]]

r+ on Kitsune as well.

Comment 25

[James Socol [:jsocol, :james]]

r66380/r66381 (I forgot to svn add the plugin the first time).

Not on mobile, since the URL is hardcoded into the XML.

Will merge the Kitsune part momentarily.

Comment 26

[James Socol [:jsocol, :james]]

http://github.com/jsocol/kitsune/commit/4464b2033a4c5ce079034dabdafed808e0bcfc51

Merged in Kitsune.

Comment 27

[Stephen Donner [:stephend] Not actively reading bugmail]

Is this not testable until we ship?  Seems like it's hardcoded to prod; it takes the search terms from the search bar, and does a 302 to the homepage:

http://support.mozilla.com/search?q=firefox+crashes&w=3&src=plugin



GET /search?q=firefox+crashes&w=3&src=plugin HTTP/1.1

Host: support.mozilla.com

User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.3) Gecko/20100401 Firefox/3.6.3

Accept: text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8

Accept-Language: en-us,en;q=0.5

Accept-Encoding: gzip,deflate

Accept-Charset: ISO-8859-1,utf-8;q=0.7,*;q=0.7

Keep-Alive: 115

Connection: keep-alive

Cookie: s_vi=[CS]v1|25E9269C05013A98-4000010B800010F9[CE]; SSID_SUMO=iboTx70N5aWc0NP11H0b; __utma=92405663.1005278883.1272073557.1272073557.1272216341.2; __utmz=92405663.1272073557.1.1.utmccn=(direct)|utmcsr=(direct)|utmcmd=(none); WT_FPC=id=267bc4a07c51900f25a1272118493556:lv=1272212882946:ss=1272211983254; wtspl=834561; SSID=ibojuy0NNmjI02uxfN0b; __utmb=92405663; SSSC=2.225294548.236943072.43.2010; SSLB=1



HTTP/1.1 302 Found

Server: Apache

Cache-Control: no-cache, pre-check=0, post-check=0

Content-Type: text/html; charset=UTF-8

Date: Sun, 25 Apr 2010 17:28:16 GMT

Location: /en-US/kb/Firefox+Support+Home+Page

Keep-Alive: timeout=5, max=1000

Connection: Keep-Alive

X-Powered-By: PHP/5.2.9

X-Cache-Info: not cacheable; response specified "Cache-Control: no-cache"

Content-Length: 0

Comment 28

[James Socol [:jsocol, :james]]

Kind of. You tested that there is a search plugin, that you can install it, and that it takes you to /search?q={searchTerms}. That's all correct behavior.

It's hard-coded because it's a static XML file right now. We may swing back (see comment 18) and come up with something more dynamic and run through Kitsune, but this works pretty well right now.

Comment 29

[Stephen Donner [:stephend] Not actively reading bugmail]

Verified FIXED:

http://support.mozilla.com/search?q=the+ring+3&w=3&src=plugin



GET /search?q=the+ring+3&w=3&src=plugin HTTP/1.1

Host: support.mozilla.com

User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.4) Gecko/20100503 Firefox/3.6.4

<snip>

HTTP/1.1 301 MOVED PERMANENTLY

Server: Apache

<snip>
Location: http://support.mozilla.com/en-US/search?q=the+ring+3&w=3&src=plugin

Keep-Alive: timeout=3, max=246

Expires: Sat, 12 Sep 2009 19:20:03 GMT

Pragma: no-cache

Connection: Keep-Alive

X-Cache-Info: not cacheable; response specified "Cache-Control: private"

Content-Length: 20

----------------------------------------------------------

http://support.mozilla.com/en-US/search?q=the+ring+3&w=3&src=plugin



GET /en-US/search?q=the+ring+3&w=3&src=plugin HTTP/1.1

Host: support.mozilla.com

User-Agent: Mozilla/5.0 (Macintosh; U; Intel Mac OS X 10.6; en-US; rv:1.9.2.4) Gecko/20100503 Firefox/3.6.4

<snip>


HTTP/1.1 200 OK