From 2e8c5b4521d7a483d9895cd4294acd51636046d4 Mon Sep 17 00:00:00 2001
From: JosJuice <josjuice@gmail.com>
Date: Mon, 15 Jun 2020 13:16:01 +0200
Subject: DolphinQt: Show a warning when launching an NKit disc image

It is my opinion that nobody should use NKit disc images without
being aware of the drawbacks of them. Since it seems like almost
nobody who is using NKit disc images knows what NKit is (hmm, now
how could that have happened...?), I am adding a warning to Dolphin
so that you can't run NKit disc images without finding out about the
drawbacks. In case someone really does want to use NKit disc images,
the warning has a "Don't show this again" option. Unfortunately, I
can't retroactively add the warning where it's most needed:
in Dolphin 5.0, which does not support Wii NKit disc images.
---
 Source/Core/DiscIO/Volume.h           |  1 +
 Source/Core/DiscIO/VolumeDisc.cpp     |  6 ++++++
 Source/Core/DiscIO/VolumeDisc.h       |  1 +
 Source/Core/DiscIO/VolumeVerifier.cpp | 24 ++++++++++--------------
 Source/Core/DiscIO/VolumeWad.cpp      |  5 +++++
 Source/Core/DiscIO/VolumeWad.h        |  1 +
 6 files changed, 24 insertions(+), 14 deletions(-)

(limited to 'Source/Core/DiscIO')

diff --git a/Source/Core/DiscIO/Volume.h b/Source/Core/DiscIO/Volume.h
index a5c4e6be14..e176c5d72a 100644
--- a/Source/Core/DiscIO/Volume.h
+++ b/Source/Core/DiscIO/Volume.h
@@ -116,6 +116,7 @@ public:
   }
   virtual Platform GetVolumeType() const = 0;
   virtual bool IsDatelDisc() const = 0;
+  virtual bool IsNKit() const = 0;
   virtual bool SupportsIntegrityCheck() const { return false; }
   virtual bool CheckH3TableIntegrity(const Partition& partition) const { return false; }
   virtual bool CheckBlockIntegrity(u64 block_index, const std::vector<u8>& encrypted_data,
diff --git a/Source/Core/DiscIO/VolumeDisc.cpp b/Source/Core/DiscIO/VolumeDisc.cpp
index bf622bb8fb..fed82a8067 100644
--- a/Source/Core/DiscIO/VolumeDisc.cpp
+++ b/Source/Core/DiscIO/VolumeDisc.cpp
@@ -84,4 +84,10 @@ std::optional<u8> VolumeDisc::GetDiscNumber(const Partition& partition) const
   return ReadSwapped<u8>(6, partition);
 }
 
+bool VolumeDisc::IsNKit() const
+{
+  constexpr u32 NKIT_MAGIC = 0x4E4B4954;  // "NKIT"
+  return ReadSwapped<u32>(0x200, PARTITION_NONE) == NKIT_MAGIC;
+}
+
 }  // namespace DiscIO
diff --git a/Source/Core/DiscIO/VolumeDisc.h b/Source/Core/DiscIO/VolumeDisc.h
index 333ea7d4aa..680bbf83b0 100644
--- a/Source/Core/DiscIO/VolumeDisc.h
+++ b/Source/Core/DiscIO/VolumeDisc.h
@@ -22,6 +22,7 @@ public:
   std::string GetInternalName(const Partition& partition = PARTITION_NONE) const override;
   std::string GetApploaderDate(const Partition& partition) const override;
   std::optional<u8> GetDiscNumber(const Partition& partition = PARTITION_NONE) const override;
+  bool IsNKit() const override;
 
 protected:
   Region RegionCodeToRegion(std::optional<u32> region_code) const;
diff --git a/Source/Core/DiscIO/VolumeVerifier.cpp b/Source/Core/DiscIO/VolumeVerifier.cpp
index 00e850071a..c1a2bcbd90 100644
--- a/Source/Core/DiscIO/VolumeVerifier.cpp
+++ b/Source/Core/DiscIO/VolumeVerifier.cpp
@@ -988,22 +988,18 @@ void VolumeVerifier::CheckMisc()
     }
   }
 
-  if (IsDisc(m_volume.GetVolumeType()))
+  if (m_volume.IsNKit())
   {
-    constexpr u32 NKIT_MAGIC = 0x4E4B4954;  // "NKIT"
-    if (m_volume.ReadSwapped<u32>(0x200, PARTITION_NONE) == NKIT_MAGIC)
-    {
-      AddProblem(
-          Severity::Low,
-          Common::GetStringT("This disc image is in the NKit format. It is not a good dump in its "
-                             "current form, but it might become a good dump if converted back. "
-                             "The CRC32 of this file might match the CRC32 of a good dump even "
-                             "though the files are not identical."));
-    }
-
-    if (StringBeginsWith(game_id_unencrypted, "R8P"))
-      CheckSuperPaperMario();
+    AddProblem(
+        Severity::Low,
+        Common::GetStringT("This disc image is in the NKit format. It is not a good dump in its "
+                           "current form, but it might become a good dump if converted back. "
+                           "The CRC32 of this file might match the CRC32 of a good dump even "
+                           "though the files are not identical."));
   }
+
+  if (IsDisc(m_volume.GetVolumeType()) && StringBeginsWith(game_id_unencrypted, "R8P"))
+    CheckSuperPaperMario();
 }
 
 void VolumeVerifier::CheckSuperPaperMario()
diff --git a/Source/Core/DiscIO/VolumeWad.cpp b/Source/Core/DiscIO/VolumeWad.cpp
index 61b772ec31..b7b8fa35cd 100644
--- a/Source/Core/DiscIO/VolumeWad.cpp
+++ b/Source/Core/DiscIO/VolumeWad.cpp
@@ -289,6 +289,11 @@ bool VolumeWAD::IsDatelDisc() const
   return false;
 }
 
+bool VolumeWAD::IsNKit() const
+{
+  return false;
+}
+
 std::map<Language, std::string> VolumeWAD::GetLongNames() const
 {
   if (!m_tmd.IsValid() || !IOS::ES::IsChannel(m_tmd.GetTitleId()))
diff --git a/Source/Core/DiscIO/VolumeWad.h b/Source/Core/DiscIO/VolumeWad.h
index d76b8853ec..a4c311da78 100644
--- a/Source/Core/DiscIO/VolumeWad.h
+++ b/Source/Core/DiscIO/VolumeWad.h
@@ -60,6 +60,7 @@ public:
   }
   Platform GetVolumeType() const override;
   bool IsDatelDisc() const override;
+  bool IsNKit() const override;
   Region GetRegion() const override;
   Country GetCountry(const Partition& partition = PARTITION_NONE) const override;
 
-- 
cgit v1.2.3