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