Skip to content

Commit

Permalink
[Economy] Detect max balance and prevent OverflowError (#2211)
Browse files Browse the repository at this point in the history 
Resolves #2091.

This doesn't fix every OverflowError with MongoDB; but at least the seemingly easiest one to achieve with core cogs.

Signed-off-by: Toby Harradine <[email protected]>
  • Loading branch information
@Tobotimus
Tobotimus authored Oct 15, 2018
1 parent aff62a8 commit d2d2683
Show file tree
Hide file tree
Showing 3 changed files with 105 additions and 24 deletions.
84 changes: 61 additions & 23 deletions redbot/cogs/economy/economy.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
import discord

from redbot.cogs.bank import check_global_setting_guildowner, check_global_setting_admin
from redbot.core import Config, bank, commands
from redbot.core import Config, bank, commands, errors
from redbot.core.i18n import Translator, cog_i18n
from redbot.core.utils.chat_formatting import box
from redbot.core.utils.menus import menu, DEFAULT_CONTROLS
Expand Down Expand Up @@ -171,7 +171,7 @@ async def transfer(self, ctx: commands.Context, to: discord.Member, amount: int)

try:
await bank.transfer_credits(from_, to, amount)
except ValueError as e:
except (ValueError, errors.BalanceTooHigh) as e:
return await ctx.send(str(e))

await ctx.send(
Expand All @@ -195,36 +195,35 @@ async def _set(self, ctx: commands.Context, to: discord.Member, creds: SetParser
author = ctx.author
currency = await bank.get_currency_name(ctx.guild)

if creds.operation == "deposit":
await bank.deposit_credits(to, creds.sum)
await ctx.send(
_("{author} added {num} {currency} to {user}'s account.").format(
try:
if creds.operation == "deposit":
await bank.deposit_credits(to, creds.sum)
msg = _("{author} added {num} {currency} to {user}'s account.").format(
author=author.display_name,
num=creds.sum,
currency=currency,
user=to.display_name,
)
)
elif creds.operation == "withdraw":
await bank.withdraw_credits(to, creds.sum)
await ctx.send(
_("{author} removed {num} {currency} from {user}'s account.").format(
elif creds.operation == "withdraw":
await bank.withdraw_credits(to, creds.sum)
msg = _("{author} removed {num} {currency} from {user}'s account.").format(
author=author.display_name,
num=creds.sum,
currency=currency,
user=to.display_name,
)
)
else:
await bank.set_balance(to, creds.sum)
await ctx.send(
_("{author} set {user}'s account balance to {num} {currency}.").format(
else:
await bank.set_balance(to, creds.sum)
msg = _("{author} set {user}'s account balance to {num} {currency}.").format(
author=author.display_name,
num=creds.sum,
currency=currency,
user=to.display_name,
)
)
except (ValueError, errors.BalanceTooHigh) as e:
await ctx.send(str(e))
else:
await ctx.send(msg)

@_bank.command()
@check_global_setting_guildowner()
Expand Down Expand Up @@ -260,7 +259,18 @@ async def payday(self, ctx: commands.Context):
if await bank.is_global(): # Role payouts will not be used
next_payday = await self.config.user(author).next_payday()
if cur_time >= next_payday:
await bank.deposit_credits(author, await self.config.PAYDAY_CREDITS())
try:
await bank.deposit_credits(author, await self.config.PAYDAY_CREDITS())
except errors.BalanceTooHigh as exc:
await bank.set_balance(author, exc.max_balance)
await ctx.send(
_(
"You've reached the maximum amount of {currency}! (**{balance:,}**) "
"Please spend some more \N{GRIMACING FACE}\n\n"
"You currently have {new_balance} {currency}."
).format(currency=credits_name, new_balance=exc.max_balance)
)
return
next_payday = cur_time + await self.config.PAYDAY_TIME()
await self.config.user(author).next_payday.set(next_payday)

Expand Down Expand Up @@ -297,14 +307,25 @@ async def payday(self, ctx: commands.Context):
).PAYDAY_CREDITS() # Nice variable name
if role_credits > credit_amount:
credit_amount = role_credits
await bank.deposit_credits(author, credit_amount)
try:
await bank.deposit_credits(author, credit_amount)
except errors.BalanceTooHigh as exc:
await bank.set_balance(author, exc.max_balance)
await ctx.send(
_(
"You've reached the maximum amount of {currency}! "
"Please spend some more \N{GRIMACING FACE}\n\n"
"You currently have {new_balance} {currency}."
).format(currency=credits_name, new_balance=exc.max_balance)
)
return
next_payday = cur_time + await self.config.guild(guild).PAYDAY_TIME()
await self.config.member(author).next_payday.set(next_payday)
pos = await bank.get_leaderboard_position(author)
await ctx.send(
_(
"{author.mention} Here, take some {currency}. "
"Enjoy! (+{amount} {new_balance}!)\n\n"
"Enjoy! (+{amount} {currency}!)\n\n"
"You currently have {new_balance} {currency}.\n\n"
"You are currently #{pos} on the global leaderboard!"
).format(
Expand Down Expand Up @@ -444,7 +465,21 @@ async def slot_machine(author, channel, bid):
then = await bank.get_balance(author)
pay = payout["payout"](bid)
now = then - bid + pay
await bank.set_balance(author, now)
try:
await bank.set_balance(author, now)
except errors.BalanceTooHigh as exc:
await bank.set_balance(author, exc.max_balance)
await channel.send(
_(
"You've reached the maximum amount of {currency}! "
"Please spend some more \N{GRIMACING FACE}\n{old_balance} -> {new_balance}!"
).format(
currency=await bank.get_currency_name(getattr(channel, "guild", None)),
old_balance=then,
new_balance=exc.max_balance,
)
)
return
phrase = T_(payout["phrase"])
else:
then = await bank.get_balance(author)
Expand Down Expand Up @@ -561,10 +596,10 @@ async def paydaytime(self, ctx: commands.Context, seconds: int):
async def paydayamount(self, ctx: commands.Context, creds: int):
"""Set the amount earned each payday."""
guild = ctx.guild
credits_name = await bank.get_currency_name(guild)
if creds <= 0:
if creds <= 0 or creds > bank.MAX_BALANCE:
await ctx.send(_("Har har so funny."))
return
credits_name = await bank.get_currency_name(guild)
if await bank.is_global():
await self.config.PAYDAY_CREDITS.set(creds)
else:
Expand All @@ -579,6 +614,9 @@ async def paydayamount(self, ctx: commands.Context, creds: int):
async def rolepaydayamount(self, ctx: commands.Context, role: discord.Role, creds: int):
"""Set the amount earned each payday for a role."""
guild = ctx.guild
if creds <= 0 or creds > bank.MAX_BALANCE:
await ctx.send(_("Har har so funny."))
return
credits_name = await bank.get_currency_name(guild)
if await bank.is_global():
await ctx.send(_("The bank must be per-server for per-role paydays to work."))
Expand Down
17 changes: 16 additions & 1 deletion redbot/core/bank.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@

import discord

from redbot.core import Config
from . import Config, errors

__all__ = [
"MAX_BALANCE",
"Account",
"get_balance",
"set_balance",
Expand All @@ -26,6 +27,8 @@
"set_default_balance",
]

MAX_BALANCE = 2 ** 63 - 1

_DEFAULT_GLOBAL = {
"is_global": False,
"bank_name": "Twentysix bank",
Expand Down Expand Up @@ -170,10 +173,22 @@ async def set_balance(member: discord.Member, amount: int) -> int:
------
ValueError
If attempting to set the balance to a negative number.
BalanceTooHigh
If attempting to set the balance to a value greater than
``bank.MAX_BALANCE``
"""
if amount < 0:
raise ValueError("Not allowed to have negative balance.")
if amount > MAX_BALANCE:
currency = (
await get_currency_name()
if await is_global()
else await get_currency_name(member.guild)
)
raise errors.BalanceTooHigh(
user=member.display_name, max_balance=MAX_BALANCE, currency_name=currency
)
if await is_global():
group = _conf.user(member)
else:
Expand Down
28 changes: 28 additions & 0 deletions redbot/core/errors.py
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
import importlib.machinery
from typing import Optional

import discord

from .i18n import Translator

_ = Translator(__name__, __file__)


class RedError(Exception):
Expand All @@ -14,3 +21,24 @@ def __init__(self, spec: importlib.machinery.ModuleSpec, *args, **kwargs):

def __str__(self) -> str:
return f"There is already a package named {self.spec.name.split('.')[-1]} loaded"


class BankError(RedError):
"""Base error class for bank-related errors."""


class BalanceTooHigh(BankError, OverflowError):
"""Raised when trying to set a user's balance to higher than the maximum."""

def __init__(
self, user: discord.abc.User, max_balance: int, currency_name: str, *args, **kwargs
):
super().__init__(*args, **kwargs)
self.user = user
self.max_balance = max_balance
self.currency_name = currency_name

def __str__(self) -> str:
return _("{user}'s balance cannot rise above {max:,} {currency}.").format(
user=self.user, max=self.max_balance, currency=self.currency_name
)

0 comments on commit d2d2683

Please sign in to comment.