Skip to Content

Changes for page Attachments

Last modified by Ludovic Dubost on 2024/07/22 15:50
From version 5.1
edited by Ludovic Dubost
on 2017/03/08 18:02
Change comment: Install extension [org.xwiki.platform:xwiki-platform-attachment-ui-9.1.1]
To version 6.1
edited by Ludovic Dubost
on 2018/07/01 11:40
Change comment: Install extension [org.xwiki.platform:xwiki-platform-attachment-ui/10.5]

Summary

Details

Page properties
Content
... ... @@ -102,14 +102,19 @@
102 102   *#
103 103  #macro (attachmentPicker_displayAttachmentDetails $attachment $options)
104 104   #if ($attachment)
105 + ## Compute the attachment reference because there's no getter.
106 + #set ($attachmentReference = $services.model.createAttachmentReference($attachment.document.documentReference,
107 + $attachment.filename))
108 + #set ($attachmentStringReference = $services.model.serialize($attachmentReference, 'default'))
105 105   #if ($attachment.isImage() && $options.displayImage)
106 - #set ($attachmentDocument = $attachment.getDocument())
107 -[[[[image:${attachmentDocument.fullName}@${attachment.filename}||width=180]]>>attach:${attachmentDocument.fullName}@${attachment.filename}||rel="lightbox[attachments]"]]
110 + ## We add the version to the query string in order to invalidate the cache when an image attachment is replaced.
111 + #set ($queryString = $escapetool.url({'version': $attachment.version}))
112 + [[[[image:$attachmentStringReference||width=180 queryString="$queryString"]]>>attach:$attachmentStringReference]]
108 108   #else
109 109   * (% class="mime" %){{html wiki=false clean=false}}#mimetypeimg($attachment.getMimeType().toLowerCase() $attachment.getFilename().toLowerCase()){{/html}}(%%) (% class="filename" %)$attachment.getFilename()(% %)
110 110   * v$attachment.getVersion() (#dynamicsize($attachment.longSize))
111 111   * $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')}])
112 - * (% class="buttonwrapper" %)[[${services.localization.render("${translationPrefix}.actions.download")}>>attach:${attachment.getDocument()}@${attachment.filename}||title="$services.localization.render("${translationPrefix}.actions.download")" rel="__blank" class="button"]](%%)
117 + * (% class="buttonwrapper" %)[[${services.localization.render("${translationPrefix}.actions.download")}>>attach:$attachmentStringReference||title="$services.localization.render("${translationPrefix}.actions.download")" rel="__blank" class="button"]](%%)
113 113   #end
114 114   #end
115 115  #end
... ... @@ -157,7 +157,7 @@
157 157   #if (${options.rawfilter} != '')
158 158   <span class="xHint">$escapetool.xml($services.localization.render("${translationPrefix}.upload.hint", [${options.rawfilter}]))</span>
159 159   #end
160 - <input type="file" name="filepath" id="attachfile" class="attachment" size="30" title="$!{escapetool.xml($options.rawfilter)}"/>
165 + <input type="file" name="filepath" id="attachfile" class="noitems" title="$!{escapetool.xml($options.rawfilter)}"/>
161 161   <input type="hidden" name="xredirect" value="$xwiki.getDocument($attachmentPickerDocName).getURL('get', "xaction=postUpload&amp;docAction=$!{escapetool.url($options.get('docAction'))}&amp;targetdocname=$!{escapetool.url($targetAttachDocument.fullName)}&amp;docname=$!{escapetool.url($targetDocument.fullName)}&amp;fieldname=$!{escapetool.url($options.get('classname'))}_$!{escapetool.url($options.get('object'))}_$!{escapetool.url($options.get('property'))}&amp;form_token=$!{services.csrf.getToken()}")" />
162 162   <input type="hidden" name="docname" value="$!{escapetool.xml($targetDocument.fullName)}" />
163 163   <input type="hidden" name="classname" value="$!{escapetool.xml($options.get('classname'))}" />
... ... @@ -165,6 +165,27 @@
165 165   <input type="hidden" name="property" value="$!{escapetool.xml($options.get('property'))}" />
166 166   <input type="hidden" name="form_token" value="$!{services.csrf.getToken()}" />
167 167   </div>
173 + #if ("$!currentValue" != '' && $currentValue != $options.defaultValue)
174 + <div>
175 + <label>
176 + <input type="checkbox" name="filename" value="$!escapetool.xml($currentValue)"
177 + />$services.localization.render('attachmentSelector.replace',
178 + ["<strong>$!escapetool.xml($currentValue)</strong>"])
179 + </label>
180 + <span class="xHint">$escapetool.xml($services.localization.render('attachmentSelector.replace.hint'))</span>
181 + </div>
182 + #end
183 + #if ($xwiki.hasEditComment() && $options.versionSummary)
184 + <div>
185 + #if ($xwiki.isEditCommentFieldHidden())
186 + <input type="hidden" name="comment" value="$!escapetool.xml($request.comment)" />
187 + #else
188 + <label for="commentinput">$services.localization.render('core.comment')</label>
189 + <input type="text" name="comment" id="commentinput" value="$!escapetool.xml($request.comment)"
190 + title="$services.localization.render('core.comment.tooltip')" />
191 + #end
192 + </div>
193 + #end
168 168   <div class="buttons">
169 169   <span class="buttonwrapper">
170 170   <input type="submit" name="action_upload" class="button " value='$services.localization.render("${translationPrefix}.upload.submit")' title='$services.localization.render("${translationPrefix}.upload.submit")'/>
... ... @@ -263,7 +263,8 @@
263 263   'defaultValue' : "$!{request.defaultValue}",
264 264   'rawfilter': "$!{rawfilter}",
265 265   'filter': ${filter},
266 - 'sortAttachmentsBy': ${sortAttachmentsBy}
292 + 'sortAttachmentsBy': ${sortAttachmentsBy},
293 + 'versionSummary': $request.versionSummary.equals('true')
267 267   })
268 268   $!targetDocument.use($targetDocument.getObject($options.classname, $options.object))##
269 269   #attachmentPicker_displayAttachmentGallery($targetDocument, $targetAttachDocument, $options)
XWiki.JavaScriptExtension[0]
Code
... ... @@ -40,7 +40,7 @@
40 40   * and saves the underlying form (if any) so that any unsaved changes won't be lost.
41 41   */
42 42   filterFormUpload : function() {
43 - this.gallery.select('.uploadAttachment input.attachment').each(function(fileInput) {
43 + this.gallery.select('.uploadAttachment input[type="file"]').each(function(fileInput) {
44 44   fileInput.__allowedExtensions = fileInput.title.toLowerCase().replace(/\s*[,|; ]\s*/g, " ").strip();
45 45   if (fileInput.__allowedExtensions != '') {
46 46   fileInput.__allowedExtensions = fileInput.__allowedExtensions.split(" ");
... ... @@ -52,7 +52,7 @@
52 52   event.stop();
53 53   var uploadForm = event.element();
54 54   var hasErrors = false;
55 - uploadForm.select('input.attachment').each(function(fileInput) {
55 + uploadForm.select('input[type="file"]').each(function(fileInput) {
56 56   if (fileInput.value == '') {
57 57   new XWiki.widgets.Notification("$services.localization.render('xe.attachmentSelector.upload.error.noFile')", 'error');
58 58   hasErrors = true;
... ... @@ -68,7 +68,7 @@
68 68   uploadForm.submit();
69 69   } else {
70 70   // FIXME This fails in HTML5, will deal with it later:
71 - // this.property.down('input').value = uploadForm.down('.attachment').value;
71 + // this.property.down('input').value = uploadForm.down('input[type="file"]').value;
72 72   // uploadForm.xredirect.value = window.location.pathname;
73 73   document.observe('xwiki:document:saved', function() {
74 74   new XWiki.widgets.Notification("$services.localization.render('xe.attachmentSelector.upload.inProgress')", 'inprogress');
... ... @@ -117,6 +117,11 @@
117 117   if (this.gallery.down('.gallery_emptyChoice')) {
118 118   this.gallery.down('.gallery_emptyChoice').addClassName('current');
119 119   }
120 + // Disable the replace feature because there's no selection.
121 + var fileNameInput = this.gallery.down('input[type="checkbox"][name="filename"]');
122 + fileNameInput.disabled = true;
123 + // Empty the displayed selected file name.
124 + fileNameInput.up('label').down('strong').update('');
120 120   if (!this.directSave) {
121 121   this.property.down('input').value = this.defaultValue;
122 122   }
XWiki.StyleSheetExtension[0]
Code
... ... @@ -153,24 +153,29 @@
153 153   background-repeat: no-repeat;
154 154   padding-left: 16px;
155 155  }
156 -.gallery_upload form {
157 - height: ${imgSize}px;
156 +.gallery_upload .gallery_attachmentframe {
157 + height: auto;
158 158  }
159 -.gallery_upload .xHint {
160 - text-transform: none !important;
159 +.gallery_upload_input {
160 + margin-bottom: 10px;
161 161  }
162 -.gallery_upload input.attachment {
163 - font-size: 83.3%;
164 - margin: 0; /* Overrides viewers/attachments.css */
165 - padding: 0; /* Overrides viewers/attachments.css */
162 +.gallery_upload input[type="file"] {
163 + font-size: 86%;
166 166   width: ${mathtool.sub($uploadBoxSize, $mathtool.mul($boxPadding, 2))}px;
167 167  }
168 168  .gallery_upload .buttonwrapper {
169 169   margin: 0;
170 170  }
171 -.gallery_upload .button {
172 - font-size: .65em;
169 +.gallery_upload .button,
170 +.gallery_upload label {
171 + font-size: 86%;
173 173  }
173 +.gallery_upload input[type="checkbox"] {
174 + vertical-align: text-bottom;
175 +}
176 +.gallery_upload label[for="commentinput"] {
177 + margin-top: 10px;
178 +}
174 174  
175 175  /* ------------------------------------ */
176 176  /* Buttons on top: */
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -123,7 +123,24 @@
123 123  ## 1. Edit the current page
124 124  ## 2. View the target attachment page. (can be the same page)
125 125  #macro (attachmentPicker_displayButton)
126 - #if ($hasEdit && $targetPermView)(% class="buttonwrapper" %)[[${buttontext}>>${xcontext.macro.doc.fullName}||queryString="#if ($hasTargetDoc)targetdocname=${escapetool.url($targetdoc.fullName)}&#{end}docname=${escapetool.url($doc.fullName)}&classname=${classname}&property=${property}&object=${object}&savemode=${savemode}&defaultValue=$escapetool.url($defaultValue)&filter=$!{filter}&displayImage=${displayImage}" class="attachment-picker-start button" title="${buttontext}"]](%%)#end
126 + #if ($hasEdit && $targetPermView)
127 + #set ($queryString = {
128 + 'docname': $doc.fullName,
129 + 'classname': $classname,
130 + 'property': $property,
131 + 'object': $object,
132 + 'savemode': $savemode,
133 + 'defaultValue': $defaultValue,
134 + 'filter': $filter,
135 + 'displayImage': $displayImage,
136 + 'versionSummary': $xcontext.macro.params.versionSummary.equals('true')
137 + })
138 + #if ($hasTargetDoc)
139 + #set ($queryString.targetdocname = $targetdoc.fullName)
140 + #end
141 + (% class="buttonwrapper" %)[[$buttontext>>$xcontext.macro.doc.fullName||queryString="$escapetool.url($queryString)"
142 + class="attachment-picker-start button" title="$buttontext"]](%%)##
143 + #end
127 127  #end
128 128  {{/velocity}}
129 129  
Default category
... ... @@ -1,0 +1,1 @@
1 +Development
XWiki.WikiMacroParameterClass[19]
Parameter default value
... ... @@ -1,0 +1,1 @@
1 +false
Parameter description
... ... @@ -1,0 +1,1 @@
1 +Whether to allow the user to enter a version summary that will be recorded in the history. An automatic message is used when no version summary is provided or if the version summary input is not displayed.
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +No
Parameter name
... ... @@ -1,0 +1,1 @@
1 +versionSummary