com.liferay.portlet.wiki.util.WikiIndexer.java Source code

Java tutorial

Introduction

Here is the source code for com.liferay.portlet.wiki.util.WikiIndexer.java

Source

/**
 * Copyright (c) 2000-2012 Liferay, Inc. All rights reserved.
 *
 * This library 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 library 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.
 */

package com.liferay.portlet.wiki.util;

import com.liferay.portal.kernel.dao.orm.QueryUtil;
import com.liferay.portal.kernel.search.BaseIndexer;
import com.liferay.portal.kernel.search.BooleanClauseOccur;
import com.liferay.portal.kernel.search.BooleanQuery;
import com.liferay.portal.kernel.search.BooleanQueryFactoryUtil;
import com.liferay.portal.kernel.search.Document;
import com.liferay.portal.kernel.search.DocumentImpl;
import com.liferay.portal.kernel.search.Field;
import com.liferay.portal.kernel.search.Hits;
import com.liferay.portal.kernel.search.Indexer;
import com.liferay.portal.kernel.search.SearchContext;
import com.liferay.portal.kernel.search.SearchEngineUtil;
import com.liferay.portal.kernel.search.Summary;
import com.liferay.portal.kernel.util.GetterUtil;
import com.liferay.portal.kernel.util.HtmlUtil;
import com.liferay.portal.kernel.util.StringUtil;
import com.liferay.portal.kernel.util.Validator;
import com.liferay.portal.kernel.workflow.WorkflowConstants;
import com.liferay.portal.util.PortletKeys;
import com.liferay.portlet.wiki.model.WikiNode;
import com.liferay.portlet.wiki.model.WikiPage;
import com.liferay.portlet.wiki.service.WikiNodeLocalServiceUtil;
import com.liferay.portlet.wiki.service.WikiNodeServiceUtil;
import com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil;

import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Locale;

import javax.portlet.PortletURL;

/**
 * @author Brian Wing Shun Chan
 * @author Harry Mark
 * @author Bruno Farache
 * @author Raymond Aug
 */
public class WikiIndexer extends BaseIndexer {

    public static final String[] CLASS_NAMES = { WikiPage.class.getName() };

    public static final String PORTLET_ID = PortletKeys.WIKI;

    public String[] getClassNames() {
        return CLASS_NAMES;
    }

    public String getPortletId() {
        return PORTLET_ID;
    }

    @Override
    public boolean isPermissionAware() {
        return _PERMISSION_AWARE;
    }

    @Override
    public void postProcessContextQuery(BooleanQuery contextQuery, SearchContext searchContext) throws Exception {

        int status = GetterUtil.getInteger(searchContext.getAttribute(Field.STATUS), WorkflowConstants.STATUS_ANY);

        if (status != WorkflowConstants.STATUS_ANY) {
            contextQuery.addRequiredTerm(Field.STATUS, status);
        }

        long[] nodeIds = searchContext.getNodeIds();

        if ((nodeIds != null) && (nodeIds.length > 0)) {
            BooleanQuery nodeIdsQuery = BooleanQueryFactoryUtil.create(searchContext);

            for (long nodeId : nodeIds) {
                try {
                    WikiNodeServiceUtil.getNode(nodeId);
                } catch (Exception e) {
                    continue;
                }

                nodeIdsQuery.addTerm(Field.NODE_ID, nodeId);
            }

            contextQuery.add(nodeIdsQuery, BooleanClauseOccur.MUST);
        }
    }

    @Override
    protected void doDelete(Object obj) throws Exception {
        SearchContext searchContext = new SearchContext();

        searchContext.setSearchEngineId(SearchEngineUtil.SYSTEM_ENGINE_ID);

        if (obj instanceof Object[]) {
            Object[] array = (Object[]) obj;

            long companyId = (Long) array[0];
            long nodeId = (Long) array[1];
            String title = (String) array[2];

            Document document = new DocumentImpl();

            document.addUID(PORTLET_ID, nodeId, title);

            SearchEngineUtil.deleteDocument(companyId, document.get(Field.UID));

        } else if (obj instanceof WikiNode) {
            WikiNode node = (WikiNode) obj;

            BooleanQuery booleanQuery = BooleanQueryFactoryUtil.create(searchContext);

            booleanQuery.addRequiredTerm(Field.PORTLET_ID, PORTLET_ID);

            booleanQuery.addRequiredTerm("nodeId", node.getNodeId());

            Hits hits = SearchEngineUtil.search(node.getCompanyId(), booleanQuery, QueryUtil.ALL_POS,
                    QueryUtil.ALL_POS);

            for (int i = 0; i < hits.getLength(); i++) {
                Document document = hits.doc(i);

                SearchEngineUtil.deleteDocument(node.getCompanyId(), document.get(Field.UID));
            }
        } else if (obj instanceof WikiPage) {
            WikiPage page = (WikiPage) obj;

            Document document = new DocumentImpl();

            document.addUID(PORTLET_ID, page.getNodeId(), page.getTitle());

            SearchEngineUtil.deleteDocument(page.getCompanyId(), document.get(Field.UID));
        }
    }

    @Override
    protected Document doGetDocument(Object obj) throws Exception {
        WikiPage page = (WikiPage) obj;

        Document document = getBaseModelDocument(PORTLET_ID, page);

        document.addUID(PORTLET_ID, page.getNodeId(), page.getTitle());

        String content = HtmlUtil.extractText(WikiUtil.convert(page, null, null, null));

        document.addText(Field.CONTENT, content);

        document.addKeyword(Field.NODE_ID, page.getNodeId());
        document.addText(Field.TITLE, page.getTitle());

        return document;
    }

    @Override
    protected Summary doGetSummary(Document document, Locale locale, String snippet, PortletURL portletURL) {

        String title = document.get(Field.TITLE);

        String content = snippet;

        if (Validator.isNull(snippet)) {
            content = StringUtil.shorten(document.get(Field.CONTENT), 200);
        }

        String nodeId = document.get("nodeId");

        portletURL.setParameter("struts_action", "/wiki/view");
        portletURL.setParameter("nodeId", nodeId);
        portletURL.setParameter("title", title);

        return new Summary(title, content, portletURL);
    }

    @Override
    protected void doReindex(Object obj) throws Exception {
        WikiPage page = (WikiPage) obj;

        if (Validator.isNotNull(page.getRedirectTitle())) {
            return;
        }

        Document document = getDocument(page);

        SearchEngineUtil.updateDocument(page.getCompanyId(), document);
    }

    @Override
    protected void doReindex(String className, long classPK) throws Exception {
        WikiPage page = WikiPageLocalServiceUtil.getPage(classPK);

        doReindex(page);
    }

    @Override
    protected void doReindex(String[] ids) throws Exception {
        long companyId = GetterUtil.getLong(ids[0]);

        reindexNodes(companyId);
    }

    @Override
    protected String getPortletId(SearchContext searchContext) {
        return PORTLET_ID;
    }

    protected void reindexNodes(long companyId) throws Exception {
        int nodeCount = WikiNodeLocalServiceUtil.getCompanyNodesCount(companyId);

        int nodePages = nodeCount / Indexer.DEFAULT_INTERVAL;

        for (int i = 0; i <= nodePages; i++) {
            int nodeStart = (i * Indexer.DEFAULT_INTERVAL);
            int nodeEnd = nodeStart + Indexer.DEFAULT_INTERVAL;

            reindexNodes(companyId, nodeStart, nodeEnd);
        }
    }

    protected void reindexNodes(long companyId, int nodeStart, int nodeEnd) throws Exception {

        List<WikiNode> nodes = WikiNodeLocalServiceUtil.getCompanyNodes(companyId, nodeStart, nodeEnd);

        for (WikiNode node : nodes) {
            long nodeId = node.getNodeId();

            int pageCount = WikiPageLocalServiceUtil.getPagesCount(nodeId, true);

            int pagePages = pageCount / Indexer.DEFAULT_INTERVAL;

            for (int i = 0; i <= pagePages; i++) {
                int pageStart = (i * Indexer.DEFAULT_INTERVAL);
                int pageEnd = pageStart + Indexer.DEFAULT_INTERVAL;

                reindexPages(companyId, nodeId, pageStart, pageEnd);
            }
        }
    }

    protected void reindexPages(long companyId, long nodeId, int pageStart, int pageEnd) throws Exception {

        List<WikiPage> pages = WikiPageLocalServiceUtil.getPages(nodeId, true, pageStart, pageEnd);

        if (pages.isEmpty()) {
            return;
        }

        Collection<Document> documents = new ArrayList<Document>();

        for (WikiPage page : pages) {
            Document document = getDocument(page);

            documents.add(document);
        }

        SearchEngineUtil.updateDocuments(companyId, documents);
    }

    private static final boolean _PERMISSION_AWARE = true;

}