From 525ab2c2780d093e6f72d2054dca998620dd4629 Mon Sep 17 00:00:00 2001
From: Charles Krinke
Date: Wed, 8 Jul 2009 20:53:22 +0000
Subject: Thank you kindly, RandomHuman for a patch that: The
 admin_close_region method removes a region from the simulator without
 deleting it. The region can then be recreated by calling admin_create_region
 with the same UUID. There is also a change to admin_create_region to
 facilitate this.The reason I want to have this functionality is to make it
 possible to detach regions when they are idle and recreate them on demand
 through a web interface. It's probably doable using the existing methods by
 saving and loading oars, but it also doesn't seem like that should be
 necessary.

---
 .../RemoteController/RemoteAdminPlugin.cs          | 94 ++++++++++++++++++++++
 1 file changed, 94 insertions(+)

(limited to 'OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs')

diff --git a/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs b/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs
index 23b1cc9..9950534 100644
--- a/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs
+++ b/OpenSim/ApplicationPlugins/RemoteController/RemoteAdminPlugin.cs
@@ -107,6 +107,7 @@ namespace OpenSim.ApplicationPlugins.RemoteController
                     Dictionary<string, XmlRpcMethod> availableMethods = new Dictionary<string, XmlRpcMethod>();
                     availableMethods["admin_create_region"] = XmlRpcCreateRegionMethod;
                     availableMethods["admin_delete_region"] = XmlRpcDeleteRegionMethod;
+                    availableMethods["admin_close_region"] = XmlRpcCloseRegionMethod;
                     availableMethods["admin_modify_region"] = XmlRpcModifyRegionMethod;
                     availableMethods["admin_region_query"] = XmlRpcRegionQueryMethod;
                     availableMethods["admin_shutdown"] = XmlRpcShutdownMethod;
@@ -507,6 +508,7 @@ namespace OpenSim.ApplicationPlugins.RemoteController
                     RegionInfo region = new RegionInfo();
 
                     region.RegionID = regionID;
+                    region.originRegionID = regionID;
                     region.RegionName = (string) requestData["region_name"];
                     region.RegionLocX = Convert.ToUInt32(requestData["region_x"]);
                     region.RegionLocY = Convert.ToUInt32(requestData["region_y"]);
@@ -735,6 +737,98 @@ namespace OpenSim.ApplicationPlugins.RemoteController
                 return response;
             }
         }
+                    
+        /// <summary>
+        /// Close a region.
+        /// <summary>
+        /// <param name="request">incoming XML RPC request</param>
+        /// <remarks>
+        /// XmlRpcCloseRegionMethod takes the following XMLRPC
+        /// parameters
+        /// <list type="table">
+        /// <listheader><term>parameter name</term><description>description</description></listheader>
+        /// <item><term>password</term>
+        ///       <description>admin password as set in OpenSim.ini</description></item>
+        /// <item><term>region_name</term>
+        ///       <description>desired region name</description></item>
+        /// <item><term>region_id</term>
+        ///       <description>(optional) desired region UUID</description></item>
+        /// </list>
+        ///
+        /// XmlRpcShutdownRegionMethod returns
+        /// <list type="table">
+        /// <listheader><term>name</term><description>description</description></listheader>
+        /// <item><term>success</term>
+        ///       <description>true or false</description></item>
+        /// <item><term>region_name</term>
+        ///       <description>the region name if success is true</description></item>
+        /// <item><term>error</term>
+        ///       <description>error message if success is false</description></item>
+        /// </list>
+        /// </remarks>
+        public XmlRpcResponse XmlRpcCloseRegionMethod(XmlRpcRequest request, IPEndPoint remoteClient)
+        {
+            m_log.Info("[RADMIN]: CloseRegion: new request");
+            XmlRpcResponse response = new XmlRpcResponse();
+            Hashtable responseData = new Hashtable();
+            Scene scene = null;
+
+            lock (rslock)
+            {
+                try
+                {
+                    Hashtable requestData = (Hashtable) request.Params[0];
+                    checkStringParameters(request, new string[] {"password"});
+                    
+                    if (requestData.ContainsKey("region_id") &&
+                        !String.IsNullOrEmpty((string) requestData["region_id"]))
+                    {
+                        // Region specified by UUID
+                        UUID regionID = (UUID) (string) requestData["region_id"];
+                        if (!m_app.SceneManager.TryGetScene(regionID, out scene))
+                            throw new Exception(String.Format("region \"{0}\" does not exist", regionID));
+
+                        m_app.CloseRegion(scene);
+
+                        responseData["success"] = true;
+                        responseData["region_id"] = regionID;
+
+                        response.Value = responseData;
+                    }
+                    else if (requestData.ContainsKey("region_name") &&
+                        !String.IsNullOrEmpty((string) requestData["region_name"]))
+                    {
+                        // Region specified by name
+
+                        string regionName = (string) requestData["region_name"];
+                        if (!m_app.SceneManager.TryGetScene(regionName, out scene))
+                            throw new Exception(String.Format("region \"{0}\" does not exist", regionName));
+
+                        m_app.CloseRegion(scene);
+
+                        responseData["success"] = true;
+                        responseData["region_name"] = regionName;
+
+                        response.Value = responseData;
+                    }
+                    else
+                        throw new Exception("no region specified");
+                }
+                catch (Exception e)
+                {
+                    m_log.ErrorFormat("[RADMIN] CloseRegion: failed {0}", e.Message);
+                    m_log.DebugFormat("[RADMIN] CloseRegion: failed {0}", e.ToString());
+
+                    responseData["success"] = false;
+                    responseData["error"] = e.Message;
+
+                    response.Value = responseData;
+                }
+
+                m_log.Info("[RADMIN]: CloseRegion: request complete");
+                return response;
+            }
+        }
 
         /// <summary>
         /// Change characteristics of an existing region.
-- 
cgit v1.1