mirror of
https://github.com/Ryujinx/ryuko-ng.git
synced 2024-12-23 09:05:33 +00:00
8550271af6
* Add log reading capabilities - User hardware specs - Game info - Controller configuration - Last error snippet in log - Warnings when using macOS or Intel iGPU - Warning of logs not turned on * Allowed log reading channels moved to config This is easier for contributors to change their config file for testing * Fixes large files not showing error snippet - Large files are partially downloaded and show header information which messes with log analysis, this gets stripped. - Finding error messages function improved * Default logs enabled shows a green checkmark * Better feedback with log parsing message - Bot prints `Log parsing...` and update message once log analysis done - Added better error logging to console * Better handling of invalid files warning - Also fixed typo with bot message edit function * Refactored embed generation to make more sense - Embed is now based off a generic json assuming Unknown values at first - Embed fields moved closer together - Fields with newlines joined instead of manually separated - Intel iGPU message changed to show preference for discrete GPU's * Refactor to be simpler and easier to read. - Hardware, ryujinx and log analysis split into separate functions - Regex explicitly defined for each property instead of confusing map - Added user settings reported, shows PPTC enabled or disabled * Game notes sorted by order of severity Notes will appear with most severe warnings first as follows: ❌ ⚠️ ℹ ✅ * Analyses toggleable settings that appear in log Currently these are: PPTC, audio backed, docked/handheld and vsync. - Formatting change so these settings are more visible in bot embed * Refactored user_settings, rewording of bot embed - User settings reading handles missing log info for older versions - `Switch Mode` (docked/handheld info) changed to `Console Mode` - Missing firmware warning if firmware not installed * Warning when shader cache collision detected * Notes time elapsed in log file - Error handling for no notes to log * Show values for some user settings: audio, docked, missing services, resolution, shader cache and vsync * Analyse user changeable settings - Restructed embed to allow easier settings handling - Changed embed formatting to deal with inline colums more cleanly * Log file is now default function parameter * Better sorting of analysis messages - Now sorted alphabetically and by severity for consistency - Show available RAM in low RAM warning - Fix variable name misspelling * Logging level changed to info * Warn if bad dump in error message * Add warning for no custom build support * Warn user to post log in correct channel - Warn about not supporting custom builds - Warn to post in pr build if detected - Warn about channels to post logs if detected in #general
541 lines
24 KiB
Python
541 lines
24 KiB
Python
import logging
|
||
import re
|
||
|
||
import aiohttp
|
||
import config
|
||
import discord
|
||
from discord.ext.commands import Cog
|
||
|
||
logging.basicConfig(
|
||
format="%(asctime)s (%(levelname)s) %(message)s (Line %(lineno)d)",
|
||
level=logging.INFO,
|
||
)
|
||
|
||
|
||
class LogFileReader(Cog):
|
||
def __init__(self, bot):
|
||
self.bot = bot
|
||
# Allows log analysis in #support and #patreon-support channels respectively
|
||
self.bot_log_allowed_channels = config.bot_log_allowed_channels
|
||
self.uploaded_log_filenames = []
|
||
|
||
async def download_file(self, log_url):
|
||
async with aiohttp.ClientSession() as session:
|
||
# Grabs first and last few bytes of log file to prevent abuse from large files
|
||
headers = {"Range": "bytes=0-25000, -6000"}
|
||
async with session.get(log_url, headers=headers) as response:
|
||
return await response.text("UTF-8")
|
||
|
||
async def log_file_read(self, message):
|
||
self.embed = {
|
||
"hardware_info": {
|
||
"cpu": "Unknown",
|
||
"gpu": "Unknown",
|
||
"ram": "Unknown",
|
||
"os": "Unknown",
|
||
},
|
||
"emu_info": {
|
||
"ryu_version": "Unknown",
|
||
"ryu_firmware": "Unknown",
|
||
"logs_enabled": None,
|
||
},
|
||
"game_info": {
|
||
"game_name": "Unknown",
|
||
"errors": "No errors found in log",
|
||
"mods": "No mods found",
|
||
"notes": [],
|
||
},
|
||
"settings": {
|
||
"audio_backend": "Unknown",
|
||
"docked": "Unknown",
|
||
"ignore_missing_services": "Unknown",
|
||
"pptc": "Unknown",
|
||
"shader_cache": "Unknown",
|
||
"vsync": "Unknown",
|
||
"resolution_scale": "Unknown",
|
||
"anisotropic_filtering": "Unknown",
|
||
"aspect_ratio": "Unknown",
|
||
},
|
||
}
|
||
attached_log = message.attachments[0]
|
||
author_name = f"@{message.author.name}"
|
||
log_file = await self.download_file(attached_log.url)
|
||
# Large files show a header value when not downloaded completely
|
||
# this regex makes sure that the log text to read starts from the first timestamp, ignoring headers
|
||
log_file_header_regex = re.compile(r"\d{2}:\d{2}:\d{2}\.\d{3}.*", re.DOTALL)
|
||
log_file = re.search(log_file_header_regex, log_file).group(0)
|
||
|
||
def get_hardware_info(log_file=log_file):
|
||
try:
|
||
self.embed["hardware_info"]["cpu"] = (
|
||
re.search(r"CPU:\s([^;\r]*)", log_file, re.MULTILINE)
|
||
.group(1)
|
||
.rstrip()
|
||
)
|
||
self.embed["hardware_info"]["ram"] = (
|
||
re.search(r"RAM:(\sTotal)?\s([^;\r]*)", log_file, re.MULTILINE)
|
||
.group(2)
|
||
.rstrip()
|
||
)
|
||
self.embed["hardware_info"]["os"] = (
|
||
re.search(r"Operating System:\s([^;\r]*)", log_file, re.MULTILINE)
|
||
.group(1)
|
||
.rstrip()
|
||
)
|
||
self.embed["hardware_info"]["gpu"] = (
|
||
re.search(
|
||
r"PrintGpuInformation:\s([^;\r]*)", log_file, re.MULTILINE
|
||
)
|
||
.group(1)
|
||
.rstrip()
|
||
)
|
||
except AttributeError:
|
||
pass
|
||
|
||
def get_ryujinx_info(log_file=log_file):
|
||
try:
|
||
self.embed["emu_info"]["ryu_version"] = [
|
||
line.split()[-1]
|
||
for line in log_file.splitlines()
|
||
if "Ryujinx Version:" in line
|
||
][0]
|
||
self.embed["emu_info"]["logs_enabled"] = (
|
||
re.search(r"Logs Enabled:\s([^;\r]*)", log_file, re.MULTILINE)
|
||
.group(1)
|
||
.rstrip()
|
||
)
|
||
self.embed["emu_info"]["ryu_firmware"] = [
|
||
line.split()[-1]
|
||
for line in log_file.splitlines()
|
||
if "Firmware Version:" in line
|
||
][0]
|
||
except (AttributeError, IndexError):
|
||
pass
|
||
|
||
def format_log_embed():
|
||
cleaned_game_name = re.sub(
|
||
r"\s\[(64|32)-bit\]$", "", self.embed["game_info"]["game_name"]
|
||
)
|
||
self.embed["game_info"]["game_name"] = cleaned_game_name
|
||
|
||
hardware_info = " | ".join(
|
||
(
|
||
f"**CPU:** {self.embed['hardware_info']['cpu']}",
|
||
f"**GPU:** {self.embed['hardware_info']['gpu']}",
|
||
f"**RAM:** {self.embed['hardware_info']['ram']}",
|
||
f"**OS:** {self.embed['hardware_info']['os']}",
|
||
)
|
||
)
|
||
|
||
system_settings_info = "\n".join(
|
||
(
|
||
f"**Audio Backend:** `{self.embed['settings']['audio_backend']}`",
|
||
f"**Console Mode:** `{self.embed['settings']['docked']}`",
|
||
f"**PPTC:** `{self.embed['settings']['pptc']}`",
|
||
f"**V-Sync:** `{self.embed['settings']['vsync']}`",
|
||
)
|
||
)
|
||
|
||
graphics_settings_info = "\n".join(
|
||
(
|
||
f"**Resolution:** `{self.embed['settings']['resolution_scale']}`",
|
||
f"**Anisotropic Filtering:** `{self.embed['settings']['anisotropic_filtering']}`",
|
||
f"**Aspect Ratio:** `{self.embed['settings']['aspect_ratio']}`",
|
||
)
|
||
)
|
||
|
||
ryujinx_info = " | ".join(
|
||
(
|
||
f"**Version:** {self.embed['emu_info']['ryu_version']}",
|
||
f"**Firmware:** {self.embed['emu_info']['ryu_firmware']}",
|
||
)
|
||
)
|
||
|
||
log_embed = discord.Embed(
|
||
title=f"{cleaned_game_name}", colour=discord.Colour(0x4A90E2)
|
||
)
|
||
log_embed.set_footer(text=f"Log uploaded by {author_name}")
|
||
log_embed.add_field(
|
||
name="General Info",
|
||
value=" | ".join((ryujinx_info, hardware_info)),
|
||
inline=False,
|
||
)
|
||
if cleaned_game_name == "Unknown":
|
||
log_embed.add_field(
|
||
name="Empty Log",
|
||
value="""This log file appears to be empty. To get a proper log, follow these steps:
|
||
\n 1) Start a game up.
|
||
\n 2) Play until your issue occurs.
|
||
\n 3) Upload your log file.""",
|
||
inline=False,
|
||
)
|
||
log_embed.add_field(
|
||
name="System Settings",
|
||
value=system_settings_info,
|
||
inline=True,
|
||
)
|
||
log_embed.add_field(
|
||
name="Graphics Settings",
|
||
value=graphics_settings_info,
|
||
inline=True,
|
||
)
|
||
log_embed.add_field(
|
||
name="Latest Error Snippet",
|
||
value=self.embed["game_info"]["errors"],
|
||
inline=False,
|
||
)
|
||
log_embed.add_field(
|
||
name="Mods", value=self.embed["game_info"]["mods"], inline=False
|
||
)
|
||
|
||
try:
|
||
notes_value = "\n".join(game_notes)
|
||
except TypeError:
|
||
notes_value = "Nothing to note"
|
||
log_embed.add_field(
|
||
name="Notes",
|
||
value=notes_value,
|
||
inline=False,
|
||
)
|
||
|
||
return log_embed
|
||
|
||
def analyse_log(log_file=log_file):
|
||
try:
|
||
self.embed["game_info"]["game_name"] = (
|
||
re.search(
|
||
r"Loader LoadNca: Application Loaded:\s([^;\r]*)",
|
||
log_file,
|
||
re.MULTILINE,
|
||
)
|
||
.group(1)
|
||
.rstrip()
|
||
)
|
||
for setting_name in self.embed["settings"]:
|
||
# Some log info may be missing for users that use older versions of Ryujinx, so reading the settings is not always possible.
|
||
# As settings are initialized with "Unknown" values, False should not be an issue for setting.get()
|
||
def get_setting(name, setting_string, log_file=log_file):
|
||
setting = self.embed["settings"]
|
||
setting_value = [
|
||
line.split()[-1]
|
||
for line in log_file.splitlines()
|
||
if f"LogValueChange: {setting_string}" in line
|
||
][-1]
|
||
if setting_value and setting.get(name):
|
||
setting[name] = setting_value
|
||
if name == "docked":
|
||
setting[
|
||
name
|
||
] = f"{'Docked' if setting_value == 'True' else 'Handheld'}"
|
||
if name == "resolution_scale":
|
||
resolution_map = {
|
||
"-1": "Custom",
|
||
"1": "Native (720p/1080p)",
|
||
"2": "2x (1440p/2160p)",
|
||
"3": "3x (2160p/31240p)",
|
||
"4": "4x (2880p/4320p)",
|
||
}
|
||
setting[name] = resolution_map[setting_value]
|
||
if name == "anisotropic_filtering":
|
||
anisotropic_map = {
|
||
"-1": "Auto",
|
||
"2": "2x",
|
||
"4": "4x",
|
||
"8": "8x",
|
||
"16": "16x",
|
||
}
|
||
setting[name] = anisotropic_map[setting_value]
|
||
if name == "aspect_ratio":
|
||
aspect_map = {
|
||
"Fixed4x3": "4:3",
|
||
"Fixed16x9": "16:9",
|
||
"Fixed16x10": "16:10",
|
||
"Fixed21x9": "21:9",
|
||
"Fixed32x9": "32:9",
|
||
"Stretched": "Stretch to Fit Window",
|
||
}
|
||
setting[name] = aspect_map[setting_value]
|
||
if name in [
|
||
"ignore_missing_services",
|
||
"pptc",
|
||
"shader_cache",
|
||
"vsync",
|
||
]:
|
||
setting[
|
||
name
|
||
] = f"{'Enabled' if setting_value == 'True' else 'Disabled'}"
|
||
return setting[name]
|
||
|
||
setting_map = {
|
||
"anisotropic_filtering": "MaxAnisotropy",
|
||
"aspect_ratio": "AspectRatio",
|
||
"audio_backend": "AudioBackend",
|
||
"docked": "EnableDockedMode",
|
||
"ignore_missing_services": "IgnoreMissingServices",
|
||
"pptc": "EnablePtc",
|
||
"resolution_scale": "ResScale",
|
||
"shader_cache": "EnableShaderCache",
|
||
"vsync": "EnableVsync",
|
||
}
|
||
try:
|
||
self.embed[setting_name] = get_setting(
|
||
setting_name, setting_map[setting_name], log_file=log_file
|
||
)
|
||
except (AttributeError, IndexError) as error:
|
||
print(
|
||
f"Settings exception: {setting_name}: {type(error).__name__}"
|
||
)
|
||
continue
|
||
|
||
def analyse_error_message(log_file=log_file):
|
||
try:
|
||
errors = []
|
||
curr_error_lines = []
|
||
for line in log_file.splitlines():
|
||
if line == "":
|
||
continue
|
||
if "|E|" in line:
|
||
curr_error_lines = [line]
|
||
errors.append(curr_error_lines)
|
||
elif line[0] == " " or line == "":
|
||
curr_error_lines.append(line)
|
||
|
||
def error_search(search_term):
|
||
found_term = bool(
|
||
[
|
||
line
|
||
for line in errors
|
||
if any(search_term in string for string in line)
|
||
]
|
||
)
|
||
return found_term
|
||
|
||
shader_cache_collision = error_search("Cache collision found")
|
||
dump_hash_warning = error_search("ResultFsInvalidIvfcHash")
|
||
last_errors = "\n".join(
|
||
errors[-1][:2] if "|E|" in errors[-1][0] else ""
|
||
)
|
||
except IndexError:
|
||
last_errors = None
|
||
return (last_errors, shader_cache_collision, dump_hash_warning)
|
||
|
||
# Finds the lastest error denoted by |E| in the log and its first line
|
||
# Also warns of shader cache collisions
|
||
(
|
||
last_error_snippet,
|
||
shader_cache_warn,
|
||
dump_hash_warning,
|
||
) = analyse_error_message()
|
||
if last_error_snippet:
|
||
self.embed["game_info"]["errors"] = f"```{last_error_snippet}```"
|
||
else:
|
||
pass
|
||
|
||
if shader_cache_warn:
|
||
shader_cache_warn = f"⚠️ Cache collision detected. Investigate possible shader cache issues"
|
||
self.embed["game_info"]["notes"].append(shader_cache_warn)
|
||
|
||
if dump_hash_warning:
|
||
dump_hash_warning = f"⚠️ Dump error detected. Investigate possible bad ROM dump issues"
|
||
self.embed["game_info"]["notes"].append(dump_hash_warning)
|
||
|
||
timestamp_regex = re.compile(r"\d{2}:\d{2}:\d{2}\.\d{3}")
|
||
latest_timestamp = re.findall(timestamp_regex, log_file)[-1]
|
||
if latest_timestamp:
|
||
timestamp_message = f"ℹ️ Time elapsed in log: `{latest_timestamp}`"
|
||
self.embed["game_info"]["notes"].append(timestamp_message)
|
||
|
||
def mods_information(log_file=log_file):
|
||
mods_regex = re.compile(r"Found mod\s\'(.+?)\'\s(\[.+?\])")
|
||
matches = re.findall(mods_regex, log_file)
|
||
if matches:
|
||
mods = [
|
||
{"mod": match[0], "status": match[1]} for match in matches
|
||
]
|
||
mods_status = [
|
||
f"ℹ️ {i['mod']} ({'ExeFS' if i['status'] == '[E]' else 'RomFS'})"
|
||
for i in mods
|
||
]
|
||
return mods_status
|
||
|
||
# Find information on installed mods
|
||
game_mods = mods_information()
|
||
if game_mods:
|
||
self.embed["game_info"]["mods"] = "\n".join(game_mods)
|
||
else:
|
||
pass
|
||
|
||
controllers_regex = re.compile(r"Hid Configure: ([^\r\n]+)")
|
||
controllers = re.findall(controllers_regex, log_file)
|
||
if controllers:
|
||
input_status = [f"ℹ {match}" for match in controllers]
|
||
# Hid Configure lines can appear multiple times, so converting to dict keys removes duplicate entries,
|
||
# also maintains the list order
|
||
input_status = list(dict.fromkeys(input_status))
|
||
input_string = "\n".join(input_status)
|
||
else:
|
||
input_string = "⚠️ No controller information found"
|
||
self.embed["game_info"]["notes"].append(input_string)
|
||
|
||
try:
|
||
ram_available_regex = re.compile(r"Available\s(\d+)(?=\sMB)")
|
||
ram_available = re.search(ram_available_regex, log_file)[1]
|
||
if int(ram_available) < 8000:
|
||
ram_warning = (
|
||
f"⚠️ Less than 8GB RAM available ({str(ram_available)} MB)"
|
||
)
|
||
self.embed["game_info"]["notes"].append(ram_warning)
|
||
except TypeError:
|
||
pass
|
||
|
||
if "Darwin" in self.embed["hardware_info"]["os"]:
|
||
mac_os_warning = "**❌ macOS is currently unsupported**"
|
||
self.embed["game_info"]["notes"].append(mac_os_warning)
|
||
|
||
if "Intel" in self.embed["hardware_info"]["gpu"]:
|
||
if (
|
||
"Darwin" in self.embed["hardware_info"]["os"]
|
||
or "Windows" in self.embed["hardware_info"]["os"]
|
||
):
|
||
intel_gpu_warning = "**⚠️ Intel iGPUs are known to have driver issues, consider using a discrete GPU**"
|
||
self.embed["game_info"]["notes"].append(intel_gpu_warning)
|
||
try:
|
||
# Find information on logs, whether defaults are enabled or not
|
||
default_logs = ["Info", "Warning", "Error", "Guest", "Stub"]
|
||
user_logs = (
|
||
self.embed["emu_info"]["logs_enabled"]
|
||
.rstrip()
|
||
.replace(" ", "")
|
||
.split(",")
|
||
)
|
||
disabled_logs = set(default_logs).difference(set(user_logs))
|
||
if disabled_logs:
|
||
logs_status = [
|
||
f"⚠️ {log} log is not enabled" for log in disabled_logs
|
||
]
|
||
log_string = "\n".join(logs_status)
|
||
else:
|
||
log_string = "✅ Default logs enabled"
|
||
self.embed["game_info"]["notes"].append(log_string)
|
||
except AttributeError:
|
||
pass
|
||
|
||
if self.embed["emu_info"]["ryu_firmware"] == "Unknown":
|
||
firmware_warning = f"**❌ Nintendo Switch firmware not found**"
|
||
self.embed["game_info"]["notes"].append(firmware_warning)
|
||
|
||
mainline_version = re.compile(r"^\d\.\d\.(\d){4}$")
|
||
pr_version = re.compile(r"^\d\.\d\.\d\+([a-f]|\d){7}$")
|
||
ldn_version = re.compile(r"^\d\.\d\.\d\-ldn\d\.\d$")
|
||
|
||
if (
|
||
message.channel.id == config.bot_log_allowed_channels["support"]
|
||
or message.channel.id
|
||
== config.bot_log_allowed_channels["patreon-support"]
|
||
):
|
||
if re.match(pr_version, self.embed["emu_info"]["ryu_version"]):
|
||
pr_version_warning = f"**⚠️ PR build logs should be posted in <#{config.bot_log_allowed_channels['pr-testing']}>**"
|
||
self.embed["game_info"]["notes"].append(pr_version_warning)
|
||
|
||
if not (
|
||
re.match(
|
||
mainline_version, self.embed["emu_info"]["ryu_version"]
|
||
)
|
||
or re.match(ldn_version, self.embed["emu_info"]["ryu_version"])
|
||
or re.match(pr_version, self.embed["emu_info"]["ryu_version"])
|
||
or re.match("Unknown", self.embed["emu_info"]["ryu_version"])
|
||
):
|
||
custom_firmware_warning = (
|
||
"**⚠️ Custom builds are not officially supported**"
|
||
)
|
||
self.embed["game_info"]["notes"].append(custom_firmware_warning)
|
||
|
||
def severity(log_note_string):
|
||
symbols = ["❌", "⚠️", "ℹ", "✅"]
|
||
return next(
|
||
i
|
||
for i, symbol in enumerate(symbols)
|
||
if symbol in log_note_string
|
||
)
|
||
|
||
game_notes = [note for note in self.embed["game_info"]["notes"]]
|
||
# Warnings split on the string after the warning symbol for alphabetical ordering
|
||
# Severity key then orders alphabetically sorted warnings to show most severe first
|
||
ordered_game_notes = sorted(
|
||
sorted(game_notes, key=lambda x: x.split()[1]), key=severity
|
||
)
|
||
return ordered_game_notes
|
||
except AttributeError:
|
||
pass
|
||
|
||
get_hardware_info()
|
||
get_ryujinx_info()
|
||
game_notes = analyse_log()
|
||
|
||
return format_log_embed()
|
||
|
||
@Cog.listener()
|
||
async def on_message(self, message):
|
||
await self.bot.wait_until_ready()
|
||
if message.author.bot:
|
||
return
|
||
try:
|
||
author_mention = message.author.mention
|
||
filename = message.attachments[0].filename
|
||
# Any message over 2000 chars is uploaded as message.txt, so this is accounted for
|
||
log_file_regex = re.compile(r"^Ryujinx_.*\.log|message\.txt$")
|
||
is_log_file = re.match(log_file_regex, filename)
|
||
if (
|
||
message.channel.id in self.bot_log_allowed_channels.values()
|
||
and is_log_file
|
||
):
|
||
if filename not in self.uploaded_log_filenames:
|
||
reply_message = await message.channel.send(
|
||
"Log detected, parsing..."
|
||
)
|
||
try:
|
||
embed = await self.log_file_read(message)
|
||
if "Ryujinx_" in filename:
|
||
self.uploaded_log_filenames.append(filename)
|
||
# Avoid duplicate log file analysis, at least temporarily; keep track of the last few filenames of uploaded logs
|
||
# this should help support channels not be flooded with too many log files
|
||
# fmt: off
|
||
self.uploaded_log_filenames = self.uploaded_log_filenames[-5:]
|
||
# fmt: on
|
||
return await reply_message.edit(content=None, embed=embed)
|
||
except UnicodeDecodeError:
|
||
return await message.channel.send(
|
||
f"This log file appears to be invalid {author_mention}. Please re-check and re-upload your log file."
|
||
)
|
||
except Exception as error:
|
||
await reply_message.edit(
|
||
content=f"Error: Couldn't parse log; parser threw {type(error).__name__} exception."
|
||
)
|
||
print(logging.warn(error))
|
||
else:
|
||
await message.channel.send(
|
||
f"The log file `{filename}` appears to be a duplicate {author_mention}. Please upload a more recent file."
|
||
)
|
||
elif not is_log_file:
|
||
return await message.channel.send(
|
||
f"{author_mention} Your file does not match the Ryujinx log format. Please check your file."
|
||
)
|
||
else:
|
||
return await message.channel.send(
|
||
"\n".join(
|
||
(
|
||
f"{author_mention} Please upload log files to the correct location:\n",
|
||
f'<#{config.bot_log_allowed_channels["support"]}>: General help and troubleshooting',
|
||
f'<#{config.bot_log_allowed_channels["patreon-suport"]}>: Help and troubleshooting for Patreon subscribers',
|
||
f'<#{config.bot_log_allowed_channels["development"]}>: Ryujinx development discussion',
|
||
f'<#{config.bot_log_allowed_channels["pr-testing"]}>: Discussion of in-progress pull request builds',
|
||
)
|
||
)
|
||
)
|
||
except IndexError:
|
||
pass
|
||
|
||
|
||
async def setup(bot):
|
||
await bot.add_cog(LogFileReader(bot))
|