MagicMirror/defaultmodules/weather/providers/envcanada.js

const Log = require("logger");
const { convertKmhToMs } = require("../provider-utils");
const HTTPFetcher = require("#http_fetcher");

/**
 * Server-side weather provider for Environment Canada MSC Datamart
 * Canada only, no API key required (anonymous access)
 *
 * Documentation:
 * https://dd.weather.gc.ca/citypage_weather/schema/
 * https://eccc-msc.github.io/open-data/msc-datamart/readme_en/
 *
 * Requires siteCode and provCode config parameters
 * See https://dd.weather.gc.ca/citypage_weather/docs/site_list_en.csv
 */
class EnvCanadaProvider {
	constructor (config) {
		this.config = {
			siteCode: "s0000000",
			provCode: "ON",
			type: "current",
			updateInterval: 10 * 60 * 1000,
			...config
		};

		this.fetcher = null;
		this.onDataCallback = null;
		this.onErrorCallback = null;
		this.lastCityPageURL = null;
		this.cacheCurrentTemp = null;
		this.currentHour = null; // Track current hour for URL updates
	}

	initialize () {
		this.#validateConfig();
		this.#initializeFetcher();
	}

	setCallbacks (onData, onError) {
		this.onDataCallback = onData;
		this.onErrorCallback = onError;
	}

	start () {
		if (this.fetcher) {
			this.fetcher.startPeriodicFetch();
		}
	}

	stop () {
		if (this.fetcher) {
			this.fetcher.clearTimer();
		}
	}

	#validateConfig () {
		if (!this.config.siteCode || !this.config.provCode) {
			throw new Error("siteCode and provCode are required");
		}
	}

	#initializeFetcher () {
		this.currentHour = new Date().toISOString().substring(11, 13);
		const indexURL = this.#getIndexUrl();

		this.fetcher = new HTTPFetcher(indexURL, {
			reloadInterval: this.config.updateInterval,
			logContext: "weatherprovider.envcanada"
		});

		this.fetcher.on("response", async (response) => {
			try {
				// Check if hour changed - restart fetcher with new URL
				const newHour = new Date().toISOString().substring(11, 13);
				if (newHour !== this.currentHour) {
					Log.info("[envcanada] Hour changed, reinitializing fetcher");
					this.stop();
					this.#initializeFetcher();
					this.start();
					return;
				}

				const html = await response.text();
				const cityPageURL = this.#extractCityPageURL(html);

				if (!cityPageURL) {
					// This can happen during hour transitions when old responses arrive
					Log.debug("[envcanada] Could not find city page URL (may be stale response from previous hour)");
					return;
				}

				if (cityPageURL === this.lastCityPageURL) {
					Log.debug("[envcanada] City page unchanged");
					return;
				}

				this.lastCityPageURL = cityPageURL;
				await this.#fetchCityPage(cityPageURL);

			} catch (error) {
				Log.error("[envcanada] Error:", error);
				if (this.onErrorCallback) {
					this.onErrorCallback({
						message: error.message,
						translationKey: "MODULE_ERROR_UNSPECIFIED"
					});
				}
			}
		});

		this.fetcher.on("error", (errorInfo) => {
			if (this.onErrorCallback) {
				this.onErrorCallback(errorInfo);
			}
		});
	}

	async #fetchCityPage (url) {
		try {
			const response = await fetch(url);
			if (!response.ok) throw new Error(`HTTP ${response.status}`);

			const xml = await response.text();
			const weatherData = this.#parseWeatherData(xml);

			if (this.onDataCallback) {
				this.onDataCallback(weatherData);
			}
		} catch (error) {
			Log.error("[envcanada] Fetch city page error:", error);
			if (this.onErrorCallback) {
				this.onErrorCallback({
					message: "Failed to fetch city data",
					translationKey: "MODULE_ERROR_UNSPECIFIED"
				});
			}
		}
	}

	#parseWeatherData (xml) {
		switch (this.config.type) {
			case "current":
				return this.#generateCurrentWeather(xml);
			case "forecast":
			case "daily":
				return this.#generateForecast(xml);
			case "hourly":
				return this.#generateHourly(xml);
			default:
				Log.error(`[envcanada] Unknown weather type: ${this.config.type}`);
				return null;
		}
	}

	#generateCurrentWeather (xml) {
		const current = { date: new Date() };

		// Try to get temperature from currentConditions first
		const currentTempStr = this.#extract(xml, /<currentConditions>.*?<temperature[^>]*>(.*?)<\/temperature>/s);

		if (currentTempStr && currentTempStr !== "") {
			current.temperature = parseFloat(currentTempStr);
			this.cacheCurrentTemp = current.temperature;
		} else {
			// Fallback: extract from first forecast period if currentConditions is empty
			const firstForecast = xml.match(/<forecast>(.*?)<\/forecast>/s);
			if (firstForecast) {
				const forecastXml = firstForecast[1];
				const temp = this.#extract(forecastXml, /<temperature[^>]*>(.*?)<\/temperature>/);
				if (temp && temp !== "") {
					current.temperature = parseFloat(temp);
					this.cacheCurrentTemp = current.temperature;
				} else if (this.cacheCurrentTemp !== null) {
					current.temperature = this.cacheCurrentTemp;
				} else {
					current.temperature = null;
				}
			}
		}

		// Wind chill / humidex for feels like temperature
		const windChill = this.#extract(xml, /<windChill[^>]*>(.*?)<\/windChill>/);
		const humidex = this.#extract(xml, /<humidex[^>]*>(.*?)<\/humidex>/);
		if (windChill) {
			current.feelsLikeTemp = parseFloat(windChill);
		} else if (humidex) {
			current.feelsLikeTemp = parseFloat(humidex);
		}

		// Get wind and icon from currentConditions or first forecast
		const firstForecast = xml.match(/<forecast>(.*?)<\/forecast>/s);
		if (!firstForecast) {
			Log.warn("[envcanada] No forecast data available");
			return current;
		}

		const forecastXml = firstForecast[1];

		// Wind speed - try currentConditions first, fallback to forecast
		let windSpeed = this.#extract(xml, /<currentConditions>.*?<wind>.*?<speed[^>]*>(.*?)<\/speed>/s);
		if (!windSpeed) {
			windSpeed = this.#extract(forecastXml, /<speed[^>]*>(.*?)<\/speed>/);
		}
		if (windSpeed) {
			current.windSpeed = (windSpeed === "calm") ? 0 : convertKmhToMs(parseFloat(windSpeed));
		}

		// Wind bearing - try currentConditions first, fallback to forecast
		let windBearing = this.#extract(xml, /<currentConditions>.*?<wind>.*?<bearing[^>]*>(.*?)<\/bearing>/s);
		if (!windBearing) {
			windBearing = this.#extract(forecastXml, /<bearing[^>]*>(.*?)<\/bearing>/);
		}
		if (windBearing) current.windFromDirection = parseFloat(windBearing);

		// Try icon from currentConditions first, fallback to forecast
		let iconCode = this.#extract(xml, /<currentConditions>.*?<iconCode[^>]*>(.*?)<\/iconCode>/s);
		if (!iconCode) {
			iconCode = this.#extract(forecastXml, /<iconCode[^>]*>(.*?)<\/iconCode>/);
		}
		if (iconCode) current.weatherType = this.#convertWeatherType(iconCode);

		// Humidity from currentConditions
		const humidity = this.#extract(xml, /<currentConditions>.*?<relativeHumidity[^>]*>(.*?)<\/relativeHumidity>/s);
		if (humidity) current.humidity = parseFloat(humidity);

		// Precipitation probability from forecast
		const pop = this.#extract(forecastXml, /<pop[^>]*>(.*?)<\/pop>/);
		if (pop && pop !== "") {
			current.precipitationProbability = parseFloat(pop);
		}

		// Sunrise/sunset (from riseSet, independent of currentConditions)
		const sunriseTime = this.#extract(xml, /<dateTime[^>]*name="sunrise"[^>]*>.*?<timeStamp>(.*?)<\/timeStamp>/s);
		const sunsetTime = this.#extract(xml, /<dateTime[^>]*name="sunset"[^>]*>.*?<timeStamp>(.*?)<\/timeStamp>/s);
		if (sunriseTime) current.sunrise = this.#parseECTime(sunriseTime);
		if (sunsetTime) current.sunset = this.#parseECTime(sunsetTime);

		return current;
	}

	#generateForecast (xml) {
		const days = [];
		const forecasts = xml.match(/<forecast>(.*?)<\/forecast>/gs) || [];

		if (forecasts.length === 0) return days;

		// Get current temp
		const currentTempStr = this.#extract(xml, /<currentConditions>.*?<temperature[^>]*>(.*?)<\/temperature>/s);
		const currentTemp = currentTempStr ? parseFloat(currentTempStr) : null;

		// Check if first forecast is Today or Tonight
		const isToday = forecasts[0].includes("textForecastName=\"Today\"");

		let nextDay = isToday ? 2 : 1;
		const lastDay = isToday ? 12 : 11;

		// Process first day
		const firstDay = {
			date: new Date(),
			precipitationProbability: null
		};
		this.#extractForecastTemps(firstDay, forecasts, 0, isToday, currentTemp);
		this.#extractForecastPrecip(firstDay, forecasts, 0);
		const firstIcon = this.#extract(forecasts[0], /<iconCode[^>]*>(.*?)<\/iconCode>/);
		if (firstIcon) firstDay.weatherType = this.#convertWeatherType(firstIcon);
		days.push(firstDay);

		// Process remaining days
		let date = new Date();
		for (let i = nextDay; i < lastDay && i < forecasts.length; i += 2) {
			date = new Date(date);
			date.setDate(date.getDate() + 1);

			const day = {
				date: new Date(date),
				precipitationProbability: null
			};
			this.#extractForecastTemps(day, forecasts, i, true, currentTemp);
			this.#extractForecastPrecip(day, forecasts, i);
			const icon = this.#extract(forecasts[i], /<iconCode[^>]*>(.*?)<\/iconCode>/);
			if (icon) day.weatherType = this.#convertWeatherType(icon);
			days.push(day);
		}

		return days;
	}

	#extractForecastTemps (weather, forecasts, index, hasToday, currentTemp) {
		let tempToday = null;
		let tempTonight = null;

		if (hasToday && forecasts[index]) {
			const temp = this.#extract(forecasts[index], /<temperature[^>]*>(.*?)<\/temperature>/);
			if (temp) tempToday = parseFloat(temp);
		}

		if (forecasts[index + 1]) {
			const temp = this.#extract(forecasts[index + 1], /<temperature[^>]*>(.*?)<\/temperature>/);
			if (temp) tempTonight = parseFloat(temp);
		}

		if (tempToday !== null && tempTonight !== null) {
			weather.maxTemperature = Math.max(tempToday, tempTonight);
			weather.minTemperature = Math.min(tempToday, tempTonight);
		} else if (tempToday !== null) {
			weather.maxTemperature = tempToday;
			weather.minTemperature = currentTemp || tempToday;
		} else if (tempTonight !== null) {
			weather.maxTemperature = currentTemp || tempTonight;
			weather.minTemperature = tempTonight;
		}
	}

	#extractForecastPrecip (weather, forecasts, index) {
		const precips = [];

		if (forecasts[index]) {
			const pop = this.#extract(forecasts[index], /<pop[^>]*>(.*?)<\/pop>/);
			if (pop) precips.push(parseFloat(pop));
		}

		if (forecasts[index + 1]) {
			const pop = this.#extract(forecasts[index + 1], /<pop[^>]*>(.*?)<\/pop>/);
			if (pop) precips.push(parseFloat(pop));
		}

		if (precips.length > 0) {
			weather.precipitationProbability = Math.max(...precips);
		}
	}

	#generateHourly (xml) {
		const hours = [];
		const hourlyMatches = xml.matchAll(/<hourlyForecast[^>]*dateTimeUTC="([^"]*)"[^>]*>(.*?)<\/hourlyForecast>/gs);

		for (const [, dateTimeUTC, hourXML] of hourlyMatches) {
			const weather = {};

			weather.date = this.#parseECTime(dateTimeUTC);

			const temp = this.#extract(hourXML, /<temperature[^>]*>(.*?)<\/temperature>/);
			if (temp) weather.temperature = parseFloat(temp);

			const lop = this.#extract(hourXML, /<lop[^>]*>(.*?)<\/lop>/);
			if (lop) weather.precipitationProbability = parseFloat(lop);

			const icon = this.#extract(hourXML, /<iconCode[^>]*>(.*?)<\/iconCode>/);
			if (icon) weather.weatherType = this.#convertWeatherType(icon);

			hours.push(weather);
			if (hours.length >= 24) break;
		}

		return hours;
	}

	#extract (text, pattern) {
		const match = text.match(pattern);
		return match ? match[1].trim() : null;
	}

	#getIndexUrl () {
		const hour = new Date().toISOString().substring(11, 13);
		return `https://dd.weather.gc.ca/today/citypage_weather/${this.config.provCode}/${hour}/`;
	}

	#extractCityPageURL (html) {
		// New format: {timestamp}_MSC_CitypageWeather_{siteCode}_en.xml
		const pattern = `[^"]*_MSC_CitypageWeather_${this.config.siteCode}_en\\.xml`;
		const match = html.match(new RegExp(`href="(${pattern})"`));

		if (match && match[1]) {
			return this.#getIndexUrl() + match[1];
		}

		return null;
	}

	#parseECTime (timeStr) {
		if (!timeStr || timeStr.length < 12) return new Date();

		const y = parseInt(timeStr.substring(0, 4), 10);
		const m = parseInt(timeStr.substring(4, 6), 10) - 1;
		const d = parseInt(timeStr.substring(6, 8), 10);
		const h = parseInt(timeStr.substring(8, 10), 10);
		const min = parseInt(timeStr.substring(10, 12), 10);
		const s = timeStr.length >= 14 ? parseInt(timeStr.substring(12, 14), 10) : 0;

		// Create UTC date since input timestamps are in UTC
		return new Date(Date.UTC(y, m, d, h, min, s));
	}

	#convertWeatherType (iconCode) {
		const code = parseInt(iconCode, 10);
		const map = {
			0: "day-sunny",
			1: "day-sunny",
			2: "day-sunny-overcast",
			3: "day-cloudy",
			4: "day-cloudy",
			5: "day-cloudy",
			6: "day-sprinkle",
			7: "day-showers",
			8: "snow",
			9: "day-thunderstorm",
			10: "cloud",
			11: "showers",
			12: "rain",
			13: "rain",
			14: "sleet",
			15: "sleet",
			16: "snow",
			17: "snow",
			18: "snow",
			19: "thunderstorm",
			20: "cloudy",
			21: "cloudy",
			22: "day-cloudy",
			23: "day-haze",
			24: "fog",
			25: "snow-wind",
			26: "sleet",
			27: "sleet",
			28: "rain",
			29: "na",
			30: "night-clear",
			31: "night-clear",
			32: "night-partly-cloudy",
			33: "night-alt-cloudy",
			34: "night-alt-cloudy",
			35: "night-partly-cloudy",
			36: "night-alt-showers",
			37: "night-rain-mix",
			38: "night-alt-snow",
			39: "night-thunderstorm",
			40: "snow-wind",
			41: "tornado",
			42: "tornado",
			43: "windy",
			44: "smoke",
			45: "sandstorm",
			46: "thunderstorm",
			47: "thunderstorm",
			48: "tornado"
		};
		return map[code] || null;
	}
}

module.exports = EnvCanadaProvider;