llGetHTTPHeader
Revision as of 10:03, 8 October 2012 by Kireji Haiku (talk | contribs) (added two comments and made loop a tiny bit faster)
| LSL Portal | Functions | Events | Types | Operators | Constants | Flow Control | Script Library | Categorized Library | Tutorials |
Summary
Function: string llGetHTTPHeader( key request_id, string header );| 0.0 | Forced Delay |
| 10.0 | Energy |
Returns a string that is the value for header for request_id.
| • key | request_id | – | A valid HTTP request key. | |
| • string | header | – | Lower case header value name. |
Returns an empty string if the header is not found or if the headers can no longer be accessed. Headers can only be accessed before llHTTPResponse is called and with-in the first 30 seconds after the http_request event is queued.
Specification
Generated Headers
These headers are automatically generated by the simulator, they were not actually sent by the requesting client. They supply information about the request to make parsing easier.
Sample URL: https://sim3015.aditi.lindenlab.com:12043/cap/a7717681-2c04-e4ac-35e3-1f01c9861322/foo/bar?arg=gra
| header | description | example |
|---|---|---|
| "x-script-url" | The base url, as originally received from llRequestURL/llRequestSecureURL | https://sim3015.aditi.lindenlab.com:12043/cap/a7717681-2c04-e4ac-35e3-1f01c9861322 |
| "x-path-info" | Any trailing path information from the requested url | /foo/bar |
| "x-query-string" | Any query arguments, the text past the first "?" in the url | arg=gra |
| "x-remote-ip" | IP address of the host that made the request |
Common Headers
| header | description | example |
|---|---|---|
| "user-agent" | The user-agent header as reported by the requester |
llHTTPRequest Headers
| Header | Description | Example data |
|---|---|---|
| connection | Connection options | close |
| cache-control | Maximum response age accepted. | max-age=259200 |
| x-forwarded-for | Used to show the IP address connected to through proxies. | 127.0.0.1 |
| via | Shows the recipients and protocols used between the User Agent and the server. | 1.1 sim10115.agni.lindenlab.com:3128 (squid/2.7.STABLE9) |
| content-length | The size of the entity-body, in decimal number of octets. | 17 |
| pragma | The message should be forwarded to the server, even if it has a cached version of the data. | no-cache |
| x-secondlife-shard | The environment the object is in. "Production" is the main grid and "Testing" is the preview grid | Production |
| x-secondlife-region | The name of the region the object is in, along with the global coordinates of the region's south-west corner | Jin Ho (264448, 233984) |
| x-secondlife-owner-name | Legacy name of the owner of the object | Zeb Wyler |
| x-secondlife-owner-key | UUID of the owner of the object | 01234567-89ab-cdef-0123-456789abcdef |
| x-secondlife-object-name | The name of the object containing the script | Object |
| x-secondlife-object-key | The key of the object containing the script | 01234567-89ab-cdef-0123-456789abcdef |
| x-secondlife-local-velocity | The velocity of the object | 0.000000, 0.000000, 0.000000 |
| x-secondlife-local-rotation | The rotation of the object containing the script | 0.000000, 0.000000, 0.000000, 1.000000 |
| x-secondlife-local-position | The position of the object within the region | (173.009827, 75.551231, 60.950001) |
| user-agent | The user-agent header sent by LSL Scripts. Contains Server version. | Second Life LSL/16.05.24.315768 (http://secondlife.com) |
| content-type | The media type of the entity body. | text/plain; charset=utf-8 |
| accept-charset | Acceptable character sets from the server. Q being the quality expected when sending the different character sets. | utf-8;q=1.0, *;q=0.5 |
| accept | Media types the server will accept. | text/*, application/xhtml+xml, application/atom+xml, application/json, application/xml, application/llsd+xml, application/x-javascript, application/javascript, application/x-www-form-urlencoded, application/rss+xml |
| accept-encoding | Acceptable content encodings for the server. | deflate, gzip |
| host | The internet host being requested. | secondlife.com |
|
||
Caveats
- Header information becomes inaccessible after 30 seconds or if llHTTPResponse is called.
- LSL is not a CGI environment
- "Content-Type" is an example of a normal header name, in a CGI environment the name would be "HTTP_CONTENT_TYPE".
- header must be lower case (or it will match nothing). All header names are converted to lower case when they are received.
- When making a request...
- The path part of the URL must be prefixed with a forward slash
- In order to use the query string, you must include a path (even if it is just a slash)
Examples
<lsl> key url_request;
default {
state_entry()
{
url_request = llRequestURL();
}
http_request(key id, string method, string body)
{
if (url_request == id)
{
// if you're usually not resetting the query ID
// now is a good time to start!
url_request = "";
if (method == URL_REQUEST_GRANTED)
{
llOwnerSay("URL: " + body);
key owner = llGetOwner();
vector ownerSize = llGetAgentSize(owner);
if (ownerSize)// != ZERO_VECTOR
llLoadURL(owner, "I got a new URL!", body);
}
else if (method == URL_REQUEST_DENIED)
llOwnerSay("Something went wrong, no url:\n" + body);
}
else
{
list headerList = ["x-script-url",
"x-path-info", "x-query-string",
"x-remote-ip", "user-agent"];
integer index = -llGetListLength(headerList);
do
{
string header = llList2String(headerList, index);
llOwnerSay(header + ": " + llGetHTTPHeader(id, header));
}
while (++pos);
llOwnerSay("body:\n" + body);
llHTTPResponse(id, 200, body);
}
}
}
</lsl>See Also
Events
| • | http_request |
Functions
| • | llGetFreeURLs | |||
| • | llRequestURL | |||
| • | llRequestSecureURL | |||
| • | llReleaseURL | |||
| • | llHTTPResponse |
Articles
| • | LSL http server | |||
| • |  Wikipedia:List of HTTP headers
|
Deep Notes
History
Signature |
|---|
function string llGetHTTPHeader( key request_id, string header ); |