aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/helpers/urls.js
blob: 96f2603970122ee16986d5dbbcb1f667a5501856 (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
/*
 * SonarQube
 * Copyright (C) 2009-2016 SonarSource SA
 * mailto:contact 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.
 */
/**
 * Generate URL for a component's home page
 * @param {string} componentKey
 * @returns {string}
 */
export function getComponentUrl (componentKey) {
  return '/dashboard?id=' + encodeURIComponent(componentKey);
}


/**
 * Generate URL for a component's issues page
 * @param {string} componentKey
 * @param {object} query
 * @returns {string}
 */
export function getComponentIssuesUrl (componentKey, query) {
  const serializedQuery = Object.keys(query).map(criterion => {
    return `${encodeURIComponent(criterion)}=${encodeURIComponent(query[criterion])}`;
  }).join('|');
  return '/component_issues?id=' + encodeURIComponent(componentKey) + '#' + serializedQuery;
}


/**
 * Generate URL for a component's drilldown page
 * @param {string} componentKey
 * @param {string} metric
 * @param {string|number} [period]
 * @param {string} [highlightedMetric]
 * @returns {string}
 */
export function getComponentDrilldownUrl (componentKey, metric, period, highlightedMetric) {
  let url = '/drilldown/measures?id=' + encodeURIComponent(componentKey) +
      '&metric=' + encodeURIComponent(metric);
  if (period) {
    url += '&period=' + period;
  }
  if (highlightedMetric) {
    url += '&highlight=' + encodeURIComponent(highlightedMetric);
  }
  return url;
}


/**
 * Generate URL for a component's dashboard
 * @param {string} componentKey
 * @param {string} dashboardKey
 * @param {string} [period]
 * @returns {string}
 */
export function getComponentDashboardUrl (componentKey, dashboardKey, period) {
  let url = '/dashboard?id=' + encodeURIComponent(componentKey) +
      '&did=' + encodeURIComponent(dashboardKey);
  if (period) {
    url += '&period=' + period;
  }
  return url;
}


/**
 * Generate URL for a fixed component's dashboard (overview)
 * @param {string} componentKey
 * @param {string} dashboardKey
 * @returns {string}
 */
export function getComponentFixedDashboardUrl (componentKey, dashboardKey) {
  return '/overview' + dashboardKey + '?id=' + encodeURIComponent(componentKey);
}


/**
 * Generate URL for a component's dashboards management page
 * @param {string} componentKey
 * @returns {string}
 */
export function getComponentDashboardManagementUrl (componentKey) {
  return '/dashboards?resource=' + encodeURIComponent(componentKey);
}