NVDAHelper.py

# A part of NonVisual Desktop Access (NVDA)
# Copyright (C) 2008-2023 NV Access Limited, Peter Vagner, Davy Kager, Mozilla Corporation, Google LLC,
# Leonard de Ruijter
# This file is covered by the GNU General Public License.
# See the file COPYING for more details.

from typing import Optional
import typing
import os
import winreg
import msvcrt
import winVersion
import buildVersion
import winKernel
import config

from ctypes import *  # noqa: F403
from ctypes import (
	WINFUNCTYPE,
	c_bool,
	c_int,
	c_long,
	c_ulong,
	c_wchar_p,
	c_wchar,
	create_unicode_buffer,
	windll,
)
from ctypes.wintypes import *  # noqa: F403
from comtypes import BSTR
import winUser
import eventHandler
import queueHandler
import api
import globalVars
from logHandler import log
import NVDAState
from utils.security import isLockScreenModeActive
from winAPI.constants import SystemErrorCodes

if typing.TYPE_CHECKING:
	from speech.priorities import SpeechPriority
	from characterProcessing import SymbolLevel

versionedLibPath = os.path.join(globalVars.appDir, "lib")
versionedLibARM64Path = os.path.join(globalVars.appDir, "libArm64")
versionedLibAMD64Path = os.path.join(globalVars.appDir, "lib64")


if not NVDAState.isRunningAsSource():
	# When running as a py2exe build, libraries are in a version-specific directory
	versionedLibPath = os.path.join(versionedLibPath, buildVersion.version)
	versionedLibAMD64Path = os.path.join(versionedLibAMD64Path, buildVersion.version)
	versionedLibARM64Path = os.path.join(versionedLibARM64Path, buildVersion.version)


_remoteLib = None
_remoteLoaderAMD64: "Optional[_RemoteLoader]" = None
_remoteLoaderARM64: "Optional[_RemoteLoader]" = None
localLib = None
generateBeep = None
onSsmlMarkReached = None
VBuf_getTextInRange = None
lastLanguageID = None
lastLayoutString = None


# utility function to point an exported function pointer in a dll  to a ctypes wrapped python function
def _setDllFuncPointer(dll, name, cfunc):
	cast(getattr(dll, name), POINTER(c_void_p)).contents.value = cast(cfunc, c_void_p).value  # noqa: F405


# Implementation of nvdaController methods
@WINFUNCTYPE(c_long, c_wchar_p)
def nvdaController_speakText(text):
	focus = api.getFocusObject()
	if focus.sleepMode == focus.SLEEP_FULL:
		return -1
	import speech

	queueHandler.queueFunction(queueHandler.eventQueue, speech.speakText, text)
	return SystemErrorCodes.SUCCESS


# C901 'nvdaController_speakSsml' is too complex
# Note: when working on nvdaController_speakSsml, look for opportunities to simplify
# and move logic out into smaller helper functions.
@WINFUNCTYPE(c_long, c_wchar_p, c_int, c_int, c_bool)
def nvdaController_speakSsml(  # noqa: C901
	ssml: str,
	symbolLevel: "SymbolLevel",
	priority: "SpeechPriority",
	asynchronous: bool,
) -> SystemErrorCodes:
	focus = api.getFocusObject()
	if focus.sleepMode == focus.SLEEP_FULL:
		return SystemErrorCodes.ACCESS_DENIED

	import speech
	from characterProcessing import SymbolLevel
	from speech.priorities import SpeechPriority
	from speech.speech import _getSpeakSsmlSpeech

	try:
		symbolLevel = SymbolLevel(symbolLevel)
	except ValueError:
		log.exception("Invalid symbolLevel")
		return SystemErrorCodes.INVALID_PARAMETER

	try:
		priority = SpeechPriority(priority)
	except ValueError:
		log.exception("Invalid SpeechPriority")
		return SystemErrorCodes.INVALID_PARAMETER

	prefixSpeechCommand = None
	markCallable = None
	if not asynchronous:
		from queue import SimpleQueue

		markQueue = SimpleQueue()

		import synthDriverHandler
		from speech.commands import CallbackCommand

		def onDoneSpeaking():
			markQueue.put_nowait(None)

		def onSpeechCanceled():
			markQueue.put_nowait(False)

		def prefixCallback():
			synthDriverHandler.synthDoneSpeaking.register(onDoneSpeaking)
			speech.speechCanceled.register(onSpeechCanceled)

		def markCallable(name: str):
			markQueue.put_nowait(name)

		prefixSpeechCommand = CallbackCommand(prefixCallback)

	try:
		sequence = _getSpeakSsmlSpeech(ssml, markCallable, prefixSpeechCommand)
	except Exception:
		log.error("Error parsing SSML", exc_info=True)
		return SystemErrorCodes.INVALID_PARAMETER

	queueHandler.queueFunction(
		queueHandler.eventQueue,
		speech.speak,
		speechSequence=sequence,
		symbolLevel=symbolLevel,
		priority=priority,
	)
	if not asynchronous:
		try:
			while True:
				match markQueue.get():
					case None:
						break
					case False:
						return SystemErrorCodes.CANCELLED
					case str() as name:
						onSsmlMarkReached(name)
					case _ as unknown:
						log.error(f"Unknown item in SSML mark queue: {unknown}")
		finally:
			speech.speechCanceled.unregister(onSpeechCanceled)
			synthDriverHandler.synthDoneSpeaking.unregister(onDoneSpeaking)
	return SystemErrorCodes.SUCCESS


@WINFUNCTYPE(c_long)
def nvdaController_cancelSpeech():
	focus = api.getFocusObject()
	if focus.sleepMode == focus.SLEEP_FULL:
		return -1
	import speech

	queueHandler.queueFunction(queueHandler.eventQueue, speech.cancelSpeech)
	return SystemErrorCodes.SUCCESS


@WINFUNCTYPE(c_long, c_wchar_p)
def nvdaController_brailleMessage(text: str) -> SystemErrorCodes:
	focus = api.getFocusObject()
	if focus.sleepMode == focus.SLEEP_FULL:
		return -1
	if config.conf["braille"]["reportLiveRegions"]:
		import braille

		queueHandler.queueFunction(queueHandler.eventQueue, braille.handler.message, text)
	return SystemErrorCodes.SUCCESS


def _lookupKeyboardLayoutNameWithHexString(layoutString):
	buf = create_unicode_buffer(1024)
	bufSize = c_int(2048)
	key = HKEY()  # noqa: F405
	if (
		windll.advapi32.RegOpenKeyExW(
			winreg.HKEY_LOCAL_MACHINE,
			"SYSTEM\\CurrentControlSet\\Control\\Keyboard Layouts\\" + layoutString,
			0,
			winreg.KEY_QUERY_VALUE,
			byref(key),  # noqa: F405
		)
		== 0
	):  # noqa: F405
		try:
			if (
				windll.advapi32.RegQueryValueExW(key, "Layout Display Name", 0, None, buf, byref(bufSize))  # noqa: F405
				== 0
			):  # noqa: F405
				windll.shlwapi.SHLoadIndirectString(buf.value, buf, 1023, None)
				return buf.value
			if windll.advapi32.RegQueryValueExW(key, "Layout Text", 0, None, buf, byref(bufSize)) == 0:  # noqa: F405
				return buf.value
		finally:
			windll.advapi32.RegCloseKey(key)


@WINFUNCTYPE(c_long, c_wchar_p)
def nvdaControllerInternal_requestRegistration(uuidString):
	pid = c_long()
	windll.rpcrt4.I_RpcBindingInqLocalClientPID(None, byref(pid))  # noqa: F405
	pid = pid.value
	if not pid:
		log.error("Could not get process ID for RPC call")
		return -1
	bindingHandle = c_long()
	bindingHandle.value = localLib.createRemoteBindingHandle(uuidString)
	if not bindingHandle:
		log.error("Could not bind to inproc rpc server for pid %d" % pid)
		return -1
	registrationHandle = c_long()
	res = localLib.nvdaInProcUtils_registerNVDAProcess(bindingHandle, byref(registrationHandle))  # noqa: F405
	if res != 0 or not registrationHandle:
		log.error(
			"Could not register NVDA with inproc rpc server for pid %d, res %d, registrationHandle %s"
			% (pid, res, registrationHandle),
		)
		windll.rpcrt4.RpcBindingFree(byref(bindingHandle))  # noqa: F405
		return -1
	import appModuleHandler

	queueHandler.queueFunction(
		queueHandler.eventQueue,
		appModuleHandler.update,
		pid,
		helperLocalBindingHandle=bindingHandle,
		inprocRegistrationHandle=registrationHandle,
	)
	return 0


@WINFUNCTYPE(c_long, c_wchar_p, c_wchar_p)
def nvdaControllerInternal_reportLiveRegion(text: str, politeness: str):
	assert isinstance(text, str), "Text isn't a string"
	assert isinstance(politeness, str), "Politeness isn't a string"
	if not config.conf["presentation"]["reportDynamicContentChanges"]:
		return -1
	focus = api.getFocusObject()
	if focus.sleepMode == focus.SLEEP_FULL:
		return -1
	import speech
	import braille
	from aria import AriaLivePoliteness
	from speech.priorities import Spri

	try:
		politenessValue = AriaLivePoliteness(politeness.lower())
	except ValueError:
		log.error(
			f"nvdaControllerInternal_reportLiveRegion got unknown politeness of {politeness}",
			exc_info=True,
		)
		return -1
	if politenessValue == AriaLivePoliteness.OFF:
		log.error(f"nvdaControllerInternal_reportLiveRegion got unexpected politeness of {politeness}")
	queueHandler.queueFunction(
		queueHandler.eventQueue,
		speech.speakText,
		text,
		priority=(Spri.NEXT if politenessValue == AriaLivePoliteness.ASSERTIVE else Spri.NORMAL),
	)
	queueHandler.queueFunction(
		queueHandler.eventQueue,
		braille.handler.message,
		text,
	)
	return 0


@WINFUNCTYPE(c_long, c_long, c_long, c_long, c_long, c_long)
def nvdaControllerInternal_displayModelTextChangeNotify(hwnd, left, top, right, bottom):
	import displayModel

	displayModel.textChangeNotify(hwnd, left, top, right, bottom)
	return 0


@WINFUNCTYPE(c_long, c_long, c_long, c_long, c_long, c_long)
def nvdaControllerInternal_drawFocusRectNotify(hwnd, left, top, right, bottom):
	import eventHandler
	from NVDAObjects.window import Window

	focus = api.getFocusObject()
	if isinstance(focus, Window) and hwnd == focus.windowHandle:
		eventHandler.queueEvent("displayModel_drawFocusRectNotify", focus, rect=(left, top, right, bottom))
	return 0


@WINFUNCTYPE(c_long, c_long, c_long, c_wchar_p)
def nvdaControllerInternal_logMessage(level, pid, message):
	if not log.isEnabledFor(level):
		return 0
	if pid:
		from appModuleHandler import getAppNameFromProcessID

		codepath = "RPC process %s (%s)" % (pid, getAppNameFromProcessID(pid, includeExt=True))
	else:
		codepath = "NVDAHelperLocal"
	log._log(level, message, [], codepath=codepath)
	return 0


def handleInputCompositionEnd(result):
	import speech
	import characterProcessing
	from NVDAObjects.inputComposition import InputComposition
	from NVDAObjects.IAccessible.mscandui import ModernCandidateUICandidateItem

	focus = api.getFocusObject()
	result = result.lstrip("\u3000 ")
	curInputComposition = None
	if isinstance(focus, InputComposition):
		curInputComposition = focus
		oldSpeechMode = speech.getState().speechMode
		speech.setSpeechMode(speech.SpeechMode.off)
		eventHandler.executeEvent("gainFocus", focus.parent)
		speech.setSpeechMode(oldSpeechMode)
	elif isinstance(focus.parent, InputComposition):
		# Candidate list is still up
		curInputComposition = focus.parent
		focus.parent = focus.parent.parent
	if isinstance(focus, ModernCandidateUICandidateItem):
		# Correct focus for ModernCandidateUICandidateItem
		# Find the InputComposition object and
		# correct focus to its parent
		if isinstance(focus.container, InputComposition):
			curInputComposition = focus.container
			newFocus = curInputComposition.parent
		else:
			# Sometimes InputCompositon object is gone
			# Correct to container of CandidateItem
			newFocus = focus.container
		oldSpeechMode = speech.getState().speechMode
		speech.setSpeechMode(speech.SpeechMode.off)
		eventHandler.executeEvent("gainFocus", newFocus)
		speech.setSpeechMode(oldSpeechMode)

	if curInputComposition and not result:
		result = curInputComposition.compositionString.lstrip("\u3000 ")
	if result:
		speech.speakText(result, symbolLevel=characterProcessing.SymbolLevel.ALL)


def handleInputCompositionStart(compositionString, selectionStart, selectionEnd, isReading):
	import speech
	from NVDAObjects.inputComposition import InputComposition
	from NVDAObjects.behaviors import CandidateItem

	focus = api.getFocusObject()
	if focus.parent and isinstance(focus.parent, InputComposition):
		# Candidates infront of existing composition string
		announce = not config.conf["inputComposition"]["announceSelectedCandidate"]
		focus.parent.compositionUpdate(
			compositionString,
			selectionStart,
			selectionEnd,
			isReading,
			announce=announce,
		)
		return 0
	# IME keeps updating input composition while the candidate list is open
	# Therefore ignore new composition updates if candidate selections are configured for speaking.
	if config.conf["inputComposition"]["announceSelectedCandidate"] and isinstance(focus, CandidateItem):
		return 0
	if not isinstance(focus, InputComposition):
		parent = api.getDesktopObject().objectWithFocus()
		# #5640: Although we want to use the most correct focus (I.e. OS, not NVDA), if they are the same, we definitely want to use the original instance, so that state such as auto selection is maintained.
		if parent == focus:
			parent = focus
		curInputComposition = InputComposition(parent=parent)
		oldSpeechMode = speech.getState().speechMode
		speech.setSpeechMode(speech.SpeechMode.off)
		eventHandler.executeEvent("gainFocus", curInputComposition)
		focus = curInputComposition
		speech.setSpeechMode(oldSpeechMode)
	focus.compositionUpdate(compositionString, selectionStart, selectionEnd, isReading)


@WINFUNCTYPE(c_long, c_wchar_p, c_int, c_int, c_int)
def nvdaControllerInternal_inputCompositionUpdate(compositionString, selectionStart, selectionEnd, isReading):
	from NVDAObjects.inputComposition import InputComposition
	from NVDAObjects.IAccessible.mscandui import ModernCandidateUICandidateItem

	if selectionStart == -1:
		queueHandler.queueFunction(queueHandler.eventQueue, handleInputCompositionEnd, compositionString)
		return 0
	focus = api.getFocusObject()
	if isinstance(focus, InputComposition):
		focus.compositionUpdate(compositionString, selectionStart, selectionEnd, isReading)
	# Eliminate InputCompositionStart events from Microsoft Pinyin to avoid reading composition string instead of candidates
	elif not isinstance(focus, ModernCandidateUICandidateItem):
		queueHandler.queueFunction(
			queueHandler.eventQueue,
			handleInputCompositionStart,
			compositionString,
			selectionStart,
			selectionEnd,
			isReading,
		)
	return 0


def handleInputCandidateListUpdate(candidatesString, selectionIndex, inputMethod):
	candidateStrings = candidatesString.split("\n")
	import speech
	from NVDAObjects.inputComposition import CandidateItem

	focus = api.getFocusObject()
	if not (0 <= selectionIndex < len(candidateStrings)):
		if isinstance(focus, CandidateItem):
			oldSpeechMode = speech.getState().speechMode
			speech.setSpeechMode(speech.SpeechMode.off)
			eventHandler.executeEvent("gainFocus", focus.parent)
			speech.setSpeechMode(oldSpeechMode)
		return
	oldCandidateItemsText = None
	if isinstance(focus, CandidateItem):
		oldCandidateItemsText = focus.visibleCandidateItemsText
		parent = focus.parent
		wasCandidate = True
	else:
		parent = focus
		wasCandidate = False
	item = CandidateItem(
		parent=parent,
		candidateStrings=candidateStrings,
		candidateIndex=selectionIndex,
		inputMethod=inputMethod,
	)
	if (
		wasCandidate
		and focus.windowHandle == item.windowHandle
		and focus.candidateIndex == item.candidateIndex
		and focus.name == item.name
	):
		return
	if (
		config.conf["inputComposition"]["autoReportAllCandidates"]
		and item.visibleCandidateItemsText != oldCandidateItemsText
	):
		import ui

		ui.message(item.visibleCandidateItemsText)
	eventHandler.executeEvent("gainFocus", item)


@WINFUNCTYPE(c_long, c_wchar_p, c_long, c_wchar_p)
def nvdaControllerInternal_inputCandidateListUpdate(candidatesString, selectionIndex, inputMethod):
	queueHandler.queueFunction(
		queueHandler.eventQueue,
		handleInputCandidateListUpdate,
		candidatesString,
		selectionIndex,
		inputMethod,
	)
	return 0


inputConversionModeMessages = {
	1: (
		# Translators: A mode  that allows typing in the actual 'native' characters for an east-Asian input method language currently selected, rather than alpha numeric (Roman/English) characters.
		_("Native input"),
		# Translators: a mode that lets you type in alpha numeric (roman/english) characters, rather than 'native' characters for the east-Asian input method  language currently selected.
		_("Alpha numeric input"),
	),
	8: (
		# Translators: for East-Asian input methods, a mode that allows typing in full-shaped (full double-byte) characters, rather than the smaller half-shaped ones.
		_("Full shaped mode"),
		# Translators: for East-Asian input methods, a mode that allows typing in half-shaped (single-byte) characters, rather than the larger full-shaped (double-byte) ones.
		_("Half shaped mode"),
	),
}

JapaneseInputConversionModeMessages = {
	# Translators: For Japanese character input: half-shaped (single-byte) alpha numeric (roman/english) mode.
	0: _("half alphanumeric"),
	# Translators: For Japanese character input: half-shaped (single-byte) Katacana input mode.
	3: _("half katakana"),
	# Translators: For Japanese character input: alpha numeric (roman/english) mode.
	8: _("alphanumeric"),
	# Translators: For Japanese character input: Hiragana input mode.
	9: _("hiragana"),
	# Translators: For Japanese character input: Katacana input mode.
	11: _("katakana"),
	# Translators: For Japanese character input: half-shaped (single-byte) alpha numeric (roman/english) mode.
	16: _("half alphanumeric"),
	# Translators: For Japanese character input: half katakana roman input mode.
	19: _("half katakana roman"),
	# Translators: For Japanese character input: alpha numeric (roman/english) mode.
	24: _("alphanumeric"),
	# Translators: For Japanese character input: Hiragana Roman input mode.
	25: _("hiragana roman"),
	# Translators: For Japanese character input: Katacana Roman input mode.
	27: _("katakana roman"),
}


def handleInputConversionModeUpdate(oldFlags, newFlags, lcid):
	import ui

	textList = []
	if newFlags != oldFlags and lcid & 0xFF == 0x11:  # Japanese
		msg = JapaneseInputConversionModeMessages.get(newFlags)
		if msg:
			textList.append(msg)
	else:
		for x in range(32):
			x = 2**x
			msgs = inputConversionModeMessages.get(x)
			if not msgs:
				continue
			newOn = bool(newFlags & x)
			oldOn = bool(oldFlags & x)
			if newOn != oldOn:
				textList.append(msgs[0] if newOn else msgs[1])
	if len(textList) > 0:
		queueHandler.queueFunction(queueHandler.eventQueue, ui.message, " ".join(textList))


@WINFUNCTYPE(c_long, c_long, c_long, c_ulong)
def nvdaControllerInternal_inputConversionModeUpdate(oldFlags, newFlags, lcid):
	queueHandler.queueFunction(
		queueHandler.eventQueue,
		handleInputConversionModeUpdate,
		oldFlags,
		newFlags,
		lcid,
	)
	return 0


@WINFUNCTYPE(c_long, c_long)
def nvdaControllerInternal_IMEOpenStatusUpdate(opened):
	if opened:
		# Translators: a message when the IME open status changes to opened
		message = _("IME opened")
	else:
		# Translators: a message when the IME open status changes to closed
		message = _("IME closed")
	import ui

	queueHandler.queueFunction(queueHandler.eventQueue, ui.message, message)
	return 0


@WINFUNCTYPE(c_long, c_long, c_ulong, c_wchar_p)
def nvdaControllerInternal_inputLangChangeNotify(threadID, hkl, layoutString):
	global lastLanguageID, lastLayoutString
	languageID = winUser.LOWORD(hkl)
	# Simple case where there is no change
	if languageID == lastLanguageID and layoutString == lastLayoutString:
		return 0
	focus = api.getFocusObject()
	# This callback can be called before NVDa is fully initialized
	# So also handle focus object being None as well as checking for sleepMode
	if not focus or focus.sleepMode:
		return 0
	import NVDAObjects.window

	# Generally we should not allow input lang changes from threads that are not focused.
	# But threadIDs for console windows are always wrong so don't ignore for those.
	if not isinstance(focus, NVDAObjects.window.Window) or (
		threadID != focus.windowThreadID and focus.windowClassName != "ConsoleWindowClass"
	):
		return 0
	from speech import sayAll

	# Never announce changes while in sayAll (#1676)
	if sayAll.SayAllHandler.isRunning():
		return 0
	import ui

	buf = create_unicode_buffer(1024)
	res = windll.kernel32.GetLocaleInfoW(languageID, 2, buf, 1024)
	# Translators: the label for an unknown language when switching input methods.
	inputLanguageName = buf.value if res else _("unknown language")
	layoutStringCodes = []
	inputMethodName = None
	# layoutString can either be a real input method name, a hex string for an input method name in the registry, or an empty string.
	# If it is a real input method name, then it is used as is.
	# If it is a hex string or it is empty, then the method name is looked up by trying:
	# The full hex string, the hkl as a hex string, the low word of the hex string or hkl, the high word of the hex string or hkl.
	if layoutString:
		try:
			int(layoutString, 16)
			layoutStringCodes.append(layoutString)
		except ValueError:
			inputMethodName = layoutString
	if not inputMethodName:
		layoutStringCodes.insert(0, hex(hkl)[2:].rstrip("L").upper().rjust(8, "0"))
		for stringCode in list(layoutStringCodes):
			layoutStringCodes.append(stringCode[4:].rjust(8, "0"))
			if stringCode[0] < "D":
				layoutStringCodes.append(stringCode[0:4].rjust(8, "0"))
		for stringCode in layoutStringCodes:
			inputMethodName = _lookupKeyboardLayoutNameWithHexString(stringCode)
			if inputMethodName:
				break
	if not inputMethodName:
		log.debugWarning("Could not find layout name for keyboard layout, reporting as unknown")
		# Translators: The label for an unknown input method when switching input methods.
		inputMethodName = _("unknown input method")
	# Remove the language name if it is in the input method name.
	if " - " in inputMethodName:
		inputMethodName = "".join(inputMethodName.split(" - ")[1:])
	# Include the language only if it changed.
	if languageID != lastLanguageID:
		msg = "{language} - {layout}".format(language=inputLanguageName, layout=inputMethodName)
	else:
		msg = inputMethodName
	lastLanguageID = languageID
	lastLayoutString = layoutString
	queueHandler.queueFunction(queueHandler.eventQueue, ui.message, msg)
	return 0


@WINFUNCTYPE(c_long, c_wchar)
def nvdaControllerInternal_typedCharacterNotify(ch):
	focus = api.getFocusObject()
	if focus.windowClassName != "ConsoleWindowClass":
		eventHandler.queueEvent("typedCharacter", focus, ch=ch)
	return 0


@WINFUNCTYPE(c_long, c_int, c_int)
def nvdaControllerInternal_vbufChangeNotify(rootDocHandle, rootID):
	import virtualBuffers

	virtualBuffers.VirtualBuffer.changeNotify(rootDocHandle, rootID)
	return 0


@WINFUNCTYPE(c_long, c_wchar_p)
def nvdaControllerInternal_installAddonPackageFromPath(addonPath):
	if globalVars.appArgs.launcher:
		log.debugWarning("Unable to install add-on into launcher.")
		return
	if globalVars.appArgs.secure:
		log.debugWarning("Unable to install add-on into secure copy of NVDA.")
		return
	if isLockScreenModeActive():
		log.debugWarning("Unable to install add-on while Windows is locked.")
		return
	import wx
	from gui import addonGui

	log.debug("Requesting installation of add-on from %s", addonPath)
	wx.CallAfter(addonGui.handleRemoteAddonInstall, addonPath)
	return 0


@WINFUNCTYPE(c_long)
def nvdaControllerInternal_openConfigDirectory():
	if globalVars.appArgs.secure:
		log.debugWarning("Unable to open user config directory for secure copy of NVDA.")
		return
	if isLockScreenModeActive():
		log.debugWarning("Unable to open user config directory while Windows is locked.")
		return
	import systemUtils

	systemUtils.openUserConfigurationDirectory()
	return 0


class _RemoteLoader:
	def __init__(self, loaderDir: str):
		# Create a pipe so we can write to stdin of the loader process.
		pipeReadOrig, self._pipeWrite = winKernel.CreatePipe(None, 0)
		# Make the read end of the pipe inheritable.
		pipeRead = self._duplicateAsInheritable(pipeReadOrig)
		winKernel.closeHandle(pipeReadOrig)
		# stdout/stderr of the loader process should go to nul.
		# Though we aren't using pythonic functions to write to nul,
		# open it in binary mode as opening it in text mode (the default) doesn't make sense.
		with open("nul", "wb") as nul:
			nulHandle = self._duplicateAsInheritable(msvcrt.get_osfhandle(nul.fileno()))
		# Set the process to start with the appropriate std* handles.
		si = winKernel.STARTUPINFO(
			dwFlags=winKernel.STARTF_USESTDHANDLES,
			hSTDInput=pipeRead,
			hSTDOutput=nulHandle,
			hSTDError=nulHandle,
		)
		pi = winKernel.PROCESS_INFORMATION()
		# Even if we have uiAccess privileges, they will not be inherited by default.
		# Therefore, explicitly specify our own process token, which causes them to be inherited.
		token = winKernel.OpenProcessToken(winKernel.GetCurrentProcess(), winKernel.MAXIMUM_ALLOWED)
		try:
			loaderPath = os.path.join(loaderDir, "nvdaHelperRemoteLoader.exe")
			log.debug(f"Starting {loaderPath}")
			winKernel.CreateProcessAsUser(token, None, loaderPath, None, None, True, None, None, None, si, pi)
			# We don't need the thread handle.
			winKernel.closeHandle(pi.hThread)
			self._process = pi.hProcess
		except:
			winKernel.closeHandle(self._pipeWrite)
			raise
		finally:
			winKernel.closeHandle(pipeRead)
			winKernel.closeHandle(token)

	def _duplicateAsInheritable(self, handle):
		curProc = winKernel.GetCurrentProcess()
		return winKernel.DuplicateHandle(curProc, handle, curProc, 0, True, winKernel.DUPLICATE_SAME_ACCESS)

	def terminate(self):
		# Closing the write end of the pipe will cause EOF for the waiting loader process, which will then exit gracefully.
		winKernel.closeHandle(self._pipeWrite)
		# Wait until it's dead.
		winKernel.waitForSingleObject(self._process, winKernel.INFINITE)
		winKernel.closeHandle(self._process)


def initialize() -> None:
	global _remoteLib, _remoteLoaderAMD64, _remoteLoaderARM64
	global localLib, generateBeep, onSsmlMarkReached, VBuf_getTextInRange
	global lastLanguageID, lastLayoutString
	hkl = c_ulong(windll.User32.GetKeyboardLayout(0)).value
	lastLanguageID = winUser.LOWORD(hkl)
	KL_NAMELENGTH = 9
	buf = create_unicode_buffer(KL_NAMELENGTH)
	res = windll.User32.GetKeyboardLayoutNameW(buf)
	if res:
		lastLayoutString = buf.value
	localLib = cdll.LoadLibrary(os.path.join(versionedLibPath, "nvdaHelperLocal.dll"))  # noqa: F405
	for name, func in [
		("nvdaController_speakText", nvdaController_speakText),
		("nvdaController_speakSsml", nvdaController_speakSsml),
		("nvdaController_cancelSpeech", nvdaController_cancelSpeech),
		("nvdaController_brailleMessage", nvdaController_brailleMessage),
		("nvdaControllerInternal_requestRegistration", nvdaControllerInternal_requestRegistration),
		("nvdaControllerInternal_reportLiveRegion", nvdaControllerInternal_reportLiveRegion),
		("nvdaControllerInternal_inputLangChangeNotify", nvdaControllerInternal_inputLangChangeNotify),
		("nvdaControllerInternal_typedCharacterNotify", nvdaControllerInternal_typedCharacterNotify),
		(
			"nvdaControllerInternal_displayModelTextChangeNotify",
			nvdaControllerInternal_displayModelTextChangeNotify,
		),
		("nvdaControllerInternal_logMessage", nvdaControllerInternal_logMessage),
		("nvdaControllerInternal_inputCompositionUpdate", nvdaControllerInternal_inputCompositionUpdate),
		("nvdaControllerInternal_inputCandidateListUpdate", nvdaControllerInternal_inputCandidateListUpdate),
		("nvdaControllerInternal_IMEOpenStatusUpdate", nvdaControllerInternal_IMEOpenStatusUpdate),
		(
			"nvdaControllerInternal_inputConversionModeUpdate",
			nvdaControllerInternal_inputConversionModeUpdate,
		),
		("nvdaControllerInternal_vbufChangeNotify", nvdaControllerInternal_vbufChangeNotify),
		(
			"nvdaControllerInternal_installAddonPackageFromPath",
			nvdaControllerInternal_installAddonPackageFromPath,
		),
		("nvdaControllerInternal_drawFocusRectNotify", nvdaControllerInternal_drawFocusRectNotify),
		("nvdaControllerInternal_openConfigDirectory", nvdaControllerInternal_openConfigDirectory),
	]:
		try:
			_setDllFuncPointer(localLib, "_%s" % name, func)
		except AttributeError as e:
			log.error(
				"nvdaHelperLocal function pointer for %s could not be found, possibly old nvdaHelperLocal dll"
				% name,
				exc_info=True,
			)
			raise e
	localLib.nvdaHelperLocal_initialize(globalVars.appArgs.secure)
	generateBeep = localLib.generateBeep
	generateBeep.argtypes = [c_char_p, c_float, c_int, c_int, c_int]  # noqa: F405
	generateBeep.restype = c_int
	onSsmlMarkReached = localLib.nvdaController_onSsmlMarkReached
	onSsmlMarkReached.argtypes = [c_wchar_p]
	onSsmlMarkReached.restype = c_ulong
	# The rest of this function (to do with injection) only applies if NVDA is not running as a Windows store application
	# Handle VBuf_getTextInRange's BSTR out parameter so that the BSTR will be freed automatically.
	VBuf_getTextInRange = CFUNCTYPE(c_int, c_int, c_int, c_int, POINTER(BSTR), c_int)(  # noqa: F405
		("VBuf_getTextInRange", localLib),
		((1,), (1,), (1,), (2,), (1,)),
	)
	if config.isAppX:
		log.info("Remote injection disabled due to running as a Windows Store Application")
		return
	# Load nvdaHelperRemote.dll
	h = windll.kernel32.LoadLibraryExW(
		os.path.join(versionedLibPath, "nvdaHelperRemote.dll"),
		0,
		# Using an altered search path is necessary here
		# As NVDAHelperRemote needs to locate dependent dlls in the same directory
		# such as IAccessible2proxy.dll.
		winKernel.LOAD_WITH_ALTERED_SEARCH_PATH,
	)
	if not h:
		log.critical("Error loading nvdaHelperRemote.dll: %s" % WinError())  # noqa: F405
		return
	_remoteLib = CDLL("nvdaHelperRemote", handle=h)  # noqa: F405
	if _remoteLib.injection_initialize() == 0:
		raise RuntimeError("Error initializing NVDAHelperRemote")
	if not _remoteLib.installIA2Support():
		log.error("Error installing IA2 support")
	# Manually start the in-process manager thread for this NVDA main thread now, as a slow system can cause this action to confuse WX
	_remoteLib.initInprocManagerThreadIfNeeded()
	arch = winVersion.getWinVer().processorArchitecture
	if arch == "AMD64":
		_remoteLoaderAMD64 = _RemoteLoader(versionedLibAMD64Path)
	elif arch == "ARM64":
		_remoteLoaderARM64 = _RemoteLoader(versionedLibARM64Path)
		# Windows on ARM from Windows 11 supports running AMD64 apps.
		# Thus we also need to be able to inject into these.
		if winVersion.getWinVer() >= winVersion.WIN11:
			_remoteLoaderAMD64 = _RemoteLoader(versionedLibAMD64Path)


def terminate():
	global _remoteLib, _remoteLoaderAMD64, _remoteLoaderARM64
	global localLib, generateBeep, VBuf_getTextInRange
	if not config.isAppX:
		if not _remoteLib.uninstallIA2Support():
			log.debugWarning("Error uninstalling IA2 support")
		if _remoteLib.injection_terminate() == 0:
			raise RuntimeError("Error terminating NVDAHelperRemote")
		_remoteLib = None
		if _remoteLoaderAMD64:
			_remoteLoaderAMD64.terminate()
			_remoteLoaderAMD64 = None
		if _remoteLoaderARM64:
			_remoteLoaderARM64.terminate()
			_remoteLoaderARM64 = None
	generateBeep = None
	VBuf_getTextInRange = None
	localLib.nvdaHelperLocal_terminate()
	localLib = None


LOCAL_WIN10_DLL_PATH = os.path.join(versionedLibPath, "nvdaHelperLocalWin10.dll")


def getHelperLocalWin10Dll():
	"""Get a ctypes WinDLL instance for the nvdaHelperLocalWin10 dll.
	This is a C++/CX dll used to provide access to certain UWP functionality.
	"""
	return windll[LOCAL_WIN10_DLL_PATH]


def bstrReturn(address):
	"""Handle a BSTR returned from a ctypes function call.
	This includes freeing the memory.
	This is needed for nvdaHelperLocalWin10 functions which return a BSTR.
	"""
	# comtypes.BSTR.from_address seems to cause a crash for some reason. Not sure why.
	# Just access the string ourselves.
	# This will terminate at a null character, even though BSTR allows nulls.
	# We're only using this for normal, null-terminated strings anyway.
	val = wstring_at(address)  # noqa: F405
	windll.oleaut32.SysFreeString(address)
	return val