CollaborationToolsFactory.java

/**
* OLAT - Online Learning and Training<br>
* http://www.olat.org
* <p>
* Licensed under the Apache License, Version 2.0 (the "License"); <br>
* you may not use this file except in compliance with the License.<br>
* You may obtain a copy of the License at
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* Unless required by applicable law or agreed to in writing,<br>
* software distributed under the License is distributed on an "AS IS" BASIS, <br>
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. <br>
* See the License for the specific language governing permissions and <br>
* limitations under the License.
* <p>
* Copyright (c) since 2004 at Multimedia- & E-Learning Services (MELS),<br>
* University of Zurich, Switzerland.
* <hr>
* <a href="http://www.openolat.org">
* OpenOLAT - Online Learning and Training</a><br>
* This file has been modified by the OpenOLAT community. Changes are licensed
* under the Apache 2.0 license as the original file.
*/

package org.olat.collaboration;

import java.util.ArrayList;

import org.olat.basesecurity.BaseSecurityModule;
import org.olat.commons.calendar.CalendarModule;
import org.olat.core.CoreSpringFactory;
import org.olat.core.id.OLATResourceable;
import org.olat.core.logging.AssertException;
import org.olat.core.logging.OLog;
import org.olat.core.logging.Tracing;
import org.olat.core.util.ArrayHelper;
import org.olat.core.util.cache.CacheWrapper;
import org.olat.core.util.coordinate.CoordinatorManager;
import org.olat.group.BusinessGroup;
import org.olat.instantMessaging.InstantMessagingModule;
import org.olat.modules.openmeetings.OpenMeetingsModule;
import org.olat.modules.portfolio.PortfolioV2Module;
import org.olat.portfolio.PortfolioModule;

/**
 * Description:<BR>
 * The singleton used for retrieving a collaboration tools suite associated with
 * the supplied OLATResourceable. Supports caching of elements as access to properties can get slow (table can become very large)
 * <P>
 * Initial Date:  2004/10/12 12:45:53
 *
 * @author Felix Jost
 * @author guido
 */
public class CollaborationToolsFactory {
	private static final OLog log = Tracing.createLoggerFor(CollaborationToolsFactory.class);
	private static CollaborationToolsFactory instance;
	private CacheWrapper<String,CollaborationTools> cache;
	private CoordinatorManager coordinatorManager;

	/**
	 * public for group test only, do not use otherwise convenience, helps
	 * iterating possible tools, i.e. in jUnit testCase, also for building up a
	 * tools choice
	 */
	public static String[] TOOLS;
	
	
	/**
	 * [used by spring]
	 */
	private CollaborationToolsFactory(CoordinatorManager coordinatorManager) {
		this.coordinatorManager = coordinatorManager;
		cache = coordinatorManager.getCoordinator().getCacher().getCache(CollaborationToolsFactory.class.getSimpleName(), "tools");
		instance = this;
	}

	/**
	 * Helper method to initialize the list of enabled tools based system wide
	 * configuration.
	 */
	public synchronized void initAvailableTools() {
		ArrayList<String> toolArr = new ArrayList<String>();
		toolArr.add(CollaborationTools.TOOL_NEWS);
		toolArr.add(CollaborationTools.TOOL_CONTACT);
		CalendarModule calendarModule = CoreSpringFactory.getImpl(CalendarModule.class);
		if(calendarModule.isEnabled() && calendarModule.isEnableGroupCalendar()) {
			toolArr.add(CollaborationTools.TOOL_CALENDAR);
		}
		toolArr.add(CollaborationTools.TOOL_FOLDER);
		toolArr.add(CollaborationTools.TOOL_FORUM);
		if (CoreSpringFactory.getImpl(InstantMessagingModule.class).isEnabled()) {
			toolArr.add(CollaborationTools.TOOL_CHAT);
		}
		BaseSecurityModule securityModule = CoreSpringFactory.getImpl(BaseSecurityModule.class); 
		if (securityModule.isWikiEnabled()) {
			toolArr.add(CollaborationTools.TOOL_WIKI);			
		}
		PortfolioModule portfolioModule = CoreSpringFactory.getImpl(PortfolioModule.class);
		PortfolioV2Module portfolioV2Module = CoreSpringFactory.getImpl(PortfolioV2Module.class);
		if (portfolioModule.isEnabled() || portfolioV2Module.isEnabled()) {
			toolArr.add(CollaborationTools.TOOL_PORTFOLIO);
		}	
		OpenMeetingsModule openMeetingsModule = CoreSpringFactory.getImpl(OpenMeetingsModule.class);
		if(openMeetingsModule.isEnabled()) {
			toolArr.add(CollaborationTools.TOOL_OPENMEETINGS);
		}
		TOOLS = ArrayHelper.toArray(toolArr);				
	}
	
	/**
	 * Get the array of available (system wide enabled) collaboration tools
	 * @return
	 */
	public String[] getAvailableTools() {
		if (TOOLS == null) {
			initAvailableTools();
		}
		return TOOLS;
	}
	
	/**
	 * it is a singleton.
	 * 
	 * @return CollaborationToolsFactory
	 */
	public static CollaborationToolsFactory getInstance() {
		return instance;
	}

	/**
	 * create a collaborative toolsuite for the specified OLATResourcable
	 * 
	 * @param ores
	 * @return CollaborationTools
	 */
	public CollaborationTools getOrCreateCollaborationTools(final BusinessGroup ores) {
		if (ores == null) throw new AssertException("Null is not allowed here, you have to provide an existing ores here!");
		
		final String cacheKey = Long.valueOf(ores.getResourceableId()).toString();
		boolean debug = log.isDebug();
		//sync operation cluster wide

		CollaborationTools collabTools = cache.get(cacheKey);
		if (collabTools != null) {		
			if (debug) log .debug("loading collabTool from cache. Ores: " + ores.getResourceableId());		
			if (collabTools.isDirty()) {
				if (debug) log .debug("CollabTools were in cache but dirty. Creating new ones. Ores: " + ores.getResourceableId());
				CollaborationTools tools = new CollaborationTools(coordinatorManager, ores);
				//update forces clusterwide invalidation of this object
				cache.update(cacheKey, tools);
				collabTools = tools;
			}	
		} else {
			if (debug) log .debug("collabTool not in cache. Creating new ones. Ores: " + ores.getResourceableId());
	
			CollaborationTools tools = new CollaborationTools(coordinatorManager, ores);
			CollaborationTools cachedTools = cache.putIfAbsent(cacheKey, tools);
			if(cachedTools != null) {
				collabTools = cachedTools;
			} else {
				collabTools = tools;
			}
		}
		return collabTools;
	}
	
	/**
	 * if you are sure that the cache is populated with the latest version of the collabtools
	 * you can use this method to avoid nested do in sync on the cluster
	 * @param ores
	 * @return
	 */
	public CollaborationTools getCollaborationToolsIfExists(OLATResourceable ores) {
		String cacheKey = Long.valueOf(ores.getResourceableId()).toString();
		return cache.get(cacheKey);
	}

	
}