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