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.bookmarks.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.BooleanQuery;
025    import com.liferay.portal.kernel.search.Document;
026    import com.liferay.portal.kernel.search.Field;
027    import com.liferay.portal.kernel.search.SearchContext;
028    import com.liferay.portal.kernel.search.SearchEngineUtil;
029    import com.liferay.portal.kernel.search.Summary;
030    import com.liferay.portal.kernel.util.CharPool;
031    import com.liferay.portal.kernel.util.GetterUtil;
032    import com.liferay.portal.kernel.util.StringUtil;
033    import com.liferay.portal.kernel.workflow.WorkflowConstants;
034    import com.liferay.portal.model.Group;
035    import com.liferay.portal.security.permission.ActionKeys;
036    import com.liferay.portal.security.permission.PermissionChecker;
037    import com.liferay.portal.service.persistence.GroupActionableDynamicQuery;
038    import com.liferay.portal.util.PortletKeys;
039    import com.liferay.portlet.bookmarks.model.BookmarksEntry;
040    import com.liferay.portlet.bookmarks.model.BookmarksFolder;
041    import com.liferay.portlet.bookmarks.model.BookmarksFolderConstants;
042    import com.liferay.portlet.bookmarks.service.BookmarksEntryLocalServiceUtil;
043    import com.liferay.portlet.bookmarks.service.permission.BookmarksEntryPermission;
044    import com.liferay.portlet.bookmarks.service.persistence.BookmarksEntryActionableDynamicQuery;
045    import com.liferay.portlet.bookmarks.service.persistence.BookmarksFolderActionableDynamicQuery;
046    
047    import java.util.Locale;
048    
049    import javax.portlet.PortletURL;
050    
051    /**
052     * @author Brian Wing Shun Chan
053     * @author Bruno Farache
054     * @author Raymond Aug??
055     */
056    public class BookmarksEntryIndexer extends BaseIndexer {
057    
058            public static final String[] CLASS_NAMES = {BookmarksEntry.class.getName()};
059    
060            public static final String PORTLET_ID = PortletKeys.BOOKMARKS;
061    
062            public BookmarksEntryIndexer() {
063                    setFilterSearch(true);
064                    setPermissionAware(true);
065            }
066    
067            @Override
068            public String[] getClassNames() {
069                    return CLASS_NAMES;
070            }
071    
072            @Override
073            public String getPortletId() {
074                    return PORTLET_ID;
075            }
076    
077            @Override
078            public boolean hasPermission(
079                            PermissionChecker permissionChecker, String entryClassName,
080                            long entryClassPK, String actionId)
081                    throws Exception {
082    
083                    return BookmarksEntryPermission.contains(
084                            permissionChecker, entryClassPK, ActionKeys.VIEW);
085            }
086    
087            @Override
088            public void postProcessContextQuery(
089                            BooleanQuery contextQuery, SearchContext searchContext)
090                    throws Exception {
091    
092                    addStatus(contextQuery, searchContext);
093            }
094    
095            @Override
096            protected void doDelete(Object obj) throws Exception {
097                    BookmarksEntry entry = (BookmarksEntry)obj;
098    
099                    deleteDocument(entry.getCompanyId(), entry.getEntryId());
100            }
101    
102            @Override
103            protected Document doGetDocument(Object obj) throws Exception {
104                    BookmarksEntry entry = (BookmarksEntry)obj;
105    
106                    Document document = getBaseModelDocument(PORTLET_ID, entry);
107    
108                    document.addText(Field.DESCRIPTION, entry.getDescription());
109                    document.addKeyword(Field.FOLDER_ID, entry.getFolderId());
110                    document.addText(Field.TITLE, entry.getName());
111                    document.addKeyword(
112                            Field.TREE_PATH,
113                            StringUtil.split(entry.getTreePath(), CharPool.SLASH));
114                    document.addText(Field.URL, entry.getUrl());
115    
116                    return document;
117            }
118    
119            @Override
120            protected Summary doGetSummary(
121                    Document document, Locale locale, String snippet,
122                    PortletURL portletURL) {
123    
124                    String entryId = document.get(Field.ENTRY_CLASS_PK);
125    
126                    portletURL.setParameter("struts_action", "/bookmarks/view_entry");
127                    portletURL.setParameter("entryId", entryId);
128    
129                    Summary summary = createSummary(document, Field.TITLE, Field.URL);
130    
131                    summary.setPortletURL(portletURL);
132    
133                    return summary;
134            }
135    
136            @Override
137            protected void doReindex(Object obj) throws Exception {
138                    BookmarksEntry entry = (BookmarksEntry)obj;
139    
140                    Document document = getDocument(entry);
141    
142                    SearchEngineUtil.updateDocument(
143                            getSearchEngineId(), entry.getCompanyId(), document);
144            }
145    
146            @Override
147            protected void doReindex(String className, long classPK) throws Exception {
148                    BookmarksEntry entry = BookmarksEntryLocalServiceUtil.getEntry(classPK);
149    
150                    doReindex(entry);
151            }
152    
153            @Override
154            protected void doReindex(String[] ids) throws Exception {
155                    long companyId = GetterUtil.getLong(ids[0]);
156    
157                    reindexFolders(companyId);
158                    reindexRoot(companyId);
159            }
160    
161            @Override
162            protected String getPortletId(SearchContext searchContext) {
163                    return PORTLET_ID;
164            }
165    
166            protected void reindexEntries(
167                            long companyId, final long groupId, final long folderId)
168                    throws PortalException, SystemException {
169    
170                    ActionableDynamicQuery actionableDynamicQuery =
171                            new BookmarksEntryActionableDynamicQuery() {
172    
173                            @Override
174                            protected void addCriteria(DynamicQuery dynamicQuery) {
175                                    Property folderIdProperty = PropertyFactoryUtil.forName(
176                                            "folderId");
177    
178                                    dynamicQuery.add(folderIdProperty.eq(folderId));
179    
180                                    Property statusProperty = PropertyFactoryUtil.forName("status");
181    
182                                    Integer[] statuses = {
183                                            WorkflowConstants.STATUS_APPROVED,
184                                            WorkflowConstants.STATUS_IN_TRASH
185                                    };
186    
187                                    dynamicQuery.add(statusProperty.in(statuses));
188                            }
189    
190                            @Override
191                            protected void performAction(Object object) throws PortalException {
192                                    BookmarksEntry entry = (BookmarksEntry)object;
193    
194                                    Document document = getDocument(entry);
195    
196                                    addDocument(document);
197                            }
198    
199                    };
200    
201                    actionableDynamicQuery.setCompanyId(companyId);
202                    actionableDynamicQuery.setGroupId(groupId);
203                    actionableDynamicQuery.setSearchEngineId(getSearchEngineId());
204    
205                    actionableDynamicQuery.performActions();
206            }
207    
208            protected void reindexFolders(final long companyId)
209                    throws PortalException, SystemException {
210    
211                    ActionableDynamicQuery actionableDynamicQuery =
212                            new BookmarksFolderActionableDynamicQuery() {
213    
214                            @Override
215                            protected void performAction(Object object)
216                                    throws PortalException, SystemException {
217    
218                                    BookmarksFolder folder = (BookmarksFolder)object;
219    
220                                    long groupId = folder.getGroupId();
221                                    long folderId = folder.getFolderId();
222    
223                                    reindexEntries(companyId, groupId, folderId);
224                            }
225    
226                    };
227    
228                    actionableDynamicQuery.setCompanyId(companyId);
229    
230                    actionableDynamicQuery.performActions();
231            }
232    
233            protected void reindexRoot(final long companyId)
234                    throws PortalException, SystemException {
235    
236                    ActionableDynamicQuery actionableDynamicQuery =
237                            new GroupActionableDynamicQuery() {
238    
239                            @Override
240                            protected void performAction(Object object)
241                                    throws PortalException, SystemException {
242    
243                                    Group group = (Group)object;
244    
245                                    long groupId = group.getGroupId();
246                                    long folderId =
247                                            BookmarksFolderConstants.DEFAULT_PARENT_FOLDER_ID;
248    
249                                    reindexEntries(companyId, groupId, folderId);
250                            }
251    
252                    };
253    
254                    actionableDynamicQuery.setCompanyId(companyId);
255    
256                    actionableDynamicQuery.performActions();
257            }
258    
259    }