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 | 112 | ||||
| -rw-r--r-- | apps/files_sharing/src/mixins/SharesMixin.js | 448 |
3 files changed, 642 insertions, 0 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 new file mode 100644 index 00000000000..2c33fa3b0c7 --- /dev/null +++ b/apps/files_sharing/src/mixins/ShareRequests.js @@ -0,0 +1,112 @@ +/** + * 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.ts' + +const shareUrl = generateOcsUrl('apps/files_sharing/api/v1/shares') + +export default { + methods: { + /** + * Create a new share + * + * @param {object} data destructuring object + * @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] allow public upload to a public shared folder + * @param {string} [data.password] password to protect public link Share with + * @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, note, attributes }) { + try { + const request = await axios.post(shareUrl, { path, permissions, shareType, shareWith, publicUpload, password, sendPasswordByTalk, expireDate, label, note, attributes }) + if (!request?.data?.ocs) { + throw request + } + 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 + showError( + errorMessage ? t('files_sharing', 'Error creating the share: {errorMessage}', { errorMessage }) : t('files_sharing', 'Error creating the share'), + { type: 'error' }, + ) + throw error + } + }, + + /** + * Delete a share + * + * @param {number} id share id + * @throws {Error} + */ + async deleteShare(id) { + try { + const request = await axios.delete(shareUrl + `/${id}`) + 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' }, + ) + throw error + } + }, + + /** + * Update a share + * + * @param {number} id share id + * @param {object} properties key-value object of the properties to update + */ + 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 { + return request.data.ocs.data + } + } catch (error) { + console.error('Error while updating share', error) + if (error.response.status !== 400) { + 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' }, + ) + } + const message = error.response.data.ocs.meta.message + throw new Error(message) + } + }, + }, +} diff --git a/apps/files_sharing/src/mixins/SharesMixin.js b/apps/files_sharing/src/mixins/SharesMixin.js new file mode 100644 index 00000000000..a461da56d85 --- /dev/null +++ b/apps/files_sharing/src/mixins/SharesMixin.js @@ -0,0 +1,448 @@ +/** + * SPDX-FileCopyrightText: 2019 Nextcloud GmbH and Nextcloud contributors + * SPDX-License-Identifier: AGPL-3.0-or-later + */ + +import { getCurrentUser } from '@nextcloud/auth' +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 GeneratePassword from '../utils/GeneratePassword.ts' +import Share from '../models/Share.ts' +import SharesRequests from './ShareRequests.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], + + props: { + fileInfo: { + type: Object, + default: () => { }, + required: true, + }, + share: { + type: Share, + default: null, + }, + isUnique: { + type: Boolean, + default: true, + }, + }, + + data() { + return { + config: new Config(), + node: null, + ShareType, + + // errors helpers + errors: {}, + + // component status toggles + loading: false, + saving: false, + open: false, + + // concurrency management queue + // we want one queue per share + updateQueue: new PQueue({ concurrency: 1 }), + + /** + * ! This allow vue to make the Share class state reactive + * ! do not remove it ot you'll lose all reactivity here + */ + reactiveState: this.share?.state, + } + }, + + computed: { + path() { + return (this.fileInfo.path + '/' + this.fileInfo.name).replace('//', '/') + }, + /** + * Does the current share have a note + * + * @return {boolean} + */ + hasNote: { + get() { + return this.share.note !== '' + }, + set(enabled) { + this.share.note = enabled + ? null // enabled but user did not changed the content yet + : '' // empty = no note = disabled + }, + }, + + dateTomorrow() { + return new Date(new Date().setDate(new Date().getDate() + 1)) + }, + + // Datepicker language + lang() { + const weekdaysShort = window.dayNamesShort + ? window.dayNamesShort // provided by Nextcloud + : ['Sun.', 'Mon.', 'Tue.', 'Wed.', 'Thu.', 'Fri.', 'Sat.'] + const monthsShort = window.monthNamesShort + ? window.monthNamesShort // provided by Nextcloud + : ['Jan.', 'Feb.', 'Mar.', 'Apr.', 'May.', 'Jun.', 'Jul.', 'Aug.', 'Sep.', 'Oct.', 'Nov.', 'Dec.'] + const firstDayOfWeek = window.firstDay ? window.firstDay : 0 + + return { + formatLocale: { + firstDayOfWeek, + monthsShort, + weekdaysMin: weekdaysShort, + weekdaysShort, + }, + 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 + * + * @param {Share} share the share to check + * @return {boolean} + */ + checkShare(share) { + if (share.password) { + if (typeof share.password !== 'string' || share.password.trim() === '') { + return false + } + } + if (share.expirationDate) { + const date = share.expirationDate + if (!date.isValid()) { + return false + } + } + return true + }, + + /** + * @param {Date} date the date to format + * @return {string} date a date with YYYY-MM-DD format + */ + formatDateToString(date) { + // Force utc time. Drop time information to be timezone-less + const utcDate = new Date(Date.UTC(date.getFullYear(), date.getMonth(), date.getDate())) + // Format to YYYY-MM-DD + return utcDate.toISOString().split('T')[0] + }, + + /** + * Save given value to expireDate and trigger queueUpdate + * + * @param {Date} date + */ + onExpirationChange(date) { + 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) + }, + + /** + * Note changed, let's save it to a different key + * + * @param {string} note the share note + */ + onNoteChange(note) { + this.$set(this.share, 'newNote', note.trim()) + }, + + /** + * When the note change, we trim, save and dispatch + * + */ + onNoteSubmit() { + if (this.share.newNote) { + this.share.note = this.share.newNote + this.$delete(this.share, 'newNote') + this.queueUpdate('note') + } + }, + + /** + * Delete share button handler + */ + async onDelete() { + try { + this.loading = true + this.open = false + await this.deleteShare(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 + } finally { + this.loading = false + } + }, + + /** + * Send an update of the share to the queue + * + * @param {Array<string>} propertyNames the properties to sync + */ + queueUpdate(...propertyNames) { + if (propertyNames.length === 0) { + // Nothing to update + return + } + + if (this.share.id) { + const properties = {} + // force value to string because that is what our + // share api controller accepts + 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() + } + } + + return this.updateQueue.add(async () => { + this.saving = true + this.errors = {} + try { + const updatedShare = await this.updateShare(this.share.id, properties) + + 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 + this.share.passwordExpirationTime = updatedShare.password_expiration_time + } + + // clear any previous errors + 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 !== '') { + 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 + } + }) + } + + // This share does not exists on the server yet + console.debug('Updated local share', this.share) + }, + + /** + * @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) { + case 'password': + case 'pending': + case 'expireDate': + case 'label': + case 'note': { + // show error + this.$set(this.errors, property, message) + + let propertyEl = this.$refs[property] + if (propertyEl) { + if (propertyEl.$el) { + propertyEl = propertyEl.$el + } + // focus if there is a focusable action element + const focusable = propertyEl.querySelector('.focusable') + if (focusable) { + focusable.focus() + } + } + break + } + case 'sendPasswordByTalk': { + // show error + this.$set(this.errors, property, message) + + // Restore previous state + this.share.sendPasswordByTalk = !this.share.sendPasswordByTalk + break + } + } + }, + /** + * Debounce queueUpdate to avoid requests spamming + * more importantly for text data + * + * @param {string} property the property to sync + */ + debounceQueueUpdate: debounce(function(property) { + this.queueUpdate(property) + }, 500), + }, +} |