From da435b1e67930e85fc30fd1b94c6214caa086f4f Mon Sep 17 00:00:00 2001 From: Louis Chemineau Date: Wed, 2 Feb 2022 16:10:52 +0100 Subject: Support CRUD share permissions Signed-off-by: Louis Chemineau --- .../src/lib/SharePermissionsToolBox.js | 123 +++++++++++++++++++++ .../src/lib/SharePermissionsToolBox.spec.js | 96 ++++++++++++++++ 2 files changed, 219 insertions(+) create mode 100644 apps/files_sharing/src/lib/SharePermissionsToolBox.js create mode 100644 apps/files_sharing/src/lib/SharePermissionsToolBox.spec.js (limited to 'apps/files_sharing/src/lib') diff --git a/apps/files_sharing/src/lib/SharePermissionsToolBox.js b/apps/files_sharing/src/lib/SharePermissionsToolBox.js new file mode 100644 index 00000000000..f5806df70bf --- /dev/null +++ b/apps/files_sharing/src/lib/SharePermissionsToolBox.js @@ -0,0 +1,123 @@ +/** + * @copyright 2022 Louis Chmn + * + * @author Louis Chmn + * + * @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 . + * + */ + +export const ATOMIC_PERMISSIONS = { + NONE: 0, + READ: 1, + UPDATE: 2, + CREATE: 4, + DELETE: 8, + SHARE: 16, +} + +export const BUNDLED_PERMISSIONS = { + READ_ONLY: ATOMIC_PERMISSIONS.READ, + UPLOAD_AND_UPDATE: ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE, + FILE_DROP: ATOMIC_PERMISSIONS.CREATE, + ALL: ATOMIC_PERMISSIONS.UPDATE | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.DELETE | ATOMIC_PERMISSIONS.SHARE, +} + +/** + * Return whether a given permissions set contains some permissions. + * + * @param {number} initialPermissionSet - the permissions set. + * @param {number} permissionsToCheck - the permissions to check. + * @return {boolean} + */ +export function hasPermissions(initialPermissionSet, permissionsToCheck) { + return initialPermissionSet !== ATOMIC_PERMISSIONS.NONE && (initialPermissionSet & permissionsToCheck) === permissionsToCheck +} + +/** + * Return whether a given permissions set is valid. + * + * @param {number} permissionsSet - the permissions set. + * + * @return {boolean} + */ +export function permissionsSetIsValid(permissionsSet) { + // Must have at least READ or CREATE permission. + if (!hasPermissions(permissionsSet, ATOMIC_PERMISSIONS.READ) && !hasPermissions(permissionsSet, ATOMIC_PERMISSIONS.CREATE)) { + return false + } + + // Must have READ permission if have UPDATE or DELETE. + if (!hasPermissions(permissionsSet, ATOMIC_PERMISSIONS.READ) && ( + hasPermissions(permissionsSet, ATOMIC_PERMISSIONS.UPDATE) || hasPermissions(permissionsSet, ATOMIC_PERMISSIONS.DELETE) + )) { + return false + } + + return true +} + +/** + * Add some permissions to an initial set of permissions. + * + * @param {number} initialPermissionSet - the initial permissions. + * @param {number} permissionsToAdd - the permissions to add. + * + * @return {number} + */ +export function addPermissions(initialPermissionSet, permissionsToAdd) { + return initialPermissionSet | permissionsToAdd +} + +/** + * Remove some permissions from an initial set of permissions. + * + * @param {number} initialPermissionSet - the initial permissions. + * @param {number} permissionsToSubtract - the permissions to remove. + * + * @return {number} + */ +export function subtractPermissions(initialPermissionSet, permissionsToSubtract) { + return initialPermissionSet & ~permissionsToSubtract +} + +/** + * Toggle some permissions from an initial set of permissions. + * + * @param {number} initialPermissionSet - the permissions set. + * @param {number} permissionsToToggle - the permissions to toggle. + * + * @return {number} + */ +export function togglePermissions(initialPermissionSet, permissionsToToggle) { + if (hasPermissions(initialPermissionSet, permissionsToToggle)) { + return subtractPermissions(initialPermissionSet, permissionsToToggle) + } else { + return addPermissions(initialPermissionSet, permissionsToToggle) + } +} + +/** + * Return whether some given permissions can be toggled from a permission set. + * + * @param {number} permissionSet - the initial permissions set. + * @param {number} permissionsToToggle - the permissions to toggle. + * + * @return {boolean} + */ +export function canTogglePermissions(permissionSet, permissionsToToggle) { + return permissionsSetIsValid(togglePermissions(permissionSet, permissionsToToggle)) +} diff --git a/apps/files_sharing/src/lib/SharePermissionsToolBox.spec.js b/apps/files_sharing/src/lib/SharePermissionsToolBox.spec.js new file mode 100644 index 00000000000..7ae29c7134a --- /dev/null +++ b/apps/files_sharing/src/lib/SharePermissionsToolBox.spec.js @@ -0,0 +1,96 @@ +/** + * @copyright 2022 Louis Chmn + * + * @author Louis Chmn + * + * @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 . + * + */ + +import { + ATOMIC_PERMISSIONS, + BUNDLED_PERMISSIONS, + addPermissions, + subtractPermissions, + hasPermissions, + permissionsSetIsValid, + togglePermissions, + canTogglePermissions, +} from '../lib/SharePermissionsToolBox' + +describe('SharePermissionsToolBox', () => { + test('Adding permissions', () => { + expect(addPermissions(ATOMIC_PERMISSIONS.NONE, ATOMIC_PERMISSIONS.NONE)).toBe(ATOMIC_PERMISSIONS.NONE) + expect(addPermissions(ATOMIC_PERMISSIONS.NONE, ATOMIC_PERMISSIONS.READ)).toBe(ATOMIC_PERMISSIONS.READ) + expect(addPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.READ)).toBe(ATOMIC_PERMISSIONS.READ) + expect(addPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.UPDATE)).toBe(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE) + expect(addPermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE | ATOMIC_PERMISSIONS.SHARE)).toBe(BUNDLED_PERMISSIONS.ALL) + expect(addPermissions(BUNDLED_PERMISSIONS.ALL, ATOMIC_PERMISSIONS.READ)).toBe(BUNDLED_PERMISSIONS.ALL) + expect(addPermissions(BUNDLED_PERMISSIONS.ALL, ATOMIC_PERMISSIONS.NONE)).toBe(BUNDLED_PERMISSIONS.ALL) + }) + + test('Subtract permissions', () => { + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.NONE)).toBe(ATOMIC_PERMISSIONS.READ) + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.READ)).toBe(ATOMIC_PERMISSIONS.NONE) + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.UPDATE)).toBe(ATOMIC_PERMISSIONS.READ) + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.UPDATE)).toBe(ATOMIC_PERMISSIONS.READ) + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE)).toBe(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE) + expect(subtractPermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.UPDATE | ATOMIC_PERMISSIONS.DELETE)).toBe(ATOMIC_PERMISSIONS.READ) + expect(subtractPermissions(BUNDLED_PERMISSIONS.ALL, ATOMIC_PERMISSIONS.READ)).toBe(ATOMIC_PERMISSIONS.UPDATE | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE | ATOMIC_PERMISSIONS.SHARE) + }) + + test('Has permissions', () => { + expect(hasPermissions(ATOMIC_PERMISSIONS.NONE, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(hasPermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.NONE)).toBe(true) + expect(hasPermissions(BUNDLED_PERMISSIONS.READ_ONLY, ATOMIC_PERMISSIONS.READ)).toBe(true) + expect(hasPermissions(BUNDLED_PERMISSIONS.READ_ONLY, ATOMIC_PERMISSIONS.UPDATE)).toBe(false) + expect(hasPermissions(BUNDLED_PERMISSIONS.READ_ONLY, ATOMIC_PERMISSIONS.DELETE)).toBe(false) + expect(hasPermissions(BUNDLED_PERMISSIONS.ALL, ATOMIC_PERMISSIONS.DELETE)).toBe(true) + }) + + test('Toggle permissions', () => { + expect(togglePermissions(BUNDLED_PERMISSIONS.ALL, BUNDLED_PERMISSIONS.UPLOAD_AND_UPDATE)).toBe(ATOMIC_PERMISSIONS.SHARE) + expect(togglePermissions(BUNDLED_PERMISSIONS.ALL, BUNDLED_PERMISSIONS.FILE_DROP)).toBe(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE | ATOMIC_PERMISSIONS.DELETE | ATOMIC_PERMISSIONS.SHARE) + expect(togglePermissions(BUNDLED_PERMISSIONS.ALL, ATOMIC_PERMISSIONS.NONE)).toBe(BUNDLED_PERMISSIONS.ALL) + expect(togglePermissions(ATOMIC_PERMISSIONS.NONE, BUNDLED_PERMISSIONS.ALL)).toBe(BUNDLED_PERMISSIONS.ALL) + expect(togglePermissions(ATOMIC_PERMISSIONS.READ, BUNDLED_PERMISSIONS.ALL)).toBe(BUNDLED_PERMISSIONS.ALL) + }) + + test('Permissions set is valid', () => { + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.NONE)).toBe(false) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.READ)).toBe(true) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.CREATE)).toBe(true) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.UPDATE)).toBe(false) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.DELETE)).toBe(false) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE)).toBe(true) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.DELETE)).toBe(true) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.UPDATE)).toBe(false) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE)).toBe(false) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.UPDATE)).toBe(true) + expect(permissionsSetIsValid(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE)).toBe(true) + }) + + test('Toggle permissions', () => { + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.CREATE, ATOMIC_PERMISSIONS.READ)).toBe(true) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.DELETE, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE, ATOMIC_PERMISSIONS.READ)).toBe(false) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.UPDATE, ATOMIC_PERMISSIONS.CREATE)).toBe(true) + expect(canTogglePermissions(ATOMIC_PERMISSIONS.READ | ATOMIC_PERMISSIONS.CREATE | ATOMIC_PERMISSIONS.DELETE, ATOMIC_PERMISSIONS.CREATE)).toBe(true) + }) +}) -- cgit v1.2.3