Initial update to OpenSim 0.8.2.1 source code.

1 files changed, 276 insertions, 38 deletions

diff --git a/OpenSim/Framework/Communications/RestClient.cs b/OpenSim/Framework/RestClient.cs
index 97b3b60..7080ca5 100644
--- a/OpenSim/Framework/Communications/RestClient.cs
+++ b/OpenSim/Framework/RestClient.cs
@@ -35,7 +35,9 @@ using System.Threading;
 using System.Web;
 using log4net;
 
-namespace OpenSim.Framework.Communications
+using OpenSim.Framework.ServiceAuth;
+
+namespace OpenSim.Framework
 {
     /// <summary>
     /// Implementation of a generic REST client
@@ -54,7 +56,7 @@ namespace OpenSim.Framework.Communications
     /// other threads to execute, while it waits for a response from the web-service. RestClient itself can be
     /// invoked by the caller in either synchronous mode or asynchronous modes.
     /// </remarks>
-    public class RestClient
+    public class RestClient : IDisposable
     {
         private static readonly ILog m_log = LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
 
@@ -88,7 +90,7 @@ namespace OpenSim.Framework.Communications
         private byte[] _readbuf;
 
         /// <summary>
-        /// MemoryStream representing the resultiong resource
+        /// MemoryStream representing the resulting resource
         /// </summary>
         private Stream _resource;
 
@@ -146,6 +148,33 @@ namespace OpenSim.Framework.Communications
 
         #endregion constructors
 
+
+        #region Dispose
+
+        private bool disposed = false;
+
+        public void Dispose()
+        {
+            Dispose(true);
+            GC.SuppressFinalize(this); 
+        }
+
+        protected virtual void Dispose(bool disposing)
+        {
+            if (disposed)
+                return;
+
+            if (disposing)
+            {
+                _resource.Dispose();
+            }
+
+            disposed = true;
+        }
+
+        #endregion Dispose
+
+
         /// <summary>
         /// Add a path element to the query, e.g. assets
         /// </summary>
@@ -299,6 +328,14 @@ namespace OpenSim.Framework.Communications
         /// </summary>
         public Stream Request()
         {
+            return Request(null);
+        }
+
+        /// <summary>
+        /// Perform a synchronous request
+        /// </summary>
+        public Stream Request(IServiceAuth auth)
+        {
             lock (_lock)
             {
                 _request = (HttpWebRequest) WebRequest.Create(buildUri());
@@ -307,44 +344,54 @@ namespace OpenSim.Framework.Communications
                 _request.Timeout = 200000;
                 _request.Method = RequestMethod;
                 _asyncException = null;
+                if (auth != null)
+                    auth.AddAuthorization(_request.Headers);
+
+                int reqnum = WebUtil.RequestNumber++;
+                if (WebUtil.DebugLevel >= 3)
+                    m_log.DebugFormat("[LOGHTTP]: HTTP OUT {0} REST {1} to {2}", reqnum, _request.Method, _request.RequestUri);
 
 //                IAsyncResult responseAsyncResult = _request.BeginGetResponse(new AsyncCallback(ResponseIsReadyDelegate), _request);
+
                 try
                 {
-                    _response = (HttpWebResponse) _request.GetResponse();
+                    using (_response = (HttpWebResponse) _request.GetResponse())
+                    {
+                        using (Stream src = _response.GetResponseStream())
+                        {
+                            int length = src.Read(_readbuf, 0, BufferSize);
+                            while (length > 0)
+                            {
+                                _resource.Write(_readbuf, 0, length);
+                                length = src.Read(_readbuf, 0, BufferSize);
+                            }
+
+                            // TODO! Implement timeout, without killing the server
+                            // this line implements the timeout, if there is a timeout, the callback fires and the request becomes aborted
+                            //ThreadPool.RegisterWaitForSingleObject(responseAsyncResult.AsyncWaitHandle, new WaitOrTimerCallback(TimeoutCallback), _request, DefaultTimeout, true);
+
+                            //                _allDone.WaitOne();
+                        }
+                    }
                 }
                 catch (WebException e)
                 {
-                    HttpWebResponse errorResponse = e.Response as HttpWebResponse;
-                    if (null != errorResponse && HttpStatusCode.NotFound == errorResponse.StatusCode)
-                    {
-                        m_log.Warn("[REST CLIENT] Resource not found (404)");
-                    }
-                    else
+                    using (HttpWebResponse errorResponse = e.Response as HttpWebResponse)
                     {
-                        m_log.Error("[REST CLIENT] Error fetching resource from server " + _request.Address.ToString());
-                        m_log.Debug(e.ToString());
+                        if (null != errorResponse && HttpStatusCode.NotFound == errorResponse.StatusCode)
+                        {
+                            // This is often benign. E.g., requesting a missing asset will return 404.
+                            m_log.DebugFormat("[REST CLIENT] Resource not found (404): {0}", _request.Address.ToString());
+                        }
+                        else
+                        {
+                            m_log.Error(string.Format("[REST CLIENT] Error fetching resource from server: {0} ", _request.Address.ToString()), e);
+                        }
                     }
 
                     return null;
                 }
 
-                Stream src = _response.GetResponseStream();
-                int length = src.Read(_readbuf, 0, BufferSize);
-                while (length > 0)
-                {
-                    _resource.Write(_readbuf, 0, length);
-                    length = src.Read(_readbuf, 0, BufferSize);
-                }
-
-
-                // TODO! Implement timeout, without killing the server
-                // this line implements the timeout, if there is a timeout, the callback fires and the request becomes aborted
-                //ThreadPool.RegisterWaitForSingleObject(responseAsyncResult.AsyncWaitHandle, new WaitOrTimerCallback(TimeoutCallback), _request, DefaultTimeout, true);
-
-//                _allDone.WaitOne();
-                if (_response != null)
-                    _response.Close();
                 if (_asyncException != null)
                     throw _asyncException;
 
@@ -354,11 +401,14 @@ namespace OpenSim.Framework.Communications
                     _resource.Seek(0, SeekOrigin.Begin);
                 }
 
+                if (WebUtil.DebugLevel >= 5)
+                    WebUtil.LogResponseDetail(reqnum, _resource);
+
                 return _resource;
             }
         }
 
-        public Stream Request(Stream src)
+        public Stream Request(Stream src, IServiceAuth auth)
         {
             _request = (HttpWebRequest) WebRequest.Create(buildUri());
             _request.KeepAlive = false;
@@ -367,24 +417,58 @@ namespace OpenSim.Framework.Communications
             _request.Method = RequestMethod;
             _asyncException = null;
             _request.ContentLength = src.Length;
+            if (auth != null)
+                auth.AddAuthorization(_request.Headers);
 
-            m_log.InfoFormat("[REST]: Request Length {0}", _request.ContentLength);
-            m_log.InfoFormat("[REST]: Sending Web Request {0}", buildUri());
             src.Seek(0, SeekOrigin.Begin);
-            m_log.Info("[REST]: Seek is ok");
+
+            int reqnum = WebUtil.RequestNumber++;
+            if (WebUtil.DebugLevel >= 3)
+                m_log.DebugFormat("[LOGHTTP]: HTTP OUT {0} REST {1} to {2}", reqnum, _request.Method, _request.RequestUri);
+            if (WebUtil.DebugLevel >= 5)
+                WebUtil.LogOutgoingDetail(string.Format("SEND {0}: ", reqnum), src);
+
             Stream dst = _request.GetRequestStream();
-            m_log.Info("[REST]: GetRequestStream is ok");
 
             byte[] buf = new byte[1024];
             int length = src.Read(buf, 0, 1024);
-            m_log.Info("[REST]: First Read is ok");
             while (length > 0)
             {
                 dst.Write(buf, 0, length);
                 length = src.Read(buf, 0, 1024);
             }
 
-            _response = (HttpWebResponse) _request.GetResponse();
+            try
+            {
+                _response = (HttpWebResponse)_request.GetResponse();
+            }
+            catch (WebException e)
+            {
+                m_log.WarnFormat("[REST]: Request {0} {1} failed with status {2} and message {3}",
+                                  RequestMethod, _request.RequestUri, e.Status, e.Message);
+                return null;
+            }
+            catch (Exception e)
+            {
+                m_log.WarnFormat(
+                    "[REST]: Request {0} {1} failed with exception {2} {3}",
+                    RequestMethod, _request.RequestUri, e.Message, e.StackTrace);
+                return null;
+            }
+
+            if (WebUtil.DebugLevel >= 5)
+            {
+                using (Stream responseStream = _response.GetResponseStream())
+                {
+                    using (StreamReader reader = new StreamReader(responseStream))
+                    {
+                        string responseStr = reader.ReadToEnd();
+                        WebUtil.LogResponseDetail(reqnum, responseStr);
+                    }
+                }
+            }
+
+            _response.Close();
 
 //            IAsyncResult responseAsyncResult = _request.BeginGetResponse(new AsyncCallback(ResponseIsReadyDelegate), _request);
 
@@ -403,7 +487,7 @@ namespace OpenSim.Framework.Communications
             /// In case, we are invoked asynchroneously this object will keep track of the state
             /// </summary>
             AsyncResult<Stream> ar = new AsyncResult<Stream>(callback, state);
-            Util.FireAndForget(RequestHelper, ar);
+            Util.FireAndForget(RequestHelper, ar, "RestClient.BeginRequest");
             return ar;
         }
 
@@ -423,7 +507,7 @@ namespace OpenSim.Framework.Communications
             try
             {
                 // Perform the operation; if sucessful set the result
-                Stream s = Request();
+                Stream s = Request(null);
                 ar.SetAsCompleted(s, false);
             }
             catch (Exception e)
@@ -435,4 +519,158 @@ namespace OpenSim.Framework.Communications
 
         #endregion Async Invocation
     }
-}
+
+    internal class SimpleAsyncResult : IAsyncResult
+    {
+        private readonly AsyncCallback m_callback;
+
+        /// <summary>
+        /// Is process completed?
+        /// </summary>
+        /// <remarks>Should really be boolean, but VolatileRead has no boolean method</remarks>
+        private byte m_completed;
+
+        /// <summary>
+        /// Did process complete synchronously?
+        /// </summary>
+        /// <remarks>I have a hard time imagining a scenario where this is the case, again, same issue about
+        /// booleans and VolatileRead as m_completed
+        /// </remarks>
+        private byte m_completedSynchronously;
+
+        private readonly object m_asyncState;
+        private ManualResetEvent m_waitHandle;
+        private Exception m_exception;
+
+        internal SimpleAsyncResult(AsyncCallback cb, object state)
+        {
+            m_callback = cb;
+            m_asyncState = state;
+            m_completed = 0;
+            m_completedSynchronously = 1;
+        }
+
+        #region IAsyncResult Members
+
+        public object AsyncState
+        {
+            get { return m_asyncState; }
+        }
+
+        public WaitHandle AsyncWaitHandle
+        {
+            get
+            {
+                if (m_waitHandle == null)
+                {
+                    bool done = IsCompleted;
+                    ManualResetEvent mre = new ManualResetEvent(done);
+                    if (Interlocked.CompareExchange(ref m_waitHandle, mre, null) != null)
+                    {
+                        mre.Close();
+                    }
+                    else
+                    {
+                        if (!done && IsCompleted)
+                        {
+                            m_waitHandle.Set();
+                        }
+                    }
+                }
+
+                return m_waitHandle;
+            }
+        }
+
+
+        public bool CompletedSynchronously
+        {
+            get { return Thread.VolatileRead(ref m_completedSynchronously) == 1; }
+        }
+
+
+        public bool IsCompleted
+        {
+            get { return Thread.VolatileRead(ref m_completed) == 1; }
+        }
+
+        #endregion
+
+        #region class Methods
+
+        internal void SetAsCompleted(bool completedSynchronously)
+        {
+            m_completed = 1;
+            if (completedSynchronously)
+                m_completedSynchronously = 1;
+            else
+                m_completedSynchronously = 0;
+
+            SignalCompletion();
+        }
+
+        internal void HandleException(Exception e, bool completedSynchronously)
+        {
+            m_completed = 1;
+            if (completedSynchronously)
+                m_completedSynchronously = 1;
+            else
+                m_completedSynchronously = 0;
+            m_exception = e;
+
+            SignalCompletion();
+        }
+
+        private void SignalCompletion()
+        {
+            if (m_waitHandle != null) m_waitHandle.Set();
+
+            if (m_callback != null) m_callback(this);
+        }
+
+        public void EndInvoke()
+        {
+            // This method assumes that only 1 thread calls EndInvoke
+            if (!IsCompleted)
+            {
+                // If the operation isn't done, wait for it
+                AsyncWaitHandle.WaitOne();
+                AsyncWaitHandle.Close();
+                m_waitHandle.Close();
+                m_waitHandle = null; // Allow early GC
+            }
+
+            // Operation is done: if an exception occured, throw it
+            if (m_exception != null) throw m_exception;
+        }
+
+        #endregion
+    }
+
+    internal class AsyncResult<T> : SimpleAsyncResult
+    {
+        private T m_result = default(T);
+
+        public AsyncResult(AsyncCallback asyncCallback, Object state) :
+            base(asyncCallback, state)
+        {
+        }
+
+        public void SetAsCompleted(T result, bool completedSynchronously)
+        {
+            // Save the asynchronous operation's result
+            m_result = result;
+
+            // Tell the base class that the operation completed
+            // sucessfully (no exception)
+            base.SetAsCompleted(completedSynchronously);
+        }
+
+        public new T EndInvoke()
+        {
+            base.EndInvoke();
+            return m_result;
+        }
+    }
+
+}
\ No newline at end of file