tab -> whitespace
[lilass.git] / dsl.py
1 #!/usr/bin/python3
2 # DSL - easy Display Setup for Laptops
3 # Copyright (C) 2012-2014 Ralf Jung <post@ralfj.de>
4 #
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 2 of the License, or
8 # (at your option) any later version.
9 #
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13 # GNU General Public License for more details.
14 #
15 # You should have received a copy of the GNU General Public License
16 # along with this program; if not, write to the Free Software
17 # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18
19 import argparse, sys, os, re, subprocess
20 from gui import getFrontend
21 frontend = getFrontend("cli") # the fallback, until we got a proper frontend. This is guaranteed to be available.
22
23 # for auto-config: common names of internal connectors
24 commonInternalConnectorNames = ['LVDS', 'LVDS0', 'LVDS1', 'LVDS-0', 'LVDS-1']
25
26 # this is as close as one can get to an enum in Python
27 class RelativeScreenPosition:
28     LEFT          = 0
29     RIGHT         = 1
30     EXTERNAL_ONLY = 2
31
32 # storing what's necessary for screen setup
33 class ScreenSetup:
34     def __init__(self, relPosition, intResolution, extResolution, extIsPrimary = False):
35         '''relPosition must be one of the RelativeScreenPosition members, the resolutions must be (width, height) pairs'''
36         self.relPosition = relPosition
37         self.intResolution = intResolution # value doesn't matter if the internal screen is disabled
38         self.extResolution = extResolution
39         self.extIsPrimary = extIsPrimary or self.relPosition == RelativeScreenPosition.EXTERNAL_ONLY # external is always primary if it is the only one
40     
41     def getInternalArgs(self):
42         if self.relPosition == RelativeScreenPosition.EXTERNAL_ONLY:
43             return ["--off"]
44         args = ["--mode", res2xrandr(self.intResolution)] # set internal screen to desired resolution
45         if not self.extIsPrimary:
46             args.append('--primary')
47         return args
48     
49     def getExternalArgs(self, intName):
50         args = ["--mode", res2xrandr(self.extResolution)] # set external screen to desired resolution
51         if self.extIsPrimary:
52             args.append('--primary')
53         if self.relPosition == RelativeScreenPosition.LEFT:
54             args += ['--left-of', intName]
55         elif self.relPosition == RelativeScreenPosition.RIGHT:
56             args += ['--right-of', intName]
57         return args
58
59 # Load a section-less config file: maps parameter names to space-separated lists of strings (with shell quotation)
60 def loadConfigFile(filename):
61     import shlex
62     result = {}
63     if not os.path.exists(filename):
64         return result # no config file
65     # read config file
66     linenr = 0
67     with open(filename) as f:
68         for line in f:
69             linenr += 1
70             line = line.strip()
71             if not len(line) or line.startswith("#"): continue # skip empty and comment lines
72             try:
73                 # parse line
74                 pos = line.index("=") # will raise exception when substring is not found
75                 curKey = line[:pos].strip()
76                 result[curKey] = shlex.split(line[pos+1:]) # shlex.split also strips
77             except Exception:
78                 raise Exception("Invalid config, line %d: Error parsing line (may be a quoting issue)." % linenr)
79     # add some convencience get functions
80     return result
81
82 # helper function: execute a process, return output as iterator, throw exception if there was an error
83 # you *must* iterate to the end if you use this!
84 def processOutputGen(*args):
85     with subprocess.Popen(args, stdout=subprocess.PIPE) as p:
86         for line in p.stdout:
87             yield line.decode("utf-8")
88     if p.returncode != 0:
89         raise Exception("Error executing "+str(args))
90 def processOutputIt(*args):
91     return list(processOutputGen(*args)) # list() iterates over the generator
92
93 # Run xrandr and return a dict of output names mapped to lists of available resolutions, each being a (width, height) pair.
94 # An empty list indicates that the connector is disabled.
95 def getXrandrInformation():
96     connectors = {} # map of connector names to a list of resolutions
97     connector = None # current connector
98     for line in processOutputGen("xrandr", "-q"):
99         # screen?
100         m = re.search(r'^Screen [0-9]+: ', line)
101         if m is not None: # ignore this line
102             connector = None
103             continue
104         # new connector?
105         m = re.search(r'^([\w\-]+) (dis)?connected ', line)
106         if m is not None:
107             connector = m.groups()[0]
108             assert connector not in connectors
109             connectors[connector] = []
110             continue
111         # new resolution?
112         m = re.search(r'^   ([\d]+)x([\d]+) +', line)
113         if m is not None:
114             assert connector is not None
115             connectors[connector].append((int(m.groups()[0]), int(m.groups()[1])))
116             continue
117         # unknown line
118         # not fatal as my xrandr shows strange stuff when a display is enabled, but not connected
119         #raise Exception("Unknown line in xrandr output:\n"+line)
120         print("Warning: Unknown xrandr line %s" % line)
121     return connectors
122
123 # convert a (width, height) pair into a string accepted by xrandr as argument for --mode
124 def res2xrandr(res):
125     (w, h) = res
126     return str(w)+'x'+str(h)
127
128 # convert a (width, height) pair into a string to be displayed to the user
129 def res2user(res):
130     (w, h) = res
131     # get ratio
132     ratio = int(round(16.0*h/w))
133     if ratio == 12: # 16:12 = 4:3
134         strRatio = '4:3'
135     elif ratio == 13: # 16:12.8 = 5:4
136         strRatio = '5:4'
137     else: # let's just hope this will never be 14 or more...
138         strRatio = '16:%d' % ratio
139     return '%dx%d (%s)' %(w, h, strRatio)
140
141 # return the first available connector from those listed in tryConnectors, skipping disabled connectors
142 def findAvailableConnector(tryConnectors, allConnectors):
143     for connector in tryConnectors:
144         if connector in allConnectors and allConnectors[connector]: # if the connector exists and is active (i.e. there is a resolution)
145             return connector
146     return None
147
148 # Return a (internalConnector, externalConnectors) pair: The name of the internal connector, and a list of external connectors.
149 # Use the config file at ~/.dsl.conf and fall back to auto-detection
150 def classifyConnectors(allConnectors):
151     config = loadConfigFile(os.getenv('HOME') + '/.dsl.conf')
152     # find internal connector
153     if 'internalConnector' in config:
154         if len(config['internalConnector']) != 1:
155             raise Exception("You must specify exactly one internal connector.")
156         internalConnector = config['internalConnector'][0]
157         if not internalConnector in allConnectors:
158             raise Exception("Connector %s does not exist, there is an error in your config file." % internalConnector)
159     else:
160         # auto-config
161         internalConnector = findAvailableConnector(commonInternalConnectorNames, allConnectors)
162         if internalConnector is None:
163             raise Exception("Could not automatically find internal connector, please use ~/.dsl.conf to specify it manually.")
164     # all the rest is external then, obviously - unless the user wants to do that manually
165     if 'externalConnectors' in config:
166         externalConnectors = config['externalConnectors']
167         for connector in externalConnectors:
168             if not connector in allConnectors:
169                 raise Exception("Connector %s does not exist, there is an error in your config file." % connector)
170             if connector == internalConnector:
171                 raise Exception("%s is both internal and external, that doesn't make sense." % connector)
172     else:
173         externalConnectors = list(allConnectors.keys())
174         externalConnectors.remove(internalConnector)
175     if not externalConnectors:
176         raise Exception("No external connector found - either your config is wrong, or your machine has only one connector.")
177     # done!
178     return (internalConnector, externalConnectors)
179
180 # if we run top-level
181 if __name__ == "__main__":
182     try:
183         # parse command-line arguments
184         parser = argparse.ArgumentParser(description='easy Display Setup for Laptops')
185         parser.add_argument("-f", "--frontend",
186                             dest="frontend",
187                             help="The frontend to be used for user interaction")
188         parser.add_argument("-r", "--relative-position",
189                             dest="rel_position", choices=('left', 'right', 'external-only'),
190                             help="Position of external screen relative to internal one")
191         parser.add_argument("-i", "--internal-only",
192                             dest="internal_only", action='store_true',
193                             help="Enable internal screen, disable all the others (as if no external screen was connected")
194         cmdArgs = parser.parse_args()
195         
196         # load frontend
197         frontend = getFrontend(cmdArgs.frontend)
198         
199         # load connectors and classify them
200         connectors = getXrandrInformation()
201         (internalConnector, externalConnectors) = classifyConnectors(connectors)
202         
203         # default: screen off
204         connectorArgs = {} # maps connector names to xrand arguments
205         for c in externalConnectors+[internalConnector]:
206             connectorArgs[c] = ["--off"]
207         
208         # check whether we got an external screen or not
209         # Check what to do
210         usedExternalConnector = findAvailableConnector(externalConnectors, connectors) # *the* external connector which is actually used
211         hasExternal = not cmdArgs.internal_only and usedExternalConnector is not None
212         if hasExternal:
213             # there's an external screen connected, we need to get a setup
214             if cmdArgs.rel_position is not None:
215                 # use command-line arguments (can we do this relPosition stuff more elegant?)
216                 if cmdArgs.rel_position == 'left':
217                     relPosition = RelativeScreenPosition.LEFT
218                 elif cmdArgs.rel_position == 'right':
219                     relPosition = RelativeScreenPosition.RIGHT
220                 else:
221                     relPosition = RelativeScreenPosition.EXTERNAL_ONLY
222                 setup = ScreenSetup(relPosition, connectors[internalConnector][0], connectors[usedExternalConnector][0]) # use default resolutions
223             else:
224                 # use GUI
225                 setup = frontend.setup(connectors[internalConnector], connectors[usedExternalConnector])
226             if setup is None: sys.exit(1) # the user canceled
227             # apply it
228             connectorArgs[internalConnector] = setup.getInternalArgs()
229             connectorArgs[usedExternalConnector] = setup.getExternalArgs(internalConnector)
230         else:
231             # use first resolution of internal connector
232             connectorArgs[internalConnector] = ["--mode", res2xrandr(connectors[internalConnector][0]), "--primary"]
233         
234         # and do it
235         call = ["xrandr"]
236         for name in connectorArgs:
237             call += ["--output", name] + connectorArgs[name]
238         print("Call that will be made:",call)
239         subprocess.check_call(call)
240         
241         # make sure the internal screen is really, *really* turned on if there is no external screen
242         if not hasExternal:
243             backlight = float(subprocess.check_output(["xbacklight", "-get"]).strip())
244             if backlight == 0: # it's completely turned off, we better enable it
245                 subprocess.check_call(["xbacklight", "-set", "100"])
246     except Exception as e:
247         frontend.error(str(e))
248         raise