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