5 # Copyright (c) 2015, Phillip Berndt
7 # Autorandr rewrite in Python
9 # This script aims to be fully compatible with the original autorandr.
11 # This program is free software: you can redistribute it and/or modify
12 # it under the terms of the GNU General Public License as published by
13 # the Free Software Foundation, either version 3 of the License, or
14 # (at your option) any later version.
16 # This program is distributed in the hope that it will be useful,
17 # but WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 from __future__ import print_function
40 from collections import OrderedDict
41 from distutils.version import LooseVersion as Version
42 from functools import reduce
43 from itertools import chain
51 # (name, description, callback)
52 ("common", "Clone all connected outputs at the largest common resolution", None),
53 ("clone-largest", "Clone all connected outputs with the largest resolution (scaled down if necessary)", None),
54 ("horizontal", "Stack all connected outputs horizontally at their largest resolution", None),
55 ("vertical", "Stack all connected outputs vertically at their largest resolution", None),
59 Usage: autorandr [options]
61 -h, --help get this small help
62 -c, --change reload current setup
63 -s, --save <profile> save your current setup to profile <profile>
64 -r, --remove <profile> remove profile <profile>
65 -l, --load <profile> load profile <profile>
66 -d, --default <profile> make profile <profile> the default profile
67 --skip-options <option> comma separated list of xrandr arguments (e.g. "gamma")
68 to skip both in detecting changes and applying a profile
69 --force force (re)loading of a profile
70 --fingerprint fingerprint your current hardware setup
71 --config dump your current xrandr setup
72 --dry-run don't change anything, only print the xrandr commands
73 --debug enable verbose output
74 --batch run autorandr for all users with active X11 sessions
76 To prevent a profile from being loaded, place a script called "block" in its
77 directory. The script is evaluated before the screen setup is inspected, and
78 in case of it returning a value of 0 the profile is skipped. This can be used
79 to query the status of a docking station you are about to leave.
81 If no suitable profile can be identified, the current configuration is kept.
82 To change this behaviour and switch to a fallback configuration, specify
85 Another script called "postswitch" can be placed in the directory
86 ~/.config/autorandr (or ~/.autorandr if you have an old installation) as well
87 as in any profile directories: The scripts are executed after a mode switch
88 has taken place and can notify window managers.
90 The following virtual configurations are available:
94 class AutorandrException(Exception):
95 def __init__(self, message, original_exception=None, report_bug=False):
96 self.message = message
97 self.report_bug = report_bug
98 if original_exception:
99 self.original_exception = original_exception
100 trace = sys.exc_info()[2]
102 trace = trace.tb_next
103 self.line = trace.tb_lineno
104 self.file_name = trace.tb_frame.f_code.co_filename
108 frame = inspect.currentframe().f_back
109 self.line = frame.f_lineno
110 self.file_name = frame.f_code.co_filename
113 self.file_name = None
114 self.original_exception = None
116 if os.path.abspath(self.file_name) == os.path.abspath(sys.argv[0]):
117 self.file_name = None
120 retval = [self.message]
122 retval.append(" (line %d%s)" % (self.line, ("; %s" % self.file_name) if self.file_name else ""))
123 if self.original_exception:
124 retval.append(":\n ")
125 retval.append(str(self.original_exception).replace("\n", "\n "))
127 retval.append("\nThis appears to be a bug. Please help improving autorandr by reporting it upstream:"
128 "\nhttps://github.com/phillipberndt/autorandr/issues"
129 "\nPlease attach the output of `xrandr --verbose` to your bug report if appropriate.")
130 return "".join(retval)
133 class XrandrOutput(object):
134 "Represents an XRandR output"
136 # This regular expression is used to parse an output in `xrandr --verbose'
137 XRANDR_OUTPUT_REGEXP = """(?x)
138 ^(?P<output>[^ ]+)\s+ # Line starts with output name
139 (?: # Differentiate disconnected and connected in first line
141 unknown\ connection |
142 (?P<connected>connected)
145 (?P<primary>primary\ )? # Might be primary screen
147 (?P<width>[0-9]+)x(?P<height>[0-9]+) # Resolution (might be overridden below!)
148 \+(?P<x>-?[0-9]+)\+(?P<y>-?[0-9]+)\s+ # Position
149 (?:\(0x[0-9a-fA-F]+\)\s+)? # XID
150 (?P<rotate>(?:normal|left|right|inverted))\s+ # Rotation
151 (?:(?P<reflect>X\ and\ Y|X|Y)\ axis)? # Reflection
152 )? # .. but everything of the above only if the screen is in use.
153 (?:[\ \t]*\([^\)]+\))(?:\s*[0-9]+mm\sx\s[0-9]+mm)?
154 (?:[\ \t]*panning\ (?P<panning>[0-9]+x[0-9]+\+[0-9]+\+[0-9]+))? # Panning information
155 (?:[\ \t]*tracking\ (?P<tracking>[0-9]+x[0-9]+\+[0-9]+\+[0-9]+))? # Tracking information
156 (?:[\ \t]*border\ (?P<border>(?:[0-9]+/){3}[0-9]+))? # Border information
157 (?:\s*(?: # Properties of the output
158 Gamma: (?P<gamma>(?:inf|[0-9\.: e])+) | # Gamma value
159 Transform: (?P<transform>(?:[\-0-9\. ]+\s+){3}) | # Transformation matrix
160 EDID: (?P<edid>\s*?(?:\\n\\t\\t[0-9a-f]+)+) | # EDID of the output
161 (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)* # Other properties
165 (?P<mode_name>\S+).+?\*current.*\s+ # Interesting (current) resolution: Extract rate
166 h:\s+width\s+(?P<mode_width>[0-9]+).+\s+
167 v:\s+height\s+(?P<mode_height>[0-9]+).+clock\s+(?P<rate>[0-9\.]+)Hz\s* |
168 \S+(?:(?!\*current).)+\s+h:.+\s+v:.+\s* # Other resolutions
172 XRANDR_OUTPUT_MODES_REGEXP = """(?x)
173 (?P<name>\S+).+?(?P<preferred>\+preferred)?\s+
174 h:\s+width\s+(?P<width>[0-9]+).+\s+
175 v:\s+height\s+(?P<height>[0-9]+).+clock\s+(?P<rate>[0-9\.]+)Hz\s* |
178 XRANDR_13_DEFAULTS = {
179 "transform": "1,0,0,0,1,0,0,0,1",
183 XRANDR_12_DEFAULTS = {
186 "gamma": "1.0:1.0:1.0",
189 XRANDR_DEFAULTS = dict(list(XRANDR_13_DEFAULTS.items()) + list(XRANDR_12_DEFAULTS.items()))
191 EDID_UNAVAILABLE = "--CONNECTED-BUT-EDID-UNAVAILABLE-"
194 return "<%s%s %s>" % (self.output, self.short_edid, " ".join(self.option_vector))
197 def short_edid(self):
198 return ("%s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else ""
201 def options_with_defaults(self):
202 "Return the options dictionary, augmented with the default values that weren't set"
203 if "off" in self.options:
206 if xrandr_version() >= Version("1.3"):
207 options.update(self.XRANDR_13_DEFAULTS)
208 if xrandr_version() >= Version("1.2"):
209 options.update(self.XRANDR_12_DEFAULTS)
210 options.update(self.options)
211 return {a: b for a, b in options.items() if a not in self.ignored_options}
214 def filtered_options(self):
215 "Return a dictionary of options without ignored options"
216 return {a: b for a, b in self.options.items() if a not in self.ignored_options}
219 def option_vector(self):
220 "Return the command line parameters for XRandR for this instance"
221 return sum([["--%s" % option[0], option[1]] if option[1] else ["--%s" % option[0]] for option in chain((("output", self.output),), sorted(self.options_with_defaults.items()))], [])
224 def option_string(self):
225 "Return the command line parameters in the configuration file format"
226 return "\n".join([" ".join(option) if option[1] else option[0] for option in chain((("output", self.output),), sorted(self.filtered_options.items()))])
230 "Return a key to sort the outputs for xrandr invocation"
233 if "off" in self.options:
235 if "pos" in self.options:
236 x, y = map(float, self.options["pos"].split("x"))
241 def __init__(self, output, edid, options):
242 "Instanciate using output name, edid and a dictionary of XRandR command line parameters"
245 self.options = options
246 self.ignored_options = []
247 self.remove_default_option_values()
249 def set_ignored_options(self, options):
250 "Set a list of xrandr options that are never used (neither when comparing configurations nor when applying them)"
251 self.ignored_options = list(options)
253 def remove_default_option_values(self):
254 "Remove values from the options dictionary that are superflous"
255 if "off" in self.options and len(self.options.keys()) > 1:
256 self.options = {"off": None}
258 for option, default_value in self.XRANDR_DEFAULTS.items():
259 if option in self.options and self.options[option] == default_value:
260 del self.options[option]
263 def from_xrandr_output(cls, xrandr_output):
264 """Instanciate an XrandrOutput from the output of `xrandr --verbose'
266 This method also returns a list of modes supported by the output.
269 xrandr_output = xrandr_output.replace("\r\n", "\n")
270 match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
272 raise AutorandrException("Parsing XRandR output failed, there is an error in the regular expression.", report_bug=True)
274 debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
275 raise AutorandrException("Parsing XRandR output failed, the regular expression did not match: %s" % debug, report_bug=True)
276 remainder = xrandr_output[len(match_object.group(0)):]
278 raise AutorandrException(("Parsing XRandR output failed, %d bytes left unmatched after regular expression, "
279 "starting at byte %d with ..'%s'.") % (len(remainder), len(match_object.group(0)), remainder[:10]), report_bug=True)
281 match = match_object.groupdict()
285 modes = [x.groupdict() for x in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]) if x.group("name")]
287 raise AutorandrException("Parsing XRandR output failed, couldn't find any display modes", report_bug=True)
290 if not match["connected"]:
293 edid = "".join(match["edid"].strip().split()) if match["edid"] else "%s-%s" % (XrandrOutput.EDID_UNAVAILABLE, match["output"])
295 if not match["width"]:
296 options["off"] = None
298 if match["mode_name"]:
299 options["mode"] = match["mode_name"]
300 elif match["mode_width"]:
301 options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"])
303 if match["rotate"] not in ("left", "right"):
304 options["mode"] = "%sx%s" % (match["width"], match["height"])
306 options["mode"] = "%sx%s" % (match["height"], match["width"])
307 options["rotate"] = match["rotate"]
309 options["primary"] = None
310 if match["reflect"] == "X":
311 options["reflect"] = "x"
312 elif match["reflect"] == "Y":
313 options["reflect"] = "y"
314 elif match["reflect"] == "X and Y":
315 options["reflect"] = "xy"
316 options["pos"] = "%sx%s" % (match["x"], match["y"])
318 panning = [match["panning"]]
319 if match["tracking"]:
320 panning += ["/", match["tracking"]]
322 panning += ["/", match["border"]]
323 options["panning"] = "".join(panning)
324 if match["transform"]:
325 transformation = ",".join(match["transform"].strip().split())
326 if transformation != "1.000000,0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000,1.000000":
327 options["transform"] = transformation
328 if not match["mode_name"]:
329 # TODO We'd need to apply the reverse transformation here. Let's see if someone complains, I doubt that this
330 # special case is actually required.
331 print("Warning: Output %s has a transformation applied. Could not determine correct mode! Using `%s'." % (match["output"], options["mode"]), file=sys.stderr)
333 gamma = match["gamma"].strip()
334 # xrandr prints different values in --verbose than it accepts as a parameter value for --gamma
335 # Also, it is not able to work with non-standard gamma ramps. Finally, it auto-corrects 0 to 1,
336 # so we approximate by 1e-10.
337 gamma = ":".join([str(max(1e-10, round(1. / float(x), 3))) for x in gamma.split(":")])
338 options["gamma"] = gamma
340 options["rate"] = match["rate"]
342 return XrandrOutput(match["output"], edid, options), modes
345 def from_config_file(cls, edid_map, configuration):
346 "Instanciate an XrandrOutput from the contents of a configuration file"
348 for line in configuration.split("\n"):
350 line = line.split(None, 1)
351 if line and line[0].startswith("#"):
353 options[line[0]] = line[1] if len(line) > 1 else None
357 if options["output"] in edid_map:
358 edid = edid_map[options["output"]]
360 # This fuzzy matching is for legacy autorandr that used sysfs output names
361 fuzzy_edid_map = [re.sub("(card[0-9]+|-)", "", x) for x in edid_map.keys()]
362 fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"])
363 if fuzzy_output in fuzzy_edid_map:
364 edid = edid_map[list(edid_map.keys())[fuzzy_edid_map.index(fuzzy_output)]]
365 elif "off" not in options:
366 raise AutorandrException("Failed to find an EDID for output `%s' in setup file, required as `%s' is not off in config file." % (options["output"], options["output"]))
367 output = options["output"]
368 del options["output"]
370 return XrandrOutput(output, edid, options)
372 def edid_equals(self, other):
373 "Compare to another XrandrOutput's edid and on/off-state, taking legacy autorandr behaviour (md5sum'ing) into account"
374 if self.edid and other.edid:
375 if len(self.edid) == 32 and len(other.edid) != 32 and not other.edid.startswith(XrandrOutput.EDID_UNAVAILABLE):
376 return hashlib.md5(binascii.unhexlify(other.edid)).hexdigest() == self.edid
377 if len(self.edid) != 32 and len(other.edid) == 32 and not self.edid.startswith(XrandrOutput.EDID_UNAVAILABLE):
378 return hashlib.md5(binascii.unhexlify(self.edid)).hexdigest() == other.edid
379 return self.edid == other.edid
381 def __ne__(self, other):
382 return not (self == other)
384 def __eq__(self, other):
385 return self.edid_equals(other) and self.output == other.output and self.filtered_options == other.filtered_options
387 def verbose_diff(self, other):
388 "Compare to another XrandrOutput and return a list of human readable differences"
390 if not self.edid_equals(other):
391 diffs.append("EDID `%s' differs from `%s'" % (self.short_edid, other.short_edid))
392 if self.output != other.output:
393 diffs.append("Output name `%s' differs from `%s'" % (self.output, other.output))
394 if "off" in self.options and "off" not in other.options:
395 diffs.append("The output is disabled currently, but active in the new configuration")
396 elif "off" in other.options and "off" not in self.options:
397 diffs.append("The output is currently enabled, but inactive in the new configuration")
399 for name in set(chain.from_iterable((self.options.keys(), other.options.keys()))):
400 if name not in other.options:
401 diffs.append("Option --%s %sis not present in the new configuration" % (name, "(= `%s') " % self.options[name] if self.options[name] else ""))
402 elif name not in self.options:
403 diffs.append("Option --%s (`%s' in the new configuration) is not present currently" % (name, other.options[name]))
404 elif self.options[name] != other.options[name]:
405 diffs.append("Option --%s %sis `%s' in the new configuration" % (name, "(= `%s') " % self.options[name] if self.options[name] else "", other.options[name]))
409 def xrandr_version():
410 "Return the version of XRandR that this system uses"
411 if getattr(xrandr_version, "version", False) is False:
412 version_string = os.popen("xrandr -v").read()
414 version = re.search("xrandr program version\s+([0-9\.]+)", version_string).group(1)
415 xrandr_version.version = Version(version)
416 except AttributeError:
417 xrandr_version.version = Version("1.3.0")
419 return xrandr_version.version
422 def debug_regexp(pattern, string):
423 "Use the partial matching functionality of the regex module to display debug info on a non-matching regular expression"
426 bounds = (0, len(string))
427 while bounds[0] != bounds[1]:
428 half = int((bounds[0] + bounds[1]) / 2)
429 if half == bounds[0]:
431 bounds = (half, bounds[1]) if regex.search(pattern, string[:half], partial=True) else (bounds[0], half - 1)
432 partial_length = bounds[0]
433 return ("Regular expression matched until position "
434 "%d, ..'%s', and did not match from '%s'.." % (partial_length, string[max(0, partial_length - 20):partial_length],
435 string[partial_length:partial_length + 10]))
438 return "Debug information would be available if the `regex' module was installed."
441 def parse_xrandr_output():
442 "Parse the output of `xrandr --verbose' into a list of outputs"
443 xrandr_output = os.popen("xrandr -q --verbose").read()
444 if not xrandr_output:
445 raise AutorandrException("Failed to run xrandr")
447 # We are not interested in screens
448 xrandr_output = re.sub("(?m)^Screen [0-9].+", "", xrandr_output).strip()
450 # Split at output boundaries and instanciate an XrandrOutput per output
451 split_xrandr_output = re.split("(?m)^([^ ]+ (?:(?:dis)?connected|unknown connection).*)$", xrandr_output)
452 if len(split_xrandr_output) < 2:
453 raise AutorandrException("No output boundaries found", report_bug=True)
454 outputs = OrderedDict()
455 modes = OrderedDict()
456 for i in range(1, len(split_xrandr_output), 2):
457 output_name = split_xrandr_output[i].split()[0]
458 output, output_modes = XrandrOutput.from_xrandr_output("".join(split_xrandr_output[i:i + 2]))
459 outputs[output_name] = output
461 modes[output_name] = output_modes
463 return outputs, modes
466 def load_profiles(profile_path):
467 "Load the stored profiles"
470 for profile in os.listdir(profile_path):
471 config_name = os.path.join(profile_path, profile, "config")
472 setup_name = os.path.join(profile_path, profile, "setup")
473 if not os.path.isfile(config_name) or not os.path.isfile(setup_name):
476 edids = dict([x.split() for x in (y.strip() for y in open(setup_name).readlines()) if x and x[0] != "#"])
480 for line in chain(open(config_name).readlines(), ["output"]):
481 if line[:6] == "output" and buffer:
482 config[buffer[0].strip().split()[-1]] = XrandrOutput.from_config_file(edids, "".join(buffer))
487 for output_name in list(config.keys()):
488 if config[output_name].edid is None:
489 del config[output_name]
491 profiles[profile] = {"config": config, "path": os.path.join(profile_path, profile), "config-mtime": os.stat(config_name).st_mtime}
496 def get_symlinks(profile_path):
497 "Load all symlinks from a directory"
500 for link in os.listdir(profile_path):
501 file_name = os.path.join(profile_path, link)
502 if os.path.islink(file_name):
503 symlinks[link] = os.readlink(file_name)
508 def find_profiles(current_config, profiles):
509 "Find profiles matching the currently connected outputs"
510 detected_profiles = []
511 for profile_name, profile in profiles.items():
512 config = profile["config"]
514 for name, output in config.items():
517 if name not in current_config or not output.edid_equals(current_config[name]):
520 if not matches or any((name not in config.keys() for name in current_config.keys() if current_config[name].edid)):
523 detected_profiles.append(profile_name)
524 return detected_profiles
527 def profile_blocked(profile_path, meta_information=None):
528 """Check if a profile is blocked.
530 meta_information is expected to be an dictionary. It will be passed to the block scripts
531 in the environment, as variables called AUTORANDR_<CAPITALIZED_KEY_HERE>.
533 return not exec_scripts(profile_path, "block", meta_information)
536 def output_configuration(configuration, config):
537 "Write a configuration file"
538 outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
539 for output in outputs:
540 print(configuration[output].option_string, file=config)
543 def output_setup(configuration, setup):
544 "Write a setup (fingerprint) file"
545 outputs = sorted(configuration.keys())
546 for output in outputs:
547 if configuration[output].edid:
548 print(output, configuration[output].edid, file=setup)
551 def save_configuration(profile_path, configuration):
552 "Save a configuration into a profile"
553 if not os.path.isdir(profile_path):
554 os.makedirs(profile_path)
555 with open(os.path.join(profile_path, "config"), "w") as config:
556 output_configuration(configuration, config)
557 with open(os.path.join(profile_path, "setup"), "w") as setup:
558 output_setup(configuration, setup)
561 def update_mtime(filename):
562 "Update a file's mtime"
564 os.utime(filename, None)
570 def call_and_retry(*args, **kwargs):
571 """Wrapper around subprocess.call that retries failed calls.
573 This function calls subprocess.call and on non-zero exit states,
574 waits a second and then retries once. This mitigates #47,
575 a timing issue with some drivers.
577 if "dry_run" in kwargs:
578 dry_run = kwargs["dry_run"]
579 del kwargs["dry_run"]
582 kwargs_redirected = dict(kwargs)
584 if hasattr(subprocess, "DEVNULL"):
585 kwargs_redirected["stdout"] = getattr(subprocess, "DEVNULL")
587 kwargs_redirected["stdout"] = open(os.devnull, "w")
588 kwargs_redirected["stderr"] = kwargs_redirected["stdout"]
589 retval = subprocess.call(*args, **kwargs_redirected)
592 retval = subprocess.call(*args, **kwargs)
596 def apply_configuration(new_configuration, current_configuration, dry_run=False):
597 "Apply a configuration"
598 outputs = sorted(new_configuration.keys(), key=lambda x: new_configuration[x].sort_key)
600 base_argv = ["echo", "xrandr"]
602 base_argv = ["xrandr"]
604 # There are several xrandr / driver bugs we need to take care of here:
605 # - We cannot enable more than two screens at the same time
606 # See https://github.com/phillipberndt/autorandr/pull/6
607 # and commits f4cce4d and 8429886.
608 # - We cannot disable all screens
609 # See https://github.com/phillipberndt/autorandr/pull/20
610 # - We should disable screens before enabling others, because there's
611 # a limit on the number of enabled screens
612 # - We must make sure that the screen at 0x0 is activated first,
613 # or the other (first) screen to be activated would be moved there.
614 # - If an active screen already has a transformation and remains active,
615 # the xrandr call fails with an invalid RRSetScreenSize parameter error.
616 # Update the configuration in 3 passes in that case. (On Haswell graphics,
618 # - Some implementations can not handle --transform at all, so avoid it unless
619 # necessary. (See https://github.com/phillipberndt/autorandr/issues/37)
620 # - Some implementations can not handle --panning without specifying --fb
621 # explicitly, so avoid it unless necessary.
622 # (See https://github.com/phillipberndt/autorandr/issues/72)
624 auxiliary_changes_pre = []
627 remain_active_count = 0
628 for output in outputs:
629 if not new_configuration[output].edid or "off" in new_configuration[output].options:
630 disable_outputs.append(new_configuration[output].option_vector)
632 if "off" not in current_configuration[output].options:
633 remain_active_count += 1
635 option_vector = new_configuration[output].option_vector
636 if xrandr_version() >= Version("1.3.0"):
637 for option in ("transform", "panning"):
638 if option in current_configuration[output].options:
639 auxiliary_changes_pre.append(["--output", output, "--%s" % option, "none"])
642 option_index = option_vector.index("--%s" % option)
643 if option_vector[option_index + 1] == XrandrOutput.XRANDR_DEFAULTS[option]:
644 option_vector = option_vector[:option_index] + option_vector[option_index + 2:]
648 enable_outputs.append(option_vector)
650 # Perform pe-change auxiliary changes
651 if auxiliary_changes_pre:
652 argv = base_argv + list(chain.from_iterable(auxiliary_changes_pre))
653 if call_and_retry(argv, dry_run=dry_run) != 0:
654 raise AutorandrException("Command failed: %s" % " ".join(argv))
656 # Disable unused outputs, but make sure that there always is at least one active screen
657 disable_keep = 0 if remain_active_count else 1
658 if len(disable_outputs) > disable_keep:
659 if call_and_retry(base_argv + list(chain.from_iterable(disable_outputs[:-1] if disable_keep else disable_outputs)), dry_run=dry_run) != 0:
660 # Disabling the outputs failed. Retry with the next command:
661 # Sometimes disabling of outputs fails due to an invalid RRSetScreenSize.
662 # This does not occur if simultaneously the primary screen is reset.
665 disable_outputs = disable_outputs[-1:] if disable_keep else []
667 # If disable_outputs still has more than one output in it, one of the xrandr-calls below would
668 # disable the last two screens. This is a problem, so if this would happen, instead disable only
669 # one screen in the first call below.
670 if len(disable_outputs) > 0 and len(disable_outputs) % 2 == 0:
671 # In the context of a xrandr call that changes the display state, `--query' should do nothing
672 disable_outputs.insert(0, ['--query'])
674 # Enable the remaining outputs in pairs of two operations
675 operations = disable_outputs + enable_outputs
676 for index in range(0, len(operations), 2):
677 argv = base_argv + list(chain.from_iterable(operations[index:index + 2]))
678 if call_and_retry(argv, dry_run=dry_run) != 0:
679 raise AutorandrException("Command failed: %s" % " ".join(argv))
682 def is_equal_configuration(source_configuration, target_configuration):
683 "Check if all outputs from target are already configured correctly in source"
684 for output in target_configuration.keys():
685 if (output not in source_configuration) or (source_configuration[output] != target_configuration[output]):
690 def add_unused_outputs(source_configuration, target_configuration):
691 "Add outputs that are missing in target to target, in 'off' state"
692 for output_name, output in source_configuration.items():
693 if output_name not in target_configuration:
694 target_configuration[output_name] = XrandrOutput(output_name, output.edid, {"off": None})
697 def remove_irrelevant_outputs(source_configuration, target_configuration):
698 "Remove outputs from target that ought to be 'off' and already are"
699 for output_name, output in source_configuration.items():
700 if "off" in output.options and output_name in target_configuration and "off" in target_configuration[output_name].options:
701 del target_configuration[output_name]
704 def generate_virtual_profile(configuration, modes, profile_name):
705 "Generate one of the virtual profiles"
706 configuration = copy.deepcopy(configuration)
707 if profile_name == "common":
708 common_resolution = [set(((mode["width"], mode["height"]) for mode in output_modes)) for output, output_modes in modes.items() if configuration[output].edid]
709 common_resolution = reduce(lambda a, b: a & b, common_resolution[1:], common_resolution[0])
710 common_resolution = sorted(common_resolution, key=lambda a: int(a[0]) * int(a[1]))
711 if common_resolution:
712 for output in configuration:
713 configuration[output].options = {}
714 if output in modes and configuration[output].edid:
715 configuration[output].options["mode"] = [x["name"] for x in sorted(modes[output], key=lambda x: 0 if x["preferred"] else 1) if x["width"] == common_resolution[-1][0] and x["height"] == common_resolution[-1][1]][0]
716 configuration[output].options["pos"] = "0x0"
718 configuration[output].options["off"] = None
719 elif profile_name in ("horizontal", "vertical"):
721 if profile_name == "horizontal":
722 shift_index = "width"
723 pos_specifier = "%sx0"
725 shift_index = "height"
726 pos_specifier = "0x%s"
728 for output in configuration:
729 configuration[output].options = {}
730 if output in modes and configuration[output].edid:
731 mode = sorted(modes[output], key=lambda a: int(a["width"]) * int(a["height"]) + (10**6 if a["preferred"] else 0))[-1]
732 configuration[output].options["mode"] = mode["name"]
733 configuration[output].options["rate"] = mode["rate"]
734 configuration[output].options["pos"] = pos_specifier % shift
735 shift += int(mode[shift_index])
737 configuration[output].options["off"] = None
738 elif profile_name == "clone-largest":
739 biggest_resolution = sorted([output_modes[0] for output, output_modes in modes.items()], key=lambda x: int(x["width"]) * int(x["height"]), reverse=True)[0]
740 for output in configuration:
741 configuration[output].options = {}
742 if output in modes and configuration[output].edid:
743 mode = sorted(modes[output], key=lambda a: int(a["width"]) * int(a["height"]) + (10**6 if a["preferred"] else 0))[-1]
744 configuration[output].options["mode"] = mode["name"]
745 configuration[output].options["rate"] = mode["rate"]
746 configuration[output].options["pos"] = "0x0"
747 scale = max(float(biggest_resolution["width"]) / float(mode["width"]), float(biggest_resolution["height"]) / float(mode["height"]))
748 mov_x = (float(mode["width"]) * scale - float(biggest_resolution["width"])) / -2
749 mov_y = (float(mode["height"]) * scale - float(biggest_resolution["height"])) / -2
750 configuration[output].options["transform"] = "{},0,{},0,{},{},0,0,1".format(scale, mov_x, scale, mov_y)
752 configuration[output].options["off"] = None
756 def print_profile_differences(one, another):
757 "Print the differences between two profiles for debugging"
760 print("| Differences between the two profiles:", file=sys.stderr)
761 for output in set(chain.from_iterable((one.keys(), another.keys()))):
762 if output not in one:
763 if "off" not in another[output].options:
764 print("| Output `%s' is missing from the active configuration" % output, file=sys.stderr)
765 elif output not in another:
766 if "off" not in one[output].options:
767 print("| Output `%s' is missing from the new configuration" % output, file=sys.stderr)
769 for line in one[output].verbose_diff(another[output]):
770 print("| [Output %s] %s" % (output, line), file=sys.stderr)
771 print("\\-", file=sys.stderr)
775 "Print help and exit"
777 for profile in virtual_profiles:
778 name, description = profile[:2]
779 description = [description]
781 while len(description[0]) > max_width + 1:
782 left_over = description[0][max_width:]
783 description[0] = description[0][:max_width] + "-"
784 description.insert(1, " %-15s %s" % ("", left_over))
785 description = "\n".join(description)
786 print(" %-15s %s" % (name, description))
790 def exec_scripts(profile_path, script_name, meta_information=None):
793 This will run all executables from the profile folder, and global per-user
794 and system-wide configuration folders, named script_name or residing in
795 subdirectories named script_name.d.
797 If profile_path is None, only global scripts will be invoked.
799 meta_information is expected to be an dictionary. It will be passed to the block scripts
800 in the environment, as variables called AUTORANDR_<CAPITALIZED_KEY_HERE>.
802 Returns True unless any of the scripts exited with non-zero exit status.
806 env = os.environ.copy()
807 env.update({"AUTORANDR_%s" % str(key).upper(): str(value) for (key, value) in meta_information.items()})
809 env = os.environ.copy()
811 # If there are multiple candidates, the XDG spec tells to only use the first one.
814 user_profile_path = os.path.expanduser("~/.autorandr")
815 if not os.path.isdir(user_profile_path):
816 user_profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
818 candidate_directories = chain((user_profile_path,), (os.path.join(x, "autorandr") for x in os.environ.get("XDG_CONFIG_DIRS", "/etc/xdg").split(":")))
820 candidate_directories = chain((profile_path,), candidate_directories)
822 for folder in candidate_directories:
824 if script_name not in ran_scripts:
825 script = os.path.join(folder, script_name)
826 if os.access(script, os.X_OK | os.F_OK):
828 all_ok &= subprocess.call(script, env=env) != 0
830 raise AutorandrException("Failed to execute user command: %s" % (script,))
831 ran_scripts.add(script_name)
833 script_folder = os.path.join(folder, "%s.d" % script_name)
834 if os.access(script_folder, os.R_OK | os.X_OK) and os.path.isdir(script_folder):
835 for file_name in os.listdir(script_folder):
836 check_name = "d/%s" % (file_name,)
837 if check_name not in ran_scripts:
838 script = os.path.join(script_folder, file_name)
839 if os.access(script, os.X_OK | os.F_OK):
841 all_ok &= subprocess.call(script, env=env) != 0
843 raise AutorandrException("Failed to execute user command: %s" % (script,))
844 ran_scripts.add(check_name)
849 def dispatch_call_to_sessions(argv):
850 """Invoke autorandr for each open local X11 session with the given options.
852 The function iterates over all processes not owned by root and checks
853 whether they have DISPLAY and XAUTHORITY variables set. It strips the
854 screen from any variable it finds (i.e. :0.0 becomes :0) and checks whether
855 this display has been handled already. If it has not, it forks, changes
856 uid/gid to the user owning the process, reuses the process's environment
857 and runs autorandr with the parameters from argv.
859 This function requires root permissions. It only works for X11 servers that
860 have at least one non-root process running. It is susceptible for attacks
861 where one user runs a process with another user's DISPLAY variable - in
862 this case, it might happen that autorandr is invoked for the other user,
863 which won't work. Since no other harm than prevention of automated
864 execution of autorandr can be done this way, the assumption is that in this
865 situation, the local administrator will handle the situation."""
867 X11_displays_done = set()
869 autorandr_binary = os.path.abspath(argv[0])
870 backup_candidates = {}
872 def fork_child_autorandr(pwent, process_environ):
873 print("Running autorandr as %s for display %s" % (pwent.pw_name, process_environ["DISPLAY"]))
874 child_pid = os.fork()
876 # This will throw an exception if any of the privilege changes fails,
877 # so it should be safe. Also, note that since the environment
878 # is taken from a process owned by the user, reusing it should
879 # not leak any information.
881 os.setresgid(pwent.pw_gid, pwent.pw_gid, pwent.pw_gid)
882 os.setresuid(pwent.pw_uid, pwent.pw_uid, pwent.pw_uid)
883 os.chdir(pwent.pw_dir)
885 os.environ.update(process_environ)
886 os.execl(autorandr_binary, autorandr_binary, *argv[1:])
888 os.waitpid(child_pid, 0)
890 for directory in os.listdir("/proc"):
891 directory = os.path.join("/proc/", directory)
892 if not os.path.isdir(directory):
894 environ_file = os.path.join(directory, "environ")
895 if not os.path.isfile(environ_file):
897 uid = os.stat(environ_file).st_uid
899 # The following line assumes that user accounts start at 1000 and that
900 # no one works using the root or another system account. This is rather
901 # restrictive, but de facto default. Alternatives would be to use the
902 # UID_MIN from /etc/login.defs or FIRST_UID from /etc/adduser.conf;
903 # but effectively, both values aren't binding in any way.
904 # If this breaks your use case, please file a bug on Github.
909 for environ_entry in open(environ_file).read().split("\0"):
910 if "=" in environ_entry:
911 name, value = environ_entry.split("=", 1)
912 if name == "DISPLAY" and "." in value:
913 value = value[:value.find(".")]
914 process_environ[name] = value
916 if "DISPLAY" not in process_environ:
917 # Cannot work with this environment, skip.
920 # To allow scripts to detect batch invocation (especially useful for predetect)
921 process_environ["AUTORANDR_BATCH_PID"] = str(os.getpid())
922 process_environ["UID"] = str(uid)
924 display = process_environ["DISPLAY"]
926 if "XAUTHORITY" not in process_environ:
927 # It's very likely that we cannot work with this environment either,
928 # but keep it as a backup just in case we don't find anything else.
929 backup_candidates[display] = process_environ
932 if display not in X11_displays_done:
934 pwent = pwd.getpwuid(uid)
936 # User has no pwd entry
939 fork_child_autorandr(pwent, process_environ)
940 X11_displays_done.add(display)
942 # Run autorandr for any users/displays which didn't have a process with
944 for display, process_environ in backup_candidates.items():
945 if display not in X11_displays_done:
947 pwent = pwd.getpwuid(int(process_environ["UID"]))
949 # User has no pwd entry
952 fork_child_autorandr(pwent, process_environ)
953 X11_displays_done.add(display)
958 opts, args = getopt.getopt(argv[1:], "s:r:l:d:cfh", ["batch", "dry-run", "change", "default=", "save=", "remove=", "load=", "force", "fingerprint", "config", "debug", "skip-options=", "help"])
959 except getopt.GetoptError as e:
960 print("Failed to parse options: {0}.\n"
961 "Use --help to get usage information.".format(str(e)),
963 sys.exit(posix.EX_USAGE)
967 if "-h" in options or "--help" in options:
971 if "--batch" in options:
972 if ("DISPLAY" not in os.environ or not os.environ["DISPLAY"]) and os.getuid() == 0:
973 dispatch_call_to_sessions([x for x in argv if x != "--batch"])
975 print("--batch mode can only be used by root and if $DISPLAY is unset")
977 if "AUTORANDR_BATCH_PID" in os.environ:
978 user = pwd.getpwuid(os.getuid())
979 user = user.pw_name if user else "#%d" % os.getuid()
980 print("autorandr running as user %s (started from batch instance)" % user)
983 profile_symlinks = {}
985 # Load profiles from each XDG config directory
986 # The XDG spec says that earlier entries should take precedence, so reverse the order
987 for directory in reversed(os.environ.get("XDG_CONFIG_DIRS", "/etc/xdg").split(":")):
988 system_profile_path = os.path.join(directory, "autorandr")
989 if os.path.isdir(system_profile_path):
990 profiles.update(load_profiles(system_profile_path))
991 profile_symlinks.update(get_symlinks(system_profile_path))
992 # For the user's profiles, prefer the legacy ~/.autorandr if it already exists
993 # profile_path is also used later on to store configurations
994 profile_path = os.path.expanduser("~/.autorandr")
995 if not os.path.isdir(profile_path):
996 # Elsewise, follow the XDG specification
997 profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
998 if os.path.isdir(profile_path):
999 profiles.update(load_profiles(profile_path))
1000 profile_symlinks.update(get_symlinks(profile_path))
1001 # Sort by descending mtime
1002 profiles = OrderedDict(sorted(profiles.items(), key=lambda x: -x[1]["config-mtime"]))
1003 except Exception as e:
1004 raise AutorandrException("Failed to load profiles", e)
1006 profile_symlinks = {k: v for k, v in profile_symlinks.items() if v in (x[0] for x in virtual_profiles) or v in profiles}
1008 exec_scripts(None, "predetect")
1009 config, modes = parse_xrandr_output()
1011 if "--fingerprint" in options:
1012 output_setup(config, sys.stdout)
1015 if "--config" in options:
1016 output_configuration(config, sys.stdout)
1019 if "--skip-options" in options:
1020 skip_options = [y[2:] if y[:2] == "--" else y for y in (x.strip() for x in options["--skip-options"].split(","))]
1021 for profile in profiles.values():
1022 for output in profile["config"].values():
1023 output.set_ignored_options(skip_options)
1024 for output in config.values():
1025 output.set_ignored_options(skip_options)
1028 options["--save"] = options["-s"]
1029 if "--save" in options:
1030 if options["--save"] in (x[0] for x in virtual_profiles):
1031 raise AutorandrException("Cannot save current configuration as profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--save"])
1033 profile_folder = os.path.join(profile_path, options["--save"])
1034 save_configuration(profile_folder, config)
1035 exec_scripts(profile_folder, "postsave", {"CURRENT_PROFILE": options["--save"], "PROFILE_FOLDER": profile_folder})
1036 except Exception as e:
1037 raise AutorandrException("Failed to save current configuration as profile '%s'" % (options["--save"],), e)
1038 print("Saved current configuration as profile '%s'" % options["--save"])
1042 options["--remove"] = options["-r"]
1043 if "--remove" in options:
1044 if options["--remove"] in (x[0] for x in virtual_profiles):
1045 raise AutorandrException("Cannot remove profile '%s':\nThis configuration name is a reserved virtual configuration." % options["--remove"])
1046 if options["--remove"] not in profiles.keys():
1047 raise AutorandrException("Cannot remove profile '%s':\nThis profile does not exist." % options["--remove"])
1050 profile_folder = os.path.join(profile_path, options["--remove"])
1051 profile_dirlist = os.listdir(profile_folder)
1052 profile_dirlist.remove("config")
1053 profile_dirlist.remove("setup")
1055 print("Profile folder '%s' contains the following additional files:\n---\n%s\n---" % (options["--remove"], "\n".join(profile_dirlist)))
1056 response = input("Do you really want to remove profile '%s'? If so, type 'yes': " % options["--remove"]).strip()
1057 if response != "yes":
1060 shutil.rmtree(profile_folder)
1061 print("Removed profile '%s'" % options["--remove"])
1063 print("Profile '%s' was not removed" % options["--remove"])
1064 except Exception as e:
1065 raise AutorandrException("Failed to remove profile '%s'" % (options["--remove"],), e)
1068 detected_profiles = find_profiles(config, profiles)
1069 load_profile = False
1072 options["--load"] = options["-l"]
1073 if "--load" in options:
1074 load_profile = options["--load"]
1076 # Find the active profile(s) first, for the block script (See #42)
1077 current_profiles = []
1078 for profile_name in profiles.keys():
1079 configs_are_equal = is_equal_configuration(config, profiles[profile_name]["config"])
1080 if configs_are_equal:
1081 current_profiles.append(profile_name)
1082 block_script_metadata = {
1083 "CURRENT_PROFILE": "".join(current_profiles[:1]),
1084 "CURRENT_PROFILES": ":".join(current_profiles)
1087 for profile_name in profiles.keys():
1088 if profile_blocked(os.path.join(profile_path, profile_name), block_script_metadata):
1089 print("%s (blocked)" % profile_name, file=sys.stderr)
1092 if profile_name in detected_profiles:
1093 props.append("(detected)")
1094 if ("-c" in options or "--change" in options) and not load_profile:
1095 load_profile = profile_name
1096 if profile_name in current_profiles:
1097 props.append("(current)")
1098 print("%s%s%s" % (profile_name, " " if props else "", " ".join(props)), file=sys.stderr)
1099 if not configs_are_equal and "--debug" in options and profile_name in detected_profiles:
1100 print_profile_differences(config, profiles[profile_name]["config"])
1103 options["--default"] = options["-d"]
1104 if not load_profile and "--default" in options:
1105 load_profile = options["--default"]
1108 if load_profile in profile_symlinks:
1109 if "--debug" in options:
1110 print("'%s' symlinked to '%s'" % (load_profile, profile_symlinks[load_profile]))
1111 load_profile = profile_symlinks[load_profile]
1113 if load_profile in (x[0] for x in virtual_profiles):
1114 load_config = generate_virtual_profile(config, modes, load_profile)
1115 scripts_path = os.path.join(profile_path, load_profile)
1118 profile = profiles[load_profile]
1119 load_config = profile["config"]
1120 scripts_path = profile["path"]
1122 raise AutorandrException("Failed to load profile '%s': Profile not found" % load_profile)
1123 if load_profile in detected_profiles and detected_profiles[0] != load_profile:
1124 update_mtime(os.path.join(scripts_path, "config"))
1125 add_unused_outputs(config, load_config)
1126 if load_config == dict(config) and "-f" not in options and "--force" not in options:
1127 print("Config already loaded", file=sys.stderr)
1129 if "--debug" in options and load_config != dict(config):
1130 print("Loading profile '%s'" % load_profile)
1131 print_profile_differences(config, load_config)
1133 remove_irrelevant_outputs(config, load_config)
1136 if "--dry-run" in options:
1137 apply_configuration(load_config, config, True)
1140 "CURRENT_PROFILE": load_profile,
1141 "PROFILE_FOLDER": scripts_path,
1143 exec_scripts(scripts_path, "preswitch", script_metadata)
1144 if "--debug" in options:
1145 print("Going to run:")
1146 apply_configuration(load_config, config, True)
1147 apply_configuration(load_config, config, False)
1148 exec_scripts(scripts_path, "postswitch", script_metadata)
1149 except AutorandrException as e:
1150 raise AutorandrException("Failed to apply profile '%s'" % load_profile, e, e.report_bug)
1151 except Exception as e:
1152 raise AutorandrException("Failed to apply profile '%s'" % load_profile, e, True)
1154 if "--dry-run" not in options and "--debug" in options:
1155 new_config, _ = parse_xrandr_output()
1156 if not is_equal_configuration(new_config, load_config):
1157 print("The configuration change did not go as expected:")
1158 print_profile_differences(new_config, load_config)
1163 def exception_handled_main(argv=sys.argv):
1166 except AutorandrException as e:
1167 print(e, file=sys.stderr)
1169 except Exception as e:
1170 if not len(str(e)): # BdbQuit
1171 print("Exception: {0}".format(e.__class__.__name__))
1174 print("Unhandled exception ({0}). Please report this as a bug at https://github.com/phillipberndt/autorandr/issues.".format(e), file=sys.stderr)
1178 if __name__ == '__main__':
1179 exception_handled_main()