Изменения документа Document Tree Macros

Редактировал(а) Георгий Глущенко 2026/07/02 17:46

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

От 3.1 до 4.1

От версии 4.1

отредактировано Давид Гавриков
на 2024/05/29 15:58

Изменить комментарий: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/16.3.1]

К версии 10.1

отредактировано Георгий Глущенко
на 2026/07/02 17:46

Изменить комментарий: Install extension [org.xwiki.platform:xwiki-platform-index-tree-macro/18.5.0]

Необработанный
Обработанный

Сводка

Свойства страницы (2 изменено, 0 добавлено, 0 удалено)

Подробности

Свойства страницы

Автор документа

@@ -1,1 +1,1 @@
--XWiki.gavrikof
++XWiki.ggv

Содержимое

@@ -30,11 +30,19 @@
      #end
    #end
    ## Handle relative references
--  #makeNodeReferencesAbsolute($docTreeConfig ['root', 'openTo'])
--  ## Sort the child documents by (raw) title when the node label is the document title.
--  #if ($docTreeConfig.showDocumentTitle)
--    #set ($docTreeConfig.orderBy = 'title')
++  #foreach ($key in ['root', 'openTo'])
++    #set ($docTreeConfig[$key] = $services.index.tree.normalizeEntityTreeNodeId($docTreeConfig[$key]))
    #end
++  ## FIXME: The 'orderBy' property of the tree API is shared by all tree node types, which means we can't indicate a
++  ## different sort field per tree node type (e.g. sort wiki nodes by name and document nodes by last modification
++  ## date). At the same time, this property is currently taken into account only for sorting document tree nodes, so for
++  ## now we set its value to the specified document sort. In the future we may want to convert this into a map, where
++  ## the key is the node type.
++  #set ($docTreeConfig.orderBy = $docTreeConfig.sortDocumentsBy)
++  ## Sort the child documents by (raw) title when the node label is the document title and there's no sort specified.
++  #if ($docTreeConfig.showDocumentTitle && "$!docTreeConfig.orderBy" == '')
++    #set ($docTreeConfig.orderBy = 'title:asc')
++  #end
    ## Determine which hierarchy needs to be used.
    #if ($docTreeConfig.showSpaces)
      #if ($docTreeConfig.hierarchyMode == 'parentchild')
@@ -50,33 +50,14 @@
    #set ($discard = $tree.properties.putAll($docTreeConfig))
  #end
--#set ($documentPseudoNodeTypes = ['translations', 'attachments', 'classProperties', 'objects', 'addDocument',
--  'addAttachment'])
--#macro (makeNodeReferencesAbsolute $map $keys)
--  #foreach ($key in $keys)
--    #set ($nodeId = $map.get($key))
--    #set ($parts = $nodeId.split(':', 2))
--    #if ($parts && $parts.size() == 2)
--      #set ($nodeType = $parts[0].toLowerCase())
--      #set ($nodeReference = $parts[1])
--      #set ($entityType = $nodeType)
--      #if ($documentPseudoNodeTypes.contains($nodeType))
--        #set ($entityType = 'document')
--      #end
--      #set ($discard = "#evaluate(""${escapetool.h}set (${escapetool.d}entityReference =
--        ${escapetool.d}services.model.resolve$stringtool.capitalize($entityType)(${escapetool.d}nodeReference))"")")
--      #if ($entityReference)
--        #set ($nodeReference = $services.model.serialize($entityReference, 'default'))
--      #end
--      #set ($discard = $map.put($key, "$nodeType:$nodeReference"))
--    #end
--  #end
--#end
--
  #macro (handleDocumentTreeRequest)
    #if ($request.action)
      #if ($services.csrf.isTokenValid($request.form_token))
--      $response.sendError(400, 'The specified action is not supported.')
++      #if ($request.action == 'create' && $request.type == 'addDocument')
++        #handleNewNodeCreationRequest()
++      #else
++        $response.sendError(400, 'The specified action is not supported.')
++      #end
      #elseif ($isAjaxRequest)
        $response.sendError(403, 'The CSRF token is missing.')
      #else
@@ -102,6 +102,22 @@
    #end
  #end
++#macro (handleNewNodeCreationRequest)
++  #set ($cleanId = $stringtool.substring($request.id, $stringtool.length('document:')))
++  #set ($parentReference = $services.model.resolveDocument($cleanId))
++  #set ($requestedName = $request.name)
++  #set ($transformedName = $services.modelvalidation.transformName($requestedName))
++  #set ($spaceReference = $services.model.createSpaceReference($transformedName, $parentReference.lastSpaceReference))
++  #set ($documentReference = $services.model.createDocumentReference('WebHome', $spaceReference))
++  #set ($data = [])
++  #addDocumentNode($documentReference, $data)
++  ## We want to allow opening the node to add another hierarchy.
++  #set ($data[0].children = true)
++  ## We want to display the actual requested name as node name.
++  #set ($data[0].text = $requestedName)
++  #jsonResponse($data)
++#end
++
  #macro (postProcessDocumentTreeData $data)
    ## This is just a hook to allow post processing the document tree data.
  #end
@@ -126,6 +126,8 @@
    #set ($limit = $mathtool.max($numbertool.toNumber($request.limit).intValue(), 1))
    #if ("$!limit" == '')
      #set ($limit = 15)
++  #else
++    #validateQueryLimit($limit)
    #end
    #if ($nodeId == '#' && $docTreeConfig.showRoot)
      #maybeAddNode($actualNodeId $children)
@@ -145,8 +145,39 @@
    #if ($parts && $parts.size() == 2)
      #set ($nodeType = $parts[0])
      #set ($nodeReference = $parts[1])
--    #set ($discard = "#evaluate(""${escapetool.h}maybeAdd$stringtool.capitalize($nodeType)Node(
--      ${escapetool.d}nodeReference ${escapetool.d}siblings ${escapetool.d}placeholder)"")")
++    #if ($nodeType == 'farm')
++      #maybeAddFarmNode($nodeReference $siblings)
++    #elseif ($nodeType == 'wiki')
++      #maybeAddWikiNode($nodeReference $siblings $placeholder)
++    #elseif ($nodeType == 'space')
++      #maybeAddSpaceNode($nodeReference $siblings $placeholder)
++    #elseif ($nodeType == 'document')
++      #maybeAddDocumentNode($nodeReference $siblings $placeholder)
++    #elseif ($nodeType == 'addDocument')
++      #maybeAddAddDocumentNode($nodeReference $siblings)
++    #elseif ($nodeType == 'translations')
++      #maybeAddTranslationsNode($nodeReference $siblings)
++    #elseif ($nodeType == 'translation')
++      #maybeAddTranslationNode($nodeReference $siblings)
++    #elseif ($nodeType == 'attachments')
++      #maybeAddAttachmentsNode($nodeReference $siblings)
++    #elseif ($nodeType == 'attachment')
++      #maybeAddAttachmentNode($nodeReference $siblings)
++    #elseif ($nodeType == 'addAttachment')
++      #maybeAddAddAttachmentNode($nodeReference $siblings)
++    #elseif ($nodeType == 'classProperties')
++      #maybeAddClassPropertiesNode($nodeReference $siblings)
++    #elseif ($nodeType == 'classProperty')
++      #maybeAddClassPropertyNode($nodeReference $siblings)
++    #elseif ($nodeType == 'objects')
++      #maybeAddObjectsNode($nodeReference $siblings)
++    #elseif ($nodeType == 'objectsOfType')
++      #maybeAddObjectsOfTypeNode($nodeReference $siblings)
++    #elseif ($nodeType == 'object')
++      #maybeAddObjectNode($nodeReference $siblings)
++    #elseif ($nodeType == 'objectProperty')
++      #maybeAddObjectPropertyNode($nodeReference $siblings)
++    #end
    #end
  #end
@@ -179,6 +179,7 @@
  #macro (maybeAddFarmNode $nodeReference $siblings)
    #set ($farmHomeReference = $services.model.resolveDocument('', 'default'))
++  #set ($isOpened = $docTreeConfig.expandToLevel > 0)
    #set ($discard = $siblings.add({
      'id': 'farm:*',
      'text': 'Farm',
@@ -188,6 +188,9 @@
        'type': 'farm',
        'validChildren': ['wiki', 'pagination']
      },
++    'state': {
++      'opened': $isOpened
++    },
      'a_attr': {
        'href': $xwiki.getURL($farmHomeReference)
      }
@@ -216,6 +216,7 @@
    #else
      #set ($label = $wiki.id)
    #end
++  #set ($isOpened = $docTreeConfig.expandToLevel > 0)
    #set ($discard = $siblings.add({
      'id': "wiki:$wiki.id",
      'text': $label,
@@ -227,6 +227,9 @@
        'validChildren': ['space', 'document', 'pagination'],
        'canDelete': $canDeleteWiki
      },
++    'state': {
++      'opened': $isOpened
++    },
      'a_attr': {
        'href': $xwiki.getURL($wiki.mainPageReference)
      }
@@ -252,6 +252,7 @@
  #macro (addSpaceNode $spaceReference $siblings)
    #set ($spaceId = $services.model.serialize($spaceReference, 'default'))
++  #set ($spaceNodeId = "space:$spaceId")
    #set ($hasSpaceAdmin = $services.security.authorization.hasAccess('admin', $spaceReference))
    #set ($canViewSpace = $services.security.authorization.hasAccess('view', $spaceReference))
    #if ($docTreeConfig.showTerminalDocuments)
@@ -259,10 +259,21 @@
      #set ($hasChildren = true)
    #else
      ## We display only the nested spaces. This space might contain only documents.
--    #set ($hasChildren = $tree.getChildCount("space:$spaceId") > 0)
++    #set ($hasChildren = $tree.getChildCount($spaceNodeId) > 0)
    #end
++  #set ($isOpened = false)
++  #if ("$!docTreeConfig.expandToLevel" != '')
++    #set ($rootNode = "wiki:$services.wiki.currentWikiId")
++    #if ("$!docTreeConfig.root" != '')
++      #set ($rootNode = "wiki:$services.wiki.currentWikiId")
++    #else
++      #set ($rootNode = $docTreeConfig.root)
++    #end
++    #set ($rootDistance = $tree.getPath($spaceNodeId).size())
++    #set ($isOpened = ($rootDistance != -1 && $docTreeConfig.expandToLevel >= $rootDistance))
++  #end
    #set ($discard = $siblings.add({
--    'id': "space:$spaceId",
++    'id': $spaceNodeId,
      'text': $spaceReference.name,
      'icon': 'fa fa-folder-o',
      'iconOpened': 'fa fa-folder-open-o',
@@ -280,6 +280,9 @@
        'createDocumentURL': $xwiki.getURL($spaceReference, 'create', $NULL),
        'deleteURL': $xwiki.getURL($spaceReference, 'deletespace', $NULL)
      },
++    'state': {
++      'opened': $isOpened
++    },
      'a_attr': {
        'href': $xwiki.getURL($spaceReference)
      }
@@ -305,6 +305,7 @@
  #macro (addDocumentNode $documentReference $siblings)
    #set ($documentId = $services.model.serialize($documentReference, 'default'))
++  #set ($docNodeId = "document:$documentId")
    #set ($label = $documentReference.name)
    #if (!$docTreeConfig.showSpaces &&
        $documentReference.name == $services.model.getEntityReference('DOCUMENT', 'default').name)
@@ -321,9 +321,11 @@
        #set ($label = $plainTitle)
      #end
    #end
--  #set ($hasChildren = $tree.getChildCount("document:$documentId") > 0)
++  #set ($hasChildren = $tree.getChildCount($docNodeId) > 0)
++  #set ($isOpened = false)
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "document:$documentId",
++    'id': $docNodeId,
      'text': $label,
      'icon': 'fa fa-file-o',
      'children': $hasChildren,
@@ -338,6 +338,9 @@
        'canCopy': $canViewDoc,
        'createDocumentURL': $xwiki.getURL($documentReference, 'create', $NULL)
      },
++    'state': {
++       'opened': $isOpened
++    },
      'a_attr': {
        'href': $xwiki.getURL($documentReference)
      }
@@ -352,14 +352,18 @@
  #end
  #macro (addAddDocumentNode $documentReference $siblings)
++  ## FIXME: This URL is wrong, it should use the $documentReference as the parent for creation of the node:
++  ## the reference is already an existing doc, so it shouldn't be the one used for creation.
    #set ($discard = $siblings.add({
      'id': "addDocument:$services.model.serialize($documentReference, 'default')",
--    'text': 'New page...',
++    'text': $services.localization.render('index.documentTree.addDocument'),
      'icon': 'fa fa-plus-circle',
      'children': false,
      'data': {
        'type': 'addDocument',
--      'validChildren': []
++      'validChildren': [],
++      'hasContextMenu': true,
++      'canRename': true
      },
      'a_attr': {
        'href': $xwiki.getURL($documentReference, 'create')
@@ -378,9 +378,27 @@
    #end
  #end
++#macro (computeIsOpened $docNodeId $result)
++  #set ($isOpened = false)
++  #if ("$!docTreeConfig.expandToLevel" != '')
++    #set ($rootNode = "wiki:$services.wiki.currentWikiId")
++    #if ("$!docTreeConfig.root" != '')
++      #set ($rootNode = "wiki:$services.wiki.currentWikiId")
++    #else
++      #set ($rootNode = $docTreeConfig.root)
++    #end
++    #set ($rootDistance = $tree.getPath($docNodeId).size())
++    #set ($isOpened = ($rootDistance != -1 && $docTreeConfig.expandToLevel >= $rootDistance))
++  #end
++  #setVariable("$result" $isOpened)
++#end
++
  #macro (addTranslationsNode $documentReference $siblings)
--  #set ($discard = $children.add({
--    'id': "translations:${documentReference}",
++  #set ($isOpened = false)
++  #set ($docNodeId = "translations:${documentReference}")
++  #computeIsOpened($docNodeId $isOpened)
++  #set ($discard = $siblings.add({
++    'id': $docNodeId,
      'text': 'Translations',
      'icon': 'fa fa-language',
      'children': true,
@@ -388,6 +388,9 @@
        'type': 'translations',
        'validChildren': ['translation'],
        'canDelete': $services.security.authorization.hasAccess('delete', $documentReference)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -404,8 +404,11 @@
  #macro (addTranslationNode $translationReference $siblings)
    #set ($currentLocale = $services.localization.currentLocale)
++  #set ($isOpened = false)
++  #set ($docNodeId = "translation:$services.model.serialize($translationReference, 'default')_$translationReference.locale")
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "translation:$services.model.serialize($translationReference, 'default')_$translationReference.locale",
++    'id': $docNodeId,
      'text': $translationReference.locale.getDisplayName($currentLocale),
      'icon': 'fa fa-file-text-o',
      'children': false,
@@ -416,6 +416,9 @@
      },
      'a_attr': {
        'href': $xwiki.getURL($translationReference)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -432,8 +432,11 @@
  #end
  #macro (addAttachmentsNode $documentReference $siblings)
++  #set ($isOpened = false)
++  #set ($docNodeId = "attachments:${documentReference}")
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "attachments:${documentReference}",
++    'id': $docNodeId,
      'text': 'Attachments',
      'icon': 'fa fa-paperclip',
      'children': true,
@@ -445,6 +445,9 @@
      },
      'a_attr': {
        'href': $xwiki.getURL($documentReference, 'view', 'viewer=attachments')
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -464,8 +464,11 @@
    #set ($attachmentId = $services.model.serialize($attachmentReference, 'default'))
    #set ($canEditDoc = $services.security.authorization.hasAccess('edit', $attachmentReference.parent))
    #getAttachmentIcon($attachment $icon)
++  #set ($isOpened = false)
++  #set ($docNodeId = "attachment:$attachmentId")
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "attachment:$attachmentId",
++    'id': $docNodeId,
      'text': $attachment.filename,
      'icon': $icon,
      'children': false,
@@ -484,6 +484,9 @@
      },
      'a_attr': {
        'href': $attachment.document.getAttachmentURL($attachment.filename)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -562,8 +562,11 @@
  #end
  #macro (addClassPropertiesNode $documentReference $siblings)
--  #set ($discard = $children.add({
--    'id': "classProperties:${documentReference}",
++  #set ($isOpened = false)
++  #set ($docNodeId = "classProperties:${documentReference}")
++  #computeIsOpened($docNodeId $isOpened)
++  #set ($discard = $siblings.add({
++    'id': $docNodeId,
      'text': 'Class Properties',
      'icon': 'fa fa-gears',
      'children': true,
@@ -571,6 +571,9 @@
        'type': 'classProperties',
        'validChildren': ['classProperty'],
        'canDelete': $services.security.authorization.hasAccess('edit', $documentReference)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -603,8 +603,11 @@
    #if (!$icon)
      #set ($icon = 'gear')
    #end
++  #set ($isOpened = false)
++  #set ($docNodeId = "classProperty:$classPropertyId")
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "classProperty:$classPropertyId",
++    'id': $docNodeId,
      'text': $property.name,
      'icon': "fa fa-$icon",
      'children': false,
@@ -612,6 +612,9 @@
        'id': $classPropertyId,
        'type': 'classProperty',
        'validChildren': []
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -628,8 +628,11 @@
  #end
  #macro (addObjectsNode $documentReference $siblings)
--  #set ($discard = $children.add({
--    'id': "objects:${documentReference}",
++  #set ($isOpened = false)
++  #set ($docNodeId = "objects:${documentReference}")
++  #computeIsOpened($docNodeId $isOpened)
++  #set ($discard = $siblings.add({
++    'id': $docNodeId,
      'text': 'Objects',
      'icon': 'fa fa-cubes',
      'children': true,
@@ -637,6 +637,9 @@
        'type': 'objects',
        'validChildren': ['objectsOfType'],
        'canDelete': $services.security.authorization.hasAccess('edit', $documentReference)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -647,8 +647,11 @@
      #set ($documentReference = $services.model.resolveDocument($parts.get(0)))
      #set ($classReference = $services.model.resolveDocument($parts.get(1)))
      #if ($services.security.authorization.hasAccess('view', $documentReference))
--      #set ($discard = $children.add({
--        'id': "objectsOfType:$documentReference/$classReference",
++      #set ($isOpened = false)
++      #set ($docNodeId = "objectsOfType:$documentReference/$classReference")
++      #computeIsOpened($docNodeId $isOpened)
++      #set ($discard = $siblings.add({
++        'id': $docNodeId,
          'text': $services.model.serialize($classReference, 'local'),
          'icon': 'fa fa-cubes',
          'children': true,
@@ -656,6 +656,9 @@
            'type': 'objectsOfType',
            'validChildren': ['object', 'pagination'],
            'canDelete': $services.security.authorization.hasAccess('edit', $documentReference)
++        },
++        'state': {
++          'opened': $isOpened
          }
        }))
      #end
@@ -682,8 +682,11 @@
  #macro (addObjectNode $object $objectReference $siblings)
    #set ($objectId = $services.model.serialize($objectReference, 'default'))
--  #set ($discard = $children.add({
--    'id': "object:$objectId",
++  #set ($isOpened = false)
++  #set ($docNodeId = "object:$objectId")
++  #computeIsOpened($docNodeId $isOpened)
++  #set ($discard = $siblings.add({
++    'id': $docNodeId,
      'text': "[$object.number]",
      'icon': 'fa fa-cube',
      'children': true,
@@ -692,6 +692,9 @@
        'type': 'object',
        'validChildren': ['objectProperty'],
        'canDelete': $services.security.authorization.hasAccess('edit', $objectReference.parent)
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -716,8 +716,11 @@
    #end
    #set ($objectPropertyReference = $services.model.createEntityReference($property.name, 'OBJECT_PROPERTY', $objRef))
    #set ($objectPropertyId = $services.model.serialize($objectPropertyReference, 'default'))
++  #set ($isOpened = false)
++  #set ($docNodeId = "objectProperty:$objectPropertyId")
++  #computeIsOpened($docNodeId $isOpened)
    #set ($discard = $siblings.add({
--    'id': "objectProperty:$objectPropertyId",
++    'id': $docNodeId,
      'text': $property.name,
      'icon': "fa fa-$icon",
      'children': false,
@@ -725,6 +725,9 @@
        'id': $objectPropertyId,
        'type': 'objectProperty',
        'validChildren': []
++    },
++    'state': {
++      'opened': $isOpened
      }
    }))
  #end
@@ -1168,6 +1168,8 @@
  #end
  #macro (addCommonDocTreeSolrParams $params)
++  ## Enable prefix matching, besides standard language-dependent matching.
++  #set ($discard = $params.add('q=__INPUT__ __INPUT__*'))
    #if ($rootType == 'wiki')
      ## Limit the search to the specified wiki.
      #addWikiLocationSolrParams($rootReference $params)

Изменения документа Document Tree Macros

Сводка

Подробности

Приложения

Навигация

Вики

Содержание

Включённые документы