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         private Settings globalSettings;\r
 105         /// <summary>\r
 106         /// Global settings for the entire application\r
 107         /// </summary>\r
 108         public Settings GlobalSettings { get { return globalSettings; } }\r
 109 \r
 110         private Settings clientSettings;\r
 111         /// <summary>\r
 112         /// Per client settings\r
 113         /// </summary>\r
 114         public Settings ClientSettings { get { return clientSettings; } }\r
 115 \r
 116         public Dictionary<UUID, string> nameCache = new Dictionary<UUID, string>();\r
 117 \r
 118         public const string INCOMPLETE_NAME = "Loading...";\r
 119 \r
 120         public readonly bool advancedDebugging = false;\r
 121 \r
 122         public readonly List<IRadegastPlugin> PluginsLoaded = new List<IRadegastPlugin>();\r
 123 \r
 124         private RadegastInstance()\r
 125         {\r
 126             InitializeLoggingAndConfig();\r
 127 \r
 128             client = new GridClient();\r
 129 \r
 130             client.Settings.MULTIPLE_SIMS = true;\r
 131 \r
 132             client.Settings.USE_INTERPOLATION_TIMER = false;\r
 133             client.Settings.ALWAYS_REQUEST_OBJECTS = true;\r
 134             client.Settings.ALWAYS_DECODE_OBJECTS = true;\r
 135             client.Settings.OBJECT_TRACKING = true;\r
 136             client.Settings.ENABLE_SIMSTATS = true;\r
 137             client.Settings.FETCH_MISSING_INVENTORY = true;\r
 138             client.Settings.SEND_AGENT_THROTTLE = true;\r
 139             client.Settings.SEND_AGENT_UPDATES = true;\r
 140 \r
 141             client.Settings.USE_ASSET_CACHE = true;\r
 142             client.Settings.ASSET_CACHE_DIR = Path.Combine(userDir, "cache");\r
 143             client.Assets.Cache.AutoPruneEnabled = false;\r
 144 \r
 145             client.Throttle.Texture = 2446000.0f;\r
 146             client.Throttle.Asset = 2446000.0f;\r
 147             client.Settings.THROTTLE_OUTGOING_PACKETS = true;\r
 148             client.Settings.LOGIN_TIMEOUT = 120 * 1000;\r
 149             client.Settings.SIMULATOR_TIMEOUT = 120 * 1000;\r
 150             client.Settings.MAX_CONCURRENT_TEXTURE_DOWNLOADS = 20;\r
 151 \r
 152             netcom = new RadegastNetcom(client);\r
 153             state = new StateManager(this);\r
 154 \r
 155             InitializeConfigLegacy();\r
 156 \r
 157             mainForm = new frmMain(this);\r
 158             mainForm.InitializeControls();\r
 159             tabsConsole = mainForm.TabConsole;\r
 160 \r
 161             Application.ApplicationExit += new EventHandler(Application_ApplicationExit);\r
 162             groups = new Dictionary<UUID, Group>();\r
 163 \r
 164             client.Groups.OnCurrentGroups += new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 165             client.Groups.OnGroupLeft += new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 166             client.Groups.OnGroupDropped += new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 167             client.Groups.OnGroupJoined += new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 168             client.Avatars.OnAvatarNames += new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 169             client.Network.OnConnected += new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 170             ScanAndLoadPlugins();\r
 171         }\r
 172 \r
 173         public void CleanUp()\r
 174         {\r
 175             if (client != null)\r
 176             {\r
 177                 client.Groups.OnCurrentGroups -= new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 178                 client.Groups.OnGroupLeft -= new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 179                 client.Groups.OnGroupDropped -= new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 180                 client.Groups.OnGroupJoined -= new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 181                 client.Avatars.OnAvatarNames -= new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 182                 client.Network.OnConnected -= new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 183             }\r
 184 \r
 185             lock (PluginsLoaded)\r
 186             {\r
 187                 PluginsLoaded.ForEach(plug =>\r
 188                 {\r
 189                     try\r
 190                     {\r
 191                         plug.StopPlugin(this);\r
 192                     }\r
 193                     catch (Exception) { }\r
 194                 });\r
 195             }\r
 196 \r
 197             state.Dispose();\r
 198             state = null;\r
 199             netcom.Dispose();\r
 200             netcom = null;\r
 201             Logger.Log("RadegastInstance finished cleaning up.", Helpers.LogLevel.Debug);\r
 202         }\r
 203 \r
 204         private void ScanAndLoadPlugins()\r
 205         {\r
 206             string dirName = Application.StartupPath;\r
 207 \r
 208             if (!Directory.Exists(dirName)) return;\r
 209 \r
 210             foreach (string loadfilename in Directory.GetFiles(dirName))\r
 211             {\r
 212                 if (loadfilename.ToLower().EndsWith(".dll") || loadfilename.ToLower().EndsWith(".exe"))\r
 213                 {\r
 214                     try\r
 215                     {\r
 216                         Assembly assembly = Assembly.LoadFile(loadfilename);\r
 217                         foreach (Type type in assembly.GetTypes())\r
 218                         {\r
 219                             if (typeof(IRadegastPlugin).IsAssignableFrom(type))\r
 220                             {\r
 221                                 foreach (var ci in type.GetConstructors())\r
 222                                 {\r
 223                                     if (ci.GetParameters().Length > 0) continue;\r
 224                                     try\r
 225                                     {\r
 226                                         IRadegastPlugin plug = (IRadegastPlugin)ci.Invoke(new object[0]);\r
 227                                         plug.StartPlugin(this);\r
 228                                         lock (PluginsLoaded) PluginsLoaded.Add(plug);\r
 229                                         break;\r
 230                                     }\r
 231                                     catch (Exception ex)\r
 232                                     {\r
 233                                         Logger.Log("ERROR in Radegast Plugin: " + ex.Message, Helpers.LogLevel.Debug);\r
 234                                     }\r
 235                                 }\r
 236                             }\r
 237                         }\r
 238                     }\r
 239                     catch (BadImageFormatException)\r
 240                     {\r
 241                         // non .NET .dlls\r
 242                     }\r
 243                     catch (ReflectionTypeLoadException)\r
 244                     {\r
 245                         // Out of date or dlls missing sub dependencies\r
 246                     }\r
 247                 }\r
 248             }\r
 249         }\r
 250 \r
 251         void Network_OnConnected(object sender)\r
 252         {\r
 253             try\r
 254             {\r
 255                 if (!Directory.Exists(ClientDir))\r
 256                     Directory.CreateDirectory(ClientDir);\r
 257             }\r
 258             catch (Exception ex)\r
 259             {\r
 260                 Logger.Log("Failed to create client directory", Helpers.LogLevel.Warning, ex);\r
 261             }\r
 262 \r
 263             clientSettings = new Settings(Path.Combine(ClientDir, "client_settings.xml"));\r
 264         }\r
 265 \r
 266         void Avatars_OnAvatarNames(Dictionary<UUID, string> names)\r
 267         {\r
 268             lock (nameCache)\r
 269             {\r
 270                 foreach (KeyValuePair<UUID, string> av in names)\r
 271                 {\r
 272                     if (!nameCache.ContainsKey(av.Key))\r
 273                     {\r
 274                         nameCache.Add(av.Key, av.Value);\r
 275                     }\r
 276                 }\r
 277             }\r
 278         }\r
 279 \r
 280         public string getAvatarName(UUID key)\r
 281         {\r
 282             lock (nameCache)\r
 283             {\r
 284                 if (key == UUID.Zero)\r
 285                 {\r
 286                     return "(???) (???)";\r
 287                 }\r
 288                 if (nameCache.ContainsKey(key))\r
 289                 {\r
 290                     return nameCache[key];\r
 291                 }\r
 292                 else\r
 293                 {\r
 294                     client.Avatars.RequestAvatarName(key);\r
 295                     return INCOMPLETE_NAME;\r
 296                 }\r
 297             }\r
 298         }\r
 299 \r
 300         public void getAvatarNames(List<UUID> keys)\r
 301         {\r
 302             lock (nameCache)\r
 303             {\r
 304                 List<UUID> newNames = new List<UUID>();\r
 305                 foreach (UUID key in keys)\r
 306                 {\r
 307                     if (!nameCache.ContainsKey(key))\r
 308                     {\r
 309                         newNames.Add(key);\r
 310                     }\r
 311                 }\r
 312                 if (newNames.Count > 0)\r
 313                 {\r
 314                     client.Avatars.RequestAvatarNames(newNames);\r
 315                 }\r
 316             }\r
 317         }\r
 318 \r
 319         public bool haveAvatarName(UUID key)\r
 320         {\r
 321             lock (nameCache)\r
 322             {\r
 323                 if (nameCache.ContainsKey(key))\r
 324                     return true;\r
 325                 else\r
 326                     return false;\r
 327             }\r
 328         }\r
 329 \r
 330         void Groups_OnGroupJoined(UUID groupID, bool success)\r
 331         {\r
 332             client.Groups.RequestCurrentGroups();\r
 333         }\r
 334 \r
 335         void Groups_OnGroupLeft(UUID groupID, bool success)\r
 336         {\r
 337             client.Groups.RequestCurrentGroups();\r
 338         }\r
 339 \r
 340         void Groups_OnGroupDropped(UUID groupID)\r
 341         {\r
 342             client.Groups.RequestCurrentGroups();\r
 343         }\r
 344 \r
 345         public static string SafeFileName(string fileName)\r
 346         {\r
 347             foreach (char lDisallowed in Path.GetInvalidFileNameChars())\r
 348             {\r
 349                 fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 350             }\r
 351 \r
 352             return fileName;\r
 353         }\r
 354 \r
 355         public void LogClientMessage(string fileName, string message)\r
 356         {\r
 357             lock (this)\r
 358             {\r
 359                 try\r
 360                 {\r
 361                     foreach (char lDisallowed in System.IO.Path.GetInvalidFileNameChars())\r
 362                     {\r
 363                         fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 364                     }\r
 365 \r
 366                     StreamWriter logfile = File.AppendText(Path.Combine(ClientDir, fileName));\r
 367                     logfile.WriteLine(DateTime.Now.ToString("yyyy-MM-dd [HH:mm:ss] ") + message);\r
 368                     logfile.Close();\r
 369                     logfile.Dispose();\r
 370                 }\r
 371                 catch (Exception) { }\r
 372             }\r
 373         }\r
 374 \r
 375         void Groups_OnCurrentGroups(Dictionary<UUID, Group> gr)\r
 376         {\r
 377             this.groups = gr;\r
 378         }\r
 379 \r
 380         private void Application_ApplicationExit(object sender, EventArgs e)\r
 381         {\r
 382             config.SaveCurrentConfig();\r
 383         }\r
 384 \r
 385         private void InitializeLoggingAndConfig()\r
 386         {\r
 387             // Are we running mono?\r
 388             monoRuntime = Type.GetType("Mono.Runtime") != null;\r
 389 \r
 390             try\r
 391             {\r
 392                 userDir = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.ApplicationData), Properties.Resources.ProgramName);\r
 393                 if (!Directory.Exists(userDir))\r
 394                 {\r
 395                     Directory.CreateDirectory(userDir);\r
 396                 }\r
 397             }\r
 398             catch (Exception)\r
 399             {\r
 400                 userDir = System.Environment.CurrentDirectory;\r
 401             };\r
 402 \r
 403             animCacheDir = Path.Combine(userDir, @"anim_cache");\r
 404             globalLogFile = Path.Combine(userDir, Properties.Resources.ProgramName + ".log");\r
 405             globalSettings = new Settings(Path.Combine(userDir, "settings.xml"));\r
 406         }\r
 407 \r
 408         private void InitializeConfigLegacy()\r
 409         {\r
 410             config = new ConfigManager(this);\r
 411             config.ApplyDefault();\r
 412 \r
 413             netcom.LoginOptions.FirstName = config.CurrentConfig.FirstName;\r
 414             netcom.LoginOptions.LastName = config.CurrentConfig.LastName;\r
 415             netcom.LoginOptions.Password = config.CurrentConfig.PasswordMD5;\r
 416             netcom.LoginOptions.IsPasswordMD5 = true;\r
 417         }\r
 418 \r
 419         public GridClient Client\r
 420         {\r
 421             get { return client; }\r
 422         }\r
 423 \r
 424         public RadegastNetcom Netcom\r
 425         {\r
 426             get { return netcom; }\r
 427         }\r
 428 \r
 429         public StateManager State\r
 430         {\r
 431             get { return state; }\r
 432         }\r
 433 \r
 434         public ConfigManager Config\r
 435         {\r
 436             get { return config; }\r
 437         }\r
 438 \r
 439         public frmMain MainForm\r
 440         {\r
 441             get { return mainForm; }\r
 442         }\r
 443 \r
 444         public TabsConsole TabConsole\r
 445         {\r
 446             get { return tabsConsole; }\r
 447         }\r
 448     }\r
 449 }\r