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