- Forward Message
-
- );
+ if (this.props.mxEvent.getType() === 'm.room.message') {
+ const content = this.props.mxEvent.getContent();
+ if (content.msgtype // truthy check msgtype
+ && content.msgtype !== 'm.bad.encrypted'
+ && content.hasOwnProperty('body')) {
+ forwardButton = (
+
+ Forward Message
+
+ );
+ }
}
viewSourceButton = (
From 7777be89ee0ec9f5e268695fc7d1233b8eb2ab0f Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Thu, 18 May 2017 23:53:37 +0100
Subject: [PATCH 05/95] only for finalised events
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
src/components/views/context_menus/MessageContextMenu.js | 6 ++----
1 file changed, 2 insertions(+), 4 deletions(-)
diff --git a/src/components/views/context_menus/MessageContextMenu.js b/src/components/views/context_menus/MessageContextMenu.js
index 002ec5bc..ffedbcad 100644
--- a/src/components/views/context_menus/MessageContextMenu.js
+++ b/src/components/views/context_menus/MessageContextMenu.js
@@ -151,11 +151,9 @@ module.exports = React.createClass({
);
}
- if (this.props.mxEvent.getType() === 'm.room.message') {
+ if (!eventStatus && this.props.mxEvent.getType() === 'm.room.message') {
const content = this.props.mxEvent.getContent();
- if (content.msgtype // truthy check msgtype
- && content.msgtype !== 'm.bad.encrypted'
- && content.hasOwnProperty('body')) {
+ if (content.msgtype && content.msgtype !== 'm.bad.encrypted' && content.hasOwnProperty('body')) {
forwardButton = (
Forward Message
From 09f987559b0209956b97f84bb21c857074ec31f0 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Fri, 19 May 2017 01:30:36 +0100
Subject: [PATCH 06/95] rename action, now forwarding any event is possible,
limited by where button is shown, i.e easy to modify
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
src/components/views/context_menus/MessageContextMenu.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/src/components/views/context_menus/MessageContextMenu.js b/src/components/views/context_menus/MessageContextMenu.js
index ffedbcad..5f8cf688 100644
--- a/src/components/views/context_menus/MessageContextMenu.js
+++ b/src/components/views/context_menus/MessageContextMenu.js
@@ -90,8 +90,8 @@ module.exports = React.createClass({
onForwardClick: function() {
dis.dispatch({
- action: 'forward_message',
- content: this.props.mxEvent.getContent(),
+ action: 'forward_event',
+ content: this.props.mxEvent,
});
this.closeMenu();
},
From 9e37fa46b154594afad3281157c21cc1a8c47ebf Mon Sep 17 00:00:00 2001
From: Maxwell Kepler
Date: Thu, 18 May 2017 22:01:00 +0100
Subject: [PATCH 07/95] Add 12 hour support
---
.../views/messages/MessageTimestamp.js | 25 +++++++++++++------
.../structures/_FilePanel.scss | 1 -
.../views/rooms/_EventTile.scss | 6 ++++-
3 files changed, 22 insertions(+), 10 deletions(-)
diff --git a/src/components/views/messages/MessageTimestamp.js b/src/components/views/messages/MessageTimestamp.js
index a97f54b1..8417f91f 100644
--- a/src/components/views/messages/MessageTimestamp.js
+++ b/src/components/views/messages/MessageTimestamp.js
@@ -16,19 +16,28 @@ limitations under the License.
'use strict';
-var React = require('react');
-var DateUtils = require('matrix-react-sdk/lib/DateUtils');
+import * as UserSettingsStore from 'matrix-react-sdk/lib/UserSettingsStore';
+const React = require('react');
+const DateUtils = require('matrix-react-sdk/lib/DateUtils');
module.exports = React.createClass({
displayName: 'MessageTimestamp',
render: function() {
var date = new Date(this.props.ts);
- return (
-
- { DateUtils.formatTime(date) }
-
- );
+ if (UserSettingsStore.getSyncedSetting('showTwelveHourTimestamps')) {
+ return (
+
+ { DateUtils.formatTime(date) }
+
+ );
+ }
+ else {
+ return (
+
+ { DateUtils.formatTime(date) }
+
+ );
+ }
},
});
-
diff --git a/src/skins/vector/css/matrix-react-sdk/structures/_FilePanel.scss b/src/skins/vector/css/matrix-react-sdk/structures/_FilePanel.scss
index 872085b6..58e09064 100644
--- a/src/skins/vector/css/matrix-react-sdk/structures/_FilePanel.scss
+++ b/src/skins/vector/css/matrix-react-sdk/structures/_FilePanel.scss
@@ -112,4 +112,3 @@ limitations under the License.
.mx_FilePanel .mx_EventTile_selected .mx_EventTile_line {
padding-left: 0px;
}
-
diff --git a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
index cbd71422..acfe768a 100644
--- a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
+++ b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
@@ -94,7 +94,7 @@ limitations under the License.
*/
.mx_EventTile_selected .mx_EventTile_line {
border-left: $accent-color 5px solid;
- padding-left: 60px;
+ padding-left: 100px;
background-color: $event-selected-color;
}
@@ -263,6 +263,10 @@ limitations under the License.
cursor: pointer;
}
+.mx_EventTile_e2eIcon_12hr {
+ padding-left: 5px;
+}
+
.mx_EventTile:hover.mx_EventTile_verified .mx_EventTile_line,
.mx_EventTile:hover.mx_EventTile_unverified .mx_EventTile_line {
padding-left: 60px;
From 1ebe819aa274e4a9efb3ac5396ed3b8fe468ea87 Mon Sep 17 00:00:00 2001
From: Kieran Gould
Date: Fri, 19 May 2017 21:14:01 +0100
Subject: [PATCH 08/95] Revert _EventTile.scss padding.
---
.../vector/css/matrix-react-sdk/views/rooms/_EventTile.scss | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
index acfe768a..5943cfdc 100644
--- a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
+++ b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
@@ -94,7 +94,7 @@ limitations under the License.
*/
.mx_EventTile_selected .mx_EventTile_line {
border-left: $accent-color 5px solid;
- padding-left: 100px;
+ padding-left: 60px;
background-color: $event-selected-color;
}
From cae62c83830890f7f904148f43e2484ee699f6ac Mon Sep 17 00:00:00 2001
From: Kieran Gould
Date: Fri, 19 May 2017 22:29:06 +0100
Subject: [PATCH 09/95] MessageTimestamp now has 12 hour prop
---
.../views/messages/MessageTimestamp.js | 25 ++++++++-----------
.../views/rooms/_EventTile.scss | 10 +++++---
2 files changed, 17 insertions(+), 18 deletions(-)
diff --git a/src/components/views/messages/MessageTimestamp.js b/src/components/views/messages/MessageTimestamp.js
index 8417f91f..dacfad92 100644
--- a/src/components/views/messages/MessageTimestamp.js
+++ b/src/components/views/messages/MessageTimestamp.js
@@ -23,21 +23,16 @@ const DateUtils = require('matrix-react-sdk/lib/DateUtils');
module.exports = React.createClass({
displayName: 'MessageTimestamp',
+ propTypes: {
+ showTwelveHour: React.PropTypes.bool,
+ },
+
render: function() {
- var date = new Date(this.props.ts);
- if (UserSettingsStore.getSyncedSetting('showTwelveHourTimestamps')) {
- return (
-
- { DateUtils.formatTime(date) }
-
- );
- }
- else {
- return (
-
- { DateUtils.formatTime(date) }
-
- );
- }
+ const date = new Date(this.props.ts);
+ return (
+
+ { DateUtils.formatTime(date, this.props.showTwelveHour) }
+
+ );
},
});
diff --git a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
index 5943cfdc..3ea25ba2 100644
--- a/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
+++ b/src/skins/vector/css/matrix-react-sdk/views/rooms/_EventTile.scss
@@ -94,7 +94,7 @@ limitations under the License.
*/
.mx_EventTile_selected .mx_EventTile_line {
border-left: $accent-color 5px solid;
- padding-left: 60px;
+ padding-left: px;
background-color: $event-selected-color;
}
@@ -263,8 +263,12 @@ limitations under the License.
cursor: pointer;
}
-.mx_EventTile_e2eIcon_12hr {
- padding-left: 5px;
+.mx_EventTile_12hr .mx_EventTile_e2eIcon {
+ padding-left: 5px;
+}
+
+.mx_EventTile_12hr .mx_MessageTimestamp {
+ text-align: center;
}
.mx_EventTile:hover.mx_EventTile_verified .mx_EventTile_line,
From 90ab4a02f256e6199c6dad19c756e46260956af9 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Sat, 20 May 2017 13:11:31 +0100
Subject: [PATCH 10/95] add category so it doesn't get dropped into
Default/Lost+Found
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
package.json | 1 +
1 file changed, 1 insertion(+)
diff --git a/package.json b/package.json
index dd25bf64..9dc14581 100644
--- a/package.json
+++ b/package.json
@@ -158,6 +158,7 @@
],
"linux": {
"target": "deb",
+ "category": "Network;InstantMessaging;P2P;",
"maintainer": "support@riot.im",
"desktop": {
"StartupWMClass": "riot-web"
From 6e8516e5376d49bb577a6ae0503d12d78ca28bf1 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@googlemail.com>
Date: Mon, 22 May 2017 16:53:46 +0100
Subject: [PATCH 11/95] fiiine!
---
package.json | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/package.json b/package.json
index 9dc14581..c4c959c3 100644
--- a/package.json
+++ b/package.json
@@ -158,7 +158,7 @@
],
"linux": {
"target": "deb",
- "category": "Network;InstantMessaging;P2P;",
+ "category": "Network;InstantMessaging;",
"maintainer": "support@riot.im",
"desktop": {
"StartupWMClass": "riot-web"
From 755c66b9f19b51bd65d7289873553c387bc5ff5d Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 18:30:45 +0100
Subject: [PATCH 12/95] pass dispatcher through to electron, on a whitelist
basis
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
src/vector/platform/ElectronPlatform.js | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/src/vector/platform/ElectronPlatform.js b/src/vector/platform/ElectronPlatform.js
index 5710e66e..ecbc5bd0 100644
--- a/src/vector/platform/ElectronPlatform.js
+++ b/src/vector/platform/ElectronPlatform.js
@@ -54,7 +54,19 @@ function platformFriendlyName(): string {
}
}
+function _onAction(payload: Object) {
+ // Whitelist payload actions, no point sending most across
+ if (['call_state'].includes(payload.action)) {
+ ipcRenderer.send('app_onAction', payload);
+ }
+}
+
export default class ElectronPlatform extends VectorBasePlatform {
+ constructor() {
+ super();
+ dis.register(_onAction);
+ }
+
setNotificationCount(count: number) {
if (this.notificationCount === count) return;
super.setNotificationCount(count);
From f57d8e4cb9bd3d87a28462e6c697dd087f4fd8a1 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 18:31:30 +0100
Subject: [PATCH 13/95] make ESLint a touch happier
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
src/vector/platform/ElectronPlatform.js | 1 -
1 file changed, 1 deletion(-)
diff --git a/src/vector/platform/ElectronPlatform.js b/src/vector/platform/ElectronPlatform.js
index ecbc5bd0..bf930a67 100644
--- a/src/vector/platform/ElectronPlatform.js
+++ b/src/vector/platform/ElectronPlatform.js
@@ -83,7 +83,6 @@ export default class ElectronPlatform extends VectorBasePlatform {
}
displayNotification(title: string, msg: string, avatarUrl: string, room: Object): Notification {
-
// GNOME notification spec parses HTML tags for styling...
// Electron Docs state all supported linux notification systems follow this markup spec
// https://github.com/electron/electron/blob/master/docs/tutorial/desktop-environment-integration.md#linux
From 4944bfdaa25abbeb4ebd8ce60fbc7376851b5bbd Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 18:32:39 +0100
Subject: [PATCH 14/95] onAction support in Electron process, disable powersave
when in call
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/electron-main.js | 20 +++++++++++++++++++-
1 file changed, 19 insertions(+), 1 deletion(-)
diff --git a/electron_app/src/electron-main.js b/electron_app/src/electron-main.js
index ab844bd3..53f9ac0f 100644
--- a/electron_app/src/electron-main.js
+++ b/electron_app/src/electron-main.js
@@ -186,6 +186,24 @@ electron.ipcMain.on('setBadgeCount', function(ev, count) {
}
});
+let powerSaveBlockerId;
+electron.ipcMain.on('app_onAction', function(ev, payload) {
+ switch (payload.action) {
+ case 'call_state':
+ if (powerSaveBlockerId && powerSaveBlockerId.isStarted(powerSaveBlockerId)) {
+ if (payload.state === 'ended') {
+ electron.powerSaveBlocker.stop(powerSaveBlockerId);
+ }
+ } else {
+ if (payload.state === 'connected') {
+ powerSaveBlockerId = electron.powerSaveBlocker.start('prevent-display-sleep');
+ }
+ }
+ break;
+ }
+});
+
+
electron.app.commandLine.appendSwitch('--enable-usermedia-screen-capturing');
const shouldQuit = electron.app.makeSingleInstance((commandLine, workingDirectory) => {
@@ -199,7 +217,7 @@ const shouldQuit = electron.app.makeSingleInstance((commandLine, workingDirector
if (shouldQuit) {
console.log("Other instance detected: exiting");
- electron.app.quit()
+ electron.app.quit();
}
electron.app.on('ready', () => {
From 911c3bcf6e6fe60148ec0d1ff161dd1561bfe37b Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 19:21:52 +0100
Subject: [PATCH 15/95] tidy electron files, they were starting to annoy me
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/electron-main.js | 85 +++++++--------
electron_app/src/squirrelhooks.js | 20 ++--
electron_app/src/tray.js | 10 +-
electron_app/src/vectormenu.js | 168 ++++++++++--------------------
4 files changed, 107 insertions(+), 176 deletions(-)
diff --git a/electron_app/src/electron-main.js b/electron_app/src/electron-main.js
index ab844bd3..b58e2553 100644
--- a/electron_app/src/electron-main.js
+++ b/electron_app/src/electron-main.js
@@ -20,15 +20,14 @@ limitations under the License.
// Squirrel on windows starts the app with various flags
// as hooks to tell us when we've been installed/uninstalled
// etc.
-const check_squirrel_hooks = require('./squirrelhooks');
-if (check_squirrel_hooks()) return;
+const checkSquirrelHooks = require('./squirrelhooks');
+if (checkSquirrelHooks()) return;
const electron = require('electron');
const url = require('url');
const tray = require('./tray');
-
-const VectorMenu = require('./vectormenu');
+const vectorMenu = require('./vectormenu');
const windowStateKeeper = require('electron-window-state');
@@ -59,13 +58,13 @@ function safeOpenURL(target) {
// so put fairly stringent limits on what can be opened
// (for instance, open /bin/sh does indeed open a terminal
// with a shell, albeit with no arguments)
- const parsed_url = url.parse(target);
- if (PERMITTED_URL_SCHEMES.indexOf(parsed_url.protocol) > -1) {
+ const parsedUrl = url.parse(target);
+ if (PERMITTED_URL_SCHEMES.indexOf(parsedUrl.protocol) > -1) {
// explicitly use the URL re-assembled by the url library,
// so we know the url parser has understood all the parts
// of the input string
- const new_target = url.format(parsed_url);
- electron.shell.openExternal(new_target);
+ const newTarget = url.format(parsedUrl);
+ electron.shell.openExternal(newTarget);
}
}
@@ -79,20 +78,19 @@ function onWindowOrNavigate(ev, target) {
}
function onLinkContextMenu(ev, params) {
- const popup_menu = new electron.Menu();
- popup_menu.append(new electron.MenuItem({
+ const popupMenu = new electron.Menu();
+
+ popupMenu.append(new electron.MenuItem({
label: params.linkURL,
- click() {
- safeOpenURL(params.linkURL);
- },
+ click() { safeOpenURL(params.linkURL); },
}));
- popup_menu.append(new electron.MenuItem({
+
+ popupMenu.append(new electron.MenuItem({
label: 'Copy Link Address',
- click() {
- electron.clipboard.writeText(params.linkURL);
- },
+ click() { electron.clipboard.writeText(params.linkURL); },
}));
- popup_menu.popup();
+
+ popupMenu.popup();
ev.preventDefault();
}
@@ -107,13 +105,13 @@ function pollForUpdates() {
try {
electron.autoUpdater.checkForUpdates();
} catch (e) {
- console.log("Couldn't check for update", e);
+ console.log('Couldn\'t check for update', e);
}
}
-function startAutoUpdate(update_base_url) {
- if (update_base_url.slice(-1) !== '/') {
- update_base_url = update_base_url + '/';
+function startAutoUpdate(updateBaseUrl) {
+ if (updateBaseUrl.slice(-1) !== '/') {
+ updateBaseUrl = updateBaseUrl + '/';
}
try {
// For reasons best known to Squirrel, the way it checks for updates
@@ -121,7 +119,7 @@ function startAutoUpdate(update_base_url) {
// hits a URL that either gives it a 200 with some json or
// 204 No Content. On windows it takes a base path and looks for
// files under that path.
- if (process.platform == 'darwin') {
+ if (process.platform === 'darwin') {
// include the current version in the URL we hit. Electron doesn't add
// it anywhere (apart from the User-Agent) so it's up to us. We could
// (and previously did) just use the User-Agent, but this doesn't
@@ -129,16 +127,15 @@ function startAutoUpdate(update_base_url) {
// and also acts as a convenient cache-buster to ensure that when the
// app updates it always gets a fresh value to avoid update-looping.
electron.autoUpdater.setFeedURL(
- update_base_url +
- 'macos/?localVersion=' + encodeURIComponent(electron.app.getVersion())
- );
- } else if (process.platform == 'win32') {
- electron.autoUpdater.setFeedURL(update_base_url + 'win32/' + process.arch + '/');
+ `${updateBaseUrl}macos/?localVersion=${encodeURIComponent(electron.app.getVersion())}`);
+
+ } else if (process.platform === 'win32') {
+ electron.autoUpdater.setFeedURL(updateBaseUrl + 'win32/' + process.arch + '/');
} else {
// Squirrel / electron only supports auto-update on these two platforms.
// I'm not even going to try to guess which feed style they'd use if they
// implemented it on Linux, or if it would be different again.
- console.log("Auto update not supported on this platform");
+ console.log('Auto update not supported on this platform');
}
// We check for updates ourselves rather than using 'updater' because we need to
// do it in the main process (and we don't really need to check every 10 minutes:
@@ -151,7 +148,7 @@ function startAutoUpdate(update_base_url) {
setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
} catch (err) {
// will fail if running in debug mode
- console.log("Couldn't enable update checking", err);
+ console.log('Couldn\'t enable update checking', err);
}
}
@@ -162,13 +159,13 @@ function startAutoUpdate(update_base_url) {
// Assuming we generally run from the console when developing,
// this is far preferable.
process.on('uncaughtException', function(error) {
- console.log("Unhandled exception", error);
+ console.log('Unhandled exception', error);
});
electron.ipcMain.on('install_update', installUpdate);
let focusHandlerAttached = false;
-electron.ipcMain.on('setBadgeCount', function(ev, count) {
+electron.ipcMain.on('setBadgeCount', function(ev, count: number) {
electron.app.setBadgeCount(count);
if (process.platform === 'win32' && mainWindow && !mainWindow.isFocused()) {
if (count > 0) {
@@ -198,30 +195,28 @@ const shouldQuit = electron.app.makeSingleInstance((commandLine, workingDirector
});
if (shouldQuit) {
- console.log("Other instance detected: exiting");
- electron.app.quit()
+ console.log('Other instance detected: exiting');
+ electron.app.quit();
}
electron.app.on('ready', () => {
if (vectorConfig.update_base_url) {
- console.log("Starting auto update with base URL: " + vectorConfig.update_base_url);
+ console.log(`Starting auto update with base URL: ${vectorConfig.update_base_url}`);
startAutoUpdate(vectorConfig.update_base_url);
} else {
- console.log("No update_base_url is defined: auto update is disabled");
+ console.log('No update_base_url is defined: auto update is disabled');
}
- const icon_path = `${__dirname}/../img/riot.` + (
- process.platform == 'win32' ? 'ico' : 'png'
- );
+ const iconPath = `${__dirname}/../img/riot.${process.platform === 'win32' ? 'ico' : 'png'}`;
// Load the previous window state with fallback to defaults
- let mainWindowState = windowStateKeeper({
+ const mainWindowState = windowStateKeeper({
defaultWidth: 1024,
defaultHeight: 768,
});
mainWindow = new electron.BrowserWindow({
- icon: icon_path,
+ icon: iconPath,
show: false,
autoHideMenuBar: true,
@@ -231,12 +226,12 @@ electron.app.on('ready', () => {
height: mainWindowState.height,
});
mainWindow.loadURL(`file://${__dirname}/../../webapp/index.html`);
- electron.Menu.setApplicationMenu(VectorMenu);
+ electron.Menu.setApplicationMenu(vectorMenu);
// Create trayIcon icon
tray.create(mainWindow, {
- icon_path: icon_path,
- brand: vectorConfig.brand || 'Riot'
+ icon_path: iconPath,
+ brand: vectorConfig.brand || 'Riot',
});
if (!process.argv.includes('--hidden')) {
@@ -249,7 +244,7 @@ electron.app.on('ready', () => {
mainWindow = null;
});
mainWindow.on('close', (e) => {
- if (!appQuitting && (tray.hasTray() || process.platform == 'darwin')) {
+ if (!appQuitting && (tray.hasTray() || process.platform === 'darwin')) {
// On Mac, closing the window just hides it
// (this is generally how single-window Mac apps
// behave, eg. Mail.app)
diff --git a/electron_app/src/squirrelhooks.js b/electron_app/src/squirrelhooks.js
index 15ed670f..728c9cfb 100644
--- a/electron_app/src/squirrelhooks.js
+++ b/electron_app/src/squirrelhooks.js
@@ -16,30 +16,30 @@ limitations under the License.
const path = require('path');
const spawn = require('child_process').spawn;
-const app = require('electron').app;
+const {app} = require('electron');
-function run_update_exe(args, done) {
+function runUpdateExe(args, done) {
// Invokes Squirrel's Update.exe which will do things for us like create shortcuts
// Note that there's an Update.exe in the app-x.x.x directory and one in the parent
// directory: we need to run the one in the parent directory, because it discovers
// information about the app by inspecting the directory it's run from.
const updateExe = path.resolve(path.dirname(process.execPath), '..', 'Update.exe');
- console.log('Spawning `%s` with args `%s`', updateExe, args);
+ console.log(`Spawning '${updateExe}' with args '${args}'`);
spawn(updateExe, args, {
- detached: true
+ detached: true,
}).on('close', done);
-};
+}
-function check_squirrel_hooks() {
- if (process.platform != 'win32') return false;
+function checkSquirrelHooks() {
+ if (process.platform !== 'win32') return false;
const cmd = process.argv[1];
const target = path.basename(process.execPath);
if (cmd === '--squirrel-install' || cmd === '--squirrel-updated') {
- run_update_exe(['--createShortcut=' + target + ''], app.quit);
+ runUpdateExe(['--createShortcut=' + target + ''], app.quit);
return true;
} else if (cmd === '--squirrel-uninstall') {
- run_update_exe(['--removeShortcut=' + target + ''], app.quit);
+ runUpdateExe(['--removeShortcut=' + target + ''], app.quit);
return true;
} else if (cmd === '--squirrel-obsolete') {
app.quit();
@@ -48,4 +48,4 @@ function check_squirrel_hooks() {
return false;
}
-module.exports = check_squirrel_hooks;
+module.exports = checkSquirrelHooks;
diff --git a/electron_app/src/tray.js b/electron_app/src/tray.js
index 5409194d..9df1a0fb 100644
--- a/electron_app/src/tray.js
+++ b/electron_app/src/tray.js
@@ -25,9 +25,7 @@ exports.hasTray = function hasTray() {
exports.create = function(win, config) {
// no trays on darwin
- if (process.platform === 'darwin' || trayIcon) {
- return;
- }
+ if (process.platform === 'darwin' || trayIcon) return;
const toggleWin = function() {
if (win.isVisible() && !win.isMinimized()) {
@@ -41,12 +39,10 @@ exports.create = function(win, config) {
const contextMenu = Menu.buildFromTemplate([
{
- label: 'Show/Hide ' + config.brand,
+ label: `Show/Hide ${config.brand}`,
click: toggleWin,
},
- {
- type: 'separator',
- },
+ { type: 'separator' },
{
label: 'Quit',
click: function() {
diff --git a/electron_app/src/vectormenu.js b/electron_app/src/vectormenu.js
index 70ed3ac3..f55009f7 100644
--- a/electron_app/src/vectormenu.js
+++ b/electron_app/src/vectormenu.js
@@ -14,170 +14,112 @@ See the License for the specific language governing permissions and
limitations under the License.
*/
-const electron = require('electron');
+const {app, shell, Menu} = require('electron');
// Menu template from http://electron.atom.io/docs/api/menu/, edited
const template = [
{
label: 'Edit',
submenu: [
- {
- role: 'undo'
- },
- {
- role: 'redo'
- },
- {
- type: 'separator'
- },
- {
- role: 'cut'
- },
- {
- role: 'copy'
- },
- {
- role: 'paste'
- },
- {
- role: 'pasteandmatchstyle'
- },
- {
- role: 'delete'
- },
- {
- role: 'selectall'
- }
- ]
+ { role: 'undo' },
+ { role: 'redo' },
+ { type: 'separator' },
+ { role: 'cut' },
+ { role: 'copy' },
+ { role: 'paste' },
+ { role: 'pasteandmatchstyle' },
+ { role: 'delete' },
+ { role: 'selectall' },
+ ],
},
{
label: 'View',
submenu: [
- {
- type: 'separator'
- },
- {
- role: 'resetzoom'
- },
- {
- role: 'zoomin'
- },
- {
- role: 'zoomout'
- },
- {
- type: 'separator'
- },
- {
- role: 'togglefullscreen'
- },
- {
- role: 'toggledevtools'
- }
- ]
+ { type: 'separator' },
+ { role: 'resetzoom' },
+ { role: 'zoomin' },
+ { role: 'zoomout' },
+ { type: 'separator' },
+ { role: 'togglefullscreen' },
+ { role: 'toggledevtools' },
+ ],
},
{
role: 'window',
submenu: [
- {
- role: 'minimize'
- },
- {
- role: 'close'
- }
- ]
+ { role: 'minimize' },
+ { role: 'close' },
+ ],
},
{
role: 'help',
submenu: [
{
label: 'riot.im',
- click () { electron.shell.openExternal('https://riot.im/') }
- }
- ]
- }
+ click() { shell.openExternal('https://riot.im/'); },
+ },
+ ],
+ },
];
// macOS has specific menu conventions...
if (process.platform === 'darwin') {
// first macOS menu is the name of the app
- const name = electron.app.getName()
+ const name = app.getName();
template.unshift({
label: name,
submenu: [
- {
- role: 'about'
- },
- {
- type: 'separator'
- },
+ { role: 'about' },
+ { type: 'separator' },
{
role: 'services',
- submenu: []
+ submenu: [],
},
- {
- type: 'separator'
- },
- {
- role: 'hide'
- },
- {
- role: 'hideothers'
- },
- {
- role: 'unhide'
- },
- {
- type: 'separator'
- },
- {
- role: 'quit'
- }
- ]
- })
+ { type: 'separator' },
+ { role: 'hide' },
+ { role: 'hideothers' },
+ { role: 'unhide' },
+ { type: 'separator' },
+ { role: 'quit' },
+ ],
+ });
// Edit menu.
// This has a 'speech' section on macOS
template[1].submenu.push(
- {
- type: 'separator'
- },
+ { type: 'separator' },
{
label: 'Speech',
submenu: [
- {
- role: 'startspeaking'
- },
- {
- role: 'stopspeaking'
- }
- ]
- }
- )
+ { role: 'startspeaking' },
+ { role: 'stopspeaking' },
+ ],
+ },
+ );
// Window menu.
// This also has specific functionality on macOS
template[3].submenu = [
{
label: 'Close',
accelerator: 'CmdOrCtrl+W',
- role: 'close'
+ role: 'close',
},
{
label: 'Minimize',
accelerator: 'CmdOrCtrl+M',
- role: 'minimize'
+ role: 'minimize',
},
{
label: 'Zoom',
- role: 'zoom'
+ role: 'zoom',
},
{
- type: 'separator'
+ type: 'separator',
},
{
label: 'Bring All to Front',
- role: 'front'
- }
- ]
+ role: 'front',
+ },
+ ];
} else {
template.unshift({
label: 'File',
@@ -186,12 +128,10 @@ if (process.platform === 'darwin') {
/*{
role: 'about'
},*/
- {
- role: 'quit'
- }
- ]
+ { role: 'quit' },
+ ],
});
}
-module.exports = electron.Menu.buildFromTemplate(template)
+module.exports = Menu.buildFromTemplate(template);
From 4bb054c9553cbf4b97e0bc95c266349a605de722 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 19:25:18 +0100
Subject: [PATCH 16/95] electron stuff isn't actually using flow, so don't
enable it
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/electron-main.js | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
diff --git a/electron_app/src/electron-main.js b/electron_app/src/electron-main.js
index b58e2553..95daaa6a 100644
--- a/electron_app/src/electron-main.js
+++ b/electron_app/src/electron-main.js
@@ -1,5 +1,3 @@
-// @flow
-
/*
Copyright 2016 Aviral Dasgupta
Copyright 2016 OpenMarket Ltd
@@ -165,7 +163,7 @@ process.on('uncaughtException', function(error) {
electron.ipcMain.on('install_update', installUpdate);
let focusHandlerAttached = false;
-electron.ipcMain.on('setBadgeCount', function(ev, count: number) {
+electron.ipcMain.on('setBadgeCount', function(ev, count) {
electron.app.setBadgeCount(count);
if (process.platform === 'win32' && mainWindow && !mainWindow.isFocused()) {
if (count > 0) {
From e0fb2fd07400cd8ae81554548080ade3b2937286 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 19:25:56 +0100
Subject: [PATCH 17/95] /me forgets we don't have babel
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/vectormenu.js | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)
diff --git a/electron_app/src/vectormenu.js b/electron_app/src/vectormenu.js
index f55009f7..ab30b376 100644
--- a/electron_app/src/vectormenu.js
+++ b/electron_app/src/vectormenu.js
@@ -93,8 +93,8 @@ if (process.platform === 'darwin') {
{ role: 'startspeaking' },
{ role: 'stopspeaking' },
],
- },
- );
+ });
+
// Window menu.
// This also has specific functionality on macOS
template[3].submenu = [
From 8994c2bad14294a54986bf2f4d220b0d1e85b050 Mon Sep 17 00:00:00 2001
From: Michael Telatynski <7t3chguy@gmail.com>
Date: Mon, 22 May 2017 19:28:01 +0100
Subject: [PATCH 18/95] missed a concat :)
Signed-off-by: Michael Telatynski <7t3chguy@gmail.com>
---
electron_app/src/electron-main.js | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
diff --git a/electron_app/src/electron-main.js b/electron_app/src/electron-main.js
index 95daaa6a..5dc889b1 100644
--- a/electron_app/src/electron-main.js
+++ b/electron_app/src/electron-main.js
@@ -128,7 +128,7 @@ function startAutoUpdate(updateBaseUrl) {
`${updateBaseUrl}macos/?localVersion=${encodeURIComponent(electron.app.getVersion())}`);
} else if (process.platform === 'win32') {
- electron.autoUpdater.setFeedURL(updateBaseUrl + 'win32/' + process.arch + '/');
+ electron.autoUpdater.setFeedURL(`${updateBaseUrl}win32/${process.arch}/`);
} else {
// Squirrel / electron only supports auto-update on these two platforms.
// I'm not even going to try to guess which feed style they'd use if they
From 6b6fa59f3e92603465e8c89942db902ab3db6607 Mon Sep 17 00:00:00 2001
From: David Baker
Date: Tue, 23 May 2017 14:12:53 +0100
Subject: [PATCH 19/95] Squash merge
https://github.com/vector-im/riot-web/pull/3636
---
README.md | 14 +-
config.sample.json | 3 +-
docs/translating-dev.md | 26 +
docs/translating.md | 57 +
package.json | 1 +
scripts/copy-res.js | 99 +-
src/components/structures/BottomLeftMenu.js | 13 +-
src/components/structures/RightPanel.js | 73 +-
src/components/structures/RoomDirectory.js | 60 +-
src/components/structures/RoomSubList.js | 11 +-
src/components/structures/SearchBox.js | 3 +-
.../views/context_menus/MessageContextMenu.js | 23 +-
.../context_menus/RoomTileContextMenu.js | 37 +-
src/components/views/elements/ImageView.js | 13 +-
src/components/views/globals/MatrixToolbar.js | 3 +-
.../views/login/VectorCustomServerDialog.js | 17 +-
.../views/login/VectorLoginFooter.js | 3 +-
.../views/messages/DateSeparator.js | 33 +-
src/components/views/rooms/DNDRoomTile.js | 14 +-
.../views/settings/Notifications.js | 58 +-
src/i18n/basefile.json | 1 +
src/i18n/be.json | 88 +
src/i18n/da.json | 84 +
src/i18n/de_DE.json | 122 +
src/i18n/en_EN.json | 120 +
src/i18n/fr.json | 66 +
src/i18n/ml.json | 5 +
src/i18n/pl.json | 1 +
src/i18n/pt.json | 116 +
src/i18n/pt_BR.json | 124 +
src/i18n/ru.json | 119 +
.../VectorPushRulesDefinitions.js | 1 +
.../structures/login/_Login.scss | 3 +-
src/vector/index.js | 46 +-
yarn-error.log | 200 +
yarn.lock | 6076 +++++++++++++++++
36 files changed, 7547 insertions(+), 186 deletions(-)
create mode 100644 docs/translating-dev.md
create mode 100644 docs/translating.md
create mode 100644 src/i18n/basefile.json
create mode 100644 src/i18n/be.json
create mode 100644 src/i18n/da.json
create mode 100644 src/i18n/de_DE.json
create mode 100644 src/i18n/en_EN.json
create mode 100644 src/i18n/fr.json
create mode 100644 src/i18n/ml.json
create mode 100644 src/i18n/pl.json
create mode 100644 src/i18n/pt.json
create mode 100644 src/i18n/pt_BR.json
create mode 100644 src/i18n/ru.json
create mode 100644 yarn-error.log
create mode 100644 yarn.lock
diff --git a/README.md b/README.md
index 34107873..c65cca82 100644
--- a/README.md
+++ b/README.md
@@ -4,6 +4,8 @@ Riot
Riot (formerly known as Vector) is a Matrix web client built using the Matrix
React SDK (https://github.com/matrix-org/matrix-react-sdk).
+[
](https://translate.nordgedanken.de/engage/riot-web/?utm_source=widget)
+
Getting Started
===============
@@ -281,6 +283,16 @@ If any of these steps error with, `file table overflow`, you are probably on a m
which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.
You'll need to do this in each new terminal you open before building Riot.
+How to add a new translation?
+=============================
+
+Head to the [translating doc](docs/translating.md)
+
+Adding Strings to the translations (Developer Guide)
+====================================================
+
+Head to the [translating dev doc](docs/translating-dev.md)
+
Triaging issues
===============
@@ -300,7 +312,7 @@ bug or feature:
* feature
bug severity:
-
+
* cosmetic - feature works functionally but UI/UX is broken
* critical - whole app doesn't work
* major - entire feature doesn't work
diff --git a/config.sample.json b/config.sample.json
index 3c513f7a..e8239df9 100644
--- a/config.sample.json
+++ b/config.sample.json
@@ -10,5 +10,6 @@
"servers": [
"matrix.org"
]
- }
+ },
+ "languages": ["en", "de", "pt-br", "ru", "da"]
}
diff --git a/docs/translating-dev.md b/docs/translating-dev.md
new file mode 100644
index 00000000..8bebd0bc
--- /dev/null
+++ b/docs/translating-dev.md
@@ -0,0 +1,26 @@
+# How to translate riot-web (Dev Guide)
+
+## Requirements
+
+- A working [Development Setup](../../#setting-up-a-dev-environment)
+- Be able to understand English
+- Be able to understand the language you want to translate riot-web into
+
+## Adding new strings
+
+1. Check if the import ``import _t from 'counterpart-riot'`` is present. If not add it to the other import statements.
+2. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method)
+3. Add the String to the ``en_EN.json`` file in ``src/i18n`` or if you are working in matrix-react-sdk you can find the json file in ``src/i18n/strings``
+
+## Adding variables inside a string.
+
+1. Extend your ``_t()`` call. Instead of ``_t(STRING)`` use ``_t(STRING, {})``
+2. Decide how to name it. Please think about if the person who has to translate it can understand what it does.
+3. Add it to the array in ``_t`` for example ``_t(STRING, {variable: this.variable})``
+4. Add the variable inside the string. The syntax for variables is ``%(variable)s``. Please note the s at the end. The name of the variable has to match the previous used name.
+
+## Things to know/Style Guides
+
+- Do not use it inside ``getDefaultProps`` at the point where ``getDefaultProps`` is initialized the translations aren't loaded yet and it causes missing translations.
+- Do use ``Array.push()`` instead of directly defining it inside the array. Arrays are not able to access ``_t()`` at runtime.
+- Do not include full stops, Emoji or similiar miscellaneous Things to the strings. They are not required to be translated.
diff --git a/docs/translating.md b/docs/translating.md
new file mode 100644
index 00000000..d79a5823
--- /dev/null
+++ b/docs/translating.md
@@ -0,0 +1,57 @@
+# How to translate riot-web
+
+## Requirements
+
+- Web Browser
+- Be able to understand English
+- Be able to understand the language you want to translate riot-web into
+
+## Step 1: Preparing your Weblate Profile
+
+1. Head to https://translate.nordgedanken.de and register either via Github or email
+2. After register check if you got a email to verify your account and click the link (if there is none head to step 1.4)
+3. Log into weblate
+4. Head to https://translate.nordgedanken.de/accounts/profile/ and select the languages you know and maybe another language you know too.
+6. Head to https://translate.nordgedanken.de/accounts/profile/#subscriptions and select Riot Web as Project
+
+## How to check if your language already is being translated
+
+Go to https://translate.nordgedanken.de/projects/riot-web/ and in all 3 sub projects if your language is listed.
+If it is listed go to Step 2a if not go to Step 2b
+
+## Step 2a: Helping on existing languages.
+
+1. Head to one of the projects listed https://translate.nordgedanken.de/projects/riot-web/
+2. Click on the ``translate`` button on the right side of your language
+3. Fill in the translations in the writeable field. You will see the original English string and the String of your second language above.
+
+Head to the explanations under Steb 2b
+
+## Step 2b: Adding a new language
+
+1. Go to one of the projects listed https://translate.nordgedanken.de/projects/riot-web/
+2. Click the ``Start new language`` button at the bottom
+3. Select our language
+4. Start translating like in 2a.3
+5. Repeat these steps for the other projects which are listed at the link of step 2b.1
+6. Add your language to the array at the [config example](../../blob/develop/config.sample.json#L14)
+
+### What means the green button under the text field?
+
+The green button let you save our translations directly. Please only use it if you are 100% sure about that translation. If you do not know a translation please DO NOT click that button. Use the arrows above the translations field and click to the right.
+
+### What means the yellow button under the text field?
+
+The yellow button has to be used if you are unsure about the translation but you have a rough idea. It ads a new suggestion to the string which can than be reviewed by others.
+
+### What are "%(something)s"?
+
+These things are variables that are filled inside the code. They can be room names, usernames or similiar. If you find one use it for changing the word order but do not delete it as thing are missing if you do so.
+
+### "I want to come back to this string. How?"
+
+You can use inside the translation field "Review needed" checkbox. It will be shown as Strings that need to be reviewed.
+
+### Further reading
+
+The official Doc provides some more in-deepth explanation on how to do translations and talks about do and don't's. You can find it at: https://docs.weblate.org/en/latest/user/translating.html
diff --git a/package.json b/package.json
index 79b0bc10..fcd568c2 100644
--- a/package.json
+++ b/package.json
@@ -56,6 +56,7 @@
"babel-runtime": "^6.11.6",
"browser-request": "^0.3.3",
"classnames": "^2.1.2",
+ "counterpart-riot": "^0.17.9",
"draft-js": "^0.8.1",
"extract-text-webpack-plugin": "^0.9.1",
"favico.js": "^0.3.10",
diff --git a/scripts/copy-res.js b/scripts/copy-res.js
index d3a2ee5e..4736d401 100755
--- a/scripts/copy-res.js
+++ b/scripts/copy-res.js
@@ -13,12 +13,32 @@ const COPY_LIST = [
["src/skins/vector/{fonts,img}/**", "webapp"],
["node_modules/emojione/assets/svg/*", "webapp/emojione/svg/"],
["node_modules/emojione/assets/png/*", "webapp/emojione/png/"],
- ["./config.json", "webapp", {directwatch: 1}],
+ ["./config.json", "webapp", { directwatch: 1 }],
+ ["src/i18n/", "webapp/i18n/", { languages: 1 }],
+ ["node_modules/matrix-react-sdk/src/i18n/strings/", "webapp/i18n/", { languages: 1 }],
];
const parseArgs = require('minimist');
const Cpx = require('cpx');
const chokidar = require('chokidar');
+const fs = require('fs');
+const rimraf = require('rimraf');
+
+// cleanup language files before copying them.
+//rimraf("webapp/", function () { console.log('cleanup language files'); });
+
+//From http://stackoverflow.com/a/20525865/4929236
+function generateFileArray(dir, files_) {
+ files_ = files_ || [];
+ var files = fs.readdirSync(dir);
+ for (var i in files) {
+ var name = files[i];
+ if (name != 'basefile.json') {
+ files_.push(name);
+ }
+ }
+ return files_;
+}
const argv = parseArgs(
process.argv.slice(2), {}
@@ -45,8 +65,32 @@ function next(i, err) {
const source = ent[0];
const dest = ent[1];
const opts = ent[2] || {};
+ let cpx = undefined;
- const cpx = new Cpx.Cpx(source, dest);
+ if (opts.languages) {
+ const sourceFiles = generateFileArray(source);
+ let Sourcelanguages = {};
+ if (!fs.existsSync(dest)) {
+ fs.mkdirSync(dest);
+ }
+ sourceFiles.forEach(file => {
+ const fileContents = fs.readFileSync(source + file).toString();
+ Sourcelanguages[file] = JSON.parse(fileContents);
+ });
+ sourceFiles.forEach(file => {
+ if (!fs.existsSync(dest + file)) {
+ let o = Object.assign({}, Sourcelanguages[file]);
+ fs.writeFileSync(dest + file, JSON.stringify(o, null, 4));
+ } else {
+ const fileContents = fs.readFileSync(dest + file).toString();
+ let o = Object.assign(JSON.parse(fileContents), Sourcelanguages[file]);
+ fs.writeFileSync(dest + file, JSON.stringify(o, null, 4));
+ }
+ });
+
+ } else {
+ cpx = new Cpx.Cpx(source, dest);
+ }
if (verbose) {
cpx.on("copy", (event) => {
@@ -57,7 +101,7 @@ function next(i, err) {
});
}
- const cb = (err) => {next(i+1, err)};
+ const cb = (err) => { next(i + 1, err) };
if (watch) {
if (opts.directwatch) {
@@ -65,20 +109,65 @@ function next(i, err) {
// which in the case of config.json is '.', which inevitably takes
// ages to crawl. So we create our own watcher on the files
// instead.
- const copy = () => {cpx.copy(errCheck)};
+ const copy = () => { cpx.copy(errCheck) };
chokidar.watch(source)
.on('add', copy)
.on('change', copy)
.on('ready', cb)
.on('error', errCheck);
+ } else if (opts.languages) {
+ if (verbose) {
+ console.log('don\'t copy language file');
+ }
+ next(i + 1, err);
} else {
cpx.on('watch-ready', cb);
cpx.on("watch-error", cb);
cpx.watch();
}
+ } else if (opts.languages) {
+ if (verbose) {
+ console.log('don\'t copy language file');
+ }
+ next(i + 1, err);
} else {
cpx.copy(cb);
}
}
-next(0);
+// Generate Language List
+
+const testFolder = 'src/i18n/';
+let languages = {};
+// Check if webapp exists
+if (!fs.existsSync('webapp')) {
+ fs.mkdirSync('webapp');
+}
+// Check if i18n exists
+if (!fs.existsSync('webapp/i18n/')) {
+ fs.mkdirSync('webapp/i18n/');
+}
+
+if (!fs.existsSync('webapp/i18n/languages.json')) {
+ rimraf("webapp/i18n/languages.json", function() { console.log('cleanup languages.json file'); });
+}
+
+fs.readdir(testFolder, function(err, files) {
+ if (err) {
+ throw err;
+ }
+ files.forEach(function(file) {
+ var normalizedLanguage = file.toLowerCase().replace("_", "-").split('.json')[0];
+ var languageParts = normalizedLanguage.split('-');
+ if (file != 'basefile.json') {
+ if (languageParts.length == 2 && languageParts[0] == languageParts[1]) {
+ languages[languageParts[0]] = file;
+ } else {
+ languages[normalizedLanguage] = file;
+ }
+ }
+ });
+ fs.writeFile('webapp/i18n/languages.json', JSON.stringify(languages, null, 4));
+})
+
+next(0);
\ No newline at end of file
diff --git a/src/components/structures/BottomLeftMenu.js b/src/components/structures/BottomLeftMenu.js
index f378cac6..57da85eb 100644
--- a/src/components/structures/BottomLeftMenu.js
+++ b/src/components/structures/BottomLeftMenu.js
@@ -18,7 +18,8 @@ limitations under the License.
var React = require('react');
var ReactDOM = require('react-dom');
-var sdk = require('matrix-react-sdk')
+var sdk = require('matrix-react-sdk');
+import _t from 'counterpart-riot';
var dis = require('matrix-react-sdk/lib/dispatcher');
var AccessibleButton = require('matrix-react-sdk/lib/components/views/elements/AccessibleButton');
@@ -120,7 +121,7 @@ module.exports = React.createClass({
homeButton = (
);
}
@@ -131,19 +132,19 @@ module.exports = React.createClass({
{ homeButton }
](https://translate.nordgedanken.de/engage/riot-web/?utm_source=widget)
+
Getting Started
===============
@@ -281,6 +283,16 @@ If any of these steps error with, `file table overflow`, you are probably on a m
which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.
You'll need to do this in each new terminal you open before building Riot.
+How to add a new translation?
+=============================
+
+Head to the [translating doc](docs/translating.md)
+
+Adding Strings to the translations (Developer Guide)
+====================================================
+
+Head to the [translating dev doc](docs/translating-dev.md)
+
Triaging issues
===============
@@ -300,7 +312,7 @@ bug or feature:
* feature
bug severity:
-
+
* cosmetic - feature works functionally but UI/UX is broken
* critical - whole app doesn't work
* major - entire feature doesn't work
diff --git a/config.sample.json b/config.sample.json
index 3c513f7a..e8239df9 100644
--- a/config.sample.json
+++ b/config.sample.json
@@ -10,5 +10,6 @@
"servers": [
"matrix.org"
]
- }
+ },
+ "languages": ["en", "de", "pt-br", "ru", "da"]
}
diff --git a/docs/translating-dev.md b/docs/translating-dev.md
new file mode 100644
index 00000000..8bebd0bc
--- /dev/null
+++ b/docs/translating-dev.md
@@ -0,0 +1,26 @@
+# How to translate riot-web (Dev Guide)
+
+## Requirements
+
+- A working [Development Setup](../../#setting-up-a-dev-environment)
+- Be able to understand English
+- Be able to understand the language you want to translate riot-web into
+
+## Adding new strings
+
+1. Check if the import ``import _t from 'counterpart-riot'`` is present. If not add it to the other import statements.
+2. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method)
+3. Add the String to the ``en_EN.json`` file in ``src/i18n`` or if you are working in matrix-react-sdk you can find the json file in ``src/i18n/strings``
+
+## Adding variables inside a string.
+
+1. Extend your ``_t()`` call. Instead of ``_t(STRING)`` use ``_t(STRING, {})``
+2. Decide how to name it. Please think about if the person who has to translate it can understand what it does.
+3. Add it to the array in ``_t`` for example ``_t(STRING, {variable: this.variable})``
+4. Add the variable inside the string. The syntax for variables is ``%(variable)s``. Please note the s at the end. The name of the variable has to match the previous used name.
+
+## Things to know/Style Guides
+
+- Do not use it inside ``getDefaultProps`` at the point where ``getDefaultProps`` is initialized the translations aren't loaded yet and it causes missing translations.
+- Do use ``Array.push()`` instead of directly defining it inside the array. Arrays are not able to access ``_t()`` at runtime.
+- Do not include full stops, Emoji or similiar miscellaneous Things to the strings. They are not required to be translated.
diff --git a/docs/translating.md b/docs/translating.md
new file mode 100644
index 00000000..d79a5823
--- /dev/null
+++ b/docs/translating.md
@@ -0,0 +1,57 @@
+# How to translate riot-web
+
+## Requirements
+
+- Web Browser
+- Be able to understand English
+- Be able to understand the language you want to translate riot-web into
+
+## Step 1: Preparing your Weblate Profile
+
+1. Head to https://translate.nordgedanken.de and register either via Github or email
+2. After register check if you got a email to verify your account and click the link (if there is none head to step 1.4)
+3. Log into weblate
+4. Head to https://translate.nordgedanken.de/accounts/profile/ and select the languages you know and maybe another language you know too.
+6. Head to https://translate.nordgedanken.de/accounts/profile/#subscriptions and select Riot Web as Project
+
+## How to check if your language already is being translated
+
+Go to https://translate.nordgedanken.de/projects/riot-web/ and in all 3 sub projects if your language is listed.
+If it is listed go to Step 2a if not go to Step 2b
+
+## Step 2a: Helping on existing languages.
+
+1. Head to one of the projects listed https://translate.nordgedanken.de/projects/riot-web/
+2. Click on the ``translate`` button on the right side of your language
+3. Fill in the translations in the writeable field. You will see the original English string and the String of your second language above.
+
+Head to the explanations under Steb 2b
+
+## Step 2b: Adding a new language
+
+1. Go to one of the projects listed https://translate.nordgedanken.de/projects/riot-web/
+2. Click the ``Start new language`` button at the bottom
+3. Select our language
+4. Start translating like in 2a.3
+5. Repeat these steps for the other projects which are listed at the link of step 2b.1
+6. Add your language to the array at the [config example](../../blob/develop/config.sample.json#L14)
+
+### What means the green button under the text field?
+
+The green button let you save our translations directly. Please only use it if you are 100% sure about that translation. If you do not know a translation please DO NOT click that button. Use the arrows above the translations field and click to the right.
+
+### What means the yellow button under the text field?
+
+The yellow button has to be used if you are unsure about the translation but you have a rough idea. It ads a new suggestion to the string which can than be reviewed by others.
+
+### What are "%(something)s"?
+
+These things are variables that are filled inside the code. They can be room names, usernames or similiar. If you find one use it for changing the word order but do not delete it as thing are missing if you do so.
+
+### "I want to come back to this string. How?"
+
+You can use inside the translation field "Review needed" checkbox. It will be shown as Strings that need to be reviewed.
+
+### Further reading
+
+The official Doc provides some more in-deepth explanation on how to do translations and talks about do and don't's. You can find it at: https://docs.weblate.org/en/latest/user/translating.html
diff --git a/package.json b/package.json
index 79b0bc10..fcd568c2 100644
--- a/package.json
+++ b/package.json
@@ -56,6 +56,7 @@
"babel-runtime": "^6.11.6",
"browser-request": "^0.3.3",
"classnames": "^2.1.2",
+ "counterpart-riot": "^0.17.9",
"draft-js": "^0.8.1",
"extract-text-webpack-plugin": "^0.9.1",
"favico.js": "^0.3.10",
diff --git a/scripts/copy-res.js b/scripts/copy-res.js
index d3a2ee5e..4736d401 100755
--- a/scripts/copy-res.js
+++ b/scripts/copy-res.js
@@ -13,12 +13,32 @@ const COPY_LIST = [
["src/skins/vector/{fonts,img}/**", "webapp"],
["node_modules/emojione/assets/svg/*", "webapp/emojione/svg/"],
["node_modules/emojione/assets/png/*", "webapp/emojione/png/"],
- ["./config.json", "webapp", {directwatch: 1}],
+ ["./config.json", "webapp", { directwatch: 1 }],
+ ["src/i18n/", "webapp/i18n/", { languages: 1 }],
+ ["node_modules/matrix-react-sdk/src/i18n/strings/", "webapp/i18n/", { languages: 1 }],
];
const parseArgs = require('minimist');
const Cpx = require('cpx');
const chokidar = require('chokidar');
+const fs = require('fs');
+const rimraf = require('rimraf');
+
+// cleanup language files before copying them.
+//rimraf("webapp/", function () { console.log('cleanup language files'); });
+
+//From http://stackoverflow.com/a/20525865/4929236
+function generateFileArray(dir, files_) {
+ files_ = files_ || [];
+ var files = fs.readdirSync(dir);
+ for (var i in files) {
+ var name = files[i];
+ if (name != 'basefile.json') {
+ files_.push(name);
+ }
+ }
+ return files_;
+}
const argv = parseArgs(
process.argv.slice(2), {}
@@ -45,8 +65,32 @@ function next(i, err) {
const source = ent[0];
const dest = ent[1];
const opts = ent[2] || {};
+ let cpx = undefined;
- const cpx = new Cpx.Cpx(source, dest);
+ if (opts.languages) {
+ const sourceFiles = generateFileArray(source);
+ let Sourcelanguages = {};
+ if (!fs.existsSync(dest)) {
+ fs.mkdirSync(dest);
+ }
+ sourceFiles.forEach(file => {
+ const fileContents = fs.readFileSync(source + file).toString();
+ Sourcelanguages[file] = JSON.parse(fileContents);
+ });
+ sourceFiles.forEach(file => {
+ if (!fs.existsSync(dest + file)) {
+ let o = Object.assign({}, Sourcelanguages[file]);
+ fs.writeFileSync(dest + file, JSON.stringify(o, null, 4));
+ } else {
+ const fileContents = fs.readFileSync(dest + file).toString();
+ let o = Object.assign(JSON.parse(fileContents), Sourcelanguages[file]);
+ fs.writeFileSync(dest + file, JSON.stringify(o, null, 4));
+ }
+ });
+
+ } else {
+ cpx = new Cpx.Cpx(source, dest);
+ }
if (verbose) {
cpx.on("copy", (event) => {
@@ -57,7 +101,7 @@ function next(i, err) {
});
}
- const cb = (err) => {next(i+1, err)};
+ const cb = (err) => { next(i + 1, err) };
if (watch) {
if (opts.directwatch) {
@@ -65,20 +109,65 @@ function next(i, err) {
// which in the case of config.json is '.', which inevitably takes
// ages to crawl. So we create our own watcher on the files
// instead.
- const copy = () => {cpx.copy(errCheck)};
+ const copy = () => { cpx.copy(errCheck) };
chokidar.watch(source)
.on('add', copy)
.on('change', copy)
.on('ready', cb)
.on('error', errCheck);
+ } else if (opts.languages) {
+ if (verbose) {
+ console.log('don\'t copy language file');
+ }
+ next(i + 1, err);
} else {
cpx.on('watch-ready', cb);
cpx.on("watch-error", cb);
cpx.watch();
}
+ } else if (opts.languages) {
+ if (verbose) {
+ console.log('don\'t copy language file');
+ }
+ next(i + 1, err);
} else {
cpx.copy(cb);
}
}
-next(0);
+// Generate Language List
+
+const testFolder = 'src/i18n/';
+let languages = {};
+// Check if webapp exists
+if (!fs.existsSync('webapp')) {
+ fs.mkdirSync('webapp');
+}
+// Check if i18n exists
+if (!fs.existsSync('webapp/i18n/')) {
+ fs.mkdirSync('webapp/i18n/');
+}
+
+if (!fs.existsSync('webapp/i18n/languages.json')) {
+ rimraf("webapp/i18n/languages.json", function() { console.log('cleanup languages.json file'); });
+}
+
+fs.readdir(testFolder, function(err, files) {
+ if (err) {
+ throw err;
+ }
+ files.forEach(function(file) {
+ var normalizedLanguage = file.toLowerCase().replace("_", "-").split('.json')[0];
+ var languageParts = normalizedLanguage.split('-');
+ if (file != 'basefile.json') {
+ if (languageParts.length == 2 && languageParts[0] == languageParts[1]) {
+ languages[languageParts[0]] = file;
+ } else {
+ languages[normalizedLanguage] = file;
+ }
+ }
+ });
+ fs.writeFile('webapp/i18n/languages.json', JSON.stringify(languages, null, 4));
+})
+
+next(0);
\ No newline at end of file
diff --git a/src/components/structures/BottomLeftMenu.js b/src/components/structures/BottomLeftMenu.js
index f378cac6..57da85eb 100644
--- a/src/components/structures/BottomLeftMenu.js
+++ b/src/components/structures/BottomLeftMenu.js
@@ -18,7 +18,8 @@ limitations under the License.
var React = require('react');
var ReactDOM = require('react-dom');
-var sdk = require('matrix-react-sdk')
+var sdk = require('matrix-react-sdk');
+import _t from 'counterpart-riot';
var dis = require('matrix-react-sdk/lib/dispatcher');
var AccessibleButton = require('matrix-react-sdk/lib/components/views/elements/AccessibleButton');
@@ -120,7 +121,7 @@ module.exports = React.createClass({
homeButton = (
- All messages (loud)
+ { _t('All messages (loud)') }
- All messages
+ { _t('All messages') }
- Mentions only
+ { _t('Mentions only') }
- Mute
+ { _t('Mute') }
- Favourite
+ { _t('Favourite') }
- Low Priority
+ { _t('Low Priority') }
- Direct Chat
+ { _t('Direct Chat') }
