OpenRA/OpenRA.Mods.Common/Lint/CheckTranslationReference.cs

#region Copyright & License Information
/*
 * Copyright 2007-2022 The OpenRA Developers (see AUTHORS)
 * This file is part of OpenRA, which is free software. It is made
 * available to you under the terms of the GNU General Public License
 * as published by the Free Software Foundation, either version 3 of
 * the License, or (at your option) any later version. For more
 * information, see COPYING.
 */
#endregion

using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Reflection;
using Linguini.Syntax.Ast;
using Linguini.Syntax.Parser;
using OpenRA.Traits;

namespace OpenRA.Mods.Common.Lint
{
	class CheckTranslationReference : ILintPass
	{
		const BindingFlags Binding = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static;

		readonly List<string> referencedKeys = new List<string>();
		readonly Dictionary<string, string[]> referencedVariablesPerKey = new Dictionary<string, string[]>();
		readonly List<string> variableReferences = new List<string>();

		void ILintPass.Run(Action<string> emitError, Action<string> emitWarning, ModData modData)
		{
			// TODO: Check all available languages
			var language = "en";
			Console.WriteLine($"Testing translation: {language}");
			var translation = new Translation(language, modData.Manifest.Translations, modData.DefaultFileSystem);

			foreach (var actorInfo in modData.DefaultRules.Actors)
			{
				foreach (var traitInfo in actorInfo.Value.TraitInfos<TraitInfo>())
				{
					var fields = traitInfo.GetType().GetFields();
					foreach (var field in fields)
					{
						var translationReference = field.GetCustomAttributes<TranslationReferenceAttribute>(true).FirstOrDefault();
						if (translationReference == null)
							continue;

						var keys = LintExts.GetFieldValues(traitInfo, field);
						foreach (var key in keys)
						{
							if (!translation.HasMessage(key))
								emitError($"{key} not present in {language} translation.");

							referencedKeys.Add(key);
						}
					}
				}
			}

			var gameSpeeds = modData.Manifest.Get<GameSpeeds>();
			foreach (var speed in gameSpeeds.Speeds.Values)
			{
				if (!translation.HasMessage(speed.Name))
					emitError($"{speed.Name} not present in {language} translation.");

				referencedKeys.Add(speed.Name);
			}

			foreach (var modType in modData.ObjectCreator.GetTypes())
			{
				foreach (var fieldInfo in modType.GetFields(Binding).Where(m => m.HasAttribute<TranslationReferenceAttribute>()))
				{
					if (fieldInfo.FieldType != typeof(string))
						emitError($"Translation attribute on non string field {fieldInfo.Name}.");

					if (fieldInfo.IsInitOnly)
						continue;

					var key = (string)fieldInfo.GetValue(string.Empty);
					if (!translation.HasMessage(key))
						emitError($"{key} not present in {language} translation.");

					var translationReference = fieldInfo.GetCustomAttributes<TranslationReferenceAttribute>(true)[0];
					if (translationReference.RequiredVariableNames != null && translationReference.RequiredVariableNames.Length > 0)
						referencedVariablesPerKey.GetOrAdd(key, translationReference.RequiredVariableNames);

					referencedKeys.Add(key);
				}
			}

			foreach (var file in modData.Manifest.Translations)
			{
				var stream = modData.DefaultFileSystem.Open(file);
				using (var reader = new StreamReader(stream))
				{
					var parser = new LinguiniParser(reader);
					var result = parser.Parse();

					foreach (var entry in result.Entries)
					{
						// Don't flag definitions referenced (only) within the .ftl definitions as unused
						if (entry.GetType() == typeof(AstTerm))
							continue;

						variableReferences.Clear();
						var key = entry.GetId();

						if (entry is AstMessage message)
						{
							var hasAttributes = message.Attributes.Count > 0;

							if (!hasAttributes)
							{
								CheckUnusedKey(key, null, emitWarning, file);
								CheckMessageValue(message.Value, key, null, emitWarning, file);
								CheckMissingVariable(key, null, emitError, file);
							}
							else
							{
								foreach (var attribute in message.Attributes)
								{
									var attrName = attribute.Id.Name.ToString();

									CheckUnusedKey(key, attrName, emitWarning, file);
									CheckMessageValue(attribute.Value, key, attrName, emitWarning, file);
									CheckMissingVariable(key, attrName, emitError, file);
								}
							}
						}
					}
				}
			}
		}

		void CheckUnusedKey(string key, string attribute, Action<string> emitWarning, string file)
		{
			var isAttribute = !string.IsNullOrEmpty(attribute);
			var keyWithAtrr = isAttribute ? $"{key}.{attribute}" : key;

			if (!referencedKeys.Contains(keyWithAtrr))
				emitWarning(isAttribute ?
					$"Unused attribute `{attribute}` of key `{key}` in {file}." :
					$"Unused key `{key}` in {file}.");
		}

		void CheckMessageValue(Pattern node, string key, string attribute, Action<string> emitWarning, string file)
		{
			foreach (var element in node.Elements)
			{
				if (element is Placeable placeable)
				{
					var expression = placeable.Expression;
					if (expression is IInlineExpression inlineExpression)
						if (inlineExpression is VariableReference variableReference)
							CheckVariableReference(variableReference.Id.Name.ToString(), key, attribute, emitWarning, file);

					if (expression is SelectExpression selectExpression)
					{
						foreach (var variant in selectExpression.Variants)
						{
							foreach (var variantElement in variant.Value.Elements)
							{
								if (variantElement is Placeable variantPlaceable)
								{
									var variantExpression = variantPlaceable.Expression;
									if (variantExpression is IInlineExpression variantInlineExpression)
										if (variantInlineExpression is VariableReference variantVariableReference)
											CheckVariableReference(variantVariableReference.Id.Name.ToString(), key, attribute, emitWarning, file);
								}
							}
						}
					}
				}
			}
		}

		void CheckMissingVariable(string key, string attribute, Action<string> emitError, string file)
		{
			var isAttribute = !string.IsNullOrEmpty(attribute);
			var keyWithAtrr = isAttribute ? $"{key}.{attribute}" : key;

			if (!referencedVariablesPerKey.ContainsKey(keyWithAtrr))
				return;

			foreach (var referencedVariable in referencedVariablesPerKey[keyWithAtrr])
				if (!variableReferences.Contains(referencedVariable))
					emitError(isAttribute ?
						$"Missing variable `{referencedVariable}` for attribute `{attribute}` of key `{key}` in {file}." :
						$"Missing variable `{referencedVariable}` for key `{key}` in {file}.");
		}

		void CheckVariableReference(string varName, string key, string attribute, Action<string> emitWarning, string file)
		{
			var isAttribute = !string.IsNullOrEmpty(attribute);
			var keyWithAtrr = isAttribute ? $"{key}.{attribute}" : key;

			variableReferences.Add(varName);

			if (!referencedVariablesPerKey.ContainsKey(keyWithAtrr) || !referencedVariablesPerKey[keyWithAtrr].Contains(varName))
				emitWarning(isAttribute ?
					$"Unused variable `{varName}` for attribute `{attribute}` of key `{key}` in {file}." :
					$"Unused variable `{varName}` for key `{key}` in {file}.");
		}
	}
}