1# Recipe creation tool - newappend plugin
2#
3# This sub-command creates a bbappend for the specified target and prints the
4# path to the bbappend.
5#
6# Example: recipetool newappend meta-mylayer busybox
7#
8# Copyright (C) 2015 Christopher Larson <kergoth@gmail.com>
9#
10# SPDX-License-Identifier: GPL-2.0-only
11#
12
13import argparse
14import errno
15import logging
16import os
17import re
18import subprocess
19import sys
20import scriptutils
21
22
23logger = logging.getLogger('recipetool')
24tinfoil = None
25
26
27def tinfoil_init(instance):
28    global tinfoil
29    tinfoil = instance
30
31
32def layer(layerpath):
33    if not os.path.exists(os.path.join(layerpath, 'conf', 'layer.conf')):
34        raise argparse.ArgumentTypeError('{0!r} must be a path to a valid layer'.format(layerpath))
35    return layerpath
36
37
38def newappend(args):
39    import oe.recipeutils
40
41    recipe_path = tinfoil.get_recipe_file(args.target)
42
43    rd = tinfoil.config_data.createCopy()
44    rd.setVar('FILE', recipe_path)
45    append_path, path_ok = oe.recipeutils.get_bbappend_path(rd, args.destlayer, args.wildcard_version)
46    if not append_path:
47        logger.error('Unable to determine layer directory containing %s', recipe_path)
48        return 1
49
50    if not path_ok:
51        logger.warning('Unable to determine correct subdirectory path for bbappend file - check that what %s adds to BBFILES also matches .bbappend files. Using %s for now, but until you fix this the bbappend will not be applied.', os.path.join(args.destlayer, 'conf', 'layer.conf'), os.path.dirname(append_path))
52
53    layerdirs = [os.path.abspath(layerdir) for layerdir in rd.getVar('BBLAYERS').split()]
54    if not os.path.abspath(args.destlayer) in layerdirs:
55        logger.warning('Specified layer is not currently enabled in bblayers.conf, you will need to add it before this bbappend will be active')
56
57    if not os.path.exists(append_path):
58        bb.utils.mkdirhier(os.path.dirname(append_path))
59
60        try:
61            open(append_path, 'a').close()
62        except (OSError, IOError) as exc:
63            logger.critical(str(exc))
64            return 1
65
66    if args.edit:
67        return scriptutils.run_editor([append_path, recipe_path], logger)
68    else:
69        print(append_path)
70
71
72def register_commands(subparsers):
73    parser = subparsers.add_parser('newappend',
74                                   help='Create a bbappend for the specified target in the specified layer')
75    parser.add_argument('-e', '--edit', help='Edit the new append. This obeys $VISUAL if set, otherwise $EDITOR, otherwise vi.', action='store_true')
76    parser.add_argument('-w', '--wildcard-version', help='Use wildcard to make the bbappend apply to any recipe version', action='store_true')
77    parser.add_argument('destlayer', help='Base directory of the destination layer to write the bbappend to', type=layer)
78    parser.add_argument('target', help='Target recipe/provide to append')
79    parser.set_defaults(func=newappend, parserecipes=True)
80