@ -1,7 +1,7 @@
#! /usr/bi n/env python3 #! /usr/bi n/env python3
# -*- coding: utf-8 -*- # -*- coding: utf-8 -*-
""" """
Copyright 2020 , Nils Hilbricht , Germany ( https : / / www . hilbricht . net ) Copyright 2021 , Nils Hilbricht , Germany ( https : / / www . hilbricht . net )
This file is part of the Laborejo Software Suite ( https : / / www . laborejo . org ) , This file is part of the Laborejo Software Suite ( https : / / www . laborejo . org ) ,
@ -28,15 +28,15 @@ import os
#Our Modules #Our Modules
from engine . start import PATHS from engine . start import PATHS
def fast_scandir ( dir ) : def fast_scandir ( dir ) :
""" """
Get all subdirectories recursively . Get all subdirectories recursively .
https : / / stackoverflow . com / questions / 973473 / getting - a - list - of - all - subdirectories - in - the - current - directory """ https : / / stackoverflow . com / questions / 973473 / getting - a - list - of - all - subdirectories - in - the - current - directory """
try : try :
subfolders = [ f . path for f in os . scandir ( dir ) if f . is_dir ( ) ] subfolders = [ f . path for f in os . scandir ( dir ) if f . is_dir ( ) ]
except PermissionError : except PermissionError :
subfolders = [ ] subfolders = [ ]
for dir in list ( subfolders ) : for dir in list ( subfolders ) :
subfolders . extend ( fast_scandir ( dir ) ) subfolders . extend ( fast_scandir ( dir ) )
return subfolders return subfolders
@ -54,13 +54,13 @@ class Watcher(object):
" new " signal , and then our watcher will notice the change itself . However , this happens only so " new " signal , and then our watcher will notice the change itself . However , this happens only so
often and can be accepted , so the program does not need more checks and exceptions . often and can be accepted , so the program does not need more checks and exceptions .
Inform you via callback when : Inform you via callback when :
a ) a session dir was deleted a ) a session dir was deleted
b ) a new directory got created . b ) a new directory got created .
c ) session directory renamed or moved c ) session directory renamed or moved
d ) session . nsm changed timestamp d ) session . nsm changed timestamp
e ) A lockfile appeared or disappeared e ) A lockfile appeared or disappeared
We cannot poll nsmServerControl . exportSessionsAsDicts ( ) because that triggers an nsmd response We cannot poll nsmServerControl . exportSessionsAsDicts ( ) because that triggers an nsmd response
including log message and will flood their console . Instead this class only offers incremental including log message and will flood their console . Instead this class only offers incremental
@ -73,7 +73,7 @@ class Watcher(object):
it goes wrong a bit , at least in the new - session - manager GUI . They will leave a zombie lockfile . it goes wrong a bit , at least in the new - session - manager GUI . They will leave a zombie lockfile .
However , it still is possible to open a second nsmd instance . In this case the lockfile prevents However , it still is possible to open a second nsmd instance . In this case the lockfile prevents
opening a session twice . And we are reflecting the opened state of the project , no matter from opening a session twice . And we are reflecting the opened state of the project , no matter from
which daemon . Horray for us : ) which daemon . Horray for us : )
Clients can only be added or removed while a session is locked . We do not check nor update Clients can only be added or removed while a session is locked . We do not check nor update
number of clients or symlinks . Therefore we advice a GUI to deactivate the display of number of clients or symlinks . Therefore we advice a GUI to deactivate the display of
@ -82,17 +82,17 @@ class Watcher(object):
def __init__ ( self , nsmServerControl ) : def __init__ ( self , nsmServerControl ) :
self . active = True self . active = True
self . _nsmServerControl = nsmServerControl self . _nsmServerControl = nsmServerControl
assert self . _nsmServerControl . sessionRoot assert self . _nsmServerControl . sessionRoot
self . _directories = fast_scandir ( self . _nsmServerControl . sessionRoot ) self . _directories = fast_scandir ( self . _nsmServerControl . sessionRoot )
logger . info ( " Requestion our own copy of the session list. Don ' t worry about the apparent redundant call :) " ) logger . info ( " Requestion our own copy of the session list. Don ' t worry about the apparent redundant call :) " )
self . _lastExport = self . _nsmServerControl . exportSessionsAsDicts ( ) self . _lastExport = self . _nsmServerControl . exportSessionsAsDicts ( ) #list of dicts
self . _lastTimestamp = { d [ " nsmSessionName " ] : d [ " lastSavedDate " ] for d in self . _lastExport } #str:str self . _lastTimestamp = { d [ " nsmSessionName " ] : d [ " lastSavedDate " ] for d in self . _lastExport } #str:str
#Init all values with None will send the initial state via callback on program start, which is what the user wants to know. #Init all values with None will send the initial state via callback on program start, which is what the user wants to know.
self . _lastLockfile = { d [ " nsmSessionName " ] : None for d in self . _lastExport } #str:bool self . _lastLockfile = { d [ " nsmSessionName " ] : None for d in self . _lastExport } #str:bool
self . timeStampHook = None # a single function that gets informed of changes, most likely the api callback self . timeStampHook = None # a single function that gets informed of changes, most likely the api callback
@ -103,17 +103,26 @@ class Watcher(object):
""" For api callbacks """ """ For api callbacks """
self . active = True self . active = True
#If we returned from an open session that will surely have changed. Trigger a single poll #If we returned from an open session that will surely have changed. Trigger a single poll
self . process ( ) self . process ( )
logger . info ( " Watcher resumed " ) logger . info ( " Watcher resumed " )
def suspend ( self , * args ) : def suspend ( self , * args ) :
""" For api callbacks """ """ For api callbacks """
self . active = False self . active = False
logger . info ( " Watcher suspended " ) logger . info ( " Watcher suspended " )
def _update ( self ) :
current_directories = fast_scandir ( self . _nsmServerControl . sessionRoot )
if not self . _directories == current_directories :
self . _directories = current_directories
self . _lastExport = self . sessionsChangedHook ( ) #will gather its own data, send it to api callbacks, but also return for us.
self . _lastTimestamp = { d [ " nsmSessionName " ] : d [ " lastSavedDate " ] for d in self . _lastExport } #str:str
self . _lastLockfile = { d [ " nsmSessionName " ] : None for d in self . _lastExport } #str:bool
def process ( self ) : def process ( self ) :
""" Add this to your event loop. """ Add this to your event loop.
We look for any changes in the directory structure . We look for any changes in the directory structure .
If we detect any we simply trigger a new NSM export and a new NSM generated project If we detect any we simply trigger a new NSM export and a new NSM generated project
list via callback . We do not expect this to happen often . list via callback . We do not expect this to happen often .
@ -123,35 +132,42 @@ class Watcher(object):
""" """
if not self . active : if not self . active :
return return
if self . sessionsChangedHook : if self . sessionsChangedHook :
current_directories = fast_scandir ( self . _nsmServerControl . sessionRoot ) self . _update ( )
if not self . _directories == current_directories :
self . _directories = current_directories
self . _lastExport = self . sessionsChangedHook ( ) #will gather its own data, send it to api callbacks, but also return for us.
self . _lastTimestamp = { d [ " nsmSessionName " ] : d [ " lastSavedDate " ] for d in self . _lastExport } #str:str
self . _lastLockfile = { d [ " nsmSessionName " ] : None for d in self . _lastExport } #str:bool
#Now check the incremental hooks. #Now check the incremental hooks.
#No hooks, no reason to process #No hooks, no reason to process
if not ( self . timeStampHook or self . lockFileHook ) : if not ( self . timeStampHook or self . lockFileHook ) :
logger . info ( " No watcher-hooks to process " ) logger . info ( " No watcher-hooks to process " )
return return
for entry in self . _lastExport : for entry in self . _lastExport :
nsmSessionName = entry [ " nsmSessionName " ] nsmSessionName = entry [ " nsmSessionName " ]
#Timestamp of session.nsm try :
if self . timeStampHook : #Timestamp of session.nsm
timestamp = datetime . fromtimestamp ( entry [ " sessionFile " ] . stat ( ) . st_mtime ) . isoformat ( sep = " " , timespec = ' minutes ' ) #same format as server control export if self . timeStampHook :
if not timestamp == self . _lastTimestamp [ nsmSessionName ] : #This will only trigger on a minute-based slot, which is all we want and need. This is for relaying information to the user, not for advanced processing. timestamp = datetime . fromtimestamp ( entry [ " sessionFile " ] . stat ( ) . st_mtime ) . isoformat ( sep = " " , timespec = ' minutes ' ) #same format as server control export
self . _lastTimestamp [ nsmSessionName ] = timestamp if not timestamp == self . _lastTimestamp [ nsmSessionName ] : #This will only trigger on a minute-based slot, which is all we want and need. This is for relaying information to the user, not for advanced processing.
self . timeStampHook ( nsmSessionName , timestamp ) self . _lastTimestamp [ nsmSessionName ] = timestamp
self . timeStampHook ( nsmSessionName , timestamp )
#Lockfiles
if self . lockFileHook : #Lockfiles
lockfileState = entry [ " lockFile " ] . is_file ( ) if self . lockFileHook :
if not self . _lastLockfile [ nsmSessionName ] == lockfileState : lockfileState = entry [ " lockFile " ] . is_file ( )
self . _lastLockfile [ nsmSessionName ] = lockfileState if not self . _lastLockfile [ nsmSessionName ] == lockfileState :
self . lockFileHook ( nsmSessionName , lockfileState ) self . _lastLockfile [ nsmSessionName ] = lockfileState
self . lockFileHook ( nsmSessionName , lockfileState )
except PermissionError :
logger . warning ( f " File Permission error for { entry } " )
self . _lastExport . remove ( entry ) #avoid stumbling upon this again
self . _update ( )
except FileNotFoundError :
logger . warning ( f " File not found error for { entry } " )
self . _lastExport . remove ( entry ) #avoid stumbling upon this again
self . _update ( )
Nils
3 years ago