# -*- sh -*-
# Build script to construct a full distribution directory of PuTTY.
-# Set up the arguments for the main make command.
-set Makeargs
-ifneq "$(RELEASE)" "" set Makeargs VER="-DRELEASE=$(RELEASE)"
-ifneq "$(SNAPSHOT)" "" set Makeargs VER="-DSNAPSHOT=$(SNAPSHOT)"
-ifneq "$(XFLAGS)" "" set Makeargs $(makeargs) XFLAGS="$(XFLAGS)"
-ifneq "$(MAKEARGS)" "" set Makeargs $(makeargs) $(MAKEARGS)
-
-# Set up the version string for the docs build.
-set Docmakeargs
-ifneq "$(RELEASE)" "" set Docmakeargs VERSION="PuTTY release $(RELEASE)"
-ifneq "$(SNAPSHOT)" "" set Docmakeaargs VERSION="PuTTY development snapshot $(SNAPSHOT)"
-
-# Set up the version string for the installer.
-set Iversion
+module putty
+
+# Start by figuring out what our version information looks like.
+#
+# There are four classes of PuTTY build:
+# - a release, which just has an X.YY version number
+# - a prerelease, which has an X.YY version number, plus a date and
+# version control commit id (and is considered to be 'almost'
+# version X.YY)
+# - a development snapshot, which just has a date and commit id
+# - a custom build, which also has a date and commit id (but is
+# labelled differently, to stress that development snapshots are
+# built from the checked-in code by the automated nightly script
+# whereas custom builds are made manually, perhaps from uncommitted
+# changes, e.g. to send to a user for diagnostic or testing
+# purposes).
+#
+# The four classes of build are triggered by invoking bob with
+# different command-line variable definitions:
+#
+# - RELEASE=X.YY makes a release build
+# - PRERELEASE=X.YY makes a prerelease build (combined with the build
+# date and VCS info)
+# - setting SNAPSHOT to any non-empty string makes a development
+# snapshot
+# - setting none of these makes a custom build.
+
+# If we need a date for our build, start by computing it in the
+# various forms we need. $(Ndate) is the date in purely numeric form
+# (YYYYMMDD); $(Date) is separated as YYYY-MM-DD; $(Days) is the
+# number of days since the epoch.
+ifeq "$(RELEASE)" "" set Ndate $(!builddate)
+ifneq "$(Ndate)" "" in . do echo $(Ndate) | perl -pe 's/(....)(..)(..)/$$1-$$2-$$3/' > date
+ifneq "$(Ndate)" "" read Date date
+set Epoch 16214 # update this at every release
+ifneq "$(Ndate)" "" in . do echo $(Ndate) | perl -ne 'use Time::Local; /(....)(..)(..)/ and print timegm(0,0,0,$$3,$$2-1,$$1) / 86400 - $(Epoch)' > days
+ifneq "$(Ndate)" "" read Days days
+
+# For any non-release, we're going to need the number of the prior
+# release, for putting in various places so as to get monotonic
+# comparisons with the surrounding actual releases.
+ifeq "$(RELEASE)" "" read Lastver putty/LATEST.VER
+
+# Set up the textual version strings for the docs build and installer.
+# We have one of these including the word 'PuTTY', and one without,
+# which are inconveniently capitalised differently.
+ifneq "$(RELEASE)" "" set Puttytextver PuTTY release $(RELEASE)
+ifneq "$(RELEASE)" "" set Textver Release $(RELEASE)
+ifneq "$(PRERELEASE)" "" set Puttytextver PuTTY pre-release $(PRERELEASE):$(Date).$(vcsid)
+ifneq "$(PRERELEASE)" "" set Textver Pre-release $(PRERELEASE):$(Date).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Puttytextver PuTTY development snapshot $(Date).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Textver Development snapshot $(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Puttytextver PuTTY custom build $(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Textver Custom build $(Date).$(vcsid)
+set Docmakever VERSION="$(Puttytextver)"
+
+# Set up the version string for use in the SSH connection greeting.
+#
+# We use $(Ndate) rather than $(Date) in the pre-release string to
+# make sure it's under 40 characters, which is a hard limit in the SSH
+# protocol spec (and enforced by a compile-time assertion in
+# version.c).
+ifneq "$(RELEASE)" "" set Sshver PuTTY-Release-$(RELEASE)
+ifneq "$(PRERELEASE)" "" set Sshver PuTTY-Prerelease-$(PRERELEASE):$(Ndate).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Sshver PuTTY-Snapshot-$(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Sshver PuTTY-Custom-$(Date).$(vcsid)
+
+# Set up the filename suffix for the Unix source archive.
+ifneq "$(RELEASE)" "" set Uxarcsuffix -$(RELEASE)
+ifneq "$(PRERELEASE)" "" set Uxarcsuffix -$(PRERELEASE)~pre$(Ndate).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Uxarcsuffix -$(Lastver)-$(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Uxarcsuffix -custom-$(Date).$(vcsid)
+
+# Set up the version number for the autoconf system.
+ifneq "$(RELEASE)" "" set Autoconfver $(RELEASE)
+ifneq "$(PRERELEASE)" "" set Autoconfver $(PRERELEASE)~pre$(Ndate).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Autoconfver $(Lastver)-$(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Autoconfver Custom.$(Date).$(vcsid)
+
+# Set up the filenames for the Windows installer (minus extension,
+# which goes on later).
+ifneq "$(RELEASE)" "" set Isuffix $(RELEASE)-installer
+ifneq "$(PRERELEASE)" "" set Isuffix $(PRERELEASE)-pre$(Ndate)-installer
+ifneq "$(SNAPSHOT)" "" set Isuffix $(Date)-installer
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Isuffix custom-$(Date)-installer
+set Ifilename32 putty-$(Isuffix)
+set Ifilename64 putty-64bit-$(Isuffix)
+
+# Set up the version string for the Windows installer.
ifneq "$(RELEASE)" "" set Iversion $(RELEASE)
-ifneq "$(SNAPSHOT)" "" set Iversion $(SNAPSHOT)
-# FIXME: what about the static version numbers in putty.iss?
+ifneq "$(PRERELEASE)" "" set Iversion $(PRERELEASE)-pre$(Ndate).$(vcsid)
+ifneq "$(SNAPSHOT)" "" set Iversion $(Date).$(vcsid)
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" set Iversion Custom-$(Date).$(vcsid)
+
+# Set up the Windows version resource info, for both the installer and
+# the individual programs. This must be a sequence of four 16-bit
+# integers compared lexicographically, and we define it as follows:
+#
+# For release X.YY: X.YY.0.0
+# For a prerelease before the X.YY release: (X.YY-1).(DDDDD + 0x8000).0
+# For a devel snapshot after the X.YY release: X.YY.DDDDD.0
+# For a custom build: X.YY.DDDDD.1
+#
+# where DDDDD is a representation of the build date, in the form of a
+# number of days since an epoch date. The epoch is reset at every
+# release (which, with 15 bits, gives us a comfortable 80-odd years
+# before it becomes vital to make another release to reset the count
+# :-).
+
+ifneq "$(RELEASE)" "" in . do echo $(RELEASE).0.0 > winver
+ifneq "$(PRERELEASE)" "" in . do perl -e 'printf "%s.%d.0", $$ARGV[0], 0x8000+$$ARGV[1]' $(Lastver) $(Days) > winver
+ifneq "$(SNAPSHOT)" "" in . do perl -e 'printf "%s.%d.0", $$ARGV[0], $$ARGV[1]' $(Lastver) $(Days) > winver
+ifeq "$(RELEASE)$(PRERELEASE)$(SNAPSHOT)" "" in . do perl -e 'printf "%s.%d.1", $$ARGV[0], $$ARGV[1]' $(Lastver) $(Days) > winver
+in . do perl -pe 'y!.!,!' winver > winvercommas
+read Winver winver
+read Winvercommas winvercommas
+
+# Write out a version.h that contains the real version number.
+in putty do echo '/* Generated by automated build script */' > version.h
+ifneq "$(RELEASE)" "" in putty do echo '$#define RELEASE $(RELEASE)' >> version.h
+ifneq "$(PRERELEASE)" "" in putty do echo '$#define PRERELEASE $(PRERELEASE)' >> version.h
+ifneq "$(SNAPSHOT)" "" in putty do echo '$#define SNAPSHOT' >> version.h
+in putty do echo '$#define TEXTVER "$(Textver)"' >> version.h
+in putty do echo '$#define SSHVER "$(Sshver)"' >> version.h
+in putty do echo '$#define BINARY_VERSION $(Winvercommas)' >> version.h
+in putty do echo '$#define SOURCE_COMMIT "$(vcsfullid)"' >> version.h
+
+# Set up the extra arguments for the main Windows nmake command. The
+# user can define XFLAGS and MAKEARGS on the bob command line, to pass
+# in extra compile and make options respectively (e.g. to do a
+# debugging or Minefield build).
+set Makeargs
+ifneq "$(XFLAGS)" "" set Makeargs $(Makeargs) XFLAGS="$(XFLAGS)"
+ifneq "$(MAKEARGS)" "" set Makeargs $(Makeargs) $(MAKEARGS)
in putty do ./mksrcarc.sh
-in putty do ./mkunxarc.sh $(RELEASE)
+in putty do ./mkunxarc.sh '$(Autoconfver)' '$(Uxarcsuffix)' $(Docmakever)
in putty do perl mkfiles.pl
-in putty/doc do make $(Docmakeargs) putty.hlp
-in putty/doc do make $(Docmakeargs) chm
+in putty/doc do make $(Docmakever) putty.hlp
+in putty/doc do make $(Docmakever) chm
+
+# Munge the installer script locally so that it reports the version
+# we're really building.
+in putty/windows do perl -i~ -pe 'BEGIN{$$a=shift@ARGV;}s/^(AppVerName=).*$$/$$1$$a/' '$(Puttytextver)' putty.iss
+in putty/windows do perl -i~ -pe 'BEGIN{$$a=shift@ARGV;}s/^(VersionInfoTextVersion=).*$$/$$1$$a/' '$(Textver)' putty.iss
+in putty/windows do perl -i~ -pe 'BEGIN{$$a=shift@ARGV;}s/^(AppVersion=).*$$/$$1$$a/' '$(Iversion)' putty.iss
+in putty/windows do perl -i~ -pe 'BEGIN{$$a=shift@ARGV;}s/^(VersionInfoVersion=)\d+\.\d+\.\d+\.\d+\r?$$/$$1$$a/' '$(Winver)' putty.iss
+
+# Windowsify LICENCE, since it's going in the Windows installer.
+in putty do perl -i~ -pe 'y/\015//d;s/$$/\015/' LICENCE
+
+# Some gratuitous theming for the MSI installer UI.
+in putty/icons do make
+in putty do convert -size 164x312 'gradient:blue-white' -distort SRT -90 -swirl 180 \( -size 329x312 canvas:white \) +append \( icons/putty-48.png -geometry +28+24 \) -composite \( icons/pscp-48.png -geometry +88+96 \) -composite \( icons/puttygen-48.png -geometry +28+168 \) -composite \( icons/pageant-48.png -geometry +88+240 \) -composite windows/msidialog.bmp
+in putty do convert -size 493x58 canvas:white \( icons/putty-48.png -geometry +440+5 \) -composite windows/msibanner.bmp
+
delegate windows
- # FIXME: Cygwin alternative?
- in putty/windows do cmd /c 'vcvars32 & nmake -f Makefile.vc $(Makeargs)'
+ # Build the original binaries.
+ in putty/windows with visualstudio do/win mkdir buildold && nmake -f Makefile.vc BUILDDIR=buildold\ $(Makeargs) all cleantestprogs
+
+ # Build the VS2015 binaries. For the 32-bit ones, we set a subsystem
+ # version of 5.01, which allows the resulting files to still run on
+ # Windows XP.
+ in putty/windows with visualstudio2015_32bit do/win mkdir build32 && nmake -f Makefile.vc BUILDDIR=build32\ SUBSYSVER=,5.01 $(Makeargs) all cleantestprogs
+ in putty/windows with visualstudio2015_64bit do/win mkdir build64 && nmake -f Makefile.vc BUILDDIR=build64\ $(Makeargs) all cleantestprogs
+
+ # Code-sign the binaries, if the local bob config provides a script
+ # to do so. We assume here that the script accepts an -i option to
+ # provide a 'more info' URL, and an optional -n option to provide a
+ # program name, and that it can take multiple .exe filename
+ # arguments and sign them all in place.
+ ifneq "$(winsigncode)" "" in putty/windows do $(winsigncode) -i http://www.chiark.greenend.org.uk/~sgtatham/putty/ build*/*.exe
+
# Ignore exit code from hhc, in favour of seeing whether the .chm
# file was created. (Yuck; but hhc appears to return non-zero
# exit codes on whim.)
- in putty/doc do hhc putty.hhp; test -f putty.chm
- in putty/windows do iscc putty.iss
- return putty/windows/*.exe
+ in putty/doc with htmlhelp do/win hhc putty.hhp & type putty.chm >nul
+
+ # Build a WiX MSI installer, for each of build32 and build64.
+ in putty/windows with wix do/win candle -arch x86 -dWin64=no -dBuilddir=build32\ -dWinver="$(Winver)" -dPuttytextver="$(Puttytextver)" installer.wxs && light -ext WixUIExtension -ext WixUtilExtension -sval installer.wixobj -o installer32.msi
+ in putty/windows with wix do/win candle -arch x64 -dWin64=yes -dBuilddir=build64\ -dWinver="$(Winver)" -dPuttytextver="$(Puttytextver)" installer.wxs && light -ext WixUIExtension -ext WixUtilExtension -sval installer.wixobj -o installer64.msi
+
+ # Build the old Inno Setup installer, for 32-bit only.
+ in putty/windows with innosetup do/win iscc putty.iss
+
+ # Sign the installers.
+ ifneq "$(winsigncode)" "" in putty/windows do $(winsigncode) -i http://www.chiark.greenend.org.uk/~sgtatham/putty/ -n "PuTTY Installer" installer32.msi installer64.msi Output/installer.exe
+
+ # Finished Windows builds.
+ return putty/windows/buildold/*.exe
+ return putty/windows/buildold/*.map
+ return putty/windows/build32/*.exe
+ return putty/windows/build32/*.map
+ return putty/windows/build64/*.exe
+ return putty/windows/build64/*.map
return putty/doc/putty.chm
- return putty/windows/Output/setup.exe
+ return putty/windows/installer32.msi
+ return putty/windows/installer64.msi
+ return putty/windows/Output/installer.exe
enddelegate
in putty/doc do make mostlyclean
-in putty/doc do make $(Docmakeargs)
-in putty/windows do zip -k -j putty.zip `ls *.exe | grep -v puttytel` ../doc/putty.chm ../doc/putty.hlp ../doc/putty.cnt
+in putty/doc do make $(Docmakever)
+in putty/windows/buildold do zip -k -j putty.zip `ls *.exe | grep -v puttytel` ../../doc/putty.chm ../../doc/putty.hlp ../../doc/putty.cnt
+in putty/windows/build32 do zip -k -j putty.zip `ls *.exe | grep -v puttytel` ../../doc/putty.chm ../../doc/putty.hlp ../../doc/putty.cnt
+in putty/windows/build64 do zip -k -j putty.zip `ls *.exe | grep -v puttytel` ../../doc/putty.chm ../../doc/putty.hlp ../../doc/putty.cnt
in putty/doc do zip puttydoc.zip *.html
-deliver putty/windows/*.exe x86/$@
-deliver putty/windows/putty.zip x86/$@
-deliver putty/windows/Output/setup.exe x86/putty-$(Iversion)-installer.exe
-deliver putty/doc/puttydoc.zip $@
-deliver putty/doc/putty.chm $@
-deliver putty/doc/putty.hlp $@
-deliver putty/doc/putty.cnt $@
-deliver putty/doc/puttydoc.txt $@
-deliver putty/doc/*.html htmldoc/$@
-deliver putty/putty-src.zip $@
-deliver putty/*.tar.gz $@
-
-# Building the md5sums file is most easily done in the destination
-# directory.
-in-dest . do md5sum `\find * -type f -print` > md5sums
+# Deliver the actual PuTTY release directory into a subdir `putty'.
+deliver putty/windows/buildold/*.exe putty/w32old/$@
+deliver putty/windows/buildold/putty.zip putty/w32old/$@
+deliver putty/windows/build32/*.exe putty/w32/$@
+deliver putty/windows/build32/putty.zip putty/w32/$@
+deliver putty/windows/build64/*.exe putty/w64/$@
+deliver putty/windows/build64/putty.zip putty/w64/$@
+deliver putty/windows/installer32.msi putty/w32/$(Ifilename32).msi
+deliver putty/windows/installer64.msi putty/w64/$(Ifilename64).msi
+deliver putty/windows/Output/installer.exe putty/w32/$(Ifilename32).exe
+deliver putty/doc/puttydoc.zip putty/$@
+deliver putty/doc/putty.chm putty/$@
+deliver putty/doc/putty.hlp putty/$@
+deliver putty/doc/putty.cnt putty/$@
+deliver putty/doc/puttydoc.txt putty/$@
+deliver putty/doc/*.html putty/htmldoc/$@
+deliver putty/putty-src.zip putty/$@
+deliver putty/*.tar.gz putty/$@
+
+# Deliver the map files alongside the `proper' release deliverables.
+deliver putty/windows/buildold/*.map maps/w32old/$@
+deliver putty/windows/build32/*.map maps/w32/$@
+deliver putty/windows/build64/*.map maps/w64/$@
+
+# Deliver sign.sh, so that whoever has just built PuTTY (the
+# snapshot scripts or me, depending) can conveniently sign it with
+# whatever key they want.
+deliver putty/sign.sh $@
+
+# Create files of cryptographic checksums, which will be signed along
+# with the files they verify. We've provided MD5 checksums for a
+# while, but now MD5 is looking iffy, we're expanding our selection.
+#
+# Creating these files is most easily done in the destination
+# directory, where all the files we're delivering are already in their
+# final relative layout.
+in-dest putty do a=`\find * -type f -print`; md5sum $$a > md5sums && sha1sum $$a > sha1sums && sha256sum $$a > sha256sums && sha512sum $$a > sha512sums
+
+# And construct .htaccess files. One in the top-level directory,
+# setting the MIME types for Windows help files and providing an
+# appropriate link to the source archive:
+in-dest putty do echo "AddType application/octet-stream .chm" >> .htaccess
+in-dest putty do echo "AddType application/octet-stream .hlp" >> .htaccess
+in-dest putty do echo "AddType application/octet-stream .cnt" >> .htaccess
+in-dest putty do set -- putty*.tar.gz; for k in '' .gpg; do echo RedirectMatch temp '(.*/)'putty.tar.gz$$k\$$ '$$1'"$$1$$k" >> .htaccess; done
+# And one in each binary directory, providing links for the installers.
+in-dest putty do for params in "w32 putty-installer" "w64 putty-64bit-installer"; do (set -- $$params; subdir=$$1; installername=$$2; cd $$subdir && for ext in msi exe; do set -- putty*installer.$$ext; if test -f $$1; then for k in '' .gpg; do echo RedirectMatch temp '(.*/)'$${installername}.$$ext$$k\$$ '$$1'"$$1$$k" >> .htaccess; done; fi; done); done
projects / PuTTY.git / blobdiff