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

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

wip on packaging

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