include/download.mk

   1 #
   2 # Copyright (C) 2006-2012 OpenWrt.org
   3 # Copyright (C) 2016 LEDE project
   4 #
   5 # This is free software, licensed under the GNU General Public License v2.
   6 # See /LICENSE for more information.
   7 #
   8
   9 PROJECT_GIT = https://git.openwrt.org
  10
  11 OPENWRT_GIT = $(PROJECT_GIT)
  12 LEDE_GIT = $(PROJECT_GIT)
  13
  14 ifdef PKG_SOURCE_VERSION
  15   ifndef PKG_VERSION
  16     PKG_VERSION := $(if $(PKG_SOURCE_DATE),$(PKG_SOURCE_DATE)-)$(call version_abbrev,$(PKG_SOURCE_VERSION))
  17   endif
  18   PKG_SOURCE_SUBDIR ?= $(PKG_NAME)-$(PKG_VERSION)
  19   PKG_SOURCE ?= $(PKG_SOURCE_SUBDIR).tar.xz
  20 endif
  21
  22 DOWNLOAD_RDEP=$(STAMP_PREPARED) $(HOST_STAMP_PREPARED)
  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 @APACHE/% @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 ifdef CHECK
  66 check_escape=$(subst ','\'',$(1))
  67 #')
  68
  69 # $(1): suffix of the F_, C_ variables, e.g. hash_deprecated, hash_mismatch, etc.
  70 # $(2): filename
  71 # $(3): expected hash value
  72 # $(4): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
  73 check_warn_nofix = $(info $(shell printf "$(_R)WARNING: %s$(_N)" '$(call check_escape,$(call C_$(1),$(2),$(3),$(4)))'))
  74 ifndef FIXUP
  75   check_warn = $(check_warn_nofix)
  76 else
  77   check_warn = $(if $(filter-out undefined,$(origin F_$(1))),$(filter ,$(shell $(call F_$(1),$(2),$(3),$(4)) >&2)),$(check_warn_nofix))
  78 endif
  79
  80 gen_sha256sum = $(shell mkhash sha256 $(DL_DIR)/$(1))
  81
  82 ifdef FIXUP
  83 F_hash_deprecated = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile fix-hash $(3) $(call gen_sha256sum,$(1)) $(2)
  84 F_hash_mismatch = $(F_hash_deprecated)
  85 F_hash_missing = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile add-hash $(3) $(call gen_sha256sum,$(1))
  86 endif
  87
  88 # $(1): filename
  89 # $(2): expected hash value
  90 # $(3): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
  91 C_download_missing = $(1) is missing, please run make download before re-running this check
  92 C_hash_mismatch = $(3) does not match $(1) hash $(call gen_sha256sum,$(1))
  93 C_hash_deprecated = $(3) uses deprecated hash, set to $(call gen_sha256sum,$(1))
  94 C_hash_missing = $(3) is missing, set to $(call gen_sha256sum,$(1))
  95
  96 # $(1): filename
  97 # $(2): expected hash value
  98 # $(3): var name of the the form: {PKG_,Download/<name>:}{,MIRROR_}{HASH,MIRROR_HASH}
  99 check_hash = \
 100   $(if $(wildcard $(DL_DIR)/$(1)), \
 101     $(if $(filter-out x,$(2)), \
 102       $(if $(filter 64,$(shell printf '%s' '$(2)' | wc -c)), \
 103         $(if $(filter $(2),$(call gen_sha256sum,$(1))),, \
 104           $(call check_warn,hash_mismatch,$(1),$(2),$(3)) \
 105         ), \
 106         $(call check_warn,hash_deprecated,$(1),$(2),$(3)), \
 107       ), \
 108       $(call check_warn,hash_missing,$(1),$(2),$(3)) \
 109     ), \
 110     $(call check_warn,download_missing,$(1),$(2),$(3)) \
 111   )
 112
 113 ifdef FIXUP
 114 F_md5_deprecated = $(SCRIPT_DIR)/fixup-makefile.pl $(CURDIR)/Makefile rename-var $(2) $(3)
 115 endif
 116
 117 C_md5_deprecated = Use of $(2) is deprecated, switch to $(3)
 118
 119 check_md5 = \
 120   $(if $(filter-out x,$(1)), \
 121     $(call check_warn,md5_deprecated,$(1),$(2),$(3)) \
 122   )
 123
 124 hash_var = $(if $(filter-out x,$(1)),MD5SUM,HASH)
 125 endif
 126
 127 define DownloadMethod/unknown
 128         echo "ERROR: No download method available"; false
 129 endef
 130
 131 define DownloadMethod/default
 132         $(SCRIPT_DIR)/download.pl "$(DL_DIR)" "$(FILE)" "$(HASH)" "$(URL_FILE)" $(foreach url,$(URL),"$(url)") \
 133         $(if $(filter check,$(1)), \
 134                 $(call check_hash,$(FILE),$(HASH),$(2)$(call hash_var,$(MD5SUM))) \
 135                 $(call check_md5,$(MD5SUM),$(2)MD5SUM,$(2)HASH) \
 136         )
 137 endef
 138
 139 # $(1): "check"
 140 # $(2): "PKG_" if <name> as in Download/<name> is "default", otherwise "Download/<name>:"
 141 # $(3): shell command sequence to do the download
 142 define wrap_mirror
 143 $(if $(if $(MIRROR),$(filter-out x,$(MIRROR_HASH))),$(SCRIPT_DIR)/download.pl "$(DL_DIR)" "$(FILE)" "$(MIRROR_HASH)" "" || ( $(3) ),$(3)) \
 144 $(if $(filter check,$(1)), \
 145         $(call check_hash,$(FILE),$(MIRROR_HASH),$(2)MIRROR_$(call hash_var,$(MIRROR_MD5SUM))) \
 146         $(call check_md5,$(MIRROR_MD5SUM),$(2)MIRROR_MD5SUM,$(2)MIRROR_HASH) \
 147 )
 148 endef
 149
 150 define DownloadMethod/cvs
 151         $(call wrap_mirror,$(1),$(2), \
 152                 echo "Checking out files from the cvs repository..."; \
 153                 mkdir -p $(TMP_DIR)/dl && \
 154                 cd $(TMP_DIR)/dl && \
 155                 rm -rf $(SUBDIR) && \
 156                 [ \! -d $(SUBDIR) ] && \
 157                 cvs -d $(URL) export $(VERSION) $(SUBDIR) && \
 158                 echo "Packing checkout..." && \
 159                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 160                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 161                 rm -rf $(SUBDIR); \
 162         )
 163 endef
 164
 165 define DownloadMethod/svn
 166         $(call wrap_mirror,$(1),$(2), \
 167                 echo "Checking out files from the svn repository..."; \
 168                 mkdir -p $(TMP_DIR)/dl && \
 169                 cd $(TMP_DIR)/dl && \
 170                 rm -rf $(SUBDIR) && \
 171                 [ \! -d $(SUBDIR) ] && \
 172                 ( svn help export | grep -q trust-server-cert && \
 173                 svn export --non-interactive --trust-server-cert -r$(VERSION) $(URL) $(SUBDIR) || \
 174                 svn export --non-interactive -r$(VERSION) $(URL) $(SUBDIR) ) && \
 175                 echo "Packing checkout..." && \
 176                 export TAR_TIMESTAMP="" && \
 177                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 178                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 179                 rm -rf $(SUBDIR); \
 180         )
 181 endef
 182
 183 define DownloadMethod/git
 184         $(call wrap_mirror,$(1),$(2), \
 185                 $(call DownloadMethod/rawgit) \
 186         )
 187 endef
 188
 189 define DownloadMethod/github_archive
 190         $(call wrap_mirror,$(1),$(2), \
 191                 $(SCRIPT_DIR)/dl_github_archive.py \
 192                         --dl-dir="$(DL_DIR)" \
 193                         --url="$(URL)" \
 194                         --version="$(VERSION)" \
 195                         --subdir="$(SUBDIR)" \
 196                         --source="$(FILE)" \
 197                         --hash="$(MIRROR_HASH)" \
 198                 || ( $(call DownloadMethod/rawgit) ); \
 199         )
 200 endef
 201
 202 # Only intends to be called as a submethod from other DownloadMethod
 203 define DownloadMethod/rawgit
 204         echo "Checking out files from the git repository..."; \
 205         mkdir -p $(TMP_DIR)/dl && \
 206         cd $(TMP_DIR)/dl && \
 207         rm -rf $(SUBDIR) && \
 208         [ \! -d $(SUBDIR) ] && \
 209         git clone $(OPTS) $(URL) $(SUBDIR) && \
 210         (cd $(SUBDIR) && git checkout $(VERSION) && \
 211         git submodule update --init --recursive) && \
 212         echo "Packing checkout..." && \
 213         export TAR_TIMESTAMP=`cd $(SUBDIR) && git log -1 --format='@%ct'` && \
 214         rm -rf $(SUBDIR)/.git && \
 215         $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 216         mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 217         rm -rf $(SUBDIR);
 218 endef
 219
 220 define DownloadMethod/bzr
 221         $(call wrap_mirror,$(1),$(2), \
 222                 echo "Checking out files from the bzr repository..."; \
 223                 mkdir -p $(TMP_DIR)/dl && \
 224                 cd $(TMP_DIR)/dl && \
 225                 rm -rf $(SUBDIR) && \
 226                 [ \! -d $(SUBDIR) ] && \
 227                 bzr export --per-file-timestamps -r$(VERSION) $(SUBDIR) $(URL) && \
 228                 echo "Packing checkout..." && \
 229                 export TAR_TIMESTAMP="" && \
 230                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 231                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 232                 rm -rf $(SUBDIR); \
 233         )
 234 endef
 235
 236 define DownloadMethod/hg
 237         $(call wrap_mirror,$(1),$(2), \
 238                 echo "Checking out files from the hg repository..."; \
 239                 mkdir -p $(TMP_DIR)/dl && \
 240                 cd $(TMP_DIR)/dl && \
 241                 rm -rf $(SUBDIR) && \
 242                 [ \! -d $(SUBDIR) ] && \
 243                 hg clone -r $(VERSION) $(URL) $(SUBDIR) && \
 244                 export TAR_TIMESTAMP=`cd $(SUBDIR) && hg log --template '@{date}' -l 1` && \
 245                 find $(SUBDIR) -name .hg | xargs rm -rf && \
 246                 echo "Packing checkout..." && \
 247                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 248                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 249                 rm -rf $(SUBDIR); \
 250         )
 251 endef
 252
 253 define DownloadMethod/darcs
 254         $(call wrap_mirror, $(1), $(2), \
 255                 echo "Checking out files from the darcs repository..."; \
 256                 mkdir -p $(TMP_DIR)/dl && \
 257                 cd $(TMP_DIR)/dl && \
 258                 rm -rf $(SUBDIR) && \
 259                 [ \! -d $(SUBDIR) ] && \
 260                 darcs get -t $(VERSION) $(URL) $(SUBDIR) && \
 261                 export TAR_TIMESTAMP=`cd $(SUBDIR) && LC_ALL=C darcs log --last 1 | sed -ne 's!^Date: \+!!p'` && \
 262                 find $(SUBDIR) -name _darcs | xargs rm -rf && \
 263                 echo "Packing checkout..." && \
 264                 $(call dl_tar_pack,$(TMP_DIR)/dl/$(FILE),$(SUBDIR)) && \
 265                 mv $(TMP_DIR)/dl/$(FILE) $(DL_DIR)/ && \
 266                 rm -rf $(SUBDIR); \
 267         )
 268 endef
 269
 270 Validate/cvs=VERSION SUBDIR
 271 Validate/svn=VERSION SUBDIR
 272 Validate/git=VERSION SUBDIR
 273 Validate/bzr=VERSION SUBDIR
 274 Validate/hg=VERSION SUBDIR
 275 Validate/darcs=VERSION SUBDIR
 276
 277 define Download/Defaults
 278   URL:=
 279   FILE:=
 280   URL_FILE:=
 281   PROTO:=
 282   HASH=$$(MD5SUM)
 283   MD5SUM:=x
 284   SUBDIR:=
 285   MIRROR:=1
 286   MIRROR_HASH=$$(MIRROR_MD5SUM)
 287   MIRROR_MD5SUM:=x
 288   VERSION:=
 289   OPTS:=
 290 endef
 291
 292 define Download/default
 293   FILE:=$(PKG_SOURCE)
 294   URL:=$(PKG_SOURCE_URL)
 295   URL_FILE:=$(PKG_SOURCE_URL_FILE)
 296   SUBDIR:=$(PKG_SOURCE_SUBDIR)
 297   PROTO:=$(PKG_SOURCE_PROTO)
 298   $(if $(PKG_SOURCE_MIRROR),MIRROR:=$(filter 1,$(PKG_MIRROR)))
 299   $(if $(PKG_MIRROR_MD5SUM),MIRROR_MD5SUM:=$(PKG_MIRROR_MD5SUM))
 300   $(if $(PKG_MIRROR_HASH),MIRROR_HASH:=$(PKG_MIRROR_HASH))
 301   VERSION:=$(PKG_SOURCE_VERSION)
 302   $(if $(PKG_MD5SUM),MD5SUM:=$(PKG_MD5SUM))
 303   $(if $(PKG_HASH),HASH:=$(PKG_HASH))
 304 endef
 305
 306 define Download
 307   $(eval $(Download/Defaults))
 308   $(eval $(Download/$(1)))
 309   $(foreach FIELD,URL FILE $(Validate/$(call dl_method,$(URL),$(PROTO))),
 310     ifeq ($($(FIELD)),)
 311       $$(error Download/$(1) is missing the $(FIELD) field.)
 312     endif
 313   )
 314
 315   $(foreach dep,$(DOWNLOAD_RDEP),
 316     $(dep): $(DL_DIR)/$(FILE)
 317   )
 318   download: $(DL_DIR)/$(FILE)
 319
 320   $(DL_DIR)/$(FILE):
 321         mkdir -p $(DL_DIR)
 322         $(call locked, \
 323                 $(if $(DownloadMethod/$(call dl_method,$(URL),$(PROTO))), \
 324                         $(call DownloadMethod/$(call dl_method,$(URL),$(PROTO)),check,$(if $(filter default,$(1)),PKG_,Download/$(1):)), \
 325                         $(DownloadMethod/unknown) \
 326                 ),\
 327                 $(FILE))
 328
 329 endef