contentdb/app/tasks/minetestcheck/tree.py

# ContentDB
# Copyright (C) 2018-21 rubenwardy
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU Affero General Public License for more details.
#
# You should have received a copy of the GNU Affero General Public License
# along with this program.  If not, see <https://www.gnu.org/licenses/>.


import os
import re
import glob
from typing import Optional

from . import MinetestCheckError, ContentType
from .config import parse_conf
from .translation import Translation, parse_tr

basenamePattern = re.compile("^([a-z0-9_]+)$")
licensePattern = re.compile("^(licen[sc]e|copying)(.[^/\n]+)?$", re.IGNORECASE)

DISALLOWED_NAMES = {
	"core", "minetest", "group", "table", "string", "lua", "luajit", "assert", "debug",
	"error", "next", "pairs", "print", "select", "type", "pack", "unpack", "builtin",
}


def get_base_dir(path) -> str:
	if not os.path.isdir(path):
		raise IOError("Expected dir")

	root, subdirs, files = next(os.walk(path))
	if len(subdirs) == 1 and len(files) == 0:
		return get_base_dir(path + "/" + subdirs[0])
	else:
		return path


def detect_type(path) -> ContentType:
	if os.path.isfile(path + "/game.conf"):
		return ContentType.GAME
	elif os.path.isfile(path + "/init.lua"):
		return ContentType.MOD
	elif os.path.isfile(path + "/modpack.txt") or \
			os.path.isfile(path + "/modpack.conf"):
		return ContentType.MODPACK
	# elif os.path.isdir(path + "/mods"):
	# 	return ContentType.GAME
	elif os.path.isfile(path + "/texture_pack.conf"):
		return ContentType.TXP
	else:
		return ContentType.UNKNOWN


def get_csv_line(line) -> list[str]:
	if line is None:
		return []

	return [x.strip() for x in line.split(",") if x.strip() != ""]


def check_name_list(key: str, value: list[str], relative: str, allow_star: bool = False):
	for dep in value:
		if not basenamePattern.match(dep):
			if dep == "*" and allow_star:
				continue
			elif " " in dep:
				raise MinetestCheckError(
					f"Invalid {key} name '{dep}' at {relative}, did you forget a comma?")
			else:
				raise MinetestCheckError(
					f"Invalid {key} name '{dep}' at {relative}, names must only contain a-z0-9_.")


class PackageTreeNode:
	baseDir: str
	relative: str
	author: Optional[str]
	name: Optional[str]
	repo: Optional[str]
	meta: dict
	children: list
	type: ContentType
	strict: bool

	def __init__(self, base_dir: str, relative: str,
			author: Optional[str] = None,
			repo: Optional[str] = None, name: Optional[str] = None,
			strict: bool = True):
		self.baseDir = base_dir
		self.relative = relative
		self.author = author
		self.name = name
		self.repo = repo
		self.meta = {}
		self.children = []
		self.strict = strict

		# Detect type
		self.type = detect_type(base_dir)
		self._read_meta()

		if self.type == ContentType.GAME:
			if not os.path.isdir(os.path.join(base_dir, "mods")):
				raise MinetestCheckError("Game at {} does not have a mods/ folder".format(self.relative))
			self._add_children_from_mod_dir("mods")
		elif self.type == ContentType.MOD:
			if self.name and not basenamePattern.match(self.name):
				raise MinetestCheckError(f"Invalid base name for mod {self.name} at {self.relative}, names must only contain a-z0-9_.")

			if self.name and self.name in DISALLOWED_NAMES:
				raise MinetestCheckError(f"Forbidden mod name '{self.name}' used at {self.relative}")

			self._check_dir_casing(["textures", "media", "sounds", "models", "locale"])
		elif self.type == ContentType.MODPACK:
			self._add_children_from_mod_dir(None)

	def find_license_file(self) -> Optional[str]:
		for name in os.listdir(self.baseDir):
			path = os.path.join(self.baseDir, name)
			if os.path.isfile(path) and licensePattern.match(name):
				return path

		return None

	def _check_dir_casing(self, dirs):
		for dir in next(os.walk(self.baseDir))[1]:
			lowercase = dir.lower()
			if lowercase != dir and lowercase in dirs:
				raise MinetestCheckError(f"Incorrect case, {dir} should be {lowercase} at {self.relative}{dir}")

	def get_readme_path(self):
		for filename in os.listdir(self.baseDir):
			path = os.path.join(self.baseDir, filename)
			if os.path.isfile(path) and filename.lower().startswith("readme."):
				return path

	def get_meta_file_name(self):
		if self.type == ContentType.GAME:
			return "game.conf"
		elif self.type == ContentType.MOD:
			return "mod.conf"
		elif self.type == ContentType.MODPACK:
			return "modpack.conf"
		elif self.type == ContentType.TXP:
			return "texture_pack.conf"
		else:
			return None

	def _read_meta(self):
		result = {}

		# Read .conf file
		meta_file_name = self.get_meta_file_name()
		if meta_file_name is not None:
			meta_file_rel = self.relative + meta_file_name
			meta_file_path = self.baseDir + "/" + meta_file_name
			try:
				with open(meta_file_path or "", "r") as f:
					conf = parse_conf(f.read())
					for key, value in conf.items():
						result[key] = value
			except SyntaxError as e:
				raise MinetestCheckError("Error while reading {}: {}".format(meta_file_rel , e.msg))
			except IOError:
				pass

			if self.strict and "release" in result:
				raise MinetestCheckError("{} should not contain 'release' key, as this is for use by ContentDB only.".format(meta_file_rel))

		# description.txt
		if "description" not in result:
			try:
				with open(self.baseDir + "/description.txt", "r") as f:
					result["description"] = f.read()
			except IOError:
				pass

		# Read dependencies
		if "depends" in result or "optional_depends" in result:
			result["depends"] = get_csv_line(result.get("depends"))
			result["optional_depends"] = get_csv_line(result.get("optional_depends"))

		elif os.path.isfile(self.baseDir + "/depends.txt"):
			pattern = re.compile(r"^([a-z0-9_]+)\??$")

			with open(self.baseDir + "/depends.txt", "r") as f:
				contents = f.read()
				soft = []
				hard = []
				for line in contents.split("\n"):
					line = line.strip()
					if pattern.match(line):
						if line[len(line) - 1] == "?":
							soft.append( line[:-1])
						else:
							hard.append(line)

				result["depends"] = hard
				result["optional_depends"] = soft

		else:
			result["depends"] = []
			result["optional_depends"] = []

		# Read supported games
		result["supported_games"] = get_csv_line(result.get("supported_games", ""))
		result["unsupported_games"] = get_csv_line(result.get("unsupported_games", ""))

		# Check dependencies
		check_name_list("depends", result["depends"], self.relative)
		check_name_list("optional_depends", result["optional_depends"], self.relative)

		# Check supported games
		check_name_list("supported_games", result["supported_games"], self.relative, True)
		check_name_list("unsupported_games", result["unsupported_games"], self.relative)

		# Fix games using "name" as "title"
		if self.type == ContentType.GAME and "name" in result:
			result["title"] = result["name"]
			del result["name"]

		# Calculate Title
		if "name" in result and "title" not in result:
			result["title"] = result["name"].replace("_", " ").title()

		# Calculate short description
		if "description" in result:
			desc = result["description"]
			idx = desc.find(".") + 1
			cutIdx = min(len(desc), 200 if idx < 5 else idx)
			result["short_description"] = desc[:cutIdx]

		if "name" in result:
			self.name = result["name"]
			del result["name"]

		self.meta = result

	def _add_children_from_mod_dir(self, subdir):
		dir = self.baseDir
		relative = self.relative
		if subdir:
			dir += "/" + subdir
			relative += subdir + "/"

		for entry in next(os.walk(dir))[1]:
			path = os.path.join(dir, entry)
			if not entry.startswith('.') and os.path.isdir(path):
				child = PackageTreeNode(path, relative + entry + "/", name=entry, strict=self.strict)
				if not child.type.is_mod_like():
					raise MinetestCheckError("Expecting mod or modpack, found {} at {} inside {}" \
						.format(child.type.value, child.relative, self.type.value))

				if child.name is None:
					raise MinetestCheckError("Missing base name for mod at {}".format(self.relative))

				self.children.append(child)

	def get_mod_names(self):
		return self.fold("name", type_=ContentType.MOD)

	# attr: Attribute name
	# key: Key in attribute
	# retval: Accumulator
	# type_: Filter to type
	def fold(self, attr, key=None, retval=None, type_=None):
		if retval is None:
			retval = set()

		# Iterate through children
		for child in self.children:
			child.fold(attr, key, retval, type_)

		# Filter on type
		if type_ and type_ != self.type:
			return retval

		# Get attribute
		at = getattr(self, attr)
		if not at:
			return retval

		# Get value
		value = at if key is None else at.get(key)
		if isinstance(value, list):
			retval |= set(value)
		elif value:
			retval.add(value)

		return retval

	def get(self, key: str, default=None):
		return self.meta.get(key, default)

	def validate(self):
		for child in self.children:
			child.validate()

	def get_supported_languages(self) -> set[str]:
		ret = set()
		for name in glob.glob(f"{self.baseDir}/**/locale/*.*.tr", recursive=True):
			parts = os.path.basename(name).split(".")
			ret.add(parts[-2])

		return ret

	def get_translations(self, textdomain: str) -> list[Translation]:
		ret = []

		for name in glob.glob(f"{self.baseDir}/**/locale/{textdomain}.*.tr", recursive=True):
			try:
				ret.append(parse_tr(name))
			except SyntaxError as e:
				relative_path = os.path.join(self.relative, os.path.relpath(name, self.baseDir))
				raise MinetestCheckError(f"Syntax error whilst reading {relative_path}: {e}")

		return ret