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 void postProcessContextQuery(
128                            BooleanQuery contextQuery, SearchContext searchContext)
129                    throws Exception {
130    
131                    addStatus(contextQuery, searchContext);
132    
133                    long[] nodeIds = searchContext.getNodeIds();
134    
135                    if (ArrayUtil.isNotEmpty(nodeIds)) {
136                            BooleanQuery nodeIdsQuery = BooleanQueryFactoryUtil.create(
137                                    searchContext);
138    
139                            for (long nodeId : nodeIds) {
140                                    try {
141                                            WikiNodeServiceUtil.getNode(nodeId);
142                                    }
143                                    catch (Exception e) {
144                                            continue;
145                                    }
146    
147                                    nodeIdsQuery.addTerm(Field.NODE_ID, nodeId);
148                            }
149    
150                            contextQuery.add(nodeIdsQuery, BooleanClauseOccur.MUST);
151                    }
152            }
153    
154            @Override
155            protected void doDelete(Object obj) throws Exception {
156                    SearchContext searchContext = new SearchContext();
157    
158                    searchContext.setSearchEngineId(getSearchEngineId());
159    
160                    if (obj instanceof Object[]) {
161                            Object[] array = (Object[])obj;
162    
163                            long companyId = (Long)array[0];
164                            long nodeId = (Long)array[1];
165                            String title = (String)array[2];
166    
167                            Document document = new DocumentImpl();
168    
169                            document.addUID(PORTLET_ID, nodeId, title);
170    
171                            SearchEngineUtil.deleteDocument(
172                                    getSearchEngineId(), companyId, document.get(Field.UID));
173                    }
174                    else if (obj instanceof WikiPage) {
175                            WikiPage page = (WikiPage)obj;
176    
177                            deleteDocument(page.getCompanyId(), page.getPageId());
178                    }
179            }
180    
181            @Override
182            protected Document doGetDocument(Object obj) throws Exception {
183                    WikiPage page = (WikiPage)obj;
184    
185                    Document document = getBaseModelDocument(PORTLET_ID, page);
186    
187                    document.addUID(PORTLET_ID, page.getNodeId(), page.getTitle());
188    
189                    String content = HtmlUtil.extractText(
190                            WikiUtil.convert(page, null, null, null));
191    
192                    document.addText(Field.CONTENT, content);
193    
194                    document.addKeyword(Field.NODE_ID, page.getNodeId());
195                    document.addText(Field.TITLE, page.getTitle());
196    
197                    return document;
198            }
199    
200            @Override
201            protected Summary doGetSummary(
202                    Document document, Locale locale, String snippet,
203                    PortletURL portletURL) {
204    
205                    Summary summary = createSummary(document, Field.TITLE, Field.CONTENT);
206    
207                    summary.setMaxContentLength(200);
208    
209                    String nodeId = document.get("nodeId");
210    
211                    portletURL.setParameter("struts_action", "/wiki/view");
212                    portletURL.setParameter("nodeId", nodeId);
213                    portletURL.setParameter("title", summary.getTitle());
214    
215                    summary.setPortletURL(portletURL);
216    
217                    return summary;
218            }
219    
220            @Override
221            protected void doReindex(Object obj) throws Exception {
222                    WikiPage page = (WikiPage)obj;
223    
224                    if (!page.isHead() || (!page.isApproved() && !page.isInTrash())) {
225                            return;
226                    }
227    
228                    if (Validator.isNotNull(page.getRedirectTitle())) {
229                            return;
230                    }
231    
232                    Document document = getDocument(page);
233    
234                    SearchEngineUtil.updateDocument(
235                            getSearchEngineId(), page.getCompanyId(), document);
236            }
237    
238            @Override
239            protected void doReindex(String className, long classPK) throws Exception {
240                    WikiPage page = WikiPageLocalServiceUtil.getPage(
241                            classPK, (Boolean)null);
242    
243                    doReindex(page);
244            }
245    
246            @Override
247            protected void doReindex(String[] ids) throws Exception {
248                    long companyId = GetterUtil.getLong(ids[0]);
249    
250                    reindexNodes(companyId);
251            }
252    
253            @Override
254            protected String getPortletId(SearchContext searchContext) {
255                    return PORTLET_ID;
256            }
257    
258            protected void reindexNodes(final long companyId)
259                    throws PortalException, SystemException {
260    
261                    ActionableDynamicQuery actionableDynamicQuery =
262                            new WikiNodeActionableDynamicQuery() {
263    
264                            @Override
265                            protected void performAction(Object object)
266                                    throws PortalException, SystemException {
267    
268                                    WikiNode node = (WikiNode)object;
269    
270                                    reindexPages(companyId, node.getGroupId(), node.getNodeId());
271                            }
272    
273                    };
274    
275                    actionableDynamicQuery.setCompanyId(companyId);
276    
277                    actionableDynamicQuery.performActions();
278            }
279    
280            protected void reindexPages(long companyId, long groupId, final long nodeId)
281                    throws PortalException, SystemException {
282    
283                    ActionableDynamicQuery actionableDynamicQuery =
284                            new WikiPageActionableDynamicQuery() {
285    
286                            @Override
287                            protected void addCriteria(DynamicQuery dynamicQuery) {
288                                    Property nodeIdProperty = PropertyFactoryUtil.forName("nodeId");
289    
290                                    dynamicQuery.add(nodeIdProperty.eq(nodeId));
291    
292                                    Property headProperty = PropertyFactoryUtil.forName("head");
293    
294                                    dynamicQuery.add(headProperty.eq(true));
295                            }
296    
297                            @Override
298                            protected void performAction(Object object) throws PortalException {
299                                    WikiPage page = (WikiPage)object;
300    
301                                    Document document = getDocument(page);
302    
303                                    addDocument(document);
304                            }
305    
306                    };
307    
308                    actionableDynamicQuery.setCompanyId(companyId);
309                    actionableDynamicQuery.setGroupId(groupId);
310                    actionableDynamicQuery.setSearchEngineId(getSearchEngineId());
311    
312                    actionableDynamicQuery.performActions();
313            }
314    
315    }