LotJ Cargo Analysis Plugin for Mushclient

json.lua

--
-- json.lua
--
-- Copyright (c) 2020 rxi
--
-- Permission is hereby granted, free of charge, to any person obtaining a copy of
-- this software and associated documentation files (the "Software"), to deal in
-- the Software without restriction, including without limitation the rights to
-- use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
-- of the Software, and to permit persons to whom the Software is furnished to do
-- so, subject to the following conditions:
--
-- The above copyright notice and this permission notice shall be included in all
-- copies or substantial portions of the Software.
--
-- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-- SOFTWARE.
--

local json = { _version = "0.1.2" }

-------------------------------------------------------------------------------
-- Encode
-------------------------------------------------------------------------------

local encode

local escape_char_map = {
  [ "\\" ] = "\\",
  [ "\"" ] = "\"",
  [ "\b" ] = "b",
  [ "\f" ] = "f",
  [ "\n" ] = "n",
  [ "\r" ] = "r",
  [ "\t" ] = "t",
}

local escape_char_map_inv = { [ "/" ] = "/" }
for k, v in pairs(escape_char_map) do
  escape_char_map_inv[v] = k
end


local function escape_char(c)
  return "\\" .. (escape_char_map[c] or string.format("u%04x", c:byte()))
end


local function encode_nil(val)
  return "null"
end


local function encode_table(val, stack)
  local res = {}
  stack = stack or {}

  -- Circular reference?
  if stack[val] then error("circular reference") end

  stack[val] = true

  if rawget(val, 1) ~= nil or next(val) == nil then
    -- Treat as array -- check keys are valid and it is not sparse
    local n = 0
    for k in pairs(val) do
      if type(k) ~= "number" then
        error("invalid table: mixed or invalid key types")
      end
      n = n + 1
    end
    if n ~= #val then
      error("invalid table: sparse array")
    end
    -- Encode
    for i, v in ipairs(val) do
      table.insert(res, encode(v, stack))
    end
    stack[val] = nil
    return "[" .. table.concat(res, ",") .. "]"

  else
    -- Treat as an object
    for k, v in pairs(val) do
      if type(k) ~= "string" then
        error("invalid table: mixed or invalid key types")
      end
      table.insert(res, encode(k, stack) .. ":" .. encode(v, stack))
    end
    stack[val] = nil
    return "{" .. table.concat(res, ",") .. "}"
  end
end


local function encode_string(val)
  return '"' .. val:gsub('[%z\1-\31\\"]', escape_char) .. '"'
end


local function encode_number(val)
  -- Check for NaN, -inf and inf
  if val ~= val or val <= -math.huge or val >= math.huge then
    error("unexpected number value '" .. tostring(val) .. "'")
  end
  return string.format("%.14g", val)
end


local type_func_map = {
  [ "nil"     ] = encode_nil,
  [ "table"   ] = encode_table,
  [ "string"  ] = encode_string,
  [ "number"  ] = encode_number,
  [ "boolean" ] = tostring,
}


encode = function(val, stack)
  local t = type(val)
  local f = type_func_map[t]
  if f then
    return f(val, stack)
  end
  error("unexpected type '" .. t .. "'")
end


function json.encode(val)
  return ( encode(val) )
end


-------------------------------------------------------------------------------
-- Decode
-------------------------------------------------------------------------------

local parse

local function create_set(...)
  local res = {}
  for i = 1, select("#", ...) do
    res[ select(i, ...) ] = true
  end
  return res
end

local space_chars   = create_set(" ", "\t", "\r", "\n")
local delim_chars   = create_set(" ", "\t", "\r", "\n", "]", "}", ",")
local escape_chars  = create_set("\\", "/", '"', "b", "f", "n", "r", "t", "u")
local literals      = create_set("true", "false", "null")

local literal_map = {
  [ "true"  ] = true,
  [ "false" ] = false,
  [ "null"  ] = nil,
}


local function next_char(str, idx, set, negate)
  for i = idx, #str do
    if set[str:sub(i, i)] ~= negate then
      return i
    end
  end
  return #str + 1
end


local function decode_error(str, idx, msg)
  local line_count = 1
  local col_count = 1
  for i = 1, idx - 1 do
    col_count = col_count + 1
    if str:sub(i, i) == "\n" then
      line_count = line_count + 1
      col_count = 1
    end
  end
  error( string.format("%s at line %d col %d", msg, line_count, col_count) )
end


local function codepoint_to_utf8(n)
  -- http://scripts.sil.org/cms/scripts/page.php?site_id=nrsi&id=iws-appendixa
  local f = math.floor
  if n <= 0x7f then
    return string.char(n)
  elseif n <= 0x7ff then
    return string.char(f(n / 64) + 192, n % 64 + 128)
  elseif n <= 0xffff then
    return string.char(f(n / 4096) + 224, f(n % 4096 / 64) + 128, n % 64 + 128)
  elseif n <= 0x10ffff then
    return string.char(f(n / 262144) + 240, f(n % 262144 / 4096) + 128,
                       f(n % 4096 / 64) + 128, n % 64 + 128)
  end
  error( string.format("invalid unicode codepoint '%x'", n) )
end


local function parse_unicode_escape(s)
  local n1 = tonumber( s:sub(1, 4),  16 )
  local n2 = tonumber( s:sub(7, 10), 16 )
   -- Surrogate pair?
  if n2 then
    return codepoint_to_utf8((n1 - 0xd800) * 0x400 + (n2 - 0xdc00) + 0x10000)
  else
    return codepoint_to_utf8(n1)
  end
end


local function parse_string(str, i)
  local res = ""
  local j = i + 1
  local k = j

  while j <= #str do
    local x = str:byte(j)

    if x < 32 then
      decode_error(str, j, "control character in string")

    elseif x == 92 then -- `\`: Escape
      res = res .. str:sub(k, j - 1)
      j = j + 1
      local c = str:sub(j, j)
      if c == "u" then
        local hex = str:match("^[dD][89aAbB]%x%x\\u%x%x%x%x", j + 1)
                 or str:match("^%x%x%x%x", j + 1)
                 or decode_error(str, j - 1, "invalid unicode escape in string")
        res = res .. parse_unicode_escape(hex)
        j = j + #hex
      else
        if not escape_chars[c] then
          decode_error(str, j - 1, "invalid escape char '" .. c .. "' in string")
        end
        res = res .. escape_char_map_inv[c]
      end
      k = j + 1

    elseif x == 34 then -- `"`: End of string
      res = res .. str:sub(k, j - 1)
      return res, j + 1
    end

    j = j + 1
  end

  decode_error(str, i, "expected closing quote for string")
end


local function parse_number(str, i)
  local x = next_char(str, i, delim_chars)
  local s = str:sub(i, x - 1)
  local n = tonumber(s)
  if not n then
    decode_error(str, i, "invalid number '" .. s .. "'")
  end
  return n, x
end


local function parse_literal(str, i)
  local x = next_char(str, i, delim_chars)
  local word = str:sub(i, x - 1)
  if not literals[word] then
    decode_error(str, i, "invalid literal '" .. word .. "'")
  end
  return literal_map[word], x
end


local function parse_array(str, i)
  local res = {}
  local n = 1
  i = i + 1
  while 1 do
    local x
    i = next_char(str, i, space_chars, true)
    -- Empty / end of array?
    if str:sub(i, i) == "]" then
      i = i + 1
      break
    end
    -- Read token
    x, i = parse(str, i)
    res[n] = x
    n = n + 1
    -- Next token
    i = next_char(str, i, space_chars, true)
    local chr = str:sub(i, i)
    i = i + 1
    if chr == "]" then break end
    if chr ~= "," then decode_error(str, i, "expected ']' or ','") end
  end
  return res, i
end


local function parse_object(str, i)
  local res = {}
  i = i + 1
  while 1 do
    local key, val
    i = next_char(str, i, space_chars, true)
    -- Empty / end of object?
    if str:sub(i, i) == "}" then
      i = i + 1
      break
    end
    -- Read key
    if str:sub(i, i) ~= '"' then
      decode_error(str, i, "expected string for key")
    end
    key, i = parse(str, i)
    -- Read ':' delimiter
    i = next_char(str, i, space_chars, true)
    if str:sub(i, i) ~= ":" then
      decode_error(str, i, "expected ':' after key")
    end
    i = next_char(str, i + 1, space_chars, true)
    -- Read value
    val, i = parse(str, i)
    -- Set
    res[key] = val
    -- Next token
    i = next_char(str, i, space_chars, true)
    local chr = str:sub(i, i)
    i = i + 1
    if chr == "}" then break end
    if chr ~= "," then decode_error(str, i, "expected '}' or ','") end
  end
  return res, i
end


local char_func_map = {
  [ '"' ] = parse_string,
  [ "0" ] = parse_number,
  [ "1" ] = parse_number,
  [ "2" ] = parse_number,
  [ "3" ] = parse_number,
  [ "4" ] = parse_number,
  [ "5" ] = parse_number,
  [ "6" ] = parse_number,
  [ "7" ] = parse_number,
  [ "8" ] = parse_number,
  [ "9" ] = parse_number,
  [ "-" ] = parse_number,
  [ "t" ] = parse_literal,
  [ "f" ] = parse_literal,
  [ "n" ] = parse_literal,
  [ "[" ] = parse_array,
  [ "{" ] = parse_object,
}


parse = function(str, idx)
  local chr = str:sub(idx, idx)
  local f = char_func_map[chr]
  if f then
    return f(str, idx)
  end
  decode_error(str, idx, "unexpected character '" .. chr .. "'")
end


function json.decode(str)
  if type(str) ~= "string" then
    error("expected argument of type string, got " .. type(str))
  end
  local res, idx = parse(str, next_char(str, 1, space_chars, true))
  idx = next_char(str, idx, space_chars, true)
  if idx <= #str then
    decode_error(str, idx, "trailing garbage")
  end
  return res
end


return json

LotJ_Cargo_Scraper.xml

<?xml version="1.0" encoding="iso-8859-1" ?> 
<!DOCTYPE muclient>  
<muclient>

<plugin name="LotJ_Cargo_Scraper" author="@Daljo" id="e95b128bc53345a4a39b29b4" language="Lua" purpose="Scrape cargo data." requires="4.73" version="0.1" save_state="y">
<description trim="y">
<![CDATA[
-- Cargo Scraper / Exporter --

]]>
</description>
</plugin>

<triggers>
  <trigger
   enabled="n"
   name="scrapeStarsystems"
   lines_to_match="30"
   multi_line="y"
   regexp="y"
   match="Listing publicly known starsystems\:\n(?P&lt;systems&gt;(.{24} \( \-?\d+, \-?\d+ \)+\n)+)\n\Z"
   script="scrapeStarsystems"
  />
  <trigger
   enabled="n"
   name="scrapePlanets"
   lines_to_match="30"
   multi_line="y"
   regexp="y"
   match="Planet           Starsystem            Governed By               Notices\n(?P&lt;planets&gt;(.+\n)+)\nLegend\: \[UFG\: Up For Grabs\] \[FP\: Freeport\] \[E\: Embargo\] \[NP\: No\-PVP Planet\]\Z"
   script="scrapePlanets"
  />
  <trigger
   enabled="n"
   name="scrapePlanetResources"
   lines_to_match="15"
   multi_line="y"
   regexp="y"
   match="You use the datapad to lookup the information\.\n\-\-Planet Data\: \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\nPlanet\: (?P&lt;planet&gt;.+)\nStarsystem\: (?P&lt;system&gt;.+)\nGoverned By\: (?P&lt;government&gt;.+)\n(.+ is a freeport\.\n)?(?P&lt;resources&gt;(.{20} \( Price per unit\: \d+\.\d\d ?\)\n)+)\nUse \'SHOWPLANET \&lt;planet\&gt; RESOURCES \&lt;resource\&gt;\' for price history\.\Z"
   script="scrapePlanetResources"
  />
  <trigger
   enabled="n"
   name="scrapePlanetResourceHistory"
   lines_to_match="25"
   multi_line="y"
   regexp="y"
   match="Price history for (?P&lt;resource&gt;.+) as traded on (?P&lt;planet&gt;.+)\:\n\-\-\-\-\-\-\-\-\-\-\-\- Max Price\: +(?P&lt;max&gt;\d+\.\d\d) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\n((.{80}\n){16})\-\-\-\-\-\-\-\-\-\-\-\- Min Price\: +(?P&lt;min&gt;\d+\.\d\d) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\n \* Chart represents approximately two days of trading activity\.\Z"
   script="scrapePlanetResourceHistory"
  />
  <trigger
   enabled="y"
   name="showPlanetsForResource"
   regexp="y"
   match="^(?P&lt;resource&gt;.{20}) \( Price per unit\: (?P&lt;price&gt;\d+\.\d\d) ?\)$"
   script="showPlanetsForResource"
  />
  <trigger
   enabled="y"
   name="showPlanetsForResourceHistory"
   lines_to_match="25"
   multi_line="y"
   regexp="y"
   match="Price history for (?P&lt;resource&gt;.+) as traded on (?P&lt;planet&gt;.+)\:\n\-\-\-\-\-\-\-\-\-\-\-\- Max Price\: +(?P&lt;max&gt;\d+\.\d\d) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\n((.{80}\n){16})\-\-\-\-\-\-\-\-\-\-\-\- Min Price\: +(?P&lt;min&gt;\d+\.\d\d) \-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\-\n \* Chart represents approximately two days of trading activity\.\Z"
   script="showPlanetsForResourceHistory"
  />

</triggers>

<aliases>
	<alias match="scrapeCargo" ignore_case="y" enabled="y" script="scrapeCargo" />
	<alias match="dumpCargo" ignore_case="y" enabled="y" script="dumpCargo" />
    <alias match="resource *" ignore_case="y" enabled="y" script="resourceCheck" />
    <alias match="resources" ignore_case="y" enabled="y" script="resourceCheckAll" />
</aliases>

<script>
<![CDATA[

require "serialize"
json = dofile(GetPluginInfo(GetPluginID(), 20) .. "json.lua")

cargo = {}
cargo.planets = {}
cargo.resources = {}

systems = {}
oldcargo = {}
toScan = {}

loadstring( GetVariable('cargo') or '' ) ()

function doQueuedCommand()
	if ( #toScan > 0 ) then
        Note( #toScan .. ' items in command queue.' )
        Send( table.remove( toScan, 1 ) )
    else
        EnableTrigger( 'scrapeStarsystems', false )
        EnableTrigger( 'scrapePlanets', false )
        EnableTrigger( 'scrapePlanetResources', false )
        EnableTrigger( 'scrapePlanetResourceHistory', false )
        EnableTrigger( 'showPlanetsForResource', true )
        EnableTrigger( 'showPlanetsForResourceHistory', true )
        cargo.lastUpdated = os.time( os.date( "!*t" ) )
        
        Note( 'Scrape done! Type `dumpCargo` to collect the output.' )
	    SaveState()
    end
end -- doQueuedCommand

function scrapeCargo()
    EnableTrigger( 'scrapeStarsystems', true )
    EnableTrigger( 'scrapePlanets', true )
    EnableTrigger( 'scrapePlanetResources', true )
    EnableTrigger( 'scrapePlanetResourceHistory', true )
    EnableTrigger( 'showPlanetsForResource', false )
    EnableTrigger( 'showPlanetsForResourceHistory', false )

    oldcargo = cargo
    cargo = {}
    cargo.planets = {}
    cargo.resources = {}

    Send( 'starsystems' )
    Send( 'planets' )
end -- scrapeCargo

function scrapeStarsystems( name, output, wildcards )
    local system, x, y

    systems = {}

    for line in wildcards.systems:gmatch( "([^\r\n]+)" ) do
        system = string.gsub( line:sub( 1, 24 ), "^(.-)%s*$", "%1" )
        for x, y in string.gmatch( line:sub( 26 ), "%( (%-?%d+), (%-?%d+) %)" ) do
            systems[ system ] = {}
            systems[ system ].x = x
            systems[ system ].y = y
        end
    end
end -- scrapeStarsystems

function scrapePlanets( name, output, wildcards )
    local planets = wildcards.planets
    local planet, system, government, flags

    for line in planets:gmatch( "([^\r\n]+)" ) do
        planet = string.gsub( line:sub( 1, 16 ), "^(.-)%s*$", "%1" )
        system = string.gsub( line:sub( 18, 39 ), "^(.-)%s*$", "%1" )
        government = string.gsub( line:sub( 40, 65 ), "^(.-)%s*$", "%1" )
        flags = string.gsub( line:sub( 66 ), "%[(.*)%]", "%1" )

        cargo.planets[ planet ] = {}
        cargo.planets[ planet ].system = system
        cargo.planets[ planet ].government = government
        cargo.planets[ planet ].flags = flags

        if ( nil ~= systems[ system ] ) then
            cargo.planets[ planet ].systemXY = systems[ system ]
        end

        table.insert( toScan, 'showplanet "' .. planet .. '" resources' )
    end

    -- We've got a clear cargo list, let's try hitting the planets now.

    doQueuedCommand()
end -- scrapePlanets

function scrapePlanetResources( name, output, wildcards )
    -- cargo.planets[ wildcards.planet ] = {}
    -- cargo.planets[ wildcards.planet ].system = wildcards.system
    cargo.planets[ wildcards.planet ].resources = {}

    local resources = wildcards.resources
    local resource, price

    -- For each line in the scraped resources ...
    for i in resources:gmatch( "([^\r\n]+)" ) do
        resource = string.gsub( i:sub( 1, 20 ), "^(.-)%s*$", "%1" ):lower()
        price = string.gsub( i:sub( 21 ), "%( Price per unit: +([%d%.]+) ?%)$", "%1" )

        if ( cargo.resources[ resource ] == nil ) then
            cargo.resources[ resource ] = {}
        end
        cargo.resources[ resource ][ wildcards.planet ] = tonumber( price )

        cargo.planets[ wildcards.planet ].resources[ resource ] = {}
        cargo.planets[ wildcards.planet ].resources[ resource ].price = tonumber( price )
        -- Leaves availability for subsequently logging min and max.

        table.insert( toScan, 'showplanet "' .. wildcards.planet .. '" resources ' .. resource )
	end

    doQueuedCommand()
end -- scrapePlanetResources

function scrapePlanetResourceHistory( name, output, wildcards )
    cargo.planets[ wildcards.planet ].resources[ wildcards.resource ].min = tonumber( wildcards.min )
    cargo.planets[ wildcards.planet ].resources[ wildcards.resource ].max = tonumber( wildcards.max )

    doQueuedCommand()
end -- scrapePlanetResourceHistory

--
-- The aliases to output stuff!
--
function resourceCheck( name, line, args )
    if ( false == hazData() ) then
        return nil
    end

    local resource = args[1]:lower()
    resourceListOutput( resource )
    displayAgeOfData()
end -- resourceCheck

function resourceCheckAll()
    if ( false == hazData() ) then
        return nil
    end

    for resource, planets in pairs( cargo.resources ) do
        resourceListOutput( resource )
    end
    displayAgeOfData()
end -- resourceCheckAll

-- on `showplanet earth resources` output
function showPlanetsForResource( name, output, wildcards )
    if ( false == hazData() ) then
        return nil
    end

    local resource = string.gsub( wildcards.resource:lower(), "^(.-)%s*$", "%1" )
    local localprice = tonumber( wildcards.price )
    local currplanet
    for match in GetRecentLines( 20 ):gmatch( "Planet: (.-)[\r\n]" ) do
        currplanet = match
    end

    resourceListOutput( resource, currplanet, localprice )
end -- showPlanetsForResource

-- on `showplanet earth resources goods` output
function showPlanetsForResourceHistory( name, output, wildcards )
    if ( false == hazData() ) then
        return nil
    end

    local currplanet = wildcards.planet
    local resource = wildcards.resource:lower()

    resourceListOutput( resource, currplanet )
    displayAgeOfData()
end -- showPlanetsForResourceHistory

--
-- The common output function!
--
function spaceAndFormatNumber( num )
    if ( false == hazData() ) then
        return nil
    end

    local val = tonumber( num )
    return ( ( ( val < 10 ) and ( val >= 0 ) ) and ' ' or '' ) .. string.format( "%.2f", val )
end -- spaceAndFormatNumber

function resourceListOutput( resource, planetToSkip, localPrice )
    if ( nil ~= cargo.resources[ resource ] ) then
        ColourTell(
            'cyan', '', '  ',
            'cyan', '', ( ( nil ~= planetToSkip ) and 'Other Prices for ' or 'Prices for ' ),
            'white', '', resource,
            'gray', '', ': '
        )

        if ( nil ~= cargo.planets[ planetToSkip ] ) then
            Hyperlink(
                'showplanet "' .. planetToSkip .. '" resources ' .. resource,
                '(View ' .. resource .. ' history for ' .. planetToSkip .. ')',
                'View the ' .. resource .. ' price history for ' .. planetToSkip,
                'yellow',
                '',
                false
            )
        end

        Note( '' )

        local min, max, resMin, resMax, minVariance, maxVariance
        for planet, price in pairs( cargo.resources[ resource ] ) do
            min = tonumber( cargo.planets[ planet ].resources[ resource ].min )
            max = tonumber( cargo.planets[ planet ].resources[ resource ].max )

            if ( ( resMin == nil ) or ( resMin > price ) ) then
                resMin = price
            end

            if ( ( resMax == nil ) or ( resMax < price ) ) then
                resMax = price
            end

            if ( planet ~= planetToSkip ) then

                ColourTell(
                    'cyan', '', '    '
                )

                Hyperlink(
                    'showplanet "' .. planet .. '" resources',
                    planet,
                    'View all resources for ' .. planet,
                    'cyan',
                    '',
                    false
                )

                ColourTell(
                    'cyan', '', string.rep( ' ', 18 - #planet )
                )

                Hyperlink(
                    'showplanet "' .. planet .. '" resources ' .. resource,
                    spaceAndFormatNumber( price ),
                    'View the ' .. resource .. ' price history for ' .. planet,
                    'white',
                    '',
                    false
                )
                
                minVariance = ( price - min ) / price * 100
                maxVariance = ( max - price ) / price * 100
                ColourTell(
                    'gray', '', ' ( ',
                    'red', '', 'min ' .. spaceAndFormatNumber( min ),
                    ( minVariance < 0 ) and 'yellow' or 'darkred', '', ' [' .. spaceAndFormatNumber( minVariance ) .. '%]',
                    'gray', '', ' ',
                    'green', '', 'max ' .. spaceAndFormatNumber( max ),
                    ( maxVariance < 0 ) and 'yellow' or 'darkgreen', '', ' [' .. spaceAndFormatNumber( maxVariance ) .. '%]',
                    'gray', '', ' ) '
                )

                if ( nil ~= localPrice ) then
                    ColourNote(
                        ( ( price > localPrice ) and 'green' or 'red' ), '', string.format( "%.2f", math.abs( price - localPrice ) ),
                        'gray', '', '/unit ',
                        'blue', '', ( ( price > localPrice ) and ( planetToSkip .. ' to ' .. planet ) or ( planet .. ' to ' .. planetToSkip ) )
                    )
                else
                    Note( '' )
                end
            end
        end

        ColourNote(
            'gray', '', '    ',
            'gray', '', 'Margin: ',
            'white', '', ( resMax - resMin ),
            'darkgray', '', ' [',
            'gray', '', ' Min: ',
            'lightgray', '', resMin,
            'gray', '', ' Max: ',
            'lightgray', '', resMax,
            'darkgray', '', ' ]'
        )
    end
end -- resourceListOutput

function displayAgeOfData()
    local since = os.time( os.date( "!*t" ) ) - cargo.lastUpdated
    if ( since > 3600 ) then
        ColourTell(
            'cyan', '', 'It has been ',
            'white', '', math.floor( since / 3600 ) .. ' hours',
            'cyan', '', ' since the cargo data was last scraped.  '
        )

        Hyperlink(
            'scrapeCargo',
            'Update?',
            'Click to re-scrape the cargo numbers.',
            'green',
            '',
            false
        )

        Note( '' )
    end
end -- displayAgeOfData

function hazData()
    if ( nil == cargo.lastUpdated ) then
        ColourTell(
            'yellow', '', 'No cargo data found. '
        )

        Hyperlink(
            'scrapeCargo',
            'Click here or run `scrapeCargo` to fill the cache.',
            'Click to scrape the cargo numbers.',
            'yellow',
            '',
            false
        )

        Note( '' )
        return false
    end

    return true
end -- hazData

function OnPluginSaveState()
	SetVariable( 'cargo', serialize.save( 'cargo' ) )
end -- OnPluginSaveState

function dumpCargo()
    displayAgeOfData()
	SetClipboard( json.encode( cargo ) )
	ColourNote( 'white', '', 'The JSON for the cargo is now in your clipboard!' )
end -- dumpCargo

]]>
</script>

</muclient>