354661 - Provide a Bugzilla Quicksearch plugin for Firefox 2 and IE 7 users to install

Status: RESOLVED FIXED

(Bugzilla :: Query/Bug List, enhancement)

Description

[Marc Schumann [:Wurblzap]]

I think a nifty thing to have would be a link on Bugzilla's front page, possibly near to the point where the sidebar is being offered, which lets me install a Search Engine plugin to my Firefox browser so that I can use that Bugzilla installation's Quicksearch capability from Firefox's Search Engine widget.

Comment 1

[Frédéric Buclin]

I like that. :)

Comment 2

[Dan Holmes]

Here is what i did for mine:  You can see our bugz at http://support.ivsi.com/bugzilla.

Created a file with this JS in it.

function addEngine(name,ext,cat,type)

{

    if ((typeof window.sidebar == "object") && (typeof window.sidebar.addSearchEngine == "function")) { 

        window.sidebar.addSearchEngine(

            "http://support.ivsi.com/support/search-engines-static/"+name+".src",

            "http://support.ivsi.com/support/search-engines-static/"+name+"."+ext, name, cat

        );

    } else {

        alert("Sorry, you need a Mozilla-based browser to install a search plugin.");

    } 

}

and in template/en/default/index.html.tmpl i added the following.

<img src="/support/search-engines-static/IVS-Bugzilla-bugno.png" alt=""/>
<a href="javascript:addEngine('IVS-Bugzilla-bugno','png','General','0')">Install the IVS Bugzilla Search Extension</a>

All of this was figured out by reading how it was done by other bugzilla search plugins.

Comment 3

[Dan Holmes]

Attachment: The plugin src

This is the contents of the src file mentioned in the prior comment.  This file isn't even original (as you can tell by the header comments).

Comment 4

[Dan Holmes]

(In reply to comment #2)
> Here is what i did for mine:  You can see our bugz at

The limitation is that it only searches by bug number.

Comment 5

[Frédéric Buclin]

Attachment: patch, v1

Asking gavin for the technical aspect of the plugin.

Comment 6

[:Gavin Sharp [email: [e-mail]]]

Comment on attachment 240508 [details] [diff] [review]
patch, v1

>Index: template/en/default/search/search-plugin.xml.tmpl

>+<?xml version="1.0" encoding="UTF-8"?>
>+<OpenSearchDescription xmlns="http://a9.com/-/spec/opensearch/1.1/">
>+<ShortName>[% terms.Bugzilla %]</ShortName>
>+<Description>[% terms.Bugzilla %] Quick Search</Description>
>+<InputEncoding>UTF-8</InputEncoding>
>+<Image width="16" height="16">data:image/x-icon;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAAABGdBTUEAAK%2FINwWK6QAAABl0RVh0U29mdHdhcmUAQWRvYmUgSW1hZ2VSZWFkeXHJZTwAAALBSURBVHjaYnxckcEAA3%2F%2B%2FT%2F17LUcH%2Fevf%2F8U%2BHmYGBkZMABAALEgc%2B68%2F3T227cf2tJKKhJLt59n%2FfmbnYnZV1KEhYkJrgYggBghNrz78fPIi3d8uvKBIdb%2FOaWPnzitLc97%2Bc5rFXnhnVO3%2BslLwjUABBDIhnsfPl%2Fj53VO91FX4Gfgkjxw%2Fd%2F6Q49%2FWStqyAj%2B%2B88gZqn%2B9u5rYU52iAaAAGL69%2F%2F%2F2d9%2FYiMclGT4fv76%2BZ9DbO%2FeA39%2BfJHVcvj5l%2Bnh03e%2FWThOvnwLtwEgAAAxAM7%2FBPj8%2FRYkHQYHAf3%2F%2Fv%2F%2B%2Fv8BAVNTUPX18yorLNHE2S8mB%2FT2%2Bq7a4dvu8iUSDgAAAAKICRgUv3%2F8ZGKGeIvpz6eXBvq61lZWLMwMv%2F5zMP7%2FqSAjVFyZ%2FNvZftuT10DnAAQAMQDO%2FwQIBAPz5Or6%2Ff0CBQEAAgT99ubq38z2%2BwT18%2FAM%2F%2BkNDAv6%2FQMCAA1GVVrhMze5h4kCCORpkd9%2F3n74KiHO%2B%2BffX8b%2Ff7m%2BXWP985%2Bf5R%2BPLNdfoK%2F%2F%2Ffv39%2BePj2%2FkZYR0fe0BAgikQZGX%2B9b9FzLS%2FH%2F%2B%2FGVgYGRlZWNlA7nv7z9QuDP8%2B8nw%2FRXjn68Mv4Gu%2FAwQQCCni3FxPLn7nIGZGegfNhYmNjYWZnBMASOakZER6Eumf9%2FYGT4y%2FHx%2F%2BfBFgAAC2cDGzPT99WeGvwzvv%2Fx89vrr%2F39%2FJER4pcT5Gf4z%2FP37D2jtj9%2B%2FL918fmzrKSsWNoAAgiaN%2Fz9%2Fff%2F6S4CP8%2BWbz9vWHfv54aukpAAz0Og%2Ff%2F7%2F%2Bs36668cO3ugED9QJUAAQTUArf7%2F8x87D9vRjcejhPiZhAUYcACAAGI5%2FOHH9ddvXzAxmjz%2B8P8lw4fXn5l4eRlwA4AAYmaTkBFg%2FKvJwfbkwZuXN57y%2Fv%2F34stXGR4uRmxpGwgAAgwA4%2FkfrfCWvLQAAAAASUVORK5CYII%3D</Image>
>+<Url type="text/html" method="GET" template="[% Param('urlbase') %]buglist.cgi">
>+  <Param name="quicksearch" value="{searchTerms}"/>
>+</Url>
>+<Url type="text/html" template="[% Param('urlbase') %]"/>

Why two URL elements? The first one should be enough. Also, you can use POST if you want, I'm not sure if it matters to you one way or the other.

>Index: template/en/default/index.html.tmpl

>+  <p>
>+    The following links require a Gecko-based browser like Mozilla Firefox:
>+  </p>
>+
>+  <ul>
>+    <li id="sidebar"><a href="javascript:addSidebar()">Add to Sidebar</a></li>
>+    <li id="quick_search_plugin">
>+      <a href="javascript:window.external.AddSearchProvider('[% Param('urlbase') %]search_plugin.cgi')">Install
>+      the Quick Search plugin</a>
>+    </li>

That statement isn't exactly true - the second link should work in IE7.

Comment 7

[Frédéric Buclin]

Attachment: patch, v1.1

Comment 8

[Frédéric Buclin]

Comment on attachment 240512 [details] [diff] [review]
patch, v1.1

>Index: search_plugin.cgi

>+  || ThrowTemplateError($template->error());

Oh, I just noted that I forgot to add 'use Bugzilla::Error;' in case the template cannot be find. I will add this line on checkin.

Comment 9

[Frédéric Buclin]

RCS file: /cvsroot/mozilla/webtools/bugzilla/search_plugin.cgi,v
done
Checking in search_plugin.cgi;
/cvsroot/mozilla/webtools/bugzilla/search_plugin.cgi,v  <--  search_plugin.cgi
initial revision: 1.1
done
Checking in skins/standard/index.css;
/cvsroot/mozilla/webtools/bugzilla/skins/standard/index.css,v  <--  index.css
new revision: 1.6; previous revision: 1.5
done
Checking in template/en/default/index.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/index.html.tmpl,v  <--  index.html.tmpl
new revision: 1.31; previous revision: 1.30
done
Checking in template/en/default/global/header.html.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/global/header.html.tmpl,v  <--  header.html.tmpl
new revision: 1.46; previous revision: 1.45
done
RCS file: /cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-plugin.xml.tmpl,v
done
Checking in template/en/default/search/search-plugin.xml.tmpl;
/cvsroot/mozilla/webtools/bugzilla/template/en/default/search/search-plugin.xml.tmpl,v  <--  search-plugin.xml.tmpl
initial revision: 1.1
done

Comment 10

[Håkan Waara]

This sounds interesting. Is it already possible to try out?

Comment 11

[:Gavin Sharp [email: [e-mail]]]

(In reply to comment #10)
> This sounds interesting. Is it already possible to try out?

You can see it in action in at http://landfill.bugzilla.org/bug354661/ .

Comment 12

[Marc Schumann [:Wurblzap]]

... and of course at http://landfill.bugzilla.org/bugzilla-tip/ :)

Comment 13

[Max Kanat-Alexander]

Added to the release notes on bug 255155.

Comment 14

[Max Kanat-Alexander]

The correct bug number for those release notes is actually bug 349423.