autorandr.py

   1 #!/usr/bin/env python
   2 # encoding: utf-8
   3 #
   4 # autorandr.py
   5 # Copyright (c) 2015, Phillip Berndt
   6 #
   7 # Autorandr rewrite in Python
   8 #
   9 # This script aims to be fully compatible with the original autorandr.
  10 #
  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.
  15 #
  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.
  20 #
  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/>.
  23 #
  24
  25 from __future__ import print_function
  26
  27 import binascii
  28 import copy
  29 import fnmatch
  30 import getopt
  31 import hashlib
  32 import os
  33 import posix
  34 import pwd
  35 import re
  36 import subprocess
  37 import sys
  38 import shutil
  39 import time
  40
  41 from collections import OrderedDict
  42 from distutils.version import LooseVersion as Version
  43 from functools import reduce
  44 from itertools import chain
  45
  46 if sys.version_info.major == 2:
  47     import ConfigParser as configparser
  48 else:
  49     import configparser
  50
  51 __version__ = "1.5"
  52
  53 try:
  54     input = raw_input
  55 except NameError:
  56     pass
  57
  58 virtual_profiles = [
  59     # (name, description, callback)
  60     ("off", "Disable all outputs", None),
  61     ("common", "Clone all connected outputs at the largest common resolution", None),
  62     ("clone-largest", "Clone all connected outputs with the largest resolution (scaled down if necessary)", None),
  63     ("horizontal", "Stack all connected outputs horizontally at their largest resolution", None),
  64     ("vertical", "Stack all connected outputs vertically at their largest resolution", None),
  65 ]
  66
  67 help_text = """
  68 Usage: autorandr [options]
  69
  70 -h, --help              get this small help
  71 -c, --change            automatically load the first detected profile
  72 -d, --default <profile> make profile <profile> the default profile
  73 -l, --load <profile>    load profile <profile>
  74 -s, --save <profile>    save your current setup to profile <profile>
  75 -r, --remove <profile>  remove profile <profile>
  76 --batch                 run autorandr for all users with active X11 sessions
  77 --current               only list current (active) configuration(s)
  78 --config                dump your current xrandr setup
  79 --debug                 enable verbose output
  80 --detected              only list detected (available) configuration(s)
  81 --dry-run               don't change anything, only print the xrandr commands
  82 --fingerprint           fingerprint your current hardware setup
  83 --force                 force (re)loading of a profile
  84 --skip-options <option> comma separated list of xrandr arguments (e.g. "gamma")
  85                         to skip both in detecting changes and applying a profile
  86 --version               show version information and exit
  87
  88  If no suitable profile can be identified, the current configuration is kept.
  89  To change this behaviour and switch to a fallback configuration, specify
  90  --default <profile>.
  91
  92  autorandr supports a set of per-profile and global hooks. See the documentation
  93  for details.
  94
  95  The following virtual configurations are available:
  96 """.strip()
  97
  98
  99 class AutorandrException(Exception):
 100     def __init__(self, message, original_exception=None, report_bug=False):
 101         self.message = message
 102         self.report_bug = report_bug
 103         if original_exception:
 104             self.original_exception = original_exception
 105             trace = sys.exc_info()[2]
 106             while trace.tb_next:
 107                 trace = trace.tb_next
 108             self.line = trace.tb_lineno
 109             self.file_name = trace.tb_frame.f_code.co_filename
 110         else:
 111             try:
 112                 import inspect
 113                 frame = inspect.currentframe().f_back
 114                 self.line = frame.f_lineno
 115                 self.file_name = frame.f_code.co_filename
 116             except:
 117                 self.line = None
 118                 self.file_name = None
 119             self.original_exception = None
 120
 121         if os.path.abspath(self.file_name) == os.path.abspath(sys.argv[0]):
 122             self.file_name = None
 123
 124     def __str__(self):
 125         retval = [self.message]
 126         if self.line:
 127             retval.append(" (line %d%s)" % (self.line, ("; %s" % self.file_name) if self.file_name else ""))
 128         if self.original_exception:
 129             retval.append(":\n  ")
 130             retval.append(str(self.original_exception).replace("\n", "\n  "))
 131         if self.report_bug:
 132             retval.append("\nThis appears to be a bug. Please help improving autorandr by reporting it upstream:"
 133                           "\nhttps://github.com/phillipberndt/autorandr/issues"
 134                           "\nPlease attach the output of `xrandr --verbose` to your bug report if appropriate.")
 135         return "".join(retval)
 136
 137
 138 class XrandrOutput(object):
 139     "Represents an XRandR output"
 140
 141     # This regular expression is used to parse an output in `xrandr --verbose'
 142     XRANDR_OUTPUT_REGEXP = """(?x)
 143         ^(?P<output>[^ ]+)\s+                                                           # Line starts with output name
 144         (?:                                                                             # Differentiate disconnected and connected
 145             disconnected |                                                              # in first line
 146             unknown\ connection |
 147             (?P<connected>connected)
 148         )
 149         \s*
 150         (?P<primary>primary\ )?                                                         # Might be primary screen
 151         (?:\s*
 152             (?P<width>[0-9]+)x(?P<height>[0-9]+)                                        # Resolution (might be overridden below!)
 153             \+(?P<x>-?[0-9]+)\+(?P<y>-?[0-9]+)\s+                                       # Position
 154             (?:\(0x[0-9a-fA-F]+\)\s+)?                                                  # XID
 155             (?P<rotate>(?:normal|left|right|inverted))\s+                               # Rotation
 156             (?:(?P<reflect>X\ and\ Y|X|Y)\ axis)?                                       # Reflection
 157         )?                                                                              # .. but only if the screen is in use.
 158         (?:[\ \t]*\([^\)]+\))(?:\s*[0-9]+mm\sx\s[0-9]+mm)?
 159         (?:[\ \t]*panning\ (?P<panning>[0-9]+x[0-9]+\+[0-9]+\+[0-9]+))?                 # Panning information
 160         (?:[\ \t]*tracking\ (?P<tracking>[0-9]+x[0-9]+\+[0-9]+\+[0-9]+))?               # Tracking information
 161         (?:[\ \t]*border\ (?P<border>(?:[0-9]+/){3}[0-9]+))?                            # Border information
 162         (?:\s*(?:                                                                       # Properties of the output
 163             Gamma: (?P<gamma>(?:inf|[0-9\.: e])+) |                                     # Gamma value
 164             Transform: (?P<transform>(?:[\-0-9\. ]+\s+){3}) |                           # Transformation matrix
 165             EDID: (?P<edid>\s*?(?:\\n\\t\\t[0-9a-f]+)+) |                               # EDID of the output
 166             (?![0-9])[^:\s][^:\n]+:.*(?:\s\\t[\\t ].+)*                                 # Other properties
 167         ))+
 168         \s*
 169         (?P<modes>(?:
 170             (?P<mode_name>\S+).+?\*current.*\s+                                         # Interesting (current) resolution:
 171              h:\s+width\s+(?P<mode_width>[0-9]+).+\s+                                   # Extract rate
 172              v:\s+height\s+(?P<mode_height>[0-9]+).+clock\s+(?P<rate>[0-9\.]+)Hz\s* |
 173             \S+(?:(?!\*current).)+\s+h:.+\s+v:.+\s*                                     # Other resolutions
 174         )*)
 175     """
 176
 177     XRANDR_OUTPUT_MODES_REGEXP = """(?x)
 178         (?P<name>\S+).+?(?P<preferred>\+preferred)?\s+
 179          h:\s+width\s+(?P<width>[0-9]+).+\s+
 180          v:\s+height\s+(?P<height>[0-9]+).+clock\s+(?P<rate>[0-9\.]+)Hz\s* |
 181     """
 182
 183     XRANDR_13_DEFAULTS = {
 184         "transform": "1,0,0,0,1,0,0,0,1",
 185         "panning": "0x0",
 186     }
 187
 188     XRANDR_12_DEFAULTS = {
 189         "reflect": "normal",
 190         "rotate": "normal",
 191         "gamma": "1.0:1.0:1.0",
 192     }
 193
 194     XRANDR_DEFAULTS = dict(list(XRANDR_13_DEFAULTS.items()) + list(XRANDR_12_DEFAULTS.items()))
 195
 196     EDID_UNAVAILABLE = "--CONNECTED-BUT-EDID-UNAVAILABLE-"
 197
 198     def __repr__(self):
 199         return "<%s%s %s>" % (self.output, self.short_edid, " ".join(self.option_vector))
 200
 201     @property
 202     def short_edid(self):
 203         return ("%s..%s" % (self.edid[:5], self.edid[-5:])) if self.edid else ""
 204
 205     @property
 206     def options_with_defaults(self):
 207         "Return the options dictionary, augmented with the default values that weren't set"
 208         if "off" in self.options:
 209             return self.options
 210         options = {}
 211         if xrandr_version() >= Version("1.3"):
 212             options.update(self.XRANDR_13_DEFAULTS)
 213         if xrandr_version() >= Version("1.2"):
 214             options.update(self.XRANDR_12_DEFAULTS)
 215         options.update(self.options)
 216         return {a: b for a, b in options.items() if a not in self.ignored_options}
 217
 218     @property
 219     def filtered_options(self):
 220         "Return a dictionary of options without ignored options"
 221         return {a: b for a, b in self.options.items() if a not in self.ignored_options}
 222
 223     @property
 224     def option_vector(self):
 225         "Return the command line parameters for XRandR for this instance"
 226         args = ["--output", self.output]
 227         for option, arg in sorted(self.options_with_defaults.items()):
 228             args.append("--%s" % option)
 229             if arg:
 230                 args.append(arg)
 231         return args
 232
 233     @property
 234     def option_string(self):
 235         "Return the command line parameters in the configuration file format"
 236         options = ["output %s" % self.output]
 237         for option, arg in sorted(self.filtered_options.items()):
 238             if arg:
 239                 options.append("%s %s" % (option, arg))
 240             else:
 241                 options.append(option)
 242         return "\n".join(options)
 243
 244     @property
 245     def sort_key(self):
 246         "Return a key to sort the outputs for xrandr invocation"
 247         if not self.edid:
 248             return -2
 249         if "off" in self.options:
 250             return -1
 251         if "pos" in self.options:
 252             x, y = map(float, self.options["pos"].split("x"))
 253         else:
 254             x, y = 0, 0
 255         return x + 10000 * y
 256
 257     def __init__(self, output, edid, options):
 258         "Instanciate using output name, edid and a dictionary of XRandR command line parameters"
 259         self.output = output
 260         self.edid = edid
 261         self.options = options
 262         self.ignored_options = []
 263         self.remove_default_option_values()
 264
 265     def set_ignored_options(self, options):
 266         "Set a list of xrandr options that are never used (neither when comparing configurations nor when applying them)"
 267         self.ignored_options = list(options)
 268
 269     def remove_default_option_values(self):
 270         "Remove values from the options dictionary that are superflous"
 271         if "off" in self.options and len(self.options.keys()) > 1:
 272             self.options = {"off": None}
 273             return
 274         for option, default_value in self.XRANDR_DEFAULTS.items():
 275             if option in self.options and self.options[option] == default_value:
 276                 del self.options[option]
 277
 278     @classmethod
 279     def from_xrandr_output(cls, xrandr_output):
 280         """Instanciate an XrandrOutput from the output of `xrandr --verbose'
 281
 282         This method also returns a list of modes supported by the output.
 283         """
 284         try:
 285             xrandr_output = xrandr_output.replace("\r\n", "\n")
 286             match_object = re.search(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
 287         except:
 288             raise AutorandrException("Parsing XRandR output failed, there is an error in the regular expression.",
 289                                      report_bug=True)
 290         if not match_object:
 291             debug = debug_regexp(XrandrOutput.XRANDR_OUTPUT_REGEXP, xrandr_output)
 292             raise AutorandrException("Parsing XRandR output failed, the regular expression did not match: %s" % debug,
 293                                      report_bug=True)
 294         remainder = xrandr_output[len(match_object.group(0)):]
 295         if remainder:
 296             raise AutorandrException("Parsing XRandR output failed, %d bytes left unmatched after "
 297                                      "regular expression, starting at byte %d with ..'%s'." %
 298                                      (len(remainder), len(match_object.group(0)), remainder[:10]),
 299                                      report_bug=True)
 300
 301         match = match_object.groupdict()
 302
 303         modes = []
 304         if match["modes"]:
 305             modes = []
 306             for mode_match in re.finditer(XrandrOutput.XRANDR_OUTPUT_MODES_REGEXP, match["modes"]):
 307                 if mode_match.group("name"):
 308                     modes.append(mode_match.groupdict())
 309             if not modes:
 310                 raise AutorandrException("Parsing XRandR output failed, couldn't find any display modes", report_bug=True)
 311
 312         options = {}
 313         if not match["connected"]:
 314             edid = None
 315         elif match["edid"]:
 316             edid = "".join(match["edid"].strip().split())
 317         else:
 318             edid = "%s-%s" % (XrandrOutput.EDID_UNAVAILABLE, match["output"])
 319
 320         if not match["width"]:
 321             options["off"] = None
 322         else:
 323             if match["mode_name"]:
 324                 options["mode"] = match["mode_name"]
 325             elif match["mode_width"]:
 326                 options["mode"] = "%sx%s" % (match["mode_width"], match["mode_height"])
 327             else:
 328                 if match["rotate"] not in ("left", "right"):
 329                     options["mode"] = "%sx%s" % (match["width"], match["height"])
 330                 else:
 331                     options["mode"] = "%sx%s" % (match["height"], match["width"])
 332             options["rotate"] = match["rotate"]
 333             if match["primary"]:
 334                 options["primary"] = None
 335             if match["reflect"] == "X":
 336                 options["reflect"] = "x"
 337             elif match["reflect"] == "Y":
 338                 options["reflect"] = "y"
 339             elif match["reflect"] == "X and Y":
 340                 options["reflect"] = "xy"
 341             options["pos"] = "%sx%s" % (match["x"], match["y"])
 342             if match["panning"]:
 343                 panning = [match["panning"]]
 344                 if match["tracking"]:
 345                     panning += ["/", match["tracking"]]
 346                     if match["border"]:
 347                         panning += ["/", match["border"]]
 348                 options["panning"] = "".join(panning)
 349             if match["transform"]:
 350                 transformation = ",".join(match["transform"].strip().split())
 351                 if transformation != "1.000000,0.000000,0.000000,0.000000,1.000000,0.000000,0.000000,0.000000,1.000000":
 352                     options["transform"] = transformation
 353                     if not match["mode_name"]:
 354                         # TODO We'd need to apply the reverse transformation here. Let's see if someone complains,
 355                         # I doubt that this special case is actually required.
 356                         print("Warning: Output %s has a transformation applied. Could not determine correct mode! "
 357                               "Using `%s'." % (match["output"], options["mode"]), file=sys.stderr)
 358             if match["gamma"]:
 359                 gamma = match["gamma"].strip()
 360                 # xrandr prints different values in --verbose than it accepts as a parameter value for --gamma
 361                 # Also, it is not able to work with non-standard gamma ramps. Finally, it auto-corrects 0 to 1,
 362                 # so we approximate by 1e-10.
 363                 gamma = ":".join([str(max(1e-10, round(1. / float(x), 3))) for x in gamma.split(":")])
 364                 options["gamma"] = gamma
 365             if match["rate"]:
 366                 options["rate"] = match["rate"]
 367
 368         return XrandrOutput(match["output"], edid, options), modes
 369
 370     @classmethod
 371     def from_config_file(cls, edid_map, configuration):
 372         "Instanciate an XrandrOutput from the contents of a configuration file"
 373         options = {}
 374         for line in configuration.split("\n"):
 375             if line:
 376                 line = line.split(None, 1)
 377                 if line and line[0].startswith("#"):
 378                     continue
 379                 options[line[0]] = line[1] if len(line) > 1 else None
 380
 381         edid = None
 382
 383         if options["output"] in edid_map:
 384             edid = edid_map[options["output"]]
 385         else:
 386             # This fuzzy matching is for legacy autorandr that used sysfs output names
 387             fuzzy_edid_map = [re.sub("(card[0-9]+|-)", "", x) for x in edid_map.keys()]
 388             fuzzy_output = re.sub("(card[0-9]+|-)", "", options["output"])
 389             if fuzzy_output in fuzzy_edid_map:
 390                 edid = edid_map[list(edid_map.keys())[fuzzy_edid_map.index(fuzzy_output)]]
 391             elif "off" not in options:
 392                 raise AutorandrException("Failed to find an EDID for output `%s' in setup file, required as `%s' "
 393                                          "is not off in config file." % (options["output"], options["output"]))
 394         output = options["output"]
 395         del options["output"]
 396
 397         return XrandrOutput(output, edid, options)
 398
 399     def edid_equals(self, other):
 400         "Compare to another XrandrOutput's edid and on/off-state, taking legacy autorandr behaviour (md5sum'ing) into account"
 401         if self.edid and other.edid:
 402             if len(self.edid) == 32 and len(other.edid) != 32 and not other.edid.startswith(XrandrOutput.EDID_UNAVAILABLE):
 403                 return hashlib.md5(binascii.unhexlify(other.edid)).hexdigest() == self.edid
 404             if len(self.edid) != 32 and len(other.edid) == 32 and not self.edid.startswith(XrandrOutput.EDID_UNAVAILABLE):
 405                 return hashlib.md5(binascii.unhexlify(self.edid)).hexdigest() == other.edid
 406             if "*" in self.edid:
 407                 return fnmatch.fnmatch(other.edid, self.edid)
 408             elif "*" in other.edid:
 409                 return fnmatch.fnmatch(self.edid, other.edid)
 410         return self.edid == other.edid
 411
 412     def __ne__(self, other):
 413         return not (self == other)
 414
 415     def __eq__(self, other):
 416         return self.edid_equals(other) and self.output == other.output and self.filtered_options == other.filtered_options
 417
 418     def verbose_diff(self, other):
 419         "Compare to another XrandrOutput and return a list of human readable differences"
 420         diffs = []
 421         if not self.edid_equals(other):
 422             diffs.append("EDID `%s' differs from `%s'" % (self.short_edid, other.short_edid))
 423         if self.output != other.output:
 424             diffs.append("Output name `%s' differs from `%s'" % (self.output, other.output))
 425         if "off" in self.options and "off" not in other.options:
 426             diffs.append("The output is disabled currently, but active in the new configuration")
 427         elif "off" in other.options and "off" not in self.options:
 428             diffs.append("The output is currently enabled, but inactive in the new configuration")
 429         else:
 430             for name in set(chain.from_iterable((self.options.keys(), other.options.keys()))):
 431                 if name not in other.options:
 432                     diffs.append("Option --%s %sis not present in the new configuration" %
 433                                  (name, "(= `%s') " % self.options[name] if self.options[name] else ""))
 434                 elif name not in self.options:
 435                     diffs.append("Option --%s (`%s' in the new configuration) is not present currently" %
 436                                  (name, other.options[name]))
 437                 elif self.options[name] != other.options[name]:
 438                     diffs.append("Option --%s %sis `%s' in the new configuration" %
 439                                  (name, "(= `%s') " % self.options[name] if self.options[name] else "", other.options[name]))
 440         return diffs
 441
 442
 443 def xrandr_version():
 444     "Return the version of XRandR that this system uses"
 445     if getattr(xrandr_version, "version", False) is False:
 446         version_string = os.popen("xrandr -v").read()
 447         try:
 448             version = re.search("xrandr program version\s+([0-9\.]+)", version_string).group(1)
 449             xrandr_version.version = Version(version)
 450         except AttributeError:
 451             xrandr_version.version = Version("1.3.0")
 452
 453     return xrandr_version.version
 454
 455
 456 def debug_regexp(pattern, string):
 457     "Use the partial matching functionality of the regex module to display debug info on a non-matching regular expression"
 458     try:
 459         import regex
 460         bounds = (0, len(string))
 461         while bounds[0] != bounds[1]:
 462             half = int((bounds[0] + bounds[1]) / 2)
 463             if half == bounds[0]:
 464                 break
 465             bounds = (half, bounds[1]) if regex.search(pattern, string[:half], partial=True) else (bounds[0], half - 1)
 466         partial_length = bounds[0]
 467         return ("Regular expression matched until position %d, ..'%s', and did not match from '%s'.." %
 468                 (partial_length, string[max(0, partial_length - 20):partial_length],
 469                  string[partial_length:partial_length + 10]))
 470     except ImportError:
 471         pass
 472     return "Debug information would be available if the `regex' module was installed."
 473
 474
 475 def parse_xrandr_output():
 476     "Parse the output of `xrandr --verbose' into a list of outputs"
 477     xrandr_output = os.popen("xrandr -q --verbose").read()
 478     if not xrandr_output:
 479         raise AutorandrException("Failed to run xrandr")
 480
 481     # We are not interested in screens
 482     xrandr_output = re.sub("(?m)^Screen [0-9].+", "", xrandr_output).strip()
 483
 484     # Split at output boundaries and instanciate an XrandrOutput per output
 485     split_xrandr_output = re.split("(?m)^([^ ]+ (?:(?:dis)?connected|unknown connection).*)$", xrandr_output)
 486     if len(split_xrandr_output) < 2:
 487         raise AutorandrException("No output boundaries found", report_bug=True)
 488     outputs = OrderedDict()
 489     modes = OrderedDict()
 490     for i in range(1, len(split_xrandr_output), 2):
 491         output_name = split_xrandr_output[i].split()[0]
 492         output, output_modes = XrandrOutput.from_xrandr_output("".join(split_xrandr_output[i:i + 2]))
 493         outputs[output_name] = output
 494         if output_modes:
 495             modes[output_name] = output_modes
 496
 497     return outputs, modes
 498
 499
 500 def load_profiles(profile_path):
 501     "Load the stored profiles"
 502
 503     profiles = {}
 504     for profile in os.listdir(profile_path):
 505         config_name = os.path.join(profile_path, profile, "config")
 506         setup_name = os.path.join(profile_path, profile, "setup")
 507         if not os.path.isfile(config_name) or not os.path.isfile(setup_name):
 508             continue
 509
 510         edids = dict([x.split() for x in (y.strip() for y in open(setup_name).readlines()) if x and x[0] != "#"])
 511
 512         config = {}
 513         buffer = []
 514         for line in chain(open(config_name).readlines(), ["output"]):
 515             if line[:6] == "output" and buffer:
 516                 config[buffer[0].strip().split()[-1]] = XrandrOutput.from_config_file(edids, "".join(buffer))
 517                 buffer = [line]
 518             else:
 519                 buffer.append(line)
 520
 521         for output_name in list(config.keys()):
 522             if config[output_name].edid is None:
 523                 del config[output_name]
 524
 525         profiles[profile] = {
 526             "config": config,
 527             "path": os.path.join(profile_path, profile),
 528             "config-mtime": os.stat(config_name).st_mtime,
 529         }
 530
 531     return profiles
 532
 533
 534 def get_symlinks(profile_path):
 535     "Load all symlinks from a directory"
 536
 537     symlinks = {}
 538     for link in os.listdir(profile_path):
 539         file_name = os.path.join(profile_path, link)
 540         if os.path.islink(file_name):
 541             symlinks[link] = os.readlink(file_name)
 542
 543     return symlinks
 544
 545
 546 def find_profiles(current_config, profiles):
 547     "Find profiles matching the currently connected outputs"
 548     detected_profiles = []
 549     for profile_name, profile in profiles.items():
 550         config = profile["config"]
 551         matches = True
 552         for name, output in config.items():
 553             if not output.edid:
 554                 continue
 555             if name not in current_config or not output.edid_equals(current_config[name]):
 556                 matches = False
 557                 break
 558         if not matches or any((name not in config.keys() for name in current_config.keys() if current_config[name].edid)):
 559             continue
 560         if matches:
 561             detected_profiles.append(profile_name)
 562     return detected_profiles
 563
 564
 565 def profile_blocked(profile_path, meta_information=None):
 566     """Check if a profile is blocked.
 567
 568     meta_information is expected to be an dictionary. It will be passed to the block scripts
 569     in the environment, as variables called AUTORANDR_<CAPITALIZED_KEY_HERE>.
 570     """
 571     return not exec_scripts(profile_path, "block", meta_information)
 572
 573
 574 def output_configuration(configuration, config):
 575     "Write a configuration file"
 576     outputs = sorted(configuration.keys(), key=lambda x: configuration[x].sort_key)
 577     for output in outputs:
 578         print(configuration[output].option_string, file=config)
 579
 580
 581 def output_setup(configuration, setup):
 582     "Write a setup (fingerprint) file"
 583     outputs = sorted(configuration.keys())
 584     for output in outputs:
 585         if configuration[output].edid:
 586             print(output, configuration[output].edid, file=setup)
 587
 588
 589 def save_configuration(profile_path, configuration):
 590     "Save a configuration into a profile"
 591     if not os.path.isdir(profile_path):
 592         os.makedirs(profile_path)
 593     with open(os.path.join(profile_path, "config"), "w") as config:
 594         output_configuration(configuration, config)
 595     with open(os.path.join(profile_path, "setup"), "w") as setup:
 596         output_setup(configuration, setup)
 597
 598
 599 def update_mtime(filename):
 600     "Update a file's mtime"
 601     try:
 602         os.utime(filename, None)
 603         return True
 604     except:
 605         return False
 606
 607
 608 def call_and_retry(*args, **kwargs):
 609     """Wrapper around subprocess.call that retries failed calls.
 610
 611     This function calls subprocess.call and on non-zero exit states,
 612     waits a second and then retries once. This mitigates #47,
 613     a timing issue with some drivers.
 614     """
 615     if "dry_run" in kwargs:
 616         dry_run = kwargs["dry_run"]
 617         del kwargs["dry_run"]
 618     else:
 619         dry_run = False
 620     kwargs_redirected = dict(kwargs)
 621     if not dry_run:
 622         if hasattr(subprocess, "DEVNULL"):
 623             kwargs_redirected["stdout"] = getattr(subprocess, "DEVNULL")
 624         else:
 625             kwargs_redirected["stdout"] = open(os.devnull, "w")
 626         kwargs_redirected["stderr"] = kwargs_redirected["stdout"]
 627     retval = subprocess.call(*args, **kwargs_redirected)
 628     if retval != 0:
 629         time.sleep(1)
 630         retval = subprocess.call(*args, **kwargs)
 631     return retval
 632
 633
 634 def get_fb_dimensions(configuration):
 635     width = 0
 636     height = 0
 637     for output in configuration.values():
 638         if "off" in output.options or not output.edid:
 639             continue
 640         # This won't work with all modes -- but it's a best effort.
 641         o_width, o_height = map(int, output.options["mode"].split("x"))
 642         if "transform" in output.options:
 643             a, b, c, d, e, f, g, h, i = map(float, output.options["transform"].split(","))
 644             w = (g * o_width + h * o_height + i)
 645             x = (a * o_width + b * o_height + c) / w
 646             y = (d * o_width + e * o_height + f) / w
 647             o_width, o_height = x, y
 648         if "pos" in output.options:
 649             o_left, o_top = map(int, output.options["pos"].split("x"))
 650             o_width += o_left
 651             o_height += o_top
 652         if "panning" in output.options:
 653             match = re.match("(?P<w>[0-9]+)x(?P<h>[0-9]+)(?:\+(?P<x>[0-9]+))?(?:\+(?P<y>[0-9]+))?.*", output.options["panning"])
 654             if match:
 655                 detail = match.groupdict()
 656                 o_width = int(detail.get("w")) + int(detail.get("x", "0"))
 657                 o_height = int(detail.get("h")) + int(detail.get("y", "0"))
 658         width = max(width, o_width)
 659         height = max(height, o_height)
 660     return int(width), int(height)
 661
 662
 663 def apply_configuration(new_configuration, current_configuration, dry_run=False):
 664     "Apply a configuration"
 665     outputs = sorted(new_configuration.keys(), key=lambda x: new_configuration[x].sort_key)
 666     if dry_run:
 667         base_argv = ["echo", "xrandr"]
 668     else:
 669         base_argv = ["xrandr"]
 670
 671     # There are several xrandr / driver bugs we need to take care of here:
 672     # - We cannot enable more than two screens at the same time
 673     #   See https://github.com/phillipberndt/autorandr/pull/6
 674     #   and commits f4cce4d and 8429886.
 675     # - We cannot disable all screens
 676     #   See https://github.com/phillipberndt/autorandr/pull/20
 677     # - We should disable screens before enabling others, because there's
 678     #   a limit on the number of enabled screens
 679     # - We must make sure that the screen at 0x0 is activated first,
 680     #   or the other (first) screen to be activated would be moved there.
 681     # - If an active screen already has a transformation and remains active,
 682     #   the xrandr call fails with an invalid RRSetScreenSize parameter error.
 683     #   Update the configuration in 3 passes in that case.  (On Haswell graphics,
 684     #   at least.)
 685     # - Some implementations can not handle --transform at all, so avoid it unless
 686     #   necessary. (See https://github.com/phillipberndt/autorandr/issues/37)
 687     # - Some implementations can not handle --panning without specifying --fb
 688     #   explicitly, so avoid it unless necessary.
 689     #   (See https://github.com/phillipberndt/autorandr/issues/72)
 690
 691     fb_dimensions = get_fb_dimensions(new_configuration)
 692     try:
 693         base_argv += ["--fb", "%dx%d" % fb_dimensions]
 694     except:
 695         # Failed to obtain frame-buffer size. Doesn't matter, xrandr will choose for the user.
 696         pass
 697
 698     auxiliary_changes_pre = []
 699     disable_outputs = []
 700     enable_outputs = []
 701     remain_active_count = 0
 702     for output in outputs:
 703         if not new_configuration[output].edid or "off" in new_configuration[output].options:
 704             disable_outputs.append(new_configuration[output].option_vector)
 705         else:
 706             if "off" not in current_configuration[output].options:
 707                 remain_active_count += 1
 708
 709             option_vector = new_configuration[output].option_vector
 710             if xrandr_version() >= Version("1.3.0"):
 711                 for option, off_value in (("transform", "none"), ("panning", "0x0")):
 712                     if option in current_configuration[output].options:
 713                         auxiliary_changes_pre.append(["--output", output, "--%s" % option, off_value])
 714                     else:
 715                         try:
 716                             option_index = option_vector.index("--%s" % option)
 717                             if option_vector[option_index + 1] == XrandrOutput.XRANDR_DEFAULTS[option]:
 718                                 option_vector = option_vector[:option_index] + option_vector[option_index + 2:]
 719                         except ValueError:
 720                             pass
 721
 722             enable_outputs.append(option_vector)
 723
 724     # Perform pe-change auxiliary changes
 725     if auxiliary_changes_pre:
 726         argv = base_argv + list(chain.from_iterable(auxiliary_changes_pre))
 727         if call_and_retry(argv, dry_run=dry_run) != 0:
 728             raise AutorandrException("Command failed: %s" % " ".join(argv))
 729
 730     # Disable unused outputs, but make sure that there always is at least one active screen
 731     disable_keep = 0 if remain_active_count else 1
 732     if len(disable_outputs) > disable_keep:
 733         argv = base_argv + list(chain.from_iterable(disable_outputs[:-1] if disable_keep else disable_outputs))
 734         if call_and_retry(argv, dry_run=dry_run) != 0:
 735             # Disabling the outputs failed. Retry with the next command:
 736             # Sometimes disabling of outputs fails due to an invalid RRSetScreenSize.
 737             # This does not occur if simultaneously the primary screen is reset.
 738             pass
 739         else:
 740             disable_outputs = disable_outputs[-1:] if disable_keep else []
 741
 742     # If disable_outputs still has more than one output in it, one of the xrandr-calls below would
 743     # disable the last two screens. This is a problem, so if this would happen, instead disable only
 744     # one screen in the first call below.
 745     if len(disable_outputs) > 0 and len(disable_outputs) % 2 == 0:
 746         # In the context of a xrandr call that changes the display state, `--query' should do nothing
 747         disable_outputs.insert(0, ['--query'])
 748
 749     # Enable the remaining outputs in pairs of two operations
 750     operations = disable_outputs + enable_outputs
 751     for index in range(0, len(operations), 2):
 752         argv = base_argv + list(chain.from_iterable(operations[index:index + 2]))
 753         if call_and_retry(argv, dry_run=dry_run) != 0:
 754             raise AutorandrException("Command failed: %s" % " ".join(argv))
 755
 756
 757 def is_equal_configuration(source_configuration, target_configuration):
 758     """
 759         Check if all outputs from target are already configured correctly in source and
 760         that no other outputs are active.
 761     """
 762     for output in target_configuration.keys():
 763         if "off" in target_configuration[output].options:
 764             if (output in source_configuration and "off" not in source_configuration[output].options):
 765                 return False
 766         else:
 767             if (output not in source_configuration) or (source_configuration[output] != target_configuration[output]):
 768                 return False
 769     for output in source_configuration.keys():
 770         if "off" in source_configuration[output].options:
 771             if output in target_configuration and "off" not in target_configuration.options:
 772                 return False
 773         else:
 774             if output not in target_configuration:
 775                 return False
 776     return True
 777
 778
 779 def add_unused_outputs(source_configuration, target_configuration):
 780     "Add outputs that are missing in target to target, in 'off' state"
 781     for output_name, output in source_configuration.items():
 782         if output_name not in target_configuration:
 783             target_configuration[output_name] = XrandrOutput(output_name, output.edid, {"off": None})
 784
 785
 786 def remove_irrelevant_outputs(source_configuration, target_configuration):
 787     "Remove outputs from target that ought to be 'off' and already are"
 788     for output_name, output in source_configuration.items():
 789         if "off" in output.options:
 790             if output_name in target_configuration:
 791                 if "off" in target_configuration[output_name].options:
 792                     del target_configuration[output_name]
 793
 794
 795 def generate_virtual_profile(configuration, modes, profile_name):
 796     "Generate one of the virtual profiles"
 797     configuration = copy.deepcopy(configuration)
 798     if profile_name == "common":
 799         mode_sets = []
 800         for output, output_modes in modes.items():
 801             mode_set = set()
 802             if configuration[output].edid:
 803                 for mode in output_modes:
 804                     mode_set.add((mode["width"], mode["height"]))
 805             mode_sets.append(mode_set)
 806         common_resolution = reduce(lambda a, b: a & b, mode_sets[1:], mode_sets[0])
 807         common_resolution = sorted(common_resolution, key=lambda a: int(a[0]) * int(a[1]))
 808         if common_resolution:
 809             for output in configuration:
 810                 configuration[output].options = {}
 811                 if output in modes and configuration[output].edid:
 812                     modes_sorted = sorted(modes[output], key=lambda x: 0 if x["preferred"] else 1)
 813                     modes_filtered = [x for x in modes_sorted if (x["width"], x["height"]) == common_resolution[-1]]
 814                     mode = modes_filtered[0]
 815                     configuration[output].options["mode"] = mode['name']
 816                     configuration[output].options["pos"] = "0x0"
 817                 else:
 818                     configuration[output].options["off"] = None
 819     elif profile_name in ("horizontal", "vertical"):
 820         shift = 0
 821         if profile_name == "horizontal":
 822             shift_index = "width"
 823             pos_specifier = "%sx0"
 824         else:
 825             shift_index = "height"
 826             pos_specifier = "0x%s"
 827
 828         for output in configuration:
 829             configuration[output].options = {}
 830             if output in modes and configuration[output].edid:
 831                 def key(a):
 832                     score = int(a["width"]) * int(a["height"])
 833                     if a["preferred"]:
 834                         score += 10**6
 835                     return score
 836                 output_modes = sorted(modes[output], key=key)
 837                 mode = output_modes[-1]
 838                 configuration[output].options["mode"] = mode["name"]
 839                 configuration[output].options["rate"] = mode["rate"]
 840                 configuration[output].options["pos"] = pos_specifier % shift
 841                 shift += int(mode[shift_index])
 842             else:
 843                 configuration[output].options["off"] = None
 844     elif profile_name == "clone-largest":
 845         modes_unsorted = [output_modes[0] for output, output_modes in modes.items()]
 846         modes_sorted = sorted(modes_unsorted, key=lambda x: int(x["width"]) * int(x["height"]), reverse=True)
 847         biggest_resolution = modes_sorted[0]
 848         for output in configuration:
 849             configuration[output].options = {}
 850             if output in modes and configuration[output].edid:
 851                 def key(a):
 852                     score = int(a["width"]) * int(a["height"])
 853                     if a["preferred"]:
 854                         score += 10**6
 855                     return score
 856                 output_modes = sorted(modes[output], key=key)
 857                 mode = output_modes[-1]
 858                 configuration[output].options["mode"] = mode["name"]
 859                 configuration[output].options["rate"] = mode["rate"]
 860                 configuration[output].options["pos"] = "0x0"
 861                 scale = max(float(biggest_resolution["width"]) / float(mode["width"]),
 862                             float(biggest_resolution["height"]) / float(mode["height"]))
 863                 mov_x = (float(mode["width"]) * scale - float(biggest_resolution["width"])) / -2
 864                 mov_y = (float(mode["height"]) * scale - float(biggest_resolution["height"])) / -2
 865                 configuration[output].options["transform"] = "{},0,{},0,{},{},0,0,1".format(scale, mov_x, scale, mov_y)
 866             else:
 867                 configuration[output].options["off"] = None
 868     elif profile_name == "off":
 869         for output in configuration:
 870             for key in list(configuration[output].options.keys()):
 871                 del configuration[output].options[key]
 872             configuration[output].options["off"] = None
 873     return configuration
 874
 875
 876 def print_profile_differences(one, another):
 877     "Print the differences between two profiles for debugging"
 878     if one == another:
 879         return
 880     print("| Differences between the two profiles:")
 881     for output in set(chain.from_iterable((one.keys(), another.keys()))):
 882         if output not in one:
 883             if "off" not in another[output].options:
 884                 print("| Output `%s' is missing from the active configuration" % output)
 885         elif output not in another:
 886             if "off" not in one[output].options:
 887                 print("| Output `%s' is missing from the new configuration" % output)
 888         else:
 889             for line in one[output].verbose_diff(another[output]):
 890                 print("| [Output %s] %s" % (output, line))
 891     print("\\-")
 892
 893
 894 def exit_help():
 895     "Print help and exit"
 896     print(help_text)
 897     for profile in virtual_profiles:
 898         name, description = profile[:2]
 899         description = [description]
 900         max_width = 78 - 18
 901         while len(description[0]) > max_width + 1:
 902             left_over = description[0][max_width:]
 903             description[0] = description[0][:max_width] + "-"
 904             description.insert(1, "  %-15s %s" % ("", left_over))
 905         description = "\n".join(description)
 906         print("  %-15s %s" % (name, description))
 907     sys.exit(0)
 908
 909
 910 def exec_scripts(profile_path, script_name, meta_information=None):
 911     """"Run userscripts
 912
 913     This will run all executables from the profile folder, and global per-user
 914     and system-wide configuration folders, named script_name or residing in
 915     subdirectories named script_name.d.
 916
 917     If profile_path is None, only global scripts will be invoked.
 918
 919     meta_information is expected to be an dictionary. It will be passed to the block scripts
 920     in the environment, as variables called AUTORANDR_<CAPITALIZED_KEY_HERE>.
 921
 922     Returns True unless any of the scripts exited with non-zero exit status.
 923     """
 924     all_ok = True
 925     env = os.environ.copy()
 926     if meta_information:
 927         for key, value in meta_information.items():
 928             env["AUTORANDR_{}".format(key.upper())] = str(value)
 929
 930     # If there are multiple candidates, the XDG spec tells to only use the first one.
 931     ran_scripts = set()
 932
 933     user_profile_path = os.path.expanduser("~/.autorandr")
 934     if not os.path.isdir(user_profile_path):
 935         user_profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
 936
 937     candidate_directories = [user_profile_path]
 938     for config_dir in os.environ.get("XDG_CONFIG_DIRS", "/etc/xdg").split(":"):
 939         candidate_directories.append(os.path.join(config_dir, "autorandr"))
 940     if profile_path:
 941         candidate_directories.append(profile_path)
 942
 943     for folder in candidate_directories:
 944         if script_name not in ran_scripts:
 945             script = os.path.join(folder, script_name)
 946             if os.access(script, os.X_OK | os.F_OK):
 947                 try:
 948                     all_ok &= subprocess.call(script, env=env) != 0
 949                 except:
 950                     raise AutorandrException("Failed to execute user command: %s" % (script,))
 951                 ran_scripts.add(script_name)
 952
 953         script_folder = os.path.join(folder, "%s.d" % script_name)
 954         if os.access(script_folder, os.R_OK | os.X_OK) and os.path.isdir(script_folder):
 955             for file_name in os.listdir(script_folder):
 956                 check_name = "d/%s" % (file_name,)
 957                 if check_name not in ran_scripts:
 958                     script = os.path.join(script_folder, file_name)
 959                     if os.access(script, os.X_OK | os.F_OK):
 960                         try:
 961                             all_ok &= subprocess.call(script, env=env) != 0
 962                         except:
 963                             raise AutorandrException("Failed to execute user command: %s" % (script,))
 964                         ran_scripts.add(check_name)
 965
 966     return all_ok
 967
 968
 969 def dispatch_call_to_sessions(argv):
 970     """Invoke autorandr for each open local X11 session with the given options.
 971
 972     The function iterates over all processes not owned by root and checks
 973     whether they have DISPLAY and XAUTHORITY variables set. It strips the
 974     screen from any variable it finds (i.e. :0.0 becomes :0) and checks whether
 975     this display has been handled already. If it has not, it forks, changes
 976     uid/gid to the user owning the process, reuses the process's environment
 977     and runs autorandr with the parameters from argv.
 978
 979     This function requires root permissions. It only works for X11 servers that
 980     have at least one non-root process running. It is susceptible for attacks
 981     where one user runs a process with another user's DISPLAY variable - in
 982     this case, it might happen that autorandr is invoked for the other user,
 983     which won't work. Since no other harm than prevention of automated
 984     execution of autorandr can be done this way, the assumption is that in this
 985     situation, the local administrator will handle the situation."""
 986
 987     X11_displays_done = set()
 988
 989     autorandr_binary = os.path.abspath(argv[0])
 990     backup_candidates = {}
 991
 992     def fork_child_autorandr(pwent, process_environ):
 993         print("Running autorandr as %s for display %s" % (pwent.pw_name, process_environ["DISPLAY"]))
 994         child_pid = os.fork()
 995         if child_pid == 0:
 996             # This will throw an exception if any of the privilege changes fails,
 997             # so it should be safe. Also, note that since the environment
 998             # is taken from a process owned by the user, reusing it should
 999             # not leak any information.
1000             os.setgroups([])
1001             os.setresgid(pwent.pw_gid, pwent.pw_gid, pwent.pw_gid)
1002             os.setresuid(pwent.pw_uid, pwent.pw_uid, pwent.pw_uid)
1003             os.chdir(pwent.pw_dir)
1004             os.environ.clear()
1005             os.environ.update(process_environ)
1006             os.execl(autorandr_binary, autorandr_binary, *argv[1:])
1007             os.exit(1)
1008         os.waitpid(child_pid, 0)
1009
1010     for directory in os.listdir("/proc"):
1011         directory = os.path.join("/proc/", directory)
1012         if not os.path.isdir(directory):
1013             continue
1014         environ_file = os.path.join(directory, "environ")
1015         if not os.path.isfile(environ_file):
1016             continue
1017         uid = os.stat(environ_file).st_uid
1018
1019         # The following line assumes that user accounts start at 1000 and that
1020         # no one works using the root or another system account. This is rather
1021         # restrictive, but de facto default. Alternatives would be to use the
1022         # UID_MIN from /etc/login.defs or FIRST_UID from /etc/adduser.conf;
1023         # but effectively, both values aren't binding in any way.
1024         # If this breaks your use case, please file a bug on Github.
1025         if uid < 1000:
1026             continue
1027
1028         process_environ = {}
1029         for environ_entry in open(environ_file).read().split("\0"):
1030             name, sep, value = environ_entry.partition("=")
1031             if name and sep:
1032                 if name == "DISPLAY" and "." in value:
1033                     value = value[:value.find(".")]
1034                 process_environ[name] = value
1035
1036         if "DISPLAY" not in process_environ:
1037             # Cannot work with this environment, skip.
1038             continue
1039
1040         # To allow scripts to detect batch invocation (especially useful for predetect)
1041         process_environ["AUTORANDR_BATCH_PID"] = str(os.getpid())
1042         process_environ["UID"] = str(uid)
1043
1044         display = process_environ["DISPLAY"]
1045
1046         if "XAUTHORITY" not in process_environ:
1047             # It's very likely that we cannot work with this environment either,
1048             # but keep it as a backup just in case we don't find anything else.
1049             backup_candidates[display] = process_environ
1050             continue
1051
1052         if display not in X11_displays_done:
1053             try:
1054                 pwent = pwd.getpwuid(uid)
1055             except KeyError:
1056                 # User has no pwd entry
1057                 continue
1058
1059             fork_child_autorandr(pwent, process_environ)
1060             X11_displays_done.add(display)
1061
1062     # Run autorandr for any users/displays which didn't have a process with
1063     # XAUTHORITY set.
1064     for display, process_environ in backup_candidates.items():
1065         if display not in X11_displays_done:
1066             try:
1067                 pwent = pwd.getpwuid(int(process_environ["UID"]))
1068             except KeyError:
1069                 # User has no pwd entry
1070                 continue
1071
1072             fork_child_autorandr(pwent, process_environ)
1073             X11_displays_done.add(display)
1074
1075
1076 def enabled_monitors(config):
1077     monitors = []
1078     for monitor in config:
1079         if "--off" in config[monitor].option_vector:
1080             continue
1081         monitors.append(monitor)
1082     return monitors
1083
1084
1085 def read_config(options, directory):
1086     """Parse a configuration config.ini from directory and merge it into
1087     the options dictionary"""
1088     config = configparser.ConfigParser()
1089     config.read(os.path.join(directory, "settings.ini"))
1090     if config.has_section("config"):
1091         for key, value in config.items("config"):
1092             options.setdefault("--%s" % key, value)
1093
1094 def main(argv):
1095     try:
1096         opts, args = getopt.getopt(argv[1:], "s:r:l:d:cfh",
1097                                    ["batch", "dry-run", "change", "default=", "save=", "remove=", "load=",
1098                                     "force", "fingerprint", "config", "debug", "skip-options=", "help",
1099                                     "current", "detected", "version"])
1100     except getopt.GetoptError as e:
1101         print("Failed to parse options: {0}.\n"
1102               "Use --help to get usage information.".format(str(e)),
1103               file=sys.stderr)
1104         sys.exit(posix.EX_USAGE)
1105
1106     options = dict(opts)
1107
1108     if "-h" in options or "--help" in options:
1109         exit_help()
1110
1111     if "--version" in options:
1112         print("autorandr " + __version__)
1113         sys.exit(0)
1114
1115     if "--current" in options and "--detected" in options:
1116         print("--current and --detected are mutually exclusive.", file=sys.stderr)
1117         sys.exit(posix.EX_USAGE)
1118
1119     # Batch mode
1120     if "--batch" in options:
1121         if ("DISPLAY" not in os.environ or not os.environ["DISPLAY"]) and os.getuid() == 0:
1122             dispatch_call_to_sessions([x for x in argv if x != "--batch"])
1123         else:
1124             print("--batch mode can only be used by root and if $DISPLAY is unset")
1125         return
1126     if "AUTORANDR_BATCH_PID" in os.environ:
1127         user = pwd.getpwuid(os.getuid())
1128         user = user.pw_name if user else "#%d" % os.getuid()
1129         print("autorandr running as user %s (started from batch instance)" % user)
1130
1131     profiles = {}
1132     profile_symlinks = {}
1133     try:
1134         # Load profiles from each XDG config directory
1135         # The XDG spec says that earlier entries should take precedence, so reverse the order
1136         for directory in reversed(os.environ.get("XDG_CONFIG_DIRS", "/etc/xdg").split(":")):
1137             system_profile_path = os.path.join(directory, "autorandr")
1138             if os.path.isdir(system_profile_path):
1139                 profiles.update(load_profiles(system_profile_path))
1140                 profile_symlinks.update(get_symlinks(system_profile_path))
1141                 read_config(options, system_profile_path)
1142         # For the user's profiles, prefer the legacy ~/.autorandr if it already exists
1143         # profile_path is also used later on to store configurations
1144         profile_path = os.path.expanduser("~/.autorandr")
1145         if not os.path.isdir(profile_path):
1146             # Elsewise, follow the XDG specification
1147             profile_path = os.path.join(os.environ.get("XDG_CONFIG_HOME", os.path.expanduser("~/.config")), "autorandr")
1148         if os.path.isdir(profile_path):
1149             profiles.update(load_profiles(profile_path))
1150             profile_symlinks.update(get_symlinks(profile_path))
1151             read_config(options, profile_path)
1152         # Sort by descending mtime
1153         profiles = OrderedDict(sorted(profiles.items(), key=lambda x: -x[1]["config-mtime"]))
1154     except Exception as e:
1155         raise AutorandrException("Failed to load profiles", e)
1156
1157     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}
1158
1159     exec_scripts(None, "predetect")
1160     config, modes = parse_xrandr_output()
1161
1162     if "--fingerprint" in options:
1163         output_setup(config, sys.stdout)
1164         sys.exit(0)
1165
1166     if "--config" in options:
1167         output_configuration(config, sys.stdout)
1168         sys.exit(0)
1169
1170     if "--skip-options" in options:
1171         skip_options = [y[2:] if y[:2] == "--" else y for y in (x.strip() for x in options["--skip-options"].split(","))]
1172         for profile in profiles.values():
1173             for output in profile["config"].values():
1174                 output.set_ignored_options(skip_options)
1175         for output in config.values():
1176             output.set_ignored_options(skip_options)
1177
1178     if "-s" in options:
1179         options["--save"] = options["-s"]
1180     if "--save" in options:
1181         if options["--save"] in (x[0] for x in virtual_profiles):
1182             raise AutorandrException("Cannot save current configuration as profile '%s':\n"
1183                                      "This configuration name is a reserved virtual configuration." % options["--save"])
1184         try:
1185             profile_folder = os.path.join(profile_path, options["--save"])
1186             save_configuration(profile_folder, config)
1187             exec_scripts(profile_folder, "postsave", {
1188                 "CURRENT_PROFILE": options["--save"],
1189                 "PROFILE_FOLDER": profile_folder,
1190                 "MONITORS": ":".join(enabled_monitors(config)),
1191             })
1192         except Exception as e:
1193             raise AutorandrException("Failed to save current configuration as profile '%s'" % (options["--save"],), e)
1194         print("Saved current configuration as profile '%s'" % options["--save"])
1195         sys.exit(0)
1196
1197     if "-r" in options:
1198         options["--remove"] = options["-r"]
1199     if "--remove" in options:
1200         if options["--remove"] in (x[0] for x in virtual_profiles):
1201             raise AutorandrException("Cannot remove profile '%s':\n"
1202                                      "This configuration name is a reserved virtual configuration." % options["--remove"])
1203         if options["--remove"] not in profiles.keys():
1204             raise AutorandrException("Cannot remove profile '%s':\n"
1205                                      "This profile does not exist." % options["--remove"])
1206         try:
1207             remove = True
1208             profile_folder = os.path.join(profile_path, options["--remove"])
1209             profile_dirlist = os.listdir(profile_folder)
1210             profile_dirlist.remove("config")
1211             profile_dirlist.remove("setup")
1212             if profile_dirlist:
1213                 print("Profile folder '%s' contains the following additional files:\n"
1214                       "---\n%s\n---" % (options["--remove"], "\n".join(profile_dirlist)))
1215                 response = input("Do you really want to remove profile '%s'? If so, type 'yes': " % options["--remove"]).strip()
1216                 if response != "yes":
1217                     remove = False
1218             if remove is True:
1219                 shutil.rmtree(profile_folder)
1220                 print("Removed profile '%s'" % options["--remove"])
1221             else:
1222                 print("Profile '%s' was not removed" % options["--remove"])
1223         except Exception as e:
1224             raise AutorandrException("Failed to remove profile '%s'" % (options["--remove"],), e)
1225         sys.exit(0)
1226
1227     detected_profiles = find_profiles(config, profiles)
1228     load_profile = False
1229
1230     if "-l" in options:
1231         options["--load"] = options["-l"]
1232     if "--load" in options:
1233         load_profile = options["--load"]
1234     elif len(args) == 1:
1235         load_profile = args[0]
1236     else:
1237         # Find the active profile(s) first, for the block script (See #42)
1238         current_profiles = []
1239         for profile_name in profiles.keys():
1240             configs_are_equal = is_equal_configuration(config, profiles[profile_name]["config"])
1241             if configs_are_equal:
1242                 current_profiles.append(profile_name)
1243         block_script_metadata = {
1244             "CURRENT_PROFILE": "".join(current_profiles[:1]),
1245             "CURRENT_PROFILES": ":".join(current_profiles)
1246         }
1247
1248         for profile_name in profiles.keys():
1249             if profile_blocked(os.path.join(profile_path, profile_name), block_script_metadata):
1250                 if "--current" not in options and "--detected" not in options:
1251                     print("%s (blocked)" % profile_name)
1252                 continue
1253             props = []
1254             if profile_name in detected_profiles:
1255                 props.append("(detected)")
1256                 if ("-c" in options or "--change" in options) and not load_profile:
1257                     load_profile = profile_name
1258             elif "--detected" in options:
1259                 continue
1260             if profile_name in current_profiles:
1261                 props.append("(current)")
1262             elif "--current" in options:
1263                 continue
1264             if "--current" in options or "--detected" in options:
1265                 print("%s" % (profile_name, ))
1266             else:
1267                 print("%s%s%s" % (profile_name, " " if props else "", " ".join(props)))
1268             if not configs_are_equal and "--debug" in options and profile_name in detected_profiles:
1269                 print_profile_differences(config, profiles[profile_name]["config"])
1270
1271     if "-d" in options:
1272         options["--default"] = options["-d"]
1273     if not load_profile and "--default" in options and ("-c" in options or "--change" in options):
1274         load_profile = options["--default"]
1275
1276     if load_profile:
1277         if load_profile in profile_symlinks:
1278             if "--debug" in options:
1279                 print("'%s' symlinked to '%s'" % (load_profile, profile_symlinks[load_profile]))
1280             load_profile = profile_symlinks[load_profile]
1281
1282         if load_profile in (x[0] for x in virtual_profiles):
1283             load_config = generate_virtual_profile(config, modes, load_profile)
1284             scripts_path = os.path.join(profile_path, load_profile)
1285         else:
1286             try:
1287                 profile = profiles[load_profile]
1288                 load_config = profile["config"]
1289                 scripts_path = profile["path"]
1290             except KeyError:
1291                 raise AutorandrException("Failed to load profile '%s': Profile not found" % load_profile)
1292             if load_profile in detected_profiles and detected_profiles[0] != load_profile:
1293                 update_mtime(os.path.join(scripts_path, "config"))
1294         add_unused_outputs(config, load_config)
1295         if load_config == dict(config) and "-f" not in options and "--force" not in options:
1296             print("Config already loaded", file=sys.stderr)
1297             sys.exit(0)
1298         if "--debug" in options and load_config != dict(config):
1299             print("Loading profile '%s'" % load_profile)
1300             print_profile_differences(config, load_config)
1301
1302         remove_irrelevant_outputs(config, load_config)
1303
1304         try:
1305             if "--dry-run" in options:
1306                 apply_configuration(load_config, config, True)
1307             else:
1308                 script_metadata = {
1309                     "CURRENT_PROFILE": load_profile,
1310                     "PROFILE_FOLDER": scripts_path,
1311                     "MONITORS": ":".join(enabled_monitors(load_config)),
1312                 }
1313                 exec_scripts(scripts_path, "preswitch", script_metadata)
1314                 if "--debug" in options:
1315                     print("Going to run:")
1316                     apply_configuration(load_config, config, True)
1317                 apply_configuration(load_config, config, False)
1318                 exec_scripts(scripts_path, "postswitch", script_metadata)
1319         except AutorandrException as e:
1320             raise AutorandrException("Failed to apply profile '%s'" % load_profile, e, e.report_bug)
1321         except Exception as e:
1322             raise AutorandrException("Failed to apply profile '%s'" % load_profile, e, True)
1323
1324         if "--dry-run" not in options and "--debug" in options:
1325             new_config, _ = parse_xrandr_output()
1326             if not is_equal_configuration(new_config, load_config):
1327                 print("The configuration change did not go as expected:")
1328                 print_profile_differences(new_config, load_config)
1329
1330     sys.exit(0)
1331
1332
1333 def exception_handled_main(argv=sys.argv):
1334     try:
1335         main(sys.argv)
1336     except AutorandrException as e:
1337         print(e, file=sys.stderr)
1338         sys.exit(1)
1339     except Exception as e:
1340         if not len(str(e)):  # BdbQuit
1341             print("Exception: {0}".format(e.__class__.__name__))
1342             sys.exit(2)
1343
1344         print("Unhandled exception ({0}). Please report this as a bug at "
1345               "https://github.com/phillipberndt/autorandr/issues.".format(e),
1346               file=sys.stderr)
1347         raise
1348
1349
1350 if __name__ == '__main__':
1351     exception_handled_main()