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 #if !DEBUG\r
 154             Application.SetUnhandledExceptionMode(UnhandledExceptionMode.CatchException);\r
 155             Application.ThreadException += HandleThreadException;\r
 156 #endif\r
 157             client = client0;\r
 158 \r
 159             // Are we running mono?\r
 160             monoRuntime = Type.GetType("Mono.Runtime") != null;\r
 161 \r
 162             netcom = new RadegastNetcom(client);\r
 163             state = new StateManager(this);\r
 164             mediaManager = new MediaManager(this);\r
 165             commandsManager = new CommandsManager(this);\r
 166             ContextActionManager = new ContextActionsManager(this);\r
 167             movement = new RadegastMovement(client);\r
 168 \r
 169             InitializeLoggingAndConfig();\r
 170 \r
 171             client.Settings.MULTIPLE_SIMS = true;\r
 172 \r
 173             client.Settings.USE_INTERPOLATION_TIMER = false;\r
 174             client.Settings.ALWAYS_REQUEST_OBJECTS = true;\r
 175             client.Settings.ALWAYS_DECODE_OBJECTS = true;\r
 176             client.Settings.OBJECT_TRACKING = true;\r
 177             client.Settings.ENABLE_SIMSTATS = true;\r
 178             client.Settings.FETCH_MISSING_INVENTORY = true;\r
 179             client.Settings.SEND_AGENT_THROTTLE = true;\r
 180             client.Settings.SEND_AGENT_UPDATES = true;\r
 181 \r
 182             client.Settings.USE_ASSET_CACHE = true;\r
 183             client.Settings.ASSET_CACHE_DIR = Path.Combine(userDir, "cache");\r
 184             client.Assets.Cache.AutoPruneEnabled = false;\r
 185 \r
 186             client.Throttle.Texture = 2446000.0f;\r
 187             client.Throttle.Asset = 2446000.0f;\r
 188             client.Settings.THROTTLE_OUTGOING_PACKETS = true;\r
 189             client.Settings.LOGIN_TIMEOUT = 120 * 1000;\r
 190             client.Settings.SIMULATOR_TIMEOUT = 120 * 1000;\r
 191             client.Settings.MAX_CONCURRENT_TEXTURE_DOWNLOADS = 20;\r
 192 \r
 193             mainForm = new frmMain(this);\r
 194             mainForm.InitializeControls();\r
 195 \r
 196             groups = new Dictionary<UUID, Group>();\r
 197 \r
 198             client.Groups.OnCurrentGroups += new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 199             client.Groups.OnGroupLeft += new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 200             client.Groups.OnGroupDropped += new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 201             client.Groups.OnGroupJoined += new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 202             client.Avatars.OnAvatarNames += new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 203             client.Network.OnConnected += new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 204             mainForm.Load += new EventHandler(mainForm_Load);\r
 205         }\r
 206 \r
 207         public void CleanUp()\r
 208         {\r
 209             if (client != null)\r
 210             {\r
 211                 client.Groups.OnCurrentGroups -= new GroupManager.CurrentGroupsCallback(Groups_OnCurrentGroups);\r
 212                 client.Groups.OnGroupLeft -= new GroupManager.GroupLeftCallback(Groups_OnGroupLeft);\r
 213                 client.Groups.OnGroupDropped -= new GroupManager.GroupDroppedCallback(Groups_OnGroupDropped);\r
 214                 client.Groups.OnGroupJoined -= new GroupManager.GroupJoinedCallback(Groups_OnGroupJoined);\r
 215                 client.Avatars.OnAvatarNames -= new AvatarManager.AvatarNamesCallback(Avatars_OnAvatarNames);\r
 216                 client.Network.OnConnected -= new NetworkManager.ConnectedCallback(Network_OnConnected);\r
 217             }\r
 218 \r
 219             lock (PluginsLoaded)\r
 220             {\r
 221                 List<IRadegastPlugin> unload = new List<IRadegastPlugin>(PluginsLoaded);\r
 222                 unload.ForEach(plug =>\r
 223                {\r
 224                    PluginsLoaded.Remove(plug);\r
 225                    try\r
 226                    {\r
 227                        plug.StopPlugin(this);\r
 228                    }\r
 229                    catch (Exception ex)\r
 230                    {\r
 231                        Logger.Log("ERROR in Shutdown Plugin: " + plug + " because " + ex, Helpers.LogLevel.Debug, ex);\r
 232                    }\r
 233                });\r
 234             }\r
 235 \r
 236             if (movement != null)\r
 237             {\r
 238                 movement.Dispose();\r
 239                 movement = null;\r
 240             }\r
 241             if (commandsManager != null)\r
 242             {\r
 243                 commandsManager.Dispose();\r
 244                 commandsManager = null;\r
 245             }\r
 246             if (ContextActionManager != null)\r
 247             {\r
 248                 ContextActionManager.Dispose();\r
 249                 ContextActionManager = null;\r
 250             }\r
 251             if (mediaManager != null)\r
 252             {\r
 253                 mediaManager.Dispose();\r
 254                 mediaManager = null;\r
 255             }\r
 256             if (state != null)\r
 257             {\r
 258                 state.Dispose();\r
 259                 state = null;\r
 260             }\r
 261             if (netcom != null)\r
 262             {\r
 263                 netcom.Dispose();\r
 264                 netcom = null;\r
 265             }\r
 266             if (mainForm != null)\r
 267             {\r
 268                 mainForm.Load -= new EventHandler(mainForm_Load);\r
 269             }\r
 270             Logger.Log("RadegastInstance finished cleaning up.", Helpers.LogLevel.Debug);\r
 271         }\r
 272 \r
 273         void mainForm_Load(object sender, EventArgs e)\r
 274         {\r
 275             ScanAndLoadPlugins();\r
 276         }\r
 277 \r
 278         private void ScanAndLoadPlugins()\r
 279         {\r
 280             string dirName = Application.StartupPath;\r
 281 \r
 282             if (!Directory.Exists(dirName)) return;\r
 283 \r
 284             foreach (string loadfilename in Directory.GetFiles(dirName))\r
 285             {\r
 286                 if (loadfilename.ToLower().EndsWith(".dll") || loadfilename.ToLower().EndsWith(".exe"))\r
 287                 {\r
 288                     try\r
 289                     {\r
 290                         Assembly assembly = Assembly.LoadFile(loadfilename);\r
 291                         LoadAssembly(loadfilename, assembly);\r
 292                     }\r
 293                     catch (BadImageFormatException)\r
 294                     {\r
 295                         // non .NET .dlls\r
 296                     }\r
 297                     catch (ReflectionTypeLoadException)\r
 298                     {\r
 299                         // Out of date or dlls missing sub dependencies\r
 300                     }\r
 301                     catch (Exception ex)\r
 302                     {\r
 303                         Logger.Log("ERROR in Radegast Plugin: " + loadfilename + " because " + ex.Message + " " + ex.StackTrace, Helpers.LogLevel.Debug);\r
 304                     }\r
 305                 }\r
 306             }\r
 307         }\r
 308 \r
 309         public void LoadAssembly(string loadfilename, Assembly assembly)\r
 310         {\r
 311             foreach (Type type in assembly.GetTypes())\r
 312             {\r
 313                 if (typeof(IRadegastPlugin).IsAssignableFrom(type))\r
 314                 {\r
 315                     foreach (var ci in type.GetConstructors())\r
 316                     {\r
 317                         if (ci.GetParameters().Length > 0) continue;\r
 318                         try\r
 319                         {\r
 320                             IRadegastPlugin plug = (IRadegastPlugin)ci.Invoke(new object[0]);\r
 321                             plug.StartPlugin(this);\r
 322                             lock (PluginsLoaded) PluginsLoaded.Add(plug);\r
 323                             break;\r
 324                         }\r
 325                         catch (Exception ex)\r
 326                         {\r
 327                             Logger.Log("ERROR Constructing Radegast Plugin: " + loadfilename + " because " + ex.Message, Helpers.LogLevel.Debug);\r
 328                             throw ex;\r
 329                         }\r
 330                     }\r
 331                 }\r
 332                 else\r
 333                 {\r
 334                     try\r
 335                     {\r
 336                         commandsManager.LoadType(type);\r
 337                         ContextActionManager.LoadType(type);\r
 338                     }\r
 339                     catch (Exception ex)\r
 340                     {\r
 341                         Logger.Log("ERROR in Radegast Plugin: " + loadfilename + " Command: " + type +\r
 342                                    " because " + ex.Message + " " + ex.StackTrace, Helpers.LogLevel.Debug);\r
 343                     }\r
 344                 }\r
 345             }\r
 346         }\r
 347 \r
 348         void Network_OnConnected(object sender)\r
 349         {\r
 350             try\r
 351             {\r
 352                 if (!Directory.Exists(ClientDir))\r
 353                     Directory.CreateDirectory(ClientDir);\r
 354             }\r
 355             catch (Exception ex)\r
 356             {\r
 357                 Logger.Log("Failed to create client directory", Helpers.LogLevel.Warning, ex);\r
 358             }\r
 359 \r
 360             clientSettings = new Settings(Path.Combine(ClientDir, "client_settings.xml"));\r
 361         }\r
 362 \r
 363         void Avatars_OnAvatarNames(Dictionary<UUID, string> names)\r
 364         {\r
 365             lock (nameCache)\r
 366             {\r
 367                 foreach (KeyValuePair<UUID, string> av in names)\r
 368                 {\r
 369                     if (!nameCache.ContainsKey(av.Key))\r
 370                     {\r
 371                         nameCache.Add(av.Key, av.Value);\r
 372                     }\r
 373                 }\r
 374             }\r
 375         }\r
 376 \r
 377         public string getAvatarName(UUID key)\r
 378         {\r
 379             lock (nameCache)\r
 380             {\r
 381                 if (key == UUID.Zero)\r
 382                 {\r
 383                     return "(???) (???)";\r
 384                 }\r
 385                 if (nameCache.ContainsKey(key))\r
 386                 {\r
 387                     return nameCache[key];\r
 388                 }\r
 389                 else\r
 390                 {\r
 391                     client.Avatars.RequestAvatarName(key);\r
 392                     return INCOMPLETE_NAME;\r
 393                 }\r
 394             }\r
 395         }\r
 396 \r
 397         public void getAvatarNames(List<UUID> keys)\r
 398         {\r
 399             lock (nameCache)\r
 400             {\r
 401                 List<UUID> newNames = new List<UUID>();\r
 402                 foreach (UUID key in keys)\r
 403                 {\r
 404                     if (!nameCache.ContainsKey(key))\r
 405                     {\r
 406                         newNames.Add(key);\r
 407                     }\r
 408                 }\r
 409                 if (newNames.Count > 0)\r
 410                 {\r
 411                     client.Avatars.RequestAvatarNames(newNames);\r
 412                 }\r
 413             }\r
 414         }\r
 415 \r
 416         public bool haveAvatarName(UUID key)\r
 417         {\r
 418             lock (nameCache)\r
 419             {\r
 420                 if (nameCache.ContainsKey(key))\r
 421                     return true;\r
 422                 else\r
 423                     return false;\r
 424             }\r
 425         }\r
 426 \r
 427         void Groups_OnGroupJoined(UUID groupID, bool success)\r
 428         {\r
 429             client.Groups.RequestCurrentGroups();\r
 430         }\r
 431 \r
 432         void Groups_OnGroupLeft(UUID groupID, bool success)\r
 433         {\r
 434             client.Groups.RequestCurrentGroups();\r
 435         }\r
 436 \r
 437         void Groups_OnGroupDropped(UUID groupID)\r
 438         {\r
 439             client.Groups.RequestCurrentGroups();\r
 440         }\r
 441 \r
 442         public static string SafeFileName(string fileName)\r
 443         {\r
 444             foreach (char lDisallowed in Path.GetInvalidFileNameChars())\r
 445             {\r
 446                 fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 447             }\r
 448 \r
 449             return fileName;\r
 450         }\r
 451 \r
 452         public void LogClientMessage(string fileName, string message)\r
 453         {\r
 454             lock (this)\r
 455             {\r
 456                 try\r
 457                 {\r
 458                     foreach (char lDisallowed in System.IO.Path.GetInvalidFileNameChars())\r
 459                     {\r
 460                         fileName = fileName.Replace(lDisallowed.ToString(), "_");\r
 461                     }\r
 462 \r
 463                     File.AppendAllText(Path.Combine(ClientDir, fileName),\r
 464                         DateTime.Now.ToString("yyyy-MM-dd [HH:mm:ss] ") + message + Environment.NewLine);\r
 465                 }\r
 466                 catch (Exception) { }\r
 467             }\r
 468         }\r
 469 \r
 470         void Groups_OnCurrentGroups(Dictionary<UUID, Group> gr)\r
 471         {\r
 472             this.groups = gr;\r
 473         }\r
 474 \r
 475         private void InitializeLoggingAndConfig()\r
 476         {\r
 477             try\r
 478             {\r
 479                 userDir = Path.Combine(System.Environment.GetFolderPath(System.Environment.SpecialFolder.ApplicationData), Properties.Resources.ProgramName);\r
 480                 if (!Directory.Exists(userDir))\r
 481                 {\r
 482                     Directory.CreateDirectory(userDir);\r
 483                 }\r
 484             }\r
 485             catch (Exception)\r
 486             {\r
 487                 userDir = System.Environment.CurrentDirectory;\r
 488             };\r
 489 \r
 490             animCacheDir = Path.Combine(userDir, @"anim_cache");\r
 491             globalLogFile = Path.Combine(userDir, Properties.Resources.ProgramName + ".log");\r
 492             globalSettings = new Settings(Path.Combine(userDir, "settings.xml"));\r
 493         }\r
 494 \r
 495         public GridClient Client\r
 496         {\r
 497             get { return client; }\r
 498         }\r
 499 \r
 500         public RadegastNetcom Netcom\r
 501         {\r
 502             get { return netcom; }\r
 503         }\r
 504 \r
 505         public StateManager State\r
 506         {\r
 507             get { return state; }\r
 508         }\r
 509 \r
 510         public frmMain MainForm\r
 511         {\r
 512             get { return mainForm; }\r
 513         }\r
 514 \r
 515         public TabsConsole TabConsole\r
 516         {\r
 517             get { return mainForm.TabConsole; }\r
 518         }\r
 519 \r
 520         public void HandleThreadException(object sender, ThreadExceptionEventArgs e)\r
 521         {\r
 522             Logger.Log("Unhandled Thread Exception: " + e.Exception + " in " + sender, Helpers.LogLevel.Error, client);\r
 523         }\r
 524     }\r
 525 }\r