From 48b9003ca13f9f0a077e1d6b96272870a0ca7b2b Mon Sep 17 00:00:00 2001 From: joostverburg Date: Mon, 28 Jan 2008 21:46:31 +0000 Subject: [PATCH] * added some comments * added settings for registry key that enables the installation mode to be set to the mode from a previous installation * fixed a few typos git-svn-id: https://svn.code.sf.net/p/nsis/code/NSIS/trunk@5498 212acab6-be3b-0410-9dea-997c60f758d6 --- Contrib/MultiUser/MultiUser.nsh | 67 ++++++- Contrib/MultiUser/Readme.html | 318 +++++++++++++++++--------------- 2 files changed, 236 insertions(+), 149 deletions(-) diff --git a/Contrib/MultiUser/MultiUser.nsh b/Contrib/MultiUser/MultiUser.nsh index 37d5c762..78f3202c 100644 --- a/Contrib/MultiUser/MultiUser.nsh +++ b/Contrib/MultiUser/MultiUser.nsh @@ -13,6 +13,8 @@ Copyright !verbose push !verbose 3 +;Standard NSIS header files + !ifdef MULTIUSER_MUI !include MUI2.nsh !endif @@ -21,9 +23,13 @@ Copyright !include WinVer.nsh !include FileFunc.nsh +;Variables + Var MultiUser.Privileges Var MultiUser.InstallMode +;Command line installation mode setting + !ifdef MULTIUSER_INSTALLMODE_COMMANDLINE !insertmacro GetParameters !ifndef MULTIUSER_NOUNINSTALLER @@ -36,13 +42,21 @@ Var MultiUser.InstallMode !endif Var MultiUser.Parameters - Var MultiUser.Result + Var MultiUser.Result !endif +;Installation folder stored in registry + !ifdef MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY & MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME Var MultiUser.InstDir !endif +!ifdef MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY & MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME + Var MultiUser.DefaultKeyValue +!endif + +;Windows Vista UAC setting + !if "${MULTIUSER_EXECUTIONLEVEL}" == Admin RequestExecutionLevel admin !define MULTIUSER_EXECUTIONLEVEL_ALLUSERS @@ -64,6 +78,8 @@ Install modes !macro MULTIUSER_INSTALLMODE_ALLUSERS UNINSTALLER_PREFIX UNINSTALLER_FUNCPREFIX + ;Install mode initialization - per-machine + ${ifnot} ${IsNT} ${orif} $MultiUser.Privileges == "Admin" ${orif} $MultiUser.Privileges == "Power" @@ -78,7 +94,7 @@ Install modes !ifdef MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY & MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME - ReadRegStr $MultiUser.InstDir SHELL_CONTEXT "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME}" + ReadRegStr $MultiUser.InstDir HKLM "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME}" ${if} $MultiUser.InstDir != "" StrCpy $INSTDIR $MultiUser.InstDir @@ -95,6 +111,8 @@ Install modes !macroend !macro MULTIUSER_INSTALLMODE_CURRENTUSER UNINSTALLER_PREFIX UNINSTALLER_FUNCPREFIX + + ;Install mode initialization - per-user ${if} ${IsNT} @@ -112,7 +130,7 @@ Install modes !ifdef MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY & MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME - ReadRegStr $MultiUser.InstDir SHELL_CONTEXT "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME}" + ReadRegStr $MultiUser.InstDir HKCU "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME}" ${if} $MultiUser.InstDir != "" StrCpy $INSTDIR $MultiUser.InstDir @@ -182,6 +200,8 @@ Installer/uninstaller initialization !macro MULTIUSER_INIT_CHECKS UNINSTALLER_PREFIX UNINSTALLER_FUNCPREFIX + ;Installer initialization - check privileges and set install mode + !insertmacro MULTIUSER_INIT_TEXTS UserInfo::GetAccountType @@ -189,6 +209,8 @@ Installer/uninstaller initialization ${if} ${IsNT} + ;Check privileges + !if "${MULTIUSER_EXECUTIONLEVEL}" == Admin ${if} $MultiUser.Privileges != "Admin" @@ -209,9 +231,11 @@ Installer/uninstaller initialization ${endif} !endif - + !ifdef MULTIUSER_EXECUTIONLEVEL_ALLUSERS + ;Default to per-machine installation if possible + ${if} $MultiUser.Privileges == "Admin" ${orif} $MultiUser.Privileges == "Power" !ifndef MULTIUSER_INSTALLMODE_DEFAULT_CURRENTUSER @@ -219,6 +243,31 @@ Installer/uninstaller initialization !else Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.CurrentUser !endif + + !ifdef MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY & MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME + + ;Set installation mode to setting from a previous installation + + !ifndef MULTIUSER_INSTALLMODE_DEFAULT_CURRENTUSER + ReadRegStr $MultiUser.DefaultKeyValue HKLM "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME}" + ${if} $MultiUser.DefaultKeyValue == "" + ReadRegStr $MultiUser.DefaultKeyValue HKCU "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME}" + ${if} $MultiUser.DefaultKeyValue != "" + Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.AllUsers + ${endif} + ${endif} + !else + ReadRegStr $MultiUser.DefaultKeyValue HKCU "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME}" + ${if} $MultiUser.DefaultKeyValue == "" + ReadRegStr $MultiUser.DefaultKeyValue HKLM "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY}" "${MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME}" + ${if} $MultiUser.DefaultKeyValue != "" + Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.CurrentUser + ${endif} + ${endif} + !endif + + !endif + ${else} Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.CurrentUser ${endif} @@ -227,9 +276,11 @@ Installer/uninstaller initialization Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.CurrentUser - !endif + !endif !ifdef MULTIUSER_INSTALLMODE_COMMANDLINE + + ;Check for install mode setting on command line ${${UNINSTALLER_FUNCPREFIX}GetParameters} $MultiUser.Parameters @@ -254,6 +305,8 @@ Installer/uninstaller initialization ${else} + ;Not running Windows NT, per-user installation not supported + Call ${UNINSTALLER_FUNCPREFIX}MultiUser.InstallMode.AllUsers ${endif} @@ -333,6 +386,8 @@ Modern UI 2 page !macro MULTIUSER_PAGE_INSTALLMODE + ;Modern UI page for install mode + !verbose push !verbose 3 @@ -349,6 +404,8 @@ Modern UI 2 page !macro MULTIUSER_FUNCTION_INSTALLMODEPAGE PRE LEAVE + ;Page functions of Modern UI page + Function "${PRE}" ${ifnot} ${IsNT} diff --git a/Contrib/MultiUser/Readme.html b/Contrib/MultiUser/Readme.html index ba439066..7d2a729b 100644 --- a/Contrib/MultiUser/Readme.html +++ b/Contrib/MultiUser/Readme.html @@ -145,7 +145,7 @@ FunctionEnd have the required privileges. After the macros are inserted, the variable $MultiUser.Privileges will contain the current execution level (Admin, Power, User or Guest).

- The following additonal settings are available to customize the initialization:

+ The following additional settings are available to customize the initialization:

@@ -185,7 +185,8 @@ FunctionEnd MULTIUSER_INIT_UNFUNCTIONQUIT - A custom fuction to be called when the installer is closed due to insufficient privileges. + A custom function to be called when the installer is closed due to insufficient + privileges.
@@ -202,27 +203,56 @@ FunctionEnd if Administrator or Power User rights are available (this is always the case if the execution level is set to Admin or Power, if Highest is set it depends on the user account). For the Standard execution level the installation will always be - for a single user. If you prefer the default to be a per-user installation even - though the rights for a per-machine installation are available, define MULTIUSER_INSTALLMODE_DEFAULT_CURRENTUSER - before including User.nsh. On Windows 95/98/Me installation for a single user is - not possible.

-

- After initialization, the variable $MultiUser.InstallMode will contain the current installation - mode (AllUsers or CurrentUser). -

-

- Mixed-Mode Installation

+ for a single user. On Windows 95/98/Me installation for a single user is not possible.

- For the Admin and Power levels, both a per-machine as well as a per-user installation - is possible. If the Highest level is set and the user is an Administrator or Power - User, both options are also available.

-

- Usually it's a good thing to give the user to choice between these options. For - users of the Modern UI version 2, a page is provided that asks the user for the - installation mode. To use this page, define MULTIUSER_MUI before including User.nsh. - Then, the MULTIUSER_PAGE_INSTALLMODE macro can be used just like a normal Modern - UI page (this page will automatically be skipped when running Windows 95/98/Me):

- 
!define MULTIUSER_EXECUTIONLEVEL Highest
+        The following settings are available to change the default installation mode:
+        
+            
+                
+                
+                
+            
+            
+                
+                
+            
+            
+                
+                
+            
+        

+                    Setting
+                
+                    Description
+                

+                    MULTIUSER_INSTALLMODE_DEFAULT_CURRENTUSER
+                
+                    Set default to a per-user installation, even if the rights for a per-machine installation
+                    are available.
+                

+                    MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_KEY MULTIUSER_INSTALLMODE_DEFAULT_REGISTRY_VALUENAME
+                
+                    Non-empty registry key that is created during the installation in either HKCU or
+                    HKLM. The default installation mode will automatically be set to the previously
+                    selected mode depending on the location of the key.
+                

+        

+            After initialization, the variable $MultiUser.InstallMode will contain the current
+            installation mode (AllUsers or CurrentUser).
+        

+        

+            Mixed-Mode Installation

+        

+            For the Admin and Power levels, both a per-machine as well as a per-user installation
+            is possible. If the Highest level is set and the user is an Administrator or Power
+            User, both options are also available.

+        

+            Usually it's a good thing to give the user to choice between these options. For
+            users of the Modern UI version 2, a page is provided that asks the user for the
+            installation mode. To use this page, define MULTIUSER_MUI before including User.nsh.
+            Then, the MULTIUSER_PAGE_INSTALLMODE macro can be used just like a normal Modern
+            UI page (this page will automatically be skipped when running Windows 95/98/Me):

+        
!define MULTIUSER_EXECUTIONLEVEL Highest
 !define MULTIUSER_MUI
 !define MULTIUSER_INSTALLMODE_COMMANDLINE
 !include MultiUser.nsh
@@ -244,131 +274,131 @@ Function un.onInit
   !insertmacro MULTIUSER_UNINIT
 FunctionEnd
 

-    

-        The MULTIUSER_INSTALLMODE_COMMANDLINE setting that also appears in this example
-        enables the installation mode to be set using the /AllUsers or /CurrentUser command
-        line parameters. This is especially useful for silent setup.

-    

-        The following settings can be used to customize the texts on the page (in addition
-        to the general Modern UI page settings):

-    
-        
-            
-            
-        
-        
-            
-            
-        
-        
-            
-            
-        
-        
-            
-            
-        
-    

-                Setting
-            
-                Description
-            

-                MULTIUSER_INSTALLMODEPAGE_TEXT_TOP
-            
-                Text to display on the top of the page.
-            

-                MULTIUSER_INSTALLMODEPAGE_TEXT_ALLUSERS
-            
-                Text to display on the combo button for a per-machine installation.
-            

-                MULTIUSER_INSTALLMODEPAGE_TEXT_CURRENTUSER
-            
-                Text to display on the combo button for a per-user installation.
-            

-    

-        Installation Mode Initalization

-    

-        The SetShellVarContext flag (which determines the folders for e.g. shortcuts, like
-        $DESKTOP) is automatically set depending on the installation mode. In addition,
-        the following settings can be used to perform additional actions when the installation
-        mode is initialized:

-    
-        
-            
-            
-            
-        
-        
-            
-            
-        
-        
-            
-            
-        
-        
-            
-            
-    

-                Setting
-            
-                Description
-            

-                MULTIUSER_INSTALLMODE_INSTDIR
-            
-                Name of the folder in which to install the application, without a path. This folder
-                will be located in Program Files for a per-machine installation and in the local
-                Application Data folder for a per-user installation (if supported).
-            

-                MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME
-            
-                Registry key from which to obtain a previously stored installation folder. It will
-                be retrieved from HKCU for per-user and HKLM for per-machine.
-            

-                MULTIUSER_INSTALLMODE_FUNCTION

-                MULTIUSER_INSTALLMODE_UNFUNCTION
-            		
-                A custom fuction to be called during the initialization of the installation mode
-                to set additional installer settings that depend on the mode
-            

-    

-        To set the installation mode manually, call one of these four functions:

-    
-        
-            
-            
-        
-        
-            
-            
-        
-        
-            
+            
+            
+                
+                
+            
+            
+                
+                
+            
+        

-                Function name
-            
-                Installation mode
-            

-                MultiUser.InstallMode.AllUsers
-            
-                Installer: Per-machine installation
-            

-                MultiUser.InstallMode.CurrentUser
+        

+            The MULTIUSER_INSTALLMODE_COMMANDLINE setting that also appears in this example
+            enables the installation mode to be set using the /AllUsers or /CurrentUser command
+            line parameters. This is especially useful for silent setup.

+        

+            The following settings can be used to customize the texts on the page (in addition
+            to the general Modern UI page settings):

+        
+            
-        
-        
-            
-        
-        
-            
+            
+                
-        
-    

                 
-                    Installer: Per-user installation
+                    Setting
                 

-                un.MultiUser.InstallMode.AllUsers
-                    Uninstaller: Per-machine installation
+                
+                    Description
                 

-                un.MultiUser.InstallMode.CurrentUser
-                    Uninstaller: Per-user installation
+            

+                    MULTIUSER_INSTALLMODEPAGE_TEXT_TOP
                 

+                		
+                    Text to display on the top of the page.
+                

+                    MULTIUSER_INSTALLMODEPAGE_TEXT_ALLUSERS
+                
+                    Text to display on the combo button for a per-machine installation.
+                

+                    MULTIUSER_INSTALLMODEPAGE_TEXT_CURRENTUSER
+                
+                    Text to display on the combo button for a per-user installation.
+                

+        

+            Installation Mode Initalization

+        

+            The SetShellVarContext flag (which determines the folders for e.g. shortcuts, like
+            $DESKTOP) is automatically set depending on the installation mode. In addition,
+            the following settings can be used to perform additional actions when the installation
+            mode is initialized:

+        
+            
+                
+                
+                
+            
+            
+                
+                
+            
+            
+                
+                
+            
+            
+                
+                
+        

+                    Setting
+                
+                    Description
+                

+                    MULTIUSER_INSTALLMODE_INSTDIR
+                
+                    Name of the folder in which to install the application, without a path. This folder
+                    will be located in Program Files for a per-machine installation and in the local
+                    Application Data folder for a per-user installation (if supported).
+                

+                    MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_KEY MULTIUSER_INSTALLMODE_INSTDIR_REGISTRY_VALUENAME
+                
+                    Registry key from which to obtain a previously stored installation folder. It will
+                    be retrieved from HKCU for per-user and HKLM for per-machine.
+                

+                    MULTIUSER_INSTALLMODE_FUNCTION

+                    MULTIUSER_INSTALLMODE_UNFUNCTION
+                		
+                    A custom fuction to be called during the initialization of the installation mode
+                    to set additional installer settings that depend on the mode
+                

+        

+            To set the installation mode manually, call one of these four functions:

+        
+            
+                
+                
+            
+            
+                
+                
+            
+            
+                
+            
+            
+                
+            
+            
+                
+            
+        

+                    Function name
+                
+                    Installation mode
+                

+                    MultiUser.InstallMode.AllUsers
+                
+                    Installer: Per-machine installation
+                

+                    MultiUser.InstallMode.CurrentUser
+                    
+                        Installer: Per-user installation
+                    

+                    un.MultiUser.InstallMode.AllUsers
+                        Uninstaller: Per-machine installation
+                    

+                    un.MultiUser.InstallMode.CurrentUser
+                        Uninstaller: Per-user installation
+