/* Copyright 2019 New Vector Ltd Copyright 2019 - 2021 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 from 'react'; import { _t } from "../../../../../languageHandler"; import SdkConfig from "../../../../../SdkConfig"; import { MatrixClientPeg } from '../../../../../MatrixClientPeg'; import SettingsStore from "../../../../../settings/SettingsStore"; import { enumerateThemes } from "../../../../../theme"; import ThemeWatcher from "../../../../../settings/watchers/ThemeWatcher"; import Slider from "../../../elements/Slider"; import AccessibleButton from "../../../elements/AccessibleButton"; import dis from "../../../../../dispatcher/dispatcher"; import { FontWatcher } from "../../../../../settings/watchers/FontWatcher"; import { RecheckThemePayload } from '../../../../../dispatcher/payloads/RecheckThemePayload'; import { Action } from '../../../../../dispatcher/actions'; import { IValidationResult, IFieldState } from '../../../elements/Validation'; import StyledCheckbox from '../../../elements/StyledCheckbox'; import SettingsFlag from '../../../elements/SettingsFlag'; import Field from '../../../elements/Field'; import EventTilePreview from '../../../elements/EventTilePreview'; import StyledRadioGroup from "../../../elements/StyledRadioGroup"; import { SettingLevel } from "../../../../../settings/SettingLevel"; import { UIFeature } from "../../../../../settings/UIFeature"; import { Layout } from "../../../../../settings/Layout"; import { replaceableComponent } from "../../../../../utils/replaceableComponent"; import { compare } from "../../../../../utils/strings"; import LayoutSwitcher from "../../LayoutSwitcher"; interface IProps { } interface IThemeState { theme: string; useSystemTheme: boolean; } export interface CustomThemeMessage { isError: boolean; text: string; } interface IState extends IThemeState { // String displaying the current selected fontSize. // Needs to be string for things like '17.' without // trailing 0s. fontSize: string; customThemeUrl: string; customThemeMessage: CustomThemeMessage; useCustomFontSize: boolean; useSystemFont: boolean; systemFont: string; showAdvanced: boolean; layout: Layout; // User profile data for the message preview userId?: string; displayName: string; avatarUrl: string; } @replaceableComponent("views.settings.tabs.user.AppearanceUserSettingsTab") export default class AppearanceUserSettingsTab extends React.Component { private readonly MESSAGE_PREVIEW_TEXT = _t("Hey you. You're the best!"); private themeTimer: number; private unmounted = false; constructor(props: IProps) { super(props); this.state = { fontSize: (SettingsStore.getValue("baseFontSize", null) + FontWatcher.SIZE_DIFF).toString(), ...this.calculateThemeState(), customThemeUrl: "", customThemeMessage: { isError: false, text: "" }, useCustomFontSize: SettingsStore.getValue("useCustomFontSize"), useSystemFont: SettingsStore.getValue("useSystemFont"), systemFont: SettingsStore.getValue("systemFont"), showAdvanced: false, layout: SettingsStore.getValue("layout"), userId: null, displayName: null, avatarUrl: null, }; } async componentDidMount() { // Fetch the current user profile for the message preview const client = MatrixClientPeg.get(); const userId = client.getUserId(); const profileInfo = await client.getProfileInfo(userId); if (this.unmounted) return; this.setState({ userId, displayName: profileInfo.displayname, avatarUrl: profileInfo.avatar_url, }); } componentWillUnmount() { this.unmounted = true; } private calculateThemeState(): IThemeState { // We have to mirror the logic from ThemeWatcher.getEffectiveTheme so we // show the right values for things. const themeChoice: string = SettingsStore.getValue("theme"); const systemThemeExplicit: boolean = SettingsStore.getValueAt( SettingLevel.DEVICE, "use_system_theme", null, false, true); const themeExplicit: string = SettingsStore.getValueAt( SettingLevel.DEVICE, "theme", null, false, true); // If the user has enabled system theme matching, use that. if (systemThemeExplicit) { return { theme: themeChoice, useSystemTheme: true, }; } // If the user has set a theme explicitly, use that (no system theme matching) if (themeExplicit) { return { theme: themeChoice, useSystemTheme: false, }; } // Otherwise assume the defaults for the settings return { theme: themeChoice, useSystemTheme: SettingsStore.getValueAt(SettingLevel.DEVICE, "use_system_theme"), }; } private onThemeChange = (newTheme: string): void => { if (this.state.theme === newTheme) return; // doing getValue in the .catch will still return the value we failed to set, // so remember what the value was before we tried to set it so we can revert const oldTheme: string = SettingsStore.getValue('theme'); SettingsStore.setValue("theme", null, SettingLevel.DEVICE, newTheme).catch(() => { dis.dispatch({ action: Action.RecheckTheme }); this.setState({ theme: oldTheme }); }); this.setState({ theme: newTheme }); // The settings watcher doesn't fire until the echo comes back from the // server, so to make the theme change immediately we need to manually // do the dispatch now // XXX: The local echoed value appears to be unreliable, in particular // when settings custom themes(!) so adding forceTheme to override // the value from settings. dis.dispatch({ action: Action.RecheckTheme, forceTheme: newTheme }); }; private onUseSystemThemeChanged = (checked: boolean): void => { this.setState({ useSystemTheme: checked }); SettingsStore.setValue("use_system_theme", null, SettingLevel.DEVICE, checked); dis.dispatch({ action: Action.RecheckTheme }); }; private onFontSizeChanged = (size: number): void => { this.setState({ fontSize: size.toString() }); SettingsStore.setValue("baseFontSize", null, SettingLevel.DEVICE, size - FontWatcher.SIZE_DIFF); }; private onValidateFontSize = async ({ value }: Pick): Promise => { const parsedSize = parseFloat(value); const min = FontWatcher.MIN_SIZE + FontWatcher.SIZE_DIFF; const max = FontWatcher.MAX_SIZE + FontWatcher.SIZE_DIFF; if (isNaN(parsedSize)) { return { valid: false, feedback: _t("Size must be a number") }; } if (!(min <= parsedSize && parsedSize <= max)) { return { valid: false, feedback: _t('Custom font size can only be between %(min)s pt and %(max)s pt', { min, max }), }; } SettingsStore.setValue( "baseFontSize", null, SettingLevel.DEVICE, parseInt(value, 10) - FontWatcher.SIZE_DIFF, ); return { valid: true, feedback: _t('Use between %(min)s pt and %(max)s pt', { min, max }) }; }; private onAddCustomTheme = async (): Promise => { let currentThemes: string[] = SettingsStore.getValue("custom_themes"); if (!currentThemes) currentThemes = []; currentThemes = currentThemes.map(c => c); // cheap clone if (this.themeTimer) { clearTimeout(this.themeTimer); } try { const r = await fetch(this.state.customThemeUrl); // XXX: need some schema for this const themeInfo = await r.json(); if (!themeInfo || typeof(themeInfo['name']) !== 'string' || typeof(themeInfo['colors']) !== 'object') { this.setState({ customThemeMessage: { text: _t("Invalid theme schema."), isError: true } }); return; } currentThemes.push(themeInfo); } catch (e) { console.error(e); this.setState({ customThemeMessage: { text: _t("Error downloading theme information."), isError: true } }); return; // Don't continue on error } await SettingsStore.setValue("custom_themes", null, SettingLevel.ACCOUNT, currentThemes); this.setState({ customThemeUrl: "", customThemeMessage: { text: _t("Theme added!"), isError: false } }); this.themeTimer = setTimeout(() => { this.setState({ customThemeMessage: { text: "", isError: false } }); }, 3000); }; private onCustomThemeChange = (e: React.ChangeEvent): void => { this.setState({ customThemeUrl: e.target.value }); }; private onLayoutChanged = (layout: Layout): void => { this.setState({ layout: layout }); }; private onIRCLayoutChange = (enabled: boolean) => { if (enabled) { this.setState({ layout: Layout.IRC }); SettingsStore.setValue("layout", null, SettingLevel.DEVICE, Layout.IRC); } else { this.setState({ layout: Layout.Group }); SettingsStore.setValue("layout", null, SettingLevel.DEVICE, Layout.Group); } }; private renderThemeSection() { const themeWatcher = new ThemeWatcher(); let systemThemeSection: JSX.Element; if (themeWatcher.isSystemThemeSupported()) { systemThemeSection =
this.onUseSystemThemeChanged(e.target.checked)} > { SettingsStore.getDisplayName("use_system_theme") }
; } let customThemeForm: JSX.Element; if (SettingsStore.getValue("feature_custom_themes")) { let messageElement = null; if (this.state.customThemeMessage.text) { if (this.state.customThemeMessage.isError) { messageElement =
{ this.state.customThemeMessage.text }
; } else { messageElement =
{ this.state.customThemeMessage.text }
; } } customThemeForm = (
{ _t("Add theme") } { messageElement }
); } // XXX: replace any type here const themes = Object.entries(enumerateThemes()) .map(p => ({ id: p[0], name: p[1] })); // convert pairs to objects for code readability const builtInThemes = themes.filter(p => !p.id.startsWith("custom-")); const customThemes = themes.filter(p => !builtInThemes.includes(p)) .sort((a, b) => compare(a.name, b.name)); const orderedThemes = [...builtInThemes, ...customThemes]; return (
{ _t("Theme") } { systemThemeSection }
({ value: t.id, label: t.name, disabled: this.state.useSystemTheme, className: "mx_ThemeSelector_" + t.id, }))} onChange={this.onThemeChange} value={this.state.useSystemTheme ? undefined : this.state.theme} outlined />
{ customThemeForm }
); } private renderFontSection() { return
{ _t("Font size") }
Aa
""} disabled={this.state.useCustomFontSize} />
Aa
this.setState({ useCustomFontSize: checked })} useCheckbox={true} /> this.setState({ fontSize: value.target.value })} disabled={!this.state.useCustomFontSize} className="mx_SettingsTab_customFontSizeField" />
; } private renderAdvancedSection() { if (!SettingsStore.getValue(UIFeature.AdvancedSettings)) return null; const brand = SdkConfig.get().brand; const toggle =
this.setState({ showAdvanced: !this.state.showAdvanced })} > { this.state.showAdvanced ? _t("Hide advanced") : _t("Show advanced") }
; let advanced: React.ReactNode; if (this.state.showAdvanced) { const tooltipContent = _t( "Set the name of a font installed on your system & %(brand)s will attempt to use it.", { brand }, ); advanced = <> { !SettingsStore.getValue("feature_new_layout_switcher") ? this.onIRCLayoutChange(ev.target.checked)} > { _t("Enable experimental, compact IRC style layout") } : null } this.setState({ useSystemFont: checked })} /> { this.setState({ systemFont: value.target.value, }); SettingsStore.setValue("systemFont", null, SettingLevel.DEVICE, value.target.value); }} tooltipContent={tooltipContent} forceTooltipVisible={true} disabled={!this.state.useSystemFont} value={this.state.systemFont} /> ; } return
{ toggle } { advanced }
; } render() { const brand = SdkConfig.get().brand; let layoutSection; if (SettingsStore.getValue("feature_new_layout_switcher")) { layoutSection = ( ); } return (
{ _t("Customise your appearance") }
{ _t("Appearance Settings only affect this %(brand)s session.", { brand }) }
{ this.renderThemeSection() } { layoutSection } { this.renderFontSection() } { this.renderAdvancedSection() }
); } }