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