dba/users library module
RA

Summary

User page.

Tags

Author: Christian Grün, BaseX Team 2005-21, BSD License

__source : users/user.xqm

View	Description	Format
xqdoc	xqDoc xml file from the source module	xml
xqparse	xqparse xml file from the source module	xml

Imports

This module is imported by 0 modules. It imports 2 modules.

(None)

imports

→

this

imports

→

dba/html

dba/options

Variables

3.1 $dba:CAT

Summary: Top category
Type: xs:string

3.2 $dba:SUB

Summary: Sub category
Type: xs:string

Functions

4.1 dba:user
#

Arities: dba:user#6RA

Summary

Returns a single user page.

Signature

dba:user ( $name as xs:string, $newname as xs:string?, $pw as xs:string?, $perm as xs:string?, $error as xs:string?, $info as xs:string? ) as element(html)

Parameters

name as xs:string user name
newname as xs:string? new name
pw as xs:string? password
perm as xs:string? permission
error as xs:string? error string
info as xs:string? info string

Return

element(html)page

Invokes 12 functions from 3 modules

html:button#2
html:button#3
html:focus#1
html:js#1
html:link#2
html:table#5
html:wrap#2
{http://basex.org/modules/user}info#1
{http://basex.org/modules/user}list-details#1
{http://www.w3.org/2005/xpath-functions}head#1
{http://www.w3.org/2005/xpath-functions}serialize#1
{http://www.w3.org/2005/xpath-functions}true#0

Invoked by 0 functions from 0 modules

Annotations

`%rest:GET`	`()`
`%rest:path`	`('/dba/user')`
`%rest:query-param`	`('name','{$name}')`
`%rest:query-param`	`('newname','{$newname}')`
`%rest:query-param`	`('pw','{$pw}')`
`%rest:query-param`	`('perm','{$perm}')`
`%rest:query-param`	`('error','{$error}')`
`%rest:query-param`	`('info','{$info}')`
`%output:method`	`('html')`

Source ( 111 lines)

function dba:user(
  $name     as xs:string,
  $newname  as xs:string?,
  $pw       as xs:string?,
  $perm     as xs:string?,
  $error    as xs:string?,
  $info     as xs:string?
) as element(html) {
  let $user := user:list-details($name)
  let $admin := $name eq 'admin'
  return html:wrap(
    map {
      'header': ($dba:CAT, $name), 'info': $info, 'error': $error,
      'css': 'codemirror/lib/codemirror.css',
      'scripts': ('codemirror/lib/codemirror.js', 'codemirror/mode/xml/xml.js')
    },
    <tr>
      <td width='49%'>
        <form action='user-edit' method='post' autocomplete='off'>
          <!--  force chrome not to autocomplete form -->
          <input style='display:none' type='text' name='fake1'/>
          <input style='display:none' type='password' name='fake2'/>
          <h2>{
            html:link('Users', $dba:CAT), ' » ',
            $name, ' » ',
            html:button('save', 'Save')
          }</h2>
          <input type='hidden' name='name' value='{ $name }'/>
          <table>{
            let $admin := $name eq 'admin' return (
              if($admin) then <input type='hidden' name='newname' value='admin'/> else (
                <tr>
                  <td>Name:</td>
                  <td>
                    <input type='text' name='newname'
                      value='{ head(($newname, $name)) }' id='newname'/>
                    { html:focus('newname') }
                    <div class='small'/>
                  </td>
                </tr>
              ),
              <tr>
                <td>Password:</td>
                <td>
                  <input type='password' name='pw' value='{ $pw }' id='pw'/> &#xa0;
                  <span class='note'>
                    …only changed if a new one is entered<br/>
                  </span>
                  <div class='small'/>
                </td>
              </tr>,
              if($admin) then <input type='hidden' name='perm' value='admin'/> else (
                <tr>
                  <td>Permission:</td>
                  <td>
                    <select name='perm' size='5'>{
                      let $perm := head(($perm, $user/@permission))
                      for $p in $options:PERMISSIONS
                      return element option { attribute selected { }[$p = $perm], $p }
                    }</select>
                    <div class='small'/>
                  </td>
                </tr>
              ),
              <tr>
                <td>Information:</td>
                <td>
                  <textarea name='info' id='editor' spellcheck='false'>{
                    serialize(user:info($name))
                  }</textarea>
                </td>
              </tr>,
              html:js('loadCodeMirror("xml", true);')
            )
          }</table>
        </form>
      </td>
      <td class='vertical'/>
      <td width='49%'>{
        if($admin) then () else <_>
          <h3>Local Permissions</h3>
          <form action='{ $dba:SUB }' method='post' id='{ $dba:SUB }' class='update'>
            <input type='hidden' name='name' value='{ $name }' id='name'/>
            <div class='small'/>
            {
              let $headers := (
                map { 'key': 'pattern', 'label': 'Pattern' },
                map { 'key': 'permission', 'label': 'Local Permission' }
              )
              let $entries := $user/database ! map {
                'pattern': @pattern,
                'permission': @permission
              }
              let $buttons := if($admin) then () else (
                html:button('pattern-add', 'Add…'),
                html:button('pattern-drop', 'Drop', true())
              )
              return html:table($headers, $entries, $buttons, map { }, map { })
            }
          </form>
          <div class='note'>
            A global permission can be overwritten by a local permission.<br/>
            Local permissions are applied to those databases that match<br/>
            a specified pattern. The pattern is based on the <a target='_blank'
              href='https://docs.basex.org/wiki/Commands#Glob_Syntax'>glob syntax</a>.<br/>
          </div>
        </_>/node()
      }</td>
    </tr>
  )
}

4.2 dba:user-redirect
#

Arities: dba:user-redirect#3R

Summary

Redirects to the specified action.

Signature

dba:user-redirect ( $action as xs:string, $name as xs:string, $patterns as xs:string* ) as element(rest:response)

Parameters

action as xs:string action to perform
name as xs:string user name
patterns as xs:string* patterns

Return

element(rest:response)redirection

Invokes 1 functions from 1 modules

{http://basex.org/modules/web}redirect#2

Invoked by 0 functions from 0 modules

Annotations

`%rest:POST`	`()`
`%rest:path`	`('/dba/user')`
`%rest:form-param`	`('action','{$action}')`
`%rest:form-param`	`('name','{$name}')`
`%rest:form-param`	`('pattern','{$patterns}')`

Source ( 7 lines)

function dba:user-redirect(
  $action    as xs:string,
  $name      as xs:string,
  $patterns  as xs:string*
) as element(rest:response) {
  web:redirect($action, map { 'name': $name, 'pattern': $patterns })
}

Namespaces

The following namespaces are defined:

Prefix	Uri
dba	dba/users 2 3 4 5 6 7
html	dba/html
options	dba/options
output	http://www.w3.org/2010/xslt-xquery-serialization
rest	http://exquery.org/ns/restxq

6 RestXQ

Paths defined 2.

Path	Method	Function
/dba/user	GET	dba:user#6
/dba/user	POST	dba:user-redirect#3

Source Code

(:~
 : User page.
 :
 : @author Christian Grün, BaseX Team 2005-21, BSD License
 :)
module namespace dba = 'dba/users';

import module namespace html = 'dba/html' at '../lib/html.xqm';
import module namespace options = 'dba/options' at '../lib/options.xqm';

(:~ Top category :)
declare variable $dba:CAT := 'users';
(:~ Sub category :)
declare variable $dba:SUB := 'user';

(:~
 : Returns a single user page.
 : @param  $name     user name
 : @param  $newname  new name
 : @param  $pw       password
 : @param  $perm     permission
 : @param  $error    error string
 : @param  $info     info string
 : @return page
 :)
declare
  %rest:GET
  %rest:path('/dba/user')
  %rest:query-param('name',     '{$name}')
  %rest:query-param('newname',  '{$newname}')
  %rest:query-param('pw',       '{$pw}')
  %rest:query-param('perm',     '{$perm}')
  %rest:query-param('error',    '{$error}')
  %rest:query-param('info',     '{$info}')
  %output:method('html')
function dba:user(
  $name     as xs:string,
  $newname  as xs:string?,
  $pw       as xs:string?,
  $perm     as xs:string?,
  $error    as xs:string?,
  $info     as xs:string?
) as element(html) {
  let $user := user:list-details($name)
  let $admin := $name eq 'admin'
  return html:wrap(
    map {
      'header': ($dba:CAT, $name), 'info': $info, 'error': $error,
      'css': 'codemirror/lib/codemirror.css',
      'scripts': ('codemirror/lib/codemirror.js', 'codemirror/mode/xml/xml.js')
    },
    <tr>
      <td width='49%'>
        <form action='user-edit' method='post' autocomplete='off'>
          <!--  force chrome not to autocomplete form -->
          <input style='display:none' type='text' name='fake1'/>
          <input style='display:none' type='password' name='fake2'/>
          <h2>{
            html:link('Users', $dba:CAT), ' » ',
            $name, ' » ',
            html:button('save', 'Save')
          }</h2>
          <input type='hidden' name='name' value='{ $name }'/>
          <table>{
            let $admin := $name eq 'admin' return (
              if($admin) then <input type='hidden' name='newname' value='admin'/> else (
                <tr>
                  <td>Name:</td>
                  <td>
                    <input type='text' name='newname'
                      value='{ head(($newname, $name)) }' id='newname'/>
                    { html:focus('newname') }
                    <div class='small'/>
                  </td>
                </tr>
              ),
              <tr>
                <td>Password:</td>
                <td>
                  <input type='password' name='pw' value='{ $pw }' id='pw'/> &#xa0;
                  <span class='note'>
                    …only changed if a new one is entered<br/>
                  </span>
                  <div class='small'/>
                </td>
              </tr>,
              if($admin) then <input type='hidden' name='perm' value='admin'/> else (
                <tr>
                  <td>Permission:</td>
                  <td>
                    <select name='perm' size='5'>{
                      let $perm := head(($perm, $user/@permission))
                      for $p in $options:PERMISSIONS
                      return element option { attribute selected { }[$p = $perm], $p }
                    }</select>
                    <div class='small'/>
                  </td>
                </tr>
              ),
              <tr>
                <td>Information:</td>
                <td>
                  <textarea name='info' id='editor' spellcheck='false'>{
                    serialize(user:info($name))
                  }</textarea>
                </td>
              </tr>,
              html:js('loadCodeMirror("xml", true);')
            )
          }</table>
        </form>
      </td>
      <td class='vertical'/>
      <td width='49%'>{
        if($admin) then () else <_>
          <h3>Local Permissions</h3>
          <form action='{ $dba:SUB }' method='post' id='{ $dba:SUB }' class='update'>
            <input type='hidden' name='name' value='{ $name }' id='name'/>
            <div class='small'/>
            {
              let $headers := (
                map { 'key': 'pattern', 'label': 'Pattern' },
                map { 'key': 'permission', 'label': 'Local Permission' }
              )
              let $entries := $user/database ! map {
                'pattern': @pattern,
                'permission': @permission
              }
              let $buttons := if($admin) then () else (
                html:button('pattern-add', 'Add…'),
                html:button('pattern-drop', 'Drop', true())
              )
              return html:table($headers, $entries, $buttons, map { }, map { })
            }
          </form>
          <div class='note'>
            A global permission can be overwritten by a local permission.<br/>
            Local permissions are applied to those databases that match<br/>
            a specified pattern. The pattern is based on the <a target='_blank'
              href='https://docs.basex.org/wiki/Commands#Glob_Syntax'>glob syntax</a>.<br/>
          </div>
        </_>/node()
      }</td>
    </tr>
  )
};

(:~
 : Redirects to the specified action.
 : @param  $action    action to perform
 : @param  $name      user name
 : @param  $patterns  patterns
 : @return redirection
 :)
declare
  %rest:POST
  %rest:path('/dba/user')
  %rest:form-param('action',  '{$action}')
  %rest:form-param('name',    '{$name}')
  %rest:form-param('pattern', '{$patterns}')
function dba:user-redirect(
  $action    as xs:string,
  $name      as xs:string,
  $patterns  as xs:string*
) as element(rest:response) {
  web:redirect($action, map { 'name': $name, 'pattern': $patterns })
};

dba/users library moduleRA

Summary

Imports

Variables

3.1 $dba:CAT

3.2 $dba:SUB

Functions

4.1 dba:user#

4.2 dba:user-redirect#

Namespaces

6 RestXQ

Source Code

dba/users library module
RA

4.1 dba:user
#

4.2 dba:user-redirect
#