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