mcbot/cmds/xep.lua
author Mikael Berthe <mikael@lilotux.net>
Tue, 27 Nov 2012 16:26:04 +0100
changeset 66 d9c00a9fe9d5
parent 39 237af42156a1
permissions -rw-r--r--
Add notices before public release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
66
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     1
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     2
--  This module is part of the McBot / mcabbot project
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     3
--  XEP module.
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     4
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     5
-- Copyright (C) 2010-2012 Mikael Berthe <mikael@lilotux.net>
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     6
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     7
-- This program is free software; you can redistribute it and/or modify
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
     8
-- 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: 39
diff changeset
     9
-- the Free Software Foundation; either version 2 of the License, or (at
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
    10
-- your option) any later version.
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
    11
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
    12
-- 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: 39
diff changeset
    13
--
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
    14
-- Some parts were inspired by Matthew Wild (MattJ) code, see below.
d9c00a9fe9d5 Add notices before public release
Mikael Berthe <mikael@lilotux.net>
parents: 39
diff changeset
    15
--
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    16
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    17
require "libs.shcmd"
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    19
-- The caching idea is borrowed from MattJ's riddim code,
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
-- and the function parse_xeps() as well.
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    21
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
local xeplisturl = "curl http://xmpp.org/extensions/xeps.xml"
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
22
4b360fe207e6 Minor description update
Mikael Berthe <mikael@lilotux.net>
parents: 16
diff changeset
    24
local xep = { ["desc"] = "Search XEP database" }
16
064a50911e05 Update command infrastructure
Mikael Berthe <mikael@lilotux.net>
parents: 11
diff changeset
    25
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    26
local xeps = {}
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    27
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    28
-- parse_xep() from Matthew Wild (aka MattJ)
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    29
local function parse_xeps(t)
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    30
if not t or t == "" then return nil end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    31
local currxep = {}
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    32
    for b in string.gmatch(t,"<xep>(.-)</xep>") do
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    33
        for k,v in string.gmatch(b,"<(%w+)>(.-)</%1>") do
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    34
            currxep[k] = v
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    35
        end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    36
        xeps[currxep.number] = { }
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    37
        for k, v in pairs(currxep) do xeps[currxep.number][k] = v end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    38
    end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    39
    return true
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    40
end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    41
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    42
local function fetch_xeps ()
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    43
    local now = os.time()
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    44
    if os.difftime(now, xeps_updated_at) < 43200 then return end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    45
    -- Let's get some fresh data
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    46
    local xepdata = shcmd(xeplisturl)
39
237af42156a1 Add checks after shcmd() calls
Mikael Berthe <mikael@lilotux.net>
parents: 30
diff changeset
    47
    if xepdata then
237af42156a1 Add checks after shcmd() calls
Mikael Berthe <mikael@lilotux.net>
parents: 30
diff changeset
    48
        xeps_updated_at = now
237af42156a1 Add checks after shcmd() calls
Mikael Berthe <mikael@lilotux.net>
parents: 30
diff changeset
    49
        parse_xeps(xepdata)
237af42156a1 Add checks after shcmd() calls
Mikael Berthe <mikael@lilotux.net>
parents: 30
diff changeset
    50
    end
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    51
end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    52
11
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    53
-- Deeply inspired by MattJ's riddim bot
16
064a50911e05 Update command infrastructure
Mikael Berthe <mikael@lilotux.net>
parents: 11
diff changeset
    54
function xep.cmd (xepstr)
11
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    55
    if (xepstr) then
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    56
        xepstr = xepstr:gsub("[%s%?%.%!]+$", "")
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    57
        local n = xepstr:upper():match("^XEP[%-%s]?(%d+)$")
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    58
        if n then xepstr = n end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    59
    end
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    60
    -- Check that xepnum is a valid number
11
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    61
    xepnum = tonumber(xepstr)
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    62
    if xepnum and (xepnum <= 0 or xepnum > 9999) then
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    63
        return nil, "What XEP?"
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    64
    end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    65
    if not xepnum and not xepstr:match("^[%w%s%-_]+$") then
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    66
        return nil, "What XEP?  Please use a simple keyword..."
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    67
    end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    68
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    69
    -- Download XEP list
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    70
    fetch_xeps()
11
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    71
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    72
    -- #1 The argument is a XEP number
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    73
    if xepnum then
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    74
        xepnum = tostring(xepnum)
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    75
        -- Expand to full 4 char number
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    76
        xepnum = string.rep("0", 4-xepnum:len())..xepnum
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    77
        local xep = xeps[tostring(xepnum)]
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    78
        if not xep then return nil, "Sorry, XEP-"..xepnum.." not found" end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    79
        return "XEP-"..xep.number.." is \""..xep.name.."\"\n"..
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    80
               -- xep.type..", "..xep.status..", last updated "..xep.updated.."\n"..
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    81
               "URL: <http://xmpp.org/extensions/xep-"..xep.number..".html>"
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    82
    end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    83
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    84
    -- #2 The argument is a keyword
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    85
    local r = ""
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    86
    xepstr = xepstr:lower()
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    87
    for n, xep in pairs(xeps) do
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    88
        if xep.name:lower():find(xepstr) then
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    89
            r = r.."XEP-"..xep.number..": "..xep.name.."\n"
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    90
        end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    91
    end
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    92
    r = r:gsub("\n$", "")
4993fc6b1108 Improve xep command
Mikael Berthe <mikael@lilotux.net>
parents: 7
diff changeset
    93
    if r ~= "" then return r; end
30
e5e20eed6c58 Fix typo
Mikael Berthe <mikael@lilotux.net>
parents: 22
diff changeset
    94
    return nil, "Sorry, no matching XEP found"
3
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    95
end
508108deee63 Add command xep
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    96
16
064a50911e05 Update command infrastructure
Mikael Berthe <mikael@lilotux.net>
parents: 11
diff changeset
    97
mcbot_register_command("xep", xep)