Merge pull request #393 from ChinYikMing/sha1

Fix hardcoded sha1sum command and compare sha1 value

Author: jserv

mk/external.mk

@@ -1,41 +1,99 @@
+COMPRESSED_SUFFIX :=
+COMPRESSED_IS_ZIP :=
+COMPRESSED_IS_DIR :=
+EXTRACTOR :=
+VERIFIER :=
+
+# temporarily files to store correct SHA1 value and computed SHA1 value
+# respectively for verification of directory source
+$(eval SHA1_FILE1 := $(shell mktemp))
+$(eval SHA1_FILE2 := $(shell mktemp))
+
+# $(1): compressed source
+define prologue
+    $(eval _ := $(shell echo "  GET\t$(1)\n"))
+    $(info $(_))
+endef
+
+# $(1), $(2), $(3): files to be deleted
+define epilogue
+    $(eval _ := $(shell $(RM) $(1) $(2) $(3)))
+endef
+
+# $(1): compressed source URL
+define download
+    $(eval _ := $(shell curl --progress-bar -O -L -C - "$(strip $(1))"))
+endef
+
+# $(1): compressed source(.zip or.gz)
+define extract
+    $(eval COMPRESSED_SUFFIX := $(suffix $(1)))
+    $(eval COMPRESSED_IS_ZIP := $(filter $(COMPRESSED_SUFFIX),.zip))
+    $(eval _ :=  \
+        $(if $(COMPRESSED_IS_ZIP), \
+            ($(eval EXTRACTOR := unzip -d $(OUT) $(1))), \
+            ($(eval EXTRACTOR := tar -xf $(1) -C $(OUT))) \
+    ))
+    $(eval _ := $(shell $(EXTRACTOR)))
+endef
+
+# $(1): correct SHA1 value
+# $(2): filename or directory path
+#
+# Note:
+# 1. for regular file, $(SHA1SUM) command's -c option generates keyword "FAILED" for indicating an unmatch
+# 2. for directory, cmp command outputs keyword "differ" for indicating an unmatch
+define verify
+    $(eval COMPRESSED_IS_DIR := $(if $(wildcard $(2)/*),1,0))
+    $(eval _ := \
+	    $(if $(filter 1,$(COMPRESSED_IS_DIR)), \
+		    ($(eval VERIFIER :=  \
+                | echo $(1) > $(SHA1_FILE1) \
+                | find $(2) -type f -print0 \
+                | sort -z \
+                | xargs -0 $(SHA1SUM) \
+                | sort \
+                | $(SHA1SUM) \
+                | cut -f 1 -d ' ' > $(SHA1_FILE2) && cmp $(SHA1_FILE1) $(SHA1_FILE2))), \
+            ($(eval VERIFIER := echo "$(strip $(1))  $(strip $(2))" | $(SHA1SUM) -c)) \
+    ))
+    $(eval _ := $(shell $(VERIFIER)))
+    $(eval _ := \
+        $(if $(filter FAILED differ:,$(_)), \
+            ($(error $(_))), \
+            (# SHA1 value match, do nothing) \
+    ))
+endef
+
 # For each external target, the following must be defined in advance:
 #   _DATA_URL : the hyperlink which points to archive.
 #   _DATA : the file to be read by specific executable.
 #   _DATA_SHA1 : the checksum of the content in _DATA
-#   _DATA_EXTRACT : the way to extract content from compressed file
-#   _DATA_VERIFY : the way to verify the checksum of extracted file
 
 # Doom
 # https://tipsmake.com/how-to-run-doom-on-raspberry-pi-without-emulator
 DOOM_DATA_URL = http://www.doomworld.com/3ddownloads/ports/shareware_doom_iwad.zip
 DOOM_DATA = $(OUT)/DOOM1.WAD
 DOOM_DATA_SHA1 = 5b2e249b9c5133ec987b3ea77596381dc0d6bc1d
-DOOM_DATA_EXTRACT = unzip -d $(OUT) $(notdir $($(T)_DATA_URL))
-DOOM_DATA_VERIFY = echo "$(strip $$($(T)_DATA_SHA1))  $$@" | $(SHA1SUM) -c
 
 # Quake
 QUAKE_DATA_URL = https://www.libsdl.org/projects/quake/data/quakesw-1.0.6.zip
 QUAKE_DATA = $(OUT)/id1/pak0.pak
 QUAKE_DATA_SHA1 = 36b42dc7b6313fd9cabc0be8b9e9864840929735
-QUAKE_DATA_EXTRACT = unzip -d $(OUT) $(notdir $($(T)_DATA_URL))
-QUAKE_DATA_VERIFY = echo "$(strip $$($(T)_DATA_SHA1))  $$@" | $(SHA1SUM) -c
 
 # Timidity software synthesizer configuration for SDL2_mixer
 TIMIDITY_DATA_URL = http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz
 TIMIDITY_DATA = $(OUT)/timidity
-TIMIDITY_DATA_SHA1 = cdd30736508d26968222a6414f3beabc3b7a0725
-TIMIDITY_DATA_EXTRACT = tar -xf $(notdir $($(T)_DATA_URL)) -C $(OUT)
-TIMIDITY_TMP_FILE = /tmp/timidity_sha1.txt
-TIMIDITY_DATA_VERIFY = echo "$(TIMIDITY_DATA_SHA1)" > $(TIMIDITY_TMP_FILE) | find $(TIMIDITY_DATA) -type f -print0 | sort -z | xargs -0 shasum | shasum | cut -f 1 -d ' '
+TIMIDITY_DATA_SHA1 = cf6217a5d824b717ec4a07e15e6c129a4657ca25
 
-define download-n-extract
+define download-extract-verify
 $($(T)_DATA):
-	$(VECHO) "  GET\t$$@\n"
-	$(Q)curl --progress-bar -O -L -C - "$(strip $($(T)_DATA_URL))"
-	$(Q)$($(T)_DATA_EXTRACT)
-	$(Q)$($(T)_DATA_VERIFY)
-	$(Q)$(RM) $(notdir $($(T)_DATA_URL)) $($(T)_TMP_FILE)
+	$(Q)$$(call prologue,$$@)
+	$(Q)$$(call download,$(strip $($(T)_DATA_URL)))
+	$(Q)$$(call extract,$(notdir $($(T)_DATA_URL)))
+	$(Q)$$(call verify,$($(T)_DATA_SHA1), $($(T)_DATA))
+	$(Q)$$(call epilogue,$(notdir $($(T)_DATA_URL)),$(SHA1_FILE1),$(SHA1_FILE2))
 endef
 
 EXTERNAL_DATA = DOOM QUAKE TIMIDITY
-$(foreach T,$(EXTERNAL_DATA),$(eval $(download-n-extract)))
+$(foreach T,$(EXTERNAL_DATA),$(eval $(download-extract-verify)))