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     setup_python_env(options, env)
  79
  80     meson = get_meson()
  81     targets_s = subprocess.check_output(meson + ['introspect', options.builddir, '--targets'])
  82     targets = json.loads(targets_s.decode())
  83     paths = set()
  84     mono_paths = set()
  85     for target in targets:
  86         filename = target['filename']
  87         root = os.path.dirname(filename)
  88         if filename.endswith('.dll'):
  89             mono_paths.add(os.path.join(options.builddir, root))
  90         if typelib_reg.search(filename):
  91             prepend_env_var(env, "GI_TYPELIB_PATH",
  92                             os.path.join(options.builddir, root))
  93         elif sharedlib_reg.search(filename):
  94             if target.get('type') != "shared library":
  95                 continue
  96
  97             if target.get('installed') and pluginpath_reg.search(os.path.normpath(target.get('install_filename'))):
  98                 prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(options.builddir, root))
  99                 continue
 100
 101             prepend_env_var(env, lib_path_envvar,
 102                             os.path.join(options.builddir, root))
 103         elif target.get('type') == 'executable' and target.get('installed'):
 104             paths.add(os.path.join(options.builddir, root))
 105
 106     for p in paths:
 107         prepend_env_var(env, 'PATH', p)
 108
 109     if os.name != 'nt':
 110         for p in mono_paths:
 111             prepend_env_var(env, "MONO_PATH", p)
 112
 113     presets = set()
 114     encoding_targets = set()
 115     pkg_dirs = set()
 116     python_dirs = set()
 117     if '--installed' in subprocess.check_output(meson + ['introspect', '-h']).decode():
 118         installed_s = subprocess.check_output(meson + ['introspect', options.builddir, '--installed'])
 119         for path, installpath in json.loads(installed_s.decode()).items():
 120             installpath_parts = pathlib.Path(installpath).parts
 121             path_parts = pathlib.Path(path).parts
 122
 123             # We want to add all python modules to the PYTHONPATH
 124             # in a manner consistent with the way they would be imported:
 125             # For example if the source path /home/meh/foo/bar.py
 126             # is to be installed in /usr/lib/python/site-packages/foo/bar.py,
 127             # we want to add /home/meh to the PYTHONPATH.
 128             # This will only work for projects where the paths to be installed
 129             # mirror the installed directory layout, for example if the path
 130             # is /home/meh/baz/bar.py and the install path is
 131             # /usr/lib/site-packages/foo/bar.py , we will not add anything
 132             # to PYTHONPATH, but the current approach works with pygobject
 133             # and gst-python at least.
 134             if 'site-packages' in installpath_parts:
 135                 install_subpath = os.path.join(*installpath_parts[installpath_parts.index('site-packages') + 1:])
 136                 if path.endswith(install_subpath):
 137                     python_dirs.add(path[:len (install_subpath) * -1])
 138
 139             if path.endswith('.prs'):
 140                 presets.add(os.path.dirname(path))
 141             elif path.endswith('.gep'):
 142                 encoding_targets.add(
 143                     os.path.abspath(os.path.join(os.path.dirname(path), '..')))
 144             elif path.endswith('.pc'):
 145                 # Is there a -uninstalled pc file for this file?
 146                 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
 147                 if os.path.exists(uninstalled):
 148                     pkg_dirs.add(os.path.dirname(path))
 149
 150         for p in presets:
 151             prepend_env_var(env, 'GST_PRESET_PATH', p)
 152
 153         for t in encoding_targets:
 154             prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t)
 155
 156         for pkg_dir in pkg_dirs:
 157             prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir)
 158     prepend_env_var(env, "PKG_CONFIG_PATH", os.path.join(options.builddir,
 159                                                          'subprojects',
 160                                                          'gst-plugins-good',
 161                                                          'pkgconfig'))
 162
 163     for python_dir in python_dirs:
 164         prepend_env_var(env, 'PYTHONPATH', python_dir)
 165
 166     mesonpath = os.path.join(SCRIPTDIR, "meson")
 167     if os.path.join(mesonpath):
 168         # Add meson/ into PYTHONPATH if we are using a local meson
 169         prepend_env_var(env, 'PYTHONPATH', mesonpath)
 170
 171     return env
 172
 173 # https://stackoverflow.com/questions/1871549/determine-if-python-is-running-inside-virtualenv
 174 def in_venv():
 175     return (hasattr(sys, 'real_prefix') or
 176             (hasattr(sys, 'base_prefix') and sys.base_prefix != sys.prefix))
 177
 178 def setup_python_env(options, env):
 179     some_overrides_built = False
 180     for override_path in [os.path.join("subprojects", "gst-editing-services", "bindings", "python", "gi", "overrides"),
 181                           os.path.join("subprojects", "gst-python", "gi", "overrides")]:
 182         if os.path.exists(os.path.join(SCRIPTDIR, override_path)):
 183             some_overrides_built = True
 184         else:
 185             continue
 186
 187         prepend_env_var(env, "PYGOBJECT_OVERRIDES_PATH", os.path.join(SCRIPTDIR, override_path))
 188         prepend_env_var(env, "PYGOBJECT_OVERRIDES_PATH", os.path.join(options.builddir, override_path))
 189
 190     if not some_overrides_built:
 191         return
 192
 193     if in_venv ():
 194         sitepackages = get_python_lib()
 195     else:
 196         sitepackages = site.getusersitepackages()
 197
 198     usercustomize = os.path.join(
 199         subprocess.check_output([sys.executable, '-c', 'import site; print(site.USER_SITE)'],
 200         env={"PYTHONUSERBASE": PREFIX_DIR}).decode().strip("\n"), "usercustomize.py")
 201
 202     custom_user_sitepackage = os.path.dirname(usercustomize)
 203     os.makedirs(custom_user_sitepackage, exist_ok=True)
 204     with open(usercustomize, "w") as f:
 205          f.write("""import os
 206 import gi.overrides
 207
 208 for override_path in os.environ.get("PYGOBJECT_OVERRIDES_PATH", "").split(os.pathsep):
 209     gi.overrides.__path__.insert(0, override_path)
 210 """)
 211
 212     env["PYTHONUSERBASE"] = PREFIX_DIR
 213     if sitepackages:
 214         prepend_env_var(env, "PYTHONPATH", sitepackages)
 215
 216 if __name__ == "__main__":
 217     parser = argparse.ArgumentParser(prog="gstreamer-uninstalled")
 218
 219     parser.add_argument("--builddir",
 220                         default=DEFAULT_BUILDDIR,
 221                         help="The meson build directory")
 222     parser.add_argument("--srcdir",
 223                         default=SCRIPTDIR,
 224                         help="The top level source directory")
 225     options, args = parser.parse_known_args()
 226
 227     if not os.path.exists(options.builddir):
 228         print("GStreamer not built in %s\n\nBuild it and try again" %
 229               options.builddir)
 230         exit(1)
 231     options.builddir = os.path.abspath(options.builddir)
 232
 233     if not os.path.exists(options.srcdir):
 234         print("The specified source dir does not exist" %
 235               options.srcdir)
 236         exit(1)
 237
 238     # The following incantation will retrieve the current branch name.
 239     gst_version = git("rev-parse", "--symbolic-full-name", "--abbrev-ref", "HEAD",
 240                       repository_path=options.srcdir).strip('\n')
 241
 242     if not args:
 243         if os.name is 'nt':
 244             args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
 245         else:
 246             args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
 247         if "bash" in args[0]:
 248             bashrc = os.path.expanduser('~/.bashrc')
 249             if os.path.exists(bashrc):
 250                 tmprc = tempfile.NamedTemporaryFile(mode='w')
 251                 with open(bashrc, 'r') as src:
 252                     shutil.copyfileobj(src, tmprc)
 253                 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % gst_version)
 254                 tmprc.flush()
 255                 # Let the GC remove the tmp file
 256                 args.append("--rcfile")
 257                 args.append(tmprc.name)
 258     try:
 259         exit(subprocess.call(args, cwd=options.srcdir, close_fds=False,
 260                              env=get_subprocess_env(options, gst_version)))
 261     except subprocess.CalledProcessError as e:
 262         exit(e.returncode)