wrolpi/modules/map/config.py
lrnselfreliance adb0adbd94
The map draws any PMTiles file as an overlay, in any sub-directory (#962)
Any PMTiles file under the map directory, at any depth, can be shown.  The API reads each file's header and metadata and says what it is (basemap, terrain, overlay, unreadable).  Overlays are offered in the layer control under the name the file gives itself, hidden until turned on, with a checkbox per vector layer, and are drawn generically.

Map files are named by their path within the map directory everywhere, and unfinished downloads are no longer listed.  A file can be ignored from the Manage page; ignored files are kept in a new maps.yaml config.

PMTiles metadata is not decompressed past its size limit, and the standalone viewer encodes map file paths.
2026-11-13 15:11:01 -07:00

60 lines
1.7 KiB
Python

from dataclasses import dataclass, field
from typing import List
from wrolpi.common import ConfigFile, logger
logger = logger.getChild(__name__)
@dataclass
class MapsConfigValidator:
version: int = None
ignored_files: list = field(default_factory=list)
class MapsConfig(ConfigFile):
"""Settings of the map files.
`ignored_files` are PMTiles files (relative to the map directory) the map does not draw, offer as a layer, or
search. A file the config does not name is visible."""
file_name = 'maps.yaml'
default_config = dict(
version=0,
ignored_files=[],
)
validator = MapsConfigValidator
@property
def ignored_files(self) -> List[str]:
return [str(i) for i in self._config.get('ignored_files') or []]
def is_ignored(self, map_path: str) -> bool:
return str(map_path) in self.ignored_files
def set_ignored(self, map_path: str, ignored: bool) -> bool:
"""Ignore (or stop ignoring) a map file. Returns True if this changed the config."""
map_path = str(map_path)
ignored_files = set(self.ignored_files)
if (map_path in ignored_files) == ignored:
return False
if ignored:
ignored_files.add(map_path)
else:
ignored_files.discard(map_path)
# Saves the config in the background.
self.update({'ignored_files': sorted(ignored_files)})
return True
MAPS_CONFIG: MapsConfig = MapsConfig()
# Test override.
TEST_MAPS_CONFIG = None
def get_maps_config() -> MapsConfig:
global TEST_MAPS_CONFIG
if isinstance(TEST_MAPS_CONFIG, ConfigFile):
return TEST_MAPS_CONFIG
return MAPS_CONFIG