Half implemented new on_tick() feature, and proper schedule module.

Author: minecraft server

helpers.py

@@ -57,36 +57,18 @@ def all_users():
 	return [name[:-4] for name in os.listdir(os.path.join(WORLD_DIR, 'players'))]
 
 
-locks = set()
-def tell(user, message, delay=0, lock=None, prefix=''):
+def tell(user, message, prefix=''):
 	"""Send a server message to user.
 	Note: Splits multiline messages. See prefix, below.
 	Optional args:
-		delay: Wait delay seconds before sending message. Useful mainly with lock. See below.
-		lock: Until message sent (see delay) allow no new messages with the same user and lock value.
-			Generally speaking, expected to be a string. But it doesn't really matter.
 		prefix: Add given prefix to every line sent, eg '<server>: '.
-	Returns bool of whether message was sent (see lock)
 	"""
-	global locks
-	if lock is not None:
-		if (user, lock) in locks:
-			return False
-		else:
-			locks.add((user, lock))
 	message = unicode(message)
-	def tell_send():
-		reverse = dict([(y,x) for x,y in packet_names.items()])
-		for line in message.split('\n'):
-			packet = Packet()
-			packet.ident = reverse['Chat message']
-			packet.direction = SERVER_TO_CLIENT
-			packet.data = {'text': line}
-			send_packet(packet, user, False)
-		if lock is not None:
-			locks.remove((user, lock))
 
-	if delay:
-		schedule(tell_send, delay)
-	else:
-		tell_send()
+	reverse = dict([(y,x) for x,y in packet_names.items()])
+	for line in message.split('\n'):
+		packet = Packet()
+		packet.ident = reverse['Chat message']
+		packet.direction = SERVER_TO_CLIENT
+		packet.data = {'text': line}
+		send_packet(packet, user, False)

plugins.py

@@ -12,6 +12,8 @@
 plugins.append(log_all)
 plugins.append(log_sorted) # Always first to catch all raw packets
 plugins.append(usernames) # The earlier the better, name the login packets sooner.
+plugins.append(schedule) # Before anything that depends on it.
+plugins.append(plugin_helpers) # Lots of things depend on this. Do it early.
 plugins.append(timed_events) # Before anything that depends on it. Not working yet.
 plugins.append(cmd) # Should probably be before anything that depends on it
 plugins.append(welcome) # Has /help, so high priority. But should be after usernames (for the welcome)

plugins/no_changes.py

@@ -2,7 +2,7 @@
 Note this is a lengthy operation and should be used sparingly."""
 
 import packet_decoder
-import simple_logging as logging
+import logging
 
 def on_start():
 	pass

plugins/plugin_helpers.py

@@ -0,0 +1,42 @@
+
+AUTHOR = "ekimekim"
+CONTACT = "[email protected]"
+DESCRIPTION = """This, like helpers.py, is for helper functions.
+However, it is reserved for functions that require other plugins to work.
+This cannot be done from helpers.py.
+Hence we have a helper plugin.
+"""
+
+import helpers
+from schedule import schedule
+
+
+locks = set()
+def tell(user, message, delay=0, lock=None, prefix=''):
+	"""Send a server message to user.
+	Note: Splits multiline messages. See prefix, below.
+	Optional args:
+		delay: Wait delay seconds before sending message. Useful mainly with lock. See below.
+		lock: Until message sent (see delay) allow no new messages with the same user and lock value.
+			Generally speaking, expected to be a string. But it doesn't really matter.
+		prefix: Add given prefix to every line sent, eg '<server>: '.
+	Returns bool of whether message was sent (see lock).
+
+	Note: Apart from delay and lock args, this function acts like helpers.tell()
+	"""
+	global locks
+	if lock is not None:
+		if (user, lock) in locks:
+			return False
+		else:
+			locks.add((user, lock))
+	message = unicode(message)
+	def tell_send():
+		helpers.tell(user, message, prefix=prefix)
+		if lock is not None:
+			locks.remove((user, lock))
+
+	if delay:
+		schedule(tell_send, delay)
+	else:
+		tell_send()

plugins/schedule.py

@@ -0,0 +1,20 @@
+import time
+
+events = [] # (time, event) - time is float epoch
+
+def schedule(delay, callback_fn):
+	"""Schedule callback_fn to run after (at least) delay seconds."""
+	new_time = time.time() + delay
+	for i in range(len(events)):
+		event_time, event = events[i]
+		if event_time > new_time:
+			events.insert(i, (new_time, callback_fn))
+			break
+	else:
+		events.append((new_time, callback_fn))
+
+def on_tick(users):
+	now = time.time()
+	while events and now >= events[0][0]:
+		events[0][1]()
+		events.pop(0)

plugins/timed_events.py

@@ -3,20 +3,24 @@
 CONTACT = '[email protected]'
 DESCRIPTION = """A module for registering a callback to occur at a later time."""
 
-def on_start():
-	pass
 
-def on_packet(packet, user, to_server):
-	return packet
-
-def on_tick():
-	pass # TODO
+events = [] # ordered list of (time, key, callback)
+#TODO UPTO
 
 def register(timeout, callback, key=None):
 	"""Register a callback to occur after given timeout (int or float, seconds).
 	If key is given, it will replace an old timeout (if any) with the same key.
 	"""
-	pass # TODO
+	new_time = time.time() + delay
+	for i in range(len(events)):
+		event_time, event = events[i]
+		if event_time > new_time:
+			events.insert(i, (new_time, callback_fn))
+			break
+	else:
+		events.append((new_time, callback_fn))
+
+
 
 def check(key):
 	"""Returns time remaining for timeout with given key.
@@ -29,3 +33,12 @@ def clear(key):
 	If no such timeout exists, raises KeyError.
 	"""
 	pass # TODO
+
+def schedule(delay, callback_fn):
+	"""Schedule callback_fn to run after (at least) delay seconds."""
+
+def on_tick(users):
+	now = time.time()
+	while events and now >= events[0][0]:
+		events[0][1]()
+		events.pop(0)

proxy.py

@@ -69,8 +69,8 @@ def main():
 
 	logging.debug("Started up")
 
-#	signal(signal.SIGALRM, handle_tick)
-#	setitimer(signal.ITIMER_REAL, TICK_INTERVAL, TICK_INTERVAL)
+	signal(signal.SIGALRM, handle_tick)
+	setitimer(signal.ITIMER_REAL, TICK_INTERVAL, TICK_INTERVAL)
 
 	try:
 		while 1:
@@ -265,6 +265,12 @@ def daemonise():
 		sys.exit(0)
 
 
+def handle_tick(sig, frame):
+	for plugin in plugins:
+		if hasattr(plugin, 'on_tick'):
+			plugin.on_tick(set(user_map.values()))
+
+
 def handle_packet(packet, user, to_server):
 	"""
 		packet: The packet object recieved

schedule.py

@@ -1,4 +1,4 @@
-"""On import, sets up SIGUSR1 to print a traceback as INFO for simple_logging"""
+"""On import, sets up SIGUSR1 to print a traceback as INFO for python logging"""
 
 import signal, traceback
 import logging