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
  15 from distutils.sysconfig import get_python_lib
  16
  17 from common import get_meson
  18 from common import git
  19
  20 SCRIPTDIR = os.path.dirname(os.path.realpath(__file__))
  21 PREFIX_DIR = os.path.join(SCRIPTDIR, 'prefix')
  22 # Use '_build' as the builddir instead of 'build'
  23 DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, 'build')
  24 if not os.path.exists(DEFAULT_BUILDDIR):
  25     DEFAULT_BUILDDIR = os.path.join(SCRIPTDIR, '_build')
  26
  27
  28 def prepend_env_var(env, var, value):
  29     env[var] = os.pathsep + value + os.pathsep + env.get(var, "")
  30     env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
  31
  32
  33 def get_subprocess_env(options, gst_version):
  34     env = os.environ.copy()
  35
  36     env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
  37     env["GST_VALIDATE_SCENARIOS_PATH"] = os.path.normpath(
  38         "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR)
  39     env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
  40         "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
  41     env["GST_VALIDATE_APPS_DIR"] = os.path.normpath(
  42         "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR)
  43     prepend_env_var(env, "PATH", os.path.normpath(
  44         "%s/subprojects/gst-devtools/validate/tools" % options.builddir))
  45     prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'))
  46     env["GST_VERSION"] = gst_version
  47     env["GST_ENV"] = 'gst-' + gst_version
  48     env["GST_PLUGIN_SYSTEM_PATH"] = ""
  49     env["GST_PLUGIN_SCANNER"] = os.path.normpath(
  50         "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
  51     env["GST_PTP_HELPER"] = os.path.normpath(
  52         "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
  53     env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
  54
  55     sharedlib_reg = re.compile(r'\.so|\.dylib|\.dll')
  56     typelib_reg = re.compile(r'.*\.typelib$')
  57     pluginpath_reg = re.compile(r'lib.*' + re.escape(os.path.normpath('/gstreamer-1.0/')))
  58
  59     if os.name is 'nt':
  60         lib_path_envvar = 'PATH'
  61     elif platform.system() == 'Darwin':
  62         lib_path_envvar = 'DYLD_LIBRARY_PATH'
  63     else:
  64         lib_path_envvar = 'LD_LIBRARY_PATH'
  65
  66     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
  67                                                         'gst-python', 'plugin'))
  68     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(PREFIX_DIR, 'lib',
  69                                                         'gstreamer-1.0'))
  70     prepend_env_var(env, "PATH", os.path.join(PREFIX_DIR, 'bin'))
  71     prepend_env_var(env, lib_path_envvar, os.path.join(PREFIX_DIR, 'lib'))
  72     prepend_env_var(env, "GST_VALIDATE_SCENARIOS_PATH", os.path.join(
  73         PREFIX_DIR, 'share', 'gstreamer-1.0', 'validate', 'scenarios'))
  74     prepend_env_var(env, "GI_TYPELIB_PATH", os.path.join(PREFIX_DIR, 'lib',
  75                                                          'lib', 'girepository-1.0'))
  76     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(PREFIX_DIR, 'lib', 'pkgconfig'))
  77     setup_python_env(options, env)
  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     if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
 116         installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
 117         for path, installpath in json.loads(installed_s.decode()).items():
 118             if path.endswith('.prs'):
 119                 presets.add(os.path.dirname(path))
 120             elif path.endswith('.gep'):
 121                 encoding_targets.add(
 122                     os.path.abspath(os.path.join(os.path.dirname(path), '..')))
 123             elif path.endswith('.pc'):
 124                 # Is there a -uninstalled pc file for this file?
 125                 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
 126                 if os.path.exists(uninstalled):
 127                     pkg_dirs.add(os.path.dirname(path))
 128
 129         for p in presets:
 130             prepend_env_var(env, 'GST_PRESET_PATH', p)
 131
 132         for t in encoding_targets:
 133             prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t)
 134
 135         for pkg_dir in pkg_dirs:
 136             prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir)
 137     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(options.builddir,
 138                                                          'subprojects',
 139                                                          'gst-plugins-good',
 140                                                          'pkgconfig'))
 141
 142     mesonpath = os.path.join(SCRIPTDIR, "meson")
 143     if os.path.join(mesonpath):
 144         # Add meson/ into PYTHONPATH if we are using a local meson
 145         prepend_env_var(env, 'PYTHONPATH', mesonpath)
 146
 147     return env
 148
 149 # https://stackoverflow.com/questions/1871549/determine-if-python-is-running-inside-virtualenv
 150 def in_venv():
 151     return (hasattr(sys, 'real_prefix') or
 152             (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix))
 153
 154 def setup_python_env(options, env):
 155     some_overrides_built = False
 156     for override_path in [os.path.join("subprojects", "gst-editing-services", "bindings", "python", "gi", "overrides"),
 157                           os.path.join("subprojects", "gst-python", "gi", "overrides")]:
 158         if os.path.exists(os.path.join(SCRIPTDIR, override_path)):
 159             some_overrides_built = True
 160         else:
 161             continue
 162
 163         prepend_env_var(env, "PYGOBJECT_OVERRIDES_PATH", os.path.join(SCRIPTDIR, override_path))
 164         prepend_env_var(env, "PYGOBJECT_OVERRIDES_PATH", os.path.join(options.builddir, override_path))
 165
 166     if not some_overrides_built:
 167         return
 168
 169     if in_venv ():
 170         sitepackages = get_python_lib()
 171     else:
 172         sitepackages = site.getusersitepackages()
 173
 174     sitecustomize = os.path.join(
 175         subprocess.check_output([sys.executable, '-c', 'import site; print(site.USER_SITE)'],
 176         env={"PYTHONUSERBASE": PREFIX_DIR}).decode().strip("\n"), "sitecustomize.py")
 177
 178     custom_user_sitepackage = os.path.dirname(sitecustomize)
 179     os.makedirs(custom_user_sitepackage, exist_ok=True)
 180     with open(sitecustomize, "w") as f:
 181          f.write("""import os
 182 import gi.overrides
 183
 184 for override_path in os.environ.get("PYGOBJECT_OVERRIDES_PATH", "").split(os.pathsep):
 185     gi.overrides.__path__.insert(0, override_path)
 186 """)
 187
 188     env["PYTHONUSERBASE"] = PREFIX_DIR
 189     if sitepackages:
 190         prepend_env_var(env, "PYTHONPATH", sitepackages)
 191
 192 if __name__ == "__main__":
 193     parser = argparse.ArgumentParser(prog="gstreamer-uninstalled")
 194
 195     parser.add_argument("--builddir",
 196                         default=DEFAULT_BUILDDIR,
 197                         help="The meson build directory")
 198     parser.add_argument("--srcdir",
 199                         default=SCRIPTDIR,
 200                         help="The top level source directory")
 201     options, args = parser.parse_known_args()
 202
 203     if not os.path.exists(options.builddir):
 204         print("GStreamer not built in %s\n\nBuild it and try again" %
 205               options.builddir)
 206         exit(1)
 207     options.builddir = os.path.abspath(options.builddir)
 208
 209     if not os.path.exists(options.srcdir):
 210         print("The specified source dir does not exist" %
 211               options.srcdir)
 212         exit(1)
 213
 214     # The following incantation will retrieve the current branch name.
 215     gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD", repository_path=options.srcdir)
 216
 217     if not args:
 218         if os.name is 'nt':
 219             args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
 220         else:
 221             args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
 222         if "bash" in args[0]:
 223             bashrc = os.path.expanduser('~/.bashrc')
 224             if os.path.exists(bashrc):
 225                 tmprc = tempfile.NamedTemporaryFile(mode='w')
 226                 with open(bashrc, 'r') as src:
 227                     shutil.copyfileobj(src, tmprc)
 228                 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
 229                 tmprc.flush()
 230                 # Let the GC remove the tmp file
 231                 args.append("--rcfile")
 232                 args.append(tmprc.name)
 233     try:
 234         exit(subprocess.call(args, cwd=options.srcdir, close_fds=False,
 235                              env=get_subprocess_env(options, gst_version)))
 236     except subprocess.CalledProcessError as e:
 237         exit(e.returncode)