Allow only one installer instance - Revision history

Anders: Simplified mutex code and added file code

2019-09-04T18:31:02Z

Simplified mutex code and added file code

Anders: Check CreateMutex GetLastError against ERROR_ALREADY_EXISTS. Compare caption with $(^SetupCaption) and not $(^Name).

2014-07-07T18:58:56Z

Check CreateMutex GetLastError against ERROR_ALREADY_EXISTS. Compare caption with $(^SetupCaption) and not $(^Name).

â† Older revision		Revision as of 18:58, 7 July 2014
Line 42:		Line 42:

	== Even more advanced ==		== Even more advanced ==
	This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized. Note (Akshay): I tested this and it works on Windows XP 64-bit, but on Windows 7 the installer fails, saying "Installer integrity check has failed. Common causes include incomplete download and damaged media. Contact the installer's author to obtain a new copy. More information is at http://nsis.sf.net/NSIS_Error".		This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized.
	~~Note (smartcom): Tested on Windows Vista and on Windows 7 64 bit and no problem found~~.
	<highlight-nsis>		<highlight-nsis>
			!define INSTALLERMUTEXNAME "$(^Name)" ; TODO: Should really use a GUID here!

	Function .onInit		Function .onInit
	BringToFront		BringToFront
	; ~~Check if already running~~		!ifndef NSIS_PTR_SIZE & SYSTYPE_PTR
	; ~~If so don't open another but bring to front~~		!define SYSTYPE_PTR i ; NSIS v2.4x
	System::Call "kernel32::CreateMutex(i 0, ~~i 0~~, t '$~~(^Name)'~~) ~~i .r0~~ ?e"		!else
	Pop $0		!define /ifndef SYSTYPE_PTR p ; NSIS v3.0+
	~~StrCmp~~ $0 0 launch		!endif
	StrLen $0 "$(^~~Name~~)"		System::Call 'kernel32::CreateMutex(${SYSTYPE_PTR}0, i1, t"${INSTALLERMUTEXNAME}")?e'
	IntOp $0 $0 + 1		Pop $0
	loop:		IntCmpU $0 183 0 launch launch ; ERROR_ALREADY_EXISTS
	FindWindow $1 '#32770~~' '' 0~~ $1		StrLen $0 "$(^SetupCaption)"
	~~IntCmp~~ $1 ~~0 +5~~		IntOp $0 $0 + 1 ; GetWindowText count includes \0
	System::Call "user32::GetWindowText(i r1, t .r2, ~~i r0~~) ~~i."~~		StrCpy $1 "" ; Start FindWindow with NULL
	StrCmp $2 "$(^~~Name~~)" 0 loop		loop:
	~~System~~:~~:Call "user32::ShowWindow(i r1,i 9) i." ; If~~ minimized ~~then restore~~		FindWindow $1 "#32770" "" "" $1
	System::Call "user32::SetForegroundWindow(i r1) i." ~~; Bring to front~~		StrCmp 0 $1 notfound
	Abort		System::Call 'user32::GetWindowText(${SYSTYPE_PTR}r1, t.r2, ir0)'
	launch:		StrCmp $2 "$(^SetupCaption)" 0 loop
			SendMessage $1 0x112 0xF120 0 /TIMEOUT=2000 ; WM_SYSCOMMAND:SC_RESTORE to restore the window if it is minimized
			System::Call "user32::SetForegroundWindow(${SYSTYPE_PTR}r1)"
			notfound:
			Abort
			launch:
	FunctionEnd		FunctionEnd
	</highlight-nsis>		</highlight-nsis>

Afrow UK at 15:27, 30 May 2014

2014-05-30T15:27:07Z

â† Older revision		Revision as of 15:27, 30 May 2014
Line 6:		Line 6:
	You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0		You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0

			== Note ==
			<span style="color:red">'''You should check the return value against ERROR_ALREADY_EXISTS (183) rather than 0. CreateMutex can set other errors such as ERROR_ACCESS_DENIED which results in a false positive.'''</span>

	== The Script ==		== The Script ==

Anders: Never mix t type and A/W suffix

2013-05-25T15:01:44Z

Never mix t type and A/W suffix

â† Older revision		Revision as of 15:01, 25 May 2013
Line 4:		Line 4:
	The best way is to use a kernel mutex. You can call the Win32 API using the [[System plug-in]]. See also [[CreateMutex plug-in]].		The best way is to use a kernel mutex. You can call the Win32 API using the [[System plug-in]]. See also [[CreateMutex plug-in]].

	~~Put this code in the~~ .~~onInit function~~:		You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0

	~~== Unicode warning ==~~
	~~Warning! You should use "CreateMutexW" instead of "CreateMutexA" for unicode NSIS! Using a wrong one like~~
	~~<highlight-nsis>~~
	~~System::Call 'kernel32::CreateMutexA(i 0, i 0, t "abcdef") ?e'~~
	~~</highlight-nsis>~~
	~~will silently create a mutex named "a", not "abcdef"!~~

	~~You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0~~

	== The Script ==		== The Script ==
			Put this code in the .onInit function:
	<highlight-nsis>		<highlight-nsis>
	System::Call 'kernel32::~~CreateMutexA~~(i 0, i 0, t "myMutex") ?e'		System::Call 'kernel32::CreateMutex(i 0, i 0, t "myMutex") ?e'
	Pop $R0		Pop $R0
	StrCmp $R0 0 +3		StrCmp $R0 0 +3
Line 23:		Line 16:
	Abort		Abort
	</highlight-nsis>		</highlight-nsis>
	'myMutex' should be replaced with a unique value (e.g. ~~ProgramSetup~~.~~exe~~).		'myMutex' should be replaced with a unique value (e.g. "MyCompany.MyApp" or a [http://www.guidgenerator.com/ generate] [http://www.guidgen.com/ a unique] [https://developer.mozilla.org/en/docs/Generating_GUIDs GUID]).

	== The advanced way ==		== The advanced way ==
Line 31:		Line 24:

	<highlight-nsis>		<highlight-nsis>
	System::Call "kernel32::~~CreateMutexA~~(i 0, i 0, t '$(^Name)') i .r0 ?e"		System::Call "kernel32::CreateMutex(i 0, i 0, t '$(^Name)') i .r0 ?e"
	Pop $0		Pop $0
	StrCmp $0 0 launch		StrCmp $0 0 launch
Line 54:		Line 47:
	; Check if already running		; Check if already running
	; If so don't open another but bring to front		; If so don't open another but bring to front
	System::Call "kernel32::~~CreateMutexA~~(i 0, i 0, t '$(^Name)') i .r0 ?e"		System::Call "kernel32::CreateMutex(i 0, i 0, t '$(^Name)') i .r0 ?e"
	Pop $0		Pop $0
	StrCmp $0 0 launch		StrCmp $0 0 launch

PeterMortensen: /* Even more advanced */ Copy edited. Expansion.

2013-05-06T20:30:01Z

Even more advanced: Copy edited. Expansion.

â† Older revision		Revision as of 20:30, 6 May 2013
Line 47:		Line 47:

	== Even more advanced ==		== Even more advanced ==
	This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized. Note (Akshay): I tested this and it works on ~~XPx64~~ but on ~~Win7~~ the installer fails saying "Installer integrity check has failed. Common causes include incomplete download and damaged media. Contact the installer's author to obtain a new copy. More ~~informations~~ at http://nsis.sf.net/NSIS_Error"		This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized. Note (Akshay): I tested this and it works on Windows XP 64-bit, but on Windows 7 the installer fails, saying "Installer integrity check has failed. Common causes include incomplete download and damaged media. Contact the installer's author to obtain a new copy. More information is at http://nsis.sf.net/NSIS_Error".
	Note (smartcom): Tested on Vista and on ~~Win~~ 7 64 bit and no problem found.		Note (smartcom): Tested on Windows Vista and on Windows 7 64 bit and no problem found.
	<highlight-nsis>		<highlight-nsis>
	Function .onInit		Function .onInit

PeterMortensen: /* The advanced way */ Copy edited.

2013-05-06T20:28:26Z

The advanced way: Copy edited.

â† Older revision		Revision as of 20:28, 6 May 2013
Line 27:		Line 27:
	== The advanced way ==		== The advanced way ==
	This code will bring the already running instance to front, instead of opening a new one.		This code will bring the already running instance to front, instead of opening a new one.
	Side Note (Jamyn): Strangely, if the user has first minimized the installer, and then tries to launch another copy, the following code will correctly set the first installer as the active window, but won't "pop" it back up from being minimized. ~~Not~~ sure how to do that simply, but that may be useful.		Side Note (Jamyn): Strangely, if the user has first minimized the installer, and then tries to launch another copy, the following code will correctly set the first installer as the active window, but it won't "pop" it back up from being minimized. I am not sure how to do that simply, but that may be useful.
	Note ([http://www.emsai.net Rescator]): Try something like System::Call "user32::ShowWindow(i r1,i 9) i." The 9 is the flag #SW_RESTORE see PSDK for more info on ShowWindow()		Note ([http://www.emsai.net Rescator]): Try something like System::Call "user32::ShowWindow(i r1, i 9) i." The 9 is the flag #SW_RESTORE see PSDK for more info on ShowWindow()

	<highlight-nsis>		<highlight-nsis>

PeterMortensen: /* Unicode warning */ Grammar.

2013-05-06T20:26:38Z

Unicode warning: Grammar.

â† Older revision		Revision as of 20:26, 6 May 2013
Line 7:		Line 7:

	== Unicode warning ==		== Unicode warning ==
	Warning! You should use "CreateMutexW" instead of "CreateMutexA" for unicode NSIS! Using wrong one like		Warning! You should use "CreateMutexW" instead of "CreateMutexA" for unicode NSIS! Using a wrong one like
	<highlight-nsis>		<highlight-nsis>
	System::Call 'kernel32::CreateMutexA(i 0, i 0, t "abcdef") ?e'		System::Call 'kernel32::CreateMutexA(i 0, i 0, t "abcdef") ?e'
	</highlight-nsis>		</highlight-nsis>
	will silently create mutex named "a", not "abcdef"!		will silently create a mutex named "a", not "abcdef"!

	You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0		You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0

121.54.15.74: /* Description */

2013-02-25T08:12:58Z

Description

â† Older revision		Revision as of 08:12, 25 February 2013
Line 5:		Line 5:

	Put this code in the .onInit function:		Put this code in the .onInit function:


	== Unicode warning ==		== Unicode warning ==

Sanya Zol: Added "Unicode warning", "See also"

2012-08-18T18:19:43Z

Added "Unicode warning", "See also"

â† Older revision		Revision as of 18:19, 18 August 2012
Line 5:		Line 5:

	Put this code in the .onInit function:		Put this code in the .onInit function:


			== Unicode warning ==
			Warning! You should use "CreateMutexW" instead of "CreateMutexA" for unicode NSIS! Using wrong one like
			<highlight-nsis>
			System::Call 'kernel32::CreateMutexA(i 0, i 0, t "abcdef") ?e'
			</highlight-nsis>
			will silently create mutex named "a", not "abcdef"!

			You can list all mutex objects using [http://processhacker.sourceforge.net/ process hacker] - open process properties, handles tab: Mutant, \BaseNamedObjects\myMutex, 0xd0

	== The Script ==		== The Script ==
Line 61:		Line 71:
	FunctionEnd		FunctionEnd
	</highlight-nsis>		</highlight-nsis>

			== See also ==
			[[Check whether your application is running]]

	[[Category:System Plugin Examples]]		[[Category:System Plugin Examples]]

95.149.148.237: Comment on suspected problem in code

2012-08-15T10:26:42Z

Comment on suspected problem in code

â† Older revision		Revision as of 10:26, 15 August 2012
Line 39:		Line 39:
	== Even more advanced ==		== Even more advanced ==
	This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized. Note (Akshay): I tested this and it works on XPx64 but on Win7 the installer fails saying "Installer integrity check has failed. Common causes include incomplete download and damaged media. Contact the installer's author to obtain a new copy. More informations at http://nsis.sf.net/NSIS_Error"		This uses the "advanced way" method. Unlike the function above, it will restore the window if the installer is minimized. Note (Akshay): I tested this and it works on XPx64 but on Win7 the installer fails saying "Installer integrity check has failed. Common causes include incomplete download and damaged media. Contact the installer's author to obtain a new copy. More informations at http://nsis.sf.net/NSIS_Error"
			Note (smartcom): Tested on Vista and on Win 7 64 bit and no problem found.
	<highlight-nsis>		<highlight-nsis>
	Function .onInit		Function .onInit