- add crawlDirectory helper function
[enigma2.git] / skin.py
1 from Tools.Profile import profile, profile_final
2 profile("LOAD:ElementTree")
3 import xml.etree.cElementTree
4 from os import path
5
6 profile("LOAD:enigma_skin")
7 from enigma import eSize, ePoint, gFont, eWindow, eLabel, ePixmap, eWindowStyleManager, \
8         addFont, gRGB, eWindowStyleSkinned
9
10 from Components.config import ConfigSubsection, ConfigText, config
11 from Components.Converter.Converter import Converter
12 from Components.Sources.Source import Source, ObsoleteSource
13 from Tools.Directories import resolveFilename, SCOPE_SKIN, SCOPE_SKIN_IMAGE, SCOPE_FONTS, SCOPE_CURRENT_SKIN, fileExists
14 from Tools.Import import my_import
15 from Tools.LoadPixmap import LoadPixmap
16
17 from Tools.XMLTools import elementsWithTag, mergeText
18
19 colorNames = dict()
20
21 def dump(x, i=0):
22         print " " * i + str(x)
23         try:
24                 for n in x.childNodes:
25                         dump(n, i + 1)
26         except:
27                 None
28
29 class SkinError(Exception):
30         def __init__(self, message):
31                 self.message = message
32
33         def __str__(self):
34                 return self.message
35
36 dom_skins = [ ]
37
38 def loadSkin(name):
39         # read the skin
40         filename = resolveFilename(SCOPE_SKIN, name)
41         mpath = path.dirname(filename) + "/"
42         dom_skins.append((mpath, xml.etree.cElementTree.parse(filename).getroot()))
43
44 # we do our best to always select the "right" value
45 # skins are loaded in order of priority: skin with
46 # highest priority is loaded last, usually the user-provided
47 # skin.
48
49 # currently, loadSingleSkinData (colors, bordersets etc.)
50 # are applied one-after-each, in order of ascending priority.
51 # the dom_skin will keep all screens in descending priority,
52 # so the first screen found will be used.
53
54 # example: loadSkin("nemesis_greenline/skin.xml")
55 config.skin = ConfigSubsection()
56 config.skin.primary_skin = ConfigText(default = "skin.xml")
57
58 profile("LoadSkin")
59 try:
60         loadSkin(config.skin.primary_skin.value)
61 except (SkinError, IOError, AssertionError), err:
62         print "SKIN ERROR:", err
63         print "defaulting to standard skin..."
64         config.skin.primary_skin.value = 'skin.xml'
65         loadSkin('skin.xml')
66
67 profile("LoadSkinDefault")
68 loadSkin('skin_default.xml')
69 profile("LoadSkinDefaultDone")
70
71 def parsePosition(str, scale):
72         x, y = str.split(',')
73         return ePoint(int(x) * scale[0][0] / scale[0][1], int(y) * scale[1][0] / scale[1][1])
74
75 def parseSize(str, scale):
76         x, y = str.split(',')
77         return eSize(int(x) * scale[0][0] / scale[0][1], int(y) * scale[1][0] / scale[1][1])
78
79 def parseFont(str, scale):
80         name, size = str.split(';')
81         return gFont(name, int(size) * scale[0][0] / scale[0][1])
82
83 def parseColor(str):
84         if str[0] != '#':
85                 try:
86                         return colorNames[str]
87                 except:
88                         raise SkinError("color '%s' must be #aarrggbb or valid named color" % (str))
89         return gRGB(int(str[1:], 0x10))
90
91 def collectAttributes(skinAttributes, node, skin_path_prefix=None, ignore=[]):
92         # walk all attributes
93         for a in node.items():
94                 #print a
95                 attrib = a[0]
96                 value = a[1]
97
98                 if attrib in ["pixmap", "pointer", "seek_pointer", "backgroundPixmap", "selectionPixmap"]:
99                         value = resolveFilename(SCOPE_SKIN_IMAGE, value, path_prefix=skin_path_prefix)
100
101                 if attrib not in ignore:
102                         skinAttributes.append((attrib, value))
103
104 def loadPixmap(path, desktop):
105         cached = False
106         option = path.find("#")
107         if option != -1:
108                 options = path[option+1:].split(',')
109                 path = path[:option]
110                 cached = "cached" in options
111         ptr = LoadPixmap(path, desktop, cached)
112         if ptr is None:
113                 raise SkinError("pixmap file %s not found!" % (path))
114         return ptr
115
116 def applySingleAttribute(guiObject, desktop, attrib, value, scale = ((1,1),(1,1))):
117         # and set attributes
118         try:
119                 if attrib == 'position':
120                         guiObject.move(parsePosition(value, scale))
121                 elif attrib == 'size':
122                         guiObject.resize(parseSize(value, scale))
123                 elif attrib == 'title':
124                         guiObject.setTitle(_(value))
125                 elif attrib == 'text':
126                         guiObject.setText(_(value))
127                 elif attrib == 'font':
128                         guiObject.setFont(parseFont(value, scale))
129                 elif attrib == 'zPosition':
130                         guiObject.setZPosition(int(value))
131                 elif attrib in ["pixmap", "backgroundPixmap", "selectionPixmap"]:
132                         ptr = loadPixmap(value, desktop) # this should already have been filename-resolved.
133                         if attrib == "pixmap":
134                                 guiObject.setPixmap(ptr)
135                         elif attrib == "backgroundPixmap":
136                                 guiObject.setBackgroundPicture(ptr)
137                         elif attrib == "selectionPixmap":
138                                 guiObject.setSelectionPicture(ptr)
139                         # guiObject.setPixmapFromFile(value)
140                 elif attrib == "alphatest": # used by ePixmap
141                         guiObject.setAlphatest(
142                                 { "on": 1,
143                                   "off": 0,
144                                   "blend": 2,
145                                 }[value])
146                 elif attrib == "orientation": # used by eSlider
147                         try:
148                                 guiObject.setOrientation(
149                                         { "orVertical": guiObject.orVertical,
150                                                 "orHorizontal": guiObject.orHorizontal
151                                         }[value])
152                         except KeyError:
153                                 print "oprientation must be either orVertical or orHorizontal!"
154                 elif attrib == "valign":
155                         try:
156                                 guiObject.setVAlign(
157                                         { "top": guiObject.alignTop,
158                                                 "center": guiObject.alignCenter,
159                                                 "bottom": guiObject.alignBottom
160                                         }[value])
161                         except KeyError:
162                                 print "valign must be either top, center or bottom!"
163                 elif attrib == "halign":
164                         try:
165                                 guiObject.setHAlign(
166                                         { "left": guiObject.alignLeft,
167                                                 "center": guiObject.alignCenter,
168                                                 "right": guiObject.alignRight,
169                                                 "block": guiObject.alignBlock
170                                         }[value])
171                         except KeyError:
172                                 print "halign must be either left, center, right or block!"
173                 elif attrib == "flags":
174                         flags = value.split(',')
175                         for f in flags:
176                                 try:
177                                         fv = eWindow.__dict__[f]
178                                         guiObject.setFlag(fv)
179                                 except KeyError:
180                                         print "illegal flag %s!" % f
181                 elif attrib == "backgroundColor":
182                         guiObject.setBackgroundColor(parseColor(value))
183                 elif attrib == "backgroundColorSelected":
184                         guiObject.setBackgroundColorSelected(parseColor(value))
185                 elif attrib == "foregroundColor":
186                         guiObject.setForegroundColor(parseColor(value))
187                 elif attrib == "foregroundColorSelected":
188                         guiObject.setForegroundColorSelected(parseColor(value))
189                 elif attrib == "shadowColor":
190                         guiObject.setShadowColor(parseColor(value))
191                 elif attrib == "selectionDisabled":
192                         guiObject.setSelectionEnable(0)
193                 elif attrib == "transparent":
194                         guiObject.setTransparent(int(value))
195                 elif attrib == "borderColor":
196                         guiObject.setBorderColor(parseColor(value))
197                 elif attrib == "borderWidth":
198                         guiObject.setBorderWidth(int(value))
199                 elif attrib == "scrollbarMode":
200                         guiObject.setScrollbarMode(
201                                 { "showOnDemand": guiObject.showOnDemand,
202                                         "showAlways": guiObject.showAlways,
203                                         "showNever": guiObject.showNever
204                                 }[value])
205                 elif attrib == "enableWrapAround":
206                         guiObject.setWrapAround(True)
207                 elif attrib == "pointer" or attrib == "seek_pointer":
208                         (name, pos) = value.split(':')
209                         pos = parsePosition(pos, scale)
210                         ptr = loadPixmap(name, desktop)
211                         guiObject.setPointer({"pointer": 0, "seek_pointer": 1}[attrib], ptr, pos)
212                 elif attrib == 'shadowOffset':
213                         guiObject.setShadowOffset(parsePosition(value, scale))
214                 elif attrib == 'noWrap':
215                         guiObject.setNoWrap(1)
216                 else:
217                         raise SkinError("unsupported attribute " + attrib + "=" + value)
218         except int:
219 # AttributeError:
220                 print "widget %s (%s) doesn't support attribute %s!" % ("", guiObject.__class__.__name__, attrib)
221
222 def applyAllAttributes(guiObject, desktop, attributes, scale):
223         for (attrib, value) in attributes:
224                 applySingleAttribute(guiObject, desktop, attrib, value, scale)
225
226 def loadSingleSkinData(desktop, skin, path_prefix):
227         """loads skin data like colors, windowstyle etc."""
228         assert skin.tag == "skin", "root element in skin must be 'skin'!"
229
230         #print "***SKIN: ", path_prefix
231
232         for c in skin.findall("output"):
233                 id = c.attrib.get('id')
234                 if id:
235                         id = int(id)
236                 else:
237                         id = 0
238                 if id == 0: # framebuffer
239                         for res in c.findall("resolution"):
240                                 get_attr = c.attrib.get
241                                 xres = get_attr("xres")
242                                 if xres:
243                                         xres = int(xres)
244                                 else:
245                                         xres = 720
246                                 yres = get_attr("yres")
247                                 if yres:
248                                         yres = int(yres)
249                                 else:
250                                         yres = 576
251                                 bpp = get_attr("bpp")
252                                 if bpp:
253                                         bpp = int(bpp)
254                                 else:
255                                         bpp = 32
256                                 #print "Resolution:", xres,yres,bpp
257                                 from enigma import gFBDC
258                                 gFBDC.getInstance().setResolution(xres, yres)
259                                 if bpp != 32:
260                                         # load palette (not yet implemented)
261                                         pass
262
263         for c in skin.findall("colors"):
264                 for color in c.findall("color"):
265                         get_attr = color.attrib.get
266                         name = get_attr("name")
267                         color = get_attr("value")
268                         if name and color:
269                                 colorNames[name] = parseColor(color)
270                                 #print "Color:", name, color
271                         else:
272                                 raise ("need color and name, got %s %s" % (name, color))
273
274         for c in skin.findall("fonts"):
275                 for font in c.findall("font"):
276                         get_attr = font.attrib.get
277                         filename = get_attr("filename", "<NONAME>")
278                         name = get_attr("name", "Regular")
279                         scale = get_attr("scale")
280                         if scale:
281                                 scale = int(scale)
282                         else:
283                                 scale = 100
284                         is_replacement = get_attr("replacement") and True or False
285                         resolved_font = resolveFilename(SCOPE_FONTS, filename, path_prefix=path_prefix)
286                         if not fileExists(resolved_font): #when font is not available look at current skin path
287                                 skin_path = resolveFilename(SCOPE_CURRENT_SKIN, filename)
288                                 if fileExists(skin_path):
289                                         resolved_font = skin_path
290                         addFont(resolved_font, name, scale, is_replacement)
291                         #print "Font: ", resolved_font, name, scale, is_replacement
292
293         for windowstyle in skin.findall("windowstyle"):
294                 style = eWindowStyleSkinned()
295                 id = windowstyle.attrib.get("id")
296                 if id:
297                         id = int(id)
298                 else:
299                         id = 0
300                 #print "windowstyle:", id
301
302                 # defaults
303                 font = gFont("Regular", 20)
304                 offset = eSize(20, 5)
305
306                 for title in windowstyle.findall("title"):
307                         get_attr = title.attrib.get
308                         offset = parseSize(get_attr("offset"), ((1,1),(1,1)))
309                         font = parseFont(get_attr("font"), ((1,1),(1,1)))
310
311                 style.setTitleFont(font);
312                 style.setTitleOffset(offset)
313                 #print "  ", font, offset
314
315                 for borderset in windowstyle.findall("borderset"):
316                         bsName = str(borderset.attrib.get("name"))
317                         for pixmap in borderset.findall("pixmap"):
318                                 get_attr = pixmap.attrib.get
319                                 bpName = get_attr("pos")
320                                 filename = get_attr("filename")
321                                 if filename and bpName:
322                                         png = loadPixmap(resolveFilename(SCOPE_SKIN_IMAGE, filename, path_prefix=path_prefix), desktop)
323                                         style.setPixmap(eWindowStyleSkinned.__dict__[bsName], eWindowStyleSkinned.__dict__[bpName], png)
324                                 #print "  borderset:", bpName, filename
325
326                 for color in windowstyle.findall("color"):
327                         get_attr = color.attrib.get
328                         type = get_attr("name")
329                         color = parseColor(get_attr("color"))
330                         try:
331                                 style.setColor(eWindowStyleSkinned.__dict__["col" + type], color)
332                         except:
333                                 raise ("Unknown color %s" % (type))
334                                 #pass
335
336                         #print "  color:", type, color
337
338                 x = eWindowStyleManager.getInstance()
339                 x.setStyle(id, style)
340
341 def loadSkinData(desktop):
342         skins = dom_skins[:]
343         skins.reverse()
344         for (path, dom_skin) in skins:
345                 loadSingleSkinData(desktop, dom_skin, path)
346
347 def lookupScreen(name):
348         for (path, skin) in dom_skins:
349                 # first, find the corresponding screen element
350                 for x in skin.findall("screen"):
351                         if x.attrib.get('name', '') == name:
352                                 return x, path
353         return None, None
354
355 class additionalWidget:
356         pass
357
358 def readSkin(screen, skin, names, desktop):
359         if not isinstance(names, list):
360                 names = [names]
361
362         name = "<embedded-in-'%s'>" % screen.__class__.__name__
363
364         # try all skins, first existing one have priority
365         for n in names:
366                 myscreen, path = lookupScreen(n)
367                 if myscreen is not None:
368                         # use this name for debug output
369                         name = n
370                         break
371
372         # otherwise try embedded skin
373         if myscreen is None:
374                 myscreen = getattr(screen, "parsedSkin", None)
375
376         # try uncompiled embedded skin
377         if myscreen is None and getattr(screen, "skin", None):
378                 print "Looking for embedded skin"
379                 myscreen = screen.parsedSkin = xml.etree.cElementTree.fromstring(screen.skin)
380
381         #assert myscreen is not None, "no skin for screen '" + repr(names) + "' found!"
382         if myscreen is None:
383                 print "No skin to read..."
384                 emptySkin = "<screen></screen>"
385                 myscreen = screen.parsedSkin = xml.etree.cElementTree.fromstring(emptySkin)
386
387         screen.skinAttributes = [ ]
388
389         skin_path_prefix = getattr(screen, "skin_path", path)
390
391         collectAttributes(screen.skinAttributes, myscreen, skin_path_prefix, ignore=["name"])
392
393         screen.additionalWidgets = [ ]
394         screen.renderer = [ ]
395
396         visited_components = set()
397
398         # now walk all widgets
399         for widget in myscreen.findall("widget"):
400                 get_attr = widget.attrib.get
401                 # ok, we either have 1:1-mapped widgets ('old style'), or 1:n-mapped
402                 # widgets (source->renderer).
403
404                 wname = get_attr('name')
405                 wsource = get_attr('source')
406
407                 if wname is None and wsource is None:
408                         print "widget has no name and no source!"
409                         continue
410
411                 if wname:
412                         #print "Widget name=", wname
413                         visited_components.add(wname)
414
415                         # get corresponding 'gui' object
416                         try:
417                                 attributes = screen[wname].skinAttributes = [ ]
418                         except:
419                                 raise SkinError("component with name '" + wname + "' was not found in skin of screen '" + name + "'!")
420                                 #print "WARNING: component with name '" + wname + "' was not found in skin of screen '" + name + "'!"
421
422 #                       assert screen[wname] is not Source
423
424                         # and collect attributes for this
425                         collectAttributes(attributes, widget, skin_path_prefix, ignore=['name'])
426                 elif wsource:
427                         # get corresponding source
428                         #print "Widget source=", wsource
429
430                         while True: # until we found a non-obsolete source
431
432                                 # parse our current "wsource", which might specifiy a "related screen" before the dot,
433                                 # for example to reference a parent, global or session-global screen.
434                                 scr = screen
435
436                                 # resolve all path components
437                                 path = wsource.split('.')
438                                 while len(path) > 1:
439                                         scr = screen.getRelatedScreen(path[0])
440                                         if scr is None:
441                                                 #print wsource
442                                                 #print name
443                                                 raise SkinError("specified related screen '" + wsource + "' was not found in screen '" + name + "'!")
444                                         path = path[1:]
445
446                                 # resolve the source.
447                                 source = scr.get(path[0])
448                                 if isinstance(source, ObsoleteSource):
449                                         # however, if we found an "obsolete source", issue warning, and resolve the real source.
450                                         print "WARNING: SKIN '%s' USES OBSOLETE SOURCE '%s', USE '%s' INSTEAD!" % (name, wsource, source.new_source)
451                                         print "OBSOLETE SOURCE WILL BE REMOVED %s, PLEASE UPDATE!" % (source.removal_date)
452                                         if source.description:
453                                                 print source.description
454
455                                         wsource = source.new_source
456                                 else:
457                                         # otherwise, use that source.
458                                         break
459
460                         if source is None:
461                                 raise SkinError("source '" + wsource + "' was not found in screen '" + name + "'!")
462
463                         wrender = get_attr('render')
464
465                         if not wrender:
466                                 raise SkinError("you must define a renderer with render= for source '%s'" % (wsource))
467
468                         for converter in widget.findall("convert"):
469                                 ctype = converter.get('type')
470                                 assert ctype, "'convert'-tag needs a 'type'-attribute"
471                                 #print "Converter:", ctype
472                                 #parms = mergeText(converter.childNodes).strip()
473                                 try:
474                                         parms = converter.text.strip()
475                                 except:
476                                         parms = ""
477                                 #print "Params:", ctype
478                                 converter_class = my_import('.'.join(["Components", "Converter", ctype])).__dict__.get(ctype)
479
480                                 c = None
481
482                                 for i in source.downstream_elements:
483                                         if isinstance(i, converter_class) and i.converter_arguments == parms:
484                                                 c = i
485
486                                 if c is None:
487                                         print "allocating new converter!"
488                                         c = converter_class(parms)
489                                         c.connect(source)
490                                 else:
491                                         print "reused converter!"
492
493                                 source = c
494
495                         renderer_class = my_import('.'.join(["Components", "Renderer", wrender])).__dict__.get(wrender)
496
497                         renderer = renderer_class() # instantiate renderer
498
499                         renderer.connect(source) # connect to source
500                         attributes = renderer.skinAttributes = [ ]
501                         collectAttributes(attributes, widget, skin_path_prefix, ignore=['render', 'source'])
502
503                         screen.renderer.append(renderer)
504
505         from Components.GUIComponent import GUIComponent
506         nonvisited_components = [x for x in set(screen.keys()) - visited_components if isinstance(x, GUIComponent)]
507         assert not nonvisited_components, "the following components in %s don't have a skin entry: %s" % (name, ', '.join(nonvisited_components))
508
509         # now walk additional objects
510         for widget in myscreen.getchildren():
511                 w_tag = widget.tag
512
513                 if w_tag == "widget":
514                         continue
515
516                 if w_tag == "applet":
517                         try:
518                                 codeText = widget.text.strip()
519                         except:
520                                 codeText = ""
521
522                         #print "Found code:"
523                         #print codeText
524                         type = widget.attrib.get('type')
525
526                         code = compile(codeText, "skin applet", "exec")
527
528                         if type == "onLayoutFinish":
529                                 screen.onLayoutFinish.append(code)
530                                 #print "onLayoutFinish = ", codeText
531                         else:
532                                 raise SkinError("applet type '%s' unknown!" % type)
533                                 #print "applet type '%s' unknown!" % type
534
535                         continue
536
537                 w = additionalWidget()
538
539                 if w_tag == "eLabel":
540                         w.widget = eLabel
541                 elif w_tag == "ePixmap":
542                         w.widget = ePixmap
543                 else:
544                         raise SkinError("unsupported stuff : %s" % w_tag)
545                         #print "unsupported stuff : %s" % widget.tag
546
547                 w.skinAttributes = [ ]
548                 collectAttributes(w.skinAttributes, widget, skin_path_prefix, ignore=['name'])
549
550                 # applyAttributes(guiObject, widget, desktop)
551                 # guiObject.thisown = 0
552                 screen.additionalWidgets.append(w)