/ConnTest/Assets/src/ProxyClientFactory.cs

/*

 *  Authors:  Benton Stark

 * 

 *  Copyright (c) 2007-2009 Starksoft, LLC (http://www.starksoft.com) 

 *

 * Permission is hereby granted, free of charge, to any person obtaining a copy

 * of this software and associated documentation files (the "Software"), to deal

 * in the Software without restriction, including without limitation the rights

 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 * copies of the Software, and to permit persons to whom the Software is

 * furnished to do so, subject to the following conditions:

 * 

 * The above copyright notice and this permission notice shall be included in

 * all copies or substantial portions of the Software.

 * 

 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 * THE SOFTWARE.

 * 

 */



using System;

using System.Collections.Generic;

using System.Text;

using System.Net.Sockets;



namespace Starksoft.Net.Proxy

{

    /// <summary>

    /// The type of proxy.

    /// </summary>

    public enum ProxyType

    {

        /// <summary>

        /// No Proxy specified.  Note this option will cause an exception to be thrown if used to create a proxy object by the factory.

        /// </summary>

        None,

        /// <summary>

        /// HTTP Proxy

        /// </summary>

        Http,

        /// <summary>

        /// SOCKS v4 Proxy

        /// </summary>

        Socks4,

        /// <summary>

        /// SOCKS v4a Proxy

        /// </summary>

        Socks4a,

        /// <summary>

        /// SOCKS v5 Proxy

        /// </summary>

        Socks5

    }



    /// <summary>

    /// Factory class for creating new proxy client objects.

    /// </summary>

    /// <remarks>

    /// <code>

    /// // create an instance of the client proxy factory

    /// ProxyClientFactory factory = new ProxyClientFactory();

    ///        

	/// // use the proxy client factory to generically specify the type of proxy to create

    /// // the proxy factory method CreateProxyClient returns an IProxyClient object

    /// IProxyClient proxy = factory.CreateProxyClient(ProxyType.Http, "localhost", 6588);

    ///

	/// // create a connection through the proxy to www.starksoft.com over port 80

    /// System.Net.Sockets.TcpClient tcpClient = proxy.CreateConnection("www.starksoft.com", 80);

    /// </code>

    /// </remarks>

    public class ProxyClientFactory

    {



        /// <summary>

        /// Factory method for creating new proxy client objects.

        /// </summary>

        /// <param name="type">The type of proxy client to create.</param>

        /// <returns>Proxy client object.</returns>

        public IProxyClient CreateProxyClient(ProxyType type)

        {

            if (type == ProxyType.None)

                throw new ArgumentOutOfRangeException("type");



            switch (type)

            {

                case ProxyType.Http:

                    return new HttpProxyClient();

                case ProxyType.Socks4:

                    return new Socks4ProxyClient();

                case ProxyType.Socks4a:

                    return new Socks4aProxyClient();

                case ProxyType.Socks5:

                    return new Socks5ProxyClient();

                default:

                    throw new ProxyException(String.Format("Unknown proxy type {0}.", type.ToString()));

            }

        }        



        /// <summary>

        /// Factory method for creating new proxy client objects using an existing TcpClient connection object.

        /// </summary>

        /// <param name="type">The type of proxy client to create.</param>

        /// <param name="tcpClient">Open TcpClient object.</param>

        /// <returns>Proxy client object.</returns>

        public IProxyClient CreateProxyClient(ProxyType type, TcpClient tcpClient)

        {

            if (type == ProxyType.None)

                throw new ArgumentOutOfRangeException("type");

            

            switch (type)

            {

                case ProxyType.Http:

                    return new HttpProxyClient(tcpClient);

                case ProxyType.Socks4:

                    return new Socks4ProxyClient(tcpClient);

                case ProxyType.Socks4a:

                    return new Socks4aProxyClient(tcpClient);

                case ProxyType.Socks5:

                    return new Socks5ProxyClient(tcpClient);

                default:

                    throw new ProxyException(String.Format("Unknown proxy type {0}.", type.ToString()));

            }

        }        

        

        /// <summary>

        /// Factory method for creating new proxy client objects.  

        /// </summary>

        /// <param name="type">The type of proxy client to create.</param>

        /// <param name="proxyHost">The proxy host or IP address.</param>

        /// <param name="proxyPort">The proxy port number.</param>

        /// <returns>Proxy client object.</returns>

        public IProxyClient CreateProxyClient(ProxyType type, string proxyHost, int proxyPort)

        {

            if (type == ProxyType.None)

                throw new ArgumentOutOfRangeException("type");

            

            switch (type)

            {

                case ProxyType.Http:

                    return new HttpProxyClient(proxyHost, proxyPort);

                case ProxyType.Socks4:

                    return new Socks4ProxyClient(proxyHost, proxyPort);

                case ProxyType.Socks4a:

                    return new Socks4aProxyClient(proxyHost, proxyPort);

                case ProxyType.Socks5:

                    return new Socks5ProxyClient(proxyHost, proxyPort);

                default:

                    throw new ProxyException(String.Format("Unknown proxy type {0}.", type.ToString()));

            }

        }



        /// <summary>

        /// Factory method for creating new proxy client objects.  

        /// </summary>

        /// <param name="type">The type of proxy client to create.</param>

        /// <param name="proxyHost">The proxy host or IP address.</param>

        /// <param name="proxyPort">The proxy port number.</param>

        /// <param name="proxyUsername">The proxy username.  This parameter is only used by Socks4 and Socks5 proxy objects.</param>

        /// <param name="proxyPassword">The proxy user password.  This parameter is only used Socks5 proxy objects.</param>

        /// <returns>Proxy client object.</returns>

        public IProxyClient CreateProxyClient(ProxyType type, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

        {

            if (type == ProxyType.None)

                throw new ArgumentOutOfRangeException("type");



            switch (type)

            {

                case ProxyType.Http:

                    return new HttpProxyClient(proxyHost, proxyPort);

                case ProxyType.Socks4:

                    return new Socks4ProxyClient(proxyHost, proxyPort, proxyUsername);

                case ProxyType.Socks4a:

                    return new Socks4aProxyClient(proxyHost, proxyPort, proxyUsername);

                case ProxyType.Socks5:

                    return new Socks5ProxyClient(proxyHost, proxyPort, proxyUsername, proxyPassword);

                default:

                    throw new ProxyException(String.Format("Unknown proxy type {0}.", type.ToString()));

            }

        }



        /// <summary>

        /// Factory method for creating new proxy client objects.  

        /// </summary>

        /// <param name="type">The type of proxy client to create.</param>

        /// <param name="tcpClient">Open TcpClient object.</param>

        /// <param name="proxyHost">The proxy host or IP address.</param>

        /// <param name="proxyPort">The proxy port number.</param>

        /// <param name="proxyUsername">The proxy username.  This parameter is only used by Socks4 and Socks5 proxy objects.</param>

        /// <param name="proxyPassword">The proxy user password.  This parameter is only used Socks5 proxy objects.</param>

        /// <returns>Proxy client object.</returns>

        public IProxyClient CreateProxyClient(ProxyType type, TcpClient tcpClient, string proxyHost, int proxyPort, string proxyUsername, string proxyPassword)

        {

            IProxyClient c = CreateProxyClient(type, proxyHost, proxyPort, proxyUsername, proxyPassword);

            c.TcpClient = tcpClient;

            return c;

        }





    }







}