--- Add gopher:// scheme support.
--
-- The module adds support for Gopher network with basic rendering.
--
-- @module gopher
-- @author Ygrex <ygrex@ygrex.ru>

local lousy = require("lousy")
local settings = require("settings")
local theme = lousy.theme.get()

local socket_loaded, socket = pcall(require, "socket")
if not socket_loaded then
    msg.error("Failed to load LuaSocket: %s", tostring(socket))
    return
end

local error_page = require("error_page")
local webview = require("webview")

local _M = {}

luakit.register_scheme("gopher")

-- menu entry representing the type of the item
local function gophertype_to_text(gophertype)
    return ({
        -- canonical types according to rfc1436
        ["0"] = 'TXT ', -- text file
        ["1"] = 'DIR ', -- submenu
        ["2"] = 'CCSO', -- CCSO Nameserver, not really supported type
     -- ["3"] = 'ERR ", -- Error
        ["4"] = 'HEX ', -- BinHex-encoded
        ["5"] = 'DOS ', -- DOS file
        ["6"] = 'UENC', -- uuencoded data
        ["7"] = 'FIND', -- search
        ["8"] = 'TEL ', -- telnet
        ["9"] = 'BIN ', -- binary
     -- ["+"] = 'SRV ', -- redundant server
        ["T"] = 'TEL ', -- telnet
        ["g"] = 'GIF ', -- gif
        ["I"] = 'IMG ', -- image
        -- well known types
        ["h"] = 'HTML', -- html
        -- additional types seen in the wild
        ["d"] = 'DOC ', -- any document format
        ["M"] = 'MBOX', -- mbox
        ["p"] = 'IMG ', -- image
        ["P"] = 'PDF ', -- binary pdf document
        ["s"] = 'SND ', -- sound
    })[gophertype] or "??? "
end

--- Parse Gopher menu entry.
-- @tparam string line Literal string line representing a Gopher menu entry.
-- @tparam table url Parsed URL structure from parse_url().
-- @treturn table Structure representing the menu entry tokens.
_M.parse_gopher_line = function(line, url)
    local ret = {
        line = line,
        item_type = nil,
        display_string = nil,
        selector = nil,
        host = nil,
        port = nil,
        scheme = nil,
    }
    if not line:match("\t") then
        ret.item_type = "i"
        ret.display_string = line
        return ret
    end
    ret.item_type = line:sub(1, 1)
    local fields = {};
    for chunk in line:sub(2):gmatch("([^\t]*)\t?") do
        fields[#fields + 1] = chunk
    end
    ret.display_string = fields[1] or ""
    ret.selector = fields[2] or ""
    ret.host = fields[3] or url.host
    ret.port = (fields[4] or tostring(url.port)):gsub("[^0-9]", "")
    ret.scheme = "gopher"
    if ret.item_type == "T" or ret.item_type == "8" then
        ret.scheme = "telnet"
    end
    return ret
end
local parse_gopher_line = _M.parse_gopher_line

--- Evaluate hyperlink for a gopher menu entry.
-- @tparam table entry Gopher menu entry structure from parse_gopher_line().
-- @treturn string Valid URL for the menu entry.
_M.href_source = function(entry)
    local src = entry.selector:match("^/?URL:(.+)$")
    if not src then
        if entry.scheme == "telnet" then
            src = ([[telnet://%s:%s/]]):format(entry.host, entry.port)
        else
            src = ([[%s://%s:%s/%s%s]]):format(
                entry.scheme,
                entry.host,
                entry.port,
                entry.item_type,
                luakit.uri_encode(entry.selector, "/")
            )
        end
    end
    return src
end
local href_source = _M.href_source

-- chop periods per RFC1436
local function chop_periods(data)
    -- trailing \n is always expected
    if data:sub(-1) ~= "\n" then
        data = data .. "\n"
    end
    -- the trailing period on a line itself is chopped off
    local dot_pos, _, prefix = data:find("(\r?\n)%.\r?\n$")
    if dot_pos then
        data = data:sub(1, dot_pos - 1 + #prefix)
    elseif data:match("^%.\r?\n$") then
        -- even if there is nothing else
        data = "\n"
    end
    -- on every line any leading period is chopped off
    data = data:gsub("(\r?\n)%.", "%1")
    if data:sub(1, 1) == "." then
        -- and on the first line
        data = data:sub(2)
    end
    return data
end

local function stylesheet()
    local bg, fg, link;
    if not (theme.gopher_dark and theme.gopher_light) then
        msg.warn("Cannot find gopher styles. Please sync your theme.lua. Loading defaults.")
        bg = "#E8E8E8"; fg = "#17181C"; link = "#03678D"
    else
        if settings.get_setting("application.prefer_dark_mode") then
            bg   = theme.gopher_dark.bg;
            fg   = theme.gopher_dark.fg;
            link = theme.gopher_dark.link
        else
            bg   = theme.gopher_light.bg;
            fg   = theme.gopher_light.fg;
            link = theme.gopher_light.link
        end
    end

    return [[
        <style>
            body, pre, input, { font-family: monospace; }
            body {
                background-color: ]] .. bg .. [[;
                color: ]] .. fg .. [[;
                max-width: 80ex;
                margin: 0;
                padding: 5px;
            }
            a, a:active, a:visited {
                text-decoration: none;
                color: ]] .. link .. [[;
            }
        </style>
    ]];
end;

local function text_to_html(data, url)
    return [[
        <html>
        <head>
            <title>]] .. url.title .. [[</title>
            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
            ]] .. stylesheet() .. [[
        </head>
        <body>
            <pre style="word-wrap: break-word; white-space: pre-wrap;">
]] .. lousy.util.escape(chop_periods(data)) .. [[</pre>
        </body>
        </html>
    ]];
end;

local function menu_entry_input(anchor_name)
    return [[<br>    | <input type="text" style="width:100%"
        onKeyPress="runSearch(this, event, ']] .. anchor_name .. [[')"/>]]
end

local function menu_html_header(title)
    return [[
        <head>
            <title>]] .. title .. [[</title>
            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
            ]] .. stylesheet() .. [[
            <script type="text/javascript">
                function runSearch(input, event, anchor_id) {
                    event = event || window.event;
                    if (event.keyCode != 13)
                        return true;
                    var anchor = document.getElementById(anchor_id);
                    window.location = anchor.href + '%09' + input.value;
                    return false;
                }
            </script>
        </head>]]
end

-- present Gopher menu as an HTML page
local function menu_to_html(data, url)
    data = chop_periods(data)
    local html = {
        "<html>",
        menu_html_header(url.title),
        "<body><pre>"
    };
    local line_num = 0
    for line in data:gmatch("(.-)\r?\n") do
        line_num = line_num + 1
        local entry = parse_gopher_line(line, url)
        if entry.item_type == "i" then
            html[#html + 1] = ("    | %s"):format(lousy.util.escape(entry.display_string))
        else
            local src = href_source(entry)
            local type_text = gophertype_to_text(entry.item_type) .. "+"
            local anchor_name = "anchor_" .. tostring(line_num)
            local input = menu_entry_input(anchor_name)
            if entry.item_type ~= "7" then input = "" end
            html[#html + 1] = ([[%s <a href="%s" id="%s">%s</a>%s]]):format(
                type_text,
                src,
                anchor_name,
                lousy.util.escape(entry.display_string),
                input
            )
        end
    end
    html[#html + 1] = "</pre></body></html>"
    return table.concat(html, "\n")
end

--- Guess the image MIME type by a filename suffix.
-- @tparam string ext The filename suffix (without leading dot).
-- @treturn string Appropriate MIME type.
_M.image_mime_type = function(ext)
    return ({
        gif  = "image/gif",
        jpeg = "image/jpeg",
        jpg  = "image/jpeg",
        pcx  = "image/pcx",
        png  = "image/png",
        svg  = "image/svg+xml",
        svgz = "image/svg+xml",
        tif  = "image/tiff",
        tiff = "image/tiff",
        bmp  = "image/x-ms-bmp",
        pbm  = "image/x-portable-bitmap",
        pgm  = "image/x-portable-graymap",
        ppm  = "image/x-portable-pixmap",
        xwd  = "image/x-xwindowdump",
    })[tostring(ext):lower()] or "application/octet-stream"
end
local image_mime_type = _M.image_mime_type

-- convert raw data received from server into the browser's representation
local function data_to_browser(data, url)
    local mime = "text/html"
    local converted = data
    if url.gophertype == "1" or url.gophertype == "7" then
        converted = menu_to_html(data, url)
    elseif url.gophertype == "0" then
        converted = text_to_html(data, url)
    elseif url.gophertype == "4" then
        mime = "application/mac-binhex40"
    elseif url.gophertype == "5" then
        mime = "application/octet-stream"
    elseif url.gophertype == "6" then
        mime = "text/x-uuencode"
    elseif url.gophertype == "9" then
        mime = "application/octet-stream"
    elseif url.gophertype == "d" then
        mime = "application/octet-stream"
    elseif url.gophertype == "g" then
        mime = "image/gif"
    elseif url.gophertype == "M" then
        mime = "application/mbox"
    elseif url.gophertype == "p" then
        mime = "image/png"
    elseif url.gophertype == "P" then
        mime = "application/pdf"
    elseif url.gophertype == "I" then
        mime = image_mime_type(url.selector:match("%.(.-)$"))
    elseif url.gophertype ~= "h" then
        msg.error("Unsupported Gopher item type: '%s'", url.gophertype)
        error("Unsupported Gopher item type", 0)
    end
    return converted, mime
end

--- Parse Gopher URL.
-- @tparam string url Gopher URL starting with gopher://
-- @treturn table A structure representing the URL tokens.
_M.parse_url = function(url)
    local host_port, gopher_path = url:match("gopher://([^/]+)/?(.-)$")
    if not host_port then return end
    local host = host_port
    local port = host_port:match(":([0-9]+)$")
    if port then
        host = host_port:match("^(.+):[0-9]+$")
        port = tonumber(port)
    else
        port = 70
    end
    local gophertype = gopher_path:sub(1, 1)
    if not gophertype or #gophertype < 1 then
        gophertype = "1"
    end
    local selector, after_selector = gopher_path:sub(2):match("^(.-)%%09(.*)$")
    if not selector then
        selector = gopher_path:sub(2)
    end
    selector = luakit.uri_decode(selector)
    local search, gopher_plus_string
    if after_selector then
        search, gopher_plus_string = after_selector:match("^(.-)%%09(.*)$")
        if not search then
            search = after_selector
        end
        search = luakit.uri_decode(search)
        if gopher_plus_string then
            gopher_plus_string = luakit.uri_decode(gopher_plus_string)
        end
    end
    local title = selector
    if title:sub(1, 1) ~= "/" then
        title = "/" .. title
    end
    title = ("/%s%s"):format(gophertype, title)
    return {
        host = host,
        port = port,
        gopher_path = gopher_path,
        gophertype = gophertype,
        selector = selector,
        search = search,
        gopher_plus_string = gopher_plus_string,
        title = title,
    }
end
local parse_url = _M.parse_url

-- establish connection, wait for the socket to become writable
local function _net_establish_connection(host, port)
    local conn = socket.tcp()
    conn:settimeout(0)
    local res, err, _ = conn:connect(host, port)
    if not res then
        if err ~= "timeout" then
            return error("Socket error: " .. tostring(err), 0)
        end
        while true do
            if coroutine.yield() then
                conn:shutdown("both")
                return
            end
            _, res, err = socket.select(nil, {conn}, 0)
            if (res or {})[conn] then
                break
            end
            if err ~= "timeout" then
                return error("Socket error: " .. tostring(err), 0)
            end
        end
    end
    return conn
end

-- non-blocking sending
local function _net_send_message(conn, message)
    local res, err, last
    local sent = 0
    while true do
        res, err, last = conn:send(message, sent + 1)
        if res == #message then
            break
        end
        if not res then
            if err ~= "timeout" then
                return error("Socket error: " .. tostring(err), 0)
            end
        end
        sent = res or last
        if coroutine.yield() then
            conn:shutdown("both")
            return
        end
    end
    return sent
end

-- non-blocking reading
local function _net_read_data(conn)
    local chunks = {}
    while true do
        local res, err, last = conn:receive("*a")
        if err == "closed" then
            res = last
        end
        if res then
            chunks[#chunks + 1] = res
            break
        end
        if err ~= "timeout" then
            return error("Socket error: " .. tostring(err), 0)
        end
        chunks[#chunks + 1] = last
        if coroutine.yield() then
            conn:shutdown("both")
            return
        end
    end
    return table.concat(chunks)
end

-- perform network transaction in non-blocking mode
local function net_request(host, port, message)
    local conn = _net_establish_connection(host, port)
    if not conn then return end
    local sent = _net_send_message(conn, message)
    if not sent then return end
    local data = _net_read_data(conn)
    conn:shutdown("both")
    return data
end

local load_timer = timer{interval = 50}
local loads = {}
load_timer:add_signal("timeout", function ()
    if not next(loads) then load_timer:stop() end
end)

-- remove a background loader
local function remove_loader(v, loader)
    local corou = loads[v]
    if corou then
        loads[v] = nil
        coroutine.resume(corou, "stop")
    end
    if loader then
        load_timer:remove_signal("timeout", loader)
    end
end

-- forward request to error_page module
local function show_error_page(v, request, reason)
    pcall(error_page.show_error_page, v, {
        heading = "Gopher Site Loading Failed",
        content = reason,
        request = request
    })
end

-- finish request with appropriate page content
local function send_data_to_browser(v, request, data, url)
    local res, html, mime = pcall(data_to_browser, data, url)
    if res then
        request:finish(html, mime)
    else
        show_error_page(v, request, html)
    end
end

webview.add_signal("init", function (view)
    view:add_signal("scheme-request::gopher", function (v, uri, request)
        local url = assert(parse_url(uri))
        local message = table.concat({url.selector, url.search}, "\t")
        local net = coroutine.create(function ()
            return net_request(url.host, url.port, message .. "\r\n")
        end)
        if not load_timer.started then load_timer:start() end
        loads[v] = net
        local function loader ()
            if loads[v] ~= net then
                remove_loader(v, loader)
                return
            end
            local alive, _ = pcall(function() return v.is_loading end)
            local status, res = coroutine.resume(net, not alive)
            if not status then
                if not request.finished then
                    show_error_page(v, request, res)
                end
                return remove_loader(v, loader)
            end
            if not res then
                return
            end
            if not request.finished then
                send_data_to_browser(v, request, res, url)
            end
            remove_loader(v, loader)
        end
        load_timer:add_signal("timeout", loader)
    end)
    view:add_signal("load-status", function (v, status)
            if status == "failed" then
                remove_loader(v)
            end
    end)
end)

return _M

-- vim: et:sw=4:ts=8:sts=4:tw=80