import * as React from 'react'; import { Platform, Linking, View, Switch, ScrollView, Text, TouchableOpacity, Alert, PermissionsAndroid, Dimensions, AccessibilityInfo } from 'react-native'; import Setting, { AppType, SettingItem, SettingMetadataSection } from '@joplin/lib/models/Setting'; import NavService from '@joplin/lib/services/NavService'; import SearchEngine from '@joplin/lib/services/search/SearchEngine'; import checkPermissions from '../../../utils/checkPermissions'; import setIgnoreTlsErrors from '../../../utils/TlsUtils'; import { reg } from '@joplin/lib/registry'; import { State } from '@joplin/lib/reducer'; const { BackButtonService } = require('../../../services/back-button.js'); const VersionInfo = require('react-native-version-info').default; import { connect } from 'react-redux'; import ScreenHeader from '../../ScreenHeader'; import { _ } from '@joplin/lib/locale'; import BaseScreenComponent from '../../base-screen'; const { themeStyle } = require('../../global-style.js'); import * as shared from '@joplin/lib/components/shared/config/config-shared'; import SyncTargetRegistry from '@joplin/lib/SyncTargetRegistry'; import biometricAuthenticate from '../../biometrics/biometricAuthenticate'; import configScreenStyles, { ConfigScreenStyles } from './configScreenStyles'; import NoteExportButton, { exportButtonDescription, exportButtonTitle } from './NoteExportSection/NoteExportButton'; import SettingsButton from './SettingsButton'; import Clipboard from '@react-native-community/clipboard'; import { ReactElement, ReactNode } from 'react'; import { Dispatch } from 'redux'; import SectionHeader from './SectionHeader'; import ExportProfileButton, { exportProfileButtonTitle } from './NoteExportSection/ExportProfileButton'; import SettingComponent from './SettingComponent'; import ExportDebugReportButton, { exportDebugReportTitle } from './NoteExportSection/ExportDebugReportButton'; import SectionSelector from './SectionSelector'; import { Button, TextInput } from 'react-native-paper'; interface ConfigScreenState { settings: any; changedSettingKeys: string[]; searchQuery: string; searching: boolean; fixingSearchIndex: boolean; checkSyncConfigResult: { ok: boolean; errorMessage: string }|'checking'|null; showAdvancedSettings: boolean; selectedSectionName: string|null; sidebarWidth: number; } interface ConfigScreenProps { settings: any; themeId: number; navigation: any; dispatch: Dispatch; } class ConfigScreenComponent extends BaseScreenComponent { public static navigationOptions(): any { return { header: null }; } private componentsY_: Record = {}; private styles_: Record = {}; private scrollViewRef_: React.RefObject; public constructor(props: ConfigScreenProps) { super(props); this.state = { ...shared.defaultScreenState, selectedSectionName: null, fixingSearchIndex: false, sidebarWidth: 100, searchQuery: '', searching: false, }; this.scrollViewRef_ = React.createRef(); shared.init(reg); } private checkSyncConfig_ = async () => { // to ignore TLS errors we need to change the global state of the app, if the check fails we need to restore the original state // this call sets the new value and returns the previous one which we can use later to revert the change const prevIgnoreTlsErrors = await setIgnoreTlsErrors(this.state.settings['net.ignoreTlsErrors']); const result = await shared.checkSyncConfig(this, this.state.settings); if (!result || !result.ok) { await setIgnoreTlsErrors(prevIgnoreTlsErrors); } }; private e2eeConfig_ = () => { void NavService.go('EncryptionConfig'); }; private saveButton_press = async () => { if (this.state.changedSettingKeys.includes('sync.target') && this.state.settings['sync.target'] === SyncTargetRegistry.nameToId('filesystem')) { if (Platform.OS === 'android') { if (Platform.Version < 29) { if (!(await this.checkFilesystemPermission())) { Alert.alert(_('Warning'), _('In order to use file system synchronisation your permission to write to external storage is required.')); } } } // Save settings anyway, even if permission has not been granted } // changedSettingKeys is cleared in shared.saveSettings so reading it now const shouldSetIgnoreTlsErrors = this.state.changedSettingKeys.includes('net.ignoreTlsErrors'); const done = await shared.saveSettings(this); if (!done) return; if (shouldSetIgnoreTlsErrors) { await setIgnoreTlsErrors(Setting.value('net.ignoreTlsErrors')); } }; private syncStatusButtonPress_ = () => { void NavService.go('Status'); }; private manageProfilesButtonPress_ = () => { void NavService.go('ProfileSwitcher'); }; private fixSearchEngineIndexButtonPress_ = async () => { this.setState({ fixingSearchIndex: true }); await SearchEngine.instance().rebuildIndex(); this.setState({ fixingSearchIndex: false }); }; private logButtonPress_ = () => { void NavService.go('Log'); }; private setShowSearch_(searching: boolean) { if (searching !== this.state.searching) { this.setState({ searching }); AccessibilityInfo.announceForAccessibility(searching ? _('Search shown') : _('Search hidden')); } } private onSearchButtonPress_ = () => { this.setShowSearch_(!this.state.searching); }; private onSearchUpdate_ = (newQuery: string) => { this.setState({ searchQuery: newQuery }); }; private updateSidebarWidth = () => { const windowWidth = Dimensions.get('window').width; let sidebarNewWidth = windowWidth; const sidebarValidWidths = [280, 230]; const maxFractionOfWindowSize = 1 / 3; for (const width of sidebarValidWidths) { if (width < windowWidth * maxFractionOfWindowSize) { sidebarNewWidth = width; break; } } this.setState({ sidebarWidth: sidebarNewWidth }); }; private navigationFillsScreen() { const windowWidth = Dimensions.get('window').width; return this.state.sidebarWidth > windowWidth / 2; } private onJumpToSection_ = (section: string) => { const label = Setting.sectionNameToLabel(section); AccessibilityInfo.announceForAccessibility(_('Opening section %s', label)); this.setState({ selectedSectionName: section, searching: false, }); }; private showSectionNavigation_ = () => { this.setState({ selectedSectionName: null }); }; public async checkFilesystemPermission() { if (Platform.OS !== 'android') { // Not implemented yet return true; } return await checkPermissions(PermissionsAndroid.PERMISSIONS.WRITE_EXTERNAL_STORAGE, { title: _('Information'), message: _('In order to use file system synchronisation your permission to write to external storage is required.'), buttonPositive: _('OK'), }); } public UNSAFE_componentWillMount() { this.setState({ settings: this.props.settings }); } public styles(): ConfigScreenStyles { const themeId = this.props.themeId; if (this.styles_[themeId]) return this.styles_[themeId]; this.styles_ = {}; this.styles_[themeId] = configScreenStyles(themeId); return this.styles_[themeId]; } private onHeaderLayout(key: string, event: any) { const layout = event.nativeEvent.layout; this.componentsY_[`header_${key}`] = layout.y; } private onSectionLayout(key: string, event: any) { const layout = event.nativeEvent.layout; this.componentsY_[`section_${key}`] = layout.y; } private componentY(key: string): number { if ((`section_${key}`) in this.componentsY_) return this.componentsY_[`section_${key}`]; if ((`header_${key}`) in this.componentsY_) return this.componentsY_[`header_${key}`]; console.error(`ConfigScreen: Could not find key to scroll to: ${key}`); return 0; } private hasUnsavedChanges() { return this.state.changedSettingKeys.length > 0; } private promptSaveChanges(): Promise { return new Promise(resolve => { if (this.hasUnsavedChanges()) { const dialogTitle: string|null = null; Alert.alert( dialogTitle, _('There are unsaved changes.'), [{ text: _('Save changes'), onPress: async () => { await this.saveButton_press(); resolve(); }, }, { text: _('Discard changes'), onPress: () => resolve(), }], ); } else { resolve(); } }); } private handleNavigateToNewScreen = async (): Promise => { await this.promptSaveChanges(); // Continue navigation return false; }; private handleBackButtonPress = (): boolean => { const goBack = async () => { BackButtonService.removeHandler(this.handleBackButtonPress); await BackButtonService.back(); }; // Cancel search on back if (this.state.searching) { this.setShowSearch_(false); return true; } // Show navigation when pressing "back" (unless always visible). if (this.state.selectedSectionName && this.navigationFillsScreen()) { this.showSectionNavigation_(); return true; } if (this.hasUnsavedChanges()) { void (async () => { await this.promptSaveChanges(); await goBack(); })(); return true; } return false; }; public componentDidMount() { if (this.props.navigation.state.sectionName) { this.setState({ selectedSectionName: this.props.navigation.state.sectionName }); setTimeout(() => { this.scrollViewRef_.current.scrollTo({ x: 0, y: this.componentY(this.props.navigation.state.sectionName), animated: true, }); }, 200); } BackButtonService.addHandler(this.handleBackButtonPress); NavService.addHandler(this.handleNavigateToNewScreen); Dimensions.addEventListener('change', this.updateSidebarWidth); this.updateSidebarWidth(); } public componentWillUnmount() { BackButtonService.removeHandler(this.handleBackButtonPress); NavService.removeHandler(this.handleNavigateToNewScreen); } private renderButton(key: string, title: string, clickHandler: ()=> void, options: any = null) { return ( ); } public sectionToComponent(key: string, section: SettingMetadataSection, settings: any, isSelected: boolean) { const settingComps: ReactElement[] = []; const advancedSettingComps: ReactElement[] = []; const headerTitle = Setting.sectionNameToLabel(section.name); const matchesSearchQuery = (relatedText: string|string[]) => { let searchThrough; if (Array.isArray(relatedText)) { searchThrough = relatedText.join('\n'); } else { searchThrough = relatedText; } searchThrough = searchThrough.toLocaleLowerCase(); const searchQuery = this.state.searchQuery.toLocaleLowerCase().trim(); const hasSearchMatches = headerTitle.toLocaleLowerCase() === searchQuery || searchThrough.includes(searchQuery); // Don't show results when the search input is empty return this.state.searchQuery.length > 0 && hasSearchMatches; }; const addSettingComponent = ( component: ReactElement, relatedText: string|string[], settingMetadata?: SettingItem, ) => { const hiddenBySearch = this.state.searching && !matchesSearchQuery(relatedText); if (component && !hiddenBySearch) { if (settingMetadata?.advanced) { advancedSettingComps.push(component); } else { settingComps.push(component); } } }; const addSettingButton = (key: string, title: string, clickHandler: ()=> void, options: any = null) => { const relatedText = [title]; if (typeof options === 'object' && options?.description) { relatedText.push(options.description); } addSettingComponent(this.renderButton(key, title, clickHandler, options), relatedText); }; const styleSheet = this.styles().styleSheet; const addSettingLink = (key: string, title: string, target: string) => { const component = ( { void Linking.openURL(target); }} accessibilityRole='link' > {title} ); addSettingComponent(component, title); }; const addSettingText = (key: string, text: string) => { addSettingComponent( {text} , text, ); }; for (let i = 0; i < section.metadatas.length; i++) { const md = section.metadatas[i]; if (section.name === 'sync' && md.key === 'sync.resourceDownloadMode') { const syncTargetMd = SyncTargetRegistry.idToMetadata(settings['sync.target']); if (syncTargetMd.supportsConfigCheck) { const messages = shared.checkSyncConfigMessages(this); const statusComp = !messages.length ? null : ( {messages[0]} {messages.length >= 1 ? ( {messages[1]} ) : null} ); addSettingButton('check_sync_config_button', _('Check synchronisation configuration'), this.checkSyncConfig_, { statusComp: statusComp }); } } const settingComp = this.settingToComponent(md.key, settings[md.key]); const relatedText = [md.label?.() ?? '', md.description?.() ?? '']; addSettingComponent( settingComp, relatedText, md, ); } if (section.name === 'sync') { addSettingButton('e2ee_config_button', _('Encryption Config'), this.e2eeConfig_); } if (section.name === 'joplinCloud') { const label = _('Email to note'); const description = _('Any email sent to this address will be converted into a note and added to your collection. The note will be saved into the Inbox notebook'); addSettingComponent( {label} {this.props.settings['sync.10.inboxEmail']} { this.renderButton( 'sync.10.inboxEmail', _('Copy to clipboard'), () => Clipboard.setString(this.props.settings['sync.10.inboxEmail']), { description }, ) } , [label, description], ); } if (section.name === 'tools') { addSettingButton('profiles_buttons', _('Manage profiles'), this.manageProfilesButtonPress_); addSettingButton('status_button', _('Sync Status'), this.syncStatusButtonPress_); addSettingButton('log_button', _('Log'), this.logButtonPress_); addSettingButton('fix_search_engine_index', this.state.fixingSearchIndex ? _('Fixing search index...') : _('Fix search index'), this.fixSearchEngineIndexButtonPress_, { disabled: this.state.fixingSearchIndex, description: _('Use this to rebuild the search index if there is a problem with search. It may take a long time depending on the number of notes.') }); } if (section.name === 'export') { addSettingComponent( , [exportButtonTitle(), exportButtonDescription()], ); addSettingComponent( , exportDebugReportTitle(), ); addSettingComponent( , exportProfileButtonTitle(), ); } if (section.name === 'moreInfo') { if (Platform.OS === 'android' && Platform.Version >= 23) { // Note: `PermissionsAndroid` doesn't work so we have to ask the user to manually // set these permissions. https://stackoverflow.com/questions/49771084/permission-always-returns-never-ask-again addSettingComponent( {_('To work correctly, the app needs the following permissions. Please enable them in your phone settings, in Apps > Joplin > Permissions')} {_('- Storage: to allow attaching files to notes and to enable filesystem synchronisation.')} {_('- Camera: to allow taking a picture and attaching it to a note.')} {_('- Location: to allow attaching geo-location information to a note.')} , '', ); } addSettingLink('donate_link', _('Make a donation'), 'https://joplinapp.org/donate/'); addSettingLink('website_link', _('Joplin website'), 'https://joplinapp.org/'); addSettingLink('privacy_link', _('Privacy Policy'), 'https://joplinapp.org/privacy/'); addSettingText('version_info_app', `Joplin ${VersionInfo.appVersion}`); addSettingText('version_info_db', _('Database v%s', reg.db().version())); addSettingText('version_info_fts', _('FTS enabled: %d', this.props.settings['db.ftsEnabled'])); addSettingText('version_info_hermes', _('Hermes enabled: %d', (global as any).HermesInternal ? 1 : 0)); const featureFlagKeys = Setting.featureFlagKeys(AppType.Mobile); if (featureFlagKeys.length) { const headerKey = 'featureFlags'; const featureFlagsTitle = _('Feature flags'); addSettingComponent( this.onHeaderLayout(headerKey, event)} />, _('Feature flags'), ); addSettingComponent( {this.renderFeatureFlags(settings, featureFlagKeys)}, featureFlagsTitle, ); } } if (!settingComps.length && !advancedSettingComps.length) return null; if (!isSelected && !this.state.searching) return null; const headerComponent = ( { this.onJumpToSection_(section.name); }}> ); const renderAdvancedSettings = () => { if (!advancedSettingComps.length) return null; const toggleAdvancedLabel = this.state.showAdvancedSettings ? _('Hide Advanced Settings') : _('Show Advanced Settings'); return ( <> {this.state.showAdvancedSettings ? advancedSettingComps : null} ); }; return ( this.onSectionLayout(key, event)}> {this.state.searching ? headerComponent : null} {settingComps} {renderAdvancedSettings()} ); } // eslint-disable-next-line @typescript-eslint/ban-types -- Old code before rule was applied private renderToggle(key: string, label: string, value: any, updateSettingValue: Function, descriptionComp: any = null) { const theme = themeStyle(this.props.themeId); return ( {label} void updateSettingValue(key, value)} /> {descriptionComp} ); } private handleSetting = async (key: string, value: any): Promise => { // When the user tries to enable biometrics unlock, we ask for the // fingerprint or Face ID, and if it's correct we save immediately. If // it's not, we don't turn on the setting. if (key === 'security.biometricsEnabled' && !!value) { try { await biometricAuthenticate(); shared.updateSettingValue(this, key, value, async () => await this.saveButton_press()); } catch (error) { shared.updateSettingValue(this, key, false); Alert.alert(error.message); } return true; } if (key === 'security.biometricsEnabled' && !value) { shared.updateSettingValue(this, key, value, async () => await this.saveButton_press()); return true; } return false; }; public settingToComponent(key: string, value: any) { const updateSettingValue = async (key: string, value: any) => { const handled = await this.handleSetting(key, value); if (!handled) shared.updateSettingValue(this, key, value); }; return ( ); } private renderFeatureFlags(settings: any, featureFlagKeys: string[]): any[] { const updateSettingValue = (key: string, value: any) => { return shared.updateSettingValue(this, key, value); }; const output: any[] = []; for (const key of featureFlagKeys) { output.push(this.renderToggle(key, key, settings[key], updateSettingValue)); } return output; } public render() { const settings = this.state.settings; const showAsSidebar = !this.navigationFillsScreen(); // If the navigation is a sidebar, always show a section. let currentSectionName = this.state.selectedSectionName; if (showAsSidebar && !currentSectionName) { currentSectionName = 'general'; } if (this.state.searching) { currentSectionName = null; } const sectionSelector = ( ); let currentSection: ReactNode; if (currentSectionName || this.state.searching) { const settingComps = shared.settingsToComponents2( this, AppType.Mobile, settings, currentSectionName, // TODO: Remove this cast. Currently necessary because of different versions // of React in lib/ and app-mobile/ ) as ReactNode[]; const searchInput = ; currentSection = ( {this.state.searching ? searchInput : null} {settingComps} ); } else { currentSection = sectionSelector; } let mainComponent; if (showAsSidebar && currentSectionName) { mainComponent = ( {sectionSelector} {currentSection} ); } else { mainComponent = currentSection; } let screenHeadingText = _('Configuration'); if (currentSectionName) { screenHeadingText = Setting.sectionNameToLabel(currentSectionName); } return ( {mainComponent} ); } } const ConfigScreen = connect((state: State) => { return { settings: state.settings, themeId: state.settings.theme, }; })(ConfigScreenComponent); export default ConfigScreen;