package/pkg-download.mk

   1 ################################################################################
   2 #
   3 # This file contains the download helpers for the various package
   4 # infrastructures. It is used to handle downloads from HTTP servers,
   5 # FTP servers, Git repositories, Subversion repositories, Mercurial
   6 # repositories, Bazaar repositories, and SCP servers.
   7 #
   8 ################################################################################
   9
  10 # Download method commands
  11 export WGET := $(call qstrip,$(BR2_WGET))
  12 export SVN := $(call qstrip,$(BR2_SVN))
  13 export CVS := $(call qstrip,$(BR2_CVS))
  14 export BZR := $(call qstrip,$(BR2_BZR))
  15 export GIT := $(call qstrip,$(BR2_GIT))
  16 export HG := $(call qstrip,$(BR2_HG))
  17 export SCP := $(call qstrip,$(BR2_SCP))
  18 SSH := $(call qstrip,$(BR2_SSH))
  19 export LOCALFILES := $(call qstrip,$(BR2_LOCALFILES))
  20
  21 DL_WRAPPER = support/download/dl-wrapper
  22
  23 # DL_DIR may have been set already from the environment
  24 ifeq ($(origin DL_DIR),undefined)
  25 DL_DIR ?= $(call qstrip,$(BR2_DL_DIR))
  26 ifeq ($(DL_DIR),)
  27 DL_DIR := $(TOPDIR)/dl
  28 endif
  29 else
  30 # Restore the BR2_DL_DIR that was overridden by the .config file
  31 BR2_DL_DIR = $(DL_DIR)
  32 endif
  33
  34 # ensure it exists and a absolute path
  35 DL_DIR := $(shell mkdir -p $(DL_DIR) && cd $(DL_DIR) >/dev/null && pwd)
  36
  37 #
  38 # URI scheme helper functions
  39 # Example URIs:
  40 # * http://www.example.com/dir/file
  41 # * scp://www.example.com:dir/file (with domainseparator :)
  42 #
  43 # geturischeme: http
  44 geturischeme = $(firstword $(subst ://, ,$(call qstrip,$(1))))
  45 # stripurischeme: www.example.com/dir/file
  46 stripurischeme = $(lastword $(subst ://, ,$(call qstrip,$(1))))
  47 # domain: www.example.com
  48 domain = $(firstword $(subst $(call domainseparator,$(2)), ,$(call stripurischeme,$(1))))
  49 # notdomain: dir/file
  50 notdomain = $(patsubst $(call domain,$(1),$(2))$(call domainseparator,$(2))%,%,$(call stripurischeme,$(1)))
  51 #
  52 # default domainseparator is /, specify alternative value as first argument
  53 domainseparator = $(if $(1),$(1),/)
  54
  55 # github(user,package,version): returns site of GitHub repository
  56 github = https://github.com/$(1)/$(2)/archive/$(3)
  57
  58 # Expressly do not check hashes for those files
  59 # Exported variables default to immediately expanded in some versions of
  60 # make, but we need it to be recursively-epxanded, so explicitly assign it.
  61 export BR_NO_CHECK_HASH_FOR =
  62
  63 ################################################################################
  64 # The DOWNLOAD_* helpers are in charge of getting a working copy
  65 # of the source repository for their corresponding SCM,
  66 # checking out the requested version / commit / tag, and create an
  67 # archive out of it. DOWNLOAD_SCP uses scp to obtain a remote file with
  68 # ssh authentication. DOWNLOAD_WGET is the normal wget-based download
  69 # mechanism.
  70 #
  71 # The SOURCE_CHECK_* helpers are in charge of simply checking that the source
  72 # is available for download. This can be used to make sure one will be able
  73 # to get all the sources needed for one's build configuration.
  74 ################################################################################
  75
  76 define DOWNLOAD_GIT
  77         $(EXTRA_ENV) $(DL_WRAPPER) -b git \
  78                 -o $(DL_DIR)/$($(PKG)_SOURCE) \
  79                 $(if $($(PKG)_GIT_SUBMODULES),-r) \
  80                 $(QUIET) \
  81                 -- \
  82                 $($(PKG)_SITE) \
  83                 $($(PKG)_DL_VERSION) \
  84                 $($(PKG)_BASE_NAME)
  85 endef
  86
  87 # TODO: improve to check that the given PKG_DL_VERSION exists on the remote
  88 # repository
  89 define SOURCE_CHECK_GIT
  90         $(GIT) ls-remote --heads $($(PKG)_SITE) > /dev/null
  91 endef
  92
  93 define DOWNLOAD_BZR
  94         $(EXTRA_ENV) $(DL_WRAPPER) -b bzr \
  95                 -o $(DL_DIR)/$($(PKG)_SOURCE) \
  96                 $(QUIET) \
  97                 -- \
  98                 $($(PKG)_SITE) \
  99                 $($(PKG)_DL_VERSION) \
 100                 $($(PKG)_BASE_NAME)
 101 endef
 102
 103 define SOURCE_CHECK_BZR
 104         $(BZR) ls --quiet $($(PKG)_SITE) > /dev/null
 105 endef
 106
 107 define DOWNLOAD_CVS
 108         $(EXTRA_ENV) $(DL_WRAPPER) -b cvs \
 109                 -o $(DL_DIR)/$($(PKG)_SOURCE) \
 110                 $(QUIET) \
 111                 -- \
 112                 $(call stripurischeme,$(call qstrip,$($(PKG)_SITE))) \
 113                 $($(PKG)_DL_VERSION) \
 114                 $($(PKG)_RAWNAME) \
 115                 $($(PKG)_BASE_NAME)
 116 endef
 117
 118 # Not all CVS servers support ls/rls, use login to see if we can connect
 119 define SOURCE_CHECK_CVS
 120         $(CVS) -d:pserver:anonymous:@$(call stripurischeme,$(call qstrip,$($(PKG)_SITE))) login
 121 endef
 122
 123 define DOWNLOAD_SVN
 124         $(EXTRA_ENV) $(DL_WRAPPER) -b svn \
 125                 -o $(DL_DIR)/$($(PKG)_SOURCE) \
 126                 $(QUIET) \
 127                 -- \
 128                 $($(PKG)_SITE) \
 129                 $($(PKG)_DL_VERSION) \
 130                 $($(PKG)_BASE_NAME)
 131 endef
 132
 133 define SOURCE_CHECK_SVN
 134         $(SVN) ls $($(PKG)_SITE)@$($(PKG)_DL_VERSION) > /dev/null
 135 endef
 136
 137 # SCP URIs should be of the form scp://[user@]host:filepath
 138 # Note that filepath is relative to the user's home directory, so you may want
 139 # to prepend the path with a slash: scp://[user@]host:/absolutepath
 140 define DOWNLOAD_SCP
 141         $(EXTRA_ENV) $(DL_WRAPPER) -b scp \
 142                 -o $(DL_DIR)/$(2) \
 143                 -H $(PKGDIR)/$($(PKG)_RAWNAME).hash \
 144                 $(QUIET) \
 145                 -- \
 146                 '$(call stripurischeme,$(call qstrip,$(1)))'
 147 endef
 148
 149 define SOURCE_CHECK_SCP
 150         $(SSH) $(call domain,$(1),:) ls '$(call notdomain,$(1),:)' > /dev/null
 151 endef
 152
 153 define DOWNLOAD_HG
 154         $(EXTRA_ENV) $(DL_WRAPPER) -b hg \
 155                 -o $(DL_DIR)/$($(PKG)_SOURCE) \
 156                 $(QUIET) \
 157                 -- \
 158                 $($(PKG)_SITE) \
 159                 $($(PKG)_DL_VERSION) \
 160                 $($(PKG)_BASE_NAME)
 161 endef
 162
 163 # TODO: improve to check that the given PKG_DL_VERSION exists on the remote
 164 # repository
 165 define SOURCE_CHECK_HG
 166         $(HG) incoming --force -l1 $($(PKG)_SITE) > /dev/null
 167 endef
 168
 169 define DOWNLOAD_WGET
 170         $(EXTRA_ENV) $(DL_WRAPPER) -b wget \
 171                 -o $(DL_DIR)/$(2) \
 172                 -H $(PKGDIR)/$($(PKG)_RAWNAME).hash \
 173                 $(QUIET) \
 174                 -- \
 175                 '$(call qstrip,$(1))'
 176 endef
 177
 178 define SOURCE_CHECK_WGET
 179         $(WGET) --spider '$(call qstrip,$(1))'
 180 endef
 181
 182 define DOWNLOAD_LOCALFILES
 183         $(EXTRA_ENV) $(DL_WRAPPER) -b cp \
 184                 -o $(DL_DIR)/$(2) \
 185                 -H $(PKGDIR)/$($(PKG)_RAWNAME).hash \
 186                 $(QUIET) \
 187                 -- \
 188                 $(call stripurischeme,$(call qstrip,$(1)))
 189 endef
 190
 191 define SOURCE_CHECK_LOCALFILES
 192         test -e $(call stripurischeme,$(call qstrip,$(1)))
 193 endef
 194
 195 ################################################################################
 196 # DOWNLOAD -- Download helper. Will try to download source from:
 197 # 1) BR2_PRIMARY_SITE if enabled
 198 # 2) Download site, unless BR2_PRIMARY_SITE_ONLY is set
 199 # 3) BR2_BACKUP_SITE if enabled, unless BR2_PRIMARY_SITE_ONLY is set
 200 #
 201 # Argument 1 is the source location
 202 #
 203 # E.G. use like this:
 204 # $(call DOWNLOAD,$(FOO_SITE))
 205 ################################################################################
 206
 207 define DOWNLOAD
 208         $(call DOWNLOAD_INNER,$(1),$(notdir $(1)),DOWNLOAD)
 209 endef
 210
 211 define SOURCE_CHECK
 212         $(call DOWNLOAD_INNER,$(1),$(notdir $(1)),SOURCE_CHECK)
 213 endef
 214
 215 define DOWNLOAD_INNER
 216         $(Q)$(if $(filter bzr cvs git hg svn,$($(PKG)_SITE_METHOD)),export BR_NO_CHECK_HASH_FOR=$(2);) \
 217         if test -n "$(call qstrip,$(BR2_PRIMARY_SITE))" ; then \
 218                 case "$(call geturischeme,$(BR2_PRIMARY_SITE))" in \
 219                         file) $(call $(3)_LOCALFILES,$(BR2_PRIMARY_SITE)/$(2),$(2)) && exit ;; \
 220                         scp) $(call $(3)_SCP,$(BR2_PRIMARY_SITE)/$(2),$(2)) && exit ;; \
 221                         *) $(call $(3)_WGET,$(BR2_PRIMARY_SITE)/$(2),$(2)) && exit ;; \
 222                 esac ; \
 223         fi ; \
 224         if test "$(BR2_PRIMARY_SITE_ONLY)" = "y" ; then \
 225                 exit 1 ; \
 226         fi ; \
 227         if test -n "$(1)" ; then \
 228                 case "$($(PKG)_SITE_METHOD)" in \
 229                         git) $($(3)_GIT) && exit ;; \
 230                         svn) $($(3)_SVN) && exit ;; \
 231                         cvs) $($(3)_CVS) && exit ;; \
 232                         bzr) $($(3)_BZR) && exit ;; \
 233                         file) $($(3)_LOCALFILES) && exit ;; \
 234                         scp) $($(3)_SCP) && exit ;; \
 235                         hg) $($(3)_HG) && exit ;; \
 236                         *) $(call $(3)_WGET,$(1),$(2)) && exit ;; \
 237                 esac ; \
 238         fi ; \
 239         if test -n "$(call qstrip,$(BR2_BACKUP_SITE))" ; then \
 240                 $(call $(3)_WGET,$(BR2_BACKUP_SITE)/$(2),$(2)) && exit ; \
 241         fi ; \
 242         exit 1
 243 endef