Skip to content

Exclude self from offline TMPE mod check #400

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Jul 2, 2019
Merged

Exclude self from offline TMPE mod check #400

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
87eda10
Attempting to exclude self from offline TMPE mod check
originalfoo Jul 1, 2019
b8ec7fa
Use `ModuleVersionId` Guid instead of build
originalfoo Jul 1, 2019
c92d05b
Fixed method name typo
originalfoo Jul 1, 2019
c50f096
Improved logging
originalfoo Jul 1, 2019
095cd0f
Include mod path in logging of skipped local builds
originalfoo Jul 1, 2019
a9a03aa
Detect _any_ other version of TM:PE, regardless of online vs. offline
originalfoo Jul 1, 2019
49db07c
Minor code cleanup
originalfoo Jul 2, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions TLM/TLM/TrafficManagerMod.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
using CSUtil.Commons;
using ICities;
using System.Reflection;
using System.Runtime.CompilerServices;
using ColossalFramework;
using ColossalFramework.UI;
using TrafficManager.State;
using TrafficManager.Util;
using UnityEngine;

namespace TrafficManager {
public class TrafficManagerMod : IUserMod {
Expand All @@ -32,8 +29,9 @@ public class TrafficManagerMod : IUserMod {

public string Description => "Manage your city's traffic";

public void OnEnabled() {
public void OnEnabled() {
Log.Info($"TM:PE enabled. Version {Version}, Build {Assembly.GetExecutingAssembly().GetName().Version} {Branch} for game version {GameVersionA}.{GameVersionB}.{GameVersionC}-f{GameVersionBuild}");
Log.Info($"Enabled TM:PE has GUID {Assembly.GetExecutingAssembly().ManifestModule.ModuleVersionId}");

// check for incompatible mods
if (UIView.GetAView() != null) { // when TM:PE is enabled in content manager
Expand Down
94 changes: 33 additions & 61 deletions TLM/TLM/Util/ModsCompatibilityChecker.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
using ColossalFramework;
#if !DEBUG
using ColossalFramework.PlatformServices; // used in RELEASE builds
#endif
using ColossalFramework.Plugins;
using ColossalFramework.UI;
using CSUtil.Commons;
Expand All @@ -18,19 +15,18 @@ namespace TrafficManager.Util
{
public class ModsCompatibilityChecker
{

public const ulong LOCAL_MOD = ulong.MaxValue;

// Used for LoadIncompatibleModsList()
private const string RESOURCES_PREFIX = "TrafficManager.Resources.";
private const string INCOMPATIBLE_MODS_FILE = "incompatible_mods.txt";

// parsed contents of incompatible_mods.txt
private readonly Dictionary<ulong, string> incompatibleMods;
private readonly Dictionary<ulong, string> knownIncompatibleMods;

public ModsCompatibilityChecker()
{
incompatibleMods = LoadListOfIncompatibleMods();
knownIncompatibleMods = LoadListOfIncompatibleMods();
}

/// <summary>
Expand All @@ -42,7 +38,7 @@ public void PerformModCheck()
{
Dictionary<PluginInfo, string> detected = ScanForIncompatibleMods();

if (detected.Count > 0 && State.GlobalConfig.Instance.Main.ScanForKnownIncompatibleModsAtStartup)
if (detected.Count > 0)
{
IncompatibleModsPanel panel = UIView.GetAView().AddUIComponent(typeof(IncompatibleModsPanel)) as IncompatibleModsPanel;
panel.IncompatibleMods = detected;
Expand All @@ -53,54 +49,61 @@ public void PerformModCheck()
}
catch (Exception e)
{
Log.Info("Something went wrong while checking incompatible mods - see main game log for details.");
Debug.LogException(e);
}
}

/// <summary>
/// Iterates installed mods looking for known incompatibilities.
/// </summary>
///
///
/// <returns>A list of detected incompatible mods.</returns>
///
/// <exception cref="ArgumentException">Invalid folder path (contains invalid characters, is empty, or contains only white spaces).</exception>
/// <exception cref="PathTooLongException">Path is too long (longer than the system-defined maximum length).</exception>
public Dictionary<PluginInfo, string> ScanForIncompatibleMods()
{
Log.Info("Scanning for incompatible mods");
Guid selfGuid = Assembly.GetExecutingAssembly().ManifestModule.ModuleVersionId;

Log.Info($"Scanning for incompatible mods; My GUID = {selfGuid}");

// list of installed incompatible mods
Dictionary<PluginInfo, string> results = new Dictionary<PluginInfo, string>();

// only check enabled mods?
bool filterToEnabled = State.GlobalConfig.Instance.Main.IgnoreDisabledMods;

#if !DEBUG
bool offline = IsOffline();
#endif

// iterate plugins
foreach (PluginInfo mod in Singleton<PluginManager>.instance.GetPluginsInfo())
{
if (!mod.isBuiltin && !mod.isCameraScript && (!filterToEnabled || mod.isEnabled))
{
string modName = GetModName(mod);
ulong workshopID = mod.publishedFileID.AsUInt64;

if (incompatibleMods.ContainsKey(mod.publishedFileID.AsUInt64))
if (knownIncompatibleMods.ContainsKey(workshopID))
{
Log.Info($"Incompatible mod: {mod.publishedFileID.AsUInt64} - {modName}");
// must be online workshop mod
Log.Info($"Incompatible with: {workshopID} - {modName}");
results.Add(mod, modName);
}
#if !DEBUG
// Workshop TM:PE builds treat local builds as incompatible
else if (!offline && mod.publishedFileID.AsUInt64 == LOCAL_MOD && (modName.Contains("TM:PE") || modName.Contains("Traffic Manager")))
else if (modName.Contains("TM:PE") || modName.Contains("Traffic Manager"))
{
Log.Info($"Local TM:PE detected: '{modName}' in '{mod.modPath}'");
string folder = Path.GetFileName(mod.modPath);
//string folder = mod.modPath.Split(Path.DirectorySeparatorChar).Last();
results.Add(mod, $"{modName} in /{folder}");
// It's a TM:PE build - either local or workshop
string workshopIDstr = workshopID == LOCAL_MOD ? "LOCAL" : workshopID.ToString();
Guid currentGuid = GetModGuid(mod);

if (currentGuid == selfGuid)
{
Log.Info($"Found myself: '{modName}' (Workshop ID: {workshopIDstr}, GUID: {currentGuid}) in '{mod.modPath}'");
}
else
{
Log.Info($"Detected conflicting '{modName}' (Workshop ID: {workshopIDstr}, GUID: {currentGuid}) in '{mod.modPath}'");
results.Add(mod, $"{modName} in /{Path.GetFileName(mod.modPath)}");
}
}
#endif
}
}

Expand All @@ -124,37 +127,16 @@ public string GetModName(PluginInfo plugin)
}

/// <summary>
/// Works out if the game is effectively running in offline mode, in which no workshop mod subscriptions will be active.
///
/// Applicalbe "offline" states include:
///
/// * Origin plaform service (no support for Steam workshop)
/// * Steam (or other platform service) not active
/// * --noWorkshop launch option
///
/// This is allows LABS and STABLE builds to be used offline without trying to delete themselves.
/// Gets the <see cref="Guid"/> of a mod.
/// </summary>
///
/// <returns>Returns <c>true</c> if game is offline for any reason, otherwise <c>false</c>.</returns>
#if !DEBUG
private bool IsOffline()
/// <param name="plugin">The <see cref="PluginInfo"/> associated with the mod.</param>
///
/// <returns>The <see cref="Guid"/> of the mod.</returns>
public Guid GetModGuid(PluginInfo plugin)
{
// TODO: Work out if TGP and QQGame platform services allow workshop
if (PluginManager.noWorkshop)
{
return true;
}
else if (PlatformService.platformType == PlatformType.Origin)
{
return true;
}
else if (!PlatformService.active)
{
return true;
}
return false;
return plugin.userModInstance.GetType().Assembly.ManifestModule.ModuleVersionId;
}
#endif

/// <summary>
/// Loads and parses the <c>incompatible_mods.txt</c> resource, adds other workshop branches of TM:PE as applicable.
Expand All @@ -176,7 +158,7 @@ private Dictionary<ulong, string> LoadListOfIncompatibleMods()
}
}

Log.Info($"{INCOMPATIBLE_MODS_FILE} contains {lines.Length} entries");
Log.Info($"{RESOURCES_PREFIX}{INCOMPATIBLE_MODS_FILE} contains {lines.Length} entries");

// parse the file
for (int i = 0; i < lines.Length; i++)
Expand All @@ -189,16 +171,6 @@ private Dictionary<ulong, string> LoadListOfIncompatibleMods()
}
}

// Treat other workshop-published branches of TM:PE, as applicable, as conflicts
#if LABS
results.Add(583429740u, "TM:PE STABLE");
#elif DEBUG
results.Add(1637663252u, "TM:PE LABS");
results.Add(583429740u, "TM:PE STABLE");
#else
results.Add(1637663252u, "TM:PE LABS");
#endif

return results;
}
}
Expand Down