Channel Bookmarks (#25449)

* create ChannelBookmarks table * ChannelBookmark model * channel bookamrks Store layer * add GetBookmarksForAllChannelByIdSince * add channel bookmarks to test store * Add channel bookmarks to app layer * remove index for createAt in channel bookmarks migrations * remove createAt from select channel bookmark query and enable store delete bookmark test * update reponse of UpdateBookmark * rename db migration files * channel bookmarks store update sort order * channel bookmarks app layer update sort order * fix lint & tests * Fix lint and introduce util functions to insert / remove from slice * remove model etag * i18n * defer remove file info after test run * Fix tests passing the request context * fix migrations * fix TestRetry * Add bookmark permissions (#25560) * Adds channel bookmarks permissions * Fix linter * Remove unnecessary empty lines * Remove scss change as it's not necessary anymore * Fix mock store * Fix mock store and add role entry * Fix test * Adds cypress test and update permissions migration to update admin roles * Adds channel bookmarks roles to default admin roles * Adds bookmark permissions to default role permissions constant in webapp * Update mmctl test * Update permission test after normalising the roles * fix store tests * fix app layer tests * Add new bookmark endpoint (#25624) * Adds channel bookmarks api scaffold and create endpoint * Applies review comments to the API docs * Adds websocket test to create channel bookmark --------- Co-authored-by: Mattermost Build <build@mattermost.com> * MM-54426 exclude Channel Bookmarks files from data retention (#25656) * Augment channel APIs to include bookmarks (#25567) * update files docs for server 9.4 * Adds update channel bookmark endpoint (#25653) * Adds update channel bookmark sort order endpoint (#25686) * Adds update channel bookmark endpoint * Updates edit app method to return the right deleted bookmark and adds tests * Adds the update channel bookmark sort order endpoint * Fix repeated test after merge * Assign right permissions to each test * Update store and app layer to return specific errors and add tests * Adds delete channel bookmark endpoint (#25693) * Updates edit app method to return the right deleted bookmark and adds tests * Fix repeated test after merge * Updates edit app method to return the right deleted bookmark and adds tests * Adds delete channel bookmark endpoint * Adds list channel bookmarks endpoint (#25700) * Add channel moderation to bookmarks (#25716) * fix migrations index * fix getChannelsForTeamForUser * fix getChannelsForTeamForUser * fix bad merge client4 * fix file api with bookmark permission * add ChannelBookmarks feature flag * add missing translations * Set DB column for type as enum * use custom type for bookmark query using sqlx * use transaction when saving bookmark * return NewErrNotFound instead of Sql.ErrNoRows * use squirrel for IN query * add a limit of 1K for records in GetBookmarksForAllChannelByIdSince * UpdateSortOrder with one single query instead of multiple updates * fix shadow declaration * fix channel bookmarks permission string definition in admin console * fix another shadow declaration * Fix model conversion * add SplitSliceInChunks * remove include bookmarks in channels api * Cap amount of bookmarks per channel * add etag back to get channels * feedback review * update file info when replacing a bookmark file * return 501 not implemented when the license is not available * add detail message when getting channel member on bookmark api * start audit before permission check on create bookmark api * use require.Eventuallyf for testing WS events * remove unnecessary log in app layer * use require instead of assert to avoid panics * enforce limit when querying bookmarks since * prevent to create/update bookmark if file is already attached * fix lint * delete file when a bookmark is deleted * Dot allow to set a fileId and a url at the same time to a bookmark * fix query to delete a file that belongs to a bookmark * do not patch the bookmark type * Server side FeatureFlag check (#26145) * use ff in server, set ff to false * turn on FF for unit tests * defer unset FF for unit tests * turn ff on for testing * only allow attaching files that were uploaded for bookmark * Set feature flag off as default * fix lint * update email templates as PR failed * revert templates * force the assignment of ID when creating a bookmark * Fix unit tests --------- Co-authored-by: Miguel de la Cruz <miguel@mcrx.me> Co-authored-by: Mattermost Build <build@mattermost.com> Co-authored-by: Caleb Roseland <caleb@calebroseland.com> Co-authored-by: Scott Bishel <scott.bishel@mattermost.com>
2024-03-12 22:36:05 +08:00
--- a/webapp/channels/src/components/admin_console/permission_schemes_settings/permissions_tree/permissions_tree.tsx
+++ b/webapp/channels/src/components/admin_console/permission_schemes_settings/permissions_tree/permissions_tree.tsx
@@ -208,6 +208,8 @@ export default class PermissionsTree extends React.PureComponent<Props, State> {
        const {config, scope, license} = this.props;

        const teamsGroup = this.groups[0];
+        const publicChannelsGroup = this.groups[1];
+        const privateChannelsGroup = this.groups[2];
        const postsGroup = this.groups[7];
        const integrationsGroup = this.groups[8];
        const sharedChannelsGroup = this.groups[9];
@@ -257,6 +259,29 @@ export default class PermissionsTree extends React.PureComponent<Props, State> {
            customGroupsGroup?.permissions.pop();
        }

+        if (license?.IsLicensed === 'true') {
+            publicChannelsGroup.permissions.push({
+                id: 'manage_public_channel_bookmarks',
+                combined: true,
+                permissions: [
+                    Permissions.ADD_BOOKMARK_PUBLIC_CHANNEL,
+                    Permissions.EDIT_BOOKMARK_PUBLIC_CHANNEL,
+                    Permissions.DELETE_BOOKMARK_PUBLIC_CHANNEL,
+                    Permissions.ORDER_BOOKMARK_PUBLIC_CHANNEL,
+                ],
+            });
+            privateChannelsGroup.permissions.push({
+                id: 'manage_private_channel_bookmarks',
+                combined: true,
+                permissions: [
+                    Permissions.ADD_BOOKMARK_PRIVATE_CHANNEL,
+                    Permissions.EDIT_BOOKMARK_PRIVATE_CHANNEL,
+                    Permissions.DELETE_BOOKMARK_PRIVATE_CHANNEL,
+                    Permissions.ORDER_BOOKMARK_PRIVATE_CHANNEL,
+                ],
+            });
+        }
+
        this.groups = this.groups.filter((group) => {
            if (group.isVisible) {
                return group.isVisible(this.props.license);
--- a/webapp/channels/src/components/admin_console/permission_schemes_settings/strings/groups.tsx
+++ b/webapp/channels/src/components/admin_console/permission_schemes_settings/strings/groups.tsx
@@ -255,4 +255,24 @@ export const groupRolesStrings: Record<string, Record<string, MessageDescriptor>
            defaultMessage: 'Create, edit, delete and manage the members of custom groups.',
        },
    }),
+    manage_public_channel_bookmarks: defineMessages({
+        name: {
+            id: 'admin.permissions.group.manage_public_channel_bookmarks.name',
+            defaultMessage: 'Manage Bookmarks',
+        },
+        description: {
+            id: 'admin.permissions.group.manage_public_channel_bookmarks.description',
+            defaultMessage: 'Add, edit, delete and sort bookmarks',
+        },
+    }),
+    manage_private_channel_bookmarks: defineMessages({
+        name: {
+            id: 'admin.permissions.group.manage_private_channel_bookmarks.name',
+            defaultMessage: 'Manage Bookmarks',
+        },
+        description: {
+            id: 'admin.permissions.group.manage_private_channel_bookmarks.description',
+            defaultMessage: 'Add, edit, delete and sort bookmarks',
+        },
+    }),
 };
--- a/webapp/channels/src/components/admin_console/team_channel_settings/channel/details/channel_moderation.tsx
+++ b/webapp/channels/src/components/admin_console/team_channel_settings/channel/details/channel_moderation.tsx
@@ -27,6 +27,8 @@ const MEMBERS_CAN_MANAGE_CHANNEL_MEMBERS_PERMISSION = 'manage_{public_or_private
 const GUESTS_CAN_MANAGE_CHANNEL_MEMBERS_PERMISSION = 'guest_manage_{public_or_private}_channel_members';
 const MEMBERS_CAN_USE_CHANNEL_MENTIONS_PERMISSION = 'use_channel_mentions';
 const GUESTS_CAN_USE_CHANNEL_MENTIONS_PERMISSION = 'guest_use_channel_mentions';
+const MEMBERS_CAN_MANAGE_CHANNEL_BOOKMARKS_PERMISSION = 'manage_{public_or_private}_channel_bookmarks';
+const GUESTS_CAN_MANAGE_CHANNEL_BOOKMARKS_PERMISSION = 'guest_manage_{public_or_private}_channel_bookmarks';

 function getChannelModerationPermissionNames(permission: string) {
    if (permission === Permissions.CHANNEL_MODERATED_PERMISSIONS.CREATE_POST) {
@@ -61,6 +63,14 @@ function getChannelModerationPermissionNames(permission: string) {
        };
    }

+    if (permission === Permissions.CHANNEL_MODERATED_PERMISSIONS.MANAGE_BOOKMARKS) {
+        return {
+            disabledGuests: GUESTS_CAN_MANAGE_CHANNEL_BOOKMARKS_PERMISSION,
+            disabledMembers: MEMBERS_CAN_MANAGE_CHANNEL_BOOKMARKS_PERMISSION,
+            disabledBoth: MEMBERS_CAN_MANAGE_CHANNEL_BOOKMARKS_PERMISSION,
+        };
+    }
+
    return null;
 }

@@ -181,6 +191,29 @@ function getChannelModerationRowsMessages(permission: string): Record<string, Me
        },
    });

+    const manageBookmarksRowMessages = defineMessages({
+        title: {
+            id: 'admin.channel_settings.channel_moderation.manageBookmarks',
+            defaultMessage: 'Manage Bookmarks',
+        },
+        description: {
+            id: 'admin.channel_settings.channel_moderation.manageBookmarksDesc',
+            defaultMessage: 'The ability for members and guests to add, delete and sort bookmarks.',
+        },
+        disabledGuests: {
+            id: 'admin.channel_settings.channel_moderation.manageBookmarks.disabledGuest',
+            defaultMessage: 'Manage bookmarks for guests are disabled in [{scheme_name}](../permissions/{scheme_link}).',
+        },
+        disabledMembers: {
+            id: 'admin.channel_settings.channel_moderation.manageBookmarks.disabledMember',
+            defaultMessage: 'Manage bookmarks for members are disabled in [{scheme_name}](../permissions/{scheme_link}).',
+        },
+        disabledBoth: {
+            id: 'admin.channel_settings.channel_moderation.manageBookmarks.disabledBoth',
+            defaultMessage: 'Manage bookmarks for members and guests are disabled in [{scheme_name}](../permissions/{scheme_link}).',
+        },
+    });
+
    if (permission === Permissions.CHANNEL_MODERATED_PERMISSIONS.CREATE_POST) {
        return createPostRowMessages;
    }
@@ -197,6 +230,10 @@ function getChannelModerationRowsMessages(permission: string): Record<string, Me
        return channelMentionsRowMessages;
    }

+    if (permission === Permissions.CHANNEL_MODERATED_PERMISSIONS.MANAGE_BOOKMARKS) {
+        return manageBookmarksRowMessages;
+    }
+
    return null;
 }

--- a/webapp/channels/src/i18n/en.json
+++ b/webapp/channels/src/i18n/en.json
@@ -543,6 +543,11 @@
  "admin.channel_settings.channel_moderation.createPostsDesc": "The ability for members and guests to create posts in the channel.",
  "admin.channel_settings.channel_moderation.createPostsDescMembers": "The ability for members to create posts in the channel.",
  "admin.channel_settings.channel_moderation.guests": "Guests",
+  "admin.channel_settings.channel_moderation.manageBookmarks": "Manage Bookmarks",
+  "admin.channel_settings.channel_moderation.manageBookmarks.disabledBoth": "Manage bookmarks for members and guests are disabled in [{scheme_name}](../permissions/{scheme_link}).",
+  "admin.channel_settings.channel_moderation.manageBookmarks.disabledGuest": "Manage bookmarks for guests are disabled in [{scheme_name}](../permissions/{scheme_link}).",
+  "admin.channel_settings.channel_moderation.manageBookmarks.disabledMember": "Manage bookmarks for members are disabled in [{scheme_name}](../permissions/{scheme_link}).",
+  "admin.channel_settings.channel_moderation.manageBookmarksDesc": "The ability for members and guests to add, delete and sort bookmarks.",
  "admin.channel_settings.channel_moderation.manageMembers": "Manage Members",
  "admin.channel_settings.channel_moderation.manageMembers.disabledBoth": "Manage members for members and guests are disabled in [{scheme_name}](../permissions/{scheme_link}).",
  "admin.channel_settings.channel_moderation.manageMembers.disabledGuest": "Manage members for guests are disabled in [{scheme_name}](../permissions/{scheme_link}).",
@@ -1629,8 +1634,12 @@
  "admin.permissions.group.guest_use_group_mentions.name": "Group Mentions",
  "admin.permissions.group.integrations.description": "Manage OAuth 2.0, slash commands, webhooks and emoji.",
  "admin.permissions.group.integrations.name": "Integrations & Customizations",
+  "admin.permissions.group.manage_private_channel_bookmarks.description": "Add, edit, delete and sort bookmarks",
+  "admin.permissions.group.manage_private_channel_bookmarks.name": "Manage Bookmarks",
  "admin.permissions.group.manage_private_channel_members_and_read_groups.description": "Add and remove private channel members.",
  "admin.permissions.group.manage_private_channel_members_and_read_groups.name": "Manage Channel Members",
+  "admin.permissions.group.manage_public_channel_bookmarks.description": "Add, edit, delete and sort bookmarks",
+  "admin.permissions.group.manage_public_channel_bookmarks.name": "Manage Bookmarks",
  "admin.permissions.group.manage_public_channel_members_and_read_groups.description": "Add and remove public channel members.",
  "admin.permissions.group.manage_public_channel_members_and_read_groups.name": "Manage Channel Members",
  "admin.permissions.group.manage_shared_channels.description": "Manage Shared Channels",
--- a/webapp/channels/src/packages/mattermost-redux/src/constants/permissions.ts
+++ b/webapp/channels/src/packages/mattermost-redux/src/constants/permissions.ts
@@ -247,6 +247,7 @@ const values = {
        CREATE_REACTIONS: 'create_reactions',
        MANAGE_MEMBERS: 'manage_members',
        USE_CHANNEL_MENTIONS: 'use_channel_mentions',
+        MANAGE_BOOKMARKS: 'manage_bookmarks',
    },
    MANAGE_BOTS: 'manage_bots',
    MANAGE_OTHERS_BOTS: 'manage_others_bots',
@@ -260,6 +261,15 @@ const values = {
    EDIT_CUSTOM_GROUP: 'edit_custom_group',
    DELETE_CUSTOM_GROUP: 'delete_custom_group',
    RESTORE_CUSTOM_GROUP: 'restore_custom_group',
+
+    ADD_BOOKMARK_PUBLIC_CHANNEL: 'add_bookmark_public_channel',
+    EDIT_BOOKMARK_PUBLIC_CHANNEL: 'edit_bookmark_public_channel',
+    DELETE_BOOKMARK_PUBLIC_CHANNEL: 'delete_bookmark_public_channel',
+    ORDER_BOOKMARK_PUBLIC_CHANNEL: 'order_bookmark_public_channel',
+    ADD_BOOKMARK_PRIVATE_CHANNEL: 'add_bookmark_private_channel',
+    EDIT_BOOKMARK_PRIVATE_CHANNEL: 'edit_bookmark_private_channel',
+    DELETE_BOOKMARK_PRIVATE_CHANNEL: 'delete_bookmark_private_channel',
+    ORDER_BOOKMARK_PRIVATE_CHANNEL: 'order_bookmark_private_channel',
 };

 values.SYSCONSOLE_READ_PERMISSIONS = [
--- a/webapp/channels/src/utils/constants.tsx
+++ b/webapp/channels/src/utils/constants.tsx
@@ -1216,6 +1216,14 @@ export const PermissionsScope = {
    [Permissions.RESTORE_CUSTOM_GROUP]: 'system_scope',
    [Permissions.MANAGE_CUSTOM_GROUP_MEMBERS]: 'system_scope',
    [Permissions.USE_SLASH_COMMANDS]: 'channel_scope',
+    [Permissions.ADD_BOOKMARK_PUBLIC_CHANNEL]: 'channel_scope',
+    [Permissions.EDIT_BOOKMARK_PUBLIC_CHANNEL]: 'channel_scope',
+    [Permissions.DELETE_BOOKMARK_PUBLIC_CHANNEL]: 'channel_scope',
+    [Permissions.ORDER_BOOKMARK_PUBLIC_CHANNEL]: 'channel_scope',
+    [Permissions.ADD_BOOKMARK_PRIVATE_CHANNEL]: 'channel_scope',
+    [Permissions.EDIT_BOOKMARK_PRIVATE_CHANNEL]: 'channel_scope',
+    [Permissions.DELETE_BOOKMARK_PRIVATE_CHANNEL]: 'channel_scope',
+    [Permissions.ORDER_BOOKMARK_PRIVATE_CHANNEL]: 'channel_scope',
 };

 export const DefaultRolePermissions = {
@@ -1267,6 +1275,14 @@ export const DefaultRolePermissions = {
        Permissions.CREATE_EMOJIS,
        Permissions.RUN_VIEW,
        Permissions.RESTORE_CUSTOM_GROUP,
+        Permissions.ADD_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ADD_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PRIVATE_CHANNEL,
    ],
    channel_admin: [
        Permissions.MANAGE_CHANNEL_ROLES,
@@ -1279,6 +1295,14 @@ export const DefaultRolePermissions = {
        Permissions.MANAGE_PRIVATE_CHANNEL_MEMBERS,
        Permissions.USE_CHANNEL_MENTIONS,
        Permissions.USE_GROUP_MENTIONS,
+        Permissions.ADD_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ADD_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PRIVATE_CHANNEL,
    ],
    team_admin: [
        Permissions.EDIT_OTHERS_POSTS,
@@ -1306,6 +1330,14 @@ export const DefaultRolePermissions = {
        Permissions.CREATE_POST,
        Permissions.REMOVE_REACTION,
        Permissions.USE_GROUP_MENTIONS,
+        Permissions.ADD_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PUBLIC_CHANNEL,
+        Permissions.ADD_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.EDIT_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.DELETE_BOOKMARK_PRIVATE_CHANNEL,
+        Permissions.ORDER_BOOKMARK_PRIVATE_CHANNEL,
    ],
    guests: [
        Permissions.EDIT_POST,