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