source: lliurex-store/trunk/fuentes/lliurex-appstore.install/usr/share/lliurex-store/storeManager.py @ 3173

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

wip on packaging

File size: 16.1 KB
Line 
1#!/usr/bin/python3
2import sys
3import os
4import threading
5import syslog
6#Load the plugin dir
7pluginDir=os.getcwd()+'/plugins' #Path to the dir that stores the plugins
8oldpwd=os.getcwd()
9os.chdir(pluginDir)
10exec ('import ' + os.path.basename(pluginDir))          #DON'T CHANGE!!!
11os.chdir(oldpwd)
12del (oldpwd)
13del (pluginDir)
14######
15#Ver. 1.0 of storeManager.py
16# This class manages the store and the related plugins
17# It's implemented as an action-drived class.
18# There're four(five) main actions and each of them could execute and undeterminated number of subprocess in their respective thread
19# Each of these actions returns EVER a list of dictionaries.
20#####
21
22class StoreManager:
23        def __init__(self,args=()):
24                #               self.store=appstream.Store()
25                self.store=None
26                self.relatedActions={
27                                        'load':['load'],
28                                        'search':['search','info','pkginfo'],
29                                        'list':['list','info','pkginfo'],
30                                        'list_sections':['list_sections'],
31                                        'install':['search','info','pkginfo','install'],
32                                        'remove':['search','info','pkginfo','remove']
33                                        }
34                self.dbg=0
35                self.threads={}                         #Dict that stores the functions that must execute each action
36                self.threadsProgress={}                 #"" "" "" the progress for each launched thread
37                self.threadsRunning={}                  #"" "" "" the running threads
38                self._define_functions_for_threads()    #Function that loads the dictionary self.threads
39                self.pluginDir=os.getcwd()+'/plugins' #Path to the dir that stores the plugins
40                self.pluginMod=os.path.basename(self.pluginDir) #DON'T CHANGE!!!       
41                self.registeredPlugins={}               #Dict that have the relation between plugins and actions
42                self.registerProcessProgress={}         #Dict that stores the progress for each function/parentAction pair
43                self.__init_plugins__()                 #Function that loads the plugins
44                self.progressActions={}                 #Progress of global actions based on average progress of individual processes
45                self.result={}                          #Result of the actions
46                self.execute_action('load')             #Function that launches the actions
47                self.lock=threading.Lock()              #locker for functions related to threads (get_progress, is_action_running...)
48#               self.log
49        #def __init__
50
51        ####
52        #Load and register the plugins from plugin dir
53        ####
54        def __init_plugins__(self):
55                os.chdir(self.pluginDir)
56                for mod in os.listdir():
57                        if not mod.startswith('_'):
58                                modName=mod.split('.')[0]
59                                strImport='from plugins.'+modName+' import *'
60                                try:
61                                        exec (strImport)
62                                except Exception as e:
63                                        print(str(e))
64                for mod in (sys.modules.keys()):
65                        if 'plugins.' in mod:
66                                definedActions={}
67                                pluginNameUp=mod.split('.')[-1]
68                                pluginName=pluginNameUp.lower()
69                                try:
70                                        loadedClass=eval(mod+'.'+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]: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['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['install']='threading.Thread(target=self._install_remove_App,args=[args,action])'
108                self.threads['remove']='threading.Thread(target=self._install_remove_App,args=[args,action])'
109                self.threads['list_sections']='threading.Thread(target=self._list_sections,args=[args,action])'
110        #def _define_functions_for_threads
111
112        ####
113        #Launch the appropiate threaded function for the desired action
114        #Input:
115        #  - action to be executed
116        #  - parms for the action
117        ####
118        def execute_action(self,action,args=None):
119                self._debug("Launching action: "+action)
120                if self.is_action_running('load'):
121                        self._join_action('load')
122                if action in self.threads.keys():
123                        if self.is_action_running(action):
124                                #join thread if we're performing the same action
125                                self._debug("Waiting for current action "+action+" to end")
126                                self.threadsRunning[action].join()
127                        try:
128                                if action in self.progressActions.keys():
129                                        self.progressActions[action]=0
130                                self.progressActions[action]=0
131                                self.threadsRunning[action]=eval(self.threads[action])
132                                self.threadsRunning[action].start()
133                                self._debug("Thread "+str(self.threadsRunning[action])+" for action "+action+" launched")
134                        except Exception as e:
135                                self._debug("Can't launch thread for action: "+action)
136                                self._debug("Reason: "+str(e))
137                                pass
138                else:
139                        self._debug("No function associated with action "+action)
140        #def execute_action
141
142        ####
143        #Launch the appropiate class function
144        #Input:
145        #  - class action to be executed
146        #  - parms for the action
147        #  - parent action that demands the execution
148        #Output
149        #  - The class method to execute
150        ####
151        def _execute_class_method(self,action,parms=None,launchedby=None):
152                exeFunction=None
153                if not parms:
154                        parms="*"
155                if action in self.registeredPlugins:
156                        self._debug("Plugin for "+action+": "+self.registeredPlugins[action][parms])
157                        exeFunction=eval(self.pluginMod+'.'+self.registeredPlugins[action][parms]+"()")
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(self.pluginMod+'.'+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 (searchItem in self.registeredPlugins[action]):
379                        self._debug("Plugin for search "+ searchItem +": "+self.registeredPlugins[action][searchItem])
380                        finder=self.registeredPlugins[action][searchItem]
381                else:
382                        self._debug("Plugin for generic search: "+self.registeredPlugins[action]['*'])
383                        finder=self.registeredPlugins[action][('*')]
384                searchFunction=eval(self.pluginMod+'.'+finder+"()")
385                if not launchedby:
386                        launchedby=action
387                self._registerProcessProgress(action,searchFunction,launchedby)
388                aux_applist=searchFunction.execute_action(self.store,action,searchItem)
389                #1.- Get appstream metadata (faster)
390                partialAction='info'
391                applist=self._get_App_Info(aux_applist,launchedby)
392                self._debug("Add result for "+partialAction)
393                self.result[partialAction]=applist
394                #2.- Get rest of metadata (slower)
395                partialAction='pkginfo'
396                applist=self._get_Extended_App_Info(applist,launchedby,fullsearch)
397                realAction=action
398                if launchedby:
399                        realAction=launchedby
400                        self._debug("Assigned results of "+action+" to "+realAction)
401                if (len(applist)):
402                        self.result[realAction]=applist
403                        return_msg=True
404                else:
405                        notfound=''
406                        for item in searchItem:
407                                notfound=' '.join(searchItem)
408                        self.result[realAction]=[{notfound:" not found"}]
409                        return_msg=False
410                return(return_msg)
411        #def _search_Store
412
413        ####
414        #Install or remove an app
415        #Input:
416        #  - String with the app name
417        #Output:
418        #  - Result of the operation
419        ####
420        def _install_remove_App(self,appName,action='install',launchedby=None):
421                self._debug("Attempting to "+action +" "+appName)
422                self._log("Attempting to "+action +" "+appName)
423                result={}
424                return_msg=False
425                if (self._search_Store(appName,'search',False,action)):
426                        applistInfo=self.result[action]
427                        typeDict={}
428                        #Check if package is installed if we want to remove it or vice versa
429                        for appInfo in applistInfo:
430                                if (action=='install' and appInfo['status']=='installed') or (action=='remove' and appInfo['status']=='available'):
431                                        if action=='remove':
432                                                self.result[action]=[{appInfo['package']:"Package not installed"}]
433                                        else:
434                                                self.result[action]=[{appInfo['package']:"Package already installed"}]
435                                        return_msg=False
436                                        typeDict={}
437                                        break
438                               
439                                package_type=self._check_package_type(appInfo)
440                                if package_type in typeDict:
441                                        typeDict[package_type].append(appInfo)
442                                else:
443                                        typeDict[package_type]=[appInfo]
444
445                        for package_type in typeDict:
446                                self._debug("Checking plugin for "+action+ " "+package_type)
447                                if package_type in self.registeredPlugins[action]:
448                                        installFunction=self._execute_class_method(action,package_type,action)
449                                        result=installFunction.execute_action(action,typeDict[package_type])
450                                        self.result[action]=result
451                                        return_msg=True
452
453                self._log("Result "+action +": "+str(self.result[action]))
454                return(return_msg)
455        #def install_App
456       
457        ####
458        #Check the package type
459        #Input:
460        # - AppInfo dict (element of the list returned by _get_app_info)
461        #Output:
462        # - String with the type (deb, sh, zmd...)
463        ####
464        def _check_package_type(self,appInfo):
465                #Standalone installers must have the subcategory "installer"
466                #Zomandos must have the subcategory "Zomando"
467                self._debug("Checking package type for app "+appInfo['name'])
468                if "Zomando" in appInfo['categories']:
469                        return_msg="zmd"
470                else:
471                        if "Installer" in appInfo['categories']:
472                                return_msg="sh"
473                        else:
474                                return_msg="deb"
475                return(return_msg)
476        #def _check_package_type
Note: See TracBrowser for help on using the repository browser.