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