minecraftctl 1.0.0 → 1.1.0

data/Gemfile

@@ -16,4 +16,7 @@ group :development do
   gem "main", ">= 4.7.3"
   gem "haml", ">= 3.1.3"
   gem "httpclient", ">= 2.2.1"
+  gem "open4", ">= 1.1.0"
+  gem "mongrel", ">= 1.1.5"
 end
+

data/Gemfile.lock

@@ -2,9 +2,13 @@ GEM
   remote: http://rubygems.org/
   specs:
     arrayfields (4.7.4)
+    cgi_multipart_eof_fix (2.5.0)
     chronic (0.6.4)
+    daemons (1.1.4)
     diff-lcs (1.1.3)
+    fastthread (1.0.1)
     fattr (2.2.0)
+    gem_plugin (0.2.3)
     git (1.2.5)
     haml (3.1.3)
     httpclient (2.2.1)
@@ -18,6 +22,12 @@ GEM
       fattr (~> 2.2.0)
       map (~> 4.3.0)
     map (4.3.0)
+    mongrel (1.1.5)
+      cgi_multipart_eof_fix (>= 2.4)
+      daemons (>= 1.0.3)
+      fastthread (>= 1.0.1)
+      gem_plugin (>= 0.2.3)
+    open4 (1.1.0)
     rack (1.3.2)
     rake (0.9.2)
     rcov (0.9.10)
@@ -55,6 +65,8 @@ DEPENDENCIES
   httpclient (>= 2.2.1)
   jeweler (~> 1.6.4)
   main (>= 4.7.3)
+  mongrel (>= 1.1.5)
+  open4 (>= 1.1.0)
   rcov
   reek (~> 1.2.8)
   roodi (~> 2.1.0)

data/README.rdoc

@@ -12,6 +12,15 @@ And control it with 'minecraftctl', for help try:
 
     $ minecraftctl serverhelp
 
+== Changelog
+
+=== v1.1.0
+* Output from server is streamed in real time
+* Fixed problem with initial pid file creation
+* Massive refactoring and tests
+* Added 'status' command
+* Better error detection and reporting
+
 == Contributing to minecraftctl
  
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/bin/minecraftctl

@@ -2,18 +2,22 @@
 require 'rubygems'
 require 'main'
 require 'httpclient'
+require 'thread'
+Thread.abort_on_exception = true
 
 Main do
 	description 'controls Minecraft via minecraftctlserver'
-	
+
 	option 'server', 's' do
 		default 'localhost'
 		description 'minecraftctlserver address'
+		argument_required
 	end
 
 	option 'port', 'p' do
 		default 25560
 		description 'minecraftctlserver port'
+		argument_required
 	end
 
 	argument 'command' do
@@ -38,13 +42,18 @@ Main do
 
 			args = params['arguments'].values
 
-			if ['log', 'inspect', 'list', 'help'].include? command
-				puts c.get_content("http://#{params['server'].value}:#{params['port'].value}/#{command}")
+			if ['status', 'log', 'inspect', 'list', 'help'].include? command
+				c.get_async("http://#{params['server'].value}:#{params['port'].value}/#{command}").pop.content.each do |line|
+					puts line
+				end
 			else
-				puts c.post_content("http://#{params['server'].value}:#{params['port'].value}/#{command}", args.join("\n"))
+				c.post_async("http://#{params['server'].value}:#{params['port'].value}/#{command}", args.join("\n")).pop.content.each do |line|
+					puts line
+				end
 			end
 		rescue Errno::ECONNREFUSED => e
 			puts "Falied to connect to minecraftctlserver; please run minecraftctlserver: #{e}"
 		end
 	end
 end
+

data/bin/minecraftctlserver

@@ -5,181 +5,37 @@ require 'open3'
 require 'thread'
 require 'pathname'
 
-class Message
-	def initialize(msg)
-		@msg = msg
-	end
-
-	attr_reader :msg
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-	def to_s
-		@msg
-	end
+require 'minecraft'
+require 'message_collector'
 
-	class Internal < Message
-		def initialize(msg)
-			super(' -- ' + msg)
-		end
+class MessageCollectorProcessed < MessageCollector
+	def initialize(&operations)
+		super(&operations)
+		@processors = []
 	end
 
-	class Out < Message
+	def process(&block)
+		@processors << block
+		self
 	end
 
-	class Err < Message
-		def initialize(line)
-			x, @time, @level, @msg = *line.match(/^([^ ]* [^ ]*) \[([^\]]*)\] (.*)/)
-		end
-
-		attr_reader :time, :level, :msg
-
-		def to_s
-			@msg
+	def collect(msg)
+		@processors.each do |processor|
+			msg = processor.call(msg)
 		end
+		@collector.call(msg) if msg
 	end
 end
 
-class Minecraft
-	def initialize(cmd)
-		@cmd = cmd
-		@in_queue = Queue.new
-		@out_queue = Queue.new
-
-		@running = false
-
-		@history = []
-		@recent = []
-	end
-
-	def running?
-		@running
-	end
-
-	def start
-		collect_msg do
-			if @running
-				internal_msg "Server already running"
-			else
-				time_operation("Server start") do
-					@stdin, stdout, stderr = Open3.popen3(@cmd) 
-					@running = true
-
-					@out_reader = Thread.new do
-						stdout.each do |line|
-							puts "OUT: #{line}"
-							@out_queue << Message::Out.new(line)
-						end
-					end
-
-					@err_reader = Thread.new do
-						stderr.each do |line|
-							puts "ERR: #{line}"
-							@out_queue << Message::Err.new(line)
-						end
-					end
-
-					wait_msg do |m|
-						m.msg =~ /Done \(([^n]*)ns\)!/
-					end
-				end
-			end
+class TextCollector < MessageCollectorProcessed
+	def initialize(&operations)
+		super
+		process do |msg|
+			msg.to_s + "\n"
 		end
 	end
-
-	def stop
-		unless @running
-			return collect_msg do
-				internal_msg "Server already stopped"
-			end
-		else
-			return command('stop') do
-				@running = false
-				time_operation("Server stop") do
-					@out_reader.join
-					@err_reader.join
-				end
-			end
-		end
-	end
-
-	def save_all
-		command('save-all') do
-			time_operation("Save") do
-				wait_msg{|m| m.msg =~ /Save complete/}
-			end
-		end
-	end
-
-	def list
-		command('list') do
-			wait_msg{|m| m.msg =~ /Connected players:/}
-		end
-	end
-
-	def command(cmd)
-		raise RuntimeError, "server not running" unless @running
-		collect_msg do
-			@stdin.write("#{cmd}\n")
-			if block_given?
-				yield 
-			else
-				active_wait
-			end
-		end
-	end
-
-	def history
-		archive_msg
-		@history
-	end
-
-	private
-
-	def flush_msg
-		until @out_queue.empty? 
-			@recent << @out_queue.pop(true)
-		end
-	end
-
-	def archive_msg
-		flush_msg
-		recent = @recent.dup
-		@history += @recent
-		@recent.clear
-		recent
-	end
-
-	def collect_msg
-		archive_msg
-		yield
-		archive_msg
-	end
-
-	def internal_msg(msg)
-		@out_queue << Message::Internal.new(msg)
-	end
-
-	def time_operation(name)
-		start = Time.now
-		yield
-		internal_msg "#{name} finished in #{(Time.now - start).to_f}"
-	end
-
-	def wait_msg(discard = false)
-		loop do
-			msg = @out_queue.pop
-			if yield msg
-				@recent << msg unless discard
-				break
-			end
-			@recent << msg
-		end
-	end
-
-	def active_wait
-		@stdin.write("list\n")
-		wait_msg(true){|m| m.msg =~ /Connected players:/}
-	end
-
 end
 
 class Daemon
@@ -188,7 +44,7 @@ class Daemon
 		Process.setsid # become session leader
 		exit if fork # and exits
 		# now in child
-	
+
 		# try to lock before we kill stdin/out
 		lock(pid_file)
 
@@ -205,7 +61,7 @@ class Daemon
 	end
 
 	def self.lock(pid_file)
-		pf = File.open(pid_file, 'r+')
+		pf = File.open(pid_file, File::RDWR | File::CREAT)
 		fail "Server already running with pid: #{pf.read}" unless pf.flock(File::LOCK_EX|File::LOCK_NB)
 		pf.truncate(0)
 		pf.write(Process.pid.to_s)
@@ -219,11 +75,13 @@ Main do
 	option 'command', 'c' do
 		default 'java -Xms256M -Xmx512M -Djava.net.preferIPv4Stack=true -jar minecraft_server.jar nogui'
 		description 'command to be used to span server'
+		argument_required
 	end
 
 	option 'port', 'p' do
 		default 25560
 		description 'port on which the control HTTP server should be running'
+		argument_required
 	end
 
 	option 'foreground', 'f' do
@@ -233,15 +91,18 @@ Main do
 	option 'pid-file', 'P' do
 		description 'pid file relative to minecraft-dir'
 		default 'minecraftctlserver.pid'
+		argument_required
 	end
 
 	option 'log-file', 'l' do
 		description 'log file relative to minecraft-dir when in not in foreground'
 		default 'minecraftctlserver.log'
+		argument_required
 	end
 
 	argument 'minecraft-dir' do
 		description 'directory path to mincraft server installation directory'
+		argument_required
 	end
 
 	run do
@@ -265,59 +126,77 @@ Main do
 
 		s = Sinatra.new
 		s.set :port, params['port'].value
+		s.set :environment, 'production'
+		s.set :server, ['mongrel']
+		s.set :lock, true
 
 		s.post '/save-all' do
-			@msg = minecraft.save_all
-			haml :messages
+			TextCollector.for(minecraft) do
+				save_all
+			end
 		end
 
 		s.post '/start' do
-			@msg = minecraft.start
-			haml :messages
+			TextCollector.for(minecraft) do
+				start
+			end
 		end
 
 		s.post '/stop' do
-			@msg = minecraft.stop
-			haml :messages
+			TextCollector.for(minecraft) do
+				stop
+			end
 		end
 
 		s.post '/shutdown' do
-			@msg = minecraft.stop
-
-			pid = Process.pid
-			Thread.new{ sleep 1; Process.kill(15, pid)}
+			TextCollector.for(minecraft) do
+				stop
 
-			haml :messages
+				pid = Process.pid
+				Thread.new{ sleep 1; Process.kill(15, pid)}
+			end
 		end
 
 		s.post %r{/(.+)} do |cmd|
 			args = request.body.read.split("\n")
-			@msg = minecraft.command(cmd + " " + args.join(' '))
-			haml :messages
+			TextCollector.for(minecraft) do
+				send(cmd.tr('-', '_').to_sym, *args)
+			end
 		end
 
 		s.get '/help' do
 			start = false
-			@msg = minecraft.command('help').
-			map{|m| m.msg}.
-			select do |m|
-				next true if start
-				if m =~ /Console commands:/
+			TextCollector.for(minecraft) do
+				help
+				log "status                    show server status"
+				log "log                       show recent server messages"
+				log "inspect                   inspect recent server messages"
+			end.process do |msg|
+				msg = msg.to_s
+
+				if msg =~ /Console commands:/
 					start = true 
-					next false
+					next
 				end
-			end.
-			map{|m| m.sub(/help  or  \?/, 'serverhelp ')}.
-			map{|m| m.sub(/^( |\t)*/, '')}
-			@msg << "log                       show recent server messages"
-			@msg << "inspect                   inspect recent server messages"
 
-			haml :messages
+				next unless start
+				msg.sub(/help  or  \?/, 'serverhelp ').sub(/^( |\t)*/, '')
+			end
 		end
 
 		s.get '/list' do
-			@msg = minecraft.list
-			haml :messages
+			TextCollector.for(minecraft) do
+				list
+			end
+		end
+
+		s.get '/status' do
+			if minecraft.running?
+				@pid = minecraft.server_pid
+				haml :status_running
+			else
+				haml :status_stopped
+			end
 		end
 
 		s.get '/inspect' do
@@ -330,9 +209,12 @@ Main do
 			haml :messages
 		end
 
-		s.get %r{/(.+)} do |cmd|
-			@msg = minecraft.command(cmd)
-			haml :messages
+		s.template :status_running do
+			'= "Minecraft server is running with pid: #{@pid}"'
+		end
+
+		s.template :status_stopped do
+			'= "Minecraft server is stopped"'
 		end
 
 		s.template :messages do
@@ -343,6 +225,18 @@ Main do
 			'= @msg.map{|m| m.inspect}.join("\n")'
 		end
 
+		s.not_found do
+			"Request '#{env['REQUEST_PATH']}' not supported, please see '/serverhelp' for details\n"
+		end
+
+		s.error do
+			"Error in minecraftctlserver while processing request '#{env['REQUEST_PATH']}': #{env['sinatra.error']}\n" 
+		end
+
 		s.run!
+
+		# make sure we stop the server on exit
+		minecraft.stop if minecraft.running?
 	end
 end
+