[chatplus] Update

This commit is contained in:
LeMagnesium 2015-12-21 17:40:40 +01:00
parent 83b5adfb1d
commit fe33132577
4 changed files with 269 additions and 358 deletions

View File

@ -1,12 +1,13 @@
Chatplus
--------
# Chatplus
Adds ignoring and email style inboxes. Also provides a powerful API,
and optionally allows distance limiting.
License: GPL 3.0 or later.
Created by rubenwardy.
Commands
========
## Chat commands
* /ignore [name] - ignore a player
* /unignore [name] - unignore a player
@ -17,7 +18,6 @@ Commands
* /inbox txt - alias of /inbox text
* /inbox t - alias of /inbox text
HUD
===
## HUD
This mod adds a new message icon to the HUD. If HUDs are not supported, no icon is added.

231
mods/chatplus/api.lua Normal file
View File

@ -0,0 +1,231 @@
-- Chat Plus
-- by rubenwardy
---------------------
-- api.lua
-- Core functionality
---------------------
chatplus = {
version = 2.2,
_logpath = minetest.get_worldpath().."/chatplus-log.txt",
_defsettings = {
log = true,
use_gui = true,
distance = 0,
badwords = ""
}
}
function chatplus.init()
chatplus.load()
chatplus.clean_players()
if not chatplus.players then
chatplus.players = {}
end
chatplus.count = 0
chatplus.loggedin = {}
chatplus._handlers = {}
end
function chatplus.setting(name)
local get = minetest.setting_get("chatplus_" .. name)
if get then
return get
elseif chatplus._defsettings[name]~= nil then
return chatplus._defsettings[name]
else
minetest.log("[Chatplus] Setting chatplus_" .. name .. " not found!")
return nil
end
end
function chatplus.log(msg)
if chatplus._log then
chatplus._log:write(os.date("%Y-%m-%d %H:%M:%S") .. " " .. msg .. "\r\n")
chatplus._log:flush()
end
end
function chatplus.load()
-- Initialize the log
if chatplus.setting("log") then
chatplus._log = io.open(chatplus._logpath, "a+")
if not chatplus._log then
minetest.log("error", "Unable to open the chatplus log file: " .. chatplus._logpath)
else
minetest.log("action", "Logging chat plus to: " .. chatplus._logpath)
end
chatplus.log("*** SERVER STARTED ***")
end
-- Load player data
minetest.log("[Chatplus] Loading data")
local file = io.open(minetest.get_worldpath() .. "/chatplus.txt", "r")
if file then
local from_file = minetest.deserialize(file:read("*all"))
file:close()
if type(from_file) == "table" then
if from_file.players and from_file.version >= 2 then
chatplus.players = from_file.players
else
chatplus.old_inbox = {}
chatplus.players = {}
for name, data in pairs(from_file) do
local inbox = data.inbox
data.inbox = nil
chatplus.players[name] = data
chatplus.old_inbox[name] = {}
for _, msg in pairs(inbox) do
table.insert(chatplus.old_inbox[name], {
date = "?",
from = "?",
msg = msg
})
end
end
if chatplus.on_old_inbox then
chatplus.on_old_inbox(chatplus.old_inbox)
end
end
return
end
end
end
function chatplus.save()
minetest.log("[Chatplus] Saving data")
local file = io.open(minetest.get_worldpath().."/chatplus.txt", "w")
if file then
file:write(minetest.serialize({ version = 2, players = chatplus.players}))
file:close()
end
end
function chatplus.clean_players()
if not chatplus.players then
chatplus.players = {}
return
end
minetest.log("[Chatplus] Cleaning player lists")
for key,value in pairs(chatplus.players) do
if value.messages then
value.inbox = value.messages
value.messages = nil
end
if (
(not value.inbox or #value.inbox==0) and
(not value.ignore or #value.ignore==0)
) then
value[key] = nil
end
end
chatplus.save()
end
local function cp_tick()
chatplus.clean_players()
minetest.after(30*60, cp_tick)
end
minetest.after(30*60, cp_tick)
function chatplus.poke(name,player)
local function check(name,value)
if not chatplus.players[name][value] then
chatplus.players[name][value] = {}
end
end
if not chatplus.players[name] then
chatplus.players[name] = {}
end
check(name, "ignore")
check(name, "inbox")
chatplus.players[name].enabled = true
if player then
if player=="end" then
chatplus.players[name].enabled = false
chatplus.loggedin[name] = nil
else
if not chatplus.loggedin[name] then
chatplus.loggedin[name] = {}
end
chatplus.loggedin[name].player = player
end
end
chatplus.save()
return chatplus.players[name]
end
function chatplus.register_handler(func,place)
if not place then
table.insert(chatplus._handlers, func)
else
table.insert(chatplus._handlers, place, func)
end
end
-- Allows overriding
function chatplus.log_message(from, msg)
chatplus.log("<" .. from .. "> " .. msg)
end
function chatplus.send(from, msg)
if msg:sub(1, 1) == "/" then
return false
end
chatplus.log_message(from, msg)
if #chatplus._handlers == 0 then
return nil
end
-- Loop through possible receivers
for to, value in pairs(chatplus.loggedin) do
if to ~= from then
-- Run handlers
local res = nil
for i = 1, #chatplus._handlers do
if chatplus._handlers[i] then
res = chatplus._handlers[i](from, to, msg)
if res ~= nil then
break
end
end
end
-- Send message
if res == nil or res == true then
minetest.chat_send_player(to, "<" .. from .. "> " .. msg)
end
end
end
return true
end
-- Minetest callbacks
minetest.register_on_chat_message(function(...)
local ret = chatplus.send(...)
if ret and minetest.global_exists("irc") and irc.on_chatmessage then
irc.on_chatmessage(...)
end
return ret
end)
minetest.register_on_joinplayer(function(player)
chatplus.log(player:get_player_name() .. " joined")
end)
minetest.register_on_leaveplayer(function(player)
chatplus.poke(player:get_player_name(), "end")
chatplus.log(player:get_player_name() .. " disconnected")
end)
chatplus.init()

View File

@ -1 +1,2 @@
Adds advanced chat features such as ignoring and inboxing.
Adds ignoring and email style inboxes. Also provides a powerful API,
and optionally allows distance limiting.

View File

@ -1,205 +1,17 @@
-- Chat Plus
-- =========
-- Advanced chat functionality
-- =========
-- by rubenwardy
---------------------
-- init.lua
-- Three handlers: ignoring, distance, and mail.
---------------------
chatplus = {
log_file = minetest.get_worldpath().."/chatplus-log.txt",
_defsettings = {
log = true,
use_gui = true,
distance = 0,
badwords = ""
}
}
function chatplus.init()
chatplus.load()
chatplus.clean_players()
if not chatplus.players then
chatplus.players = {}
end
chatplus.count = 0
chatplus.loggedin = {}
chatplus._handlers = {}
end
function chatplus.setting(name)
local get = minetest.setting_get("chatplus_"..name)
if get then
return get
elseif chatplus._defsettings[name]~= nil then
return chatplus._defsettings[name]
else
minetest.log("[Chatplus] Setting chatplus_"..name.." not found!")
return nil
end
end
function chatplus.load()
-- Initialize the log
if chatplus.setting("log") then
chatplus.log_handle = io.open(chatplus.log_file,"a+")
if not chatplus.log_handle then
minetest.log("error","Unable to open chat plus log file: "..chatplus.log_file)
else
minetest.log("action","Logging chat plus to: "..chatplus.log_file)
end
end
-- Load player data
minetest.log("[Chatplus] Loading data")
local file = io.open(minetest.get_worldpath().."/chatplus.txt", "r")
if file then
local table = minetest.deserialize(file:read("*all"))
file:close()
if type(table) == "table" then
chatplus.players = table
return
end
end
end
function chatplus.save()
minetest.log("[Chatplus] Saving data")
local file = io.open(minetest.get_worldpath().."/chatplus.txt", "w")
if file then
file:write(minetest.serialize(chatplus.players))
file:close()
end
end
function chatplus.clean_players()
if not chatplus.players then
chatplus.players = {}
return
end
minetest.log("[Chatplus] Cleaning player lists")
for key,value in pairs(chatplus.players) do
if value.messages then
value.inbox = value.messages
value.messages = nil
end
if (
(not value.inbox or #value.inbox==0) and
(not value.ignore or #value.ignore==0)
) then
minetest.log("Deleting blank player "..key)
value[key] = nil
end
end
chatplus.save()
minetest.log("[Chatplus] Clean complete")
end
function chatplus.poke(name,player)
local function check(name,value)
if not chatplus.players[name][value] then
chatplus.players[name][value] = {}
end
end
if not chatplus.players[name] then
chatplus.players[name] = {}
end
check(name,"ignore")
check(name,"inbox")
chatplus.players[name].enabled = true
if player then
if player=="end" then
chatplus.players[name].enabled = false
chatplus.loggedin[name] = nil
else
if not chatplus.loggedin[name] then
chatplus.loggedin[name] = {}
end
chatplus.loggedin[name].player = player
end
end
chatplus.save()
return chatplus.players[name]
end
function chatplus.register_handler(func,place)
if not place then
table.insert(chatplus._handlers,func)
else
table.insert(chatplus._handlers,place,func)
end
end
function chatplus.send(from, msg)
if msg:sub(1, 1) == "/" then
return false
end
-- Log chat message
if chatplus.log_handle ~= nil then
chatplus.log_handle:write(
os.date("%Y/%m/%d %I:%M%p")..
" <"..from.."> "..
msg..
"\r\n"
)
chatplus.log_handle:flush()
end
-- Loop through senders
for key,value in pairs(chatplus.loggedin) do
local res = nil
for i=1,#chatplus._handlers do
if chatplus._handlers[i] then
res = chatplus._handlers[i](from,key,msg)
if res ~= nil then
break
end
end
end
if (res == nil or res == true) and key~=from then
minetest.chat_send_player(key,"<"..from.."> "..msg,false)
end
end
return true
end
-- Minetest callbacks
minetest.register_on_chat_message(chatplus.send)
minetest.register_on_joinplayer(function(player)
local _player = chatplus.poke(player:get_player_name(),player)
if chatplus.log_handle ~= nil then
chatplus.log_handle:write(os.date("%d/%m/%Y %I:%M%p").." "..player:get_player_name().." joined\r\n")
chatplus.log_handle:flush()
end
-- inbox stuff!
if _player.inbox and #_player.inbox>0 then
minetest.after(10,minetest.chat_send_player,player:get_player_name(),"("..#_player.inbox..") You have mail! Type /inbox to recieve")
end
end)
minetest.register_on_leaveplayer(function(player)
chatplus.poke(player:get_player_name(),"end")
if chatplus.log_handle ~= nil then
chatplus.log_handle:write(os.date("%d/%m/%Y %I:%M%p").." "..player:get_player_name().." disconnected\r\n")
chatplus.log_handle:flush()
end
end)
-- Init
chatplus.init()
dofile(minetest.get_modpath("chatplus") .. "/api.lua")
--
-- Ignoring
chatplus.register_handler(function(from,to,msg)
if chatplus.players[to] and chatplus.players[to].ignore and chatplus.players[to].ignore[from]==true then
--
chatplus.register_handler(function(from, to, msg)
if chatplus.players[to] and chatplus.players[to].ignore and chatplus.players[to].ignore[from] then
return false
end
return nil
@ -210,12 +22,12 @@ minetest.register_chatcommand("ignore", {
description = "ignore: Ignore a player",
func = function(name, param)
chatplus.poke(name)
if not chatplus.players[name].ignore[param]==true then
chatplus.players[name].ignore[param]=true
minetest.chat_send_player(name,param.." has been ignored")
if not chatplus.players[name].ignore[param] then
chatplus.players[name].ignore[param] = true
minetest.chat_send_player(name, param .. " has been ignored")
chatplus.save()
else
minetest.chat_send_player(name,"Player "..param.." is already ignored.")
minetest.chat_send_player(name, "Player " .. param .. " is already ignored.")
end
end
})
@ -225,174 +37,41 @@ minetest.register_chatcommand("unignore", {
description = "unignore: Unignore a player",
func = function(name, param)
chatplus.poke(name)
if chatplus.players[name].ignore[param]==true then
chatplus.players[name].ignore[param]=false
minetest.chat_send_player(name,param.." has been unignored")
if chatplus.players[name].ignore[param] then
chatplus.players[name].ignore[param] = false
minetest.chat_send_player(name, param .. " has been unignored")
chatplus.save()
else
minetest.chat_send_player(name,"Player "..param.." is already unignored.")
minetest.chat_send_player(name, "Player " .. param .. " is already unignored.")
end
end
})
-- inbox
function chatplus.showInbox(name,forcetest)
if not chatplus.players[name] then
return false
end
local player = chatplus.players[name]
if not player.inbox or #player.inbox==0 then
minetest.chat_send_player(name,"Your inbox is empty!")
return false
end
local setting = chatplus.setting("use_gui")
if (setting == true or setting == "true" or setting == "1") and not forcetest then
minetest.chat_send_player(name,"Showing your inbox to you.")
local fs = "size[10,8]textarea[0.25,0.25;10.15,8;inbox;You have " .. #player.inbox .. " messages in your inbox:;"
for i=1,#player.inbox do
fs = fs .. minetest.formspec_escape(player.inbox[i])
fs = fs .. "\n"
end
fs = fs .. "]"
fs = fs .. "button[0,7.25;2,1;clear;Clear Inbox]"
fs = fs .. "button_exit[8.1,7.25;2,1;close;Close]"
minetest.show_formspec(name, "chatplus:inbox", fs)
else
minetest.chat_send_player(name,"("..#player.inbox..") You have mail:")
for i=1,#player.inbox do
minetest.chat_send_player(name,player.inbox[i],false)
end
minetest.chat_send_player(name,"("..#player.inbox..")",false)
end
return true
end
minetest.register_on_player_receive_fields(function(player,formname,fields)
if fields.clear then
local name = player:get_player_name()
chatplus.poke(name).inbox = {}
chatplus.save()
minetest.chat_send_player(name,"Inbox cleared!")
chatplus.showInbox(name)
end
end)
minetest.register_chatcommand("inbox", {
params = "clear?",
description = "inbox: print the items in your inbox",
func = function(name, param)
if param == "clear" then
local player = chatplus.poke(name)
player.inbox = {}
chatplus.save()
minetest.chat_send_player(name,"Inbox cleared")
elseif param == "text" or param == "txt" or param == "t" then
chatplus.showInbox(name,true)
else
chatplus.showInbox(name,false)
end
end,
})
minetest.register_chatcommand("mail", {
params = "name msg",
description = "mail: add a message to a player's inbox",
func = function(name, param)
chatplus.poke(name)
local to, msg = string.match(param, "([%a%d_]+) (.+)")
if not to or not msg then
minetest.chat_send_player(name,"mail: <playername> <msg>",false)
return
end
minetest.log("To: "..to..", From: "..name..", MSG: "..msg)
if chatplus.log_handle ~= nil then
chatplus.log_handle:write(os.date("%d/%m/%Y %I:%M%p").." To: "..to..", From: "..name..", MSG: "..msg)
chatplus.log_handle:flush()
end
if chatplus.players[to] then
table.insert(chatplus.players[to].inbox,os.date("%d/%m").." <"..name..">: "..msg)
minetest.chat_send_player(name,"Message sent")
chatplus.save()
else
minetest.chat_send_player(name,"Player "..to.." does not exist")
end
end,
})
local function tick()
-- loop through player list
for key,value in pairs(chatplus.players) do
if (
chatplus.loggedin and
chatplus.loggedin[key] and
chatplus.loggedin[key].player and
value and
value.inbox and
chatplus.loggedin[key].player.hud_add and
chatplus.loggedin[key].lastcount ~= #value.inbox
) then
if chatplus.loggedin[key].msgicon then
chatplus.loggedin[key].player:hud_remove(chatplus.loggedin[key].msgicon)
end
if chatplus.loggedin[key].msgicon2 then
chatplus.loggedin[key].player:hud_remove(chatplus.loggedin[key].msgicon2)
end
if #value.inbox>0 then
chatplus.loggedin[key].msgicon = chatplus.loggedin[key].player:hud_add({
hud_elem_type = "image",
name = "MailIcon",
position = {x=0.52, y=0.52},
text="chatplus_mail.png",
scale = {x=1,y=1},
alignment = {x=0.5, y=0.5},
})
chatplus.loggedin[key].msgicon2 = chatplus.loggedin[key].player:hud_add({
hud_elem_type = "text",
name = "MailText",
position = {x=0.55, y=0.52},
text=#value.inbox,
scale = {x=1,y=1},
alignment = {x=0.5, y=0.5},
})
end
chatplus.loggedin[key].lastcount = #value.inbox
end
end
minetest.after(5, tick)
end
tick()
chatplus.register_handler(function(from,to,msg)
if chatplus.setting("distance") <= 0 then
--
-- Distance
--
chatplus.register_handler(function(from, to, msg)
local d = chatplus.setting("distance")
if d <= 0 then
return nil
end
local from_o = minetest.get_player_by_name(from)
local to_o = minetest.get_player_by_name(to)
if not from_o or not to_o then
return nil
end
if (
chatplus.setting("distance") ~= 0 and
chatplus.setting("distance") ~= nil and
(vector.distance(from_o:getpos(),to_o:getpos()) > tonumber(chatplus.setting("distance")))
)then
return false
end
return nil
return not d or vector.distance(from_o:getpos(), to_o:getpos()) <= tonumber(d)
end)
--
-- Bad words
--
chatplus.register_handler(function(from,to,msg)
local words = chatplus.setting("badwords"):split(",")
for _,v in pairs(words) do