This repository has been archived by the owner on Sep 11, 2024. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 828
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #2500 from matrix-org/travis/usettings/tab/help
Implement the "Help & About" tab of new user settings
- Loading branch information
Showing
5 changed files
with
274 additions
and
15 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /* | ||
| Copyright 2019 New Vector 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. | ||
| */ | ||
|
|
||
| .mx_HelpSettingsTab_debugButton { | ||
| margin-bottom: 5px; | ||
| margin-top: 5px; | ||
| } | ||
|
|
||
| .mx_HelpSettingsTab span.mx_AccessibleButton { | ||
| word-break: break-word; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,227 @@ | ||
| /* | ||
| Copyright 2019 New Vector 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'; | ||
| import PropTypes from 'prop-types'; | ||
| import {_t, getCurrentLanguage} from "../../../../languageHandler"; | ||
| import MatrixClientPeg from "../../../../MatrixClientPeg"; | ||
| import AccessibleButton from "../../elements/AccessibleButton"; | ||
| import SdkConfig from "../../../../SdkConfig"; | ||
| import createRoom from "../../../../createRoom"; | ||
| const packageJson = require('../../../../../package.json'); | ||
| const Modal = require("../../../../Modal"); | ||
| const sdk = require("../../../../index"); | ||
| const PlatformPeg = require("../../../../PlatformPeg"); | ||
|
|
||
| // if this looks like a release, use the 'version' from package.json; else use | ||
| // the git sha. Prepend version with v, to look like riot-web version | ||
| const REACT_SDK_VERSION = 'dist' in packageJson ? packageJson.version : packageJson.gitHead || '<local>'; | ||
|
|
||
| // Simple method to help prettify GH Release Tags and Commit Hashes. | ||
| const semVerRegex = /^v?(\d+\.\d+\.\d+(?:-rc.+)?)(?:-(?:\d+-g)?([0-9a-fA-F]+))?(?:-dirty)?$/i; | ||
| const ghVersionLabel = function(repo, token='') { | ||
| const match = token.match(semVerRegex); | ||
| let url; | ||
| if (match && match[1]) { // basic semVer string possibly with commit hash | ||
| url = (match.length > 1 && match[2]) | ||
| ? `https://github.com/${repo}/commit/${match[2]}` | ||
| : `https://github.com/${repo}/releases/tag/v${match[1]}`; | ||
| } else { | ||
| url = `https://github.com/${repo}/commit/${token.split('-')[0]}`; | ||
| } | ||
| return <a target="_blank" rel="noopener" href={url}>{ token }</a>; | ||
| }; | ||
|
|
||
| export default class HelpSettingsTab extends React.Component { | ||
| static propTypes = { | ||
| closeSettingsFn: PropTypes.func.isRequired, | ||
| }; | ||
|
|
||
| constructor() { | ||
| super(); | ||
|
|
||
| this.state = { | ||
| vectorVersion: null, | ||
| canUpdate: false, | ||
| }; | ||
| } | ||
|
|
||
| componentWillMount(): void { | ||
| PlatformPeg.get().getAppVersion().then((ver) => this.setState({vectorVersion: ver})).catch((e) => { | ||
| console.error("Error getting vector version: ", e); | ||
| }); | ||
| PlatformPeg.get().canSelfUpdate().then((v) => this.setState({canUpdate: v})).catch((e) => { | ||
| console.error("Error getting self updatability: ", e); | ||
| }); | ||
| } | ||
|
|
||
| _onClearCacheAndReload = (e) => { | ||
| if (!PlatformPeg.get()) return; | ||
|
|
||
| MatrixClientPeg.get().stopClient(); | ||
| MatrixClientPeg.get().store.deleteAllData().done(() => { | ||
| PlatformPeg.get().reload(); | ||
| }); | ||
| }; | ||
|
|
||
| _onBugReport = (e) => { | ||
| const BugReportDialog = sdk.getComponent("dialogs.BugReportDialog"); | ||
| if (!BugReportDialog) { | ||
| return; | ||
| } | ||
| Modal.createTrackedDialog('Bug Report Dialog', '', BugReportDialog, {}); | ||
| }; | ||
|
|
||
| _onStartBotChat = (e) => { | ||
| this.props.closeSettingsFn(); | ||
| createRoom({ | ||
| dmUserId: SdkConfig.get().welcomeUserId, | ||
| andView: true, | ||
| }); | ||
| }; | ||
|
|
||
| _showSpoiler = (event) => { | ||
| const target = event.target; | ||
| target.innerHTML = target.getAttribute('data-spoiler'); | ||
|
|
||
| const range = document.createRange(); | ||
| range.selectNodeContents(target); | ||
|
|
||
| const selection = window.getSelection(); | ||
| selection.removeAllRanges(); | ||
| selection.addRange(range); | ||
| }; | ||
|
|
||
| _renderLegal() { | ||
| const tocLinks = SdkConfig.get().terms_and_conditions_links; | ||
| if (!tocLinks) return null; | ||
|
|
||
| const legalLinks = []; | ||
| for (const tocEntry of SdkConfig.get().terms_and_conditions_links) { | ||
| legalLinks.push(<div key={tocEntry.url}> | ||
| <a href={tocEntry.url} rel="noopener" target="_blank">{tocEntry.text}</a> | ||
| </div>); | ||
| } | ||
|
|
||
| return ( | ||
| <div className='mx_SettingsTab_section mx_HelpSettingsTab_versions'> | ||
| <span className='mx_SettingsTab_subheading'>{_t("Legal")}</span> | ||
| <div className='mx_SettingsTab_subsectionText'> | ||
| {legalLinks} | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| render() { | ||
| let faqText = _t('For help with using Riot, click <a>here</a>.', {}, { | ||
| 'a': (sub) => <a href="https://about.riot.im/need-help/" rel='noopener' target='_blank'>{sub}</a>, | ||
| }); | ||
| if (SdkConfig.get().welcomeUserId && getCurrentLanguage().startsWith('en')) { | ||
| faqText = ( | ||
| <div> | ||
| { | ||
| _t('For help with using Riot, click <a>here</a> or start a chat with our ' + | ||
| 'bot using the button below.', {}, { | ||
| 'a': (sub) => <a href="https://about.riot.im/need-help/" rel='noopener' | ||
| target='_blank'>{sub}</a>, | ||
| }) | ||
| } | ||
| <AccessibleButton onClick={this._onStartBotChat} kind='primary'> | ||
| {_t("Start a chat with Riot Bot")} | ||
| </AccessibleButton> | ||
| </div> | ||
| ); | ||
| } | ||
|
|
||
| const reactSdkVersion = REACT_SDK_VERSION !== '<local>' | ||
| ? ghVersionLabel('matrix-org/matrix-react-sdk', REACT_SDK_VERSION) | ||
| : REACT_SDK_VERSION; | ||
| const vectorVersion = this.state.vectorVersion | ||
| ? ghVersionLabel('vector-im/riot-web', this.state.vectorVersion) | ||
| : 'unknown'; | ||
|
|
||
| let olmVersion = MatrixClientPeg.get().olmVersion; | ||
| olmVersion = olmVersion ? `${olmVersion[0]}.${olmVersion[1]}.${olmVersion[2]}` : '<not-enabled>'; | ||
|
|
||
| let updateButton = null; | ||
| if (this.state.canUpdate) { | ||
| const platform = PlatformPeg.get(); | ||
| updateButton = ( | ||
| <AccessibleButton onClick={platform.startUpdateCheck} kind='primary'> | ||
| {_t('Check for update')} | ||
| </AccessibleButton> | ||
| ); | ||
| } | ||
|
|
||
| return ( | ||
| <div className="mx_SettingsTab mx_HelpSettingsTab"> | ||
| <div className="mx_SettingsTab_heading">{_t("Help & About")}</div> | ||
| <div className="mx_SettingsTab_section"> | ||
| <span className='mx_SettingsTab_subheading'>{_t('Bug reporting')}</span> | ||
| <div className='mx_SettingsTab_subsectionText'> | ||
| { | ||
| _t( "If you've submitted a bug via GitHub, debug logs can help " + | ||
| "us track down the problem. Debug logs contain application " + | ||
| "usage data including your username, the IDs or aliases of " + | ||
| "the rooms or groups you have visited and the usernames of " + | ||
| "other users. They do not contain messages.", | ||
| ) | ||
| } | ||
| <div className='mx_HelpSettingsTab_debugButton'> | ||
| <AccessibleButton onClick={this._onBugReport} kind='primary'> | ||
| {_t("Submit debug logs")} | ||
| </AccessibleButton> | ||
| </div> | ||
| <div className='mx_HelpSettingsTab_debugButton'> | ||
| <AccessibleButton onClick={this._onClearCacheAndReload} kind='danger'> | ||
| {_t("Clear Cache and Reload")} | ||
| </AccessibleButton> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| <div className='mx_SettingsTab_section'> | ||
| <span className='mx_SettingsTab_subheading'>{_t("FAQ")}</span> | ||
| <div className='mx_SettingsTab_subsectionText'> | ||
| {faqText} | ||
| </div> | ||
| </div> | ||
| <div className='mx_SettingsTab_section mx_HelpSettingsTab_versions'> | ||
| <span className='mx_SettingsTab_subheading'>{_t("Versions")}</span> | ||
| <div className='mx_SettingsTab_subsectionText'> | ||
| {_t("matrix-react-sdk version:")} {reactSdkVersion}<br /> | ||
| {_t("riot-web version:")} {vectorVersion}<br /> | ||
| {_t("olm version:")} {olmVersion}<br /> | ||
| {updateButton} | ||
| </div> | ||
| </div> | ||
| {this._renderLegal()} | ||
| <div className='mx_SettingsTab_section mx_HelpSettingsTab_versions'> | ||
| <span className='mx_SettingsTab_subheading'>{_t("Advanced")}</span> | ||
| <div className='mx_SettingsTab_subsectionText'> | ||
| {_t("Homeserver is")} {MatrixClientPeg.get().getHomeserverUrl()}<br /> | ||
| {_t("Identity Server is")} {MatrixClientPeg.get().getIdentityServerUrl()}<br /> | ||
| {_t("Access Token:") + ' '} | ||
| <AccessibleButton element="span" onClick={this._showSpoiler} | ||
| data-spoiler={MatrixClientPeg.get().getAccessToken()}> | ||
| <{ _t("click to reveal") }> | ||
| </AccessibleButton> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters