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