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

Last change on this file since 5218 was 5218, checked in by Juanma, 21 months ago

minor changes in loadstore

File size: 20.3 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                                else:
155                                        self.result[action]['status']={'status':-1,'msg':''}
156                                self._debug("Thread "+str(self.threadsRunning[action])+" for action "+action+" launched")
157
158                        except Exception as e:
159                                self._debug("Can't launch thread for action: "+action)
160                                self._debug("Reason: "+str(e))
161                                pass
162                else:
163                        self._debug("No function associated with action "+action)
164        #def execute_action
165
166        ####
167        #Launch the appropiate class function
168        #Input:
169        #  - class action to be executed
170        #  - parms for the action
171        #  - parent action that demands the execution
172        #Output
173        #  - The class method to execute
174        ####
175        def _execute_class_method(self,action,parms=None,launchedby=None):
176                exeFunction=None
177                if not parms:
178                        parms="*"
179                if action in self.registeredPlugins:
180                        self._debug("Plugin for "+action+": "+self.registeredPlugins[action][parms])
181                        exeFunction=eval(self.registeredPlugins[action][parms]+"()")
182                        if self.dbg:
183                                exeFunction.set_debug(1)
184                        self._registerProcessProgress(action,exeFunction,launchedby)
185                else:
186                        self._debug("No plugin for action: "+action)
187
188                return (exeFunction)
189        #def _execute_class_method
190
191        ###
192        #Tell if a a action is running
193        #Input:
194        #  - action to monitorize
195        #Output:
196        #  - status true/false
197        ###
198        def is_action_running(self,actionSearched=None):
199                status=False
200                actionList=[]
201                if actionSearched:
202                        actionList.append(actionSearched)
203                else:
204                        actionList=self.relatedActions.keys()
205
206                for action in actionList:
207                        if action in self.threadsRunning.keys():
208                                if self.threadsRunning[action].is_alive():
209                                        status=True
210                                        break
211                                else:
212                                        if action in self.relatedActions.keys():
213                                                for relatedAction in self.relatedActions[action]:
214                                                        if relatedAction in self.threadsRunning.keys():
215                                                                if self.threadsRunning[relatedAction].is_alive():
216                                                                        status=True
217                                                                        break
218#                       self._debug(action+" running: "+str(status))
219                return(status)
220        #def is_action_running
221
222        ####
223        #Joins an action till finish
224        #Input:
225        #  - action to join
226        ####
227        def _join_action(self,action):
228                self._debug("Joining action: "+action)
229                try:
230                        self.threadsRunning[action].join()
231                except Exception as e:
232                        self._debug("Unable to join thread for: "+action)
233                        self._debug("Reason: "+ str(e))
234                finally:               
235                        if action in self.threadsRunning.keys():
236                                del(self.threadsRunning[action])
237        #def _join_action
238
239        ####
240        #Register the method and action/parentAction pair in the progress dict
241        #Input:
242        #  - action launched
243        #  - function (a reference to the function)
244        #  - parentAction that owns the action (if any)
245        ####
246        def _registerProcessProgress(self,action,function,parentAction=None):
247                if action in self.registerProcessProgress.keys():
248                        self._debug("Appended process for action: "+action +" and function: "+str(function))
249                        self.registerProcessProgress[action].append(function)
250                else:
251                        self._debug("Registered process for action: "+action+" and function: "+str(function))
252                        self.registerProcessProgress[action]=[function]
253                if parentAction:
254                        self._debug("Registered process for Parent Action: "+action+"-"+parentAction+" and function: "+str(function))
255                        if parentAction in self.threadsProgress.keys():
256                                self.threadsProgress[parentAction].update({action:function})
257                        else:
258                                self.threadsProgress[parentAction]={action:function}
259        #def _registerProcessProgress
260
261        ####
262        #Get the progress of the executed actions
263        #Input
264        #  - action or none if we want all of the progress
265        #Output:
266        #  - Dict of results indexed by actions
267        ####
268        def get_progress(self,action=None):
269                progress={'search':0,'list':0,'install':0,'remove':0,'load':0,'list_sections':0}
270                actionList=[]
271                if action and action in self.registerProcessProgress:
272                        actionList=[action]
273                else:
274                        actionList=self.registerProcessProgress.keys()
275                self.lock.acquire() #prevent that any thread attempts to change the iterator
276                for parentAction in self.relatedActions.keys():
277                        if self.is_action_running(parentAction):
278                                for action in actionList:
279                                        if parentAction in self.threadsProgress.keys():
280#                                               self._debug(str(len(self.threadsProgress[parentAction]))+" Threads for action "+parentAction+": "+str(self.threadsProgress[parentAction]))
281                                                acumProgress=0
282                                                for threadfunction,function in self.threadsProgress[parentAction].items():
283#                                                       function=self.threadsProgress[parentAction][threadfunction]
284#                                                       self._debug(str(function)+" "+ str(threadfunction) + " "+parentAction)
285                                                        acumProgress=acumProgress+function.progress
286#                                                       self._debug("Acum for process "+parentAction+": "+str(acumProgress))
287       
288                                                count=len(self.relatedActions[parentAction])
289#                                               self._debug("Assign result for action" +action)
290                                                self.progressActions[parentAction]=round(acumProgress/count,0)
291                                                progress[parentAction]=self.progressActions[parentAction]
292                        else:
293                                #put a 100% just in case
294                                if parentAction in self.progressActions.keys():
295#                                       if self.progressActions[parentAction]:
296#                                               self.progressActions[parentAction]=100
297                                        self.progressActions[parentAction]=100
298                self.lock.release()
299#               self._debug("Progress :"+str(progress))
300                return(self.progressActions)
301        #def get_progress
302
303        ####
304        #Gets the result of an action
305        #Input:
306        #  - action
307        #Output:
308        #  - Dict of results indexed by actions
309        ####
310        def get_result(self,action=None):
311                self.lock.acquire() #Prevent changes on results from threads
312                result={}
313                if action==None:
314                        for res in self.result.keys():
315                                if res!='load':
316                                        if 'data' in self.result[res]:
317                                                result[res]=self.result[res]['data']
318                                        else:
319                                                result[res]=[]
320                else:
321                        self._debug("Checking result for action "+action)
322                        if self.is_action_running(action):
323                                self._join_action(action)
324                        result[action]=None
325                        if action in self.result:
326                                if 'data' in self.result[action]:
327                                        result[action]=self.result[action]['data']
328                                else:
329                                        result[action]=[]
330                self.lock.release()
331                if action in self.extraActions.keys():
332                        self._load_Store()
333                return(result)
334        #def get_result
335
336        ####
337        #Gets the status of an action
338        #Input.
339        # - action
340        #Output:
341        # - Status dict of the action
342        ####
343        def get_status(self,action=None):
344                self.lock.acquire()
345                self._debug("Checking status for action "+str(action))
346                result={}
347                if action in self.result:
348                        result=self.result[action]['status']
349                        try:
350                                errorFile=open('/usr/share/lliurex-store/files/error.json').read()
351                                errorCodes=json.loads(errorFile)
352                                errCode=str(result['status'])
353                                if errCode in errorCodes:
354                                        result['msg']=errorCodes[errCode]
355                                else:
356                                        result['msg']=u"Unknown error"
357                        except:
358                                        result['msg']=u"Unknown error"
359                self.lock.release()
360                return(result)
361        #def get_status
362
363        def load_bundles(self):
364                self.loadBundles=True
365                self._load_Store()
366
367        ####
368        #Loads the store
369        ####
370        def _load_Store(self):
371                action='load'
372                loadFunction=self._execute_class_method(action)
373                self.store=loadFunction.execute_action(action,self.store,self.loadBundles)
374        #def _load_Store
375
376        ####
377        #Loads the info related to one app
378        #Input:
379        #  - List of App objects
380        #Output:
381        #  - Dict with the related info
382        ####
383        def _get_App_Info(self,applist,launchedby=None):
384                action='get_info'
385                infoFunction=self._execute_class_method(action,None,launchedby)
386                applistInfo=infoFunction.execute_action(self.store,action,applist)
387                return(applistInfo)
388        #def _get_App_Info
389
390        ####
391        #Loads the extended info related to one app (slower)
392        #Input:
393        #  - Dict off Apps (as returned by _get_app_info)
394        #Output:
395        #  - Dict with the related info
396        ####
397        def _get_Extended_App_Info(self,applistInfo,launchedby=None,fullsearch=True):
398                #Check if there's any plugin for the distinct type of packages
399                action='pkginfo'
400                typeDict={}
401                result={}
402                result['data']=[]
403                result['status']={'status':0,'msg':''}
404                for appInfo in applistInfo:
405#                       result['data'].append(appInfo)
406                        package_type=self._check_package_type(appInfo)
407                        if package_type in typeDict:
408                                typeDict[package_type].append(appInfo)
409                        else:
410                                typeDict[package_type]=[appInfo]
411                for package_type in typeDict:
412                        self._debug("Checking plugin for "+action+ " "+package_type)
413                        if package_type in self.registeredPlugins[action]:
414#                               result['data']=[]
415                                #Only search full info if it's required
416                                if (fullsearch==False and package_type=='deb'):
417                                        result['data'].extend(typeDict[package_type])
418                                        continue
419                                self._debug("Retrieving info for "+str(typeDict[package_type]))
420                                pkgInfoFunction=self._execute_class_method(action,package_type,launchedby)
421#                               result.update(pkgInfoFunction.execute_action(action,typeDict[package_type]))
422                                result['data'].extend(pkgInfoFunction.execute_action(action,typeDict[package_type])['data'])
423#                               result['status']=pkgInfoFunction.execute_action(action,typeDict[package_type])['status']
424#                               result=pkgInfoFunction.execute_action(action,typeDict[package_type])
425                        else:
426                                result['data'].append(appInfo)
427                return(result)
428        #def _get_Extended_App_Info
429
430        def _list_sections(self,searchItem='',action='list_sections',launchedby=None):
431                result={}
432                self._debug("Retrieving all sections")
433                data={}
434                status={}
435                if action in self.registeredPlugins.keys():
436                        self._debug("Plugin for generic search: "+self.registeredPlugins[action]['*'])
437                        finder=self.registeredPlugins[action][('*')]
438                        searchFunction=eval(finder+"()")
439                        result=searchFunction.execute_action(self.store,action,searchItem)
440                        status=result['status']
441                        data=result['data']
442                else:
443                        print("No plugin for action "+action)
444                self.result[action]['data']=data
445                self.result[action]['status']=status
446                self._debug("Sections: "+str(self.result[action]['data']))
447                self._debug("Status: "+str(self.result[action]['status']))
448
449        ####
450        #Search the store
451        #Input:
452        #  - string search
453        #Output:
454        #  - List of dicts with all the info
455        ####
456        def _search_Store(self,searchItem='',action='search',fullsearch=False,launchedby=None):
457                applist={}
458                result={}
459                aux_applist=[]
460                if action=='list':
461                        try:
462                                searchItem=' '.join(searchItem)
463                        except:
464                                searchItem=''
465                elif action=='list_sections':
466                        searchItem=''
467                elif action=='info':
468                        fullsearch=True
469                if not launchedby:
470                        launchedby=action
471                #Set the exact match to false for search method
472                exact_match=True
473                if (launchedby=='search'):
474                                exact_match=False
475                searchFunction=self._execute_class_method(action,'*',launchedby)
476                result=searchFunction.execute_action(self.store,action,searchItem,exact_match)
477                aux_applist=result['data']
478                status=result['status']
479                realAction=action
480                if status['status']==0:
481                        #1.- Get appstream metadata (faster)
482                        partialAction='get_info'
483                        self.result[partialAction]={}
484                        result=self._get_App_Info(aux_applist,launchedby)
485                        self._debug("Add result for "+partialAction)
486                        self.result[partialAction]=result
487                        #2.- Get rest of metadata (slower)
488                        partialAction='pkginfo'
489                        result=self._get_Extended_App_Info(result['data'],launchedby,fullsearch)
490                        if launchedby:
491                                realAction=launchedby
492                                self._debug("Assigned results of "+action+" to "+realAction)
493                        if (result['status']['status']==0) or (result['status']['status']==9):
494                                return_msg=True
495                                if fullsearch:
496                                        result['status']['status']=0
497                        else:
498                                return_msg=False
499                else:
500                        return_msg=False
501                self.result[launchedby]['data']=result['data']
502                self.result[launchedby]['status']=result['status']
503                return(return_msg)
504        #def _search_Store
505
506        ####
507        #Install or remove an app
508        #Input:
509        #  - String with the app name
510        #Output:
511        #  - Result of the operation
512        ####
513        def _install_remove_App(self,appName,action='install',launchedby=None):
514                self._log("Attempting to "+action +" "+appName)
515                result={}
516                return_msg=False
517                if (self._search_Store(appName,'search',True,action)):
518                        applistInfo=self.result[action]['data']
519                        typeDict={}
520                        #Check if package is installed if we want to remove it or vice versa
521                        for appInfo in applistInfo:
522#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....
523                                if (action=='install' and appInfo['state']=='installed') or (action=='remove' and appInfo['state']=='available'):
524                                        if (action=='remove' and appInfo['state']=='available'):
525                                                        self.result[action]['status']={appInfo['package']:3}
526                                                        self.result[action]['status']={'status':3}
527                                        else:
528                                                self.result[action]['status']={appInfo['package']:4}
529                                                self.result[action]['status']={'status':4}
530                                                pass
531                                        return_msg=False
532                                        typeDict={}
533                                        break
534                               
535                                package_type=self._check_package_type(appInfo)
536                                if package_type in typeDict:
537                                        typeDict[package_type].append(appInfo)
538                                else:
539                                        typeDict[package_type]=[appInfo]
540
541                        for package_type in typeDict:
542                                self._debug("Checking plugin for "+action+ " "+package_type)
543                                if package_type in self.registeredPlugins[action]:
544                                        installFunction=self._execute_class_method(action,package_type,action)
545                                        if package_type=='zmd':
546                                        #If it's a zmd the zomando must be present in the system
547                                                zmdAppInfo=[]
548                                                for zmdPackage in typeDict[package_type]:
549                                                        zmdInfo={}
550                                                        self._debug("Cheking presence of zmd "+ zmdPackage['package'])
551                                                        zmd='/usr/share/zero-center/zmds/'+appInfo['package']+'.zmd'
552                                                        if not os.path.exists(zmd):
553                                                                zmdInfo['package']=zmdPackage['package']
554                                                                zmdAppInfo.append(zmdInfo)
555                                                if zmdAppInfo:
556                                                        self._debug("Installing needed packages")
557                                                        installAuxFunction=self._execute_class_method(action,"deb",action)
558                                                        result=installAuxFunction.execute_action(action,zmdAppInfo)
559                                                       
560                                        result=installFunction.execute_action(action,typeDict[package_type])
561                                        self.result[action]=result
562                                        if result['status']['status']==0:
563                                                #Mark the apps as installed or available
564                                                for app in typeDict[package_type]:
565                                                        if action=='install':
566                                                                app['appstream_id'].set_state(1)
567                                                                self._debug("App state changed to installed")
568                                                        else:
569                                                                app['appstream_id'].set_state(2)
570                                                                self._debug("App state changed to available")
571                                        return_msg=True
572#                       self._debug("Regenerating the cache...")
573#                       self._load_Store()
574                self._log("Result "+action +": "+str(self.result[action]))
575                return(return_msg)
576        #def install_App
577       
578        ####
579        #Check the package type
580        #Input:
581        # - AppInfo dict (element of the list returned by _get_app_info)
582        #Output:
583        # - String with the type (deb, sh, zmd...)
584        ####
585        def _check_package_type(self,appInfo):
586                #Standalone installers must have the subcategory "installer"
587                #Zomandos must have the subcategory "Zomando"
588                self._debug("Checking package type for app "+appInfo['name'])
589                if "Zomando" in appInfo['categories']:
590                        return_msg="zmd"
591                else:
592                #Standalone installers must have an installerUrl field loaded from a bundle type=script description
593                        if appInfo['installerUrl']!='':
594                                return_msg="sh"
595                        elif appInfo['appImage']!='':
596                                return_msg="appimage"
597                        else:
598                                return_msg="deb"
599                return(return_msg)
600        #def _check_package_type
Note: See TracBrowser for help on using the repository browser.