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.usersadmin.util;
016    
017    import com.liferay.portal.kernel.dao.orm.ActionableDynamicQuery;
018    import com.liferay.portal.kernel.exception.PortalException;
019    import com.liferay.portal.kernel.search.BaseIndexer;
020    import com.liferay.portal.kernel.search.BooleanClauseOccur;
021    import com.liferay.portal.kernel.search.BooleanQuery;
022    import com.liferay.portal.kernel.search.BooleanQueryFactoryUtil;
023    import com.liferay.portal.kernel.search.Document;
024    import com.liferay.portal.kernel.search.Field;
025    import com.liferay.portal.kernel.search.SearchContext;
026    import com.liferay.portal.kernel.search.SearchEngineUtil;
027    import com.liferay.portal.kernel.search.Summary;
028    import com.liferay.portal.kernel.util.GetterUtil;
029    import com.liferay.portal.kernel.util.Validator;
030    import com.liferay.portal.model.Organization;
031    import com.liferay.portal.model.OrganizationConstants;
032    import com.liferay.portal.service.OrganizationLocalServiceUtil;
033    import com.liferay.portal.service.persistence.OrganizationActionableDynamicQuery;
034    import com.liferay.portal.util.PortletKeys;
035    import com.liferay.portal.util.PropsValues;
036    
037    import java.util.ArrayList;
038    import java.util.Collection;
039    import java.util.HashMap;
040    import java.util.LinkedHashMap;
041    import java.util.List;
042    import java.util.Locale;
043    import java.util.Map;
044    
045    import javax.portlet.PortletURL;
046    
047    /**
048     * @author Raymond Aug??
049     * @author Zsigmond Rab
050     * @author Hugo Huijser
051     */
052    public class OrganizationIndexer extends BaseIndexer {
053    
054            public static final String[] CLASS_NAMES = {Organization.class.getName()};
055    
056            public static final String PORTLET_ID = PortletKeys.USERS_ADMIN;
057    
058            public OrganizationIndexer() {
059                    setCommitImmediately(true);
060                    setIndexerEnabled(PropsValues.ORGANIZATIONS_INDEXER_ENABLED);
061                    setPermissionAware(true);
062                    setStagingAware(false);
063            }
064    
065            @Override
066            public String[] getClassNames() {
067                    return CLASS_NAMES;
068            }
069    
070            @Override
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                    LinkedHashMap<String, Object> params =
081                            (LinkedHashMap<String, Object>)searchContext.getAttribute("params");
082    
083                    if (params == null) {
084                            return;
085                    }
086    
087                    List<Long> excludedOrganizationIds = (List<Long>)params.get(
088                            "excludedOrganizationIds");
089    
090                    if ((excludedOrganizationIds != null) &&
091                            !excludedOrganizationIds.isEmpty()) {
092    
093                            BooleanQuery booleanQuery = BooleanQueryFactoryUtil.create(
094                                    searchContext);
095    
096                            for (long excludedOrganizationId : excludedOrganizationIds) {
097                                    booleanQuery.addTerm(
098                                            "organizationId", String.valueOf(excludedOrganizationId));
099                            }
100    
101                            contextQuery.add(booleanQuery, BooleanClauseOccur.MUST_NOT);
102                    }
103    
104                    List<Organization> organizationsTree = (List<Organization>)params.get(
105                            "organizationsTree");
106    
107                    if ((organizationsTree != null) && !organizationsTree.isEmpty()) {
108                            BooleanQuery booleanQuery = BooleanQueryFactoryUtil.create(
109                                    searchContext);
110    
111                            for (Organization organization : organizationsTree) {
112                                    String treePath = organization.buildTreePath();
113    
114                                    booleanQuery.addTerm(Field.TREE_PATH, treePath, true);
115                            }
116    
117                            contextQuery.add(booleanQuery, BooleanClauseOccur.MUST);
118                    }
119                    else {
120                            long parentOrganizationId = GetterUtil.getLong(
121                                    searchContext.getAttribute("parentOrganizationId"));
122    
123                            if (parentOrganizationId !=
124                                            OrganizationConstants.ANY_PARENT_ORGANIZATION_ID) {
125    
126                                    contextQuery.addRequiredTerm(
127                                            "parentOrganizationId", parentOrganizationId);
128                            }
129                    }
130            }
131    
132            @Override
133            public void postProcessSearchQuery(
134                            BooleanQuery searchQuery, SearchContext searchContext)
135                    throws Exception {
136    
137                    addSearchTerm(searchQuery, searchContext, "city", false);
138                    addSearchTerm(searchQuery, searchContext, "country", false);
139                    addSearchTerm(searchQuery, searchContext, "name", false);
140                    addSearchTerm(searchQuery, searchContext, "region", false);
141                    addSearchTerm(searchQuery, searchContext, "street", false);
142                    addSearchTerm(searchQuery, searchContext, "type", false);
143                    addSearchTerm(searchQuery, searchContext, "zip", false);
144    
145                    LinkedHashMap<String, Object> params =
146                            (LinkedHashMap<String, Object>)searchContext.getAttribute("params");
147    
148                    if (params != null) {
149                            String expandoAttributes = (String)params.get("expandoAttributes");
150    
151                            if (Validator.isNotNull(expandoAttributes)) {
152                                    addSearchExpando(searchQuery, searchContext, expandoAttributes);
153                            }
154                    }
155            }
156    
157            @Override
158            protected void doDelete(Object obj) throws Exception {
159                    Organization organization = (Organization)obj;
160    
161                    deleteDocument(
162                            organization.getCompanyId(), organization.getOrganizationId());
163            }
164    
165            @Override
166            protected Document doGetDocument(Object obj) throws Exception {
167                    Organization organization = (Organization)obj;
168    
169                    Document document = getBaseModelDocument(PORTLET_ID, organization);
170    
171                    document.addKeyword(Field.COMPANY_ID, organization.getCompanyId());
172                    document.addText(Field.NAME, organization.getName());
173                    document.addKeyword(
174                            Field.ORGANIZATION_ID, organization.getOrganizationId());
175                    document.addKeyword(Field.TREE_PATH, organization.buildTreePath());
176                    document.addKeyword(Field.TYPE, organization.getType());
177    
178                    document.addKeyword(
179                            "parentOrganizationId", organization.getParentOrganizationId());
180    
181                    populateAddresses(
182                            document, organization.getAddresses(), organization.getRegionId(),
183                            organization.getCountryId());
184    
185                    return document;
186            }
187    
188            @Override
189            protected String doGetSortField(String orderByCol) {
190                    if (orderByCol.equals("name")) {
191                            return "name";
192                    }
193                    else if (orderByCol.equals("type")) {
194                            return "type";
195                    }
196                    else {
197                            return orderByCol;
198                    }
199            }
200    
201            @Override
202            protected Summary doGetSummary(
203                    Document document, Locale locale, String snippet,
204                    PortletURL portletURL) {
205    
206                    String title = document.get("name");
207    
208                    String content = null;
209    
210                    String organizationId = document.get(Field.ORGANIZATION_ID);
211    
212                    portletURL.setParameter(
213                            "struts_action", "/users_admin/edit_organization");
214                    portletURL.setParameter("organizationId", organizationId);
215    
216                    return new Summary(title, content, portletURL);
217            }
218    
219            @Override
220            protected void doReindex(Object obj) throws Exception {
221                    if (obj instanceof Long) {
222                            long organizationId = (Long)obj;
223    
224                            Organization organization =
225                                    OrganizationLocalServiceUtil.getOrganization(organizationId);
226    
227                            doReindex(organization);
228                    }
229                    else if (obj instanceof long[]) {
230                            long[] organizationIds = (long[])obj;
231    
232                            Map<Long, Collection<Document>> documentsMap =
233                                    new HashMap<Long, Collection<Document>>();
234    
235                            for (long organizationId : organizationIds) {
236                                    Organization organization =
237                                            OrganizationLocalServiceUtil.fetchOrganization(
238                                                    organizationId);
239    
240                                    if (organization == null) {
241                                            continue;
242                                    }
243    
244                                    Document document = getDocument(organization);
245    
246                                    long companyId = organization.getCompanyId();
247    
248                                    Collection<Document> documents = documentsMap.get(companyId);
249    
250                                    if (documents == null) {
251                                            documents = new ArrayList<Document>();
252    
253                                            documentsMap.put(companyId, documents);
254                                    }
255    
256                                    documents.add(document);
257                            }
258    
259                            for (Map.Entry<Long, Collection<Document>> entry :
260                                            documentsMap.entrySet()) {
261    
262                                    long companyId = entry.getKey();
263                                    Collection<Document> documents = entry.getValue();
264    
265                                    SearchEngineUtil.updateDocuments(
266                                            getSearchEngineId(), companyId, documents,
267                                            isCommitImmediately());
268                            }
269                    }
270                    else if (obj instanceof Organization) {
271                            Organization organization = (Organization)obj;
272    
273                            Document document = getDocument(organization);
274    
275                            SearchEngineUtil.updateDocument(
276                                    getSearchEngineId(), organization.getCompanyId(), document,
277                                    isCommitImmediately());
278                    }
279            }
280    
281            @Override
282            protected void doReindex(String className, long classPK) throws Exception {
283                    Organization organization =
284                            OrganizationLocalServiceUtil.getOrganization(classPK);
285    
286                    doReindex(organization);
287            }
288    
289            @Override
290            protected void doReindex(String[] ids) throws Exception {
291                    long companyId = GetterUtil.getLong(ids[0]);
292    
293                    reindexOrganizations(companyId);
294            }
295    
296            @Override
297            protected String getPortletId(SearchContext searchContext) {
298                    return PORTLET_ID;
299            }
300    
301            protected void reindexOrganizations(long companyId) throws Exception {
302                    ActionableDynamicQuery actionableDynamicQuery =
303                            new OrganizationActionableDynamicQuery() {
304    
305                            @Override
306                            protected void performAction(Object object) throws PortalException {
307                                    Organization organization = (Organization)object;
308    
309                                    Document document = getDocument(organization);
310    
311                                    addDocument(document);
312                            }
313    
314                    };
315    
316                    actionableDynamicQuery.setCompanyId(companyId);
317                    actionableDynamicQuery.setSearchEngineId(getSearchEngineId());
318    
319                    actionableDynamicQuery.performActions();
320            }
321    
322    }