GetTextureRobustHandler.cs 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390
  1. /*
  2. * Copyright (c) Contributors, http://opensimulator.org/
  3. * See CONTRIBUTORS.TXT for a full list of copyright holders.
  4. *
  5. * Redistribution and use in source and binary forms, with or without
  6. * modification, are permitted provided that the following conditions are met:
  7. * * Redistributions of source code must retain the above copyright
  8. * notice, this list of conditions and the following disclaimer.
  9. * * Redistributions in binary form must reproduce the above copyright
  10. * notice, this list of conditions and the following disclaimer in the
  11. * documentation and/or other materials provided with the distribution.
  12. * * Neither the name of the OpenSimulator Project nor the
  13. * names of its contributors may be used to endorse or promote products
  14. * derived from this software without specific prior written permission.
  15. *
  16. * THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY
  17. * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  18. * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  19. * DISCLAIMED. IN NO EVENT SHALL THE CONTRIBUTORS BE LIABLE FOR ANY
  20. * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
  21. * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
  22. * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  23. * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24. * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
  25. * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26. */
  27. using System;
  28. using System.Collections;
  29. using System.Collections.Specialized;
  30. using System.Drawing;
  31. using System.Drawing.Imaging;
  32. using System.Reflection;
  33. using System.IO;
  34. using System.Web;
  35. using log4net;
  36. using Nini.Config;
  37. using OpenMetaverse;
  38. using OpenMetaverse.StructuredData;
  39. using OpenMetaverse.Imaging;
  40. using OpenSim.Framework;
  41. using OpenSim.Framework.Servers;
  42. using OpenSim.Framework.Servers.HttpServer;
  43. using OpenSim.Region.Framework.Interfaces;
  44. using OpenSim.Services.Interfaces;
  45. using Caps = OpenSim.Framework.Capabilities.Caps;
  46. namespace OpenSim.Capabilities.Handlers
  47. {
  48. public class GetTextureRobustHandler : BaseStreamHandler
  49. {
  50. private static readonly ILog m_log =
  51. LogManager.GetLogger(MethodBase.GetCurrentMethod().DeclaringType);
  52. private IAssetService m_assetService;
  53. public const string DefaultFormat = "x-j2c";
  54. // TODO: Change this to a config option
  55. private string m_RedirectURL = null;
  56. public GetTextureRobustHandler(string path, IAssetService assService, string name, string description, string redirectURL)
  57. : base("GET", path, name, description)
  58. {
  59. m_assetService = assService;
  60. m_RedirectURL = redirectURL;
  61. if (m_RedirectURL != null && !m_RedirectURL.EndsWith("/"))
  62. m_RedirectURL += "/";
  63. }
  64. protected override byte[] ProcessRequest(string path, Stream request, IOSHttpRequest httpRequest, IOSHttpResponse httpResponse)
  65. {
  66. // Try to parse the texture ID from the request URL
  67. NameValueCollection query = HttpUtility.ParseQueryString(httpRequest.Url.Query);
  68. string textureStr = query.GetOne("texture_id");
  69. string format = query.GetOne("format");
  70. //m_log.DebugFormat("[GETTEXTURE]: called {0}", textureStr);
  71. if (m_assetService == null)
  72. {
  73. m_log.Error("[GETTEXTURE]: Cannot fetch texture " + textureStr + " without an asset service");
  74. httpResponse.StatusCode = (int)System.Net.HttpStatusCode.NotFound;
  75. return null;
  76. }
  77. UUID textureID;
  78. if (!String.IsNullOrEmpty(textureStr) && UUID.TryParse(textureStr, out textureID))
  79. {
  80. // m_log.DebugFormat("[GETTEXTURE]: Received request for texture id {0}", textureID);
  81. string[] formats;
  82. if (!string.IsNullOrEmpty(format))
  83. {
  84. formats = new string[1] { format.ToLower() };
  85. }
  86. else
  87. {
  88. formats = WebUtil.GetPreferredImageTypes(httpRequest.Headers.Get("Accept"));
  89. if (formats.Length == 0)
  90. formats = new string[1] { DefaultFormat }; // default
  91. }
  92. // OK, we have an array with preferred formats, possibly with only one entry
  93. httpResponse.StatusCode = (int)System.Net.HttpStatusCode.NotFound;
  94. foreach (string f in formats)
  95. {
  96. if (FetchTexture(httpRequest, httpResponse, textureID, f))
  97. break;
  98. }
  99. }
  100. else
  101. {
  102. m_log.Warn("[GETTEXTURE]: Failed to parse a texture_id from GetTexture request: " + httpRequest.Url);
  103. }
  104. // m_log.DebugFormat(
  105. // "[GETTEXTURE]: For texture {0} sending back response {1}, data length {2}",
  106. // textureID, httpResponse.StatusCode, httpResponse.ContentLength);
  107. return null;
  108. }
  109. /// <summary>
  110. ///
  111. /// </summary>
  112. /// <param name="httpRequest"></param>
  113. /// <param name="httpResponse"></param>
  114. /// <param name="textureID"></param>
  115. /// <param name="format"></param>
  116. /// <returns>False for "caller try another codec"; true otherwise</returns>
  117. private bool FetchTexture(IOSHttpRequest httpRequest, IOSHttpResponse httpResponse, UUID textureID, string format)
  118. {
  119. // m_log.DebugFormat("[GETTEXTURE]: {0} with requested format {1}", textureID, format);
  120. if(!String.IsNullOrEmpty(m_RedirectURL))
  121. {
  122. string textureUrl = m_RedirectURL + "?texture_id=" + textureID.ToString();
  123. m_log.Debug("[GETTEXTURE]: Redirecting texture request to " + textureUrl);
  124. httpResponse.StatusCode = (int)OSHttpStatusCode.RedirectMovedPermanently;
  125. httpResponse.RedirectLocation = textureUrl;
  126. return true;
  127. }
  128. // Fetch, Misses or invalid return a 404
  129. AssetBase texture = m_assetService.Get(textureID.ToString());
  130. if (texture != null)
  131. {
  132. if (texture.Type != (sbyte)AssetType.Texture)
  133. {
  134. httpResponse.StatusCode = (int)System.Net.HttpStatusCode.NotFound;
  135. return true;
  136. }
  137. if (format == DefaultFormat)
  138. {
  139. WriteTextureData(httpRequest, httpResponse, texture, format);
  140. return true;
  141. }
  142. // need to convert format
  143. AssetBase newTexture = new AssetBase(texture.ID + "-" + format, texture.Name, (sbyte)AssetType.Texture, texture.Metadata.CreatorID);
  144. newTexture.Data = ConvertTextureData(texture, format);
  145. if (newTexture.Data.Length == 0)
  146. return false; // !!! Caller try another codec, please!
  147. newTexture.Flags = AssetFlags.Collectable;
  148. newTexture.Temporary = true;
  149. newTexture.Local = true;
  150. WriteTextureData(httpRequest, httpResponse, newTexture, format);
  151. return true;
  152. }
  153. // not found
  154. // m_log.Warn("[GETTEXTURE]: Texture " + textureID + " not found");
  155. httpResponse.StatusCode = (int)System.Net.HttpStatusCode.NotFound;
  156. return true;
  157. }
  158. private void WriteTextureData(IOSHttpRequest request, IOSHttpResponse response, AssetBase texture, string format)
  159. {
  160. string range = request.Headers.GetOne("Range");
  161. if (!String.IsNullOrEmpty(range)) // JP2's only
  162. {
  163. // Range request
  164. int start, end;
  165. if (TryParseRange(range, out start, out end))
  166. {
  167. // Before clamping start make sure we can satisfy it in order to avoid
  168. // sending back the last byte instead of an error status
  169. if (start >= texture.Data.Length)
  170. {
  171. // m_log.DebugFormat(
  172. // "[GETTEXTURE]: Client requested range for texture {0} starting at {1} but texture has end of {2}",
  173. // texture.ID, start, texture.Data.Length);
  174. // Stricly speaking, as per http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html, we should be sending back
  175. // Requested Range Not Satisfiable (416) here. However, it appears that at least recent implementations
  176. // of the Linden Lab viewer (3.2.1 and 3.3.4 and probably earlier), a viewer that has previously
  177. // received a very small texture may attempt to fetch bytes from the server past the
  178. // range of data that it received originally. Whether this happens appears to depend on whether
  179. // the viewer's estimation of how large a request it needs to make for certain discard levels
  180. // (http://wiki.secondlife.com/wiki/Image_System#Discard_Level_and_Mip_Mapping), chiefly discard
  181. // level 2. If this estimate is greater than the total texture size, returning a RequestedRangeNotSatisfiable
  182. // here will cause the viewer to treat the texture as bad and never display the full resolution
  183. // However, if we return PartialContent (or OK) instead, the viewer will display that resolution.
  184. // response.StatusCode = (int)System.Net.HttpStatusCode.RequestedRangeNotSatisfiable;
  185. // response.AddHeader("Content-Range", String.Format("bytes */{0}", texture.Data.Length));
  186. // response.StatusCode = (int)System.Net.HttpStatusCode.OK;
  187. response.StatusCode = (int)System.Net.HttpStatusCode.PartialContent;
  188. response.ContentType = texture.Metadata.ContentType;
  189. }
  190. else
  191. {
  192. // Handle the case where no second range value was given. This is equivalent to requesting
  193. // the rest of the entity.
  194. if (end == -1)
  195. end = int.MaxValue;
  196. end = Utils.Clamp(end, 0, texture.Data.Length - 1);
  197. start = Utils.Clamp(start, 0, end);
  198. int len = end - start + 1;
  199. // m_log.Debug("Serving " + start + " to " + end + " of " + texture.Data.Length + " bytes for texture " + texture.ID);
  200. // Always return PartialContent, even if the range covered the entire data length
  201. // We were accidentally sending back 404 before in this situation
  202. // https://issues.apache.org/bugzilla/show_bug.cgi?id=51878 supports sending 206 even if the
  203. // entire range is requested, and viewer 3.2.2 (and very probably earlier) seems fine with this.
  204. //
  205. // We also do not want to send back OK even if the whole range was satisfiable since this causes
  206. // HTTP textures on at least Imprudence 1.4.0-beta2 to never display the final texture quality.
  207. // if (end > maxEnd)
  208. // response.StatusCode = (int)System.Net.HttpStatusCode.OK;
  209. // else
  210. response.StatusCode = (int)System.Net.HttpStatusCode.PartialContent;
  211. response.ContentLength = len;
  212. response.ContentType = texture.Metadata.ContentType;
  213. response.AddHeader("Content-Range", String.Format("bytes {0}-{1}/{2}", start, end, texture.Data.Length));
  214. response.Body.Write(texture.Data, start, len);
  215. }
  216. }
  217. else
  218. {
  219. m_log.Warn("[GETTEXTURE]: Malformed Range header: " + range);
  220. response.StatusCode = (int)System.Net.HttpStatusCode.BadRequest;
  221. }
  222. }
  223. else // JP2's or other formats
  224. {
  225. // Full content request
  226. response.StatusCode = (int)System.Net.HttpStatusCode.OK;
  227. response.ContentLength = texture.Data.Length;
  228. if (format == DefaultFormat)
  229. response.ContentType = texture.Metadata.ContentType;
  230. else
  231. response.ContentType = "image/" + format;
  232. response.Body.Write(texture.Data, 0, texture.Data.Length);
  233. }
  234. // if (response.StatusCode < 200 || response.StatusCode > 299)
  235. // m_log.WarnFormat(
  236. // "[GETTEXTURE]: For texture {0} requested range {1} responded {2} with content length {3} (actual {4})",
  237. // texture.FullID, range, response.StatusCode, response.ContentLength, texture.Data.Length);
  238. // else
  239. // m_log.DebugFormat(
  240. // "[GETTEXTURE]: For texture {0} requested range {1} responded {2} with content length {3} (actual {4})",
  241. // texture.FullID, range, response.StatusCode, response.ContentLength, texture.Data.Length);
  242. }
  243. /// <summary>
  244. /// Parse a range header.
  245. /// </summary>
  246. /// <remarks>
  247. /// As per http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html,
  248. /// this obeys range headers with two values (e.g. 533-4165) and no second value (e.g. 533-).
  249. /// Where there is no value, -1 is returned.
  250. /// FIXME: Need to cover the case where only a second value is specified (e.g. -4165), probably by returning -1
  251. /// for start.</remarks>
  252. /// <returns></returns>
  253. /// <param name='header'></param>
  254. /// <param name='start'>Start of the range. Undefined if this was not a number.</param>
  255. /// <param name='end'>End of the range. Will be -1 if no end specified. Undefined if there was a raw string but this was not a number.</param>
  256. private bool TryParseRange(string header, out int start, out int end)
  257. {
  258. start = end = 0;
  259. if (header.StartsWith("bytes="))
  260. {
  261. string[] rangeValues = header.Substring(6).Split('-');
  262. if (rangeValues.Length == 2)
  263. {
  264. if (!Int32.TryParse(rangeValues[0], out start))
  265. return false;
  266. string rawEnd = rangeValues[1];
  267. if (rawEnd == "")
  268. {
  269. end = -1;
  270. return true;
  271. }
  272. else if (Int32.TryParse(rawEnd, out end))
  273. {
  274. return true;
  275. }
  276. }
  277. }
  278. start = end = 0;
  279. return false;
  280. }
  281. private byte[] ConvertTextureData(AssetBase texture, string format)
  282. {
  283. m_log.DebugFormat("[GETTEXTURE]: Converting texture {0} to {1}", texture.ID, format);
  284. byte[] data = new byte[0];
  285. MemoryStream imgstream = new MemoryStream();
  286. Bitmap mTexture = null;
  287. ManagedImage managedImage = null;
  288. Image image = null;
  289. try
  290. {
  291. // Taking our jpeg2000 data, decoding it, then saving it to a byte array with regular data
  292. // Decode image to System.Drawing.Image
  293. if (OpenJPEG.DecodeToImage(texture.Data, out managedImage, out image) && image != null)
  294. {
  295. // Save to bitmap
  296. mTexture = new Bitmap(image);
  297. using(EncoderParameters myEncoderParameters = new EncoderParameters())
  298. {
  299. myEncoderParameters.Param[0] = new EncoderParameter(Encoder.Quality,95L);
  300. // Save bitmap to stream
  301. ImageCodecInfo codec = GetEncoderInfo("image/" + format);
  302. if (codec != null)
  303. {
  304. mTexture.Save(imgstream, codec, myEncoderParameters);
  305. // Write the stream to a byte array for output
  306. data = imgstream.ToArray();
  307. }
  308. else
  309. m_log.WarnFormat("[GETTEXTURE]: No such codec {0}", format);
  310. }
  311. }
  312. }
  313. catch (Exception e)
  314. {
  315. m_log.WarnFormat("[GETTEXTURE]: Unable to convert texture {0} to {1}: {2}", texture.ID, format, e.Message);
  316. }
  317. finally
  318. {
  319. // Reclaim memory, these are unmanaged resources
  320. // If we encountered an exception, one or more of these will be null
  321. if (mTexture != null)
  322. mTexture.Dispose();
  323. if (image != null)
  324. image.Dispose();
  325. if(managedImage != null)
  326. managedImage.Clear();
  327. if (imgstream != null)
  328. imgstream.Dispose();
  329. }
  330. return data;
  331. }
  332. // From msdn
  333. private static ImageCodecInfo GetEncoderInfo(String mimeType)
  334. {
  335. ImageCodecInfo[] encoders;
  336. encoders = ImageCodecInfo.GetImageEncoders();
  337. for (int j = 0; j < encoders.Length; ++j)
  338. {
  339. if (encoders[j].MimeType == mimeType)
  340. return encoders[j];
  341. }
  342. return null;
  343. }
  344. }
  345. }