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