Skip to content

Commit 93bbd21

Browse files
LeonarddeRLeonard de Ruijter
LeonarddeR
and
Leonard de Ruijter
authored
Add --copy-portable-config command line parameter to automatically copy the portable configuration with a silent installation (#9679)
* gui.installerGui.doInstall, kwargs * Added command line parameter to copy the portable configuration when installing * Fix linting issues * Fix linting Co-authored-by: Leonard de Ruijter <leonard@babbage.com>
1 parent 6af3083 commit 93bbd21

4 files changed

Lines changed: 66 additions & 11 deletions

File tree

‎source/core.py‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,6 +228,17 @@ def main():
228228
log.debug("loading config")
229229
import config
230230
config.initialize()
231+
if globalVars.appArgs.configPath == config.getUserDefaultConfigPath(useInstalledPathIfExists=True):
232+
# Make sure not to offer the ability to copy the current configuration to the user account.
233+
# This case always applies to the launcher when configPath is not overridden by the user,
234+
# which is the default.
235+
# However, if a user wants to run the launcher with a custom configPath,
236+
# it is likely that he wants to copy that configuration when installing.
237+
# This check also applies to cases where a portable copy is run using the installed configuration,
238+
# in which case we want to avoid copying a configuration to itself.
239+
# We set the value to C{None} in order for the gui to determine
240+
# when to disable the checkbox for this feature.
241+
globalVars.appArgs.copyPortableConfig = None
231242
if config.conf['development']['enableScratchpadDir']:
232243
log.info("Developer Scratchpad mode enabled")
233244
if not globalVars.appArgs.minimal and config.conf["general"]["playStartAndExitSounds"]:
@@ -483,7 +494,11 @@ def handlePowerStatusChange(self):
483494
globalPluginHandler.initialize()
484495
if globalVars.appArgs.install or globalVars.appArgs.installSilent:
485496
import gui.installerGui
486-
wx.CallAfter(gui.installerGui.doSilentInstall,startAfterInstall=not globalVars.appArgs.installSilent)
497+
wx.CallAfter(
498+
gui.installerGui.doSilentInstall,
499+
copyPortableConfig=globalVars.appArgs.copyPortableConfig,
500+
startAfterInstall=not globalVars.appArgs.installSilent
501+
)
487502
elif globalVars.appArgs.portablePath and (globalVars.appArgs.createPortable or globalVars.appArgs.createPortableSilent):
488503
import gui.installerGui
489504
wx.CallAfter(gui.installerGui.doCreatePortable,portableDirectory=globalVars.appArgs.portablePath,

‎source/gui/installerGui.py‎

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,15 @@
2222
import tones
2323
import systemUtils
2424

25-
def doInstall(createDesktopShortcut,startOnLogon,copyPortableConfig,isUpdate,silent=False,startAfterInstall=True):
25+
26+
def doInstall(
27+
createDesktopShortcut=True,
28+
startOnLogon=True,
29+
isUpdate=False,
30+
copyPortableConfig=False,
31+
silent=False,
32+
startAfterInstall=True
33+
):
2634
progressDialog = gui.IndeterminateProgressDialog(gui.mainFrame,
2735
# Translators: The title of the dialog presented while NVDA is being updated.
2836
_("Updating NVDA") if isUpdate
@@ -55,7 +63,14 @@ def doInstall(createDesktopShortcut,startOnLogon,copyPortableConfig,isUpdate,sil
5563
# Translators: the title of a retry cancel dialog when NVDA installation fails
5664
title=_("File in Use")
5765
if winUser.MessageBox(None,message,title,winUser.MB_RETRYCANCEL)==winUser.IDRETRY:
58-
return doInstall(createDesktopShortcut,startOnLogon,copyPortableConfig,isUpdate,silent,startAfterInstall)
66+
return doInstall(
67+
createDesktopShortcut=createDesktopShortcut,
68+
startOnLogon=startOnLogon,
69+
copyPortableConfig=copyPortableConfig,
70+
isUpdate=isUpdate,
71+
silent=silent,
72+
startAfterInstall=startAfterInstall
73+
)
5974
if res!=0:
6075
log.error("Installation failed: %s"%res)
6176
# Translators: The message displayed when an error occurs during installation of NVDA.
@@ -88,16 +103,20 @@ def doInstall(createDesktopShortcut,startOnLogon,copyPortableConfig,isUpdate,sil
88103
else:
89104
wx.GetApp().ExitMainLoop()
90105

91-
def doSilentInstall(startAfterInstall=True):
106+
107+
def doSilentInstall(
108+
copyPortableConfig=False,
109+
startAfterInstall=True
110+
):
92111
prevInstall=installer.comparePreviousInstall() is not None
93112
startOnLogon=globalVars.appArgs.enableStartOnLogon
94113
if startOnLogon is None:
95114
startOnLogon=config.getStartOnLogonScreen() if prevInstall else True
96115
doInstall(
97-
installer.isDesktopShortcutInstalled() if prevInstall else True,
98-
startOnLogon,
99-
False,
100-
prevInstall,
116+
createDesktopShortcut=installer.isDesktopShortcutInstalled() if prevInstall else True,
117+
startOnLogon=startOnLogon,
118+
isUpdate=prevInstall,
119+
copyPortableConfig=copyPortableConfig,
101120
silent=True,
102121
startAfterInstall=startAfterInstall
103122
)
@@ -181,8 +200,10 @@ def __init__(self, parent, isUpdate):
181200
# Translators: The label of a checkbox option in the Install NVDA dialog.
182201
createPortableText = _("Copy &portable configuration to current user account")
183202
self.copyPortableConfigCheckbox = optionsSizer.addItem(wx.CheckBox(self, label=createPortableText))
184-
self.copyPortableConfigCheckbox.Value = False
185-
if globalVars.appArgs.launcher:
203+
self.copyPortableConfigCheckbox.Value = bool(globalVars.appArgs.copyPortableConfig)
204+
if globalVars.appArgs.copyPortableConfig is None:
205+
# copyPortableConfig is set to C{None} in the main loop,
206+
# when copying the portable configuration should be disabled at all costs.
186207
self.copyPortableConfigCheckbox.Disable()
187208

188209
bHelper = sHelper.addDialogDismissButtons(guiHelper.ButtonHelper(wx.HORIZONTAL))
@@ -213,7 +234,12 @@ def __init__(self, parent, isUpdate):
213234

214235
def onInstall(self, evt):
215236
self.Hide()
216-
doInstall(self.createDesktopShortcutCheckbox.Value,self.startOnLogonCheckbox.Value,self.copyPortableConfigCheckbox.Value,self.isUpdate)
237+
doInstall(
238+
createDesktopShortcut=self.createDesktopShortcutCheckbox.Value,
239+
startOnLogon=self.startOnLogonCheckbox.Value,
240+
copyPortableConfig=self.copyPortableConfigCheckbox.Value,
241+
silent=self.isUpdate
242+
)
217243
self.Destroy()
218244

219245
def onCancel(self, evt):
@@ -227,7 +253,9 @@ def onReviewAddons(self, evt):
227253
)
228254
incompatibleAddons.ShowModal()
229255

256+
230257
class InstallingOverNewerVersionDialog(wx.Dialog, DpiScalingHelperMixin):
258+
231259
def __init__(self):
232260
# Translators: The title of a warning dialog.
233261
wx.Dialog.__init__(self, gui.mainFrame, title=_("Warning"))

‎source/nvda.pyw‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ def stringToBool(string):
9090
except ValidateError as e:
9191
raise argparse.ArgumentTypeError(e.message)
9292

93+
9394
#Process option arguments
9495
parser=NoConsoleOptionParser()
9596
quitGroup = parser.add_mutually_exclusive_group()
@@ -113,6 +114,16 @@ parser.add_argument('--portable-path',dest='portablePath',default=None,type=str,
113114
parser.add_argument('--launcher',action="store_true",dest='launcher',default=False,help="Started from the launcher")
114115
parser.add_argument('--enable-start-on-logon',metavar="True|False",type=stringToBool,dest='enableStartOnLogon',default=None,
115116
help="When installing, enable NVDA's start on the logon screen")
117+
parser.add_argument(
118+
'--copy-portable-config',
119+
action="store_true",
120+
dest='copyPortableConfig',
121+
default=False,
122+
help=(
123+
"When installing, copy the portable configuration "
124+
"from the provided path (--config-path, -c) to the current user account"
125+
)
126+
)
116127
# This option is passed by Ease of Access so that if someone downgrades without uninstalling
117128
# (despite our discouragement), the downgraded copy won't be started in non-secure mode on secure desktops.
118129
# (Older versions always required the --secure option to start in secure mode.)

‎user_docs/en/userGuide.t2t‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3128,6 +3128,7 @@ Following are the command line options for NVDA:
31283128
| None | --install | Installs NVDA (starting the newly installed copy) |
31293129
| None | --install-silent | Silently installs NVDA (does not start the newly installed copy) |
31303130
| None | --enable-start-on-logon=True|False | When installing, enable NVDA's [Use NVDA during Windows sign-in #StartAtWindowsLogon] |
3131+
| None | --copy-portable-config | When installing, copy the portable configuration from the provided path (--config-path, -c) to the current user account |
31313132
| None | --create-portable | Creates a portable copy of NVDA (starting the newly created copy). Requires --portable-path to be specified |
31323133
| None | --create-portable-silent | Creates a portable copy of NVDA (does not start the newly installed copy). Requires --portable-path to be specified |
31333134
| None | --portable-path=PORTABLEPATH | The path where a portable copy will be created |

0 commit comments

Comments
 (0)