org.sakaiproject.nakamura.connections.search.MyRelatedGroupsPropertyProvider.java Source code

Introduction

Here is the source code for org.sakaiproject.nakamura.connections.search.MyRelatedGroupsPropertyProvider.java

Source

/**
 * Licensed to the Sakai Foundation (SF) under one
 * or more contributor license agreements. See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership. The SF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License. You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.sakaiproject.nakamura.connections.search;

import org.apache.felix.scr.annotations.Component;
import org.apache.felix.scr.annotations.Property;
import org.apache.felix.scr.annotations.Reference;
import org.apache.felix.scr.annotations.Service;
import org.apache.sling.api.SlingHttpServletRequest;
import org.apache.solr.client.solrj.util.ClientUtils;
import org.sakaiproject.nakamura.api.search.SearchConstants;
import org.sakaiproject.nakamura.api.search.solr.SolrSearchUtil;
import org.sakaiproject.nakamura.api.search.solr.SolrSearchException;
import org.sakaiproject.nakamura.api.search.solr.SolrSearchPropertyProvider;
import org.sakaiproject.nakamura.api.search.solr.SolrSearchServiceFactory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.util.Map;

/**
 * Provides properties for myrelatedgroups.json. Added my groups and contact's groups,
 * titles, and tags.
 */
@Component
@Service
@Property(name = SearchConstants.REG_PROVIDER_NAMES, value = "MyRelatedGroupsPropertyProvider")
public class MyRelatedGroupsPropertyProvider implements SolrSearchPropertyProvider {
    private static final Logger LOGGER = LoggerFactory.getLogger(MyRelatedGroupsPropertyProvider.class);

    @Reference
    private SolrSearchServiceFactory searchServiceFactory;

    // @Reference
    // private Repository repo;

    public MyRelatedGroupsPropertyProvider() {
    }

    MyRelatedGroupsPropertyProvider(SolrSearchServiceFactory searchServiceFactory) {
        // this.connPropProv = connPropProv;
        this.searchServiceFactory = searchServiceFactory;
        // this.repo = repo;
    }

    /**
     * Loads properties needed for myrelatedgroups.json.
     *
     * _groupQuery == a (partial) query for the IDs of recommended groups.
     *
     * {@inheritDoc}
     *
     * @see org.sakaiproject.nakamura.api.search.solr.SolrSearchPropertyProvider#loadUserProperties(org.apache.sling.api.SlingHttpServletRequest, java.util.Map)
     */
    public void loadUserProperties(SlingHttpServletRequest request, Map<String, String> propertiesMap) {
        try {
            String user = request.getRemoteUser();

            LOGGER.debug("Recommending groups for: " + user);

            // Perform a MoreLikeThis query for this user's groups
            String suggestedIds = SolrSearchUtil.getMoreLikeThis(request, searchServiceFactory,
                    String.format("type:g AND " + "resourceType:authorizable AND " + "readers:\"%s\"",
                            ClientUtils.escapeQueryChars(user)),
                    "fl", "*,score", "rows", "10", "mlt", "true", "mlt.fl", "type,readers,title,name,tagname",
                    "mlt.count", "10", "mlt.maxntp", "0", "mlt.mintf", "1", "mlt.mindf", "1", "mlt.boost", "true",
                    "mlt.qf", "type^100 readers^3 name^2 tagname^1 title^1");

            if (suggestedIds != null) {
                propertiesMap.put("_groupQuery", String.format(" AND %s AND -readers:\"%s\"", suggestedIds,
                        ClientUtils.escapeQueryChars(user)));
            } else {
                propertiesMap.put("_groupQuery", "");
            }

            LOGGER.debug("Query: " + propertiesMap.get("_groupQuery"));
        } catch (SolrSearchException e) {
            LOGGER.error(e.getMessage(), e);
            throw new IllegalStateException(e);
        }
    }
}