/*
 * Copyright (C) 2006-2008 Alfresco Software Limited.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.

 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.

 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.

 * As a special exception to the terms and conditions of version 2.0 of 
 * the GPL, you may redistribute this Program in connection with Free/Libre 
 * and Open Source Software ("FLOSS") applications as described in Alfresco's 
 * FLOSS exception.  You should have recieved a copy of the text describing 
 * the FLOSS exception, and it is also available here: 
 * http://www.alfresco.com/legal/licensing"
 */

package org.alfresco.jlan.server.auth.acl;

import java.util.StringTokenizer;

import org.alfresco.jlan.server.SrvSession;
import org.alfresco.jlan.server.core.SharedDevice;


/**
 * Protocol Access Control Class
 * 
 * <p>Allow/disallow access to a share based on the protocol type.
 *
 * @author gkspencer
 */
public class ProtocolAccessControl extends AccessControl {

	//	Available protocol type names
	
	private static final String[] _protoTypes = {"SMB", "CIFS", "NFS", "FTP"};

	//	Parsed list of protocol types
	
	private String[] m_checkList;
			
	/**
	 * Class constructor
	 *
	 * @param protList String
	 * @param type String
	 * @param access int 
	 */	
	public ProtocolAccessControl(String protList, String type, int access) {
		super(protList, type, access);
		
		//	Parse the protocol list
		
		m_checkList = listFromString(protList);
	}
	
	/**
	 * Check if the protocol matches the access control protocol list and return the allowed access.
	 * 
	 * @param sess SrvSession
	 * @param share SharedDevice
	 * @param mgr AccessControlManager
	 * @return int
	 */
	public int allowsAccess(SrvSession sess, SharedDevice share, AccessControlManager mgr) {
		
		//	Determine the session protocol type
		
		String sessProto = null;
		String sessName = sess.getClass().getName();
		
		if ( sessName.endsWith(".SMBSrvSession"))
			sessProto = "CIFS";
		else if ( sessName.endsWith(".FTPSrvSession"))
			sessProto = "FTP";
		else if ( sessName.endsWith(".NFSSrvSession"))
			sessProto = "NFS";

		//	Check if the session protocol type is in the protocols to be checked
		
		if ( sessProto != null && indexFromList( sessProto, m_checkList, false) != -1)
			return getAccess();			
		return Default;
	}
	
	/**
	 * Validate the protocol list
	 * 
	 * @param protList String
	 * @return boolean
	 */
	public static final boolean validateProtocolList(String protList) {
		
		//	Check if the protocol list string is valid
		
		if ( protList == null || protList.length() == 0)
			return false;
			
		//	Split the protocol list and validate each protocol name
		
		StringTokenizer tokens = new StringTokenizer(protList, ",");
		
		while ( tokens.hasMoreTokens()) {
			
			//	Get the current protocol name and validate
			
			String name = tokens.nextToken().toUpperCase();
			if ( indexFromList(name, _protoTypes, false) == -1)
				return false;
		}
		
		//	Protocol list is valid
		
		return true;
	}
}