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