Radegast/Core/RadegastInstance.cs

   1 // \r
   2 // Radegast Metaverse Client\r
   3 // Copyright (c) 2009, Radegast Development Team\r
   4 // All rights reserved.\r
   5 // \r
   6 // Redistribution and use in source and binary forms, with or without\r
   7 // modification, are permitted provided that the following conditions are met:\r
   8 // \r
   9 //     * Redistributions of source code must retain the above copyright notice,\r
  10 //       this list of conditions and the following disclaimer.\r
  11 //     * Redistributions in binary form must reproduce the above copyright\r
  12 //       notice, this list of conditions and the following disclaimer in the\r
  13 //       documentation and/or other materials provided with the distribution.\r
  14 //     * Neither the name of the application "Radegast", nor the names of its\r
  15 //       contributors may be used to endorse or promote products derived from\r
  16 //       this software without specific prior written permission.\r
  17 // \r
  18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"\r
  19 // AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\r
  20 // IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\r
  21 // DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\r
  22 // FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\r
  23 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\r
  24 // SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\r
  25 // CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\r
  26 // OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\r
  27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\r
  28 //\r
  29 // $Id$\r
  30 //\r
  31 using System;\r
  32 using System.Collections.Generic;\r
  33 using System.IO;\r
  34 using System.Reflection;\r
  35 using System.Windows.Forms;\r
  36 using Radegast.Netcom;\r
  37 using OpenMetaverse;\r
  38 \r
  39 namespace Radegast\r
  40 {\r
  41     public class RadegastInstance\r
  42     {\r
  43         private GridClient client;\r
  44         private RadegastNetcom netcom;\r
  45 \r
  46         private StateManager state;\r
  47         private ConfigManager config;\r
  48 \r
  49         private frmMain mainForm;\r
  50         private TabsConsole tabsConsole;\r
  51 \r
  52         // Singleton, there can be only one instance\r
  53         private static RadegastInstance globalInstance = null;\r
  54         public static RadegastInstance GlobalInstance\r
  55         {\r
  56             get\r
  57             {\r
  58                 if (globalInstance == null)\r
  59                 {\r
  60                     globalInstance = new RadegastInstance();\r
  61                 }\r
  62                 return globalInstance;\r
  63             }\r
  64         }\r
  65 \r
  66         private string userDir;\r
  67         /// <summary>\r
  68         /// System (not grid!) user's dir\r
  69         /// </summary>\r
  70         public string UserDir { get { return userDir; } }\r
  71 \r
  72         /// <summary>\r
  73         /// Grid client's user dir for settings and logs\r
  74         /// </summary>\r
  75         public string ClientDir\r
  76         {\r
  77             get\r
  78             {\r
  79                 if (client != null && client.Self != null && !string.IsNullOrEmpty(client.Self.Name))\r
  80                 {\r
  81                     return Path.Combine(userDir, client.Self.Name);\r
  82                 }\r
  83                 else\r
  84                 {\r
  85                     return Environment.CurrentDirectory;\r
  86                 }\r
  87             }\r
  88         }\r
  89 \r
  90         public string InventoryCacheFileName { get { return Path.Combine(ClientDir, "inventory.cache"); } }\r
  91 \r
  92         private string animCacheDir;\r
  93         public string AnimCacheDir { get { return animCacheDir; } }\r
  94 \r
  95         private string globalLogFile;\r
  96         public string GlobalLogFile { get { return globalLogFile; } }\r
  97 \r
  98         private bool monoRuntime;\r
  99         public bool MonoRuntime { get { return monoRuntime; } }\r
 100 \r
 101         private Dictionary<UUID, Group> groups;\r
 102         public Dictionary<UUID, Group> Groups { get { return groups; } }\r
 103 \r
 104         public Dictionary<UUID, string> nameCache = new Dictionary<UUID, string>();\r
 105 \r
 106         public const string INCOMPLETE_NAME = "Loading...";\r
 107 \r
 108         public readonly bool advancedDebugging = false;\r
 109 \r
 110         public readonly List<IRadegastPlugin> PluginsLoaded = new List<IRadegastPlugin>();\r
 111 \r
 112         private RadegastInstance()\r
 113         {\r
 114             InitializeLoggingAndConfig();\r
 115 \r
 116             client = new GridClient();\r
 117             client.Settings.USE_INTERPOLATION_TIMER = false;\r
 118             client.Settings.ALWAYS_REQUEST_OBJECTS = true;\r
 119             client.Settings.ALWAYS_DECODE_OBJECTS = true;\r
 120             client.Settings.OBJECT_TRACKING = true;\r
 121             client.Settings.ENABLE_SIMSTATS = true;\r
 122             client.Settings.FETCH_MISSING_INVENTORY = true;\r
 123             client.Settings.MULTIPLE_SIMS = false;\r
 124             client.Settings.SEND_AGENT_THROTTLE = true;\r
 125             client.Settings.SEND_AGENT_UPDATES = true;\r
 126 \r
 127             client.Settings.USE_ASSET_CACHE = true;\r
 128             client.Settings.ASSET_CACHE_DIR = Path.Combine(userDir, "cache");\r
 129             client.Assets.Cache.AutoPruneEnabled = false;\r
 130 \r
 131             client.Throttle.Texture = 2446000.0f;\r
 132             client.Throttle.Asset = 2446000.0f;\r
 133             client.Settings.THROTTLE_OUTGOING_PACKETS = true;\r
 134             client.Settings.LOGIN_TIMEOUT = 120 * 1000;\r
 135             client.Settings.SIMULATOR_TIMEOUT = 120 * 1000;\r
 136             client.Settings.MAX_CONCURRENT_TEXTURE_DOWNLOADS = 20;\r
 137 \r
 138             netcom = new RadegastNetcom(client);\r
 139             state = new StateManager(this);\r
 140 \r
 141             InitializeConfigLegacy();\r
 142 \r
 143             mainForm = new frmMain(this);\r
 144             mainForm.InitializeControls();\r
 145             tabsConsole = mainForm.TabConsole;\r
 146 \r
 147             Application.ApplicationExit += new EventHandler(Application_ApplicationExit);\r
 148             groups = new Dictionary<UUID, Group>();\r
 149 \r
 150             client.Groups.OnCurrentGroups += new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 151             client.Groups.OnGroupLeft += new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 152             client.Groups.OnGroupDropped += new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 153             client.Groups.OnGroupJoined += new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 154             client.Avatars.OnAvatarNames += new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 155             client.Network.OnConnected += new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 156             ScanAndLoadPlugins();\r
 157         }\r
 158 \r
 159         public void CleanUp()\r
 160         {\r
 161             if (client != null)\r
 162             {\r
 163                 client.Groups.OnCurrentGroups -= new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 164                 client.Groups.OnGroupLeft -= new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 165                 client.Groups.OnGroupDropped -= new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 166                 client.Groups.OnGroupJoined -= new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 167                 client.Avatars.OnAvatarNames -= new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 168                 client.Network.OnConnected -= new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 169             }\r
 170 \r
 171             lock (PluginsLoaded)\r
 172             {\r
 173                 PluginsLoaded.ForEach(plug =>\r
 174                 {\r
 175                     try\r
 176                     {\r
 177                         plug.StopPlugin(this);\r
 178                     }\r
 179                     catch (Exception) { }\r
 180                 });\r
 181             }\r
 182 \r
 183             state.Dispose();\r
 184             state = null;\r
 185             netcom.Dispose();\r
 186             netcom = null;\r
 187             Logger.Log("RadegastInstance finished cleaning up.", Helpers.LogLevel.Debug);\r
 188         }\r
 189 \r
 190         private void ScanAndLoadPlugins()\r
 191         {\r
 192             string dirName = Application.StartupPath;\r
 193 \r
 194             if (!Directory.Exists(dirName)) return;\r
 195 \r
 196             foreach (string loadfilename in Directory.GetFiles(dirName))\r
 197             {\r
 198                 if (loadfilename.ToLower().EndsWith(".dll") || loadfilename.ToLower().EndsWith(".exe"))\r
 199                 {\r
 200                     try\r
 201                     {\r
 202                         Assembly assembly = Assembly.LoadFile(loadfilename);\r
 203                         foreach (Type type in assembly.GetTypes())\r
 204                         {\r
 205                             if (typeof(IRadegastPlugin).IsAssignableFrom(type))\r
 206                             {\r
 207                                 foreach (var ci in type.GetConstructors())\r
 208                                 {\r
 209                                     if (ci.GetParameters().Length > 0) continue;\r
 210                                     try\r
 211                                     {\r
 212                                         IRadegastPlugin plug = (IRadegastPlugin)ci.Invoke(new object[0]);\r
 213                                         plug.StartPlugin(this);\r
 214                                         lock (PluginsLoaded) PluginsLoaded.Add(plug);\r
 215                                         break;\r
 216                                     }\r
 217                                     catch (Exception ex)\r
 218                                     {\r
 219                                         Logger.Log("ERROR in Radegast Plugin: " + ex.Message, Helpers.LogLevel.Debug);\r
 220                                     }\r
 221                                 }\r
 222                             }\r
 223                         }\r
 224                     }\r
 225                     catch (BadImageFormatException)\r
 226                     {\r
 227                         // non .NET .dlls\r
 228                     }\r
 229                     catch (ReflectionTypeLoadException)\r
 230                     {\r
 231                         // Out of date or dlls missing sub dependencies\r
 232                     }\r
 233                 }\r
 234             }\r
 235         }\r
 236 \r
 237         void Network_OnConnected(object sender)\r
 238         {\r
 239             try\r
 240             {\r
 241                 if (!Directory.Exists(ClientDir))\r
 242                     Directory.CreateDirectory(ClientDir);\r
 243             }\r
 244             catch (Exception ex)\r
 245             {\r
 246                 Logger.Log("Failed to create client directory", Helpers.LogLevel.Warning, ex);\r
 247             }\r
 248         }\r
 249 \r
 250         void Avatars_OnAvatarNames(Dictionary<UUID, string> names)\r
 251         {\r
 252             lock (nameCache)\r
 253             {\r
 254                 foreach (KeyValuePair<UUID, string> av in names)\r
 255                 {\r
 256                     if (!nameCache.ContainsKey(av.Key))\r
 257                     {\r
 258                         nameCache.Add(av.Key, av.Value);\r
 259                     }\r
 260                 }\r
 261             }\r
 262         }\r
 263 \r
 264         public string getAvatarName(UUID key)\r
 265         {\r
 266             lock (nameCache)\r
 267             {\r
 268                 if (key == UUID.Zero)\r
 269                 {\r
 270                     return "(???) (???)";\r
 271                 }\r
 272                 if (nameCache.ContainsKey(key))\r
 273                 {\r
 274                     return nameCache[key];\r
 275                 }\r
 276                 else\r
 277                 {\r
 278                     client.Avatars.RequestAvatarName(key);\r
 279                     return INCOMPLETE_NAME;\r
 280                 }\r
 281             }\r
 282         }\r
 283 \r
 284         public void getAvatarNames(List<UUID> keys)\r
 285         {\r
 286             lock (nameCache)\r
 287             {\r
 288                 List<UUID> newNames = new List<UUID>();\r
 289                 foreach (UUID key in keys)\r
 290                 {\r
 291                     if (!nameCache.ContainsKey(key))\r
 292                     {\r
 293                         newNames.Add(key);\r
 294                     }\r
 295                 }\r
 296                 if (newNames.Count > 0)\r
 297                 {\r
 298                     client.Avatars.RequestAvatarNames(newNames);\r
 299                 }\r
 300             }\r
 301         }\r
 302 \r
 303         public bool haveAvatarName(UUID key)\r
 304         {\r
 305             lock (nameCache)\r
 306             {\r
 307                 if (nameCache.ContainsKey(key))\r
 308                     return true;\r
 309                 else\r
 310                     return false;\r
 311             }\r
 312         }\r
 313 \r
 314         void Groups_OnGroupJoined(UUID groupID, bool success)\r
 315         {\r
 316             client.Groups.RequestCurrentGroups();\r
 317         }\r
 318 \r
 319         void Groups_OnGroupLeft(UUID groupID, bool success)\r
 320         {\r
 321             client.Groups.RequestCurrentGroups();\r
 322         }\r
 323 \r
 324         void Groups_OnGroupDropped(UUID groupID)\r
 325         {\r
 326             client.Groups.RequestCurrentGroups();\r
 327         }\r
 328 \r
 329         public void LogClientMessage(string fileName, string message)\r
 330         {\r
 331             lock (this)\r
 332             {\r
 333                 try\r
 334                 {\r
 335                     foreach (char lDisallowed in System.IO.Path.GetInvalidFileNameChars())\r
 336                     {\r
 337                         fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 338                     }\r
 339 \r
 340                     StreamWriter logfile = File.AppendText(Path.Combine(ClientDir, fileName));\r
 341                     logfile.WriteLine(DateTime.Now.ToString("yyyy-MM-dd [HH:mm:ss] ") + message);\r
 342                     logfile.Close();\r
 343                     logfile.Dispose();\r
 344                 }\r
 345                 catch (Exception) { }\r
 346             }\r
 347         }\r
 348 \r
 349         void Groups_OnCurrentGroups(Dictionary<UUID, Group> gr)\r
 350         {\r
 351             this.groups = gr;\r
 352         }\r
 353 \r
 354         private void Application_ApplicationExit(object sender, EventArgs e)\r
 355         {\r
 356             config.SaveCurrentConfig();\r
 357         }\r
 358 \r
 359         private void InitializeLoggingAndConfig()\r
 360         {\r
 361             // Are we running mono?\r
 362             monoRuntime = Type.GetType("Mono.Runtime") != null;\r
 363 \r
 364             try\r
 365             {\r
 366                 userDir = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.ApplicationData), Properties.Resources.ProgramName);\r
 367                 if (!Directory.Exists(userDir))\r
 368                 {\r
 369                     Directory.CreateDirectory(userDir);\r
 370                 }\r
 371             }\r
 372             catch (Exception)\r
 373             {\r
 374                 userDir = System.Environment.CurrentDirectory;\r
 375             };\r
 376 \r
 377             animCacheDir = Path.Combine(userDir, @"anim_cache");\r
 378             globalLogFile = Path.Combine(userDir, Properties.Resources.ProgramName + ".log");\r
 379         }\r
 380 \r
 381         private void InitializeConfigLegacy()\r
 382         {\r
 383             config = new ConfigManager(this);\r
 384             config.ApplyDefault();\r
 385 \r
 386             netcom.LoginOptions.FirstName = config.CurrentConfig.FirstName;\r
 387             netcom.LoginOptions.LastName = config.CurrentConfig.LastName;\r
 388             netcom.LoginOptions.Password = config.CurrentConfig.PasswordMD5;\r
 389             netcom.LoginOptions.IsPasswordMD5 = true;\r
 390         }\r
 391 \r
 392         public GridClient Client\r
 393         {\r
 394             get { return client; }\r
 395         }\r
 396 \r
 397         public RadegastNetcom Netcom\r
 398         {\r
 399             get { return netcom; }\r
 400         }\r
 401 \r
 402         public StateManager State\r
 403         {\r
 404             get { return state; }\r
 405         }\r
 406 \r
 407         public ConfigManager Config\r
 408         {\r
 409             get { return config; }\r
 410         }\r
 411 \r
 412         public frmMain MainForm\r
 413         {\r
 414             get { return mainForm; }\r
 415         }\r
 416 \r
 417         public TabsConsole TabConsole\r
 418         {\r
 419             get { return tabsConsole; }\r
 420         }\r
 421     }\r
 422 }\r