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

Last change on this file since 3661 was 3661, checked in by Juanma, 3 years ago

WIP on blacklist

File size: 16.6 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.dbg=0
31                if args:
32                        self.dbg=args
33                self.threads={}                         #Dict that stores the functions that must execute each action
34                self.threadsProgress={}                 #"" "" "" the progress for each launched thread
35                self.threadsRunning={}                  #"" "" "" the running threads
36                self.registeredPlugins={}               #Dict that have the relation between plugins and actions
37                self.registerProcessProgress={}         #Dict that stores the progress for each function/parentAction pair
38                self.progressActions={}                 #Progress of global actions based on average progress of individual processes
39                self.result={}                          #Result of the actions
40                self.lock=threading.Lock()              #locker for functions related to threads (get_progress, is_action_running...)
41                self.main()
42        #def __init__
43
44        def main(self):
45                self._define_functions_for_threads()    #Function that loads the dictionary self.threads
46                self.__init_plugins__()                 #Function that loads the plugins
47                self.execute_action('load')             #Initial load of the store
48        #def main
49
50        ####
51        #Load and register the plugins from plugin dir
52        ####
53        def __init_plugins__(self):
54                package=plugins
55                for importer, mod, ispkg in pkgutil.walk_packages(path=package.__path__, prefix=package.__name__+'.',onerror=lambda x: None):
56                        strImport='from '+mod+' import *'
57                        try:
58                                self._debug("Importing "+str(mod))
59                                exec (strImport)
60                        except Exception as e:
61                                print(str(e))
62
63                for mod in (sys.modules.keys()):
64                        if 'plugins.' in mod:
65                                definedActions={}
66                                pluginNameUp=mod.split('.')[-1]
67                                pluginName=pluginNameUp.lower()
68                                self._debug("Initializing "+str(pluginName))
69                                try:
70                                        loadedClass=eval(pluginName)()
71                                        definedActions=loadedClass.register()
72                                except Exception as e:
73                                        print ("Can't initialize "+str(mod)+' '+str(loadedClass))
74                                        print ("Reason: "+str(e))
75                                        pass
76                       
77                                for action in definedActions.keys():
78                                        if action not in self.registeredPlugins:
79                                                self.registeredPlugins[action]={}
80                                        self.registeredPlugins[action].update({definedActions[action]:'plugins.'+pluginNameUp+'.'+pluginName})
81                self._debug(str(self.registeredPlugins))
82        #def __init_plugins__
83
84        def set_debug(self,dbg='1'):
85                self.dbg=int(dbg)
86                self._debug ("Debug enabled")
87        #def set_debug
88
89        def _debug(self,msg=''):
90                if self.dbg==1:
91                        print ('DEBUG Store: '+msg)
92        #def _debug
93
94        def _log(self,msg=None):
95                if msg:
96                        syslog.openlog('lliurex-store')
97                        syslog.syslog(msg)
98        ####
99        #dict of actions/related functions for threading
100        ####
101        def _define_functions_for_threads(self):
102                self.threads['load']="threading.Thread(target=self._load_Store)"
103                self.threads['get_info']="threading.Thread(target=self._get_App_Info,args=[args])"
104                self.threads['pkginfo']="threading.Thread(target=self._get_Extended_App_Info,args=[args])"
105                self.threads['search']='threading.Thread(target=self._search_Store,args=[args,action])'
106                self.threads['list']='threading.Thread(target=self._search_Store,args=[args,action])'
107                self.threads['info']='threading.Thread(target=self._search_Store,args=[args,action])'
108                self.threads['install']='threading.Thread(target=self._install_remove_App,args=[args,action])'
109                self.threads['remove']='threading.Thread(target=self._install_remove_App,args=[args,action])'
110                self.threads['list_sections']='threading.Thread(target=self._list_sections,args=[args,action])'
111        #def _define_functions_for_threads
112
113        ####
114        #Launch the appropiate threaded function for the desired action
115        #Input:
116        #  - action to be executed
117        #  - parms for the action
118        ####
119        def execute_action(self,action,args=None):
120                self._debug("Launching action: "+action)
121                if self.is_action_running('load'):
122                        self._join_action('load')
123                if action in self.threads.keys():
124                        if self.is_action_running(action):
125                                #join thread if we're performing the same action
126                                self._debug("Waiting for current action "+action+" to end")
127                                self.threadsRunning[action].join()
128                        try:
129                                if action in self.progressActions.keys():
130                                        self.progressActions[action]=0
131                                self.progressActions[action]=0
132                                self.threadsRunning[action]=eval(self.threads[action])
133                                self.threadsRunning[action].start()
134                                self.result[action]={}
135                                self.result[action]['status']={'status':-1,'msg':''}
136                                self._debug("Thread "+str(self.threadsRunning[action])+" for action "+action+" launched")
137
138                        except Exception as e:
139                                self._debug("Can't launch thread for action: "+action)
140                                self._debug("Reason: "+str(e))
141                                pass
142                else:
143                        self._debug("No function associated with action "+action)
144        #def execute_action
145
146        ####
147        #Launch the appropiate class function
148        #Input:
149        #  - class action to be executed
150        #  - parms for the action
151        #  - parent action that demands the execution
152        #Output
153        #  - The class method to execute
154        ####
155        def _execute_class_method(self,action,parms=None,launchedby=None):
156                exeFunction=None
157                if not parms:
158                        parms="*"
159                if action in self.registeredPlugins:
160                        self._debug("Plugin for "+action+": "+self.registeredPlugins[action][parms])
161                        exeFunction=eval(self.registeredPlugins[action][parms]+"()")
162                        if self.dbg:
163                                exeFunction.set_debug(1)
164                        self._registerProcessProgress(action,exeFunction,launchedby)
165                else:
166                        self._debug("No plugin for action: "+action)
167
168                return (exeFunction)
169        #def _execute_class_method
170
171        ###
172        #Tell if a a action is running
173        #Input:
174        #  - action to monitorize
175        #Output:
176        #  - status true/false
177        ###
178        def is_action_running(self,action=None):
179                status=False
180                if action:
181                        if action in self.threadsRunning:
182                                if self.threadsRunning[action].is_alive():
183                                        status=True
184                                else:
185                                        if action in self.relatedActions.keys():
186                                                for relatedAction in self.relatedActions[action]:
187                                                        if relatedAction in self.threadsRunning.keys():
188                                                                if self.threadsRunning[relatedAction].is_alive():
189                                                                        status=True
190                                                                        break
191#                                       self._debug(action+" running: "+str(status))
192                else:
193                        if (threading.active_count()-1):
194                                status=True
195#                               self._debug("Running: "+str(threading.active_count()) + " threads")
196                return(status)
197        #def is_action_running
198
199        ####
200        #Joins an action till finish
201        #Input:
202        #  - action to join
203        ####
204        def _join_action(self,action):
205                self._debug("Joining action: "+action)
206                try:
207                        self.threadsRunning[action].join()
208                except Exception as e:
209                        self._debug("Unable to join thread for: "+action)
210                        self._debug("Reason: "+ str(e))
211                finally:               
212                        if action in self.threadsRunning.keys():
213                                del(self.threadsRunning[action])
214        #def _join_action
215
216        ####
217        #Register the method and action/parentAction pair in the progress dict
218        #Input:
219        #  - action launched
220        #  - function (a reference to the function)
221        #  - parentAction that owns the action (if any)
222        ####
223        def _registerProcessProgress(self,action,function,parentAction=None):
224                if action in self.registerProcessProgress.keys():
225                        self._debug("Appended process for action: "+action +" and function: "+str(function))
226                        self.registerProcessProgress[action].append(function)
227                else:
228                        self._debug("Registered process for action: "+action+" and function: "+str(function))
229                        self.registerProcessProgress[action]=[function]
230                if parentAction:
231                        self._debug("Registered process for Parent Action: "+action+"-"+parentAction+" and function: "+str(function))
232                        if parentAction in self.threadsProgress.keys():
233                                self.threadsProgress[parentAction].update({action:function})
234                        else:
235                                self.threadsProgress[parentAction]={action:function}
236        #def _registerProcessProgress
237
238        ####
239        #Get the progress of the executed actions
240        #Input
241        #  - action or none if we want all of the progress
242        #Output:
243        #  - Dict of results indexed by actions
244        ####
245        def get_progress(self,action=None):
246                progress={'search':0,'list':0,'install':0,'remove':0,'load':0,'list_sections':0}
247                actionList=[]
248                if action and action in self.registerProcessProgress:
249                        actionList=[action]
250                else:
251                        actionList=self.registerProcessProgress.keys()
252                self.lock.acquire() #prevent that any thread attempts to change the iterator
253                for parentAction in self.relatedActions.keys():
254                        if self.is_action_running(parentAction):
255                                for action in actionList:
256                                        if parentAction in self.threadsProgress.keys():
257#                                               self._debug(str(len(self.threadsProgress[parentAction]))+" Threads for action "+parentAction+": "+str(self.threadsProgress[parentAction]))
258                                                acumProgress=0
259                                                for threadfunction in self.threadsProgress[parentAction]:
260                                                        function=self.threadsProgress[parentAction][threadfunction]
261#                                                       self._debug(str(function)+" "+ str(threadfunction) + " "+parentAction)
262                                                        acumProgress=acumProgress+function.progress
263#                                                       self._debug("Acum for process "+parentAction+": "+str(acumProgress))
264       
265                                                count=len(self.relatedActions[parentAction])
266#                                               self._debug("Assign result for action" +action)
267                                                self.progressActions[parentAction]=round(acumProgress/count,0)
268                                                progress[parentAction]=self.progressActions[parentAction]
269                        else:
270                                #put a 100% just in case
271                                if parentAction in self.progressActions.keys():
272#                                       if self.progressActions[parentAction]:
273#                                               self.progressActions[parentAction]=100
274                                        self.progressActions[parentAction]=100
275                self.lock.release()
276#               self._debug("Progress :"+str(progress))
277                return(self.progressActions)
278        #def get_progress
279
280        ####
281        #Gets the result of an action
282        #Input:
283        #  - action
284        #Output:
285        #  - Dict of results indexed by actions
286        ####
287        def get_result(self,action=None):
288                self.lock.acquire() #Prevent changes on results from threads
289                result={}
290                if action==None:
291                        for res in self.result.keys():
292                                if res!='load':
293                                        result[res]=self.result[res]['data']
294                else:
295                        if self.is_action_running(action):
296                                self._join_action(action)
297                        result[action]=None
298                        if action in self.result:
299                                result[action]=self.result[action]['data']
300                self.lock.release()
301                return(result)
302        #def get_result
303
304        ####
305        #Gets the status of an action
306        #Input.
307        # - action
308        #Output:
309        # - Status dict of the action
310        ####
311        def get_status(self,action=None):
312                self.lock.acquire()
313
314                result={}
315                if action in self.result:
316                        result=self.result[action]['status']
317                        errorFile=open('/usr/share/lliurex-store/files/error.json').read()
318                        errorCodes=json.loads(errorFile)
319                        result['msg']=errorCodes[str(result['status'])]
320                self.lock.release()
321                return(result)
322        #def get_status
323
324        ####
325        #Loads the store
326        ####
327        def _load_Store(self):
328                action='load'
329                loadFunction=self._execute_class_method(action)
330                self.store=loadFunction.execute_action(action)
331        #def _load_Store
332
333        ####
334        #Loads the info related to one app
335        #Input:
336        #  - List of App objects
337        #Output:
338        #  - Dict with the related info
339        ####
340        def _get_App_Info(self,applist,launchedby=None):
341                action='get_info'
342                infoFunction=self._execute_class_method(action,None,launchedby)
343                applistInfo=infoFunction.execute_action(self.store,action,applist)
344                return(applistInfo)
345        #def _get_App_Info
346
347        ####
348        #Loads the extended info related to one app (slower)
349        #Input:
350        #  - Dict off Apps (as returned by _get_app_info)
351        #Output:
352        #  - Dict with the related info
353        ####
354        def _get_Extended_App_Info(self,applistInfo,launchedby=None,fullsearch=True):
355                #Check if there's any plugin for the distinct type of packages
356                action='pkginfo'
357                typeDict={}
358                for appInfo in applistInfo:
359                        package_type=self._check_package_type(appInfo)
360                        if package_type in typeDict:
361                                typeDict[package_type].append(appInfo)
362                        else:
363                                typeDict[package_type]=[appInfo]
364                for package_type in typeDict:
365                        self._debug("Checking plugin for "+action+ " "+package_type)
366                        if package_type in self.registeredPlugins[action]:
367                                #Only search deb's full info if it's required
368                                if (package_type=='deb' and fullsearch==False):
369                                        continue
370                                pkgInfoFunction=self._execute_class_method(action,package_type,launchedby)
371                                pkgInfoFunction.execute_action(action,typeDict[package_type])
372                return(applistInfo)
373        #def _get_Extended_App_Info
374
375        def _list_sections(self,searchItem='',action='list_sections',launchedby=None):
376                result={}
377                self._debug("Retrieving all sections")
378                data={}
379                status={}
380                if action in self.registeredPlugins.keys():
381                        self._debug("Plugin for generic search: "+self.registeredPlugins[action]['*'])
382                        finder=self.registeredPlugins[action][('*')]
383                        searchFunction=eval(finder+"()")
384                        result=searchFunction.execute_action(self.store,action,searchItem)
385                        status=result['status']
386                        data=result['data']
387                else:
388                        print("No plugin for action "+action)
389                self.result[action]['data']=data
390                self.result[action]['status']=status
391                self._debug("Sections: "+str(self.result[action]['data']))
392                self._debug("Status: "+str(self.result[action]['status']))
393
394        ####
395        #Search the store
396        #Input:
397        #  - string search
398        #Output:
399        #  - List of dicts with all the info
400        ####
401        def _search_Store(self,searchItem='',action='search',fullsearch=False,launchedby=None):
402                applist={}
403                aux_applist=[]
404                if action=='list':
405                        try:
406                                searchItem=' '.join(searchItem)
407                        except:
408                                searchItem=''
409                elif action=='list_sections':
410                        searchItem=''
411                elif action=='info':
412                        fullsearch=True
413                if not launchedby:
414                        launchedby=action
415
416                searchFunction=self._execute_class_method(action,'*',launchedby)
417                aux_result=searchFunction.execute_action(self.store,action,searchItem)
418                aux_applist=aux_result['data']
419                status=aux_result['status']
420                realAction=action
421                if status['status']==0:
422                        #1.- Get appstream metadata (faster)
423                        partialAction='get_info'
424                        self.result[partialAction]={}
425                        applist=self._get_App_Info(aux_applist,launchedby)
426                        self._debug("Add result for "+partialAction)
427                        self.result[partialAction]['data']=applist
428                        #2.- Get rest of metadata (slower)
429                        partialAction='pkginfo'
430                        applist=self._get_Extended_App_Info(applist,launchedby,fullsearch)
431                        if launchedby:
432                                realAction=launchedby
433                                self._debug("Assigned results of "+action+" to "+realAction)
434                        if (len(applist)):
435                                return_msg=True
436                        else:
437                                return_msg=False
438                else:
439                        return_msg=False
440                self.result[launchedby]['data']=applist
441                self.result[launchedby]['status']=status
442                return(return_msg)
443        #def _search_Store
444
445        ####
446        #Install or remove an app
447        #Input:
448        #  - String with the app name
449        #Output:
450        #  - Result of the operation
451        ####
452        def _install_remove_App(self,appName,action='install',launchedby=None):
453                self._debug("Attempting to "+action +" "+appName)
454                self._log("Attempting to "+action +" "+appName)
455                result={}
456                return_msg=False
457                if (self._search_Store(appName,'search',False,action)):
458                        applistInfo=self.result[action]['data']
459                        typeDict={}
460                        #Check if package is installed if we want to remove it or vice versa
461                        for appInfo in applistInfo:
462                                if (action=='install' and appInfo['state']=='installed') or (action=='remove' and appInfo['state']=='available'):
463                                        if action=='remove':
464#                                               self.result[action]['status']={appInfo['package']:3}
465                                                self.result[action]['status']={'status':3}
466                                        else:
467#                                               self.result[action]['status']={appInfo['package']:4}
468                                                self.result[action]['status']={'status':4}
469                                        return_msg=False
470                                        typeDict={}
471                                        break
472                               
473                                package_type=self._check_package_type(appInfo)
474                                if package_type in typeDict:
475                                        typeDict[package_type].append(appInfo)
476                                else:
477                                        typeDict[package_type]=[appInfo]
478
479                        for package_type in typeDict:
480                                self._debug("Checking plugin for "+action+ " "+package_type)
481                                if package_type in self.registeredPlugins[action]:
482                                        installFunction=self._execute_class_method(action,package_type,action)
483                                        result=installFunction.execute_action(action,typeDict[package_type])
484                                        self.result[action]=result
485                                        return_msg=True
486
487                self._log("Result "+action +": "+str(self.result[action]))
488                return(return_msg)
489        #def install_App
490       
491        ####
492        #Check the package type
493        #Input:
494        # - AppInfo dict (element of the list returned by _get_app_info)
495        #Output:
496        # - String with the type (deb, sh, zmd...)
497        ####
498        def _check_package_type(self,appInfo):
499                #Standalone installers must have the subcategory "installer"
500                #Zomandos must have the subcategory "Zomando"
501                self._debug("Checking package type for app "+appInfo['name'])
502                if "Zomando" in appInfo['categories']:
503                        return_msg="zmd"
504                else:
505                        if "Installer" in appInfo['categories']:
506                                return_msg="sh"
507                        else:
508                                return_msg="deb"
509                return(return_msg)
510        #def _check_package_type
Note: See TracBrowser for help on using the repository browser.