Merge branch 'develop' into patch-1

.babelrc

@@ -1,4 +1,4 @@
 {
   "presets": ["react", "es2015", "es2016"],
-  "plugins": ["transform-class-properties", "transform-object-rest-spread", "transform-async-to-generator", "transform-runtime", "add-module-exports"]
+  "plugins": ["transform-class-properties", "transform-object-rest-spread", "transform-async-to-bluebird", "transform-runtime", "add-module-exports"]
 }

.editorconfig

@@ -0,0 +1,23 @@
+#   Copyright 2017 Aviral Dasgupta
+#
+#   Licensed under the Apache License, Version 2.0 (the "License");
+#   you may not use this file except in compliance with the License.
+#   You may obtain a copy of the License at
+#
+#       http://www.apache.org/licenses/LICENSE-2.0
+#
+#   Unless required by applicable law or agreed to in writing, software
+#   distributed under the License is distributed on an "AS IS" BASIS,
+#   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#   See the License for the specific language governing permissions and
+#   limitations under the License.
+
+root = true
+
+[*]
+charset=utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true

.eslintignore

@@ -0,0 +1,2 @@
+src/vector/modernizr.js
+src/component-index.js

.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+    extends: ["./node_modules/matrix-react-sdk/.eslintrc.js"],
+}

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,46 @@
+<!-- Please report security issues by email to security@matrix.org -->
+
+<!-- This is a bug report template. By following the instructions below and
+filling out the sections with your information, you will help the us to get all
+the necessary data to fix your issue.
+
+You can also preview your report before submitting it. You may remove sections
+that aren't relevant to your particular case.
+
+Text between <!-- and --​> marks will be invisible in the report.
+-->
+
+### Description
+
+Describe here the problem that you are experiencing, or the feature you are requesting.
+
+### Steps to reproduce
+
+- For bugs, list the steps
+- that reproduce the bug
+- using hyphens as bullet points
+
+Describe how what happens differs from what you expected.
+
+Log: sent/not sent?    <!-- You can send us the app's logs via the 'Report bug'
+link on the 'Settings' page. Very important for hard-to-reproduce bugs. Please
+file a bug here too! -->
+
+<!-- Include screenshots if possible: you can drag and drop images below. -->
+
+### Version information
+
+<!-- IMPORTANT: please answer the following questions, to help us narrow down the problem -->
+
+- **Platform**: web (in-browser) or desktop?
+
+For the web app:
+
+- **Browser**: Chrome, Safari, Firefox? which version?
+- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
+- **URL**: riot.im/develop / riot.im/app / somewhere else? If a private server, what version of riot-web?
+
+For the desktop app:
+
+- **OS**: Windows, macOS, Ubuntu, Arch Linux, etc?
+- **Version**: 0.x.y <!-- check the user settings panel if unsure -->

.gitignore

@@ -5,6 +5,8 @@
 /key.pem
 /lib
 /node_modules
+/electron_app/node_modules
+/electron_app/dist
 /packages/
 /webapp
 /.npmrc
@@ -12,3 +14,6 @@
 npm-debug.log
 electron/dist
 electron/pub
+**/.idea
+/config.json
+/src/component-index.js

.modernizr.json

@@ -9,6 +9,8 @@
     "test/css/flexbox",
     "test/es5/specification",
     "test/css/objectfit",
-    "test/storage/localstorage"
+    "test/storage/localstorage",
+    "test/workers/webworkers",
+    "test/indexeddb"
   ]
-}
+}

.travis.yml

@@ -1,6 +1,32 @@
+# we need trusty for the chrome addon
+dist: trusty
+
+# we don't need sudo, so can run in a container, which makes startup much
+# quicker.
+sudo: false
+
 language: node_js
 node_js:
-    - 6   # node v6, to match jenkins
+    # make sure we work with a range of node versions.
+    # As of the time of writing:
+    #  - 4.x is still in LTS (until April 2018), but some of our deps (notably
+    #    extract-zip) don't work with it
+    #  - 5.x has been EOLed for nearly a year.
+    #  - 6.x is the active 'LTS' version
+    #  - 7.x is no longer supported
+    #  - 8.x is the current 'current' version (until October 2017)
+    #
+    # see: https://github.com/nodejs/LTS/
+    #
+    # anything before 6.3 ships with npm 3.9 or earlier, which had problems
+    # with symlinks in node_modules (see
+    # https://github.com/npm/npm/releases/tag/v3.10.0 'FIXES AND REFACTORING').
+    - 6.3
+    - 6
+    - 7
+addons:
+    chrome: stable
 install:
-    - npm install
+    # clone the deps with depth 1: we know we will only ever need that one
-    - (cd node_modules/matrix-react-sdk && npm run build)
+    # commit.
+    - scripts/fetch-develop.deps.sh --depth 1 && npm install

AUTHORS.rst

@@ -10,3 +10,9 @@ include:
 
 * Florent VIOLLEAU (https://github.com/floviolleau) <floviolleau at gmail dot com>
   Improve README.md for a better understanding of installation instructions
+
+* Michael Telatynski (https://github.com/t3chguy)
+  Improved consistency of inverted elements in dark theme across browsers
+
+* Alexandr Korsak (https://github.com/oivoodoo)
+  Improved multiple file uploading

CONTRIBUTING.rst

@@ -1,4 +1,4 @@
-Contributing code to Vector
+Contributing code to Riot
-===========================
+=========================
 
-Vector follows the same pattern as https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst
+Riot follows the same pattern as https://github.com/matrix-org/synapse/blob/master/CONTRIBUTING.rst.

README.md

@@ -14,13 +14,16 @@ https://riot.im/develop for those who like living dangerously.
 To host your own copy of Riot, the quickest bet is to use a pre-built
 released version of Riot:
 
-1. Download the latest version from https://github.com/vector-im/vector-web/releases
+1. Download the latest version from https://github.com/vector-im/riot-web/releases
 1. Untar the tarball on your web server
-1. Move (or symlink) the vector-x.x.x directory to an appropriate name
+1. Move (or symlink) the riot-x.x.x directory to an appropriate name
 1. If desired, copy `config.sample.json` to `config.json` and edit it
    as desired. See below for details.
 1. Enter the URL into your browser and log into Riot!
 
+Releases are signed by PGP, and can be checked against the public key
+at https://riot.im/packages/keys/riot.asc
+
 Note that Chrome does not allow microphone or webcam access for sites served
 over http (except localhost), so for working VoIP you will need to serve Riot
 over https.
@@ -44,7 +47,7 @@ access to Riot (or other apps) due to sharing the same domain.
 
 We have put some coarse mitigations into place to try to protect against this
 situation, but it's still not good practice to do it in the first place.  See
-https://github.com/vector-im/vector-web/issues/1977 for more details.
+https://github.com/vector-im/riot-web/issues/1977 for more details.
 
 Building From Source
 ====================
@@ -52,16 +55,41 @@ Building From Source
 Riot is a modular webapp built with modern ES6 and requires a npm build system
 to build.
 
-1. Install or update `node.js` so that your `npm` is at least at version `2.0.0`
+1. Install or update `node.js` so that your `node` is at least v6.3.0 (and `npm`
-1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git`
+   is at least v3.10.x).
-1. Switch to the vector-web directory: `cd vector-web`
+1. Clone the repo: `git clone https://github.com/vector-im/riot-web.git`.
-1. Install the prerequisites: `npm install`
+1. Switch to the riot-web directory: `cd riot-web`.
-1. If you are using the `develop` branch of vector-web, you will probably need
+1. If you're using the `develop` branch, install the develop versions of the
-   to rebuild one of the dependencies, due to
+   dependencies, as the released ones will be too old:
-   https://github.com/npm/npm/issues/3055: `(cd node_modules/matrix-react-sdk
+   ```
-   && npm install)`
+   scripts/fetch-develop.deps.sh
+   ```
+   Whenever you git pull on riot-web you will also probably need to force an update
+   to these dependencies - the simplest way is to re-run the script, but you can also
+   manually update and rebuild them:
+   ```
+   cd matrix-js-sdk
+   git pull
+   npm install # re-run to pull in any new dependencies
+   # Depending on your version of npm, npm run build may happen as part of
+   # the npm install above (https://docs.npmjs.com/misc/scripts#prepublish-and-prepare)
+   # If in doubt, run it anyway:
+   npm run build
+   cd ../matrix-react-sdk
+   git pull
+   npm install
+   npm run build
+   ```
+   However, we recommend setting up a proper development environment (see "Setting
+   up a dev environment" below) if you want to run your own copy of the
+   `develop` branch, as it makes it much easier to keep these dependencies
+   up-to-date.  Or just use https://riot.im/develop - the continuous integration
+   release of the develop branch.
+   (Note that we don't reference the develop versions in git directly due to
+   https://github.com/npm/npm/issues/3055.)
+1. Install the prerequisites: `npm install`.
 1. Configure the app by copying `config.sample.json` to `config.json` and
-   modifying it (see below for details)
+   modifying it (see below for details).
 1. `npm run dist` to build a tarball to deploy. Untaring this file will give
    a version-specific directory containing all the files that need to go on your
    web server.
@@ -87,7 +115,9 @@ You can configure the app by copying `config.sample.json` to
    addresses) to matrix IDs: see http://matrix.org/docs/spec/identity_service/unstable.html
    for more details.  Currently the only public matrix identity servers are https://matrix.org
    and https://vector.im.  In future identity servers will be decentralised.
-1. `integrations_ui_url`: URL to the web interface for the integrations server.
+1. `integrations_ui_url`: URL to the web interface for the integrations server. The integrations
+   server is not Riot and normally not your Home Server either. The integration server settings
+   may be left blank to disable integrations.
 1. `integrations_rest_url`: URL to the REST interface for the integrations server.
 1. `roomDirectory`: config for the public room directory. This section is optional.
 1. `roomDirectory.servers`: List of other Home Servers' directories to include in the drop
@@ -105,16 +135,19 @@ Running as a Desktop app
 ========================
 
 Riot can also be run as a desktop app, wrapped in electron. You can download a
-pre-built version from https://riot.im/download/desktop/ or, if you prefer,
+pre-built version from https://riot.im/desktop.html or, if you prefer,
-built it yourself.
+build it yourself. Requires Electron >=1.6.0
 
 To run as a desktop app:
-```
+
-npm install
+1. Follow the instructions in 'Building From Source' above, but run
-npm install electron
+   `npm run build` instead of `npm run dist` (since we don't need the tarball).
-npm run build
+2. Install electron and run it:
-node_modules/.bin/electron .
+
-```
+   ```
+   npm install electron
+   npm run electron
+   ```
 
 To build packages, use electron-builder. This is configured to output:
  * dmg + zip for macOS
@@ -137,11 +170,9 @@ npm run build:electron
 
 For other packages, use electron-builder manually. For example, to build a package
 for 64 bit Linux:
-```
+
-npm install
+ 1. Follow the instructions in 'Building From Source' above
-npm run build
+ 2. `node_modules/.bin/build -l --x64`
-node_modules/.bin/build -l --x64
-```
 
 All electron packages go into `electron/dist/`
 
@@ -175,13 +206,13 @@ the `component-index.js` for the app (used in future for skinning)
 development on Riot forcing `matrix-react-sdk` to move fast at the expense of
 maintaining a clear abstraction between the two.**  Hacking on Riot inevitably
 means hacking equally on `matrix-react-sdk`, and there are bits of
-`matrix-react-sdk` behaviour incorrectly residing in the `vector-web` project
+`matrix-react-sdk` behaviour incorrectly residing in the `riot-web` project
 (e.g. matrix-react-sdk specific CSS), and a bunch of Riot specific behaviour
 in the `matrix-react-sdk` (grep for `vector` / `riot`).  This separation problem will be
 solved asap once development on Riot (and thus matrix-react-sdk) has
 stabilised.  Until then, the two projects should basically be considered as a
 single unit.  In particular, `matrix-react-sdk` issues are currently filed
-against `vector-web` in github.
+against `riot-web` in github.
 
 Please note that Riot is intended to run correctly without access to the public
 internet.  So please don't depend on resources (JS libs, CSS, images, fonts)
@@ -216,15 +247,14 @@ Then similarly with `matrix-react-sdk`:
 
 Finally, build and start Riot itself:
 
-1. `git clone git@github.com:vector-im/vector-web.git`
+1. `git clone git@github.com:vector-im/riot-web.git`
-1. `cd vector-web`
+1. `cd riot-web`
 1. `git checkout develop`
 1. `npm install`
 1. `rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/`
 1. `rm -r node_modules/matrix-react-sdk; ln -s ../../matrix-react-sdk node_modules/`
 1. `npm start`
 1. Wait a few seconds for the initial build to finish; you should see something like:
-
     ```
     Hash: b0af76309dd56d7275c8
     Version: webpack 1.12.14
@@ -241,10 +271,10 @@ Finally, build and start Riot itself:
    disables caching, so do NOT use it in production.
 1. Open http://127.0.0.1:8080/ in your browser to see your newly built Riot.
 
-When you make changes to `matrix-react-sdk`, you will need to run `npm run
+When you make changes to `matrix-react-sdk` or `matrix-js-sdk`, you will need
-build` in the relevant directory. You can do this automatically by instead
+to run `npm run build` in the relevant directory. You can do this automatically
-running `npm start` in the directory, to start a development builder which
+by instead running `npm start` in the directory, to start a development builder
-will watch for changes to the files and rebuild automatically.
+which will watch for changes to the files and rebuild automatically.
 
 If you add or remove any components from the Riot skin, you will need to rebuild
 the skin's index by running, `npm run reskindex`.
@@ -253,27 +283,62 @@ 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.
 
+Running the tests
+-----------------
+
+There are a number of application-level tests in the `tests` directory; these
+are designed to run in a browser instance under the control of
+[karma](https://karma-runner.github.io). To run them:
+
+* Make sure you have Chrome installed (a recent version, like 59)
+* Make sure you have `matrix-js-sdk` and `matrix-react-sdk` installed and
+  built, as above
+* `npm run test`
+
+The above will run the tests under Chrome in a `headless` mode.
+
+You can also tell karma to run the tests in a loop (every time the source
+changes), in an instance of Chrome on your desktop, with `npm run
+test-multi`. This also gives you the option of running the tests in 'debug'
+mode, which is useful for stepping through the tests in the developer tools.
+
+Translations
+============
+
+To add a new translation, head to the [translating doc](docs/translating.md).
+
+For a developer guide, see the [translating dev doc](docs/translating-dev.md).
+
+[<img src="https://translate.riot.im/widgets/riot-web/-/multi-auto.svg" alt="translationsstatus" width="340">](https://translate.riot.im/engage/riot-web/?utm_source=widget)
+
 Triaging issues
 ===============
 
 Issues will be triaged by the core team using the following primary set of tags:
 
 priority:
-    P1: top priority; typically blocks releases.
+
-    P2: one below that
+* P1: top priority; typically blocks releases
-    P3: non-urgent
+* P2: still need to fix, but lower than P1
-    P4/P5: bluesky some day, who knows.
+* P3: non-urgent
+* P4: intereseting idea - bluesky some day
+* P5: recorded for posterity/to avoid duplicates. No intention to resolves right now.
 
 bug or feature:
-  bug severity:
-     * cosmetic - feature works functionally but UI/UX is broken.
-     * critical - whole app doesn't work
-     * major - entire feature doesn't work
-     * minor - partially broken feature (but still usable)
 
-     * release blocker
+* bug
+* feature
 
-     * ui/ux (think of this as cosmetic)
+bug severity:
 
-     * network (specific to network conditions)
+* cosmetic - feature works functionally but UI/UX is broken
-     * platform (platform specific)
+* critical - whole app doesn't work
+* major - entire feature doesn't work
+* minor - partially broken feature (but still usable)
+
+additional categories:
+
+* release blocker
+* ui/ux (think of this as cosmetic)
+* network (specific to network conditions)
+* platform (platform specific)

config.sample.json

@@ -1,13 +1,29 @@
 {
     "default_hs_url": "https://matrix.org",
     "default_is_url": "https://vector.im",
+    "disable_custom_urls": false,
+    "disable_guests": false,
+    "disable_login_language_selector": false,
+    "disable_3pid_login": false,
     "brand": "Riot",
     "integrations_ui_url": "https://scalar.vector.im/",
     "integrations_rest_url": "https://scalar.vector.im/api",
-    "enableLabs": true,
+    "bug_report_endpoint_url": "https://riot.im/bugreports/submit",
+    "features": {
+        "feature_groups": "labs",
+        "feature_pinning": "labs"
+    },
+    "default_federate": true,
+    "welcomePageUrl": "home.html",
+    "default_theme": "light",
     "roomDirectory": {
         "servers": [
             "matrix.org"
         ]
+    },
+    "welcomeUserId": "@riot-bot:matrix.org",
+    "piwik": {
+        "url": "https://piwik.riot.im/",
+        "siteId": 1
     }
 }

docs/skinning thoughts.md

@@ -0,0 +1,68 @@
+== Skinning refactor ==
+
+matrix-react-sdk
+  - base images
+  - base CSS
+  - all the components needed to build a workable app (including the top layer)
+
+riot-web: the riot skin
+  - riot-specific classes (e.g. login header/footer)
+  - riot-specific themes
+    - light
+    - dark
+
+i.e. the only things which should go into riot-web are bits which apply vector-specific skinning
+specifically "Stuff that any other brand would not want to use. (e.g. riot logos, links, T&Cs)"
+ - Questions:
+   - Electron app?  (should probably be a separate repo in its own right?  but might as well go here for now)
+   - index.html & index.js?  (should be in matrix-react-sdk, given the SDK is useless without them?)
+
+ideally matrix-react-sdk itself should ship with a default skin which actually works built in.
+
+status skin (can go in the same app for now)
+  - has status theme
+    - which inherits from riot light theme
+    - how do we share graphics between skins?
+      - shove them into react-sdk, or...
+      - guess we do ../../vector/img 
+      - this means keeping the skin name in the images (unless /img is a shortcut to the right skin's images)
+
+out of scope:
+  - making the components more independent, so they can be used in isolation.
+  - that said, the bits which should probably be used by being embeded into a different app:
+    - login/reg
+    - RoomView + RoomSettings
+    - MessageComposer
+    - RoomList
+    - MemberList
+    - MemberInfo
+    - Voip UI
+    - UserSettings
+  - sharing different js-sdks between the different isolated modules
+
+other changes:
+  - how do we handle i18n?
+    - each skin should really be its own i18n project.  As long as all the commonality stuff is in matrix-react-sdk this shouldn't be too bad.
+  - ability to associate components with a given skin
+    - skins/vector/src <-- components
+    - skins/vector/css
+    - skins/vector/img
+    - skins/vector/fonts
+  - gather together themes (per skin) into a single place too
+    - skins/vector/themes/foo/css
+    - skins/vector/themes/foo/img
+    - skins/vector/themes/foo/fonts
+  - ideally riot-web would contain almost nothing but skins/vector directory. 
+  - ability to entirely replace CSS rather than override it for a given theme
+    - e.g. if we replace `Login.js` with `StatusLogin.js`, then we should similarly be able to replace `_Login.scss` with `_StatusLogin.scss`.
+
+random thoughts;
+   - should we be able to change the entire skin at runtime (more like wordpress) - to the extent of replacing entire components?
+     - might pose security issues if a theme can be swapped out to replace MatrixChat or other fundamental functionality at runtime
+   - if so, perhaps skins & themes should converge...
+
+-----------------
+
+Immediate plan for Status:
+ * Implement it as a theme for the riot skin
+ * Ideally move skins to a sensible level (possibly even including src?)

docs/theming.md

@@ -0,0 +1,25 @@
+Theming Riot
+============
+
+Themes are a very basic way of providing simple alternative look & feels to the
+riot-web app via CSS & custom imagery.
+
+They are *NOT* co be confused with 'skins', which describe apps which sit on top
+of matrix-react-sdk - e.g. in theory Riot itself is a react-sdk skin.
+As of Jan 2017, skins are not fully supported; riot is the only available skin.
+
+To define a theme for Riot:
+
+ 1. Pick a name, e.g. `teal`. at time of writing we have `light` and `dark`.
+ 2. Fork `src/skins/vector/css/themes/dark.scss` to be teal.scss
+ 3. Fork `src/skins/vector/css/themes/_base.scss` to be _teal.scss
+ 4. Override variables in _teal.scss as desired. You may wish to delete ones
+    which don't differ from _base.scss, to make it clear which are being
+    overridden. If every single colour is being changed (as per _dark.scss)
+    then you might as well keep them all.
+ 5. Add the theme to the list of entrypoints in webpack.config.js
+ 6. Add the theme to the list of themes in matrix-react-sdk's UserSettings.js
+ 7. Sit back and admire your handywork.
+
+In future, the assets for a theme will probably be gathered together into a
+single directory tree.

docs/translating-dev.md

@@ -0,0 +1,55 @@
+# 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
+
+## Translating strings vs. marking strings for translation
+
+Translating strings are done with the `_t()` function found in matrix-react-sdk/lib/languageHandler.js. It is recommended to call this function wherever you introduce a string constant which should be translated. However, translating can not be performed until after the translation system has been initialized. Thus, sometimes translation must be performed at a different location in the source code than where the string is introduced. This breaks some tooling and makes it difficult to find translatable strings. Therefore, there is the alternative `_td()` function which is used to mark strings for translation, without actually performing the translation (which must still be performed separately, and after the translation system has been initialized).
+
+Basically, whenever a translatable string is introduced, you should call either `_t()` immediately OR `_td()` and later `_t()`.
+
+Example:
+```
+// Module-level constant
+const COLORS = {
+    '#f8481c': _td('reddish orange'), // Can't call _t() here yet
+    '#fc2647': _td('pinky red') // Use _td() instead so the text is picked up for translation anyway
+}
+
+// Function that is called some time after i18n has been loaded
+function getColorName(hex) {
+    return _t(COLORS[hex]); // Perform actual translation here
+}
+```
+
+## Adding new strings
+
+ 1. Check if the import ``import { _t } from 'matrix-react-sdk/lib/languageHandler';`` is present. If not add it to the other import statements. Also import `_td` if needed.
+ 1. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method). If the string is introduced at a point before the translation system has not yet been initialized, use `_td()` instead, and call `_t()` at the appropriate time.
+ 1. Run `npm run i18n` to update ``src/i18n/strings/en_EN.json`` (if it fails because it can't find the script, your dev environment predates the script, so reinstall/link react-sdk with `npm link ../matrix-react-sdk`). If it segfaults, you may be on Node 6, so try a newer version of node.
+ 1. If you added a string with a plural, you can add other English plural variants to ``src/i18n/strings/en_EN.json`` (remeber to edit the one in the same project as the source file containing your new translation).
+
+## Adding variables inside a string.
+
+1. Extend your ``_t()`` call. Instead of ``_t(STRING)`` use ``_t(STRING, {})``
+1. Decide how to name it. Please think about if the person who has to translate it can understand what it does. E.g. using the name 'recipient' is bad, because a translator does not know if it is the name of a person, an email address, a user ID, etc. Rather use e.g. recipientEmailAddress.
+1. Add it to the array in ``_t`` for example ``_t(STRING, {variable: this.variable})``
+1. 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.
+
+- You can use the special ``count`` variable to choose between multiple versions of the same string, in order to get the correct pluralization. E.g. ``_t('You have %(count)s new messages', { count: 2 })`` would show 'You have 2 new messages', while ``_t('You have %(count)s new messages', { count: 1 })`` would show 'You have one new message' (assuming a singular version of the string has been added to the translation file. See above). Passing in ``count`` is much prefered over having an if-statement choose the correct string to use, because some languages have much more complicated plural rules than english (e.g. they might need a completely different form if there are three things rather than two).
+- If you want to translate text that includes e.g. hyperlinks or other HTML you have to also use tag substitution, e.g. ``_t('<a>Click here!</a>', {}, { 'a': (sub) => <a>{sub}</a> })``. If you don't do the tag substitution you will end up showing literally '<a>' rather than making a hyperlink.
+- You can also use React components with normal variable substitution if you want to insert HTML markup, e.g. ``_t('Your email address is %(emailAddress)s', { emailAddress: <i>{userEmailAddress}</i> })``.
+
+## Things to know/Style Guides
+
+- Do not use `_t()` inside ``getDefaultProps``: the translations aren't loaded when `getDefaultProps` is called, leading to missing translations. Use `_td()` to indicate that `_t()` will be called on the string later.
+- If using translated strings as constants, translated strings can't be in constants loaded at class-load time since the translations won't be loaded. Mark the strings using `_td()` instead and perform the actual translation later.
+- If a string is presented in the UI with punctuation like a full stop, include this in the translation strings, since punctuation varies between languages too.
+- Avoid "translation in parts", i.e. concatenating translated strings or using translated strings in variable substitutions. Context is important for translations, and translating partial strings this way is simply not always possible.
+- Concatenating strings often also introduces an implicit assumption about word order (e.g. that the subject of the sentence comes first), which is incorrect for many languages.
+- Translation 'smell test': If you have a string that does not begin with a capital letter (is not the start of a sentence) or it ends with e.g. ':' or a preposition (e.g. 'to') you should recheck that you are not trying to translate a partial sentence.
+- If you have multiple strings, that are almost identical, except some part (e.g. a word or two) it is still better to translate the full sentence multiple times. It may seem like inefficient repetion, but unlike programming where you try to minimize repetition, translation is much faster if you have many, full, clear, sentences to work with, rather than fewer, but incomplete sentence fragments.

docs/translating.md

@@ -0,0 +1,64 @@
+# 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 0: Join #riotweb-translations:matrix.org
+
+1. Come and join https://matrix.to/#/#riotweb-translations:matrix.org
+2. Read scrollback and/or ask if anyone else is working on your language, and co-ordinate if needed.  In general little-or-no coordination is needed though :)
+
+## Step 1: Preparing your Weblate Profile
+
+1. Head to https://translate.riot.im and register either via Github or email
+2. After registering check if you got an 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.riot.im/accounts/profile/ and select the languages you know and maybe another language you know too.
+6. Head to https://translate.riot.im/accounts/profile/#subscriptions and select Riot Web as Project
+
+## How to check if your language already is being translated
+
+Go to https://translate.riot.im/projects/riot-web/ and visit the 2 sub-projects.
+If your language is listed go to Step 2a and if not go to Step 2b
+
+## Step 2a: Helping on existing languages.
+
+1. Head to one of the projects listed https://translate.riot.im/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.riot.im/projects/riot-web/
+2. Click the ``Start new language`` button at the bottom
+3. Select a 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
+
+### 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 adds a new suggestion to the string which can than be reviewed by others.
+
+### What are "%(something)s"?
+
+These things are variables that are expanded when displayed by Riot. They can be room names, usernames or similar. If you find one, you can move to the right place for your language, but not delete it as the variable will be missing if you do.
+
+A special case is `%(urlStart)s` and `%(urlEnd)s` which are used to mark the beginning of a hyperlink (i.e. `<a href="/somewhere">` and `</a>`.  You must keep these markers surrounding the equivalent string in your language that needs to be hyperlinked.
+
+### "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 Weblate doc provides some more in-deepth explanation on how to do translations and talks about do and don'ts. You can find it at: https://docs.weblate.org/en/latest/user/translating.html

electron/riot.im/config.json

@@ -1,72 +0,0 @@
-{
-    "update_base_url": "https://riot.im/download/desktop/update/",
-    "default_hs_url": "https://matrix.org",
-    "default_is_url": "https://vector.im",
-    "brand": "Riot",
-    "integrations_ui_url": "https://scalar.vector.im/",
-    "integrations_rest_url": "https://scalar.vector.im/api",
-    "enableLabs": true,
-    "roomDirectory": {
-        "servers": [
-            "matrix.org"
-        ],
-        "serverConfig": {
-            "matrix.org": {
-                "networks": [
-                    "_matrix",
-                    "gitter",
-                    "irc:freenode",
-                    "irc:mozilla",
-                    "irc:snoonet",
-                    "irc:oftc"
-                ]
-            }
-        },
-        "networks": {
-            "gitter": {
-                "protocol": "gitter",
-                "portalRoomPattern": "#gitter_.*:matrix.org",
-                "name": "Gitter",
-                "icon": "https://gitter.im/favicon.ico",
-                "example": "org/community",
-                "nativePattern": "[^\\s]+/[^\\s]+$"
-            },
-            "irc:freenode": {
-                "protocol": "irc",
-                "domain": "chat.freenode.net",
-                "portalRoomPattern": "#freenode_.*:matrix.org",
-                "name": "Freenode",
-                "icon": "https://matrix.org/_matrix/media/v1/download/matrix.org/DHLHpDDgWNNejFmrewvwEAHX",
-                "example": "#channel",
-                "nativePattern": "^#[^\\s]+$"
-            },
-            "irc:mozilla": {
-                "protocol": "irc",
-                "domain": "chat.freenode.net",
-                "portalRoomPattern": "#mozilla_.*:matrix.org",
-                "name": "Mozilla",
-                "icon": "https://matrix.org/_matrix/media/v1/download/matrix.org/DHLHpDDgWNNejFmrewvwEAHX",
-                "example": "#channel",
-                "nativePattern": "^#[^\\s]+$"
-            },
-            "irc:snoonet": {
-                "protocol": "irc",
-                "domain": "ipv6-irc.snoonet.org",
-                "portalRoomPattern": "#_snoonet_.*:matrix.org",
-                "name": "Snoonet",
-                "icon": "https://matrix.org/_matrix/media/v1/download/matrix.org/DHLHpDDgWNNejFmrewvwEAHX",
-                "example": "#channel",
-                "nativePattern": "^#[^\\s]+$"
-            },
-            "irc:oftc": {
-                "protocol": "irc",
-                "domain": "irc.oftc.net",
-                "portalRoomPattern": "#_oftc_.*:matrix.org",
-                "name": "OFTC",
-                "icon": "https://matrix.org/_matrix/media/v1/download/matrix.org/DHLHpDDgWNNejFmrewvwEAHX",
-                "example": "#channel",
-                "nativePattern": "^#[^\\s]+$"
-            }
-        }
-    }
-}

electron/src/electron-main.js

@@ -1,214 +0,0 @@
-// @flow
-
-/*
-Copyright 2016 Aviral Dasgupta
-Copyright 2016 OpenMarket Ltd
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-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 electron = require('electron');
-const url = require('url');
-
-const VectorMenu = require('./vectormenu');
-
-let vectorConfig = {};
-try {
-    vectorConfig = require('../../webapp/config.json');
-} catch (e) {
-    // it would be nice to check the error code here and bail if the config
-    // is unparseable, but we get MODULE_NOT_FOUND in the case of a missing
-    // file or invalid json, so node is just very unhelpful.
-    // Continue with the defaults (ie. an empty config)
-}
-
-const PERMITTED_URL_SCHEMES = [
-    'http:',
-    'https:',
-    'mailto:',
-];
-
-const UPDATE_POLL_INTERVAL_MS = 60 * 60 * 1000;
-const INITIAL_UPDATE_DELAY_MS = 30 * 1000;
-
-let mainWindow = null;
-let appQuitting = false;
-
-function safeOpenURL(target) {
-    // openExternal passes the target to open/start/xdg-open,
-    // 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) {
-        // 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);
-    }
-}
-
-function onWindowOrNavigate(ev, target) {
-    // always prevent the default: if something goes wrong,
-    // we don't want to end up opening it in the electron
-    // app, as we could end up opening any sort of random
-    // url in a window that has node scripting access.
-    ev.preventDefault();
-    safeOpenURL(target);
-}
-
-function onLinkContextMenu(ev, params) {
-    const popup_menu = new electron.Menu();
-    popup_menu.append(new electron.MenuItem({
-        label: params.linkURL,
-        click() {
-            safeOpenURL(params.linkURL);
-        },
-    }));
-    popup_menu.popup();
-    ev.preventDefault();
-}
-
-function installUpdate() {
-    // for some reason, quitAndInstall does not fire the
-    // before-quit event, so we need to set the flag here.
-    appQuitting = true;
-    electron.autoUpdater.quitAndInstall();
-}
-
-function pollForUpdates() {
-    try {
-        electron.autoUpdater.checkForUpdates();
-    } catch (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 + '/';
-    }
-    try {
-        // For reasons best known to Squirrel, the way it checks for updates
-        // is completely different between macOS and windows. On macOS, it
-        // 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') {
-            electron.autoUpdater.setFeedURL(update_base_url + 'macos/');
-        } else if (process.platform == 'win32') {
-            electron.autoUpdater.setFeedURL(update_base_url + '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");
-        }
-        // 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:
-        // every hour should be just fine for a desktop app)
-        // However, we still let the main window listen for the update events.
-        // We also wait a short time before checking for updates the first time because
-        // of squirrel on windows and it taking a small amount of time to release a
-        // lock file.
-        setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
-        setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
-    } catch (err) {
-        // will fail if running in debug mode
-        console.log("Couldn't enable update checking", err);
-    }
-}
-
-// handle uncaught errors otherwise it displays
-// stack traces in popup dialogs, which is terrible (which
-// it will do any time the auto update poke fails, and there's
-// no other way to catch this error).
-// Assuming we generally run from the console when developing,
-// this is far preferable.
-process.on('uncaughtException', function (error) {
-    console.log("Unhandled exception", error);
-});
-
-electron.ipcMain.on('install_update', installUpdate);
-
-electron.app.on('ready', () => {
-    if (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");
-    }
-
-    const icon_path = `${__dirname}/../img/riot.` + (
-        process.platform == 'win32' ? 'ico' : 'png'
-    );
-
-    mainWindow = new electron.BrowserWindow({
-        icon: icon_path,
-        width: 1024, height: 768,
-        show: false,
-    });
-    mainWindow.loadURL(`file://${__dirname}/../../webapp/index.html`);
-    electron.Menu.setApplicationMenu(VectorMenu);
-
-    mainWindow.once('ready-to-show', () => {
-        mainWindow.show();
-    });
-    mainWindow.on('closed', () => {
-        mainWindow = null;
-    });
-    mainWindow.on('close', (e) => {
-        if (process.platform == 'darwin' && !appQuitting) {
-            // On Mac, closing the window just hides it
-            // (this is generally how single-window Mac apps
-            // behave, eg. Mail.app)
-            e.preventDefault();
-            mainWindow.hide();
-            return false;
-        }
-    });
-
-    mainWindow.webContents.on('new-window', onWindowOrNavigate);
-    mainWindow.webContents.on('will-navigate', onWindowOrNavigate);
-
-    mainWindow.webContents.on('context-menu', function(ev, params) {
-        if (params.linkURL) {
-            onLinkContextMenu(ev, params);
-        }
-    });
-});
-
-electron.app.on('window-all-closed', () => {
-    electron.app.quit();
-});
-
-electron.app.on('activate', () => {
-    mainWindow.show();
-});
-
-electron.app.on('before-quit', () => {
-    appQuitting = true;
-});
-
-// Set the App User Model ID to match what the squirrel
-// installer uses for the shortcut icon.
-// This makes notifications work on windows 8.1 (and is
-// a noop on other platforms).
-electron.app.setAppUserModelId('com.squirrel.riot-web.Riot');

electron/src/squirrelhooks.js

@@ -1,30 +0,0 @@
-const path = require('path');
-const spawn = require('child_process').spawn;
-const app = require('electron').app;
-
-function run_update_exe(args, done) {
-    const updateExe = path.resolve(path.dirname(process.execPath), 'Update.exe');
-    spawn(updateExe, args, {
-      detached: true
-    }).on('close', done);
-};
-
-function check_squirrel_hooks() {
-    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);
-        return true;
-    } else if (cmd === '--squirrel-uninstall') {
-        run_update_exe(['--removeShortcut=' + target + ''], app.quit);
-        return true;
-    } else if (cmd === '--squirrel-obsolete') {
-        app.quit();
-        return true;
-    }
-    return false;
-}
-
-module.exports = check_squirrel_hooks;

electron/src/vectormenu.js

@@ -1,201 +0,0 @@
-/*
-Copyright 2016 OpenMarket Ltd
-
-Licensed under the Apache License, Version 2.0 (the "License");
-you may not use this file except in compliance with the License.
-You may obtain a copy of the License at
-
-    http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing, software
-distributed under the License is distributed on an "AS IS" BASIS,
-WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-See the License for the specific language governing permissions and
-limitations under the License.
-*/
-
-const electron = 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'
-            }
-        ]
-    },
-    {
-        label: 'View',
-        submenu: [
-            {
-                type: 'separator'
-            },
-            {
-                role: 'resetzoom'
-            },
-            {
-                role: 'zoomin'
-            },
-            {
-                role: 'zoomout'
-            },
-            {
-                type: 'separator'
-            },
-            {
-                role: 'togglefullscreen'
-            },
-            {
-                label: 'Toggle Developer Tools',
-                accelerator: process.platform == 'darwin' ? 'Alt+Command+I' : 'Ctrl+Shift+I',
-                click: function(item, focusedWindow) {
-                    if (focusedWindow) focusedWindow.toggleDevTools();
-                }
-            }
-        ]
-    },
-    {
-        role: 'window',
-        submenu: [
-            {
-                role: 'minimize'
-            },
-            {
-                role: 'close'
-            }
-        ]
-    },
-    {
-        role: 'help',
-        submenu: [
-            {
-                label: 'riot.im',
-                click () { electron.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()
-    template.unshift({
-        label: name,
-        submenu: [
-            {
-                role: 'about'
-            },
-            {
-                type: 'separator'
-            },
-            {
-                role: 'services',
-                submenu: []
-            },
-            {
-                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'
-        },
-        {
-            label: 'Speech',
-            submenu: [
-                {
-                    role: 'startspeaking'
-                },
-                {
-                    role: 'stopspeaking'
-                }
-            ]
-        }
-    )
-    // Window menu.
-    // This also has specific functionality on macOS
-    template[3].submenu = [
-        {
-            label: 'Close',
-            accelerator: 'CmdOrCtrl+W',
-            role: 'close'
-        },
-        {
-            label: 'Minimize',
-            accelerator: 'CmdOrCtrl+M',
-            role: 'minimize'
-        },
-        {
-            label: 'Zoom',
-            role: 'zoom'
-        },
-        {
-            type: 'separator'
-        },
-        {
-            label: 'Bring All to Front',
-            role: 'front'
-        }
-    ]
-} else {
-    template.unshift({
-        label: 'File',
-        submenu: [
-            // For some reason, 'about' does not seem to work on windows.
-            /*{
-                role: 'about'
-            },*/
-            {
-                role: 'quit'
-            }
-        ]
-    });
-}
-
-module.exports = electron.Menu.buildFromTemplate(template)
-

electron_app/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "riot-web",
+  "productName": "Riot",
+  "main": "src/electron-main.js",
+  "version": "0.13.4",
+  "description": "A feature-rich client for Matrix.org",
+  "author": "Vector Creations Ltd.",
+  "dependencies": {
+    "auto-launch": "^5.0.1",
+    "electron-window-state": "^4.1.0",
+    "minimist": "^1.2.0",
+    "png-to-ico": "^1.0.2"
+  }
+}

electron_app/riot.im/New Vector Ltd.pem

@@ -0,0 +1,34 @@
+-----BEGIN CERTIFICATE-----
+MIIF0jCCBLqgAwIBAgIRAISYBqZi3VvCUeSfHXF+cbwwDQYJKoZIhvcNAQELBQAw
+gZExCzAJBgNVBAYTAkdCMRswGQYDVQQIExJHcmVhdGVyIE1hbmNoZXN0ZXIxEDAO
+BgNVBAcTB1NhbGZvcmQxGjAYBgNVBAoTEUNPTU9ETyBDQSBMaW1pdGVkMTcwNQYD
+VQQDEy5DT01PRE8gUlNBIEV4dGVuZGVkIFZhbGlkYXRpb24gQ29kZSBTaWduaW5n
+IENBMB4XDTE3MDgyMzAwMDAwMFoXDTIwMDgyMjIzNTk1OVowgdgxETAPBgNVBAUT
+CDEwODczNjYxMRMwEQYLKwYBBAGCNzwCAQMTAkdCMR0wGwYDVQQPExRQcml2YXRl
+IE9yZ2FuaXphdGlvbjELMAkGA1UEBhMCR0IxETAPBgNVBBEMCFdDMVIgNEFHMQ8w
+DQYDVQQIDAZMb25kb24xDzANBgNVBAcMBkxvbmRvbjEbMBkGA1UECQwSMjYgUmVk
+IExpb24gU3F1YXJlMRcwFQYDVQQKDA5OZXcgVmVjdG9yIEx0ZDEXMBUGA1UEAwwO
+TmV3IFZlY3RvciBMdGQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQC7
+X0HP3oM/SVr6PboD03ndtYTONZDcJ/GJ3EyYi6UNrcbKjuDHwPktx9hjAhNjcVkG
+lmuTEPluPj9DbvjaTrers0cQsAS1vJ0RHjLfA93Flg1ys9Q6OThUMw77FtFPtiJU
+z5cSYzfFAhn/4dv7BcgGptn+Mv/8CaTu+RUZJUgoSlRWcT1TREmxkzWotbblqsHO
+zjDmUg20tL5/qpt6BSWsNespf5udKQFXMtqkczBcLvBLmql0vurVcQy8BibB+Q89
+QKwRzwLgaIa7O8WEssFcW8uJe9s0SNtUy8ehbuoSxpA/DbHFwsiDbNA78vp7HrqM
+qY6t6OIgLtDYBFCfe/btAgMBAAGjggHaMIIB1jAfBgNVHSMEGDAWgBTfj/MgDOnK
+pgTYW1g3Kj2rRtyDSTAdBgNVHQ4EFgQUH+mDOdRkF3bYDxCWEaGB4lxiCxcwDgYD
+VR0PAQH/BAQDAgeAMAwGA1UdEwEB/wQCMAAwEwYDVR0lBAwwCgYIKwYBBQUHAwMw
+EQYJYIZIAYb4QgEBBAQDAgQQMEYGA1UdIAQ/MD0wOwYMKwYBBAGyMQECAQYBMCsw
+KQYIKwYBBQUHAgEWHWh0dHBzOi8vc2VjdXJlLmNvbW9kby5jb20vQ1BTMFUGA1Ud
+HwROMEwwSqBIoEaGRGh0dHA6Ly9jcmwuY29tb2RvY2EuY29tL0NPTU9ET1JTQUV4
+dGVuZGVkVmFsaWRhdGlvbkNvZGVTaWduaW5nQ0EuY3JsMIGGBggrBgEFBQcBAQR6
+MHgwUAYIKwYBBQUHMAKGRGh0dHA6Ly9jcnQuY29tb2RvY2EuY29tL0NPTU9ET1JT
+QUV4dGVuZGVkVmFsaWRhdGlvbkNvZGVTaWduaW5nQ0EuY3J0MCQGCCsGAQUFBzAB
+hhhodHRwOi8vb2NzcC5jb21vZG9jYS5jb20wJgYDVR0RBB8wHaAbBggrBgEFBQcI
+A6APMA0MC0dCLTEwODczNjYxMA0GCSqGSIb3DQEBCwUAA4IBAQBJ2aH4aixh0aiz
+4WKlK+LMVLHpQ2POE3FZYNpAW7o1q2YDGEADXdGrygPE9NCGNBXKo0CAemCYNWfX
+Ov/jdoiMfeqW3vrZ66oEy8OqbvJSwK1xmomWuYw3wYPWcPVG+YbWYD2CGdQu8jTz
+fzAJCpvAuY3Wji3fQjiecAC7JCSB4fBHa0ALJOmiSqKQUUpkXs5kW7O0lPBnHzNF
+2tQGltXMSIrq1QfFtcreMyKlwDOxPIh360dv5aHhaeSRDRKxq7uq5ikQF2gjKx4k
+ieg2HRbAW6fVPpFr4zRS5umpeZV3i06i11VQQPS/mA/OBEXyaqzx4mr6B7U6ptrp
+jMqiUv2w
+-----END CERTIFICATE-----

electron_app/riot.im/config.json

@@ -0,0 +1,23 @@
+{
+    "update_base_url": "https://riot.im/download/desktop/update/",
+    "default_hs_url": "https://matrix.org",
+    "default_is_url": "https://vector.im",
+    "brand": "Riot",
+    "integrations_ui_url": "https://scalar.vector.im/",
+    "integrations_rest_url": "https://scalar.vector.im/api",
+    "integrations_widgets_urls": [
+        "https://scalar-staging.riot.im/scalar/api",
+        "https://scalar.vector.im/api"
+    ],
+    "bug_report_endpoint_url": "https://riot.im/bugreports/submit",
+    "welcomeUserId": "@riot-bot:matrix.org",
+    "roomDirectory": {
+        "servers": [
+            "matrix.org"
+        ]
+    },
+    "piwik": {
+        "url": "https://piwik.riot.im/",
+        "siteId": 1
+    }
+}

electron_app/src/electron-main.js

@@ -0,0 +1,265 @@
+/*
+Copyright 2016 Aviral Dasgupta
+Copyright 2016 OpenMarket Ltd
+Copyright 2017 Michael Telatynski <7t3chguy@gmail.com>
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+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 checkSquirrelHooks = require('./squirrelhooks');
+if (checkSquirrelHooks()) return;
+
+const argv = require('minimist')(process.argv);
+const electron = require('electron');
+const AutoLaunch = require('auto-launch');
+
+const tray = require('./tray');
+const vectorMenu = require('./vectormenu');
+const webContentsHandler = require('./webcontents-handler');
+const updater = require('./updater');
+
+const windowStateKeeper = require('electron-window-state');
+
+if (argv.profile) {
+    electron.app.setPath('userData', `${electron.app.getPath('userData')}-${argv.profile}`);
+}
+
+let vectorConfig = {};
+try {
+    vectorConfig = require('../../webapp/config.json');
+} catch (e) {
+    // it would be nice to check the error code here and bail if the config
+    // is unparseable, but we get MODULE_NOT_FOUND in the case of a missing
+    // file or invalid json, so node is just very unhelpful.
+    // Continue with the defaults (ie. an empty config)
+}
+
+let mainWindow = null;
+global.appQuitting = false;
+
+
+// handle uncaught errors otherwise it displays
+// stack traces in popup dialogs, which is terrible (which
+// it will do any time the auto update poke fails, and there's
+// no other way to catch this error).
+// Assuming we generally run from the console when developing,
+// this is far preferable.
+process.on('uncaughtException', function(error) {
+    console.log('Unhandled exception', error);
+});
+
+let focusHandlerAttached = false;
+electron.ipcMain.on('setBadgeCount', function(ev, count) {
+    electron.app.setBadgeCount(count);
+    if (count === 0) {
+        mainWindow.flashFrame(false);
+    }
+});
+
+electron.ipcMain.on('loudNotification', function() {
+    if (process.platform === 'win32' && mainWindow && !mainWindow.isFocused() && !focusHandlerAttached) {
+        mainWindow.flashFrame(true);
+        mainWindow.once('focus', () => {
+            mainWindow.flashFrame(false);
+            focusHandlerAttached = false;
+        });
+        focusHandlerAttached = true;
+    }
+});
+
+let powerSaveBlockerId;
+electron.ipcMain.on('app_onAction', function(ev, payload) {
+    switch (payload.action) {
+        case 'call_state':
+            if (powerSaveBlockerId && electron.powerSaveBlocker.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) => {
+    // Someone tried to run a second instance, we should focus our window.
+    if (mainWindow) {
+        if (!mainWindow.isVisible()) mainWindow.show();
+        if (mainWindow.isMinimized()) mainWindow.restore();
+        mainWindow.focus();
+    }
+});
+
+if (shouldQuit) {
+    console.log('Other instance detected: exiting');
+    electron.app.exit();
+}
+
+
+const launcher = new AutoLaunch({
+    name: vectorConfig.brand || 'Riot',
+    isHidden: true,
+    mac: {
+        useLaunchAgent: true,
+    },
+});
+
+const settings = {
+    'auto-launch': {
+        get: launcher.isEnabled,
+        set: function(bool) {
+            if (bool) {
+                return launcher.enable();
+            } else {
+                return launcher.disable();
+            }
+        },
+    },
+};
+
+electron.ipcMain.on('settings_get', async function(ev) {
+    const data = {};
+
+    try {
+        await Promise.all(Object.keys(settings).map(async function (setting) {
+            data[setting] = await settings[setting].get();
+        }));
+
+        ev.sender.send('settings', data);
+    } catch(e) { console.error(e); }
+});
+
+electron.ipcMain.on('settings_set', function(ev, key, value) {
+    console.log(key, value);
+    if (settings[key] && settings[key].set) {
+        settings[key].set(value);
+    }
+});
+
+electron.app.on('ready', () => {
+
+    if (argv.devtools) {
+        try {
+            const { default: installExtension, REACT_DEVELOPER_TOOLS, REACT_PERF } = require('electron-devtools-installer');
+            installExtension(REACT_DEVELOPER_TOOLS)
+                .then((name) => console.log(`Added Extension: ${name}`))
+                .catch((err) => console.log('An error occurred: ', err));
+            installExtension(REACT_PERF)
+                .then((name) => console.log(`Added Extension: ${name}`))
+                .catch((err) => console.log('An error occurred: ', err));
+        } catch(e) {console.log(e);}
+    }
+
+
+    if (vectorConfig.update_base_url) {
+        console.log(`Starting auto update with base URL: ${vectorConfig.update_base_url}`);
+        updater.start(vectorConfig.update_base_url);
+    } else {
+        console.log('No update_base_url is defined: auto update is disabled');
+    }
+
+    const iconPath = `${__dirname}/../img/riot.${process.platform === 'win32' ? 'ico' : 'png'}`;
+
+    // Load the previous window state with fallback to defaults
+    const mainWindowState = windowStateKeeper({
+        defaultWidth: 1024,
+        defaultHeight: 768,
+    });
+
+    mainWindow = global.mainWindow = new electron.BrowserWindow({
+        icon: iconPath,
+        show: false,
+        autoHideMenuBar: true,
+
+        x: mainWindowState.x,
+        y: mainWindowState.y,
+        width: mainWindowState.width,
+        height: mainWindowState.height,
+    });
+    mainWindow.loadURL(`file://${__dirname}/../../webapp/index.html`);
+    electron.Menu.setApplicationMenu(vectorMenu);
+
+    // explicitly hide because setApplicationMenu on Linux otherwise shows...
+    // https://github.com/electron/electron/issues/9621
+    mainWindow.hide();
+
+    // Create trayIcon icon
+    tray.create({
+        icon_path: iconPath,
+        brand: vectorConfig.brand || 'Riot',
+    });
+
+    if (!argv.hidden) {
+        mainWindow.once('ready-to-show', () => {
+            mainWindow.show();
+        });
+    }
+
+    mainWindow.on('closed', () => {
+        mainWindow = global.mainWindow = null;
+    });
+    mainWindow.on('close', (e) => {
+        if (!global.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)
+            e.preventDefault();
+            mainWindow.hide();
+            return false;
+        }
+    });
+
+    if (process.platform === 'win32') {
+        // Handle forward/backward mouse buttons in Windows
+        mainWindow.on('app-command', (e, cmd) => {
+            if (cmd === 'browser-backward' && mainWindow.webContents.canGoBack()) {
+                mainWindow.webContents.goBack();
+            } else if (cmd === 'browser-forward' && mainWindow.webContents.canGoForward()) {
+                mainWindow.webContents.goForward();
+            }
+        });
+    }
+
+    webContentsHandler(mainWindow.webContents);
+    mainWindowState.manage(mainWindow);
+});
+
+electron.app.on('window-all-closed', () => {
+    electron.app.quit();
+});
+
+electron.app.on('activate', () => {
+    mainWindow.show();
+});
+
+electron.app.on('before-quit', () => {
+    global.appQuitting = true;
+    if (mainWindow) {
+        mainWindow.webContents.send('before-quit');
+    }
+});
+
+// Set the App User Model ID to match what the squirrel
+// installer uses for the shortcut icon.
+// This makes notifications work on windows 8.1 (and is
+// a noop on other platforms).
+electron.app.setAppUserModelId('com.squirrel.riot-web.Riot');

electron_app/src/squirrelhooks.js

@@ -0,0 +1,51 @@
+/*
+Copyright 2017 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+const path = require('path');
+const spawn = require('child_process').spawn;
+const {app} = require('electron');
+
+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 '${updateExe}' with args '${args}'`);
+    spawn(updateExe, args, {
+      detached: true,
+    }).on('close', done);
+}
+
+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') {
+        runUpdateExe(['--createShortcut=' + target + ''], app.quit);
+        return true;
+    } else if (cmd === '--squirrel-uninstall') {
+        runUpdateExe(['--removeShortcut=' + target + ''], app.quit);
+        return true;
+    } else if (cmd === '--squirrel-obsolete') {
+        app.quit();
+        return true;
+    }
+    return false;
+}
+
+module.exports = checkSquirrelHooks;

electron_app/src/tray.js

@@ -0,0 +1,99 @@
+/*
+Copyright 2017 Karl Glatz <karl@glatz.biz>
+Copyright 2017 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+const {app, Tray, Menu, nativeImage} = require('electron');
+const pngToIco = require('png-to-ico');
+const path = require('path');
+const fs = require('fs');
+
+let trayIcon = null;
+
+exports.hasTray = function hasTray() {
+    return (trayIcon !== null);
+};
+
+exports.create = function(config) {
+    // no trays on darwin
+    if (process.platform === 'darwin' || trayIcon) return;
+
+    const toggleWin = function() {
+        if (global.mainWindow.isVisible() && !global.mainWindow.isMinimized()) {
+            global.mainWindow.hide();
+        } else {
+            if (global.mainWindow.isMinimized()) global.mainWindow.restore();
+            if (!global.mainWindow.isVisible()) global.mainWindow.show();
+            global.mainWindow.focus();
+        }
+    };
+
+    const contextMenu = Menu.buildFromTemplate([
+        {
+            label: `Show/Hide ${config.brand}`,
+            click: toggleWin,
+        },
+        { type: 'separator' },
+        {
+            label: 'Quit',
+            click: function() {
+                app.quit();
+            },
+        },
+    ]);
+
+    const defaultIcon = nativeImage.createFromPath(config.icon_path);
+
+    trayIcon = new Tray(defaultIcon);
+    trayIcon.setToolTip(config.brand);
+    trayIcon.setContextMenu(contextMenu);
+    trayIcon.on('click', toggleWin);
+
+    let lastFavicon = null;
+    global.mainWindow.webContents.on('page-favicon-updated', async function(ev, favicons) {
+        if (!favicons || favicons.length <= 0 || !favicons[0].startsWith('data:')) {
+            if (lastFavicon !== null) {
+                win.setIcon(defaultIcon);
+                trayIcon.setImage(defaultIcon);
+                lastFavicon = null;
+            }
+            return;
+        }
+
+        // No need to change, shortcut
+        if (favicons[0] === lastFavicon) return;
+        lastFavicon = favicons[0];
+
+        let newFavicon = nativeImage.createFromDataURL(favicons[0]);
+
+        // Windows likes ico's too much.
+        if (process.platform === 'win32') {
+            try {
+                const icoPath = path.join(app.getPath('temp'), 'win32_riot_icon.ico');
+                fs.writeFileSync(icoPath, await pngToIco(newFavicon.toPNG()));
+                newFavicon = nativeImage.createFromPath(icoPath);
+            } catch (e) {
+                console.error("Failed to make win32 ico", e);
+            }
+        }
+
+        trayIcon.setImage(newFavicon);
+        global.mainWindow.setIcon(newFavicon);
+    });
+
+    global.mainWindow.webContents.on('page-title-updated', function(ev, title) {
+        trayIcon.setToolTip(title);
+    });
+};

electron_app/src/updater.js

@@ -0,0 +1,84 @@
+const { app, autoUpdater, ipcMain } = require('electron');
+
+const UPDATE_POLL_INTERVAL_MS = 60 * 60 * 1000;
+const INITIAL_UPDATE_DELAY_MS = 30 * 1000;
+
+function installUpdate() {
+    // for some reason, quitAndInstall does not fire the
+    // before-quit event, so we need to set the flag here.
+    global.appQuitting = true;
+    autoUpdater.quitAndInstall();
+}
+
+function pollForUpdates() {
+    try {
+        autoUpdater.checkForUpdates();
+    } catch (e) {
+        console.log('Couldn\'t check for update', e);
+    }
+}
+
+module.exports = {};
+module.exports.start = function startAutoUpdate(updateBaseUrl) {
+    if (updateBaseUrl.slice(-1) !== '/') {
+        updateBaseUrl = updateBaseUrl + '/';
+    }
+    try {
+        let url;
+        // For reasons best known to Squirrel, the way it checks for updates
+        // is completely different between macOS and windows. On macOS, it
+        // 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') {
+            // 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
+            // rely on NSURLConnection setting the User-Agent to what we expect,
+            // 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.
+            url = `${updateBaseUrl}macos/?localVersion=${encodeURIComponent(app.getVersion())}`;
+
+        } else if (process.platform === 'win32') {
+            url = `${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');
+        }
+
+        if (url) {
+            autoUpdater.setFeedURL(url);
+            // 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:
+            // every hour should be just fine for a desktop app)
+            // However, we still let the main window listen for the update events.
+            // We also wait a short time before checking for updates the first time because
+            // of squirrel on windows and it taking a small amount of time to release a
+            // lock file.
+            setTimeout(pollForUpdates, INITIAL_UPDATE_DELAY_MS);
+            setInterval(pollForUpdates, UPDATE_POLL_INTERVAL_MS);
+        }
+    } catch (err) {
+        // will fail if running in debug mode
+        console.log('Couldn\'t enable update checking', err);
+    }
+}
+
+ipcMain.on('install_update', installUpdate);
+ipcMain.on('check_updates', pollForUpdates);
+
+function ipcChannelSendUpdateStatus(status) {
+    if (global.mainWindow) {
+        global.mainWindow.webContents.send('check_updates', status);
+    }
+}
+
+autoUpdater.on('update-available', function() {
+    ipcChannelSendUpdateStatus(true);
+}).on('update-not-available', function() {
+    ipcChannelSendUpdateStatus(false);
+}).on('error', function(error) {
+    ipcChannelSendUpdateStatus(error.message);
+});

electron_app/src/vectormenu.js

@@ -0,0 +1,139 @@
+/*
+Copyright 2016 OpenMarket Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+*/
+
+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' },
+        ],
+    },
+    {
+        label: '&View',
+        submenu: [
+            { type: 'separator' },
+            { role: 'resetzoom' },
+            { role: 'zoomin' },
+            { role: 'zoomout' },
+            { type: 'separator' },
+            { role: 'togglefullscreen' },
+            { role: 'toggledevtools' },
+        ],
+    },
+    {
+        label: '&Window',
+        role: 'window',
+        submenu: [
+            { role: 'minimize' },
+            { role: 'close' },
+        ],
+    },
+    {
+        label: '&Help',
+        role: 'help',
+        submenu: [
+            {
+                label: '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 = app.getName();
+    template.unshift({
+        label: name,
+        submenu: [
+            { role: 'about' },
+            { type: 'separator' },
+            {
+                role: 'services',
+                submenu: [],
+            },
+            { 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' },
+        {
+            label: 'Speech',
+            submenu: [
+                { role: 'startspeaking' },
+                { role: 'stopspeaking' },
+            ],
+        });
+
+    // Window menu.
+    // This also has specific functionality on macOS
+    template[3].submenu = [
+        {
+            label: 'Close',
+            accelerator: 'CmdOrCtrl+W',
+            role: 'close',
+        },
+        {
+            label: 'Minimize',
+            accelerator: 'CmdOrCtrl+M',
+            role: 'minimize',
+        },
+        {
+            label: 'Zoom',
+            role: 'zoom',
+        },
+        {
+            type: 'separator',
+        },
+        {
+            label: 'Bring All to Front',
+            role: 'front',
+        },
+    ];
+} else {
+    template.unshift({
+        label: '&File',
+        submenu: [
+            // For some reason, 'about' does not seem to work on windows.
+            /*{
+                role: 'about'
+            },*/
+            { role: 'quit' },
+        ],
+    });
+}
+
+module.exports = Menu.buildFromTemplate(template);
+

electron_app/src/webcontents-handler.js

@@ -0,0 +1,122 @@
+const {clipboard, nativeImage, Menu, MenuItem, shell} = require('electron');
+const url = require('url');
+
+const PERMITTED_URL_SCHEMES = [
+    'http:',
+    'https:',
+    'mailto:',
+];
+
+function safeOpenURL(target) {
+    // openExternal passes the target to open/start/xdg-open,
+    // 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 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 newTarget = url.format(parsedUrl);
+        shell.openExternal(newTarget);
+    }
+}
+
+function onWindowOrNavigate(ev, target) {
+    // always prevent the default: if something goes wrong,
+    // we don't want to end up opening it in the electron
+    // app, as we could end up opening any sort of random
+    // url in a window that has node scripting access.
+    ev.preventDefault();
+    safeOpenURL(target);
+}
+
+function onLinkContextMenu(ev, params) {
+    const url = params.linkURL || params.srcURL;
+
+    const popupMenu = new Menu();
+    popupMenu.append(new MenuItem({
+        label: url,
+        click() {
+            safeOpenURL(url);
+        },
+    }));
+
+    if (params.mediaType && params.mediaType === 'image' && !url.startsWith('file://')) {
+        popupMenu.append(new MenuItem({
+            label: 'Copy Image',
+            click() {
+                if (url.startsWith('data:')) {
+                    clipboard.writeImage(nativeImage.createFromDataURL(url));
+                } else {
+                    ev.sender.copyImageAt(params.x, params.y);
+                }
+            },
+        }));
+    }
+
+    popupMenu.append(new MenuItem({
+        label: 'Copy Link Address',
+        click() {
+            clipboard.writeText(url);
+        },
+    }));
+    popupMenu.popup();
+    ev.preventDefault();
+}
+
+function _CutCopyPasteSelectContextMenus(params) {
+    return [{
+        role: 'cut',
+        enabled: params.editFlags.canCut,
+    }, {
+        role: 'copy',
+        enabled: params.editFlags.canCopy,
+    }, {
+        role: 'paste',
+        enabled: params.editFlags.canPaste,
+    }, {
+        role: 'pasteandmatchstyle',
+        enabled: params.editFlags.canPaste,
+    }, {
+        role: 'selectall',
+        enabled: params.editFlags.canSelectAll,
+    }];
+}
+
+function onSelectedContextMenu(ev, params) {
+    const items = _CutCopyPasteSelectContextMenus(params);
+    const popupMenu = Menu.buildFromTemplate(items);
+
+    popupMenu.popup();
+    ev.preventDefault();
+}
+
+function onEditableContextMenu(ev, params) {
+    const items = [
+        { role: 'undo' },
+        { role: 'redo', enabled: params.editFlags.canRedo },
+        { type: 'separator' },
+    ].concat(_CutCopyPasteSelectContextMenus(params));
+
+    const popupMenu = Menu.buildFromTemplate(items);
+
+    popupMenu.popup();
+    ev.preventDefault();
+}
+
+
+module.exports = (webContents) => {
+    webContents.on('new-window', onWindowOrNavigate);
+    webContents.on('will-navigate', onWindowOrNavigate);
+
+    webContents.on('context-menu', function(ev, params) {
+        if (params.linkURL || params.srcURL) {
+            onLinkContextMenu(ev, params);
+        } else if (params.selectionText) {
+            onSelectedContextMenu(ev, params);
+        } else if (params.isEditable) {
+            onEditableContextMenu(ev, params);
+        }
+    });
+};

karma.conf.js

@@ -2,13 +2,14 @@
 
 var path = require('path');
 var webpack = require('webpack');
+var webpack_config = require('./webpack.config');
 
 /*
  * We use webpack to build our tests. It's a pain to have to wait for webpack
  * to build everything; however it's the easiest way to load our dependencies
  * from node_modules.
  *
- * If you run karma in multi-run mode (with `npm run test:multi`), it will watch
+ * If you run karma in multi-run mode (with `npm run test-multi`), it will watch
  * the tests for changes, and webpack will rebuild using a cache. This is much quicker
  * than a clean rebuild.
  */
@@ -19,8 +20,40 @@ var testFile = process.env.KARMA_TEST_FILE || 'test/all-tests.js';
 process.env.PHANTOMJS_BIN = 'node_modules/.bin/phantomjs';
 process.env.Q_DEBUG = 1;
 
+/* the webpack config is based on the real one, to (a) try to simulate the
+ * deployed environment as closely as possible, and (b) to avoid a shedload of
+ * cut-and-paste.
+ */
+
+// find out if we're shipping olm, and where it is, if so.
+const olm_entry = webpack_config.entry['olm'];
+
+// remove the default entries - karma provides its own (via the 'files' and
+// 'preprocessors' config below)
+delete webpack_config['entry'];
+
+// add ./test as a search path for js
+webpack_config.module.loaders.unshift({
+    test: /\.js$/, loader: "babel",
+    include: [path.resolve('./src'), path.resolve('./test')],
+});
+
+// disable parsing for sinon, because it
+// tries to do voodoo with 'require' which upsets
+// webpack (https://github.com/webpack/webpack/issues/304)
+webpack_config.module.noParse.push(/sinon\/pkg\/sinon\.js$/);
+
+// ?
+webpack_config.resolve.alias['sinon'] = 'sinon/pkg/sinon.js';
+
+webpack_config.resolve.root = [
+    path.resolve('./test'),
+];
+
+webpack_config.devtool = 'inline-source-map';
+
 module.exports = function (config) {
-    config.set({
+    const myconfig = {
         // frameworks to use
         // available frameworks: https://npmjs.org/browse/keyword/karma-adapter
         frameworks: ['mocha'],
@@ -29,25 +62,45 @@ module.exports = function (config) {
         files: [
             'node_modules/babel-polyfill/browser.js',
             testFile,
-            {pattern: 'vector/img/*', watched: false, included: false, served: true, nocache: false},
+
+            // make the images available via our httpd. They will be avaliable
+            // below http://localhost:[PORT]/base/. See also `proxies` which
+            // defines alternative URLs for them.
+            //
+            // This isn't required by any of the tests, but it stops karma
+            // logging warnings when it serves a 404 for them.
+            {
+                pattern: 'src/skins/vector/img/*',
+                watched: false, included: false, served: true, nocache: false,
+            },
         ],
 
-        // redirect img links to the karma server
         proxies: {
-            "/img/": "/base/vector/img/",
+            // redirect img links to the karma server. See above.
+            "/img/": "/base/src/skins/vector/img/",
         },
 
         // preprocess matching files before serving them to the browser
         // available preprocessors:
         // https://npmjs.org/browse/keyword/karma-preprocessor
         preprocessors: {
-            'test/**/*.js': ['webpack', 'sourcemap']
+            '{src,test}/**/*.js': ['webpack', 'sourcemap'],
         },
 
         // test results reporter to use
-        // possible values: 'dots', 'progress'
         // available reporters: https://npmjs.org/browse/keyword/karma-reporter
-        reporters: ['progress', 'junit'],
+        reporters: ['logcapture', 'spec', 'junit', 'summary'],
+
+        specReporter: {
+            suppressErrorSummary: false, // do print error summary
+            suppressFailed: false, // do print information about failed tests
+            suppressPassed: false, // do print information about passed tests
+            showSpecTiming: true, // print the time elapsed for each spec
+        },
+
+        client: {
+            captureLogs: true,
+        },
 
         // web server port
         port: 9876,
@@ -70,8 +123,23 @@ module.exports = function (config) {
         browsers: [
             'Chrome',
             //'PhantomJS',
+            //'ChromeHeadless'
         ],
 
+        customLaunchers: {
+            'ChromeHeadless': {
+                base: 'Chrome',
+                flags: [
+                    // '--no-sandbox',
+                    // See https://chromium.googlesource.com/chromium/src/+/lkgr/headless/README.md
+                    '--headless',
+                    '--disable-gpu',
+                    // Without a remote debugging port, Google Chrome exits immediately.
+                    '--remote-debugging-port=9222',
+                ],
+            }
+        },
+
         // Continuous Integration mode
         // if true, Karma captures browsers, runs the tests and exits
         // singleRun: false,
@@ -84,53 +152,20 @@ module.exports = function (config) {
             outputDir: 'karma-reports',
         },
 
-        webpack: {
+        webpack: webpack_config,
-            module: {
-                loaders: [
-                    { test: /\.json$/, loader: "json" },
-                    {
-                        test: /\.js$/, loader: "babel",
-                        include: [path.resolve('./src'),
-                                  path.resolve('./test'),
-                                 ]
-                    },
-                ],
-                noParse: [
-                    // don't parse the languages within highlight.js. They
-                    // cause stack overflows
-                    // (https://github.com/webpack/webpack/issues/1721), and
-                    // there is no need for webpack to parse them - they can
-                    // just be included as-is.
-                    /highlight\.js\/lib\/languages/,
 
-                    // also disable parsing for sinon, because it
+        webpackMiddleware: {
-                    // tries to do voodoo with 'require' which upsets
+            stats: {
-                    // webpack (https://github.com/webpack/webpack/issues/304)
+                // don't fill the console up with a mahoosive list of modules
-                    /sinon\/pkg\/sinon\.js$/,
+                chunks: false,
-                ],
             },
-            resolve: {
-                alias: {
-                    // alias any requires to the react module to the one in our path, otherwise
-                    // we tend to get the react source included twice when using npm link.
-                    react: path.resolve('./node_modules/react'),
-
-                    // same goes for js-sdk
-                    "matrix-js-sdk": path.resolve('./node_modules/matrix-js-sdk'),
-
-                    sinon: 'sinon/pkg/sinon.js',
-                },
-                root: [
-                    path.resolve('./src'),
-                    path.resolve('./test'),
-                ],
-            },
-            plugins: [
-                // olm may not be installed, so avoid webpack warnings by
-                // ignoring it.
-                new webpack.IgnorePlugin(/^olm$/),
-            ],
-            devtool: 'inline-source-map',
         },
-    });
+    };
+
+    // include the olm loader if we have it.
+    if (olm_entry) {
+        myconfig.files.unshift(olm_entry);
+    }
+
+    config.set(myconfig);
 };

package.json

@@ -1,8 +1,8 @@
 {
   "name": "riot-web",
   "productName": "Riot",
-  "main": "electron/src/electron-main.js",
+  "main": "electron_app/src/electron-main.js",
-  "version": "0.9.5",
+  "version": "0.13.4",
   "description": "A feature-rich client for Matrix.org",
   "author": "Vector Creations Ltd.",
   "repository": {
@@ -27,65 +27,71 @@
   "matrix-react-parent": "matrix-react-sdk",
   "scripts": {
     "reskindex": "reskindex -h src/header",
-    "build:res": "cpx \"{src/skins/vector/fonts,src/skins/vector/img}/**\" webapp/ && cpx \"{res/media,res/vector-icons}/**\" webapp/",
+    "reskindex:watch": "reskindex -h src/header -w",
-    "build:config": "cpx config.json webapp/",
+    "i18n": "matrix-gen-i18n",
-    "build:emojione": "cpx \"node_modules/emojione/assets/svg/*\" webapp/emojione/svg/",
+    "prunei18n": "matrix-prune-i18n",
+    "build:res": "node scripts/copy-res.js",
     "build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js",
-    "build:css": "mkdirp build && catw \"src/skins/vector/css/**/*.css\" -o build/components.css --no-watch",
+    "build:compile": "npm run reskindex && babel --source-maps -d lib src",
-    "build:compile": "babel --source-maps -d lib src",
+    "build:bundle": "cross-env NODE_ENV=production webpack -p --progress --bail",
-    "build:bundle": "NODE_ENV=production webpack -p --progress",
+    "build:bundle:dev": "webpack --optimize-occurence-order --progress --bail",
-    "build:bundle:dev": "webpack --optimize-occurence-order --progress",
+    "build:electron": "npm run clean && npm run build && npm run install:electron && build -wml --ia32 --x64",
-    "build:electron": "npm run clean && npm run build && build -wml --ia32 --x64",
+    "build": "npm run reskindex && npm run build:res && npm run build:bundle",
-    "build": "node scripts/babelcheck.js && npm run build:res && npm run build:config && npm run build:emojione && npm run build:css && npm run build:bundle",
+    "build:dev": "npm run reskindex && npm run build:res && npm run build:bundle:dev",
-    "build:dev": "node scripts/babelcheck.js && npm run build:res && npm run build:config && npm run build:emojione && npm run build:css && npm run build:bundle:dev",
     "dist": "scripts/package.sh",
-    "start:res": "parallelshell \"cpx -w \\\"{src/skins/vector/fonts,src/skins/vector/img}/**\\\" webapp/\" \"cpx -w \\\"{res/media,res/vector-icons}/**\\\" webapp/\"",
+    "install:electron": "install-app-deps",
-    "start:config": "cpx -w config.json webapp/",
+    "electron": "npm run install:electron && electron .",
-    "start:emojione": "cpx \"node_modules/emojione/assets/svg/*\" webapp/emojione/svg/ -w",
+    "start:res": "node scripts/copy-res.js -w",
-    "start:js": "webpack-dev-server -w --progress",
+    "start:js": "webpack-dev-server --output-filename=bundles/_dev_/[name].js --output-chunk-file=bundles/_dev_/[name].js -w --progress",
-    "start:js:prod": "NODE_ENV=production webpack-dev-server -w --progress",
+    "start:js:prod": "cross-env NODE_ENV=production webpack-dev-server -w --progress",
-    "start:skins:css": "mkdirp build && catw \"src/skins/vector/css/**/*.css\" -o build/components.css",
+    "start": "parallelshell \"npm run reskindex:watch\" \"npm run start:res\" \"npm run start:js\"",
-    "start": "node scripts/babelcheck.js && parallelshell \"npm run start:emojione\" \"npm run start:res\" \"npm run start:config\" \"npm run start:js\" \"npm run start:skins:css\"",
+    "start:prod": "parallelshell \"npm run reskindex:watch\" \"npm run start:res\" \"npm run start:js:prod\"",
-    "start:prod": "parallelshell \"npm run start:emojione\" \"npm run start:js:prod\" \"npm run start:skins:css\"",
+    "lint": "eslint src/",
-    "clean": "rimraf build lib webapp electron/dist",
+    "lintall": "eslint src/ test/",
-    "prepublish": "npm run build:compile",
+    "clean": "rimraf lib webapp electron_app/dist",
-    "test": "karma start --single-run=true --autoWatch=false --browsers PhantomJS --colors=false",
+    "prepublish": "npm run clean && npm run build:compile",
-    "test:multi": "karma start"
+    "test": "karma start --single-run=true --autoWatch=false --browsers ChromeHeadless",
+    "test-multi": "karma start"
   },
   "dependencies": {
     "babel-polyfill": "^6.5.0",
     "babel-runtime": "^6.11.6",
+    "bluebird": "^3.5.0",
     "browser-request": "^0.3.3",
     "classnames": "^2.1.2",
-    "draft-js": "^0.8.1",
+    "draft-js": "^0.11.0-alpha",
     "extract-text-webpack-plugin": "^0.9.1",
     "favico.js": "^0.3.10",
-    "filesize": "^3.1.2",
+    "filesize": "3.5.6",
-    "flux": "~2.0.3",
+    "flux": "2.1.1",
     "gemini-scrollbar": "matrix-org/gemini-scrollbar#b302279",
     "gfm.css": "^1.1.1",
     "highlight.js": "^9.0.0",
     "linkifyjs": "^2.1.3",
-    "matrix-js-sdk": "matrix-org/matrix-js-sdk#develop",
+    "matrix-js-sdk": "0.9.2",
-    "matrix-react-sdk": "matrix-org/matrix-react-sdk#develop",
+    "matrix-react-sdk": "0.11.3",
     "modernizr": "^3.1.0",
-    "q": "^1.4.1",
+    "pako": "^1.0.5",
-    "react": "^15.4.0",
+    "prop-types": "^15.5.10",
+    "react": "^15.6.0",
     "react-dnd": "^2.1.4",
     "react-dnd-html5-backend": "^2.1.2",
-    "react-dom": "^15.4.0",
+    "react-dom": "^15.6.0",
     "react-gemini-scrollbar": "matrix-org/react-gemini-scrollbar#5e97aef",
     "sanitize-html": "^1.11.1",
+    "text-encoding-utf-8": "^1.0.1",
     "ua-parser-js": "^0.7.10",
-    "url": "^0.11.0"
+    "url": "^0.11.0",
+    "velocity-vector": "vector-im/velocity#059e3b2"
   },
   "devDependencies": {
+    "autoprefixer": "^6.6.0",
     "babel-cli": "^6.5.2",
     "babel-core": "^6.14.0",
     "babel-eslint": "^6.1.0",
     "babel-loader": "^6.2.5",
     "babel-plugin-add-module-exports": "^0.2.1",
-    "babel-plugin-transform-async-to-generator": "^6.16.0",
+    "babel-plugin-transform-async-to-bluebird": "^1.1.1",
     "babel-plugin-transform-class-properties": "^6.16.0",
     "babel-plugin-transform-object-rest-spread": "^6.16.0",
     "babel-plugin-transform-runtime": "^6.15.0",
@@ -94,61 +100,88 @@
     "babel-preset-es2017": "^6.16.0",
     "babel-preset-react": "^6.16.0",
     "babel-preset-stage-2": "^6.17.0",
-    "catw": "^1.0.1",
+    "chokidar": "^1.6.1",
     "cpx": "^1.3.2",
+    "cross-env": "^4.0.0",
     "css-raw-loader": "^0.1.1",
-    "electron-builder": "^10.4.1",
+    "electron-builder": "^11.2.4",
-    "emojione": "^2.2.3",
+    "electron-builder-squirrel-windows": "^11.2.1",
+    "electron-devtools-installer": "^2.2.0",
+    "emojione": "^2.2.7",
+    "eslint": "^3.14.0",
+    "eslint-config-google": "^0.7.1",
+    "eslint-plugin-babel": "^4.1.1",
+    "eslint-plugin-flowtype": "^2.30.0",
+    "eslint-plugin-react": "^7.4.0",
     "expect": "^1.16.0",
     "fs-extra": "^0.30.0",
     "html-webpack-plugin": "^2.24.0",
     "json-loader": "^0.5.3",
-    "karma": "^0.13.22",
+    "karma": "^1.7.0",
     "karma-chrome-launcher": "^0.2.3",
     "karma-cli": "^0.1.2",
     "karma-junit-reporter": "^0.4.1",
+    "karma-logcapture-reporter": "0.0.1",
     "karma-mocha": "^0.2.2",
-    "karma-phantomjs-launcher": "^1.0.0",
     "karma-sourcemap-loader": "^0.3.7",
+    "karma-spec-reporter": "0.0.31",
+    "karma-summary-reporter": "^1.3.3",
     "karma-webpack": "^1.7.0",
+    "matrix-mock-request": "^1.2.0",
+    "matrix-react-test-utils": "^0.2.0",
+    "minimist": "^1.2.0",
     "mkdirp": "^0.5.1",
     "mocha": "^2.4.5",
-    "parallelshell": "^1.2.0",
+    "parallelshell": "^3.0.2",
-    "phantomjs-prebuilt": "^2.1.7",
+    "postcss-extend": "^1.0.5",
+    "postcss-import": "^9.0.0",
+    "postcss-loader": "^1.2.2",
+    "postcss-mixins": "^5.4.1",
+    "postcss-nested": "^1.0.0",
+    "postcss-scss": "^0.4.0",
+    "postcss-simple-vars": "^3.0.0",
+    "postcss-strip-inline-comments": "^0.1.5",
     "react-addons-perf": "^15.4.0",
-    "react-addons-test-utils": "^15.4.0",
+    "react-addons-test-utils": "^15.6.0",
     "rimraf": "^2.4.3",
     "source-map-loader": "^0.1.5",
     "webpack": "^1.12.14",
     "webpack-dev-server": "^1.16.2"
   },
   "optionalDependencies": {
-    "olm": "https://matrix.org/packages/npm/olm/olm-2.1.0.tgz"
+    "olm": "https://matrix.org/packages/npm/olm/olm-2.2.1.tgz"
   },
   "build": {
     "appId": "im.riot.app",
     "category": "Network",
-    "electronVersion": "1.4.11",
+    "electronVersion": "1.7.9",
     "//asar=false": "https://github.com/electron-userland/electron-builder/issues/675",
     "asar": false,
     "dereference": true,
     "//files": "We bundle everything, so we only need to include webapp/",
     "files": [
-      "electron/src/**",
+      "node_modules/**",
-      "electron/img/**",
+      "src/**",
-      "webapp/**",
+      "img/**"
-      "package.json"
+    ],
+    "extraResources": [
+      "webapp/**/*"
     ],
     "linux": {
       "target": "deb",
-      "maintainer": "support@riot.im"
+      "category": "Network;InstantMessaging;Chat",
+      "maintainer": "support@riot.im",
+      "desktop": {
+        "StartupWMClass": "riot"
+      }
     },
     "win": {
       "target": "squirrel"
+    },
+    "directories": {
+      "buildResources": "electron_app/build",
+      "output": "electron_app/dist",
+      "app": "electron_app"
     }
-  },
-  "directories": {
-    "buildResources": "electron/build",
-    "output": "electron/dist"
   }
 }

postcss.config.js

@@ -0,0 +1,13 @@
+module.exports = {
+    plugins: [
+        require("postcss-import")(),
+        require("autoprefixer")(),
+        require("postcss-simple-vars")(),
+        require("postcss-extend")(),
+        require("postcss-nested")(),
+        require("postcss-mixins")(),
+        require("postcss-strip-inline-comments")(),
+    ],
+    "parser": "postcss-scss",
+    "local-plugins": true,
+};

release.sh

@@ -1,12 +1,41 @@
-#!/bin/sh
+#!/bin/bash
 #
 # Script to perform a release of vector-web.
 #
-# Requires github-changelog-generator; to install, do 
+# Requires github-changelog-generator; to install, do
 #   pip install git+https://github.com/matrix-org/github-changelog-generator.git
 
 set -e
 
 cd `dirname $0`
 
+for i in matrix-js-sdk matrix-react-sdk
+do
+    depver=`cat package.json | jq -r .dependencies[\"$i\"]`
+    latestver=`npm show $i version`
+    if [ "$depver" != "$latestver" ]
+    then
+        echo "The latest version of $i is $latestver but package.json depends on $depver"
+        echo -n "Type 'Yes' to continue anyway: "
+        read resp
+        if [ "$resp" != "Yes" ]
+        then
+            echo "OK, never mind."
+            exit 1
+        fi
+    fi
+done
+
+# bump Electron's package.json first
+release="${1#v}"
+tag="v${release}"
+echo "electron npm version"
+
+cd electron_app
+npm version --no-git-tag-version "$release"
+git commit package.json -m "$tag"
+
+
+cd ..
+
 exec ./node_modules/matrix-js-sdk/release.sh -z "$@"