Extract location utils from components (#8152)

* extract util functions from MLocationBody

Signed-off-by: Kerry Archibald <kerrya@element.io>

* disassemble mlocationbody

Signed-off-by: Kerry Archibald <kerrya@element.io>

* tidy and add copyrights

Signed-off-by: Kerry Archibald <kerrya@element.io>

* move types and utils from components/location to utils

Signed-off-by: Kerry Archibald <kerrya@element.io>

* i18n

Signed-off-by: Kerry Archibald <kerrya@element.io>

* empty line

Signed-off-by: Kerry Archibald <kerrya@element.io>

src/components/views/location/LocationPicker.tsx

@@ -28,16 +28,16 @@ import MatrixClientContext from '../../../contexts/MatrixClientContext';
 import Modal from '../../../Modal';
 import ErrorDialog from '../dialogs/ErrorDialog';
 import { tileServerFromWellKnown } from '../../../utils/WellKnownUtils';
-import { findMapStyleUrl } from './findMapStyleUrl';
 import { LocationShareType, ShareLocationFn } from './shareLocation';
 import { Icon as LocationIcon } from '../../../../res/img/element-icons/location.svg';
-import { LocationShareError } from './LocationShareErrors';
 import AccessibleButton from '../elements/AccessibleButton';
 import { MapError } from './MapError';
 import { getUserNameColorClass } from '../../../utils/FormattingUtils';
 import LiveDurationDropdown, { DEFAULT_DURATION_MS } from './LiveDurationDropdown';
 import { GenericPosition, genericPositionFromGeolocation, getGeoUri } from '../../../utils/beacon';
 import SdkConfig from '../../../SdkConfig';
+import { LocationShareError, findMapStyleUrl } from '../../../utils/location';
+
 export interface ILocationPickerProps {
     sender: RoomMember;
     shareType: LocationShareType;

src/components/views/location/LocationShareErrors.ts

@@ -1,34 +0,0 @@
-/*
-Copyright 2022 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 { _t } from "../../../languageHandler";
-
-export enum LocationShareError {
-    MapStyleUrlNotConfigured = 'MapStyleUrlNotConfigured',
-    MapStyleUrlNotReachable = 'MapStyleUrlNotReachable',
-    Default = 'Default'
-}
-
-export const getLocationShareErrorMessage = (errorType?: LocationShareError): string => {
-    switch (errorType) {
-        case LocationShareError.MapStyleUrlNotConfigured:
-            return _t('This homeserver is not configured to display maps.');
-        case LocationShareError.MapStyleUrlNotReachable:
-        default:
-            return _t(`This homeserver is not configured correctly to display maps, `
-                + `or the configured map server may be unreachable.`);
-    }
-};

src/components/views/location/LocationViewDialog.tsx

@@ -21,8 +21,9 @@ import { ClientEvent, IClientWellKnown, MatrixClient } from 'matrix-js-sdk/src/c
 import { replaceableComponent } from "../../../utils/replaceableComponent";
 import BaseDialog from "../dialogs/BaseDialog";
 import { IDialogProps } from "../dialogs/IDialogProps";
-import { createMap, LocationBodyContent, locationEventGeoUri, parseGeoUri } from '../messages/MLocationBody';
+import { LocationBodyContent } from '../messages/MLocationBody';
 import { tileServerFromWellKnown } from '../../../utils/WellKnownUtils';
+import { parseGeoUri, locationEventGeoUri, createMap } from '../../../utils/location';
 
 interface IProps extends IDialogProps {
     matrixClient: MatrixClient;

src/components/views/location/MapError.tsx

@@ -18,9 +18,9 @@ import React from 'react';
 
 import { Icon as WarningBadge } from '../../../../res/img/element-icons/warning-badge.svg';
 import { _t } from '../../../languageHandler';
+import { getLocationShareErrorMessage, LocationShareError } from '../../../utils/location';
 import AccessibleButton from '../elements/AccessibleButton';
 import Heading from '../typography/Heading';
-import { getLocationShareErrorMessage, LocationShareError } from './LocationShareErrors';
 
 interface Props {
     onFinished: () => void;

src/components/views/location/findMapStyleUrl.ts

@@ -1,41 +0,0 @@
-/*
-Copyright 2022 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 { logger } from "matrix-js-sdk/src/logger";
-
-import SdkConfig from "../../../SdkConfig";
-import { getTileServerWellKnown } from "../../../utils/WellKnownUtils";
-import { LocationShareError } from "./LocationShareErrors";
-
-/**
- * Look up what map tile server style URL was provided in the homeserver's
- * .well-known location, or, failing that, in our local config, or, failing
- * that, defaults to the same tile server listed by matrix.org.
- */
-export function findMapStyleUrl(): string {
-    const mapStyleUrl = (
-        getTileServerWellKnown()?.map_style_url ??
-        SdkConfig.get().map_style_url
-    );
-
-    if (!mapStyleUrl) {
-        logger.error("'map_style_url' missing from homeserver .well-known area, and " +
-            "missing from from config.json.");
-        throw new Error(LocationShareError.MapStyleUrlNotConfigured);
-    }
-
-    return mapStyleUrl;
-}