001    /**
002     * Copyright (c) 2000-2012 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            public BookmarksIndexer() {
062                    setPermissionAware(true);
063            }
064    
065            public String[] getClassNames() {
066                    return CLASS_NAMES;
067            }
068    
069            public String getPortletId() {
070                    return PORTLET_ID;
071            }
072    
073            @Override
074            public void postProcessContextQuery(
075                            BooleanQuery contextQuery, SearchContext searchContext)
076                    throws Exception {
077    
078                    long[] folderIds = searchContext.getFolderIds();
079    
080                    if ((folderIds != null) && (folderIds.length > 0)) {
081                            if (folderIds[0] ==
082                                            BookmarksFolderConstants.DEFAULT_PARENT_FOLDER_ID) {
083    
084                                    return;
085                            }
086    
087                            BooleanQuery folderIdsQuery = BooleanQueryFactoryUtil.create(
088                                    searchContext);
089    
090                            for (long folderId : folderIds) {
091                                    try {
092                                            BookmarksFolderServiceUtil.getFolder(folderId);
093                                    }
094                                    catch (Exception e) {
095                                            continue;
096                                    }
097    
098                                    folderIdsQuery.addTerm(Field.FOLDER_ID, folderId);
099                            }
100    
101                            contextQuery.add(folderIdsQuery, BooleanClauseOccur.MUST);
102                    }
103            }
104    
105            @Override
106            protected void doDelete(Object obj) throws Exception {
107                    BookmarksEntry entry = (BookmarksEntry)obj;
108    
109                    deleteDocument(entry.getCompanyId(), entry.getEntryId());
110            }
111    
112            @Override
113            protected Document doGetDocument(Object obj) throws Exception {
114                    BookmarksEntry entry = (BookmarksEntry)obj;
115    
116                    Document document = getBaseModelDocument(PORTLET_ID, entry);
117    
118                    document.addText(Field.DESCRIPTION, entry.getDescription());
119                    document.addKeyword(Field.FOLDER_ID, entry.getFolderId());
120                    document.addText(Field.TITLE, entry.getName());
121                    document.addText(Field.URL, entry.getUrl());
122    
123                    return document;
124            }
125    
126            @Override
127            protected Summary doGetSummary(
128                    Document document, Locale locale, String snippet,
129                    PortletURL portletURL) {
130    
131                    String entryId = document.get(Field.ENTRY_CLASS_PK);
132    
133                    portletURL.setParameter("struts_action", "/bookmarks/view_entry");
134                    portletURL.setParameter("entryId", entryId);
135    
136                    Summary summary = createSummary(document, Field.TITLE, Field.URL);
137    
138                    summary.setPortletURL(portletURL);
139    
140                    return summary;
141            }
142    
143            @Override
144            protected void doReindex(Object obj) throws Exception {
145                    BookmarksEntry entry = (BookmarksEntry)obj;
146    
147                    Document document = getDocument(entry);
148    
149                    SearchEngineUtil.updateDocument(
150                            getSearchEngineId(), entry.getCompanyId(), document);
151            }
152    
153            @Override
154            protected void doReindex(String className, long classPK) throws Exception {
155                    BookmarksEntry entry = BookmarksEntryLocalServiceUtil.getEntry(classPK);
156    
157                    doReindex(entry);
158            }
159    
160            @Override
161            protected void doReindex(String[] ids) throws Exception {
162                    long companyId = GetterUtil.getLong(ids[0]);
163    
164                    reindexFolders(companyId);
165                    reindexRoot(companyId);
166            }
167    
168            @Override
169            protected String getPortletId(SearchContext searchContext) {
170                    return PORTLET_ID;
171            }
172    
173            protected void reindexEntries(
174                            long companyId, final long groupId, final long folderId)
175                    throws PortalException, SystemException {
176    
177                    final Collection<Document> documents = new ArrayList<Document>();
178    
179                    ActionableDynamicQuery actionableDynamicQuery =
180                            new BookmarksEntryActionableDynamicQuery() {
181    
182                            @Override
183                            protected void addCriteria(DynamicQuery dynamicQuery) {
184                                    Property property = PropertyFactoryUtil.forName("folderId");
185    
186                                    dynamicQuery.add(property.eq(folderId));
187                            }
188    
189                            @Override
190                            protected void performAction(Object object) throws PortalException {
191                                    BookmarksEntry entry = (BookmarksEntry)object;
192    
193                                    Document document = getDocument(entry);
194    
195                                    documents.add(document);
196                            }
197    
198                    };
199    
200                    actionableDynamicQuery.setGroupId(groupId);
201    
202                    actionableDynamicQuery.performActions();
203    
204                    SearchEngineUtil.updateDocuments(
205                            getSearchEngineId(), companyId, documents);
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    }