Donating the Avination Mute Module

This lived out-of-tree and therefore wasn't part of the big code
drop. It's classic Avination, tied to MySQL and a direct database
connection and I don't have the bandwidth to fix it to core methods.
However, it has all the strange mute logic that OpenSim was missing
and maybe someone can step up to make it work in an open grid context.

2 files changed, 373 insertions, 0 deletions

diff --git a/OpenSim/Data/MySQL/Resources/XMute.migrations b/OpenSim/Data/MySQL/Resources/XMute.migrations
new file mode 100644
index 0000000..4ac7f82
--- /dev/null
+++ b/OpenSim/Data/MySQL/Resources/XMute.migrations
@@ -0,0 +1,16 @@
+:VERSION 1
+
+BEGIN;
+
+CREATE TABLE `XMute` (
+  `AgentID` char(36) NOT NULL,
+  `MuteID` char(36) NOT NULL DEFAULT '00000000-0000-0000-0000-000000000000',
+  `MuteName` varchar(64) NOT NULL DEFAULT '',
+  `MuteType` int(11) NOT NULL DEFAULT '1',
+  `MuteFlags` int(11) NOT NULL DEFAULT '0',
+  `Stamp` int(11) NOT NULL,
+  UNIQUE KEY `AgentID_2` (`AgentID`,`MuteID`,`MuteName`),
+  KEY `AgentID` (`AgentID`)
+);
+
+COMMIT;
diff --git a/OpenSim/Region/CoreModules/Avatar/InstantMessage/XMuteModule.cs b/OpenSim/Region/CoreModules/Avatar/InstantMessage/XMuteModule.cs
new file mode 100644
index 0000000..fb5239f
--- /dev/null
+++ b/OpenSim/Region/CoreModules/Avatar/InstantMessage/XMuteModule.cs
@@ -0,0 +1,357 @@
+/*
+ * 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 log4net;
+using Nini.Config;
+using OpenMetaverse;
+using OpenSim.Framework;
+using OpenSim.Framework.Servers;
+using OpenSim.Framework.Client;
+using OpenSim.Region.Framework.Interfaces;
+using OpenSim.Region.Framework.Scenes;
+using Mono.Addins;
+using OpenSim.Data;
+using OpenSim.Data.MySQL;
+using MySql.Data.MySqlClient;
+using System.Security.Cryptography;
+
+namespace OpenSim.Region.CoreModules.Avatar.InstantMessage
+{
+    public class MuteData
+    {
+        public UUID AgentID;
+        public UUID MuteID;
+        public string MuteName;
+        public int MuteType;
+        public int MuteFlags;
+        public int Stamp;
+    }
+
+    [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "XMute")]
+    public class XMuteModule : ISharedRegionModule
+    {
+        private static readonly ILog m_log = LogManager.GetLogger(
+                MethodBase.GetCurrentMethod().DeclaringType);
+
+        protected bool m_Enabled = true;
+        protected List<Scene> m_SceneList = new List<Scene>();
+        protected MuteTableHandler m_MuteTable;
+        protected string m_DatabaseConnect;
+
+        public void Initialise(IConfigSource config)
+        {
+            IConfig cnf = config.Configs["Messaging"];
+            if (cnf == null)
+            {
+                m_Enabled = false;
+                return;
+            }
+
+            if (cnf.GetString("MuteListModule", "None") !=
+                    "XMute")
+            {
+                m_Enabled = false;
+                return;
+            }
+
+            m_DatabaseConnect = cnf.GetString("MuteDatabaseConnect", String.Empty);
+            if (m_DatabaseConnect == String.Empty)
+            {
+                m_log.Debug("[XMute]: MuteDatabaseConnect missing or empty");
+                m_Enabled = false;
+                return;
+            }
+
+            m_MuteTable = new MuteTableHandler(
+                    m_DatabaseConnect, "XMute", String.Empty);
+        }
+
+        public void AddRegion(Scene scene)
+        {
+            if (!m_Enabled)
+                return;
+
+            lock (m_SceneList)
+            {
+                m_SceneList.Add(scene);
+
+                scene.EventManager.OnNewClient += OnNewClient;
+            }
+        }
+
+        public void RegionLoaded(Scene scene)
+        {
+        }
+
+        public void RemoveRegion(Scene scene)
+        {
+            if (!m_Enabled)
+                return;
+
+            lock (m_SceneList)
+            {
+                m_SceneList.Remove(scene);
+            }
+        }
+
+        public void PostInitialise()
+        {
+            if (!m_Enabled)
+                return;
+
+            m_log.Debug("[XMute]: Mute list enabled");
+        }
+
+        public string Name
+        {
+            get { return "XMuteModule"; }
+        }
+
+        public Type ReplaceableInterface
+        {
+            get { return null; }
+        }
+        
+        public void Close()
+        {
+        }
+       
+        private void OnNewClient(IClientAPI client)
+        {
+            client.OnMuteListRequest += OnMuteListRequest;
+            client.OnUpdateMuteListEntry += OnUpdateMuteListEntry;
+            client.OnRemoveMuteListEntry += OnRemoveMuteListEntry;
+        }
+
+        private void OnMuteListRequest(IClientAPI client, uint crc)
+        {
+            string filename = "mutes"+client.AgentId.ToString();
+
+            IXfer xfer = client.Scene.RequestModuleInterface<IXfer>();
+            if (xfer != null)
+            {
+                MuteData[] data = m_MuteTable.Get("AgentID", client.AgentId.ToString());
+                if (data == null || data.Length == 0)
+                {
+                    xfer.AddNewFile(filename, new Byte[0]);
+                }
+                else
+                {
+                    List<string> mutes = new List<string>();
+
+                    foreach (MuteData d in data)
+                        mutes.Add(String.Format("{0} {1} {2}|{3}",
+                                d.MuteType,
+                                d.MuteID.ToString(),
+                                d.MuteName,
+                                d.MuteFlags));
+
+                    Byte[] filedata = Util.UTF8.GetBytes(String.Join("\n",
+                            mutes.ToArray()) + "\n");
+
+                    uint dataCrc = Crc32.Compute(filedata);
+
+                    if (dataCrc == crc)
+                    {
+                        client.SendUseCachedMuteList();
+                        return;
+                    }
+
+                    xfer.AddNewFile(filename, filedata);
+                }
+
+                client.SendMuteListUpdate(filename);
+            }
+        }
+
+        private void OnUpdateMuteListEntry(IClientAPI client, UUID muteID, string muteName, int muteType, uint muteFlags)
+        {
+            MuteData mute = new MuteData();
+
+            mute.AgentID = client.AgentId;
+            mute.MuteID = muteID;
+            mute.MuteName = muteName;
+            mute.MuteType = muteType;
+            mute.MuteFlags = (int)muteFlags;
+            mute.Stamp = Util.UnixTimeSinceEpoch();
+
+            m_MuteTable.Store(mute);
+        }
+
+        private void OnRemoveMuteListEntry(IClientAPI client, UUID muteID, string muteName)
+        {
+            m_MuteTable.Delete(new string[] { "AgentID",
+                                              "MuteID",
+                                              "MuteName" },
+                               new string[] { client.AgentId.ToString(),
+                                              muteID.ToString(),
+                                              muteName });
+        }
+    }
+
+    public class MuteTableHandler : MySQLGenericTableHandler<MuteData>
+    {
+        public MuteTableHandler(string conn, string realm, string m) : base(conn, realm, m)
+        {
+        }
+
+        public bool Delete(string[] fields, string[] val)
+        {
+            if (fields.Length != val.Length)
+                return false;
+
+            using (MySqlCommand cmd = new MySqlCommand())
+            {
+                string text = String.Format("delete from {0} where ", m_Realm);
+
+                List<string> terms = new List<string>();
+
+                for (int i = 0 ; i < fields.Length ; i++)
+                {
+                    terms.Add(String.Format("{0} = ?{0}", fields[i]));
+                    cmd.Parameters.AddWithValue("?" + fields[i], val[i]);
+                }
+
+                text += string.Join(" and ", terms.ToArray());
+
+                cmd.CommandText = text;
+
+                if (ExecuteNonQuery(cmd) > 0)
+                    return true;
+                return false;
+            }
+        }
+    }
+
+    public class Crc32 : HashAlgorithm
+    {
+        public const UInt32 DefaultPolynomial = 0xedb88320;
+        public const UInt32 DefaultSeed = 0xffffffff;
+
+        private UInt32 hash;
+        private UInt32 seed;
+        private UInt32[] table;
+        private static UInt32[] defaultTable;
+
+        public Crc32()
+        {
+            table = InitializeTable(DefaultPolynomial);
+            seed = DefaultSeed;
+            Initialize();
+        }
+
+        public Crc32(UInt32 polynomial, UInt32 seed)
+        {
+            table = InitializeTable(polynomial);
+            this.seed = seed;
+            Initialize();
+        }
+
+        public override void Initialize()
+        {
+            hash = seed;
+        }
+
+        protected override void HashCore(byte[] buffer, int start, int length)
+        {
+            hash = CalculateHash(table, hash, buffer, start, length);
+        }
+
+        protected override byte[] HashFinal()
+        {
+            byte[] hashBuffer = UInt32ToBigEndianBytes(~hash);
+            this.HashValue = hashBuffer;
+            return hashBuffer;
+        }
+
+        public override int HashSize
+        {
+            get { return 32; }
+        }
+
+        public static UInt32 Compute(byte[] buffer)
+        {
+            return ~CalculateHash(InitializeTable(DefaultPolynomial), DefaultSeed, buffer, 0, buffer.Length);
+        }
+
+        public static UInt32 Compute(UInt32 seed, byte[] buffer)
+        {
+            return ~CalculateHash(InitializeTable(DefaultPolynomial), seed, buffer, 0, buffer.Length);
+        }
+
+        public static UInt32 Compute(UInt32 polynomial, UInt32 seed, byte[] buffer)
+        {
+            return ~CalculateHash(InitializeTable(polynomial), seed, buffer, 0, buffer.Length);
+        }
+
+        private static UInt32[] InitializeTable(UInt32 polynomial)
+        {
+            if (polynomial == DefaultPolynomial && defaultTable != null)
+                return defaultTable;
+
+            UInt32[] createTable = new UInt32[256];
+            for (int i = 0; i < 256; i++)
+            {
+                UInt32 entry = (UInt32)i;
+                for (int j = 0; j < 8; j++)
+                    if ((entry & 1) == 1)
+                        entry = (entry >> 1) ^ polynomial;
+                    else
+                        entry = entry >> 1;
+                createTable[i] = entry;
+            }
+
+            if (polynomial == DefaultPolynomial)
+                defaultTable = createTable;
+
+            return createTable;
+        }
+
+        private static UInt32 CalculateHash(UInt32[] table, UInt32 seed, byte[] buffer, int start, int size)
+        {
+            UInt32 crc = seed;
+            for (int i = start; i < size; i++)
+                unchecked
+                {
+                    crc = (crc >> 8) ^ table[buffer[i] ^ crc & 0xff];
+                }
+            return crc;
+        }
+
+        private byte[] UInt32ToBigEndianBytes(UInt32 x)
+        {
+            return new byte[] {
+                    (byte)((x >> 24) & 0xff),
+                    (byte)((x >> 16) & 0xff),
+                    (byte)((x >> 8) & 0xff),
+                    (byte)(x & 0xff) };
+        }
+    }
+}
+