Show map tile for hyperlinks. Perform Check4096 before adding a hyperlink.

Configuration option AssetService in section [GridService] must be set to enable this functionality.

Map tiles do currently not show for hyperlinks set in simulators that are connected to grids, see Mantis #5270.

8 files changed, 95 insertions, 71 deletions

diff --git a/OpenSim/Services/Connectors/Hypergrid/GatekeeperServiceConnector.cs b/OpenSim/Services/Connectors/Hypergrid/GatekeeperServiceConnector.cs
index 85c1380..d4fd1b8 100644
--- a/OpenSim/Services/Connectors/Hypergrid/GatekeeperServiceConnector.cs
+++ b/OpenSim/Services/Connectors/Hypergrid/GatekeeperServiceConnector.cs
@@ -29,6 +29,7 @@ using System;
 using System.Collections;
 using System.Collections.Generic;
 using System.Drawing;
+using System.IO;
 using System.Net;
 using System.Reflection;
 using OpenSim.Framework;
@@ -48,7 +49,7 @@ namespace OpenSim.Services.Connectors.Hypergrid
     {
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
-//        private static UUID m_HGMapImage = new UUID("00000000-0000-1111-9999-000000000013");
+        private static UUID m_HGMapImage = new UUID("00000000-0000-1111-9999-000000000013");
 
         private IAssetService m_AssetService;
 
@@ -143,24 +144,25 @@ namespace OpenSim.Services.Connectors.Hypergrid
             return true;
         }
 
-        UUID m_MissingTexture = new UUID("5748decc-f629-461c-9a36-a35a221fe21f");
-
-        public UUID GetMapImage(UUID regionID, string imageURL)
+        public UUID GetMapImage(UUID regionID, string imageURL, string storagePath)
         {
             if (m_AssetService == null)
-                return m_MissingTexture;
+                return m_HGMapImage;
 
+            UUID mapTile = m_HGMapImage;
+            string filename = string.Empty;
+            Bitmap bitmap = null;
             try
             {
-
                 WebClient c = new WebClient();
                 //m_log.Debug("JPEG: " + imageURL);
-                string filename = regionID.ToString();
-                c.DownloadFile(imageURL, filename + ".jpg");
-                Bitmap m = new Bitmap(filename + ".jpg");
+                string name = regionID.ToString();
+                filename = Path.Combine(storagePath, name + ".jpg");
+                c.DownloadFile(imageURL, filename);
+                bitmap = new Bitmap(filename);
                 //m_log.Debug("Size: " + m.PhysicalDimension.Height + "-" + m.PhysicalDimension.Width);
-                byte[] imageData = OpenJPEG.EncodeFromImage(m, true);
-                AssetBase ass = new AssetBase(UUID.Random(), "region " + filename, (sbyte)AssetType.Texture, regionID.ToString());
+                byte[] imageData = OpenJPEG.EncodeFromImage(bitmap, true);
+                AssetBase ass = new AssetBase(UUID.Random(), "region " + name, (sbyte)AssetType.Texture, regionID.ToString());
 
                 // !!! for now
                 //info.RegionSettings.TerrainImageID = ass.FullID;
@@ -172,14 +174,13 @@ namespace OpenSim.Services.Connectors.Hypergrid
                 m_AssetService.Store(ass);
 
                 // finally
-                return ass.FullID;
-
+                mapTile = ass.FullID;
             }
             catch // LEGIT: Catching problems caused by OpenJPEG p/invoke
             {
                 m_log.Warn("[GATEKEEPER SERVICE CONNECTOR]: Failed getting/storing map image, because it is probably already in the cache");
             }
-            return UUID.Zero;
+            return mapTile;
         }
 
         public GridRegion GetHyperlinkRegion(GridRegion gatekeeper, UUID regionID)
diff --git a/OpenSim/Services/GridService/HypergridLinker.cs b/OpenSim/Services/GridService/HypergridLinker.cs
index 9863ba0..643d0fc 100644
--- a/OpenSim/Services/GridService/HypergridLinker.cs
+++ b/OpenSim/Services/GridService/HypergridLinker.cs
@@ -28,6 +28,7 @@
 using System;
 using System.Collections;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Net;
 using System.Reflection;
@@ -52,8 +53,6 @@ namespace OpenSim.Services.GridService
                 LogManager.GetLogger(
                 MethodBase.GetCurrentMethod().DeclaringType);
 
-        private static UUID m_HGMapImage = new UUID("00000000-0000-1111-9999-000000000013");
-
         private static uint m_autoMappingX = 0;
         private static uint m_autoMappingY = 0;
         private static bool m_enableAutoMapping = false;
@@ -65,6 +64,7 @@ namespace OpenSim.Services.GridService
 
         protected UUID m_ScopeID = UUID.Zero;
         protected bool m_Check4096 = true;
+        protected string m_MapTileDirectory = string.Empty;
 
         // Hyperlink regions are hyperlinks on the map
         public readonly Dictionary<UUID, GridRegion> m_HyperlinkRegions = new Dictionary<UUID, GridRegion>();
@@ -121,9 +121,24 @@ namespace OpenSim.Services.GridService
 
                 m_Check4096 = gridConfig.GetBoolean("Check4096", true);
 
+                m_MapTileDirectory = gridConfig.GetString("MapTileDirectory", string.Empty);
+
                 m_GatekeeperConnector = new GatekeeperServiceConnector(m_AssetService);
 
-                m_log.DebugFormat("[HYPERGRID LINKER]: Loaded all services...");
+                m_log.Debug("[HYPERGRID LINKER]: Loaded all services...");
+            }
+
+            if (!string.IsNullOrEmpty(m_MapTileDirectory))
+            {
+                try
+                {
+                    Directory.CreateDirectory(m_MapTileDirectory);
+                }
+                catch (Exception e)
+                {
+                    m_log.WarnFormat("[HYPERGRID LINKER]: Could not create map tile storage directory {0}: {1}", m_MapTileDirectory, e);
+                    m_MapTileDirectory = string.Empty;
+                }
             }
 
             if (MainConsole.Instance != null)
@@ -271,42 +286,22 @@ namespace OpenSim.Services.GridService
             if (!m_GatekeeperConnector.LinkRegion(regInfo, out regionID, out handle, out externalName, out imageURL, out reason))
                 return false;
 
-            if (regionID != UUID.Zero)
-            {
-                region = m_GridService.GetRegionByUUID(scopeID, regionID);
-                if (region != null)
-                {
-                    m_log.DebugFormat("[HYPERGRID LINKER]: Region already exists in coordinates {0} {1}",
-                        region.RegionLocX / Constants.RegionSize, region.RegionLocY / Constants.RegionSize);
-                    regInfo = region;
-                    return true;
-                }
-
-                regInfo.RegionID = regionID;
-
-                if ( externalName == string.Empty )
-                    regInfo.RegionName = regInfo.ServerURI;
-                else
-                    regInfo.RegionName = externalName;
-
-                m_log.Debug("[HYPERGRID LINKER]: naming linked region " + regInfo.RegionName);
-                
-                // Try get the map image
-                //regInfo.TerrainImage = m_GatekeeperConnector.GetMapImage(regionID, imageURL);
-                // I need a texture that works for this... the one I tried doesn't seem to be working
-                regInfo.TerrainImage = m_HGMapImage;
-
-                AddHyperlinkRegion(regInfo, handle);
-                m_log.Info("[HYPERGRID LINKER]: Successfully linked to region_uuid " + regInfo.RegionID);
-
-            }
-            else
+            if (regionID == UUID.Zero)
             {
                 m_log.Warn("[HYPERGRID LINKER]: Unable to link region");
                 reason = "Remote region could not be found";
                 return false;
             }
 
+            region = m_GridService.GetRegionByUUID(scopeID, regionID);
+            if (region != null)
+            {
+                m_log.DebugFormat("[HYPERGRID LINKER]: Region already exists in coordinates {0} {1}",
+                    region.RegionLocX / Constants.RegionSize, region.RegionLocY / Constants.RegionSize);
+                regInfo = region;
+                return true;
+            }
+
             uint x, y;
             if (m_Check4096 && !Check4096(handle, out x, out y))
             {
@@ -316,7 +311,20 @@ namespace OpenSim.Services.GridService
                 return false;
             }
 
-            m_log.Debug("[HYPERGRID LINKER]: link region succeeded");
+            regInfo.RegionID = regionID;
+
+            if ( externalName == string.Empty )
+                regInfo.RegionName = regInfo.ServerURI;
+            else
+                regInfo.RegionName = externalName;
+
+            m_log.Debug("[HYPERGRID LINKER]: naming linked region " + regInfo.RegionName);
+                
+            // Get the map image
+            regInfo.TerrainImage = m_GatekeeperConnector.GetMapImage(regionID, imageURL, m_MapTileDirectory);
+
+            AddHyperlinkRegion(regInfo, handle);
+            m_log.Info("[HYPERGRID LINKER]: Successfully linked to region_uuid " + regInfo.RegionID);
             return true;
         }
 
diff --git a/OpenSim/Services/HypergridService/GatekeeperService.cs b/OpenSim/Services/HypergridService/GatekeeperService.cs
index 05be7b8..4419201 100644
--- a/OpenSim/Services/HypergridService/GatekeeperService.cs
+++ b/OpenSim/Services/HypergridService/GatekeeperService.cs
@@ -123,42 +123,39 @@ namespace OpenSim.Services.HypergridService
             externalName = m_ExternalName + ((regionName != string.Empty) ? " " + regionName : "");
             imageURL = string.Empty;
             reason = string.Empty;
-
+            GridRegion region = null;
 
             m_log.DebugFormat("[GATEKEEPER SERVICE]: Request to link to {0}", (regionName == string.Empty)? "default region" : regionName);
             if (!m_AllowTeleportsToAnyRegion || regionName == string.Empty)
             {
                 List<GridRegion> defs = m_GridService.GetDefaultRegions(m_ScopeID);
                 if (defs != null && defs.Count > 0)
-                    m_DefaultGatewayRegion = defs[0];
-
-                try
                 {
-                    regionID = m_DefaultGatewayRegion.RegionID;
-                    regionHandle = m_DefaultGatewayRegion.RegionHandle;
+                    region = defs[0];
+                    m_DefaultGatewayRegion = region;
                 }
-                catch
+                else
                 {
                     reason = "Grid setup problem. Try specifying a particular region here.";
                     m_log.DebugFormat("[GATEKEEPER SERVICE]: Unable to send information. Please specify a default region for this grid!");
                     return false;
                 }
-
-                return true;
             }
-
-            GridRegion region = m_GridService.GetRegionByName(m_ScopeID, regionName);
-            if (region == null)
+            else
             {
-                reason = "Region not found";
-                return false;
+                region = m_GridService.GetRegionByName(m_ScopeID, regionName);
+                if (region == null)
+                {
+                    reason = "Region not found";
+                    return false;
+                }
             }
 
             regionID = region.RegionID;
             regionHandle = region.RegionHandle;
-            string regionimage = "regionImage" + region.RegionID.ToString();
-            regionimage = regionimage.Replace("-", "");
 
+            string regionimage = "regionImage" + regionID.ToString();
+            regionimage = regionimage.Replace("-", "");
             imageURL = region.ServerURI + "index.php?method=" + regionimage;
 
             return true;
diff --git a/bin/Robust.HG.ini.example b/bin/Robust.HG.ini.example
index c690e06..9adf1ac 100644
--- a/bin/Robust.HG.ini.example
+++ b/bin/Robust.HG.ini.example
@@ -68,6 +68,12 @@ ServiceConnectors = "8003/OpenSim.Server.Handlers.dll:AssetServiceConnector,8003
     ;; Perform distance check for the creation of a linked region
     ; Check4096 = "True"
 
+    ;; Needed to display non-default map tile images for linked regions
+    AssetService = "OpenSim.Services.AssetService.dll:AssetService"
+
+    ;; Directory for map tile images of linked regions
+    ; MapTileDirectory = "./"
+ 
     ;; Next, we can specify properties of regions, including default and fallback regions
     ;; The syntax is: Region_<RegionName> = "<flags>"
     ;; or:            Region_<RegionID> = "<flags>"
diff --git a/bin/config-include/GridCommon.ini.example b/bin/config-include/GridCommon.ini.example
index 1122cbd..761e5eb 100644
--- a/bin/config-include/GridCommon.ini.example
+++ b/bin/config-include/GridCommon.ini.example
@@ -42,6 +42,9 @@
     GridServerURI = "http://mygridserver.com:8003"
     ;AllowHypergridMapSearch = true
 
+    ;; Directory for map tile images of linked regions
+    ; MapTileDirectory = "./"
+
 [AvatarService]
     ;
     ; change this to your grid-wide grid server
diff --git a/bin/config-include/GridHypergrid.ini b/bin/config-include/GridHypergrid.ini
index 409b2a9..e983755 100644
--- a/bin/config-include/GridHypergrid.ini
+++ b/bin/config-include/GridHypergrid.ini
@@ -44,12 +44,15 @@
     LocalGridInventoryService = "OpenSim.Region.CoreModules.dll:RemoteXInventoryServicesConnector"
 
 [GridService]
-        ; RemoteGridServicesConnector instantiates a LocalGridServicesConnector,
-        ; which in turn uses this
+    ; RemoteGridServicesConnector instantiates a LocalGridServicesConnector,
+    ; which in turn uses this
     LocalServiceModule = "OpenSim.Services.GridService.dll:GridService"
     StorageProvider = "OpenSim.Data.Null.dll:NullRegionData"
 
-        AllowHypergridMapSearch = true
+    ; Needed to display non-default map tile images for linked regions
+    AssetService = "OpenSim.Services.Connectors.dll:AssetServicesConnector"
+
+    AllowHypergridMapSearch = true
 
 [LibraryService]
     LocalServiceModule = "OpenSim.Services.InventoryService.dll:LibraryService"
diff --git a/bin/config-include/StandaloneCommon.ini.example b/bin/config-include/StandaloneCommon.ini.example
index 58059f5..4956bc3 100644
--- a/bin/config-include/StandaloneCommon.ini.example
+++ b/bin/config-include/StandaloneCommon.ini.example
@@ -65,6 +65,9 @@
     ;; With hypergrid, perform distance check for the creation of a linked region
     ; Check4096 = true
 
+    ;; Directory for map tile images of remote regions
+    ; MapTileDirectory = "./"
+
     ;; Next, we can specify properties of regions, including default and fallback regions
     ;; The syntax is: Region_<RegioName> = "<flags>"
     ;; where <flags> can be DefaultRegion, FallbackRegion, NoDirectLogin, Persistent, LockedOut
diff --git a/bin/config-include/StandaloneHypergrid.ini b/bin/config-include/StandaloneHypergrid.ini
index 68aa739..486f22e 100644
--- a/bin/config-include/StandaloneHypergrid.ini
+++ b/bin/config-include/StandaloneHypergrid.ini
@@ -65,12 +65,15 @@
     LocalServiceModule = "OpenSim.Services.AuthenticationService.dll:PasswordAuthenticationService"
 
 [GridService]
-        ; LocalGridServicesConnector needs this
-        LocalServiceModule = "OpenSim.Services.GridService.dll:GridService"
-        Realm = "regions"
+    ; LocalGridServicesConnector needs this
+    LocalServiceModule = "OpenSim.Services.GridService.dll:GridService"
+    Realm = "regions"
     StorageProvider = "OpenSim.Data.Null.dll"
         
-        AllowHypergridMapSearch = true
+    ; Needed to display non-default map tile images for remote regions
+    AssetService = "OpenSim.Services.AssetService.dll:AssetService"
+  
+    AllowHypergridMapSearch = true
         
 [PresenceService]
     LocalServiceModule = "OpenSim.Services.PresenceService.dll:PresenceService"