server package

server.check_secrets(app)

server.create_app(config_override={})

server.populate_database()

Initial commits to a new empty database.

server.run_server(config={}, server_kwargs={})

Subpackages

• server.events package
  • Submodules
  • server.events.client module
    • on_check_devices()
    • on_command()
    • on_connect()
    • on_disconnect()
    • on_stats()
  • server.events.device module
    • device_registered()
    • on_command_state()
    • on_connect()
    • on_disconnect()
    • on_entity()
    • on_file()
    • on_register()
    • on_unregister()
  • server.events.update_frontend module
    • emit_full_update()
    • emit_update()
• server.resources package
  • Submodules
  • server.resources.resources module
    • EntityContainer
      • EntityContainer.add()
      • EntityContainer.to_dict()
      • EntityContainer.update()
    • ParentEntityContainer
      • ParentEntityContainer.add()
    • SocketioConnections
      • SocketioConnections.add()
      • SocketioConnections.by_pubid
      • SocketioConnections.by_sid
      • SocketioConnections.get_hosts()
      • SocketioConnections.remove()
    • TempdirManager
      • TempdirManager.add()
      • TempdirManager.delete_files_over_limit()
      • TempdirManager.update_file()
• server.views_api package
  • Submodules
  • server.views_api.datafiles module
    • delete_datafile()
    • get_datafile()
  • server.views_api.device module
    • change_password()
    • create_device()
    • delete_device()
    • disconnect_device()
    • get_all_devices()
    • get_device()
    • modify_device()
  • server.views_api.experiment module
    • create_experiment()
    • delete_experiment()
    • get_all_experiments()
    • get_experiment()
    • modify_experiment()
  • server.views_api.other module
    • camera_realtime()
    • news()
    • shutdown()
  • server.views_api.session module
    • create_session()
    • delete_session()
    • get_all_sessions()
    • get_session()
    • modify_session()
  • server.views_api.user module
    • change_password()
    • create_user()
    • delete_user()
    • get_all_users()
    • get_user()
    • modify_user()
  • server.views_api.usergroup module
    • create_usergroup()
    • delete_usergroup()
    • get_all_usergroups()
    • get_usergroup()
    • modify_usergroup()
  • server.views_api.validations module
    • email_address_is_valid()
    • get_device_metadata_errors()
    • get_metadata_errors()
    • get_password_errors()
    • get_session_metadata_errors()
    • ipv4_is_valid()
    • name_is_valid()
    • password_format_is_valid()
    • password_is_secure()
    • password_is_too_short()
    • pretty_name_is_valid()
    • role_is_valid()
    • username_is_too_long()
    • username_is_too_short()
    • username_is_valid_format()
• server.views_main package
  • Submodules
  • server.views_main.auth module
    • check_if_token_revoked()
    • get_tokens()
    • login()
    • logout()
    • modify_token()
    • refresh()
  • server.views_main.root module
    • index()
    • index_fallback()
    • serve_index_if_not_proxy()
    • static_from_root()

Submodules

server.blacklist_helpers module

server.blacklist_helpers.add_token_to_database(encoded_token)

Add a new token to the database. It is not revoked when it is added.

server.blacklist_helpers.get_user_tokens(user_identity)

Return all tokens belonging to given user.

server.blacklist_helpers.prune_database()

Delete all expired tokens from the database.

server.blacklist_helpers.revoke_all_tokens(user_identity)

Revoke all tokens belonging to given user.

server.blacklist_helpers.revoke_token(token_id, user)

Revoke token. If it does not exist in database, raise TokenNotFound.

server.blacklist_helpers.token_is_revoked(decoded_token)

Check if token is revoked. If it does not exist in the database, consider it revoked.

server.blacklist_helpers.unrevoke_token(token_id, user)

Unrevoke given token. Raise TokenNotFound if it does not exist in the database.

server.config module

server.exceptions module

exception server.exceptions.ItemMustHaveId

Bases: PyplasError

exception server.exceptions.NonexistentDevice

Bases: PyplasError

exception server.exceptions.NonexistentSid

Bases: PyplasError

exception server.exceptions.PyplasError

Bases: Exception

Base class for all exceptions

exception server.exceptions.TokenNotFound

Bases: PyplasError

Token cannot be found in database.

exception server.exceptions.UniqueIdConflict

Bases: PyplasError

server.functions module

server.functions.submit_device(name, password, ipv4, replace_device=None)

server.functions.submit_experiment(name, devices, replace=None)

server.functions.submit_session(name, begin, end, experiment, users, replace=None)

server.functions.submit_user(username, password, role, email, replace_user=None)

server.functions.submit_usergroup(name, users, description, style_json, replace=None)

server.models module

class server.models.Device(**kwargs)

Bases: Model

classmethod by_id(id_public)

Find device by public id.

classmethod by_name(name)

Find device by name.

check_password(password)

Check hashed password.

id

id_public

ipv4

modify(**kwargs)

Modify some or all modifiable properties.

name

password

set_password(password)

Create hashed password.

to_dict()

Return device as a dictionary (public id).

class server.models.Experiment(**kwargs)

Bases: Model

classmethod by_id(id_public)

Find experiment by public id.

classmethod by_name(name)

Find device by name.

devices

id

id_public

modify(**kwargs)

Modify some or all modifiable properties.

name

sessions

to_dict()

Return experiment as a dictionary (public id).

class server.models.Session(**kwargs)

Bases: Model

classmethod all_active(user=None, device=None)

Get active sessions belonging to a user and/or device. If neither user nor device is specified, return all active sessions.

Parameters:

• user – server.models.User or None

• device – server.models.Device or None

Returns:

set of server.models.Session

begin

classmethod by_id(id_public)

Find session by public id.

end

experiment

experiment_id

id

id_public

is_active()

modify(**kwargs)

Modify some or all modifiable properties.

name

to_dict()

Return session as a dictionary (public id).

users

class server.models.Token(**kwargs)

Bases: Model

expires

id

jti

revoked

to_dict()

Return token as a dictionary (with private id).

token_type

user_identity

class server.models.User(**kwargs)

Bases: Model

classmethod by_id(id_public)

Find user by public id.

classmethod by_username(username)

Find user by username.

check_password(password)

Check hashed password.

email

get_active_sessions()

Get all active session containing this user.

id

id_public

property is_admin

modify(**kwargs)

Modify some or all modifiable properties.

password

role

sessions

set_password(password)

Create hashed password.

to_dict()

Return user as a dictionary (public id).

usergroups

username

class server.models.Usergroup(**kwargs)

Bases: Model

classmethod by_id(id_public)

Find usergroup by public id.

classmethod by_name(name)

Find usergroup by name.

description

id

id_public

modify(**kwargs)

Modify some or all modifiable properties.

name

style_json

to_dict()

Return usergroup as a dictionary (public id).

users

server.protections module

This file contains protections that are used for routes in API.

server.protections.add_claims_to_access_token(identity)

server.protections.admin_required(f)

Decorator: accept when authenticated and role == admin.

server.protections.admin_required_sio(f)

Event decorator: accept authenticated users with role admin.

server.protections.content_json(mandatory_keys)

Endpoint decorator: Make sure content is application/json and json contains mandatory keys. Otherwise return with error status code.

server.protections.device_required_sio(f)

Event decorator: accept authenticated devices. Corresponding Device object (queried from database) is passed as a first argument to the decorated func.

server.protections.user_authorized_for_device(device_id)

Event security check: check if user, as the sender of request/event, belongs to an active session that can operate the device.

server.protections.user_required(f)

Decorator: accept authenticated users.

server.protections.user_required_sio(f)

Event decorator: accept authenticated users.

server.proxy_helpers module

server.proxy_helpers.real_remote_addr()

Returns the real remote IP address. Uses BEHIND_PROXY config setting.

When the app is not behind a proxy (BEHIND_PROXY==None), the returned address is just request.remote_addr. Otherwise, the real address must be retrieved from a special header set by the proxy service.

server.serverlogging module

class server.serverlogging.SlackHandler(token, channel)

Bases: Handler

Send messages or files to a Slack channel. To send a file, specify the path to the file as a file attribute:

slacklog.info(“Sending file”, extra={“file”: “path/to/file.txt”})

emit(record)

Do whatever it takes to actually log the specified logging record.

This version is intended to be implemented by subclasses and so raises a NotImplementedError.

class server.serverlogging.TimedSummaryFilter(interval=10, levels=[20])

Bases: Filter

This can deal with very frequent records from libraries like socketio.

1. Start timer, intercept everything with specified level.

   • count identical records (identical: levelno & message & args)

   • let first through, drop any subsequent (i.e. infrequent records are not affected)

2. Timer finishes, make a summary and log it.

   • log the counts (minus the first one) per each record entry

   • restart timer, continue with step 1.

filter(record)

Determine if the specified record is to be logged.

Returns True if the record should be logged, or False otherwise. If deemed appropriate, the record may be modified in-place.

log_summary()

server.serverlogging.configure()

Configure the loggers. Returns list of warnings that were encountered during the configuration (e.g. missing token for a Slack logger).