= Advanced Search =

One of the expected feature for [milestone:1.0] is a much improved search system.

But what exactly should be improved?
This is the place to discuss it and make proposals.

Note that there's currently no development branch dedicated to 
this topic, but when there will be one, this page can be used to 
discuss the corresponding implementation details.

As usual with Trac, the challenge is that we're not only searching
Wiki pages, but other kind of Trac resources as well: tickets, changesets, etc.
Therefore, the result shown should also be adapted to the kind of object
retrieved (see e.g. #2859).

A related question is how the TracSearch and the TracQuery should interact,
see Trac-Dev:333, #1329, #2644.

== Weighting ==

Right now, the results are returned in reverse chronological order (i.e. most recent first). All matches are considered equal. It was suggested that we could use some simple weighting techniques to return the results in a more useful order.
For example, if a term is found in a ticket summary, this could "weight" more than if found in a ticket comment. Likewise, the number of times the term is found for a given result could be taken into account, etc.

It should be possible to do a first version of this improvement independently of the rest, by modifying the return type of `ISearch.get_search_results` to return a list of `SearchResult` object (much like the [wiki:"TracDev/ApiChanges/0.11#ITimelineEventProvider" ITimelineEventProvider] change).

In [wikipedia:"Information retrieval"] systems, it is standard to use [wikipedia:"Tf–idf" TF-IDF] (term frequency–inverse document frequency) scoring functions. It normalizes weights based on document length and how common the different search terms are in general. One commonly used such function is [wikipedia:"Okapi BM25"] or its variant BM25F. The latter supports weighting multiple fields differently.

== Indexing ==

It would probably be a good idea if objects were indexed as they are created/updated. This would obviously improve search performance greatly, and no longer effectively require a full retrieval of the entire DB. This could be optional I guess.

A generic search system would provide components with a means to index content, query the content in a standard way (ie. a decent query language) and refer to this content at a later date (eg. ticket hits would display the ticket in a useful way, with links to specific comments, etc.)

== Alec's Stream of Consciousness ==

If indexing on creation/update we would need hooks for each resource in Trac (ala `IWikiChangeListener`) to update the indexer. The potential downside for this is that indexing on the fly could slow down Trac's responsiveness at the cost of faster search. This could be mitigated by running the indexer in a thread. I like this solution.

For indexing itself, there seems to be two solutions: use a generalised indexing engine (Hyperestraier, Lucene, etc.) or in-database indexers. A generalised indexing engine has advantages in that one interface could be used for all resources (wiki, ticket, source, attachment, ...). I am personally a fan of this option, and in particular [http://swapoff.org/pyndexter pyndexter] (bias!), which provides an abstraction layer for a number of indexers. It also includes a generic query language (similar to Google's) which is transformed into the query language particular to each backend.

So, here is a completely unthoughtout proposal:

{{{
#!python
# trac.wiki.search
from trac.search import SearchSystem

class WikiIndexer(Component):
    implements(IWikiChangeListener)

    def _update(self, page):
        SearchSystem(self.env).add('wiki:%s' % page.id, content=page.content)

    wiki_page_added = _update
    wiki_page_changed = _update
    wiki_page_version_deleted = _update

    def wiki_page_deleted(self, page):
        SearchSystem(self.env).remove('wiki:%s' % page.id)
}}}

This kind of system could be implemented entirely as a plugin, assuming appropriate ''!ChangeListener'' style interfaces existed for all resources (currently only the versioncontrol module is missing this functionality).

== Search Engines ==

Several search engines could be good candidate for handling
the search requests, but probably this should be done in a
pluggable way, so that different search engines could be supported, including a ''fallback'' engine (i.e. the current SQL-based search in the database), which would require no extra package.

Among the possible candidates:
 * [http://www.xapian.org Xapian] 
   and [http://divmod.org/trac/wiki/DivmodXapwrap DivmodXapwrap]. 
   See also the discussion about using Xapin in MoinMoin:
   MoinMoin:FeatureRequests/AdvancedXapianSearch
 * [http://pylucene.osafoundation.org/ PyLucene]
 * [http://lucene.apache.org/solr/ Solr]
 * [http://hyperestraier.sourceforge.net/ Hyper Estraier] 
   and [http://hype.python-hosting.com/ hype].
 * [http://whoosh.ca/ Whoosh] (read Chris Mulligan on trac-dev [googlegroups:trac-dev:d4025a6f2feef8d7 Whoosh for search?])
 * ... ?
 * There's been some efforts to provide a neutral API for some of the above search engines:
   - [http://swapoff.org/wiki/pyndexter pyndexter] [[BR]]
     The Hyperestraier adapter works well, Xapian is coming along nicely and the pure python indexer is based on that used by th:wiki:RepoSearchPlugin (ie. works, but has issues). I have yet to write the !PyLucene adapter, but it doesn't look too difficult.
   - [http://blog.case.edu/bmb12/2006/08/merquery_summer_of_code_results merquery] [[BR]]
     This is now a Django specific SoC project.
   - [http://opensearch.a9.com/ OpenSearch]
 * DatabaseBackend may also have their own way to implement full text search:
   - Recent SQLite (3.3.8) comes with experimental full-text search module, sqlite:FtsTwo
     (depends on pysqlite:#180). [[BR]]
     This seems to be a long way from useful in its current state,
     unfortunately :(. fts1 and fts2 are both deprecated, and there are no
     decent build instructions for fts3. More critically, FTS support is also
     not shipped with any major distribution I'm aware of.
   - postgres fulltext search. Postgresql 8.3 has integrated full text search as a core functionality.
     - [http://pgfoundry.org/projects/pgestraier postgres calling hyper estraier], soure is[http://svn.rot13.org/index.cgi/pgestraier/browse/trunk/ here]
     - [http://www.sai.msu.su/~megera/oddmuse/index.cgi/Tsearch2 Tsearch2]
     - [http://www.devx.com/opensource/Article/21674 article about tsearch2]
     - [http://www.postgresql.org/docs/8.3/static/textsearch.html Postgres 8.3 integrated Full Text Search]
   - [http://dev.mysql.com/doc/refman/5.1/en/fulltext-search.html MySql fulltext indexing] [[BR]] not an option, because it is only available for MyISAM type tables that don't have transactions support

Not an engine, but might be a source of inspiration nonetheless: [http://haystacksearch.org/ Haystack], modular search for Django, supports Solr, Whoosh and Xapian.

== Optional Search Targets ==

On the search page, there are checkboxes to search tickets, changesets, and the wiki.  It would helpful to expand these.  For example, specific checkboxes for ticket summary, ticket description, ticket comments, wiki page title, wiki page content, etc.  I'm sure the Trac development team could come up with a great, user-friendly way to make a user-friendly advanced search with many options.

On a similar note - it would be nice to add a checkbox for searching (or to explicitly exclude searching) in the Trac documentation. Many times I am searching for something I am either looking something up in the Trac help, or in my project data - rarely do I not know which it is in :-).

== Searching Down Links and Attachments to a Specified Depth ==

It would be exceptionally useful to be able to extend the search to look inside attachments and links and to control the depth of the search. By this I mean that the search would allow for 
 * a link (depth 1); 
 * a link within a link (depth 2); 
 * a link within a link within a link (depth 3); 
etc 

to be indexed within the search. 

For example I make a link to a page outside my trac setup and on this page there is a pdf file linked, like [http://www.federalreserve.gov/pubs/bulletin/2010/default.htm#legal Federal Reserve] which contains links including a pdf file [http://www.federalreserve.gov/pubs/bulletin/2010/pdf/legalq409.pdf]. For example, I could search for "FDIC" and it would turn up in this paper. 

If the external search depth were 2 then the search function would search external links down two levels and include the text FDIC within the pdf document as shown. The unix program lynx is able to recursively locate links to a specified depth. The hack would have to do something similar and then index the pages and files (of allowed types) to be included within the search. It might be most efficient to recognise if the link has changed (either by date or by some hash based upon the data) and only try to index it if it is new or changed. These could be indexed periodically, and/or after the page with the links has been changed.

The beauty of this is that it extends the search from just the trac website to the local nodes of the network and would allow information on adjacent sites specified by links to be searched. 

The same search could be extended to attached files too, that already exist within the trac framework. The file types to search could be specified (pdf txt doc etc).

I put this into requestahack on the trac-hacks site as [http://trac-hacks.org/ticket/6918 (#6918)] but it might be better as part of the core trac project.

   '''markm:''' I think searching sites outside of track is beyond the scope of Trac. It would involve a web crawler to follow those links. 
   I think it perfectly acceptable that Trac does not index links outside of trac itself. I thikn that Indexing attachments may be quite interesting. 
   But I think it may belong in an optional plugin - as it probably needs to be quite platform dependent, and may involve technologies completely oblique to Trac's core functionality.