Minor corrections, added FontInstallationIssues

Author: texhex

FontInstallationIssues.md

@@ -0,0 +1,63 @@
+#Font Installation Issues
+
+When creating this setup, and when deploying this setup to 200+ machines, I faced some issues that come from the fact that Windows is not very smart when handling fonts. This file lists the issues I'm aware of.
+
+##Font files can be damaged
+
+For whatever reason, sometimes the *.ttf files are broken and depending how exactly they are broken can lead to all sorts of effects, from "Font can't be used" to "Some glyphs are broken".
+
+*OSFontPack.exe* uses SHA-1 hashes to compare the files that should be installed with the files actually installed. This has the side effect that always the files included with the setup are installed, even if one font file was already manually updated to a newer version. 
+
+##The FONTS applet might save fonts as (Fontname)_X.ttf
+
+When copying TTF files by simply dropping them onto the *Fonts* applet from Control Panel and the file that is copied is currently locked in *C:\WINDOWS\FONTS*, the applet will just append `_0` to the filename without extension and register this new file to the registry. For example, dropping `Hack-Regular.ttf` to FONTS when this file is locked will save the file as `Hack-Regular_0.ttf` to *C:\WINDOWS\FONTS*. 
+
+Depending on the application and the caching method it can happen that the application continues to use the old font file.
+ 
+*OSFontPack.exe* will delete any *(Fontname)_X.ttf* for each font file it installs. However, if a font file was renamed, *OSFontPack.exe* won’t delete the old _0.ttf file because this deletion is executed upon installation and depends on the current font names.
+
+##Some fonts can be locked when in use
+
+As soon as a font is used, the TTF file for it is locked and can’t be updated to a newer version.
+
+*OSFontPack.exe* will try to replace any locked file five times and if this doesn’t work, it will use `PendingFileOperations` to replace the file in question upon next boot. 
+
+##The FontCache service can lock fonts during installation
+
+For performance reasons, Windows includes a cache for all installed fonts. Because it is sometime to “eager” to read the information from a file, the installation can fail because the file is locked during the installation.
+
+*OSFontPack.exe* will stop `FontCache` (and `FontCache3.0.0.0` for .NET if it exists) during installation.
+##The font data in the registry and the font files can be different
+
+Depending what else has gone wrong, the font registration data (Name and File) inside the registry can be different from the actual fonts installed in C:\WINDOWS\FONTS. When this happens, the fonts can go “crazy” - see issue [#152 for Hack](https://github.com/chrissimpkins/Hack/issues/152).
+
+*OSFontPack.exe* will ensure that the files and the registration data are exactly as desired and reinstall the font if this is not the case.
+
+##A new font is not visible directly after installation
+
+When a new font is installed, Windows expects the broadcast message WM_FONTCHANGE before the font can be used. 
+
+*OSFontPack.exe* will sent this message if any new font is installed. However, some applications do not react on this message so a restart will be requested when the installation is finished.
+
+##A font cannot be updated without restart
+
+The [MSDN  docs](https://msdn.microsoft.com/en-us/library/windows/desktop/dd183326%28v=vs.85%29.aspx) say that a call to RemoveFontResource() requires a restart before this font is really removed. However, it does not say anything if updating a font also requires this. Based on the current findings, I think it is required.
+
+*OSFontPack.exe* will always request a restart when the installation is finished. 
+
+
+##Not fixed: The cache files of the FontCache service can be corrupted
+
+This issue is not yet fixed by *OSFontPack.exe* mostly because I never experienced this defect. 
+
+Both font cache services (FontCache and FontCache3.0.0.0) use cache files stored in *C:\Windows\ServiceProfiles\LocalService\AppData\Local\*. When these files become corrupted, the services might hang and the entire font handling goes haywire. 
+
+The solution in this case is to stop both services, delete the file `FontCache3.0.dat` as well as renaming the folder `FontCache` and recreating a new empty folder with the same name. 
+
+After that, restart the computer. 
+
+
+----------
+2016-03-30
+~Michael 'Tex' Hex
+

README.md

@@ -8,6 +8,12 @@ A Windows installer for [Hack](https://github.com/chrissimpkins/Hack).
 - Run HackWindowsInstaller.exe
 - Follow the instructions
 
+## Why this project exists
+
+It might seem to be overkill to have an installation tool just for some fonts, but a lot of things can go wrong when trying to install or update them manually (see [issue #152](https://github.com/chrissimpkins/Hack/issues/152) in the Hack repository).
+
+The installer can prevent most of these issues. A (not complete) list of things that can go wrong can be found in [FontInstallationIssues.md](https://github.com/source-foundry/Hack-windows-installer/blob/master/FontInstallationIssues.md).
+
 ## Silent Installation
 
 To install silently, use the following command:
@@ -28,6 +34,8 @@ If you are using EMET: If the "Only trusted fonts" option is activated, you need
 
 Any constructive contribution is very welcome! If you have any question or encounter a bug, please create a new [issue](https://github.com/source-foundry/Hack-windows-installer/issues/new).
 
+## Why does this 
+
 ## Build from source
 
 To build this setup yourself, download the newest ANSI (not unicode)  version of [Inno Setup](http://www.jrsoftware.org/isdl.php). Install it and activate the option to install the [Inno Setup Preprocessor](http://www.jrsoftware.org/ispphelp/). 

src/HackWindowsInstaller.iss

@@ -18,13 +18,15 @@
 //#define DEBUG
 
 //Update this when releasing a new version
-#define public Version '1.0.0'
+#define public Version '1.0.1'
 
 //This defines in which sub folder of this project the current files are located
 #define public HackMonospaced_Sourcefolder 'Hack_v2_019'
 
-//URL of the project homepage of the FONT 
-#define public HackMonospaced_Homepage 'http://sourcefoundry.org/hack/' /*'https://github.com/chrissimpkins/Hack'*/
+//This definies the version of Hack monospaces
+#define public HackMonospaced_Version '2.019'
+
+
 
 
 //--------------------------------------------------------------------
@@ -35,6 +37,12 @@
 //Name of this setup
 #define public AppName 'Hack Windows Installer'
 
+//URL of the project homepage of the FONT 
+#define public HackMonospaced_Homepage 'http://sourcefoundry.org/hack/' /*'https://github.com/chrissimpkins/Hack'*/
+
+//URL of the installer homepage
+#define public Installer_Homepage 'https://github.com/source-foundry/Hack-windows-installer'
+
 //Copyright information 
 #define public Copyright 'Copyright © 2016 Michael Hex / Source Foundry'
 
@@ -129,7 +137,7 @@ VersionInfoVersion={#Version}
 
 AppPublisher=Michael Hex / Source Foundry
 AppContact=Michael Hex / Source Foundry
-AppSupportURL={#HackMonospaced_Homepage}
+AppSupportURL={#Installer_Homepage}
 AppComments=Hack font installer
 AppCopyright={#Copyright}
 
@@ -235,6 +243,16 @@ Filename: "{app}\InstallInfo.ini"; Section: "Main"; Key: "Name"; String: "{#AppN
 Type: files; Name: "{app}\InstallInfo.ini"
 
 
+[Messages]
+;Message for the "Read to install" wizard page
+;"Ready To Install"
+;WizardReady=
+
+;"Setup is now ready to begin installing ...."
+ReadyLabel1=
+;"Click Install to continue with the installation" 
+ReadyLabel2b=Setup is now ready to install the Hack fonts v{#HackMonospaced_Version} on your system.
+;%n%nClick Install to continue.
 
 
 [Code]
@@ -478,6 +496,20 @@ begin
 end;
 
 
+{ //Not used right now - See [Messages]
+function UpdateReadyMemo(Space, NewLine, MemoUserInfoInfo, MemoDirInfo, MemoTypeInfo, MemoComponentsInfo, MemoGroupInfo, MemoTasksInfo: String): String;
+var
+ text:string;
+begin
+ text:='';
+ text:=text + 'Setup is now ready to install Hack v2.XXX on your system' + NewLine;
+ text:=text + NewLine;
+ text:=text + 'Click Install to continue.' + NewLine;
+
+ result:=text;
+end;
+}
+
 
 //This function returns TRUE if:
 // - the SHA1 hash of a file inside Windows\fonts is the same as the hash we have calculated

src/HackWindowsInstaller_TEMP_Preprocessed.iss

@@ -18,6 +18,8 @@
 
 
 
+
+
 ; ISPP: Base Path C:\dev\git\Hack-windows-installer\
 
 
@@ -38,6 +40,8 @@
 
 
 
+
+
 
 
 
@@ -73,12 +77,12 @@ AppId=HackWindowsInstaller
 SetupMutex=HackWindowsInstaller_SetupMutex 
 
 AppName=Hack Windows Installer
-AppVersion=1.0.0
-VersionInfoVersion=1.0.0
+AppVersion=1.0.1
+VersionInfoVersion=1.0.1
 
 AppPublisher=Michael Hex / Source Foundry
 AppContact=Michael Hex / Source Foundry
-AppSupportURL=http://sourcefoundry.org/hack/
+AppSupportURL=https://github.com/source-foundry/Hack-windows-installer
 AppComments=Hack font installer
 AppCopyright=Copyright © 2016 Michael Hex / Source Foundry
 
@@ -170,14 +174,24 @@ Type: files; Name: "{fonts}\Hack-RegularOblique.ttf";
 
 [INI]
 ;Create an ini to make detection for enterprise deployment tools easy
-Filename: "{app}\InstallInfo.ini"; Section: "Main"; Key: "Version"; String: "1.0.0"
+Filename: "{app}\InstallInfo.ini"; Section: "Main"; Key: "Version"; String: "1.0.1"
 Filename: "{app}\InstallInfo.ini"; Section: "Main"; Key: "Name"; String: "Hack Windows Installer"
 
 [UninstallDelete]
 ;Delete Install Info
 Type: files; Name: "{app}\InstallInfo.ini"
 
 
+[Messages]
+;Message for the "Read to install" wizard page
+;"Ready To Install"
+;WizardReady=
+
+;"Setup is now ready to begin installing ...."
+ReadyLabel1=
+;"Click Install to continue with the installation" 
+ReadyLabel2b=Setup is now ready to install the Hack fonts v2.019 on your system.
+;%n%nClick Install to continue.
 
 
 [Code]
@@ -399,6 +413,20 @@ begin
 end;
 
 
+{ //Not used right now - See [Messages]
+function UpdateReadyMemo(Space, NewLine, MemoUserInfoInfo, MemoDirInfo, MemoTypeInfo, MemoComponentsInfo, MemoGroupInfo, MemoTasksInfo: String): String;
+var
+ text:string;
+begin
+ text:='';
+ text:=text + 'Setup is now ready to install Hack v2.XXX on your system' + NewLine;
+ text:=text + NewLine;
+ text:=text + 'Click Install to continue.' + NewLine;
+
+ result:=text;
+end;
+}
+
 
 function IsSetupFontSameAsInstalledFont(fileName:string):boolean;
 var