diff options
Diffstat (limited to 'apps/files_sharing/src/mixins')
-rw-r--r-- | apps/files_sharing/src/mixins/ShareDetails.js | 82 | ||||
-rw-r--r-- | apps/files_sharing/src/mixins/ShareRequests.js | 60 | ||||
-rw-r--r-- | apps/files_sharing/src/mixins/ShareTypes.js | 32 | ||||
-rw-r--r-- | apps/files_sharing/src/mixins/SharesMixin.js | 249 |
4 files changed, 280 insertions, 143 deletions
diff --git a/apps/files_sharing/src/mixins/ShareDetails.js b/apps/files_sharing/src/mixins/ShareDetails.js new file mode 100644 index 00000000000..6ccdf8d63d0 --- /dev/null +++ b/apps/files_sharing/src/mixins/ShareDetails.js @@ -0,0 +1,82 @@ +/** + * SPDX-FileCopyrightText: 2023 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + +import Share from '../models/Share.ts' +import Config from '../services/ConfigService.ts' +import { ATOMIC_PERMISSIONS } from '../lib/SharePermissionsToolBox.js' +import logger from '../services/logger.ts' + +export default { + methods: { + async openSharingDetails(shareRequestObject) { + let share = {} + // handle externalResults from OCA.Sharing.ShareSearch + // TODO : Better name/interface for handler required + // For example `externalAppCreateShareHook` with proper documentation + if (shareRequestObject.handler) { + const handlerInput = {} + if (this.suggestions) { + handlerInput.suggestions = this.suggestions + handlerInput.fileInfo = this.fileInfo + handlerInput.query = this.query + } + const externalShareRequestObject = await shareRequestObject.handler(handlerInput) + share = this.mapShareRequestToShareObject(externalShareRequestObject) + } else { + share = this.mapShareRequestToShareObject(shareRequestObject) + } + + if (this.fileInfo.type !== 'dir') { + const originalPermissions = share.permissions + const strippedPermissions = originalPermissions + & ~ATOMIC_PERMISSIONS.CREATE + & ~ATOMIC_PERMISSIONS.DELETE + + if (originalPermissions !== strippedPermissions) { + logger.debug('Removed create/delete permissions from file share (only valid for folders)') + share.permissions = strippedPermissions + } + } + + const shareDetails = { + fileInfo: this.fileInfo, + share, + } + + this.$emit('open-sharing-details', shareDetails) + }, + openShareDetailsForCustomSettings(share) { + share.setCustomPermissions = true + this.openSharingDetails(share) + }, + mapShareRequestToShareObject(shareRequestObject) { + + if (shareRequestObject.id) { + return shareRequestObject + } + + const share = { + attributes: [ + { + value: true, + key: 'download', + scope: 'permissions', + }, + ], + hideDownload: false, + share_type: shareRequestObject.shareType, + share_with: shareRequestObject.shareWith, + is_no_user: shareRequestObject.isNoUser, + user: shareRequestObject.shareWith, + share_with_displayname: shareRequestObject.displayName, + subtitle: shareRequestObject.subtitle, + permissions: shareRequestObject.permissions ?? new Config().defaultPermissions, + expiration: '', + } + + return new Share(share) + }, + }, +} diff --git a/apps/files_sharing/src/mixins/ShareRequests.js b/apps/files_sharing/src/mixins/ShareRequests.js index 9eaad8c4161..2c33fa3b0c7 100644 --- a/apps/files_sharing/src/mixins/ShareRequests.js +++ b/apps/files_sharing/src/mixins/ShareRequests.js @@ -1,34 +1,17 @@ /** - * @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Joas Schilling <coding@schilljs.com> - * @author John Molakvoæ <skjnldsv@protonmail.com> - * @author Julius Härtl <jus@bitgrid.net> - * - * @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/>. - * + * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ // TODO: remove when ie not supported import 'url-search-params-polyfill' +import { emit } from '@nextcloud/event-bus' +import { showError } from '@nextcloud/dialogs' import { generateOcsUrl } from '@nextcloud/router' import axios from '@nextcloud/axios' -import Share from '../models/Share' + +import Share from '../models/Share.ts' const shareUrl = generateOcsUrl('apps/files_sharing/api/v1/shares') @@ -41,29 +24,32 @@ export default { * @param {string} data.path path to the file/folder which should be shared * @param {number} data.shareType 0 = user; 1 = group; 3 = public link; 6 = federated cloud share * @param {string} data.shareWith user/group id with which the file should be shared (optional for shareType > 1) - * @param {boolean} [data.publicUpload=false] allow public upload to a public shared folder + * @param {boolean} [data.publicUpload] allow public upload to a public shared folder * @param {string} [data.password] password to protect public link Share with - * @param {number} [data.permissions=31] 1 = read; 2 = update; 4 = create; 8 = delete; 16 = share; 31 = all (default: 31, for public shares: 1) - * @param {boolean} [data.sendPasswordByTalk=false] send the password via a talk conversation - * @param {string} [data.expireDate=''] expire the shareautomatically after - * @param {string} [data.label=''] custom label - * @param {string} [data.attributes=null] Share attributes encoded as json + * @param {number} [data.permissions] 1 = read; 2 = update; 4 = create; 8 = delete; 16 = share; 31 = all (default: 31, for public shares: 1) + * @param {boolean} [data.sendPasswordByTalk] send the password via a talk conversation + * @param {string} [data.expireDate] expire the share automatically after + * @param {string} [data.label] custom label + * @param {string} [data.attributes] Share attributes encoded as json + * @param {string} data.note custom note to recipient * @return {Share} the new share * @throws {Error} */ - async createShare({ path, permissions, shareType, shareWith, publicUpload, password, sendPasswordByTalk, expireDate, label, attributes }) { + async createShare({ path, permissions, shareType, shareWith, publicUpload, password, sendPasswordByTalk, expireDate, label, note, attributes }) { try { - const request = await axios.post(shareUrl, { path, permissions, shareType, shareWith, publicUpload, password, sendPasswordByTalk, expireDate, label, attributes }) + const request = await axios.post(shareUrl, { path, permissions, shareType, shareWith, publicUpload, password, sendPasswordByTalk, expireDate, label, note, attributes }) if (!request?.data?.ocs) { throw request } - return new Share(request.data.ocs.data) + const share = new Share(request.data.ocs.data) + emit('files_sharing:share:created', { share }) + return share } catch (error) { console.error('Error while creating share', error) const errorMessage = error?.response?.data?.ocs?.meta?.message - OC.Notification.showTemporary( + showError( errorMessage ? t('files_sharing', 'Error creating the share: {errorMessage}', { errorMessage }) : t('files_sharing', 'Error creating the share'), - { type: 'error' } + { type: 'error' }, ) throw error } @@ -81,13 +67,14 @@ export default { if (!request?.data?.ocs) { throw request } + emit('files_sharing:share:deleted', { id }) return true } catch (error) { console.error('Error while deleting share', error) const errorMessage = error?.response?.data?.ocs?.meta?.message OC.Notification.showTemporary( errorMessage ? t('files_sharing', 'Error deleting the share: {errorMessage}', { errorMessage }) : t('files_sharing', 'Error deleting the share'), - { type: 'error' } + { type: 'error' }, ) throw error } @@ -102,6 +89,7 @@ export default { async updateShare(id, properties) { try { const request = await axios.put(shareUrl + `/${id}`, properties) + emit('files_sharing:share:updated', { id }) if (!request?.data?.ocs) { throw request } else { @@ -113,7 +101,7 @@ export default { const errorMessage = error?.response?.data?.ocs?.meta?.message OC.Notification.showTemporary( errorMessage ? t('files_sharing', 'Error updating the share: {errorMessage}', { errorMessage }) : t('files_sharing', 'Error updating the share'), - { type: 'error' } + { type: 'error' }, ) } const message = error.response.data.ocs.meta.message diff --git a/apps/files_sharing/src/mixins/ShareTypes.js b/apps/files_sharing/src/mixins/ShareTypes.js deleted file mode 100644 index 8b85f63f456..00000000000 --- a/apps/files_sharing/src/mixins/ShareTypes.js +++ /dev/null @@ -1,32 +0,0 @@ -/** - * @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com> - * - * @author John Molakvoæ <skjnldsv@protonmail.com> - * @author Julius Härtl <jus@bitgrid.net> - * - * @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 { Type as ShareTypes } from '@nextcloud/sharing' - -export default { - data() { - return { - SHARE_TYPES: ShareTypes, - } - }, -} diff --git a/apps/files_sharing/src/mixins/SharesMixin.js b/apps/files_sharing/src/mixins/SharesMixin.js index 2a4637be121..a461da56d85 100644 --- a/apps/files_sharing/src/mixins/SharesMixin.js +++ b/apps/files_sharing/src/mixins/SharesMixin.js @@ -1,48 +1,34 @@ /** - * @copyright Copyright (c) 2019 John Molakvoæ <skjnldsv@protonmail.com> - * - * @author Christoph Wurst <christoph@winzerhof-wurst.at> - * @author Daniel Calviño Sánchez <danxuliu@gmail.com> - * @author Gary Kim <gary@garykim.dev> - * @author John Molakvoæ <skjnldsv@protonmail.com> - * @author Julius Härtl <jus@bitgrid.net> - * @author Vincent Petry <vincent@nextcloud.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/>. - * + * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later */ -import { showError, showSuccess } from '@nextcloud/dialogs' import { getCurrentUser } from '@nextcloud/auth' -// eslint-disable-next-line import/no-unresolved, node/no-missing-import +import { showError, showSuccess } from '@nextcloud/dialogs' +import { ShareType } from '@nextcloud/sharing' +import { emit } from '@nextcloud/event-bus' + import PQueue from 'p-queue' import debounce from 'debounce' -import Share from '../models/Share.js' +import GeneratePassword from '../utils/GeneratePassword.ts' +import Share from '../models/Share.ts' import SharesRequests from './ShareRequests.js' -import ShareTypes from './ShareTypes.js' -import Config from '../services/ConfigService.js' +import Config from '../services/ConfigService.ts' +import logger from '../services/logger.ts' + +import { + BUNDLED_PERMISSIONS, +} from '../lib/SharePermissionsToolBox.js' +import { fetchNode } from '../../../files/src/services/WebdavClient.ts' export default { - mixins: [SharesRequests, ShareTypes], + mixins: [SharesRequests], props: { fileInfo: { type: Object, - default: () => {}, + default: () => { }, required: true, }, share: { @@ -58,6 +44,8 @@ export default { data() { return { config: new Config(), + node: null, + ShareType, // errors helpers errors: {}, @@ -80,7 +68,9 @@ export default { }, computed: { - + path() { + return (this.fileInfo.path + '/' + this.fileInfo.name).replace('//', '/') + }, /** * Does the current share have a note * @@ -104,10 +94,10 @@ export default { // Datepicker language lang() { const weekdaysShort = window.dayNamesShort - ? window.dayNamesShort // provided by nextcloud + ? window.dayNamesShort // provided by Nextcloud : ['Sun.', 'Mon.', 'Tue.', 'Wed.', 'Thu.', 'Fri.', 'Sat.'] const monthsShort = window.monthNamesShort - ? window.monthNamesShort // provided by nextcloud + ? window.monthNamesShort // provided by Nextcloud : ['Jan.', 'Feb.', 'Mar.', 'Apr.', 'May.', 'Jun.', 'Jul.', 'Aug.', 'Sep.', 'Oct.', 'Nov.', 'Dec.'] const firstDayOfWeek = window.firstDay ? window.firstDay : 0 @@ -121,15 +111,91 @@ export default { monthFormat: 'MMM', } }, - + isNewShare() { + return !this.share.id + }, + isFolder() { + return this.fileInfo.type === 'dir' + }, + isPublicShare() { + const shareType = this.share.shareType ?? this.share.type + return [ShareType.Link, ShareType.Email].includes(shareType) + }, + isRemoteShare() { + return this.share.type === ShareType.RemoteGroup || this.share.type === ShareType.Remote + }, isShareOwner() { return this.share && this.share.owner === getCurrentUser().uid }, - + isExpiryDateEnforced() { + if (this.isPublicShare) { + return this.config.isDefaultExpireDateEnforced + } + if (this.isRemoteShare) { + return this.config.isDefaultRemoteExpireDateEnforced + } + return this.config.isDefaultInternalExpireDateEnforced + }, + hasCustomPermissions() { + const bundledPermissions = [ + BUNDLED_PERMISSIONS.ALL, + BUNDLED_PERMISSIONS.READ_ONLY, + BUNDLED_PERMISSIONS.FILE_DROP, + ] + return !bundledPermissions.includes(this.share.permissions) + }, + maxExpirationDateEnforced() { + if (this.isExpiryDateEnforced) { + if (this.isPublicShare) { + return this.config.defaultExpirationDate + } + if (this.isRemoteShare) { + return this.config.defaultRemoteExpirationDateString + } + // If it get's here then it must be an internal share + return this.config.defaultInternalExpirationDate + } + return null + }, + /** + * Is the current share password protected ? + * + * @return {boolean} + */ + isPasswordProtected: { + get() { + return this.config.enforcePasswordForPublicLink + || this.share.password !== '' + || this.share.newPassword !== undefined + }, + async set(enabled) { + if (enabled) { + this.$set(this.share, 'newPassword', await GeneratePassword(true)) + } else { + this.share.password = '' + this.$delete(this.share, 'newPassword') + } + }, + }, }, methods: { /** + * Fetch WebDAV node + * + * @return {Node} + */ + async getNode() { + const node = { path: this.path } + try { + this.node = await fetchNode(node.path) + logger.info('Fetched node:', { node: this.node }) + } catch (error) { + logger.error('Error:', error) + } + }, + + /** * Check if a share is valid before * firing the request * @@ -152,19 +218,7 @@ export default { }, /** - * @param {string} date a date with YYYY-MM-DD format - * @return {Date} date - */ - parseDateString(date) { - if (!date) { - return - } - const regex = /([0-9]{4}-[0-9]{2}-[0-9]{2})/i - return new Date(date.match(regex)?.pop()) - }, - - /** - * @param {Date} date + * @param {Date} date the date to format * @return {string} date a date with YYYY-MM-DD format */ formatDateToString(date) { @@ -180,19 +234,13 @@ export default { * @param {Date} date */ onExpirationChange(date) { - this.share.expireDate = this.formatDateToString(date) - this.queueUpdate('expireDate') - }, - - /** - * Uncheck expire date - * We need this method because @update:checked - * is ran simultaneously as @uncheck, so - * so we cannot ensure data is up-to-date - */ - onExpirationDisable() { - this.share.expireDate = '' - this.queueUpdate('expireDate') + if (!date) { + this.share.expireDate = null + this.$set(this.share, 'expireDate', null) + return + } + const parsedDate = (date instanceof Date) ? date : new Date(date) + this.share.expireDate = this.formatDateToString(parsedDate) }, /** @@ -224,12 +272,14 @@ export default { this.loading = true this.open = false await this.deleteShare(this.share.id) - console.debug('Share deleted', this.share.id) + logger.debug('Share deleted', { shareId: this.share.id }) const message = this.share.itemType === 'file' ? t('files_sharing', 'File "{path}" has been unshared', { path: this.share.path }) : t('files_sharing', 'Folder "{path}" has been unshared', { path: this.share.path }) showSuccess(message) this.$emit('remove:share', this.share) + await this.getNode() + emit('files:node:updated', this.node) } catch (error) { // re-open menu if error this.open = true @@ -253,22 +303,30 @@ export default { const properties = {} // force value to string because that is what our // share api controller accepts - propertyNames.forEach(name => { - if ((typeof this.share[name]) === 'object') { + for (const name of propertyNames) { + if (name === 'password') { + properties[name] = this.share.newPassword ?? this.share.password + continue + } + + if (this.share[name] === null || this.share[name] === undefined) { + properties[name] = '' + } else if ((typeof this.share[name]) === 'object') { properties[name] = JSON.stringify(this.share[name]) } else { properties[name] = this.share[name].toString() } - }) + } - this.updateQueue.add(async () => { + return this.updateQueue.add(async () => { this.saving = true this.errors = {} try { const updatedShare = await this.updateShare(this.share.id, properties) - if (propertyNames.indexOf('password') >= 0) { + if (propertyNames.includes('password')) { // reset password state after sync + this.share.password = this.share.newPassword ?? '' this.$delete(this.share, 'newPassword') // updates password expiration time after sync @@ -276,18 +334,27 @@ export default { } // clear any previous errors - this.$delete(this.errors, propertyNames[0]) - showSuccess(t('files_sharing', 'Share {propertyName} saved', { propertyName: propertyNames[0] })) - } catch ({ message }) { + for (const property of propertyNames) { + this.$delete(this.errors, property) + } + showSuccess(this.updateSuccessMessage(propertyNames)) + } catch (error) { + logger.error('Could not update share', { error, share: this.share, propertyNames }) + + const { message } = error if (message && message !== '') { - this.onSyncError(propertyNames[0], message) - showError(t('files_sharing', message)) + for (const property of propertyNames) { + this.onSyncError(property, message) + } + showError(message) + } else { + // We do not have information what happened, but we should still inform the user + showError(t('files_sharing', 'Could not update share')) } } finally { this.saving = false } }) - return } // This share does not exists on the server yet @@ -295,12 +362,45 @@ export default { }, /** + * @param {string[]} names Properties changed + */ + updateSuccessMessage(names) { + if (names.length !== 1) { + return t('files_sharing', 'Share saved') + } + + switch (names[0]) { + case 'expireDate': + return t('files_sharing', 'Share expiry date saved') + case 'hideDownload': + return t('files_sharing', 'Share hide-download state saved') + case 'label': + return t('files_sharing', 'Share label saved') + case 'note': + return t('files_sharing', 'Share note for recipient saved') + case 'password': + return t('files_sharing', 'Share password saved') + case 'permissions': + return t('files_sharing', 'Share permissions saved') + default: + return t('files_sharing', 'Share saved') + } + }, + + /** * Manage sync errors * * @param {string} property the errored property, e.g. 'password' * @param {string} message the error message */ onSyncError(property, message) { + if (property === 'password' && this.share.newPassword) { + if (this.share.newPassword === this.share.password) { + this.share.password = '' + } + this.$delete(this.share, 'newPassword') + } + // re-open menu if closed this.open = true switch (property) { @@ -335,7 +435,6 @@ export default { } } }, - /** * Debounce queueUpdate to avoid requests spamming * more importantly for text data |