Bureaucrats, editor, reviewer, Administrators
13,554
edits
Changes
Jump to navigation
Jump to search
m
{{Mark|Updated with Version 9.0:}}
* The query <code><nowiki>web:redirect('/a/b')</nowiki></code> returns the following result (which will be interpreted as redirection if RESTXQ is used):<pre classlang="brush:xml">
</pre>
* The first RESTXQ function creates an initial database, and redirects to a second function that will access this database:
<pre class="brush:xquery">
declare %updating %rest:path('/app/init') function local:init() {
db:create('app', <root/>, 'root.xml'),
db:output(web:redirect('/app/main'))
};
declare %rest:path('/app/main') function local:update() {
'Stored documents: ' || count(db:open('app'))
};
{{Mark|Updated with Version 9.0:}} third argument added; default parameters removed.
{{Mark|Updated with Version 9.0:}}
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/>
{| 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|invalid|#Errors}} the string contains invalid XML characters.
|}
==web:forward==
{| width='100%'
|- valign="top"
| width='120' | '''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 {{Function||web:create-url}}.
|- 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|web:redirect|$location as xs:string|element(rest:response)}}<br/pre>{{Func|web:redirect|( $location url as xs:string, $parameters as map(item*) := (), item $anchor as xs:string := ()*)|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'''
|
<rest:response xmlns:rest="http://exquery.org/ns/restxq">
<http:response xmlns:http="http://expath.org/ns/http-client" status="302">
</http:response>
</rest:response>
</pre>
|}
==web:response-header==
{| width='100%'
|-valign="top"| width='120' | '''SignaturesSignature'''|{{Func|web:response-header||element(rest:response)}}<br/pre>{{Func|web:response-header|( $output as map(*)|element(rest? :response)}}<br/>{{Func|web:response-header|$output as map= (*), $headers as map(*)|element(rest? :response)}}<br/>{{Func|web:response-header|$output as map= (*), $headers atts as map(*), $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 top HTTP response element with the <code>$atts</code> argument.
* <code>media-type</code>: <code>application/octet-stream</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>
|-valign="top"
| '''Examples'''
|
* The function call <code>web:response-header()</code> returns:
<pre classlang="brush:xml">
<rest:response xmlns:rest="http://exquery.org/ns/restxq">
<http:response xmlns:http="http://expath.org/ns/http-client"/>
</pre>
* The following expression returns a media-type for binary data, a caching directive, and the OK status:<br/>
<pre classlang="brush:'xquery"'>
web:response-header(
map { 'media-type': 'application/octet-stream' },
</pre>
* The following RESTXQ function returns the contents of a 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>
|}
==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 QName {{Code|rest:error}}, the specified {{Code|$message}} and the specified {{Code|$status}} as error value.<br/>Calls to this function are equivalent to <code>fn:error(xs:QName('rest:error'), $message, $status)</code>.
See [[RESTXQ#Raise Errors|RESTXQ: Raise Errors]] to learn how the function is helpful in web applications.
|- valign="top"
| '''Examples'''
|
* <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.
|}
=Errors=
{| class="wikitable" width="100%"
! width="110"|Code
|Description
|-valign="top"
|{{Code|invalid}}
|A string contains invalid XML characters.
|- valign="top"
|{{Code|status}}
|The supplied status code is invalid.
|}
=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: [[#web:response-header{{Function||web:response-header]]}}: third argument added; default parameters removed.
* Updated: error codes updated; errors now use the module namespace
;Version 8.4
* Updated: [[#web:response-header{{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.
