# MIT License
# Copyright 2023 Ryan Hausen and contributers
# Permission is hereby granted, free of charge, to any person obtaining a copy of
# this software and associated documentation files (the "Software"), to deal in
# the Software without restriction, including without limitation the rights to
# use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
# the Software, and to permit persons to whom the Software is furnished to do so,
# subject to the following conditions:
# The above copyright notice and this permission notice shall be included in all
# copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
# FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
# COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
# IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
# CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
"""Helper functions for creating a leaflet JS HTML map.
# ******************************************************************************
# Designed for internal use. Any method/variable can be deprecated/changed
# without consideration.
# ******************************************************************************
"""
import os
import shutil
from functools import partial, reduce
from itertools import cycle, repeat, starmap
from typing import Dict, Iterable, List, Tuple, Union
import numpy as np
from astropy.wcs import WCS
from jinja2 import Environment, FileSystemLoader, PackageLoader, select_autoescape
import fitsmap.utils as utils
LAYER_ATTRIBUTION = "<a href='https://github.com/ryanhausen/fitsmap'>FitsMap</a>"
[docs]
def chart(
out_dir: str,
title: str,
img_layer_names: List[str],
marker_layer_names: List[str],
wcs: WCS,
n_cols: int,
max_xy: Tuple[int, int],
pixel_scale: float,
units_are_pixels: bool,
) -> None:
"""Creates an HTML file containing a leaflet js map using the given params.
* Designed for internal use. Any method/variable can be deprecated/changed *
* without consideration. *
"""
# convert layer names into a single javascript string
def layer_zooms(line: str) -> List[int]:
"""Return a list of zoom levels (as integers) for the given layer directory."""
return list(map(int, os.listdir(os.path.join(out_dir, line))))
img_zooms = reduce(lambda x, y: x + y, list(map(layer_zooms, img_layer_names)), [0])
cat_zooms = reduce(
lambda x, y: x + y, list(map(layer_zooms, marker_layer_names)), [0]
)
# be able to zoom in 5 levels further than the native zoom
# this seems to work well in general, but could become a parameter.
max_overall_zoom = max(img_zooms + cat_zooms) + 5
convert_layer_name_func = partial(layer_name_to_dict, out_dir, max_overall_zoom)
img_layer_dicts = list(
starmap(
convert_layer_name_func,
zip(
repeat(min(img_zooms)),
repeat(max(img_zooms)),
img_layer_names,
repeat(None),
),
)
)
cat_layer_dicts = list(
starmap(
convert_layer_name_func,
zip(
repeat(min(cat_zooms)),
repeat(max(cat_zooms)),
marker_layer_names,
get_colors(),
),
)
)
# generated javascript =====================================================
with open(os.path.join(out_dir, "js", "urlCoords.js"), "w") as f:
f.write(build_urlCoords_js(wcs))
with open(os.path.join(out_dir, "js", "index.js"), "w") as f:
f.write(
build_index_js(
img_layer_dicts,
cat_layer_dicts,
n_cols,
max_xy,
pixel_scale,
units_are_pixels,
)
)
# generated javascript =====================================================
# HTML file contents =======================================================
extra_js = build_conditional_js(out_dir, bool(cat_layer_dicts))
extra_css = build_conditional_css(out_dir)
move_support_images(out_dir)
env = Environment(
loader=PackageLoader("fitsmap"),
autoescape=select_autoescape(),
)
template = env.get_template("index.html")
with open(os.path.join(out_dir, "index.html"), "w") as f:
f.write(
template.render(
title=title,
extra_js=extra_js,
extra_css=extra_css,
version=utils.get_version(),
)
+ "\n"
)
# HTML file contents =======================================================
[docs]
def layer_name_to_dict(
out_dir: str,
max_zoom: int,
min_zoom: int,
max_native_zoom: int,
name: str,
color: str,
) -> Dict[str, Union[str, int, List[str]]]:
"""Convert layer name to dict for conversion."""
layer_dict = dict(
directory=name + "/{z}/{y}/{x}." + ("pbf" if color else "png"),
name=name,
min_zoom=min_zoom,
max_zoom=max_zoom,
max_native_zoom=max_native_zoom,
)
if color:
layer_dict["stroke_color"] = color
layer_dict["fill_color"] = color
layer_dict["stroke_opacity"] = 1.0
layer_dict["fill_opacity"] = 0.2
cat_col_path = "/".join([out_dir, f"{name}.columns"])
with open(cat_col_path, "r") as f:
columns = f.readline().strip().split(",")
layer_dict["columns"] = [f'"{c}"' for c in columns]
return layer_dict
[docs]
def get_colors() -> Iterable[str]:
return cycle(
[
"rgb(76, 114, 176)",
"rgb(221, 132, 82)",
"rgb(85, 168, 104)",
"rgb(196, 78, 82)",
"rgb(129, 114, 179)",
"rgb(147, 120, 96)",
"rgb(218, 139, 195)",
"rgb(140, 140, 140)",
"rgb(204, 185, 116)",
"rgb(100, 181, 205)",
]
)
[docs]
def move_support_images(out_dir: str) -> List[str]:
img_extensions = [".png", ".jpg", ".ico", ".svg"]
support_dir = os.path.join(os.path.dirname(__file__), "support")
out_img_dir = os.path.join(out_dir, "imgs")
local_img_files = list(
filter(
lambda f: os.path.splitext(f)[1] in img_extensions,
sorted(os.listdir(support_dir)),
)
)
if not os.path.exists(out_img_dir):
os.mkdir(out_img_dir)
all(
map(
lambda f: shutil.copy2(
os.path.join(support_dir, f), os.path.join(out_img_dir, f)
),
local_img_files,
)
)
return local_img_files
[docs]
def build_conditional_css(out_dir: str) -> str:
search_css = "https://unpkg.com/leaflet-search@2.9.8/dist/leaflet-search.src.css"
css_string = " <link rel='preload' href='{}' as='style' onload='this.rel=\"stylesheet\"'/>"
support_dir = os.path.join(os.path.dirname(__file__), "support")
out_css_dir = os.path.join(out_dir, "css")
local_css_files = list(
filter(lambda f: f.endswith(".min.css"), sorted(os.listdir(support_dir)))
)
if not os.path.exists(out_css_dir):
os.mkdir(out_css_dir)
all(
map(
lambda f: shutil.copy2(
os.path.join(support_dir, f), os.path.join(out_css_dir, f)
),
local_css_files,
)
)
local_css = list(map(lambda f: f"css/{f}", local_css_files))
return "\n".join(map(lambda s: css_string.format(s), [search_css] + local_css))
[docs]
def build_conditional_js(out_dir: str, include_markerjs: bool) -> str:
support_dir = os.path.join(os.path.dirname(__file__), "support")
out_js_dir = os.path.join(out_dir, "js")
local_js_files = list(
sorted(filter(lambda f: f.endswith(".min.js"), os.listdir(support_dir)))
)
if not os.path.exists(out_js_dir):
os.mkdir(out_js_dir)
all(
map(
lambda f: shutil.copy2(
os.path.join(support_dir, f), os.path.join(out_js_dir, f)
),
local_js_files,
)
)
# some files have to be loaded before index.js, so that index.js can
# sucessfully run. Other files get placed after index.js so that the map
# can load first and then those will load in the background
pre_index_files = [
"https://cdnjs.cloudflare.com/ajax/libs/leaflet-search/3.0.2/leaflet-search.src.min.js"
* include_markerjs,
"js/customSearch.min.js" * include_markerjs,
"js/tiledMarkers.min.js" * include_markerjs,
"https://cdn.jsdelivr.net/npm/toolcool-color-picker/dist/toolcool-color-picker.min.js"
* include_markerjs,
"js/fitsmapScale.min.js",
"js/labelControl.min.js",
"js/settingsControl.min.js",
"js/urlCoords.js",
"js/index.js",
]
post_index_files = [
"https://unpkg.com/cbor-web@8.1.0/dist/cbor.js" * include_markerjs,
"https://unpkg.com/pbf@3.0.5/dist/pbf.js" * include_markerjs,
"js/l.ellipse.min.js" * include_markerjs,
"js/vector-tile.min.js" * include_markerjs,
]
js_string = " <script defer src='{}'></script>"
js_tags = list(
map(
lambda s: js_string.format(s),
filter(lambda x: x, pre_index_files + post_index_files),
)
)
return "\n".join(js_tags)
[docs]
def build_urlCoords_js(img_wcs: WCS) -> str:
wcs_js_file = os.path.join(os.path.dirname(__file__), "support", "urlCoords.js.tmp")
with open(wcs_js_file, "r") as f:
wcs_js = "".join(f.readlines())
if img_wcs:
wcs_js = wcs_js.replace("_IS_RA_DEC", "1")
wcs_js = wcs_js.replace("_CRPIX", str(img_wcs.wcs.crpix.tolist()))
wcs_js = wcs_js.replace("_CRVAL", str(img_wcs.wcs.crval.tolist()))
wcs_js = wcs_js.replace("_CD", extract_cd_matrix_as_string(img_wcs))
else:
wcs_js = wcs_js.replace("_IS_RA_DEC", "0")
wcs_js = wcs_js.replace("_CRPIX", "[1, 1]")
wcs_js = wcs_js.replace("_CRVAL", "[0, 0]")
wcs_js = wcs_js.replace("_CD", "[[1, 0], [0, 1]]")
return wcs_js
[docs]
def build_index_js(
image_layer_dicts: List[Dict],
marker_layer_dicts: List[str],
n_cols: int,
max_xy: Tuple[int, int],
pixel_scale: float,
units_are_pixels: bool,
) -> str:
template_dir = os.path.join(os.path.dirname(__file__), "templates")
# autoescape=False is safe here because we are generating Javascript code, not HTML.
# Standard HTML escaping would break Javascript syntax.
env = Environment( # nosec B701
loader=FileSystemLoader(template_dir), autoescape=False
)
template = env.get_template("index.js.j2")
max_zoom = max(map(lambda t: t["max_native_zoom"], image_layer_dicts))
crs_scale_factor = int(2**max_zoom)
min_zoom = max(map(lambda t: t["min_zoom"], image_layer_dicts))
return template.render(
image_layers=image_layer_dicts,
marker_layers=marker_layer_dicts,
n_cols=n_cols,
pixel_scale=pixel_scale,
units_are_pixels=units_are_pixels,
max_xy=max_xy,
layer_attribution=LAYER_ATTRIBUTION,
crs_scale_factor=crs_scale_factor,
min_zoom=min_zoom,
)