Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[stable25] Fix regression: Use preview for unsupported images (fix #1408) #1411

Merged
merged 1 commit into from
Oct 13, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified cypress/snapshots/base/visual-regression.cy.js/image-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cypress/snapshots/base/visual-regression.cy.js/image2-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cypress/snapshots/base/visual-regression.cy.js/non-dav-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified cypress/snapshots/base/visual-regression.cy.js/video-base.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions js/viewer-main.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion js/viewer-main.js.map

Large diffs are not rendered by default.

12 changes: 6 additions & 6 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

13 changes: 9 additions & 4 deletions src/components/Images.vue
Original file line number Diff line number Diff line change
Expand Up @@ -100,17 +100,22 @@ export default {

asyncComputed: {
data() {
// Avoid svg xss attack vector
if (this.mime === 'image/svg+xml') {
return this.getBase64FromImage()
}

if (this.source) {
return this.source
}

// Load the raw gif instead of the static preview
if (this.mime === 'image/gif') {
return this.src
}

// If there is no preview and we have a drirect source
// load it instead
if (this.source && !this.hasPreview) {
return this.source
}

return this.previewPath
},
},
Expand Down
8 changes: 1 addition & 7 deletions src/mixins/PreviewUrl.js
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ export default {
previewPath() {
return this.getPreviewIfAny({
fileid: this.fileid,
source: this.source,
filename: this.filename,
hasPreview: this.hasPreview,
davPath: this.davPath,
Expand All @@ -60,17 +59,12 @@ export default {
*
* @param {object} data destructuring object
* @param {string} data.fileid the file id
* @param {?string} data.source the download source
* @param {boolean} data.hasPreview have the file an existing preview ?
* @param {string} data.davPath the absolute dav path
* @param {string} data.filename the file name
* @return {string} the absolute url
*/
getPreviewIfAny({ fileid, source, filename, hasPreview, davPath }) {
if (source) {
return source
}

getPreviewIfAny({ fileid, filename, hasPreview, davPath }) {
const searchParams = `fileId=${fileid}`
+ `&x=${Math.floor(screen.width * devicePixelRatio)}`
+ `&y=${Math.floor(screen.height * devicePixelRatio)}`
Expand Down
32 changes: 23 additions & 9 deletions src/models/images.js
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,37 @@ import Images from '../components/Images.vue'

const enabledPreviewProviders = loadState(appName, 'enabled_preview_providers', [])

const mimes = [
'image/bmp',
/**
* Those mimes needs a proper preview to be displayed
* if they are not enabled on the server, let's not activate them.
*/
const previewSupportedMimes = [
'image/heic',
'image/heif',
'image/tiff',
'image/x-xbitmap',
]

/**
* Those mimes are always supported by the browser
* Since we fallback to the source image if there is no
* preview, we can always include them.
*/
const browserSupportedMimes = [
'image/apng',
'image/bmp',
'image/gif',
'image/jpeg',
'image/png',
'image/tiff',
'image/svg+xml',
'image/webp',
'image/x-xbitmap',
'image/x-icon',
]

// Filter out supported mimes that are _not_
// enabled in the preview API
const filterEnabledMimes = () => {
return mimes.filter(filter => {
return previewSupportedMimes.filter(filter => {
return enabledPreviewProviders.findIndex(mimeRegex => {
// Remove leading and trailing slash from string regex
const regex = new RegExp(mimeRegex.replace(/^\/|\/$/g, ''), 'i')
Expand All @@ -50,7 +66,7 @@ const filterEnabledMimes = () => {
}

const enabledMimes = filterEnabledMimes()
const ignoredMimes = mimes.filter(x => !enabledMimes.includes(x))
const ignoredMimes = previewSupportedMimes.filter(x => !enabledMimes.includes(x))
if (ignoredMimes.length > 0) {
logger.warn('Some mimes were ignored because they are not enabled in the server previews config', { ignoredMimes })
}
Expand All @@ -59,9 +75,7 @@ export default {
id: 'images',
group: 'media',
mimes: [
// Gif and svg images does not rely on previews
'image/gif',
'image/svg+xml',
...browserSupportedMimes,
...enabledMimes,
],
component: Images,
Expand Down