WikiSolrReferenceResolver.java

/*
 * See the NOTICE file distributed with this work for additional
 * information regarding copyright ownership.
 *
 * This is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of
 * the License, or (at your option) any later version.
 *
 * This software is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this software; if not, write to the Free
 * Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
 * 02110-1301 USA, or see the FSF site: http://www.fsf.org.
 */
package org.xwiki.search.solr.internal.reference;

import java.util.ArrayList;
import java.util.List;

import javax.inject.Inject;
import javax.inject.Named;
import javax.inject.Provider;
import javax.inject.Singleton;

import org.apache.solr.client.solrj.util.ClientUtils;
import org.xwiki.component.annotation.Component;
import org.xwiki.model.EntityType;
import org.xwiki.model.reference.EntityReference;
import org.xwiki.model.reference.EntityReferenceResolver;
import org.xwiki.query.QueryException;
import org.xwiki.query.QueryManager;
import org.xwiki.search.solr.internal.api.FieldUtils;
import org.xwiki.search.solr.internal.api.SolrIndexerException;

import com.google.common.collect.Iterables;

/**
 * Resolve wiki references.
 * 
 * @version $Id: b0dd5b02a5fe03076d87a9e4baa9b338873d45eb $
 * @since 5.1M2
 */
@Component
@Named("wiki")
@Singleton
public class WikiSolrReferenceResolver extends AbstractSolrReferenceResolver
{
    /**
     * Used to resolve space references.
     */
    @Inject
    @Named("space")
    private Provider<SolrReferenceResolver> spaceResolverProvider;

    /**
     * Query manager used to perform queries on the XWiki model.
     */
    @Inject
    private QueryManager queryManager;

    @Inject
    @Named("explicit")
    private EntityReferenceResolver<String> explicitEntityReferenceResolver;

    @Override
    public List<EntityReference> getReferences(EntityReference wikiReference) throws SolrIndexerException
    {
        List<EntityReference> result = new ArrayList<EntityReference>();

        // Ignore the wiki reference because it is not indexable.

        List<String> localSpaceRefs = null;

        // Make sure the list of spaces is from the requested wiki.
        try {
            localSpaceRefs = this.queryManager.getNamedQuery("getSpaces").setWiki(wikiReference.getName()).execute();
        } catch (QueryException e) {
            throw new SolrIndexerException("Failed to query wiki [" + wikiReference.getName() + "] spaces", e);
        }

        // Visit each space
        for (String localSpaceRef : localSpaceRefs) {
            EntityReference spaceReference =
                this.explicitEntityReferenceResolver.resolve(localSpaceRef, EntityType.SPACE, wikiReference);

            try {
                Iterables.addAll(result, this.spaceResolverProvider.get().getReferences(spaceReference));
            } catch (Exception e) {
                this.logger.error("Failed to resolve references for space [" + spaceReference + "]", e);
            }
        }

        return result;
    }

    @Override
    public String getQuery(EntityReference reference)
    {
        return FieldUtils.WIKI + ':' + ClientUtils.escapeQueryChars(reference.getName());
    }
}