1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
|
#!/usr/bin/env python3
#
# Copyright (C) 2012-2013 Martyn Russell <martyn@lanedo.com>
# Copyright (C) 2012 Sam Thursfield <sam.thursfield@codethink.co.uk>
# Copyright (C) 2016,2019 Sam Thursfield <sam@afuera.me.uk>
#
# This is a tool for running development versions of Tracker.
#
# See README.md for usage information.
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
#
import argparse
import collections
import contextlib
import locale
import logging
import os
import shlex
import shutil
import signal
import subprocess
import sys
import tempfile
import time
from gi.repository import Gio
from gi.repository import GLib
from . import dconf
from . import helpers
# Script
script_name = 'tracker-sandbox'
script_about = "Tracker Sandbox developer tool."
default_store_location = '/tmp/tracker-sandbox'
store_pid = -1
store_proc = None
original_xdg_data_home = GLib.get_user_data_dir()
log = logging.getLogger('sandbox')
# Environment / Clean up
def environment_unset(dbus):
log.debug('Cleaning up processes ...')
dbus.stop()
# FIXME: clean up tracker-store, can't use 'tracker daemon ...' for this,
# that kills everything it finds in /proc sadly.
if store_pid > 0:
log.debug(' Killing Tracker store')
os.kill(store_pid, signal.SIGTERM)
def environment_set_and_add_path(env, var, prefix, suffix):
new = os.path.join(prefix, suffix)
if var in os.environ:
existing = os.environ[var]
full = '%s:%s' % (new, existing)
else:
full = new
env[var] = full
class ExternalDBusSandbox():
def __init__(self, session_bus_address, extra_env):
self.session_bus_address = session_bus_address
self.extra_env = extra_env
def get_session_bus_address(self):
return self.session_bus_address
def stop(self):
log.info("Not stopping D-Bus daemon managed by another process")
pass
def create_sandbox(store_location, prefix=None, use_session_dirs=False,
dbus_config=None, dbus_session_bus_address=None,
interactive=False):
assert prefix is None or dbus_config is None
extra_env = {}
# Data
if not use_session_dirs:
extra_env['XDG_DATA_HOME'] = '%s/data/' % store_location
extra_env['XDG_CONFIG_HOME'] = '%s/config/' % store_location
extra_env['XDG_CACHE_HOME'] = '%s/cache/' % store_location
extra_env['XDG_RUNTIME_DIR'] = '%s/run/' % store_location
# Prefix - only set if non-standard
if prefix and prefix != '/usr':
environment_set_and_add_path(extra_env, 'PATH', prefix, 'bin')
environment_set_and_add_path(extra_env, 'LD_LIBRARY_PATH', prefix, 'lib')
environment_set_and_add_path(extra_env, 'LD_LIBRARY_PATH', prefix, 'lib64')
environment_set_and_add_path(extra_env, 'XDG_DATA_DIRS', prefix, 'share')
# Preferences
extra_env['G_MESSAGES_PREFIXED'] = 'all'
log.debug('Using prefix location "%s"' % prefix)
log.debug('Using store location "%s"' % store_location)
# Update our own environment, so when we launch a subprocess it has the
# same settings as the Tracker daemons.
os.environ.update(extra_env)
if dbus_session_bus_address:
sandbox = ExternalDBusSandbox(dbus_session_bus_address, extra_env=extra_env)
os.environ['DBUS_SESSION_BUS_ADDRESS'] = dbus_session_bus_address
else:
sandbox = helpers.TrackerDBusSandbox(dbus_config, extra_env=extra_env)
sandbox.start(new_session=True)
os.environ['DBUS_SESSION_BUS_ADDRESS'] = sandbox.get_session_bus_address()
os.environ['TRACKER_SANDBOX'] = '1'
return sandbox
def config_set(sandbox, content_locations_recursive=None,
content_locations_single=None, applications=False):
dconfclient = dconf.DConfClient(sandbox)
if content_locations_recursive:
log.debug("Using content locations: %s" %
content_locations_recursive)
if content_locations_single:
log.debug("Using non-recursive content locations: %s" %
content_locations_single)
if applications:
log.debug("Indexing applications")
def locations_gsetting(locations):
locations = [dir if dir.startswith('&') else os.path.abspath(dir)
for dir in locations]
return GLib.Variant('as', locations)
dconfclient.write('org.freedesktop.Tracker3.Miner.Files',
'index-recursive-directories',
locations_gsetting(content_locations_recursive or []))
dconfclient.write('org.freedesktop.Tracker3.Miner.Files',
'index-single-directories',
locations_gsetting(content_locations_single or []))
dconfclient.write('org.freedesktop.Tracker3.Miner.Files',
'index-applications',
GLib.Variant('b', applications))
dconfclient.write('org.freedesktop.Tracker3.Miner.Files',
'initial-sleep',
GLib.Variant('i', 0))
def link_to_mime_data():
'''Create symlink to $XDG_DATA_HOME/mime in our custom data home dir.
Mimetype detection seems to break horribly if the $XDG_DATA_HOME/mime
directory is missing. Since we have to override the normal XDG_DATA_HOME
path, we need to work around this by linking back to the real mime data.
'''
new_xdg_data_home = os.environ['XDG_DATA_HOME']
old_mime_dir = os.path.join(original_xdg_data_home, 'mime')
if os.path.exists(old_mime_dir):
new_mime_dir = os.path.join(new_xdg_data_home, 'mime')
if (not os.path.exists(new_mime_dir)
and not os.path.islink(new_mime_dir)):
os.makedirs(new_xdg_data_home, exist_ok=True)
os.symlink(
os.path.join(original_xdg_data_home, 'mime'), new_mime_dir)
def argument_parser():
class expand_path(argparse.Action):
"""Expand user- and relative-paths in filenames."""
# From https://gist.github.com/brantfaircloth/1443543
def __call__(self, parser, namespace, values, option_string=None):
setattr(namespace, self.dest, os.path.abspath(os.path.expanduser(values)))
parser = argparse.ArgumentParser(description=script_about)
parser.add_argument('--dbus-config', metavar='FILE', action=expand_path,
help="use a custom D-Bus config file to locate the "
"Tracker daemons. This can be used to run Tracker "
"from a build tree of tracker-miners.git, by "
"using the generated file ./tests/test-bus.conf")
parser.add_argument('-p', '--prefix', metavar='DIR', action=expand_path,
help="run Tracker from the given install prefix. You "
"can run the system version of Tracker by "
"specifying --prefix=/usr")
parser.add_argument('--use-session-dirs', action='store_true',
help=f"update the real Tracker index (use with care!)")
store_group = parser.add_mutually_exclusive_group()
store_group.add_argument('-s', '--store', metavar='DIR', action=expand_path,
default=default_store_location, dest='store_location',
help=f"directory to store the index (default={default_store_location})")
store_group.add_argument('--store-tmpdir', action='store_true',
help="create index in a temporary directory and "
"delete it on exit (useful for automated testing)")
index_group = parser.add_mutually_exclusive_group()
index_group.add_argument('--index-recursive-directories', nargs='+',
help="override the default locations Tracker should index")
index_group.add_argument('--index-recursive-tmpdir', action='store_true',
help="create a temporary directory and configure Tracker "
"to only index that location (useful for automated testing)")
parser.add_argument('--wait-for-miner', type=str, action='append',
help="wait for one or more daemons to start, and "
"return to idle for at least 1 second, before "
"exiting. Usually used with `tracker index` where "
"you should pass --wait-for-miner=Files and "
"--wait-for-miner=Extract")
parser.add_argument('-d', '--dbus-session-bus', metavar='ADDRESS',
help="use an existing D-Bus session bus. This can be "
"used to run commands inside an existing sandbox")
parser.add_argument('--debug-dbus', action='store_true',
help="show stdout and stderr messages from every daemon "
"running on the sandbox session bus. By default we "
"only show messages logged by Tracker daemons.")
parser.add_argument('--debug-sandbox', action='store_true',
help="show debugging info from tracker-sandbox")
parser.add_argument('command', type=str, nargs='*', help="Command to run inside the shell")
return parser
def init_logging(debug_sandbox, debug_dbus):
SANDBOX_FORMAT = "%(name)s: %(message)s"
DBUS_FORMAT = "%(message)s"
if debug_sandbox:
sandbox_log_handler = logging.StreamHandler()
sandbox_log_handler.setFormatter(logging.Formatter(SANDBOX_FORMAT))
root = logging.getLogger()
root.setLevel(logging.DEBUG)
root.addHandler(sandbox_log_handler)
else:
dbus_stderr = logging.getLogger('sandbox-session-bus.stderr')
dbus_stdout = logging.getLogger('sandbox-session-bus.stdout')
dbus_handler = logging.StreamHandler(stream=sys.stderr)
dbus_handler.setFormatter(logging.Formatter(DBUS_FORMAT))
if debug_dbus:
dbus_stderr.setLevel(logging.DEBUG)
dbus_stdout.setLevel(logging.DEBUG)
else:
dbus_stderr.setLevel(logging.INFO)
dbus_stdout.setLevel(logging.INFO)
dbus_stderr.addHandler(dbus_handler)
dbus_stdout.addHandler(dbus_handler)
class MinerStatusWatch():
"""This class provides a way to block waiting for miners to finish.
This is needed because of a deficiency in `tracker index`, see:
https://gitlab.gnome.org/GNOME/tracker/issues/122
"""
def __init__(self, sandbox, miner_name):
self.dbus_name = 'org.freedesktop.Tracker3.Miner.' + miner_name
self.object_path = '/org/freedesktop/Tracker3/Miner/' + miner_name
self._sandbox = sandbox
# Stores a list of (time, status) pairs. This is used to determine
# if the miner has been idle continuously over a time peroid.
self._status_log = collections.deque()
def _log_status(self, time, status):
self._status_log.append((time, status))
if len(self._status_log) > 100:
self._status_log.popleft()
def setup(self):
log.debug(f"Set up status watch on {self.dbus_name}")
self._proxy = Gio.DBusProxy.new_sync(
self._sandbox.get_session_bus_connection(),
Gio.DBusProxyFlags.NONE, None,
self.dbus_name, self.object_path, 'org.freedesktop.Tracker3.Miner',
None)
# FIXME: this doesn't appear to work, so we have to use polling.
#proxy.connect('g-signal', miner_signal_cb)
# This call will raise GDBus.Error:org.freedesktop.DBus.Error.ServiceUnknown
# if the miner name is invalid.
status = self._proxy.GetStatus()
self._log_status(time.time(), status)
log.debug(f"{self.dbus_name}: Current status: {status}")
def check_was_idle_for_time_period(self, period_seconds):
now = time.time()
status = self._proxy.GetStatus()
self._log_status(now, status)
log.debug(f"{self.dbus_name}: Current status: {status}")
cursor = len(self._status_log) - 1
previous_delta_from_now = 0
while True:
if cursor < 0 or self._status_log[cursor][1] != 'Idle':
if previous_delta_from_now >= period_seconds:
return True
else:
return False
previous_delta_from_now = (now - self._status_log[cursor][0])
cursor -= 1
def wait_for_miners(watches):
# We wait 1 second after "Idle" status is seen before exiting, because the
# extractor goes to/from Idle frequently.
wait_for_idle_time = 1
while True:
status = [watch.check_was_idle_for_time_period(wait_for_idle_time) for watch in watches.values()]
if all(status):
break
else:
log.debug(f"Waiting for idle.")
time.sleep(0.1)
@contextlib.contextmanager
def ignore_sigint():
handler = signal.signal(signal.SIGINT, signal.SIG_IGN)
yield
signal.signal(signal.SIGINT, handler)
def main():
locale.setlocale(locale.LC_ALL, '')
parser = argument_parser()
args = parser.parse_args()
init_logging(args.debug_sandbox, args.debug_dbus)
if args.debug_dbus and args.dbus_session_bus:
log.warn("The --debug-dbus flag has no effect when --dbus-session-bus is used")
shell = os.environ.get('SHELL', '/bin/bash')
if args.prefix is None and args.dbus_config is None:
parser.print_help()
print("\nYou must specify either --dbus-config (to run Tracker from "
"a build tree) or --prefix (to run an installed Tracker).")
sys.exit(1)
if args.prefix is not None and args.dbus_config is not None:
raise RuntimeError(
"You cannot specify --dbus-config and --prefix at the same time. "
"Note that running Tracker from the build tree implies "
"--dbus-config.")
if args.command is None and args.wait_for_miner is not None:
raise RuntimeError("--wait-for-miner cannot be used when opening an "
"interactive shell.")
use_session_dirs = False
store_location = None
store_tmpdir = None
if args.use_session_dirs:
if args.store_location != default_store_location or args.store_tmpdir:
raise RuntimeError("The --use-session-dirs flag cannot be combined "
" with --store= or --store-tmpdir")
if args.index_recursive_directories or args.index_recursive_tmpdir:
raise RuntimeError("The --use-session-dir flag cannot be combined "
" with --index-recursive-directories or "
"--index-recursive-tmpdir")
use_session_dirs = True
else:
if args.store_tmpdir:
store_location = store_tmpdir = tempfile.mkdtemp(prefix='tracker-sandbox-store')
else:
store_location = args.store_location
index_recursive_directories = None
index_recursive_tmpdir = None
if args.index_recursive_tmpdir:
# This tmpdir goes in cwd because paths under /tmp are ignored for indexing
index_recursive_tmpdir = tempfile.mkdtemp(prefix='tracker-indexed-tmpdir', dir=os.getcwd())
index_recursive_directories = [index_recursive_tmpdir]
os.environ['TRACKER_INDEXED_TMPDIR'] = index_recursive_tmpdir
else:
index_recursive_directories = args.index_recursive_directories
interactive = not (args.command)
# Set up environment variables and foo needed to get started.
sandbox = create_sandbox(store_location, args.prefix,
use_session_dirs=use_session_dirs,
dbus_config=args.dbus_config,
dbus_session_bus_address=args.dbus_session_bus,
interactive=interactive)
if not use_session_dirs:
# We only want to overwrite dconf keys if XDG_CONFIG_HOME is set to a
# a temporary directory. We don't want to upset the user's real config.
config_set(sandbox, index_recursive_directories)
link_to_mime_data()
miner_watches = {}
for miner in (args.wait_for_miner or []):
watch = MinerStatusWatch(sandbox, miner)
watch.setup()
miner_watches[miner] = watch
try:
if interactive:
if args.dbus_config:
print(f"Using Tracker daemons from build tree with D-Bus config {args.dbus_config}")
else:
print(f"Using Tracker daemons from prefix {args.prefix}")
print("Starting interactive Tracker sandbox shell... (type 'exit' to finish)")
print()
with ignore_sigint():
subprocess.run(shell)
else:
command = [shell, '-c', ' '.join(shlex.quote(c) for c in args.command)]
log.debug("Running: %s", command)
interrupted = False
try:
result = subprocess.run(command)
except KeyboardInterrupt:
interrupted = True
if len(miner_watches) > 0:
wait_for_miners(miner_watches)
if interrupted:
log.debug("Process exited due to SIGINT")
sys.exit(0)
else:
log.debug("Process finished with returncode %i", result.returncode)
sys.exit(result.returncode)
finally:
sandbox.stop()
if store_tmpdir:
shutil.rmtree(store_tmpdir, ignore_errors=True)
if index_recursive_tmpdir:
shutil.rmtree(index_recursive_tmpdir, ignore_errors=True)
# Entry point/start
if __name__ == "__main__":
try:
main()
except RuntimeError as e:
sys.stderr.write(f"ERROR: {e}\n")
sys.exit(1)
|