aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/helpers/permissions.ts
blob: d49dd1e428eea010b2c5d472016b78060e9d8334 (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
/*
 * SonarQube
 * Copyright (C) 2009-2023 SonarSource SA
 * mailto:info AT sonarsource DOT com
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 */
import { Permissions } from '../types/permissions';
import { Dict, PermissionDefinition, PermissionDefinitionGroup } from '../types/types';
import { translate } from './l10n';

export const PERMISSIONS_ORDER_FOR_PROJECT_TEMPLATE = [
  Permissions.Browse,
  Permissions.CodeViewer,
  Permissions.IssueAdmin,
  Permissions.SecurityHotspotAdmin,
  Permissions.Admin,
  Permissions.Scan,
];

export const PERMISSIONS_ORDER_GLOBAL = [
  Permissions.Admin,
  {
    category: 'administer',
    permissions: [Permissions.QualityGateAdmin, Permissions.QualityProfileAdmin],
  },
  Permissions.Scan,
  {
    category: 'creator',
    permissions: [
      Permissions.ProjectCreation,
      Permissions.ApplicationCreation,
      Permissions.PortfolioCreation,
    ],
  },
];

export const PERMISSIONS_ORDER_FOR_VIEW = [Permissions.Browse, Permissions.Admin];

export const PERMISSIONS_ORDER_BY_QUALIFIER: Dict<string[]> = {
  TRK: PERMISSIONS_ORDER_FOR_PROJECT_TEMPLATE,
  VW: PERMISSIONS_ORDER_FOR_VIEW,
  SVW: PERMISSIONS_ORDER_FOR_VIEW,
  APP: PERMISSIONS_ORDER_FOR_VIEW,
};

function convertToPermissionDefinition(permission: string, l10nPrefix: string) {
  const name = translate(`${l10nPrefix}.${permission}`);
  const description = translate(`${l10nPrefix}.${permission}.desc`);

  return {
    key: permission,
    name,
    description,
  };
}

export function filterPermissions(
  permissions: Array<Permissions | { category: string; permissions: Permissions[] }>,
  hasApplicationsEnabled: boolean,
  hasPortfoliosEnabled: boolean,
) {
  return permissions.map((permission) => {
    if (typeof permission === 'object' && permission.category === 'creator') {
      return {
        ...permission,
        permissions: permission.permissions.filter((p) => {
          return (
            p === Permissions.ProjectCreation ||
            (p === Permissions.PortfolioCreation && hasPortfoliosEnabled) ||
            (p === Permissions.ApplicationCreation && hasApplicationsEnabled)
          );
        }),
      };
    }
    return permission;
  });
}

export function convertToPermissionDefinitions(
  permissions: Array<string | { category: string; permissions: string[] }>,
  l10nPrefix: string,
): Array<PermissionDefinition | PermissionDefinitionGroup> {
  return permissions.map((permission) => {
    if (typeof permission === 'object') {
      return {
        category: permission.category,
        permissions: permission.permissions.map((permission) =>
          convertToPermissionDefinition(permission, l10nPrefix),
        ),
      };
    }
    return convertToPermissionDefinition(permission, l10nPrefix);
  });
}

export function isPermissionDefinitionGroup(
  permission?: PermissionDefinition | PermissionDefinitionGroup,
): permission is PermissionDefinitionGroup {
  return Boolean(permission && (permission as PermissionDefinitionGroup).category);
}