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