gst-uninstalled.py

   1 #!/usr/bin/env python3
   2
   3 import argparse
   4 import contextlib
   5 import json
   6 import os
   7 import platform
   8 import re
   9 import site
  10 import shutil
  11 import subprocess
  12 import sys
  13 import tempfile
  14 import pathlib
  15
  16 from distutils.sysconfig import get_python_lib
  17 from distutils.util import strtobool
  18
  19 from scripts.common import get_meson
  20 from scripts.common import git
  21 from scripts.common import win32_get_short_path_name
  22
  23 SCRIPTDIR = os.path.dirname(os.path.realpath(__file__))
  24 PREFIX_DIR = os.path.join(SCRIPTDIR, 'prefix')
  25 # Use '_build' as the builddir instead of 'build'
  26 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, 'build')
  27 if not os.path.exists(DEFAULT_BUILDDIR):
  28     DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, '_build')
  29
  30
  31 def listify(o):
  32     if isinstance(o, str):
  33         return [o]
  34     if isinstance(o, list):
  35         return o
  36     raise AssertionError('Object {!r} must be a string or a list'.format(o))
  37
  38 def stringify(o):
  39     if isinstance(o, str):
  40         return o
  41     if isinstance(o, list):
  42         if len(o) == 1:
  43             return o[0]
  44         raise AssertionError('Did not expect object {!r} to have more than one element'.format(o))
  45     raise AssertionError('Object {!r} must be a string or a list'.format(o))
  46
  47 def prepend_env_var(env, var, value, sysroot):
  48     if value.startswith(sysroot):
  49         value = value[len(sysroot):]
  50     # Try not to exceed maximum length limits for env vars on Windows
  51     if os.name is 'nt':
  52         value = win32_get_short_path_name(value)
  53     env_val = env.get(var, '')
  54     val = os.pathsep + value + os.pathsep
  55     # Don't add the same value twice
  56     if val in env_val or env_val.startswith(value + os.pathsep):
  57         return
  58     env[var] = val + env_val
  59     env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
  60
  61
  62 def get_subprocess_env(options, gst_version):
  63     env = os.environ.copy()
  64
  65     env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
  66     env["GST_VALIDATE_SCENARIOS_PATH"] = os.path.normpath(
  67         "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR)
  68     env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
  69         "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
  70     env["GST_VALIDATE_APPS_DIR"] = os.path.normpath(
  71         "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR)
  72     prepend_env_var(env, "PATH", os.path.normpath(
  73         "%s/subprojects/gst-devtools/validate/tools" % options.builddir),
  74         options.sysroot)
  75     prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'),
  76         options.sysroot)
  77     env["GST_VERSION"] = gst_version
  78     env["GST_ENV"] = 'gst-' + gst_version
  79     env["GST_PLUGIN_SYSTEM_PATH"] = ""
  80     env["GST_PLUGIN_SCANNER"] = os.path.normpath(
  81         "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
  82     env["GST_PTP_HELPER"] = os.path.normpath(
  83         "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
  84     env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
  85
  86     sharedlib_reg = re.compile(r'\.so|\.dylib|\.dll')
  87     typelib_reg = re.compile(r'.*\.typelib$')
  88
  89     if os.name is 'nt':
  90         lib_path_envvar = 'PATH'
  91     elif platform.system() == 'Darwin':
  92         lib_path_envvar = 'DYLD_LIBRARY_PATH'
  93     else:
  94         lib_path_envvar = 'LD_LIBRARY_PATH'
  95
  96     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
  97                                                         'gst-python', 'plugin'),
  98                     options.sysroot)
  99     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(PREFIX_DIR, 'lib',
 100                                                         'gstreamer-1.0'),
 101                     options.sysroot)
 102     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(options.builddir, 'subprojects',
 103                                                          'libnice', 'gst'),
 104                     options.sysroot)
 105     prepend_env_var(env, "GST_VALIDATE_SCENARIOS_PATH",
 106                     os.path.join(PREFIX_DIR, 'share', 'gstreamer-1.0',
 107                                  'validate', 'scenarios'),
 108                     options.sysroot)
 109     prepend_env_var(env, "GI_TYPELIB_PATH", os.path.join(PREFIX_DIR, 'lib',
 110                                                          'lib', 'girepository-1.0'),
 111                     options.sysroot)
 112     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(PREFIX_DIR, 'lib', 'pkgconfig'),
 113                     options.sysroot)
 114
 115     # gst-indent
 116     prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'gstreamer', 'tools'),
 117                     options.sysroot)
 118
 119     # Library and binary search paths
 120     prepend_env_var(env, "PATH", os.path.join(PREFIX_DIR, 'bin'),
 121                     options.sysroot)
 122     if lib_path_envvar != 'PATH':
 123         prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib'),
 124                         options.sysroot)
 125         prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib64'),
 126                         options.sysroot)
 127     elif 'QMAKE' in os.environ:
 128         # There's no RPATH on Windows, so we need to set PATH for the qt5 DLLs
 129         prepend_env_var(env, 'PATH', os.path.dirname(os.environ['QMAKE']),
 130                         options.sysroot)
 131
 132     meson = get_meson()
 133     targets_s = subprocess.check_output(meson + ['introspect', options.builddir, '--targets'])
 134     targets = json.loads(targets_s.decode())
 135     paths = set()
 136     mono_paths = set()
 137     srcdir_path = pathlib.Path(options.srcdir)
 138     for target in targets:
 139         filenames = listify(target['filename'])
 140         for filename in filenames:
 141             root = os.path.dirname(filename)
 142             if srcdir_path / "subprojects/gst-devtools/validate/plugins" in (srcdir_path / root).parents:
 143                 continue
 144             if filename.endswith('.dll'):
 145                 mono_paths.add(os.path.join(options.builddir, root))
 146             if typelib_reg.search(filename):
 147                 prepend_env_var(env, "GI_TYPELIB_PATH",
 148                                 os.path.join(options.builddir, root),
 149                                 options.sysroot)
 150             elif sharedlib_reg.search(filename):
 151                 if not target['type'].startswith('shared'):
 152                     continue
 153
 154                 prepend_env_var(env, lib_path_envvar,
 155                                 os.path.join(options.builddir, root),
 156                                 options.sysroot)
 157             elif target['type'] == 'executable' and target['installed']:
 158                 paths.add(os.path.join(options.builddir, root))
 159
 160     with open(os.path.join(options.builddir, 'GstPluginsPath.json')) as f:
 161         for plugin_path in json.load(f):
 162             prepend_env_var(env, 'GST_PLUGIN_PATH', plugin_path,
 163                             options.sysroot)
 164
 165     for p in paths:
 166         prepend_env_var(env, 'PATH', p, options.sysroot)
 167
 168     if os.name != 'nt':
 169         for p in mono_paths:
 170             prepend_env_var(env, "MONO_PATH", p, options.sysroot)
 171
 172     presets = set()
 173     encoding_targets = set()
 174     pkg_dirs = set()
 175     python_dirs = set(["%s/subprojects/gstreamer/libs/gst/helpers/" % options.srcdir])
 176     if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
 177         installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
 178         for path, installpath in json.loads(installed_s.decode()).items():
 179             installpath_parts = pathlib.Path(installpath).parts
 180             path_parts = pathlib.Path(path).parts
 181
 182             # We want to add all python modules to the PYTHONPATH
 183             # in a manner consistent with the way they would be imported:
 184             # For example if the source path /home/meh/foo/bar.py
 185             # is to be installed in /usr/lib/python/site-packages/foo/bar.py,
 186             # we want to add /home/meh to the PYTHONPATH.
 187             # This will only work for projects where the paths to be installed
 188             # mirror the installed directory layout, for example if the path
 189             # is /home/meh/baz/bar.py and the install path is
 190             # /usr/lib/site-packages/foo/bar.py , we will not add anything
 191             # to PYTHONPATH, but the current approach works with pygobject
 192             # and gst-python at least.
 193             if 'site-packages' in installpath_parts:
 194                 install_subpath = os.path.join(*installpath_parts[installpath_parts.index('site-packages') + 1:])
 195                 if path.endswith(install_subpath):
 196                     python_dirs.add(path[:len (install_subpath) * -1])
 197
 198             if path.endswith('.prs'):
 199                 presets.add(os.path.dirname(path))
 200             elif path.endswith('.gep'):
 201                 encoding_targets.add(
 202                     os.path.abspath(os.path.join(os.path.dirname(path), '..')))
 203             elif path.endswith('.pc'):
 204                 # Is there a -uninstalled pc file for this file?
 205                 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
 206                 if os.path.exists(uninstalled):
 207                     pkg_dirs.add(os.path.dirname(path))
 208
 209             if path.endswith('gstomx.conf'):
 210                 prepend_env_var(env, 'GST_OMX_CONFIG_DIR', os.path.dirname(path),
 211                                 options.sysroot)
 212
 213         for p in presets:
 214             prepend_env_var(env, 'GST_PRESET_PATH', p, options.sysroot)
 215
 216         for t in encoding_targets:
 217             prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t, options.sysroot)
 218
 219         for pkg_dir in pkg_dirs:
 220             prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir, options.sysroot)
 221     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(options.builddir,
 222                                                          'subprojects',
 223                                                          'gst-plugins-good',
 224                                                          'pkgconfig'),
 225                     options.sysroot)
 226
 227     for python_dir in python_dirs:
 228         prepend_env_var(env, 'PYTHONPATH', python_dir, options.sysroot)
 229
 230     mesonpath = os.path.join(SCRIPTDIR, "meson")
 231     if os.path.join(mesonpath):
 232         # Add meson/ into PYTHONPATH if we are using a local meson
 233         prepend_env_var(env, 'PYTHONPATH', mesonpath, options.sysroot)
 234
 235     # For devhelp books
 236     if not 'XDG_DATA_DIRS' in env or not env['XDG_DATA_DIRS']:
 237         # Preserve default paths when empty
 238         prepend_env_var(env, 'XDG_DATA_DIRS', '/usr/local/share/:/usr/share/', '')
 239
 240     prepend_env_var (env, 'XDG_DATA_DIRS', os.path.join(options.builddir,
 241                                                         'subprojects',
 242                                                         'gst-docs',
 243                                                         'GStreamer-doc'),
 244                      options.sysroot)
 245
 246     return env
 247
 248 def get_windows_shell():
 249     command = ['powershell.exe' ,'-noprofile', '-executionpolicy', 'bypass', '-file', 'cmd_or_ps.ps1']
 250     result = subprocess.check_output(command)
 251     return result.decode().strip()
 252
 253 # https://stackoverflow.com/questions/1871549/determine-if-python-is-running-inside-virtualenv
 254 def in_venv():
 255     return (hasattr(sys, 'real_prefix') or
 256             (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix))
 257
 258 if __name__ == "__main__":
 259     parser = argparse.ArgumentParser(prog="gstreamer-uninstalled")
 260
 261     parser.add_argument("--builddir",
 262                         default=DEFAULT_BUILDDIR,
 263                         help="The meson build directory")
 264     parser.add_argument("--srcdir",
 265                         default=SCRIPTDIR,
 266                         help="The top level source directory")
 267     parser.add_argument("--sysroot",
 268                         default='',
 269                         help="The sysroot path used during cross-compilation")
 270     options, args = parser.parse_known_args()
 271
 272     if not os.path.exists(options.builddir):
 273         print("GStreamer not built in %s\n\nBuild it and try again" %
 274               options.builddir)
 275         exit(1)
 276     options.builddir = os.path.abspath(options.builddir)
 277
 278     if not os.path.exists(options.srcdir):
 279         print("The specified source dir does not exist" %
 280               options.srcdir)
 281         exit(1)
 282
 283     # The following incantation will retrieve the current branch name.
 284     gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD",
 285                       repository_path=options.srcdir).strip('\n')
 286
 287     if not args:
 288         if os.name is 'nt':
 289             shell = get_windows_shell()
 290             if shell == 'powershell.exe':
 291                 args = ['powershell.exe']
 292                 args += ['-NoLogo', '-NoExit']
 293                 prompt = 'function global:prompt {  "[gst-' + gst_version + '"+"] PS " + $PWD + "> "}'
 294                 args += ['-Command', prompt]
 295             else:
 296                 args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
 297                 args += ['/k', 'prompt [gst-{}] $P$G'.format(gst_version)]
 298         else:
 299             args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
 300         if "bash" in args[0] and not strtobool(os.environ.get("GST_BUILD_DISABLE_PS1_OVERRIDE", r"FALSE")):
 301             bashrc = os.path.expanduser('~/.bashrc')
 302             if os.path.exists(bashrc):
 303                 tmprc = tempfile.NamedTemporaryFile(mode='w')
 304                 with open(bashrc, 'r') as src:
 305                     shutil.copyfileobj(src, tmprc)
 306                 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
 307                 tmprc.flush()
 308                 # Let the GC remove the tmp file
 309                 args.append("--rcfile")
 310                 args.append(tmprc.name)
 311     try:
 312         exit(subprocess.call(args, close_fds=False,
 313                              env=get_subprocess_env(options, gst_version)))
 314     except subprocess.CalledProcessError as e:
 315         exit(e.returncode)