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