Geoffrey-Django/api/commands.py

485 lines
15 KiB
Python
Raw Normal View History

from django.db.models import Q, F
from GeoffreyApp.models import *
2018-12-17 16:02:43 +00:00
from GeoffreyApp.errors import *
from GeoffreyApp.minecraft_api import *
import inspect
import datetime
import re
command_dict = {"GET": {}, "POST": {}, "DELETE": {}}
def objects_list_to_json(obj_list):
json_list = []
for obj in obj_list:
json_list.append(obj.json)
return json_list
def get_required_args(func):
args = inspect.getfullargspec(func)
return args.args + args.kwonlyargs
def command(type):
def command_dec(func):
def add_command():
command_dict[type][func.__name__] = {"func": func, "params": get_required_args(func)}
return func
return add_command()
return command_dec
def get_player(discord_uuid=None, mc_uuid=None):
try:
if discord_uuid is not None:
player = Player.objects.get(discord_uuid__iexact=discord_uuid)
elif mc_uuid is not None:
player = Player.objects.get(mc_uuid__iexact=mc_uuid)
else:
raise AttributeError
except Player.DoesNotExist:
raise PlayerNotFound
return player
def get_location(owner, name=None, loc_type=Location):
if name is None:
loc_list = loc_type.objects.filter(owner=owner).all()
if len(loc_list) == 1:
loc = loc_list[0]
elif len(loc_list) == 0:
raise NoLocationsInDatabase
else:
raise EntryNameNotUniqueError
else:
loc_list = loc_type.objects.filter(owner=owner, name__iexact=name).all()
if len(loc_list) == 1:
loc = loc_list[0]
else:
raise LocationLookUpError
return loc
2019-01-02 23:17:53 +00:00
def add_location(x_pos, z_pos, name=None, discord_uuid=None, mc_uuid=None, loc_type=Location):
player = get_player(discord_uuid, mc_uuid)
try:
get_location(player, name, loc_type=loc_type)
raise EntryNameNotUniqueError
except (Location.DoesNotExist, NoLocationsInDatabase, LocationLookUpError):
2019-01-02 23:17:53 +00:00
if name is None:
name = "{}'s {}".format(player.name, loc_type.__name__)
location = loc_type.objects.create(owner=player, name=name, x_coord=x_pos, z_coord=z_pos)
2019-01-02 23:17:53 +00:00
return location.json
2019-01-02 23:17:53 +00:00
@command("POST")
def register(player_name, discord_uuid):
2019-01-01 17:05:19 +00:00
'''
2019-01-02 23:17:53 +00:00
:request: POST
:param player_name: Minecraft in-game name
:param discord_uuid: Discord UUID if registering from Discord
:return: JSON representation of the new Player
:raise: PlayerInDBError
2019-01-02 23:17:53 +00:00
:help: Registers your Discord and Minecraft account with the the database
2019-01-01 17:05:19 +00:00
'''
2019-01-02 23:17:53 +00:00
mc_uuid = grab_UUID(player_name)
try:
get_player(mc_uuid=mc_uuid)
raise PlayerInDBError
except PlayerNotFound:
player = Player.objects.create(name=player_name, mc_uuid=mc_uuid, discord_uuid=discord_uuid)
player.save()
return player.json
@command("POST")
2018-12-08 21:37:00 +00:00
def add_base(x_pos, z_pos, name=None, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param x_pos: MC X Coordinate
:param z_pos: MC Z Coordinate
:param name: Base Name (If None, Defaults to Player's Base)
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: JSON representation of the new base
:raises: EntryNameNotUniqueError, PlayerNotFound, LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Adds your base to the database. The base name is optional if this is your first base
'''
2018-12-08 21:37:00 +00:00
return add_location(x_pos, z_pos, name=name, discord_uuid=discord_uuid, mc_uuid=mc_uuid, loc_type=Base)
@command("POST")
2018-12-08 21:37:00 +00:00
def add_shop(x_pos, z_pos, name=None, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param x_pos: MC X Coordinate
:param z_pos: MC Z Coordinate
:param name: Shop Name (If None, Defaults to Player's Shop)
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: JSON representation of the new shop
:raises: EntryNameNotUniqueError, PlayerNotFound, LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Adds your shop to the database. The name is optional if this is your first shop
'''
2019-01-02 23:17:53 +00:00
return add_location(x_pos, z_pos, name=name, discord_uuid=discord_uuid, mc_uuid=mc_uuid, loc_type=Shop)
@command("POST")
def add_tunnel(tunnel_direction, tunnel_number, location_name=None, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param tunnel_direction: Tunnel Direction
:param tunnel_number: Tunnel Coordinate
:param location_name: Name of the Location to attach the tunnel to
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: JSON Representation of the Tunnel
:raises: PlayerNotFound, LocationHasTunnelError, EntryNameNotUniqueError, NoLocationsInDatabase
2019-01-02 23:17:53 +00:00
:help: Adds your tunnel to the database. If you only have one location, you do not need to specify a location name
'''
player = get_player(discord_uuid, mc_uuid)
if location_name is None:
loc = get_location(player)
location_name = loc.name
else:
loc = get_location(player, name=location_name)
for direction in Tunnel.TUNNEL_NAMES:
if re.search("{}.*".format(tunnel_direction), direction[1], re.IGNORECASE):
tunnel_direction = direction[0]
break
if Tunnel.objects.filter(location=loc).first():
raise LocationHasTunnelError
tunnel = Tunnel.objects.create(tunnel_direction=tunnel_direction, tunnel_number=tunnel_number,
location=get_location(player, location_name))
return tunnel.json
@command("GET")
def find_location(search, limit=25):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param search: Location name or owner to search for
:param limit: How man locations to return
2019-01-02 23:17:53 +00:00
:return: List of the matching locations
:raises: LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Finds all the locations matching the search term
'''
locations = Location.objects.filter(Q(name__icontains=search) | Q(owner__name__icontains=search)).all()[:limit]
if len(locations) == 0:
raise LocationLookUpError
return objects_list_to_json(locations)
@command("DELETE")
def delete(name, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: DELETE
:param name: Name of location to delete
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: Location Name
:raises: LocationLookUpError
2019-01-02 23:17:53 +00:00
:help: Deletes a location from the database
'''
owner = get_player(discord_uuid, mc_uuid)
try:
Location.objects.get(name__iexact=name, owner=owner).delete()
except Location.DoesNotExist:
raise LocationLookUpError
return name
@command("GET")
def find_around(x_pos, z_pos, radius=200):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param x_pos: MC X Coordinate
:param z_pos: MC Z Coordinate
:param radius: Radius to each around (default 200)
:return: List of all locations in the radius
:raises: LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Finds all the locations around a certain point
'''
locations = Location.objects.filter(x_coord__range=(x_pos - radius, x_pos + radius),
z_coord__range=(z_pos - radius, z_pos + radius)).all()
if len(locations) == 0:
raise LocationLookUpError
return objects_list_to_json(locations)
@command("POST")
def add_item(item_name, quantity, diamond_price, shop_name=None, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param item_name: name of the item
:param quantity: number of items being sold
:param diamond_price: price in diamonds
:param shop_name: Name of the shop, can be blank if the user only has one shop
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: Item Listing
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
2019-01-02 23:17:53 +00:00
:help: Adds an item to a shop's inventory. If you have one shop, the shop name is not required
'''
player = get_player(discord_uuid, mc_uuid)
shop = get_location(player, shop_name, Shop).shop
item_listing = ItemListing.objects.create(shop=shop, amount=int(quantity), price=int(diamond_price),
item_name=item_name)
return item_listing.json
@command("GET")
def selling(item_name, sort="-date_restocked"):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param item_name: Item name to search for
:param sort: Field to sort shop results by, default is date_restocked
:return: List of top matching shops, sorted by the
:raises: ItemNotFound
:help: Lists shops selling an item.
2019-01-02 23:17:53 +00:00
'''
2019-01-02 23:17:53 +00:00
items = []
if len(item_name) == 0:
raise EmptryString
2019-01-02 23:17:53 +00:00
shops = ItemListing.objects.annotate(normalized_price=F('price') / F('amount')) \
2019-01-04 20:18:56 +00:00
.filter(item_name__icontains=item_name).order_by(sort).values('shop_id').all()
2019-01-02 23:17:53 +00:00
if len(shops) == 0:
raise ItemNotFound
# Removes duplicates
2019-01-04 20:18:56 +00:00
shops = [i for n, i in enumerate(shops) if i not in shops[n + 1:]]
2019-01-02 23:17:53 +00:00
for shop_id in shops:
shop = Shop.objects.get(pk=shop_id['shop_id']).json
2019-01-02 23:17:53 +00:00
item_query = ItemListing.objects.annotate(normalized_price=F('price') / F('amount')) \
.filter(item_name__icontains=item_name, shop_id=shop_id['shop_id']) \
.order_by(sort) \
2019-01-02 23:17:53 +00:00
.values("item_name", "price", "amount")
2019-01-02 23:17:53 +00:00
item_list = []
for item in item_query:
item_list.append(item)
2018-12-08 21:37:00 +00:00
2019-01-02 23:17:53 +00:00
shop["items"] = item_list
items.append(shop)
return items
@command("GET")
def info(location_name):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param location_name: Name of the location to get info on
:return: JSON representation of location
:raises: LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Finds all the locations matching the search term
'''
location = Location.objects.get(name__iexact=location_name)
if location is None:
location = Location.objects.get(name__iregex="*{}*".format(location_name))
if location is not None:
return location.json
else:
raise LocationLookUpError
@command("GET")
def tunnel(player_name):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param player_name: MC player name
:return: List of all the tunnels a user owns
:raises: LocationLookUpError
:raises: LocationLookupError
2019-01-02 23:17:53 +00:00
:help: Finds all the tunnels a player owns
'''
tunnels = Tunnel.objects.filter(location__owner__name__icontains=player_name).all()
if len(tunnels) == 0:
raise LocationLookUpError
return objects_list_to_json(tunnels)
@command("POST")
def edit_pos(x, z, loc_name, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param x: New MC X coordinate
:param z: New MC Z Coordinate
:param loc_name: Location Name to edit
:param discord_uuid: Discord UUID
:param mc_uuid: MC UUID
:return: Edited Locatio
:raises:
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
2019-01-02 23:17:53 +00:00
:help: Edits the position of a location
'''
player = get_player(discord_uuid=discord_uuid, mc_uuid=mc_uuid)
location = get_location(player, loc_name)
location.x_coord = x
location.z_coord = z
location.save()
return location.json
@command("POST")
def edit_tunnel(tunnel_direction, tunnel_number, loc_name, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param tunnel_direction: New Tunnel Direction
:param tunnel_number: New Tunnel Address
:param loc_name: Location Name to edit
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: Edited Location
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
2019-01-02 23:17:53 +00:00
:help: Edits the tunnel of a location
'''
player = get_player(discord_uuid=discord_uuid, mc_uuid=mc_uuid)
location = get_location(player, loc_name)
if location.tunnel is not None:
location.tunnel.tunnel_direction = tunnel_direction
location.tunnel.tunnel_number = tunnel_number
else:
Tunnel.objects.create(tunnel_direction=tunnel_direction, tunnel_number=tunnel_number, location=location)
return location.json
@command("POST")
def edit_name(new_name, loc_name, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: POST
:param new_name: New Location Name
:param loc_name: Old Location name
:param discord_uuid: Discord UUID
:param mc_uuid: MC UUID
:return: Edited Location
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
2019-01-02 23:17:53 +00:00
:help: Edits the name of a location
'''
player = get_player(discord_uuid=discord_uuid, mc_uuid=mc_uuid)
location = get_location(player, loc_name)
location.name = new_name
location.save()
return location.json
@command("DELETE")
def delete_item(item, shop_name=None, discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: DELETE
:param item: Item name to delete
:param shop_name: Shop selling item, can be None if the user only has one shop
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: Deletes an item from the database
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
:help: Deletes an item from a shop
2019-01-02 23:17:53 +00:00
'''
player = get_player(discord_uuid=discord_uuid, mc_uuid=mc_uuid)
shop = get_location(player, shop_name, Shop)
ItemListing.objects.filter(item_name__iexact=item, shop=shop).delete()
return shop.json
@command("GET")
def me(discord_uuid=None, mc_uuid=None):
2019-01-02 23:17:53 +00:00
'''
:request: GET
:param discord_uuid: Discord UUID
:param mc_uuid: MC UUID
:return: Returns a list of all the locations owned by a user
:raises: NoLocationsInDatabase, PlayerNotFound
2019-01-02 23:17:53 +00:00
:help: Find all the locations in the database
'''
try:
player = get_player(discord_uuid=discord_uuid, mc_uuid=mc_uuid)
except Player.DoesNotExist:
raise PlayerNotFound
locations = Location.objects.filter(owner=player).all()
if len(locations) == 0:
raise NoLocationsInDatabase
return objects_list_to_json(locations)
@command("POST")
def restock(item_name, shop_name=None, discord_uuid=None, mc_uuid=None):
'''
:request: POST
:param item_name: Item to restock
:param shop_name: Shop the item is in, can be none if the only one location is owned by the user
:param discord_uuid: Discord UUID
:param mc_uuid: Minecraft UUID
:return: List of items updated
:raises: PlayerNotFound, LocationLookupError, EntryNameNotUniqueError, NoLocationsInDatabase
:help: Restocks items matching the item name in your shop
'''
owner = get_player(discord_uuid, mc_uuid)
shop = get_location(owner, shop_name, Shop)
items = ItemListing.objects.filter(item_name__iexact=item_name, shop=shop).all()
for item in items:
item.date_restocked = datetime.datetime.now()
item.save()
return objects_list_to_json(items)