mirror of
https://github.com/opensim/opensim.git
synced 2026-08-07 09:45:47 +08:00
this is step 2 of 2 of the OpenSim.Region.Environment refactor.
NOTHING has been deleted or moved off to forge at this point. what
has happened is that OpenSim.Region.Environment.Modules has been split
in two:
- OpenSim.Region.CoreModules: all those modules that are either
directly or indirectly referenced from other OpenSim packages, or
that provide functionality that the OpenSim developer community
considers core functionality:
CoreModules/Agent/AssetTransaction
CoreModules/Agent/Capabilities
CoreModules/Agent/TextureDownload
CoreModules/Agent/TextureSender
CoreModules/Agent/TextureSender/Tests
CoreModules/Agent/Xfer
CoreModules/Avatar/AvatarFactory
CoreModules/Avatar/Chat/ChatModule
CoreModules/Avatar/Combat
CoreModules/Avatar/Currency/SampleMoney
CoreModules/Avatar/Dialog
CoreModules/Avatar/Friends
CoreModules/Avatar/Gestures
CoreModules/Avatar/Groups
CoreModules/Avatar/InstantMessage
CoreModules/Avatar/Inventory
CoreModules/Avatar/Inventory/Archiver
CoreModules/Avatar/Inventory/Transfer
CoreModules/Avatar/Lure
CoreModules/Avatar/ObjectCaps
CoreModules/Avatar/Profiles
CoreModules/Communications/Local
CoreModules/Communications/REST
CoreModules/Framework/EventQueue
CoreModules/Framework/InterfaceCommander
CoreModules/Hypergrid
CoreModules/InterGrid
CoreModules/Scripting/DynamicTexture
CoreModules/Scripting/EMailModules
CoreModules/Scripting/HttpRequest
CoreModules/Scripting/LoadImageURL
CoreModules/Scripting/VectorRender
CoreModules/Scripting/WorldComm
CoreModules/Scripting/XMLRPC
CoreModules/World/Archiver
CoreModules/World/Archiver/Tests
CoreModules/World/Estate
CoreModules/World/Land
CoreModules/World/Permissions
CoreModules/World/Serialiser
CoreModules/World/Sound
CoreModules/World/Sun
CoreModules/World/Terrain
CoreModules/World/Terrain/DefaultEffects
CoreModules/World/Terrain/DefaultEffects/bin
CoreModules/World/Terrain/DefaultEffects/bin/Debug
CoreModules/World/Terrain/Effects
CoreModules/World/Terrain/FileLoaders
CoreModules/World/Terrain/FloodBrushes
CoreModules/World/Terrain/PaintBrushes
CoreModules/World/Terrain/Tests
CoreModules/World/Vegetation
CoreModules/World/Wind
CoreModules/World/WorldMap
- OpenSim.Region.OptionalModules: all those modules that are not core
modules:
OptionalModules/Avatar/Chat/IRC-stuff
OptionalModules/Avatar/Concierge
OptionalModules/Avatar/Voice/AsterixVoice
OptionalModules/Avatar/Voice/SIPVoice
OptionalModules/ContentManagementSystem
OptionalModules/Grid/Interregion
OptionalModules/Python
OptionalModules/SvnSerialiser
OptionalModules/World/NPC
OptionalModules/World/TreePopulator
This commit is contained in:
219
OpenSim/Region/OptionalModules/Avatar/Chat/IRCBridgeModule.cs
Normal file
219
OpenSim/Region/OptionalModules/Avatar/Chat/IRCBridgeModule.cs
Normal file
@@ -0,0 +1,219 @@
|
||||
/*
|
||||
* 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 OpenSim 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;
|
||||
using System.Collections.Generic;
|
||||
using System.Reflection;
|
||||
using log4net;
|
||||
using Nini.Config;
|
||||
using Nwc.XmlRpc;
|
||||
using OpenSim.Framework;
|
||||
using OpenSim.Region.Framework.Interfaces;
|
||||
using OpenSim.Region.Framework.Scenes;
|
||||
|
||||
namespace OpenSim.Region.OptionalModules.Avatar.Chat
|
||||
{
|
||||
public class IRCBridgeModule : IRegionModule
|
||||
{
|
||||
private static readonly ILog m_log =
|
||||
LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
|
||||
|
||||
internal static bool configured = false;
|
||||
internal static bool enabled = false;
|
||||
internal static IConfig m_config = null;
|
||||
|
||||
internal static List<ChannelState> m_channels = new List<ChannelState>();
|
||||
internal static List<RegionState> m_regions = new List<RegionState>();
|
||||
|
||||
internal static string password = String.Empty;
|
||||
|
||||
internal RegionState region = null;
|
||||
|
||||
#region IRegionModule Members
|
||||
|
||||
public string Name
|
||||
{
|
||||
get { return "IRCBridgeModule"; }
|
||||
}
|
||||
|
||||
public bool IsSharedModule
|
||||
{
|
||||
get { return false; }
|
||||
}
|
||||
|
||||
public void Initialise(Scene scene, IConfigSource config)
|
||||
{
|
||||
// Do a once-only scan of the configuration file to make
|
||||
// sure it's basically intact.
|
||||
|
||||
if (!configured)
|
||||
{
|
||||
configured = true;
|
||||
|
||||
try
|
||||
{
|
||||
if ((m_config = config.Configs["IRC"]) == null)
|
||||
{
|
||||
m_log.InfoFormat("[IRC-Bridge] module not configured");
|
||||
return;
|
||||
}
|
||||
|
||||
if (!m_config.GetBoolean("enabled", false))
|
||||
{
|
||||
m_log.InfoFormat("[IRC-Bridge] module disabled in configuration");
|
||||
return;
|
||||
}
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
m_log.ErrorFormat("[IRC-Bridge] configuration failed : {0}", e.Message);
|
||||
return;
|
||||
}
|
||||
|
||||
enabled = true;
|
||||
|
||||
if (config.Configs["RemoteAdmin"] != null)
|
||||
{
|
||||
password = config.Configs["RemoteAdmin"].GetString("access_password", password);
|
||||
scene.CommsManager.HttpServer.AddXmlRPCHandler("irc_admin", XmlRpcAdminMethod, false);
|
||||
}
|
||||
}
|
||||
|
||||
// Iff the IRC bridge is enabled, then each new region may be
|
||||
// connected to IRC. But it should NOT be obligatory (and it
|
||||
// is not).
|
||||
// We have to do ALL of the startup here because PostInitialize
|
||||
// is not called when a region gets created in-flight from the
|
||||
// command line.
|
||||
|
||||
if (enabled)
|
||||
{
|
||||
try
|
||||
{
|
||||
m_log.InfoFormat("[IRC-Bridge] Connecting region {0}", scene.RegionInfo.RegionName);
|
||||
region = new RegionState(scene, m_config);
|
||||
lock (m_regions) m_regions.Add(region);
|
||||
region.Open();
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
m_log.WarnFormat("[IRC-Bridge] Region {0} not connected to IRC : {1}", scene.RegionInfo.RegionName, e.Message);
|
||||
m_log.Debug(e);
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
m_log.WarnFormat("[IRC-Bridge] Not enabled. Connect for region {0} ignored", scene.RegionInfo.RegionName);
|
||||
}
|
||||
}
|
||||
|
||||
// This module can be called in-flight in which case PostInitialize
|
||||
// is not called following Initialize. So no use is made of this
|
||||
// call.
|
||||
|
||||
public void PostInitialise()
|
||||
{
|
||||
}
|
||||
|
||||
// Called immediately before the region module is unloaded. Cleanup
|
||||
// the region.
|
||||
|
||||
public void Close()
|
||||
{
|
||||
if (!enabled)
|
||||
return;
|
||||
|
||||
region.Close();
|
||||
lock (m_regions) m_regions.Remove(region);
|
||||
}
|
||||
|
||||
#endregion
|
||||
|
||||
public static XmlRpcResponse XmlRpcAdminMethod(XmlRpcRequest request)
|
||||
{
|
||||
m_log.Info("[IRC-Bridge]: XML RPC Admin Entry");
|
||||
|
||||
XmlRpcResponse response = new XmlRpcResponse();
|
||||
Hashtable responseData = new Hashtable();
|
||||
|
||||
try
|
||||
{
|
||||
Hashtable requestData = (Hashtable)request.Params[0];
|
||||
bool found = false;
|
||||
string region = String.Empty;
|
||||
|
||||
if (password != String.Empty)
|
||||
{
|
||||
if (!requestData.ContainsKey("password"))
|
||||
throw new Exception("Invalid request");
|
||||
if ((string)requestData["password"] != password)
|
||||
throw new Exception("Invalid request");
|
||||
}
|
||||
|
||||
if (!requestData.ContainsKey("region"))
|
||||
throw new Exception("No region name specified");
|
||||
region = (string)requestData["region"];
|
||||
|
||||
foreach (RegionState rs in m_regions)
|
||||
{
|
||||
if (rs.Region == region)
|
||||
{
|
||||
responseData["server"] = rs.cs.Server;
|
||||
responseData["port"] = (int)rs.cs.Port;
|
||||
responseData["user"] = rs.cs.User;
|
||||
responseData["channel"] = rs.cs.IrcChannel;
|
||||
responseData["enabled"] = rs.cs.irc.Enabled;
|
||||
responseData["connected"] = rs.cs.irc.Connected;
|
||||
responseData["nickname"] = rs.cs.irc.Nick;
|
||||
found = true;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
if (!found) throw new Exception(String.Format("Region <{0}> not found", region));
|
||||
|
||||
responseData["success"] = true;
|
||||
}
|
||||
catch (Exception e)
|
||||
{
|
||||
m_log.InfoFormat("[IRC-Bridge] XML RPC Admin request failed : {0}", e.Message);
|
||||
|
||||
responseData["success"] = "false";
|
||||
responseData["error"] = e.Message;
|
||||
}
|
||||
finally
|
||||
{
|
||||
response.Value = responseData;
|
||||
}
|
||||
|
||||
m_log.Debug("[IRC-Bridge]: XML RPC Admin Exit");
|
||||
|
||||
return response;
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user