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