/*
JSPWiki - a JSP-based WikiWiki clone.
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
*/
package com.ecyrd.jspwiki.search;
import java.io.IOException;
import java.util.*;
import org.apache.commons.lang.time.StopWatch;
import org.apache.log4j.Logger;
import com.ecyrd.jspwiki.*;
import com.ecyrd.jspwiki.event.WikiEvent;
import com.ecyrd.jspwiki.event.WikiEventListener;
import com.ecyrd.jspwiki.event.WikiEventUtils;
import com.ecyrd.jspwiki.event.WikiPageEvent;
import com.ecyrd.jspwiki.filters.BasicPageFilter;
import com.ecyrd.jspwiki.filters.FilterException;
import com.ecyrd.jspwiki.modules.InternalModule;
import com.ecyrd.jspwiki.parser.MarkupParser;
import com.ecyrd.jspwiki.providers.ProviderException;
import com.ecyrd.jspwiki.rpc.RPCCallable;
import com.ecyrd.jspwiki.rpc.json.JSONRPCManager;
import com.ecyrd.jspwiki.util.ClassUtil;
/**
* Manages searching the Wiki.
*
* @author Arent-Jan Banck
* @since 2.2.21.
*/
public class SearchManager
extends BasicPageFilter
implements InternalModule, WikiEventListener
{
private static final Logger log = Logger.getLogger(SearchManager.class);
private static final String DEFAULT_SEARCHPROVIDER = "com.ecyrd.jspwiki.search.LuceneSearchProvider";
/** Old option, now deprecated. */
private static final String PROP_USE_LUCENE = "jspwiki.useLucene";
/**
* Property name for setting the search provider. Value is <tt>{@value}</tt>.
*/
public static final String PROP_SEARCHPROVIDER = "jspwiki.searchProvider";
private SearchProvider m_searchProvider = null;
/**
* The name of the JSON object that manages search.
*/
public static final String JSON_SEARCH = "search";
/**
* Creates a new SearchManager.
*
* @param engine The WikiEngine that owns this SearchManager.
* @param properties The list of Properties.
* @throws WikiException If it cannot be instantiated.
*/
public SearchManager( WikiEngine engine, Properties properties )
throws WikiException
{
initialize( engine, properties );
WikiEventUtils.addWikiEventListener(m_engine.getPageManager(),
WikiPageEvent.PAGE_DELETE_REQUEST, this);
JSONRPCManager.registerGlobalObject( JSON_SEARCH, new JSONSearch() );
}
/**
* Provides a JSON RPC API to the JSPWiki Search Engine.
*/
public class JSONSearch implements RPCCallable
{
/**
* Provides a list of suggestions to use for a page name.
* Currently the algorithm just looks into the value parameter,
* and returns all page names from that.
*
* @param wikiName the page name
* @param maxLength maximum number of suggestions
* @return the suggestions
*/
public List getSuggestions( String wikiName, int maxLength )
{
StopWatch sw = new StopWatch();
sw.start();
List<String> list = new ArrayList<String>(maxLength);
if( wikiName.length() > 0 )
{
// split pagename and attachment filename
String filename = "";
int pos = wikiName.indexOf("/");
if( pos >= 0 )
{
filename = wikiName.substring( pos ).toLowerCase();
wikiName = wikiName.substring( 0, pos );
}
String cleanWikiName = MarkupParser.cleanLink(wikiName).toLowerCase() + filename;
String oldStyleName = MarkupParser.wikifyLink(wikiName).toLowerCase() + filename;
Set allPages = m_engine.getReferenceManager().findCreated();
int counter = 0;
for( Iterator i = allPages.iterator(); i.hasNext() && counter < maxLength; )
{
String p = (String) i.next();
String pp = p.toLowerCase();
if( pp.startsWith( cleanWikiName) || pp.startsWith( oldStyleName ) )
{
list.add( p );
counter++;
}
}
}
sw.stop();
if( log.isDebugEnabled() ) log.debug("Suggestion request for "+wikiName+" done in "+sw);
return list;
}
/**
* Performs a full search of pages.
*
* @param searchString The query string
* @param maxLength How many hits to return
* @return the pages found
*/
public List findPages( String searchString, int maxLength )
{
StopWatch sw = new StopWatch();
sw.start();
List<HashMap> list = new ArrayList<HashMap>(maxLength);
if( searchString.length() > 0 )
{
try
{
Collection c;
if( m_searchProvider instanceof LuceneSearchProvider )
c = ((LuceneSearchProvider)m_searchProvider).findPages( searchString, 0 );
else
c = m_searchProvider.findPages( searchString );
int count = 0;
for( Iterator i = c.iterator(); i.hasNext() && count < maxLength; count++ )
{
SearchResult sr = (SearchResult)i.next();
HashMap<String,Object> hm = new HashMap<String,Object>();
hm.put( "page", sr.getPage().getName() );
hm.put( "score", sr.getScore() );
list.add( hm );
}
}
catch(Exception e)
{
log.info("AJAX search failed; ",e);
}
}
sw.stop();
if( log.isDebugEnabled() ) log.debug("AJAX search complete in "+sw);
return list;
}
}
/**
* This particular method starts off indexing and all sorts of various activities,
* so you need to run this last, after things are done.
*
* @param engine the wiki engine
* @param properties the properties used to initialize the wiki engine
* @throws FilterException if the search provider failed to initialize
*/
public void initialize(WikiEngine engine, Properties properties)
throws FilterException
{
m_engine = engine;
loadSearchProvider(properties);
try
{
m_searchProvider.initialize(engine, properties);
}
catch (NoRequiredPropertyException e)
{
// TODO Auto-generated catch block
e.printStackTrace();
}
catch (IOException e)
{
// TODO Auto-generated catch block
e.printStackTrace();
}
}
private void loadSearchProvider(Properties properties)
{
//
// See if we're using Lucene, and if so, ensure that its
// index directory is up to date.
//
String useLucene = properties.getProperty(PROP_USE_LUCENE);
// FIXME: Obsolete, remove, or change logic to first load searchProvder?
// If the old jspwiki.useLucene property is set we use that instead of the searchProvider class.
if( useLucene != null )
{
log.info( PROP_USE_LUCENE+" is deprecated; please use "+PROP_SEARCHPROVIDER+"=<your search provider> instead." );
if( TextUtil.isPositive( useLucene ) )
{
m_searchProvider = new LuceneSearchProvider();
}
else
{
m_searchProvider = new BasicSearchProvider();
}
log.debug("useLucene was set, loading search provider " + m_searchProvider);
return;
}
String providerClassName = properties.getProperty( PROP_SEARCHPROVIDER,
DEFAULT_SEARCHPROVIDER );
try
{
Class providerClass = ClassUtil.findClass( "com.ecyrd.jspwiki.search", providerClassName );
m_searchProvider = (SearchProvider)providerClass.newInstance();
}
catch( ClassNotFoundException e )
{
log.warn("Failed loading SearchProvider, will use BasicSearchProvider.", e);
}
catch( InstantiationException e )
{
log.warn("Failed loading SearchProvider, will use BasicSearchProvider.", e);
}
catch( IllegalAccessException e )
{
log.warn("Failed loading SearchProvider, will use BasicSearchProvider.", e);
}
if( null == m_searchProvider )
{
// FIXME: Make a static with the default search provider
m_searchProvider = new BasicSearchProvider();
}
log.debug("Loaded search provider " + m_searchProvider);
}
/**
* Returns the SearchProvider used.
*
* @return The current SearchProvider.
*/
public SearchProvider getSearchEngine()
{
return m_searchProvider;
}
/**
* Sends a search to the current search provider. The query is is whatever native format
* the query engine wants to use.
*
* @param query The query. Null is safe, and is interpreted as an empty query.
* @return A collection of WikiPages that matched.
* @throws ProviderException If the provider fails and a search cannot be completed.
* @throws IOException If something else goes wrong.
*/
public Collection findPages( String query )
throws ProviderException, IOException
{
if( query == null ) query = "";
Collection c = m_searchProvider.findPages( query );
return c;
}
/**
* Removes the page from the search cache (if any).
* @param page The page to remove
*/
public void pageRemoved(WikiPage page)
{
m_searchProvider.pageRemoved(page);
}
/**
* Reindexes the page.
*
* @param wikiContext {@inheritDoc}
* @param content {@inheritDoc}
*/
@Override
public void postSave( WikiContext wikiContext, String content )
{
//
// Makes sure that we're indexing the latest version of this
// page.
//
WikiPage p = m_engine.getPage( wikiContext.getPage().getName() );
reindexPage( p );
}
/**
* Forces the reindex of the given page.
*
* @param page The page.
*/
public void reindexPage(WikiPage page)
{
m_searchProvider.reindexPage(page);
}
/**
* If the page has been deleted, removes it from the index.
*
* @param event {@inheritDoc}
*/
public void actionPerformed(WikiEvent event)
{
if( (event instanceof WikiPageEvent) && (event.getType() == WikiPageEvent.PAGE_DELETE_REQUEST) )
{
String pageName = ((WikiPageEvent) event).getPageName();
WikiPage p = m_engine.getPage( pageName );
if( p != null )
{
pageRemoved( p );
}
}
}
}