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

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

WIP on CLI

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