def creator(**params):
item = Scene().get_or_create(**params)
scenes = scenario_svc.get_scenes(self.scenario)
characters = scenario_svc.get_characters(scenes)
item.characters = [str(c.id) for c in characters]
scene_svc.save(item, self.user)
return item
def __init__(self, mongo_name=None):
self.mongo_wrapper = MongoWrapper(mongo_name)
self.mono_db_names = self.mongo_wrapper.get_db_names()
self.scenes_handler = Scene(self.mongo_wrapper)
self.hypothesis_handler = Hypothesis(self.mongo_wrapper)
self.objects_handler = Object(self.mongo_wrapper)
self.active_data_type = self.scenes_handler
def delete_scene(self, args, guild, channel, scenario, sc, user):
messages = []
search = ''
if len(args) == 1:
if not sc:
raise Exception('No scene provided for deletion')
else:
search = ' '.join(args[1:])
sc = Scene().find(guild.name, str(channel.id), str(scenario.id),
search)
if not sc:
return [f'{search} was not found. No changes made.']
else:
search = str(sc.name)
scenario_id = str(sc.scenario_id) if sc.scenario_id else ''
channel_id = str(sc.channel_id) if sc.channel_id else ''
sc.character.archive(user)
sc.archived = True
sc.updated_by = str(user.id)
sc.updated = T.now()
sc.save()
messages.append(f'***{search}*** removed')
if scenario_id:
secenario = Scenario().get_by_id(scenario_id)
messages.append(secenario.get_string(channel))
elif channel_id:
channel = Channel().get_by_id(channel_id)
messages.append(channel.get_string())
return messages
def __init__(self, parent, ctx, args, guild, user, channel):
"""
Command handler for SceneCommand
Parameters
----------
parent : DreamcraftHandler
The handler for Dreamcraft Bot commands and subcommands
ctx : object(Context)
The Discord.Context object used to retrieve and send information to Discord users
args : array(str)
The arguments sent to the bot to parse and evaluate
guild : Guild
The guild object containing information about the server issuing commands
user : User
The user database object containing information about the user's current setttings, and dialogs
channel : Channel
The channel from which commands were issued
Returns
-------
SceneCommand - object for processing scene commands and subcommands
"""
self.parent = parent
self.new = parent.new
self.delete = parent.delete
self.ctx = ctx
self.args = args[1:] if args[0] in ['scene', 's'] else args
self.guild = guild
self.user = user
self.command = self.args[0].lower() if len(self.args) > 0 else 'select'
channel = 'private' if ctx.channel.type.name == 'private' else ctx.channel.name
self.channel = Channel().get_or_create(channel, self.guild.name, self.user)
self.scenario = Scenario().get_by_id(self.channel.active_scenario) if self.channel and self.channel.active_scenario else None
self.sc = Scene().get_by_id(self.channel.active_scene) if self.channel and self.channel.active_scene else None
self.can_edit = self.user.role == 'Game Master' if self.user and self.sc else True
self.zone = Zone().get_by_id(self.channel.active_zone) if self.channel and self.channel.active_zone else None
self.char = Character().get_by_id(self.user.active_character) if self.user and self.user.active_character else None
class UserController:
def __init__(self, mongo_name=None):
self.mongo_wrapper = MongoWrapper(mongo_name)
self.mono_db_names = self.mongo_wrapper.get_db_names()
self.scenes_handler = Scene(self.mongo_wrapper)
self.hypothesis_handler = Hypothesis(self.mongo_wrapper)
self.objects_handler = Object(self.mongo_wrapper)
self.active_data_type = self.scenes_handler
def get_db_names(self):
return self.mono_db_names
def get_no_objs(self):
no = self.mongo_wrapper.exist_persistent_obj()
return no
def set_active_db(self, db_name):
self.mongo_wrapper = MongoWrapper(dbname=db_name)
self.scenes_handler.set_mongo_wrp(self.mongo_wrapper)
self.hypothesis_handler.set_mongo_wrp(self.mongo_wrapper)
self.objects_handler.set_mongo_wrp(self.mongo_wrapper)
def first_call(self, call_type, query=''):
if call_type is "hypos":
self.hypothesis_handler.reset()
self.active_data_type = self.hypothesis_handler
return self.hypothesis_handler.first_call(query)
elif call_type is "scenes":
self.scenes_handler.reset()
self.active_data_type = self.scenes_handler
return self.scenes_handler.first_call(query)
elif call_type is "objects":
self.objects_handler.reset()
self.active_data_type = self.objects_handler
return self.objects_handler.first_call()
def prepare_export(self):
self.active_data_type.prepare_export()
return "OK"
def get_timestamps(self):
return self.mongo_wrapper.get_timestamps()
def scroll_call(self, data_type):
if data_type == "scenes_tab":
return self.scenes_handler.scroll_call()
elif data_type == "hypothesis_tab":
return self.hypothesis_handler.scroll_call()
elif data_type == "objects_tab":
return self.objects_handler.scroll_call()
return "OK"
def export_all(self):
return self.active_data_type.export_all()
def delete_scene(self, args):
"""Delete (archive) the current active Scene
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d scenario "SCENARIO NAME"```')
return scene_svc.delete_item(args, self.user, self.sc, Scene().find, {'guild': self.guild.name, 'channel_id': str(self.channel.id), 'scenario_id': str(self.scenario.id)})
def __init__(self, parent, ctx, args, guild, user, channel):
"""
Command handler for UndoCommand
Parameters
----------
parent : DreamcraftHandler
The handler for Dreamcraft Bot commands and subcommands
ctx : object(Context)
The Discord.Context object used to retrieve and send information to Discord users
args : array(str)
The arguments sent to the bot to parse and evaluate
guild : Guild
The guild object containing information about the server issuing commands
user : User
The user database object containing information about the user's current setttings, and dialogs
channel : Channel
The channel from which commands were issued
Returns
-------
UndoCommand - object for processing undo/redo commands and subcommands
"""
self.parent = parent
self.new = parent.new
self.delete = parent.delete
self.ctx = ctx
self.args = args[1:]
self.guild = guild
self.user = user
self.channel = channel
self.command = self.args[0].lower() if len(self.args) > 0 else 'undo'
self.scenario = Scenario().get_by_id(
self.channel.active_scenario
) if self.channel and self.channel.active_scenario else None
self.sc = Scene().get_by_id(
self.channel.active_scene
) if self.channel and self.channel.active_scene else None
self.zone = Zone().get_by_id(
self.channel.active_zone
) if self.channel and self.channel.active_zone else None
self.char = Character().get_by_id(
self.user.active_character
) if self.user and self.user.active_character else None
def enter_new_order(email, order_source, scene_list, option_string, note=''):
'''Places a new espa order in the database'''
order = Order()
order.orderid = generate_order_id(email)
order.email = email
order.note = note
order.status = 'ordered'
order.order_date = datetime.datetime.now()
order.product_options = option_string
order.order_source = order_source
order.save()
for s in set(scene_list):
scene = Scene()
scene.name = s
scene.order = order
scene.order_date = datetime.datetime.now()
scene.status = 'submitted'
scene.save()
return order
def scene_list(self, args):
"""Display a dialog for viewing and selecting Scenes
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d scenario "SCENARIO NAME"```')
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
messages.extend(Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Scene List',
'command': 'scene ' + (' '.join(args)),
'type': 'view',
'getter': {
'method': Scene().get_by_scenario,
'params': {'scenario': self.scenario, 'archived': False}
},
'formatter': lambda item, item_num, page_num, page_size: f'{item.get_short_string(self.channel)}',
'cancel': canceler
}).open())
return messages
def enter_new_order(email, order_source, scene_list, option_string, note=""):
"""Places a new espa order in the database"""
order = Order()
order.orderid = generate_order_id(email)
order.email = email
order.note = note
order.status = "ordered"
order.order_date = datetime.datetime.now()
order.product_options = option_string
order.order_source = order_source
order.save()
for s in set(scene_list):
scene = Scene()
scene.name = s
scene.order = order
scene.order_date = datetime.datetime.now()
scene.status = "submitted"
scene.save()
return order
def get_scene_by_id(self, scene_id):
response = requests.get(self._base_url + 'do=/scenes/' + str(scene_id), timeout=TIMEOUT)
data = json.loads(response.content)
scene = data['scene']
return Scene(scene)
def load_ee_orders():
''' Loads all the available orders from lta into our database and updates their status '''
lta_service = lta.LtaServices()
#This returns a dict that contains a list of dicts{}
#key:(order_num,email) = list({sceneid:, unit_num:})
orders = lta_service.get_available_orders()
#This sets (hard codes) the product options that comes in from EE when someone
#is requesting processing via their interface
ee_options = {
'include_sourcefile': False,
'include_source_metadata': False,
'include_sr_toa': False,
'include_sr_thermal': False,
'include_sr': True,
'include_sr_browse': False,
'include_sr_ndvi': False,
'include_sr_ndmi': False,
'include_sr_nbr': False,
'include_sr_nbr2': False,
'include_sr_savi': False,
'include_sr_evi': False,
'include_solr_index': False,
'include_cfmask': False,
'reproject': False,
'resize': False,
'image_extents': False
}
#Capture in our db
for eeorder, email in orders:
#create the orderid based on the info from the eeorder
order_id = generate_ee_order_id(email, eeorder)
order = None
#go look to see if it already exists in the db
try:
order = Order.objects.get(orderid=order_id)
except:
#Didn't find it in the db... make the order now
order = Order()
order.orderid = generate_ee_order_id(email, eeorder)
order.email = email
order.chain = 'sr_ondemand'
order.status = 'ordered'
order.note = 'EarthExplorer order id: %s' % eeorder
order.product_options = json.dumps(ee_options)
order.ee_order_id = eeorder
order.order_source = 'ee'
order.order_date = datetime.datetime.now()
order.save()
for s in orders[eeorder, email]:
#go look for the scene by ee_unit_id. This will stop
#duplicate key update collisions
scene = None
try:
scene = Scene.objects.get(order=order,
ee_unit_id=s['unit_num'])
if scene.status == 'complete':
success, msg, status = lta_service.update_order(
eeorder, s['unit_num'], "C")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder, s['unit_num'], scene.name, order.orderid)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (
msg, status)
helperlogger(log_msg)
elif scene.status == 'unavailable':
success, msg, status = lta_service.update_order(
eeorder, s['unit_num'], "R")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder, s['unit_num'], scene.name, order.orderid)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (
msg, status)
helperlogger(log_msg)
except:
scene = Scene()
scene.name = s['sceneid']
scene.ee_unit_id = s['unit_num']
scene.order = order
scene.order_date = datetime.datetime.now()
scene.status = 'submitted'
scene.save()
#Update LTA
success, msg, status = lta_service.update_order(
eeorder, s['unit_num'], "I")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder, s['unit_num'], scene.name, order.orderid)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (
msg, status)
helperlogger(log_msg)
from models import Scene
import sys
size = 550
if __name__ == "__main__":
angle = None
try:
angle = int(sys.argv[1])
except IndexError as e:
print(f"IndexError: {e.args} - No argument passed in command line")
finally:
if angle is None:
angle = 1
scene = Scene(size, angle)
scene.draw()
def load_ee_orders():
""" Loads all the available orders from lta into our database and updates their status """
lta_service = lta.LtaServices()
# This returns a dict that contains a list of dicts{}
# key:(order_num,email) = list({sceneid:, unit_num:})
orders = lta_service.get_available_orders()
# This sets (hard codes) the product options that comes in from EE when someone
# is requesting processing via their interface
ee_options = {
"include_sourcefile": False,
"include_source_metadata": False,
"include_sr_toa": False,
"include_sr_thermal": False,
"include_sr": True,
"include_sr_browse": False,
"include_sr_ndvi": False,
"include_sr_ndmi": False,
"include_sr_nbr": False,
"include_sr_nbr2": False,
"include_sr_savi": False,
"include_sr_evi": False,
"include_solr_index": False,
"include_cfmask": False,
"reproject": False,
"resize": False,
"image_extents": False,
}
# Capture in our db
for eeorder, email in orders:
# create the orderid based on the info from the eeorder
order_id = generate_ee_order_id(email, eeorder)
order = None
# go look to see if it already exists in the db
try:
order = Order.objects.get(orderid=order_id)
except:
# Didn't find it in the db... make the order now
order = Order()
order.orderid = generate_ee_order_id(email, eeorder)
order.email = email
order.chain = "sr_ondemand"
order.status = "ordered"
order.note = "EarthExplorer order id: %s" % eeorder
order.product_options = json.dumps(ee_options)
order.ee_order_id = eeorder
order.order_source = "ee"
order.order_date = datetime.datetime.now()
order.save()
for s in orders[eeorder, email]:
# go look for the scene by ee_unit_id. This will stop
# duplicate key update collisions
scene = None
try:
scene = Scene.objects.get(order=order, ee_unit_id=s["unit_num"])
if scene.status == "complete":
success, msg, status = lta_service.update_order(eeorder, s["unit_num"], "C")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder,
s["unit_num"],
scene.name,
order.orderid,
)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (msg, status)
helperlogger(log_msg)
elif scene.status == "unavailable":
success, msg, status = lta_service.update_order(eeorder, s["unit_num"], "R")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder,
s["unit_num"],
scene.name,
order.orderid,
)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (msg, status)
helperlogger(log_msg)
except:
scene = Scene()
scene.name = s["sceneid"]
scene.ee_unit_id = s["unit_num"]
scene.order = order
scene.order_date = datetime.datetime.now()
scene.status = "submitted"
scene.save()
# Update LTA
success, msg, status = lta_service.update_order(eeorder, s["unit_num"], "I")
if not success:
log_msg = "Error updating lta for [eeorder:%s ee_unit_num:%s scene name:%s order:%s" % (
eeorder,
s["unit_num"],
scene.name,
order.orderid,
)
helperlogger(log_msg)
log_msg = "Error detail: lta return message:%s lta return status code:%s" % (msg, status)
helperlogger(log_msg)
def get_scenes(self, item):
return list(Scene.get_by_scenario(scenario=item, page_num=0))
class SceneCommand():
"""
Handle 'scene', 's' commands and subcommands
Subcommands:
help - display a set of instructions on SceneCommand usage
note - add a note to the scene
say - add dialog to the scene from the scene
story - display the scene's story
new - create new scenes by name
name, n - display scenes by name
description, desc - add/edit the Description in the scene
select, = - display existing scene
character, char, c - edit the scene as a character
list, l - display a list of existing characters and NPCs
players, player, p - add players to the scene
connect, adjoin, ajoin, join, j - connect zones to each other
start - add a start time to the scene
end - add an end time to the scene
enter - add a character to a scene with a staging note
move - add a character to the current zone
exit - remove a character from the scene with a staging note
delete - remove an scene (archive)
"""
def __init__(self, parent, ctx, args, guild, user, channel):
"""
Command handler for SceneCommand
Parameters
----------
parent : DreamcraftHandler
The handler for Dreamcraft Bot commands and subcommands
ctx : object(Context)
The Discord.Context object used to retrieve and send information to Discord users
args : array(str)
The arguments sent to the bot to parse and evaluate
guild : Guild
The guild object containing information about the server issuing commands
user : User
The user database object containing information about the user's current setttings, and dialogs
channel : Channel
The channel from which commands were issued
Returns
-------
SceneCommand - object for processing scene commands and subcommands
"""
self.parent = parent
self.new = parent.new
self.delete = parent.delete
self.ctx = ctx
self.args = args[1:] if args[0] in ['scene', 's'] else args
self.guild = guild
self.user = user
self.command = self.args[0].lower() if len(self.args) > 0 else 'select'
channel = 'private' if ctx.channel.type.name == 'private' else ctx.channel.name
self.channel = Channel().get_or_create(channel, self.guild.name, self.user)
self.scenario = Scenario().get_by_id(self.channel.active_scenario) if self.channel and self.channel.active_scenario else None
self.sc = Scene().get_by_id(self.channel.active_scene) if self.channel and self.channel.active_scene else None
self.can_edit = self.user.role == 'Game Master' if self.user and self.sc else True
self.zone = Zone().get_by_id(self.channel.active_zone) if self.channel and self.channel.active_zone else None
self.char = Character().get_by_id(self.user.active_character) if self.user and self.user.active_character else None
def run(self):
"""
Execute the channel commands by validating and finding their respective methods
Returns
-------
list(str) - a list of messages in response the command validation and execution
"""
try:
# List of subcommands mapped the command methods
switcher = {
'help': self.help,
'note': self.note,
'say': self.say,
'story': self.story,
'name': self.select,
'n': self.select,
'select': self.select,
'description': self.description,
'desc': self.description,
'character': self.character,
'char': self.character,
'c': self.character,
'approaches': self.character,
'approach': self.character,
'apps': self.character,
'app': self.character,
'skills': self.character,
'skill': self.character,
'sks': self.character,
'sk': self.character,
'aspects': self.character,
'aspect': self.character,
'a': self.character,
'stunts': self.character,
'stunt': self.character,
's': self.character,
'custom': self.character,
'stress': self.character,
'st': self.character,
'consequences': self.character,
'consequence':self.character,
'con': self.character,
'players': self.player,
'player': self.player,
'p': self.player,
'connect': self.adjoin,
'adjoin': self.adjoin,
'ajoin': self.adjoin,
'join': self.adjoin,
'j': self.adjoin,
'list': self.scene_list,
'l': self.scene_list,
'delete': self.delete_scene,
'd': self.delete_scene,
'start': self.start,
'end': self.end,
'enter': self.enter,
'move': self.move,
'exit': self.exit
}
if self.new and not self.user.command or self.user.command and 'new' in self.user.command:
func = self.new_scene
elif self.delete:
func = self.delete_scene
# Get the function from switcher dictionary
elif self.command in switcher:
func = switcher.get(self.command, lambda: self.select)
else:
match = self.search(self.args)
if match:
self.args = ('select',) + self.args
self.command = 'select'
func = self.select
else:
self.args = ('n',) + self.args
self.command = 'n'
func = self.select
if func:
# Execute the function
messages = func(self.args)
# Send messages
return messages
except Exception as err:
traceback.print_exc()
# Log every error
scene_svc.log(
str(self.sc.id) if self.sc else str(self.user.id),
self.sc.name if self.sc else self.user.name,
str(self.user.id),
self.guild.name,
'Error',
{
'command': self.command,
'args': self.args,
'traceback': traceback.format_exc()
}, 'created')
return list(err.args)
def help(self, args):
"""Returns the help text for the command"""
return [SCENE_HELP]
def check_scene(self):
if not self.sc:
raise Exception('You don\'t have an active scene. Try this:```css\n.d new scene "SCENE NAME"```')
def search(self, args):
"""Search for an existing Scene using the command string
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
params = {'name__icontains': ' '.join(args[0:]), 'guild': self.guild.name, 'channel_id': str(self.channel.id), 'archived': False}
return scene_svc.search(args, Scene.filter, params)
def note(self, args):
"""Add a note to the Scene story
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
if self.sc:
Log().create_new(str(self.sc.id), f'Scene: {self.sc.name}', str(self.user.id), self.guild.name, 'Scene', {'by': self.user.name, 'note': ' '.join(args[1:])}, 'created')
return ['Log created']
else:
return ['No active scene to log']
def say(self, args):
"""Add dialog to the Scene story
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
if not self.sc:
return ['No active scene to log']
else:
note_text = ' '.join(args[1:])
Log().create_new(str(self.sc.id), f'Scene: {self.sc.name}', str(self.user.id), self.guild.name, 'Scene', {'by': self.user.name, 'note': f'***Narrator*** says, "{note_text}"'}, 'created')
return ['Log created']
def story(self, args):
"""Disaply the Scene story
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages =[]
command = 'scene ' + (' '.join(args))
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene','s']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
response = Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Story',
'type': 'view',
'type_name': 'Story Log',
'command': command,
'getter': {
'method': Log.get_by_page,
'params': {
'params': {'parent_id': str(self.sc.id), 'data__note__exists': True},
'sort': 'created'
},
'parent_method': Scene.get_by_page,
'parent_params': {
'params': {'category__in': ['Character','Aspect','Stunt']},
'sort': 'created'
}
},
'formatter': lambda log, num, page_num, page_size: log.get_string(self.user), # if log.category == 'Log' else log.get_string()
'cancel': canceler,
'page_size': 10
}).open()
messages.extend(response)
return messages
def dialog(self, dialog_text, sc=None):
"""Display Scene information and help text
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
sc = sc if sc else self.sc
sc, name, get_string, get_short_string = scene_svc.get_info('scene', sc, self.channel, self.user)
can_edit = str(self.user.id) == str(sc.created) or self.user.role in ['Admin','Game Master'] if self.user and sc else True
category = 'Scene'
dialog = {
'create_scene': ''.join([
'**CREATE or SCENE**```css\n',
'.d new scene "YOUR SCENE\'S NAME"```'
]),
'active_scene': ''.join([
'***YOU ARE CURRENTLY EDITING...***\n' if self.can_edit else '',
f':point_down:\n\n{get_string}'
]),
'active_scene_short': ''.join([
'***YOU ARE CURRENTLY EDITING...:***\n' if self.can_edit else '',
f':point_down:\n\n{get_short_string}'
]),
'rename_delete': ''.join([
f'\n\n_Is ***{name}*** not the {category.lower()} name you wanted?_',
f'```css\n.d scene rename "NEW NAME"```_Want to remove ***{name}***?_',
'```css\n.d scene delete```'
]) if self.can_edit else '',
'edit_active_scene': ''.join([
f'\n***You can edit this scene as if it were a character***',
'```css\n.d scene character\n',
'/* THIS WILL SHOW THE SCENE IS THE ACTIVE CHARACTER */\n',
'.d c\n',
'/* THIS WILL RETURN YOU TO EDITING THE SCENE ITSELF */\n',
'.d c parent```'
]) if can_edit else '',
'scene_actions': ''.join([
f'\n***You can start and end the scene***',
'```css\n.d scene start\n',
'.d scene end```',
f'\n***You can have characters enter and exit the scene***',
'```css\n.d c "CHARACTER NAME" /* to select the character */\n',
'```css\n.d scene enter "CHARACTER NAME"\n',
'.d scene exit "CHARACTER NAME"```',
f'***You can connect zones to each other***',
'```css\n.d connect "Kitchen" to "Dining Room"```',
f'***You can move characters from zone to zone***',
'```css\n.d c "CHARACTER NAME" /* to select the character */\n',
'.d scene move from "Kitchen" to "Dining Room"```'
]),
'go_back_to_parent': ''.join([
f'\n\n***You can GO BACK to the parent scene, aspect, or stunt***',
'```css\n.d scene parent```'
])
}
dialog_string = ''
if dialog_text == 'all':
if not sc:
dialog_string += dialog.get('create_scene', '')
else:
dialog_string += dialog.get('rename_delete', '')
dialog_string += dialog.get('scene_actions', '')
dialog_string += dialog.get('edit_active_scene')
elif category == 'Scene':
if dialog_text:
dialog_string += dialog.get(dialog_text, '')
else:
dialog_string += dialog.get('active_scene', '')
dialog_string += dialog.get('rename_delete', '')
dialog_string += dialog.get('edit_active_scene', '')
dialog_string += dialog.get('scene_actions', '')
else:
if dialog_text:
dialog_string += dialog.get(dialog_text, '')
else:
dialog_string += dialog.get('active_scene', '')
dialog_string += dialog.get('rename_delete', '')
dialog_string += dialog.get('go_back_to_parent', '')
return dialog_string
def new_scene(self, args):
"""Create a new Scene by name
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d new scenario "SCENARIO NAME"```')
if len(args) == 0:
if not self.sc:
return [
'No active scene or name provided\n\n',
self.dialog('all')
]
messages.append(self.sc.get_string(self.channel, self.user))
else:
if len(args) == 1 and args[0].lower() == 'short':
return [self.dialog('active_scene_short')]
scene_name = ' '.join(args)
if len(args) > 1 and args[1] == 'rename':
scene_name = ' '.join(args[2:])
if not self.sc:
return [
'No active scene or name provided\n\n',
self.dialog('all')
]
else:
scene = Scene().find(self.guild.name, str(self.channel.id), str(self.scenario.id), scene_name)
if scene:
return [f'Cannot rename to _{scene_name}_. Scene already exists']
else:
self.sc.name = scene_name
scene_svc.save(self.sc, self.user)
messages.append(self.dialog(''))
else:
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene','s']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
def selector(selection):
self.sc = selection
self.channel.set_active_scene(self.sc, self.user)
return [self.dialog('')]
def creator(**params):
item = Scene().get_or_create(**params)
scenes = scenario_svc.get_scenes(self.scenario)
characters = scenario_svc.get_characters(scenes)
item.characters = [str(c.id) for c in characters]
scene_svc.save(item, self.user)
return item
messages.extend(Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Scene List',
'command': 'new scene ' + ' '.join(args),
'type': 'select',
'type_name': 'SCENE',
'getter': {
'method': Scene.get_by_page,
'params': {'params': {'name__icontains': scene_name, 'scenario_id': str(self.scenario.id), 'guild': self.guild.name, 'archived': False}}
},
'formatter': lambda item, item_num, page_num, page_size: f'_SCENE #{item_num+1}_\n{item.get_short_string()}',
'cancel': canceler,
'select': selector,
'confirm': {
'method': creator,
'params': {'user': self.user, 'name': scene_name, 'scenario': self.scenario, 'channel': self.channel, 'guild': self.guild.name}
}
}).open())
return messages
def select(self, args):
"""Select an existing Scene by name
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d scenario "SCENARIO NAME"```')
if len(args) == 0:
if not self.sc:
return [
'No active scene or name provided\n\n',
self.dialog('all')
]
messages.append(self.sc.get_string())
else:
if len(args) == 1 and args[0].lower() == 'short':
return [self.dialog('active_scene_short')]
if len(args) == 1 and self.char:
return [self.dialog('')]
sc_name = ' '.join(args[1:])
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene','s']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
def selector(selection):
self.sc = selection
self.channel.set_active_scene(self.sc, self.user)
return [self.dialog('')]
messages.extend(Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Scene List',
'command': 's ' + ' '.join(args),
'type': 'select',
'type_name': 'SCENE',
'getter': {
'method': Scene.get_by_page,
'params': {'params': {'name__icontains': sc_name, 'scenario_id': str(self.scenario.id), 'guild': self.guild.name, 'archived': False}}
},
'formatter': lambda item, item_num, page_num, page_size: f'_SCENE #{item_num+1}_\n{item.get_short_string()}',
'cancel': canceler,
'select': selector
}).open())
return messages
def scene_list(self, args):
"""Display a dialog for viewing and selecting Scenes
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d scenario "SCENARIO NAME"```')
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
messages.extend(Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Scene List',
'command': 'scene ' + (' '.join(args)),
'type': 'view',
'getter': {
'method': Scene().get_by_scenario,
'params': {'scenario': self.scenario, 'archived': False}
},
'formatter': lambda item, item_num, page_num, page_size: f'{item.get_short_string(self.channel)}',
'cancel': canceler
}).open())
return messages
def description(self, args):
"""Add/edit the description for a Scene
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
if len(args) == 1:
raise Exception('No description provided')
self.check_scene()
description = ' '.join(args[1:])
self.sc.description = description
scene_svc.save(self.sc, self.user)
return [
f'Description updated to "{description}"',
self.sc.get_string(self.channel, self.user)
]
def character(self, args):
"""Edit the Scene as a character
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
self.check_scene()
self.user.active_character = str(self.sc.character.id)
scene_svc.save_user(self.user)
command = CharacterCommand(parent=self.parent, ctx=self.ctx, args=args, guild=self.guild, user=self.user, channel=self.channel, char=self.sc.character)
return command.run()
def player(self, args):
"""Add/remove a player from the Scene
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
return scene_svc.player(args, self.channel, self.sc, self.user)
def adjoin(self, args):
"""Connect/disconned zones from each other
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
return scene_svc.adjoin(args, self.guild.name, self.channel, self.sc, self.user)
def delete_scene(self, args):
"""Delete (archive) the current active Scene
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d scenario "SCENARIO NAME"```')
return scene_svc.delete_item(args, self.user, self.sc, Scene().find, {'guild': self.guild.name, 'channel_id': str(self.channel.id), 'scenario_id': str(self.scenario.id)})
def start(self, args):
"""Add a start time to the Scene
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
self.check_scene()
if self.sc.started_on:
raise Exception(f'***{self.sc.name}*** already began on {T.to(self.sc.started_on, self.user)}')
else:
self.sc.started_on = T.now()
scene_svc.save(self.sc, self.user)
return [self.dialog('')]
def end(self, args):
"""Add an end time to the Engagement
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
self.check_scene()
if len(args) > 1 and args[1] == 'delete':
self.sc.ended_on = None
scene_svc.save(self.sc, self.user)
return [self.dialog('')]
else:
if not self.sc.started_on:
raise Exception(f'***{self.sc.name}*** has not yet started.')
if self.sc.ended_on:
raise Exception(f'***{self.sc.name}*** already ended on {T.to(self.sc.ended_on, self.user)}')
else:
self.sc.ended_on = T.now()
scene_svc.save(self.sc, self.user)
return [self.dialog('')]
def enter(self, args):
"""Add a character to a scene with a stage note
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
self.check_scene()
if not self.char:
raise Exception(f'You have no active character.```css\n.d c "CHARACTER NAME"```')
if not self.sc.started_on:
raise Exception(f'***{self.sc.name}*** has not yet started. You may not enter.')
if self.sc.ended_on:
raise Exception(f'***{self.sc.name}*** has already ended. You missed it.')
messages = self.player(('p', self.char.name))
self.note(('note', f'***{self.char.name}*** enters the _({self.sc.name})_ scene'))
if self.zone:
messages.extend(self.move(('move', 'to', self.zone.name)))
return messages
def move(self, args):
"""Move a Character to the current zone
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
self.check_scene()
if not self.char or (self.char and self.char.category != 'Character'):
raise Exception(f'You have no active character.```css\n.d c "CHARACTER NAME"```')
zones = list(Zone.filter(scene_id=str(self.sc.id), archived=False))
if len(args) == 1:
leaving = [z for z in zones if str(self.char.id) in z.characters]
leaving_str = f'You are currently in the _{leaving[0].name}_ zone.\n' if leaving else ''
zones_string = '\n'.join([f'.d s move {z.name}' for z in zones])
raise Exception(f'{leaving_str}Which zone do you want?```css\n{zones_string}```')
if not zones:
raise Exception('There are no zones to move into.')
if args[1] == 'to':
zone_name = ' '.join(args[2:])
else:
zone_name = ' '.join(args[1:])
zone = [z for z in zones if zone_name.lower() in z.character.name.lower()]
if not zone:
raise Exception(f'***{zone_name}*** not found in ***{self.sc.name}***')
if len(zone) > 1:
zones_string = '\n'.join([f'.d s move {z.name}' for z in zones])
raise Exception(f'Which zone do you want?```css\n{zones_string}```')
if str(self.char.id) in zone[0].characters:
raise Exception(f'***{self.char.name}*** is already in the _{zone[0].name}_ zone.')
leaving = [z for z in zones if str(self.char.id) in z.characters]
for l in leaving:
messages.extend(zone_svc.player(('p', 'delete', self.char.name), self.channel, l, self.user))
self.note(('note', f'***{self.char.name}*** exits the _{l.name}_ zone'))
messages.extend(zone_svc.player(('p', self.char.name), self.channel, zone[0], self.user))
self.note(('note', f'***{self.char.name}*** enters the _{zone[0].name}_ zone'))
return messages
def exit(self, args):
"""Remove a character from the scene with a staging note
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
self.check_scene()
if not self.char and not self.char.category == 'Character':
raise Exception(f'You have no active character.```css\n.d c "CHARACTER NAME"```')
if not self.sc.started_on:
raise Exception(f'***{self.sc.name}*** has not yet started. You may not enter.')
if self.sc.ended_on:
raise Exception(f'***{self.sc.name}*** has already ended. You missed it.')
zones = list(Zone.filter(scene_id=str(self.sc.id), archived=False))
leaving = [z for z in zones if str(self.char.id) in z.characters]
for l in leaving:
messages.extend(zone_svc.player(('p', 'delete', self.char.name), self.channel, l, self.user))
self.note(('note', f'***{self.char.name}*** exits the _{l.name}_ zone'))
if self.channel and self.channel.active_engagement:
engagement = Engagement().get_by_id(self.channel.active_engagement)
messages.extend(engagement_svc.player(('player', 'delete', self.char.name), self.channel, engagement, self.user))
messages.extend(self.player(('p', 'delete', self.char.name)))
self.note(('note', f'***{self.char.name}*** exits the _{self.sc.name}_ scene'))
return messages
def new_scene(self, args):
"""Create a new Scene by name
Parameters
----------
args : list(str)
List of strings with subcommands
Returns
-------
list(str) - the response messages string array
"""
messages = []
if not self.scenario:
raise Exception('No active scenario. Try this:```css\n.d new scenario "SCENARIO NAME"```')
if len(args) == 0:
if not self.sc:
return [
'No active scene or name provided\n\n',
self.dialog('all')
]
messages.append(self.sc.get_string(self.channel, self.user))
else:
if len(args) == 1 and args[0].lower() == 'short':
return [self.dialog('active_scene_short')]
scene_name = ' '.join(args)
if len(args) > 1 and args[1] == 'rename':
scene_name = ' '.join(args[2:])
if not self.sc:
return [
'No active scene or name provided\n\n',
self.dialog('all')
]
else:
scene = Scene().find(self.guild.name, str(self.channel.id), str(self.scenario.id), scene_name)
if scene:
return [f'Cannot rename to _{scene_name}_. Scene already exists']
else:
self.sc.name = scene_name
scene_svc.save(self.sc, self.user)
messages.append(self.dialog(''))
else:
def canceler(cancel_args):
if cancel_args[0].lower() in ['scene','s']:
return SceneCommand(parent=self.parent, ctx=self.ctx, args=cancel_args, guild=self.guild, user=self.user, channel=self.channel).run()
else:
self.parent.args = cancel_args
self.parent.command = self.parent.args[0]
return self.parent.get_messages()
def selector(selection):
self.sc = selection
self.channel.set_active_scene(self.sc, self.user)
return [self.dialog('')]
def creator(**params):
item = Scene().get_or_create(**params)
scenes = scenario_svc.get_scenes(self.scenario)
characters = scenario_svc.get_characters(scenes)
item.characters = [str(c.id) for c in characters]
scene_svc.save(item, self.user)
return item
messages.extend(Dialog({
'svc': scene_svc,
'user': self.user,
'title': 'Scene List',
'command': 'new scene ' + ' '.join(args),
'type': 'select',
'type_name': 'SCENE',
'getter': {
'method': Scene.get_by_page,
'params': {'params': {'name__icontains': scene_name, 'scenario_id': str(self.scenario.id), 'guild': self.guild.name, 'archived': False}}
},
'formatter': lambda item, item_num, page_num, page_size: f'_SCENE #{item_num+1}_\n{item.get_short_string()}',
'cancel': canceler,
'select': selector,
'confirm': {
'method': creator,
'params': {'user': self.user, 'name': scene_name, 'scenario': self.scenario, 'channel': self.channel, 'guild': self.guild.name}
}
}).open())
return messages
def add_music_scene_tag(self, name):
scene = Scene(name=name)
database.session.add(scene)
database.session.commit()
def __map_response_to_scenes(self, scene_list):
scene_objects = map(lambda x: Scene(x), scene_list)
return scene_objects