OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
GetDisplayNamesModule.cs
Go to the documentation of this file.
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.Collections;
30 using System.Collections.Specialized;
31 using System.Drawing;
32 using System.Drawing.Imaging;
33 using System.Reflection;
34 using System.IO;
35 using System.Web;
36 using log4net;
37 using Nini.Config;
38 using Mono.Addins;
39 using OpenMetaverse;
40 using OpenMetaverse.StructuredData;
41 using OpenMetaverse.Imaging;
42 using OpenSim.Framework;
43 using OpenSim.Framework.Servers;
44 using OpenSim.Framework.Servers.HttpServer;
45 using OpenSim.Region.Framework.Interfaces;
46 using OpenSim.Region.Framework.Scenes;
47 using OpenSim.Services.Interfaces;
49 using OpenSim.Capabilities.Handlers;
50 
51 namespace OpenSim.Region.ClientStack.Linden
52 {
53 
54  [Extension(Path = "/OpenSim/RegionModules", NodeName = "RegionModule", Id = "GetDisplayNamesModule")]
56  {
57  private static readonly ILog m_log =
58  LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
59 
60  private Scene m_scene;
61  private IUserManagement m_UserManager;
62 
63  private bool m_Enabled = false;
64 
65  private string m_URL;
66 
67  #region ISharedRegionModule Members
68 
69  public void Initialise(IConfigSource source)
70  {
71  IConfig config = source.Configs["ClientStack.LindenCaps"];
72  if (config == null)
73  return;
74 
75  m_URL = config.GetString("Cap_GetDisplayNames", string.Empty);
76  if (m_URL != string.Empty)
77  m_Enabled = true;
78  }
79 
80  public void AddRegion(Scene s)
81  {
82  if (!m_Enabled)
83  return;
84 
85  m_scene = s;
86  }
87 
88  public void RemoveRegion(Scene s)
89  {
90  if (!m_Enabled)
91  return;
92 
93  m_scene.EventManager.OnRegisterCaps -= RegisterCaps;
94  m_scene = null;
95  }
96 
97  public void RegionLoaded(Scene s)
98  {
99  if (!m_Enabled)
100  return;
101 
102  m_UserManager = m_scene.RequestModuleInterface<IUserManagement>();
103  m_scene.EventManager.OnRegisterCaps += RegisterCaps;
104  }
105 
106  public void PostInitialise()
107  {
108  }
109 
110  public void Close() { }
111 
112  public string Name { get { return "GetDisplayNamesModule"; } }
113 
114  public Type ReplaceableInterface
115  {
116  get { return null; }
117  }
118 
119  #endregion
120 
121  public void RegisterCaps(UUID agentID, Caps caps)
122  {
123  UUID capID = UUID.Random();
124 
125  if (m_URL == "localhost")
126  {
127  m_log.DebugFormat("[GET_DISPLAY_NAMES]: /CAPS/agents/{0} in region {1}", capID, m_scene.RegionInfo.RegionName);
128  caps.RegisterHandler(
129  "GetDisplayNames",
130  new GetDisplayNamesHandler("/CAPS/agents" + capID + "/", m_UserManager, "GetDisplayNames", agentID.ToString()));
131  }
132  else
133  {
134 // m_log.DebugFormat("[GETTEXTURE]: {0} in region {1}", m_URL, m_scene.RegionInfo.RegionName);
135  IExternalCapsModule handler = m_scene.RequestModuleInterface<IExternalCapsModule>();
136  if (handler != null)
137  handler.RegisterExternalUserCapsHandler(agentID,caps,"GetDisplayNames", m_URL);
138  else
139  caps.RegisterHandler("GetDisplayNames", m_URL);
140  }
141  }
142 
143  }
144 }
void Close()
This is the inverse to Initialise. After a Close(), this instance won't be usable anymore...
void RemoveRegion(Scene s)
This is called whenever a Scene is removed. For shared modules, this can happen several times...
OpenSim.Framework.Capabilities.Caps Caps
void Initialise(IConfigSource source)
This is called to initialize the region module. For shared modules, this is called exactly once...
void RegionLoaded(Scene s)
This will be called once for every scene loaded. In a shared module this will be multiple times in on...
void AddRegion(Scene s)
This is called whenever a Scene is added. For shared modules, this can happen several times...
OpenSim.Framework.Capabilities.Caps Caps
This maintains the relationship between a UUID and a user name.