OpenSearchBeanImpl.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/search/trunk/search-tool/tool/src/java/org/sakaiproject/search/tool/OpenSearchBeanImpl.java $
 * $Id: OpenSearchBeanImpl.java 105078 2012-02-24 23:00:38Z ottenhoff@longsight.com $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008, 2009 The Sakai Foundation
 *
 * Licensed under the Educational Community 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.opensource.org/licenses/ECL-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.search.tool;

import javax.servlet.http.HttpServletRequest;

import org.sakaiproject.component.cover.ServerConfigurationService;
import org.sakaiproject.entity.api.ResourceProperties;
import org.sakaiproject.exception.IdUnusedException;
import org.sakaiproject.search.api.SearchService;
import org.sakaiproject.search.tool.SearchBeanImpl.Scope;
import org.sakaiproject.search.tool.api.OpenSearchBean;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.tool.api.ToolManager;
import org.sakaiproject.util.FormattedText;

/**
 * @author ieb
 */
public class OpenSearchBeanImpl implements OpenSearchBean
{

	private SiteService siteService;

	private String placementId;

	private String siteId;

	private Site currentSite;

	private String baseURL;
	private String scope = null;
	public OpenSearchBeanImpl(HttpServletRequest request,
			SearchService searchService, SiteService siteService,
			ToolManager toolManager) throws IdUnusedException
	{
		this.siteService = siteService;
		this.placementId = toolManager.getCurrentPlacement().getId();
		this.siteId = toolManager.getCurrentPlacement().getContext();
		this.currentSite = this.siteService.getSite(this.siteId);
		if (siteService.isUserSite(siteId)) {
			scope = Scope.MINE.name();
		} else {
			scope = Scope.SITE.name();
		}
		baseURL = getBaseURL();
	}

	private String getBaseURL()
	{
		return ServerConfigurationService.getPortalUrl()+"/tool/"+placementId;
	}

	public String getAdultContent()
	{
		return "false";
	}

	public String getAttibution()
	{
		String copyright = ServerConfigurationService
				.getString("default.copyright");
		String siteCopyright = currentSite.getProperties().getProperty(
				ResourceProperties.PROP_COPYRIGHT);
		if (siteCopyright != null)
		{
			copyright = siteCopyright;
		}
		return FormattedText.escapeHtml(copyright,false);
	}

	public String getHTMLSearchFormUrl()
	{
		return baseURL + "/index";
	}

	public String getHTMLSearchTemplate()
	{
		return baseURL + "/index?panel=Main&scope=" + scope +"&search={searchTerms}";
	}

	public String getIconUrl()
	{
		String iconURL = currentSite.getIconUrlFull();
		if ( iconURL == null ) {
			iconURL = ServerConfigurationService.getServerUrl()+"/favicon.ico";
		}
		return FormattedText.escapeHtml(iconURL,false);
	}
	

	public String getRSSSearchTemplate()
	{
		return baseURL + "/rss20?panel=Main&search={searchTerms}";
	}

	public String getSindicationRight()
	{
		String sindicationRights = "private";
		if (currentSite.isPubView())
		{
			sindicationRights = "limited";
		}
		return FormattedText.escapeHtml(sindicationRights,false);
	}

	public String getSiteName()
	{
		return FormattedText.escapeHtml(currentSite.getTitle(),false);
	}
	public String getSystemName()
	{
		return FormattedText.escapeHtml(ServerConfigurationService.getString("ui.service","Sakai"),false);
	}


}