source: lliurex-store/trunk/fuentes/python3-lliurex-store.install/usr/share/lliurexstore/storeManager.py @ 5187

Last change on this file since 5187 was 5187, checked in by Juanma, 2 years ago

added appImage catalogue download

File size: 20.1 KB
Line 
1#!/usr/bin/python3
2import sys
3import os
4import threading
5import syslog
6import pkgutil
7import lliurexstore.plugins as plugins
8import json
9######
10#Ver. 1.0 of storeManager.py
11# This class manages the store and the related plugins
12# It's implemented as an action-drived class.
13# There're four(five) main actions and each of them could execute and undeterminated number of subprocess in their respective thread
14# Each of these actions returns EVER a list of dictionaries.
15#####
16
17class StoreManager:
18        def __init__(self,args=()):
19                #               self.store=appstream.Store()
20                self.store=None
21                self.relatedActions={
22                                        'load':['load'],
23                                        'search':['search','get_info','pkginfo'],
24                                        'list':['list','get_info','pkginfo'],
25                                        'info':['list','get_info','pkginfo'],
26                                        'list_sections':['list_sections'],
27                                        'install':['search','get_info','pkginfo','install'],
28                                        'remove':['search','get_info','pkginfo','remove']
29                                        }
30                self.loadBundles=False
31                self.dbg=0
32                if args[0]==1:
33                        self.loadBundles=True
34                if args[1]==1:
35                        self.dbg=args
36                self.threads={}                         #Dict that stores the functions that must execute each action
37                self.threadsProgress={}                 #"" "" "" the progress for each launched thread
38                self.threadsRunning={}                  #"" "" "" the running threads
39                self.registeredPlugins={}               #Dict that have the relation between plugins and actions
40                self.registerProcessProgress={}         #Dict that stores the progress for each function/parentAction pair
41                self.progressActions={}                 #Progress of global actions based on average progress of individual processes
42                self.extraActions={}            #Dict that have the actions managed by plugins and no defined on the main class as relatedActions
43                self.result={}                          #Result of the actions
44                self.lock=threading.Lock()              #locker for functions related to threads (get_progress, is_action_running...)
45                self.main()
46        #def __init__
47
48        def main(self):
49                self._define_functions_for_threads()    #Function that loads the dictionary self.threads
50                self.__init_plugins__()                 #Function that loads the plugins
51                self.execute_action('load')             #Initial load of the store
52        #def main
53
54        ####
55        #Load and register the plugins from plugin dir
56        ####
57        def __init_plugins__(self):
58                package=plugins
59                for importer, mod, ispkg in pkgutil.walk_packages(path=package.__path__, prefix=package.__name__+'.',onerror=lambda x: None):
60                        strImport='from '+mod+' import *'
61                        try:
62                                self._debug("Importing "+str(mod))
63                                exec (strImport)
64                        except Exception as e:
65                                print(str(e))
66
67                for mod in (sys.modules.keys()):
68                        if 'plugins.' in mod:
69                                definedActions={}
70                                pluginNameUp=mod.split('.')[-1]
71                                pluginName=pluginNameUp.lower()
72                                self._debug("Initializing "+str(pluginName))
73                                try:
74                                        loadedClass=eval(pluginName)()
75                                        definedActions=loadedClass.register()
76                                except Exception as e:
77                                        print ("Can't initialize "+str(mod)+' '+str(loadedClass))
78                                        print ("Reason: "+str(e))
79                                        pass
80                       
81                                for action in definedActions.keys():
82                                        if action not in self.registeredPlugins:
83                                                self.registeredPlugins[action]={}
84                                        self.registeredPlugins[action].update({definedActions[action]:'plugins.'+pluginNameUp+'.'+pluginName})
85                self._debug(str(self.registeredPlugins))
86        #def __init_plugins__
87
88        def set_debug(self,dbg='1'):
89                self.dbg=int(dbg)
90                self._debug ("Debug enabled")
91        #def set_debug
92
93        def _debug(self,msg=''):
94                if self.dbg==1:
95                        print ('DEBUG Store: '+msg)
96        #def _debug
97
98        def _log(self,msg=None):
99                if msg:
100                        syslog.openlog('lliurex-store')
101                        syslog.syslog(msg)
102                        self._debug(msg)
103        ####
104        #dict of actions/related functions for threading
105        ####
106        def _define_functions_for_threads(self):
107                self.threads['load']="threading.Thread(target=self._load_Store)"
108                self.threads['get_info']="threading.Thread(target=self._get_App_Info,args=[args])"
109                self.threads['pkginfo']="threading.Thread(target=self._get_Extended_App_Info,args=[args])"
110                self.threads['search']='threading.Thread(target=self._search_Store,args=[args,action])'
111                self.threads['list']='threading.Thread(target=self._search_Store,args=[args,action])'
112                self.threads['info']='threading.Thread(target=self._search_Store,args=[args,action])'
113                self.threads['install']='threading.Thread(target=self._install_remove_App,args=[args,action])'
114                self.threads['remove']='threading.Thread(target=self._install_remove_App,args=[args,action])'
115                self.threads['list_sections']='threading.Thread(target=self._list_sections,args=[args,action])'
116        #def _define_functions_for_threads
117
118        ####
119        #Launch the appropiate threaded function for the desired action
120        #Input:
121        #  - action to be executed
122        #  - parms for the action
123        ####
124        def execute_action(self,action,args=None):
125                self._debug("Launching action: "+action+" and args "+str(args))
126                if self.is_action_running('load'):
127                        self._join_action('load')
128                sw_withoutStatus=False
129                if action not in self.threads.keys():
130                        #Attempt to add a new action managed by a plugin
131                        self._debug("Attempting to find a plugin for action "+action)
132                        if action in self.registeredPlugins.keys():
133                                for packageType,plugin in self.registeredPlugins[action].items():
134                                        self.progressActions[action]=0
135                                        self.threads[action]='threading.Thread(target=self._execute_class_method(action,packageType,action).execute_action,args=[action])'
136                                        break
137                                self._debug('Plugin for '+action+' found: '+str(self.registeredPlugins[action]))
138                                self.relatedActions.update({action:[action]})
139                                sw_withoutStatus=True
140                if action in self.threads.keys():
141                        if self.is_action_running(action):
142                                #join thread if we're performing the same action
143                                self._debug("Waiting for current action "+action+" to end")
144                                self.threadsRunning[action].join()
145                        try:
146                                if action in self.progressActions.keys():
147                                        self.progressActions[action]=0
148                                self.progressActions[action]=0
149                                self.threadsRunning[action]=eval(self.threads[action])
150                                self.threadsRunning[action].start()
151                                self.result[action]={}
152                                if sw_withoutStatus:
153                                        self.result[action]['status']={'status':0,'msg':''}
154                                        self.extraActions.update({action:1})
155                                else:
156                                        self.result[action]['status']={'status':-1,'msg':''}
157                                self._debug("Thread "+str(self.threadsRunning[action])+" for action "+action+" launched")
158
159                        except Exception as e:
160                                self._debug("Can't launch thread for action: "+action)
161                                self._debug("Reason: "+str(e))
162                                pass
163                else:
164                        self._debug("No function associated with action "+action)
165        #def execute_action
166
167        ####
168        #Launch the appropiate class function
169        #Input:
170        #  - class action to be executed
171        #  - parms for the action
172        #  - parent action that demands the execution
173        #Output
174        #  - The class method to execute
175        ####
176        def _execute_class_method(self,action,parms=None,launchedby=None):
177                exeFunction=None
178                if not parms:
179                        parms="*"
180                if action in self.registeredPlugins:
181                        self._debug("Plugin for "+action+": "+self.registeredPlugins[action][parms])
182                        exeFunction=eval(self.registeredPlugins[action][parms]+"()")
183                        if self.dbg:
184                                exeFunction.set_debug(1)
185                        self._registerProcessProgress(action,exeFunction,launchedby)
186                else:
187                        self._debug("No plugin for action: "+action)
188
189                return (exeFunction)
190        #def _execute_class_method
191
192        ###
193        #Tell if a a action is running
194        #Input:
195        #  - action to monitorize
196        #Output:
197        #  - status true/false
198        ###
199        def is_action_running(self,actionSearched=None):
200                status=False
201                actionList=[]
202                if actionSearched:
203                        actionList.append(actionSearched)
204                else:
205                        actionList=self.relatedActions.keys()
206
207                for action in actionList:
208                        if action in self.threadsRunning.keys():
209                                if self.threadsRunning[action].is_alive():
210                                        status=True
211                                        break
212                                else:
213                                        if action in self.relatedActions.keys():
214                                                for relatedAction in self.relatedActions[action]:
215                                                        if relatedAction in self.threadsRunning.keys():
216                                                                if self.threadsRunning[relatedAction].is_alive():
217                                                                        status=True
218                                                                        break
219#                       self._debug(action+" running: "+str(status))
220                return(status)
221        #def is_action_running
222
223        ####
224        #Joins an action till finish
225        #Input:
226        #  - action to join
227        ####
228        def _join_action(self,action):
229                self._debug("Joining action: "+action)
230                try:
231                        self.threadsRunning[action].join()
232                except Exception as e:
233                        self._debug("Unable to join thread for: "+action)
234                        self._debug("Reason: "+ str(e))
235                finally:               
236                        if action in self.threadsRunning.keys():
237                                del(self.threadsRunning[action])
238        #def _join_action
239
240        ####
241        #Register the method and action/parentAction pair in the progress dict
242        #Input:
243        #  - action launched
244        #  - function (a reference to the function)
245        #  - parentAction that owns the action (if any)
246        ####
247        def _registerProcessProgress(self,action,function,parentAction=None):
248                if action in self.registerProcessProgress.keys():
249                        self._debug("Appended process for action: "+action +" and function: "+str(function))
250                        self.registerProcessProgress[action].append(function)
251                else:
252                        self._debug("Registered process for action: "+action+" and function: "+str(function))
253                        self.registerProcessProgress[action]=[function]
254                if parentAction:
255                        self._debug("Registered process for Parent Action: "+action+"-"+parentAction+" and function: "+str(function))
256                        if parentAction in self.threadsProgress.keys():
257                                self.threadsProgress[parentAction].update({action:function})
258                        else:
259                                self.threadsProgress[parentAction]={action:function}
260        #def _registerProcessProgress
261
262        ####
263        #Get the progress of the executed actions
264        #Input
265        #  - action or none if we want all of the progress
266        #Output:
267        #  - Dict of results indexed by actions
268        ####
269        def get_progress(self,action=None):
270                progress={'search':0,'list':0,'install':0,'remove':0,'load':0,'list_sections':0}
271                actionList=[]
272                if action and action in self.registerProcessProgress:
273                        actionList=[action]
274                else:
275                        actionList=self.registerProcessProgress.keys()
276                self.lock.acquire() #prevent that any thread attempts to change the iterator
277                for parentAction in self.relatedActions.keys():
278                        if self.is_action_running(parentAction):
279                                for action in actionList:
280                                        if parentAction in self.threadsProgress.keys():
281#                                               self._debug(str(len(self.threadsProgress[parentAction]))+" Threads for action "+parentAction+": "+str(self.threadsProgress[parentAction]))
282                                                acumProgress=0
283                                                for threadfunction,function in self.threadsProgress[parentAction].items():
284#                                                       function=self.threadsProgress[parentAction][threadfunction]
285#                                                       self._debug(str(function)+" "+ str(threadfunction) + " "+parentAction)
286                                                        acumProgress=acumProgress+function.progress
287#                                                       self._debug("Acum for process "+parentAction+": "+str(acumProgress))
288       
289                                                count=len(self.relatedActions[parentAction])
290#                                               self._debug("Assign result for action" +action)
291                                                self.progressActions[parentAction]=round(acumProgress/count,0)
292                                                progress[parentAction]=self.progressActions[parentAction]
293                        else:
294                                #put a 100% just in case
295                                if parentAction in self.progressActions.keys():
296#                                       if self.progressActions[parentAction]:
297#                                               self.progressActions[parentAction]=100
298                                        self.progressActions[parentAction]=100
299                self.lock.release()
300#               self._debug("Progress :"+str(progress))
301                return(self.progressActions)
302        #def get_progress
303
304        ####
305        #Gets the result of an action
306        #Input:
307        #  - action
308        #Output:
309        #  - Dict of results indexed by actions
310        ####
311        def get_result(self,action=None):
312                self.lock.acquire() #Prevent changes on results from threads
313                result={}
314                if action==None:
315                        for res in self.result.keys():
316                                if res!='load':
317                                        if 'data' in self.result[res]:
318                                                result[res]=self.result[res]['data']
319                                        else:
320                                                result[res]=[]
321                else:
322                        self._debug("Checking result for action "+action)
323                        if self.is_action_running(action):
324                                self._join_action(action)
325                        result[action]=None
326                        if action in self.result:
327                                if 'data' in self.result[action]:
328                                        result[action]=self.result[action]['data']
329                                else:
330                                        result[action]=[]
331                self.lock.release()
332                if action in self.extraActions.keys():
333                        self._load_Store()
334                return(result)
335        #def get_result
336
337        ####
338        #Gets the status of an action
339        #Input.
340        # - action
341        #Output:
342        # - Status dict of the action
343        ####
344        def get_status(self,action=None):
345                self.lock.acquire()
346                self._debug("Checking status for action "+str(action))
347                result={}
348                if action in self.result:
349                        result=self.result[action]['status']
350                        try:
351                                errorFile=open('/usr/share/lliurex-store/files/error.json').read()
352                                errorCodes=json.loads(errorFile)
353                                errCode=str(result['status'])
354                                if errCode in errorCodes:
355                                        result['msg']=errorCodes[errCode]
356                                else:
357                                        result['msg']=u"Unknown error"
358                        except:
359                                        result['msg']=u"Unknown error"
360                self.lock.release()
361                return(result)
362        #def get_status
363
364        def load_bundles(self):
365                self.loadBundles=True
366                self._load_Store()
367
368        ####
369        #Loads the store
370        ####
371        def _load_Store(self):
372                action='load'
373                if self.loadBundles:
374                        function=self._execute_class_method('loadCatalogue','appimage')
375                        function.execute_action('loadCatalogue')
376                loadFunction=self._execute_class_method(action)
377                self.store=loadFunction.execute_action(action,self.store,self.loadBundles)
378        #def _load_Store
379
380        ####
381        #Loads the info related to one app
382        #Input:
383        #  - List of App objects
384        #Output:
385        #  - Dict with the related info
386        ####
387        def _get_App_Info(self,applist,launchedby=None):
388                action='get_info'
389                infoFunction=self._execute_class_method(action,None,launchedby)
390                applistInfo=infoFunction.execute_action(self.store,action,applist)
391                return(applistInfo)
392        #def _get_App_Info
393
394        ####
395        #Loads the extended info related to one app (slower)
396        #Input:
397        #  - Dict off Apps (as returned by _get_app_info)
398        #Output:
399        #  - Dict with the related info
400        ####
401        def _get_Extended_App_Info(self,applistInfo,launchedby=None,fullsearch=True):
402                #Check if there's any plugin for the distinct type of packages
403                action='pkginfo'
404                typeDict={}
405                result={}
406                result['data']=[]
407                result['status']={'status':0,'msg':''}
408                for appInfo in applistInfo:
409#                       result['data'].append(appInfo)
410                        package_type=self._check_package_type(appInfo)
411                        if package_type in typeDict:
412                                typeDict[package_type].append(appInfo)
413                        else:
414                                typeDict[package_type]=[appInfo]
415                for package_type in typeDict:
416                        self._debug("Checking plugin for "+action+ " "+package_type)
417                        if package_type in self.registeredPlugins[action]:
418#                               result['data']=[]
419                                #Only search full info if it's required
420                                if (fullsearch==False and package_type=='deb'):
421                                        result['data'].extend(typeDict[package_type])
422                                        continue
423                                self._debug("Retrieving info for "+str(typeDict[package_type]))
424                                pkgInfoFunction=self._execute_class_method(action,package_type,launchedby)
425#                               result.update(pkgInfoFunction.execute_action(action,typeDict[package_type]))
426#                               result['data'].extend(pkgInfoFunction.execute_action(action,typeDict[package_type])['data'])
427#                               result['status']=pkgInfoFunction.execute_action(action,typeDict[package_type])['status']
428                                result=pkgInfoFunction.execute_action(action,typeDict[package_type])
429                        else:
430                                result['data'].append(appInfo)
431                return(result)
432        #def _get_Extended_App_Info
433
434        def _list_sections(self,searchItem='',action='list_sections',launchedby=None):
435                result={}
436                self._debug("Retrieving all sections")
437                data={}
438                status={}
439                if action in self.registeredPlugins.keys():
440                        self._debug("Plugin for generic search: "+self.registeredPlugins[action]['*'])
441                        finder=self.registeredPlugins[action][('*')]
442                        searchFunction=eval(finder+"()")
443                        result=searchFunction.execute_action(self.store,action,searchItem)
444                        status=result['status']
445                        data=result['data']
446                else:
447                        print("No plugin for action "+action)
448                self.result[action]['data']=data
449                self.result[action]['status']=status
450                self._debug("Sections: "+str(self.result[action]['data']))
451                self._debug("Status: "+str(self.result[action]['status']))
452
453        ####
454        #Search the store
455        #Input:
456        #  - string search
457        #Output:
458        #  - List of dicts with all the info
459        ####
460        def _search_Store(self,searchItem='',action='search',fullsearch=False,launchedby=None):
461                applist={}
462                result={}
463                aux_applist=[]
464                if action=='list':
465                        try:
466                                searchItem=' '.join(searchItem)
467                        except:
468                                searchItem=''
469                elif action=='list_sections':
470                        searchItem=''
471                elif action=='info':
472                        fullsearch=True
473                if not launchedby:
474                        launchedby=action
475                #Set the exact match to false for search method
476                exact_match=True
477                if (launchedby=='search'):
478                                exact_match=False
479                searchFunction=self._execute_class_method(action,'*',launchedby)
480                result=searchFunction.execute_action(self.store,action,searchItem,exact_match)
481                aux_applist=result['data']
482                status=result['status']
483                realAction=action
484                if status['status']==0:
485                        #1.- Get appstream metadata (faster)
486                        partialAction='get_info'
487                        self.result[partialAction]={}
488                        result=self._get_App_Info(aux_applist,launchedby)
489                        self._debug("Add result for "+partialAction)
490                        self.result[partialAction]=result
491                        #2.- Get rest of metadata (slower)
492                        partialAction='pkginfo'
493                        result=self._get_Extended_App_Info(result['data'],launchedby,fullsearch)
494                        if launchedby:
495                                realAction=launchedby
496                                self._debug("Assigned results of "+action+" to "+realAction)
497                        if (result['status']['status']==0) or (result['status']['status']==9):
498                                return_msg=True
499                                if fullsearch:
500                                        result['status']['status']=0
501                        else:
502                                return_msg=False
503                else:
504                        return_msg=False
505                self.result[launchedby]['data']=result['data']
506                self.result[launchedby]['status']=result['status']
507                return(return_msg)
508        #def _search_Store
509
510        ####
511        #Install or remove an app
512        #Input:
513        #  - String with the app name
514        #Output:
515        #  - Result of the operation
516        ####
517        def _install_remove_App(self,appName,action='install',launchedby=None):
518                self._log("Attempting to "+action +" "+appName)
519                result={}
520                return_msg=False
521                if (self._search_Store(appName,'search',True,action)):
522                        applistInfo=self.result[action]['data']
523                        typeDict={}
524                        #Check if package is installed if we want to remove it or vice versa
525                        for appInfo in applistInfo:
526#Deactivated as appstream don't get the right status in all cases. Also it only returns two values: Installed and Unknown. Perhaps in some newer versions....
527#                               if (action=='install' and appInfo['state']=='installed') or (action=='remove' and appInfo['state']=='available'):
528#                               if (action=='remove' and appInfo['state']=='available'):
529#                                       if action=='remove':
530#                                               self.result[action]['status']={appInfo['package']:3}
531#                                               self.result[action]['status']={'status':3}
532#                                       else:
533#                                               self.result[action]['status']={appInfo['package']:4}
534#                                               self.result[action]['status']={'status':4}
535#                                               pass
536#                                       return_msg=False
537#                                       typeDict={}
538#                                       break
539                               
540                                package_type=self._check_package_type(appInfo)
541                                if package_type in typeDict:
542                                        typeDict[package_type].append(appInfo)
543                                else:
544                                        typeDict[package_type]=[appInfo]
545
546                        for package_type in typeDict:
547                                self._debug("Checking plugin for "+action+ " "+package_type)
548                                if package_type in self.registeredPlugins[action]:
549                                        installFunction=self._execute_class_method(action,package_type,action)
550                                        if package_type=='zmd':
551                                        #If it's a zmd the zomando must be present in the system
552                                                zmdAppInfo=[]
553                                                for zmdPackage in typeDict[package_type]:
554                                                        zmdInfo={}
555                                                        self._debug("Cheking presence of zmd "+ zmdPackage['package'])
556                                                        zmd='/usr/share/zero-center/zmds/'+appInfo['package']+'.zmd'
557                                                        if not os.path.exists(zmd):
558                                                                zmdInfo['package']=zmdPackage['package']
559                                                                zmdAppInfo.append(zmdInfo)
560                                                if zmdAppInfo:
561                                                        self._debug("Installing needed packages")
562                                                        installAuxFunction=self._execute_class_method(action,"deb",action)
563                                                        result=installAuxFunction.execute_action(action,zmdAppInfo)
564                                                       
565                                        result=installFunction.execute_action(action,typeDict[package_type])
566                                        self.result[action]=result
567                                        return_msg=True
568                        self._debug("Regenerating the cache...")
569                        self._load_Store()
570                self._log("Result "+action +": "+str(self.result[action]))
571                return(return_msg)
572        #def install_App
573       
574        ####
575        #Check the package type
576        #Input:
577        # - AppInfo dict (element of the list returned by _get_app_info)
578        #Output:
579        # - String with the type (deb, sh, zmd...)
580        ####
581        def _check_package_type(self,appInfo):
582                #Standalone installers must have the subcategory "installer"
583                #Zomandos must have the subcategory "Zomando"
584                self._debug("Checking package type for app "+appInfo['name'])
585                if "Zomando" in appInfo['categories']:
586                        return_msg="zmd"
587                else:
588                #Standalone installers must have an installerUrl field loaded from a bundle type=script description
589                        if appInfo['installerUrl']!='':
590                                return_msg="sh"
591                        elif appInfo['appImage']!='':
592                                return_msg="appimage"
593                        else:
594                                return_msg="deb"
595                return(return_msg)
596        #def _check_package_type
Note: See TracBrowser for help on using the repository browser.