v0.10.2

* Translated using Weblate (Chinese (Traditional))

Currently translated at 61.1% (99 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/zh_Hant/

* Translated using Weblate (German)

Currently translated at 100.0% (162 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/de/

* Translated using Weblate (Chinese (Traditional))

Currently translated at 90.7% (147 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/zh_Hant/

* Translated using Weblate (Swedish)

Currently translated at 43.8% (71 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/sv/

* Translated using Weblate (Swedish)

Currently translated at 46.2% (75 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/sv/

* Translated using Weblate (German)

Currently translated at 100.0% (162 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/de/

* Translated using Weblate (Swedish)

Currently translated at 61.7% (100 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/sv/

* Translated using Weblate (Swedish)

Currently translated at 72.2% (117 of 162 strings)

Translation: Riot Web/Riot Web
Translate-URL: https://translate.nordgedanken.de/projects/riot-web/riot-web/sv/

.babelrc

@@ -0,0 +1,4 @@
+{
+  "presets": ["react", "es2015", "es2016"],
+  "plugins": ["transform-class-properties", "transform-object-rest-spread", "transform-async-to-generator", "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,44 @@
+<!-- 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

@@ -1,9 +1,19 @@
+/build
 /cert.pem
-/.DS_Store
+/dist
 /karma-reports
 /key.pem
 /lib
 /node_modules
+/electron_app/node_modules
+/electron_app/dist
 /packages/
-/vector/bundle.*
-/vector/components.css
+/webapp
+/.npmrc
+.DS_Store
+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"
   ]
-}
+}

.npmignore

@@ -1,3 +0,0 @@
-example
-examples
-build/.module-cache

.travis.yml

@@ -0,0 +1,22 @@
+language: node_js
+node_js:
+    # 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 current 'LTS' version
+    #  - 7.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
+install:
+    # clone the deps with depth 1: we know we will only ever need that one
+    # commit.
+    - scripts/fetch-develop.deps.sh --depth 1 && npm install

AUTHORS.rst

@@ -10,3 +10,6 @@ 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

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

@@ -1,65 +1,229 @@
-Vector/Web
-==========
+Riot
+====
 
-Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).
+Riot (formerly known as Vector) is a Matrix web client built using the Matrix
+React SDK (https://github.com/matrix-org/matrix-react-sdk).
 
-Getting started
+Getting Started
 ===============
 
-1. Install or update `node.js` so that your `npm` is at least at version `2.0.0`
-1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git` 
-1. Switch to the vector directory: `cd vector-web`
-1. Install the prerequisites: `npm install`
-1. If you are using the `develop` branch of vector, you will probably need to
-   rebuild one of the dependencies, due to https://github.com/npm/npm/issues/3055:
-   `(cd node_modules/matrix-react-sdk && npm install)`
-1. Start the development builder and a testing server: `npm start`
-1. Wait a few seconds for the initial build to finish (the command won't
-   terminate: it's running a web server for you).
-1. Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.
+The easiest way to test Riot is to just use the hosted copy at
+https://riot.im/app.  The develop branch is continuously deployed by Jenkins at
+https://riot.im/develop for those who like living dangerously.
 
-With `npm start`, any changes you make to the source files will cause a rebuild so
-your changes will show up when you refresh. This development server also disables
-caching, so do NOT use it in production.
+To host your own copy of Riot, the quickest bet is to use a pre-built
+released version of Riot:
 
-Configuring
+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. 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-master.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.
+
+### Installation Steps for Debian Stretch
+1. Add the repository to your sources.list using either of the following two options:
+  - Directly to sources.list: `echo "deb https://riot.im/packages/debian/ stretch main" | sudo tee -a /etc/apt/sources.list`
+  - As a separate entry in sources.list.d: `echo "deb https://riot.im/packages/debian/ stretch main" | sudo tee /etc/apt/sources.list.d/riot.list`
+2. Add the gpg signing key for the riot repository: `curl -s https://riot.im/packages/debian/repo-key.asc | sudo apt-key add -`
+3. Update your package lists: `sudo apt-get update`
+4. Install Riot: `sudo apt-get install riot-web`
+
+Important Security Note
+=======================
+
+We do not recommend running Riot from the same domain name as your Matrix
+homeserver.  The reason is the risk of XSS (cross-site-scripting)
+vulnerabilities that could occur if someone caused Riot to load and render
+malicious user generated content from a Matrix API which then had trusted
+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/riot-web/issues/1977 for more details.
+
+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 `node` is at least v6.3.0 (and `npm`
+   is at least v3.10.x).
+1. Clone the repo: `git clone https://github.com/vector-im/riot-web.git`.
+1. Switch to the riot-web directory: `cd riot-web`.
+1. If you're using the `develop` branch, install the develop versions of the
+   dependencies, as the released ones will be too old:
+   ```
+   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 development 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).
+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.
+
+Note that `npm run dist` is not supported on Windows, so Windows users can run `npm
+run build`, which will build all the necessary files into the `webapp`
+directory. The version of Riot will not appear in Settings without
+using the dist script. You can then mount the `webapp` directory on your
+webserver to actually serve up the app, which is entirely static content.
+
+config.json
 ===========
 
-Configure the app by modifying the `config.json` file:
+You can configure the app by copying `config.sample.json` to
+`config.json` and customising it:
 
 1. `default_hs_url` is the default home server url.
 1. `default_is_url` is the default identity server url (this is the server used
    for verifying third party identifiers like email addresses). If this is blank,
-   registering with an email address or adding an email address to your account
-   will not work.
+   registering with an email address, adding an email address to your account,
+   or inviting users via email address will not work.  Matrix identity servers are
+   very simple web services which map third party identifiers (currently only email
+   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_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
+   down list. Optional.
+1. `update_base_url` (electron app only): HTTPS URL to a web server to download
+   updates from. This should be the path to the directory containing `macos`
+   and `win32` (for update packages, not installer packages).
+1. `cross_origin_renderer_url`: URL to a static HTML page hosting code to help display
+   encrypted file attachments. This MUST be hosted on a completely separate domain to
+   anything else since it is used to isolate the privileges of file attachments to this
+   domain. Default: `usercontent.riot.im`. This needs to contain v1.html from
+   https://github.com/matrix-org/usercontent/blob/master/v1.html
 
-You will need to re-run `npm run build` after editing `config.json`.
+Running as a Desktop app
+========================
 
-Deployment
-==========
+Riot can also be run as a desktop app, wrapped in electron. You can download a
+pre-built version from https://riot.im/desktop.html or, if you prefer,
+built it yourself.
 
-On a Unix-based OS, run `npm run package` to build a tarball package.  Untaring
-this file will give a version-specific directory containing all the files that
-need to go on your web server.
+To run as a desktop app:
 
-The package script is not supported on Windows, so Windows users can run `npm
-run build`, which will build all the necessary files into the `vector`
-directory. Note that the version of Vector will not appear in Settings without
-using the package script. You can then mount the vector directory on your
-webserver to actually serve up the app, which is entirely static content.
+1. Follow the instructions in 'Building From Source' above, but run
+   `npm run build` instead of `npm run dist` (since we don't need the tarball).
+2. Install electron and run it:
+
+   ```
+   npm install electron
+   npm run electron
+   ```
+
+To build packages, use electron-builder. This is configured to output:
+ * dmg + zip for macOS
+ * exe + nupkg for Windows
+ * deb for Linux
+But this can be customised by editing the `build` section of package.json
+as per https://github.com/electron-userland/electron-builder/wiki/Options
+
+See https://github.com/electron-userland/electron-builder/wiki/Multi-Platform-Build
+for dependencies required for building packages for various platforms.
+
+The only platform that can build packages for all three platforms is macOS:
+```
+brew install wine --without-x11
+brew install mono
+brew install gnu-tar
+npm install
+npm run build:electron
+```
+
+For other packages, use electron-builder manually. For example, to build a package
+for 64 bit Linux:
+
+ 1. Follow the instructions in 'Building From Source' above
+ 2. `node_modules/.bin/build -l --x64`
+
+All electron packages go into `electron/dist/`
+
+Many thanks to @aviraldg for the initial work on the electron integration.
+
+Other options for running as a desktop app:
+ * https://github.com/krisak/vector-electron-desktop
+ * @asdf:matrix.org points out that you can use nativefier and it just works(tm)
+
+```
+sudo npm install nativefier -g
+nativefier https://riot.im/app/
+```
 
 Development
 ===========
 
-For simple tweaks, you can work on any of the source files within Vector with
-the setup above, and your changes will cause an instant rebuild.
+Before attempting to develop on Riot you **must** read the developer guide
+for `matrix-react-sdk` at https://github.com/matrix-org/matrix-react-sdk, which
+also defines the design, architecture and style for Riot too.
 
-However, much of the functionality in Vector is actually in the
-`matrix-react-sdk` and `matrix-js-sdk` modules. It is possible to set these up
-in a way that makes it easy to track the `develop` branches in git and to make
-local changes without having to manually rebuild each time.
+The idea of Riot is to be a relatively lightweight "skin" of customisations on
+top of the underlying `matrix-react-sdk`. `matrix-react-sdk` provides both the
+higher and lower level React components useful for building Matrix communication
+apps using React.
 
-[Be aware that there may be problems with this process under npm version 3.]
+After creating a new component you must run `npm run reskindex` to regenerate
+the `component-index.js` for the app (used in future for skinning)
+
+**However, as of July 2016 this layering abstraction is broken due to rapid
+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 `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 `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)
+hosted by external CDNs or servers but instead please package all dependencies
+into Riot itself.
+
+Setting up a dev environment
+============================
+
+Much of the functionality in Riot is actually in the `matrix-react-sdk` and
+`matrix-js-sdk` modules. It is possible to set these up in a way that makes it
+easy to track the `develop` branches in git and to make local changes without
+having to manually rebuild each time.
 
 First clone and build `matrix-js-sdk`:
 
@@ -79,10 +243,10 @@ Then similarly with `matrix-react-sdk`:
 1. `rm -r node_modules/matrix-js-sdk; ln -s ../../matrix-js-sdk node_modules/`
 1. `popd`
 
-Finally, build and start vector itself:
+Finally, build and start Riot itself:
 
-1. `git clone git@github.com:vector-im/vector-web.git`
-1. `cd vector-web`
+1. `git clone git@github.com:vector-im/riot-web.git`
+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/`
@@ -102,42 +266,63 @@ Finally, build and start vector itself:
         + 1013 hidden modules
     ```
    Remember, the command will not terminate since it runs the web server
-   and rebuilds source files when they change.
-1. Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.
+   and rebuilds source files when they change. This development server also
+   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-js-sdk` or `matrix-react-sdk`, you will need
+When you make changes to `matrix-react-sdk` or `matrix-js-sdk`, you will need
 to run `npm run build` in the relevant directory. You can do this automatically
-by instead running `npm start` in each directory, to start a development
-builder which will watch for changes to the files and rebuild automatically.
+by instead running `npm start` in the directory, to start a development builder
+which will watch for changes to the files and rebuild automatically.
 
-If you add or remove any components from the Vector skin, you will need to rebuild
+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`.
 
-Enabling encryption
-===================
+If any of these steps error with, `file table overflow`, you are probably on a mac
+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.
 
-End-to-end encryption in Vector and Matrix is not yet considered ready for
-day-to-day use; it is experimental and should be considered only as a
-proof-of-concept. See https://matrix.org/jira/browse/SPEC-162 for an overview
-of the current progress.
+How to add a new translation?
+=============================
 
-To build a version of vector with support for end-to-end encryption, install
-the olm module with `npm i https://matrix.org/packages/npm/olm/olm-0.1.0.tgz`
-before running `npm start`. The olm library will be detected and used if
-available.
+[<img src="https://translate.nordgedanken.de/widgets/riot-web/-/multi-auto.svg" alt="translationsstatus" width="340">](https://translate.nordgedanken.de/engage/riot-web/?utm_source=widget)
 
-To enable encryption for a room, type
 
-```
-/encrypt on
-```
+Head to the [translating doc](docs/translating.md)
 
-in the message bar in that room. Vector will then generate a set of keys, and
-encrypt all outgoing messages in that room. (Note that other people in that
-room will send messages in the clear unless they also `/encrypt on`.)
+Adding Strings to the translations (Developer Guide)
+====================================================
 
-Note that historical encrypted messages cannot currently be decoded - history
-is therefore lost when the page is reloaded.
+Head to the [translating dev doc](docs/translating-dev.md)
 
-There is currently no visual indication of whether encryption is enabled for a
-room, or whether a particular message was encrypted.
+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: still need to fix, but lower than P1
+* 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
+* 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)
+
+additional categories:
+
+* release blocker
+* ui/ux (think of this as cosmetic)
+* network (specific to network conditions)
+* platform (platform specific)

config.json

@@ -1,4 +0,0 @@
-{
-    "default_hs_url": "https://matrix.org",
-    "default_is_url": "https://vector.im"
-}

config.sample.json

@@ -0,0 +1,18 @@
+{
+    "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",
+    "bug_report_endpoint_url": "https://riot.im/bugreports/submit",
+    "enableLabs": true,
+    "roomDirectory": {
+        "servers": [
+            "matrix.org"
+        ]
+    },
+    "piwik": {
+        "url": "https://piwik.riot.im/",
+        "siteId": 1
+    }
+}

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,26 @@
+# How to translate riot-web (Dev Guide)
+
+## Requirements
+
+- A working [Development Setup](../../#setting-up-a-dev-environment)
+- Be able to understand English
+- Be able to understand the language you want to translate riot-web into
+
+## Adding new strings
+
+1. Check if the import ``import _t from 'counterpart-riot'`` is present. If not add it to the other import statements.
+2. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method)
+3. Add the String to the ``en_EN.json`` file in ``src/i18n`` or if you are working in matrix-react-sdk you can find the json file in ``src/i18n/strings``
+
+## Adding variables inside a string.
+
+1. Extend your ``_t()`` call. Instead of ``_t(STRING)`` use ``_t(STRING, {})``
+2. Decide how to name it. Please think about if the person who has to translate it can understand what it does.
+3. Add it to the array in ``_t`` for example ``_t(STRING, {variable: this.variable})``
+4. Add the variable inside the string. The syntax for variables is ``%(variable)s``. Please note the s at the end. The name of the variable has to match the previous used name.
+
+## Things to know/Style Guides
+
+- Do not use it inside ``getDefaultProps`` at the point where ``getDefaultProps`` is initialized the translations aren't loaded yet and it causes missing translations.
+- 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.
+- 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.

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://riot.im/develop/#/room/#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.nordgedanken.de 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.nordgedanken.de/accounts/profile/ and select the languages you know and maybe another language you know too.
+6. Head to https://translate.nordgedanken.de/accounts/profile/#subscriptions and select Riot Web as Project
+
+## How to check if your language already is being translated
+
+Go to https://translate.nordgedanken.de/projects/riot-web/ and 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.nordgedanken.de/projects/riot-web/
+2. Click on the ``translate`` button on the right side of your language
+3. Fill in the translations in the writeable field. You will see the original English string and the string of your second language above.
+
+Head to the explanations under Steb 2b
+
+## Step 2b: Adding a new language
+
+1. Go to one of the projects listed https://translate.nordgedanken.de/projects/riot-web/
+2. Click the ``Start new language`` button at the bottom
+3. Select 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_app/package.json

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

electron_app/riot.im/README

@@ -0,0 +1,4 @@
+This directory contains the config file for the official riot.im distribution
+of Riot Desktop. You probably do not want to build with this config unless
+you're building the official riot.im distribution, or you'll find your builds
+will replace themselves with the riot.im build.

electron_app/riot.im/config.json

@@ -0,0 +1,20 @@
+{
+    "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",
+    "bug_report_endpoint_url": "https://riot.im/bugreports/submit",
+    "welcomeUserId": "@riot-bot:matrix.org",
+    "enableLabs": true,
+    "roomDirectory": {
+        "servers": [
+            "matrix.org"
+        ]
+    },
+    "piwik": {
+        "url": "https://piwik.riot.im/",
+        "siteId": 1
+    }
+}

electron_app/src/electron-main.js

@@ -0,0 +1,297 @@
+/*
+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 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 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)
+}
+
+const UPDATE_POLL_INTERVAL_MS = 60 * 60 * 1000;
+const INITIAL_UPDATE_DELAY_MS = 30 * 1000;
+
+let mainWindow = null;
+let appQuitting = false;
+
+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(updateBaseUrl) {
+    if (updateBaseUrl.slice(-1) !== '/') {
+        updateBaseUrl = updateBaseUrl + '/';
+    }
+    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') {
+            // 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.
+            electron.autoUpdater.setFeedURL(
+                `${updateBaseUrl}macos/?localVersion=${encodeURIComponent(electron.app.getVersion())}`);
+
+        } else if (process.platform === 'win32') {
+            electron.autoUpdater.setFeedURL(`${updateBaseUrl}win32/${process.arch}/`);
+        } else {
+            // Squirrel / electron only supports auto-update on these two platforms.
+            // I'm not even going to try to guess which feed style they'd use if they
+            // implemented it on Linux, or if it would be different again.
+            console.log('Auto update not supported on this platform');
+        }
+        // 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);
+
+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 && powerSaveBlockerId.isStarted(powerSaveBlockerId)) {
+                if (payload.state === 'ended') {
+                    electron.powerSaveBlocker.stop(powerSaveBlockerId);
+                }
+            } else {
+                if (payload.state === 'connected') {
+                    powerSaveBlockerId = electron.powerSaveBlocker.start('prevent-display-sleep');
+                }
+            }
+            break;
+    }
+});
+
+
+electron.app.commandLine.appendSwitch('--enable-usermedia-screen-capturing');
+
+const shouldQuit = electron.app.makeSingleInstance((commandLine, workingDirectory) => {
+    // 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 (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 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 = 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(mainWindow, {
+        icon_path: iconPath,
+        brand: vectorConfig.brand || 'Riot',
+    });
+
+    if (!argv.hidden) {
+        mainWindow.once('ready-to-show', () => {
+            mainWindow.show();
+        });
+    }
+
+    mainWindow.on('closed', () => {
+        mainWindow = null;
+    });
+    mainWindow.on('close', (e) => {
+        if (!appQuitting && (tray.hasTray() || process.platform === 'darwin')) {
+            // On Mac, closing the window just hides it
+            // (this is generally how single-window Mac apps
+            // behave, eg. Mail.app)
+            e.preventDefault();
+            mainWindow.hide();
+            return false;
+        }
+    });
+
+    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', () => {
+    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_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,82 @@
+/*
+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');
+
+let trayIcon = null;
+
+exports.hasTray = function hasTray() {
+    return (trayIcon !== null);
+};
+
+exports.create = function(win, config) {
+    // no trays on darwin
+    if (process.platform === 'darwin' || trayIcon) return;
+
+    const toggleWin = function() {
+        if (win.isVisible() && !win.isMinimized()) {
+            win.hide();
+        } else {
+            if (win.isMinimized()) win.restore();
+            if (!win.isVisible()) win.show();
+            win.focus();
+        }
+    };
+
+    const contextMenu = Menu.buildFromTemplate([
+        {
+            label: `Show/Hide ${config.brand}`,
+            click: toggleWin,
+        },
+        { type: 'separator' },
+        {
+            label: 'Quit',
+            click: function() {
+                app.quit();
+            },
+        },
+    ]);
+
+    trayIcon = new Tray(config.icon_path);
+    trayIcon.setToolTip(config.brand);
+    trayIcon.setContextMenu(contextMenu);
+    trayIcon.on('click', toggleWin);
+
+    let lastFavicon = null;
+    win.webContents.on('page-favicon-updated', function(ev, favicons) {
+        let newFavicon = config.icon_path;
+        if (favicons && favicons.length > 0 && favicons[0].startsWith('data:')) {
+            newFavicon = favicons[0];
+        }
+
+        // No need to change, shortcut
+        if (newFavicon === lastFavicon) return;
+        lastFavicon = newFavicon;
+
+        // if its not default we have to construct into nativeImage
+        if (newFavicon !== config.icon_path) {
+            newFavicon = nativeImage.createFromDataURL(favicons[0]);
+        }
+
+        trayIcon.setImage(newFavicon);
+        win.setIcon(newFavicon);
+    });
+
+    win.webContents.on('page-title-updated', function(ev, title) {
+        trayIcon.setToolTip(title);
+    });
+};

electron_app/src/vectormenu.js

@@ -0,0 +1,137 @@
+/*
+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' },
+        ],
+    },
+    {
+        role: 'window',
+        submenu: [
+            { role: 'minimize' },
+            { role: 'close' },
+        ],
+    },
+    {
+        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);
+        }
+    });
+};

jenkins.sh

@@ -1,33 +0,0 @@
-#!/bin/bash
-
-set -e
-
-export NVM_DIR="/home/jenkins/.nvm"
-[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
-nvm use 4
-
-set -x
-
-npm install
-
-# we may be using a dev branch of react-sdk, in which case we need to build it
-(cd node_modules/matrix-react-sdk && npm run build)
-
-# run the mocha tests
-npm run test
-
-# build our artifacts; dumps them in ./vector
-npm run build:dev
-
-# gzip up ./vector
-rm vector-*.tar.gz || true # rm previous artifacts without failing if it doesn't exist
-
- # node_modules deps from 'npm install' don't have a .git dir so can't
- # rev-parse; but they do set the commit in package.json under 'gitHead' which
- # we're grabbing here.
-REACT_SHA=$(grep 'gitHead' node_modules/matrix-react-sdk/package.json | cut -d \" -f 4 | head -c 12)
-JSSDK_SHA=$(grep 'gitHead' node_modules/matrix-js-sdk/package.json | cut -d \" -f 4 | head -c 12)
-
-VECTOR_SHA=$(git rev-parse --short=12 HEAD) # use the ACTUAL SHA rather than assume develop
-
-tar -zcvhf vector-$VECTOR_SHA-react-$REACT_SHA-js-$JSSDK_SHA.tar.gz vector #g[z]ip, [c]reate archive, [v]erbose, [f]ilename, [h]ard-dereference (do not archive symlinks)

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,28 +20,71 @@ 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'],
 
         // list of files / patterns to load in the browser
         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'],
         },
 
         // test results reporter to use
@@ -83,54 +127,20 @@ module.exports = function (config) {
             outputDir: 'karma-reports',
         },
 
-        webpack: {
-            module: {
-                loaders: [
-                    { test: /\.json$/, loader: "json" },
-                    {
-                        test: /\.js$/, loader: "babel",
-                        include: [path.resolve('./src'),
-                                  path.resolve('./test'),
-                                 ],
-                        query: {
-                            // we're using babel 5, for consistency with
-                            // the release build, which doesn't use the
-                            // presets.
-                            // presets: ['react', 'es2015'],
-                        },
-                    },
-                ],
-                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/,
+        webpack: webpack_config,
 
-                    // also disable parsing for sinon, because it
-                    // tries to do voodoo with 'require' which upsets
-                    // webpack (https://github.com/webpack/webpack/issues/304)
-                    /sinon\/pkg\/sinon\.js$/,
-                ],
+        webpackMiddleware: {
+            stats: {
+                // don't fill the console up with a mahoosive list of modules
+                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'),
-                ],
-            },
-            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,65 +1,115 @@
 {
-  "name": "vector-web",
-  "version": "0.6.1",
-  "description": "Vector webapp",
-  "author": "matrix.org",
+  "name": "riot-web",
+  "productName": "Riot",
+  "main": "electron_app/src/electron-main.js",
+  "version": "0.10.2",
+  "description": "A feature-rich client for Matrix.org",
+  "author": "Vector Creations Ltd.",
   "repository": {
     "type": "git",
-    "url": "https://github.com/vector-im/vector-web"
+    "url": "https://github.com/vector-im/riot-web"
   },
   "license": "Apache-2.0",
+  "files": [
+    "AUTHORS.rst",
+    "CONTRIBUTING.rst",
+    "deploy",
+    "docs",
+    "karma.conf.js",
+    "lib",
+    "release.sh",
+    "scripts",
+    "src",
+    "test",
+    "webpack.config.js"
+  ],
   "style": "bundle.css",
   "matrix-react-parent": "matrix-react-sdk",
   "scripts": {
     "reskindex": "reskindex -h src/header",
+    "reskindex:watch": "reskindex -h src/header -w",
+    "build:res": "node scripts/copy-res.js",
     "build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js",
-    "build:css": "catw \"src/skins/vector/css/**/*.css\" -o vector/components.css --no-watch",
-    "build:compile": "babel --source-maps -d lib src",
-    "build:bundle": "NODE_ENV=production webpack -p lib/vector/index.js vector/bundle.js",
-    "build:bundle:dev": "NODE_ENV=production webpack --optimize-occurence-order lib/vector/index.js vector/bundle.js",
-    "build": "npm run build:css && npm run build:compile && npm run build:bundle",
-    "build:dev": "npm run build:css && npm run build:compile && npm run build:bundle:dev",
-    "package": "scripts/package.sh",
-    "start:js": "webpack -w src/vector/index.js vector/bundle.js",
-    "start:js:prod": "NODE_ENV=production webpack -w src/vector/index.js vector/bundle.js",
-    "start:skins:css": "catw \"src/skins/vector/css/**/*.css\" -o vector/components.css",
-    "//cache": "Note the -c 1 below due to https://code.google.com/p/chromium/issues/detail?id=508270",
-    "start": "parallelshell \"npm run start:js\" \"npm run start:skins:css\" \"http-server -c 1 vector\"",
-    "start:prod": "parallelshell \"npm run start:js:prod\" \"npm run start:skins:css\" \"http-server -c 1 vector\"",
-    "clean": "rimraf lib vector/bundle.css vector/bundle.js vector/bundle.js.map vector/webpack.css*",
-    "prepublish": "npm run build:css && npm run build:compile",
+    "build:compile": "npm run reskindex && babel --source-maps -d lib src",
+    "build:bundle": "cross-env NODE_ENV=production webpack -p --progress",
+    "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": "npm run reskindex && npm run build:res && npm run build:bundle",
+    "build:dev": "npm run reskindex && npm run build:res && npm run build:bundle:dev",
+    "dist": "scripts/package.sh",
+    "install:electron": "install-app-deps",
+    "electron": "npm run install:electron && electron .",
+    "start:res": "node scripts/copy-res.js -w",
+    "start:js": "webpack-dev-server --output-filename=bundles/_dev_/[name].js --output-chunk-file=bundles/_dev_/[name].js -w --progress",
+    "start:js:prod": "cross-env NODE_ENV=production webpack-dev-server -w --progress",
+    "start": "parallelshell \"npm run reskindex:watch\" \"npm run start:res\" \"npm run start:js\"",
+    "start:prod": "parallelshell \"npm run reskindex:watch\" \"npm run start:res\" \"npm run start:js:prod\"",
+    "lint": "eslint src/",
+    "lintall": "eslint src/ test/",
+    "clean": "rimraf lib webapp electron/dist",
+    "prepublish": "npm run build:compile",
     "test": "karma start --single-run=true --autoWatch=false --browsers PhantomJS --colors=false",
-    "test:multi": "karma start"
+    "test-multi": "karma start"
   },
   "dependencies": {
     "babel-polyfill": "^6.5.0",
+    "babel-runtime": "^6.11.6",
+    "browser-request": "^0.3.3",
     "classnames": "^2.1.2",
+    "draft-js": "^0.8.1",
     "extract-text-webpack-plugin": "^0.9.1",
-    "filesize": "^3.1.2",
+    "favico.js": "^0.3.10",
+    "filesize": "3.5.6",
     "flux": "~2.0.3",
-    "gemini-scrollbar": "matrix-org/gemini-scrollbar#87ebaa7",
+    "gemini-scrollbar": "matrix-org/gemini-scrollbar#b302279",
     "gfm.css": "^1.1.1",
     "highlight.js": "^9.0.0",
-    "linkifyjs": "^2.0.0-beta.4",
-    "matrix-js-sdk": "^0.5.2",
-    "matrix-react-sdk": "^0.5.2",
+    "linkifyjs": "^2.1.3",
+    "matrix-js-sdk": "0.7.10",
+    "matrix-react-sdk": "0.9.2",
     "modernizr": "^3.1.0",
+    "pako": "^1.0.5",
     "q": "^1.4.1",
-    "react": "^15.0.1",
+    "react": "^15.4.0",
     "react-dnd": "^2.1.4",
     "react-dnd-html5-backend": "^2.1.2",
-    "react-dom": "^15.0.1",
-    "react-gemini-scrollbar": "matrix-org/react-gemini-scrollbar#c3d942e",
-    "sanitize-html": "^1.11.1"
+    "react-dom": "^15.4.0",
+    "react-gemini-scrollbar": "matrix-org/react-gemini-scrollbar#5e97aef",
+    "sanitize-html": "^1.11.1",
+    "ua-parser-js": "^0.7.10",
+    "url": "^0.11.0"
   },
   "devDependencies": {
-    "babel": "^5.8.23",
-    "babel-core": "^5.8.25",
-    "babel-loader": "^5.3.2",
-    "catw": "^1.0.1",
+    "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-class-properties": "^6.16.0",
+    "babel-plugin-transform-object-rest-spread": "^6.16.0",
+    "babel-plugin-transform-runtime": "^6.15.0",
+    "babel-preset-es2015": "^6.16.0",
+    "babel-preset-es2016": "^6.16.0",
+    "babel-preset-es2017": "^6.16.0",
+    "babel-preset-react": "^6.16.0",
+    "babel-preset-stage-2": "^6.17.0",
+    "chokidar": "^1.6.1",
+    "cpx": "^1.3.2",
+    "cross-env": "^4.0.0",
     "css-raw-loader": "^0.1.1",
+    "electron-builder": "^11.2.4",
+    "electron-builder-squirrel-windows": "^11.2.1",
+    "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": "^6.9.0",
     "expect": "^1.16.0",
-    "http-server": "^0.8.4",
+    "fs-extra": "^0.30.0",
+    "html-webpack-plugin": "^2.24.0",
     "json-loader": "^0.5.3",
     "karma": "^0.13.22",
     "karma-chrome-launcher": "^0.2.3",
@@ -67,15 +117,61 @@
     "karma-junit-reporter": "^0.4.1",
     "karma-mocha": "^0.2.2",
     "karma-phantomjs-launcher": "^1.0.0",
-    "karma-sourcemap-loader": "^0.3.7",
     "karma-webpack": "^1.7.0",
+    "minimist": "^1.2.0",
+    "mkdirp": "^0.5.1",
     "mocha": "^2.4.5",
     "parallelshell": "^1.2.0",
     "phantomjs-prebuilt": "^2.1.7",
-    "react-addons-test-utils": "^15.0.1",
-    "react-addons-perf": "^15.0",
+    "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",
     "rimraf": "^2.4.3",
     "source-map-loader": "^0.1.5",
-    "webpack": "^1.12.14"
+    "webpack": "^1.12.14",
+    "webpack-dev-server": "^1.16.2"
+  },
+  "optionalDependencies": {
+    "olm": "https://matrix.org/packages/npm/olm/olm-2.2.1.tgz"
+  },
+  "build": {
+    "appId": "im.riot.app",
+    "category": "Network",
+    "electronVersion": "1.6.8",
+    "//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": [
+      "node_modules/**",
+      "src/**",
+      "img/**"
+    ],
+    "extraResources": [
+      "webapp/**/*"
+    ],
+    "linux": {
+      "target": "deb",
+      "category": "Network;InstantMessaging;Chat",
+      "maintainer": "support@riot.im",
+      "desktop": {
+        "StartupWMClass": "riot-web"
+      }
+    },
+    "win": {
+      "target": "squirrel"
+    },
+    "directories": {
+      "buildResources": "electron_app/build",
+      "output": "electron_app/dist",
+      "app": "electron_app"
+    }
   }
 }

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 "$@"

release_config.yaml

@@ -0,0 +1 @@
+signing_id: packages@riot.im