001    /**
002     * Copyright (c) 2000-2013 Liferay, Inc. All rights reserved.
003     *
004     * This library is free software; you can redistribute it and/or modify it under
005     * the terms of the GNU Lesser General Public License as published by the Free
006     * Software Foundation; either version 2.1 of the License, or (at your option)
007     * any later version.
008     *
009     * This library is distributed in the hope that it will be useful, but WITHOUT
010     * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
011     * FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more
012     * details.
013     */
014    
015    package com.liferay.portlet.wiki.util;
016    
017    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
018    import com.liferay.portal.kernel.dao.orm.DynamicQuery;
019    import com.liferay.portal.kernel.dao.orm.Property;
020    import com.liferay.portal.kernel.dao.orm.PropertyFactoryUtil;
021    import com.liferay.portal.kernel.exception.PortalException;
022    import com.liferay.portal.kernel.exception.SystemException;
023    import com.liferay.portal.kernel.search.BaseIndexer;
024    import com.liferay.portal.kernel.search.BooleanClauseOccur;
025    import com.liferay.portal.kernel.search.BooleanQuery;
026    import com.liferay.portal.kernel.search.BooleanQueryFactoryUtil;
027    import com.liferay.portal.kernel.search.Document;
028    import com.liferay.portal.kernel.search.DocumentImpl;
029    import com.liferay.portal.kernel.search.Field;
030    import com.liferay.portal.kernel.search.SearchContext;
031    import com.liferay.portal.kernel.search.SearchEngineUtil;
032    import com.liferay.portal.kernel.search.Summary;
033    import com.liferay.portal.kernel.util.ArrayUtil;
034    import com.liferay.portal.kernel.util.GetterUtil;
035    import com.liferay.portal.kernel.util.HtmlUtil;
036    import com.liferay.portal.kernel.util.Validator;
037    import com.liferay.portal.security.permission.ActionKeys;
038    import com.liferay.portal.security.permission.PermissionChecker;
039    import com.liferay.portal.util.PortalUtil;
040    import com.liferay.portal.util.PortletKeys;
041    import com.liferay.portlet.documentlibrary.model.DLFileEntry;
042    import com.liferay.portlet.messageboards.model.MBMessage;
043    import com.liferay.portlet.wiki.model.WikiNode;
044    import com.liferay.portlet.wiki.model.WikiPage;
045    import com.liferay.portlet.wiki.service.WikiNodeServiceUtil;
046    import com.liferay.portlet.wiki.service.WikiPageLocalServiceUtil;
047    import com.liferay.portlet.wiki.service.permission.WikiPagePermission;
048    import com.liferay.portlet.wiki.service.persistence.WikiNodeActionableDynamicQuery;
049    import com.liferay.portlet.wiki.service.persistence.WikiPageActionableDynamicQuery;
050    
051    import java.util.Locale;
052    
053    import javax.portlet.PortletURL;
054    
055    /**
056     * @author Brian Wing Shun Chan
057     * @author Harry Mark
058     * @author Bruno Farache
059     * @author Raymond Aug??
060     */
061    public class WikiPageIndexer extends BaseIndexer {
062    
063            public static final String[] CLASS_NAMES = {WikiPage.class.getName()};
064    
065            public static final String PORTLET_ID = PortletKeys.WIKI;
066    
067            public WikiPageIndexer() {
068                    setFilterSearch(true);
069                    setPermissionAware(true);
070            }
071    
072            @Override
073            public void addRelatedEntryFields(Document document, Object obj)
074                    throws Exception {
075    
076                    WikiPage page = null;
077    
078                    try {
079                            if (obj instanceof DLFileEntry) {
080                                    DLFileEntry dlFileEntry = (DLFileEntry)obj;
081    
082                                    page = WikiPageAttachmentsUtil.getPage(
083                                            dlFileEntry.getFileEntryId());
084    
085                                    document.addKeyword(
086                                            Field.CLASS_NAME_ID,
087                                            PortalUtil.getClassNameId(WikiPage.class.getName()));
088                                    document.addKeyword(Field.CLASS_PK, page.getResourcePrimKey());
089                            }
090                            else if (obj instanceof MBMessage) {
091                                    MBMessage message = (MBMessage)obj;
092    
093                                    page = WikiPageLocalServiceUtil.getPage(message.getClassPK());
094                            }
095                    }
096                    catch (Exception e) {
097                            return;
098                    }
099    
100                    document.addKeyword(Field.NODE_ID, page.getNodeId());
101                    document.addKeyword(Field.RELATED_ENTRY, true);
102            }
103    
104            @Override
105            public String[] getClassNames() {
106                    return CLASS_NAMES;
107            }
108    
109            @Override
110            public String getPortletId() {
111                    return PORTLET_ID;
112            }
113    
114            @Override
115            public boolean hasPermission(
116                            PermissionChecker permissionChecker, String entryClassName,
117                            long entryClassPK, String actionId)
118                    throws Exception {
119    
120                    WikiPage page = WikiPageLocalServiceUtil.getPage(entryClassPK);
121    
122                    return WikiPagePermission.contains(
123                            permissionChecker, page, ActionKeys.VIEW);
124            }
125    
126            @Override
127            public boolean isVisible(long classPK, int status) throws Exception {
128                    WikiPage page = WikiPageLocalServiceUtil.getPage(classPK);
129    
130                    return isVisible(page.getStatus(), status);
131            }
132    
133            @Override
134            public void postProcessContextQuery(
135                            BooleanQuery contextQuery, SearchContext searchContext)
136                    throws Exception {
137    
138                    addStatus(contextQuery, searchContext);
139    
140                    long[] nodeIds = searchContext.getNodeIds();
141    
142                    if (ArrayUtil.isNotEmpty(nodeIds)) {
143                            BooleanQuery nodeIdsQuery = BooleanQueryFactoryUtil.create(
144                                    searchContext);
145    
146                            for (long nodeId : nodeIds) {
147                                    try {
148                                            WikiNodeServiceUtil.getNode(nodeId);
149                                    }
150                                    catch (Exception e) {
151                                            continue;
152                                    }
153    
154                                    nodeIdsQuery.addTerm(Field.NODE_ID, nodeId);
155                            }
156    
157                            contextQuery.add(nodeIdsQuery, BooleanClauseOccur.MUST);
158                    }
159            }
160    
161            @Override
162            protected void doDelete(Object obj) throws Exception {
163                    SearchContext searchContext = new SearchContext();
164    
165                    searchContext.setSearchEngineId(getSearchEngineId());
166    
167                    if (obj instanceof Object[]) {
168                            Object[] array = (Object[])obj;
169    
170                            long companyId = (Long)array[0];
171                            long nodeId = (Long)array[1];
172                            String title = (String)array[2];
173    
174                            Document document = new DocumentImpl();
175    
176                            document.addUID(PORTLET_ID, nodeId, title);
177    
178                            SearchEngineUtil.deleteDocument(
179                                    getSearchEngineId(), companyId, document.get(Field.UID));
180                    }
181                    else if (obj instanceof WikiPage) {
182                            WikiPage page = (WikiPage)obj;
183    
184                            deleteDocument(page.getCompanyId(), page.getResourcePrimKey());
185                    }
186            }
187    
188            @Override
189            protected Document doGetDocument(Object obj) throws Exception {
190                    WikiPage page = (WikiPage)obj;
191    
192                    Document document = getBaseModelDocument(PORTLET_ID, page);
193    
194                    document.addUID(PORTLET_ID, page.getResourcePrimKey());
195    
196                    String content = HtmlUtil.extractText(
197                            WikiUtil.convert(page, null, null, null));
198    
199                    document.addText(Field.CONTENT, content);
200    
201                    document.addKeyword(Field.NODE_ID, page.getNodeId());
202                    document.addText(Field.TITLE, page.getTitle());
203    
204                    return document;
205            }
206    
207            @Override
208            protected Summary doGetSummary(
209                    Document document, Locale locale, String snippet,
210                    PortletURL portletURL) {
211    
212                    Summary summary = createSummary(document, Field.TITLE, Field.CONTENT);
213    
214                    summary.setMaxContentLength(200);
215    
216                    String nodeId = document.get("nodeId");
217    
218                    portletURL.setParameter("struts_action", "/wiki/view");
219                    portletURL.setParameter("nodeId", nodeId);
220                    portletURL.setParameter("title", summary.getTitle());
221    
222                    summary.setPortletURL(portletURL);
223    
224                    return summary;
225            }
226    
227            @Override
228            protected void doReindex(Object obj) throws Exception {
229                    WikiPage page = (WikiPage)obj;
230    
231                    if (!page.isHead() || (!page.isApproved() && !page.isInTrash())) {
232                            return;
233                    }
234    
235                    if (Validator.isNotNull(page.getRedirectTitle())) {
236                            return;
237                    }
238    
239                    Document document = getDocument(page);
240    
241                    SearchEngineUtil.updateDocument(
242                            getSearchEngineId(), page.getCompanyId(), document);
243            }
244    
245            @Override
246            protected void doReindex(String className, long classPK) throws Exception {
247                    WikiPage page = WikiPageLocalServiceUtil.fetchWikiPage(classPK);
248    
249                    if (page == null) {
250                            page = WikiPageLocalServiceUtil.getPage(classPK, (Boolean)null);
251                    }
252    
253                    doReindex(page);
254            }
255    
256            @Override
257            protected void doReindex(String[] ids) throws Exception {
258                    long companyId = GetterUtil.getLong(ids[0]);
259    
260                    reindexNodes(companyId);
261            }
262    
263            @Override
264            protected String getPortletId(SearchContext searchContext) {
265                    return PORTLET_ID;
266            }
267    
268            protected void reindexNodes(final long companyId)
269                    throws PortalException, SystemException {
270    
271                    ActionableDynamicQuery actionableDynamicQuery =
272                            new WikiNodeActionableDynamicQuery() {
273    
274                            @Override
275                            protected void performAction(Object object)
276                                    throws PortalException, SystemException {
277    
278                                    WikiNode node = (WikiNode)object;
279    
280                                    reindexPages(companyId, node.getGroupId(), node.getNodeId());
281                            }
282    
283                    };
284    
285                    actionableDynamicQuery.setCompanyId(companyId);
286    
287                    actionableDynamicQuery.performActions();
288            }
289    
290            protected void reindexPages(long companyId, long groupId, final long nodeId)
291                    throws PortalException, SystemException {
292    
293                    ActionableDynamicQuery actionableDynamicQuery =
294                            new WikiPageActionableDynamicQuery() {
295    
296                            @Override
297                            protected void addCriteria(DynamicQuery dynamicQuery) {
298                                    Property nodeIdProperty = PropertyFactoryUtil.forName("nodeId");
299    
300                                    dynamicQuery.add(nodeIdProperty.eq(nodeId));
301    
302                                    Property headProperty = PropertyFactoryUtil.forName("head");
303    
304                                    dynamicQuery.add(headProperty.eq(true));
305                            }
306    
307                            @Override
308                            protected void performAction(Object object) throws PortalException {
309                                    WikiPage page = (WikiPage)object;
310    
311                                    Document document = getDocument(page);
312    
313                                    addDocument(document);
314                            }
315    
316                    };
317    
318                    actionableDynamicQuery.setCompanyId(companyId);
319                    actionableDynamicQuery.setGroupId(groupId);
320                    actionableDynamicQuery.setSearchEngineId(getSearchEngineId());
321    
322                    actionableDynamicQuery.performActions();
323            }
324    
325    }