Fix language patch - always install base scripts before language patch installed

- See #233

Author: drojf

fileVersionManagement.py

@@ -89,8 +89,8 @@ def userDidPartialReinstall(self, gameInstallTimeProbePath):
 		return os.path.getctime(gameInstallTimeProbePath) > os.path.getmtime(self.localVersionFilePath)
 
 	def __init__(self, fullInstallConfiguration, modFileList, localVersionFolder, datadir=None, _testRemoteSubModVersion=None, verbosePrinting=True):
-		#type: (installConfiguration.FullInstallConfiguration, List[installConfiguration.ModFile], str, str, Optional[SubModVersionInfo], bool) -> None
-		subMod = fullInstallConfiguration.subModConfig
+		#type: (installConfiguration.FullInstallConfiguration, List[installConfiguration.ModFile], str, str, Optional[SubModVersionInfo], bool, Optional[list[str]]) -> None
+		subMod = fullInstallConfiguration.subModConfig # type: installConfiguration.SubModConfig
 		self.verbosePrinting = verbosePrinting
 		self.targetID = subMod.modName + '/' + subMod.subModName
 		self.unfilteredModFileList = modFileList
@@ -132,8 +132,14 @@ def __init__(self, fullInstallConfiguration, modFileList, localVersionFolder, da
 			for file in self.unfilteredModFileList:
 				self.updatesRequiredDict[file.id] = (True, "Failed to retrieve remote version information")
 		else:
+			forceUpdateList = []
+
+			# Always install script when language patch is enabled
+			if subMod.family == "higurashi" and modOptionParser.languagePatchIsEnabled:
+				forceUpdateList.append(ForceUpdate('script', 'Language patch option forces script re-install'))
+
 			# Mark files which need update
-			self.updatesRequiredDict = getFilesNeedingUpdate(self.unfilteredModFileList, self.localVersionInfo, self.remoteVersionInfo, repairMode=modOptionParser.repairMode)
+			self.updatesRequiredDict = getFilesNeedingUpdate(self.unfilteredModFileList, self.localVersionInfo, self.remoteVersionInfo, repairMode=modOptionParser.repairMode, forceUpdateList=forceUpdateList)
 
 			if verbosePrinting:
 				print("\nInstaller Update Information:")
@@ -266,10 +272,15 @@ def getRemoteVersion(remoteTargetID):
 
 	return SubModVersionInfo(remoteVersionObject)
 
+class ForceUpdate:
+	def __init__(self, name, reason):
+		#type: (str, str) -> None
+		self.name = name
+		self.reason = reason
 
 # given a mod
-def getFilesNeedingUpdate(modFileList, localVersionInfo, remoteVersionInfo, repairMode):
-	#type: (List[installConfiguration.ModFile], SubModVersionInfo, SubModVersionInfo, bool) -> Dict[str, Tuple[bool, str]]
+def getFilesNeedingUpdate(modFileList, localVersionInfo, remoteVersionInfo, repairMode, forceUpdateList=None):
+	#type: (List[installConfiguration.ModFile], SubModVersionInfo, SubModVersionInfo, bool, Optional[list[ForceUpdate]]) -> Dict[str, Tuple[bool, str]]
 	"""
 
 	:param modFileList:
@@ -301,6 +312,13 @@ def getFilesNeedingUpdate(modFileList, localVersionInfo, remoteVersionInfo, repa
 		result = updatesRequiredDict.get(file.id)
 		needUpdate, updateReason = (True, "Missing version info") if result is None else result
 
+		# Check for files forced to update via forceUpdateList parameter
+		if not needUpdate and forceUpdateList is not None:
+			for forceUpdate in forceUpdateList:
+				if file.name == forceUpdate.name:
+					needUpdate = True
+					updateReason = forceUpdate.reason
+
 		if not needUpdate and repairMode and file.installOnRepair:
 			needUpdate = True
 			updateReason = "Re-installing as Repair Mode Enabled"

higurashiInstaller.py

@@ -124,12 +124,12 @@ def __init__(self, fullInstallConfiguration, extractDirectlyToGameDirectory, mod
 		:param str directory: The directory of the game
 		:param dict info: The info dictionary from server JSON file for the requested target
 		"""
+		self.optionParser = modOptionParser
 		self.forcedExtractDirectory = forcedExtractDirectory
 		self.info = fullInstallConfiguration
 		self.directory = fullInstallConfiguration.installPath
 		self.dataDirectory = self.getDataDirectory(self.directory)
 		self.clearScripts = False  # If true, will clear CompiledUpdateScripts before extraction stage
-		self.languagePatchIsEnabled = False  # True if at least one language patch will be installed
 		self.skipDownload = skipDownload
 		self.isWine = fullInstallConfiguration.isWine
 
@@ -175,16 +175,11 @@ def __init__(self, fullInstallConfiguration, extractDirectlyToGameDirectory, mod
 
 		self.downloaderAndExtractor.buildDownloadAndExtractionList()
 
-		self.optionParser = modOptionParser
-
 		for opt in self.optionParser.downloadAndExtractOptionsByPriority:
 			self.downloaderAndExtractor.addItemManually(
 				url=opt.url,
 				extractionDir=os.path.join(self.extractDir, opt.relativeExtractionPath),
 			)
-			if opt.group == 'Alternate Languages':
-				self.clearScripts = True
-				self.languagePatchIsEnabled = True
 
 		self.downloaderAndExtractor.printPreview()
 
@@ -227,7 +222,7 @@ def clearScriptsAndCompiledScripts(self):
 		for globPattern in ["CompiledUpdateScripts/*.mg", "Update/*.txt"]:
 			compiledScriptsPattern = path.join(self.assetsDir, globPattern)
 
-			print("Attempting to clear compiled scripts")
+			print("Attempting to clear compiled scripts in [{}]".format(compiledScriptsPattern))
 			try:
 				for mg in glob.glob(compiledScriptsPattern):
 					forceRemove(mg)
@@ -376,12 +371,23 @@ def applyLanguagePatchFixesIfNecessary(self):
 			folderToApply = self.getDataDirectory(self.forcedExtractDirectory)
 
 		# Don't need to apply any special UI if no language patch
-		if not self.languagePatchIsEnabled:
+		if not self.optionParser.languagePatchIsEnabled:
 			return
 
+		print("applyLanguagePatchFixesIfNecessary(): Language Patch Enabled - Executing Extra Language Patch Fixes...")
+
 		# For now, assume language patches don't provide CompiledUpdateScripts folder, so clear any existing compiled
 		# scripts which may come with the main patch
-		self.clearScriptsAndCompiledScripts()
+		# NOTE: previously, scripts were cleared here via self.clearScriptsAndCompiledScripts(), but this caused issues.
+		# It is now changed to:
+		#
+		# 1. Before this function is called, scripts are cleared (as part of normal mod script installation)
+		# 2. Then, base scripts are then installed (will always happen even if already on latest script ver.)
+		# 3. Then the language patch scripts are installed
+		#
+		# This is done because as all language patches omit some files (at least init.txt, but often other scripts),
+		# so language patches must be installed "ontop" of existing scripts. Clearing scripts at any other time will result
+		# in missing scripts.
 
 		invalidUIFileList = listInvalidUIFiles(folderToApply)
 

installConfiguration.py

@@ -275,6 +275,7 @@ def __init__(self, fullInstallConfiguration):
 		self.repairMode = False
 		self.downloadManually = False
 		self.forceInstallFromScratch = False
+		self.languagePatchIsEnabled = False
 
 		# Sort according to priority - higher priority items will be extracted later, overwriting lower priority items.
 		for modOption in self.config.subModConfig.modOptions:
@@ -307,6 +308,10 @@ def __init__(self, fullInstallConfiguration):
 		# Make sure download and extraction options are sorted
 		self.downloadAndExtractOptionsByPriority.sort(key=lambda opt: opt.priority)
 
+		# Check if any language patch options are enabled
+		for opt in self.downloadAndExtractOptionsByPriority:
+			if opt.group == 'Alternate Languages':
+				self.languagePatchIsEnabled = True
 
 class SubModConfig:
 	# directly represents a single submod from the json file