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

[stable24] Use preview for unsupported images #1415

Merged
merged 2 commits into from
Oct 18, 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 added cypress/fixtures/image-apng.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 added cypress/fixtures/image.ico
Binary file not shown.
70 changes: 70 additions & 0 deletions cypress/integration/image-apng.cy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/**
* @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/

import { randHash } from '../utils/'
const randUser = randHash()

describe('Open image-apng.png in viewer', function() {
before(function() {
// Init user
cy.nextcloudCreateUser(randUser, 'password')
cy.login(randUser, 'password')

// Upload test files
cy.uploadFile('image-apng.png', 'image/png')
cy.visit('/apps/files')

// wait a bit for things to be settled
cy.wait(1000)
})
after(function() {
cy.logout()
})

it('See image-apng.png in the list', function() {
cy.get('#fileList tr[data-file="image-apng.png"]', { timeout: 10000 })
.should('contain', 'image-apng.png')
})

it('Open the viewer on file click', function() {
cy.openFile('image-apng.png')
cy.get('body > .viewer').should('be.visible')
})

it('Does not see a loading animation', function() {
cy.get('body > .viewer', { timeout: 10000 })
.should('be.visible')
.and('have.class', 'modal-mask')
.and('not.have.class', 'icon-loading')
})

it('See the menu icon and title on the viewer header', function() {
cy.get('body > .viewer .modal-title').should('contain', 'image-apng.png')
cy.get('body > .viewer .modal-header button.action-item__menutoggle').should('be.visible')
cy.get('body > .viewer .modal-header button.header-close').should('be.visible')
})

it('Does not see navigation arrows', function() {
cy.get('body > .viewer a.prev').should('not.be.visible')
cy.get('body > .viewer a.next').should('not.be.visible')
})
})
70 changes: 70 additions & 0 deletions cypress/integration/image.ico.cy.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
/**
* @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com>
*
* @author John Molakvoæ <skjnldsv@protonmail.com>
*
* @license AGPL-3.0-or-later
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/

import { randHash } from '../utils/'
const randUser = randHash()

describe('Open image.ico in viewer', function() {
before(function() {
// Init user
cy.nextcloudCreateUser(randUser, 'password')
cy.login(randUser, 'password')

// Upload test files
cy.uploadFile('image.ico', 'image/x-icon')
cy.visit('/apps/files')

// wait a bit for things to be settled
cy.wait(1000)
})
after(function() {
cy.logout()
})

it('See image.ico in the list', function() {
cy.get('.files-fileList tr[data-file="image.ico"]', { timeout: 10000 })
.should('contain', 'image.ico')
})

it('Open the viewer on file click', function() {
cy.openFile('image.ico')
cy.get('body > .viewer').should('be.visible')
})

it('Does not see a loading animation', function() {
cy.get('body > .viewer', { timeout: 10000 })
.should('be.visible')
.and('have.class', 'modal-mask')
.and('not.have.class', 'icon-loading')
})

it('See the menu icon and title on the viewer header', function() {
cy.get('body > .viewer .modal-title').should('contain', 'image.ico')
cy.get('body > .viewer .modal-header button.action-item__menutoggle').should('be.visible')
cy.get('body > .viewer .modal-header button.header-close').should('be.visible')
})

it('Does not see navigation arrows', function() {
cy.get('body > .viewer button.prev').should('not.be.visible')
cy.get('body > .viewer button.next').should('not.be.visible')
})
})
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.

13 changes: 8 additions & 5 deletions src/components/Images.vue
Original file line number Diff line number Diff line change
Expand Up @@ -75,14 +75,17 @@ export default {

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

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

return this.previewPath
},
},
watch: {
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