blob: e7d1c8c58f576050b39c850acdbc8b550306dc00 [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001"""
2BitBake 'Fetch' implementations
3
4Classes for obtaining upstream sources for the
5BitBake build tools.
6
7"""
8
9# Copyright (C) 2003, 2004 Chris Larson
10#
Brad Bishopc342db32019-05-15 21:57:59 -040011# SPDX-License-Identifier: GPL-2.0-only
Patrick Williamsc124f4f2015-09-15 14:41:29 -050012#
13# Based on functions from the base bb module, Copyright 2003 Holger Schurig
Brad Bishopc342db32019-05-15 21:57:59 -040014#
Patrick Williamsc124f4f2015-09-15 14:41:29 -050015
16import os
Patrick Williamsc0f7c042017-02-23 20:41:17 -060017import urllib.request, urllib.parse, urllib.error
Patrick Williamsc124f4f2015-09-15 14:41:29 -050018import bb
19import bb.utils
Andrew Geisslerc9f78652020-09-18 14:11:35 -050020from bb.fetch2 import FetchMethod, FetchError, ParameterError
Patrick Williamsc124f4f2015-09-15 14:41:29 -050021from bb.fetch2 import logger
22
23class Local(FetchMethod):
24 def supports(self, urldata, d):
25 """
26 Check to see if a given url represents a local fetch.
27 """
28 return urldata.type in ['file']
29
30 def urldata_init(self, ud, d):
31 # We don't set localfile as for this fetcher the file is already local!
Patrick Williamsc0f7c042017-02-23 20:41:17 -060032 ud.decodedurl = urllib.parse.unquote(ud.url.split("://")[1].split(";")[0])
Patrick Williamsc124f4f2015-09-15 14:41:29 -050033 ud.basename = os.path.basename(ud.decodedurl)
34 ud.basepath = ud.decodedurl
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050035 ud.needdonestamp = False
Andrew Geisslerc9f78652020-09-18 14:11:35 -050036 if "*" in ud.decodedurl:
37 raise bb.fetch2.ParameterError("file:// urls using globbing are no longer supported. Please place the files in a directory and reference that instead.", ud.url)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050038 return
39
40 def localpath(self, urldata, d):
41 """
42 Return the local filename of a given url assuming a successful fetch.
43 """
44 return self.localpaths(urldata, d)[-1]
45
46 def localpaths(self, urldata, d):
47 """
48 Return the local filename of a given url assuming a successful fetch.
49 """
50 searched = []
51 path = urldata.decodedurl
52 newpath = path
53 if path[0] == "/":
54 return [path]
Brad Bishop6e60e8b2018-02-01 10:27:11 -050055 filespath = d.getVar('FILESPATH')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050056 if filespath:
Andrew Geisslerd1e89492021-02-12 15:35:20 -060057 logger.debug2("Searching for %s in paths:\n %s" % (path, "\n ".join(filespath.split(":"))))
Patrick Williamsc124f4f2015-09-15 14:41:29 -050058 newpath, hist = bb.utils.which(filespath, path, history=True)
59 searched.extend(hist)
Patrick Williamsc124f4f2015-09-15 14:41:29 -050060 if not os.path.exists(newpath):
Brad Bishop6e60e8b2018-02-01 10:27:11 -050061 dldirfile = os.path.join(d.getVar("DL_DIR"), path)
Andrew Geisslerd1e89492021-02-12 15:35:20 -060062 logger.debug2("Defaulting to %s for %s" % (dldirfile, path))
Patrick Williamsc124f4f2015-09-15 14:41:29 -050063 bb.utils.mkdirhier(os.path.dirname(dldirfile))
64 searched.append(dldirfile)
65 return searched
66 return searched
67
68 def need_update(self, ud, d):
Patrick Williamsc124f4f2015-09-15 14:41:29 -050069 if os.path.exists(ud.localpath):
70 return False
71 return True
72
73 def download(self, urldata, d):
74 """Fetch urls (no-op for Local method)"""
75 # no need to fetch local files, we'll deal with them in place.
76 if self.supports_checksum(urldata) and not os.path.exists(urldata.localpath):
77 locations = []
Brad Bishop6e60e8b2018-02-01 10:27:11 -050078 filespath = d.getVar('FILESPATH')
Patrick Williamsc124f4f2015-09-15 14:41:29 -050079 if filespath:
80 locations = filespath.split(":")
Brad Bishop6e60e8b2018-02-01 10:27:11 -050081 locations.append(d.getVar("DL_DIR"))
Patrick Williamsc124f4f2015-09-15 14:41:29 -050082
83 msg = "Unable to find file " + urldata.url + " anywhere. The paths that were searched were:\n " + "\n ".join(locations)
84 raise FetchError(msg)
85
86 return True
87
88 def checkstatus(self, fetch, urldata, d):
89 """
90 Check the status of the url
91 """
Patrick Williamsc124f4f2015-09-15 14:41:29 -050092 if os.path.exists(urldata.localpath):
93 return True
94 return False
95
96 def clean(self, urldata, d):
97 return
98