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.Threading;\r
  36 using System.Windows.Forms;\r
  37 using Radegast.Commands;\r
  38 using Radegast.Netcom;\r
  39 using Radegast.Media;\r
  40 using OpenMetaverse;\r
  41 \r
  42 namespace Radegast\r
  43 {\r
  44     public class RadegastInstance\r
  45     {\r
  46         private GridClient client;\r
  47         private RadegastNetcom netcom;\r
  48 \r
  49         private StateManager state;\r
  50 \r
  51         private frmMain mainForm;\r
  52 \r
  53         // Singleton, there can be only one instance\r
  54         private static RadegastInstance globalInstance = null;\r
  55         public static RadegastInstance GlobalInstance\r
  56         {\r
  57             get\r
  58             {\r
  59                 if (globalInstance == null)\r
  60                 {\r
  61                     globalInstance = new RadegastInstance(new GridClient());\r
  62                 }\r
  63                 return globalInstance;\r
  64             }\r
  65         }\r
  66 \r
  67         private string userDir;\r
  68         /// <summary>\r
  69         /// System (not grid!) user's dir\r
  70         /// </summary>\r
  71         public string UserDir { get { return userDir; } }\r
  72 \r
  73         /// <summary>\r
  74         /// Grid client's user dir for settings and logs\r
  75         /// </summary>\r
  76         public string ClientDir\r
  77         {\r
  78             get\r
  79             {\r
  80                 if (client != null && client.Self != null && !string.IsNullOrEmpty(client.Self.Name))\r
  81                 {\r
  82                     return Path.Combine(userDir, client.Self.Name);\r
  83                 }\r
  84                 else\r
  85                 {\r
  86                     return Environment.CurrentDirectory;\r
  87                 }\r
  88             }\r
  89         }\r
  90 \r
  91         public string InventoryCacheFileName { get { return Path.Combine(ClientDir, "inventory.cache"); } }\r
  92 \r
  93         private string animCacheDir;\r
  94         public string AnimCacheDir { get { return animCacheDir; } }\r
  95 \r
  96         private string globalLogFile;\r
  97         public string GlobalLogFile { get { return globalLogFile; } }\r
  98 \r
  99         private bool monoRuntime;\r
 100         public bool MonoRuntime { get { return monoRuntime; } }\r
 101 \r
 102         private Dictionary<UUID, Group> groups;\r
 103         public Dictionary<UUID, Group> Groups { get { return groups; } }\r
 104 \r
 105         private Settings globalSettings;\r
 106         /// <summary>\r
 107         /// Global settings for the entire application\r
 108         /// </summary>\r
 109         public Settings GlobalSettings { get { return globalSettings; } }\r
 110 \r
 111         private Settings clientSettings;\r
 112         /// <summary>\r
 113         /// Per client settings\r
 114         /// </summary>\r
 115         public Settings ClientSettings { get { return clientSettings; } }\r
 116 \r
 117         public Dictionary<UUID, string> nameCache = new Dictionary<UUID, string>();\r
 118 \r
 119         public const string INCOMPLETE_NAME = "Loading...";\r
 120 \r
 121         public readonly bool advancedDebugging = false;\r
 122 \r
 123         public readonly List<IRadegastPlugin> PluginsLoaded = new List<IRadegastPlugin>();\r
 124 \r
 125         private MediaManager mediaManager;\r
 126         /// <summary>\r
 127         /// Radegast media manager for playing streams and in world sounds\r
 128         /// </summary>\r
 129         public MediaManager MediaManager { get { return mediaManager; } }\r
 130 \r
 131 \r
 132         private CommandsManager commandsManager;\r
 133         /// <summary>\r
 134         /// Radegast command manager for executing textual console commands\r
 135         /// </summary>\r
 136         public CommandsManager CommandsManager { get { return commandsManager; } }\r
 137 \r
 138         /// <summary>\r
 139         /// Radegast ContextAction manager for context sensitive actions\r
 140         /// </summary>\r
 141         public ContextActionsManager ContextActionManager { get; private set; }\r
 142 \r
 143         private RadegastMovement movement;\r
 144         /// <summary>\r
 145         /// Allows key emulation for moving avatar around\r
 146         /// </summary>\r
 147         public RadegastMovement Movement { get { return movement; } }\r
 148 \r
 149         public RadegastInstance(GridClient client0)\r
 150         {\r
 151             // incase something else calls GlobalInstance while we are loading\r
 152             globalInstance = this;\r
 153 \r
 154 #if HANDLE_THREAD_EXCEPTIONS\r
 155             Application.SetUnhandledExceptionMode(UnhandledExceptionMode.CatchException);\r
 156             Application.ThreadException += HandleThreadException;\r
 157 #endif\r
 158 \r
 159             client = client0;\r
 160 \r
 161             // Are we running mono?\r
 162             monoRuntime = Type.GetType("Mono.Runtime") != null;\r
 163 \r
 164             netcom = new RadegastNetcom(client);\r
 165             state = new StateManager(this);\r
 166             mediaManager = new MediaManager(this);\r
 167             commandsManager = new CommandsManager(this);\r
 168             ContextActionManager = new ContextActionsManager(this);\r
 169             movement = new RadegastMovement(client);\r
 170 \r
 171             InitializeLoggingAndConfig();\r
 172 \r
 173             client.Settings.MULTIPLE_SIMS = true;\r
 174 \r
 175             client.Settings.USE_INTERPOLATION_TIMER = false;\r
 176             client.Settings.ALWAYS_REQUEST_OBJECTS = true;\r
 177             client.Settings.ALWAYS_DECODE_OBJECTS = true;\r
 178             client.Settings.OBJECT_TRACKING = true;\r
 179             client.Settings.ENABLE_SIMSTATS = true;\r
 180             client.Settings.FETCH_MISSING_INVENTORY = true;\r
 181             client.Settings.SEND_AGENT_THROTTLE = true;\r
 182             client.Settings.SEND_AGENT_UPDATES = true;\r
 183 \r
 184             client.Settings.USE_ASSET_CACHE = true;\r
 185             client.Settings.ASSET_CACHE_DIR = Path.Combine(userDir, "cache");\r
 186             client.Assets.Cache.AutoPruneEnabled = false;\r
 187 \r
 188             client.Throttle.Total = 5000000f;\r
 189             client.Settings.THROTTLE_OUTGOING_PACKETS = true;\r
 190             client.Settings.LOGIN_TIMEOUT = 120 * 1000;\r
 191             client.Settings.SIMULATOR_TIMEOUT = 120 * 1000;\r
 192             client.Settings.MAX_CONCURRENT_TEXTURE_DOWNLOADS = 20;\r
 193 \r
 194             mainForm = new frmMain(this);\r
 195             mainForm.InitializeControls();\r
 196 \r
 197             groups = new Dictionary<UUID, Group>();\r
 198 \r
 199             client.Groups.OnCurrentGroups += new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 200             client.Groups.OnGroupLeft += new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 201             client.Groups.OnGroupDropped += new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 202             client.Groups.OnGroupJoined += new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 203             client.Avatars.OnAvatarNames += new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 204             client.Network.OnConnected += new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 205             mainForm.Load += new EventHandler(mainForm_Load);\r
 206             ScanAndLoadPlugins();\r
 207         }\r
 208 \r
 209         public void CleanUp()\r
 210         {\r
 211             if (client != null)\r
 212             {\r
 213                 client.Groups.OnCurrentGroups -= new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 214                 client.Groups.OnGroupLeft -= new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 215                 client.Groups.OnGroupDropped -= new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 216                 client.Groups.OnGroupJoined -= new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 217                 client.Avatars.OnAvatarNames -= new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 218                 client.Network.OnConnected -= new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 219             }\r
 220 \r
 221             lock (PluginsLoaded)\r
 222             {\r
 223                 List<IRadegastPlugin> unload = new List<IRadegastPlugin>(PluginsLoaded);\r
 224                 unload.ForEach(plug =>\r
 225                {\r
 226                    PluginsLoaded.Remove(plug);\r
 227                    try\r
 228                    {\r
 229                        plug.StopPlugin(this);\r
 230                    }\r
 231                    catch (Exception ex)\r
 232                    {\r
 233                        Logger.Log("ERROR in Shutdown Plugin: " + plug + " because " + ex, Helpers.LogLevel.Debug, ex);\r
 234                    }\r
 235                });\r
 236             }\r
 237 \r
 238             if (movement != null)\r
 239             {\r
 240                 movement.Dispose();\r
 241                 movement = null;\r
 242             }\r
 243             if (commandsManager != null)\r
 244             {\r
 245                 commandsManager.Dispose();\r
 246                 commandsManager = null;\r
 247             }\r
 248             if (ContextActionManager != null)\r
 249             {\r
 250                 ContextActionManager.Dispose();\r
 251                 ContextActionManager = null;\r
 252             }\r
 253             if (mediaManager != null)\r
 254             {\r
 255                 mediaManager.Dispose();\r
 256                 mediaManager = null;\r
 257             }\r
 258             if (state != null)\r
 259             {\r
 260                 state.Dispose();\r
 261                 state = null;\r
 262             }\r
 263             if (netcom != null)\r
 264             {\r
 265                 netcom.Dispose();\r
 266                 netcom = null;\r
 267             }\r
 268             if (mainForm != null)\r
 269             {\r
 270                 mainForm.Load -= new EventHandler(mainForm_Load);\r
 271             }\r
 272             Logger.Log("RadegastInstance finished cleaning up.", Helpers.LogLevel.Debug);\r
 273         }\r
 274 \r
 275         void mainForm_Load(object sender, EventArgs e)\r
 276         {\r
 277             StartPlugins();\r
 278         }\r
 279 \r
 280         private void StartPlugins()\r
 281         {\r
 282             lock (PluginsLoaded)\r
 283             {\r
 284                 foreach (IRadegastPlugin plug in PluginsLoaded)\r
 285                 {\r
 286                     try\r
 287                     {\r
 288                         plug.StartPlugin(this);\r
 289                     }\r
 290                     catch (Exception ex)\r
 291                     {\r
 292                         Logger.Log("ERROR in Starting Radegast Plugin: " + plug + " because " + ex, Helpers.LogLevel.Debug);\r
 293                     }\r
 294                 }\r
 295             }\r
 296         }\r
 297 \r
 298         private void ScanAndLoadPlugins()\r
 299         {\r
 300             string dirName = Application.StartupPath;\r
 301 \r
 302             if (!Directory.Exists(dirName)) return;\r
 303 \r
 304             foreach (string loadfilename in Directory.GetFiles(dirName))\r
 305             {\r
 306                 if (loadfilename.ToLower().EndsWith(".dll") || loadfilename.ToLower().EndsWith(".exe"))\r
 307                 {\r
 308                     try\r
 309                     {\r
 310                         Assembly assembly = Assembly.LoadFile(loadfilename);\r
 311                         LoadAssembly(loadfilename, assembly);\r
 312                     }\r
 313                     catch (BadImageFormatException)\r
 314                     {\r
 315                         // non .NET .dlls\r
 316                     }\r
 317                     catch (ReflectionTypeLoadException)\r
 318                     {\r
 319                         // Out of date or dlls missing sub dependencies\r
 320                     }\r
 321                     catch (TypeLoadException)\r
 322                     {\r
 323                         // Another version of: Out of date or dlls missing sub dependencies\r
 324                     }\r
 325                     catch (Exception ex)\r
 326                     {\r
 327                         Logger.Log("ERROR in Radegast Plugin: " + loadfilename + " because " + ex, Helpers.LogLevel.Debug);\r
 328                     }\r
 329                 }\r
 330             }\r
 331         }\r
 332 \r
 333         public void LoadAssembly(string loadfilename, Assembly assembly)\r
 334         {\r
 335             foreach (Type type in assembly.GetTypes())\r
 336             {\r
 337                 if (typeof(IRadegastPlugin).IsAssignableFrom(type))\r
 338                 {\r
 339                     if  (type.IsInterface) continue;\r
 340                     try\r
 341                     {\r
 342                         IRadegastPlugin plug;\r
 343                         ConstructorInfo constructorInfo = type.GetConstructor(new Type[] {typeof (RadegastInstance)});\r
 344                         if (constructorInfo != null)\r
 345                             plug = (IRadegastPlugin) constructorInfo.Invoke(new[] {this});\r
 346                         else\r
 347                         {\r
 348                             constructorInfo = type.GetConstructor(new Type[] {});\r
 349                             if (constructorInfo != null)\r
 350                                 plug = (IRadegastPlugin) constructorInfo.Invoke(new object[0]);\r
 351                             else\r
 352                             {\r
 353                                 Logger.Log("ERROR Constructing Radegast Plugin: " + loadfilename + " because "+type+ " has no usable constructor.",Helpers.LogLevel.Debug);\r
 354                                 continue;\r
 355                             }\r
 356                         }\r
 357                         lock (PluginsLoaded) PluginsLoaded.Add(plug);\r
 358                     }\r
 359                     catch (Exception ex)\r
 360                     {\r
 361                         Logger.Log("ERROR Constructing Radegast Plugin: " + loadfilename + " because " + ex,\r
 362                                    Helpers.LogLevel.Debug);\r
 363                     }\r
 364                 }\r
 365                 else\r
 366                 {\r
 367                     try\r
 368                     {\r
 369                         commandsManager.LoadType(type);\r
 370                     }\r
 371                     catch (Exception ex)\r
 372                     {\r
 373                         Logger.Log("ERROR in Radegast Plugin: " + loadfilename + " Command: " + type +\r
 374                                    " because " + ex.Message + " " + ex.StackTrace, Helpers.LogLevel.Debug);\r
 375                     }\r
 376                 }\r
 377             }\r
 378         }\r
 379 \r
 380         void Network_OnConnected(object sender)\r
 381         {\r
 382             try\r
 383             {\r
 384                 if (!Directory.Exists(ClientDir))\r
 385                     Directory.CreateDirectory(ClientDir);\r
 386             }\r
 387             catch (Exception ex)\r
 388             {\r
 389                 Logger.Log("Failed to create client directory", Helpers.LogLevel.Warning, ex);\r
 390             }\r
 391 \r
 392             clientSettings = new Settings(Path.Combine(ClientDir, "client_settings.xml"));\r
 393         }\r
 394 \r
 395         void Avatars_OnAvatarNames(Dictionary<UUID, string> names)\r
 396         {\r
 397             lock (nameCache)\r
 398             {\r
 399                 foreach (KeyValuePair<UUID, string> av in names)\r
 400                 {\r
 401                     if (!nameCache.ContainsKey(av.Key))\r
 402                     {\r
 403                         nameCache.Add(av.Key, av.Value);\r
 404                     }\r
 405                 }\r
 406             }\r
 407         }\r
 408 \r
 409         public string getAvatarName(UUID key)\r
 410         {\r
 411             lock (nameCache)\r
 412             {\r
 413                 if (key == UUID.Zero)\r
 414                 {\r
 415                     return "(???) (???)";\r
 416                 }\r
 417                 if (nameCache.ContainsKey(key))\r
 418                 {\r
 419                     return nameCache[key];\r
 420                 }\r
 421                 else\r
 422                 {\r
 423                     client.Avatars.RequestAvatarName(key);\r
 424                     return INCOMPLETE_NAME;\r
 425                 }\r
 426             }\r
 427         }\r
 428 \r
 429         public void getAvatarNames(List<UUID> keys)\r
 430         {\r
 431             lock (nameCache)\r
 432             {\r
 433                 List<UUID> newNames = new List<UUID>();\r
 434                 foreach (UUID key in keys)\r
 435                 {\r
 436                     if (!nameCache.ContainsKey(key))\r
 437                     {\r
 438                         newNames.Add(key);\r
 439                     }\r
 440                 }\r
 441                 if (newNames.Count > 0)\r
 442                 {\r
 443                     client.Avatars.RequestAvatarNames(newNames);\r
 444                 }\r
 445             }\r
 446         }\r
 447 \r
 448         public bool haveAvatarName(UUID key)\r
 449         {\r
 450             lock (nameCache)\r
 451             {\r
 452                 if (nameCache.ContainsKey(key))\r
 453                     return true;\r
 454                 else\r
 455                     return false;\r
 456             }\r
 457         }\r
 458 \r
 459         void Groups_OnGroupJoined(UUID groupID, bool success)\r
 460         {\r
 461             client.Groups.RequestCurrentGroups();\r
 462         }\r
 463 \r
 464         void Groups_OnGroupLeft(UUID groupID, bool success)\r
 465         {\r
 466             client.Groups.RequestCurrentGroups();\r
 467         }\r
 468 \r
 469         void Groups_OnGroupDropped(UUID groupID)\r
 470         {\r
 471             client.Groups.RequestCurrentGroups();\r
 472         }\r
 473 \r
 474         public static string SafeFileName(string fileName)\r
 475         {\r
 476             foreach (char lDisallowed in Path.GetInvalidFileNameChars())\r
 477             {\r
 478                 fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 479             }\r
 480 \r
 481             return fileName;\r
 482         }\r
 483 \r
 484         public void LogClientMessage(string fileName, string message)\r
 485         {\r
 486             lock (this)\r
 487             {\r
 488                 try\r
 489                 {\r
 490                     foreach (char lDisallowed in System.IO.Path.GetInvalidFileNameChars())\r
 491                     {\r
 492                         fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 493                     }\r
 494 \r
 495                     File.AppendAllText(Path.Combine(ClientDir, fileName),\r
 496                         DateTime.Now.ToString("yyyy-MM-dd [HH:mm:ss] ") + message + Environment.NewLine);\r
 497                 }\r
 498                 catch (Exception) { }\r
 499             }\r
 500         }\r
 501 \r
 502         void Groups_OnCurrentGroups(Dictionary<UUID, Group> gr)\r
 503         {\r
 504             this.groups = gr;\r
 505         }\r
 506 \r
 507         private void InitializeLoggingAndConfig()\r
 508         {\r
 509             try\r
 510             {\r
 511                 userDir = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.ApplicationData), Properties.Resources.ProgramName);\r
 512                 if (!Directory.Exists(userDir))\r
 513                 {\r
 514                     Directory.CreateDirectory(userDir);\r
 515                 }\r
 516             }\r
 517             catch (Exception)\r
 518             {\r
 519                 userDir = System.Environment.CurrentDirectory;\r
 520             };\r
 521 \r
 522             animCacheDir = Path.Combine(userDir, @"anim_cache");\r
 523             globalLogFile = Path.Combine(userDir, Properties.Resources.ProgramName + ".log");\r
 524             globalSettings = new Settings(Path.Combine(userDir, "settings.xml"));\r
 525         }\r
 526 \r
 527         public GridClient Client\r
 528         {\r
 529             get { return client; }\r
 530         }\r
 531 \r
 532         public RadegastNetcom Netcom\r
 533         {\r
 534             get { return netcom; }\r
 535         }\r
 536 \r
 537         public StateManager State\r
 538         {\r
 539             get { return state; }\r
 540         }\r
 541 \r
 542         public frmMain MainForm\r
 543         {\r
 544             get { return mainForm; }\r
 545         }\r
 546 \r
 547         public TabsConsole TabConsole\r
 548         {\r
 549             get { return mainForm.TabConsole; }\r
 550         }\r
 551 \r
 552         public void HandleThreadException(object sender, ThreadExceptionEventArgs e)\r
 553         {\r
 554             Logger.Log("Unhandled Thread Exception: " \r
 555                 + e.Exception.Message + Environment.NewLine\r
 556                 + e.Exception.StackTrace + Environment.NewLine,\r
 557                 Helpers.LogLevel.Error,\r
 558                 client);\r
 559 \r
 560             Application.Exit();\r
 561         }\r
 562     }\r
 563 }\r