StdUtils plug-in - Revision history

Bugmenot: link to proper en.wiki page

2022-03-09T16:42:58Z

link to proper en.wiki page

â† Older revision		Revision as of 16:42, 9 March 2022
Line 2:		Line 2:
	[[Category:Plugins]]		[[Category:Plugins]]

	<b>Swiss Army Knife for NSIS</b> – This plug-in provides access to a number of "standard" functions from the [~~http~~:~~//en.~~wikipedia~~.org/wiki/C_standard_library~~ C Standard Library], which programmers are used to from C/C++ and other "high level" languages, but which are <i>not</i> normally available in NSIS. In order to keep the plug-in size as small as possible and for maximum compatibility, the Visual C++ Runtime v6.0 "MSVCRT.DLL" is used, which is an integral part of all versions of Windows (since Windows 2000). This means that the C++ Runtime neither needs to be shipped as a separate DLL nor does it need to be linked <i>statically</i> into the plug-in.		<b>Swiss Army Knife for NSIS</b> – This plug-in provides access to a number of "standard" functions from the [[:wikipedia:C Standard Library\|C Standard Library]], which programmers are used to from C/C++ and other "high level" languages, but which are <i>not</i> normally available in NSIS. In order to keep the plug-in size as small as possible and for maximum compatibility, the Visual C++ Runtime v6.0 "MSVCRT.DLL" is used, which is an integral part of all versions of Windows (since Windows 2000). This means that the C++ Runtime neither needs to be shipped as a separate DLL nor does it need to be linked <i>statically</i> into the plug-in.

	Many additional functions, <i>not</i> directly related to the C Standard Library, have been added over the years: For example, this plug-in provides a number convenience functions to deal with <i>strings</i>, such as trimming whitespaces or validating a given file name. There also are some functions to conveniently access the <i>command-line parameters</i> that have been passed to the installer. Furthermore, there is a wrapper for the [http://msdn.microsoft.com/en-us/library/windows/desktop/bb762164%28v=vs.85%29.aspx SHFileOperation] function, which can be used to <i>copy or move files</i> using the Windows Shell, as well as a function to efficiently <i>append</i> the contents of one file to another file. Moreover, the plug-in provides a method for launching programs in a <i>non-elevated</i> way (aka "user mode") from an installer that is running in <i>elevated</i> context (aka "admin mode"). In addition to that, there is a set of functions that can be used to detect the <i>real</i> Windows version that the installer is running on, which still work correctly/reliably on Windows 8.1 (and later) where Microsoft has <i style="color:darkred">broken</i> the GetVersionEx() system function. And, as if this wasn't enough, the plug-in can compute the <i>cryptographic hash</i> of a given file or text message, using various state-of-the-art hash functions, including SHA-{1,2,3}. Last but not least, the plug-in provides a variant of <tt>ExecShell</tt> with "wait for process termination" feature, based on [http://msdn.microsoft.com/en-us/library/windows/desktop/bb762154%28v=vs.85%29.aspx ShellExecuteEx], as well as a function for invoking "shell verbs" – useful for programmatically <i>pinning shortcuts to the Taskbar</i>.		Many additional functions, <i>not</i> directly related to the C Standard Library, have been added over the years: For example, this plug-in provides a number convenience functions to deal with <i>strings</i>, such as trimming whitespaces or validating a given file name. There also are some functions to conveniently access the <i>command-line parameters</i> that have been passed to the installer. Furthermore, there is a wrapper for the [http://msdn.microsoft.com/en-us/library/windows/desktop/bb762164%28v=vs.85%29.aspx SHFileOperation] function, which can be used to <i>copy or move files</i> using the Windows Shell, as well as a function to efficiently <i>append</i> the contents of one file to another file. Moreover, the plug-in provides a method for launching programs in a <i>non-elevated</i> way (aka "user mode") from an installer that is running in <i>elevated</i> context (aka "admin mode"). In addition to that, there is a set of functions that can be used to detect the <i>real</i> Windows version that the installer is running on, which still work correctly/reliably on Windows 8.1 (and later) where Microsoft has <i style="color:darkred">broken</i> the GetVersionEx() system function. And, as if this wasn't enough, the plug-in can compute the <i>cryptographic hash</i> of a given file or text message, using various state-of-the-art hash functions, including SHA-{1,2,3}. Last but not least, the plug-in provides a variant of <tt>ExecShell</tt> with "wait for process termination" feature, based on [http://msdn.microsoft.com/en-us/library/windows/desktop/bb762154%28v=vs.85%29.aspx ShellExecuteEx], as well as a function for invoking "shell verbs" – useful for programmatically <i>pinning shortcuts to the Taskbar</i>.

Anders: Added category

2022-01-19T21:37:07Z

Added category

â† Older revision		Revision as of 21:37, 19 January 2022
Line 1:		Line 1:
	{{PageAuthor\|LoRd MuldeR}}		{{PageAuthor\|LoRd MuldeR}}
			[[Category:Plugins]]

	<b>Swiss Army Knife for NSIS</b> – This plug-in provides access to a number of "standard" functions from the [http://en.wikipedia.org/wiki/C_standard_library C Standard Library], which programmers are used to from C/C++ and other "high level" languages, but which are <i>not</i> normally available in NSIS. In order to keep the plug-in size as small as possible and for maximum compatibility, the Visual C++ Runtime v6.0 "MSVCRT.DLL" is used, which is an integral part of all versions of Windows (since Windows 2000). This means that the C++ Runtime neither needs to be shipped as a separate DLL nor does it need to be linked <i>statically</i> into the plug-in.		<b>Swiss Army Knife for NSIS</b> – This plug-in provides access to a number of "standard" functions from the [http://en.wikipedia.org/wiki/C_standard_library C Standard Library], which programmers are used to from C/C++ and other "high level" languages, but which are <i>not</i> normally available in NSIS. In order to keep the plug-in size as small as possible and for maximum compatibility, the Visual C++ Runtime v6.0 "MSVCRT.DLL" is used, which is an integral part of all versions of Windows (since Windows 2000). This means that the C++ Runtime neither needs to be shipped as a separate DLL nor does it need to be linked <i>statically</i> into the plug-in.
Line 135:		Line 136:
	* https://bitbucket.org/muldersoft/stdutils.git ([https://bitbucket.org/muldersoft/stdutils/src Browse])		* https://bitbucket.org/muldersoft/stdutils.git ([https://bitbucket.org/muldersoft/stdutils/src Browse])
	* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])		* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])

	~~<br>~~

	~~[https://www.youtube.com/embed/uKUYSl8c-90 🌐]~~

LoRd MuldeR: /* Overview */ Updated function reference

2018-03-29T19:37:26Z

Overview: Updated function reference

â† Older revision		Revision as of 19:37, 29 March 2018
Line 25:		Line 25:
	!define StdUtils.RandMinMax #rand(), as in C standard library, with minimum/maximum value		!define StdUtils.RandMinMax #rand(), as in C standard library, with minimum/maximum value
	!define StdUtils.RandList #rand(), as in C standard library, with list support		!define StdUtils.RandList #rand(), as in C standard library, with list support
			!define StdUtils.RandBytes #Generates random bytes, returned as Base64-encoded string
	!define StdUtils.FormatStr #sprintf(), as in C standard library, one '%d' placeholder		!define StdUtils.FormatStr #sprintf(), as in C standard library, one '%d' placeholder
	!define StdUtils.FormatStr2 #sprintf(), as in C standard library, two '%d' placeholders		!define StdUtils.FormatStr2 #sprintf(), as in C standard library, two '%d' placeholders
Line 37:		Line 38:
	!define StdUtils.ValidFileName #Test whether string is a valid file name - no paths allowed		!define StdUtils.ValidFileName #Test whether string is a valid file name - no paths allowed
	!define StdUtils.ValidPathSpec #Test whether string is a valid full(!) path specification		!define StdUtils.ValidPathSpec #Test whether string is a valid full(!) path specification
			!define StdUtils.ValidDomainName #Test whether string is a valid host name or domain name
			!define StdUtils.StrToUtf8 #Convert string from Unicode (UTF-16) or ANSI to UTF-8 bytes
			!define StdUtils.StrFromUtf8 #Convert string from UTF-8 bytes to Unicode (UTF-16) or ANSI
	!define StdUtils.SHFileMove #SHFileOperation(), using the FO_MOVE operation		!define StdUtils.SHFileMove #SHFileOperation(), using the FO_MOVE operation
	!define StdUtils.SHFileCopy #SHFileOperation(), using the FO_COPY operation		!define StdUtils.SHFileCopy #SHFileOperation(), using the FO_COPY operation
Line 67:		Line 71:
	!define StdUtils.TimerCreate #Create a new event-timer that will be triggered periodically		!define StdUtils.TimerCreate #Create a new event-timer that will be triggered periodically
	!define StdUtils.TimerDestroy #Destroy a running timer created with TimerCreate()		!define StdUtils.TimerDestroy #Destroy a running timer created with TimerCreate()
			!define StdUtils.ProtectStr #Protect a given String using Windows' DPAPI
			!define StdUtils.UnprotectStr #Unprotect a string that was protected via ProtectStr()
	!define StdUtils.GetLibVersion #Get the current StdUtils library version (for debugging)		!define StdUtils.GetLibVersion #Get the current StdUtils library version (for debugging)
	!define StdUtils.SetVerbose #Enable or disable "verbose" mode (for debugging)</highlight-nsis>		!define StdUtils.SetVerbose #Enable or disable "verbose" mode (for debugging)</highlight-nsis>

LoRd MuldeR at 13:32, 21 January 2018

2018-01-21T13:32:22Z

â† Older revision		Revision as of 13:32, 21 January 2018
Line 6:		Line 6:

	Overall I use this plug-in as my "Swiss Army Knife" for all the small things I needed in my NSIS-based installers but that NSIS didn't provide out-of-the-box. <b>ANSI</b> <i>and</i> <b>Unicode</b> builds are provided. Supports all Windows versions, starting with <b>Windows XP</b>.		Overall I use this plug-in as my "Swiss Army Knife" for all the small things I needed in my NSIS-based installers but that NSIS didn't provide out-of-the-box. <b>ANSI</b> <i>and</i> <b>Unicode</b> builds are provided. Supports all Windows versions, starting with <b>Windows XP</b>.

	~~<b style="color:darkred">For details please refer to the [http://muldersoft.com/docs/stdutils_readme.html online documentation], a copy of which is also included in the download package!</b>~~

	== Available Functions ==		== Available Functions ==

LoRd MuldeR: /* Available Functions */

2018-01-21T13:30:00Z

Available Functions

â† Older revision		Revision as of 13:30, 21 January 2018
Line 10:		Line 10:

	== Available Functions ==		== Available Functions ==

			<b style="color:darkred">For details please refer to the [http://muldersoft.com/docs/stdutils_readme.html online documentation], a copy of which is also included in the download package!</b>

			(The documentation can be found at <tt>"Docs\StdUtils\StdUtils.html"</tt> inside the ZIP package)

			=== Overview ===

	The StdUtils plug-in makes the following functions available in NSIS:		The StdUtils plug-in makes the following functions available in NSIS:
Line 65:		Line 71:
	!define StdUtils.GetLibVersion #Get the current StdUtils library version (for debugging)		!define StdUtils.GetLibVersion #Get the current StdUtils library version (for debugging)
	!define StdUtils.SetVerbose #Enable or disable "verbose" mode (for debugging)</highlight-nsis>		!define StdUtils.SetVerbose #Enable or disable "verbose" mode (for debugging)</highlight-nsis>

	~~<b style="color:darkred">For details please refer to the [http://muldersoft.com/docs/stdutils_readme.html online documentation], a copy of which is also included in the download package!</b>~~

	~~(The "offline" documentation can be found at <tt>"Docs\StdUtils\StdUtils.html"</tt> inside the ZIP package)~~

	== General Usage ==		== General Usage ==

LoRd MuldeR: /* Available Functions */

2018-01-21T13:28:57Z

Available Functions

â† Older revision		Revision as of 13:28, 21 January 2018
Line 49:		Line 49:
	!define StdUtils.GetRealOSName #Get the real Windows version, as a "friendly" name		!define StdUtils.GetRealOSName #Get the real Windows version, as a "friendly" name
	!define StdUtils.GetOSEdition #Get the Windows edition, i.e. "workstation" or "server"		!define StdUtils.GetOSEdition #Get the Windows edition, i.e. "workstation" or "server"
			!define StdUtils.GetOSReleaseId #Get the Windows release identifier (on Windows 10)
	!define StdUtils.VerifyOSVersion #Compare real operating system to an expected version number		!define StdUtils.VerifyOSVersion #Compare real operating system to an expected version number
	!define StdUtils.VerifyOSBuildNo #Compare real operating system to an expected build number		!define StdUtils.VerifyOSBuildNo #Compare real operating system to an expected build number
	!define StdUtils.HashText #Compute hash from text string (CRC32, MD5, SHA1/2/3, BLAKE2)		!define StdUtils.HashText #Compute hash from text string (CRC32, MD5, SHA1/2/3, BLAKE2)
	!define StdUtils.HashFile #Compute hash from file (CRC32, MD5, SHA1/2/3, BLAKE2)		!define StdUtils.HashFile #Compute hash from file (CRC32, MD5, SHA1/2/3, BLAKE2)
			!define StdUtils.NormalizePath #Simplifies the path to produce a direct, well-formed path
			!define StdUtils.GetParentPath #Get parent path by removing the last component from the path
			!define StdUtils.SplitPath #Split the components of the given path
			!define StdUtils.GetDrivePart #Get drive component of path
			!define StdUtils.GetDirectoryPart #Get directory component of path
			!define StdUtils.GetFileNamePart #Get file name component of path
			!define StdUtils.GetExtensionPart #Get file extension component of path
	!define StdUtils.TimerCreate #Create a new event-timer that will be triggered periodically		!define StdUtils.TimerCreate #Create a new event-timer that will be triggered periodically
	!define StdUtils.TimerDestroy #Destroy a running timer created with TimerCreate()		!define StdUtils.TimerDestroy #Destroy a running timer created with TimerCreate()

LoRd MuldeR at 18:22, 17 April 2017

2017-04-17T18:22:31Z

â† Older revision		Revision as of 18:22, 17 April 2017
Line 124:		Line 124:
	<br>		<br>

	[https://www.youtube.com/v/uKUYSl8c-90~~?autoplay=1~~ 🌐]		[https://www.youtube.com/embed/uKUYSl8c-90 🌐]

LoRd MuldeR: /* Download */

2017-04-17T15:20:36Z

Download

â† Older revision		Revision as of 15:20, 17 April 2017
Line 124:		Line 124:
	<br>		<br>

	[https://www.youtube.com/v/uKUYSl8c-90?autoplay=1		[https://www.youtube.com/v/uKUYSl8c-90?autoplay=1 🌐]

LoRd MuldeR: /* Download */

2017-04-17T15:19:54Z

Download

â† Older revision		Revision as of 15:19, 17 April 2017
Line 110:		Line 110:
	'''<font color="darkred">Download the <u>latest</u> version from GitHub:</font><br>https://github.com/lordmulder/stdutils/releases/latest'''		'''<font color="darkred">Download the <u>latest</u> version from GitHub:</font><br>https://github.com/lordmulder/stdutils/releases/latest'''

	~~'''~~Other official download mirrors~~:<br>~~		=== Other official download mirrors ===
	* http://sourceforge.net/projects/muldersoft/files/StdUtils-Plugin%20%28NSIS%29/		* http://sourceforge.net/projects/muldersoft/files/StdUtils-Plugin%20%28NSIS%29/
	* https://bitbucket.org/muldersoft/stdutils/downloads		* https://bitbucket.org/muldersoft/stdutils/downloads
Line 122:		Line 122:
	* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])		* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])

	~~== Support ==~~		<br>

	~~If you have any feature requests or bug reports, please submit them directly to our GitHub bug-tracker:<br>~~		[https://www.youtube.com/v/uKUYSl8c-90?autoplay=1
	https://~~github~~.com/~~lordmulder/stdutils~~/~~issues~~

	~~For help and support, please use the "NSIS Discussion" sub~~-~~forum of the Winamp forums:<br>~~
	~~http://forums.winamp.com/forumdisplay.php~~?f=65

	~~Contact by E-Mail - please do '''''not''''' use this method, if any of the above methods is applicable for you:<br>~~
	~~<tt>MuldeR2 (at) gmx (dot) de</tt>~~

	~~[[Category:Plugins]]~~
	~~[[Category:Disk, Path & File Functions‏‎]]~~
	~~[[Category:Date & Time Functions]]~~
	~~[[Category:Internet Functions‏‎]]~~

LoRd MuldeR: /* Download */

2017-04-17T15:17:47Z

Download

â† Older revision		Revision as of 15:17, 17 April 2017
Line 112:		Line 112:
	'''Other official download mirrors:<br>		'''Other official download mirrors:<br>
	* http://sourceforge.net/projects/muldersoft/files/StdUtils-Plugin%20%28NSIS%29/		* http://sourceforge.net/projects/muldersoft/files/StdUtils-Plugin%20%28NSIS%29/
	* https://bitbucket.org/~~lord_mulder~~/stdutils/downloads		* https://bitbucket.org/muldersoft/stdutils/downloads
	* https://www.assembla.com/spaces/stdutils/documents		* https://www.assembla.com/spaces/stdutils/documents

Line 119:		Line 119:
	* https://github.com/lordmulder/stdutils.git ([https://github.com/lordmulder/stdutils Browse])		* https://github.com/lordmulder/stdutils.git ([https://github.com/lordmulder/stdutils Browse])
	* https://gitlab.com/stdutils-plug-in-for-nsis/stdutils-plug-in-for-nsis.git ([https://gitlab.com/stdutils-plug-in-for-nsis/stdutils-plug-in-for-nsis/tree/master Browse])		* https://gitlab.com/stdutils-plug-in-for-nsis/stdutils-plug-in-for-nsis.git ([https://gitlab.com/stdutils-plug-in-for-nsis/stdutils-plug-in-for-nsis/tree/master Browse])
	* https://bitbucket.org/~~lord_mulder~~/stdutils.git ([https://bitbucket.org/~~lord_mulder~~/stdutils/src Browse])		* https://bitbucket.org/muldersoft/stdutils.git ([https://bitbucket.org/muldersoft/stdutils/src Browse])
	* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])		* https://git.assembla.com/stdutils.git ([https://www.assembla.com/spaces/stdutils/git/source Browse])

	~~=== Archived Versions ===~~

	~~For historical reasons only. Please do <b>not</b> use these <u>outdated</u> versions nowadays!~~

	* <attach>StdUtils.2013-02-21.zip</attach>
	* <attach>StdUtils.2012-10-28.zip</attach>
	* <attach>StdUtils.2011-10-18.zip</attach>

	== Support ==		== Support ==