aboutsummaryrefslogtreecommitdiffstats
path: root/server/sonar-web/src/main/js/helpers/l10n.js
blob: 425dd32674f68982faf871f2b7be69bc1dadc00d (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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
/*
 * 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.
 */
import moment from 'moment';
import { request } from './request';

let messages = {};

export function translate (...keys) {
  const messageKey = keys.join('.');
  return messages[messageKey] || messageKey;
}

export function translateWithParameters (messageKey, ...parameters) {
  const message = messages[messageKey];
  if (message) {
    return parameters.reduce((acc, parameter, index) => acc.replace(`{${index}}`, parameter), message);
  } else {
    return `${messageKey}.${parameters.join('.')}`;
  }
}

export function hasMessage (...keys) {
  const messageKey = keys.join('.');
  return messages[messageKey] != null;
}

function getCurrentLocale () {
  return window.navigator.languages ? window.navigator.languages[0] : window.navigator.language;
}

function makeRequest (params) {
  const url = '/api/l10n/index';

  return request(url)
      .setData(params)
      .submit()
      .then(response => {
        switch (response.status) {
          case 200:
            return response.json();
          case 304:
            return JSON.parse(localStorage.getItem('l10n.bundle'));
          case 401:
            window.location = window.baseUrl + '/sessions/new?return_to=' +
                encodeURIComponent(window.location.pathname + window.location.search + window.location.hash);
            return {};
          default:
            throw new Error('Unexpected status code: ' + response.status);
        }
      });
}

function checkCachedBundle () {
  const cached = localStorage.getItem('l10n.bundle');

  if (!cached) {
    return false;
  }

  try {
    const parsed = JSON.parse(cached);
    return parsed != null && typeof parsed === 'object';
  } catch (e) {
    return false;
  }
}

export function requestMessages () {
  const currentLocale = getCurrentLocale();
  const cachedLocale = localStorage.getItem('l10n.locale');

  if (cachedLocale !== currentLocale) {
    localStorage.removeItem('l10n.timestamp');
  }

  const bundleTimestamp = localStorage.getItem('l10n.timestamp');
  const params = {};
  if (currentLocale) {
    params.locale = currentLocale;
  }
  if (bundleTimestamp !== null && checkCachedBundle()) {
    params.ts = bundleTimestamp;
  }

  return makeRequest(params).then(bundle => {
    try {
      const currentTimestamp = moment().format('YYYY-MM-DDTHH:mm:ssZZ');
      localStorage.setItem('l10n.timestamp', currentTimestamp);
      localStorage.setItem('l10n.locale', currentLocale);
      localStorage.setItem('l10n.bundle', JSON.stringify(bundle));
    } catch (e) {
      // do nothing
    }

    messages = bundle;
  });
}

export function resetBundle (bundle) {
  messages = bundle;
}

export function installGlobal () {
  window.t = translate;
  window.tp = translateWithParameters;
  window.requestMessages = requestMessages;
}

export function getLocalizedDashboardName (baseName) {
  const l10nKey = `dashboard.${baseName}.name`;
  const l10nLabel = translate(l10nKey);
  return l10nLabel !== l10nKey ? l10nLabel : baseName;
}

export function getLocalizedMetricName (metric) {
  const bundleKey = `metric.${metric.key}.name`;
  const fromBundle = translate(bundleKey);
  return fromBundle !== bundleKey ? fromBundle : metric.name;
}

export function getLocalizedMetricDomain (domainName) {
  const bundleKey = `metric_domain.${domainName}`;
  const fromBundle = translate(bundleKey);
  return fromBundle !== bundleKey ? fromBundle : domainName;
}