sbcp 0.1.4 → 0.2.3

data/config.yml

@@ -2,8 +2,10 @@
 starbound_directory: ~
 backup_directory: ~
 backup_history: 90
-backup_schedule: 1
+backup_schedule: hourly
 log_directory: ~
 log_history: 90
 log_style: daily
+duplicate_names: false
+duplicate_kick_msg: Another player is currently online with your character's name.
 restart_schedule: 4

data/lib/sbcp.rb

@@ -1,38 +1,270 @@
-require 'sinatra/base'
-require 'sinatra/contrib'
-require 'sinatra/flash'
-require 'securerandom'
-require 'fileutils'
-require 'logger'
+# SBCP - Starbound Server Management Solution for Linux Servers
+# Copyright (C) 2016 Kazyyk
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'highline/import'
+require 'celluloid/current'
+require 'time_diff'
+require 'tempfile'
 require 'yaml'
+require 'pp'
 
-require 'sbcp/daemon'
+require_relative 'sbcp/backup'
+require_relative 'sbcp/config'
+require_relative 'sbcp/daemon'
+require_relative 'sbcp/rcon'
+require_relative 'sbcp/setup'
 
 module SBCP
-	class Panel < Sinatra::Base
-		register Sinatra::Contrib
-		register Sinatra::Flash
-		config = YAML.load_file(File.expand_path('../../config.yml', __FILE__))
-		configure do
-			set :environment, :development
-			set :server, 'thin'
-			set :threaded, true
-			set :bind, '0.0.0.0'
-			use Rack::Session::Cookie, 
-				:key => 'rack.session',
-				:path => '/',
-				:expire_after => 3600 # In seconds
-		end
-		Process.daemon unless settings.environment == :development
-		# First thing's first, we create a file containing the current process pid.
-		# This is used later when we need to grace or force quit SBCP.
-		# Note to self: Don't forget to close and unlink
-		pid_file = Tempfile.new('sbcp_panel-pid')
-		pid_file.write(Process.pid.to_s)
-		# Require any present plugins
-		plugins_directory = "#{config['starbound_directory']}/sbcp/plugins"
-		$LOAD_PATH.unshift(plugins_directory)
-		Dir[File.join(plugins_directory, '*.rb')].each {|file| require File.basename(file) }
-		run! if app_file == $0
+	class SBCP
+		def initialize
+			@config = YAML.load_file(File.expand_path('../../config.yml', __FILE__))
+			@commands = ['backup', 'clear', 'config', 'detach', 'exit', 'get', 'kill', 'quit', 'reboot', 'restart', 'say', 'setup', 'start', 'stop', 'help']
+			@commands_scheme = [
+				"<%= color('backup', :command) %>",
+				"<%= color('clear', :command) %>",
+				"<%= color('config', :command) %>",
+				"<%= color('detach', :command) %>",
+				"<%= color('exit', :command) %>",
+				"<%= color('get', :command) %>",
+				"<%= color('kill', :command) %>",
+				"<%= color('quit', :command) %>",
+				"<%= color('reboot', :command) %>",
+				"<%= color('restart', :command) %>",
+				"<%= color('say', :command) %>",
+				"<%= color('setup', :command) %>",
+				"<%= color('start', :command) %>",
+				"<%= color('stop', :command) %>",
+				"<%= color('help', :command) %>"
+			]
+			scheme = HighLine::ColorScheme.new do |cs|
+				cs[:headline] =		[ :bold, :yellow, :on_black ]
+				cs[:subheader] =	[ :cyan, :on_black ]
+				cs[:command] =		[ :green, :on_black ]
+				cs[:warning] = 		[ :red, :on_black ]
+				cs[:failure] =		[ :bold, :red, :on_black ]
+				cs[:success] =		[ :bold, :green, :on_black]
+				cs[:info] =			[ :bold, :blue, :on_black ]
+				cs[:help] =			[ :magenta, :on_black ]
+			end
+			HighLine.color_scheme = scheme
+		end
+
+		def repl
+			system('clear')
+			say("<%= color(' .d8888b.  888888b.    .d8888b.  8888888b.', :headline) %>")
+			say("<%= color('d88P  Y88b 888  \"88b  d88P  Y88b 888   Y88b', :headline) %>")
+			say("<%= color('Y88b.      888  .88P  888    888 888    888', :headline) %>")
+			say("<%= color(' \"Y888b.   8888888K.  888        888   d88P', :headline) %>")
+			say("<%= color('    \"Y88b. 888  \"Y88b 888        8888888P\"', :headline) %>")
+			say("<%= color('      \"888 888    888 888    888 888', :headline) %>")
+			say("<%= color('Y88b  d88P 888   d88P Y88b  d88P 888', :headline) %>")
+			say("<%= color(' \"Y8888P\"  8888888P\"   \"Y8888P\"  888', :headline) %>")
+			say("<%= color('       (    (        *       ) (', :subheader) %>")
+			say("<%= color('   (   )\\ ) )\\ )   (  `   ( /( )\\ )', :subheader) %>")
+			say("<%= color('   )\\ (()/((()/(   )\\))(  )\\()|()/(  (', :subheader) %>")
+			say("<%= color(' (((_) /(_))/(_)) ((_)()\\((_)\\ /(_)) )', :subheader) %>")
+			say("<%= color(' )\\___(_)) (_))   (_()((_) ((_|_))_ ((_)', :subheader) %>")
+			say("<%= color('((/ __| |  |_ _|  |  \\/  |/ _ \\|   \\| __|', :subheader) %>")
+			say("<%= color(' | (__| |__ | |   | |\\/| | (_) | |) | _|', :subheader) %>")
+			say("<%= color('  \\___|____|___|  |_|  |_|\\___/|___/|___|', :subheader) %>")
+			say("\n")
+			loop do
+				input = ask('> ')
+				case input
+				when /^(backup|backup\s?(\S+))$/
+					backup($2)
+				when 'clear'
+					system('clear')
+				when 'config'
+					Config.new.config_menu(:main)
+				when 'detach'
+					system('screen -d')
+				when 'exit', 'quit'
+					say("<%= color('!!! This action could result in data loss !!!', :warning) %>")
+					say("<%= color('!!! Starbound shall be stopped if running !!!', :warning) %>")
+					if agree("Are you sure? ", true)
+						stop('SIGKILL') unless `pidof starbound_server`.empty?
+						exit
+					end
+				when /^(get|get\s?(\S+))$/
+					get($2)
+				when 'kill'
+					say("<%= color('!!! This action could result in data loss !!!', :warning) %>")
+					if agree("Are you sure? ", true)
+						stop('SIGKILL')
+					end
+				when 'reboot'
+					say("<%= color('!!! This action could result in data loss !!!', :warning) %>")
+					if agree("Are you sure? ", true)
+						restart('SIGKILL')
+					end
+				when 'restart'
+					if agree("Are you sure? ", true)
+						restart
+					end
+				when /^(say|say\s?(.+))$/
+					sb_say($2)
+				when 'setup'
+					Setup.new.run
+				when 'start'
+					if not @config['starbound_directory'].nil?
+						if `pidof starbound_server`.empty?
+							if $daemon.nil?
+								start
+							else
+								say("<%= color('Duplicate prevented.', :warning) %> The daemon is still processing. Please wait and try again.")
+							end
+						else
+							say("<%= color('Duplicate prevented.', :warning) %> The server is already running.")
+						end
+					else
+						say("<%= color('Error', :warning) %> Please run setup then restart SBCP.")
+					end
+				when 'stop'
+					if agree("Are you sure? ", true)
+						stop
+					end
+				when /^(help|help\s?(\S+))$/
+					command = $2
+					if not command.nil?
+						if @commands.include? command.strip
+							help(command)
+						else
+							say("The command \"#{command.strip}\" does not exist.")
+						end
+					else
+						help
+					end
+				else
+					say('Invalid command. Try help for a list of possible commands.')
+				end
+			end
+		ensure
+			$daemon.terminate unless $daemon.nil?
+		end
+
+		def backup(type=nil)
+			if not type.nil?
+				case type
+				when 'starbound', 'sbcp', 'full'
+					Backup.create_backup(type)
+				else
+					say("Backup type \"#{type}\" is not valid.")
+				end
+			else
+				say('Please specify a backup type.')
+			end
+		end
+
+		def get(data=nil)
+			if not data.nil?
+				case data
+				when 'info'
+					unless Starbound::SESSION.nil? || Starbound::SESSION.empty?
+						Starbound::SESSION[:info][:uptime] = Time.diff(Starbound::SESSION[:info][:started], Time.now, '%H %N %S')[:diff]
+						unless Starbound::SESSION[:info][:restart_in] == 'Never'
+							Starbound::SESSION[:info][:restart_in] = "#{(((@config['restart_schedule']*60*60) - (Time.now - Starbound::SESSION[:info][:started]))/60).to_i} minutes" # Inaccurate for first start, fairly acurrate thereafter
+						end
+						Starbound::SESSION[:info].each_pair do |key, value|
+							say("<%= color('#{key.to_s.capitalize}:', :info) %> #{value}")
+						end
+					else
+						say("<%= color('Error!', :failure) %> Session data is missing or empty.")
+					end
+				when 'players'
+					unless Starbound::SESSION.nil? || Starbound::SESSION.empty?
+						pp(Starbound::SESSION[:players])
+					else
+						say("<%= color('Error!', :failure) %> Session data is missing or empty.")
+					end
+				else
+					say("Data type \"#{data}\" is not valid.")
+				end
+			else
+				say('Please specify a data type.')
+			end
+		end
+
+		def restart(signal='SIGTERM')
+			say('Sending restart request...')
+			kill(signal)
+		end
+
+		def start
+			say('Starting the Starbound server...')
+			supervisor = Daemon.supervise
+			$daemon = supervisor.actors.first
+			$daemon.async.start
+			say("<%= color('Operation complete.', :success) %>")
+		end
+
+		def stop(signal='SIGTERM')
+			say('Sending stop request...')
+			file = Tempfile.new('sb-shutdown')
+			kill(signal)
+		ensure
+			unless file.nil?
+				file.close
+				file.unlink
+			end
+		end
+
+		def sb_say(string)
+			unless string.nil?
+				if not $rcon.nil?
+					$rcon.execute("say #{string}")
+					say("<%= color('Message sent to server.', :success) %>")
+				else
+					say("<%= color('RCON is not running.', :warning) %>")
+				end
+			else
+				say("Please type something to say.")
+			end
+		end
+
+		def kill(signal='SIGTERM')
+			pid = `pidof starbound_server`
+			unless pid.empty?
+				system("kill -s #{signal} #{pid.to_i}")
+				t = Time.now
+				d = 0
+				until `pidof starbound_server`.empty? || d >= 5
+					sleep(1)
+					d = Time.now - t
+				end
+				if not `pidof starbound_server`.empty?
+					return say("<%= color('Failure!', :failure) %> The server is still running.")
+				end
+				return say("<%= color('Operation complete.', :success) %>")
+			end
+			say("<%= color('Aborting request. See details below.', :failure) %>")
+			return say('Unable to locate the starbound_server process. Is it running?')
+		end
+
+		def help(command=nil)
+			if not command.nil?
+				case command
+				when 'backup'
+				else
+					say("Could not find help for \"#{command}\" command.")
+				end
+			else
+				say("<%= color('Command list. Type help [command] to learn more.', :help) %>")
+				say("#{@commands_scheme.join(", ")}")
+			end
+		end
 	end
-end
+end

data/lib/sbcp/backup.rb

@@ -1,3 +1,19 @@
+# SBCP - Starbound Server Management Solution for Linux Servers
+# Copyright (C) 2016 Kazyyk
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
 require 'securerandom'
 require 'fileutils'
 require 'rsync'
@@ -12,11 +28,14 @@ module SBCP
 		# Full: backs up both Starbound and SBCP data.
 		# Defaults to Starbound.
 
-		def self.create_backup(kind=:starbound)
+		def self.create_backup(type='starbound')
 			config = YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
-			return('Backups disabled.') if config['backup_history'] == 'none'
-			case kind
-			when :starbound
+			if config['backup_history'] == 'none'
+				puts 'Backups are currently disabled.'
+				return
+			end
+			case type
+			when 'starbound'
 				root = config['starbound_directory']
 				world_files = "#{root}/giraffe_storage/universe/*.world"
 				latest_files_directory = File.expand_path('../../../backup', __FILE__)
@@ -40,9 +59,9 @@ module SBCP
 						end
 					end
 				end
-			when :sbcp
-				abort("Unimplemented.")
-			when :full
+			when 'sbcp'
+				puts "Unimplemented."
+			when 'full'
 				# This should take a complete backup of Starbound and SBCP.
 				# Currently only supports Starbound.
 				root = config['starbound_directory']
@@ -54,6 +73,7 @@ module SBCP
 					FileUtils.mv backup_name, backup_directory # Move the created backup to the backup directory
 				end
 			end
+			puts "Backup completed successfully."
 		end
 	end
 end

data/lib/sbcp/config.rb

@@ -0,0 +1,229 @@
+# SBCP - Starbound Server Management Solution for Linux Servers
+# Copyright (C) 2016 Kazyyk
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Affero General Public License as
+# published by the Free Software Foundation, either version 3 of the
+# License, or (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU Affero General Public License for more details.
+
+# You should have received a copy of the GNU Affero General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'yaml'
+require 'highline'
+
+module SBCP
+	class Config
+		def initialize
+			@cli = HighLine.new
+		end
+
+		def config_menu(menu)
+			config_file = File.expand_path('../../../config.yml', __FILE__)
+			config = YAML.load_file(config_file)
+			case menu
+			when :main
+				answer = @cli.choose do |menu|
+					menu.prompt = "Please select a menu option\n> "
+					@cli.say("=== SBCP Configuration Menu ===")
+					menu.choice(:General) { config_menu(:general) }
+					menu.choice(:Backups) { config_menu(:backups) }
+					menu.choice(:Logs) { config_menu(:logs) }
+					menu.choice(:Restarts) { config_menu(:restarts) }
+					menu.choice(:Exit) { puts 'Thank you for using SBCP.' }
+				end
+			when :general
+				answer = @cli.choose do |menu|
+					menu.prompt = "Please select a menu option\n> "
+					@cli.say("=== SBCP General Settings ===")
+					menu.choice('Starbound Directory') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Starbound Directory Setting ===")
+							@cli.say('Your current starbound directory is:')
+							@cli.say("\"#{config['starbound_directory']}\"")
+							sub_menu.choice('Keep this directory') { @cli.say('Directory kept.'); config_menu(:general) }
+							sub_menu.choice('Change this directory') do
+								response = ''
+								until Dir.exist?(response) && Dir.exist?(response + '/giraffe_storage') && File.writable?(response)
+									response = @cli.ask("Please enter a new directory.\n> ")
+									if not Dir.exist?(response) && Dir.exist?(response + '/giraffe_storage')
+										@cli.say('Error - This dirctory does not exist or is not a valid starbound installation. Try again.')
+									elsif not File.writable?(response)
+										@cli.say('Error - This dirctory cannot be written to. Check permissions and try again.')
+									end
+								end
+								config['starbound_directory'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:general)
+							end
+						end
+					end
+					menu.choice('Back to Main Menu') { config_menu(:main) }
+				end
+			when :backups
+				@cli.choose do |menu|
+					menu.prompt = "Please select a menu option\n> "
+					@cli.say("=== SBCP Backup Settings ===")
+					menu.choice('Backup Directory') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Backup Directory Setting ===")
+							@cli.say('Your current backup directory is:')
+							@cli.say("\"#{config['backup_directory']}\"")
+							sub_menu.choice('Keep this directory') { @cli.say('Directory kept.'); config_menu(:backups) }
+							sub_menu.choice('Change this directory') do
+								response = ''
+								until Dir.exist?(response) && File.writable?(response)
+									response = @cli.ask("Please enter a new directory.\n> ")
+									if not Dir.exist?(response)
+										@cli.say('Error - This dirctory does not exist. Try again.')
+									elsif not File.writable?(response)
+										@cli.say('Error - This dirctory cannot be written to. Check permissions and try again.')
+									end
+								end
+								config['backup_directory'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:backups)
+							end
+						end
+					end
+					menu.choice('Backup History') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Backup History Setting ===")
+							@cli.say('Backups are currently set to remain archived for:')
+							@cli.say(config['backup_history'].to_s + ' days')
+							sub_menu.choice('Keep this setting') { @cli.say('Setting kept.'); config_menu(:backups) }
+							sub_menu.choice('Change this setting') do
+								until response > 0
+									response = @cli.ask("Enter a new value in days (enter 0 to disable backups)\n> ", Integer)
+									@cli.say('Value must be greater than zero.') if not response > 0
+								end
+								config['backup_history'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:backups)
+							end
+						end
+					end
+					menu.choice('Backup Schedule') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Backup Schedule Setting ===")
+							@cli.say('The backup schedule is currently set to:')
+							config['backup_schedule'].is_a?(Integer) ? @cli.say('Every ' + config['backup_schedule'].to_s + ' hours') : @cli.say(config['backup_schedule'].to_s)
+							sub_menu.choice('Keep this setting') { @cli.say('Setting kept.'); config_menu(:backups) }
+							sub_menu.choice('Change this setting') do
+								response = @cli.ask("Enter a new value in hours (enter 0 for on restart)\n> ", Integer) { |q| q.in = [0, 1, 2, 3, 4, 6, 8, 12, 24] }
+								response = 'restart' if response == 0
+								response = 'hourly' if response == 1
+								response = 'daily' if response == 24
+								config['backup_schedule'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:backups)
+							end
+						end
+					end
+					menu.choice('Back to Main Menu') { config_menu(:main) }
+				end
+			when :logs
+				@cli.choose do |menu|
+					menu.prompt = "Please select a menu option\n> "
+					@cli.say("=== SBCP Log Settings ===")
+					menu.choice('Log Directory') do 
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Log Directory Setting ===")
+							@cli.say('Your current logs directory is:')
+							@cli.say("\"#{config['log_directory']}\"")
+							sub_menu.choice('Keep this directory') { @cli.say('Directory kept.'); config_menu(:logs) }
+							sub_menu.choice('Change this directory') do
+								response = ''
+								until Dir.exist?(response) && File.writable?(response)
+									response = @cli.ask("Please enter a new directory.\n> ")
+									if not Dir.exist?(response)
+										@cli.say('Error - This dirctory does not exist. Try again.')
+									elsif not File.writable?(response)
+										@cli.say('Error - This dirctory cannot be written to. Check permissions and try again.')
+									end
+								end
+								config['log_directory'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:logs)
+							end
+						end
+					end
+					menu.choice('Log History') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Log History Setting ===")
+							@cli.say('Logs are currently set to remain archived for:')
+							@cli.say(config['log_history'].to_s + ' days')
+							sub_menu.choice('Keep this setting') { @cli.say('Setting kept.'); config_menu(:logs) }
+							sub_menu.choice('Change this setting') do
+								until response >= 1
+									response = @cli.ask("Enter a new value in days\n> ", Integer)
+									@cli.say('Value must be greater than or equal to one.') if not response >= 1
+								end
+								config['log_history'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:logs)
+							end
+						end
+					end
+					menu.choice('Log Style') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Log Style Setting ===")
+							@cli.say('The log style is currently set to:')
+							@cli.say(config['log_style'])
+							sub_menu.choice('Keep this setting') { @cli.say('Setting kept.'); config_menu(:logs) }
+							sub_menu.choice('Change this setting') do
+								response = @cli.ask("Enter a style name (daily, restart))\n> ") { |q| q.in = ['daily', 'restart'] }
+								config['log_style'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:logs)
+							end
+						end
+					end
+					menu.choice('Back to Main Menu') { config_menu(:main) }
+				end
+			when :restarts
+				@cli.choose do |menu|
+					menu.prompt = "Please select a menu option\n> "
+					@cli.say("=== SBCP Restart Settings ===")
+					menu.choice('Restart Schedule') do
+						@cli.choose do |sub_menu|
+							sub_menu.prompt = "Please select a menu option\n> "
+							@cli.say("=== SBCP Restart Schedule Setting ===")
+							@cli.say('The restart schedule is currently set to:')
+							config['restart_schedule'].is_a?(Integer) ? @cli.say('Every ' + config['restart_schedule'].to_s + ' hours') : @cli.say(config['restart_schedule'].to_s.capitalize)
+							sub_menu.choice('Keep this setting') { @cli.say('Setting kept.'); config_menu(:restarts) }
+							sub_menu.choice('Change this setting') do
+								response = @cli.ask("Enter a new value in hours\n> ", Integer) { |q| q.in = [0, 1, 2, 3, 4, 6, 8, 12, 24] }
+								response = 'disabled' if response == 0
+								config['restart_schedule'] = response
+								File.write(config_file, config.to_yaml)
+								@cli.say('Changes saved successfully.')
+								config_menu(:restarts)
+							end
+						end
+					end
+					menu.choice('Back to Main Menu') { config_menu(:main) }
+				end
+			end
+		end
+	end
+end