Module:DropsLineRoatz

Documentation for this module may be created at Module:DropsLineRoatz/doc

local p = {}

local params = require('Module:Paramtest')
local lang = mw.language.getContentLanguage()
local coins_image = require('Module:Coins image')
local curr_image = require('Module:Currency Image')
local yesno = require('Module:Yesno')

local var = mw.ext.VariablesLua

-- precalculated cached data
local droppeditem_data = mw.loadJsonData('Module:DropsLine/itemData.json')
local geprices_data = mw.loadJsonData('Module:GEPrices/data.json')
local highalch_data = mw.loadJsonData('Module:GEHighAlchs/data.json')

local ptitle = mw.title.getCurrentTitle()
local ns = ptitle.nsText
local title = ptitle.fullText
local pgTitle = ptitle.text

local _noted = '&nbsp;<span class="dropsline-noted">(noted)</span>'

local coins_priceString = "%s Pkp"
local other_priceString = "%s Pkp"



--bg, txt, sort; acceptable non-quantity rarity names
local rarities = {
    always = { 'table-bg-blue', 1 },
    common = { 'table-bg-green', 16 },
    uncommon = { 'table-bg-yellow', 64 },
    rare = { 'table-bg-orange', 128 },
    ['very rare'] = { 'table-bg-red', 1024 },
    random = { 'table-bg-pink', 4096 },
    varies = { 'table-bg-pink', 4096 },
    once = { 'table-bg-pink', 65536 },
    conditional = { 'table-bg-pink', 65536 },
    _default = { 'table-bg-grey', 65536 }
}

-- colour-code
local rarities_class = {
    { 1, 'table-bg-blue' },
    { 1/25, 'table-bg-green' },
    { 1/99.99, 'table-bg-yellow' },
    { 1/999.99, 'table-bg-orange' },
    { 1/9999999, 'table-bg-red' }
}

function get_rarity_class(val)
    for i,v in ipairs(rarities_class) do
        curr = v
        if val >= v[1] then
            break
        end
    end
    return curr[2]
end

function commas(n)
    if tonumber(n) then
        return lang:formatNum(tonumber(n))
    else
        return n
    end
end

function expr(t)
    local noerr, val = pcall(mw.ext.ParserFunctions.expr, t)
    if noerr then
        return tonumber(val)
    else
        return false
    end
end
function sigfig(n, f)
    f = math.floor(f-1)
    if n == 0 then return 0 end
    local m = math.floor(math.log10(n))
    f = math.max(m, f)
    local v = n / (10^(m-f))
    v = math.floor(v + 0.5) * 10^(m-f)
    -- floor(x + 0.5) is standard rounding to one decimal place
    return v
end
p.sigfig = sigfig
p.commas = commas

function p.main(frame)
    local args = frame:getParent().args
    local frameArgs = frame.args

    -- Params and defaults
    local name,namenotes,
        quantity,quantitynotes,
        rarity,alt_rarity,alt_rarity_endash,
        raritynotes,citation,monVers = params.defaults{
                    {args.name or args.Name,'Item'},
                    {args.namenotes or args.Namenotes,''},
                    {args.quantity or args.Quantity,'Unknown'},
                    {args.quantitynotes or args.Quantitynotes,''},
                    {args.rarity or args.Rarity,'Unknown'},
                    {args.altrarity or args.AltRarity,''},
                    {args.altraritydash or args.AltRarityDash,''},
                    {args.raritynotes or args.Raritynotes,''},
                    {args.citation,''},
                    {args.version or args.Version,''},
        }
        raritynotes = raritynotes .. citation
    local rolls = tonumber(args.rolls or args.Rolls) or false
    local rollstext = ''
    if rolls then
        rollstext = rolls .. ' × '
    end
    local approx = yesno(args.approx or args.Approx or 'no', false)
    local isCoins = name:lower() == 'coins'
    local isNothing = name:lower() == 'nothing'
    local altname = params.default_to(args.alt or args.Alt,name)
    local gemwname = params.default_to(args.gemwname,name)
    local _smwname = params.default_to(args.smwname,gemwname)

    -- Remove version number from potions, enchanted jewellery, waterskins etc for smw
    local cleanedName
    local dropVers = ''
    if _smwname:match(' ?%(%d%)$') then
        cleanedName, dropVers = mw.ustring.match(gemwname, '^(.-) ?(%(%d%))$')
    elseif _smwname:match(' ?%(p%+*%)$') then
        cleanedName, dropVers = mw.ustring.match(_smwname, '^(.-) ?(%(p%+*%))$')
    elseif _smwname:match('%#') then
        cleanedName, dropVers = mw.ustring.match(_smwname, '^(.-)%#([%w%s%(%)]+)$')
    else
        cleanedName = mw.ustring.gsub(_smwname, ' %(%d%)$', '')
    end
    cleanedName = mw.text.trim(cleanedName)
    dropVers = mw.text.trim(dropVers)
    
    local smwname = cleanedName 
    if dropVers ~= '' then
        -- get subobject instead
        smwname = cleanedName..'#'..dropVers
    end
    
    local useSmw = true
    if params.has_content(args.smw) then
        useSmw = args.smw:lower() ~= 'no'
    end
    if params.has_content(frameArgs.smw) then
        useSmw = frameArgs.smw:lower() ~= 'no'
    end
    
    local rarity_value
    if rarities[rarity:lower()] then
        rarity = params.ucflc(rarity)
    else
        rarity_value = rarity:gsub(',','') --temp place to put this without overriding rarity
        local rv1, rv2 = string.match(rarity_value, '([%d%.]+)/([%d%.]+)')
        if rv1 and rv2 then
            rarity = commas(rv1) .. '/' .. commas(rv2)
            rarity_value = rv1/rv2
        else
            rarity_value = expr(rarity)
        end
    end

    local alt_rarity_value
    if rarities[alt_rarity:lower()] then
        alt_rarity = params.ucflc(alt_rarity)
    else
        alt_rarity_value = alt_rarity:gsub(',','') --temp place to put this without overriding rarity
        local rv1, rv2 = string.match(alt_rarity_value, '([%d%.]+)/([%d%.]+)')
        if rv1 and rv2 then
            alt_rarity = commas(rv1) .. '/' .. commas(rv2)
            alt_rarity_value = rv1/rv2
        else
            alt_rarity_value = expr(alt_rarity)
        end
    end

    quantity = mw.ustring.lower(quantity)
    local gemw = yesno(args.gemw or 'yes', false)
    local alch = yesno(args.alch or 'yes', false)

    -- Test for existance of alch value
    local hasmwalch, smwalchval
    local valueInfo = {
        alch = {
            has = false,
            value = 0
        },
        ge = {
            has = false,
            value = 0
        }
    }
    
    local cached_dropdata = droppeditem_data[smwname]
    local cached_alch = nil
    if type(cached_dropdata) == 'table' then
        if cached_dropdata[1] ~= nil and cached_dropdata[2] ~= nil then
            cached_alch = cached_dropdata[2]
        elseif cached_dropdata[1] ~= nil then
            cached_dropdata = cached_dropdata[1]
            if type(cached_dropdata) == 'boolean' then
            elseif type(cached_dropdata) == 'number' then
                cached_alch = cached_dropdata
            end
        end
    end
    
    local geprice_frombulk = geprices_data[gemwname]
    if not (type(geprice_frombulk) == 'number' and geprice_frombulk > 0) then
        geprice_frombulk = nil
    end
    
    if cached_alch == nil then
        cached_alch = highalch_data[gemwname]
        if not (type(cached_alch) == 'number' and cached_alch > -1) then
            cached_alch = nil
        end
    end
        
    if isNothing then
        gemw = false
    elseif isCoins then
        -- coins override
        valueInfo = {
            alch = {
                has = true,
                value = 1
            },
            ge = {
                has = true,
                value = 1
            }
        }
    else
        -- find alch price
        if alch then
            -- first check cache for alch value
            if cached_alch ~= nil then
                valueInfo.alch = {
                    has = true,
                    value = cached_alch
                }
            elseif gemw then
                -- then check gemw for alch value
                local hasgealch, gealchval = pcall(f_gealch,gemwname)
                if hasgealch then
                    if gealchval > -1 then
                        valueInfo.alch = {
                            has = true,
                            value = tonumber(gealchval)
                        }
                    end
                end
            end
            if not valueInfo.alch.has then
                -- failed to find alch in GEMW or is on the no-ge list/override
                -- lookup in SMW

                if smwret and smwret.alch ~= nil then
                    -- alch is defined, use it
                    valueInfo.alch = {
                        has = true,
                        value = smwret.alch
                    }
                else
                    alch = false
                end
            end
        end
        -- find ge price
        if gemw then
            if geprice_frombulk ~= nil then
                valueInfo.ge = {
                    has = true,
                    value = geprice_frombulk
                }
            else
                gemw = false
            end
        end
    end

    -- Use 'File:<name>.png' if no image param
    -- Use 'File:<image>' if image param; image param will include extension
    -- Special catch for coins
    local image,image_n
    if isCoins then
        image_n = coins_image(quantity)
    else
        image_n = params.default_to(args.image or args.Image, name .. '.png')
        image_n = mw.ustring.gsub(image_n, '#.+$', '.png')
    end
    if image_n:lower() == 'no' or params.is_empty(args.name or args.Name) then
        image = ''
    elseif isNothing then
        image = '[[File:Bank filler.png|link=Nothing|alt=This does not exist.]]'
    else
        image = mw.ustring.format('[[File:%s|alt=%s: %s drops %s with rarity %s%s in quantity %s]]', image_n, name, image_n, title, name, rollstext, rarity, quantity)
    end
    -- this only affects the JSON
    local rdt = string.lower(args.rdt or '') == 'yes'
        
    -- Table row
    local ret =  p._main(name,
            altname,namenotes,
            quantity,quantitynotes,
            rarity,rarity_value,alt_rarity,alt_rarity_endash,alt_rarity_value,
            raritynotes,image,
            valueInfo,gemw,alch,alt,
            isCoins,
            isNothing,
            frameArgs,monVers,
            cleanedName,dropVers,smwname,
            rdt,useSmw,
            approx,rolls)

    -- categories for mainspace
    local cats = ''
    local onMain = ns == '' or ns == 'RuneScape'
    if onMain and useSmw then
        cats = categories{name,quantity,rarity}
    end
    return ret..cats
end

-- main function to generate the row
function p._main(name,
        altname,namenotes,
        quantity,quantitynotes,
        rarity,rarity_value,alt_rarity,alt_rarity_endash,alt_rarity_value,
        raritynotes,image,
        valueInfo,gemw,alch,alt,
        isCoins,
        isNothing,
        frameArgs,monVers,
        cleanedName,dropVers,smwname,
        rdt,useSmw,
        approx, rolls)
    -- GE value, alch value, quantity cell contents
    local total, alchtotal, vsort, vasort, _h, _l
    quantity, _h, _l = qty(quantity, isNothing)
    if valueInfo.ge.has then
        total, vsort, totalavg = get_total(valueInfo.ge.value,_h,_l)
        total = total or 'Not sold'
    end

   
    -- value sorts
    if type(vsort) ~= 'number' then
        vsort = 0
    end
    if type(vasort) ~= 'number' then
        vasort = 0
    end

    -- quantity notes
    if #quantitynotes > 3 then
        quantity = quantity..quantitynotes
    end
    
    -- rarity cell contents
    local rare_class, rare_sort
    if rarity_value == undefined then
        rare_class, rare_sort = unpack(rarities[rarity:lower()] or rarities._default)
    elseif rarity_value == false then
        rare_class, rare_sort = unpack(rarities._default)
    else
        rare_sort = 1/rarity_value
        rare_class = get_rarity_class(rarity_value)
    end
    local rollstext = ''
    if rolls then
        rollstext = rolls .. ' × '
        rare_sort = rare_sort / rolls
        rare_class = get_rarity_class(math.min(1/rare_sort,0.99))
    end
    local tilde = ''
    if approx then
        tilde = '~'
    end
    local _r = rarity
    
    -- monster versions
    local hasRowwideVersion = false
    local tblVers = frameArgs.version
    local versionKey = 'DEFAULT'
    if params.has_content(tblVers) then
        -- versions applied to the entire table
       versionKey = tblVers
    end
    if params.has_content(monVers) then
        -- versions applied to this row
        versionKey = monVers
        hasRowwideVersion = true
    end

    local quantityClassOverride = isNothing and 'table-na' or nil
    -- Table row creation
    local ret = mw.html.create('tr')
            -- row-wide things
            :css('text-align','center')
            -- inventory image
            :tag('td')
                :addClass('inventory-image')
                :wikitext(image)
            :done()
            -- item name
            :tag('td')
                :css('text-align','left')
                :addClass('item-col')
                :wikitext(string.format('%s',name,altname,#namenotes > 3 and namenotes or ''))
            :done()
            -- quantity
            :tag('td')
                :addClass(quantityClassOverride)
                :attr('data-sort-value',_h)
                :wikitext(quantity)
            :done()
    
    -- rarity
    local rarity_cell = ret:tag('td')
    local rarity_span = rarity_cell:tag('span')
    rarity_span:wikitext(rollstext .. tilde .. rarity)
    rarity_cell:attr('data-sort-value',rare_sort)
                :addClass(rare_class)
    if type(rarity_value) == 'number' then
        rarity_cell:attr('title', rollstext .. tilde .. string.format('%.3g%%', 100 * rarity_value))
        rarity_span:attr({
            ['data-drop-fraction'] = rollstext .. tilde .. rarity,
            ['data-drop-oneover'] = rollstext .. tilde .. '1/' .. commas(sigfig(1/rarity_value, 4)),
            ['data-drop-percent'] = rollstext .. tilde .. sigfig(100 * rarity_value, 3),
            ['data-drop-permil'] = rollstext .. tilde .. sigfig(1000 * rarity_value, 3),
            ['data-drop-permyriad'] = rollstext .. tilde .. sigfig(10000 * rarity_value, 3),
        })
    end
    
    if alt_rarity ~= '' then
        if alt_rarity_endash  ~= '' then
            rarity_cell:tag('span'):wikitext('–')
        else
            rarity_cell:tag('span'):wikitext('; ')
        end
        local alt_rarity_span = rarity_cell:tag('span')
        alt_rarity_span:wikitext(alt_rarity)
        if type(alt_rarity_value) == 'number' then
            alt_rarity_span:attr({
                ['data-drop-fraction'] = alt_rarity,
                ['data-drop-oneover'] = '1/' .. commas(sigfig(1/alt_rarity_value, 3)),
                ['data-drop-percent'] = sigfig(100 * alt_rarity_value, 3),
                ['data-drop-permil'] = sigfig(1000 * alt_rarity_value, 3),
                ['data-drop-permyriad'] = sigfig(10000 * alt_rarity_value, 3),
            })
        end
    end

    if #raritynotes > 3 then
        rarity_cell:wikitext(raritynotes)
    end

    -- setup GE and alch cells
    local ge_td = ret:tag('td')
    

    -- common attributes
    ge_td   :attr('data-sort-value',vsort)
	    :addClass('ge-column')
	    :css({
	        ['text-align'] = 'right',
	        cursor = 'help'
	    })
   

    local ge_td_title, ge_td_content, alch_td_title, alch_td_content
    --Cases for the GE, alch values, and isNothing handling
    if isNothing then
        ge_td_content = 'N/A'
        ge_td_title = 'This does not exist.'
        ge_td:addClass('table-na'):css('text-decoration', 'underline dotted')
        alch_td_content = 'N/A'
        alch_td_title = 'This does not exist.'
        alch_td:addClass('table-na'):css('text-decoration', 'underline dotted')
    elseif isCoins then
        local coinsStr = lang:plural(vsort, '', 's')
        ge_td_title = mw.ustring.format(coins_priceString, total, coinsStr)
        ge_td_content = total
        alch_td_title = mw.ustring.format(coins_priceString, total, coinsStr)
        alch_td_content = total
    else
        if valueInfo.ge.has then
            ge_td_title = mw.ustring.format(other_priceString, commas(valueInfo.ge.value), lang:plural(valueInfo.ge.value, '', 's'))
            ge_td_content = total
        end
        if valueInfo.alch.has then
            alch_td_title = mw.ustring.format(other_priceString, commas(valueInfo.alch.value), lang:plural(valueInfo.alch.value, '', 's'))
            alch_td_content = alchtotal
        end
        
        if ge_td_content == nil then
            ge_td_content = 'Not sold'
            ge_td_title = 'This item cannot be traded on the Trading Post.'
            ge_td:addClass('table-na'):css('text-decoration', 'underline dotted')
        end

    end
    ge_td:wikitext(ge_td_content):attr('title', ge_td_title)

    -- SMW
    local onMain = ns == '' or ns == 'RuneScape'
    local unrecognizedDropVersionCategory = ''
    if onMain and useSmw and isNothing ~= true then
        local smw_sub = {}
        -- check if applies to all or only a version

      
        dropFrom = pgTitle
        if versionKey ~= 'DEFAULT' then
            dropFrom = pgTitle .. '#' .. versionKey
        end
        local droppedItemName = 'Dropped item'
        if rdt == true then
            droppedItemName = 'Dropped item from RDT'
        end
        

        local smw_json = {
            ['Dropped item']=smwname,
            ['Name Notes']=smwNameNote,
            ['Drop Quantity']=smwQuantity,
            ['Quantity High']=_h,
            ['Quantity Low']=_l,
            Rarity=rarity,
            ['Alt Rarity']=alt_rarity,
            ['Alt Rarity Dash'] = alt_rarity_endash,
            ['Rarity Notes']=smwRarityNote,
            ['Rolls']=smwRolls,
            ['Drop Value'] = valueInfo.alch.value or 0,
            ['Dropped from'] = dropFrom,
            ['Drop level'] = dropLevel,
            ['Drop type'] = dropType
        }
        local smw_sub = {
            [droppedItemName] = smwname,
            ['Dropped from'] = dropFrom,
            ["Drop JSON"] = mw.text.jsonEncode(smw_json)
        }
    end
    
    return tostring(ret) .. unrecognizedDropVersionCategory
end

function qty(quantity, isNothing)
    -- if no quantity is given, return unknown
    if string.lower(quantity) == 'varies' then
        return 'Varies'
    elseif isNothing then
        return 'N/A'
    elseif not quantity or string.lower(quantity) == 'unknown' then
        return 'Unknown'
    end
    -- en dashes are the proper dash for number ranges
    -- replace all hyphens and em dashes with en
    -- strip *all* whitespace
    -- change '(noted)' to '$n' for parsing
    quantity = mw.ustring.gsub(quantity,'[-—]','–')
        :gsub('%s','')
        :gsub('%(noted%)','$n')
    -- split list into table
    local vals = mw.text.split(quantity,'[,;]')
    local low = 2147483648
    local high = 0
    -- recreate the quantity string to ensure consistent formatting
    local numstr = {}
    for i, v in ipairs(vals) do
        local clean = v:gsub('$n','')
        -- if list element contains an en dash (indicating range)
        -- Find the smaller/larger number (just in case)
        -- Compare them to the current min/max
        -- put them in order with desired format
        if mw.ustring.find(v,'–') then
            local splitvals = mw.text.split(clean,'–')
            -- assume a is smaller, b is larger
            local a = tonumber(splitvals[1])
            local b = tonumber(splitvals[2])
            -- Just in case
            if a > b then
                a,b = b,a
            end
            if a < low then
                low = a
            end
            if b > high then
                high = b
            end
            local addx = commas(a)..'–'..commas(b)
            if v:find('$n') then
                addx = addx.._noted
            end
            table.insert(numstr,addx)
        else
            local a = tonumber(clean)
            if a < low then
                low = a
            end
            if a > high then 
                high = a
            end
            local addx = commas(a)
            if v:find('$n') then
                addx = addx.._noted
            end
            table.insert(numstr,addx)
        end
    end
    -- Add a line break if there are too many elements
    -- To keep the tables thin
    if #numstr > 11 then
        local mid = math.floor(#numstr/2)
        numstr[mid] = '<br/>'..numstr[mid]
    end
    -- To prevent any possible confusion with formatted numbers
    -- elements should be separated with semicolons followed by a space
    numstr = table.concat(numstr,'; ')
    -- If no numbers are found in the string, return unknown
    if not numstr:find('%d') then
        return 'Unknown', price
    end

    return numstr, high, low
end

function get_total(value,qhigh,qlow)
    -- if no alch value is given, return unknown
    if not value or string.lower(value) == 'unknown' then
        return value
    end
    -- if value is negative (from smw/ge) it cannot be alched
    if tonumber(value) and tonumber(value) < 0 then
        return false
    end
    -- if no numbers return not alchemisable
    if not tonumber(value) and not value:find('%d') then
        return false
    end

    -- en dashes are the proper dash for number ranges
    -- replace all hyphens and em dashes with en
    -- strip *all* whitespace
    value = mw.ustring.gsub(value,'[-—]','–')
        :gsub('%s','')
    -- split list into table
    local vals = mw.text.split(value,'[,;]')
    -- All value ranges will be a range
    -- e.g. if items valued at 100 coins are dropped in quantities of 1, 3, 5
    -- the value returned will be 100–500 rather than 100; 300; 500
    -- If low and high vars are the same in the end, only 1 value is displayed
    local low = 2147483648
    local high = 0
    -- recreate the alchval string to ensure consistent formatting
    for i, v in ipairs(vals) do
        local clean = v:gsub('$n','')
        -- if list element contains an en dash (indicating range)
        -- Find the smaller/larger number (just in case)
        -- Compare them to the current min/max
        -- put them in order with desired format
        if mw.ustring.find(v,'–') then
            local splitvals = mw.text.split(clean,'–')
            -- assume a is smaller, b is larger
            local a = tonumber(splitvals[1])
            local b = tonumber(splitvals[2])
            -- Just in case
            if a > b then
                a,b = b,a
            end
            if a < low then
                low = a
            end
            if b > high then
                high = b
            end
        else
            local a = tonumber(clean)
            if a < low then
                low = a
            end
            if a > high then 
                high = a
            end
        end
    end

    local valret, sort, avg
    if not qhigh or not qlow then
        sort = high
        avg = high
        valret = commas(high)
    else
        local lower = qlow * low
        local higher = qhigh * high
        if higher == lower then
            valret = commas(higher)
            avg = higher
        else
            valret = commas(lower)..'–'..commas(higher)
            avg = (lower+higher)/2
        end
        sort = higher
    end

    return valret, sort, avg
end

-- adding categories to mainspace
function categories(...)
    local name,quantity,rarity = unpack(...)
    local ret = ''
    name = name:lower()
    quantity = quantity:lower()
    if name:find('clue scroll') then
        ret = ret .. ''
    end
    if rarity == nil or rarity == '' or rarity:lower() == 'unknown' then
        ret = ret .. ''
    end
    if quantity:find('Unknown') then
        ret = ret .. ''
    end
    return ret
end

return p