idx
int64
0
63k
question
stringlengths
61
4.03k
target
stringlengths
6
1.23k
5,100
def _fail ( self , event , message = 'Invalid credentials' ) : notification = { 'component' : 'auth' , 'action' : 'fail' , 'data' : message } ip = event . sock . getpeername ( ) [ 0 ] self . failing_clients [ ip ] = event Timer ( 3 , Event . create ( 'notify_fail' , event . clientuuid , notification , ip ) ) . register ( self )
Sends a failure message to the requesting client
5,101
def _login ( self , event , user_account , user_profile , client_config ) : user_account . lastlogin = std_now ( ) user_account . save ( ) user_account . passhash = "" self . fireEvent ( authentication ( user_account . name , ( user_account , user_profile , client_config ) , event . clientuuid , user_account . uuid , event . sock ) , "auth" )
Send login notification to client
5,102
def _handle_autologin ( self , event ) : self . log ( "Verifying automatic login request" ) try : client_config = objectmodels [ 'client' ] . find_one ( { 'uuid' : event . requestedclientuuid } ) except Exception : client_config = None if client_config is None or client_config . autologin is False : self . log ( "Autologin failed:" , event . requestedclientuuid , lvl = error ) self . _fail ( event ) return try : user_account = objectmodels [ 'user' ] . find_one ( { 'uuid' : client_config . owner } ) if user_account is None : raise AuthenticationError self . log ( "Autologin for" , user_account . name , lvl = debug ) except Exception as e : self . log ( "No user object due to error: " , e , type ( e ) , lvl = error ) self . _fail ( event ) return if user_account . active is False : self . log ( "Account deactivated." ) self . _fail ( event , 'Account deactivated.' ) return user_profile = self . _get_profile ( user_account ) self . _login ( event , user_account , user_profile , client_config ) self . log ( "Autologin successful!" , lvl = warn )
Automatic logins for client configurations that allow it
5,103
def _handle_login ( self , event ) : self . log ( "Auth request for " , event . username , 'client:' , event . clientuuid ) if ( len ( event . username ) < 1 ) or ( len ( event . password ) < 5 ) : self . log ( "Illegal username or password received, login cancelled" , lvl = warn ) self . _fail ( event , 'Password or username too short' ) return client_config = None try : user_account = objectmodels [ 'user' ] . find_one ( { 'name' : event . username } ) if user_account is None : raise AuthenticationError except Exception as e : self . log ( "No userobject due to error: " , e , type ( e ) , lvl = error ) self . _fail ( event ) return self . log ( "User found." , lvl = debug ) if user_account . active is False : self . log ( "Account deactivated." ) self . _fail ( event , 'Account deactivated.' ) return if not std_hash ( event . password , self . salt ) == user_account . passhash : self . log ( "Password was wrong!" , lvl = warn ) self . _fail ( event ) return self . log ( "Passhash matches, checking client and profile." , lvl = debug ) requested_client_uuid = event . requestedclientuuid if requested_client_uuid is not None : client_config = objectmodels [ 'client' ] . find_one ( { 'uuid' : requested_client_uuid } ) if client_config : self . log ( "Checking client configuration permissions" , lvl = debug ) if client_config . owner != user_account . uuid : client_config = None self . log ( "Unauthorized client configuration " "requested" , lvl = warn ) else : self . log ( "Unknown client configuration requested: " , requested_client_uuid , event . __dict__ , lvl = warn ) if not client_config : self . log ( "Creating new default client configuration" ) uuid = event . clientuuid if event . clientuuid is not None else str ( uuid4 ( ) ) client_config = objectmodels [ 'client' ] ( { 'uuid' : uuid } ) client_config . name = std_human_uid ( kind = 'place' ) client_config . description = "New client configuration from " + user_account . name client_config . owner = user_account . uuid client_config . save ( ) user_profile = self . _get_profile ( user_account ) self . _login ( event , user_account , user_profile , client_config ) self . log ( "Done with Login request" , lvl = debug )
Manual password based login
5,104
def _get_profile ( self , user_account ) : try : user_profile = objectmodels [ 'profile' ] . find_one ( { 'owner' : str ( user_account . uuid ) } ) self . log ( "Profile: " , user_profile , user_account . uuid , lvl = debug ) except Exception as e : self . log ( "No profile due to error: " , e , type ( e ) , lvl = error ) user_profile = None if not user_profile : default = { 'uuid' : std_uuid ( ) , 'owner' : user_account . uuid , 'userdata' : { 'notes' : 'Default profile of ' + user_account . name } } user_profile = objectmodels [ 'profile' ] ( default ) user_profile . save ( ) return user_profile
Retrieves a user s profile
5,105
def _parse ( self , bus , data ) : sen_time = time . time ( ) try : if isinstance ( data , bytes ) : data = data . decode ( 'ascii' ) dirtysentences = data . split ( "\n" ) sentences = [ ( sen_time , x ) for x in dirtysentences if x ] def unique ( it ) : s = set ( ) for el in it : if el not in s : s . add ( el ) yield el else : self . log ( "Duplicate sentence received: " , el , lvl = debug ) sentences = list ( unique ( sentences ) ) return sentences except Exception as e : self . log ( "Error during data unpacking: " , e , type ( e ) , lvl = error , exc = True )
Called when a sensor sends a new raw data to this serial connector .
5,106
def main ( ) : desc = 'Converts between geodetic, modified apex, quasi-dipole and MLT' parser = argparse . ArgumentParser ( description = desc , prog = 'apexpy' ) parser . add_argument ( 'source' , metavar = 'SOURCE' , choices = [ 'geo' , 'apex' , 'qd' , 'mlt' ] , help = 'Convert from {geo, apex, qd, mlt}' ) parser . add_argument ( 'dest' , metavar = 'DEST' , choices = [ 'geo' , 'apex' , 'qd' , 'mlt' ] , help = 'Convert to {geo, apex, qd, mlt}' ) desc = 'YYYY[MM[DD[HHMMSS]]] date/time for IGRF coefficients, time part ' desc += 'required for MLT calculations' parser . add_argument ( 'date' , metavar = 'DATE' , help = desc ) parser . add_argument ( '--height' , dest = 'height' , default = 0 , metavar = 'HEIGHT' , type = float , help = 'height for conversion' ) parser . add_argument ( '--refh' , dest = 'refh' , metavar = 'REFH' , type = float , default = 0 , help = 'reference height for modified apex coordinates' ) parser . add_argument ( '-i' , '--input' , dest = 'file_in' , metavar = 'FILE_IN' , type = argparse . FileType ( 'r' ) , default = STDIN , help = 'input file (stdin if none specified)' ) parser . add_argument ( '-o' , '--output' , dest = 'file_out' , metavar = 'FILE_OUT' , type = argparse . FileType ( 'wb' ) , default = STDOUT , help = 'output file (stdout if none specified)' ) args = parser . parse_args ( ) array = np . loadtxt ( args . file_in , ndmin = 2 ) if 'mlt' in [ args . source , args . dest ] and len ( args . date ) < 14 : desc = 'full date/time YYYYMMDDHHMMSS required for MLT calculations' raise ValueError ( desc ) if 9 <= len ( args . date ) <= 13 : desc = 'full date/time must be given as YYYYMMDDHHMMSS, not ' + 'YYYYMMDDHHMMSS' [ : len ( args . date ) ] raise ValueError ( desc ) datetime = dt . datetime . strptime ( args . date , '%Y%m%d%H%M%S' [ : len ( args . date ) - 2 ] ) A = apexpy . Apex ( date = datetime , refh = args . refh ) lats , lons = A . convert ( array [ : , 0 ] , array [ : , 1 ] , args . source , args . dest , args . height , datetime = datetime ) np . savetxt ( args . file_out , np . column_stack ( ( lats , lons ) ) , fmt = '%.8f' )
Entry point for the script
5,107
def run_process ( cwd , args ) : try : process = check_output ( args , cwd = cwd , stderr = STDOUT ) return process except CalledProcessError as e : log ( 'Uh oh, the teapot broke again! Error:' , e , type ( e ) , lvl = verbose , pretty = True ) log ( e . cmd , e . returncode , e . output , lvl = verbose ) return e . output
Executes an external process via subprocess . Popen
5,108
def _ask_password ( ) : password = "Foo" password_trial = "" while password != password_trial : password = getpass . getpass ( ) password_trial = getpass . getpass ( prompt = "Repeat:" ) if password != password_trial : print ( "\nPasswords do not match!" ) return password
Securely and interactively ask for a password
5,109
def _get_credentials ( username = None , password = None , dbhost = None ) : system_config = dbhost . objectmodels [ 'systemconfig' ] . find_one ( { 'active' : True } ) try : salt = system_config . salt . encode ( 'ascii' ) except ( KeyError , AttributeError ) : log ( 'No systemconfig or it is without a salt! ' 'Reinstall the system provisioning with' 'hfos_manage.py install provisions -p system' ) sys . exit ( 3 ) if username is None : username = _ask ( "Please enter username: " ) else : username = username if password is None : password = _ask_password ( ) else : password = password try : password = password . encode ( 'utf-8' ) except UnicodeDecodeError : password = password passhash = hashlib . sha512 ( password ) passhash . update ( salt ) return username , passhash . hexdigest ( )
Obtain user credentials by arguments or asking the user
5,110
def _ask ( question , default = None , data_type = 'str' , show_hint = False ) : data = default if data_type == 'bool' : data = None default_string = "Y" if default else "N" while data not in ( 'Y' , 'J' , 'N' , '1' , '0' ) : data = input ( "%s? [%s]: " % ( question , default_string ) ) . upper ( ) if data == '' : return default return data in ( 'Y' , 'J' , '1' ) elif data_type in ( 'str' , 'unicode' ) : if show_hint : msg = "%s? [%s] (%s): " % ( question , default , data_type ) else : msg = question data = input ( msg ) if len ( data ) == 0 : data = default elif data_type == 'int' : if show_hint : msg = "%s? [%s] (%s): " % ( question , default , data_type ) else : msg = question data = input ( msg ) if len ( data ) == 0 : data = int ( default ) else : data = int ( data ) return data
Interactively ask the user for data
5,111
def getsinIm ( alat ) : alat = np . float64 ( alat ) return 2 * np . sin ( np . radians ( alat ) ) / np . sqrt ( 4 - 3 * np . cos ( np . radians ( alat ) ) ** 2 )
Computes sinIm from modified apex latitude .
5,112
def getcosIm ( alat ) : alat = np . float64 ( alat ) return np . cos ( np . radians ( alat ) ) / np . sqrt ( 4 - 3 * np . cos ( np . radians ( alat ) ) ** 2 )
Computes cosIm from modified apex latitude .
5,113
def gc2gdlat ( gclat ) : WGS84_e2 = 0.006694379990141317 return np . rad2deg ( - np . arctan ( np . tan ( np . deg2rad ( gclat ) ) / ( WGS84_e2 - 1 ) ) )
Converts geocentric latitude to geodetic latitude using WGS84 .
5,114
def subsol ( datetime ) : year = datetime . year doy = datetime . timetuple ( ) . tm_yday ut = datetime . hour * 3600 + datetime . minute * 60 + datetime . second if not 1601 <= year <= 2100 : raise ValueError ( 'Year must be in [1601, 2100]' ) yr = year - 2000 nleap = int ( np . floor ( ( year - 1601.0 ) / 4.0 ) ) nleap -= 99 if year <= 1900 : ncent = int ( np . floor ( ( year - 1601.0 ) / 100.0 ) ) ncent = 3 - ncent nleap = nleap + ncent l0 = - 79.549 + ( - 0.238699 * ( yr - 4.0 * nleap ) + 3.08514e-2 * nleap ) g0 = - 2.472 + ( - 0.2558905 * ( yr - 4.0 * nleap ) - 3.79617e-2 * nleap ) df = ( ut / 86400.0 - 1.5 ) + doy lmean = l0 + 0.9856474 * df grad = np . radians ( g0 + 0.9856003 * df ) lmrad = np . radians ( lmean + 1.915 * np . sin ( grad ) + 0.020 * np . sin ( 2.0 * grad ) ) sinlm = np . sin ( lmrad ) epsrad = np . radians ( 23.439 - 4e-7 * ( df + 365 * yr + nleap ) ) alpha = np . degrees ( np . arctan2 ( np . cos ( epsrad ) * sinlm , np . cos ( lmrad ) ) ) sslat = np . degrees ( np . arcsin ( np . sin ( epsrad ) * sinlm ) ) etdeg = lmean - alpha nrot = round ( etdeg / 360.0 ) etdeg = etdeg - 360.0 * nrot sslon = 180.0 - ( ut / 240.0 + etdeg ) nrot = round ( sslon / 360.0 ) sslon = sslon - 360.0 * nrot return sslat , sslon
Finds subsolar geocentric latitude and longitude .
5,115
def make_auth_headers ( ) : if not os . path . exists ( ".appveyor.token" ) : raise RuntimeError ( "Please create a file named `.appveyor.token` in the current directory. " "You can get the token from https://ci.appveyor.com/api-token" ) with open ( ".appveyor.token" ) as f : token = f . read ( ) . strip ( ) headers = { 'Authorization' : 'Bearer {}' . format ( token ) , } return headers
Make the authentication headers needed to use the Appveyor API .
5,116
def get_project_build ( account_project ) : url = make_url ( "/projects/{account_project}" , account_project = account_project ) response = requests . get ( url , headers = make_auth_headers ( ) ) return response . json ( )
Get the details of the latest Appveyor build .
5,117
def download_url ( url , filename , headers ) : ensure_dirs ( filename ) response = requests . get ( url , headers = headers , stream = True ) if response . status_code == 200 : with open ( filename , 'wb' ) as f : for chunk in response . iter_content ( 16 * 1024 ) : f . write ( chunk )
Download a file from url to filename .
5,118
def cli_schemata_list ( self , * args ) : self . log ( 'Registered schemata languages:' , "," . join ( sorted ( l10n_schemastore . keys ( ) ) ) ) self . log ( 'Registered Schemata:' , "," . join ( sorted ( schemastore . keys ( ) ) ) ) if '-c' in args or '-config' in args : self . log ( 'Registered Configuration Schemata:' , "," . join ( sorted ( configschemastore . keys ( ) ) ) , pretty = True )
Display a list of registered schemata
5,119
def cli_form ( self , * args ) : if args [ 0 ] == '*' : for schema in schemastore : self . log ( schema , ':' , schemastore [ schema ] [ 'form' ] , pretty = True ) else : self . log ( schemastore [ args [ 0 ] ] [ 'form' ] , pretty = True )
Display a schemata s form definition
5,120
def cli_schema ( self , * args ) : key = None if len ( args ) > 1 : key = args [ 1 ] args = list ( args ) if '-config' in args or '-c' in args : store = configschemastore try : args . remove ( '-c' ) args . remove ( '-config' ) except ValueError : pass else : store = schemastore def output ( schema ) : self . log ( "%s :" % schema ) if key == 'props' : self . log ( store [ schema ] [ 'schema' ] [ 'properties' ] , pretty = True ) elif key == 'perms' : try : self . log ( store [ schema ] [ 'schema' ] [ 'roles_create' ] , pretty = True ) except KeyError : self . log ( 'Schema' , schema , 'has no role for creation' , lvl = warn ) try : self . log ( store [ schema ] [ 'schema' ] [ 'properties' ] [ 'perms' ] [ 'properties' ] , pretty = True ) except KeyError : self . log ( 'Schema' , schema , 'has no permissions' , lvl = warn ) else : self . log ( store [ schema ] [ 'schema' ] , pretty = True ) if '*' in args : for schema in store : output ( schema ) else : output ( args [ 0 ] )
Display a single schema definition
5,121
def cli_forms ( self , * args ) : forms = [ ] missing = [ ] for key , item in schemastore . items ( ) : if 'form' in item and len ( item [ 'form' ] ) > 0 : forms . append ( key ) else : missing . append ( key ) self . log ( 'Schemata with form:' , forms ) self . log ( 'Missing forms:' , missing )
List all available form definitions
5,122
def cli_default_perms ( self , * args ) : for key , item in schemastore . items ( ) : if item [ 'schema' ] . get ( 'no_perms' , False ) : self . log ( 'Schema without permissions:' , key ) continue try : perms = item [ 'schema' ] [ 'properties' ] [ 'perms' ] [ 'properties' ] if perms == { } : self . log ( 'Schema:' , item , pretty = True ) self . log ( 'Schema:' , key , 'read' , perms [ 'read' ] [ 'default' ] , 'write' , perms [ 'write' ] [ 'default' ] , 'list' , perms [ 'list' ] [ 'default' ] , 'create' , item [ 'schema' ] [ 'roles_create' ] ) except KeyError as e : self . log ( 'Fishy schema found:' , key , e , lvl = error ) self . log ( item , pretty = True )
Show default permissions for all schemata
5,123
def all ( self , event ) : self . log ( "Schemarequest for all schemata from" , event . user , lvl = debug ) response = { 'component' : 'hfos.events.schemamanager' , 'action' : 'all' , 'data' : l10n_schemastore [ event . client . language ] } self . fireEvent ( send ( event . client . uuid , response ) )
Return all known schemata to the requesting client
5,124
def get ( self , event ) : self . log ( "Schemarequest for" , event . data , "from" , event . user , lvl = debug ) if event . data in schemastore : response = { 'component' : 'hfos.events.schemamanager' , 'action' : 'get' , 'data' : l10n_schemastore [ event . client . language ] [ event . data ] } self . fireEvent ( send ( event . client . uuid , response ) ) else : self . log ( "Unavailable schema requested!" , lvl = warn )
Return a single schema
5,125
def configuration ( self , event ) : try : self . log ( "Schemarequest for all configuration schemata from" , event . user . account . name , lvl = debug ) response = { 'component' : 'hfos.events.schemamanager' , 'action' : 'configuration' , 'data' : configschemastore } self . fireEvent ( send ( event . client . uuid , response ) ) except Exception as e : self . log ( "ERROR:" , e )
Return all configurable components schemata
5,126
def uuid_object ( title = "Reference" , description = "Select an object" , default = None , display = True ) : uuid = { 'pattern' : '^[a-fA-F0-9]{8}-[a-fA-F0-9]{4}-[a-fA-F0-9]{' '4}-[' 'a-fA-F0-9]{4}-[a-fA-F0-9]{12}$' , 'type' : 'string' , 'title' : title , 'description' : description , } if not display : uuid [ 'x-schema-form' ] = { 'condition' : "false" } if default is not None : uuid [ 'default' ] = default return uuid
Generates a regular expression controlled UUID field
5,127
def base_object ( name , no_perms = False , has_owner = True , hide_owner = True , has_uuid = True , roles_write = None , roles_read = None , roles_list = None , roles_create = None , all_roles = None ) : base_schema = { 'id' : '#' + name , 'type' : 'object' , 'name' : name , 'properties' : { } } if not no_perms : if all_roles : roles_create = [ 'admin' , all_roles ] roles_write = [ 'admin' , all_roles ] roles_read = [ 'admin' , all_roles ] roles_list = [ 'admin' , all_roles ] else : if roles_write is None : roles_write = [ 'admin' ] if roles_read is None : roles_read = [ 'admin' ] if roles_list is None : roles_list = [ 'admin' ] if roles_create is None : roles_create = [ 'admin' ] if isinstance ( roles_create , str ) : roles_create = [ roles_create ] if isinstance ( roles_write , str ) : roles_write = [ roles_write ] if isinstance ( roles_read , str ) : roles_read = [ roles_read ] if isinstance ( roles_list , str ) : roles_list = [ roles_list ] if has_owner : roles_write . append ( 'owner' ) roles_read . append ( 'owner' ) roles_list . append ( 'owner' ) base_schema [ 'roles_create' ] = roles_create base_schema [ 'properties' ] . update ( { 'perms' : { 'id' : '#perms' , 'type' : 'object' , 'name' : 'perms' , 'properties' : { 'write' : { 'type' : 'array' , 'default' : roles_write , 'items' : { 'type' : 'string' , } } , 'read' : { 'type' : 'array' , 'default' : roles_read , 'items' : { 'type' : 'string' , } } , 'list' : { 'type' : 'array' , 'default' : roles_list , 'items' : { 'type' : 'string' , } } } , 'default' : { } , 'x-schema-form' : { 'condition' : "false" } } , 'name' : { 'type' : 'string' , 'description' : 'Name of ' + name } } ) if has_owner : base_schema [ 'properties' ] . update ( { 'owner' : uuid_object ( title = 'Unique Owner ID' , display = hide_owner ) } ) else : base_schema [ 'no_perms' ] = True if has_uuid : base_schema [ 'properties' ] . update ( { 'uuid' : uuid_object ( title = 'Unique ' + name + ' ID' , display = False ) } ) base_schema [ 'required' ] = [ "uuid" ] return base_schema
Generates a basic object with RBAC properties
5,128
def sensordata ( self , event ) : if len ( self . datatypes ) == 0 : return data = event . data timestamp = event . timestamp self . log ( "New incoming navdata:" , data , lvl = verbose ) for name , value in data . items ( ) : if name in self . datatypes : ref = self . datatypes [ name ] self . sensed [ name ] = ref if ref . lastvalue != str ( value ) : item = { 'value' : value , 'timestamp' : timestamp , 'type' : name } self . referenceframe [ name ] = value self . referenceages [ name ] = timestamp if ref . name in self . subscriptions : packet = { 'component' : 'hfos.navdata.sensors' , 'action' : 'update' , 'data' : item } self . log ( "Serving update: " , packet , lvl = verbose ) for uuid in self . subscriptions [ ref . name ] : self . log ( "Serving to " , uuid , lvl = events ) self . fireEvent ( send ( uuid , packet ) , 'hfosweb' ) sensordata = objectmodels [ 'sensordata' ] ( item ) if ref . record : self . log ( "Recording updated reference:" , sensordata . _fields ) sensordata . save ( ) ref . lastvalue = str ( value ) ref . timestamp = timestamp else : self . log ( "Unknown sensor data received!" , data , lvl = warn )
Generates a new reference frame from incoming sensordata
5,129
def db_export ( schema , uuid , object_filter , export_format , filename , pretty , all_schemata , omit ) : internal_backup ( schema , uuid , object_filter , export_format , filename , pretty , all_schemata , omit )
Export stored objects
5,130
def db_import ( ctx , schema , uuid , object_filter , import_format , filename , all_schemata , dry ) : import_format = import_format . upper ( ) with open ( filename , 'r' ) as f : json_data = f . read ( ) data = json . loads ( json_data ) if schema is None : if all_schemata is False : log ( 'No schema given. Read the help' , lvl = warn ) return else : schemata = data . keys ( ) else : schemata = [ schema ] from hfos import database database . initialize ( ctx . obj [ 'dbhost' ] , ctx . obj [ 'dbname' ] ) all_items = { } total = 0 for schema_item in schemata : model = database . objectmodels [ schema_item ] objects = data [ schema_item ] if uuid : for item in objects : if item [ 'uuid' ] == uuid : items = [ model ( item ) ] else : items = [ ] for item in objects : thing = model ( item ) items . append ( thing ) schema_total = len ( items ) total += schema_total if dry : log ( 'Would import' , schema_total , 'items of' , schema_item ) all_items [ schema_item ] = items if dry : log ( 'Would import' , total , 'objects.' ) else : log ( 'Importing' , total , 'objects.' ) for schema_name , item_list in all_items . items ( ) : log ( 'Importing' , len ( item_list ) , 'objects of type' , schema_name ) for item in item_list : item . _fields [ '_id' ] = bson . objectid . ObjectId ( item . _fields [ '_id' ] ) item . save ( )
Import objects from file
5,131
def _page_update ( self , event ) : try : if event . schema == 'wikipage' : self . _update_index ( ) except Exception as e : self . log ( "Page creation notification error: " , event , e , type ( e ) , lvl = error )
Checks if the newly created object is a wikipage .. If so rerenders the automatic index .
5,132
def construct_graph ( args ) : app = Core ( args ) setup_root ( app ) if args [ 'debug' ] : from circuits import Debugger hfoslog ( "Starting circuits debugger" , lvl = warn , emitter = 'GRAPH' ) dbg = Debugger ( ) . register ( app ) dbg . IgnoreEvents . extend ( [ "read" , "_read" , "write" , "_write" , "stream_success" , "stream_complete" , "serial_packet" , "raw_data" , "stream" , "navdatapush" , "referenceframe" , "updateposition" , "updatesubscriptions" , "generatevesseldata" , "generatenavdata" , "sensordata" , "reset_flood_offenders" , "reset_flood_counters" , "task_success" , "task_done" , "keepalive" ] ) hfoslog ( "Beginning graph assembly." , emitter = 'GRAPH' ) if args [ 'drawgraph' ] : from circuits . tools import graph graph ( app ) if args [ 'opengui' ] : import webbrowser webbrowser . open ( "http://%s:%i/" % ( args [ 'host' ] , args [ 'port' ] ) ) hfoslog ( "Graph assembly done." , emitter = 'GRAPH' ) return app
Preliminary HFOS application Launcher
5,133
def launch ( run = True , ** args ) : verbosity [ 'console' ] = args [ 'log' ] if not args [ 'quiet' ] else 100 verbosity [ 'global' ] = min ( args [ 'log' ] , args [ 'logfileverbosity' ] ) verbosity [ 'file' ] = args [ 'logfileverbosity' ] if args [ 'dolog' ] else 100 set_logfile ( args [ 'logfilepath' ] , args [ 'instance' ] ) if args [ 'livelog' ] is True : from hfos import logger logger . live = True hfoslog ( "Running with Python" , sys . version . replace ( "\n" , "" ) , sys . platform , lvl = debug , emitter = 'CORE' ) hfoslog ( "Interpreter executable:" , sys . executable , emitter = 'CORE' ) if args [ 'cert' ] is not None : hfoslog ( "Warning! Using SSL without nginx is currently not broken!" , lvl = critical , emitter = 'CORE' ) hfoslog ( "Initializing database access" , emitter = 'CORE' , lvl = debug ) initialize ( args [ 'dbhost' ] , args [ 'dbname' ] , args [ 'instance' ] ) server = construct_graph ( args ) if run and not args [ 'norun' ] : server . run ( ) return server
Bootstrap basics assemble graph and hand over control to the Core component
5,134
def ready ( self , source ) : from hfos . database import configschemastore configschemastore [ self . name ] = self . configschema self . _start_server ( ) if not self . insecure : self . _drop_privileges ( ) self . fireEvent ( cli_register_event ( 'components' , cli_components ) ) self . fireEvent ( cli_register_event ( 'drop_privileges' , cli_drop_privileges ) ) self . fireEvent ( cli_register_event ( 'reload_db' , cli_reload_db ) ) self . fireEvent ( cli_register_event ( 'reload' , cli_reload ) ) self . fireEvent ( cli_register_event ( 'quit' , cli_quit ) ) self . fireEvent ( cli_register_event ( 'info' , cli_info ) )
All components have initialized set up the component configuration schema - store run the local server and drop privileges
5,135
def trigger_frontend_build ( self , event ) : from hfos . database import instance install_frontend ( instance = instance , forcerebuild = event . force , install = event . install , development = self . development )
Event hook to trigger a new frontend build
5,136
def cli_reload ( self , event ) : self . log ( 'Reloading all components.' ) self . update_components ( forcereload = True ) initialize ( ) from hfos . debugger import cli_compgraph self . fireEvent ( cli_compgraph ( ) )
Experimental call to reload the component tree
5,137
def cli_info ( self , event ) : self . log ( 'Instance:' , self . instance , 'Dev:' , self . development , 'Host:' , self . host , 'Port:' , self . port , 'Insecure:' , self . insecure , 'Frontend:' , self . frontendtarget )
Provides information about the running instance
5,138
def _start_server ( self , * args ) : self . log ( "Starting server" , args ) secure = self . certificate is not None if secure : self . log ( "Running SSL server with cert:" , self . certificate ) else : self . log ( "Running insecure server without SSL. Do not use without SSL proxy in production!" , lvl = warn ) try : self . server = Server ( ( self . host , self . port ) , secure = secure , certfile = self . certificate ) . register ( self ) except PermissionError : self . log ( 'Could not open (privileged?) port, check ' 'permissions!' , lvl = critical )
Run the node local server
5,139
def update_components ( self , forcereload = False , forcerebuild = False , forcecopy = True , install = False ) : self . log ( "Updating components" ) components = { } if True : from pkg_resources import iter_entry_points entry_point_tuple = ( iter_entry_points ( group = 'hfos.base' , name = None ) , iter_entry_points ( group = 'hfos.sails' , name = None ) , iter_entry_points ( group = 'hfos.components' , name = None ) ) for iterator in entry_point_tuple : for entry_point in iterator : try : name = entry_point . name location = entry_point . dist . location loaded = entry_point . load ( ) self . log ( "Entry point: " , entry_point , name , entry_point . resolve ( ) , lvl = verbose ) self . log ( "Loaded: " , loaded , lvl = verbose ) comp = { 'package' : entry_point . dist . project_name , 'location' : location , 'version' : str ( entry_point . dist . parsed_version ) , 'description' : loaded . __doc__ } components [ name ] = comp self . loadable_components [ name ] = loaded self . log ( "Loaded component:" , comp , lvl = verbose ) except Exception as e : self . log ( "Could not inspect entrypoint: " , e , type ( e ) , entry_point , iterator , lvl = error , exc = True ) self . log ( "Checking component frontend bits in " , self . frontendroot , lvl = verbose ) diff = set ( components ) ^ set ( self . config . components ) if diff or forcecopy and self . config . frontendenabled : self . log ( "Old component configuration differs:" , diff , lvl = debug ) self . log ( self . config . components , components , lvl = verbose ) self . config . components = components else : self . log ( "No component configuration change. Proceeding." ) if forcereload : self . log ( "Restarting all components." , lvl = warn ) self . _instantiate_components ( clear = True )
Check all known entry points for components . If necessary manage configuration updates
5,140
def _start_frontend ( self , restart = False ) : self . log ( self . config , self . config . frontendenabled , lvl = verbose ) if self . config . frontendenabled and not self . frontendrunning or restart : self . log ( "Restarting webfrontend services on" , self . frontendtarget ) self . static = Static ( "/" , docroot = self . frontendtarget ) . register ( self ) self . websocket = WebSocketsDispatcher ( "/websocket" ) . register ( self ) self . frontendrunning = True
Check if it is enabled and start the frontend http & websocket
5,141
def _instantiate_components ( self , clear = True ) : if clear : import objgraph from copy import deepcopy from circuits . tools import kill from circuits import Component for comp in self . runningcomponents . values ( ) : self . log ( comp , type ( comp ) , isinstance ( comp , Component ) , pretty = True ) kill ( comp ) self . runningcomponents = { } self . log ( 'Not running blacklisted components: ' , self . component_blacklist , lvl = debug ) running = set ( self . loadable_components . keys ( ) ) . difference ( self . component_blacklist ) self . log ( 'Starting components: ' , sorted ( running ) ) for name , componentdata in self . loadable_components . items ( ) : if name in self . component_blacklist : continue self . log ( "Running component: " , name , lvl = verbose ) try : if name in self . runningcomponents : self . log ( "Component already running: " , name , lvl = warn ) else : runningcomponent = componentdata ( ) runningcomponent . register ( self ) self . runningcomponents [ name ] = runningcomponent except Exception as e : self . log ( "Could not register component: " , name , e , type ( e ) , lvl = error , exc = True )
Inspect all loadable components and run them
5,142
def _create_user ( ctx ) : username , passhash = _get_credentials ( ctx . obj [ 'username' ] , ctx . obj [ 'password' ] , ctx . obj [ 'db' ] ) if ctx . obj [ 'db' ] . objectmodels [ 'user' ] . count ( { 'name' : username } ) > 0 : raise KeyError ( ) new_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] ( { 'uuid' : str ( uuid4 ( ) ) , 'created' : std_now ( ) } ) new_user . name = username new_user . passhash = passhash return new_user
Internal method to create a normal user
5,143
def create_user ( ctx ) : try : new_user = _create_user ( ctx ) new_user . save ( ) log ( "Done" ) except KeyError : log ( 'User already exists' , lvl = warn )
Creates a new local user
5,144
def create_admin ( ctx ) : try : admin = _create_user ( ctx ) admin . roles . append ( 'admin' ) admin . save ( ) log ( "Done" ) except KeyError : log ( 'User already exists' , lvl = warn )
Creates a new local user and assigns admin role
5,145
def delete_user ( ctx , yes ) : if ctx . obj [ 'username' ] is None : username = _ask ( "Please enter username:" ) else : username = ctx . obj [ 'username' ] del_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] . find_one ( { 'name' : username } ) if yes or _ask ( 'Confirm deletion' , default = False , data_type = 'bool' ) : try : del_user . delete ( ) log ( "Done" ) except AttributeError : log ( 'User not found' , lvl = warn ) else : log ( "Cancelled" )
Delete a local user
5,146
def change_password ( ctx ) : username , passhash = _get_credentials ( ctx . obj [ 'username' ] , ctx . obj [ 'password' ] , ctx . obj [ 'db' ] ) change_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] . find_one ( { 'name' : username } ) if change_user is None : log ( 'No such user' , lvl = warn ) return change_user . passhash = passhash change_user . save ( ) log ( "Done" )
Change password of an existing user
5,147
def list_users ( ctx , search , uuid , active ) : users = ctx . obj [ 'db' ] . objectmodels [ 'user' ] for found_user in users . find ( ) : if not search or ( search and search in found_user . name ) : print ( found_user . name , end = ' ' if active or uuid else '\n' ) if uuid : print ( found_user . uuid , end = ' ' if active else '\n' ) if active : print ( found_user . active ) log ( "Done" )
List all locally known users
5,148
def disable ( ctx ) : if ctx . obj [ 'username' ] is None : log ( 'Specify the username with "iso db user --username ..."' ) return change_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] . find_one ( { 'name' : ctx . obj [ 'username' ] } ) change_user . active = False change_user . save ( ) log ( 'Done' )
Disable an existing user
5,149
def enable ( ctx ) : if ctx . obj [ 'username' ] is None : log ( 'Specify the username with "iso db user --username ..."' ) return change_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] . find_one ( { 'name' : ctx . obj [ 'username' ] } ) change_user . active = True change_user . save ( ) log ( 'Done' )
Enable an existing user
5,150
def add_role ( ctx , role ) : if role is None : log ( 'Specify the role with --role' ) return if ctx . obj [ 'username' ] is None : log ( 'Specify the username with --username' ) return change_user = ctx . obj [ 'db' ] . objectmodels [ 'user' ] . find_one ( { 'name' : ctx . obj [ 'username' ] } ) if role not in change_user . roles : change_user . roles . append ( role ) change_user . save ( ) log ( 'Done' ) else : log ( 'User already has that role!' , lvl = warn )
Grant a role to an existing user
5,151
def _get_future_tasks ( self ) : self . alerts = { } now = std_now ( ) for task in objectmodels [ 'task' ] . find ( { 'alert_time' : { '$gt' : now } } ) : self . alerts [ task . alert_time ] = task self . log ( 'Found' , len ( self . alerts ) , 'future tasks' )
Assemble a list of future alerts
5,152
def cmdmap ( xdot ) : from copy import copy def print_commands ( command , map_output , groups = None , depth = 0 ) : if groups is None : groups = [ ] if 'commands' in command . __dict__ : if len ( groups ) > 0 : if xdot : line = " %s -> %s [weight=1.0];\n" % ( groups [ - 1 ] , command . name ) else : line = " " * ( depth - 1 ) + "%s %s\n" % ( groups [ - 1 ] , command . name ) map_output . append ( line ) for item in command . commands . values ( ) : subgroups = copy ( groups ) subgroups . append ( command . name ) print_commands ( item , map_output , subgroups , depth + 1 ) else : if xdot : line = " %s -> %s [weight=%1.1f];\n" % ( groups [ - 1 ] , command . name , len ( groups ) ) else : line = " " * ( len ( groups ) - 3 + depth ) + "%s %s\n" % ( groups [ - 1 ] , command . name ) map_output . append ( line ) output = [ ] print_commands ( cli , output ) output = [ line . replace ( "cli" , "isomer" ) for line in output ] if xdot : with open ( 'iso.dot' , 'w' ) as f : f . write ( 'strict digraph {\n' ) f . writelines ( sorted ( output ) ) f . write ( '}' ) run_process ( '.' , [ 'xdot' , 'iso.dot' ] ) else : print ( "" . join ( output ) )
Generates a command map
5,153
def format_template ( template , content ) : import pystache result = u"" if True : result = pystache . render ( template , content , string_encoding = 'utf-8' ) return result
Render a given pystache template with given content
5,154
def format_template_file ( filename , content ) : with open ( filename , 'r' ) as f : template = f . read ( ) if type ( template ) != str : template = template . decode ( 'utf-8' ) return format_template ( template , content )
Render a given pystache template file with given content
5,155
def write_template_file ( source , target , content ) : print ( target ) data = format_template_file ( source , content ) with open ( target , 'w' ) as f : for line in data : if type ( line ) != str : line = line . encode ( 'utf-8' ) f . write ( line )
Write a new file from a given pystache template file and content
5,156
def insert_nginx_service ( definition ) : config_file = '/etc/nginx/sites-available/hfos.conf' splitter = "### SERVICE DEFINITIONS ###" with open ( config_file , 'r' ) as f : old_config = "" . join ( f . readlines ( ) ) pprint ( old_config ) if definition in old_config : print ( "Service definition already inserted" ) return parts = old_config . split ( splitter ) print ( len ( parts ) ) if len ( parts ) != 3 : print ( "Nginx configuration seems to be changed and cannot be " "extended automatically anymore!" ) pprint ( parts ) return try : with open ( config_file , "w" ) as f : f . write ( parts [ 0 ] ) f . write ( splitter + "\n" ) f . write ( parts [ 1 ] ) for line in definition : f . write ( line ) f . write ( "\n " + splitter ) f . write ( parts [ 2 ] ) except Exception as e : print ( "Error during Nginx configuration extension:" , type ( e ) , e )
Insert a new nginx service definition
5,157
def add_action_role ( ctx ) : objects = ctx . obj [ 'objects' ] action = ctx . obj [ 'action' ] role = ctx . obj [ 'role' ] if action is None or role is None : log ( 'You need to specify an action or role to the RBAC command group for this to work.' , lvl = warn ) return for item in objects : if role not in item . perms [ action ] : item . perms [ action ] . append ( role ) item . save ( ) log ( "Done" )
Adds a role to an action on objects
5,158
def del_action_role ( ctx ) : objects = ctx . obj [ 'objects' ] action = ctx . obj [ 'action' ] role = ctx . obj [ 'role' ] if action is None or role is None : log ( 'You need to specify an action or role to the RBAC command group for this to work.' , lvl = warn ) return for item in objects : if role in item . perms [ action ] : item . perms [ action ] . remove ( role ) item . save ( ) log ( "Done" )
Deletes a role from an action on objects
5,159
def change_owner ( ctx , owner , uuid ) : objects = ctx . obj [ 'objects' ] database = ctx . obj [ 'db' ] if uuid is True : owner_filter = { 'uuid' : owner } else : owner_filter = { 'name' : owner } owner = database . objectmodels [ 'user' ] . find_one ( owner_filter ) if owner is None : log ( 'User unknown.' , lvl = error ) return for item in objects : item . owner = owner . uuid item . save ( ) log ( 'Done' )
Changes the ownership of objects
5,160
def notify ( self , event ) : self . log ( 'Got a notification event!' ) self . log ( event , pretty = True ) self . log ( event . __dict__ )
Notify a user
5,161
def getlist ( self , event ) : try : componentlist = model_factory ( Schema ) . find ( { } ) data = [ ] for comp in componentlist : try : data . append ( { 'name' : comp . name , 'uuid' : comp . uuid , 'class' : comp . componentclass , 'active' : comp . active } ) except AttributeError : self . log ( 'Bad component without component class encountered:' , lvl = warn ) self . log ( comp . serializablefields ( ) , pretty = True , lvl = warn ) data = sorted ( data , key = lambda x : x [ 'name' ] ) response = { 'component' : 'hfos.ui.configurator' , 'action' : 'getlist' , 'data' : data } self . fireEvent ( send ( event . client . uuid , response ) ) return except Exception as e : self . log ( "List error: " , e , type ( e ) , lvl = error , exc = True )
Processes configuration list requests
5,162
def put ( self , event ) : self . log ( "Configuration put request " , event . user ) try : component = model_factory ( Schema ) . find_one ( { 'uuid' : event . data [ 'uuid' ] } ) component . update ( event . data ) component . save ( ) response = { 'component' : 'hfos.ui.configurator' , 'action' : 'put' , 'data' : True } self . log ( 'Updated component configuration:' , component . name ) self . fireEvent ( reload_configuration ( component . name ) ) except ( KeyError , ValueError , ValidationError , PermissionError ) as e : response = { 'component' : 'hfos.ui.configurator' , 'action' : 'put' , 'data' : False } self . log ( 'Storing component configuration failed: ' , type ( e ) , e , exc = True , lvl = error ) self . fireEvent ( send ( event . client . uuid , response ) ) return
Store a given configuration
5,163
def get ( self , event ) : try : comp = event . data [ 'uuid' ] except KeyError : comp = None if not comp : self . log ( 'Invalid get request without schema or component' , lvl = error ) return self . log ( "Config data get request for " , event . data , "from" , event . user ) component = model_factory ( Schema ) . find_one ( { 'uuid' : comp } ) response = { 'component' : 'hfos.ui.configurator' , 'action' : 'get' , 'data' : component . serializablefields ( ) } self . fireEvent ( send ( event . client . uuid , response ) )
Get a stored configuration
5,164
def rec ( self ) : try : self . _snapshot ( ) except Exception as e : self . log ( "Timer error: " , e , type ( e ) , lvl = error )
Records a single snapshot
5,165
def _toggle_filming ( self ) : if self . _filming : self . log ( "Stopping operation" ) self . _filming = False self . timer . stop ( ) else : self . log ( "Starting operation" ) self . _filming = True self . timer . start ( )
Toggles the camera system recording state
5,166
def client_disconnect ( self , event ) : self . log ( "Removing disconnected client from subscriptions" , lvl = debug ) client_uuid = event . clientuuid self . _unsubscribe ( client_uuid )
A client has disconnected update possible subscriptions accordingly .
5,167
def get ( self , event ) : try : data , schema , user , client = self . _get_args ( event ) except AttributeError : return object_filter = self . _get_filter ( event ) if 'subscribe' in data : do_subscribe = data [ 'subscribe' ] is True else : do_subscribe = False try : uuid = str ( data [ 'uuid' ] ) except ( KeyError , TypeError ) : uuid = "" opts = schemastore [ schema ] . get ( 'options' , { } ) hidden = opts . get ( 'hidden' , [ ] ) if object_filter == { } : if uuid == "" : self . log ( 'Object with no filter/uuid requested:' , schema , data , lvl = warn ) return object_filter = { 'uuid' : uuid } storage_object = None storage_object = objectmodels [ schema ] . find_one ( object_filter ) if not storage_object : self . _cancel_by_error ( event , uuid + '(' + str ( object_filter ) + ') of ' + schema + ' unavailable' ) return if storage_object : self . log ( "Object found, checking permissions: " , data , lvl = verbose ) if not self . _check_permissions ( user , 'read' , storage_object ) : self . _cancel_by_permission ( schema , data , event ) return for field in hidden : storage_object . _fields . pop ( field , None ) if do_subscribe and uuid != "" : self . _add_subscription ( uuid , event ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'get' , 'data' : { 'schema' : schema , 'uuid' : uuid , 'object' : storage_object . serializablefields ( ) } } self . _respond ( None , result , event )
Get a specified object
5,168
def objectlist ( self , event ) : self . log ( 'LEGACY LIST FUNCTION CALLED!' , lvl = warn ) try : data , schema , user , client = self . _get_args ( event ) except AttributeError : return object_filter = self . _get_filter ( event ) self . log ( 'Object list for' , schema , 'requested from' , user . account . name , lvl = debug ) if 'fields' in data : fields = data [ 'fields' ] else : fields = [ ] object_list = [ ] opts = schemastore [ schema ] . get ( 'options' , { } ) hidden = opts . get ( 'hidden' , [ ] ) if objectmodels [ schema ] . count ( object_filter ) > WARNSIZE : self . log ( "Getting a very long list of items for " , schema , lvl = warn ) try : for item in objectmodels [ schema ] . find ( object_filter ) : try : if not self . _check_permissions ( user , 'list' , item ) : continue if fields in ( '*' , [ '*' ] ) : item_fields = item . serializablefields ( ) for field in hidden : item_fields . pop ( field , None ) object_list . append ( item_fields ) else : list_item = { 'uuid' : item . uuid } if 'name' in item . _fields : list_item [ 'name' ] = item . _fields [ 'name' ] for field in fields : if field in item . _fields and field not in hidden : list_item [ field ] = item . _fields [ field ] else : list_item [ field ] = None object_list . append ( list_item ) except Exception as e : self . log ( "Faulty object or field: " , e , type ( e ) , item . _fields , fields , lvl = error , exc = True ) except ValidationError as e : self . log ( 'Invalid object in database encountered!' , e , exc = True , lvl = warn ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'getlist' , 'data' : { 'schema' : schema , 'list' : object_list } } self . _respond ( None , result , event )
Get a list of objects
5,169
def change ( self , event ) : try : data , schema , user , client = self . _get_args ( event ) except AttributeError : return try : uuid = data [ 'uuid' ] change = data [ 'change' ] field = change [ 'field' ] new_data = change [ 'value' ] except KeyError as e : self . log ( "Update request with missing arguments!" , data , e , lvl = critical ) self . _cancel_by_error ( event , 'missing_args' ) return storage_object = None try : storage_object = objectmodels [ schema ] . find_one ( { 'uuid' : uuid } ) except Exception as e : self . log ( 'Change for unknown object requested:' , schema , data , lvl = warn ) if storage_object is None : self . _cancel_by_error ( event , 'not_found' ) return if not self . _check_permissions ( user , 'write' , storage_object ) : self . _cancel_by_permission ( schema , data , event ) return self . log ( "Changing object:" , storage_object . _fields , lvl = debug ) storage_object . _fields [ field ] = new_data self . log ( "Storing object:" , storage_object . _fields , lvl = debug ) try : storage_object . validate ( ) except ValidationError : self . log ( "Validation of changed object failed!" , storage_object , lvl = warn ) self . _cancel_by_error ( event , 'invalid_object' ) return storage_object . save ( ) self . log ( "Object stored." ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'change' , 'data' : { 'schema' : schema , 'uuid' : uuid } } self . _respond ( None , result , event )
Change an existing object
5,170
def put ( self , event ) : try : data , schema , user , client = self . _get_args ( event ) except AttributeError : return try : clientobject = data [ 'obj' ] uuid = clientobject [ 'uuid' ] except KeyError as e : self . log ( "Put request with missing arguments!" , e , data , lvl = critical ) return try : model = objectmodels [ schema ] created = False storage_object = None if uuid != 'create' : storage_object = model . find_one ( { 'uuid' : uuid } ) if uuid == 'create' or model . count ( { 'uuid' : uuid } ) == 0 : if uuid == 'create' : uuid = str ( uuid4 ( ) ) created = True clientobject [ 'uuid' ] = uuid clientobject [ 'owner' ] = user . uuid storage_object = model ( clientobject ) if not self . _check_create_permission ( user , schema ) : self . _cancel_by_permission ( schema , data , event ) return if storage_object is not None : if not self . _check_permissions ( user , 'write' , storage_object ) : self . _cancel_by_permission ( schema , data , event ) return self . log ( "Updating object:" , storage_object . _fields , lvl = debug ) storage_object . update ( clientobject ) else : storage_object = model ( clientobject ) if not self . _check_permissions ( user , 'write' , storage_object ) : self . _cancel_by_permission ( schema , data , event ) return self . log ( "Storing object:" , storage_object . _fields , lvl = debug ) try : storage_object . validate ( ) except ValidationError : self . log ( "Validation of new object failed!" , clientobject , lvl = warn ) storage_object . save ( ) self . log ( "Object %s stored." % schema ) if created : notification = objectcreation ( storage_object . uuid , schema , client ) else : notification = objectchange ( storage_object . uuid , schema , client ) self . _update_subscribers ( schema , storage_object ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'put' , 'data' : { 'schema' : schema , 'object' : storage_object . serializablefields ( ) , 'uuid' : storage_object . uuid , } } self . _respond ( notification , result , event ) except Exception as e : self . log ( "Error during object storage:" , e , type ( e ) , data , lvl = error , exc = True , pretty = True )
Put an object
5,171
def delete ( self , event ) : try : data , schema , user , client = self . _get_args ( event ) except AttributeError : return try : uuids = data [ 'uuid' ] if not isinstance ( uuids , list ) : uuids = [ uuids ] if schema not in objectmodels . keys ( ) : self . log ( "Unknown schema encountered: " , schema , lvl = warn ) return for uuid in uuids : self . log ( "Looking for object to be deleted:" , uuid , lvl = debug ) storage_object = objectmodels [ schema ] . find_one ( { 'uuid' : uuid } ) if not storage_object : self . _cancel_by_error ( event , 'not found' ) return self . log ( "Found object." , lvl = debug ) if not self . _check_permissions ( user , 'write' , storage_object ) : self . _cancel_by_permission ( schema , data , event ) return storage_object . delete ( ) self . log ( "Deleted. Preparing notification." , lvl = debug ) notification = objectdeletion ( uuid , schema , client ) if uuid in self . subscriptions : deletion = { 'component' : 'hfos.events.objectmanager' , 'action' : 'deletion' , 'data' : { 'schema' : schema , 'uuid' : uuid , } } for recipient in self . subscriptions [ uuid ] : self . fireEvent ( send ( recipient , deletion ) ) del ( self . subscriptions [ uuid ] ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'delete' , 'data' : { 'schema' : schema , 'uuid' : storage_object . uuid } } self . _respond ( notification , result , event ) except Exception as e : self . log ( "Error during delete request: " , e , type ( e ) , lvl = error )
Delete an existing object
5,172
def subscribe ( self , event ) : uuids = event . data if not isinstance ( uuids , list ) : uuids = [ uuids ] subscribed = [ ] for uuid in uuids : try : self . _add_subscription ( uuid , event ) subscribed . append ( uuid ) except KeyError : continue result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'subscribe' , 'data' : { 'uuid' : subscribed , 'success' : True } } self . _respond ( None , result , event )
Subscribe to an object s future changes
5,173
def unsubscribe ( self , event ) : uuids = event . data if not isinstance ( uuids , list ) : uuids = [ uuids ] result = [ ] for uuid in uuids : if uuid in self . subscriptions : self . subscriptions [ uuid ] . pop ( event . client . uuid ) if len ( self . subscriptions [ uuid ] ) == 0 : del ( self . subscriptions [ uuid ] ) result . append ( uuid ) result = { 'component' : 'hfos.events.objectmanager' , 'action' : 'unsubscribe' , 'data' : { 'uuid' : result , 'success' : True } } self . _respond ( None , result , event )
Unsubscribe from an object s future changes
5,174
def all_languages ( ) : rv = [ ] for lang in os . listdir ( localedir ) : base = lang . split ( '_' ) [ 0 ] . split ( '.' ) [ 0 ] . split ( '@' ) [ 0 ] if 2 <= len ( base ) <= 3 and all ( c . islower ( ) for c in base ) : if base != 'all' : rv . append ( lang ) rv . sort ( ) rv . append ( 'en' ) l10n_log ( 'Registered languages:' , rv , lvl = verbose ) return rv
Compile a list of all available language translations
5,175
def language_token_to_name ( languages ) : result = { } with open ( os . path . join ( localedir , 'languages.json' ) , 'r' ) as f : language_lookup = json . load ( f ) for language in languages : language = language . lower ( ) try : result [ language ] = language_lookup [ language ] except KeyError : l10n_log ( 'Language token lookup not found:' , language , lvl = warn ) result [ language ] = language return result
Get a descriptive title for all languages
5,176
def print_messages ( domain , msg ) : domain = Domain ( domain ) for lang in all_languages ( ) : print ( lang , ':' , domain . get ( lang , msg ) )
Debugging function to print all message language variants
5,177
def i18n ( msg , event = None , lang = 'en' , domain = 'backend' ) : if event is not None : language = event . client . language else : language = lang domain = Domain ( domain ) return domain . get ( language , msg )
Gettext function wrapper to return a message in a specified language by domain
5,178
def std_human_uid ( kind = None ) : kind_list = alphabet if kind == 'animal' : kind_list = animals elif kind == 'place' : kind_list = places name = "{color} {adjective} {kind} of {attribute}" . format ( color = choice ( colors ) , adjective = choice ( adjectives ) , kind = choice ( kind_list ) , attribute = choice ( attributes ) ) return name
Return a random generated human - friendly phrase as low - probability unique id
5,179
def std_table ( rows ) : result = "" if len ( rows ) > 1 : headers = rows [ 0 ] . _fields lens = [ ] for i in range ( len ( rows [ 0 ] ) ) : lens . append ( len ( max ( [ x [ i ] for x in rows ] + [ headers [ i ] ] , key = lambda x : len ( str ( x ) ) ) ) ) formats = [ ] hformats = [ ] for i in range ( len ( rows [ 0 ] ) ) : if isinstance ( rows [ 0 ] [ i ] , int ) : formats . append ( "%%%dd" % lens [ i ] ) else : formats . append ( "%%-%ds" % lens [ i ] ) hformats . append ( "%%-%ds" % lens [ i ] ) pattern = " | " . join ( formats ) hpattern = " | " . join ( hformats ) separator = "-+-" . join ( [ '-' * n for n in lens ] ) result += hpattern % tuple ( headers ) + " \n" result += separator + "\n" for line in rows : result += pattern % tuple ( t for t in line ) + "\n" elif len ( rows ) == 1 : row = rows [ 0 ] hwidth = len ( max ( row . _fields , key = lambda x : len ( x ) ) ) for i in range ( len ( row ) ) : result += "%*s = %s" % ( hwidth , row . _fields [ i ] , row [ i ] ) + "\n" return result
Return a formatted table of given rows
5,180
def _get_translation ( self , lang ) : try : return self . _translations [ lang ] except KeyError : rv = self . _translations [ lang ] = gettext . translation ( self . _domain , localedir = localedir , languages = [ lang ] , fallback = True ) return rv
Add a new translation language to the live gettext translator
5,181
def handler ( * names , ** kwargs ) : def wrapper ( f ) : if names and isinstance ( names [ 0 ] , bool ) and not names [ 0 ] : f . handler = False return f if len ( names ) > 0 and inspect . isclass ( names [ 0 ] ) and issubclass ( names [ 0 ] , hfosEvent ) : f . names = ( str ( names [ 0 ] . realname ( ) ) , ) else : f . names = names f . handler = True f . priority = kwargs . get ( "priority" , 0 ) f . channel = kwargs . get ( "channel" , None ) f . override = kwargs . get ( "override" , False ) args = inspect . getargspec ( f ) [ 0 ] if args and args [ 0 ] == "self" : del args [ 0 ] f . event = getattr ( f , "event" , bool ( args and args [ 0 ] == "event" ) ) return f return wrapper
Creates an Event Handler
5,182
def log ( self , * args , ** kwargs ) : func = inspect . currentframe ( ) . f_back . f_code if 'exc' in kwargs and kwargs [ 'exc' ] is True : exc_type , exc_obj , exc_tb = exc_info ( ) line_no = exc_tb . tb_lineno args += traceback . extract_tb ( exc_tb ) , else : line_no = func . co_firstlineno sourceloc = "[%.10s@%s:%i]" % ( func . co_name , func . co_filename , line_no ) hfoslog ( sourceloc = sourceloc , emitter = self . uniquename , * args , ** kwargs )
Log a statement from this component
5,183
def register ( self , * args ) : super ( ConfigurableMeta , self ) . register ( * args ) from hfos . database import configschemastore configschemastore [ self . name ] = self . configschema
Register a configurable component in the configuration schema store
5,184
def unregister ( self ) : self . names . remove ( self . uniquename ) super ( ConfigurableMeta , self ) . unregister ( )
Removes the unique name from the systems unique name list
5,185
def _read_config ( self ) : try : self . config = self . componentmodel . find_one ( { 'name' : self . uniquename } ) except ServerSelectionTimeoutError : self . log ( "No database access! Check if mongodb is running " "correctly." , lvl = critical ) if self . config : self . log ( "Configuration read." , lvl = verbose ) else : self . log ( "No configuration found." , lvl = warn )
Read this component s configuration from the database
5,186
def _write_config ( self ) : if not self . config : self . log ( "Unable to write non existing configuration" , lvl = error ) return self . config . save ( ) self . log ( "Configuration stored." )
Write this component s configuration back to the database
5,187
def _set_config ( self , config = None ) : if not config : config = { } try : self . config = self . componentmodel ( config ) try : name = self . config . name self . log ( "Name set to: " , name , lvl = verbose ) except ( AttributeError , KeyError ) : self . log ( "Has no name." , lvl = verbose ) try : self . config . name = self . uniquename except ( AttributeError , KeyError ) as e : self . log ( "Cannot set component name for configuration: " , e , type ( e ) , self . name , exc = True , lvl = critical ) try : uuid = self . config . uuid self . log ( "UUID set to: " , uuid , lvl = verbose ) except ( AttributeError , KeyError ) : self . log ( "Has no UUID" , lvl = verbose ) self . config . uuid = str ( uuid4 ( ) ) try : notes = self . config . notes self . log ( "Notes set to: " , notes , lvl = verbose ) except ( AttributeError , KeyError ) : self . log ( "Has no notes, trying docstring" , lvl = verbose ) notes = self . __doc__ if notes is None : notes = "No notes." else : notes = notes . lstrip ( ) . rstrip ( ) self . log ( notes ) self . config . notes = notes try : componentclass = self . config . componentclass self . log ( "Componentclass set to: " , componentclass , lvl = verbose ) except ( AttributeError , KeyError ) : self . log ( "Has no component class" , lvl = verbose ) self . config . componentclass = self . name except ValidationError as e : self . log ( "Not setting invalid component configuration: " , e , type ( e ) , exc = True , lvl = error )
Set this component s initial configuration
5,188
def reload_configuration ( self , event ) : if event . target == self . uniquename : self . log ( 'Reloading configuration' ) self . _read_config ( )
Event triggered configuration reload
5,189
def _augment_info ( info ) : info [ 'description_header' ] = "=" * len ( info [ 'description' ] ) info [ 'component_name' ] = info [ 'plugin_name' ] . capitalize ( ) info [ 'year' ] = time . localtime ( ) . tm_year info [ 'license_longtext' ] = '' info [ 'keyword_list' ] = u"" for keyword in info [ 'keywords' ] . split ( " " ) : print ( keyword ) info [ 'keyword_list' ] += u"\'" + str ( keyword ) + u"\', " print ( info [ 'keyword_list' ] ) if len ( info [ 'keyword_list' ] ) > 0 : info [ 'keyword_list' ] = info [ 'keyword_list' ] [ : - 2 ] return info
Fill out the template information
5,190
def _construct_module ( info , target ) : for path in paths : real_path = os . path . abspath ( os . path . join ( target , path . format ( ** info ) ) ) log ( "Making directory '%s'" % real_path ) os . makedirs ( real_path ) for item in templates . values ( ) : source = os . path . join ( 'dev/templates' , item [ 0 ] ) filename = os . path . abspath ( os . path . join ( target , item [ 1 ] . format ( ** info ) ) ) log ( "Creating file from template '%s'" % filename , emitter = 'MANAGE' ) write_template_file ( source , filename , info )
Build a module from templates and user supplied information
5,191
def _ask_questionnaire ( ) : answers = { } print ( info_header ) pprint ( questions . items ( ) ) for question , default in questions . items ( ) : response = _ask ( question , default , str ( type ( default ) ) , show_hint = True ) if type ( default ) == unicode and type ( response ) != str : response = response . decode ( 'utf-8' ) answers [ question ] = response return answers
Asks questions to fill out a HFOS plugin template
5,192
def create_module ( clear_target , target ) : if os . path . exists ( target ) : if clear_target : shutil . rmtree ( target ) else : log ( "Target exists! Use --clear to delete it first." , emitter = 'MANAGE' ) sys . exit ( 2 ) done = False info = None while not done : info = _ask_questionnaire ( ) pprint ( info ) done = _ask ( 'Is the above correct' , default = 'y' , data_type = 'bool' ) augmented_info = _augment_info ( info ) log ( "Constructing module %(plugin_name)s" % info ) _construct_module ( augmented_info , target )
Creates a new template HFOS plugin module
5,193
def lookup_field ( key , lookup_type = None , placeholder = None , html_class = "div" , select_type = "strapselect" , mapping = "uuid" ) : if lookup_type is None : lookup_type = key if placeholder is None : placeholder = "Select a " + lookup_type result = { 'key' : key , 'htmlClass' : html_class , 'type' : select_type , 'placeholder' : placeholder , 'options' : { "type" : lookup_type , "asyncCallback" : "$ctrl.getFormData" , "map" : { 'valueProperty' : mapping , 'nameProperty' : 'name' } } } return result
Generates a lookup field for form definitions
5,194
def fieldset ( title , items , options = None ) : result = { 'title' : title , 'type' : 'fieldset' , 'items' : items } if options is not None : result . update ( options ) return result
A field set with a title and sub items
5,195
def section ( rows , columns , items , label = None ) : sections = [ ] column_class = "section-column col-sm-%i" % ( 12 / columns ) for vertical in range ( columns ) : column_items = [ ] for horizontal in range ( rows ) : try : item = items [ horizontal ] [ vertical ] column_items . append ( item ) except IndexError : hfoslog ( 'Field in' , label , 'omitted, due to missing row/column:' , vertical , horizontal , lvl = warn , emitter = 'FORMS' , tb = True , frame = 2 ) column = { 'type' : 'section' , 'htmlClass' : column_class , 'items' : column_items } sections . append ( column ) result = { 'type' : 'section' , 'htmlClass' : 'row' , 'items' : sections } return result
A section consisting of rows and columns
5,196
def emptyArray ( key , add_label = None ) : result = { 'key' : key , 'startEmpty' : True } if add_label is not None : result [ 'add' ] = add_label result [ 'style' ] = { 'add' : 'btn-success' } return result
An array that starts empty
5,197
def tabset ( titles , contents ) : tabs = [ ] for no , title in enumerate ( titles ) : tab = { 'title' : title , } content = contents [ no ] if isinstance ( content , list ) : tab [ 'items' ] = content else : tab [ 'items' ] = [ content ] tabs . append ( tab ) result = { 'type' : 'tabs' , 'tabs' : tabs } return result
A tabbed container widget
5,198
def timed_connectivity_check ( self , event ) : self . status = self . _can_connect ( ) self . log ( 'Timed connectivity check:' , self . status , lvl = verbose ) if self . status : if not self . old_status : self . log ( 'Connectivity gained' ) self . fireEvent ( backend_nodestate_toggle ( STATE_UUID_CONNECTIVITY , on = True , force = True ) ) else : if self . old_status : self . log ( 'Connectivity lost' , lvl = warn ) self . old_status = False self . fireEvent ( backend_nodestate_toggle ( STATE_UUID_CONNECTIVITY , off = True , force = True ) ) self . old_status = self . status
Tests internet connectivity in regular intervals and updates the nodestate accordingly
5,199
def activityrequest ( self , event ) : try : action = event . action data = event . data self . log ( "Activityrequest: " , action , data ) except Exception as e : self . log ( "Error: '%s' %s" % ( e , type ( e ) ) , lvl = error )
ActivityMonitor event handler for incoming events