Редактирование User Directory Macros

Редактировать
Режимы редактирования
Создать
Управление
Действия
- Экспорт
- Предварительный просмотр
Просмотр

Родитель (скрыть)

Название

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="ru" xml:lang="ru">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<script type="importmap">
{"imports":{"xwiki-livedata":"\/webjars\/wiki%3Areglaments\/xwiki-platform-livedata-webjar\/17.10.12\/main.es.js?r=1","vue":"\/webjars\/wiki%3Areglaments\/vue\/3.5.23\/dist\/vue.runtime.esm-browser.prod.js?r=1","vue-i18n":"\/webjars\/wiki%3Areglaments\/vue-i18n\/11.1.12\/dist\/vue-i18n.esm-browser.prod.js?r=1"}}
</script>

</head>
<body id="body" class="skin-flamingo viewbody main wiki-reglaments
space-XWiki"><!--startmacro:velocity|-|output="false"|-|## Users class
#set ($xwikiUsersClassReference = $services.model.createDocumentReference($xcontext.database, 'XWiki', 'XWikiUsers'))
#set ($xwikiUsersClass = $xwiki.getDocument($xwikiUsersClassReference).xWikiClass)
## Configuration class
#set ($directoryPreferencesClassReference = $services.model.createDocumentReference($xcontext.database, 'XWiki', 'UserDirectoryPreferencesClass'))
#set ($directoryPreferencesClassName = $services.model.serialize($directoryPreferencesClassReference))
## Default Configuration
#set ($defaultConfigurationDocReference = $services.model.createDocumentReference($xcontext.database, 'XWiki', 'UserDirectoryConfiguration'))
#set ($defaultConfigurationDoc = $xwiki.getDocument($defaultConfigurationDocReference))
#set ($defaultConfiguration = $defaultConfigurationDoc.getObject($directoryPreferencesClassName))

## We use an ordered set to collect the live table columns because we want to avoid duplicates (they break the live
## table filtering query) and at the same time we want to preserve the column order.
#set ($columns = $collectiontool.orderedSet)
## Add the fixed columns that we want the user directory to always show.
#set ($discard = $columns.addAll(['_avatar', 'doc.name']))

## Default configuration
## The columns that the user directory will default to when no user preferences exist or when the user resets to default.
## These defaults can be configured by the wiki's admins.
#set ($isGlobalUserDirectory = $doc.fullName != 'Main.UserDirectory')
#if ($isGlobalUserDirectory)
  ## Fallback defaults.
  #set ($defaultColumnsString = 'first_name last_name')
#else
  ## Admin configured defaults.
  #set ($defaultColumnsString = "$!defaultConfiguration.getValue('columns').trim()")
#end
#set ($defaultColumns = $defaultColumnsString.split('\\s+'))

## Current Configuration
#if ($isGlobalUserDirectory || $isGuest || $isSuperAdmin)
  ## Use the default configuration when editing the default configuration itself or
  ## when the current user doesn't have a profile document, so no preferences.
  #set ($configurationDoc = $defaultConfigurationDoc)
#else
  ## Use the current user's configuration
  #set ($configurationDoc = $xwiki.getDocument($xcontext.userReference))
#end
## Get or create the current configuration object, taking into account the values from the request (which is needed for
## the live preview).
#set ($configuration = $configurationDoc.updateObjectFromRequest($directoryPreferencesClassName))

## Read the configuration and initialize with defaults if necessary.
#set ($columnsString = $configuration.getValue('columns').trim())
#if ($columnsString == $NULL)
  #set ($columnsString = $defaultColumnsString)
  #set ($discard = $configuration.set('columns', $columnsString))
#end

## Check if they are the default preferences.
#set ($isCustomized = false)
#if ($columnsString != $defaultColumnsString)
  ## Mark it as a customized user directory.
  #set ($isCustomized = true)
#end

## Build the list of columns to display.
#foreach ($column in $columnsString.split('\\s+'))
  ## Skip invalid columns.
  #if ($column.trim() != '' && $xwikiUsersClass.get($column))
    #set ($discard = $columns.add($column))
  #end
#end

##
## Build and display the resulting livetable, nothing else.
##
#macro (displayUserDirectoryLiveTable)
  \{\{html clean="false"}}
  #set ($columnsProperties = \{})
  #foreach ($column in $columns)
    #set ($columnProperties = \{
      'type': 'text',
      'html': false,
      'sortable': true,
      'filterable': true,
      'displayName': $xwikiUsersClass.get($column).translatedPrettyName
    })
    #set ($classPropertyType = $xwikiUsersClass.get($column).classType)
    #if ($column == '_avatar')
      #set ($discard = $columnProperties.putAll(\{
        'html': true,
        'sortable': false,
        'filterable': false,
        'link': 'view'
      }))
    #elseif ($column == 'doc.name')
      #set ($columnProperties.link = 'view')
    #elseif ($classPropertyType.endsWith('List'))
      #set ($columnProperties.type = 'list')
    #elseif ($classPropertyType.endsWith('Number'))
      #set ($columnProperties.type = 'number')
    #elseif ($classPropertyType.endsWith('Password'))
      #set ($discard = $columnProperties.putAll(\{
        'sortable': false,
        'filterable': false
      }))
    #elseif ($classPropertyType.endsWith('TextArea') || $classPropertyType.endsWith('Email') || $classPropertyType.endsWith('Groups'))
      #set ($columnProperties.html = true)
    #end
    #set ($discard = $columnsProperties.put($column, $columnProperties))
  #end
  ##
  ## Allow other applications to provide a different data source for the user directory livetable. For example, some application might define a different membership relation.
  #set ($userDirectoryLivetableResultsReference = $services.model.createDocumentReference($xcontext.database, 'XWiki', 'UserDirectoryLivetableResultsOverride'))
  #if (!$xwiki.exists($userDirectoryLivetableResultsReference))
    ## If no override is present, use the default data source.
    #set ($userDirectoryLivetableResultsReference = $services.model.createDocumentReference($xcontext.database, 'XWiki', 'UserDirectoryLivetableResults'))
  #end
  ## Note that we specify the class name even though we use a custom results page (which hard-codes it) because the class
  ## name is needed by the live table filters, to have a proper drop down list for Static List fields for instance
  ## (see XWIKI-9660).
  #set ($options = \{
    'className': $services.model.serialize($xwikiUsersClassReference, 'local'),
    'resultPage' : "$services.model.serialize($userDirectoryLivetableResultsReference)",
    'translationPrefix' : 'xe.userdirectory.',
    'tagCloud' : true,
    'rowCount': 10,
    'outputOnlyHtml': true
  })
  ## Add a filter for subwikis
  #if ($xcontext.database != $xcontext.mainWikiName && "$!services.wiki" != '' && "$!services.wiki.user" != '')
    #set ($userScope = $services.wiki.user.getUserScope($services.wiki.currentWikiId))
    #if ($userScope == 'GLOBAL_ONLY')
      #set ($discard = $options.put('extraParams', 'userScope=global'))
    #else
      #set ($discard = $options.put('extraParams', 'userScope=local'))
    #end
    #if ($userScope == 'LOCAL_AND_GLOBAL')
      <\form class='xform third' action=''>
        <\dl>
          <\dt>
            <\label for='userScopeFilter'>$services.localization.render('userdirectory.userScopeFilter')<\/label>
            <\span class='xHint'>$services.localization.render('userdirectory.userScopeFilter.hint')<\/span>
          <\/dt>
          <\dd>
            <\select name='userScope' id='userScopeFilter'>
              <\option value='local'>$services.localization.render('userdirectory.userScopeFilter.local')<\/option>
              <\option value='global'>$services.localization.render('userdirectory.userScopeFilter.global')<\/option>
            <\/select>
          <\/dd>
        <\/dl>
      <\/form>
    #end
  #end
  ## We can't filter the values of the 'disabled' user profile property directly from the 'extraParams' live table
  ## results option because we can't express 'not equal' (we need to say: include only the user profiles for which the
  ## value of the 'disabled' property is not equal to 1). An user profile that doesn't have any value set for the
  ## 'disabled' property is enabled.
  ## We don't hide the disabled user profiles when the active and disabled columns are present because the user can use
  ## the live table filters to achieve this.
  #set ($hideDisabledProfilesValue = $configuration.getValue('hideDisabledProfiles'))
  #if (!$columns.contains('active')
      && ($hideDisabledProfilesValue == 1 || ("$!hideDisabledProfilesValue" == '' &&
      $configuration.xWikiClass.get('hideDisabledProfiles').getValue('defaultValue') == 1)))
    #set ($options.extraParams = "$!options.extraParams&hideDisabledProfiles=true")
  #end
  ## We need to know which users are disabled or inactive in order to display them differently.
  #set ($discard = $columns.add('active'))
  #set ($discard = $columnsProperties.putIfAbsent('active', \{'type': 'hidden'}))
  ## Display the computed livetable.
  #livetable('userdirectory' $columns $columnsProperties $options)
  \{\{/html}}
#end

## xredirect value used to come back to the current URL when performing actions
#set ($xredirect = $doc.getURL($xcontext.action, $request.queryString))

##
## Displays the customization form and preview. Also handles the form's actions.
##
#macro (displayUserDirectoryCustomizationForm)
  #if (!$configurationDoc.hasAccessLevel('edit'))
    \{\{error}}$services.localization.render('platform.userdirectory.customizeNotAllowed')\{\{/error}}
  #else
    #handleUserDirectoryAction()
    ##
    ## Customization form
    ##
    (% id="HUserDirectoryConfiguration" %)
    == \{\{translation key="userdirectory.configuration.title"/}} ==
    \{\{html clean="false"}}
    <\form class="user-directory-settings xform" action="$configurationDoc.getURL('save')" method="post">
      <\div class="hidden">
        <\input type="hidden" name="form_token" value="$escapetool.xml($services.csrf.token)" />
        <\input type="hidden" name="objectPolicy" value="updateOrCreate" />
        <\input type="hidden" name="xredirect" value="$escapetool.xml($xredirect)" />
        <\input type="hidden" name="comment" value="Updated user directory preferences" />
      <\/div>
      <\dl>
        #displayProperty('columns' $configuration 'edit')
        #displayProperty('hideDisabledProfiles' $configuration 'edit')
      <\/dl>
      <\p>
        <\input class="button" type="submit" name="action_save"
          value="$escapetool.xml($services.localization.render('xe.userdirectory.customizeSaveButtonLabel'))"/>
        #set ($resetQueryString = "$!request.queryString&" + $escapetool.url(\{
          'action': 'reset',
          'form_token': $services.csrf.token,
          'xredirect': $xredirect
        }))
        #set ($resetURL = $doc.getURL($xcontext.action, $resetQueryString))
        <\a href="$escapetool.xml($resetURL)" class="button secondary">
          $escapetool.xml($services.localization.render('xe.userdirectory.customizeResetButtonLabel'))
        <\/a>
      <\/p>
    <\/form>
    \{\{/html}}
  #end
#end

#macro (handleUserDirectoryAction)
  #if ("$!request.action" != '')
    #if ($services.csrf.isTokenValid($request.form_token))
      #if ($request.action == 'reset')
        #if ($isGlobalUserDirectory)
          ## For the global configuration it might be best to keep the object but set default values.
          #set ($discard = $configuration.set('columns', $defaultColumnsString))
        #else
          ## For user preferences, just remove the object.
          #set ($discard = $configurationDoc.removeObject($configuration))
        #end
        #set ($discard = $configurationDoc.save('Reset user directory preferences.'))
      #end
      ## Redirect using xredirect so that the page can be safely refreshed after an action.
      #set ($discard = $response.sendRedirect($request.xredirect))
    #elseif ($request.getHeader('X-Requested-With') == 'XMLHttpRequest')
      #set ($discard = $response.sendError(401, 'CSRF token verification failed!'))
    #else
      #set ($discard = $response.sendRedirect($services.csrf.resubmissionURL))
    #end
    #stop()
  #end
#end

#macro (displayProperty $propertyName $object $action)
  #set ($propertyClass = $object.xWikiClass.get($propertyName))
  #set ($isCheckbox = $propertyClass.getValue('displayFormType') == 'checkbox')
  #set ($fieldDisplay = "#unwrapXPropertyDisplay($object.display($propertyName, $action))")
  <\dt>
    <\label #if ($action == 'edit' && !$isCheckbox)
        for="$escapetool.xml("$\{object.xWikiClass.name}_$\{object.number}_$propertyName")"#end>
      #if ($isCheckbox)
        $fieldDisplay
      #end
      $escapetool.xml($propertyClass.translatedPrettyName)
    <\/label>
    <\span class="xHint">
      $!escapetool.xml($propertyClass.hint)
    <\/span>
  <\/dt>
  <\dd>#if (!$isCheckbox)$fieldDisplay#end<\/dd>
#end

##
## Displays the user directory with customization status and customization form for when it is being customized.
##
#macro (displayUserDirectoryCustomizationOptions $customize)
  ##
  ## Ability to customize the view.
  ##
  #if ($customize)
    #displayUserDirectoryCustomizationForm()
  #elseif ($isCustomized)
    \{\{warning}}
    $services.localization.render('xe.userdirectory.isCustomizedWarning', [
      "$doc.fullName",
      $escapetool.url(\{
        'customize': true,
        'action': 'reset',
        'xredirect': $xredirect,
        'form_token': $services.csrf.token
      }),
      "$doc.fullName",
      'customize=true'
    ])
    \{\{/warning}}
  #elseif ($isGuest)
    \{\{info}}
    $services.localization.render('xe.userdirectory.canCustomizeInfoGuest', ["path:$doc.getURL('login')"])
    \{\{/info}}
  #else
    \{\{info}}
    $services.localization.render('xe.userdirectory.canCustomizeInfo', ["$doc.fullName", 'customize=true'])
    \{\{/info}}
  #end
#end

##
## Displays the user directory.
##
#macro (displayUserDirectory $customize)
  #set ($discard = $xwiki.jsx.use('XWiki.UserDirectoryMacros'))
  #displayUserDirectoryCustomizationOptions($customize)

#if ($customize)
    (% id="HUserDirectoryCustomizePreview" %)
    == \{\{translation key="xe.userdirectory.customizePreviewTitle"/}} ==

#end
  #displayUserDirectoryLiveTable()
#end--></body>
</html>

Несущественное изменение

Редактирование заголовка и содержимого User Directory Macros

Информация о документе