Merge pull request #1257 from matrix-org/rxl881/widgetPermissions

Widget permissions

src/WidgetUtils.js

@@ -0,0 +1,58 @@
+/*
+Copyright 2017 Vector Creations 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.
+*/
+
+import MatrixClientPeg from './MatrixClientPeg';
+
+export default class WidgetUtils {
+
+    /* Returns true if user is able to send state events to modify widgets in this room
+     * @param roomId -- The ID of the room to check
+     * @return Boolean -- true if the user can modify widgets in this room
+     * @throws Error -- specifies the error reason
+     */
+    static canUserModifyWidgets(roomId) {
+        if (!roomId) {
+            console.warn('No room ID specified');
+            return false;
+        }
+
+        const client = MatrixClientPeg.get();
+        if (!client) {
+            console.warn('User must be be logged in');
+            return false;
+        }
+
+        const room = client.getRoom(roomId);
+        if (!room) {
+            console.warn(`Room ID ${roomId} is not recognised`);
+            return false;
+        }
+
+        const me = client.credentials.userId;
+        if (!me) {
+            console.warn('Failed to get user ID');
+            return false;
+        }
+
+        const member = room.getMember(me);
+        if (!member || member.membership !== "join") {
+            console.warn(`User ${me} is not in room ${roomId}`);
+            return false;
+        }
+
+        return room.currentState.maySendStateEvent('im.vector.modular.widgets', me);
+    }
+}

src/components/views/elements/AppPermission.js

@@ -0,0 +1,74 @@
+import React from 'react';
+import PropTypes from 'prop-types';
+import url from 'url';
+import { _t } from '../../../languageHandler';
+
+export default class AppPermission extends React.Component {
+    constructor(props) {
+        super(props);
+
+        const curlBase = this.getCurlBase();
+        this.state = { curlBase: curlBase};
+    }
+
+    // Return string representation of content URL without query parameters
+    getCurlBase() {
+        const wurl = url.parse(this.props.url);
+        let curl;
+        let curlString;
+
+        const searchParams = new URLSearchParams(wurl.search);
+
+        if(this.isScalarWurl(wurl) && searchParams && searchParams.get('url')) {
+            curl = url.parse(searchParams.get('url'));
+            if(curl) {
+                curl.search = curl.query = "";
+                curlString = curl.format();
+            }
+        }
+        if (!curl && wurl) {
+            wurl.search = wurl.query = "";
+            curlString = wurl.format();
+        }
+        return curlString;
+    }
+
+    isScalarWurl(wurl) {
+        if(wurl && wurl.hostname && (
+            wurl.hostname === 'scalar.vector.im' ||
+            wurl.hostname === 'scalar-staging.riot.im' ||
+            wurl.hostname === 'demo.riot.im' ||
+            wurl.hostname === 'localhost'
+        )) {
+            return true;
+        }
+        return false;
+    }
+
+    render() {
+        return (
+            <div className='mx_AppPermissionWarning'>
+                <div className='mx_AppPermissionWarningImage'>
+                    <img src='img/warning.svg' alt={_t('Warning!')}/>
+                </div>
+                <div className='mx_AppPermissionWarningText'>
+                    <span className='mx_AppPermissionWarningTextLabel'>Do you want to load widget from URL:</span> <span className='mx_AppPermissionWarningTextURL'>{this.state.curlBase}</span>
+                </div>
+                <input
+                    className='mx_AppPermissionButton'
+                    type='button'
+                    value={_t('Allow')}
+                    onClick={this.props.onPermissionGranted}
+                />
+            </div>
+        );
+    }
+}
+
+AppPermission.propTypes = {
+    url: PropTypes.string.isRequired,
+    onPermissionGranted: PropTypes.func.isRequired,
+};
+AppPermission.defaultProps = {
+    onPermissionGranted: function() {},
+};

src/components/views/elements/AppTile.js

@@ -24,6 +24,9 @@ import SdkConfig from '../../../SdkConfig';
 import Modal from '../../../Modal';
 import { _t } from '../../../languageHandler';
 import sdk from '../../../index';
+import AppPermission from './AppPermission';
+import MessageSpinner from './MessageSpinner';
+import WidgetUtils from '../../../WidgetUtils';
 
 const ALLOWED_APP_URL_SCHEMES = ['https:', 'http:'];
 const betaHelpMsg = 'This feature is currently experimental and is intended for beta testing only';
@@ -37,6 +40,9 @@ export default React.createClass({
         name: React.PropTypes.string.isRequired,
         room: React.PropTypes.object.isRequired,
         type: React.PropTypes.string.isRequired,
+        // Specifying 'fullWidth' as true will render the app tile to fill the width of the app drawer continer.
+        // This should be set to true when there is only one widget in the app drawer, otherwise it should be false.
+        fullWidth: React.PropTypes.bool,
     },
 
     getDefaultProps: function() {
@@ -46,9 +52,13 @@ export default React.createClass({
     },
 
     getInitialState: function() {
+        const widgetPermissionId = [this.props.room.roomId, encodeURIComponent(this.props.url)].join('_');
+        const hasPermissionToLoad = localStorage.getItem(widgetPermissionId);
         return {
             loading: false,
             widgetUrl: this.props.url,
+            widgetPermissionId: widgetPermissionId,
+            hasPermissionToLoad: Boolean(hasPermissionToLoad === 'true'),
             error: null,
             deleting: false,
         };
@@ -91,6 +101,10 @@ export default React.createClass({
         });
     },
 
+    _canUserModify: function() {
+        return WidgetUtils.canUserModifyWidgets(this.props.room.roomId);
+    },
+
     _onEditClick: function(e) {
         console.log("Edit widget ID ", this.props.id);
         const IntegrationsManager = sdk.getComponent("views.settings.IntegrationsManager");
@@ -100,20 +114,49 @@ export default React.createClass({
         }, "mx_IntegrationsManager");
     },
 
+    /* If user has permission to modify widgets, delete the widget, otherwise revoke access for the widget to load in the user's browser
+    */
     _onDeleteClick: function() {
-        console.log("Delete widget %s", this.props.id);
+        if (this._canUserModify()) {
-        this.setState({deleting: true});
+            console.log("Delete widget %s", this.props.id);
-        MatrixClientPeg.get().sendStateEvent(
+            this.setState({deleting: true});
-            this.props.room.roomId,
+            MatrixClientPeg.get().sendStateEvent(
-            'im.vector.modular.widgets',
+                this.props.room.roomId,
-            {}, // empty content
+                'im.vector.modular.widgets',
-            this.props.id,
+                {}, // empty content
-        ).then(() => {
+                this.props.id,
-            console.log('Deleted widget');
+            ).then(() => {
-        }, (e) => {
+                console.log('Deleted widget');
-            console.error('Failed to delete widget', e);
+            }, (e) => {
-            this.setState({deleting: false});
+                console.error('Failed to delete widget', e);
-        });
+                this.setState({deleting: false});
+            });
+        } else {
+            console.log("Revoke widget permissions - %s", this.props.id);
+            this._revokeWidgetPermission();
+        }
+    },
+
+    // Widget labels to render, depending upon user permissions
+    // These strings are translated at the point that they are inserted in to the DOM, in the render method
+    _deleteWidgetLabel() {
+        if (this._canUserModify()) {
+            return 'Delete widget';
+        }
+        return 'Revoke widget access';
+    },
+
+    /* TODO -- Store permission in account data so that it is persisted across multiple devices */
+    _grantWidgetPermission() {
+        console.warn('Granting permission to load widget - ', this.state.widgetUrl);
+        localStorage.setItem(this.state.widgetPermissionId, true);
+        this.setState({hasPermissionToLoad: true});
+    },
+
+    _revokeWidgetPermission() {
+        console.warn('Revoking permission to load widget - ', this.state.widgetUrl);
+        localStorage.removeItem(this.state.widgetPermissionId);
+        this.setState({hasPermissionToLoad: false});
     },
 
     formatAppTileName: function() {
@@ -133,34 +176,56 @@ export default React.createClass({
             return <div></div>;
         }
 
+        // Note that there is advice saying allow-scripts shouldn't be used with allow-same-origin
+        // because that would allow the iframe to prgramatically remove the sandbox attribute, but
+        // this would only be for content hosted on the same origin as the riot client: anything
+        // hosted on the same origin as the client will get the same access as if you clicked
+        // a link to it.
+        const sandboxFlags = "allow-forms allow-popups allow-popups-to-escape-sandbox "+
+            "allow-same-origin allow-scripts allow-presentation";
+        const parsedWidgetUrl = url.parse(this.state.widgetUrl);
+        let safeWidgetUrl = '';
+        if (ALLOWED_APP_URL_SCHEMES.indexOf(parsedWidgetUrl.protocol) !== -1) {
+            safeWidgetUrl = url.format(parsedWidgetUrl);
+        }
+
         if (this.state.loading) {
             appTileBody = (
-                <div> Loading... </div>
+                <div className='mx_AppTileBody mx_AppLoading'>
+                    <MessageSpinner msg='Loading...'/>
+                </div>
             );
-        } else {
+        } else if (this.state.hasPermissionToLoad == true) {
-            // Note that there is advice saying allow-scripts shouldn't be used with allow-same-origin
-            // because that would allow the iframe to prgramatically remove the sandbox attribute, but
-            // this would only be for content hosted on the same origin as the riot client: anything
-            // hosted on the same origin as the client will get the same access as if you clicked
-            // a link to it.
-            const sandboxFlags = "allow-forms allow-popups allow-popups-to-escape-sandbox "+
-                "allow-same-origin allow-scripts";
-            const parsedWidgetUrl = url.parse(this.state.widgetUrl);
-            let safeWidgetUrl = '';
-            if (ALLOWED_APP_URL_SCHEMES.indexOf(parsedWidgetUrl.protocol) !== -1) {
-                safeWidgetUrl = url.format(parsedWidgetUrl);
-            }
             appTileBody = (
                 <div className="mx_AppTileBody">
-                    <iframe ref="appFrame" src={safeWidgetUrl} allowFullScreen="true"
+                    <iframe
+                        ref="appFrame"
+                        src={safeWidgetUrl}
+                        allowFullScreen="true"
                         sandbox={sandboxFlags}
                     ></iframe>
                 </div>
             );
+        } else {
+            appTileBody = (
+                <div className="mx_AppTileBody">
+                    <AppPermission
+                        url={this.state.widgetUrl}
+                        onPermissionGranted={this._grantWidgetPermission}
+                    />
+                </div>
+            );
         }
 
         // editing is done in scalar
-        const showEditButton = Boolean(this._scalarClient);
+        const showEditButton = Boolean(this._scalarClient && this._canUserModify());
+        const deleteWidgetLabel = this._deleteWidgetLabel();
+        let deleteIcon = 'img/cancel.svg';
+        let deleteClasses = 'mx_filterFlipColor mx_AppTileMenuBarWidget';
+        if(this._canUserModify()) {
+            deleteIcon = 'img/cancel-red.svg';
+            deleteClasses += ' mx_AppTileMenuBarWidgetDelete';
+        }
 
         return (
             <div className={this.props.fullWidth ? "mx_AppTileFullWidth" : "mx_AppTile"} id={this.props.id}>
@@ -172,14 +237,18 @@ export default React.createClass({
                         {showEditButton && <img
                             src="img/edit.svg"
                             className="mx_filterFlipColor mx_AppTileMenuBarWidget mx_AppTileMenuBarWidgetPadding"
-                            width="8" height="8" alt="Edit"
+                            width="8" height="8"
+                            alt={_t('Edit')}
+                            title={_t('Edit')}
                             onClick={this._onEditClick}
                         />}
 
                         {/* Delete widget */}
-                        <img src="img/cancel.svg"
+                        <img src={deleteIcon}
-                        className="mx_filterFlipColor mx_AppTileMenuBarWidget"
+                        className={deleteClasses}
-                        width="8" height="8" alt={_t("Cancel")}
+                        width="8" height="8"
+                        alt={_t(deleteWidgetLabel)}
+                        title={_t(deleteWidgetLabel)}
                         onClick={this._onDeleteClick}
                         />
                     </span>

src/components/views/elements/MessageSpinner.js

@@ -0,0 +1,34 @@
+/*
+Copyright 2017 Vector Creations 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.
+*/
+
+import React from 'react';
+
+module.exports = React.createClass({
+    displayName: 'MessageSpinner',
+
+    render: function() {
+        const w = this.props.w || 32;
+        const h = this.props.h || 32;
+        const imgClass = this.props.imgClassName || "";
+        const msg = this.props.msg || "Loading...";
+        return (
+            <div className="mx_Spinner">
+                <div className="mx_Spinner_Msg">{msg}</div>&nbsp;
+                <img src="img/spinner.gif" width={w} height={h} className={imgClass}/>
+            </div>
+        );
+    },
+});

src/components/views/rooms/AppsDrawer.js

@@ -26,6 +26,7 @@ import SdkConfig from '../../../SdkConfig';
 import ScalarAuthClient from '../../../ScalarAuthClient';
 import ScalarMessaging from '../../../ScalarMessaging';
 import { _t } from '../../../languageHandler';
+import WidgetUtils from '../../../WidgetUtils';
 
 
 module.exports = React.createClass({
@@ -147,6 +148,15 @@ module.exports = React.createClass({
         });
     },
 
+    _canUserModify: function() {
+        try {
+            return WidgetUtils.canUserModifyWidgets(this.props.room.roomId);
+        } catch(err) {
+            console.error(err);
+            return false;
+        }
+    },
+
     onClickAddWidget: function(e) {
         if (e) {
             e.preventDefault();
@@ -164,7 +174,7 @@ module.exports = React.createClass({
     render: function() {
         const apps = this.state.apps.map(
             (app, index, arr) => {
-                return <AppTile
+                return (<AppTile
                     key={app.id}
                     id={app.id}
                     url={app.url}
@@ -173,10 +183,10 @@ module.exports = React.createClass({
                     fullWidth={arr.length<2 ? true : false}
                     room={this.props.room}
                     userId={this.props.userId}
-                />;
+                />);
             });
 
-        const addWidget = this.state.apps && this.state.apps.length < 2 &&
+        const addWidget = this.state.apps && this.state.apps.length < 2 && this._canUserModify() &&
             (<div onClick={this.onClickAddWidget}
                             role="button"
                             tabIndex="0"

src/i18n/strings/en_EN.json

@@ -134,6 +134,7 @@
     "Add phone number": "Add phone number",
     "Admin": "Admin",
     "Admin tools": "Admin tools",
+    "Allow": "Allow",
     "And %(count)s more...": "And %(count)s more...",
     "VoIP": "VoIP",
     "Missing Media Permissions, click here to request.": "Missing Media Permissions, click here to request.",
@@ -241,6 +242,7 @@
     "Decrypt %(text)s": "Decrypt %(text)s",
     "Decryption error": "Decryption error",
     "Delete": "Delete",
+    "Delete widget": "Delete widget",
     "demote": "demote",
     "Deops user with given id": "Deops user with given id",
     "Default": "Default",
@@ -267,6 +269,7 @@
     "Drop here %(toAction)s": "Drop here %(toAction)s",
     "Drop here to tag %(section)s": "Drop here to tag %(section)s",
     "Ed25519 fingerprint": "Ed25519 fingerprint",
+    "Edit": "Edit",
     "Email": "Email",
     "Email address": "Email address",
     "Email address (optional)": "Email address (optional)",
@@ -460,6 +463,7 @@
     "Reason": "Reason",
     "Reason: %(reasonText)s": "Reason: %(reasonText)s",
     "Revoke Moderator": "Revoke Moderator",
+    "Revoke widget access": "Revoke widget access",
     "Refer a friend to Riot:": "Refer a friend to Riot:",
     "Register": "Register",
     "rejected": "rejected",

src/i18n/strings/en_US.json

@@ -233,6 +233,7 @@
     "demote": "demote",
     "Deops user with given id": "Deops user with given id",
     "Default": "Default",
+    "Delete widget": "Delete widget",
     "Device already verified!": "Device already verified!",
     "Device ID": "Device ID",
     "Device ID:": "Device ID:",
@@ -252,6 +253,7 @@
     "Drop here %(toAction)s": "Drop here %(toAction)s",
     "Drop here to tag %(section)s": "Drop here to tag %(section)s",
     "Ed25519 fingerprint": "Ed25519 fingerprint",
+    "Edit": "Edit",
     "Email": "Email",
     "Email address": "Email address",
     "Email address (optional)": "Email address (optional)",
@@ -421,6 +423,7 @@
     "Profile": "Profile",
     "Reason": "Reason",
     "Revoke Moderator": "Revoke Moderator",
+    "Revoke widget access": "Revoke widget access",
     "Refer a friend to Riot:": "Refer a friend to Riot:",
     "Register": "Register",
     "rejected": "rejected",