async def run_start(self, context, length=None, start=None):
"""
Try to start a sprint on the server
:param context
:param length: Length of time (in minutes) the sprint should last
:param start: Time in minutes from now, that the sprint should start
:return:
"""
user = User(context.message.author.id, context.guild.id, context)
sprint = Sprint(user.get_guild())
# Check if sprint is finished but not marked as completed, in which case we can mark it as complete
if sprint.is_finished():
# Mark the sprint as complete
await sprint.complete()
# Reload the sprint object, as now there shouldn't be a pending one
sprint = Sprint(user.get_guild())
# If a sprint is currently running, we cannot start a new one
if sprint.exists():
return await context.send(user.get_mention() + ', ' + lib.get_string('sprint:err:alreadyexists', user.get_guild()))
# Must be okay to continue #
# If the length argument is not valid, use the default
if length is None or lib.is_number(length) is False or lib.is_number(length) <= 0 or lib.is_number(length) > self.MAX_LENGTH:
length = self.DEFAULT_LENGTH
# Same goes for the start argument
if start is None or lib.is_number(start) is False or lib.is_number(start) < 0 or lib.is_number(start) > self.MAX_DELAY:
start = self.DEFAULT_DELAY
# Make sure we are using ints and not floats passed through in the command
length = int(length)
start = int(start)
# Calculate the start and end times based on the current timestamp
now = int(time.time())
start_time = now + (start * 60)
end_time = start_time + (length * 60)
# Create the sprint
sprint = Sprint.create(guild=user.get_guild(), channel=context.message.channel.id, start=start_time, end=end_time, end_reference=end_time, length=length, createdby=user.get_id(), created=now)
# Join the sprint
sprint.join(user.get_id())
# Increment the user's stat for sprints created
user.add_stat('sprints_started', 1)
# Are we starting immediately or after a delay?
if start == 0:
# Immediately. That means we need to schedule the end task.
Task.schedule(sprint.TASKS['end'], end_time, 'sprint', sprint.get_id())
return await sprint.post_start(context)
else:
# Delay. That means we need to schedule the start task, which will in turn schedule the end task once it's run.
Task.schedule(sprint.TASKS['start'], start_time, 'sprint', sprint.get_id())
return await sprint.post_delayed_start(context)
async def run_join(self, context, starting_wc=None, shortname=None):
"""
Join the sprint, with an optional starting word count and project shortname
:param starting_wc:
:param shortname: Shortname of Project
:return:
"""
user = User(context.message.author.id, context.guild.id, context)
sprint = Sprint(user.get_guild())
# If there is no active sprint, then just display an error
if not sprint.exists():
return await context.send(user.get_mention() + ', ' + lib.get_string('sprint:err:noexists', user.get_guild()))
# Convert starting_wc to int if we can
starting_wc = lib.is_number(starting_wc)
if starting_wc is False:
starting_wc = 0
# If the user is already sprinting, then just update their starting wordcount
if sprint.is_user_sprinting(user.get_id()):
# Update the sprint_users record. We set their current_wc to the same as starting_wc here, otherwise if they join with, say 50 and their current remains 0
# then if they run a status, or in the ending calculations, it will say they wrote -50.
sprint.update_user(user.get_id(), start=starting_wc, current=starting_wc)
# Send message back to channel letting them know their starting word count was updated
await context.send(user.get_mention() + ', ' + lib.get_string('sprint:join:update', user.get_guild()).format(starting_wc))
else:
# Join the sprint
sprint.join(user.get_id(), starting_wc)
# Send message back to channel letting them know their starting word count was updated
await context.send(user.get_mention() + ', ' + lib.get_string('sprint:join', user.get_guild()).format(starting_wc))
# If a project shortname is supplied, try to set that as what the user is sprinting for.
if shortname is not None:
# Convert to lowercase for searching.
shortname = shortname.lower()
# Make sure the project exists.
project = user.get_project(shortname)
if not project:
return await context.send(user.get_mention() + ', ' + lib.get_string('project:err:noexists', user.get_guild()).format(shortname))
sprint.set_project(project.get_id(), user.get_id())
return await context.send(user.get_mention() + ', ' + lib.get_string('sprint:project', user.get_guild()).format(project.get_title()))
async def run_join(self, context, arg1=None, arg2=None):
"""
Join the sprint, with an optional starting word count and project shortname
:param opt1: Argument 1 of the join command
:param opt2: Argument 2 of the join command
:return:
"""
user = User(context.message.author.id, context.guild.id, context)
sprint = Sprint(user.get_guild())
project_id = None
starting_wc = None
sprint_type = None
# If there is no active sprint, then just display an error
if not sprint.exists():
return await context.send(
user.get_mention() + ', ' +
lib.get_string('sprint:err:noexists', user.get_guild()))
# Are we using the `same` keyword?
if arg1 == "same":
# Okay, check for their most recent sprint record
most_recent = user.get_most_recent_sprint(sprint)
if most_recent is not None:
starting_wc = most_recent['ending_wc']
project_id = most_recent['project']
sprint_type = most_recent['sprint_type']
# Can't use the second argument in this case.
arg2 = None
# Are we doing a no wordcount sprint? E.g. we are sprinting or using the functionality for something else.
elif arg1 in ["edit", "non-wc"]:
sprint_type = Sprint.SPRINT_TYPE_NO_WORDCOUNT
# Can't use the second argument in this case.
arg2 = None
else:
# Convert starting_wc to int if we can
starting_wc = lib.is_number(arg1)
# If the starting_wc is still False at this point, just set it to 0
if not starting_wc:
starting_wc = 0
# If the user is already sprinting, then just update their starting wordcount
if sprint.is_user_sprinting(user.get_id()):
# Update the sprint_users record. We set their current_wc to the same as starting_wc here, otherwise if they join with, say 50 and their current remains 0
# then if they run a status, or in the ending calculations, it will say they wrote -50.
sprint.update_user(user.get_id(),
start=starting_wc,
current=starting_wc,
sprint_type=sprint_type)
# If it's a non-wordcount sprint, send a different message.
if sprint_type == Sprint.SPRINT_TYPE_NO_WORDCOUNT:
await context.send(user.get_mention() + ', ' + lib.get_string(
'sprint:join:update:no_wordcount', user.get_guild()))
else:
# Send message back to channel letting them know their starting word count was updated
await context.send(user.get_mention() + ', ' + lib.get_string(
'sprint:join:update', user.get_guild()).format(starting_wc)
)
else:
# Join the sprint
sprint.join(user.get_id(),
starting_wc=starting_wc,
sprint_type=sprint_type)
if sprint_type == Sprint.SPRINT_TYPE_NO_WORDCOUNT:
await context.send(user.get_mention() + ', ' + lib.get_string(
'sprint:join:update:no_wordcount', user.get_guild()))
else:
# Send message back to channel letting them know their starting word count was updated
await context.send(user.get_mention() + ', ' + lib.get_string(
'sprint:join', user.get_guild()).format(starting_wc))
# Currently this is the only usage of argument 2.
shortname = arg2
# If a project shortname is supplied, try to set that as what the user is sprinting for.
if shortname is not None or project_id is not None:
# Did we supply the project by name?
if shortname is not None:
# Convert to lowercase for searching.
shortname = shortname.lower()
# Make sure the project exists.
project = user.get_project(shortname)
# Or do we already have the ID from using 'same' and getting from previous sprint?
elif project_id is not None:
project = Project(project_id)
# If that did not yield a valid project, send an error message.
if not project:
return await context.send(
user.get_mention() +
', ' + lib.get_string('project:err:noexists',
user.get_guild()).format(shortname))
sprint.set_project(project.get_id(), user.get_id())
return await context.send(
user.get_mention() + ', ' +
lib.get_string('sprint:project', user.get_guild()).format(
project.get_title()))