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