opensim/OpenSim/Services/Connectors/MapImage/MapImageServicesConnector.cs

/*
 * Copyright (c) Contributors, http://opensimulator.org/
 * See CONTRIBUTORS.TXT for a full list of copyright holders.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the OpenSimulator Project nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

using log4net;
using System.Net;
using System.Reflection;

using Nini.Config;
using OpenSim.Framework;
using OpenSim.Server.Base;
using OpenSim.Services.Interfaces;
using OpenMetaverse;

namespace OpenSim.Services.Connectors
{
    public class MapImageServicesConnector : BaseServiceConnector, IMapImageService
    {
        private static readonly ILog m_log =
                LogManager.GetLogger(
                MethodBase.GetCurrentMethod().DeclaringType);

        private string m_ServerURI = String.Empty;

        public MapImageServicesConnector()
        {
        }

        public MapImageServicesConnector(string serverURI)
        {
            m_ServerURI = serverURI.TrimEnd('/');
        }

        public MapImageServicesConnector(IConfigSource source)
        {
            Initialise(source);
        }

        public virtual void Initialise(IConfigSource source)
        {
            IConfig config = source.Configs["MapImageService"];
            if (config == null)
            {
                m_log.Error("[MAP IMAGE CONNECTOR]: MapImageService missing");
                throw new Exception("MapImage connector init error");
            }

            string serviceURI = config.GetString("MapImageServerURI",
                    String.Empty);

            if (serviceURI.Length == 0)
            {
                m_log.Error("[MAP IMAGE CONNECTOR]: No Server URI named in section MapImageService");
                throw new Exception("MapImage connector init error");
            }
            m_ServerURI = serviceURI;
            m_ServerURI = serviceURI.TrimEnd('/');
            base.Initialise(source, "MapImageService");
        }

        public bool RemoveMapTile(int x, int y, UUID scopeID, out string reason)
        {
            reason = string.Empty;
            string reqString;
            if (scopeID.IsNotZero())
            {
                reqString = ServerUtils.BuildQueryString(
                    new Dictionary<string, object>()
                        {
                            {"X" , x.ToString() },
                            {"Y" , y.ToString() },
                            { "SCOPE" , scopeID.ToString() },
                        }
                    );
            }
            else
            {
                // Do not include SCOPE when it's zero
                reqString = ServerUtils.BuildQueryString(
                    new Dictionary<string, object>()
                        {
                            {"X" , x.ToString() },
                            {"Y" , y.ToString() }
                        }
                    );
            }

            try
            {
                string reply = SynchronousRestFormsRequester.MakeRequest("POST", m_ServerURI + "/map", reqString, 10, null, false);
                if (!string.IsNullOrEmpty(reply))
                {
                    Dictionary<string, object> replyData = ServerUtils.ParseXmlResponse(reply);
                    if(replyData.TryGetValue("Result", out object resultobj))
                    {
                        string res = resultobj as string;
                        if(string.IsNullOrEmpty(res))
                        {
                            m_log.DebugFormat("[MAP IMAGE CONNECTOR]: unknown result field");
                            return false;
                        }
                        else if (res.Equals("success", StringComparison.InvariantCultureIgnoreCase))
                            return true;
                        else if (res.Equals("failure", StringComparison.InvariantCultureIgnoreCase))
                        {
                            reason = replyData.TryGetValue("Message", out var value) ? value.ToString() : "";
                            m_log.DebugFormat("[MAP IMAGE CONNECTOR]: RemoveMapTile failed: {0}", reason);
                            return false;
                        }
                        m_log.DebugFormat("[MAP IMAGE CONNECTOR]: RemoveMapTile unknown result field contents");
                        return false;
                    }
                    else
                    {
                        m_log.DebugFormat("[MAP IMAGE CONNECTOR]: RemoveMapTile reply data does not contain result field");
                    }
                }
            }
            catch (Exception e)
            {
                m_log.DebugFormat("[MAP IMAGE CONNECTOR]: RemoveMapTile Exception at {0}/map: {1}", m_ServerURI, e.Message);
            }
            return false;
        }

        public bool AddMapTile(int x, int y, byte[] jpgData, UUID scopeID, out string reason)
        {
            reason = string.Empty;
            int tickstart = Util.EnvironmentTickCount();

            string reqString;
            if (scopeID.IsNotZero())
            {
                reqString = ServerUtils.BuildQueryString(
                    new Dictionary<string, object>()
                        {
                            {"X" , x.ToString() },
                            {"Y" , y.ToString() },
                            { "SCOPE" , scopeID.ToString() },
                            { "TYPE" , "image/jpeg" },
                            { "DATA" , Convert.ToBase64String(jpgData) }
                        }
                    );
            }
            else
            {
                reqString = ServerUtils.BuildQueryString(
                    new Dictionary<string, object>()
                        {
                            {"X" , x.ToString() },
                            {"Y" , y.ToString() },
                            { "TYPE" , "image/jpeg" },
                            { "DATA" , Convert.ToBase64String(jpgData) }
                        }
                    );
            }

            try
            {
                string reply = SynchronousRestFormsRequester.MakeRequest("POST", m_ServerURI + "/map", reqString, 10, m_Auth, false);
                if (!string.IsNullOrEmpty(reply))
                {
                    Dictionary<string, object> replyData = ServerUtils.ParseXmlResponse(reply);
                    if (replyData.TryGetValue("Result", out object resultobj))
                    {
                        string res = resultobj as string;
                        if (string.IsNullOrEmpty(res))
                        {
                            m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile unknown result field");
                            return false;
                        }
                        else if (res.Equals("success", StringComparison.InvariantCultureIgnoreCase))
                            return true;
                        else if (res.Equals("failure", StringComparison.InvariantCultureIgnoreCase))
                        {
                            reason = replyData.TryGetValue("Message", out var value) ? value.ToString() : "";
                            m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile failed: {0}", reason);
                            return false;
                        }
                        m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile unknown result field contents");
                        return false;
                    }
                }
                else
                {
                    m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile reply data does not contain result field");
                }
            }
            catch (Exception e)
            {
                m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile Exception at {0}/map: {1}", m_ServerURI, e.Message);
            }
            finally
            {
                // This just dumps a warning for any operation that takes more than 100 ms
                int tickdiff = Util.EnvironmentTickCountSubtract(tickstart);
                m_log.DebugFormat("[MAP IMAGE CONNECTOR]: AddMapTile {1} Bytes in {0}ms", tickdiff, jpgData.Length);
            }
            return false;
        }

        public byte[] GetMapTile(string fileName, UUID scopeID, out string format)
        {
            throw new Exception("GetMapTile method not Implemented");
        }
    }
}