Modül:SMAPI compatibility

Bu modül için bir belgeleme oluşturabilirsiniz: Modül:SMAPI compatibility/belge

local p = {}
local private = {}

-- whether to handle Stardew Valley beta fields (don't forget to comment or uncomment the beta fields in /doc)
local enableBeta = false

--##########
--## Public functions
--##########
-- Start a SMAPI compatibility table.
-- @test mw.log(p.header({}))
function p.header(frame)
  return
    private.style(frame)
    .. '<table class="wikitable sortable plainlinks" id="mod-list">'
    .. "<tr><th>Mod İsmi</th><th>Yapımcı</th><th><abbr title=\"Bir modun *uyumlu* olup olmamasını gösterir. SMAPI uyumluluğu ile alakası olmayan hataları da olabilir.\">Uyumluluk</abbr></th><th>Bozulduğu Sürüm</th><th>Kaynak</th><th>&nbsp;</th></tr>";
end

-- End a SMAPI compatibility table.
-- @test mw.log(p.footer())
function p.footer()
  return '</table>'
end

--- Render the SMAPI compatibility table based on JSON input.
-- @param frame The arguments passed to the script.
-- @test mw.log(p.table({ args = { [1]='[  { "name":   "24h Clock", "author": "Lajna", // test\n"id":  "Lajna.24hClock", "nexus": 1695, "github": "LajnaLegenden/Stardew_Valley_Mods", "brokeIn": "SMAPI 3.0", "unofficial": [ "1.0.1-unofficial.1-pathoschild", "https://community.playstarbound.com/threads/updating-mods-for-stardew-valley-1-3.142524/page-76#post-3342641" ] } ]' }}))
function p.table(frame)
  -- parse data
  local json = string.gsub(frame.args[1], '%s*//[^"\n]+', '')
  local data = mw.text.jsonDecode(json, mw.text.JSON_TRY_FIXING)

  -- start table
  local table = mw.html.create("table")
  table:addClass("wikitable sortable plainlinks")
  table:attr("id", "mod-list")
  table:wikitext("<tr><th>Mod İsmi</th><th>Yapımcı</th><th><abbr title=\"Bir modun *uyumlu* olup olmamasını gösterir. SMAPI uyumluluğu ile alakası olmayan hataları da olabilir.\">Uyumluluk</abbr></th><th>Bozulduğu Sürüm</th><th>Kaynak</th><th>&nbsp;</th></tr>")

  -- add mod rows
  for index,mod in pairs(data) do
    -- temporarily passthrough args to avoid duplicating code until we migrate fully to JSON
    -- (We need tostring on numeric fields since the previous code doesn't support numbers)
    mod.chucklefish = private.toSafeString(mod.chucklefish)
    mod.curse = private.toSafeString(mod.curse)
    mod.moddrop = private.toSafeString(mod.moddrop)
    mod.nexus = private.toSafeString(mod.nexus)

    local row = p.entry({ args = mod })
    table:node(row)
  end

  -- return output
  return private.style(frame) .. tostring(table)
end

--- Render a mod row in the SMAPI compatibility table.
-- @param frame The arguments passed to the script.
-- @test mw.log(p.entry({ args = { name="Content Patcher, ContentPatcher", author="Pathoschild, Pathos", id="Pathoschild.ContentPatcher, ContentPatcher", nexus="1915", chucklefish="4250", curse="309243,content-patcher", github="Pathoschild/StardewMods", warnings="warning A, warning B" }}))
function p.entry(frame)
  -- read input args
  local names      = private.parseCommaDelimited(frame.args["name"] or '')
  local authors    = private.parseCommaDelimited(frame.args["author"] or '')
  local ids        = private.parseCommaDelimited(frame.args["id"] or '')
  local nexusId    = private.emptyToNil(frame.args["nexus"])
  local github     = private.emptyToNil(frame.args["github"])
  local summary    = private.emptyToNil(frame.args["summary"])
  local brokeIn    = private.emptyToNil(frame.args["broke in"])

  local status     = private.emptyToNil(frame.args["status"])
  local unofficialVersion = private.emptyToNil(frame.args["unofficial version"])
  local unofficialUrl     = private.emptyToNil(frame.args["unofficial url"])
  local chucklefishId  = private.emptyToNil(frame.args["chucklefish"])
  local curseforgeId   = private.emptyToNil(frame.args["curse"])
  local moddropId      = private.emptyToNil(frame.args["moddrop"])
  local customUrl      = private.emptyToNil(frame.args["url"])
  local customSource   = private.emptyToNil(frame.args["source"])

  local warnings       = private.parseCommaDelimited(frame.args["warnings"])
  local devNote        = private.emptyToNil(frame.args["dev note"])
  local contentPackFor = private.emptyToNil(frame.args["content pack for"])

  local betaSummary = nil
  local betaBrokeIn = nil
  local betaStatus  = nil
  local betaUnofficialVersion = nil
  local betaUnofficialUrl     = nil
  if enableBeta then
    betaSummary = private.emptyToNil(frame.args["beta summary"])
    betaBrokeIn = private.emptyToNil(frame.args["beta broke in"])
    betaStatus  = private.emptyToNil(frame.args["beta status"])
    betaUnofficialVersion = private.emptyToNil(frame.args["beta unofficial version"])
    betaUnofficialUrl     = private.emptyToNil(frame.args["beta unofficial url"])
  end

  -- get source url
  local sourceUrl = customSource
  if github then
    sourceUrl = "https://github.com/" .. string.gsub(mw.uri.encode(github, "PATH"), "%%2F", "/")
  end
  local hasSource = sourceUrl ~= nil

  -- parse compatibility
  local compat = private.getCompatInfo(status, summary, brokeIn, unofficialVersion, unofficialUrl, hasSource)
  local betaCompat = nil
  if enableBeta and (betaStatus or betaBrokeIn or betaUnofficialUrl or betaUnofficialVersion) then
    betaCompat = private.getCompatInfo(betaStatus, betaSummary, betaBrokeIn, betaUnofficialVersion, betaUnofficialUrl, hasSource)
  end

  -- get main URL
  local url = nil
  if nexusId then
    url = "https://www.nexusmods.com/stardewvalley/mods/" .. mw.uri.encode(nexusId, "PATH")
  elseif moddropId then
    url = "https://www.moddrop.com/stardew-valley/mods/" .. mw.uri.encode(moddropId, "PATH")
  elseif curseforgeId then
    url = "https://www.curseforge.com/projects/" .. mw.uri.encode(curseforgeId, "PATH")
  elseif chucklefishId then
    url = "https://community.playstarbound.com/resources/" .. mw.uri.encode(chucklefishId, "PATH")
  elseif customUrl then
    url = customUrl
  elseif hasSource then
    url = sourceUrl
  end

  -- build HTML row
  local row = mw.html.create("tr")
  row:addClass("mod")
  row:attr("id", names[1] and mw.uri.anchorEncode(names[1]));
  row:attr("data-id", table.concat(ids, ","))
  row:attr("data-name", table.concat(names, ","))
  row:attr("data-author", table.concat(authors, ","))
  row:attr("data-cf-id", chucklefishId)
  row:attr("data-curseforge-id", curseforgeId)
  row:attr("data-moddrop-id", moddropId)
  row:attr("data-nexus-id", nexusId)
  row:attr("data-github", github)
  row:attr("data-custom-source", customSource)
  row:attr("data-url", url)
  row:attr("data-status", compat.status)
  row:attr("data-summary", compat.summary)
  row:attr("data-broke-in", compat.brokeIn)
  row:attr("data-unofficial-version", compat.unofficialVersion)
  row:attr("data-unofficial-url", compat.unofficialUrl)
  if enableBeta then
    row:attr("data-beta-status", betaCompat and betaCompat.status)
    row:attr("data-beta-summary", betaCompat and betaCompat.summary)
    row:attr("data-beta-broke-in", betaCompat and betaCompat.brokeIn)
    row:attr("data-beta-unofficial-version", betaCompat and betaCompat.unofficialVersion)
    row:attr("data-beta-unofficial-url", betaCompat and betaCompat.unofficialUrl)
  end
  row:attr("data-warnings", private.emptyToNil(table.concat(warnings, ",")))
  row:attr("data-content-pack-for", contentPackFor)
  row:attr("data-dev-note", devNote)
  row:newline()

  -- add name field
  do
    local field = mw.html.create("td")

    field:wikitext("[" .. (url or '') .. " " .. (names[1] or '') .. "]")

    local nameCount = #names
    if nameCount > 1 then
      field:wikitext("<br /><small>(aka ")
      for i = 1, nameCount do
        if i > 1 then
          field:wikitext(names[i])
          if i < nameCount then
            field:wikitext(", ")
          end
        end
      end
      field:wikitext(")</small>")
    end

    row:node(field)
    row:newline()
  end

  -- add author field
  do
    local field = mw.html.create("td")

    field:wikitext(authors[1])

    local authorCount = #authors
    if authorCount > 1 then
      field:wikitext("<br /><small>(aka ")
      for i = 1, authorCount do
        if i > 1 then
          field:wikitext(authors[i])
          if i < authorCount then
            field:wikitext(", ")
          end
        end
      end
      field:wikitext(")</small>")
    end

    row:node(field)
    row:newline()
  end

  -- add summary field
  do
    local field = mw.html.create("td")

    -- stable status
    field:wikitext("<span class=\"mod-summary\">" .. compat.summaryIcon .. " " .. compat.summary .. "</span>")
    if compat.status == "optional" then
      field:wikitext("<ref name=\"optional-update\" />")
    end

    -- beta status
    if betaCompat ~= nil then
      field:wikitext("<br />")
      field:wikitext("'''SDV 1.6 beta only:''' <span class=\"mod-beta-summary\">" .. betaCompat.summaryIcon .. " " .. betaCompat.summary .. "</span>")
      if betaCompat.status == "optional" then
        field:wikitext("<ref name=\"optional-update\" />")
      end
    end

    -- warnings
    do
      local warningCount = #warnings
      if warningCount > 0 then
        for i = 1, warningCount do
          field:wikitext("<br />⚠ " .. warnings[i])
        end
      end
    end

    row:node(field)
    row:newline()
  end

  -- add 'broke in' field
  do
    local field = mw.html.create("td")

    if betaCompat ~= nil and betaCompat.brokeIn ~= nil then
      field:wikitext(betaCompat.brokeIn)
    elseif compat.brokeIn ~= nil then
      field:wikitext(compat.brokeIn)
    end

    row:node(field)
    row:newline()
  end

  -- add 'source' field
  do
    if sourceUrl then
      row:wikitext("<td class=\"mod-source\">[" .. sourceUrl .. " kaynak]</td>")
    else
      row:wikitext("<td class=\"mod-source\"><span>closed source</span></td>")
    end
    row:newline()
  end

  -- add metadata field
  do
    local field = mw.html.create("td")
    field:attr("class", "mod-metadata")

    -- anchor
    field:wikitext("[[#" .. (names[1] or '') .. "|#]] ")

    -- dev note
    if devNote then
      local devNoteField = mw.html.create("abbr")
      devNoteField:attr("title", devNote)
      devNoteField:wikitext("[dev note]")

      field:node(devNoteField)
    end

    -- validation
    if #ids == 0 then
      field:wikitext("[⚠ no id] ")
    end

    row:node(field)
  end

  return tostring(row)
end


--##########
--## Private functions
--##########
-- Get the  tag for the module's stylesheet.
-- @param frame The arguments passed to the script.
function private.style(frame)
  if frame.extensionTag ~= nil then
    return frame:extensionTag('templatestyles', '', {src = 'Module:SMAPI compatibility/styles.css'})
  else
    return "" -- called from the debug console
  end
end

-- Get the normalised compatibility info for a mod.
-- @param status The specified status code. If nil or blank, it'll be derived from the other fields.
-- @param summary A human-readable summary of the compatibility info. If nil or blank, it'll be derived from the other fields.
-- @param brokeIn The SMAPI or Stardew Valley version which broke the mod, if applicable.
-- @param unofficialVersion The unofficial version which fixes compatibility, if applicable.
-- @param unofficialUrl The URL for the unofficial version which fixes compatibility, if applicable.
-- @param hasSource Whether the mod has public source code available.
function private.getCompatInfo(status, summary, brokeIn, unofficialVersion, unofficialUrl, hasSource)
  -- derive status
  if status == nil then
    if unofficialVersion ~= nil then
      status = "unofficial"
    elseif brokeIn ~= nil then
      status = "broken"
    else
      status = "ok"
    end
  end

  -- derive summary icon
  local summaryIcon = "✓"
  if status == "unofficial" or status == "workaround" then
    summaryIcon = "⚠"
  elseif status == "broken" and hasSource then
    summaryIcon = "↻"
  elseif status == "broken" or status == "obsolete" or status == "abandoned" then
    summaryIcon = "✖"
  end

  -- derive summary
  if not summary then
    if status == "ok" then
      summary = "use latest version."
    elseif status == "optional" then
      summary = "use optional download."
    elseif status == "unofficial" then
      summary = "bozuk, şunu kullanın: [" .. (unofficialUrl or "") .. " " .. "resmi olmayan sürüm]"
      if unofficialVersion ~= nil then
        summary = summary .. " (<small>" .. unofficialVersion .. "</small>)"
      end
      summary = summary .. "."
    elseif status == "workaround" then
      summary = "broken. '''error:''' should specify summary."
    elseif status == "broken" then
      if hasSource then
        summary = "broken, not updated yet."
      else
        summary = "broken, not open-source."
      end
    elseif status == "obsolete" then
      summary = "remove this mod (obsolete)."
    elseif status == "abandoned" then
      summary = "remove this mod (no longer maintained)."
    else
      summary = "'''error:''' unknown status '" .. status .. "'."
    end
  end

  return {
    status = status,
    summaryIcon = summaryIcon,
    summary = summary,
    brokeIn = brokeIn,
    unofficialVersion = unofficialVersion,
    unofficialUrl = unofficialUrl
  }
end

-- Call tostring() on the value if it's not nil, else return the value as-is.
-- @param value The value to format.
function private.toSafeString(value)
  if value then
    return tostring(value)
  else
    return nil
  end
end

-- Get a nil value if the specified value is an empty string, else return the value unchanged.
-- @param value The string to format.
function private.emptyToNil(value)
  if value ~= "" then
    return value
  else
    return nil
  end
end

-- Parse a comma-delimited string into an array.
-- @param value The string to parse.
function private.parseCommaDelimited(value)
  local result = {}

  if value ~= nil then
    local values = mw.text.split(value, ",", true)
    for i = 1, #values do
      v = mw.text.trim(values[i])
      if v ~= "" then
        table.insert(result, v)
      end
    end
  end

  return result
end

return p