include/download.mk

   1 # SPDX-License-Identifier: GPL-2.0-only
   2 #
   3 # Copyright (C) 2006-2012 OpenWrt.org
   4 # Copyright (C) 2016 LEDE project
   5
   6 PROJECT_GIT = https://git.openwrt.org
   7
   8 OPENWRT_GIT = $(PROJECT_GIT)
   9 LEDE_GIT = $(PROJECT_GIT)
  10
  11 ifdef PKG_SOURCE_VERSION
  12   ifndef PKG_VERSION
  13     PKG_VERSION := $(if $(PKG_SOURCE_DATE),$(PKG_SOURCE_DATE)-)$(call version_abbrev,$(PKG_SOURCE_VERSION))
  14   endif
  15   PKG_SOURCE_SUBDIR ?= $(PKG_NAME)-$(PKG_VERSION)
  16   PKG_SOURCE ?= $(PKG_SOURCE_SUBDIR).tar.xz
  17 endif
  18
  19 DOWNLOAD_RDEP=$(STAMP_PREPARED) $(HOST_STAMP_PREPARED)
  20
  21 # Export options for download.pl
  22 export DOWNLOAD_CHECK_CERTIFICATE:=$(CONFIG_DOWNLOAD_CHECK_CERTIFICATE)
  23
  24 define dl_method_git
  25 $(if $(filter https://github.com/% git://github.com/%,$(1)),github_archive,git)
  26 endef
  27
  28 # Try to guess the download method from the URL
  29 define dl_method
  30 $(strip \
  31   $(if $(filter git,$(2)),$(call dl_method_git,$(1),$(2)),
  32     $(if $(2),$(2), \
  33       $(if $(filter @OPENWRT @APACHE/% @DEBIAN/% @GITHUB/% @GNOME/% @GNU/% @KERNEL/% @SF/% @SAVANNAH/% ftp://% http://% https://% file://%,$(1)),default, \
  34         $(if $(filter git://%,$(1)),$(call dl_method_git,$(1),$(2)), \
  35           $(if $(filter svn://%,$(1)),svn, \
  36             $(if $(filter cvs://%,$(1)),cvs, \
  37               $(if $(filter hg://%,$(1)),hg, \
  38                 $(if $(filter sftp://%,$(1)),bzr, \
  39                   unknown \
  40                 ) \
  41               ) \
  42             ) \
  43           ) \
  44         ) \
  45       ) \
  46     ) \
  47   ) \
  48 )
  49 endef
  50
  51 # code for creating tarballs from cvs/svn/git/bzr/hg/darcs checkouts - useful for mirror support
  52 dl_pack/bz2=bzip2 -c > $(1)
  53 dl_pack/gz=gzip -nc > $(1)
  54 dl_pack/xz=xz -zc -7e > $(1)
  55 dl_pack/zst=zstd -T0 --ultra -20 -c > $(1)
  56 dl_pack/unknown=$(error ERROR: Unknown pack format for file $(1))
  57 define dl_pack
  58         $(if $(dl_pack/$(call ext,$(1))),$(dl_pack/$(call ext,$(1))),$(dl_pack/unknown))
  59 endef
  60 define dl_tar_pack
  61         $(TAR) --numeric-owner --owner=0 --group=0 --mode=a-s --sort=name \
  62                 $$$${TAR_TIMESTAMP:+--mtime="$$$$TAR_TIMESTAMP"} -c $(2) | $(call dl_pack,$(1))
  63 endef
  64
  65 gen_sha256sum = $(shell $(MKHASH) sha256 $(DL_DIR)/$(1))
  66
  67 # Used in Build/CoreTargets and HostBuild/Core as an integrity check for
  68 # downloaded files.  It will add a FORCE rule if the sha256 hash does not
  69 # match, so that the download can be more thoroughly handled by download.pl.
  70 define check_download_integrity
  71   expected_hash:=$(strip $(if $(filter-out x,$(HASH)),$(HASH),$(MIRROR_HASH)))
  72   $$(if $$(and $(FILE),$$(wildcard $(DL_DIR)/$(FILE)), \
  73                $$(filter undefined,$$(flavor DownloadChecked/$(FILE)))), \
  74     $$(eval DownloadChecked/$(FILE):=1) \
  75     $$(if $$(filter-out $$(call gen_sha256sum,$(FILE)),$$(expected_hash)), \
  76       $(DL_DIR)/$(FILE): FORCE) \
  77   )
  78 endef
  79
  80 ifdef CHECK
  81 check_escape=$(subst ','\'',$(1))
  82 #')
  83
  84 # $(1): suffix of the F_, C_ variables, e.g. hash_deprecated, hash_mismatch, etc.
  85 # $(2): filename
  86 # $(3): expected hash value
  87 # $(4): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
  88 check_warn_nofix = $(info $(shell printf "$(_R)WARNING: %s$(_N)" '$(call check_escape,$(call C_$(1),$(2),$(3),$(4)))'))
  89 ifndef FIXUP
  90   check_warn = $(check_warn_nofix)
  91 else
  92   check_warn = $(if $(filter-out undefined,$(origin F_$(1))),$(filter ,$(shell $(call F_$(1),$(2),$(3),$(4)) >&2)),$(check_warn_nofix))
  93 endif
  94
  95 ifdef FIXUP
  96 F_hash_deprecated = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile fix-hash $(3) $(call gen_sha256sum,$(1)) $(2)
  97 F_hash_mismatch = $(F_hash_deprecated)
  98 F_hash_missing = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile add-hash $(3) $(call gen_sha256sum,$(1))
  99 endif
 100
 101 # $(1): filename
 102 # $(2): expected hash value
 103 # $(3): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
 104 C_download_missing = $(1) is missing, please run make download before re-running this check
 105 C_hash_mismatch = $(3) does not match $(1) hash $(call gen_sha256sum,$(1))
 106 C_hash_deprecated = $(3) uses deprecated hash, set to $(call gen_sha256sum,$(1))
 107 C_hash_missing = $(3) is missing, set to $(call gen_sha256sum,$(1))
 108
 109 # $(1): filename
 110 # $(2): expected hash value
 111 # $(3): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
 112 check_hash = \
 113   $(if $(wildcard $(DL_DIR)/$(1)), \
 114     $(if $(filter-out x,$(2)), \
 115       $(if $(filter 64,$(shell printf '%s' '$(2)' | wc -c)), \
 116         $(if $(filter $(2),$(call gen_sha256sum,$(1))),, \
 117           $(call check_warn,hash_mismatch,$(1),$(2),$(3)) \
 118         ), \
 119         $(call check_warn,hash_deprecated,$(1),$(2),$(3)), \
 120       ), \
 121       $(call check_warn,hash_missing,$(1),$(2),$(3)) \
 122     ), \
 123     $(call check_warn,download_missing,$(1),$(2),$(3)) \
 124   )
 125
 126 ifdef FIXUP
 127 F_md5_deprecated = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile rename-var $(2) $(3)
 128 endif
 129
 130 C_md5_deprecated = Use of $(2) is deprecated, switch to $(3)
 131
 132 check_md5 = \
 133   $(if $(filter-out x,$(1)), \
 134     $(call check_warn,md5_deprecated,$(1),$(2),$(3)) \
 135   )
 136
 137 hash_var = $(if $(filter-out x,$(1)),MD5SUM,HASH)
 138 endif
 139
 140 define DownloadMethod/unknown
 141         echo "ERROR: No download method available"; false
 142 endef
 143
 144 define DownloadMethod/default
 145         $(SCRIPT_DIR)/download.pl "$(DL_DIR)" "$(FILE)" "$(HASH)" "$(URL_FILE)" $(foreach url,$(URL),"$(url)") \
 146         $(if $(filter check,$(1)), \
 147                 $(call check_hash,$(FILE),$(HASH),$(2)$(call hash_var,$(MD5SUM))) \
 148                 $(call check_md5,$(MD5SUM),$(2)MD5SUM,$(2)HASH) \
 149         )
 150 endef
 151
 152 # $(1): "check"
 153 # $(2): "PKG_" if <name> as in Download/<name> is "default", otherwise "Download/<name>:"
 154 # $(3): shell command sequence to do the download
 155 define wrap_mirror
 156 $(if $(if $(MIRROR),$(filter-out x,$(MIRROR_HASH))),$(SCRIPT_DIR)/download.pl "$(DL_DIR)" "$(FILE)" "$(MIRROR_HASH)" "" || ( $(3) ),$(3)) \
 157 $(if $(filter check,$(1)), \
 158         $(call check_hash,$(FILE),$(MIRROR_HASH),$(2)MIRROR_$(call hash_var,$(MIRROR_MD5SUM))) \
 159         $(call check_md5,$(MIRROR_MD5SUM),$(2)MIRROR_MD5SUM,$(2)MIRROR_HASH) \
 160 )
 161 endef
 162
 163 define DownloadMethod/cvs
 164         $(call wrap_mirror,$(1),$(2), \
 165                 echo "Checking out files from the cvs repository..."; \
 166                 mkdir -p $(TMP_DIR)/dl && \
 167                 cd $(TMP_DIR)/dl && \
 168                 rm -rf $(SUBDIR) && \
 169                 [ \! -d $(SUBDIR) ] && \
 170                 cvs -d $(URL) export $(VERSION) $(SUBDIR) && \
 171                 echo "Packing checkout..." && \
 172                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 173                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 174                 rm -rf $(SUBDIR); \
 175         )
 176 endef
 177
 178 define DownloadMethod/svn
 179         $(call wrap_mirror,$(1),$(2), \
 180                 echo "Checking out files from the svn repository..."; \
 181                 mkdir -p $(TMP_DIR)/dl && \
 182                 cd $(TMP_DIR)/dl && \
 183                 rm -rf $(SUBDIR) && \
 184                 [ \! -d $(SUBDIR) ] && \
 185                 ( svn help export | grep -q trust-server-cert && \
 186                 svn export --non-interactive --trust-server-cert -r$(VERSION) $(URL) $(SUBDIR) || \
 187                 svn export --non-interactive -r$(VERSION) $(URL) $(SUBDIR) ) && \
 188                 echo "Packing checkout..." && \
 189                 export TAR_TIMESTAMP="" && \
 190                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 191                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 192                 rm -rf $(SUBDIR); \
 193         )
 194 endef
 195
 196 define DownloadMethod/git
 197         $(call wrap_mirror,$(1),$(2), \
 198                 $(call DownloadMethod/rawgit) \
 199         )
 200 endef
 201
 202 define DownloadMethod/github_archive
 203         $(call wrap_mirror,$(1),$(2), \
 204                 $(SCRIPT_DIR)/dl_github_archive.py \
 205                         --dl-dir="$(DL_DIR)" \
 206                         --url="$(URL)" \
 207                         --version="$(VERSION)" \
 208                         --subdir="$(SUBDIR)" \
 209                         --source="$(FILE)" \
 210                         --hash="$(MIRROR_HASH)" \
 211                 || ( $(call DownloadMethod/rawgit) ); \
 212         )
 213 endef
 214
 215 # Only intends to be called as a submethod from other DownloadMethod
 216 define DownloadMethod/rawgit
 217         echo "Checking out files from the git repository..."; \
 218         mkdir -p $(TMP_DIR)/dl && \
 219         cd $(TMP_DIR)/dl && \
 220         rm -rf $(SUBDIR) && \
 221         [ \! -d $(SUBDIR) ] && \
 222         git clone $(OPTS) $(URL) $(SUBDIR) && \
 223         (cd $(SUBDIR) && git checkout $(VERSION) && \
 224         git submodule update --init --recursive) && \
 225         echo "Packing checkout..." && \
 226         export TAR_TIMESTAMP=`cd $(SUBDIR) && git log -1 --format='@%ct'` && \
 227         rm -rf $(SUBDIR)/.git && \
 228         $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 229         mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 230         rm -rf $(SUBDIR);
 231 endef
 232
 233 define DownloadMethod/bzr
 234         $(call wrap_mirror,$(1),$(2), \
 235                 echo "Checking out files from the bzr repository..."; \
 236                 mkdir -p $(TMP_DIR)/dl && \
 237                 cd $(TMP_DIR)/dl && \
 238                 rm -rf $(SUBDIR) && \
 239                 [ \! -d $(SUBDIR) ] && \
 240                 bzr export --per-file-timestamps -r$(VERSION) $(SUBDIR) $(URL) && \
 241                 echo "Packing checkout..." && \
 242                 export TAR_TIMESTAMP="" && \
 243                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 244                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 245                 rm -rf $(SUBDIR); \
 246         )
 247 endef
 248
 249 define DownloadMethod/hg
 250         $(call wrap_mirror,$(1),$(2), \
 251                 echo "Checking out files from the hg repository..."; \
 252                 mkdir -p $(TMP_DIR)/dl && \
 253                 cd $(TMP_DIR)/dl && \
 254                 rm -rf $(SUBDIR) && \
 255                 [ \! -d $(SUBDIR) ] && \
 256                 hg clone -r $(VERSION) $(URL) $(SUBDIR) && \
 257                 export TAR_TIMESTAMP=`cd $(SUBDIR) && hg log --template '@{date}' -l 1` && \
 258                 find $(SUBDIR) -name .hg | xargs rm -rf && \
 259                 echo "Packing checkout..." && \
 260                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 261                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 262                 rm -rf $(SUBDIR); \
 263         )
 264 endef
 265
 266 define DownloadMethod/darcs
 267         $(call wrap_mirror, $(1), $(2), \
 268                 echo "Checking out files from the darcs repository..."; \
 269                 mkdir -p $(TMP_DIR)/dl && \
 270                 cd $(TMP_DIR)/dl && \
 271                 rm -rf $(SUBDIR) && \
 272                 [ \! -d $(SUBDIR) ] && \
 273                 darcs get -t $(VERSION) $(URL) $(SUBDIR) && \
 274                 export TAR_TIMESTAMP=`cd $(SUBDIR) && LC_ALL=C darcs log --last 1 | sed -ne 's!^Date: \+!!p'` && \
 275                 find $(SUBDIR) -name _darcs | xargs rm -rf && \
 276                 echo "Packing checkout..." && \
 277                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 278                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 279                 rm -rf $(SUBDIR); \
 280         )
 281 endef
 282
 283 Validate/cvs=VERSION SUBDIR
 284 Validate/svn=VERSION SUBDIR
 285 Validate/git=VERSION SUBDIR
 286 Validate/bzr=VERSION SUBDIR
 287 Validate/hg=VERSION SUBDIR
 288 Validate/darcs=VERSION SUBDIR
 289
 290 define Download/Defaults
 291   URL:=
 292   FILE:=
 293   URL_FILE:=
 294   PROTO:=
 295   HASH=$$(MD5SUM)
 296   MD5SUM:=x
 297   SUBDIR:=
 298   MIRROR:=1
 299   MIRROR_HASH=$$(MIRROR_MD5SUM)
 300   MIRROR_MD5SUM:=x
 301   VERSION:=
 302   OPTS:=
 303 endef
 304
 305 define Download/default
 306   FILE:=$(PKG_SOURCE)
 307   URL:=$(PKG_SOURCE_URL)
 308   URL_FILE:=$(PKG_SOURCE_URL_FILE)
 309   SUBDIR:=$(PKG_SOURCE_SUBDIR)
 310   PROTO:=$(PKG_SOURCE_PROTO)
 311   $(if $(PKG_SOURCE_MIRROR),MIRROR:=$(filter 1,$(PKG_MIRROR)))
 312   $(if $(PKG_MIRROR_MD5SUM),MIRROR_MD5SUM:=$(PKG_MIRROR_MD5SUM))
 313   $(if $(PKG_MIRROR_HASH),MIRROR_HASH:=$(PKG_MIRROR_HASH))
 314   VERSION:=$(PKG_SOURCE_VERSION)
 315   $(if $(PKG_MD5SUM),MD5SUM:=$(PKG_MD5SUM))
 316   $(if $(PKG_HASH),HASH:=$(PKG_HASH))
 317 endef
 318
 319 define Download
 320   $(eval $(Download/Defaults))
 321   $(eval $(Download/$(1)))
 322   $(foreach FIELD,URL FILE $(Validate/$(call dl_method,$(URL),$(PROTO))),
 323     ifeq ($($(FIELD)),)
 324       $$(error Download/$(1) is missing the $(FIELD) field.)
 325     endif
 326   )
 327
 328   $(foreach dep,$(DOWNLOAD_RDEP),
 329     $(dep): $(DL_DIR)/$(FILE)
 330   )
 331   download: $(DL_DIR)/$(FILE)
 332
 333   $(DL_DIR)/$(FILE):
 334         mkdir -p $(DL_DIR)
 335         $(call locked, \
 336                 $(if $(DownloadMethod/$(call dl_method,$(URL),$(PROTO))), \
 337                         $(call DownloadMethod/$(call dl_method,$(URL),$(PROTO)),check,$(if $(filter default,$(1)),PKG_,Download/$(1):)), \
 338                         $(DownloadMethod/unknown) \
 339                 ),\
 340                 $(FILE))
 341
 342 endef