def tower(tower_id, decorator=None):
try:
towers.garbage_collection(tower_id)
tower = towers[tower_id]
except KeyError:
log('Bad tower_id')
abort(404)
# Make sure the Bearer token for the current user is not expired and pass it to the client html
# This is how the client will be automatically logged in w/o cross-domain cookies
user_token = '' if current_user.is_anonymous\
else current_user.get_token()
# Pass in both the tower and the user_name
return render_template('ringing_room.html',
tower = tower,
user_id = 0 if current_user.is_anonymous else current_user.id,
user_name = '' if current_user.is_anonymous else current_user.username,
user_email = '' if current_user.is_anonymous else current_user.email,
user_badge = '' if current_user.is_anonymous else current_user.badge,
user_settings = Config.DEFAULT_SETTINGS if current_user.is_anonymous else current_user.get_settings_with_defaults(),
server_ip=get_server_ip(tower_id),
user_token = user_token,
host_permissions = current_user.check_permissions(tower_id,'host')\
if current_user.is_authenticated else False,
listen_link = False)
def on_audio_change(json):
log('c_audio_change', json)
tower_id = json['tower_id']
towers[tower_id].audio = json['new_audio']
emit('s_audio_change', {'new_audio': json['new_audio']},
broadcast=True,
include_self=True,
room=tower_id)
def on_call(call_dict):
log('c_call', call_dict)
emit('s_call',
call_dict,
broadcast=True,
include_self=True,
room=call_dict['tower_id'])
towers[call_dict['tower_id']].wheatley.on_call(call_dict['call'])
def on_request_global_state(json):
log('c_request_global_state', json)
tower_id = json['tower_id']
tower = towers[tower_id]
state = tower.bell_state
emit('s_global_state', {'global_bell_state': state})
# Send assignments
send_assignments(tower_id)
def on_toggle_bookmark(json):
if current_user.is_anonymous:
# Login failed, just return
return
log('c_toggle_bookmark', current_user, json['tower_id'])
tower = towers[json['tower_id']]
current_user.toggle_bookmark(tower)
def on_assign_user(json):
log('c_assign_user', json)
tower = towers[json['tower_id']]
tower.assign_bell(json['bell'], json['user'])
emit('s_assign_user',
json,
broadcast=True,
include_self=True,
room=json['tower_id'])
def on_check_tower_id(json):
tower_id = json['tower_id']
try:
# Doing it this way (using towers[id]) tests the database for us
emit('s_check_id_success', {'tower_name': towers[tower_id].name})
log('Found tower_id:', str(tower_id))
except KeyError:
emit('s_check_id_failure')
log("Didn't find tower_id:", str(tower_id))
def on_set_bells(json):
log('c_set_bells', json)
tower_id = json['tower_id']
tower = towers[tower_id]
tower.set_at_hand()
emit('s_global_state', {'global_bell_state': tower.bell_state},
broadcast=True,
include_self=True,
room=tower_id)
def on_size_change(size):
log('c_size_change', size)
tower_id = size['tower_id']
size = size['new_size']
towers[tower_id].n_bells = size
towers[tower_id].set_at_hand()
emit('s_size_change', {'size': size},
broadcast=True,
include_self=True,
room=tower_id)
def on_host_mode(json):
log('c_host_mode')
tower_id = json['tower_id']
tower = towers[tower_id]
tower.host_mode = json['new_mode']
emit('s_host_mode',
json,
broadcast=True,
include_self=False,
room=tower_id)
def remove_user(self, user_id):
try:
for (bell, assignment) in self._assignments.items():
if assignment == user_id:
# unassign the user from all bells
self._assignments[bell] = UNASSIGNED_BELL
del self._users[int(user_id)]
except ValueError:
log('Value error when removing user from tower.')
except KeyError:
log("Tried to remove user that wasn't there")
def observer(tower_id, decorator=None):
try:
towers.garbage_collection(tower_id)
tower = towers[tower_id]
except KeyError:
log('Bad tower_id')
abort(404)
return render_template('ringing_room.html',
tower=tower,
listen_link=True,
server_ip=get_server_ip(tower_id))
def on_create_tower(data):
log('c_create_tower', data)
tower_name = data['tower_name']
new_tower = Tower(tower_name)
towers[new_tower.tower_id] = new_tower
if not current_user.is_anonymous:
new_tower.to_TowerDB().created_by(current_user)
new_tower.add_host_id(current_user.id)
emit('s_redirection',
str(new_tower.tower_id) + '/' + new_tower.url_safe_name)
def garbage_collection(self, key=None):
# prepare garbage collection
# don't collect the key we're currently looking up though
keys_to_delete = [
k for k, (value, timestamp) in self.items()
if timestamp < datetime.now() -
self._garbage_collection_interval and k != key
]
log('Garbage collection:', keys_to_delete)
# run garbage collection
for deleted_key in keys_to_delete:
dict.__delitem__(self, deleted_key)
def check_db_for_key(self, key):
if key in self.keys():
# It's already in memory, don't check the db
return True
tower = self._table.query.get(key)
if tower:
log('Loading tower from db:', key)
# load the thing back into memory
dict.__setitem__(self, key, (tower.to_Tower(), datetime.now()))
return True
return False
def on_kick_user(json):
log('c_kick_user', json)
tower_id = json['tower_id']
tower = towers[tower_id]
user_id = json['user_id']
user = User.query.get(user_id)
if user is None:
return
tower.remove_user(user_id)
emit('s_user_left', {
'user_id': user_id,
'username': user.username,
'kicked': True
},
broadcast=True,
include_self=True,
room=tower_id)
def on_bell_rung(event_dict):
log('c_bell_rung', event_dict)
disagreement = False
cur_bell = event_dict["bell"]
tower_id = event_dict["tower_id"]
cur_tower = towers[tower_id]
bell_state = cur_tower.bell_state
if bell_state[cur_bell - 1] is event_dict["stroke"]:
bell_state[cur_bell - 1] = not bell_state[cur_bell - 1]
else:
log('Current stroke disagrees between server and client')
disagreement = True
emit('s_bell_rung', {
"global_bell_state": bell_state,
"who_rang": cur_bell,
"disagree": disagreement
},
broadcast=True,
include_self=True,
room=tower_id)
def on_user_left(json):
log('c_user_left', json)
tower_id = json['tower_id']
tower = towers[tower_id]
user_id = session.get(
'user_id') if current_user.is_anonymous else current_user.id
if user_id is None:
return
if current_user.is_anonymous:
tower.remove_observer(user_id)
emit('s_set_observers', {'observers': tower.observers},
broadcast=True,
include_self=False,
room=tower_id)
return
tower.remove_user(user_id)
# TODO: 'username' is depricated
emit('s_user_left', {
'user_id': current_user.id,
'username': current_user.username
},
broadcast=True,
include_self=True,
room=tower_id)
# Now that the user is gone, check if there are any hosts left. If not, make sure
# the tower is not in host mode.
if not tower.host_present():
tower.host_mode = False
emit('s_host_mode', {
'tower_id': tower_id,
'new_mode': False
},
broadcast=True,
include_self=True,
room=tower_id)
def on_size_change(json):
log('c_size_change', json)
tower_id = json['tower_id']
size = json['new_size']
tower = towers[tower_id]
# There seems to be double-calling bug where `c_size_change` is emitted twice when the tower size is
# changed. To that end, if the signal tells us that the new size should be the same as what we already
# have, we should just early return and ignore that request
if tower.n_bells == size:
log('No size change - ignoring')
return
# If the new size is smaller than the old, we need to manually kick people
# off the back bells. This ensures that the assignment list in Users gets
# updated properly.
if tower.n_bells > size:
for i in range(size + 1, tower.n_bells + 1):
# unassigning them on this end is taken care of when the model
# changes, so just emit
emit('s_assign_user', {
'bell': i,
'user': 0
},
broadcast=True,
include_self=True,
room=tower_id)
tower.n_bells = size
tower.set_at_hand()
emit('s_size_change', {'size': size},
broadcast=True,
include_self=True,
room=tower_id)
# Update Wheatley's row_gen according to the new stage, and broadcast the new row generator
tower.wheatley.on_size_change()
emit('s_wheatley_row_gen',
tower.wheatley.row_gen,
broadcast=True,
include_self=True,
room=tower_id)
def remove_observer(self, removed_observer):
try:
self._observers.remove(removed_observer)
except KeyError:
log("Tried to remove an observer that didn't exist.")
pass
def log(self, message):
""" Function to make a log entry under this Wheatley instance's name """
log(f"WHEATLEY:{self._tower.tower_id}:{message}")
def on_join(json):
log('c_join', json)
# First, get the tower_id & tower from the client and find the tower
tower_id = json['tower_id']
tower = towers[tower_id]
# Next, join the tower
join_room(tower_id)
log('SETUP Joined tower:', tower_id)
# We need to custom-load the user based on the jwt token passed up
user = None
if not json['anonymous_user']:
try:
user_id = jwt.decode(json['user_token'],
app.config['SECRET_KEY'],
algorithms=['HS256'])['id']
user = load_user(user_id)
except:
pass # leave user set to None
# Whether the user is anonymous or not, send them the list of current users and the Wheatley settings
# (we send this to anonymous users because to the server, Wheatley is an anonymous user and we need to
# send Wheatley the initial settings as quickly as possible).
# TODO 11 March 2021: We need to check wheatley enabledness in the database
# if we're on the support server
if Config.SUPPORT_SERVER:
tower.wheatley.set_enabledness(tower.wheatley_enabled())
emit('s_set_wheatley_enabledness', {'enabled': tower.wheatley.enabled})
if tower.wheatley.enabled:
emit('s_wheatley_setting', tower.wheatley.settings)
emit('s_wheatley_row_gen', tower.wheatley.row_gen)
emit('s_set_userlist', {'user_list': tower.user_json})
# If the user is anonymous, mark them as an observer and set some cookies
if current_user.is_anonymous:
# Check they're not already in the room
if 'user_id' in session.keys():
tower.remove_observer(session['user_id'])
session['user_id'] = assign_user_id()
tower.add_observer(session['user_id'])
log('SETUP Observer joined tower:', tower_id)
emit('s_set_observers', {'observers': tower.observers},
broadcast=True,
include_self=True,
room=tower_id)
log('SETUP observer s_set_observers', tower.observers)
else:
# The user is logged in. Add this as a recent tower
current_user.add_recent_tower(tower)
# If the user is logged in, but is already in the room: Remove them (in
# preparation for adding them again)
if current_user.username in tower.users.keys():
log('SETUP User already present')
tower.remove_user(current_user.id)
emit('s_user_left', {
'user_id': current_user.id,
'username': current_user.username
},
broadcast=True,
include_self=True,
room=tower_id)
# For now: Keeping the "id/username" split in the tower model
# Eventually, this will allow us to have display names different
# from the username
tower.add_user(current_user.id, current_user.username)
# Hack to fix a bug with the multiserver setup
emit('s_size_change', {'size': tower.n_bells})
emit('s_audio_change', {'new_audio': tower.audio})
emit('s_host_mode', {
'tower_id': tower_id,
'new_mode': tower.host_mode
})
emit('s_user_entered', {
'user_id': current_user.id,
'username': current_user.username,
'badge': current_user.badge
},
broadcast=True,
include_self=True,
room=json['tower_id'])
# Check if there are any hosts in the room, and if not, make sure that
# the tower is not in host mode.
if not tower.host_present():
tower.host_mode = False
emit('s_host_mode', {
'tower_id': tower_id,
'new_mode': False
},
broadcast=True,
include_self=True,
room=tower_id)
# Store the tower in case of accidental disconnect
# We need to do it under the SocketIO SID, otherwise a refresh might kick us out of the room
if not 'tower_ids' in session.keys():
session['tower_ids'] = {}
session['tower_ids'][request.sid] = json['tower_id']
session.modified = True
def send_assignments(tower_id):
tower = towers[tower_id]
for (bell, user_name) in tower.assignments.items():
log('s_assign_user', {'bell': bell, 'user': user_name})
emit('s_assign_user', {'bell': bell, 'user': user_name})
def on_join(json):
log('c_join', json)
# First, get the tower_id & tower from the client and find the tower
tower_id = json['tower_id']
tower = towers[tower_id]
# Next, join the tower
join_room(tower_id)
log('SETUP Joined tower:', tower_id)
# Whether the user is anonymous or not, send them the list of current users
emit('s_set_userlist', {'user_list': tower.user_json})
# If the user is anonymous, mark them as an observer and set some cookies
if current_user.is_anonymous:
# Check they're not already in the room
if 'user_id' in session.keys():
tower.remove_observer(session['user_id'])
session['user_id'] = assign_user_id()
tower.add_observer(session['user_id'])
log('SETUP Observer joined tower:', tower_id)
emit('s_set_observers', {'observers': tower.observers},
broadcast=True,
include_self=True,
room=tower_id)
log('SETUP observer s_set_observers', tower.observers)
else:
# The user is logged in. Add this as a recent tower
current_user.add_recent_tower(tower)
# If the user is logged in, but is already in the room: Remove them (in
# preparation for adding them again)
if current_user.username in tower.users.keys():
log('SETUP User already present')
tower.remove_user(current_user.id)
emit('s_user_left', {
'user_id': current_user.id,
'username': current_user.username
},
broadcast=True,
include_self=True,
room=tower_id)
# For now: Keeping the "id/username" split in the tower model
# Eventually, this will allow us to have display names different
# from the username
tower.add_user(current_user.id, current_user.username)
# Hack to fix a bug with the multiserver setup
emit('s_size_change', {'size': tower.n_bells})
emit('s_audio_change', {'new_audio': tower.audio})
emit('s_host_mode', {
'tower_id': tower_id,
'new_mode': tower.host_mode
})
emit('s_user_entered', {
'user_id': current_user.id,
'username': current_user.username
},
broadcast=True,
include_self=True,
room=json['tower_id'])
# Check if there are any hosts in the room, and if not, make sure that
# the tower is not in host mode.
if not tower.host_present():
tower.host_mode = False
emit('s_host_mode', {
'tower_id': tower_id,
'new_mode': False
},
broadcast=True,
include_self=True,
room=tower_id)
# Store the tower in case of accidental disconnect
# We need to do it under the SocketIO SID, otherwise a refresh might kick us out of the room
if not 'tower_ids' in session.keys():
session['tower_ids'] = {}
session['tower_ids'][request.sid] = json['tower_id']
session.modified = True
def on_call(call_dict):
tower_id = call_dict['tower_id']
tower = towers[tower_id]
log('c_call', call_dict)
tower_id = call_dict['tower_id']
emit('s_call', call_dict, broadcast=True, include_self=True, room=tower_id)
def on_remove_recent(tower_id):
log('c_remove_recent', current_user, tower_id)
tower = towers[tower_id]
current_user.remove_recent_tower(tower)
def on_join_tower_by_id(json):
log('c_join_tower_by_id', json)
tower_id = json['tower_id']
tower_name = towers[tower_id].url_safe_name
emit('s_redirection', str(tower_id) + '/' + tower_name)
def on_report(json):
log('c_report', json)
send_email(subject='Behavior Report',
recipient='*****@*****.**',
text_body="A report was submitted. Details:\n\n" + str(json),
html_body="A report was submitted. Details:\n\n" + str(json))