Changes for page Attachments

Last modified by teamwire004 on 2026/01/13 09:09

Manage
- Copy
Actions
- Export
- Print Preview
Viewers
- Source
- Siblings
- Content
- Attachments

From 4.1 to 5.1

From version 5.1

edited by teamwire004
on 2024/07/08 15:23

Change comment: Migrated property [type] from class [XWiki.WikiMacroParameterClass]

To version 13.1

edited by teamwire004
on 2026/01/13 09:09

Change comment: Install extension [org.xwiki.platform:xwiki-platform-attachment-ui/17.10.2]

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (3 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -10,7 +10,7 @@
    #set ($docAction = $request.get('docAction'))
    #set ($attachmentList = $targetAttachDocument.getAttachmentList())
    #if ($attachmentList && $attachmentList.size() > 0)
--    #set ($sortedAttachments = $sorttool.sort($attachmentList, 'date:desc'))
++    #set ($sortedAttachments = $collectiontool.sort($attachmentList, 'date:desc'))
      #set ($lastAttachment = $sortedAttachments.get(0))
    #end
    $response.sendRedirect($targetDocument.getURL($docAction, $escapetool.url({
@@ -38,7 +38,7 @@
   * @param $targetAttachDocument the document to list/save attachments to
   * @param $options generic picker options
   *#
--#macro (attachmentPicker_displayAttachmentGallery $targetDocument, $targetAttachDocument, $options)
++#macro (_attachmentPicker_displayAttachmentGallery $targetDocument, $targetAttachDocument, $options)
    #set ($currentValue = $targetDocument.getValue($options.property))
    #if ("$!{targetAttachDocument.getAttachment($currentValue)}" == '')
      #set ($currentValue = "$!{options.defaultValue}")
@@ -45,14 +45,19 @@
    #end
    (% class="gallery" %)(((
    ## Only display the upload form if they have edit permission on targetAttachDocument
--  #attachmentPicker_displayUploadForm($targetDocument, $targetAttachDocument, $options)
--  #attachmentPicker_displayAttachmentGalleryEmptyValue($targetDocument, $targetAttachDocument, $options, $currentValue)
--  #set ($sortedAttachments = $sorttool.sort($targetAttachDocument.getAttachmentList(), "${options.sortAttachmentsBy}") )
++  #_attachmentPicker_displayUploadForm($targetDocument, $targetAttachDocument, $options)
++  #_attachmentPicker_displayAttachmentGalleryEmptyValue($targetDocument, $targetAttachDocument, $options, $currentValue)
++  #if ("$!services.temporaryAttachments" != '')
++    #set ($unsortedAttachments = $services.temporaryAttachments.listAllAttachments($targetAttachDocument))
++    #set ($sortedAttachments = $collectiontool.sort($unsortedAttachments, "${options.sortAttachmentsBy}"))
++  #else
++    #set ($sortedAttachments = $collectiontool.sort($targetAttachDocument.getAttachmentList(), "${options.sortAttachmentsBy}") )
++  #end
    #foreach ($attachment in $sortedAttachments)
      #set ($extension = $attachment.getFilename())
      #set ($extension = $extension.substring($mathtool.add($extension.lastIndexOf('.'), 1)).toLowerCase())
      #if ($options.filter.size() == 0 || $options.filter.contains($extension))
--      #attachmentPicker_displayAttachmentBox($attachment $targetDocument $targetAttachDocument, $options $currentValue)
++      #_attachmentPicker_displayAttachmentBox($attachment $targetDocument $targetAttachDocument, $options $currentValue)
      #end
    #end
    )))
@@ -66,7 +66,7 @@
   * @param $options generic picker options
   * @param $currentValue the currently selected file, used for determining if the box should be highlighted as the current value
   *#
--#macro (attachmentPicker_displayAttachmentBox $attachment $targetDocument $targetAttachDocument, $options $currentValue)
++#macro (_attachmentPicker_displayAttachmentBox $attachment $targetDocument $targetAttachDocument, $options $currentValue)
    #set ($hasTemporaryAttachment = "$!services.temporaryAttachments" != '')
    #set ($canEdit = $xwiki.hasAccessLevel('edit', $xcontext.user, ${targetAttachDocument.fullName}))
    #set ($isTemporaryAttachment = false)
@@ -84,8 +84,8 @@
    #if ($isTemporaryAttachment)
      #set ($discard = $cssClasses.add('temporary_attachment'))
    #end
--  #attachmentPicker_displayStartFrame({'value' : $attachment.filename, 'text' : $attachment.filename, 'cssClass' : "${stringtool.join($cssClasses, ' ')}"} $currentValue)
--  #attachmentPicker_displayAttachmentDetails($attachment $options)
++  #_attachmentPicker_displayStartFrame({'value' : $attachment.filename, 'text' : $attachment.filename, 'cssClass' : "${stringtool.join($cssClasses, ' ')}"} $currentValue)
++  #_attachmentPicker_displayAttachmentDetails($attachment $options)
    #set ($returnURL = $escapetool.url($doc.getURL('view', $request.queryString)))
    #set ($deleteURL = $targetAttachDocument.getAttachmentURL($attachment.filename, 'delattachment', "xredirect=${returnURL}&form_token=$!{services.csrf.getToken()}") )
    #set ($viewURL = $targetAttachDocument.getAttachmentURL($attachment.filename) )##{'name' : 'download', 'url' : $viewURL, 'rel' : '__blank'}
@@ -95,9 +95,9 @@
    })))
    ## Delete action is only proposed for users with the edit right on the document.
    ## If the temporary attachment is available, the delete action is only allowed for non-temporary attachments.
--  #set ($attachmentActions = [{'name' : 'select', 'url' : $selectURL}])
++  #set ($attachmentActions = [{'name' : 'select', 'url' : $selectURL, 'icon' : 'check', 'extraCssClass' : 'btn btn-xs btn-success'}])
    #if($canDeleteAttachment)
--    #set ($discard = $attachmentActions.add({'name' : 'delete', 'url' : $deleteURL}))
++    #set ($discard = $attachmentActions.add({'name' : 'delete', 'url' : $deleteURL, 'icon' : 'cross', 'extraCssClass' : 'btn btn-xs btn-danger'}))
    #end
    #define($additionalContent)
      #if ($isTemporaryAttachment)
@@ -106,7 +106,7 @@
        (% title="$titleMessage" %)$services.icon.render('clock')(%%)
      #end
    #end
--  #attachmentPicker_displayEndFrame ($attachmentActions $additionalContent)
++  #_attachmentPicker_displayEndFrame ($attachmentActions $additionalContent)
  #end
  #**
@@ -116,9 +116,10 @@
   *        the title to display (boxOptions.text), optional extra CSS classnames to put on the box (boxOptions.cssClass)
   * @param $currentValue the currently selected file, used for determining if this attachment should be highlighted as the current value
   *#
--#macro (attachmentPicker_displayStartFrame $boxOptions $currentValue)
++#macro (_attachmentPicker_displayStartFrame $boxOptions $currentValue)
    (% class="gallery_attachmentbox $!{boxOptions.cssClass} #if ("$!{boxOptions.value}" == $currentValue) current#{end}" %)(((
      (% class="gallery_attachmenttitle" title="$services.rendering.escape($!{boxOptions.value}, 'xwiki/2.1')" %)(((
++      #if($!{boxOptions.cssClass} == 'gallery_upload')$services.icon.render('add') #end##
        $services.rendering.escape($boxOptions.text, 'xwiki/2.1')
      )))
      (% class="gallery_attachmentframe" %)(((
@@ -131,7 +131,7 @@
   * @param $attachment the target attachment to display
   * @param $options generic picker options
   *#
--#macro (attachmentPicker_displayAttachmentDetails $attachment $options)
++#macro (_attachmentPicker_displayAttachmentDetails $attachment $options)
    #if ($attachment)
      ## Compute the attachment reference because there's no getter.
      #set ($attachmentReference = $services.model.createAttachmentReference($attachment.document.documentReference,
@@ -140,12 +140,12 @@
      #if ($attachment.isImage() && $options.displayImage)
        ## We add the version to the query string in order to invalidate the cache when an image attachment is replaced.
        #set ($queryString = $escapetool.url({'version': $attachment.version}))
--      [[[[image:$attachmentStringReference||width=180 queryString="$queryString"]]>>attach:$attachmentStringReference]]
++      [[[[image:${attachmentStringReference}||width=180 queryString="$queryString"]]>>attach:$attachmentStringReference]]
      #else
        * (% class="mime" %){{html wiki=false clean=false}}#mimetypeimg($attachment.getMimeType().toLowerCase() $attachment.getFilename().toLowerCase()){{/html}}(%%) (% class="filename" %)$services.rendering.escape($attachment.getFilename(), 'xwiki/2.1')(% %)
        * v$attachment.getVersion() (#dynamicsize($attachment.longSize))
        * $services.localization.render('core.viewers.attachments.author', [$!{xwiki.getUserName($attachment.author, false)}]) $services.localization.render('core.viewers.attachments.date', [$!{xwiki.formatDate($attachment.date, 'dd/MM/yyyy hh:mm')}])
--      * (% class="buttonwrapper" %)[[${services.localization.render("${translationPrefix}.actions.download")}>>attach:$attachmentStringReference||title="$services.localization.render("${translationPrefix}.actions.download")" rel="__blank" class="button"]](%%)
++      * (% class="buttonwrapper" %)[[${services.localization.render("${translationPrefix}.actions.download")}>>attach:${attachmentStringReference}||title="$services.localization.render("${translationPrefix}.actions.download")" rel="__blank" class="button"]](%%)
      #end
    #end
  #end
@@ -164,12 +164,14 @@
   *        </dl>
   * @param $additionalContent optional additional content that does not follow the structure of the actions
   *#
--#macro (attachmentPicker_displayEndFrame $actions $additionalContent)
++#macro (_attachmentPicker_displayEndFrame $actions $additionalContent)
      )))## attachmentframe
      (% class="gallery_actions" %)(((
        #foreach ($action in $actions)
          #set( $actionname = $services.localization.render("${translationPrefix}.actions.${action.name}") )
--        [[${actionname}>>path:${action.url}||class="tool ${action.name}" title="${actionname}" #if($action.rel) rel="${action.rel}"#end]]##
++        [[${services.icon.render($action.icon)}(% class="sr-only"%)${actionname}(%%)>>##
++          path:${action.url}||class="tool ${action.name} $!{action.extraCssClass}"##
++          title="${actionname}" #if($action.rel) rel="${action.rel}"#end]]##
        #end
        $!additionalContent
      )))## actions
@@ -183,8 +183,8 @@
   * @param $targetAttachDocument the document to upload the attachment to
   * @param $options generic picker options
   *#
--#macro (attachmentPicker_displayUploadForm $targetDocument, $targetAttachDocument, $options)
--#attachmentPicker_displayStartFrame({
++#macro (_attachmentPicker_displayUploadForm $targetDocument, $targetAttachDocument, $options)
++#_attachmentPicker_displayStartFrame({
     'value' : $services.localization.render("${translationPrefix}.upload.title"),
     'text' : $services.localization.render("${translationPrefix}.upload.title"),
     'cssClass' : 'gallery_upload'
@@ -231,7 +231,7 @@
    </div>
  </form>
  {{/html}}
--#attachmentPicker_displayEndFrame ([])
++#_attachmentPicker_displayEndFrame ([])
  #end
  #**
@@ -242,7 +242,7 @@
   * @param $options generic picker options
   * @param $currentValue the currently selected file, used for determining if the empty box should be highlighted as the current value
   *#
--#macro (attachmentPicker_displayAttachmentGalleryEmptyValue $targetDocument, $targetAttachDocument, $options, $currentValue)
++#macro (_attachmentPicker_displayAttachmentGalleryEmptyValue $targetDocument, $targetAttachDocument, $options, $currentValue)
    #if ("$!{options.get('defaultValue')}" != '')
      #set ($reference = ${options.get('defaultValue')})
      #set ($docNameLimit = $reference.indexOf('@'))
@@ -257,11 +257,11 @@
        #set($dcssClass = 'gallery_image')
      #end
    #end
--  #attachmentPicker_displayStartFrame({'cssClass' : "gallery_emptyChoice $!{dcssClass}", 'text' : $services.localization.render("${translationPrefix}.default"), 'value' : "${options.defaultValue}"} $currentValue)
--  #attachmentPicker_displayAttachmentDetails($defaultAttachment $options)
++  #_attachmentPicker_displayStartFrame({'cssClass' : "gallery_emptyChoice $!{dcssClass}", 'text' : $services.localization.render("${translationPrefix}.default"), 'value' : "${options.defaultValue}"} $currentValue)
++  #_attachmentPicker_displayAttachmentDetails($defaultAttachment $options)
    #set ($returnURL = $escapetool.url($doc.getURL('view', $request.queryString)))
    #set ($selectURL = $targetDocument.getURL(${options.get('docAction')}, "${options.get('classname')}_${options.get('object')}_${options.get('property')}=&form_token=$!{services.csrf.getToken()}"))
--  #attachmentPicker_displayEndFrame ([{'name' : 'select', 'url' : $selectURL}])
++  #_attachmentPicker_displayEndFrame ([{'name' : 'select', 'url' : $selectURL, 'icon' : 'check', 'extraCssClass' : 'btn btn-xs btn-success'}])
  #end
  {{/velocity}}
@@ -315,7 +315,7 @@
    #end
    #set ($options = {
      'classname' : ${request.get('classname')},
--    'object' : $!{mathtool.toInteger($request.object)},
++    'object' : $!{numbertool.toNumber($request.object).intValue()},
      'property' : ${request.property},
      'displayImage' : ${displayImage},
      'docAction' : ${docAction},
@@ -326,12 +326,12 @@
      'versionSummary': $request.versionSummary.equals('true')
    })
    $!targetDocument.use($targetDocument.getObject($options.classname, $options.object))##
--  #attachmentPicker_displayAttachmentGallery($targetDocument, $targetAttachDocument, $options)
++  #_attachmentPicker_displayAttachmentGallery($targetDocument, $targetAttachDocument, $options)
    #set ($cancelLinkName = $services.rendering.escape($services.rendering.escape($services.localization.render("${translationPrefix}.cancel"), 'xwiki/2.1'), 'xwiki/2.1'))
    #set ($cancelLinkTarget = $services.rendering.escape($services.model.serialize($targetDocument), 'xwiki/2.1'))
    (% class="gallery_buttons buttons" %)(((
--  (% class="buttonwrapper secondary" %)[[$services.localization.render("${translationPrefix}.cancel")>>$targetDocument||class="button secondary" id="attachment-picker-close"]]
++  (% class="buttonwrapper secondary" %)[[$cancelLinkName>>$cancelLinkTarget||class="button secondary" id="attachment-picker-close"]]
    )))
  #end
  {{/velocity}}

XWiki.JavaScriptExtension[0]

Code

@@ -167,7 +167,7 @@
      /** AJAX deletion of attachments. */
      onDelete : function(event) {
        event.stop();
--      deleteTool = event.element();
++      const deleteTool = event.target.closest('.btn');
        if (!deleteTool.disabled) {
          new XWiki.widgets.ConfirmedAjaxRequest(
            deleteTool.readAttribute('href'),
@@ -210,7 +210,7 @@
      /** Update the property with the selected value without reloading the page. */
      onSelect : function(event) {
        event.stop();
--      var targetElement = event.element();
++      const targetElement = event.target.closest('.btn');
        var attachmentName = targetElement.up('.gallery_attachmentbox').down('.gallery_attachmenttitle').title;
        var imageSource = targetElement.up('.gallery_attachmentbox.gallery_image');
        if (imageSource) {
@@ -225,7 +225,7 @@
        if (this.directSave) {
          // save via ajax
          if (!targetElement.disabled) {
--          new Ajax.Request(event.element().href, {
++          new Ajax.Request(targetElement.href, {
              onCreate : function() {
                targetElement.disabled = true;
                targetElement._x_notif = new XWiki.widgets.Notification("$services.localization.render('core.widgets.confirmationBox.notification.inProgress')", 'inprogress');

XWiki.StyleSheetExtension[0]

Code

@@ -25,9 +25,12 @@
    margin: 0;
  }
  .gallery_attachmentbox {
++  display: grid;
++  gap: .2rem;
    background: $theme.pageContentBackgroundColor;
++  padding: .2rem;
    border: 1px solid $theme.borderColor;
--  border-radius: 5px;
++  border-radius: var(--border-radius-base);
    float: left;
    margin: ${boxMargin}px;
    overflow: hidden;
@@ -36,8 +36,6 @@
  }
  .gallery .current {
    background-color: $theme.highlightColor;
--  border-width: 3px;
--  margin: 3px;
  }
  .gallery .current .gallery_attachmenttitle {
    font-weight: bold;
@@ -47,9 +47,7 @@
  }
  .gallery_attachmenttitle {
--  background: $theme.backgroundSecondaryColor;
--  border-bottom: 1px dotted $theme.borderColor;
--  border-radius: 5px 5px 0px 0px;
++  grid-area: 1 / 1 / 2 / 2;
    font-size: 85%;
    padding: 3px ${boxPadding}px;
    overflow: hidden;
@@ -62,7 +62,7 @@
  }
  .gallery_attachmentframe {
--  padding: ${boxPadding}px;
++  grid-area: 2 / 1 / 3 / 3;
    height: ${imgSize}px;
    overflow: hidden;
    position: relative;
@@ -101,39 +101,16 @@
  }
  /* Actions */
--.gallery_actions {
--  width: auto;
--  position: absolute;
--  bottom: 0px;
--  right: ${boxPadding}px;
++.gallery_actions p {
++  grid-area: 1 / 2 / 2 / 3;
++  display: flex;
++  justify-content: flex-end;
++  gap: .2rem;
  }
  .gallery_actions .tool {
--  background: none no-repeat 50% transparent;
    cursor: pointer;
    display: block;
--  float: left;
--  height: ${actionsHeight}px;
--  padding: 0 !important;
--  overflow: hidden;
--  text-indent: -1000em;
--  opacity: 0.6;
--  width: ${actionsWidth}px;
  }
--.gallery_actions .tool:hover {
--  opacity: 1;
--}
--.gallery_actions .select {
--  background-image: url("$xwiki.getSkinFile('icons/silk/tick.png')");
--}
--.gallery_actions .delete {
--  background-image: url("$xwiki.getSkinFile('icons/silk/cross.png')");
--}
--.gallery_actions .view {
--  background-image: url("$xwiki.getSkinFile('icons/silk/link.png')");
--}
--.gallery_actions .download {
--  background-image: url("$xwiki.getSkinFile('icons/silk/arrow_down.png')");
--}
  /*--------------------------------------------------*/
  /* Upload form                                      */
  .gallery_upload {
@@ -144,12 +144,6 @@
    background-color: $theme.backgroundSecondaryColor;
  }
--.gallery_upload .gallery_attachmenttitle {
--  background-position: 1px center;
--  background-image: url("$xwiki.getSkinFile('icons/silk/bullet_add.png')");
--  background-repeat: no-repeat;
--  padding-left: 16px;
--}
  .gallery_upload .gallery_attachmentframe {
    height: auto;
  }

XWiki.WikiMacroClass[0]

Macro code

@@ -3,7 +3,6 @@
  $xwiki.ssfx.use('js/xwiki/widgets/modalPopup.css', true)##
  $xwiki.jsx.use($xcontext.macro.doc.fullName)##
  $xwiki.ssx.use($xcontext.macro.doc.fullName)##
--$xwiki.jsfx.use('js/scriptaculous/builder.js')##
  ## Integrates the optional Lightbox widget (from http://extensions.xwiki.org/xwiki/bin/view/Extension/Lightbox+Application )
  #if ($xwiki.exists('XWiki.Lightbox'))
    $xwiki.jsx.use('XWiki.Lightbox')
@@ -32,7 +32,7 @@
  #end
  #set ($classname = "$!{xcontext.macro.params.classname}")
  #set ($property = "$!{xcontext.macro.params.property}")
--#set ($object = $mathtool.toInteger("$!{xcontext.macro.params.object}"))
++#set ($object = $numbertool.toNumber("$!{xcontext.macro.params.object}").intValue())
  #if ("$!{object}" != $!{xcontext.macro.params.object})
    #set ($object = ${targetdoc.getObject($classname).number})
    #if ("$!{object}" == '')
@@ -98,7 +98,7 @@
  #set ($propValue = "$!{targetdoc.getObject($classname, $object).getProperty($property).value}")
  ##
--#macro (attachmentPicker_displayAttachment $name $displayImage $withLink $forceElement)
++#macro (_attachmentPicker_displayAttachment $name $displayImage $withLink $forceElement)
    #set ($attachment = $targetdoc.getAttachment("$!{name}"))
    #if ("$!{name}" != '' && "$!{attachment}" != '')
      #set ($attachmentRef = $services.model.createAttachmentReference(${targetdoc.documentReference}, ${name}))
@@ -131,7 +131,7 @@
  ## Display the "Choose an attachment" button if they can:
  ##  1. Edit the current page
  ##  2. View the target attachment page. (can be the same page)
--#macro (attachmentPicker_displayButton)
++#macro (_attachmentPicker_displayButton)
    #if ($targetPermView)
      #set ($queryString = {
        'docname': $doc.fullName,
@@ -147,8 +147,9 @@
      #if ($hasTargetDoc)
        #set ($queryString.targetdocname = $targetdoc.fullName)
      #end
--    (% class="buttonwrapper" %)[[$buttontext>>$xcontext.macro.doc.fullName||queryString="$escapetool.url($queryString)"
--      class="attachment-picker-start button" title="$buttontext"]](%%)##
++    #set ($linkLabel = $services.rendering.escape($services.rendering.escape($buttontext, 'xwiki/2.1'), 'xwiki/2.1'))
++    (% class="buttonwrapper" %)[[$linkLabel>>${xcontext.macro.doc.fullName}||queryString="$escapetool.url($queryString)"
++      class="attachment-picker-start button" title="$services.rendering.escape($buttontext, 'xwiki/2.1')"]](%%)##
    #end
  #end
  {{/velocity}}
@@ -155,13 +155,13 @@
  {{velocity}}
  #if ("${savemode}" == 'direct')
--  (% class="attachment-picker" %)(((#attachmentPicker_displayAttachment($propValue $displayImage $link true) #attachmentPicker_displayButton())))
++  (% class="attachment-picker" %)(((#_attachmentPicker_displayAttachment($propValue $displayImage $link true) #_attachmentPicker_displayButton())))
  #elseif ($xcontext.action == 'inline' || $xcontext.action == 'edit')
    (% class="attachment-picker" %)(((##
--    #attachmentPicker_displayAttachment($propValue $displayImage false true) #attachmentPicker_displayButton()##
++    #_attachmentPicker_displayAttachment($propValue $displayImage false true) #_attachmentPicker_displayButton()##
      {{html}}<input type="hidden" name="$escapetool.xml("${classname}_${object}_${property}")" value="$escapetool.xml("${propValue}")" class="property-reference"/>{{/html}}##
    )))
  #else
--  #attachmentPicker_displayAttachment($propValue $displayImage $link false)
++  #_attachmentPicker_displayAttachment($propValue $displayImage $link false)
  #end
  {{/velocity}}