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

[stable29] fix(files): Allow downloading multiple nodes not from same base #49345

Merged
merged 2 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
94 changes: 89 additions & 5 deletions apps/files/src/actions/downloadAction.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,14 @@
*/
import { action } from './downloadAction'
import { expect } from '@jest/globals'
import { File, Folder, Permission, View, FileAction, DefaultType } from '@nextcloud/files'
import {
File,
Folder,
Permission,
View,
FileAction,
DefaultType,
} from '@nextcloud/files'

const view = {
id: 'files',
Expand Down Expand Up @@ -121,7 +128,9 @@ describe('Download action execute tests', () => {
// Silent action
expect(exec).toBe(null)
expect(link.download).toEqual('')
expect(link.href).toEqual('https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt')
expect(link.href).toEqual(
'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
)
expect(link.click).toHaveBeenCalledTimes(1)
})

Expand All @@ -139,7 +148,9 @@ describe('Download action execute tests', () => {
// Silent action
expect(exec).toStrictEqual([null])
expect(link.download).toEqual('')
expect(link.href).toEqual('https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt')
expect(link.href).toEqual(
'https://cloud.domain.com/remote.php/dav/files/admin/foobar.txt',
)
expect(link.click).toHaveBeenCalledTimes(1)
})

Expand All @@ -156,7 +167,11 @@ describe('Download action execute tests', () => {
// Silent action
expect(exec).toBe(null)
expect(link.download).toEqual('')
expect(link.href.startsWith('/index.php/apps/files/ajax/download.php?dir=%2F&files=%5B%22FooBar%22%5D&downloadStartSecret=')).toBe(true)
expect(
link.href.startsWith(
'/index.php/apps/files/ajax/download.php?dir=%2F&files=%5B%22FooBar%22%5D&downloadStartSecret=',
),
).toBe(true)
expect(link.click).toHaveBeenCalledTimes(1)
})

Expand All @@ -181,7 +196,76 @@ describe('Download action execute tests', () => {
// Silent action
expect(exec).toStrictEqual([null, null])
expect(link.download).toEqual('')
expect(link.href.startsWith('/index.php/apps/files/ajax/download.php?dir=%2FDir&files=%5B%22foo.txt%22%2C%22bar.txt%22%5D&downloadStartSecret=')).toBe(true)
expect(link.click).toHaveBeenCalledTimes(1)

expect(link.href).toMatch(
'/index.php/apps/files/ajax/download.php?dir=%2F&files=%5B%22foo.txt%22%2C%22bar.txt%22%5D&downloadStartSecret=',
)
})

test('Download multiple nodes from different sources', async () => {
const files = [
new File({
id: 1,
source: 'https://cloud.domain.com/remote.php/dav/files/admin/Folder 1/foo.txt',
owner: 'admin',
mime: 'text/plain',
permissions: Permission.READ,
}),
new File({
id: 2,
source: 'https://cloud.domain.com/remote.php/dav/files/admin/Folder 2/bar.txt',
owner: 'admin',
mime: 'text/plain',
permissions: Permission.READ,
}),
new File({
id: 3,
source: 'https://cloud.domain.com/remote.php/dav/files/admin/Folder 2/baz.txt',
owner: 'admin',
mime: 'text/plain',
permissions: Permission.READ,
}),
]

const exec = await action.execBatch!(files, view, '/Dir')

// Silent action
expect(exec).toStrictEqual([null, null, null])
expect(link.download).toEqual('')
expect(link.click).toHaveBeenCalledTimes(1)

expect(link.href).toMatch(
'/index.php/apps/files/ajax/download.php?dir=%2F&files=%5B%22foo.txt%22%2C%22bar.txt%22%2C%22baz.txt%22%5D&downloadStartSecret=',
)
})

test('Download node and parent folder', async () => {
const files = [
new File({
id: 1,
source: 'https://cloud.domain.com/remote.php/dav/files/admin/Folder 1/foo.txt',
owner: 'admin',
mime: 'text/plain',
permissions: Permission.READ,
}),
new Folder({
id: 2,
source: 'https://cloud.domain.com/remote.php/dav/files/admin/Folder 1',
owner: 'admin',
permissions: Permission.READ,
}),
]

const exec = await action.execBatch!(files, view, '/Dir')

// Silent action
expect(exec).toStrictEqual([null, null])
expect(link.download).toEqual('')
expect(link.click).toHaveBeenCalledTimes(1)

expect(link.href).toMatch(
'/index.php/apps/files/ajax/download.php?dir=%2F&files=%5B%22foo.txt%22%2C%22Folder%201%22%5D&downloadStartSecret=',
)
})
})
57 changes: 51 additions & 6 deletions apps/files/src/actions/downloadAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,57 @@ const triggerDownload = function(url: string) {
hiddenElement.click()
}

const downloadNodes = function(dir: string, nodes: Node[]) {
/**
* Find the longest common path prefix of both input paths
* @param first The first path
* @param second The second path
*/
function longestCommonPath(first: string, second: string): string {
const firstSegments = first.split('/').filter(Boolean)
const secondSegments = second.split('/').filter(Boolean)
let base = '/'
for (const [index, segment] of firstSegments.entries()) {
if (index >= second.length) {
break
}
if (segment !== secondSegments[index]) {
break
}
const sep = base === '/' ? '' : '/'
base = `${base}${sep}${segment}`
}
return base
}

/**
* Handle downloading multiple nodes
* @param nodes The nodes to download
*/
function downloadNodes(nodes: Node[]): void {
// Remove nodes that are already included in parent folders
// Example: Download A/foo.txt and A will only return A as A/foo.txt is already included
const filteredNodes = nodes.filter((node) => {
const parent = nodes.find((other) => (
other.type === FileType.Folder
&& node.path.startsWith(`${other.path}/`)
))
return parent === undefined
})

let base = filteredNodes[0].dirname
for (const node of filteredNodes.slice(1)) {
base = longestCommonPath(base, node.dirname)
}
base = base || '/'

// Remove the common prefix
const filenames = filteredNodes.map((node) => node.path.slice(base === '/' ? 1 : (base.length + 1)))

const secret = Math.random().toString(36).substring(2)
const url = generateUrl('/apps/files/ajax/download.php?dir={dir}&files={files}&downloadStartSecret={secret}', {
dir,
const url = generateUrl('/apps/files/ajax/download.php?dir={base}&files={files}&downloadStartSecret={secret}', {
base,
secret,
files: JSON.stringify(nodes.map(node => node.basename)),
files: JSON.stringify(filenames),
})
triggerDownload(url)
}
Expand Down Expand Up @@ -83,7 +128,7 @@ export const action = new FileAction({

async exec(node: Node, view: View, dir: string) {
if (node.type === FileType.Folder) {
downloadNodes(dir, [node])
downloadNodes([node])
return null
}

Expand All @@ -97,7 +142,7 @@ export const action = new FileAction({
return [null]
}

downloadNodes(dir, nodes)
downloadNodes(nodes)
return new Array(nodes.length).fill(null)
},

Expand Down
2 changes: 1 addition & 1 deletion apps/files/src/actions/editLocallyAction.spec.ts
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ describe('Edit locally action enabled tests', () => {
describe('Edit locally action execute tests', () => {
test('Edit locally opens proper URL', async () => {
jest.spyOn(axios, 'post').mockImplementation(async () => ({
data: { ocs: { data: { token: 'foobar' } } }
data: { ocs: { data: { token: 'foobar' } } },
}))
const mockedShowError = jest.mocked(showError)
const spyDialogBuilder = jest.spyOn(dialogBuilder, 'build')
Expand Down
2 changes: 1 addition & 1 deletion apps/files/src/actions/sidebarAction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
import { Permission, type Node, View, FileAction, FileType } from '@nextcloud/files'
import { Permission, type Node, View, FileAction } from '@nextcloud/files'
import { translate as t } from '@nextcloud/l10n'
import InformationSvg from '@mdi/svg/svg/information-variant.svg?raw'

Expand Down
Loading