mcbot/cmds/rfc.lua
author Mikael Berthe <mikael@lilotux.net>
Tue, 27 Nov 2012 16:26:04 +0100
changeset 66 d9c00a9fe9d5
parent 34 ca01a1696cff
child 67 5c756a9d7d8c
permissions -rw-r--r--
Add notices before public release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     1
#! /usr/bin/env lua
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     2
66
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     3
--  This module is part of the McBot / mcabbot project
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     4
--  RFC index parser
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     5
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     6
-- Copyright (C) 2010-2012 Mikael Berthe <mikael@lilotux.net>
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     7
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     8
-- This program is free software; you can redistribute it and/or modify
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
     9
-- it under the terms of the GNU General Public License as published by
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
    10
-- the Free Software Foundation; either version 2 of the License, or (at
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
    11
-- your option) any later version.
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
    12
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
    13
-- Please check the license in the COPYING file at the root of the tree.
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 34
diff changeset
    14
--
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
-- TXT index database, retrieved from
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
-- <ftp://ftp.rfc-editor.org/in-notes/rfc-index.txt>
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
local indexfname = "/home/mikael/.mcabber/lua/mcbot/rfc-index.txt"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
32
96bce644394a Add URLs to RFCs
Mikael Berthe <mikael@lilotux.net>
parents: 31
diff changeset
    20
local urlbase = "http://tools.ietf.org/html/rfc"
96bce644394a Add URLs to RFCs
Mikael Berthe <mikael@lilotux.net>
parents: 31
diff changeset
    21
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
local rfc = { ["desc"] = "Search RFC database" }
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    24
local rfcdb = {}
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    25
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
local function parse_file (fname)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
    local fh = io.open(fname)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
34
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
    29
    if not fh then return nil, "Cannot open RFC database" end
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    31
    -- Skip header
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    32
    local count = 0
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    33
    for line in fh:lines() do
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    34
        count = count + 1
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
        if line:match("^%s+RFC INDEX%s*$") and count > 30 then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    36
            break
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    37
        end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    38
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    39
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    40
    -- Skip 2 more lines
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    41
    fh:read("*l")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    42
    fh:read("*l")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    43
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    44
    local contents = fh:read("*a")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    45
    fh:close()
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    46
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    47
    for entry in contents:gfind("(%d%d%d%d .-)\n\n") do
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    48
        entry = entry:gsub("\n     ", " ")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    49
        local n = entry:match("^(%d%d%d%d) ")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    50
        entry = entry:gsub("^(%d%d%d%d) ", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    51
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    52
        local data = {}
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    53
        data.title = entry:match("^(.-)%. ")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    54
        entry = entry:gsub("^(.-)%. ", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    55
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    56
        data.date = entry:match("%. (.-)%. %(Format:")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    57
        data.obsoletes = entry:match("%(Obsoletes (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    58
        data.obsoleted_by = entry:match("%(Obsoleted by (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    59
        data.updates = entry:match("%(Updates (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    60
        data.updated_by = entry:match("%(Updated by (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    61
        data.also = entry:match("%(Also (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    62
        data.status = entry:match("%(Status: (.-)%)")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    63
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    64
        if data.title then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    65
            rfcdb[n] = data
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    66
        end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    67
    end
34
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
    68
    return true
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    69
end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    70
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    71
local function rfc_lookup_string (rfcstring)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    72
    rfcstring = rfcstring:lower()
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    73
    local r = ""
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    74
    for id, data in pairs(rfcdb) do
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    75
        if data.title:lower():find(rfcstring) then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    76
            r = r.."RFC"..id..": "..data.title.."\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    77
        end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    78
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    79
    r = r:gsub("\n$", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    80
    if r ~= "" then return r; end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    81
    return nil, "Sorry, I couldn't find any relevant RFC"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    82
end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    83
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    84
local function rfc_lookup_number (rfcnum)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    85
    rfcnum = tostring(rfcnum)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    86
    rfcnum = string.rep("0", 4 - rfcnum:len()) .. rfcnum
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    87
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    88
    local data = rfcdb[rfcnum]
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    89
    if not data then return nil, "Sorry, RFC not found" end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    90
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    91
    local r = "RFC"..rfcnum .. " is " .. data.title .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    92
    if data.status then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    93
        r = r .. "Status:\t" .. data.status:lower() .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    94
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    95
    if data.obsoletes then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    96
        r = r .. "Obsoletes:\t" .. data.obsoletes .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    97
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    98
    if data.obsoleted_by then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    99
        r = r .. "Obsoleted by:\t" .. data.obsoleted_by .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   100
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   101
    if data.updates then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   102
        r = r .. "Updates:\t" .. data.updates .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   103
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   104
    if data.updated_by then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   105
        r = r .. "Updated by:\t" .. data.updated_by .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   106
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   107
    if data.also then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   108
        r = r .. "Also:\t" .. data.also .. "\n"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   109
    end
32
96bce644394a Add URLs to RFCs
Mikael Berthe <mikael@lilotux.net>
parents: 31
diff changeset
   110
    r = r .. "URL:\t" .. urlbase..rfcnum
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   111
    return r
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   112
end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   113
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   114
function rfc.cmd (rfcnum)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   115
    local empty = true
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   116
    for i,v in pairs(rfcdb) do empty = false; break end
34
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
   117
    if empty then
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
   118
        local r, err = parse_file(indexfname)
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
   119
        if not r then return nil, err end
ca01a1696cff Remove print() in rfc module
Mikael Berthe <mikael@lilotux.net>
parents: 32
diff changeset
   120
    end
31
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   121
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   122
    if (rfcnum) then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   123
        rfcnum = rfcnum:gsub("^RFC[%s%-]*", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   124
        rfcnum = rfcnum:gsub("^rfc[%s%-]*", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   125
        rfcnum = rfcnum:gsub("[!%?%s:]+$", "")
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   126
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   127
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   128
    if not rfcnum or rfcnum == "" then
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   129
        return nil, "What RFC do you want?"
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   130
    end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   131
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   132
    local n = tonumber(rfcnum)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   133
    if not n then return rfc_lookup_string(rfcnum) end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   134
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   135
    return rfc_lookup_number(n)
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   136
end
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   137
71bf91612a33 Add command rfc
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   138
mcbot_register_command("rfc", rfc)