opensim/OpenSim/Client/MXP/MXPModule.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using System;
using System.Collections.Generic;
using System.Reflection;
using System.Text;
using System.Timers;
using log4net;
using Mono.Addins;
using MXP;
using Nini.Config;
using OpenMetaverse;
using OpenSim.Client.MXP.PacketHandler;
using OpenSim.Region.Framework.Interfaces;
using OpenSim.Region.Framework.Scenes;

namespace OpenSim.Client.MXP
{

    /**
     * MXP Client Module which adds MXP support to client / region communication.
     */
    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule")]
    public class MXPModule : ISharedRegionModule
    {
        private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);

        private MXPPacketServer m_server;

        private IConfigSource m_config;
        private int m_port = 1253;
        private Timer m_ticker;

        private readonly Dictionary<UUID, Scene> m_scenes = new Dictionary<UUID, Scene>();
        private bool m_shutdown;

        public void Initialise(IConfigSource source)
        {
            m_config = source;
        }

        public Type ReplaceableInterface
        {
            get { return null; }
        }

        public void AddRegion(Scene scene)
        {
            if (!m_scenes.ContainsKey(scene.RegionInfo.RegionID))
                m_scenes.Add(scene.RegionInfo.RegionID, scene);
        }

        public void RegionLoaded(Scene scene)
        {
            if (m_config.Configs["MXP"] != null)
            {
                IConfig con = m_config.Configs["MXP"];

                if (!con.GetBoolean("Enabled", false))
                    return;

                m_port = con.GetInt("Port", m_port);

                m_server = new MXPPacketServer(m_port, m_scenes, m_config.Configs["StandAlone"].GetBoolean("accounts_authenticate", true));

                m_ticker = new Timer(100);
                m_ticker.AutoReset = false;
                m_ticker.Elapsed += ticker_Elapsed;

                lock (m_ticker)
                    m_ticker.Start();

                m_log.Info("[MXP ClientStack] MXP Enabled and Listening");
            }
        }

        public void RemoveRegion(Scene scene)
        {
        }

        public void PostInitialise()
        {
        }

        void ticker_Elapsed(object sender, ElapsedEventArgs e)
        {
            try
            {
                m_server.Process();
            }
            catch (Exception ex)
            {
                m_log.Error("[MXP ClientStack]: Unhandled exception in process loop: " + ex.ToString() + " :" + ex.StackTrace.ToString());
            }

            if (!m_shutdown)
            {
                lock (m_ticker)
                    m_ticker.Start();
            }
        }

        public void Close()
        {
            m_shutdown = true;
            if (m_ticker != null)
            {
                lock (m_ticker)
                    m_ticker.Stop();
            }
        }

        public string Name
        {
            get { return "MXP ClientStack Module"; }
        }
    }
}