mapcomplete/Logic/State/FeatureSwitchState.ts

/**
 * The part of the global state which initializes the feature switches, based on default values and on the layoutToUse
 */
import LayoutConfig from "../../Models/ThemeConfig/LayoutConfig"
import { UIEventSource } from "../UIEventSource"
import { QueryParameters } from "../Web/QueryParameters"
import Constants from "../../Models/Constants"
import { Utils } from "../../Utils"

export default class FeatureSwitchState {
    /**
     * The layout that is being used in this run
     */
    public readonly layoutToUse: LayoutConfig

    public readonly featureSwitchUserbadge: UIEventSource<boolean>
    public readonly featureSwitchSearch: UIEventSource<boolean>
    public readonly featureSwitchBackgroundSelection: UIEventSource<boolean>
    public readonly featureSwitchAddNew: UIEventSource<boolean>
    public readonly featureSwitchWelcomeMessage: UIEventSource<boolean>
    public readonly featureSwitchCommunityIndex: UIEventSource<boolean>
    public readonly featureSwitchExtraLinkEnabled: UIEventSource<boolean>
    public readonly featureSwitchMoreQuests: UIEventSource<boolean>
    public readonly featureSwitchShareScreen: UIEventSource<boolean>
    public readonly featureSwitchGeolocation: UIEventSource<boolean>
    public readonly featureSwitchIsTesting: UIEventSource<boolean>
    public readonly featureSwitchIsDebugging: UIEventSource<boolean>
    public readonly featureSwitchShowAllQuestions: UIEventSource<boolean>
    public readonly featureSwitchApiURL: UIEventSource<string>
    public readonly featureSwitchFilter: UIEventSource<boolean>
    public readonly featureSwitchEnableExport: UIEventSource<boolean>
    public readonly featureSwitchFakeUser: UIEventSource<boolean>
    public readonly featureSwitchExportAsPdf: UIEventSource<boolean>
    public readonly overpassUrl: UIEventSource<string[]>
    public readonly overpassTimeout: UIEventSource<number>
    public readonly overpassMaxZoom: UIEventSource<number>
    public readonly osmApiTileSize: UIEventSource<number>
    public readonly backgroundLayerId: UIEventSource<string>

    public constructor(layoutToUse: LayoutConfig) {
        this.layoutToUse = layoutToUse

        // Helper function to initialize feature switches
        function featSw(
            key: string,
            deflt: (layout: LayoutConfig) => boolean,
            documentation: string
        ): UIEventSource<boolean> {
            const defaultValue = deflt(layoutToUse)
            const queryParam = QueryParameters.GetQueryParameter(
                key,
                "" + defaultValue,
                documentation
            )

            // It takes the current layout, extracts the default value for this query parameter. A query parameter event source is then retrieved and flattened
            return queryParam.sync(
                (str) => (str === undefined ? defaultValue : str !== "false"),
                [],
                (b) => (b == defaultValue ? undefined : "" + b)
            )
        }

        this.featureSwitchUserbadge = featSw(
            "fs-userbadge",
            (layoutToUse) => layoutToUse?.enableUserBadge ?? true,
            "Disables/Enables the user information pill (userbadge) at the top left. Disabling this disables logging in and thus disables editing all together, effectively putting MapComplete into read-only mode."
        )
        this.featureSwitchSearch = featSw(
            "fs-search",
            (layoutToUse) => layoutToUse?.enableSearch ?? true,
            "Disables/Enables the search bar"
        )
        this.featureSwitchBackgroundSelection = featSw(
            "fs-background",
            (layoutToUse) => layoutToUse?.enableBackgroundLayerSelection ?? true,
            "Disables/Enables the background layer control"
        )

        this.featureSwitchFilter = featSw(
            "fs-filter",
            (layoutToUse) => layoutToUse?.enableLayers ?? true,
            "Disables/Enables the filter view"
        )
        this.featureSwitchAddNew = featSw(
            "fs-add-new",
            (layoutToUse) => layoutToUse?.enableAddNewPoints ?? true,
            "Disables/Enables the 'add new feature'-popup. (A theme without presets might not have it in the first place)"
        )
        this.featureSwitchWelcomeMessage = featSw(
            "fs-welcome-message",
            () => true,
            "Disables/enables the help menu or welcome message"
        )
        this.featureSwitchCommunityIndex = featSw(
            "fs-community-index",
            () => true,
            "Disables/enables the button to get in touch with the community"
        )
        this.featureSwitchExtraLinkEnabled = featSw(
            "fs-iframe-popout",
            (_) => true,
            "Disables/Enables the extraLink button. By default, if in iframe mode and the welcome message is hidden, a popout button to the full mapcomplete instance is shown instead (unless disabled with this switch or another extraLink button is enabled)"
        )
        this.featureSwitchMoreQuests = featSw(
            "fs-more-quests",
            (layoutToUse) => layoutToUse?.enableMoreQuests ?? true,
            "Disables/Enables the 'More Quests'-tab in the welcome message"
        )
        this.featureSwitchShareScreen = featSw(
            "fs-share-screen",
            (layoutToUse) => layoutToUse?.enableShareScreen ?? true,
            "Disables/Enables the 'Share-screen'-tab in the welcome message"
        )
        this.featureSwitchGeolocation = featSw(
            "fs-geolocation",
            (layoutToUse) => layoutToUse?.enableGeolocation ?? true,
            "Disables/Enables the geolocation button"
        )
        this.featureSwitchShowAllQuestions = featSw(
            "fs-all-questions",
            (layoutToUse) => layoutToUse?.enableShowAllQuestions ?? false,
            "Always show all questions"
        )

        this.featureSwitchEnableExport = featSw(
            "fs-export",
            (layoutToUse) => layoutToUse?.enableExportButton ?? false,
            "Enable the export as GeoJSON and CSV button"
        )
        this.featureSwitchExportAsPdf = featSw(
            "fs-pdf",
            (layoutToUse) => layoutToUse?.enablePdfDownload ?? false,
            "Enable the PDF download button"
        )

        this.featureSwitchApiURL = QueryParameters.GetQueryParameter(
            "backend",
            "osm",
            "The OSM backend to use - can be used to redirect mapcomplete to the testing backend when using 'osm-test'"
        )

        let testingDefaultValue = false
        if (
            this.featureSwitchApiURL.data !== "osm-test" &&
            !Utils.runningFromConsole &&
            (location.hostname === "localhost" || location.hostname === "127.0.0.1")
        ) {
            testingDefaultValue = true
        }

        this.featureSwitchIsTesting = QueryParameters.GetBooleanQueryParameter(
            "test",
            testingDefaultValue,
            "If true, 'dryrun' mode is activated. The app will behave as normal, except that changes to OSM will be printed onto the console instead of actually uploaded to osm.org"
        )

        this.featureSwitchIsDebugging = QueryParameters.GetBooleanQueryParameter(
            "debug",
            false,
            "If true, shows some extra debugging help such as all the available tags on every object"
        )

        this.featureSwitchFakeUser = QueryParameters.GetBooleanQueryParameter(
            "fake-user",
            false,
            "If true, 'dryrun' mode is activated and a fake user account is loaded"
        )

        this.overpassUrl = QueryParameters.GetQueryParameter(
            "overpassUrl",
            (layoutToUse?.overpassUrl ?? Constants.defaultOverpassUrls).join(","),
            "Point mapcomplete to a different overpass-instance. Example: https://overpass-api.de/api/interpreter"
        ).sync(
            (param) => param?.split(","),
            [],
            (urls) => urls?.join(",")
        )

        this.overpassTimeout = UIEventSource.asFloat(
            QueryParameters.GetQueryParameter(
                "overpassTimeout",
                "" + layoutToUse?.overpassTimeout,
                "Set a different timeout (in seconds) for queries in overpass"
            )
        )

        this.overpassMaxZoom = UIEventSource.asFloat(
            QueryParameters.GetQueryParameter(
                "overpassMaxZoom",
                "" + layoutToUse?.overpassMaxZoom,
                " point to switch between OSM-api and overpass"
            )
        )

        this.osmApiTileSize = UIEventSource.asFloat(
            QueryParameters.GetQueryParameter(
                "osmApiTileSize",
                "" + layoutToUse?.osmApiTileSize,
                "Tilesize when the OSM-API is used to fetch data within a BBOX"
            )
        )

        this.featureSwitchUserbadge.addCallbackAndRun((userbadge) => {
            if (!userbadge) {
                this.featureSwitchAddNew.setData(false)
            }
        })

        this.backgroundLayerId = QueryParameters.GetQueryParameter(
            "background",
            layoutToUse?.defaultBackgroundId ?? "osm",
            "The id of the background layer to start with"
        )
    }
}