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

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

wip

File size: 16.9 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,actionSearched=None):
179                status=False
180                actionList=[]
181                if actionSearched:
182                        actionList.append(actionSearched)
183                else:
184                        actionList=self.relatedActions.keys()
185
186                for action in actionList:
187                        if action in self.threadsRunning:
188                                if self.threadsRunning[action].is_alive():
189                                        status=True
190                                        break
191                                else:
192                                        if action in self.relatedActions.keys():
193                                                for relatedAction in self.relatedActions[action]:
194                                                        if relatedAction in self.threadsRunning.keys():
195                                                                if self.threadsRunning[relatedAction].is_alive():
196                                                                        status=True
197                                                                        break
198#                       self._debug(action+" running: "+str(status))
199                return(status)
200        #def is_action_running
201
202        ####
203        #Joins an action till finish
204        #Input:
205        #  - action to join
206        ####
207        def _join_action(self,action):
208                self._debug("Joining action: "+action)
209                try:
210                        self.threadsRunning[action].join()
211                except Exception as e:
212                        self._debug("Unable to join thread for: "+action)
213                        self._debug("Reason: "+ str(e))
214                finally:               
215                        if action in self.threadsRunning.keys():
216                                del(self.threadsRunning[action])
217        #def _join_action
218
219        ####
220        #Register the method and action/parentAction pair in the progress dict
221        #Input:
222        #  - action launched
223        #  - function (a reference to the function)
224        #  - parentAction that owns the action (if any)
225        ####
226        def _registerProcessProgress(self,action,function,parentAction=None):
227                if action in self.registerProcessProgress.keys():
228                        self._debug("Appended process for action: "+action +" and function: "+str(function))
229                        self.registerProcessProgress[action].append(function)
230                else:
231                        self._debug("Registered process for action: "+action+" and function: "+str(function))
232                        self.registerProcessProgress[action]=[function]
233                if parentAction:
234                        self._debug("Registered process for Parent Action: "+action+"-"+parentAction+" and function: "+str(function))
235                        if parentAction in self.threadsProgress.keys():
236                                self.threadsProgress[parentAction].update({action:function})
237                        else:
238                                self.threadsProgress[parentAction]={action:function}
239        #def _registerProcessProgress
240
241        ####
242        #Get the progress of the executed actions
243        #Input
244        #  - action or none if we want all of the progress
245        #Output:
246        #  - Dict of results indexed by actions
247        ####
248        def get_progress(self,action=None):
249                progress={'search':0,'list':0,'install':0,'remove':0,'load':0,'list_sections':0}
250                actionList=[]
251                if action and action in self.registerProcessProgress:
252                        actionList=[action]
253                else:
254                        actionList=self.registerProcessProgress.keys()
255                self.lock.acquire() #prevent that any thread attempts to change the iterator
256                for parentAction in self.relatedActions.keys():
257                        if self.is_action_running(parentAction):
258                                for action in actionList:
259                                        if parentAction in self.threadsProgress.keys():
260#                                               self._debug(str(len(self.threadsProgress[parentAction]))+" Threads for action "+parentAction+": "+str(self.threadsProgress[parentAction]))
261                                                acumProgress=0
262                                                for threadfunction in self.threadsProgress[parentAction]:
263                                                        function=self.threadsProgress[parentAction][threadfunction]
264#                                                       self._debug(str(function)+" "+ str(threadfunction) + " "+parentAction)
265                                                        acumProgress=acumProgress+function.progress
266#                                                       self._debug("Acum for process "+parentAction+": "+str(acumProgress))
267       
268                                                count=len(self.relatedActions[parentAction])
269#                                               self._debug("Assign result for action" +action)
270                                                self.progressActions[parentAction]=round(acumProgress/count,0)
271                                                progress[parentAction]=self.progressActions[parentAction]
272                        else:
273                                #put a 100% just in case
274                                if parentAction in self.progressActions.keys():
275                                        self.progressActions[parentAction]=100
276                self.lock.release()
277#               self._debug("Progress :"+str(progress))
278                return(self.progressActions)
279        #def get_progress
280
281        ####
282        #Gets the result of an action
283        #Input:
284        #  - action
285        #Output:
286        #  - Dict of results indexed by actions
287        ####
288        def get_result(self,action=None):
289                self.lock.acquire() #Prevent changes on results from threads
290                result={}
291                if action==None:
292                        for res in self.result.keys():
293                                if res!='load':
294                                        result[res]=self.result[res]['data']
295                else:
296                        self._debug("Checking result for action "+action)
297                        if self.is_action_running(action):
298                                self._join_action(action)
299                        result[action]=None
300                        if action in self.result:
301                                result[action]=self.result[action]['data']
302                self.lock.release()
303                return(result)
304        #def get_result
305
306        ####
307        #Gets the status of an action
308        #Input.
309        # - action
310        #Output:
311        # - Status dict of the action
312        ####
313        def get_status(self,action=None):
314                self.lock.acquire()
315
316                result={}
317                if action in self.result:
318                        result=self.result[action]['status']
319                        errorFile=open('/usr/share/lliurex-store/files/error.json').read()
320                        errorCodes=json.loads(errorFile)
321                        result['msg']=errorCodes[str(result['status'])]
322                self.lock.release()
323                return(result)
324        #def get_status
325
326        ####
327        #Loads the store
328        ####
329        def _load_Store(self):
330                action='load'
331                loadFunction=self._execute_class_method(action)
332                self.store=loadFunction.execute_action(action)
333        #def _load_Store
334
335        ####
336        #Loads the info related to one app
337        #Input:
338        #  - List of App objects
339        #Output:
340        #  - Dict with the related info
341        ####
342        def _get_App_Info(self,applist,launchedby=None):
343                action='get_info'
344                infoFunction=self._execute_class_method(action,None,launchedby)
345                applistInfo=infoFunction.execute_action(self.store,action,applist)
346                return(applistInfo)
347        #def _get_App_Info
348
349        ####
350        #Loads the extended info related to one app (slower)
351        #Input:
352        #  - Dict off Apps (as returned by _get_app_info)
353        #Output:
354        #  - Dict with the related info
355        ####
356        def _get_Extended_App_Info(self,applistInfo,launchedby=None,fullsearch=True):
357                #Check if there's any plugin for the distinct type of packages
358                action='pkginfo'
359                typeDict={}
360                for appInfo in applistInfo:
361                        package_type=self._check_package_type(appInfo)
362                        if package_type in typeDict:
363                                typeDict[package_type].append(appInfo)
364                        else:
365                                typeDict[package_type]=[appInfo]
366                for package_type in typeDict:
367                        self._debug("Checking plugin for "+action+ " "+package_type)
368                        if package_type in self.registeredPlugins[action]:
369                                #Only search deb's full info if it's required
370                                if (package_type=='deb' and fullsearch==False):
371                                        continue
372#                               self._debug("Retrieving info for "+str(typeDict[package_type]))
373                                backup_applist=applistInfo
374                                try:
375                                        pkgInfoFunction=self._execute_class_method(action,package_type,launchedby)
376                                        applistInfo=pkgInfoFunction.execute_action(action,typeDict[package_type])['data']
377                                except:
378                                        applistInfo=backup_applist
379                return(applistInfo)
380        #def _get_Extended_App_Info
381
382        def _list_sections(self,searchItem='',action='list_sections',launchedby=None):
383                result={}
384                self._debug("Retrieving all sections")
385                data={}
386                status={}
387                if action in self.registeredPlugins.keys():
388                        self._debug("Plugin for generic search: "+self.registeredPlugins[action]['*'])
389                        finder=self.registeredPlugins[action][('*')]
390                        searchFunction=eval(finder+"()")
391                        result=searchFunction.execute_action(self.store,action,searchItem)
392                        status=result['status']
393                        data=result['data']
394                else:
395                        print("No plugin for action "+action)
396                self.result[action]['data']=data
397                self.result[action]['status']=status
398                self._debug("Sections: "+str(self.result[action]['data']))
399                self._debug("Status: "+str(self.result[action]['status']))
400
401        ####
402        #Search the store
403        #Input:
404        #  - string search
405        #Output:
406        #  - List of dicts with all the info
407        ####
408        def _search_Store(self,searchItem='',action='search',fullsearch=False,launchedby=None,exact_match=True):
409                applist={}
410                result={}
411                aux_applist=[]
412                if action=='list':
413                        try:
414                                searchItem=' '.join(searchItem)
415                        except:
416                                searchItem=''
417                elif action=='list_sections':
418                        searchItem=''
419                elif action=='info':
420                        fullsearch=True
421                if not launchedby:
422                        launchedby=action
423                #Set the exact match to false for search and list methods
424                if (launchedby=='search' or launchedby=='list'):
425                        exact_match=False
426                searchFunction=self._execute_class_method(action,'*',launchedby)
427                aux_result=searchFunction.execute_action(self.store,action,searchItem,exact_match)
428                aux_applist=aux_result['data']
429                status=aux_result['status']
430                realAction=action
431                if status['status']==0:
432                        #1.- Get appstream metadata (faster)
433                        partialAction='get_info'
434                        self.result[partialAction]={}
435                        applist=self._get_App_Info(aux_applist,launchedby)
436                        self._debug("Add result for "+partialAction)
437                        self.result[partialAction]['data']=applist
438                        #2.- Get rest of metadata (slower)
439                        partialAction='pkginfo'
440                        applist=self._get_Extended_App_Info(applist,launchedby,fullsearch)
441                        if launchedby:
442                                realAction=launchedby
443                                self._debug("Assigned results of "+action+" to "+realAction)
444                        if (len(applist)):
445                                return_msg=True
446                        else:
447                                return_msg=False
448                else:
449                        return_msg=False
450                self.result[launchedby]['data']=applist
451                self.result[launchedby]['status']=status
452                return(return_msg)
453        #def _search_Store
454
455        ####
456        #Install or remove an app
457        #Input:
458        #  - String with the app name
459        #Output:
460        #  - Result of the operation
461        ####
462        def _install_remove_App(self,appName,action='install',launchedby=None):
463                self._debug("Attempting to "+action +" "+appName)
464                self._log("Attempting to "+action +" "+appName)
465                result={}
466                return_msg=False
467                if (self._search_Store(appName,'search',False,action)):
468                        applistInfo=self.result[action]['data']
469                        typeDict={}
470                        #Check if package is installed if we want to remove it or vice versa
471                        for appInfo in applistInfo:
472                                if (action=='install' and appInfo['state']=='installed') or (action=='remove' and appInfo['state']=='available'):
473                                        if action=='remove':
474#                                               self.result[action]['status']={appInfo['package']:3}
475                                                self.result[action]['status']={'status':3}
476                                        else:
477#                                               self.result[action]['status']={appInfo['package']:4}
478                                                self.result[action]['status']={'status':4}
479                                        return_msg=False
480                                        typeDict={}
481                                        break
482                               
483                                package_type=self._check_package_type(appInfo)
484                                if package_type in typeDict:
485                                        typeDict[package_type].append(appInfo)
486                                else:
487                                        typeDict[package_type]=[appInfo]
488
489                        for package_type in typeDict:
490                                self._debug("Checking plugin for "+action+ " "+package_type)
491                                if package_type in self.registeredPlugins[action]:
492                                        installFunction=self._execute_class_method(action,package_type,action)
493                                        result=installFunction.execute_action(action,typeDict[package_type])
494                                        self.result[action]=result
495                                        return_msg=True
496
497                self._log("Result "+action +": "+str(self.result[action]))
498                return(return_msg)
499        #def install_App
500       
501        ####
502        #Check the package type
503        #Input:
504        # - AppInfo dict (element of the list returned by _get_app_info)
505        #Output:
506        # - String with the type (deb, sh, zmd...)
507        ####
508        def _check_package_type(self,appInfo):
509                #Standalone installers must have the subcategory "installer"
510                #Zomandos must have the subcategory "Zomando"
511#               self._debug("Checking package type for app "+appInfo['name'])
512                if "Zomando" in appInfo['categories']:
513                        return_msg="zmd"
514                else:
515                        if "Installer" in appInfo['categories']:
516                                return_msg="sh"
517                        else:
518                                return_msg="deb"
519                return(return_msg)
520        #def _check_package_type
Note: See TracBrowser for help on using the repository browser.