DefaultSiteViewImpl.java

/**********************************************************************************
 * $URL: https://source.sakaiproject.org/svn/portal/trunk/portal-impl/impl/src/java/org/sakaiproject/portal/charon/site/DefaultSiteViewImpl.java $
 * $Id: DefaultSiteViewImpl.java 127575 2013-07-23 12:12:31Z azeckoski@unicon.net $
 ***********************************************************************************
 *
 * Copyright (c) 2003, 2004, 2005, 2006, 2007, 2008 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.portal.charon.site;

import java.util.ArrayList;
import java.util.List;
import java.util.Map;
import java.util.Iterator;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

import org.sakaiproject.authz.api.AuthzGroup;
import org.sakaiproject.authz.api.Role;
import org.sakaiproject.authz.cover.AuthzGroupService;
import org.sakaiproject.authz.cover.SecurityService;
import org.sakaiproject.component.api.ServerConfigurationService;
import org.sakaiproject.entity.api.ResourceProperties;
import org.sakaiproject.exception.IdUnusedException;
import org.sakaiproject.portal.api.Portal;
import org.sakaiproject.portal.api.SiteNeighbourhoodService;
import org.sakaiproject.site.api.Site;
import org.sakaiproject.site.api.SiteService;
import org.sakaiproject.site.api.ToolConfiguration;
import org.sakaiproject.site.api.SitePage;
import org.sakaiproject.tool.api.Session;
import org.sakaiproject.user.api.Preferences;
import org.sakaiproject.user.api.PreferencesService;
import org.sakaiproject.user.cover.UserDirectoryService;

import org.sakaiproject.util.Web;

/**
 * @author ieb
 */
public class DefaultSiteViewImpl extends AbstractSiteViewImpl
{
    private static final Log LOG = LogFactory.getLog(DefaultSiteViewImpl.class);

	/**
	 * @param siteHelper
	 * @param request
	 * @param session
	 * @param currentSiteId
	 * @param siteService
	 * @param serverConfigurationService
	 * @param preferencesService
	 */
	public DefaultSiteViewImpl(PortalSiteHelperImpl siteHelper,  SiteNeighbourhoodService siteNeighbourhoodService, HttpServletRequest request,
			Session session, String currentSiteId, SiteService siteService,
			ServerConfigurationService serverConfigurationService,
			PreferencesService preferencesService)
	{
		super(siteHelper, siteNeighbourhoodService, request, session, currentSiteId, siteService,
				serverConfigurationService, preferencesService);
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.sakaiproject.portal.api.SiteView#getRenderContextObject()
	 */
	public Object getRenderContextObject()
	{
		// Get the list of sites in the right order,
		// My WorkSpace will be the first in the list

		// if public workgroup/gateway site is not included, add to list
		boolean siteFound = false;
		for (int i = 0; i < mySites.size(); i++)
		{
			if (((Site) mySites.get(i)).getId().equals(currentSiteId))
			{
				siteFound = true;
			}
		}

		try
		{
			if (!siteFound)
			{
				mySites.add(siteService.getSite(currentSiteId));
			}
		}
		catch (IdUnusedException e)
		{

		} // ignore

		int tabsToDisplay = serverConfigurationService.getInt(Portal.CONFIG_DEFAULT_TABS, 5);
		
		boolean loggedIn = session.getUserId() != null;

		if (!loggedIn)
		{
			tabsToDisplay = serverConfigurationService.getInt(
					"gatewaySiteListDisplayCount", tabsToDisplay);
		}
		else
		{
			Preferences prefs = preferencesService
					.getPreferences(session.getUserId());
			ResourceProperties props = prefs.getProperties("sakai:portal:sitenav");
			try
			{
				tabsToDisplay = (int) props.getLongProperty("tabs");
			}
			catch (Exception any)
			{
			}
		}

		// we allow one site in the drawer - that is OK
		moreSites = new ArrayList<Site>();
		if (mySites.size() > tabsToDisplay)
		{
			// Check to see if the selected site is in the first
			// "tabsToDisplay" tabs
			boolean found = false;
			for (int i = 0; i < tabsToDisplay && i < mySites.size(); i++)
			{
				Site site = mySites.get(i);
				String effectiveId = siteHelper.getSiteEffectiveId(site);
				if (site.getId().equals(currentSiteId)
						|| effectiveId.equals(currentSiteId)) found = true;
			}

			// Save space for the current site
			if (!found) tabsToDisplay = tabsToDisplay - 1;
			if (tabsToDisplay < 2) tabsToDisplay = 2;

			// Create the list of "additional sites"- but do not
			// include the currently selected set in the list
			Site currentSelectedSite = null;

			int remove = mySites.size() - tabsToDisplay;
			for (int i = 0; i < remove; i++)
			{
				// We add the site the the drop-down
				// unless it it the current site in which case
				// we retain it for later
				Site site = mySites.get(tabsToDisplay);
				mySites.remove(tabsToDisplay);

				String effectiveId = siteHelper.getSiteEffectiveId(site);
				if (site.getId().equals(currentSiteId)
						|| effectiveId.equals(currentSiteId))
				{
					currentSelectedSite = site;
				}
				else
				{
					moreSites.add(site);
				}
			}

			// check to see if we need to re-add the current site
			if (currentSelectedSite != null)
			{
				mySites.add(currentSelectedSite);
			}
		}

		
		processMySites();

		String profileToolId = serverConfigurationService.getString("portal.profiletool","sakai.profile2");
		String preferencesToolId = serverConfigurationService.getString("portal.preferencestool","sakai.preferences");
		String worksiteToolId = serverConfigurationService.getString("portal.worksitetool","sakai.sitesetup");

        // SAK-22390. Need to make sure that the current user has permission to create a site.
        boolean canAddSite = false;
        try {
            // See if current user is super duper and say yes if so
            canAddSite = SecurityService.isSuperUser(session.getUserId());
            if(!canAddSite) {
                // Not super duper. Test the user template realm.
                String type = UserDirectoryService.getUser(session.getUserId()).getType();
                AuthzGroup ag = AuthzGroupService.getAuthzGroup("!user.template." + type);
                Role role = ag.getRole(".auth");
                canAddSite = role.isAllowed("site.add.course") || role.isAllowed("site.add.portfolio") || role.isAllowed("site.add.project");
            }
        } catch(Exception e) {
            LOG.warn("Failed to set canAddSite for current user. Defaulting to false ...");
        }

 		String profileToolUrl = null;
 		String worksiteToolUrl = null;
 		String prefsToolUrl = null;
                if ( myWorkspaceSiteId != null ) for (Iterator iSi = mySites.iterator(); iSi.hasNext();)
                {
                        Site s = (Site) iSi.next();
                        if ( !myWorkspaceSiteId.equals(s.getId()) ) continue;
                	List pages = siteHelper.getPermittedPagesInOrder(s);
                	for (Iterator iPg = pages.iterator(); iPg.hasNext();)
                	{
                        	SitePage p = (SitePage) iPg.next();
				List<ToolConfiguration> pTools = p.getTools();
                        	Iterator iPt = pTools.iterator();
                        	while (iPt.hasNext())
                        	{
                                	ToolConfiguration placement = (ToolConfiguration) iPt.next();
					if ( profileToolId.equals(placement.getToolId()) ) {
                				profileToolUrl = Web.returnUrl(request, "/site/" + Web.escapeUrl(siteHelper.getSiteEffectiveId(s)) + "/page/" + Web.escapeUrl(p.getId()));
					}
					if ( preferencesToolId.equals(placement.getToolId()) ) {
                				prefsToolUrl = Web.returnUrl(request, "/site/" + Web.escapeUrl(siteHelper.getSiteEffectiveId(s)) + "/page/" + Web.escapeUrl(p.getId()));
					}
					if ( worksiteToolId.equals(placement.getToolId()) ) {
                				worksiteToolUrl = Web.returnUrl(request, "/site/" + Web.escapeUrl(siteHelper.getSiteEffectiveId(s)) + "/page/" + Web.escapeUrl(p.getId()));
					}
				}
			}
		}

		if ( profileToolUrl != null ) {
			renderContextMap.put("profileToolUrl", profileToolUrl);
		}
		if ( prefsToolUrl != null ) {
			renderContextMap.put("prefsToolUrl", prefsToolUrl);
		}
		if ( worksiteToolUrl != null ) {
			renderContextMap.put("worksiteToolUrl", worksiteToolUrl);
		}
		if (serverConfigurationService.getBoolean("portal.use.tutorial", true)){
			renderContextMap.put("tutorial", true);
		}else{
			renderContextMap.put("tutorial", false);
		}
		List<Map> l = siteHelper.convertSitesToMaps(request, mySites, prefix,
				currentSiteId, myWorkspaceSiteId,
				/* includeSummary */false, /* expandSite */false,
				/* resetTools */"true".equalsIgnoreCase(serverConfigurationService
						.getString(Portal.CONFIG_AUTO_RESET)),
				/* doPages */true, /* toolContextPath */null, loggedIn);

		renderContextMap.put("tabsSites", l);

		boolean displayActive = serverConfigurationService.getBoolean("portal.always.display.active_sites",false);
		//If we don't always want to display it anyway, check to see if we need to display it
		if (!displayActive) {
				displayActive=Boolean.valueOf(moreSites.size() > 0);
		}

		renderContextMap.put("tabsMoreSitesShow", displayActive);

		// more dropdown
		if (moreSites.size() > 0)
		{
			List<Map> m = siteHelper.convertSitesToMaps(request, moreSites, prefix,
					currentSiteId, myWorkspaceSiteId,
					/* includeSummary */false, /* expandSite */ false,
					/* resetTools */"true".equalsIgnoreCase(serverConfigurationService
							.getString(Portal.CONFIG_AUTO_RESET)),
					/* doPages */true, /* toolContextPath */null, loggedIn);

			renderContextMap.put("tabsMoreSites", m);
		}

		return renderContextMap;
	}

	/**
	 */
	protected void processMySites()
	{
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.sakaiproject.portal.api.SiteView#isEmpty()
	 */
	public boolean isEmpty()
	{
		return mySites.isEmpty();
	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.sakaiproject.portal.api.SiteView#setPrefix(java.lang.String)
	 */
	public void setPrefix(String prefix)
	{
		this.prefix = prefix;

	}

	/*
	 * (non-Javadoc)
	 * 
	 * @see org.sakaiproject.portal.api.SiteView#setToolContextPath(java.lang.String)
	 */
	public void setToolContextPath(String toolContextPath)
	{
		this.toolContextPath = toolContextPath;

	}

}