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