Add meson/ to PYTHONPATH if needed
[platform/upstream/gstreamer.git] / gst-uninstalled.py
1 #!/usr/bin/env python3
2
3 import argparse
4 import json
5 import os
6 import platform
7 import re
8 import site
9 import shutil
10 import subprocess
11 import sys
12 import tempfile
13
14 from common import get_meson
15
16 SCRIPTDIR = os.path.abspath(os.path.dirname(__file__))
17
18
19 def prepend_env_var(env, var, value):
20     env[var] = os.pathsep + value + os.pathsep + env.get(var, "")
21     env[var] = env[var].replace(os.pathsep + os.pathsep, os.pathsep).strip(os.pathsep)
22
23
24 def get_subprocess_env(options):
25     env = os.environ.copy()
26
27     prepend_env_var(env, "GST_PLUGIN_PATH", options.builddir)
28     prepend_env_var(env, "GST_PLUGIN_PATH", os.path.join(SCRIPTDIR, 'subprojects',
29                                                          'gst-python', 'plugin'))
30     env["CURRENT_GST"] = os.path.normpath(SCRIPTDIR)
31     env["GST_VALIDATE_SCENARIOS_PATH"] = os.path.normpath(
32         "%s/subprojects/gst-devtools/validate/data/scenarios" % SCRIPTDIR)
33     env["GST_VALIDATE_PLUGIN_PATH"] = os.path.normpath(
34         "%s/subprojects/gst-devtools/validate/plugins" % options.builddir)
35     env["GST_VALIDATE_APPS_DIR"] = os.path.normpath(
36         "%s/subprojects/gst-editing-services/tests/validate" % SCRIPTDIR)
37     prepend_env_var(env, "PATH", os.path.normpath(
38         "%s/subprojects/gst-devtools/validate/tools" % options.builddir))
39     prepend_env_var(env, "PATH", os.path.join(SCRIPTDIR, 'meson'))
40     env["GST_VERSION"] = options.gst_version
41     env["GST_ENV"] = 'gst-' + options.gst_version
42     env["GST_PLUGIN_SYSTEM_PATH"] = ""
43     env["GST_PLUGIN_SCANNER"] = os.path.normpath(
44         "%s/subprojects/gstreamer/libs/gst/helpers/gst-plugin-scanner" % options.builddir)
45     env["GST_PTP_HELPER"] = os.path.normpath(
46         "%s/subprojects/gstreamer/libs/gst/helpers/gst-ptp-helper" % options.builddir)
47     env["GST_REGISTRY"] = os.path.normpath(options.builddir + "/registry.dat")
48
49     sharedlib_reg = re.compile(r'\.so|\.dylib|\.dll')
50     typelib_reg = re.compile(r'.*\.typelib$')
51
52     if os.name is 'nt':
53         lib_path_envvar = 'PATH'
54     elif platform.system() == 'Darwin':
55         lib_path_envvar = 'DYLD_LIBRARY_PATH'
56     else:
57         lib_path_envvar = 'LD_LIBRARY_PATH'
58
59     meson, mesonconf, mesonintrospect = get_meson()
60     targets_s = subprocess.check_output([sys.executable, mesonintrospect, options.builddir, '--targets'])
61     targets = json.loads(targets_s.decode())
62     paths = set()
63     for target in targets:
64         filename = target['filename']
65         root = os.path.dirname(filename)
66         if typelib_reg.search(filename):
67             prepend_env_var(env, "GI_TYPELIB_PATH",
68                             os.path.join(options.builddir, root))
69         elif sharedlib_reg.search(filename):
70             if target.get('type') != "shared library":
71                 continue
72
73             if os.path.normpath("lib/gstreamer-1.0") in os.path.normpath(target.get('install_filename')):
74                 continue
75
76             prepend_env_var(env, lib_path_envvar,
77                             os.path.join(options.builddir, root))
78         elif target.get('type') == 'executable' and target.get('installed'):
79             paths.add(os.path.join(options.builddir, root))
80
81     for p in paths:
82         prepend_env_var(env, 'PATH', p)
83
84     presets = set()
85     encoding_targets = set()
86     pkg_dirs = set()
87     if '--installed' in subprocess.check_output([mesonintrospect, '-h']).decode():
88         installed_s = subprocess.check_output([sys.executable, mesonintrospect,
89                                                options.builddir, '--installed'])
90         for path, installpath in json.loads(installed_s.decode()).items():
91             if path.endswith('.prs'):
92                 presets.add(os.path.dirname(path))
93             elif path.endswith('.gep'):
94                 encoding_targets.add(
95                     os.path.abspath(os.path.join(os.path.dirname(path), '..')))
96             elif path.endswith('.pc'):
97                 # Is there a -uninstalled pc file for this file?
98                 uninstalled = "{0}-uninstalled.pc".format(path[:-3])
99                 if os.path.exists(uninstalled):
100                     pkg_dirs.add(os.path.dirname(path))
101
102         for p in presets:
103             prepend_env_var(env, 'GST_PRESET_PATH', p)
104
105         for t in encoding_targets:
106             prepend_env_var(env, 'GST_ENCODING_TARGET_PATH', t)
107
108         for pkg_dir in pkg_dirs:
109             prepend_env_var(env, "PKG_CONFIG_PATH", pkg_dir)
110
111     mesonpath = os.path.join(SCRIPTDIR, "meson")
112     if os.path.join(mesonpath):
113         # Add meson/ into PYTHONPATH if we are using a local meson
114         prepend_env_var(env, 'PYTHONPATH', mesonpath)
115
116     return env
117
118
119 def python_env(options, unset_env=False):
120     """
121     Setup our overrides_hack.py as sitecustomize.py script in user
122     site-packages if unset_env=False, else unset, previously set
123     env.
124     """
125     subprojects_path = os.path.join(options.builddir, "subprojects")
126     gst_python_path = os.path.join(SCRIPTDIR, "subprojects", "gst-python")
127     if not os.path.exists(os.path.join(subprojects_path, "gst-python")) or \
128             not os.path.exists(gst_python_path):
129         return False
130
131     sitepackages = site.getusersitepackages()
132     if not sitepackages:
133         return False
134
135     sitecustomize = os.path.join(sitepackages, "sitecustomize.py")
136     overrides_hack = os.path.join(gst_python_path, "testsuite", "overrides_hack.py")
137
138     if not unset_env:
139         if os.path.exists(sitecustomize):
140             if os.path.realpath(sitecustomize) == overrides_hack:
141                 print("Customize user site script already linked to the GStreamer one")
142                 return False
143
144             old_sitecustomize = os.path.join(sitepackages,
145                                             "old.sitecustomize.gstuninstalled.py")
146             shutil.move(sitecustomize, old_sitecustomize)
147         elif not os.path.exists(sitepackages):
148             os.makedirs(sitepackages)
149
150         os.symlink(overrides_hack, sitecustomize)
151         return os.path.realpath(sitecustomize) == overrides_hack
152     else:
153         if not os.path.realpath(sitecustomize) == overrides_hack:
154             return False
155
156         os.remove(sitecustomize)
157         old_sitecustomize = os.path.join(sitepackages,
158                                             "old.sitecustomize.gstuninstalled.py")
159
160         if os.path.exists(old_sitecustomize):
161             shutil.move(old_sitecustomize, sitecustomize)
162
163         return True
164
165
166 if __name__ == "__main__":
167     parser = argparse.ArgumentParser(prog="gstreamer-uninstalled")
168
169     parser.add_argument("--builddir",
170                         default=os.path.join(SCRIPTDIR, "build"),
171                         help="The meson build directory")
172     parser.add_argument("--gst-version", default="master",
173                         help="The GStreamer major version")
174     options, args = parser.parse_known_args()
175
176     if not os.path.exists(options.builddir):
177         print("GStreamer not built in %s\n\nBuild it and try again" %
178               options.builddir)
179         exit(1)
180
181     if not args:
182         if os.name is 'nt':
183             args = [os.environ.get("COMSPEC", r"C:\WINDOWS\system32\cmd.exe")]
184         else:
185             args = [os.environ.get("SHELL", os.path.realpath("/bin/sh"))]
186         if "bash" in args[0]:
187             bashrc = os.path.expanduser('~/.bashrc')
188             if os.path.exists(bashrc):
189                 tmprc = tempfile.NamedTemporaryFile(mode='w')
190                 with open(bashrc, 'r') as src:
191                     shutil.copyfileobj(src, tmprc)
192                 tmprc.write('\nexport PS1="[gst-%s] $PS1"' % options.gst_version)
193                 tmprc.flush()
194                 # Let the GC remove the tmp file
195                 args.append("--rcfile")
196                 args.append(tmprc.name)
197     python_set = python_env(options)
198     try:
199         exit(subprocess.call(args, env=get_subprocess_env(options)))
200     except subprocess.CalledProcessError as e:
201         exit(e.returncode)
202     finally:
203         if python_set:
204             python_env(options, unset_env=True)