def users_bio_fetch(token, user_id):
"""
Returns the target user's bio and its associated details
Parameters:
token (str)
user_id (int)
Returns:
{
first_name, last_name, cover_img_url,
title, summary, location, education,
email, username
}
"""
verify_token(token)
user = User.query.filter_by(id=user_id).first()
if not user:
raise InputError(description="{} does not refer to any user in the database".format(user_id))
return {
"first_name": user.bio.first_name,
"last_name" : user.bio.last_name,
"cover_img_url" : user.bio.cover_img_url,
"title" : user.bio.title,
"summary" : user.bio.summary,
"location" : user.bio.location,
"education" : user.bio.education,
"email": user.email,
"username": user.username
}
def users_profile_setemail(token, email):
"""
Update the authorised user's email address
Parameters:
token (str)
email (str)
Returns:
{}
"""
verify_token(token)
user = get_user_from_token(token)
if not user:
raise InputError(description="Target user doesn't exist")
# If the email is unchanged, do nothing
if user.email == email:
return
# The supplied email must pass the email regex format
if not email_is_legit(email):
raise InputError(description="Email entered is not a valid email")
# Email mustn't be in use by any existing user
existing_user = User.query.filter_by(email=email).first()
if existing_user:
raise InputError(description="{} is being used by another user".format(email))
user.email = email
db.session.commit()
def channels_join(token, channel_id):
"""
Given a channel_id of a channel that the authorised user can join, adds them to that channel
Parameters:
token (str)
channel_id (int)
Returns:
{}
"""
verify_token(token)
user = get_user_from_token(token)
if not user:
raise AccessError(description="Invalid Token")
selected_channel = select_channel(channel_id)
if not selected_channel:
raise InputError(description="Target channel is not a valid channel")
# Check whether channel is private or not. Raise AccessError if it is
if not selected_channel.visibility == "public":
raise AccessError(description="Target channel isn't public")
new_membership = MemberOf(
user=user,
channel=selected_channel,
is_owner=False
)
db.session.add(new_membership)
db.session.commit()
return {}
def message_send(token, channel_id, message):
"""
Sends a message to the selected channel.
Parameters:
token (str)
channel_id (int)
message (str)
Returns:
{ message_id }
"""
verify_token(token)
if not message:
raise InputError("Message can't be empty")
if len(message) > 1000:
raise InputError("Message is over 1000 characters")
user = get_user_from_token(token)
selected_channel = select_channel(channel_id)
# Raise error if the user is not a part of the channel they are trying to message in
if not is_user_member(user, selected_channel):
raise AccessError(
description="User is not a member of channel with channel_id")
sent_message = Message(channel=selected_channel,
user=user,
message=message)
db.session.add(sent_message)
db.session.commit()
return {"message_id": sent_message.id}
def channels_leave(token, channel_id):
"""
Removes the caller from the specified channel.
Parameters:
token (str)
channel_id (str)
Returns:
{}
"""
verify_token(token)
user = get_user_from_token(token)
if not user:
raise AccessError(description="Invalid Token")
channels_list = Channel.query.all()
selected_channel = select_channel(channel_id)
# Check if Channel ID is not a valid channel
if not selected_channel:
raise InputError(description="Channel ID is not a valid channel")
# Check user if the user is not currently a member of the selected channel
if not is_user_member(user, selected_channel):
raise AccessError(description="You are not a member of this channel")
membership = MemberOf.query.filter_by(user_id=user.id, channel_id=selected_channel.id).first()
db.session.delete(membership)
db.session.commit()
# If the user attempting to leave is the owner... Pass down ownership to someone else? Or delete channel
# TODO:
# If there is no members left in channel, delete channel
# TODO:
return {}
def users_profile(token, user_id):
"""
For a valid user, returns some of their basic fields
Parameters:
token (str)
user_id (int)
Returns:
{ user_id, email, username, profile_img_url, is_connected_to, connection_is_pending }
"""
verify_token(token)
calling_user = get_user_from_token(token)
target_user = User.query.filter_by(id=user_id).first()
if not target_user:
raise InputError(description="user_id does not refer to any user in the database")
connected = False
pending = False
connection = Connection.query.filter_by(user_id=calling_user.id, other_user_id=target_user.id).first()
if connection:
if connection.approved:
connected = True
else:
pending = True
return {
"user_id": target_user.id,
"email": target_user.email,
"username": target_user.username,
"profile_img_url": target_user.bio.profile_img_url,
"is_connected_to": connected,
"connection_is_pending": pending
}
def channels_messages(token, channel_id, start, limit=50):
"""
Given a channel that the user is a member of, returns up to a specified maximum
number of messages from a starting index. Messages are ordered in ascending
recency, so the message at index 0 is the most recent.
Parameters:
token (str)
channel_id (int)
start (int)
limit (int)
Returns:
{ messages, exhausted }
Where:
messages: list of message dictionary: { message_id, user_id, message, time_created, is_author }
exhausted: bool indicating whether the there any more messages left to fetch
"""
# check parameters are all valid and raise exception if they aren't
# add user_id, associated first name and last name into channel_id dictionary (or storage)
verify_token(token)
user = get_user_from_token(token)
if not user:
raise AccessError(description="Invalid Token")
selected_channel = select_channel(channel_id)
if not selected_channel:
raise InputError(description="Channel ID is not a valid channel")
if is_user_member(user, selected_channel) is False:
raise AccessError(description="You are not a member of this channel")
# Loop through 50 message dictionaries of list starting from start index
messsages_list = selected_channel.messages_sent
messsages_list.sort(key=(lambda x: x.time_created))
payload = {
"messages": [],
"exhausted": True
}
if not messsages_list:
# printColour("Results: {}".format(payload), colour="blue")
return payload
if start >= len(messsages_list):
raise InputError(description="Starting index is greater than or equal to the total number of messages in the channel")
if not (start + limit >= len(messsages_list)):
messages["exhausted"] = False
for i, message in enumerate(messsages_list[start :], start=1):
payload["messages"].append({
"message_id": message.id,
"user_id": message.user_id,
"message": message.message,
"time_created": message.time_created.timestamp(),
"is_author": message.user_id == user.id
})
if i == limit:
break
# printColour("Results: {}".format(payload), colour="blue")
return payload
def users_profile_upload_photo(token, user_id, img_endpoint):
"""
Given a URL to an image, updates the user's bio tuple to hold
the new profile picture's URL.
"""
verify_token(token)
user = User.query.filter_by(id=user_id).first()
user.bio.profile_img_url = img_endpoint
db.session.commit()
def users_profile_upload_cover(token, user_id, img_endpoint):
"""
Given a URL to an image, updates the user's bio tuple to hold
the new cover image's URL.
"""
verify_token(token)
user = User.query.filter_by(id=user_id).first()
# printColour("Setting user {}'s image endpoint to {}".format(user_id, img_endpoint))
user.bio.cover_img_url = img_endpoint
db.session.commit()
def channels_removeowner(token, channel_id, user_id):
"""
Desc: Remove user with user id user_id an owner of this channel
Params: (token, channel_id, user_id)
Returns: empty dict
Errors: InputError on invalid channel_id
InputError when user_id DOESN'T already have ownership over
a channel before calling channel_removeowner
AccessError when the user isn't an owner of the
slackr or an owner of this channel
TYPES:
token str
channel_id int
user_id int
"""
verify_token(token)
selected_channel = select_channel(channel_id)
if not selected_channel:
raise InputError(description="Not a valid channel")
calling_user = get_user_from_token(token)
details = channels_details(token, channel_id)
# Check whether the target user is actually in the list of members
members_list = details["all_members"]
user_found = False
for member in members_list:
if member["user_id"] == user_id:
user_found = True
break
if not user_found:
raise InputError("Target user must be a part of this channel")
# Check whether user_id is not already an owner in channel
owners_list = details["owner_members"]
calling_user_is_owner = False
target_user_is_owner = False
for owner in owners_list:
if owner["user_id"] == user_id:
target_user_is_owner = True
if owner["user_id"] == calling_user.id:
calling_user_is_owner = True
if not calling_user_is_owner:
raise InputError("You are not authorised to remove existing owners")
if not target_user_is_owner:
raise InputError("Target user is not an owner of the channel")
target_user = User.query.filter_by(id=user_id).first()
for each_membership in target_user.channel_membership:
if each_membership.channel_id == channel_id:
each_membership.is_owner = False
db.session.commit()
return {}
def channels_upload_cover(token, channel_id, img_url):
"""
Adds a channel cover image
Parameters:
token (str)
channel_id (str)
img_url (str)
"""
verify_token(token)
channel = Channel.query.filter_by(id=channel_id).first()
channel.channel_cover_img_url = img_url
db.session.commit()
def channels_details(token, channel_id):
"""
Given a Channel with ID channel_id that the authorised user is
part of, provide basic details about the channel
Parameters:
token (str)
channel_id (channel_id)
Returns:
{ name, description, visibility, channel_img_url, owner_members, all_members } (dict)
Where:
owner_members: [{ user_id, username, email, profile_img_url }, ...] (list of user objects)
all_members: [{ user_id, username, email, profile_img_url }, ...] (list of user objects)
"""
verify_token(token)
user = get_user_from_token(token)
if not user:
raise AccessError(description="Invalid Token")
selected_channel = select_channel(channel_id)
if not selected_channel:
raise InputError(description=f"{channel_id} doesn't point to a valid channel")
# Raise exception when the user is not a member of the channel with the given channel_id
if not is_user_member(user, selected_channel):
raise AccessError(description="You are not a member of this channel")
channel_owners = []
channel_members = []
# Joining User with MemberOf, then filtering for users associated with the selected channel
# TODO: Possible optimisation -> swap the ordering of the filtering
memberships = db.session.query(User, MemberOf, Channel).outerjoin(MemberOf, MemberOf.user_id==User.id).outerjoin(Channel, Channel.id==MemberOf.channel_id).filter_by(id=channel_id).all()
for each_membership in memberships:
curr_member = each_membership[0]
member_data = {
"user_id": curr_member.id,
"username": curr_member.username,
"profile_img_url": curr_member.bio.profile_img_url,
"email": curr_member.email
}
channel_members.append(member_data)
if each_membership[1].is_owner:
channel_owners.append(member_data)
details = {
"name": selected_channel.name,
"description": selected_channel.description,
"visibility": selected_channel.visibility,
"channel_img_url": selected_channel.channel_img_url,
"channel_cover_img_url": selected_channel.channel_cover_img_url,
"owner_members": channel_owners,
"all_members": channel_members
}
# printColour("Results: {}".format(details), colour="blue")
return details
def users_bio_update(token, user_id, updated_bio):
verify_token(token)
user = User.query.filter_by(id=user_id).first()
if not user:
raise InputError(description="Target user doesn't exist")
user.bio.first_name = updated_bio["first_name"]
user.bio.last_name=updated_bio["last_name"]
user.bio.cover_img_url=updated_bio["cover_img_url"]
user.bio.summary=updated_bio["summary"]
user.bio.location=updated_bio["location"]
user.bio.title=updated_bio["title"]
user.bio.education=updated_bio["education"]
db.session.commit()
return { "succeeded": True }
def users_all(token):
"""
Returns a list of all users and their associated details
Parameters:
token (str)
Returns:
{ users }
Where:
users: list of dictionaries: { user_id, email, username, profile_img_url }
"""
verify_token(token)
# Get all users into a list, database prints other info as well
all_users = User.query.all()
users = [{ "user_id": user.id, "email": user.email, "username": user.username, "profile_img_url": user.bio.profile_img_url } for user in all_users]
return { "users": users }
def messages_search_match(token, channel_id, query_str):
"""
Given a query string, return a collection of messages from the target channel
that matches the query string. Results are sorted from most
recent message to least recent message
ERRORS
- Invalid token
Returns: {
messages: [ { message_id, user_id, message, time_created }, { ... }, ... ]
}
"""
verify_token(token)
# Empty result
if query_str == "":
return {}
user = get_user_from_token(token)
# Searches all messages and compares query_str
search_results = []
channel = Channel.query.filter_by(id=channel_id).first()
all_messages = channel.messages_sent
for message_obj in all_messages:
curr_message = message_obj.message
print(curr_message)
print(message_obj.time_created)
# Case-insensitive matching
if curr_message.lower().find(query_str.lower()) != -1:
print("{} matches {}!".format(curr_message, query_str))
search_results.append({
"message_id":
message_obj.id,
"user_id":
message_obj.user_id,
"message":
message_obj.message,
"time_created":
message_obj.time_created.timestamp()
})
sorted_messages = sorted(search_results, key=lambda k: k['time_created'])
# Returns messages that contain query_str
# Contains all info on message (message_id, user_id, message, time_created)
return {'messages': sorted_messages}
def users_profile_set_username(token, username):
"""
Update the authorised user's first and last name
Parameters:
token (str)
username (str)
"""
verify_token(token)
user = get_user_from_token(token)
if not user:
raise InputError(description="Target user doesn't exist")
if not username_valid(username):
raise InputError(
description="Username, {}, must only use alphanumeric characters and be 1-20 characters long".format(username)
)
user.username = username
db.session.commit()
def message_remove(token, message_id):
"""
Removes a message from the list of messages
Returns: { old_message }
"""
verify_token(token)
message_obj = Message.query.filter_by(id=message_id).first()
if not message_obj:
raise InputError("Message doesn't exist")
calling_user = get_user_from_token(token)
if calling_user.id != message_obj.user_id:
raise AccessError("You can't modify someone else's message")
# Removes message and saves changes
db.session.delete(message_obj)
db.session.commit()
return {"old_message": message_obj.message}
def channels_update_info(token, channel_id, name, description, visibility):
"""
Updates an existing channel's fields
Parameters:
token (str)
channel_id (str)
name (str)
description (str)
visibility (bool)
"""
verify_token(token)
if not name:
raise InputError("Channel name can't be blank")
channel = Channel.query.filter_by(id=channel_id).first()
channel.name = name
channel.description = description
channel.visibility = visibility
db.session.commit()
def channels_invite(token, channel_id, user_id):
"""
Invites a user, with the given user_id, to join the channel with ID channel_id.
Once invited, the user is added to the channel immediately.
Parameters:
token (str)
channel_id (int)
user_id (int)
Returns:
{} (dict)
"""
printColour("RECEIVED CHANNEL ID: {}".format(channel_id), colour="blue")
printColour("RECEIVED USER ID: {}".format(user_id), colour="blue")
verify_token(token)
calling_user = get_user_from_token(token)
if not calling_user:
raise AccessError(description="Invalid Token")
# If channel_id is invalid, raise input error
selected_channel = select_channel(channel_id)
if not selected_channel:
raise InputError(description="Target channel is not a valid channel that the user is part of.")
# Check the authorised user is not already a member of the channel
if not is_user_member(calling_user, selected_channel):
raise AccessError(description="You are not a member of this channel")
invited_user = User.query.filter_by(id=user_id).first()
# Check that the user exists (ie. the user_id is valid)
if not invited_user:
raise InputError(description="Target user is not a valid user")
# Check if invited_user is already a member
if is_user_member(invited_user, selected_channel):
raise InputError(description="{} is already a member".format(invited_user.username))
# Granting membership
new_membership = MemberOf(
user=invited_user,
channel=selected_channel,
is_owner=False
)
printColour("Trying to add user {} to channel {}".format(new_membership.user.id, new_membership.channel.id), colour="blue")
db.session.add(new_membership)
db.session.commit()
return {}
def auth_logout(token):
"""
Given a valid token, verifies it and logs out the associated user.
Parameters:
token (str)
Returns: {
is_success(True/False) bool
}
"""
if verify_token(token):
return {"is_success": True}
else:
raise AccessError(description="Logout failed. Token is invalid")
def channels_create(token, name, description, visibility):
"""
Creates a new channel with that name that is either a public or private channel. The created channel object
has the following fields: { channel_id, name, description, visibility }
Parameters:
token (str)
name (str)
description (str)
visibility (bool)
Raises: TODO
Returns:
{ channel_id }
"""
verify_token(token)
if not name or not visibility:
raise InputError("Channel name or visibility not specified")
if len(name) > 30:
raise InputError("Channel name too long. Stay under 30 characters")
creator = get_user_from_token(token)
# Adding a default picture for the channel
channel_image_endpoint = os.getenv("BASE_URI") + "/images/{}".format("default_channel.jpg")
new_channel = Channel(
visibility=visibility,
name=name,
description=description,
channel_img_url=channel_image_endpoint
)
ownership = MemberOf(
user=creator,
channel=new_channel,
is_owner=True
)
db.session.add(new_channel)
db.session.add(ownership)
db.session.commit()
return { 'channel_id': new_channel.id }
def message_edit(token, message_id, message):
"""
Edits an existing message. Deletes it if the new message is empty
"""
verify_token(token)
if len(message) > 1000:
raise InputError("Message is over 1000 characters")
if not message:
raise InputError("New message can't be empty")
user = get_user_from_token(token)
message_obj = Message.query.filter_by(id=message_id).first()
is_user_owner = user_is_owner(token, message_obj.channel_id)
is_user_admin = user_is_admin(token)
if message_obj.user_id == user.id or is_user_admin or is_user_owner:
printColour("Editing message from '{}' to '{}'".format(
message_obj.message, message),
colour="red_1")
message_obj = Message.query.filter_by(id=message_id).first()
message_obj.message = message
db.session.commit()
else:
printColour("Not permitted to edit message", colour="red_1")
raise AccessError("You are not authorised to edit this message")
return {}
def channels_listall(token):
"""
Provide a list of all channels (and their associated details)
Parameters:
token (str)
Returns:
{ channels }
Where:
List of dictionaries: { channel_id, name, channel_img_url, description, visibility, member_of, owner_of }
"""
verify_token(token)
user = get_user_from_token(token)
channels_list = []
all_channels = Channel.query.all()
for each_channel in all_channels:
curr_channel_data = {
"channel_id": each_channel.id,
"name": each_channel.name,
"channel_img_url": each_channel.channel_img_url,
"channel_cover_img_url": each_channel.channel_cover_img_url,
"description": each_channel.description,
"visibility": each_channel.visibility,
"member_of": False,
"owner_of": False
}
memberships = each_channel.channel_membership
for membership in memberships:
if membership.user_id == user.id:
curr_channel_data["member_of"] = True
if membership.is_owner:
curr_channel_data["owner_of"] = True
channels_list.append(curr_channel_data)
# printColour("Results: {}".format(channels_list), colour="blue")
return {
"channels": channels_list
}
