/* Copyright 2019 - 2023 The Matrix.org Foundation C.I.C. 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, { ReactNode } from "react"; import { logger } from "matrix-js-sdk/src/logger"; import AccessibleButton from "../../../elements/AccessibleButton"; import { _t, getCurrentLanguage } from "../../../../../languageHandler"; import { MatrixClientPeg } from "../../../../../MatrixClientPeg"; import SdkConfig from "../../../../../SdkConfig"; import createRoom from "../../../../../createRoom"; import Modal from "../../../../../Modal"; import PlatformPeg from "../../../../../PlatformPeg"; import UpdateCheckButton from "../../UpdateCheckButton"; import BugReportDialog from "../../../dialogs/BugReportDialog"; import { OpenToTabPayload } from "../../../../../dispatcher/payloads/OpenToTabPayload"; import { Action } from "../../../../../dispatcher/actions"; import { UserTab } from "../../../dialogs/UserTab"; import dis from "../../../../../dispatcher/dispatcher"; import CopyableText from "../../../elements/CopyableText"; import SettingsTab from "../SettingsTab"; import { SettingsSection } from "../../shared/SettingsSection"; import SettingsSubsection, { SettingsSubsectionText } from "../../shared/SettingsSubsection"; import ExternalLink from "../../../elements/ExternalLink"; import MatrixClientContext from "../../../../../contexts/MatrixClientContext"; interface IProps { closeSettingsFn: () => void; } interface IState { appVersion: string | null; canUpdate: boolean; } export default class HelpUserSettingsTab extends React.Component { public static contextType = MatrixClientContext; public context!: React.ContextType; public constructor(props: IProps) { super(props); this.state = { appVersion: null, canUpdate: false, }; } public componentDidMount(): void { PlatformPeg.get() ?.getAppVersion() .then((ver) => this.setState({ appVersion: ver })) .catch((e) => { logger.error("Error getting vector version: ", e); }); PlatformPeg.get() ?.canSelfUpdate() .then((v) => this.setState({ canUpdate: v })) .catch((e) => { logger.error("Error getting self updatability: ", e); }); } private getVersionInfo(): { appVersion: string; olmVersion: string } { const brand = SdkConfig.get().brand; const appVersion = this.state.appVersion || "unknown"; const olmVersionTuple = MatrixClientPeg.get().olmVersion; const olmVersion = olmVersionTuple ? `${olmVersionTuple[0]}.${olmVersionTuple[1]}.${olmVersionTuple[2]}` : ""; return { appVersion: `${_t("%(brand)s version:", { brand })} ${appVersion}`, olmVersion: `${_t("Olm version:")} ${olmVersion}`, }; } private onClearCacheAndReload = (): void => { if (!PlatformPeg.get()) return; // Dev note: please keep this log line, it's useful when troubleshooting a MatrixClient suddenly // stopping in the middle of the logs. logger.log("Clear cache & reload clicked"); MatrixClientPeg.get().stopClient(); MatrixClientPeg.get() .store.deleteAllData() .then(() => { PlatformPeg.get()?.reload(); }); }; private onBugReport = (): void => { Modal.createDialog(BugReportDialog, {}); }; private onStartBotChat = (): void => { this.props.closeSettingsFn(); createRoom(this.context, { dmUserId: SdkConfig.get("welcome_user_id"), andView: true, }); }; private renderLegal(): ReactNode { const tocLinks = SdkConfig.get().terms_and_conditions_links; if (!tocLinks) return null; const legalLinks: JSX.Element[] = []; for (const tocEntry of tocLinks) { legalLinks.push(
{tocEntry.text}
, ); } return ( {legalLinks} ); } private renderCredits(): JSX.Element { // Note: This is not translated because it is legal text. // Also,   is ugly but necessary. return (
  • {_t( "The default cover photo is © " + "Jesús Roncero used under the terms of CC-BY-SA 4.0.", {}, { photo: (sub) => ( {sub} ), author: (sub) => ( {sub} ), terms: (sub) => ( {sub} ), }, )}
  • {_t( "The twemoji-colr font is © Mozilla Foundation " + "used under the terms of Apache 2.0.", {}, { colr: (sub) => ( {sub} ), author: (sub) => {sub}, terms: (sub) => ( {sub} ), }, )}
  • {_t( "The Twemoji emoji art is © " + "Twitter, Inc and other contributors used under the terms of " + "CC-BY 4.0.", {}, { twemoji: (sub) => ( {sub} ), author: (sub) => ( {sub} ), terms: (sub) => ( {sub} ), }, )}
); } private getVersionTextToCopy = (): string => { const { appVersion, olmVersion } = this.getVersionInfo(); return `${appVersion}\n${olmVersion}`; }; private onKeyboardShortcutsClicked = (): void => { dis.dispatch({ action: Action.ViewUserSettings, initialTabId: UserTab.Keyboard, }); }; public render(): React.ReactNode { const brand = SdkConfig.get().brand; let faqText = _t( "For help with using %(brand)s, click here.", { brand, }, { a: (sub) => {sub}, }, ); if (SdkConfig.get("welcome_user_id") && getCurrentLanguage().startsWith("en")) { faqText = (
{_t( "For help with using %(brand)s, click here or start a chat with our " + "bot using the button below.", { brand, }, { a: (sub) => ( {sub} ), }, )}
{_t("Chat with %(brand)s Bot", { brand })}
); } let updateButton: JSX.Element | undefined; if (this.state.canUpdate) { updateButton = ; } let bugReportingSection; if (SdkConfig.get().bug_report_endpoint_url) { bugReportingSection = ( {_t( "If you've submitted a bug via GitHub, debug logs can help " + "us track down the problem. ", )} {_t( "Debug logs contain application " + "usage data including your username, the IDs or aliases of " + "the rooms you have visited, which UI elements you " + "last interacted with, and the usernames of other users. " + "They do not contain messages.", )} } > {_t("Submit debug logs")} {_t( "To report a Matrix-related security issue, please read the Matrix.org " + "Security Disclosure Policy.", {}, { a: (sub) => ( {sub} ), }, )} ); } const { appVersion, olmVersion } = this.getVersionInfo(); return ( {bugReportingSection} {_t("Keyboard Shortcuts")} {appVersion}
{olmVersion}
{updateButton}
{this.renderLegal()} {this.renderCredits()} {_t( "Homeserver is %(homeserverUrl)s", { homeserverUrl: MatrixClientPeg.get().getHomeserverUrl(), }, { code: (sub) => {sub}, }, )} {MatrixClientPeg.get().getIdentityServerUrl() && ( {_t( "Identity server is %(identityServerUrl)s", { identityServerUrl: MatrixClientPeg.get().getIdentityServerUrl(), }, { code: (sub) => {sub}, }, )} )}
{_t("Access Token")} {_t( "Your access token gives full access to your account." + " Do not share it with anyone.", )} MatrixClientPeg.get().getAccessToken()}> {MatrixClientPeg.get().getAccessToken()}
{_t("Clear cache and reload")}
); } }