Merge branch 'master' of git.opendreambox.org:/git/enigma2
[enigma2.git] / lib / python / Components / DreamInfoHandler.py
1 # -*- coding: iso-8859-1 -*-
2 import xml.sax
3 from Tools.Directories import crawlDirectory, resolveFilename, SCOPE_CONFIG, SCOPE_SKIN, SCOPE_METADIR, copyfile, copytree
4 from Components.NimManager import nimmanager
5 from Components.Ipkg import IpkgComponent
6 from Components.config import config, configfile
7 from Tools.HardwareInfo import HardwareInfo
8 from enigma import eConsoleAppContainer, eDVBDB
9 import os
10 from re import compile as re_compile, search as re_search, IGNORECASE
11
12 class InfoHandlerParseError(Exception):
13         def __init__(self, value):
14                 self.value = value
15         def __str__(self):
16                 return repr(self.value)
17
18 class InfoHandler(xml.sax.ContentHandler):
19         def __init__(self, prerequisiteMet, directory, language = None):
20                 self.attributes = {}
21                 self.directory = directory
22                 self.list = []
23                 self.globalprerequisites = {}
24                 self.prerequisites = {}
25                 self.elements = []
26                 self.validFileTypes = ["skin", "config", "services", "favourites", "package"]
27                 self.prerequisitesMet = prerequisiteMet
28                 self.data = ""
29                 self.language = language
30                 self.translatedPackageInfos = {}
31                 self.foundTranslation = None
32
33         def printError(self, error):
34                 print "Error in defaults xml files:", error
35                 raise InfoHandlerParseError, error
36
37         def startElement(self, name, attrs):
38                 #print name, ":", attrs.items()
39                 self.elements.append(name)
40
41                 if name in ("hardware", "bcastsystem", "satellite", "tag", "flag"):
42                         if not attrs.has_key("type"):
43                                         self.printError(str(name) + " tag with no type attribute")
44                         if self.elements[-3] in ("default", "package"):
45                                 prerequisites = self.globalprerequisites
46                         else:
47                                 prerequisites = self.prerequisites
48                         if not prerequisites.has_key(name):
49                                 prerequisites[name] = []
50                         prerequisites[name].append(str(attrs["type"]))
51
52                 if name == "info":
53                         self.foundTranslation = None
54                         self.data = ""
55                         if not attrs.has_key("language"):
56                                         print "info tag with no language attribute"
57                         else:
58                                 if attrs["language"] == 'en': # read default translations
59                                         self.foundTranslation = False
60                                         self.data = ""
61                                 elif attrs["language"] == self.language:
62                                         self.foundTranslation = True
63                                         self.data = ""
64
65                 if name == "files":
66                         if attrs.has_key("type"):
67                                 if attrs["type"] == "directories":
68                                         self.attributes["filestype"] = "directories"
69                                 elif attrs["type"] == "package":
70                                         self.attributes["filestype"] = "package"
71                                 # TODO add a compressed archive type
72
73                 if name == "file":
74                         self.prerequisites = {}
75                         if not attrs.has_key("type"):
76                                 self.printError("file tag with no type attribute")
77                         else:
78                                 if not attrs.has_key("name"):
79                                         self.printError("file tag with no name attribute")
80                                 else:   
81                                         if not attrs.has_key("directory"):
82                                                 directory = self.directory
83                                         type = attrs["type"]
84                                         if not type in self.validFileTypes:
85                                                 self.printError("file tag with invalid type attribute")
86                                         else:
87                                                 self.filetype = type
88                                                 self.fileattrs = attrs
89
90                 if name == "package":
91                         if attrs.has_key("details"):
92                                 self.attributes["details"] = str(attrs["details"])
93                         if attrs.has_key("name"):
94                                 self.attributes["name"] = str(attrs["name"].encode("utf-8"))
95                         if attrs.has_key("packagename"):
96                                 self.attributes["packagename"] = str(attrs["packagename"].encode("utf-8"))
97                         if attrs.has_key("shortdescription"):
98                                 self.attributes["shortdescription"] = str(attrs["shortdescription"].encode("utf-8"))
99
100                 if name == "screenshot":
101                         if attrs.has_key("src"):
102                                 if self.foundTranslation is False:
103                                         self.attributes["screenshot"] = str(attrs["src"])
104                                 elif self.foundTranslation is True:
105                                         self.translatedPackageInfos["screenshot"] = str(attrs["src"])
106
107         def endElement(self, name):
108                 #print "endElement", name
109                 #print "self.elements:", self.elements
110                 self.elements.pop()
111                 if name == "file":
112                         #print "prerequisites:", self.prerequisites
113                         if len(self.prerequisites) == 0 or self.prerequisitesMet(self.prerequisites):
114                                 if not self.attributes.has_key(self.filetype):
115                                         self.attributes[self.filetype] = []
116                                 if self.fileattrs.has_key("directory"):
117                                         directory = str(self.fileattrs["directory"])
118                                         if len(directory) < 1 or directory[0] != "/":
119                                                 directory = self.directory + directory
120                                 else:
121                                         directory = self.directory
122                                 self.attributes[self.filetype].append({ "name": str(self.fileattrs["name"]), "directory": directory })
123
124                 if name in ( "default", "package" ):
125                         self.list.append({"attributes": self.attributes, 'prerequisites': self.globalprerequisites ,"translation": self.translatedPackageInfos})
126                         self.attributes = {}
127                         self.globalprerequisites = {}
128
129         def characters(self, data):
130                 if self.elements[-1] == "author":
131                         self.attributes["author"] = str(data)
132                 if self.elements[-1] == "name":
133                         self.attributes["name"] = str(data)
134                 if self.foundTranslation is False:
135                         if self.elements[-1] == "author":
136                                 self.attributes["author"] = str(data)
137                         if self.elements[-1] == "name":
138                                 self.attributes["name"] = str(data)
139                         if self.elements[-1] == "packagename":
140                                 self.attributes["packagename"] = str(data.encode("utf-8"))
141                         if self.elements[-1] == "shortdescription":
142                                 self.attributes["shortdescription"] = str(data.encode("utf-8"))
143                         if self.elements[-1] == "description":
144                                 self.data += data.strip()
145                                 self.attributes["description"] = str(self.data.encode("utf-8"))
146                 elif self.foundTranslation is True:
147                         if self.elements[-1] == "author":
148                                 self.translatedPackageInfos["author"] = str(data)
149                         if self.elements[-1] == "name":
150                                 self.translatedPackageInfos["name"] = str(data)
151                         if self.elements[-1] == "description":
152                                 self.data += data.strip()
153                                 self.translatedPackageInfos["description"] = str(self.data.encode("utf-8"))
154                         if self.elements[-1] == "name":
155                                 self.translatedPackageInfos["name"] = str(data.encode("utf-8"))
156                         if self.elements[-1] == "shortdescription":
157                                 self.translatedPackageInfos["shortdescription"] = str(data.encode("utf-8"))
158                 #print "characters", data
159
160
161 class DreamInfoHandler:
162         STATUS_WORKING = 0
163         STATUS_DONE = 1
164         STATUS_ERROR = 2
165         STATUS_INIT = 4
166
167         def __init__(self, statusCallback, blocking = False, neededTag = None, neededFlag = None, language = None):
168                 self.hardware_info = HardwareInfo()
169                 self.directory = "/"
170
171                 self.neededTag = neededTag
172                 self.neededFlag = neededFlag
173                 self.language = language
174
175                 # caution: blocking should only be used, if further execution in enigma2 depends on the outcome of
176                 # the installer!
177                 self.blocking = blocking
178
179                 self.currentlyInstallingMetaIndex = None
180
181                 self.console = eConsoleAppContainer()
182                 self.console.appClosed.append(self.installNext)
183                 self.reloadFavourites = False
184
185                 self.statusCallback = statusCallback
186                 self.setStatus(self.STATUS_INIT)
187
188                 self.packageslist = []
189                 self.packagesIndexlist = []
190                 self.packageDetails = []
191
192         def readInfo(self, directory, file):
193                 print "Reading .info file", file
194                 handler = InfoHandler(self.prerequisiteMet, directory)
195                 try:
196                         xml.sax.parse(file, handler)
197                         for entry in handler.list:
198                                 self.packageslist.append((entry,file)) 
199                 except InfoHandlerParseError:
200                         print "file", file, "ignored due to errors in the file"
201                 #print handler.list
202
203         def readIndex(self, directory, file):
204                 print "Reading .xml meta index file", file
205                 handler = InfoHandler(self.prerequisiteMet, directory, self.language)
206                 try:
207                         xml.sax.parse(file, handler)
208                         for entry in handler.list:
209                                 self.packagesIndexlist.append((entry,file))
210                 except InfoHandlerParseError:
211                         print "file", file, "ignored due to errors in the file"
212                 #print handler.list
213
214         def readDetails(self, directory, file):
215                 self.packageDetails = []
216                 print "Reading .xml meta details file", file
217                 handler = InfoHandler(self.prerequisiteMet, directory, self.language)
218                 try:
219                         xml.sax.parse(file, handler)
220                         for entry in handler.list:
221                                 self.packageDetails.append((entry,file))
222                 except InfoHandlerParseError:
223                         print "file", file, "ignored due to errors in the file"
224                 #print handler.list
225
226
227         # prerequisites = True: give only packages matching the prerequisites
228         def fillPackagesList(self, prerequisites = True):
229                 self.packageslist = []
230                 packages = []
231                 if not isinstance(self.directory, list):
232                         self.directory = [self.directory]
233
234                 for directory in self.directory:
235                         packages += crawlDirectory(directory, ".*\.info$")
236
237                 for package in packages:
238                         self.readInfo(package[0] + "/", package[0] + "/" + package[1])
239
240                 if prerequisites:
241                         for package in self.packageslist[:]:
242                                 if not self.prerequisiteMet(package[0]["prerequisites"]):
243                                         self.packageslist.remove(package)
244                 return self.packageslist
245
246         # prerequisites = True: give only packages matching the prerequisites
247         def fillPackagesIndexList(self, prerequisites = True):
248                 self.packagesIndexlist = []
249                 indexfileList = []
250
251                 if not isinstance(self.directory, list):
252                         self.directory = [self.directory]
253
254                 for indexfile in os.listdir(self.directory[0]):
255                         if indexfile.startswith("index"):
256                                 if os.path.splitext(indexfile)[0][-3:-2] is not "_": #we first catch all non translated indexfiles
257                                         indexfileList.append(os.path.splitext(indexfile)[0])
258
259                 if len(indexfileList):
260                         for file in indexfileList:
261                                 neededFile = self.directory[0] + "/" + file
262                                 if self.language is not None:
263                                         if os.path.exists(neededFile + '_' + self.language + '.xml' ):
264                                                 #print "translated index file found",neededFile + '_' + self.language + '.xml'
265                                                 self.readIndex(self.directory[0] + "/", neededFile + '_' + self.language + '.xml')
266                                         else:
267                                                 #print "reading original index file"
268                                                 self.readIndex(self.directory[0] + "/", neededFile + '.xml')
269
270                 if prerequisites:
271                         for package in self.packagesIndexlist[:]:
272                                 if not self.prerequisiteMet(package[0]["prerequisites"]):
273                                         self.packagesIndexlist.remove(package)
274                 return self.packagesIndexlist
275
276         # prerequisites = True: give only packages matching the prerequisites
277         def fillPackageDetails(self, details = None):
278                 self.packageDetails = []
279                 detailsfile = details
280                 if not isinstance(self.directory, list):
281                         self.directory = [self.directory]
282                 self.readDetails(self.directory[0] + "/", self.directory[0] + "/" + detailsfile)
283                 return self.packageDetails
284                         
285         def prerequisiteMet(self, prerequisites):
286                 # TODO: we need to implement a hardware detection here...
287                 print "prerequisites:", prerequisites
288                 met = True
289                 if self.neededTag is None:
290                         if prerequisites.has_key("tag"):
291                                 return False
292                 elif self.neededTag == 'ALL_TAGS':
293                                 return True
294                 else:
295                         if prerequisites.has_key("tag"):
296                                 if not self.neededTag in prerequisites["tag"]:
297                                         return False
298                         else:
299                                 return False
300
301                 if self.neededFlag is None:
302                         if prerequisites.has_key("flag"):
303                                 return False
304                 else:
305                         if prerequisites.has_key("flag"):
306                                 if not self.neededFlag in prerequisites["flag"]:
307                                         return False
308                         else:
309                                 return True # No flag found, assuming all flags valid
310                                 
311                 if prerequisites.has_key("satellite"):
312                         for sat in prerequisites["satellite"]:
313                                 if int(sat) not in nimmanager.getConfiguredSats():
314                                         return False                    
315                 if prerequisites.has_key("bcastsystem"):
316                         has_system = False
317                         for bcastsystem in prerequisites["bcastsystem"]:
318                                 if nimmanager.hasNimType(bcastsystem):
319                                         has_system = True
320                         if not has_system:
321                                 return False
322                 if prerequisites.has_key("hardware"):
323                         hardware_found = False
324                         for hardware in prerequisites["hardware"]:
325                                 if hardware == self.hardware_info.device_name:
326                                         hardware_found = True
327                         if not hardware_found:
328                                 return False
329                 return True
330         
331         def installPackages(self, indexes):
332                 print "installing packages", indexes
333                 if len(indexes) == 0:
334                         self.setStatus(self.STATUS_DONE)
335                         return
336                 self.installIndexes = indexes
337                 print "+++++++++++++++++++++++bla"
338                 self.currentlyInstallingMetaIndex = 0
339                 self.installPackage(self.installIndexes[self.currentlyInstallingMetaIndex])
340
341         def installPackage(self, index):
342                 print "self.packageslist:", self.packageslist
343                 if len(self.packageslist) <= index:
344                         print "no package with index", index, "found... installing nothing"
345                         return
346                 print "installing package with index", index, "and name", self.packageslist[index][0]["attributes"]["name"]
347                 
348                 attributes = self.packageslist[index][0]["attributes"]
349                 self.installingAttributes = attributes
350                 self.attributeNames = ["skin", "config", "favourites", "package", "services"]
351                 self.currentAttributeIndex = 0
352                 self.currentIndex = -1
353                 self.installNext()
354                 
355         def setStatus(self, status):
356                 self.status = status
357                 self.statusCallback(self.status, None)
358                                                 
359         def installNext(self, *args, **kwargs):
360                 if self.reloadFavourites:
361                         self.reloadFavourites = False
362                         db = eDVBDB.getInstance().reloadBouquets()
363
364                 self.currentIndex += 1
365                 attributes = self.installingAttributes
366                 #print "attributes:", attributes
367                 
368                 if self.currentAttributeIndex >= len(self.attributeNames): # end of package reached
369                         print "end of package reached"
370                         if self.currentlyInstallingMetaIndex is None or self.currentlyInstallingMetaIndex >= len(self.installIndexes) - 1:
371                                 print "set status to DONE"
372                                 self.setStatus(self.STATUS_DONE)
373                                 return
374                         else:
375                                 print "increment meta index to install next package"
376                                 self.currentlyInstallingMetaIndex += 1
377                                 self.currentAttributeIndex = 0
378                                 self.installPackage(self.installIndexes[self.currentlyInstallingMetaIndex])
379                                 return
380                 
381                 self.setStatus(self.STATUS_WORKING)             
382                 
383                 print "currentAttributeIndex:", self.currentAttributeIndex
384                 currentAttribute = self.attributeNames[self.currentAttributeIndex]
385                 
386                 print "installing", currentAttribute, "with index", self.currentIndex
387                 
388                 if attributes.has_key(currentAttribute):
389                         if self.currentIndex >= len(attributes[currentAttribute]): # all jobs done for current attribute
390                                 self.currentIndex = -1
391                                 self.currentAttributeIndex += 1
392                                 self.installNext()
393                                 return
394                 else: # nothing to install here
395                         self.currentIndex = -1
396                         self.currentAttributeIndex += 1
397                         self.installNext()
398                         return
399                         
400                 if currentAttribute == "skin":
401                         skin = attributes["skin"][self.currentIndex]
402                         self.installSkin(skin["directory"], skin["name"])
403                 elif currentAttribute == "config":
404                         if self.currentIndex == 0:
405                                 from Components.config import configfile
406                                 configfile.save()
407                         config = attributes["config"][self.currentIndex]
408                         self.mergeConfig(config["directory"], config["name"])
409                 elif currentAttribute == "favourites":
410                         favourite = attributes["favourites"][self.currentIndex]
411                         self.installFavourites(favourite["directory"], favourite["name"])
412                 elif currentAttribute == "package":
413                         package = attributes["package"][self.currentIndex]
414                         self.installIPK(package["directory"], package["name"])
415                 elif currentAttribute == "services":
416                         service = attributes["services"][self.currentIndex]
417                         self.mergeServices(service["directory"], service["name"])
418                                 
419         def readfile(self, filename):
420                 if not os.path.isfile(filename):
421                         return []
422                 fd = open(filename)
423                 lines = fd.readlines()
424                 fd.close()
425                 return lines
426                         
427         def mergeConfig(self, directory, name, merge = True):
428                 print "merging config:", directory, " - ", name
429                 if os.path.isfile(directory + name):
430                         config.loadFromFile(directory + name)
431                         configfile.save()
432                 self.installNext()
433                 
434         def installIPK(self, directory, name):
435                 if self.blocking:
436                         os.system("ipkg install " + directory + name)
437                         self.installNext()
438                 else:
439                         self.ipkg = IpkgComponent()
440                         self.ipkg.addCallback(self.ipkgCallback)
441                         self.ipkg.startCmd(IpkgComponent.CMD_INSTALL, {'package': directory + name})
442                 
443         def ipkgCallback(self, event, param):
444                 print "ipkgCallback"
445                 if event == IpkgComponent.EVENT_DONE:
446                         self.installNext()
447                 elif event == IpkgComponent.EVENT_ERROR:
448                         self.installNext()
449         
450         def installSkin(self, directory, name):
451                 print "installing skin:", directory, " - ", name
452                 print "cp -a %s %s" % (directory, resolveFilename(SCOPE_SKIN))
453                 if self.blocking:
454                         copytree(directory, resolveFilename(SCOPE_SKIN))
455                         self.installNext()
456                 else:
457                         if self.console.execute("cp -a %s %s" % (directory, resolveFilename(SCOPE_SKIN))):
458                                 print "execute failed"
459                                 self.installNext()
460
461         def mergeServices(self, directory, name, merge = False):
462                 print "merging services:", directory, " - ", name
463                 if os.path.isfile(directory + name):
464                         db = eDVBDB.getInstance()
465                         db.reloadServicelist()
466                         db.loadServicelist(directory + name)
467                         db.saveServicelist()
468                 self.installNext()
469
470         def installFavourites(self, directory, name):
471                 print "installing favourites:", directory, " - ", name
472                 self.reloadFavourites = True
473
474                 if self.blocking:
475                         copyfile(directory + name, resolveFilename(SCOPE_CONFIG))
476                         self.installNext()
477                 else:
478                         if self.console.execute("cp %s %s" % ((directory + name), resolveFilename(SCOPE_CONFIG))):
479                                 print "execute failed"
480                                 self.installNext()