Difference between revisions of "Template:LSL Constants HTTP"

From Second Life Wiki
Jump to navigation Jump to search
(Documented maximum allowed max header length)
(6 intermediate revisions by 4 users not shown)
Line 34: Line 34:
{{!}} <nowiki>[</nowiki>[[string]]&nbsp;{{LSL Param|MIME_type}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>[[string]]&nbsp;{{LSL Param|MIME_type}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>"text/plain;charset=utf-8"<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>"text/plain;charset=utf-8"<nowiki>]</nowiki>
{{!}} text/* MIME types should specify a charset. To emulate HTML forms use application/x-www-form-urlencoded. This allows you to set the body to a properly escaped ([[llEscapeURL]]) sequence of &lt;name,value&gt; pairs in the form var=value&amp;var2=value2 and have them automatically parsed by web frameworks
{{!}} text/* MIME types should specify a charset. To emulate HTML forms use application/x-www-form-urlencoded. This allows you to set the body to a properly escaped ([[llEscapeURL]]) sequence of &lt;name,value&gt; pairs in the form var=value&amp;var2=value2 and have them automatically parsed by web frameworks.
:MIME types must be specified in the format: ''type'''''/'''''subtype''[''';'''''option'''''='''''value'']
;Some valid examples are:
: <nowiki>"text/html"</nowiki>
: <nowiki>"text/plain;charset=utf-8"</nowiki>
: <nowiki>"application/xhtml+xml"</nowiki>
: <nowiki>"application/json"</nowiki>
: <nowiki>"application/x-www-form-urlencoded"</nowiki>
: <nowiki>"application/rss+xml"</nowiki>
: <nowiki>"multipart/mixed; boundary="---1234567890---""</nowiki>
{{!}}-
{{!}}-
{{!}} {{LSL Const|HTTP_BODY_MAXLENGTH|integer|2}}
{{!}} {{LSL Const|HTTP_BODY_MAXLENGTH|integer|2}}
Line 40: Line 49:
{{!}} <nowiki>[</nowiki>[[integer]]&nbsp;{{LSL Param|length}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>[[integer]]&nbsp;{{LSL Param|length}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>{{BytesHover|2048}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>{{BytesHover|2048}}<nowiki>]</nowiki>
{{!}} Sets the maximum (UTF-8 encoded) byte length of the HTTP body. The maximum that can be set depends upon which VM is used.
{{!}} Sets the maximum (UTF-8 encoded) byte length of the HTTP response body. The maximum that can be set depends upon which VM is used.
* '''[[Mono]] Max:''' {{BytesHover|16384}}
* '''[[Mono]] Max:''' {{BytesHover|16384}}
* '''[[LSO]] Max:''' {{BytesHover|4096}}
* '''[[LSO]] Max:''' {{BytesHover|4096}}
Line 67: Line 76:
{{!}} <nowiki>[</nowiki>[[TRUE]]<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>[[TRUE]]<nowiki>]</nowiki>
{{!}} Sends "Pragma: no-cache" header ([[TRUE]]), or does not send a "Pragma" header ([[FALSE]]).
{{!}} Sends "Pragma: no-cache" header ([[TRUE]]), or does not send a "Pragma" header ([[FALSE]]).
{{!}}-
{{!}} {{LSL Const|HTTP_USER_AGENT|integer|7}}
{{!}} {{#var:value}}
{{!}} <nowiki>[</nowiki>[[string]]&nbsp;{{LSL Param|user agent value}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>''(none)''<nowiki>]</nowiki>
{{!}}The user agent value is appended to the one generated by LSL itself. It should follow the syntax from the HTTP standard like: "My-Script-Name/1.0 (Mozilla compatible)".
'''Note:''' Spaces are not allowed in HTTP User Agent token values, so "My Script Name/1.0" will produce a script error; change the spaces to hyphens ("-")
'''Note:''' ''this constant is not yet available in all deployed server versions''
{{!}}-
{{!}} {{LSL Const|HTTP_ACCEPT|integer|8}}
{{!}} {{#var:value}}
{{!}} <nowiki>[</nowiki>[[string]]&nbsp;{{LSL Param|MIME_type}}<nowiki>]</nowiki>
{{!}} <nowiki>[</nowiki>"text/plain;charset=utf-8"<nowiki>]</nowiki>
{{!}} HTTP_ACCEPT parameters can be passed to limit the number of mime types that are sent in the Accept: header of the HTTP request.  Specified mime types may include character set and q parameters. This parameter may be specified multiple times.
The specified mime type must be one already recognized by llHTTPRequest.  These include any text/ mime type, or the following application mime types: “application/xhtml+xml”, “application/atom+xml”, “application/json”, “application/xml”, “application/llsd+xml”, “application/x-javascript”, “application/javascript”, “application/x-www-form-urlencoded”, or “application/rss+xml”.
The Content-Type header in the response is checked against the specified HTTP_ACCEPT parameters. If the value of the header is not in the list of acceptable mime types, llHTTPRequest will return 415 as a result code and the body will be "Unsupported or unknown Content-Type."
{{!}}}
{{!}}}

Revision as of 13:12, 17 August 2017

Flag Parameter(s) Default Parameter Value(s) Description
HTTP_METHOD 0 [string method] ["GET"] "GET", "POST", "PUT" and "DELETE"
HTTP_MIMETYPE 1 [string MIME_type] ["text/plain;charset=utf-8"] text/* MIME types should specify a charset. To emulate HTML forms use application/x-www-form-urlencoded. This allows you to set the body to a properly escaped (llEscapeURL) sequence of <name,value> pairs in the form var=value&var2=value2 and have them automatically parsed by web frameworks.
MIME types must be specified in the format: type/subtype[;option=value]
Some valid examples are
"text/html"
"text/plain;charset=utf-8"
"application/xhtml+xml"
"application/json"
"application/x-www-form-urlencoded"
"application/rss+xml"
"multipart/mixed; boundary="---1234567890---""
HTTP_BODY_MAXLENGTH 2 [integer length] [2048] Sets the maximum (UTF-8 encoded) byte length of the HTTP response body. The maximum that can be set depends upon which VM is used.
HTTP_VERIFY_CERT 3 [integer verify] [TRUE] If TRUE, the server SSL certificate must be verifiable using one of the standard certificate authorities[1] when making HTTPS requests. If FALSE, any server SSL certificate will be accepted.
HTTP_VERBOSE_THROTTLE 4 [integer noisy] [TRUE] If TRUE, shout error messages to DEBUG_CHANNEL if the outgoing request rate exceeds the server limit. If FALSE, the error messages are suppressed (llHTTPRequest will still return NULL_KEY).
HTTP_CUSTOM_HEADER 5 [string name, string value] NA Add an extra custom HTTP header to the request. The first string is the name of the parameter to change, e.g. "Pragma", and the second string is the value, e.g. "no-cache". Up to 8 custom headers may be configured per request, and each header's combined name+value length must be no greater than 253 characters. Note that certain headers, such as the default headers, are blocked for security reasons.
HTTP_PRAGMA_NO_CACHE 6 [integer send_header] [TRUE] Sends "Pragma: no-cache" header (TRUE), or does not send a "Pragma" header (FALSE).
HTTP_USER_AGENT 7 [string user agent value] [(none)] The user agent value is appended to the one generated by LSL itself. It should follow the syntax from the HTTP standard like: "My-Script-Name/1.0 (Mozilla compatible)".

Note: Spaces are not allowed in HTTP User Agent token values, so "My Script Name/1.0" will produce a script error; change the spaces to hyphens ("-")

Note: this constant is not yet available in all deployed server versions

HTTP_ACCEPT 8 [string MIME_type] ["text/plain;charset=utf-8"] HTTP_ACCEPT parameters can be passed to limit the number of mime types that are sent in the Accept: header of the HTTP request. Specified mime types may include character set and q parameters. This parameter may be specified multiple times.

The specified mime type must be one already recognized by llHTTPRequest. These include any text/ mime type, or the following application mime types: “application/xhtml+xml”, “application/atom+xml”, “application/json”, “application/xml”, “application/llsd+xml”, “application/x-javascript”, “application/javascript”, “application/x-www-form-urlencoded”, or “application/rss+xml”.

The Content-Type header in the response is checked against the specified HTTP_ACCEPT parameters. If the value of the header is not in the list of acceptable mime types, llHTTPRequest will return 415 as a result code and the body will be "Unsupported or unknown Content-Type."