OpenSim
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
HttpRequest.cs
Go to the documentation of this file.
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 
28 using System;
29 using OpenSim.Region.Framework.Interfaces;
30 using OpenSim.Region.CoreModules.Scripting.HttpRequest;
31 using OpenSim.Region.ScriptEngine.Shared;
32 using OpenSim.Region.ScriptEngine.Interfaces;
33 using OpenSim.Region.ScriptEngine.Shared.Api;
34 
35 namespace OpenSim.Region.ScriptEngine.Shared.Api.Plugins
36 {
37  public class HttpRequest
38  {
40 
41  public HttpRequest(AsyncCommandManager CmdManager)
42  {
43  m_CmdManager = CmdManager;
44  }
45 
46  public void CheckHttpRequests()
47  {
48  if (m_CmdManager.m_ScriptEngine.World == null)
49  return;
50 
51  IHttpRequestModule iHttpReq =
52  m_CmdManager.m_ScriptEngine.World.RequestModuleInterface<IHttpRequestModule>();
53 
54  HttpRequestClass httpInfo = null;
55 
56  if (iHttpReq != null)
57  httpInfo = (HttpRequestClass)iHttpReq.GetNextCompletedRequest();
58 
59  while (httpInfo != null)
60  {
61  //m_log.Debug("[AsyncLSL]:" + httpInfo.response_body + httpInfo.status);
62 
63  // Deliver data to prim's remote_data handler
64  //
65  // TODO: Returning null for metadata, since the lsl function
66  // only returns the byte for HTTP_BODY_TRUNCATED, which is not
67  // implemented here yet anyway. Should be fixed if/when maxsize
68  // is supported
69 
70  iHttpReq.RemoveCompletedRequest(httpInfo.ReqID);
71 
72  object[] resobj = new object[]
73  {
74  new LSL_Types.LSLString(httpInfo.ReqID.ToString()),
75  new LSL_Types.LSLInteger(httpInfo.Status),
76  new LSL_Types.list(),
77  new LSL_Types.LSLString(httpInfo.ResponseBody)
78  };
79 
80  foreach (IScriptEngine e in m_CmdManager.ScriptEngines)
81  {
82  if (e.PostObjectEvent(httpInfo.LocalID,
83  new EventParams("http_response",
84  resobj, new DetectParams[0])))
85  break;
86  }
87  httpInfo = (HttpRequestClass)iHttpReq.GetNextCompletedRequest();
88  }
89  }
90  }
91 }
Handles LSL commands that takes long time and returns an event, for example timers, HTTP requests, etc.
bool PostObjectEvent(uint localID, EventParams parms)
Post event to an entire prim
An interface for a script API module to communicate with the engine it's running under ...
Holds all the data required to execute a scripting event.
Definition: Helpers.cs:281