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