aboutsummaryrefslogtreecommitdiffstatshomepage
diff options
context:
space:
mode:
-rw-r--r--OpenSim/Region/OptionalModules/Scripting/RegionReady/RegionReady.cs146
-rw-r--r--bin/OpenSim.ini.example11
2 files changed, 157 insertions, 0 deletions
diff --git a/OpenSim/Region/OptionalModules/Scripting/RegionReady/RegionReady.cs b/OpenSim/Region/OptionalModules/Scripting/RegionReady/RegionReady.cs
new file mode 100644
index 0000000..c68d1cb
--- /dev/null
+++ b/OpenSim/Region/OptionalModules/Scripting/RegionReady/RegionReady.cs
@@ -0,0 +1,146 @@
1/*
2 * Copyright (c) Contributors, http://opensimulator.org/
3 * See CONTRIBUTORS.TXT for a full list of copyright holders.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the OpenSim Project nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
17 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28using System;
29using System.Collections.Generic;
30using System.Reflection;
31
32using log4net;
33using Nini.Config;
34using OpenMetaverse;
35
36using OpenSim.Framework;
37using OpenSim.Region.Framework.Interfaces;
38using OpenSim.Region.Framework.Scenes;
39
40namespace OpenSim.Region.CoreModules.Scripting.RegionReady
41{
42 public class RegionReady : IRegionModule
43 {
44 private readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
45 private IConfig m_config = null;
46 private bool m_firstEmptyCompileQueue;
47 private bool m_oarFileLoading;
48 private bool m_lastOarLoadedOk;
49 private int m_channelNotify = -1000;
50 private bool m_enabled = false;
51
52 Scene m_scene = null;
53
54 #region IRegionModule interface
55
56 public void Initialise(Scene scene, IConfigSource config)
57 {
58 m_log.Info("[RegionReady] Initialising");
59 m_scene = scene;
60 m_firstEmptyCompileQueue = true;
61 m_oarFileLoading = false;
62 m_lastOarLoadedOk = true;
63 m_config = config.Configs["RegionReady"];
64
65 if (m_config != null)
66 {
67 m_enabled = m_config.GetBoolean("enabled", false);
68 if (m_enabled)
69 {
70 m_channelNotify = m_config.GetInt("channel_notify", m_channelNotify);
71 }
72 }
73 }
74
75 public void PostInitialise()
76 {
77 if (m_enabled)
78 {
79 m_log.Info("[RegionReady] Enabled");
80 m_scene.EventManager.OnEmptyScriptCompileQueue += new EventManager.EmptyScriptCompileQueue(OnEmptyScriptCompileQueue);
81 m_scene.EventManager.OnOarFileLoaded += new EventManager.OarFileLoaded(OnOarFileLoaded);
82 }
83 else
84 {
85 m_log.Info("[RegionReady] Disabled");
86 }
87 }
88
89 public void Close()
90 {
91 }
92
93 public string Name
94 {
95 get { return "Region Ready Module"; }
96 }
97
98 public bool IsSharedModule
99 {
100 get { return false; }
101 }
102
103 #endregion
104
105
106 void OnEmptyScriptCompileQueue(int numScriptsFailed, string message)
107 {
108 if (m_firstEmptyCompileQueue || m_oarFileLoading)
109 {
110 m_firstEmptyCompileQueue = false;
111 m_oarFileLoading = false;
112
113 m_scene.Backup();
114
115 OSChatMessage c = new OSChatMessage();
116 c.From = "RegionReady";
117 if (m_lastOarLoadedOk)
118 c.Message = "1,";
119 else
120 c.Message = "0,";
121 c.Channel = m_channelNotify;
122 c.Message += numScriptsFailed.ToString() + "," + message;
123 c.Type = ChatTypeEnum.Region;
124 c.Position = new Vector3(128, 128, 30);
125 c.Sender = null;
126 c.SenderUUID = UUID.Zero;
127
128 m_log.InfoFormat("[RegionReady] Region is ready: \"{0}\" on channel {1}",
129 c.Message, m_channelNotify);
130 m_scene.EventManager.TriggerOnChatBroadcast(this, c);
131 }
132 }
133
134 void OnOarFileLoaded(string message)
135 {
136 m_oarFileLoading = true;
137 if (message==String.Empty)
138 {
139 m_lastOarLoadedOk = true;
140 } else {
141 m_log.InfoFormat("[RegionReady] Oar file load errors: {0}", message);
142 m_lastOarLoadedOk = false;
143 }
144 }
145 }
146}
diff --git a/bin/OpenSim.ini.example b/bin/OpenSim.ini.example
index 459d3ed..3015392 100644
--- a/bin/OpenSim.ini.example
+++ b/bin/OpenSim.ini.example
@@ -1012,3 +1012,14 @@ InterregionComms = "RESTComms"
1012 1012
1013 ; Density of tree population 1013 ; Density of tree population
1014 tree_density = 1000.0 1014 tree_density = 1000.0
1015
1016[RegionReady]
1017 ; Enable this module to get notified once all items and scripts in the region have been completely loaded and compiled
1018 enabled = false
1019
1020 ; Channel on which to signal region readiness through a message
1021 ; formatted as follows: "{0|1},n,[oar error]"
1022 ; - the first number indicating whether the OAR file loaded ok (1 == ok, 0 == error)
1023 ; - the second number indicates how many scrips failed to compile
1024 ; - "oar error" if supplied, provides the error message from the OAR load
1025 channel_notify = -800