Module:Infobox/Extension/PrizePool

Documentation

---

---
-- @Liquipedia
-- page=Module:Infobox/Extension/PrizePool
--
-- Please see https://github.com/Liquipedia/Lua-Modules to contribute
--

local Lua = require('Module:Lua')

local Class = Lua.import('Module:Class')
local Currency = Lua.import('Module:Currency')
local Logic = Lua.import('Module:Logic')
local Namespace = Lua.import('Module:Namespace')
local Math = Lua.import('Module:MathUtil')
local String = Lua.import('Module:StringUtils')
local Variables = Lua.import('Module:Variables')

local PrizePoolCurrency = {}

local NOW = os.date('!%F') --[[@as string]]
local USD = 'USD'
local CATEGRORY = '[[Category:Tournaments with invalid prize pool]]'

---@class InfoboxExtensionsPrizePoolArgs
---@field currency string?
---@field date string?
---@field displayRoundPrecision number|string|nil
---@field prizepool number|string|nil
---@field prizepoolusd number|string|nil
---@field rate string?
---@field setvariables boolean|string?
---@field text string?
---@field varRoundPrecision string?

---@param args InfoboxExtensionsPrizePoolArgs
---@return string|number|nil
function PrizePoolCurrency.display(args)
	args = args or {}
	local currency = string.upper(args.currency or USD)
	local date = PrizePoolCurrency._cleanDate(args.date or NOW)
	local text = args.text or 'Currency exchange rate taken from exchangerate.host'
	local prizepool = PrizePoolCurrency._cleanValue(args.prizepool)
	local prizepoolUsd = PrizePoolCurrency._cleanValue(args.prizepoolusd)
	local currencyRate = tonumber(args.rate)
	local setVariables = Logic.emptyOr(args.setvariables, true)
	local varRoundPrecision = tonumber(args.varRoundPrecision) or (args.varRoundPrecision == 'full' and -1) or 2
	local displayRoundPrecision = tonumber(args.displayRoundPrecision) or 0

	if (varRoundPrecision ~= -1) and (varRoundPrecision < displayRoundPrecision) then
		return PrizePoolCurrency._errorMessage('Display precision cannot be higher than Variable precious')
	end

	if not prizepool and not prizepoolUsd then
		if Namespace.isMain() then
			return (args.prizepool or args.prizepoolusd or '')
				.. '[[Category:Tournaments with invalid prize pool]]'
		else
			return args.prizepool or args.prizepoolusd or ''
		end
	end

	if not date then
		date = NOW
		mw.log('Infobox league: Invalid currency exchange date -> default date (' .. date .. ')')
	elseif date > NOW then
		date = NOW
	end

	if currency == USD and Logic.isEmpty(prizepoolUsd) then
		return PrizePoolCurrency._errorMessage('Need valid currency')
	elseif currency ~= USD then
		local errorMessage
		prizepool, prizepoolUsd, currencyRate, errorMessage = PrizePoolCurrency._exchange{
			currency = currency,
			currencyRate = currencyRate,
			date = date,
			prizepool = prizepool,
			prizepoolUsd = prizepoolUsd,
			setVariables = setVariables,
		}
		if errorMessage then
			return PrizePoolCurrency._errorMessage(errorMessage)
		end
	end

	if varRoundPrecision ~= -1 and prizepoolUsd then
		prizepoolUsd = Math.round(prizepoolUsd, varRoundPrecision)
	end

	if setVariables then
		if String.isNotEmpty(args.currency) then
			Variables.varDefine('tournament_currency', currency:upper())
		end

		Variables.varDefine('tournament_currency_date', date)
		Variables.varDefine('tournament_currency_text', text)
		Variables.varDefine('tournament_prizepoollocal', prizepool)
		Variables.varDefine('tournament_prizepoolusd', prizepoolUsd)

		-- legacy compatibility
		Variables.varDefine('tournament_currency_rate', currencyRate)
		Variables.varDefine('tournament_prizepool_local', prizepool)
		Variables.varDefine('tournament_prizepool_usd', prizepoolUsd)
		Variables.varDefine('currency', args.currency and currency)
		Variables.varDefine('currency date', date)
		Variables.varDefine('currency rate', currencyRate)
		Variables.varDefine('prizepool', prizepool)
		Variables.varDefine('prizepool usd', prizepoolUsd)
		Variables.varDefine('tournament_prizepool', prizepoolUsd)
	end

	local display = Currency.display(USD, prizepoolUsd, {
			setVariables = false,
			formatValue = true,
			formatPrecision = displayRoundPrecision
		})
	if Logic.isNotEmpty(prizepool) then
		display = Currency.display(currency, prizepool, {
				setVariables = true,
				formatValue = true,
				formatPrecision = displayRoundPrecision
			}) .. '<br>(≃ ' .. display .. ')'
	end

	return display
end

---@param props table
---@return number?
---@return number?
---@return number?
---@return string?
function PrizePoolCurrency._exchange(props)
	local prizepool = props.prizepool
	local prizepoolUsd = props.prizepoolUsd
	local currencyRate = Currency.getExchangeRate(props)

	if not currencyRate and Logic.isNumeric(prizepool) and Logic.isNumeric(prizepoolUsd) then
		currencyRate = tonumber(prizepoolUsd) / tonumber(prizepool)
	elseif not currencyRate then
		local errorMessage = 'Need valid currency and exchange date or exchange rate'
		return prizepool, prizepoolUsd, currencyRate, errorMessage
	end

	if Logic.isNumeric(prizepool) and currencyRate ~= math.huge and not Logic.isNumeric(prizepoolUsd) then
		prizepoolUsd = tonumber(prizepool) * currencyRate
	end

	if Logic.isNumeric(prizepool) then
		prizepool = tonumber(prizepool)
	end
	if Logic.isNumeric(prizepoolUsd) then
		prizepoolUsd = tonumber(prizepoolUsd)
	end

	return prizepool, prizepoolUsd, currencyRate, nil
end

---@param dateString string
---@return string?
function PrizePoolCurrency._cleanDate(dateString)
	dateString = string.gsub(dateString, '[^%d%-]', '')
	return string.match(dateString, '%d%d%d%d%-%d%d%-%d%d')
end

---@param valueString string|number|nil
---@return number?
function PrizePoolCurrency._cleanValue(valueString)
	valueString = string.gsub(valueString or '', '[^%d%.?]', '')
	return tonumber(valueString)
end

---@param message string
---@return string
function PrizePoolCurrency._errorMessage(message)
	local category = ''
	if Namespace.isMain() then
		category = CATEGRORY
	end
	return tostring(mw.html.create('strong')
		:addClass('error')
		:wikitext('Error: ')
		:wikitext(mw.text.nowiki(message))
		:wikitext(category))
end

return Class.export(PrizePoolCurrency, {exports = {'display'}})