BaseToolConfiguration.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/trunk/sakai/admin-tools/su/src/java/org/sakaiproject/tool/su/SuTool.java $
 * $Id: SuTool.java 5970 2006-02-15 03:07:19Z ggolden@umich.edu $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 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.site.impl;

import java.util.Enumeration;
import java.util.Hashtable;
import java.util.Properties;
import java.util.Stack;

import org.apache.commons.lang.StringUtils;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.sakaiproject.site.api.SitePage;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.tool.api.Tool;
import org.sakaiproject.util.StringUtil;
import org.sakaiproject.util.Xml;
import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * <p>
 * BaseToolConfiguration is an implementation of the Site API's
 * ToolConfiguration.
 * </p>
 */
public class BaseToolConfiguration extends org.sakaiproject.util.Placement implements
		ToolConfiguration, Identifiable
{
	/** Our log (commons). */
	private static Log M_log = LogFactory.getLog(BaseToolConfiguration.class);

	/** A fixed class serial number. */
	private static final long serialVersionUID = 1L;

	/** The layout hints. */
	protected String m_layoutHints = null;

	/** The SitePage I belong to. */
	protected SitePage m_page = null;

	/** The site id I belong to, in case I have no m_page. */
	protected String m_siteId = null;

	/** The page id I belong to, in case I have no m_page. */
	protected String m_pageId = null;

	/** The site skin, in case I have no m_page. */
	protected String m_skin = null;

	/** True if the placement conf has not been read yet. */
	protected boolean m_configLazy = false;

	/** The order within the page. */
	protected int m_pageOrder = -1;
	
	/** Flag for custom title configuration */
	protected boolean m_custom_title = false;

	private BaseSiteService siteService;

	/**
	 * ReConstruct
	 * 
	 * @param page
	 *        The page in which this tool lives.
	 * @param id
	 *        The tool (placement) id.
	 * @param toolId
	 *        The id (registration code) of the tool to place here.
	 * @param title
	 *        The tool title.
	 * @param layoutHints
	 *        The layout hints.
	 * @param pageOrder
	 *        The order within the page.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, SitePage page, String id, String toolId,
			String title, String layoutHints, int pageOrder)
	{
		super( id, toolId, siteService.activeToolManager().getTool(toolId), null, null, title);
		this.siteService = siteService;

		m_page = page;
		m_layoutHints = layoutHints;
		m_pageOrder = pageOrder;
		m_custom_title = getTitleCustom(page);

		m_configLazy = true;
		setPageCategory();
	}
	
	/**
	 ** Checks if the tool's page has set the custom_title property (for custom page or tool titles),
	 ** or alternately checks if this tool should be cosidered a "legacy" custom tool title
	 ** (e.g. iframe, news, linktool). 
	 ** 
	 ** @see org.sakaiproject.site.impl.BaseSitePage#getTitleCustom
	 **/
	private boolean getTitleCustom(SitePage page)
	{
		String custom = (String)page.getProperties().get(SitePage.PAGE_CUSTOM_TITLE_PROP);
		if ( custom != null )
			return Boolean.parseBoolean(custom);
		else	if ( "sakai.iframe".equals(m_toolId) || "sakai.news".equals(m_toolId) || "sakai.rutgers.linktool".equals(m_toolId) )
			return true;
		else if (m_toolId != null && m_toolId.startsWith("sakai.iframe"))
			return true;
		else
			return false;
	}

	/**
	 * ReConstruct - if we don't have a page to follow up to get to certain page
	 * and site info.
	 * 
	 * @param id
	 *        The tool (placement) id.
	 * @param toolId
	 *        The id (registration code) of the tool to place here.
	 * @param title
	 *        The tool title.
	 * @param layoutHints
	 *        The layout hints.
	 * @param pageId
	 *        The page id in which this tool lives.
	 * @param siteId
	 *        The site id in which this tool lives.
	 * @param skin
	 *        The site's skin.
	 * @param pageOrder
	 *        The order within the page.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, String id, String toolId, String title,
			String layoutHints, String pageId, String siteId, String skin, int pageOrder)
	{
		super(id, toolId, siteService.activeToolManager().getTool(toolId), null, null, title);
		this.siteService = siteService;
		
		m_page = null;

		m_layoutHints = layoutHints;
		m_pageId = pageId;
		m_siteId = siteId;
		m_skin = skin;
		m_pageOrder = pageOrder;

		m_configLazy = true;
		setPageCategory();
	}

	/**
	 * Construct as a copy of another.
	 * 
	 * @param other
	 *        The other to copy.
	 * @param page
	 *        The page in which this tool lives.
	 * @param exact
	 *        If true, we copy ids - else we generate a new one.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, ToolConfiguration other, SitePage page, boolean exact)
	{
		this.siteService = siteService;
		m_page = page;
		BaseToolConfiguration bOther = (BaseToolConfiguration) other;

		if (exact)
		{
			m_id = other.getId();
		}
		else
		{
			m_id = siteService.idManager().createUuid();
		}
		m_toolId = other.getToolId();
		m_tool = other.getTool();
		m_title = other.getTitle();
		m_layoutHints = other.getLayoutHints();
		m_pageId = bOther.m_pageId;
		m_pageOrder = bOther.m_pageOrder;
		m_custom_title = getTitleCustom(page);

		m_siteId = getContainingPage().getContainingSite().getId();
		m_skin = bOther.m_skin;

		Hashtable h = other.getPlacementConfig();
		// exact copying of ToolConfiguration items vs replacing occurence of
		// site id within item value, depending on "exact" setting -zqian
		if (exact)
		{
			m_config.putAll(other.getPlacementConfig());
		}
		else
		{
			for (Enumeration e = h.keys(); e.hasMoreElements();)
			{
				// replace site id string inside configuration
				String pOtherConfig = (String) e.nextElement();
				String pOtherConfigValue = (String) h.get(pOtherConfig);
				m_config.put(pOtherConfig, pOtherConfigValue.replaceAll(bOther
						.getSiteId(), m_siteId));
			}
		}
		m_configLazy = bOther.m_configLazy;
		setPageCategory();
	}

	/**
	 * Construct using a tool registration for default information.
	 * 
	 * @param reg
	 *        The tool registration.
	 * @param page
	 *        The page in which this tool lives.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, SitePage page)
	{
		super(siteService.idManager().createUuid(), null, null, null, null, null);
		this.siteService = siteService;

		m_page = page;
		m_custom_title = getTitleCustom(page);
	}

	/**
	 * Construct using a tool registration for default information.
	 * 
	 * @param reg
	 *        The tool registration.
	 * @param page
	 *        The page in which this tool lives.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, Tool reg, SitePage page)
	{
		super(siteService.idManager().createUuid(), reg.getId(), reg, null, null, null);
		this.siteService = siteService;
		
		m_page = page;
		m_custom_title = getTitleCustom(page);
		setPageCategory();
	}

	/**
	 * Construct using a tool id.
	 * 
	 * @param toolId
	 *        The tool id.
	 * @param page
	 *        The page in which this tool lives.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, String toolId, SitePage page)
	{
		super(siteService.idManager().createUuid(), toolId, null, null, null, null);
		this.siteService = siteService;

		m_page = page;
		m_custom_title = getTitleCustom(page);
		setPageCategory();
	}

	/**
	 * Construct from XML element.
	 * 
	 * @param el
	 *        The XML element.
	 * @param page
	 *        The page in which this tool lives.
	 */
	protected BaseToolConfiguration(BaseSiteService siteService, Element el, SitePage page)
	{
		super();
		this.siteService = siteService;

		m_page = page;

		m_id = el.getAttribute("id");
		m_toolId = StringUtils.trimToNull(el.getAttribute("toolId"));
		if (m_toolId != null)
		{
			m_tool = siteService.activeToolManager().getTool(m_toolId);
		}
		m_title = StringUtils.trimToNull(el.getAttribute("title"));
		m_layoutHints = StringUtils.trimToNull(el.getAttribute("layoutHints"));
		m_custom_title = getTitleCustom(page);

		// the children (properties)
		NodeList children = el.getChildNodes();
		final int length = children.getLength();
		for (int i = 0; i < length; i++)
		{
			Node child = children.item(i);
			if (child.getNodeType() != Node.ELEMENT_NODE)
			{
				continue;
			}
			Element element = (Element) child;

			// look for properties
			if (element.getTagName().equals("properties"))
			{
				// re-create properties
				Xml.xmlToProperties(m_config, element);
			}
		}
		setPageCategory();
	}

	/**
	 * {@inheritDoc}
	 */
	public Properties getPlacementConfig()
	{
		// if the config has not yet been read, read it
		if (m_configLazy)
		{
			siteService.storage().readToolProperties(
					this, m_config);
			m_configLazy = false;
		}

		return m_config;
	}

	/**
	 * Acces the m_config, which is inherited and not visible to this package
	 * outside this class -ggolden
	 */
	protected Properties getMyConfig()
	{
		return m_config;
	}

	/**
	 * @inheritDoc
	 */
	public String getLayoutHints()
	{
		return m_layoutHints;
	}

	/**
	 * @inheritDoc
	 */
	public int[] parseLayoutHints()
	{
		try
		{
			if (m_layoutHints == null)
			{
				return null;
			}
			String[] parts = StringUtil.split(m_layoutHints, ",");
			if (parts.length < 2)
			{
				return null;
			}
			int[] rv = new int[2];
			rv[0] = Integer.parseInt(parts[0]);
			rv[1] = Integer.parseInt(parts[1]);
			return rv;
		}
		catch (Exception t)
		{
			return null;
		}
	}

	/**
	 * {@inheritDoc}
	 */
	public int getPageOrder()
	{
		return m_pageOrder;
	}

	/**
	 * {@inheritDoc}
	 */
	public String getSkin()
	{
		// use local copy if no page is set
		if (m_page == null)
		{
			return m_skin;
		}

		return m_page.getSkin();
	}

	/**
	 * {@inheritDoc}
	 */
	public String getPageId()
	{
		// use local copy if no page is set
		if (m_page == null)
		{
			return m_pageId;
		}

		return getContainingPage().getId();
	}

	/**
	 * {@inheritDoc}
	 */
	public String getSiteId()
	{
		// use local copy if no page is set
		if (m_page == null)
		{
			return m_siteId;
		}

		return getContainingPage().getContainingSite().getId();
	}

	/**
	 * {@inheritDoc}
	 */
	public String getContext()
	{
		// the context of a site based placement is the site id
		return getSiteId();
	}

	/**
	 * {@inheritDoc}
	 */
	public void setLayoutHints(String hints)
	{
		m_layoutHints = hints;
	}

	/**
	 * {@inheritDoc}
	 */
	public void moveUp()
	{
		if (m_page == null)
		{
			M_log.warn("moveUp: null page: " + m_id);
			return;
		}

		((ResourceVector) m_page.getTools()).moveUp(this);
	}

	/**
	 * {@inheritDoc}
	 */
	public void moveDown()
	{
		if (m_page == null)
		{
			M_log.warn("moveDown: null page: " + m_id);
			return;
		}

		((ResourceVector) m_page.getTools()).moveDown(this);
	}

	/**
	 * {@inheritDoc}
	 */
	public SitePage getContainingPage()
	{
		return m_page;
	}

	/**
	 * {@inheritDoc}
	 */
	public Element toXml(Document doc, Stack stack)
	{
		Element element = doc.createElement("tool");
		((Element) stack.peek()).appendChild(element);
		stack.push(element);

		element.setAttribute("id", getId());
		String toolId = getToolId();
		if (toolId != null)
		{
			element.setAttribute("toolId", toolId);
		}
		if (m_title != null)
		{
			element.setAttribute("title", m_title);
		}
		if (m_layoutHints != null)
		{
			element.setAttribute("layoutHints", m_layoutHints);
		}

		// properties
		Xml.propertiesToXml(getPlacementConfig(), doc, stack);

		stack.pop();

		return (Element) element;
	}

	/**
	 * {@inheritDoc}
	 */
	public void save()
	{
		// TODO: security? version?
		siteService.storage().saveToolConfig(this);

		// track the site change
		siteService.eventTrackingService().post(siteService.eventTrackingService().newEvent(
				SiteService.SECURE_UPDATE_SITE, siteService.siteReference(getSiteId()),
				true));
	}

	protected void setPageCategory()
	{
		if (m_page != null) m_page.setupPageCategory(m_toolId);
	}

	/**
	 * {@inheritDoc}
	 */
	public void setTool(String toolId, Tool tool)
	{
		super.setTool(toolId, tool);
		setPageCategory();
	}
   
	/**
	 * @inheritDoc
	 *
	 *	Modified by mnorton for SAK-8908.
	 */
	public String getTitle()
	{
		String rv = null;
		if (m_tool != null && !m_custom_title)
		{
			rv = m_tool.getTitle();
		}
		else if (m_title != null)
		{
			rv = m_title;
		}
		//else
			//rv = "(title unknown)";

		return rv;
	}

	/**
	 * Replace tool title with its localized value
	 * 
	 * @return localized tool title
	 */
	protected String localizeTool()
	{
		String localizedTitle = siteService.activeToolManager().getLocalizedToolProperty(getTool().getId(), "title");
			
		// Use localized title if present
		if(localizedTitle != null && localizedTitle.length()>0)
			setTitle(localizedTitle);
		
		return localizedTitle;
	}
}