This repository has been archived on 2021-04-24. You can view files and clone it, but cannot push or open issues or pull requests.
Mikubot/bot/utils.lua

782 lines
20 KiB
Lua
Raw Normal View History

2015-11-12 17:42:03 +01:00
http = require("socket.http")
https = require("ssl.https")
2015-03-10 20:40:08 +01:00
ltn12 = require "ltn12"
2015-11-12 17:42:03 +01:00
URL = require("socket.url")
feedparser = require ("feedparser")
2015-03-10 20:40:08 +01:00
json = (loadfile "./libs/JSON.lua")()
2015-11-12 17:42:03 +01:00
serpent = (loadfile "./libs/serpent.lua")()
2015-03-10 20:40:08 +01:00
mimetype = (loadfile "./libs/mimetype.lua")()
2015-05-28 16:47:30 +02:00
redis = (loadfile "./libs/redis.lua")()
2015-11-12 17:42:03 +01:00
http.TIMEOUT = 5
2014-12-14 21:28:32 +01:00
function get_receiver(msg)
if msg.to.type == 'user' then
return 'user#id'..msg.from.id
end
if msg.to.type == 'chat' then
return 'chat#id'..msg.to.id
end
2015-03-10 20:35:19 +01:00
if msg.to.type == 'encr_chat' then
return msg.to.print_name
2015-11-12 17:42:03 +01:00
end
2014-12-14 21:28:32 +01:00
end
function is_chat_msg( msg )
if msg.to.type == 'chat' then
return true
end
return false
end
function string.random(length)
local str = "";
for i = 1, length do
math.random(97, 122)
str = str..string.char(math.random(97, 122));
end
return str;
end
function string:split(sep)
local sep, fields = sep or ":", {}
local pattern = string.format("([^%s]+)", sep)
self:gsub(pattern, function(c) fields[#fields+1] = c end)
return fields
end
2015-11-12 17:42:03 +01:00
-- Removes spaces
2015-01-31 16:46:30 +01:00
function string.trim(s)
return s:gsub("^%s*(.-)%s*$", "%1")
end
2015-02-15 16:52:08 +01:00
function get_http_file_name(url, headers)
2015-05-28 16:47:30 +02:00
-- Eg: foo.var
local file_name = url:match("[^%w]+([%.%w]+)$")
2015-05-28 16:47:30 +02:00
-- Any delimited alphanumeric on the url
file_name = file_name or url:match("[^%w]+(%w+)[^%w]+$")
-- Random name, hope content-type works
file_name = file_name or str:random(5)
2015-11-12 17:42:03 +01:00
local content_type = headers["content-type"]
2015-02-15 16:52:08 +01:00
2015-02-27 22:20:05 +01:00
local extension = nil
if content_type then
2015-11-12 17:42:03 +01:00
extension = mimetype.get_mime_extension(content_type)
2015-02-27 22:20:05 +01:00
end
2015-11-12 17:42:03 +01:00
2015-02-15 16:52:08 +01:00
if extension then
file_name = file_name.."."..extension
end
2015-11-12 17:42:03 +01:00
local disposition = headers["content-disposition"]
if disposition then
-- attachment; filename=CodeCogsEqn.png
file_name = disposition:match('filename=([^;]+)') or file_name
2015-07-21 22:08:58 +02:00
file_name = string.gsub(file_name, "\"", "")
end
2015-02-15 16:52:08 +01:00
return file_name
end
-- Saves file to tmp/. If file_name isn't provided,
-- will get the text after the last "/" for filename
2015-02-15 16:52:08 +01:00
-- and content-type for extension
function download_to_file(url, file_name)
2015-05-09 16:35:22 +02:00
print("Download URL: "..url)
2014-12-21 18:19:33 +01:00
local respbody = {}
local options = {
url = url,
sink = ltn12.sink.table(respbody),
redirect = true
2015-11-12 17:42:03 +01:00
}
-- nil, code, headers, status
local response = nil
if url:starts('https') then
options.redirect = false
response = {https.request(options)}
else
response = {http.request(options)}
end
local code = response[2]
local headers = response[3]
local status = response[4]
if code ~= 200 then return nil end
file_name = file_name or get_http_file_name(url, headers)
2015-05-28 16:47:30 +02:00
local file_path = "tmp/"..file_name
2015-05-09 16:35:22 +02:00
print("Gespeichert in: "..file_path)
file = io.open(file_path, "w+")
2014-12-21 18:19:33 +01:00
file:write(table.concat(respbody))
file:close()
return file_path
end
function vardump(value)
print(serpent.block(value, {comment=false}))
end
-- taken from http://stackoverflow.com/a/11130774/3163199
function scandir(directory)
local i, t, popen = 0, {}, io.popen
for filename in popen('ls -a "'..directory..'"'):lines() do
i = i + 1
t[i] = filename
end
return t
2014-12-17 13:01:34 +01:00
end
-- http://www.lua.org/manual/5.2/manual.html#pdf-io.popen
function run_command(str)
local cmd = io.popen(str)
local result = cmd:read('*all')
cmd:close()
return result
end
2014-12-22 21:52:11 +01:00
function is_sudo(msg)
2015-11-12 17:42:03 +01:00
local var = false
-- Check if user id is in sudoers table
for v,user in pairs(sudo_users) do
if string.match(user, msg.from.id) then
var = true
end
end
return var
2014-12-22 21:52:11 +01:00
end
2015-05-03 13:51:33 +02:00
function can_use_bot(msg)
local var = false
-- Check users id in config
for v,user in pairs(_config.can_use_bot) do
if user == msg.from.id then
var = true
end
end
return var
end
2014-12-24 01:38:41 +01:00
-- Returns the name of the sender
2014-12-22 21:52:11 +01:00
function get_name(msg)
2015-11-12 17:42:03 +01:00
local name = msg.from.first_name
if name == nil then
name = msg.from.id
end
return name
2014-12-24 01:38:41 +01:00
end
-- Returns at table of lua files inside plugins
function plugins_names( )
local files = {}
for k, v in pairs(scandir("plugins")) do
-- Ends with .lua
if (v:match(".lua$")) then
table.insert(files, v)
end
2014-12-24 01:38:41 +01:00
end
return files
end
-- Function name explains what it does.
function file_exists(name)
local f = io.open(name,"r")
if f ~= nil then
io.close(f)
return true
else
return false
2014-12-24 01:38:41 +01:00
end
2015-01-01 16:06:24 +01:00
end
-- Save into file the data serialized for lua.
-- Set uglify true to minify the file.
function serialize_to_file(data, file, uglify)
2015-01-01 16:06:24 +01:00
file = io.open(file, 'w+')
local serialized
if not uglify then
serialized = serpent.block(data, {
comment = false,
name = '_'
})
else
serialized = serpent.dump(data)
end
2015-01-01 16:06:24 +01:00
file:write(serialized)
file:close()
2015-01-06 14:10:26 +01:00
end
2015-05-28 16:47:30 +02:00
-- Returns true if the string is empty
2015-01-06 14:10:26 +01:00
function string:isempty()
return self == nil or self == ''
end
2015-05-28 16:47:30 +02:00
-- Returns true if the string is blank
function string:isblank()
self = self:trim()
return self:isempty()
end
-- DEPRECATED!!!!!
function string.starts(String, Start)
print("string.starts(String, Start) is DEPRECATED use string:starts(text) instead")
return Start == string.sub(String,1,string.len(Start))
end
-- Returns true if String starts with Start
function string:starts(text)
return text == string.sub(self,1,string.len(text))
end
-- Send image to user and delete it when finished.
-- cb_function and cb_extra are optionals callback
function _send_photo(receiver, file_path, cb_function, cb_extra)
local cb_extra = {
file_path = file_path,
cb_function = cb_function,
cb_extra = cb_extra
}
-- Call to remove with optional callback
2015-09-07 18:11:32 +02:00
send_photo(receiver, file_path, cb_function, cb_extra)
end
-- Download the image and send to receiver, it will be deleted.
2015-02-15 14:37:23 +01:00
-- cb_function and cb_extra are optionals callback
2015-11-12 17:42:03 +01:00
function send_photo_from_url(receiver, url, cb_function, cb_extra, sendNotErrMsg)
-- If callback not provided
cb_function = cb_function or ok_cb
cb_extra = cb_extra or false
local file_path = download_to_file(url, false)
if not file_path then -- Error
2015-11-12 17:42:03 +01:00
if sendNotErrMsg then
return false
else
local text = 'Fehler beim Laden des Bildes'
send_msg(receiver, text, cb_function, cb_extra)
end
else
2015-05-09 16:35:22 +02:00
print("Datei Pfad: "..file_path)
_send_photo(receiver, file_path, cb_function, cb_extra)
2015-11-12 17:42:03 +01:00
return true
end
end
-- Same as send_photo_from_url but as callback function
2015-11-12 17:42:03 +01:00
function send_photo_from_url_callback(cb_extra, success, result, sendErrMsg)
local receiver = cb_extra.receiver
local url = cb_extra.url
2015-11-12 17:42:03 +01:00
local file_path = download_to_file(url, false)
if not file_path then -- Error
2015-11-12 17:42:03 +01:00
local text = 'Fehler beim Herunterladen des Bildes'
send_msg(receiver, text, ok_cb, false)
else
2015-05-09 16:35:22 +02:00
print("Datei Pfad: "..file_path)
_send_photo(receiver, file_path, ok_cb, false)
end
end
2015-11-12 17:42:03 +01:00
-- Same as above, but with send_as_document
function send_document_from_url_callback(cb_extra, success, result)
local receiver = cb_extra.receiver
local url = cb_extra.url
local file_path = download_to_file(url, false)
if not file_path then -- Error
local text = 'Fehler beim Herunterladen des Dokumentes'
send_msg(receiver, text, ok_cb, false)
else
print("File path: "..file_path)
_send_document(receiver, file_path, ok_cb, false)
end
end
2015-05-28 16:47:30 +02:00
-- Send multiple images asynchronous.
-- param urls must be a table.
function send_photos_from_url(receiver, urls)
local cb_extra = {
receiver = receiver,
urls = urls,
remove_path = nil
}
send_photos_from_url_callback(cb_extra)
end
-- Use send_photos_from_url.
2015-05-28 16:47:30 +02:00
-- This function might be difficult to understand.
function send_photos_from_url_callback(cb_extra, success, result)
-- cb_extra is a table containing receiver, urls and remove_path
local receiver = cb_extra.receiver
local urls = cb_extra.urls
local remove_path = cb_extra.remove_path
-- The previously image to remove
if remove_path ~= nil then
os.remove(remove_path)
2015-05-09 16:35:22 +02:00
print(remove_path.." gelöscht!")
end
-- Nil or empty, exit case (no more urls)
if urls == nil or #urls == 0 then
return false
end
-- Take the head and remove from urls table
local head = table.remove(urls, 1)
local file_path = download_to_file(head, false)
local cb_extra = {
receiver = receiver,
urls = urls,
remove_path = file_path
}
-- Send first and postpone the others as callback
send_photo(receiver, file_path, send_photos_from_url_callback, cb_extra)
end
-- Callback to remove a file
function rmtmp_cb(cb_extra, success, result)
local file_path = cb_extra.file_path
2015-02-15 16:52:08 +01:00
local cb_function = cb_extra.cb_function or ok_cb
local cb_extra = cb_extra.cb_extra
if file_path ~= nil then
os.remove(file_path)
2015-05-09 16:35:22 +02:00
print(file_path.." gelöscht!")
end
2015-05-28 16:47:30 +02:00
-- Finally call the callback
cb_function(cb_extra, success, result)
end
-- Send document to user and delete it when finished.
-- cb_function and cb_extra are optionals callback
function _send_document(receiver, file_path, cb_function, cb_extra)
local cb_extra = {
file_path = file_path,
cb_function = cb_function or ok_cb,
cb_extra = cb_extra or false
}
-- Call to remove with optional callback
send_document(receiver, file_path, rmtmp_cb, cb_extra)
end
-- Download the image and send to receiver, it will be deleted.
-- cb_function and cb_extra are optionals callback
2015-11-12 17:42:03 +01:00
function send_document_from_url(receiver, url, cb_function, cb_extra, sendNotErrMsg)
-- If callback not provided
cb_function = cb_function or ok_cb
cb_extra = cb_extra or false
local file_path = download_to_file(url, false)
2015-11-12 17:42:03 +01:00
if not file_path then -- Error
if sendNotErrMsg then
return false
else
local text = 'Fehler beim Herunterladen des Dokumentes'
send_msg(receiver, text, cb_function, cb_extra)
end
else
print("Datei Pfad: "..file_path)
_send_document(receiver, file_path, cb_function, cb_extra)
return true
end
2015-02-27 21:36:50 +01:00
end
2015-03-14 17:22:52 +01:00
-- Parameters in ?a=1&b=2 style
function format_http_params(params, is_get)
local str = ''
-- If is get add ? to the beginning
if is_get then str = '?' end
local first = true -- Frist param
for k,v in pairs (params) do
if v then -- nil value
if first then
first = false
str = str..k.. "="..v
else
str = str.."&"..k.. "="..v
end
end
end
return str
2015-04-10 12:30:57 +02:00
end
-- Check if user can use the plugin and warns user
-- Returns true if user was warned and false if not warned (is allowed)
function warns_user_not_allowed(plugin, msg)
if not user_allowed(plugin, msg) then
2015-05-09 16:35:22 +02:00
local text = 'Du darfst diesen Befehl nicht nutzen!'
local receiver = get_receiver(msg)
send_msg(receiver, text, ok_cb, false)
return true
else
return false
end
end
-- Check if user can use the plugin
function user_allowed(plugin, msg)
if plugin.privileged and not is_sudo(msg) then
return false
end
return true
end
function send_order_msg(destination, msgs)
local cb_extra = {
destination = destination,
msgs = msgs
}
send_order_msg_callback(cb_extra, true)
end
function send_large_msg(destination, text)
local cb_extra = {
destination = destination,
text = text
}
send_large_msg_callback(cb_extra, true)
end
-- If text is longer than 4096 chars, send multiple msg.
-- https://core.telegram.org/method/messages.sendMessage
function send_large_msg_callback(cb_extra, success, result)
local text_max = 4096
local destination = cb_extra.destination
local text = cb_extra.text
local text_len = string.len(text)
local num_msg = math.ceil(text_len / text_max)
if num_msg <= 1 then
send_msg(destination, text, ok_cb, false)
else
local my_text = string.sub(text, 1, 4096)
local rest = string.sub(text, 4096, text_len)
local cb_extra = {
destination = destination,
text = rest
}
send_msg(destination, my_text, send_large_msg_callback, cb_extra)
end
end
2015-04-12 21:56:20 +02:00
-- Returns a table with matches or nil
2015-11-12 17:42:03 +01:00
--function match_pattern(pattern, text, lower_case)
function match_pattern(pattern, text)
2015-04-12 23:26:01 +02:00
if text then
2015-11-12 17:42:03 +01:00
local matches = { string.match(text, pattern) }
if next(matches) then
return matches
end
2015-04-12 21:56:20 +02:00
end
-- nil
end
2015-04-22 16:48:05 +02:00
function sleep(n)
os.execute("sleep " .. tonumber(n))
end
-- Function to read data from files
2015-05-28 16:47:30 +02:00
function load_from_file(file, default_data)
local f = io.open(file, "r+")
-- If file doesn't exists
if f == nil then
-- Create a new empty table
2015-05-28 16:47:30 +02:00
default_data = default_data or {}
serialize_to_file(default_data, file)
2015-05-09 16:35:22 +02:00
print ('Erstelle Datei', file)
else
2015-05-09 16:35:22 +02:00
print ('Daten geladen von', file)
f:close()
end
return loadfile (file)()
2015-05-28 16:47:30 +02:00
end
2015-11-12 17:42:03 +01:00
function run_bash(str)
2015-05-28 16:47:30 +02:00
local cmd = io.popen(str)
local result = cmd:read('*all')
cmd:close()
return result
end
2015-07-21 16:10:51 +02:00
function run_sh(msg)
name = get_name(msg)
text = ''
bash = msg.text:sub(4,-1)
text = run_bash(bash)
return text
end
2015-11-12 17:42:03 +01:00
function round(num, idp)
if idp and idp>0 then
local mult = 10^idp
return math.floor(num * mult + 0.5) / mult
end
return math.floor(num + 0.5)
end
2015-06-25 22:10:29 +02:00
function unescape(str)
2016-02-09 16:22:12 +01:00
-- Character encoding
str = string.gsub(str, "&acute;", "´")
str = string.gsub(str, "&bull;", "")
str = string.gsub(str, "&gt;", ">")
str = string.gsub(str, "&hellip;", "")
str = string.gsub(str, "&lt;", "<")
str = string.gsub(str, "&mdash;", "")
str = string.gsub(str, "&nabla;", "")
str = string.gsub(str, "&ndash;", "")
str = string.gsub(str, "&Psi;", "ψ")
str = string.gsub(str, "&psi;", "ψ")
str = string.gsub(str, "&quot;", '"')
str = string.gsub(str, "&raquo;", "»")
str = string.gsub(str, "&reg;", "®")
str = string.gsub(str, "&szlig;", "ß")
str = string.gsub(str, "&trade;", "")
str = string.gsub(str, "&#038;", "&")
str = string.gsub(str, "&#039;", "'")
str = string.gsub(str, "&#39;", "'")
str = string.gsub(str, "&#124;", "|")
str = string.gsub(str, "&#160;", " ")
str = string.gsub(str, "&#174;", "®")
str = string.gsub(str, "&#187;", "»")
str = string.gsub(str, "&#223;", "ß")
str = string.gsub(str, "&#8211;", "")
str = string.gsub(str, "&#8217;", "'")
str = string.gsub(str, "&#8220;", "")
str = string.gsub(str, "&#8221;", "")
str = string.gsub(str, "&#8222;", "")
str = string.gsub(str, "&#8249;", "")
str = string.gsub(str, "&#8364;", "")
-- Ä Ö Ü
str = string.gsub(str, "&auml;", "ä")
str = string.gsub(str, "&Auml;", "Ä")
str = string.gsub(str, "&#228;", "ä")
str = string.gsub(str, "&#196;", "Ä")
str = string.gsub(str, "&ouml;", "ö")
str = string.gsub(str, "&Ouml;", "Ö")
str = string.gsub(str, "&#246;", "ö")
str = string.gsub(str, "&#214;", "Ö")
str = string.gsub(str, "&uuml;", "ü")
str = string.gsub(str, "&Uuml;", "Ü")
str = string.gsub(str, "&#252;", "ü")
str = string.gsub(str, "&#220;", "Ü")
2015-06-25 22:10:29 +02:00
str = string.gsub( str, '&#(%d+);', function(n) return string.char(n) end )
str = string.gsub( str, '&#x(%d+);', function(n) return string.char(tonumber(n,16)) end )
str = string.gsub( str, '&amp;', '&' ) -- Be sure to do this after all others
return str
end
-- See http://stackoverflow.com/a/14899740
function unescape_html(str)
local map = {
["lt"] = "<",
["gt"] = ">",
["amp"] = "&",
["quot"] = '"',
["apos"] = "'"
}
new = string.gsub(str, '(&(#?x?)([%d%a]+);)', function(orig, n, s)
var = map[s] or n == "#" and string.char(s)
var = var or n == "#x" and string.char(tonumber(s,16))
var = var or orig
return var
end)
return new
2015-11-12 17:42:03 +01:00
end
function post_petition(url, arguments)
local url, h = string.gsub(url, "http://", "")
local url, hs = string.gsub(url, "https://", "")
local post_prot = "http"
if hs == 1 then
post_prot = "https"
end
local response_body = {}
local request_constructor = {
url = post_prot..'://'..url,
method = "POST",
sink = ltn12.sink.table(response_body),
headers = {},
redirect = false
}
local source = arguments
if type(arguments) == "table" then
local source = helpers.url_encode_arguments(arguments)
end
request_constructor.headers["Content-Type"] = "application/x-www-form-urlencoded"
request_constructor.headers["Content-Length"] = tostring(#source)
request_constructor.source = ltn12.source.string(source)
if post_prot == "http" then
ok, response_code, response_headers, response_status_line = http.request(request_constructor)
else
ok, response_code, response_headers, response_status_line = https.request(request_constructor)
end
if not ok then
return nil
end
response_body = json:decode(table.concat(response_body))
return response_body
end
function get_redis_hash(msg, var)
if msg.to.type == 'chat' then
return 'chat:'..msg.to.id..':'..var
end
if msg.to.type == 'user' then
return 'user:'..msg.from.id..':'..var
end
end
function tablelength(T)
local count = 0
for _ in pairs(T) do count = count + 1 end
return count
end
function comma_value(amount)
local formatted = amount
while true do
formatted, k = string.gsub(formatted, "^(-?%d+)(%d%d%d)", '%1.%2')
if (k==0) then
break
end
end
return formatted
end
function string.ends(str, fin)
return fin=='' or string.sub(str,-string.len(fin)) == fin
end
function get_location(user_id)
local hash = 'user:'..user_id
local set_location = redis:hget(hash, 'location')
if set_location == 'false' or set_location == nil then
return false
else
return set_location
end
2015-12-05 21:36:56 +01:00
end
function cache_data(plugin, query, data, timeout, typ)
-- How to: cache_data(pluginname, query_name, data_to_cache, expire_in_seconds)
if not timeout then timeout = 86400 end
local hash = 'telegram:cache:'..plugin..':'..query
print('Caching "'..query..'" from plugin '..plugin..' (expires in '..timeout..' seconds)')
if typ == 'key' then
redis:set(hash, data)
2015-12-06 17:19:49 +01:00
elseif typ == 'set' then
-- make sure that you convert your data into a table:
-- {"foo", "bar", "baz"} instead of
-- {"bar" = "foo", "foo" = "bar", "bar" = "baz"}
-- because other formats are not supported by redis (or I haven't found a way to store them)
for _,str in pairs(data) do
redis:sadd(hash, str)
end
2015-12-05 21:36:56 +01:00
else
redis:hmset(hash, data)
end
redis:expire(hash, timeout)
2016-01-11 19:38:03 +01:00
end
--[[
Ordered table iterator, allow to iterate on the natural order of the keys of a
table.
-- http://lua-users.org/wiki/SortedIteration
]]
function __genOrderedIndex( t )
local orderedIndex = {}
for key in pairs(t) do
table.insert( orderedIndex, key )
end
table.sort( orderedIndex )
return orderedIndex
end
function orderedNext(t, state)
-- Equivalent of the next function, but returns the keys in the alphabetic
-- order. We use a temporary ordered key table that is stored in the
-- table being iterated.
key = nil
--print("orderedNext: state = "..tostring(state) )
if state == nil then
-- the first time, generate the index
t.__orderedIndex = __genOrderedIndex( t )
key = t.__orderedIndex[1]
else
-- fetch the next value
for i = 1,table.getn(t.__orderedIndex) do
if t.__orderedIndex[i] == state then
key = t.__orderedIndex[i+1]
end
end
end
if key then
return key, t[key]
end
-- no more value to return, cleanup
t.__orderedIndex = nil
return
end
2016-01-11 19:38:03 +01:00
function orderedPairs(t)
-- Equivalent of the pairs() function on tables. Allows to iterate
-- in order
return orderedNext, t, nil
end
-- converts total amount of seconds (e.g. 65 seconds) to human redable time (e.g. 1:05 minutes)
function makeHumanTime(totalseconds)
local seconds = totalseconds % 60
local minutes = math.floor(totalseconds / 60)
local minutes = minutes % 60
local hours = math.floor(totalseconds / 3600)
if minutes == 00 and hours == 00 then
return seconds..' Sekunden'
elseif hours == 00 and minutes ~= 00 then
return string.format("%02d:%02d", minutes, seconds)..' Minuten'
elseif hours ~= 00 then
return string.format("%02d:%02d:%02d", hours, minutes, seconds)..' Stunden'
end
end
function is_blacklisted(msg)
_blacklist = redis:smembers("telegram:img_blacklist")
local var = false
for v,word in pairs(_blacklist) do
if string.find(string.lower(msg), string.lower(word)) then
print("Wort steht auf der Blacklist!")
var = true
break
end
end
return var
end
function convert_timestamp(timestamp, format)
local converted_date = run_command('date -d @'..timestamp..' +'..format)
local converted_date = string.gsub(converted_date, '%\n', '')
return converted_date
end