aboutsummaryrefslogtreecommitdiffstats
path: root/apps/files_versions/src/utils/versions.ts
blob: b52f92ef4621c3b5993d1a8009895c7b88cd5399 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
/* eslint-disable @typescript-eslint/no-explicit-any */
/* eslint-disable jsdoc/require-param */
/* eslint-disable jsdoc/require-jsdoc */
/**
 * SPDX-FileCopyrightText: 2022 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
import type { FileStat, ResponseDataDetailed } from 'webdav'

import { generateRemoteUrl, generateUrl } from '@nextcloud/router'
import { getCurrentUser } from '@nextcloud/auth'
import { joinPaths, encodePath } from '@nextcloud/paths'
import moment from '@nextcloud/moment'

import client from '../utils/davClient.js'
import davRequest from '../utils/davRequest.js'
import logger from '../utils/logger.js'

export interface Version {
	fileId: string, // The id of the file associated to the version.
	label: string, // 'Current version' or ''
	author: string|null, // UID for the author of the version
	filename: string, // File name relative to the version DAV endpoint
	basename: string, // A base name generated from the mtime
	mime: string, // Empty for the current version, else the actual mime type of the version
	etag: string, // Empty for the current version, else the actual mime type of the version
	size: string, // Human readable size
	type: string, // 'file'
	mtime: number, // Version creation date as a timestamp
	permissions: string, // Only readable: 'R'
	hasPreview: boolean, // Whether the version has a preview
	previewUrl: string, // Preview URL of the version
	url: string, // Download URL of the version
	source: string, // The WebDAV endpoint of the ressource
	fileVersion: string|null, // The version id, null for the current version
}

export async function fetchVersions(fileInfo: any): Promise<Version[]> {
	const path = `/versions/${getCurrentUser()?.uid}/versions/${fileInfo.id}`

	try {
		const response = await client.getDirectoryContents(path, {
			data: davRequest,
			details: true,
		}) as ResponseDataDetailed<FileStat[]>

		return response.data
			// Filter out root
			.filter(({ mime }) => mime !== '')
			.map(version => formatVersion(version, fileInfo))
	} catch (exception) {
		logger.error('Could not fetch version', { exception })
		throw exception
	}
}

/**
 * Restore the given version
 */
export async function restoreVersion(version: Version) {
	try {
		logger.debug('Restoring version', { url: version.url })
		await client.moveFile(
			`/versions/${getCurrentUser()?.uid}/versions/${version.fileId}/${version.fileVersion}`,
			`/versions/${getCurrentUser()?.uid}/restore/target`,
		)
	} catch (exception) {
		logger.error('Could not restore version', { exception })
		throw exception
	}
}

/**
 * Format version
 */
function formatVersion(version: any, fileInfo: any): Version {
	const mtime = moment(version.lastmod).unix() * 1000
	let previewUrl = ''

	if (mtime === fileInfo.mtime) { // Version is the current one
		previewUrl = generateUrl('/core/preview?fileId={fileId}&c={fileEtag}&x=250&y=250&forceIcon=0&a=0', {
			fileId: fileInfo.id,
			fileEtag: fileInfo.etag,
		})
	} else {
		previewUrl = generateUrl('/apps/files_versions/preview?file={file}&version={fileVersion}', {
			file: joinPaths(fileInfo.path, fileInfo.name),
			fileVersion: version.basename,
		})
	}

	return {
		fileId: fileInfo.id,
		// If version-label is defined make sure it is a string (prevent issue if the label is a number an PHP returns a number then)
		label: version.props['version-label'] && String(version.props['version-label']),
		author: version.props['version-author'] ?? null,
		filename: version.filename,
		basename: moment(mtime).format('LLL'),
		mime: version.mime,
		etag: `${version.props.getetag}`,
		size: version.size,
		type: version.type,
		mtime,
		permissions: 'R',
		hasPreview: version.props['has-preview'] === 1,
		previewUrl,
		url: joinPaths('/remote.php/dav', version.filename),
		source: generateRemoteUrl('dav') + encodePath(version.filename),
		fileVersion: version.basename,
	}
}

export async function setVersionLabel(version: Version, newLabel: string) {
	return await client.customRequest(
		version.filename,
		{
			method: 'PROPPATCH',
			data: `<?xml version="1.0"?>
					<d:propertyupdate xmlns:d="DAV:"
						xmlns:oc="http://owncloud.org/ns"
						xmlns:nc="http://nextcloud.org/ns"
						xmlns:ocs="http://open-collaboration-services.org/ns">
					<d:set>
						<d:prop>
							<nc:version-label>${newLabel}</nc:version-label>
						</d:prop>
					</d:set>
					</d:propertyupdate>`,
		},
	)
}

export async function deleteVersion(version: Version) {
	await client.deleteFile(version.filename)
}