Better error and irc logging

Author: MCvarial

resources/irc/meta.xml

@@ -71,10 +71,30 @@
 			examples="true,false"
 			desc="Should all irc messages be sent to the server?"
 		/>
+		
+		<!-- Event logging -->
+		<setting name="*irc-onResourceStart"            value="true" friendlyname="output onResourceStart event"            examples="true,false" />
+		<setting name="*irc-onResourceStop"             value="true" friendlyname="output onResourceStop event"             examples="true,false" />
+		<setting name="*irc-onPlayerJoin"               value="true" friendlyname="output onPlayerJoin event"               examples="true,false" />
+		<setting name="*irc-onPlayerQuit"               value="true" friendlyname="output onPlayerQuit event"               examples="true,false" />
+		<setting name="*irc-onPlayerChangeNick"         value="true" friendlyname="output onPlayerChangeNick event"         examples="true,false" />
+		<setting name="*irc-onPlayerMute"               value="true" friendlyname="output onPlayerMute event"               examples="true,false" />
+		<setting name="*irc-onPlayerUnmute"             value="true" friendlyname="output onPlayerUnmute event"             examples="true,false" />
+		<setting name="*irc-onPlayerChat"               value="true" friendlyname="output onPlayerChat event"               examples="true,false" />
+		<setting name="*irc-onSettingChange"            value="true" friendlyname="output onSettingChange event"            examples="true,false" />
+		<setting name="*irc-onPlayerWasted"             value="true" friendlyname="output onPlayerWasted event"             examples="true,false" />
+		<setting name="*irc-onPlayerFinish"             value="true" friendlyname="output onPlayerFinish event"             examples="true,false" />
+		<setting name="*irc-onGamemodeMapStart"         value="true" friendlyname="output onGamemodeMapStart event"         examples="true,false" />
+		<setting name="*irc-onPlayerToptimeImprovement" value="true" friendlyname="output onPlayerToptimeImprovement event" examples="true,false" />
+		<setting name="*irc-onBan"                      value="true" friendlyname="output onBan event"                      examples="true,false" />
+		<setting name="*irc-onUnban"                    value="true" friendlyname="output onUnban event"                    examples="true,false" />
+		<setting name="*irc-onPlayerFreeze"             value="true" friendlyname="output onPlayerFreeze event"             examples="true,false" />
+		<setting name="*irc-adminMessage"               value="true" friendlyname="output adminMessage event"               examples="true,false" />
+		<setting name="*irc-onPollStuff"                value="true" friendlyname="output onPollStuff events"               examples="true,false" />
 	</settings>
 
 	<!-- Don't touch anything below! -->
-	<info author="MCvarial" version="1.0.4" type="misc" name="irc" description="Echobot to be used on irc" />
+	<info author="MCvarial" version="1.0.5" type="misc" name="irc" description="Echobot to be used on irc" />
 
 	<export function="ircGetChannelFromName"       type="server" http="false" />
 	<export function="ircGetEchoChannels"          type="server" http="false" />

resources/irc/scripts/echo.lua

@@ -13,6 +13,7 @@ local messages = {}
 
 addEventHandler("onResourceStart",root,
 	function (resource)
+		if get("*irc-onResourceStart") ~= "true" then return end
 		if getResourceInfo(resource,"type") ~= "map" then
 			outputIRC("07* Resource '"..getResourceName(resource).."' started!")
 		end
@@ -26,6 +27,7 @@ addEventHandler("onResourceStart",root,
 
 addEventHandler("onResourceStop",root,
 	function (resource)
+		if get("*irc-onResourceStop") ~= "true" then return end
 		if getResourceInfo(resource,"type") ~= "map" then
 			outputIRC("07* Resource '"..(getResourceName(resource) or "?").."' stopped!")
 		end
@@ -34,13 +36,15 @@ addEventHandler("onResourceStop",root,
 
 addEventHandler("onPlayerJoin",root,
 	function ()
+		if get("*irc-onPlayerJoin") ~= "true" then return end
 		messages[source] = 0
 		outputIRC("03*** "..getPlayerName(source).." joined the game.")
 	end
 )
 
 addEventHandler("onPlayerQuit",root,
 	function (quit,reason,element)
+		if get("*irc-onPlayerQuit") ~= "true" then return end
 		messages[source] = nil
 		if reason then
 			if element then
@@ -56,6 +60,7 @@ addEventHandler("onPlayerQuit",root,
 
 addEventHandler("onPlayerChangeNick",root,
 	function (oldNick,newNick)
+		if get("*irc-onPlayerChangeNick") ~= "true" then return end
 		setTimer(function (player,oldNick)
 			local newNick = getPlayerName(player)
 			if newNick ~= oldNick then
@@ -67,6 +72,7 @@ addEventHandler("onPlayerChangeNick",root,
 
 addEventHandler("onPlayerMute",root,
 	function (arg)
+		if get("*irc-onPlayerMute") ~= "true" then return end
 		if type(arg) ~= "nil" then return end
 		local result = executeSQLSelect("ircmutes","serial,reason","serial = '"..getPlayerSerial(source).."'")
 		if result and result[1] then
@@ -84,12 +90,14 @@ addEventHandler("onPlayerMute",root,
 
 addEventHandler("onPlayerUnmute",root,
 	function ()
+		if get("*irc-onPlayerUnmute") ~= "true" then return end
 		outputIRC("12* "..getPlayerName(source).." has been unmuted")
 	end
 )
 
 addEventHandler("onPlayerChat",root,
 	function (message,type)
+		if get("*irc-onPlayerChat") ~= "true" then return end
 		messages[source] = messages[source] + 1
 		if type == 0 then
 			outputIRC("07"..getPlayerName(source)..": "..message)
@@ -115,6 +123,7 @@ addEventHandler("onPlayerChat",root,
 
 addEventHandler("onSettingChange",root,
 	function (setting,oldValue,newValue)
+		if get("*irc-onSettingChange") ~= "true" then return end
 		outputIRC("6Setting '"..tostring(setting).."' changed: "..tostring(oldValue).." -> "..tostring(newValue))
 	end
 )
@@ -125,6 +134,7 @@ weapons[19] = "Rockets"
 weapons[88] = "Fire"
 addEventHandler("onPlayerWasted",root,
 	function (ammo,killer,weapon,bodypart)
+		if get("*irc-onPlayerWasted") ~= "true" then return end
 		if killer then
 			if getElementType(killer) == "vehicle" then
 				local driver = getVehicleController(killer)
@@ -148,17 +158,29 @@ addEventHandler("onPlayerWasted",root,
 		end
 	end
 )
+
+addEvent("onPlayerRaceWasted")
+addEventHandler("onPlayerRaceWasted",root,
+	function (vehicle)
+		if get("*irc-onPlayerRaceWasted") ~= "true" then return end
+		if #getAlivePlayers() == 1 and currentmode ~= "Sprint" then
+			outputIRC("12* "..getPlayerName(getAlivePlayers()[1]).." won the deathmatch!")
+		end
+	end
+)
 
 addEvent("onPlayerFinish",true)
 addEventHandler("onPlayerFinish",root,
 	function (rank,time)
+		if get("*irc-onPlayerFinish") ~= "true" then return end
 		outputIRC("12* "..getPlayerName(source).." finished (rank: "..rank.." time: "..msToTimeStr(time)..")")
 	end
 )
 
 addEvent("onGamemodeMapStart",true)
 addEventHandler("onGamemodeMapStart",root,
 	function (res)
+		if get("*irc-onGamemodeMapStart") ~= "true" then return end
 		outputIRC("12* Map started: "..(getResourceInfo(res, "name") or getResourceName(res)))
 		local resource = getResourceFromName("mapratings")
 		if resource and getResourceState(resource) == "running" and exports.mapratings:getMapRating(getResourceName(res)) and exports.mapratings:getMapRating(getResourceName(res)).average then
@@ -170,6 +192,7 @@ addEventHandler("onGamemodeMapStart",root,
 addEvent("onPlayerToptimeImprovement",true)
 addEventHandler("onPlayerToptimeImprovement",root,
 	function (newPos,newTime,oldPos,oldTime)
+		if get("*irc-onPlayerToptimeImprovement") ~= "true" then return end
 		if newPos == 1 then
 			outputIRC("07* New record: "..msToTimeStr(newTime).." by "..getPlayerName(source).."!")
 		end
@@ -178,31 +201,25 @@ addEventHandler("onPlayerToptimeImprovement",root,
 
 addEventHandler("onBan",root,
 	function (ban)
+		if get("*irc-onBan") ~= "true" then return end
 		outputIRC("12* Ban added by "..(getPlayerName(source) or "Console")..": name: "..(getBanNick(ban) or "/")..", ip: "..(getBanIP(ban) or "/")..", serial: "..(getBanSerial(ban) or "/")..", banned by: "..(getBanAdmin(ban) or "/").." banned for: "..(getBanReason(ban) or "/"))
 	end
 )
 
 addEventHandler("onUnban",root,
 	function (ban)
+		if get("*irc-onUnban") ~= "true" then return end
 		outputIRC("12* Ban removed by "..(getPlayerName(source) or "Console")..": name: "..(getBanNick(ban) or "/")..", ip: "..(getBanIP(ban) or "/")..", serial: "..(getBanSerial(ban) or "/")..", banned by: "..(getBanAdmin(ban) or "/").." banned for: "..(getBanReason(ban) or "/"))
 	end
 )
 
-addEvent("onPlayerRaceWasted")
-addEventHandler("onPlayerRaceWasted",root,
-	function (vehicle)
-		if #getAlivePlayers() == 1 and currentmode ~= "Sprint" then
-			outputIRC("12* "..getPlayerName(getAlivePlayers()[1]).." won the deathmatch!")
-		end
-	end
-)
-
 ------------------------------------
 -- Admin interaction
 ------------------------------------
 addEvent("onPlayerFreeze")
 addEventHandler("onPlayerFreeze",root,
 	function (state)
+		if get("*irc-onPlayerFreeze") ~= "true" then return end
 		if state then
 			outputIRC("12* "..getPlayerName(source).." was frozen!")
 		else
@@ -214,6 +231,7 @@ addEventHandler("onPlayerFreeze",root,
 addEvent("aMessage",true)
 addEventHandler("aMessage",root,
 	function (Type,t)
+		if get("*irc-adminMessage") ~= "true" then return end
 		if Type ~= "new" then return end
 
 		for i,channel in ipairs (ircGetEchoChannels()) do
@@ -251,6 +269,7 @@ addEventHandler("onPollModified",root,
 addEvent("onPollStart")
 addEventHandler("onPollStart",root,
 	function ()
+		if get("*irc-onPollStuff") ~= "true" then return end
 		if pollTitle then
 			outputIRC("14* A vote was started ["..tostring(pollTitle).."]")
 		end
@@ -260,6 +279,7 @@ addEventHandler("onPollStart",root,
 addEvent("onPollStop")
 addEventHandler("onPollStop",root,
 	function ()
+		if get("*irc-onPollStuff") ~= "true" then return end
 		if pollTitle then
 			pollTitle = nil
 			outputIRC("14* Vote stopped!")
@@ -270,6 +290,7 @@ addEventHandler("onPollStop",root,
 addEvent("onPollEnd")
 addEventHandler("onPollEnd",root,
 	function ()
+		if get("*irc-onPollStuff") ~= "true" then return end
 		if pollTitle then
 			pollTitle = nil
 			outputIRC("14* Vote ended!")
@@ -280,6 +301,7 @@ addEventHandler("onPollEnd",root,
 addEvent("onPollDraw")
 addEventHandler("onPollDraw",root,
 	function ()
+		if get("*irc-onPollStuff") ~= "true" then return end
 		if pollTitle then
 			pollTitle = nil
 			outputIRC("14* A draw was reached!")

resources/irc/scripts/loading.lua

@@ -46,7 +46,7 @@ addEventHandler("onResourceStart",resourceRoot,
 			end
 		end
 		if #missingRights ~= 0 then
-			outputDebugString("IRC: "..#missingRights.." missing rights: ")
+			outputDebugString("irc is missing "..#missingRights.." rights: ")
 			for i,missingRight in ipairs (missingRights) do
 				outputDebugString("	- "..missingRight)
 			end
@@ -99,8 +99,10 @@ addEventHandler("onResourceStart",resourceRoot,
 			end
 			xmlUnloadFile(aclFile)
 		else
-			outputServerLog("IRC: could not start resource, the acl file can't be loaded!")
-			outputServerLog("IRC: restart the resource to retry")
+			outputDebugString("could not start the irc resource, the acl file can't be loaded!")
+			outputDebugString("try to start the resource again to retry")
+			startupCancelled = true
+			cancelEvent()
 			return
 		end
 
@@ -149,11 +151,11 @@ function internalConnect ()
 			local secure = xmlNodeGetAttribute(server,"secure") == "true" or false
 			local nspass = xmlNodeGetAttribute(server,"nickservpass") or xmlNodeGetAttribute(server,"nickserverpass") or false
 			if not host then
-				outputServerLog("IRC: problem with server #"..i..", no host given!")
+				outputDebugString("problem with irc server #"..i..", no host given!")
 			elseif not nick then
-				outputServerLog("IRC: problem with server #"..i..", no nick given!")
+				outputDebugString("problem with irc server #"..i..", no nick given!")
 			elseif not channels then
-				outputServerLog("IRC: problem with server #"..i..", no channels given!")
+				outputDebugString("problem with irc server #"..i..", no channels given!")
 			else
 				local server = ircConnect(host,nick,port,password,secure)
 				if server then
@@ -164,14 +166,16 @@ function internalConnect ()
 						ircJoin(server,gettok(channel,1,32),gettok(channel,2,32))
 					end
 				else
-					outputServerLog("IRC: problem with server #"..i..", could not connect ("..tostring(getSocketErrorString(sockError)..")"))
+					outputDebugString("problem with irc server #"..i..", could not connect ("..tostring(getSocketErrorString(sockError)..")"))
 				end
 			end
 		end
 		xmlUnloadFile(settingsFile)
 	else
-		outputServerLog("IRC: could not start resource, the settings.xml can't be parsed!")
-		outputServerLog("IRC: restart the resource to retry")
+		outputDebugString("could not start the irc resource, the settings.xml can't be parsed!")
+		outputDebugString("try to start the resource again to retry")
+		startupCancelled = true
+		cancelEvent()
 		return
 	end
 end

resources/irc/scripts/servers.lua

@@ -158,7 +158,7 @@ function func_ircConnect (host,nick,port,password,secure)
 		return server
 	end
 	if sockError then
-		outputServerLog("IRC: Failed to connect to "..tostring(host).." reason: "..getSocketErrorString(sockError))
+		outputDebugString("irc failed to connect to "..tostring(host).." reason: "..getSocketErrorString(sockError))
 	end
 	return false
 end