Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
m
Serialization parameters can be supplied via the <code>$output</code> argument. Empty string values can be specified to invalidate default values. By default, the following serialization parameters will be returned:* <code>media-type</code>: <code>application/octet-stream</code>* <code>method</code>: <code>raw</code>|-valign="top"
…a file resource |} ==web:error== {| width='100%'|- valign="top"| width='120' | '''Signature'''|<pre>web:error( $status as xs:integer, $message as xs:string) as none</pre>|- valign="top"| '''Summary'''|Raises an error with the correct content-type will be returned QName {{Code|rest:error}}, the specified {{Code|$message}} and the specified {{Code|$status}} as error value.<br/>Calls to this function are equivalent to user <code>fn:error(xs:QName(provided that it exists 'rest:error'), $message, $status)</code>. See [[RESTXQ#Raise Errors|RESTXQ: Raise Errors]] to learn how the function is helpful in the web serverapplications.|- valign="top"| '''Examples'''s file system|* <code><nowiki>web:error(404, "The requested resource cannot be found.")</nowiki></code>|- valign="top"| '''Errors'''|{{Error|status|#Errors}} The supplied status code is invalid.
[[Category:XQuery]]
Text replacement - "syntaxhighlight" to "pre"
=Conventions=
All functions and errors in this module are assigned to the <code><nowiki>http://basex.org/modules/web</nowiki></code> namespace, which is statically bound to the {{Code|web}} prefix.<br/>All errors are assigned to the <code><nowiki>http://basex.org/errors</nowiki></code> namespace, which is statically bound to the {{Code|bxerr}} prefix.
=Functions=
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>web:content-type|( $path as xs:string|) as xs:string}}<br/pre>|-valign="top"
| '''Summary'''
|Returns the content type of a path by analyzing its file suffix. <code>application/octet-stream</code> is returned if the file suffix is unknown.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>web:create-url|( $url href as xs:string, $parameters as map(item(*), item $anchor as xs:string := ()*)|as xs:string}}<br/pre>|-valign="top"
| '''Summary'''
|Creates a new URL from the specified <code>{{Code|$url</code> href}} string, query string and the <code>$parameters</code> specified in a mapand an optional {{Code|$anchor}} reference. The keys and and values of the map entries will be converted to strings, URL-encoded (see [[#web:encode-url{{Function||web:encode-url]]}}), and appended to the url URL as query parameters. If a map entry has more than a single item, all of them will be appended as single parameters.|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>web:encode-url|( $string as xs:string|) as xs:string}}<br/pre>|-valign="top"
| '''Summary'''
|Encodes a string to a URL. Spaces are rewritten to {{Code|+}}; {{Code|*}}, {{Code|-}}, {{Code|.}} and {{Code|_}} are adopted; and all other non-ASCII characters and special characters are percent-encoded.
|-valign="top"
| '''Examples'''
|
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>web:decode-url|( $string as xs:string|) as xs:string}}<br/pre>|-valign="top"
| '''Summary'''
|Decodes a URL to the original string. Percent-encoded characters are decoded to their UTF8 codepoints, and {{Code|+}} characters are rewritten to spaces.
|-valign="top"
| '''Examples'''
|
* <code><nowiki>web:decode-url("%E6%97%A5%E6%9C%AC%E8%AA%9E")</nowiki></code> returns <code>日本語</code>.
|-valign="top"
| '''Errors'''
|{{Error|BXWE0001invalid|#Errors}} Specified URI is the string contains invalidXML characters.|} ==web:forward== {| width='100%'|-valign="top"| width='120'| ''Errors'Signature'''|<pre>web:forward( $path as xs:string, $parameters as map(*) := ()) as element(rest:forward)</pre>|- valign="top"| '''Summary'''|Creates a server-side [[RESTXQ#Forwards and Redirects|RESTXQ forward request]] to the specified {{Code|$path}}:* The client will not get notified of this forwarding.* Supplied query parameters will be attached to parameters of the current request.* The {{Code|$parameter}} argument is processed as described in {{ErrorFunction|BXWE0002|#Errorsweb:create-url}} Specified URI contains invalid XML characters.|- valign="top"| '''Examples'''|The function call <code><nowiki>web:forward('/a/b')</nowiki></code> creates the following result (which will be interpreted as forwarding if RESTXQ is used):<pre lang="xml"><rest:forward>/a/b</rest:forward></pre>
|}
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|<pre>web:redirect|( $location url as xs:string|element, $parameters as map(rest*) :response= ()}}<br/>{{Func|web:redirect|, $location anchor as xs:string, $parameters as map := (*)|) as element(rest:response)}}<br/pre>|-valign="top"
| '''Summary'''
|Creates a [[RESTXQ#Forwards and Redirects|RESTXQ redirection]] to the specified location{{Code|$url}}. The returned response will only work if no other items are returned by the RESTXQ function.<br/>If <code>The {{Code|$parameters</code> }} and {{Code|$anchor}} arguments are specified, they will be appended as query parameters to the URL processed as described for [[#web:create-urlin (see {{Function||web:create-url]]}}).|-valign="top"
| '''Examples'''
|The query <code><nowiki>web:redirect('/a/b')</nowiki></code> returns the following response elementresult (which will be interpreted as redirection if RESTXQ is used):<pre classlang="brush:xml">
<rest:response xmlns:rest="http://exquery.org/ns/restxq">
<http:response xmlns:http="http://expath.org/ns/http-client" status="302">
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|web:response-header||element(rest:response)}}<br/pre>{{Func|web:response-header|( $headers output as map(*)|element? := (rest:response)}}<br/>{{Func|web:response-header|, $headers as map(*)? := (), $output atts as map(*)|? := ()) as element(rest:response)}}<br/pre>|-valign="top"
| '''Summary'''
|Creates a [[RESTXQ#Response|RESTXQ response header]] .<br/>Serialization parameters and header values can be supplied via the <code>$output</code> and <code>$headers</code> arguments, and status and message attributes can be attached to the HTTP response element with a default caching directive and default serialization parametersthe <code>$atts</code> argument.* <code>media-type</code>: <code>application/octet-stream<br/code>
Header options can be supplied via the <code>$headers</code> argument. Empty string values can be specified to invalidate default values. By default, the following header options will be returned:
* <code>Cache-Control</code>: <code>max-age=3600,public</code>
| '''Examples'''
|
* The function call <code>web:response-header()</code> returns the following response element:<pre classlang="brush:xml">
<rest:response xmlns:rest="http://exquery.org/ns/restxq">
<http:response xmlns:http="http://expath.org/ns/http-client"> <http:header name="Cache-Control" value="max-age=3600,public"/> </http:response> <output:serialization-parameters xmlns:output="http://www.w3.org/2010/xslt-xquery-serialization"> <output:media-type value="application/octet-stream"/> <output:method value="raw"/> </output:serialization-parameters>
</rest:response>
</pre>
* If The following expression returns a media-type for binary data, a caching directive, and the OK status:<br/><pre lang='xquery'>web:response-header( map { 'media-type': 'application/octet-stream' }, map { 'Cache-Control': 'max-age=3600,public' }, map { 'status': 200, 'message': 'OK' })</pre>* The following RESTXQ function is called by returns the contents of a web browser…file to the client with correct media type:<br/><pre classlang="brush:'xquery"'>
declare %rest:path('media/{$file}') function local:get($file) {
let $path := 'path/to/' || $file
};
</pre>
|}
! width="110"|Code
|Description
|-valign="top"|{{Code|BXWE0001invalid}}|Specified URL is A string contains invalidXML characters.|-valign="top"|{{Code|BXWE0002status}}|Specified URL contains The supplied status code is invalid XML characters.
|}
=Changelog=
;Version 9.3
* Added: {{Function||web:error}}, {{Function||web:forward}}
;Version 9.2
* Updated: {{Function||web:create-url}}, {{Function||web:redirect}}: third argument added.
;Version 9.0
* Updated: {{Function||web:response-header}}: third argument added; default parameters removed.
* Updated: error codes updated; errors now use the module namespace
;Version 8.4
* Updated: {{Function||web:response-header}}: serialization method <code>raw</code> was removed (now obsolete).
;Version 8.2
* Added: [[#web:encode-url{{Function||web:encode-url]]}}, [[#web:decode-url{{Function||web:decode-url]]}}.
The module was introduced with Version 8.1.
