itchio-opengamepadui-artprovider-plugin/core/boxart_itch.gd

extends BoxArtProvider

## itch.io box art provider for OpenGamepadUI
##
## Fetches cover art and screenshots from itch.io game pages. Works alongside
## the itch.io library plugin to provide per-layout artwork: the cover for
## portrait/logo, full-res screenshots for landscape/banner.
##
## Enriches game metadata by scraping the itch.io page HTML for screenshots
## (the itch.io API does not expose them), caches the result in
## itch_art_meta.json, and uses HTTPImageFetcher for async image downloads.

const BOXART_DIR := "user://boxart/itch"
const META_CACHE_FILE := "itch_art_meta.json"
const HTTP_TIMEOUT_MS := 15000
const SCREENSHOT_REGEX_PATTERN := "https://img\\.itch\\.zone/aW1hZ2Uv[\\w+/=]*/original/[\\w+/=]*\\.[a-z]+"
const IMAGE_EXTS := ["png", "jpg", "jpeg", "gif", "webp", "bmp"]
const FFMPEG_BUILDS_URL := "https://github.com/BtbN/FFmpeg-Builds/releases/download/latest"
const CONNECT_POLL_DELAY_MS := 50
const READ_POLL_DELAY_MS := 10
const LOG_URL_MAX_LEN := 80

@export var use_caching: bool = true
var http_image := HTTPImageFetcher.new()
var _meta_cache_dir := "itch_art"
var _enriched_meta: Dictionary = {}

var layout_map: Dictionary = {
	LAYOUT.GRID_PORTRAIT: "-portrait",
	LAYOUT.GRID_LANDSCAPE: "-landscape",
	LAYOUT.BANNER: "-banner",
	LAYOUT.LOGO: "-logo",
}

## Resolved path to the ffmpeg binary (system or bundled). Populated lazily.
var _ffmpeg_bin: String = ""


func _init() -> void:
	super()
	DirAccess.make_dir_recursive_absolute(ProjectSettings.globalize_path(BOXART_DIR))
	provider_id = "itch"
	logger_name = "BoxArtItch"


func _ready() -> void:
	super()
	_enriched_meta = _load_enriched_meta()
	logger.info("itch.io Art Provider loaded")
	add_child(http_image)


## Strips HTML srcset artifacts from a URL. Butlerd sometimes passes through
## itch.io cover URLs with trailing srcset descriptors like " 1x, h" or " 2x".
## These cause HTTPImageFetcher to fail because the URL is no longer valid.
func _sanitize_url(url: String) -> String:
	if url.is_empty():
		return url
	# Srcset descriptors are separated by spaces — take only the URL portion.
	var clean: String = url.split(" ")[0]
	# Validate that the cleaned URL ends with a known image extension.
	var ext: String = clean.get_extension().to_lower()
	if ext not in IMAGE_EXTS:
		logger.warn("Sanitized URL has unexpected extension '%s': %s" % [ext, clean.left(LOG_URL_MAX_LEN)])
	return clean


## Returns whether a URL points to a GIF image. Handles both clean URLs and
## URLs contaminated with srcset artifacts (e.g. "image.gif 1x, h").
func _is_gif_url(url: String) -> bool:
	return _sanitize_url(url).to_lower().ends_with(".gif")


func get_boxart(item: LibraryItem, kind: LAYOUT) -> Texture2D:
	if not kind in layout_map:
		logger.error("Unsupported boxart layout: {0}".format([kind]))
		return null

	var game := _find_game_dict(item)
	if game.is_empty():
		logger.warn("No itch.io game metadata found for: " + item.name)
		return null

	var game_id := int(game.get("id", 0))
	var title: String = game.get("title", "")
	logger.info("get_boxart: title=%s id=%d layout=%s" % [title, game_id, str(kind)])
	if title.is_empty():
		logger.warn("Game title is empty for id %d" % game_id)
		return null

	# Enrich on first access: scrape the itch.io page for screenshots.
	# Cached failures (empty screenshots) are stored to avoid repeated
	# requests against Cloudflare-protected pages.
	var meta: Dictionary = _enriched_meta.get(game_id, {})
	if meta.is_empty() and game.has("url"):
		logger.info("Enriching metadata for: %s (url=%s)" % [title, game.get("url", "")])
		meta = _fetch_game_page_metadata(game)
		# Cache both successes and failures to avoid repeated requests.
		_enriched_meta[game_id] = meta
		_save_enriched_meta(game_id, meta)
		if meta.is_empty():
			logger.info("No screenshots available for: %s — will use cover art" % title)
		else:
			logger.info("Scraped %d screenshots for: %s" % [meta.get("screenshots", []).size(), title])
	elif not meta.is_empty():
		logger.info("Using cached metadata for: %s (%d screenshots)" % [title, meta.get("screenshots", []).size()])
	else:
		logger.warn("No URL in game dict for: %s" % title)

	var screenshots: Array = meta.get("screenshots", []).map(_sanitize_url)
	var cover_url := _sanitize_url(_best_portrait_url(game, screenshots))
	if cover_url.is_empty():
		logger.warn("No cover URL for: %s (id=%d)" % [title, game_id])
		return null
	logger.info("cover_url=%s" % cover_url.left(LOG_URL_MAX_LEN))

	var cache_flags := Cache.FLAGS.NONE
	if use_caching:
		cache_flags = Cache.FLAGS.LOAD | Cache.FLAGS.SAVE

	# Banner: combine two screenshots side-by-side when available.
	if kind == LAYOUT.BANNER and screenshots.size() >= 2:
		logger.info("Fetching itch.io banner (2 screenshots) for: " + item.name)
		var tex_a := await _fetch_image(screenshots[0], cache_flags)
		var tex_b := await _fetch_image(screenshots[1], cache_flags)
		if tex_a != null and tex_b != null:
			return _combine_side_by_side(tex_a, tex_b)
		# Banner combine failed — fall back to single-image path.
		logger.warn("Banner screenshot fetch failed: tex_a=%s tex_b=%s" % [str(tex_a != null), str(tex_b != null)])
		if tex_a != null:
			return tex_a
		if tex_b != null:
			return tex_b

	var url := _url_for_layout(kind, cover_url, screenshots)
	if url.is_empty():
		logger.warn("URL for layout %s is empty (cover=%s)" % [str(kind), cover_url])
		return null

	logger.info("Fetching itch.io box art for: %s layout=%s url=%s" % [item.name, str(kind), url.left(LOG_URL_MAX_LEN)])
	var texture: Texture2D = await _fetch_image(url, cache_flags)
	if texture == null:
		logger.warn("Image download returned null for: %s url=%s" % [item.name, url.left(LOG_URL_MAX_LEN)])
	return texture


## Finds the itch.io game dict from the library item's launch items.
func _find_game_dict(item: LibraryItem) -> Dictionary:
	if item.launch_items.is_empty():
		logger.warn("Item has no launch items: " + item.name)
		return {}
	for launch_item in item.launch_items:
		if launch_item._provider_id != "itch":
			continue
		var game: Dictionary = launch_item.metadata.get("game", {})
		if not game.is_empty():
			return game
	logger.warn("No itch.io launch item found for: %s (providers: %s)" % [
		item.name,
		PackedStringArray(item.launch_items.map(func(l): return l._provider_id))
	])
	return {}


func _url_for_layout(kind: LAYOUT, cover_url: String, screenshots: Array) -> String:
	match kind:
		LAYOUT.GRID_PORTRAIT, LAYOUT.LOGO:
			return cover_url
		LAYOUT.GRID_LANDSCAPE:
			return screenshots[0] if not screenshots.is_empty() else cover_url
		LAYOUT.BANNER:
			# Single screenshot fallback (two-screenshot case handled in get_boxart).
			return screenshots[0] if not screenshots.is_empty() else cover_url
	return ""


## Returns the best portrait/logo URL from the game data.
## Prefers stillCoverUrl (the still/non-animated version of the cover),
## then coverUrl. Screenshots are never used as capsule art.
func _best_portrait_url(game: Dictionary, _screenshots: Array) -> String:
	var still: String = game.get("stillCoverUrl", "")
	if not still.is_empty():
		return still
	return game.get("coverUrl", "")


## Ensures an ffmpeg binary is available. Checks the system PATH first,
## then falls back to a bundled copy under user://boxart/itch/. Downloads
## the static build on first use if neither is found.
func _ensure_ffmpeg() -> String:
	if not _ffmpeg_bin.is_empty():
		return _ffmpeg_bin
	# 1. Check system PATH by probing directly.
	var probe: Array = []
	OS.execute("ffmpeg", ["-version"], probe, true)
	if probe.size() > 0 and probe[0].find("ffmpeg version") != -1:
		_ffmpeg_bin = "ffmpeg"
		logger.info("Using system ffmpeg")
		return _ffmpeg_bin
	# 2. Check bundled location.
	var bundled: String = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg"
	if FileAccess.file_exists(bundled):
		_ffmpeg_bin = bundled
		logger.info("Using bundled ffmpeg: " + _ffmpeg_bin)
		return _ffmpeg_bin
	# 3. Download.
	logger.info("ffmpeg not found — downloading static build")
	if await _install_ffmpeg():
		_ffmpeg_bin = ProjectSettings.globalize_path(BOXART_DIR) + "/ffmpeg"
		return _ffmpeg_bin
	logger.warn("ffmpeg unavailable — GIF covers will not load")
	return ""


## Downloads a static ffmpeg build. Detects the platform and architecture
## the same way the itch plugin's butler installer does, then fetches
## the matching BtbN pre-built binary.
func _install_ffmpeg() -> bool:
	var goos := "linux"
	var goarch := "64"
	if OS.get_name() == "Windows":
		goos = "win"
	if OS.get_name() == "macOS":
		goos = "macos"
	if Engine.has_method("get_architecture_name"):
		var arch: String = Engine.get_architecture_name()
		if "arm64" in arch or "aarch64" in arch:
			goarch = "arm64"

	var platform_slug := goos + goarch
	var archive_name := "ffmpeg-master-latest-%s-gpl" % platform_slug
	var is_win: bool = goos == "win"
	var archive_url := "%s/%s.%s" % [FFMPEG_BUILDS_URL, archive_name,
		"zip" if is_win else "tar.xz"]

	var http := HTTPRequest.new()
	add_child.call_deferred(http)
	await http.ready

	if http.request(archive_url) != OK:
		logger.error("Error requesting ffmpeg archive: " + archive_url)
		remove_child(http)
		http.queue_free()
		return false

	var args: Array = await http.request_completed
	var result: int = args[0]
	var response_code: int = args[1]
	var body: PackedByteArray = args[3]
	remove_child(http)
	http.queue_free()

	if result != HTTPRequest.RESULT_SUCCESS or response_code != 200:
		logger.error("ffmpeg download failed: HTTP %d for %s" % [response_code, archive_url])
		return false

	var globalized_dir := ProjectSettings.globalize_path(BOXART_DIR)
	DirAccess.make_dir_recursive_absolute(globalized_dir)
	var ext := "zip" if is_win else "tar.xz"
	var archive_path := globalized_dir + "/ffmpeg." + ext
	var file := FileAccess.open(archive_path, FileAccess.WRITE)
	if file == null:
		logger.error("Cannot write ffmpeg archive to " + archive_path)
		return false
	file.store_buffer(body)
	file.close()

	var out := []
	if is_win:
		OS.execute("unzip", ["-o", archive_path, "-d", globalized_dir], out)
		OS.execute("chmod", ["+x", globalized_dir + "/ffmpeg.exe"], out)
	else:
		OS.execute("tar", ["xf", archive_path, "-C", globalized_dir,
			"--strip-components=1", "--wildcards", "*/ffmpeg"], out)
		OS.execute("chmod", ["+x", globalized_dir + "/ffmpeg"], out)
	DirAccess.remove_absolute(archive_path)
	logger.info("ffmpeg installed to " + globalized_dir)
	return true


## Unified image fetch that routes GIF URLs through ffmpeg first-frame
## extraction and non-GIF URLs through the normal HTTPImageFetcher path.
func _fetch_image(url: String, cache_flags: int) -> Texture2D:
	if _is_gif_url(url):
		return await _fetch_gif_first_frame(url, cache_flags)
	return await http_image.fetch(url, cache_flags)


## Downloads a GIF and extracts the first frame using ffmpeg.
## Returns an ImageTexture, or null on failure.
func _fetch_gif_first_frame(url: String, cache_flags: int) -> Texture2D:
	var ffmpeg_bin := await _ensure_ffmpeg()
	if ffmpeg_bin.is_empty():
		return null

	var globalized_dir := ProjectSettings.globalize_path(BOXART_DIR)
	var gif_path := globalized_dir + "/_tmp.gif"
	var png_path := globalized_dir + "/_tmp.png"

	# Download the GIF bytes via HTTPClient (same pattern as _fetch_game_page_metadata).
	var http := HTTPClient.new()
	var parts := url.split("/")
	var use_tls := parts[0] == "https:"
	var err := http.connect_to_host(parts[2], 443 if use_tls else 80, TLSOptions.client() if use_tls else null)
	if err != OK:
		logger.warn("GIF fetch: HTTP connect failed for %s: %d" % [url.left(LOG_URL_MAX_LEN), err])
		return null
	var deadline := Time.get_ticks_msec() + HTTP_TIMEOUT_MS
	while http.get_status() == HTTPClient.STATUS_CONNECTING or http.get_status() == HTTPClient.STATUS_RESOLVING:
		http.poll()
		if Time.get_ticks_msec() > deadline:
			http.close()
			logger.warn("GIF fetch: connect timed out")
			return null
		OS.delay_msec(CONNECT_POLL_DELAY_MS)
	if http.get_status() != HTTPClient.STATUS_CONNECTED:
		logger.warn("GIF fetch: not connected (status=%d)" % http.get_status())
		http.close()
		return null

	http.request(HTTPClient.METHOD_GET, "/" + "/".join(parts.slice(3)), PackedStringArray())
	deadline = Time.get_ticks_msec() + HTTP_TIMEOUT_MS
	while http.get_status() == HTTPClient.STATUS_REQUESTING:
		http.poll()
		if Time.get_ticks_msec() > deadline:
			http.close()
			logger.warn("GIF fetch: request timed out")
			return null
		OS.delay_msec(READ_POLL_DELAY_MS)

	var body := PackedByteArray()
	while http.get_status() == HTTPClient.STATUS_BODY:
		http.poll()
		var chunk: PackedByteArray = http.read_response_body_chunk()
		if chunk.is_empty():
			if Time.get_ticks_msec() > deadline:
				http.close()
				logger.warn("GIF fetch: body read timed out")
				return null
			OS.delay_msec(READ_POLL_DELAY_MS)
			continue
		body.append_array(chunk)
	http.close()

	if body.is_empty():
		logger.warn("GIF fetch: empty response for %s" % url.left(LOG_URL_MAX_LEN))
		return null

	# Write GIF to temp file.
	var gif_file := FileAccess.open(gif_path, FileAccess.WRITE)
	if gif_file == null:
		logger.warn("GIF fetch: cannot write temp gif")
		return null
	gif_file.store_buffer(body)
	gif_file.close()

	# Extract first frame with ffmpeg.
	var ffmpeg_args: PackedStringArray = [
		"-y", "-i", gif_path,
		"-frames:v", "1",
		"-f", "image2", png_path,
	]
	var ret: Array = []
	OS.execute(ffmpeg_bin, ffmpeg_args, ret)

	if not FileAccess.file_exists(png_path):
		logger.warn("GIF fetch: ffmpeg did not produce output for %s" % url.left(LOG_URL_MAX_LEN))
		DirAccess.remove_absolute(gif_path)
		return null

	var image := Image.load_from_file(png_path)
	# Clean up temp files.
	DirAccess.remove_absolute(gif_path)
	DirAccess.remove_absolute(png_path)

	if image == null:
		logger.warn("GIF fetch: failed to load extracted PNG")
		return null

	logger.info("GIF fetch: extracted first frame from %s" % url.left(LOG_URL_MAX_LEN))
	return ImageTexture.create_from_image(image)


## Combines two textures side-by-side into a single banner image.
## Both images are scaled to the same height, then placed left and right.
func _combine_side_by_side(left: Texture2D, right: Texture2D) -> Texture2D:
	var img_a := left.get_image()
	var img_b := right.get_image()
	if img_a == null or img_b == null:
		return left

	# Scale both to the same height (use the taller one).
	var target_h: int = max(img_a.get_height(), img_b.get_height())
	if img_a.get_height() != target_h:
		var scale: float = float(target_h) / float(img_a.get_height())
		img_a.resize(int(img_a.get_width() * scale), target_h, Image.INTERPOLATE_BILINEAR)
	if img_b.get_height() != target_h:
		var scale: float = float(target_h) / float(img_b.get_height())
		img_b.resize(int(img_b.get_width() * scale), target_h, Image.INTERPOLATE_BILINEAR)

	var combined := Image.create(img_a.get_width() + img_b.get_width(), target_h, false, img_a.get_format())
	combined.blit_rect(img_a, Rect2i(0, 0, img_a.get_width(), target_h), Vector2i.ZERO)
	combined.blit_rect(img_b, Rect2i(0, 0, img_b.get_width(), target_h), Vector2i(img_a.get_width(), 0))

	return ImageTexture.create_from_image(combined)


## Scrapes the itch.io game page for screenshots. The itch.io API does not
## expose screenshots, so the page HTML is the only source.
func _fetch_game_page_metadata(game: Dictionary) -> Dictionary:
	var page_url: String = game.get("url", "")
	if page_url.is_empty():
		logger.warn("No page URL in game dict")
		return {}

	logger.info("Scraping page for screenshots: " + page_url)
	var http := HTTPClient.new()
	var parts := page_url.split("/")
	var use_tls := parts[0] == "https:"
	var err := http.connect_to_host(parts[2], 443 if use_tls else 80, TLSOptions.client() if use_tls else null)
	if err != OK:
		logger.warn("HTTP connect failed for %s: %d" % [page_url, err])
		return {}
	var deadline := Time.get_ticks_msec() + HTTP_TIMEOUT_MS
	while http.get_status() == HTTPClient.STATUS_CONNECTING or http.get_status() == HTTPClient.STATUS_RESOLVING:
		http.poll()
		if Time.get_ticks_msec() > deadline:
			http.close()
			logger.warn("HTTP connect timed out for: " + page_url)
			return {}
		OS.delay_msec(CONNECT_POLL_DELAY_MS)
	if http.get_status() != HTTPClient.STATUS_CONNECTED:
		logger.warn("HTTP not connected for %s: status=%d" % [page_url, http.get_status()])
		http.close()
		return {}

	http.request(HTTPClient.METHOD_GET, "/" + "/".join(parts.slice(3)), PackedStringArray())
	deadline = Time.get_ticks_msec() + HTTP_TIMEOUT_MS
	while http.get_status() == HTTPClient.STATUS_REQUESTING:
		http.poll()
		if Time.get_ticks_msec() > deadline:
			http.close()
			logger.warn("HTTP request timed out for: " + page_url)
			return {}
		OS.delay_msec(READ_POLL_DELAY_MS)

	var body := PackedByteArray()
	while http.get_status() == HTTPClient.STATUS_BODY:
		http.poll()
		var chunk: PackedByteArray = http.read_response_body_chunk()
		if chunk.is_empty():
			if Time.get_ticks_msec() > deadline:
				http.close()
				logger.warn("HTTP body read timed out for: " + page_url)
				return {}
			OS.delay_msec(READ_POLL_DELAY_MS)
			continue
		body.append_array(chunk)
	http.close()

	var html := body.get_string_from_utf8()
	if html.is_empty():
		logger.warn("Empty HTML response for: " + page_url)
		return {}

	# Detect Cloudflare challenge pages — no point extracting screenshots.
	if html.find("challenge-platform") != -1 or html.find("cf-browser-verification") != -1:
		logger.warn("Cloudflare challenge detected for: %s — falling back to cover art" % page_url)
		return {}

	var shot_re := RegEx.new()
	shot_re.compile(SCREENSHOT_REGEX_PATTERN)
	var screenshots: Array = []
	for m in shot_re.search_all(html):
		var url: String = _sanitize_url(m.get_string(0))
		screenshots.append(url)

	logger.info("Found %d screenshots for page %s" % [screenshots.size(), page_url])
	return {"screenshots": screenshots}


func _load_enriched_meta() -> Dictionary:
	var raw: Variant = Cache.get_json(_meta_cache_dir, META_CACHE_FILE)
	if typeof(raw) != TYPE_DICTIONARY:
		return {}
	var out := {}
	for key in raw:
		out[int(key)] = raw[key]
	return out


func _save_enriched_meta(game_id: int, meta: Dictionary) -> void:
	var raw: Variant = Cache.get_json(_meta_cache_dir, META_CACHE_FILE)
	if typeof(raw) != TYPE_DICTIONARY:
		raw = {}
	raw[str(game_id)] = meta
	Cache.save_json(_meta_cache_dir, META_CACHE_FILE, raw)