blob: 1fb6b555301983a2002647c4b8cf133190a3d64c [file] [log] [blame]
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001# Recipe creation tool - create command plugin
2#
Brad Bishopd7bf8c12018-02-25 22:55:05 -05003# Copyright (C) 2014-2017 Intel Corporation
Patrick Williamsc124f4f2015-09-15 14:41:29 -05004#
Brad Bishopc342db32019-05-15 21:57:59 -04005# SPDX-License-Identifier: GPL-2.0-only
Patrick Williamsc124f4f2015-09-15 14:41:29 -05006#
Patrick Williamsc124f4f2015-09-15 14:41:29 -05007
8import sys
9import os
10import argparse
11import glob
12import fnmatch
13import re
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050014import json
Patrick Williamsc124f4f2015-09-15 14:41:29 -050015import logging
16import scriptutils
Patrick Williamsc0f7c042017-02-23 20:41:17 -060017from urllib.parse import urlparse, urldefrag, urlsplit
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050018import hashlib
Brad Bishop6e60e8b2018-02-01 10:27:11 -050019import bb.fetch2
Patrick Williamsc124f4f2015-09-15 14:41:29 -050020logger = logging.getLogger('recipetool')
21
22tinfoil = None
23plugins = None
24
Brad Bishop6e60e8b2018-02-01 10:27:11 -050025def log_error_cond(message, debugonly):
26 if debugonly:
27 logger.debug(message)
28 else:
29 logger.error(message)
30
31def log_info_cond(message, debugonly):
32 if debugonly:
33 logger.debug(message)
34 else:
35 logger.info(message)
36
Patrick Williamsc124f4f2015-09-15 14:41:29 -050037def plugin_init(pluginlist):
38 # Take a reference to the list so we can use it later
39 global plugins
40 plugins = pluginlist
41
42def tinfoil_init(instance):
43 global tinfoil
44 tinfoil = instance
45
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050046class RecipeHandler(object):
47 recipelibmap = {}
48 recipeheadermap = {}
49 recipecmakefilemap = {}
50 recipebinmap = {}
51
Brad Bishop6e60e8b2018-02-01 10:27:11 -050052 def __init__(self):
53 self._devtool = False
54
Patrick Williamsc124f4f2015-09-15 14:41:29 -050055 @staticmethod
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050056 def load_libmap(d):
57 '''Load library->recipe mapping'''
58 import oe.package
59
60 if RecipeHandler.recipelibmap:
61 return
62 # First build up library->package mapping
Brad Bishop96ff1982019-08-19 13:50:42 -040063 d2 = bb.data.createCopy(d)
64 d2.setVar("WORKDIR_PKGDATA", "${PKGDATA_DIR}")
65 shlib_providers = oe.package.read_shlib_providers(d2)
Brad Bishop6e60e8b2018-02-01 10:27:11 -050066 libdir = d.getVar('libdir')
67 base_libdir = d.getVar('base_libdir')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050068 libpaths = list(set([base_libdir, libdir]))
69 libname_re = re.compile('^lib(.+)\.so.*$')
70 pkglibmap = {}
Patrick Williamsc0f7c042017-02-23 20:41:17 -060071 for lib, item in shlib_providers.items():
72 for path, pkg in item.items():
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050073 if path in libpaths:
74 res = libname_re.match(lib)
75 if res:
76 libname = res.group(1)
77 if not libname in pkglibmap:
78 pkglibmap[libname] = pkg[0]
79 else:
80 logger.debug('unable to extract library name from %s' % lib)
81
82 # Now turn it into a library->recipe mapping
Brad Bishop6e60e8b2018-02-01 10:27:11 -050083 pkgdata_dir = d.getVar('PKGDATA_DIR')
Patrick Williamsc0f7c042017-02-23 20:41:17 -060084 for libname, pkg in pkglibmap.items():
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050085 try:
86 with open(os.path.join(pkgdata_dir, 'runtime', pkg)) as f:
87 for line in f:
88 if line.startswith('PN:'):
89 RecipeHandler.recipelibmap[libname] = line.split(':', 1)[-1].strip()
90 break
91 except IOError as ioe:
92 if ioe.errno == 2:
Brad Bishop1a4b7ee2018-12-16 17:11:34 -080093 logger.warning('unable to find a pkgdata file for package %s' % pkg)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -050094 else:
95 raise
96
97 # Some overrides - these should be mapped to the virtual
98 RecipeHandler.recipelibmap['GL'] = 'virtual/libgl'
99 RecipeHandler.recipelibmap['EGL'] = 'virtual/egl'
100 RecipeHandler.recipelibmap['GLESv2'] = 'virtual/libgles2'
101
102 @staticmethod
103 def load_devel_filemap(d):
104 '''Build up development file->recipe mapping'''
105 if RecipeHandler.recipeheadermap:
106 return
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500107 pkgdata_dir = d.getVar('PKGDATA_DIR')
108 includedir = d.getVar('includedir')
109 cmakedir = os.path.join(d.getVar('libdir'), 'cmake')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500110 for pkg in glob.glob(os.path.join(pkgdata_dir, 'runtime', '*-dev')):
111 with open(os.path.join(pkgdata_dir, 'runtime', pkg)) as f:
112 pn = None
113 headers = []
114 cmakefiles = []
115 for line in f:
116 if line.startswith('PN:'):
117 pn = line.split(':', 1)[-1].strip()
118 elif line.startswith('FILES_INFO:'):
119 val = line.split(':', 1)[1].strip()
120 dictval = json.loads(val)
121 for fullpth in sorted(dictval):
122 if fullpth.startswith(includedir) and fullpth.endswith('.h'):
123 headers.append(os.path.relpath(fullpth, includedir))
124 elif fullpth.startswith(cmakedir) and fullpth.endswith('.cmake'):
125 cmakefiles.append(os.path.relpath(fullpth, cmakedir))
126 if pn and headers:
127 for header in headers:
128 RecipeHandler.recipeheadermap[header] = pn
129 if pn and cmakefiles:
130 for fn in cmakefiles:
131 RecipeHandler.recipecmakefilemap[fn] = pn
132
133 @staticmethod
134 def load_binmap(d):
135 '''Build up native binary->recipe mapping'''
136 if RecipeHandler.recipebinmap:
137 return
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500138 sstate_manifests = d.getVar('SSTATE_MANIFESTS')
139 staging_bindir_native = d.getVar('STAGING_BINDIR_NATIVE')
140 build_arch = d.getVar('BUILD_ARCH')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500141 fileprefix = 'manifest-%s-' % build_arch
142 for fn in glob.glob(os.path.join(sstate_manifests, '%s*-native.populate_sysroot' % fileprefix)):
143 with open(fn, 'r') as f:
144 pn = os.path.basename(fn).rsplit('.', 1)[0][len(fileprefix):]
145 for line in f:
146 if line.startswith(staging_bindir_native):
147 prog = os.path.basename(line.rstrip())
148 RecipeHandler.recipebinmap[prog] = pn
149
150 @staticmethod
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500151 def checkfiles(path, speclist, recursive=False, excludedirs=None):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500152 results = []
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500153 if recursive:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500154 for root, dirs, files in os.walk(path, topdown=True):
155 if excludedirs:
156 dirs[:] = [d for d in dirs if d not in excludedirs]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500157 for fn in files:
158 for spec in speclist:
159 if fnmatch.fnmatch(fn, spec):
160 results.append(os.path.join(root, fn))
161 else:
162 for spec in speclist:
163 results.extend(glob.glob(os.path.join(path, spec)))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500164 return results
165
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500166 @staticmethod
167 def handle_depends(libdeps, pcdeps, deps, outlines, values, d):
168 if pcdeps:
169 recipemap = read_pkgconfig_provides(d)
170 if libdeps:
171 RecipeHandler.load_libmap(d)
172
173 ignorelibs = ['socket']
174 ignoredeps = ['gcc-runtime', 'glibc', 'uclibc', 'musl', 'tar-native', 'binutils-native', 'coreutils-native']
175
176 unmappedpc = []
177 pcdeps = list(set(pcdeps))
178 for pcdep in pcdeps:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600179 if isinstance(pcdep, str):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500180 recipe = recipemap.get(pcdep, None)
181 if recipe:
182 deps.append(recipe)
183 else:
184 if not pcdep.startswith('$'):
185 unmappedpc.append(pcdep)
186 else:
187 for item in pcdep:
188 recipe = recipemap.get(pcdep, None)
189 if recipe:
190 deps.append(recipe)
191 break
192 else:
193 unmappedpc.append('(%s)' % ' or '.join(pcdep))
194
195 unmappedlibs = []
196 for libdep in libdeps:
197 if isinstance(libdep, tuple):
198 lib, header = libdep
199 else:
200 lib = libdep
201 header = None
202
203 if lib in ignorelibs:
204 logger.debug('Ignoring library dependency %s' % lib)
205 continue
206
207 recipe = RecipeHandler.recipelibmap.get(lib, None)
208 if recipe:
209 deps.append(recipe)
210 elif recipe is None:
211 if header:
212 RecipeHandler.load_devel_filemap(d)
213 recipe = RecipeHandler.recipeheadermap.get(header, None)
214 if recipe:
215 deps.append(recipe)
216 elif recipe is None:
217 unmappedlibs.append(lib)
218 else:
219 unmappedlibs.append(lib)
220
221 deps = set(deps).difference(set(ignoredeps))
222
223 if unmappedpc:
224 outlines.append('# NOTE: unable to map the following pkg-config dependencies: %s' % ' '.join(unmappedpc))
225 outlines.append('# (this is based on recipes that have previously been built and packaged)')
226
227 if unmappedlibs:
228 outlines.append('# NOTE: the following library dependencies are unknown, ignoring: %s' % ' '.join(list(set(unmappedlibs))))
229 outlines.append('# (this is based on recipes that have previously been built and packaged)')
230
231 if deps:
232 values['DEPENDS'] = ' '.join(deps)
233
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500234 @staticmethod
235 def genfunction(outlines, funcname, content, python=False, forcespace=False):
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500236 if python:
237 prefix = 'python '
238 else:
239 prefix = ''
240 outlines.append('%s%s () {' % (prefix, funcname))
241 if python or forcespace:
242 indent = ' '
243 else:
244 indent = '\t'
245 addnoop = not python
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500246 for line in content:
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500247 outlines.append('%s%s' % (indent, line))
248 if addnoop:
249 strippedline = line.lstrip()
250 if strippedline and not strippedline.startswith('#'):
251 addnoop = False
252 if addnoop:
253 # Without this there'll be a syntax error
254 outlines.append('%s:' % indent)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500255 outlines.append('}')
256 outlines.append('')
257
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500258 def process(self, srctree, classes, lines_before, lines_after, handled, extravalues):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500259 return False
260
261
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500262def validate_pv(pv):
263 if not pv or '_version' in pv.lower() or pv[0] not in '0123456789':
264 return False
265 return True
266
267def determine_from_filename(srcfile):
268 """Determine name and version from a filename"""
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600269 if is_package(srcfile):
270 # Force getting the value from the package metadata
271 return None, None
272
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500273 if '.tar.' in srcfile:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600274 namepart = srcfile.split('.tar.')[0]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500275 else:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600276 namepart = os.path.splitext(srcfile)[0]
277 namepart = namepart.lower().replace('_', '-')
278 if namepart.endswith('.src'):
279 namepart = namepart[:-4]
280 if namepart.endswith('.orig'):
281 namepart = namepart[:-5]
282 splitval = namepart.split('-')
283 logger.debug('determine_from_filename: split name %s into: %s' % (srcfile, splitval))
284
285 ver_re = re.compile('^v?[0-9]')
286
287 pv = None
288 pn = None
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500289 if len(splitval) == 1:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600290 # Try to split the version out if there is no separator (or a .)
291 res = re.match('^([^0-9]+)([0-9.]+.*)$', namepart)
292 if res:
293 if len(res.group(1)) > 1 and len(res.group(2)) > 1:
294 pn = res.group(1).rstrip('.')
295 pv = res.group(2)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500296 else:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600297 pn = namepart
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500298 else:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600299 if splitval[-1] in ['source', 'src']:
300 splitval.pop()
301 if len(splitval) > 2 and re.match('^(alpha|beta|stable|release|rc[0-9]|pre[0-9]|p[0-9]|[0-9]{8})', splitval[-1]) and ver_re.match(splitval[-2]):
302 pv = '-'.join(splitval[-2:])
303 if pv.endswith('-release'):
304 pv = pv[:-8]
305 splitval = splitval[:-2]
306 elif ver_re.match(splitval[-1]):
307 pv = splitval.pop()
308 pn = '-'.join(splitval)
309 if pv and pv.startswith('v'):
310 pv = pv[1:]
311 logger.debug('determine_from_filename: name = "%s" version = "%s"' % (pn, pv))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500312 return (pn, pv)
313
314def determine_from_url(srcuri):
315 """Determine name and version from a URL"""
316 pn = None
317 pv = None
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600318 parseres = urlparse(srcuri.lower().split(';', 1)[0])
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500319 if parseres.path:
320 if 'github.com' in parseres.netloc:
321 res = re.search(r'.*/(.*?)/archive/(.*)-final\.(tar|zip)', parseres.path)
322 if res:
323 pn = res.group(1).strip().replace('_', '-')
324 pv = res.group(2).strip().replace('_', '.')
325 else:
326 res = re.search(r'.*/(.*?)/archive/v?(.*)\.(tar|zip)', parseres.path)
327 if res:
328 pn = res.group(1).strip().replace('_', '-')
329 pv = res.group(2).strip().replace('_', '.')
330 elif 'bitbucket.org' in parseres.netloc:
331 res = re.search(r'.*/(.*?)/get/[a-zA-Z_-]*([0-9][0-9a-zA-Z_.]*)\.(tar|zip)', parseres.path)
332 if res:
333 pn = res.group(1).strip().replace('_', '-')
334 pv = res.group(2).strip().replace('_', '.')
335
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500336 if not pn and not pv:
337 if parseres.scheme not in ['git', 'gitsm', 'svn', 'hg']:
338 srcfile = os.path.basename(parseres.path.rstrip('/'))
339 pn, pv = determine_from_filename(srcfile)
340 elif parseres.scheme in ['git', 'gitsm']:
341 pn = os.path.basename(parseres.path.rstrip('/')).lower().replace('_', '-')
342 if pn.endswith('.git'):
343 pn = pn[:-4]
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500344
345 logger.debug('Determined from source URL: name = "%s", version = "%s"' % (pn, pv))
346 return (pn, pv)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500347
348def supports_srcrev(uri):
349 localdata = bb.data.createCopy(tinfoil.config_data)
350 # This is a bit sad, but if you don't have this set there can be some
351 # odd interactions with the urldata cache which lead to errors
352 localdata.setVar('SRCREV', '${AUTOREV}')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600353 try:
354 fetcher = bb.fetch2.Fetch([uri], localdata)
355 urldata = fetcher.ud
356 for u in urldata:
357 if urldata[u].method.supports_srcrev():
358 return True
359 except bb.fetch2.FetchError as e:
360 logger.debug('FetchError in supports_srcrev: %s' % str(e))
361 # Fall back to basic check
362 if uri.startswith(('git://', 'gitsm://')):
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500363 return True
364 return False
365
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500366def reformat_git_uri(uri):
367 '''Convert any http[s]://....git URI into git://...;protocol=http[s]'''
368 checkuri = uri.split(';', 1)[0]
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600369 if checkuri.endswith('.git') or '/git/' in checkuri or re.match('https?://github.com/[^/]+/[^/]+/?$', checkuri):
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500370 # Appends scheme if the scheme is missing
371 if not '://' in uri:
372 uri = 'git://' + uri
373 scheme, host, path, user, pswd, parms = bb.fetch2.decodeurl(uri)
374 # Detection mechanism, this is required due to certain URL are formatter with ":" rather than "/"
375 # which causes decodeurl to fail getting the right host and path
376 if len(host.split(':')) > 1:
377 splitslash = host.split(':')
Brad Bishop316dfdd2018-06-25 12:45:53 -0400378 # Port number should not be split from host
379 if not re.match('^[0-9]+$', splitslash[1]):
380 host = splitslash[0]
381 path = '/' + splitslash[1] + path
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500382 #Algorithm:
383 # if user is defined, append protocol=ssh or if a protocol is defined, then honor the user-defined protocol
384 # if no user & password is defined, check for scheme type and append the protocol with the scheme type
385 # finally if protocols or if the url is well-formed, do nothing and rejoin everything back to normal
386 # Need to repackage the arguments for encodeurl, the format is: (scheme, host, path, user, password, OrderedDict([('key', 'value')]))
387 if user:
388 if not 'protocol' in parms:
389 parms.update({('protocol', 'ssh')})
390 elif (scheme == "http" or scheme == 'https' or scheme == 'ssh') and not ('protocol' in parms):
391 parms.update({('protocol', scheme)})
392 # Always append 'git://'
393 fUrl = bb.fetch2.encodeurl(('git', host, path, user, pswd, parms))
394 return fUrl
395 else:
396 return uri
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500397
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600398def is_package(url):
399 '''Check if a URL points to a package'''
400 checkurl = url.split(';', 1)[0]
401 if checkurl.endswith(('.deb', '.ipk', '.rpm', '.srpm')):
402 return True
403 return False
404
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500405def create_recipe(args):
406 import bb.process
407 import tempfile
408 import shutil
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600409 import oe.recipeutils
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500410
411 pkgarch = ""
412 if args.machine:
413 pkgarch = "${MACHINE_ARCH}"
414
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600415 extravalues = {}
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500416 checksums = {}
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500417 tempsrc = ''
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600418 source = args.source
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500419 srcsubdir = ''
420 srcrev = '${AUTOREV}'
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500421 srcbranch = ''
422 scheme = ''
423 storeTagName = ''
424 pv_srcpv = False
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600425
426 if os.path.isfile(source):
427 source = 'file://%s' % os.path.abspath(source)
428
429 if scriptutils.is_src_url(source):
Brad Bishop316dfdd2018-06-25 12:45:53 -0400430 # Warn about github archive URLs
431 if re.match('https?://github.com/[^/]+/[^/]+/archive/.+(\.tar\..*|\.zip)$', source):
Brad Bishop1a4b7ee2018-12-16 17:11:34 -0800432 logger.warning('github archive files are not guaranteed to be stable and may be re-generated over time. If the latter occurs, the checksums will likely change and the recipe will fail at do_fetch. It is recommended that you point to an actual commit or tag in the repository instead (using the repository URL in conjunction with the -S/--srcrev option).')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500433 # Fetch a URL
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600434 fetchuri = reformat_git_uri(urldefrag(source)[0])
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500435 if args.binary:
436 # Assume the archive contains the directory structure verbatim
437 # so we need to extract to a subdirectory
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600438 fetchuri += ';subdir=${BP}'
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500439 srcuri = fetchuri
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500440 rev_re = re.compile(';rev=([^;]+)')
441 res = rev_re.search(srcuri)
442 if res:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500443 if args.srcrev:
444 logger.error('rev= parameter and -S/--srcrev option cannot both be specified - use one or the other')
445 sys.exit(1)
446 if args.autorev:
447 logger.error('rev= parameter and -a/--autorev option cannot both be specified - use one or the other')
448 sys.exit(1)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500449 srcrev = res.group(1)
450 srcuri = rev_re.sub('', srcuri)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500451 elif args.srcrev:
452 srcrev = args.srcrev
453
454 # Check whether users provides any branch info in fetchuri.
455 # If true, we will skip all branch checking process to honor all user's input.
456 scheme, network, path, user, passwd, params = bb.fetch2.decodeurl(fetchuri)
457 srcbranch = params.get('branch')
458 if args.srcbranch:
459 if srcbranch:
460 logger.error('branch= parameter and -B/--srcbranch option cannot both be specified - use one or the other')
461 sys.exit(1)
462 srcbranch = args.srcbranch
463 nobranch = params.get('nobranch')
464 if nobranch and srcbranch:
465 logger.error('nobranch= cannot be used if you specify a branch')
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500466 sys.exit(1)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500467 tag = params.get('tag')
468 if not srcbranch and not nobranch and srcrev != '${AUTOREV}':
469 # Append nobranch=1 in the following conditions:
470 # 1. User did not set 'branch=' in srcuri, and
471 # 2. User did not set 'nobranch=1' in srcuri, and
472 # 3. Source revision is not '${AUTOREV}'
473 params['nobranch'] = '1'
474 if tag:
475 # Keep a copy of tag and append nobranch=1 then remove tag from URL.
476 # Bitbake fetcher unable to fetch when {AUTOREV} and tag is set at the same time.
477 storeTagName = params['tag']
478 params['nobranch'] = '1'
479 del params['tag']
480 if scheme == 'npm':
481 params['noverify'] = '1'
482 fetchuri = bb.fetch2.encodeurl((scheme, network, path, user, passwd, params))
483
484 tmpparent = tinfoil.config_data.getVar('BASE_WORKDIR')
485 bb.utils.mkdirhier(tmpparent)
486 tempsrc = tempfile.mkdtemp(prefix='recipetool-', dir=tmpparent)
487 srctree = os.path.join(tempsrc, 'source')
488
489 try:
490 checksums, ftmpdir = scriptutils.fetch_url(tinfoil, fetchuri, srcrev, srctree, logger, preserve_tmp=args.keep_temp)
491 except scriptutils.FetchUrlFailure as e:
492 logger.error(str(e))
493 sys.exit(1)
494
495 if ftmpdir and args.keep_temp:
496 logger.info('Fetch temp directory is %s' % ftmpdir)
497
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500498 dirlist = os.listdir(srctree)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500499 filterout = ['git.indirectionsymlink']
500 dirlist = [x for x in dirlist if x not in filterout]
501 logger.debug('Directory listing (excluding filtered out):\n %s' % '\n '.join(dirlist))
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500502 if len(dirlist) == 1:
503 singleitem = os.path.join(srctree, dirlist[0])
504 if os.path.isdir(singleitem):
505 # We unpacked a single directory, so we should use that
506 srcsubdir = dirlist[0]
507 srctree = os.path.join(srctree, srcsubdir)
508 else:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500509 check_single_file(dirlist[0], fetchuri)
510 elif len(dirlist) == 0:
511 if '/' in fetchuri:
512 fn = os.path.join(tinfoil.config_data.getVar('DL_DIR'), fetchuri.split('/')[-1])
513 if os.path.isfile(fn):
514 check_single_file(fn, fetchuri)
515 # If we've got to here then there's no source so we might as well give up
516 logger.error('URL %s resulted in an empty source tree' % fetchuri)
517 sys.exit(1)
518
519 # We need this checking mechanism to improve the recipe created by recipetool and devtool
520 # is able to parse and build by bitbake.
521 # If there is no input for branch name, then check for branch name with SRCREV provided.
522 if not srcbranch and not nobranch and srcrev and (srcrev != '${AUTOREV}') and scheme in ['git', 'gitsm']:
523 try:
524 cmd = 'git branch -r --contains'
525 check_branch, check_branch_err = bb.process.run('%s %s' % (cmd, srcrev), cwd=srctree)
526 except bb.process.ExecutionError as err:
527 logger.error(str(err))
528 sys.exit(1)
529 get_branch = [x.strip() for x in check_branch.splitlines()]
530 # Remove HEAD reference point and drop remote prefix
531 get_branch = [x.split('/', 1)[1] for x in get_branch if not x.startswith('origin/HEAD')]
532 if 'master' in get_branch:
533 # If it is master, we do not need to append 'branch=master' as this is default.
534 # Even with the case where get_branch has multiple objects, if 'master' is one
535 # of them, we should default take from 'master'
536 srcbranch = ''
537 elif len(get_branch) == 1:
538 # If 'master' isn't in get_branch and get_branch contains only ONE object, then store result into 'srcbranch'
539 srcbranch = get_branch[0]
540 else:
541 # If get_branch contains more than one objects, then display error and exit.
542 mbrch = '\n ' + '\n '.join(get_branch)
543 logger.error('Revision %s was found on multiple branches: %s\nPlease provide the correct branch with -B/--srcbranch' % (srcrev, mbrch))
544 sys.exit(1)
545
546 # Since we might have a value in srcbranch, we need to
547 # recontruct the srcuri to include 'branch' in params.
548 scheme, network, path, user, passwd, params = bb.fetch2.decodeurl(srcuri)
549 if srcbranch:
550 params['branch'] = srcbranch
551
552 if storeTagName and scheme in ['git', 'gitsm']:
553 # Check srcrev using tag and check validity of the tag
554 cmd = ('git rev-parse --verify %s' % (storeTagName))
555 try:
556 check_tag, check_tag_err = bb.process.run('%s' % cmd, cwd=srctree)
557 srcrev = check_tag.split()[0]
558 except bb.process.ExecutionError as err:
559 logger.error(str(err))
560 logger.error("Possibly wrong tag name is provided")
561 sys.exit(1)
562 # Drop tag from srcuri as it will have conflicts with SRCREV during recipe parse.
563 del params['tag']
564 srcuri = bb.fetch2.encodeurl((scheme, network, path, user, passwd, params))
565
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600566 if os.path.exists(os.path.join(srctree, '.gitmodules')) and srcuri.startswith('git://'):
567 srcuri = 'gitsm://' + srcuri[6:]
568 logger.info('Fetching submodules...')
569 bb.process.run('git submodule update --init --recursive', cwd=srctree)
570
571 if is_package(fetchuri):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500572 localdata = bb.data.createCopy(tinfoil.config_data)
573 pkgfile = bb.fetch2.localpath(fetchuri, localdata)
574 if pkgfile:
575 tmpfdir = tempfile.mkdtemp(prefix='recipetool-')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600576 try:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600577 if pkgfile.endswith(('.deb', '.ipk')):
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500578 stdout, _ = bb.process.run('ar x %s' % pkgfile, cwd=tmpfdir)
579 stdout, _ = bb.process.run('tar xf control.tar.gz', cwd=tmpfdir)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600580 values = convert_debian(tmpfdir)
581 extravalues.update(values)
582 elif pkgfile.endswith(('.rpm', '.srpm')):
583 stdout, _ = bb.process.run('rpm -qp --xml %s > pkginfo.xml' % pkgfile, cwd=tmpfdir)
584 values = convert_rpm_xml(os.path.join(tmpfdir, 'pkginfo.xml'))
585 extravalues.update(values)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500586 finally:
587 shutil.rmtree(tmpfdir)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500588 else:
589 # Assume we're pointing to an existing source tree
590 if args.extract_to:
591 logger.error('--extract-to cannot be specified if source is a directory')
592 sys.exit(1)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600593 if not os.path.isdir(source):
594 logger.error('Invalid source directory %s' % source)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500595 sys.exit(1)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600596 srctree = source
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500597 srcuri = ''
598 if os.path.exists(os.path.join(srctree, '.git')):
599 # Try to get upstream repo location from origin remote
600 try:
601 stdout, _ = bb.process.run('git remote -v', cwd=srctree, shell=True)
602 except bb.process.ExecutionError as e:
603 stdout = None
604 if stdout:
605 for line in stdout.splitlines():
606 splitline = line.split()
607 if len(splitline) > 1:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600608 if splitline[0] == 'origin' and scriptutils.is_src_url(splitline[1]):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500609 srcuri = reformat_git_uri(splitline[1])
610 srcsubdir = 'git'
611 break
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500612
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500613 if args.src_subdir:
614 srcsubdir = os.path.join(srcsubdir, args.src_subdir)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500615 srctree_use = os.path.abspath(os.path.join(srctree, args.src_subdir))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500616 else:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500617 srctree_use = os.path.abspath(srctree)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500618
619 if args.outfile and os.path.isdir(args.outfile):
620 outfile = None
621 outdir = args.outfile
622 else:
623 outfile = args.outfile
624 outdir = None
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500625 if outfile and outfile != '-':
626 if os.path.exists(outfile):
627 logger.error('Output file %s already exists' % outfile)
628 sys.exit(1)
629
630 lines_before = []
631 lines_after = []
632
633 lines_before.append('# Recipe created by %s' % os.path.basename(sys.argv[0]))
634 lines_before.append('# This is the basis of a recipe and may need further editing in order to be fully functional.')
635 lines_before.append('# (Feel free to remove these comments when editing.)')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600636 # We need a blank line here so that patch_recipe_lines can rewind before the LICENSE comments
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500637 lines_before.append('')
638
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500639 # We'll come back and replace this later in handle_license_vars()
640 lines_before.append('##LICENSE_PLACEHOLDER##')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600641
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500642 handled = []
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500643 classes = []
644
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500645 # FIXME This is kind of a hack, we probably ought to be using bitbake to do this
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500646 pn = None
647 pv = None
648 if outfile:
649 recipefn = os.path.splitext(os.path.basename(outfile))[0]
650 fnsplit = recipefn.split('_')
651 if len(fnsplit) > 1:
652 pn = fnsplit[0]
653 pv = fnsplit[1]
654 else:
655 pn = recipefn
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500656
657 if args.version:
658 pv = args.version
659
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500660 if args.name:
661 pn = args.name
662 if args.name.endswith('-native'):
663 if args.also_native:
664 logger.error('--also-native cannot be specified for a recipe named *-native (*-native denotes a recipe that is already only for native) - either remove the -native suffix from the name or drop --also-native')
665 sys.exit(1)
666 classes.append('native')
667 elif args.name.startswith('nativesdk-'):
668 if args.also_native:
669 logger.error('--also-native cannot be specified for a recipe named nativesdk-* (nativesdk-* denotes a recipe that is already only for nativesdk)')
670 sys.exit(1)
671 classes.append('nativesdk')
672
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500673 if pv and pv not in 'git svn hg'.split():
674 realpv = pv
675 else:
676 realpv = None
677
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500678 if not srcuri:
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500679 lines_before.append('# No information for SRC_URI yet (only an external source tree was specified)')
680 lines_before.append('SRC_URI = "%s"' % srcuri)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500681 for key, value in sorted(checksums.items()):
682 lines_before.append('SRC_URI[%s] = "%s"' % (key, value))
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500683 if srcuri and supports_srcrev(srcuri):
684 lines_before.append('')
685 lines_before.append('# Modify these as desired')
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500686 # Note: we have code to replace realpv further down if it gets set to some other value
687 scheme, _, _, _, _, _ = bb.fetch2.decodeurl(srcuri)
688 if scheme in ['git', 'gitsm']:
689 srcpvprefix = 'git'
690 elif scheme == 'svn':
691 srcpvprefix = 'svnr'
692 else:
693 srcpvprefix = scheme
694 lines_before.append('PV = "%s+%s${SRCPV}"' % (realpv or '1.0', srcpvprefix))
695 pv_srcpv = True
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600696 if not args.autorev and srcrev == '${AUTOREV}':
697 if os.path.exists(os.path.join(srctree, '.git')):
698 (stdout, _) = bb.process.run('git rev-parse HEAD', cwd=srctree)
Brad Bishopc342db32019-05-15 21:57:59 -0400699 srcrev = stdout.rstrip()
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500700 lines_before.append('SRCREV = "%s"' % srcrev)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500701 if args.provides:
702 lines_before.append('PROVIDES = "%s"' % args.provides)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500703 lines_before.append('')
704
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600705 if srcsubdir and not args.binary:
706 # (for binary packages we explicitly specify subdir= when fetching to
707 # match the default value of S, so we don't need to set it in that case)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500708 lines_before.append('S = "${WORKDIR}/%s"' % srcsubdir)
709 lines_before.append('')
710
711 if pkgarch:
712 lines_after.append('PACKAGE_ARCH = "%s"' % pkgarch)
713 lines_after.append('')
714
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500715 if args.binary:
716 lines_after.append('INSANE_SKIP_${PN} += "already-stripped"')
717 lines_after.append('')
718
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500719 if args.fetch_dev:
720 extravalues['fetchdev'] = True
721 else:
722 extravalues['fetchdev'] = None
723
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500724 # Find all plugins that want to register handlers
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500725 logger.debug('Loading recipe handlers')
726 raw_handlers = []
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500727 for plugin in plugins:
728 if hasattr(plugin, 'register_recipe_handlers'):
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500729 plugin.register_recipe_handlers(raw_handlers)
730 # Sort handlers by priority
731 handlers = []
732 for i, handler in enumerate(raw_handlers):
733 if isinstance(handler, tuple):
734 handlers.append((handler[0], handler[1], i))
735 else:
736 handlers.append((handler, 0, i))
737 handlers.sort(key=lambda item: (item[1], -item[2]), reverse=True)
738 for handler, priority, _ in handlers:
739 logger.debug('Handler: %s (priority %d)' % (handler.__class__.__name__, priority))
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500740 setattr(handler, '_devtool', args.devtool)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500741 handlers = [item[0] for item in handlers]
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500742
743 # Apply the handlers
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500744 if args.binary:
745 classes.append('bin_package')
746 handled.append('buildsystem')
747
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500748 for handler in handlers:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500749 handler.process(srctree_use, classes, lines_before, lines_after, handled, extravalues)
750
751 extrafiles = extravalues.pop('extrafiles', {})
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600752 extra_pn = extravalues.pop('PN', None)
753 extra_pv = extravalues.pop('PV', None)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500754
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600755 if extra_pv and not realpv:
756 realpv = extra_pv
757 if not validate_pv(realpv):
758 realpv = None
759 else:
760 realpv = realpv.lower().split()[0]
761 if '_' in realpv:
762 realpv = realpv.replace('_', '-')
763 if extra_pn and not pn:
764 pn = extra_pn
765 if pn.startswith('GNU '):
766 pn = pn[4:]
767 if ' ' in pn:
768 # Probably a descriptive identifier rather than a proper name
769 pn = None
770 else:
771 pn = pn.lower()
772 if '_' in pn:
773 pn = pn.replace('_', '-')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500774
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500775 if srcuri and not realpv or not pn:
776 name_pn, name_pv = determine_from_url(srcuri)
777 if name_pn and not pn:
778 pn = name_pn
779 if name_pv and not realpv:
780 realpv = name_pv
781
782 licvalues = handle_license_vars(srctree_use, lines_before, handled, extravalues, tinfoil.config_data)
783
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500784 if not outfile:
785 if not pn:
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500786 log_error_cond('Unable to determine short program name from source tree - please specify name with -N/--name or output file name with -o/--outfile', args.devtool)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500787 # devtool looks for this specific exit code, so don't change it
788 sys.exit(15)
789 else:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600790 if srcuri and srcuri.startswith(('gitsm://', 'git://', 'hg://', 'svn://')):
791 suffix = srcuri.split(':', 1)[0]
792 if suffix == 'gitsm':
793 suffix = 'git'
794 outfile = '%s_%s.bb' % (pn, suffix)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500795 elif realpv:
796 outfile = '%s_%s.bb' % (pn, realpv)
797 else:
798 outfile = '%s.bb' % pn
799 if outdir:
800 outfile = os.path.join(outdir, outfile)
801 # We need to check this again
802 if os.path.exists(outfile):
803 logger.error('Output file %s already exists' % outfile)
804 sys.exit(1)
805
806 # Move any extra files the plugins created to a directory next to the recipe
807 if extrafiles:
808 if outfile == '-':
809 extraoutdir = pn
810 else:
811 extraoutdir = os.path.join(os.path.dirname(outfile), pn)
812 bb.utils.mkdirhier(extraoutdir)
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600813 for destfn, extrafile in extrafiles.items():
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500814 shutil.move(extrafile, os.path.join(extraoutdir, destfn))
815
816 lines = lines_before
817 lines_before = []
818 skipblank = True
819 for line in lines:
820 if skipblank:
821 skipblank = False
822 if not line:
823 continue
824 if line.startswith('S = '):
825 if realpv and pv not in 'git svn hg'.split():
826 line = line.replace(realpv, '${PV}')
827 if pn:
828 line = line.replace(pn, '${BPN}')
829 if line == 'S = "${WORKDIR}/${BPN}-${PV}"':
830 skipblank = True
831 continue
832 elif line.startswith('SRC_URI = '):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500833 if realpv and not pv_srcpv:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500834 line = line.replace(realpv, '${PV}')
835 elif line.startswith('PV = '):
836 if realpv:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500837 # Replace the first part of the PV value
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500838 line = re.sub('"[^+]*\+', '"%s+' % realpv, line)
839 lines_before.append(line)
840
841 if args.also_native:
842 lines = lines_after
843 lines_after = []
844 bbclassextend = None
845 for line in lines:
846 if line.startswith('BBCLASSEXTEND ='):
847 splitval = line.split('"')
848 if len(splitval) > 1:
849 bbclassextend = splitval[1].split()
850 if not 'native' in bbclassextend:
851 bbclassextend.insert(0, 'native')
852 line = 'BBCLASSEXTEND = "%s"' % ' '.join(bbclassextend)
853 lines_after.append(line)
854 if not bbclassextend:
855 lines_after.append('BBCLASSEXTEND = "native"')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500856
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500857 postinst = ("postinst", extravalues.pop('postinst', None))
858 postrm = ("postrm", extravalues.pop('postrm', None))
859 preinst = ("preinst", extravalues.pop('preinst', None))
860 prerm = ("prerm", extravalues.pop('prerm', None))
861 funcs = [postinst, postrm, preinst, prerm]
862 for func in funcs:
863 if func[1]:
864 RecipeHandler.genfunction(lines_after, 'pkg_%s_${PN}' % func[0], func[1])
865
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500866 outlines = []
867 outlines.extend(lines_before)
868 if classes:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -0500869 if outlines[-1] and not outlines[-1].startswith('#'):
870 outlines.append('')
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500871 outlines.append('inherit %s' % ' '.join(classes))
872 outlines.append('')
873 outlines.extend(lines_after)
874
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600875 if extravalues:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600876 _, outlines = oe.recipeutils.patch_recipe_lines(outlines, extravalues, trailing_newline=False)
877
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500878 if args.extract_to:
879 scriptutils.git_convert_standalone_clone(srctree)
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500880 if os.path.isdir(args.extract_to):
881 # If the directory exists we'll move the temp dir into it instead of
882 # its contents - of course, we could try to always move its contents
883 # but that is a pain if there are symlinks; the simplest solution is
884 # to just remove it first
885 os.rmdir(args.extract_to)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500886 shutil.move(srctree, args.extract_to)
Patrick Williamsf1e5d692016-03-30 15:21:19 -0500887 if tempsrc == srctree:
888 tempsrc = None
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500889 log_info_cond('Source extracted to %s' % args.extract_to, args.devtool)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500890
891 if outfile == '-':
892 sys.stdout.write('\n'.join(outlines) + '\n')
893 else:
894 with open(outfile, 'w') as f:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600895 lastline = None
896 for line in outlines:
897 if not lastline and not line:
898 # Skip extra blank lines
899 continue
900 f.write('%s\n' % line)
901 lastline = line
Brad Bishop6e60e8b2018-02-01 10:27:11 -0500902 log_info_cond('Recipe %s has been created; further editing may be required to make it fully functional' % outfile, args.devtool)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500903
904 if tempsrc:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600905 if args.keep_temp:
906 logger.info('Preserving temporary directory %s' % tempsrc)
907 else:
908 shutil.rmtree(tempsrc)
Patrick Williamsc124f4f2015-09-15 14:41:29 -0500909
910 return 0
911
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500912def check_single_file(fn, fetchuri):
913 """Determine if a single downloaded file is something we can't handle"""
914 with open(fn, 'r', errors='surrogateescape') as f:
915 if '<html' in f.read(100).lower():
916 logger.error('Fetching "%s" returned a single HTML page - check the URL is correct and functional' % fetchuri)
917 sys.exit(1)
918
919def split_value(value):
920 if isinstance(value, str):
921 return value.split()
922 else:
923 return value
924
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600925def handle_license_vars(srctree, lines_before, handled, extravalues, d):
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500926 lichandled = [x for x in handled if x[0] == 'license']
927 if lichandled:
928 # Someone else has already handled the license vars, just return their value
929 return lichandled[0][1]
930
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600931 licvalues = guess_license(srctree, d)
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500932 licenses = []
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600933 lic_files_chksum = []
934 lic_unknown = []
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500935 lines = []
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600936 if licvalues:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600937 for licvalue in licvalues:
938 if not licvalue[0] in licenses:
939 licenses.append(licvalue[0])
940 lic_files_chksum.append('file://%s;md5=%s' % (licvalue[1], licvalue[2]))
941 if licvalue[0] == 'Unknown':
942 lic_unknown.append(licvalue[1])
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600943 if lic_unknown:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500944 lines.append('#')
945 lines.append('# The following license files were not able to be identified and are')
946 lines.append('# represented as "Unknown" below, you will need to check them yourself:')
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600947 for licfile in lic_unknown:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500948 lines.append('# %s' % licfile)
949
950 extra_license = split_value(extravalues.pop('LICENSE', []))
951 if '&' in extra_license:
952 extra_license.remove('&')
953 if extra_license:
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600954 if licenses == ['Unknown']:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500955 licenses = extra_license
Patrick Williamsc0f7c042017-02-23 20:41:17 -0600956 else:
Brad Bishopd7bf8c12018-02-25 22:55:05 -0500957 for item in extra_license:
958 if item not in licenses:
959 licenses.append(item)
960 extra_lic_files_chksum = split_value(extravalues.pop('LIC_FILES_CHKSUM', []))
961 for item in extra_lic_files_chksum:
962 if item not in lic_files_chksum:
963 lic_files_chksum.append(item)
964
965 if lic_files_chksum:
966 # We are going to set the vars, so prepend the standard disclaimer
967 lines.insert(0, '# WARNING: the following LICENSE and LIC_FILES_CHKSUM values are best guesses - it is')
968 lines.insert(1, '# your responsibility to verify that the values are complete and correct.')
969 else:
970 # Without LIC_FILES_CHKSUM we set LICENSE = "CLOSED" to allow the
971 # user to get started easily
972 lines.append('# Unable to find any files that looked like license statements. Check the accompanying')
973 lines.append('# documentation and source headers and set LICENSE and LIC_FILES_CHKSUM accordingly.')
974 lines.append('#')
975 lines.append('# NOTE: LICENSE is being set to "CLOSED" to allow you to at least start building - if')
976 lines.append('# this is not accurate with respect to the licensing of the software being built (it')
977 lines.append('# will not be in most cases) you must specify the correct value before using this')
978 lines.append('# recipe for anything other than initial testing/development!')
979 licenses = ['CLOSED']
980
981 if extra_license and sorted(licenses) != sorted(extra_license):
982 lines.append('# NOTE: Original package / source metadata indicates license is: %s' % ' & '.join(extra_license))
983
984 if len(licenses) > 1:
985 lines.append('#')
986 lines.append('# NOTE: multiple licenses have been detected; they have been separated with &')
987 lines.append('# in the LICENSE value for now since it is a reasonable assumption that all')
988 lines.append('# of the licenses apply. If instead there is a choice between the multiple')
989 lines.append('# licenses then you should change the value to separate the licenses with |')
990 lines.append('# instead of &. If there is any doubt, check the accompanying documentation')
991 lines.append('# to determine which situation is applicable.')
992
993 lines.append('LICENSE = "%s"' % ' & '.join(licenses))
994 lines.append('LIC_FILES_CHKSUM = "%s"' % ' \\\n '.join(lic_files_chksum))
995 lines.append('')
996
997 # Replace the placeholder so we get the values in the right place in the recipe file
998 try:
999 pos = lines_before.index('##LICENSE_PLACEHOLDER##')
1000 except ValueError:
1001 pos = -1
1002 if pos == -1:
1003 lines_before.extend(lines)
1004 else:
1005 lines_before[pos:pos+1] = lines
1006
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001007 handled.append(('license', licvalues))
1008 return licvalues
1009
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001010def get_license_md5sums(d, static_only=False):
1011 import bb.utils
1012 md5sums = {}
1013 if not static_only:
1014 # Gather md5sums of license files in common license dir
Brad Bishop6e60e8b2018-02-01 10:27:11 -05001015 commonlicdir = d.getVar('COMMON_LICENSE_DIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001016 for fn in os.listdir(commonlicdir):
1017 md5value = bb.utils.md5_file(os.path.join(commonlicdir, fn))
1018 md5sums[md5value] = fn
1019 # The following were extracted from common values in various recipes
1020 # (double checking the license against the license file itself, not just
1021 # the LICENSE value in the recipe)
1022 md5sums['94d55d512a9ba36caa9b7df079bae19f'] = 'GPLv2'
1023 md5sums['b234ee4d69f5fce4486a80fdaf4a4263'] = 'GPLv2'
1024 md5sums['59530bdf33659b29e73d4adb9f9f6552'] = 'GPLv2'
1025 md5sums['0636e73ff0215e8d672dc4c32c317bb3'] = 'GPLv2'
1026 md5sums['eb723b61539feef013de476e68b5c50a'] = 'GPLv2'
1027 md5sums['751419260aa954499f7abaabaa882bbe'] = 'GPLv2'
1028 md5sums['393a5ca445f6965873eca0259a17f833'] = 'GPLv2'
1029 md5sums['12f884d2ae1ff87c09e5b7ccc2c4ca7e'] = 'GPLv2'
1030 md5sums['8ca43cbc842c2336e835926c2166c28b'] = 'GPLv2'
1031 md5sums['ebb5c50ab7cab4baeffba14977030c07'] = 'GPLv2'
1032 md5sums['c93c0550bd3173f4504b2cbd8991e50b'] = 'GPLv2'
1033 md5sums['9ac2e7cff1ddaf48b6eab6028f23ef88'] = 'GPLv2'
1034 md5sums['4325afd396febcb659c36b49533135d4'] = 'GPLv2'
1035 md5sums['18810669f13b87348459e611d31ab760'] = 'GPLv2'
1036 md5sums['d7810fab7487fb0aad327b76f1be7cd7'] = 'GPLv2' # the Linux kernel's COPYING file
1037 md5sums['bbb461211a33b134d42ed5ee802b37ff'] = 'LGPLv2.1'
1038 md5sums['7fbc338309ac38fefcd64b04bb903e34'] = 'LGPLv2.1'
1039 md5sums['4fbd65380cdd255951079008b364516c'] = 'LGPLv2.1'
1040 md5sums['2d5025d4aa3495befef8f17206a5b0a1'] = 'LGPLv2.1'
1041 md5sums['fbc093901857fcd118f065f900982c24'] = 'LGPLv2.1'
1042 md5sums['a6f89e2100d9b6cdffcea4f398e37343'] = 'LGPLv2.1'
1043 md5sums['d8045f3b8f929c1cb29a1e3fd737b499'] = 'LGPLv2.1'
1044 md5sums['fad9b3332be894bab9bc501572864b29'] = 'LGPLv2.1'
1045 md5sums['3bf50002aefd002f49e7bb854063f7e7'] = 'LGPLv2'
1046 md5sums['9f604d8a4f8e74f4f5140845a21b6674'] = 'LGPLv2'
1047 md5sums['5f30f0716dfdd0d91eb439ebec522ec2'] = 'LGPLv2'
1048 md5sums['55ca817ccb7d5b5b66355690e9abc605'] = 'LGPLv2'
1049 md5sums['252890d9eee26aab7b432e8b8a616475'] = 'LGPLv2'
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001050 md5sums['3214f080875748938ba060314b4f727d'] = 'LGPLv2'
1051 md5sums['db979804f025cf55aabec7129cb671ed'] = 'LGPLv2'
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001052 md5sums['d32239bcb673463ab874e80d47fae504'] = 'GPLv3'
1053 md5sums['f27defe1e96c2e1ecd4e0c9be8967949'] = 'GPLv3'
1054 md5sums['6a6a8e020838b23406c81b19c1d46df6'] = 'LGPLv3'
1055 md5sums['3b83ef96387f14655fc854ddc3c6bd57'] = 'Apache-2.0'
1056 md5sums['385c55653886acac3821999a3ccd17b3'] = 'Artistic-1.0 | GPL-2.0' # some perl modules
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001057 md5sums['54c7042be62e169199200bc6477f04d1'] = 'BSD-3-Clause'
Brad Bishop96ff1982019-08-19 13:50:42 -04001058 md5sums['bfe1f75d606912a4111c90743d6c7325'] = 'MPL-1.1'
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001059 return md5sums
1060
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001061def crunch_license(licfile):
1062 '''
1063 Remove non-material text from a license file and then check
1064 its md5sum against a known list. This works well for licenses
1065 which contain a copyright statement, but is also a useful way
1066 to handle people's insistence upon reformatting the license text
1067 slightly (with no material difference to the text of the
1068 license).
1069 '''
1070
1071 import oe.utils
1072
1073 # Note: these are carefully constructed!
1074 license_title_re = re.compile('^\(?(#+ *)?(The )?.{1,10} [Ll]icen[sc]e( \(.{1,10}\))?\)?:?$')
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001075 license_statement_re = re.compile('^(This (project|software) is( free software)? (released|licen[sc]ed)|(Released|Licen[cs]ed)) under the .{1,10} [Ll]icen[sc]e:?$')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001076 copyright_re = re.compile('^(#+)? *Copyright .*$')
1077
1078 crunched_md5sums = {}
1079 # The following two were gleaned from the "forever" npm package
1080 crunched_md5sums['0a97f8e4cbaf889d6fa51f84b89a79f6'] = 'ISC'
1081 crunched_md5sums['eecf6429523cbc9693547cf2db790b5c'] = 'MIT'
1082 # https://github.com/vasi/pixz/blob/master/LICENSE
1083 crunched_md5sums['2f03392b40bbe663597b5bd3cc5ebdb9'] = 'BSD-2-Clause'
1084 # https://github.com/waffle-gl/waffle/blob/master/LICENSE.txt
1085 crunched_md5sums['e72e5dfef0b1a4ca8a3d26a60587db66'] = 'BSD-2-Clause'
1086 # https://github.com/spigwitmer/fakeds1963s/blob/master/LICENSE
1087 crunched_md5sums['8be76ac6d191671f347ee4916baa637e'] = 'GPLv2'
1088 # https://github.com/datto/dattobd/blob/master/COPYING
1089 # http://git.savannah.gnu.org/cgit/freetype/freetype2.git/tree/docs/GPLv2.TXT
1090 crunched_md5sums['1d65c5ad4bf6489f85f4812bf08ae73d'] = 'GPLv2'
1091 # http://www.gnu.org/licenses/old-licenses/gpl-2.0.txt
1092 # http://git.neil.brown.name/?p=mdadm.git;a=blob;f=COPYING;h=d159169d1050894d3ea3b98e1c965c4058208fe1;hb=HEAD
1093 crunched_md5sums['fb530f66a7a89ce920f0e912b5b66d4b'] = 'GPLv2'
1094 # https://github.com/gkos/nrf24/blob/master/COPYING
1095 crunched_md5sums['7b6aaa4daeafdfa6ed5443fd2684581b'] = 'GPLv2'
1096 # https://github.com/josch09/resetusb/blob/master/COPYING
1097 crunched_md5sums['8b8ac1d631a4d220342e83bcf1a1fbc3'] = 'GPLv3'
1098 # https://github.com/FFmpeg/FFmpeg/blob/master/COPYING.LGPLv2.1
1099 crunched_md5sums['2ea316ed973ae176e502e2297b574bb3'] = 'LGPLv2.1'
1100 # unixODBC-2.3.4 COPYING
1101 crunched_md5sums['1daebd9491d1e8426900b4fa5a422814'] = 'LGPLv2.1'
1102 # https://github.com/FFmpeg/FFmpeg/blob/master/COPYING.LGPLv3
1103 crunched_md5sums['2ebfb3bb49b9a48a075cc1425e7f4129'] = 'LGPLv3'
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001104 # https://raw.githubusercontent.com/eclipse/mosquitto/v1.4.14/epl-v10
1105 crunched_md5sums['efe2cb9a35826992b9df68224e3c2628'] = 'EPL-1.0'
1106 # https://raw.githubusercontent.com/eclipse/mosquitto/v1.4.14/edl-v10
1107 crunched_md5sums['0a9c78c0a398d1bbce4a166757d60387'] = 'EDL-1.0'
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001108 lictext = []
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001109 with open(licfile, 'r', errors='surrogateescape') as f:
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001110 for line in f:
1111 # Drop opening statements
1112 if copyright_re.match(line):
1113 continue
1114 elif license_title_re.match(line):
1115 continue
1116 elif license_statement_re.match(line):
1117 continue
1118 # Squash spaces, and replace smart quotes, double quotes
1119 # and backticks with single quotes
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001120 line = oe.utils.squashspaces(line.strip())
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001121 line = line.replace(u"\u2018", "'").replace(u"\u2019", "'").replace(u"\u201c","'").replace(u"\u201d", "'").replace('"', '\'').replace('`', '\'')
1122 if line:
1123 lictext.append(line)
1124
1125 m = hashlib.md5()
1126 try:
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001127 m.update(' '.join(lictext).encode('utf-8'))
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001128 md5val = m.hexdigest()
1129 except UnicodeEncodeError:
1130 md5val = None
1131 lictext = ''
1132 license = crunched_md5sums.get(md5val, None)
1133 return license, md5val, lictext
1134
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001135def guess_license(srctree, d):
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001136 import bb
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001137 md5sums = get_license_md5sums(d)
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001138
1139 licenses = []
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001140 licspecs = ['*LICEN[CS]E*', 'COPYING*', '*[Ll]icense*', 'LEGAL*', '[Ll]egal*', '*GPL*', 'README.lic*', 'COPYRIGHT*', '[Cc]opyright*', 'e[dp]l-v10']
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001141 licfiles = []
1142 for root, dirs, files in os.walk(srctree):
1143 for fn in files:
1144 for spec in licspecs:
1145 if fnmatch.fnmatch(fn, spec):
1146 fullpath = os.path.join(root, fn)
1147 if not fullpath in licfiles:
1148 licfiles.append(fullpath)
1149 for licfile in licfiles:
1150 md5value = bb.utils.md5_file(licfile)
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001151 license = md5sums.get(md5value, None)
1152 if not license:
1153 license, crunched_md5, lictext = crunch_license(licfile)
1154 if not license:
1155 license = 'Unknown'
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001156 licenses.append((license, os.path.relpath(licfile, srctree), md5value))
1157
1158 # FIXME should we grab at least one source file with a license header and add that too?
1159
1160 return licenses
1161
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001162def split_pkg_licenses(licvalues, packages, outlines, fallback_licenses=None, pn='${PN}'):
1163 """
1164 Given a list of (license, path, md5sum) as returned by guess_license(),
1165 a dict of package name to path mappings, write out a set of
1166 package-specific LICENSE values.
1167 """
1168 pkglicenses = {pn: []}
1169 for license, licpath, _ in licvalues:
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001170 for pkgname, pkgpath in packages.items():
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001171 if licpath.startswith(pkgpath + '/'):
1172 if pkgname in pkglicenses:
1173 pkglicenses[pkgname].append(license)
1174 else:
1175 pkglicenses[pkgname] = [license]
1176 break
1177 else:
1178 # Accumulate on the main package
1179 pkglicenses[pn].append(license)
1180 outlicenses = {}
1181 for pkgname in packages:
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001182 license = ' '.join(list(set(pkglicenses.get(pkgname, ['Unknown'])))) or 'Unknown'
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001183 if license == 'Unknown' and pkgname in fallback_licenses:
1184 license = fallback_licenses[pkgname]
1185 outlines.append('LICENSE_%s = "%s"' % (pkgname, license))
1186 outlicenses[pkgname] = license.split()
1187 return outlicenses
1188
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001189def read_pkgconfig_provides(d):
Brad Bishop6e60e8b2018-02-01 10:27:11 -05001190 pkgdatadir = d.getVar('PKGDATA_DIR')
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001191 pkgmap = {}
1192 for fn in glob.glob(os.path.join(pkgdatadir, 'shlibs2', '*.pclist')):
1193 with open(fn, 'r') as f:
1194 for line in f:
1195 pkgmap[os.path.basename(line.rstrip())] = os.path.splitext(os.path.basename(fn))[0]
1196 recipemap = {}
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001197 for pc, pkg in pkgmap.items():
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001198 pkgdatafile = os.path.join(pkgdatadir, 'runtime', pkg)
1199 if os.path.exists(pkgdatafile):
1200 with open(pkgdatafile, 'r') as f:
1201 for line in f:
1202 if line.startswith('PN: '):
1203 recipemap[pc] = line.split(':', 1)[1].strip()
1204 return recipemap
1205
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001206def convert_debian(debpath):
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001207 value_map = {'Package': 'PN',
1208 'Version': 'PV',
1209 'Section': 'SECTION',
1210 'License': 'LICENSE',
1211 'Homepage': 'HOMEPAGE'}
1212
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001213 # FIXME extend this mapping - perhaps use distro_alias.inc?
1214 depmap = {'libz-dev': 'zlib'}
1215
1216 values = {}
1217 depends = []
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001218 with open(os.path.join(debpath, 'control'), 'r', errors='surrogateescape') as f:
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001219 indesc = False
1220 for line in f:
1221 if indesc:
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001222 if line.startswith(' '):
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001223 if line.startswith(' This package contains'):
1224 indesc = False
1225 else:
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001226 if 'DESCRIPTION' in values:
1227 values['DESCRIPTION'] += ' ' + line.strip()
1228 else:
1229 values['DESCRIPTION'] = line.strip()
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001230 else:
1231 indesc = False
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001232 if not indesc:
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001233 splitline = line.split(':', 1)
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001234 if len(splitline) < 2:
1235 continue
1236 key = splitline[0]
1237 value = splitline[1].strip()
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001238 if key == 'Build-Depends':
1239 for dep in value.split(','):
1240 dep = dep.split()[0]
1241 mapped = depmap.get(dep, '')
1242 if mapped:
1243 depends.append(mapped)
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001244 elif key == 'Description':
1245 values['SUMMARY'] = value
1246 indesc = True
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001247 else:
1248 varname = value_map.get(key, None)
1249 if varname:
1250 values[varname] = value
Brad Bishop6e60e8b2018-02-01 10:27:11 -05001251 postinst = os.path.join(debpath, 'postinst')
1252 postrm = os.path.join(debpath, 'postrm')
1253 preinst = os.path.join(debpath, 'preinst')
1254 prerm = os.path.join(debpath, 'prerm')
1255 sfiles = [postinst, postrm, preinst, prerm]
1256 for sfile in sfiles:
1257 if os.path.isfile(sfile):
1258 logger.info("Converting %s file to recipe function..." %
1259 os.path.basename(sfile).upper())
1260 content = []
1261 with open(sfile) as f:
1262 for line in f:
1263 if "#!/" in line:
1264 continue
1265 line = line.rstrip("\n")
1266 if line.strip():
1267 content.append(line)
1268 if content:
1269 values[os.path.basename(f.name)] = content
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001270
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001271 #if depends:
1272 # values['DEPENDS'] = ' '.join(depends)
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001273
1274 return values
1275
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001276def convert_rpm_xml(xmlfile):
1277 '''Converts the output from rpm -qp --xml to a set of variable values'''
1278 import xml.etree.ElementTree as ElementTree
1279 rpmtag_map = {'Name': 'PN',
1280 'Version': 'PV',
1281 'Summary': 'SUMMARY',
1282 'Description': 'DESCRIPTION',
1283 'License': 'LICENSE',
1284 'Url': 'HOMEPAGE'}
1285
1286 values = {}
1287 tree = ElementTree.parse(xmlfile)
1288 root = tree.getroot()
1289 for child in root:
1290 if child.tag == 'rpmTag':
1291 name = child.attrib.get('name', None)
1292 if name:
1293 varname = rpmtag_map.get(name, None)
1294 if varname:
1295 values[varname] = child[0].text
1296 return values
1297
1298
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001299def register_commands(subparsers):
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001300 parser_create = subparsers.add_parser('create',
1301 help='Create a new recipe',
1302 description='Creates a new recipe from a source tree')
1303 parser_create.add_argument('source', help='Path or URL to source')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001304 parser_create.add_argument('-o', '--outfile', help='Specify filename for recipe to create')
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001305 parser_create.add_argument('-p', '--provides', help='Specify an alias for the item provided by the recipe')
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001306 parser_create.add_argument('-m', '--machine', help='Make recipe machine-specific as opposed to architecture-specific', action='store_true')
1307 parser_create.add_argument('-x', '--extract-to', metavar='EXTRACTPATH', help='Assuming source is a URL, fetch it and extract it to the directory specified as %(metavar)s')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001308 parser_create.add_argument('-N', '--name', help='Name to use within recipe (PN)')
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001309 parser_create.add_argument('-V', '--version', help='Version to use within recipe (PV)')
Patrick Williamsf1e5d692016-03-30 15:21:19 -05001310 parser_create.add_argument('-b', '--binary', help='Treat the source tree as something that should be installed verbatim (no compilation, same directory structure)', action='store_true')
Patrick Williamsd8c66bc2016-06-20 12:57:21 -05001311 parser_create.add_argument('--also-native', help='Also add native variant (i.e. support building recipe for the build host as well as the target machine)', action='store_true')
1312 parser_create.add_argument('--src-subdir', help='Specify subdirectory within source tree to use', metavar='SUBDIR')
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001313 group = parser_create.add_mutually_exclusive_group()
1314 group.add_argument('-a', '--autorev', help='When fetching from a git repository, set SRCREV in the recipe to a floating revision instead of fixed', action="store_true")
1315 group.add_argument('-S', '--srcrev', help='Source revision to fetch if fetching from an SCM such as git (default latest)')
1316 parser_create.add_argument('-B', '--srcbranch', help='Branch in source repository if fetching from an SCM such as git (default master)')
Patrick Williamsc0f7c042017-02-23 20:41:17 -06001317 parser_create.add_argument('--keep-temp', action="store_true", help='Keep temporary directory (for debugging)')
Brad Bishop6e60e8b2018-02-01 10:27:11 -05001318 parser_create.add_argument('--fetch-dev', action="store_true", help='For npm, also fetch devDependencies')
1319 parser_create.add_argument('--devtool', action="store_true", help=argparse.SUPPRESS)
Brad Bishopd7bf8c12018-02-25 22:55:05 -05001320 parser_create.add_argument('--mirrors', action="store_true", help='Enable PREMIRRORS and MIRRORS for source tree fetching (disabled by default).')
1321 parser_create.set_defaults(func=create_recipe)
Patrick Williamsc124f4f2015-09-15 14:41:29 -05001322