Developer installation from within Visual Studio

Makefile.DevInstall

 #
 # NMAKE is a 32-bit application, which makes it problematic to make 64-bit registry entries with the standard command-line tools such as "reg.exe".
 # As a 32-bit application, when it loads "reg.exe" from the ordinary directory, %WINDIR%\System32, the WOW64 system redirects it load from %WINDIR%\SysWOW64.
 # So even if you explicitly put in the 64-bit path, because NMAKE is 32-bit it will load the 32-bit version anyway.
 # To get around this, we check for the existence of %WINDIR%\sysnative\reg.exe, which if present means a few things.
 # -- 1. We're running on Windows Vista or later, because 64-bit XP doesn't have "sysnative."
 # -- 2. We're running on a 64-bit version of Windows.
 # -- 3. We're running from a 32-bit process, which should always be true about NMAKE.
 #
 # See http://ovidiupl.wordpress.com/2008/07/11/useful-wow64-file-system-trick/ for more details.
 #
 !if [cmd /c if exist %WINDIR%\sysnative\reg.exe exit /b 1]
 REG=$(WINDIR)\sysnative\reg.exe
 X64=1
 !else
 REG=$(WINDIR)\reg.exe
 !message Warning: Developer installation not tested on XP or 32-bit Windows.
 !endif
 
 !message DLL=$(DLL)
 
 #
 # Default (first) target is a help message, in case anybody runs it outside Visual Studio.
 #
 help:
         @echo This Makefile is intended to be run from within Visual Studio to provide developer installations of Adblock Plus for IE.
 
-build64: register64 check_BHO copy
+build64: register64 check_BHO64 copy
 
 rebuild64: clean64 build64
 
-build32: register32 check_BHO copy
+build32: register32 check_BHO32 copy
 
 rebuild32: clean32 build32
 
 #
 # We're using "reg.exe" for the HKCU keys because the one with the DLL path name would need to be backslash-quoted to go into a .REG file.
 #
 # Note that the CLSID is register in HKCU, which avoids the need to elevate with UAC to high integrity in order to write.
 # Also note that the "Browser Helper Object" key is in HKLM, which is required because of IE.
 # IE only scans in HKLM for BHO entries.
 # IE does not scan HKCU for BHO entries, contrary to some sources online.
 # The tale for this is that it would be a security violation to allow an Administrator to run a BHO from HKCU,
 #    since anything might have written to HKCU (a low-integrity part of the registry).
 # On the other hand, IE could just run low-integrity BHO in a low-integrity container, but no, it can't do that.
 #
 register64:
         @echo Start 'register' action.
         $(REG) add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve /d "Adblock Plus for IE Browser Helper Object" /f >nul
         $(REG) add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 /ve /d "$(DLL)" /f >nul
         $(REG) add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 /v ThreadingModel /d "Both" /f >nul
         @date /t >"$(OutDir)registered.timestamp.txt"
         @time /t >>"$(OutDir)registered.timestamp.txt"
 
 #
 # This is exactly the same as 'register64' except it does not use the $(REG) macro but rather just 'reg'
 # On 64-bit Windows, invoking it this way ends up with the 32-bit version of 'reg'.

[Wladimir Palant, 2013/06/20 07:10:38]

How about renaming the current REG variable into REG64 and defining REG32 as
%WINDIR%\SysWOW64\reg.exe to be used here? Then you can save that lengthy
explanation and it's immediately obvious what's going on. 

[Eric, 2013/06/20 14:13:47]

I want to disagree with one thing. Nothing is ever immediately obvious about
Windows and multiple architectures. I've been steeped in it for a few weeks and
I still get hung up occasionally. Renaming to save a comment is not a good
tradeoff in this matter.

That would be the right thing if we were only ever to run on 64-bit Windows. If
we're running on 32-bit Windows, the SysWOW64 directory doesn't exist. If you
want a rename, then REG is really REG_NATIVE, that is, 64-bit reg.exe on 64-bit
Windows and 32-bit reg.exe on 32-bit Windows.

"reg" could be REG32, because invoking it that way from NMAKE, a 32-bit program,
always gets the 32-bit version. If you invoke "reg" from the ordinary command
line on 64-bit Windows, then you get 64-bit "reg.exe", because the ordinary
command line is a 64-bit program.

 # See above about 'sysnative' for why that is.
 # On 32-bit Windows, it does what you'd expect.
 # Thus we can use this for 32-bit build targets on both 32- and 64-bit Windows.
 #
 register32:
         @echo Start 'register' action.
         reg add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve /d "Adblock Plus for IE Browser Helper Object" /f >nul
         reg add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 /ve /d "$(DLL)" /f >nul
         reg add HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 /v ThreadingModel /d "Both" /f >nul
         @date /t >"$(OutDir)registered.timestamp.txt"
         @time /t >>"$(OutDir)registered.timestamp.txt"
 
 #
 # Fortuitously, the warning message below is actually parsed by Visual Studio and show up with a yellow flag in the error list.
 #
-check_BHO:
+check_BHO64:
 !if [$(REG) query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Browser Helper Objects\{FFCB3198-32F3-4E8B-9539-4324694ED664}" 2>&1 >nul]

[Wladimir Palant, 2013/06/20 07:10:38]

What about
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\
Explorer\Browser Helper Objects\{FFCB3198-32F3-4E8B-9539-4324694ED664} - doesn't
that key have to be set as well? I would expect check_BHO32 and check_BHO64,
with the 32 bit and 64 bit reg.exe respectively.

[Eric, 2013/06/20 14:13:47]

You're correct. I also need to add it to the query target below.

+        @echo Warning: BHO key not registered. IE cannot find the plugin unless the BHO key is present in the registry. Use "BHO_add.reg" to add the key.
+!endif
+
+check_BHO32:
+!if [reg query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Browser Helper Objects\{FFCB3198-32F3-4E8B-9539-4324694ED664}" 2>&1 >nul]
         @echo Warning: BHO key not registered. IE cannot find the plugin unless the BHO key is present in the registry. Use "BHO_add.reg" to add the key.
 !endif
 
 copy:
         @echo Copying files
         copy "$(ProjectDir)files\settings.ini" "$(OutDir)settings.ini"
         xcopy /s /I /y /D "$(ProjectDir)html\*" "$(OutDir)html"
         xcopy /s /I /y /D "$(ProjectDir)locales\*" "$(OutDir)locales"
         @date /t >"$(OutDir)copied.timestamp.txt"
         @time /t >>"$(OutDir)copied.timestamp.txt"
 
 #
 # N.B. We don't delete the CLSID in HKLM for clean. That wouldn't be our key, but the installer's.

[Wladimir Palant, 2013/06/20 07:10:38]

IMHO, since this is about the development environment we have to assume that
it's our key - developers usually don't run the installer. And even if they do,
they will just run it again - it's obvious that the development environment will
interfere with the installer.

[Eric, 2013/06/20 14:13:47]

There are three reasons not to delete installer keys.

1) There's no need to. If the HKCU keys for CLSID are registered, they override
those in HKLM. (The BHO keys are identical.)

2) It's not a good idea to alter any asset registered by the installer. At best
you trigger a Windows Installer "repair" action.

3) We don't have support for writing to HKLM right now. That includes deleting
keys.

 #
 clean64:
         $(REG) delete HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /f
 
 clean32:
         reg delete HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /f
 
 #
 # This utility queries all the registry locations that might be present either in a developer install or a regular one.
 # The '-' annotation means to ignore the error code. '2>nul' means to ignore any error text. It's not an error for a registry key to be absent.
 # The BHO key is only relevant in HKLM. The CLSID keys may be either in HKLM or HKCU.
 #
 query:
 # BHO key
         -@$(REG) query "HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\Browser Helper Objects\{FFCB3198-32F3-4E8B-9539-4324694ED664}" 2>nul
 # Native platform keys
         -@$(REG) query HKLM\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve 2>nul
         -@$(REG) query HKLM\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 2>nul
         -@$(REG) query HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve 2>nul
         -@$(REG) query HKCU\Software\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 2>nul
 !ifdef X64
 # WoW64 keys
         -@$(REG) query HKLM\Software\Wow6432Node\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve 2>nul
         -@$(REG) query HKLM\Software\Wow6432Node\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 2>nul
         -@$(REG) query HKCU\Software\Wow6432Node\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664} /ve 2>nul
         -@$(REG) query HKCU\Software\Wow6432Node\Classes\CLSID\{FFCB3198-32F3-4E8B-9539-4324694ED664}\InprocServer32 2>nul
 !endif