diff options
author | Diva Canto | 2014-11-10 19:03:06 -0800 |
---|---|---|
committer | Diva Canto | 2014-11-10 19:03:06 -0800 |
commit | 5e34727b7e2796e6eb621cdc3ede48ab796c198e (patch) | |
tree | 4a47c34bc3a80e7d020de4a89984b18ab9a9f258 /OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs | |
parent | Merge branch 'master' of ssh://opensimulator.org/var/git/opensim (diff) | |
download | opensim-SC_OLD-5e34727b7e2796e6eb621cdc3ede48ab796c198e.zip opensim-SC_OLD-5e34727b7e2796e6eb621cdc3ede48ab796c198e.tar.gz opensim-SC_OLD-5e34727b7e2796e6eb621cdc3ede48ab796c198e.tar.bz2 opensim-SC_OLD-5e34727b7e2796e6eb621cdc3ede48ab796c198e.tar.xz |
Add additional viewer support modules that allow certain viewers to modify their UI on the fly.
Diffstat (limited to '')
-rw-r--r-- | OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs b/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs new file mode 100644 index 0000000..6415c6c --- /dev/null +++ b/OpenSim/Region/OptionalModules/ViewerSupport/SpecialUIModule.cs | |||
@@ -0,0 +1,147 @@ | |||
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 OpenSimulator 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 | |||
28 | using System; | ||
29 | using System.IO; | ||
30 | using System.Reflection; | ||
31 | using System.Text; | ||
32 | using System.Collections.Generic; | ||
33 | using System.Threading; | ||
34 | using OpenMetaverse; | ||
35 | using OpenMetaverse.StructuredData; | ||
36 | using OpenSim; | ||
37 | using OpenSim.Region; | ||
38 | using OpenSim.Region.Framework; | ||
39 | using OpenSim.Region.Framework.Scenes; | ||
40 | using OpenSim.Region.Framework.Interfaces; | ||
41 | using OpenSim.Framework; | ||
42 | //using OpenSim.Framework.Capabilities; | ||
43 | using OpenSim.Framework.Servers; | ||
44 | using OpenSim.Framework.Servers.HttpServer; | ||
45 | using Nini.Config; | ||
46 | using log4net; | ||
47 | using Mono.Addins; | ||
48 | using OSDMap = OpenMetaverse.StructuredData.OSDMap; | ||
49 | using TeleportFlags = OpenSim.Framework.Constants.TeleportFlags; | ||
50 | |||
51 | namespace OpenSim.Region.OptionalModules.ViewerSupport | ||
52 | { | ||
53 | [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "SpecialUI")] | ||
54 | public class SpecialUIModule : INonSharedRegionModule | ||
55 | { | ||
56 | private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType); | ||
57 | private const string VIEWER_SUPPORT_DIR = "ViewerSupport"; | ||
58 | |||
59 | private Scene m_scene; | ||
60 | private SimulatorFeaturesHelper m_Helper; | ||
61 | private bool m_Enabled; | ||
62 | private int m_UserLevel; | ||
63 | |||
64 | public string Name | ||
65 | { | ||
66 | get { return "SpecialUIModule"; } | ||
67 | } | ||
68 | |||
69 | public Type ReplaceableInterface | ||
70 | { | ||
71 | get { return null; } | ||
72 | } | ||
73 | |||
74 | public void Initialise(IConfigSource config) | ||
75 | { | ||
76 | IConfig moduleConfig = config.Configs["SpecialUIModule"]; | ||
77 | if (moduleConfig != null) | ||
78 | { | ||
79 | m_Enabled = moduleConfig.GetBoolean("enabled", false); | ||
80 | if (m_Enabled) | ||
81 | { | ||
82 | m_UserLevel = moduleConfig.GetInt("UserLevel", 0); | ||
83 | m_log.Info("[SPECIAL UI]: SpecialUIModule enabled"); | ||
84 | } | ||
85 | |||
86 | } | ||
87 | } | ||
88 | |||
89 | public void Close() | ||
90 | { | ||
91 | } | ||
92 | |||
93 | public void AddRegion(Scene scene) | ||
94 | { | ||
95 | if (m_Enabled) | ||
96 | { | ||
97 | m_scene = scene; | ||
98 | IEntityTransferModule et = m_scene.RequestModuleInterface<IEntityTransferModule>(); | ||
99 | m_Helper = new SimulatorFeaturesHelper(scene, et); | ||
100 | } | ||
101 | } | ||
102 | |||
103 | public void RegionLoaded(Scene scene) | ||
104 | { | ||
105 | if (m_Enabled) | ||
106 | { | ||
107 | ISimulatorFeaturesModule featuresModule = m_scene.RequestModuleInterface<ISimulatorFeaturesModule>(); | ||
108 | |||
109 | if (featuresModule != null && m_Enabled) | ||
110 | featuresModule.OnSimulatorFeaturesRequest += OnSimulatorFeaturesRequest; | ||
111 | } | ||
112 | } | ||
113 | |||
114 | public void RemoveRegion(Scene scene) | ||
115 | { | ||
116 | } | ||
117 | |||
118 | private void OnSimulatorFeaturesRequest(UUID agentID, ref OSDMap features) | ||
119 | { | ||
120 | m_log.DebugFormat("[SPECIAL UI]: OnSimulatorFeaturesRequest in {0}", m_scene.RegionInfo.RegionName); | ||
121 | if (m_Helper.ShouldSend(agentID) && m_Helper.UserLevel(agentID) <= m_UserLevel) | ||
122 | { | ||
123 | using (StreamReader s = new StreamReader(Path.Combine(VIEWER_SUPPORT_DIR, "panel_toolbar.xml"))) | ||
124 | { | ||
125 | OSDMap extrasMap; | ||
126 | if (features.ContainsKey("OpenSimExtras")) | ||
127 | extrasMap = (OSDMap)features["OpenSimExtras"]; | ||
128 | else | ||
129 | { | ||
130 | extrasMap = new OSDMap(); | ||
131 | features["OpenSimExtras"] = extrasMap; | ||
132 | } | ||
133 | |||
134 | OSDMap specialUI = new OSDMap(); | ||
135 | specialUI["toolbar"] = OSDMap.FromString(s.ReadToEnd()); | ||
136 | extrasMap["special-ui"] = specialUI; | ||
137 | } | ||
138 | m_log.DebugFormat("[SPECIAL UI]: Sending panel_toolbar.xml in {0}", m_scene.RegionInfo.RegionName); | ||
139 | } | ||
140 | else | ||
141 | m_log.DebugFormat("[SPECIAL UI]: NOT Sending panel_toolbar.xml in {0}", m_scene.RegionInfo.RegionName); | ||
142 | |||
143 | } | ||
144 | |||
145 | } | ||
146 | |||
147 | } | ||