StartPage.java

/**
 * This file Copyright (c) 2005-2008 Aptana, Inc. This program is
 * dual-licensed under both the Aptana Public License and the GNU General
 * Public license. You may elect to use one or the other of these licenses.
 * 
 * This program is distributed in the hope that it will be useful, but
 * AS-IS and WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE, TITLE, or
 * NONINFRINGEMENT. Redistribution, except as permitted by whichever of
 * the GPL or APL you select, is prohibited.
 *
 * 1. For the GPL license (GPL), you can redistribute and/or modify this
 * program under the terms of the GNU General Public License,
 * Version 3, as published by the Free Software Foundation.  You should
 * have received a copy of the GNU General Public License, Version 3 along
 * with this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 * 
 * Aptana provides a special exception to allow redistribution of this file
 * with certain other free and open source software ("FOSS") code and certain additional terms
 * pursuant to Section 7 of the GPL. You may view the exception and these
 * terms on the web at http://www.aptana.com/legal/gpl/.
 * 
 * 2. For the Aptana Public License (APL), this program and the
 * accompanying materials are made available under the terms of the APL
 * v1.0 which accompanies this distribution, and is available at
 * http://www.aptana.com/legal/apl/.
 * 
 * You may view the GPL, Aptana's exception and additional terms, and the
 * APL in the file titled license.html at the root of the corresponding
 * plugin containing this source file.
 * 
 * Any modifications to this file must keep this entire header intact.
 */
package com.aptana.ide.server.ui;

import java.util.Observable;

import org.eclipse.core.resources.IResource;
import org.eclipse.core.resources.IWorkspace;
import org.eclipse.core.resources.ResourcesPlugin;
import org.eclipse.core.runtime.IPath;
import org.eclipse.core.runtime.Path;
import org.eclipse.core.runtime.Preferences;

import com.aptana.ide.core.StringUtils;
import com.aptana.ide.server.core.ServerCorePlugin;

/**
 * Singleton class for managing the active Web start page for the workspace.
 * 
 * @author Spike Washburn
 */
public class StartPage extends Observable
{
	private static final String PREF_KEY_START_PAGE = "com.aptana.ide.server.start.resource"; //$NON-NLS-1$
	private IResource startPageResource;
	private String startPageResourcePath;
	private static StartPage instance;

	/**
	 * Returns the singleton instance for the workspace.
	 * 
	 * @return StartPage
	 */
	public static StartPage getInstance()
	{
		if (instance == null)
		{
			instance = new StartPage();
		}
		return instance;
	}

	/**
	 * @return the workspace resource currently set as the start page.
	 */
	public IResource getStartPageResource()
	{
		if (startPageResourcePath == null)
		{
			startPageResourcePath = getStartPagePath();
			if (!startPageResourcePath.equals(StringUtils.EMPTY))
			{
				IWorkspace workspace = ResourcesPlugin.getWorkspace();
				startPageResource = workspace.getRoot().findMember(new Path(startPageResourcePath));
			}
		}
		return startPageResource;
	}

	/**
	 * Sets the resource that should be used as the start page for the workspace.
	 * 
	 * @param resource
	 */
	public void setStartPageResource(IResource resource)
	{
		Preferences prefs = ServerCorePlugin.getDefault().getPluginPreferences();
		String path = StringUtils.EMPTY;
		if (resource != null)
		{
			path = resource.getFullPath().toPortableString();
		}

		prefs.setValue(PREF_KEY_START_PAGE, path);
		ServerCorePlugin.getDefault().savePluginPreferences();
		startPageResourcePath = path;
		startPageResource = resource;

		// notify any observers that the start page has changed
		setChanged();
		this.notifyObservers(null);
	}

	/**
	 * @return the path of the resource currently set as the start page.
	 */
	private String getStartPagePath()
	{
		if (startPageResourcePath == null)
		{
			Preferences prefs = ServerCorePlugin.getDefault().getPluginPreferences();
			startPageResourcePath = prefs.getString(PREF_KEY_START_PAGE);
			if (!startPageResourcePath.equals(StringUtils.EMPTY))
			{
				IWorkspace workspace = ResourcesPlugin.getWorkspace();
				startPageResource = workspace.getRoot().findMember(new Path(startPageResourcePath));
			}
		}
		return startPageResourcePath;
	}

	/**
	 * @return the path (relative to its project) of the resource currently set as the start page.
	 */
	public String getProjectRelativePath()
	{
		IResource resource = getStartPageResource();
		if (resource != null)
		{
			IPath path = resource.getProjectRelativePath();
			return path.toPortableString();
		}
		return null;
	}
}