NSIS Wiki - User contributions [en]

Unicode plug-in

2007-11-28T09:59:41Z

Intersol: /* Description */

{{PageAuthor|Instructor}}

== Links ==

Download v1.0: 
<attach>Unicode.zip</attach>

Discussion: 
[http://forums.winamp.com/showthread.php?s=&threadid=218714 Forum thread]

== Description ==

This is NSIS plug-in for Unicode files conversion.

'''Features:'''
*Convert file from Unicode to ANSI
*Convert file from ANSI to Unicode
**Conversions supported:
         "UTF-8"       <-> ANSI
          "UTF-16LE" <-> ANSI
          "UTF-16BE" <-> ANSI
*Get file unicode type:
         "NONE"                      - None Unicode
          "UTF-8"                      - 8-bit Variable Width (Web)
          "UTF-16LE|UCS-2LE" - 16-bit Little Endian (Default for Windows)
          "UTF-16BE|UCS-2BE" - 16-bit Big Endian (Default for Linux)
          "UTF-32LE|UCS-4LE" - 32-bit Little Endian
          "UTF-32BE|UCS-4BE" - 32-bit Big Endian

== Related ==
* [http://sourceforge.net/projects/nsisu/ NSIS Unicode build] - a branch of NSIS for building unicode installers
[[Category:Plugins]]

Talk:Check if the current user is an Administrator

2007-11-24T13:27:21Z

Intersol:

Macro 2 crashed.

Since some users still use NT4, I tried the second version first. When testing as an administrator, it worked. When testing as plain user, the installer crashed on a WinXPSP2-system.

Solution: Macro 1 works, so I use that one instead, and assume that all NT4-users are administrators.

How about Vista? Does it work in Vista? We need to specify this.

Check if the current user is an Administrator

2007-11-24T13:26:38Z

Intersol: /* Macro 2 (NT/2k/XP/2k3) - doen't work! */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doesn't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

Check if the current user is an Administrator

2007-11-24T13:26:17Z

Intersol: /* Macro 2 (NT/2k/XP/2k3) */

{{PageAuthor|CancerFace}}

NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]

== Description ==
I wanted to have the option of checking if a user belongs to the adminisrator's group without using a special plugin. This can be achieved using API calls with the System plugin.

== Macros ==
The first macro works only in Windows 2000, XP and 2003 while the second one also works in NT
=== Usage ===
Use the following code in your NSIS installer to find out if the user invoking it belongs to the administrator's group:
<highlight-nsis>
!insertmacro IsUserAdmin $0
; $0 = 1 if the user belongs to the administrator's group
; $0 = 0 if not
; $0 = -1 if there was an error (only for the 1st Macro)
</highlight-nsis>

=== Macro 1 (2k/XP/2k3)===
<highlight-nsis>
!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0
System::Call '*(&i1 0,&i4 0,&i1 5)i.r0'
System::Call 'advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0, \
i 0,*i .R0)i.r5'
System::Free $0
System::Call 'advapi32::CheckTokenMembership(i n,i R0,*i .R1)i.r5'
StrCmp $5 0 ${Index}_Error
StrCpy ${RESULT} $R1
Goto ${Index}_End
${Index}_Error:
StrCpy ${RESULT} -1
${Index}_End:
System::Call 'advapi32::FreeSid(i R0)i.r5'
!undef Index
!macroend
</highlight-nsis>

=== Macro 2 (NT/2k/XP/2k3) - doen't work! ===
<highlight-nsis>
!define TOKEN_READ 0x00020008
!define TokenGroups 2

!macro IsUserAdmin RESULT
!define Index "Line${__LINE__}"
StrCpy ${RESULT} 0

# Construct the SID for the Admin group - (S-1-5-32-544 for administrators) put in $R4
System::Call "*(&i1 0,&i4 0,&i1 5)i.r0"
System::Call "advapi32::AllocateAndInitializeSid(i r0,i 2,i 32,i 544,i 0,i 0,i 0,i 0,i 0,\
i 0,*i .R4)i.r5"
System::Free $0

# Get a psuedo-handle of the current process and place it on R0
System::Call 'kernel32::GetCurrentProcess()i.R0'

# Open the Token from the psuedo process and place the handle on R1
System::Call 'advapi32::OpenProcessToken(i R0,i ${TOKEN_READ},*i .R1)i.R9'

# Get info from the token and place it in $R2 (the size goes to $R3)
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},*i .R2,i 0,*i .R3)i.R9'
System::Alloc $R3
Pop $R2
System::Call 'advapi32::GetTokenInformation(i R1,i ${TokenGroups},i R2,i $R3,*i .R3)i.R9'

# Check how many TOKEN_GROUPS elements are in $R2 (place the number in $R5)
System::Call '*$R2(i.R5,i.R6)'

# Compare the SID structures
StrCpy $1 0

${Index}_Start:
StrCmp $1 $R5 ${Index}_Stop
System::Call 'advapi32::EqualSid(i R4,i R6)i.R9'
StrCmp $R9 "" ${Index}_Increment
StrCmp $R9 0 +1 +3
StrCpy ${RESULT} 0
Goto ${Index}_Increment
StrCpy ${RESULT} 1
System::Call 'advapi32::FreeSid(i R6)i.R8'
Goto ${Index}_Stop
${Index}_Increment:
System::Call 'advapi32::GetLengthSid(i R6)i.R9'
System::Call 'advapi32::FreeSid(i R6)i.R8'
IntOp $R6 $R6 + $R9
IntOp $1 $1 + 1
Goto ${Index}_Start

${Index}_Stop:
# Close the token handle
System::Call 'kernel32::CloseHandle(i R1)i.R9'

# cleanup
System::Call 'advapi32::FreeSid(i R4)i.r5'
System::Free $R2
System::Free 0

!undef Index
!macroend
</highlight-nsis>

== Resources and Links ==
* NSIS forum [http://forums.winamp.com/showthread.php?s=&threadid=253904 thread]
* [http://nsis.sourceforge.net/XtInfoPlugin_plug-in XtInfo Plugin]

API Functions used:
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/netmgmt/netmgmt/netuseradd.asp AllocateAndInitializeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dllproc/base/getcurrentprocess.asp GetCurrentProcess]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/openprocesstoken.asp OpenProcessToken]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/gettokeninformation.asp GetTokenInformation]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/equalsid.asp EqualSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/freesid.asp FreeSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/secauthz/security/getlengthsid.asp GetLengthSid]
* [http://msdn.microsoft.com/library/default.asp?url=/library/en-us/sysinfo/base/closehandle.asp CloseHandle]

----

[[Category:User Accounts Related Functions]]

File Association

2007-11-24T11:26:32Z

Intersol:

{{PageAuthor|Vytautas}}
{{PageAuthor|intersol}}

== Description ==
Macro for registering and unregistering file extensions in NSIS scripts.

== Usage ==
<highlight-nsis>
!include "registerExtension.nsh"
...
# later, inside a section:
${registerExtension} "c:\myplayer.exe" ".mkv" "MKV File"

${unregisterExtension} ".mkv" "MKV File"

</highlight-nsis>

== registerExtension.nsh ==
<highlight-nsis>
!define registerExtension "!insertmacro registerExtension"
!define unregisterExtension "!insertmacro unregisterExtension"

!macro registerExtension executable extension description
Push "${executable}" ; "full path to my.exe"
Push "${extension}" ; ".mkv"
Push "${description}" ; "MKV File"
Call registerExtension
!macroend

; back up old value of .opt
Function registerExtension
!define Index "Line${__LINE__}"
pop $R0 ; ext name
pop $R1
pop $R2
push $1
push $0
ReadRegStr $1 HKCR $R1 ""
StrCmp $1 "" "${Index}-NoBackup"
StrCmp $1 "OptionsFile" "${Index}-NoBackup"
WriteRegStr HKCR $R1 "backup_val" $1
"${Index}-NoBackup:"
WriteRegStr HKCR $R1 "" $R0
ReadRegStr $0 HKCR $R0 ""
StrCmp $0 "" 0 "${Index}-Skip"
WriteRegStr HKCR $R0 "" $R0
WriteRegStr HKCR "$R0\shell" "" "open"
WriteRegStr HKCR "$R0\DefaultIcon" "" "$R2,0"
"${Index}-Skip:"
WriteRegStr HKCR "$R0\shell\open\command" "" '$R2 "%1"'
WriteRegStr HKCR "$R0\shell\edit" "" "Edit $R0"
WriteRegStr HKCR "$R0\shell\edit\command" "" '$R2 "%1"'
pop $0
pop $1
!undef Index
FunctionEnd

!macro unregisterExtension extension description
Push ${extension} ; ".mkv"
Push ${description} ; "MKV File"
Call unregisterExtension
!macroend

Function unregisterExtension
pop $R1 ; description
pop $R0 ; extension
!define Index "Line${__LINE__}"
ReadRegStr $1 HKCR $R0 ""
StrCmp $1 $R1 0 "${Index}-NoOwn" ; only do this if we own it
ReadRegStr $1 HKCR $R0 "backup_val"
StrCmp $1 "" 0 "${Index}-Restore" ; if backup="" then delete the whole key
DeleteRegKey HKCR $R0
Goto "${Index}-NoOwn"
"${Index}-Restore:"
WriteRegStr HKCR $R0 "" $1
DeleteRegValue HKCR $R0 "backup_val"
DeleteRegKey HKCR $R1 ;Delete key with association name settings
"${Index}-NoOwn:"
!undef Index
FunctionEnd
</highlight-nsis>

== Info ==
Any refereces to execute.exe should be replaced with the appropriate command to perform the specified action.

This page was based on information provided in "Examples\makensis.nsi" and this thread: [http://forums.winamp.com/showthread.php?s=&threadid=140254 http://forums.winamp.com/showthread.php?s=&threadid=140254]

Vytautas

[[Category:System Related Functions]]
[[Category:Scripting FAQ|How can I associate a file extension with my application?]]

File Association

2007-11-24T11:25:44Z

Intersol: Replaced the register/unregister file extension macro/function

{{PageAuthor|Vytautas}}
{{PageAuthor|intersol}}

== Description ==
Macro for registering and unregistering file extensions in NSIS scripts.

== Usage ==
<highlight-nsis>
!include "registerExtension.nsh"
...
# later, inside a section:
${registerExtension} "c:\myplayer.exe" ".mkv" "MKV File"

${unregisterExtension} ".mkv" "MKV File"

</highlight-nsis>

{| border=1 cellspacing=0
|-
! Token
! Description
|-
| ".opt"
| Is the extention of your choice
|-
| "OptionsFile"
| Is the general description of the file. Make sure NOT TO USE GENERIC DESCRIPTIONS or descriptions IN USE BY OTHER APPLICATIONS. Use a format like ApplicationName.FileType. If the application name is too generic add for example the company name.
|-
| "Program Options File"
| Is the windows description of the file
|-
| "open" & "Edit Options File"
| Are descriptions of the action performed by the following commands
|}

== registerExtension.nsh ==
<highlight-nsis>
!define registerExtension "!insertmacro registerExtension"
!define unregisterExtension "!insertmacro unregisterExtension"

!macro registerExtension executable extension description
Push "${executable}" ; "full path to my.exe"
Push "${extension}" ; ".mkv"
Push "${description}" ; "MKV File"
Call registerExtension
!macroend

; back up old value of .opt
Function registerExtension
!define Index "Line${__LINE__}"
pop $R0 ; ext name
pop $R1
pop $R2
push $1
push $0
ReadRegStr $1 HKCR $R1 ""
StrCmp $1 "" "${Index}-NoBackup"
StrCmp $1 "OptionsFile" "${Index}-NoBackup"
WriteRegStr HKCR $R1 "backup_val" $1
"${Index}-NoBackup:"
WriteRegStr HKCR $R1 "" $R0
ReadRegStr $0 HKCR $R0 ""
StrCmp $0 "" 0 "${Index}-Skip"
WriteRegStr HKCR $R0 "" $R0
WriteRegStr HKCR "$R0\shell" "" "open"
WriteRegStr HKCR "$R0\DefaultIcon" "" "$R2,0"
"${Index}-Skip:"
WriteRegStr HKCR "$R0\shell\open\command" "" '$R2 "%1"'
WriteRegStr HKCR "$R0\shell\edit" "" "Edit $R0"
WriteRegStr HKCR "$R0\shell\edit\command" "" '$R2 "%1"'
pop $0
pop $1
!undef Index
FunctionEnd

!macro unregisterExtension extension description
Push ${extension} ; ".mkv"
Push ${description} ; "MKV File"
Call unregisterExtension
!macroend

Function unregisterExtension
pop $R1 ; description
pop $R0 ; extension
!define Index "Line${__LINE__}"
ReadRegStr $1 HKCR $R0 ""
StrCmp $1 $R1 0 "${Index}-NoOwn" ; only do this if we own it
ReadRegStr $1 HKCR $R0 "backup_val"
StrCmp $1 "" 0 "${Index}-Restore" ; if backup="" then delete the whole key
DeleteRegKey HKCR $R0
Goto "${Index}-NoOwn"
"${Index}-Restore:"
WriteRegStr HKCR $R0 "" $1
DeleteRegValue HKCR $R0 "backup_val"
DeleteRegKey HKCR $R1 ;Delete key with association name settings
"${Index}-NoOwn:"
!undef Index
FunctionEnd
</highlight-nsis>

== Info ==
Any refereces to execute.exe should be replaced with the appropriate command to perform the specified action.

This page was based on information provided in "Examples\makensis.nsi" and this thread: [http://forums.winamp.com/showthread.php?s=&threadid=140254 http://forums.winamp.com/showthread.php?s=&threadid=140254]

Vytautas

[[Category:System Related Functions]]
[[Category:Scripting FAQ|How can I associate a file extension with my application?]]