path: root/apt-panopticon-report-email-web.lua

#!/usr/bin/env luajit

local APT = require 'apt-panopticommon'
local D = APT.D
local I = APT.I
local T = APT.T
local W = APT.W
local E = APT.E
local C = APT.C
local arg, sendArgs = APT.parseArgs({...})


local results = {}
APT.mirrors = loadfile("results/mirrors.lua")()

local revDNS = function(dom, IP)
    if "deb.devuan.org" ~= dom then
	if nil ~= APT.mirrors["deb.devuan.org"] then
	    if nil ~= APT.mirrors["deb.devuan.org"].IPs["deb.roundr.devuan.org"][IP] then
		if APT.html then
		    return "<font color='purple'><b>DNS-RR</b></font>"
		else
		    return "DNS-RR"
		end
	    end
	end
    else
	for k, v in pairs(APT.mirrors) do
	    if "deb.devuan.org" ~= k then
		local IPs = v.IPs
		for i, u in pairs(IPs) do
		    if "table" == type(u) then
			for h, t in pairs(u) do
			    if IP == h then return k end
			end
		    else
			if IP == i then return k end
		    end
		end
	    end
	end
    end
    return ""
end

local faulty = ""
local status = function(host, results, typ)
    local result = ""
    local e = 0
    local w = 0
    local t = 0
    local s = nil ~= APT.mirrors[host].Protocols[typ]
    local to = results.timeout
    if not APT.search(APT.protocols, typ) then s = true end
    if nil ~= results[typ] then
	e = results[typ].errors
	w = results[typ].warnings
	t = results[typ].timeouts
	for k, v in pairs(results[typ]) do
	    if "table" == type(v) then
		if 0 <= v.errors   then e = e + v.errors   else to = true end
		if 0 <= v.warnings then w = w + v.warnings else to = true end
		if 0 <= v.timeouts then t = t + v.timeouts else to = true end
	    end
	end
    else
	for k, v in pairs(results) do
	    if "table" == type(v) then
		for i, u in pairs(v) do
		    if "table" == type(u) then
			if typ == i then
			    if 0 <= u.errors   then e = e + u.errors   end
			    if 0 <= u.warnings then w = w + u.warnings end
			    if 0 <= u.timeouts then t = t + u.timeouts end
			end
		    end
		end
	    end
	end
    end

    if to then
	result = "[TIMEOUT"
	if not s then result = result .. "*" end
	if APT.html then
	    if s then
		result = "[<font color='blue'><b>TIMEOUT</b></font>"
	    else
		result = "[<font color='darkblue'><b>TIMEOUT*</b></font>"
	    end
	end
    elseif 0 < e then
	result = "[FAILED"
	if not s then result = result .. "*" end
	if APT.html then
	    if s then
		result = "[<font color='red'><b>FAILED</b></font>"
	    else
		result = "[<font color='darkred'><b>FAILED*</b></font>"
	    end
	end
	if APT.html then
	    faulty = faulty .. host .. " (" .. typ .. ")<br>\n"
	else
	    faulty = faulty .. host .. " (" .. typ .. ")\n"
	end
    elseif 0 < t then
	result = "[timeout"
	if not s then result = result .. "*" end
	if APT.html then
	    if s then
		result = "[<font color='blue'><b>timeout</b></font>"
	    else
		result = "[<font color='darkblue'><b>timeout*</b></font>"
	    end
	end
	if APT.html then
	    faulty = faulty .. host .. " (" .. typ .. ")<br>\n"
	else
	    faulty = faulty .. host .. " (" .. typ .. ")\n"
	end
    else
	result = "[OK"
	if not s then result = result .. "*" end
	if APT.html then
	    if s then
		result = "[<font color='lime'><b>OK</b></font>"
	    else
		result = "[<font color='darkgreen'><b>OK*</b></font>"
	    end
	end
    end
    return result .. APT.plurals(e, w, t) .. "]"
end

local m = {}

local logCount = function(domain, ip)
    local nm = "LOG_" .. domain
    local log = ""
    local extra = ""
    if nil ~= ip then nm = nm .. "_" .. ip end
    nm = nm .. ".html"
    local rfile, e = io.open("results/" .. nm, "r")
    if nil ~= rfile then
	local errors = 0
	local warnings = 0
	local timeouts = 0
	for l in rfile:lines() do
	    if nil ~= l:match("><b>ERROR ") then errors = errors + 1 end
	    if nil ~= l:match("><b>WARNING ") then warnings = warnings + 1 end
	    if nil ~= l:match("><b>TIMEOUT ") then timeouts = timeouts + 1 end
	end
	rfile:close()
	if APT.html then
	    if nil == ip then
		log = "<a href='" .. nm .. "'>" .. domain .. "</a>"
	    else
		log = "<a href='" .. nm .. "'>" .. ip .. "</a>"
	    end
	end
	log = log .. APT.plurals(errors, warnings, timeouts)
    end
    return log
end


APT.html = false
local email, e = io.open("results/Report-email.txt", "w+")
if nil == email then C("opening mirrors file - " .. e) else
    email:write( "Dear Mirror Admins,\n\n" ..
		"This is the status of the mirror servers in the Devuan package mirror network.\n\n" ..
		"EXPERIMENTAL CODE - double check all results you see here, and read the logs if it's important." ..
		"The full list of Devuan package mirrors is available at the URL:\n\n" ..
		" https://pkgmaster.devuan.org/mirror_list.txt\n\n" ..
		'Please contact "mirrors@devuan.org" if any of the information \nin the file above needs to be amended. \n\n' ..
		"The full results of the mirror checking is available at the URL:\n\n" ..
		" https://sledjhamr.org/apt-panopticon/results/Report-web.html\n\n" ..
		"Due to the nature of the tests, some errors or warnings will be \ncounted several times.  " ..
		"Refer to the logs on the web page for details.\n\n" ..
		"Please see below the current status of the Devuan Package Mirror \nnetwork:\n\n" ..
		"==== package mirror status " .. os.date("!%Y-%m-%d %H:%M") .. " GMT ====\n" ..
		"[skip] means that the test hasn't been written yet.\n\n")
    for k, v in APT.orderedPairs(APT.mirrors) do
	email:write(k .. "....\n")
	local results = APT.collateAll('results', k)
	local ftp	= "[skip]"
	local http	= status(k, results, "http")
	local https	= status(k, results, "https")
	local rsync	= "[skip]"
	local dns	= ""
	local protocol	= status(k, results, "Protocol")
	local sanity	= status(k, results, "URLSanity")
	local integrity = status(k, results, "Integrity")
	local updated	= status(k, results, "Updated")

	-- DNS-RR test.
	if ("deb.devuan.org" ~= k) and (nil ~= APT.mirrors["deb.devuan.org"]) then
	    for l, w in pairs(APT.mirrors[k].IPs) do
		if type(w) == "table" then
		    for i, u in pairs(w) do
			if nil ~= APT.mirrors["deb.devuan.org"].IPs["deb.roundr.devuan.org"][i] then
			    local log = logCount("deb.devuan.org", i)
			    if "" ~= log then
				if "" == dns then dns = " " else dns = dns .. "  " end
				dns = dns .. logCount("deb.devuan.org", i)
			    else
				if "" == dns then dns = " " else dns = dns .. "  " end
				dns = dns .. i
			    end
			end
		    end
		else
		    if nil ~= APT.mirrors["deb.devuan.org"].IPs["deb.roundr.devuan.org"][l] then
			local log = logCount("deb.devuan.org", l)
			if "" ~= log then
			    if "" == dns then dns = " " else dns = dns .. "  " end
			    dns = dns .. log
			else
			    if "" == dns then dns = " " else dns = dns .. "  " end
			    dns = dns .. l
			end
		    end
		end
	    end
	    if "" == dns then dns = "[no]" end
	    dns = " DNS-RR: " .. dns
	end

	email:write(	"      ftp: " .. ftp .. " http: " .. http .. " https: " .. https .." rsync: " .. rsync .. "\n" ..
			"     " .. dns .. "\n" ..
			"      Protocol: " .. protocol .. " URL-sanity: " .. sanity .. " Integrity: " .. integrity .. "\n" ..
			"      Updated: " .. updated .. "\n")
    end
    email:write( "\n==== faulty mirrors: ====\n" .. faulty)
    email:write( "\n-------------------------\n\n" ..
		"* This means that this protocol isn't actually supported, but the test was run ayway.\n\n" ..
		"Thanks for your precious help in ensuring that Devuan GNU+Linux \nremains a universal, stable, dependable, free operating system.\n\n" ..
		"You can get the source code from https://sledjhamr.org/cgit/apt-panopticon/about/ .\n\n" ..
		"Love\n\n" ..
		"The Dev1Devs\n\n")
    email:close()
end


local colours = 
{
    'f0000080',
    '0f000080',
    '00f00080',
    '000f0080',
    '0000f080',
    '00000f80',
    '80000080',
    '08000080',
    '00800080',
    '00080080',
    '00008080',
    '00000880',
    'ff000080',
    '0ff00080',
    '00ff0080',
    '000ff080',
    '0000ff80',
    '88000080',
    '08800080',
    '00880080',
    '00088080',
    '00008880',
}
local g = {}
local count = 0
for k, v in APT.orderedPairs(mirrors) do
    if 'pkgmaster.devuan.org' ~= k then count = count + 1 end
end
for i = 1, count do
end

count = 1
for k, v in APT.orderedPairs(mirrors) do
    if 'deb.devuan.org' ~= k then
	local c = colours[count]
	local name = string.format('%32s', k)
	if 'pkgmaster.devuan.org' == k then c = 'ffffff' end
	table.insert(g, 'DEF:speedn' .. count .. '=rrd/' .. k .. '/Speed/Speed.rrd:max:MIN')
	table.insert(g, 'DEF:speedx' .. count .. '=rrd/' .. k .. '/Speed/Speed.rrd:max:MAX')
	table.insert(g, 'DEF:speeda' .. count .. '=rrd/' .. k .. '/Speed/Speed.rrd:max:AVERAGE')
	table.insert(g, 'DEF:speedl' .. count .. '=rrd/' .. k .. '/Speed/Speed.rrd:max:LAST')
	table.insert(g, 'VDEF:vspeedn' .. count .. '=speedn' .. count .. ',AVERAGE')
	table.insert(g, 'VDEF:vspeedx' .. count .. '=speedx' .. count .. ',AVERAGE')
	table.insert(g, 'VDEF:vspeeda' .. count .. '=speeda' .. count .. ',AVERAGE')
	table.insert(g, 'VDEF:vspeedl' .. count .. '=speedl' .. count .. ',AVERAGE')
	table.insert(g, 'LINE2:speedx' .. count .. '#' .. c .. ':' .. name .. ' ')
	table.insert(g, 'GPRINT:vspeedn' .. count .. ':Min %5.1lf%s,')
	table.insert(g, 'GPRINT:vspeeda' .. count .. ':Avg %5.1lf%s,')
	table.insert(g, 'GPRINT:vspeedx' .. count .. ':Max %5.1lf%s,')
	table.insert(g, 'GPRINT:vspeedl' .. count .. ':Last %5.1lf%s\\l')
	count = count + 1
    end
end
APT.rrd.graph('results/speed.png', '--start', 'now-2w', '--end', 'now', '-t', 'Speed, rough maximum guess.', '-v', 'bytes per second', '-w', '900', '-h', '400', '-Z',
'-c', 'BACK#000000', '-c', 'CANVAS#000000', '-c', 'FONT#FFFFFF', '-c', 'AXIS#FFFFFF', '-c', 'FRAME#FFFFFF', '-c', 'ARROW#FFFFFF',
unpack(g))



results = {}
m = {}
faulty = ""
APT.html = true
local web, e = io.open("results/Report-web.html", "w+")
if nil == web then C("opening mirrors file - " .. e) else
    web:write(  "<html><head><title>apt-panopticon results</title>\n")
    if 0 < tonumber(APT.options.refresh.value) then
	web:write('<meta http-equiv="refresh" content="' .. APT.options.refresh.value .. '">\n')
    end
    web:write(  '</head><body bgcolor="black" text="white">' ..
		"<h1>Welcome to the apt-panopticon results page.</h1>\n" ..
		"<p>Here the apt-panopticon system probes into every nook and cranny of the Devuan apt package mirror system, trying to live up to it's name.</p>" ..
		"<p>This is the status of the mirror servers in the Devuan package mirror network.</p>\n")
    if 0 < tonumber(APT.options.refresh.value) then
    web:write(  '<p>This page will refresh every ' .. (APT.options.refresh.value / 60) .. ' minutes.</p>')
    end 
    web:write(  "<p><font style='background-color:red; color:black'>EXPERIMENTAL CODE - double check all results you see here, and read the logs if it's important.</font></p>" ..
		"<p>The full list of Devuan package mirrors is available at the URL: " ..
		"<a href='https://pkgmaster.devuan.org/mirror_list.txt'>https://pkgmaster.devuan.org/mirror_list.txt</a></p>\n" ..
		"<p>Due to the nature of the tests, some errors or warnings will be counted several times. &nbsp; " ..
		"The links in the table and DNS list go to the detailed testing logs.</p>\n\n" ..
		"<hr>\n<h2>==== package mirror status " .. os.date("!%Y-%m-%d %H:%M") .. " GMT ====</h2>\n" ..

		"<p>[<font color='red'><b>FAILED</b></font>] or [<font color='lime'><b>OK</b></font>]" ..
		" means the tested thing is supported for that mirror.</p>\n" ..
		"<p>[<font color='darkred'><b>FAILED*</b></font>] or [<font color='darkgreen'><b>OK*</b></font>]" ..
		" means the tested thing is unsupported for that mirror, but might have been tested anyway.</p>\n" ..
		"<p>[<font color='blue'><b>timeout</b></font>] or [<font color='darkblue'><b>timeout</b></font>]" ..
		" means the mirror had some timeouts, and tests where not yet aborted.  The darker colour means unsupported by the mirror, but tested anyway.</p>" ..
		"<p>[<font color='blue'><b>TIMEOUT</b></font>] or [<font color='darkblue'><b>TIMEOUT</b></font>]" ..
		" means the mirror had too many timeouts, and tests where aborted, so there is no result for this test.</p>" ..
		"<p>NOTE: timeouts may be due to a problem on the testing computer.</p>" ..
		"<p>The DNS round robin (DNS-RR) column shows the IPs for that mirror, or [<font color='grey'><b>no</b></font>] if it isn't part of the DNS-RR. &nbsp; " ..
		"The IPs link to the testing log for that IP accessed via the DNS-RR. &nbsp; " ..
		"deb.devuan.org is the DNS-RR itself, so it doesn't get tested directly.</p>\n" ..
		"<p>The time in the Updated column is how often the mirror updates itself.</p>" ..
		"<p>Mirrors with a <font style='background-color:dimgrey'>grey background</font> are not active (though may be usable as part of the DNS-RR).</p>\n" ..
		"<p>[<font color='grey'><b>skip</b></font>] means that the test hasn't been written yet.</p>\n" ..
		"<table>\n<tr><th></th><th>FTP</th><th>HTTP</th><th>HTTPS</th><th>RSYNC</th><th>DNS round robin</th>" ..
		"<th>Protocol</th><th>URL sanity</th><th>Integrity</th><th>Updated</th><th colspan='2'>Speed range</th></tr>\n"
		)
    for k, v in APT.orderedPairs(APT.mirrors) do
	local results = APT.collateAll('results', k)
	local active = ""
	if "yes" == v.Active then
	    web:write("     <tr><th>" .. k .. "</th> ")
	else
	    if nil == v.Active then active = 'nil' else active = v.Active end
	    web:write("     <tr style='background-color:dimgrey'><th>" .. k .. "</th> ")
	end
	local ftp	= "[<font color='grey'><b>skip</b></font>]"
	local http	= status(k, results, "http")
	local https	= status(k, results, "https")
	local rsync	= "[<font color='grey'><b>skip</b></font>]"
	local dns	= ""
	local protocol	= status(k, results, "Protocol")
	local sanity	= status(k, results, "URLSanity")
	local integrity = status(k, results, "Integrity")
	local updated	= status(k, results, "Updated")
	local rate = v.Rate
	if nil ~= rate then updated = updated .. ' ' .. rate end
	local min	= tonumber(results.speed.min)
	local max	= tonumber(results.speed.max)
	local spd	= ''

	-- DNS-RR test.
	if ("deb.devuan.org" ~= k) and (nil ~= APT.mirrors["deb.devuan.org"]) then
	    for l, w in pairs(APT.mirrors[k].IPs) do
		if type(w) == "table" then
		    for i, u in pairs(w) do
			if nil ~= APT.mirrors["deb.devuan.org"].IPs["deb.roundr.devuan.org"][i] then
			    local log = logCount("deb.devuan.org", i)
			    if "" ~= log then
				if "" == dns then dns = " " else dns = dns .. " &nbsp; " end
				dns = dns .. logCount("deb.devuan.org", i)
			    else
				if "" == dns then dns = " " else dns = dns .. " &nbsp; " end
				dns = dns .. "<font color='maroon'><b>" .. i .. "</b></font>"
			    end
			end
		    end
		else
		    if nil ~= APT.mirrors["deb.devuan.org"].IPs["deb.roundr.devuan.org"][l] then
			local log = logCount("deb.devuan.org", l)
			if "" ~= log then
			    if "" == dns then dns = " " else dns = dns .. " &nbsp; " end
			    dns = dns .. log
			else
			    if "" == dns then dns = " " else dns = dns .. " &nbsp; " end
			    dns = dns .. "<font color='maroon'><b>" .. l .. "</b></font>"
			end
		    end
		end
	    end
	    if "" == dns then dns = "[<font color='grey'><b>no</b></font>]" end

	    if 0 == max then
		spd = '<td></td><td></td>'
	    else
		spd = string.format('<td align="right">%d -></td><td align="right">%d</td>', min, max)
	    end
	end

	web:write("<td>" .. ftp .. "&nbsp;</td><td>" .. http .. "&nbsp;</td><td>" .. https .. "&nbsp;</td><td>" .. rsync .. "&nbsp;</td><td>" .. dns ..
		    "&nbsp;</td><td>" .. protocol .. "&nbsp;</td><td>" .. sanity ..
		    "&nbsp;</td><td>" .. integrity .. "&nbsp;</td><td>" .. updated .. "&nbsp;</td>" .. spd .. "</tr>\n")
	if "" ~= active then
	    web:write("<tr><td style='background-color:dimgrey'>" .. active .. "</td></tr>\n")
	end
    end
    web:write( "</table>\n<br>\n<h2>==== faulty mirrors: ====</h2>\n" .. faulty)
    web:write( "<br>\n<br>\n<h2>==== DNS and logs: ====</h2>\n")

    for k, v in pairs(APT.mirrors) do
	local log = k
	local n = {}
	log = logCount(k)
	APT.mirrors[k].Protocols = nil
	APT.mirrors[k].FQDN = nil
	APT.mirrors[k].Active = nil
	APT.mirrors[k].Rate = nil
	APT.mirrors[k].BaseURL = nil
	APT.mirrors[k].Country = nil
	APT.mirrors[k].Bandwidth = nil
	for l, w in pairs(APT.mirrors[k].IPs) do
	    if type(w) == "table" then
		n[l] = {}
		for i, u in pairs(w) do
		    local log = logCount(k, i)
		    if "" == log then n[l][i] = u else n[l][log .. " " .. revDNS(k, i)] = u end
		end
	    else
		local log = logCount(k, l)
		if "" == log then n[l] = w else n[log .. " " .. revDNS(k, l)] = w end
	    end
	end
	m[log .. " DNS entries -"] = n
    end
    web:write(	"<p>This lists each mirror, and the DNS entries for that mirror. &nbsp; " ..
		"The links point to the testing log files for " .. logCount("apt-panopticon") .. " for each domain name / IP combination that was tested. &nbsp; " ..
		"If a mirror has a CNAME, that CNAME is listed along with that CNAMEs DNS entries. &nbsp; " ..
		"deb.devuan.org is the DNS round robin, which points to the mirrors that are part of the DNS-RR. &nbsp; " ..
		"If an IP is part of the DNS-RR, it is marked with '<font color='purple'><b>DNS-RR</b></font>' &nbsp; " ..
		"pkgmaster.devuan.org is the master mirror, all the others sync to it. &nbsp; " ..
		"</p>\n"
		)
    web:write(APT.dumpTableHTML(m, "", ""))
    web:write( "\n<br>\n<br>\n<h2>==== graphs: ====</h2>\n" ..
		"<img src='speed.png'>\n<br>\n<p><a href='../apt-panopticon_cgp/'>More graphs.</a> with greater detail.</p><hr>\n\n" ..
		"<p>The <a href='Report-email.txt'>email report</a>. &nbsp; " ..
		"All <a href='../results'>the logs and other output</a>. &nbsp; " ..
		"You can get the <a href='https://sledjhamr.org/cgit/apt-panopticon/about/'>source code here</a>.</p>\n")
    local status, whn = APT.execute('TZ="GMT" ls -l1 --time-style="+%s" results/stamp | cut -d " " -f 6-6')
    web:write(  "<p>This run took " .. (os.time() - tonumber("0" .. whn:sub(2, -2))) .. " seconds.</p>" ..
		"\n</body></html>\n")
    web:close()
end