Continue with renaming of Groups module components

4 files changed, 51 insertions, 42 deletions

diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
index f7883da..0bfb8e7 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsMessagingModule.cs
@@ -59,7 +59,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         private IGroupsModule m_groupsModule = null;
 
-        // TODO: Move this off to the xmlrpc server
+        // TODO: Move this off to the Groups Server
         public Dictionary<Guid, List<Guid>> m_agentsInGroupSession = new Dictionary<Guid, List<Guid>>();
         public Dictionary<Guid, List<Guid>> m_agentsDroppedSession = new Dictionary<Guid, List<Guid>>();
 
@@ -81,31 +81,28 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             }
             else
             {
-                if (!groupsConfig.GetBoolean("Enabled", false))
-                {
-                    return;
-                }
-
-                if (groupsConfig.GetString("Module", "Default") != "XmlRpcGroups")
+                // if groups aren't enabled, we're not needed.
+                // if we're not specified as the connector to use, then we're not wanted
+                if ((groupsConfig.GetBoolean("Enabled", false) == false)
+                     || (groupsConfig.GetString("MessagingModule", "Default") != Name))
                 {
                     m_groupMessagingEnabled = false;
-
                     return;
                 }
 
-                m_groupMessagingEnabled = groupsConfig.GetBoolean("XmlRpcMessagingEnabled", true);
+                m_groupMessagingEnabled = groupsConfig.GetBoolean("MessagingEnabled", true);
 
                 if (!m_groupMessagingEnabled)
                 {
                     return;
                 }
 
-                m_log.Info("[GROUPS-MESSAGING]: Initializing XmlRpcGroupsMessaging");
+                m_log.Info("[GROUPS-MESSAGING]: Initializing GroupsMessagingModule");
 
-                m_debugEnabled = groupsConfig.GetBoolean("XmlRpcDebugEnabled", true);
+                m_debugEnabled = groupsConfig.GetBoolean("DebugEnabled", true);
             }
 
-            m_log.Info("[GROUPS-MESSAGING]: XmlRpcGroupsMessaging starting up");
+            m_log.Info("[GROUPS-MESSAGING]: GroupsMessagingModule starting up");
 
         }
 
@@ -125,7 +122,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             // No groups module, no groups messaging
             if (m_groupsModule == null)
             {
-                m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsModule, XmlRpcGroupsMessaging is now disabled.");
+                m_log.Error("[GROUPS-MESSAGING]: Could not get IGroupsModule, GroupsMessagingModule is now disabled.");
                 Close();
                 m_groupMessagingEnabled = false;
                 return;
@@ -165,7 +162,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             if (!m_groupMessagingEnabled)
                 return;
 
-            if (m_debugEnabled) m_log.Debug("[GROUPS-MESSAGING]: Shutting down XmlRpcGroupsMessaging module.");
+            if (m_debugEnabled) m_log.Debug("[GROUPS-MESSAGING]: Shutting down GroupsMessagingModule module.");
 
             foreach (Scene scene in m_sceneList)
             {
@@ -186,7 +183,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         public string Name
         {
-            get { return "XmlRpcGroupsMessaging"; }
+            get { return "GroupsMessagingModule"; }
         }
 
         #endregion
diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
index 3fd2a85..5ec8de8 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/GroupsModule.cs
@@ -57,14 +57,19 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
         /// ; To use this module, you must specify the following in your OpenSim.ini
         /// [GROUPS]
         /// Enabled = true
-        /// Module  = XmlRpcGroups
-        /// XmlRpcServiceURL = http://osflotsam.org/xmlrpc.php
-        /// XmlRpcMessagingEnabled = true
-        /// XmlRpcNoticesEnabled = true
-        /// XmlRpcDebugEnabled = true
-        /// XmlRpcServiceReadKey = 1234
+        /// 
+        /// GroupsModule   = GroupsModule
+        /// NoticesEnabled = true
+        /// DebugEnabled   = true
+        /// 
+        /// GroupsServicesConnectorModule = XmlRpcGroupsServicesConnector
+        /// XmlRpcServiceURL      = http://osflotsam.org/xmlrpc.php
+        /// XmlRpcServiceReadKey  = 1234
         /// XmlRpcServiceWriteKey = 1234
         /// 
+        /// GroupsMessagingModule  = GroupsMessagingModule
+        /// GroupsMessagingEnabled = true
+        /// 
         /// ; Disables HTTP Keep-Alive for Groups Module HTTP Requests, work around for
         /// ; a problem discovered on some Windows based region servers.  Only disable
         /// ; if you see a large number (dozens) of the following Exceptions:
@@ -116,7 +121,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                     return;
                 }
 
-                if (groupsConfig.GetString("Module", "Default") != "XmlRpcGroups")
+                if (groupsConfig.GetString("Module", "Default") != Name)
                 {
                     m_groupsEnabled = false;
 
@@ -125,8 +130,8 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
                 m_log.InfoFormat("[GROUPS]: Initializing {0}", this.Name);
 
-                m_groupNoticesEnabled   = groupsConfig.GetBoolean("XmlRpcNoticesEnabled", true);
-                m_debugEnabled          = groupsConfig.GetBoolean("XmlRpcDebugEnabled", true);
+                m_groupNoticesEnabled   = groupsConfig.GetBoolean("NoticesEnabled", true);
+                m_debugEnabled          = groupsConfig.GetBoolean("DebugEnabled", true);
 
                 m_clientRequestIDFlushTimer.Interval = m_clientRequestIDFlushTimeOut;
                 m_clientRequestIDFlushTimer.Elapsed += FlushClientRequestIDInfoCache;
@@ -224,7 +229,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
             if (!m_groupsEnabled)
                 return;
 
-            if (m_debugEnabled) m_log.Debug("[GROUPS]: Shutting down XmlRpcGroups module.");
+            if (m_debugEnabled) m_log.Debug("[GROUPS]: Shutting down Groups module.");
 
             m_clientRequestIDFlushTimer.Stop();
         }
@@ -236,7 +241,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
 
         public string Name
         {
-            get { return "XmlRpcGroupsModule"; }
+            get { return "GroupsModule"; }
         }
 
         #endregion
diff --git a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs
index 80adb9e..d77fe5b 100644
--- a/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs
+++ b/OpenSim/Region/OptionalModules/Avatar/XmlRpcGroups/XmlRpcGroupsServicesConnectorModule.cs
@@ -96,7 +96,7 @@ namespace OpenSim.Region.OptionalModules.Avatar.XmlRpcGroups
                 // if groups aren't enabled, we're not needed.
                 // if we're not specified as the connector to use, then we're not wanted
                 if ( (groupsConfig.GetBoolean("Enabled", false) == false)
-                     || (groupsConfig.GetString("GroupsServicesConnectorModule", "Default") != Name))
+                     || (groupsConfig.GetString("ServicesConnectorModule", "Default") != Name))
                 {
                     m_connectorEnabled = false;
                     return;
diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 6ae6a95..643b0af 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -1271,21 +1271,28 @@
     ; The PHP code for the server is available from the Flotsam project for you to deploy 
     ; to your own server.  The Flotsam project is located at http://code.google.com/p/flotsam/
     ;
-    ;Module  = XmlRpcGroups
-
-    ;XmlRpcServiceURL       = http://yourxmlrpcserver.com/xmlrpc.php
-    ;XmlRpcServiceReadKey = 1234
-    ;XmlRpcServiceWriteKey = 1234
-
-    ;XmlRpcMessagingEnabled = true
-    ;XmlRpcNoticesEnabled   = true
-
-    ; This makes the XmlRpcGroups modules very chatty on the console.
-    ;XmlRpcDebugEnabled     = true
-
-    ; Disables HTTP Keep-Alive for Groups Module HTTP Requests, work around for
-    ; a problem discovered on some Windows based region servers.  Only disable
-    ; if you see a large number (dozens) of the following Exceptions:
+    ;Module  = GroupsModule
+    
+    ; Enable Group Notices
+        ;NoticesEnabled   = true
+
+    ; This makes the Groups modules very chatty on the console.
+    ;DebugEnabled     = true
+
+    ; Specify which messaging module to use for groups messaging and if it's enabled    
+        ;MessagingModule = GroupsMessagingModule
+    ;MessagingEnabled = true
+
+    ; Service connector to Groups Service [Select One]
+    ; XmlRpc Service Connector to the Flotsam XmlRpc Groups Service Implementation
+    ;ServicesConnectorModule = XmlRpcGroupsServicesConnector
+    ;XmlRpcServiceURL        = http://yourxmlrpcserver.com/xmlrpc.php
+    ;XmlRpcServiceReadKey    = 1234
+    ;XmlRpcServiceWriteKey   = 1234
+
+    ; Disables HTTP Keep-Alive for XmlRpcGroupsServicesConnector HTTP Requests, 
+        ; this is a work around fora problem discovered on some Windows based region servers.  
+        ; Only disable keep alive if you see a large number (dozens) of the following Exceptions:
     ; System.Net.WebException: The request was aborted: The request was canceled.
     ;
     ; XmlRpcDisableKeepAlive = false