sbcp 0.1.4

data/config.yml

@@ -0,0 +1,9 @@
+---
+starbound_directory: ~
+backup_directory: ~
+backup_history: 90
+backup_schedule: 1
+log_directory: ~
+log_history: 90
+log_style: daily
+restart_schedule: 4

data/lib/sbcp.rb

@@ -0,0 +1,38 @@
+require 'sinatra/base'
+require 'sinatra/contrib'
+require 'sinatra/flash'
+require 'securerandom'
+require 'fileutils'
+require 'logger'
+require 'yaml'
+
+require 'sbcp/daemon'
+
+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
+	end
+end

data/lib/sbcp/backup.rb

@@ -0,0 +1,59 @@
+require 'securerandom'
+require 'fileutils'
+require 'rsync'
+require 'yaml'
+module SBCP
+	class Backup
+
+		# This methods backs up various files.
+		# It supports 3 types of backups.
+		# Starbound: backs up world and related log files.
+		# SBCP: backs up the SBCP database and related log files.
+		# Full: backs up both Starbound and SBCP data.
+		# Defaults to Starbound.
+
+		def self.create_backup(kind=:starbound)
+			config = YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+			return('Backups disabled.') if config['backup_history'] == 'none'
+			case kind
+			when :starbound
+				root = config['starbound_directory']
+				world_files = "#{root}/giraffe_storage/universe/*.world"
+				latest_files_directory = File.expand_path('../../../backup', __FILE__)
+				backup_directory = config['backup_directory']
+				backup_name = "#{Time.now.strftime("%m-%d-%Y-%H-%M-%S")}-starbound_backup.tar.bz2"
+				changed_files = Array.new
+				Rsync.run(world_files, latest_files_directory, ['-a']) do |result|
+					if result.success?
+						unless result.changes.length == 0
+							result.changes.each do |change|
+								changed_files.push("#{root}/giraffe_storage/universe/#{change.filename}")
+							end
+							FileUtils.cd('/tmp') do
+								random_name = SecureRandom.urlsafe_base64
+								FileUtils.mkdir random_name
+								FileUtils.cp changed_files, random_name
+								system("tar cjpf #{backup_name} #{random_name}")
+								FileUtils.mv backup_name, backup_directory # Move the created backup to the backup directory
+								FileUtils.rm_r random_name # Remove the folder after we're done with it
+							end
+						end
+					end
+				end
+			when :sbcp
+				abort("Unimplemented.")
+			when :full
+				# This should take a complete backup of Starbound and SBCP.
+				# Currently only supports Starbound.
+				root = config['starbound_directory']
+				giraffe_directory = "#{root}/giraffe_storage"
+				backup_directory = config['backup_directory']
+				backup_name = "#{Time.now.strftime("%m-%d-%Y-%H-%M-%S")}-full_backup.tar.bz2"
+				FileUtils.cd('/tmp') do
+					system("tar cjpf #{backup_name} #{giraffe_directory} > /dev/null 2>&1")
+					FileUtils.mv backup_name, backup_directory # Move the created backup to the backup directory
+				end
+			end
+		end
+	end
+end

data/lib/sbcp/daemon.rb

@@ -0,0 +1,115 @@
+require 'yaml'
+require 'logger'
+require 'tempfile'
+require 'rufus-scheduler'
+require 'celluloid/current'
+require_relative 'starbound'
+require_relative 'backup'
+require_relative 'parser'
+require_relative 'logs'
+module SBCP
+	class Daemon
+		def initialize
+			# Loads the config into an instance variable for use in GUI mode
+			@config = YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+		end
+
+		def self.run
+			# This method is used when starting SBCP from the sbcp executable.
+			# It's primary purpose is to enable running SBCP in CLI mode.
+			# The Sinatra web server is completely bypassed in this case.
+
+			# Check to see if the daemon is already running.
+			# This can happen after a server shut down and it's taking a backup or handling log files.
+			abort("SBCP is currently running. If you recently shut down Starbound, please allow a few minutes.\nSBCP is likely handling backup or log file operations. Interruption could lead to data loss.") if not Dir.glob('/tmp/sbcp_daemon-pid*').empty?
+
+			# Create a file containing the pid of this process so it can be aborted if neccesary.
+			pid_file = Tempfile.new('sbcp_daemon-pid')
+			pid = Process.pid.to_s
+			pid_file.write(pid)
+
+			# Next, we perform a check to ensure that the server isn't already running.
+			abort('Starbound is already running.') if not `pidof starbound_server`.empty?
+
+			# We should load the config values into a local variable.
+			# Since CLI mode does not create an instance of the daemon method,
+			# we have to set things up separately so they can be used.
+			config = YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+
+			# Quick check for invalid config values.
+			abort('Please run sbcp --setup first.') if config['starbound_directory'].nil?
+			abort('Error - Invalid starbound directory') if not Dir.exist?(config['starbound_directory']) && Dir.exist?(config['starbound_directory'] + '/giraffe_storage')
+			abort('Error - Invalid backup directory') if not Dir.exist?(config['backup_directory'])
+			abort('Error - Invalid backup schedule') if not ['hourly', 2, 3, 4, 6, 8, 12, 'daily', 'restart'].include? config['backup_schedule']
+			abort('Error - Invalid backup history') if not config['backup_history'] >= 1 || config['backup_history'] == 'none'
+			abort('Error - Invalid log directory') if not Dir.exist?(config['log_directory'])
+			abort('Error - Invalid log history') if not config['log_history'].is_a?(Integer) && config['log_history'] >= 1
+			abort('Error - Invalid log style') if not ['daily', 'restart'].include? config['log_style']
+			abort('Error - Invalid restart schedule') if not ['none', 'hourly', 2, 3, 4, 6, 8, 12, 'daily'].include? config['restart_schedule']
+
+			# 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) }
+
+			# We detach and daemonize this process to prevent a block in the calling executable.
+			Process.daemon(nochdir=true)
+
+			# We create an infinite loop so we can easily restart the server.
+			loop do
+				# Next we invoke the Starbound class to create an instance of the server.
+				# This class will spawn a sub-process containing the server.
+				server = SBCP::Starbound.new
+				server.start
+
+				# We wait for the server process to conclude before moving on.
+				# This normally occurs after a shutdown, crash, or restart.
+				# The daemon process will do nothing until the server closes.
+
+				# Once the server has finished running, we'll want to age our logfiles.
+				# We'll also take backups here if they've been set to behave that way.
+				# There's probably a better way than sending config values as arguements, but...
+				SBCP::Logs.age(config['log_directory'], config['log_history']) if config['log_style'] == 'restart'
+				SBCP::Backup.create_backup if config['backup_schedule'] == 'restart'
+
+				# Now we must determine if the server was closed intentionally.
+				# If the server was shut down on purpose, we don't want to automatically restart it.
+				# If the shutdown file exists, it was an intentional shutdown.
+				# We break the loop which ends the method and closes the Daemon process.
+				break if not Dir.glob('/tmp/sb-shutdown*').empty?
+
+				# This delay is needed or some commands don't report back correctly
+				sleep 5
+			end
+		ensure
+			unless pid_file.nil?
+				pid_file.close
+				pid_file.unlink
+			end
+		end
+
+		private
+
+		# These methods are used only in GUI mode for managing the server.
+		# In CLI mode, server management is handled via CLI options.
+
+		def start_server
+			# TODO: Create code that spawns a sub-process containing the server
+		end
+
+		def restart_server
+		end
+
+		def force_restart_server
+		end
+
+		def stop_server
+		end
+
+		def force_stop_server
+		end
+
+		def server_status
+		end
+  	end
+end

data/lib/sbcp/logs.rb

@@ -0,0 +1,11 @@
+module SBCP
+	class Logs
+		def self.age(directory, days)
+			Dir.glob("#{directory}/*.log").each do |log|
+				if ((Time.now - File.stat(log).mtime).to_i / 86400.0) >= days
+					File.delete(log)
+				end
+			end
+		end
+	end
+end

data/lib/sbcp/parser.rb

@@ -0,0 +1,10 @@
+module SBCP
+	class Parser
+		include Celluloid
+
+		def parse(line)
+			# This method will eventually be responsible for parsing server output and running other methods based on that output.
+			# One example would be to emulate in-game server commands.
+		end
+	end
+end

data/lib/sbcp/starbound.rb

@@ -0,0 +1,71 @@
+module SBCP
+	class Starbound
+		def initialize
+			@config = YAML.load_file(File.expand_path('../../../config.yml', __FILE__))
+			backup_schedule = @config['backup_schedule']
+			restart_schedule = @config['restart_schedule']
+			scheduler = Rufus::Scheduler.new
+			unless ['restart', 'none'].include? backup_schedule # Only run backups if they're not set to run at restart or aren't disabled
+				if backup_schedule == 'hourly'
+					scheduler.cron "0 */1 * * *" do
+						SBCP::Backup.create_backup
+					end
+				elsif backup_schedule == 'daily'
+					scheduler.cron "0 0 * * *" do
+						SBCP::Backup.create_backup
+					end
+				else
+					scheduler.cron "0 */#{backup_schedule} * * *" do
+						SBCP::Backup.create_backup
+					end
+				end
+			end
+			unless restart_schedule == 'none' # Only schedule restarts if enabled
+				if restart_schedule == 'hourly'
+					scheduler.cron "0 */1 * * *" do
+						pid = `pidof starbound_server`
+						system("kill -15 #{pid.to_i}") if not pid.empty?
+					end
+				elsif restart_schedule == 'daily'
+					scheduler.cron "0 0 * * *" do
+						pid = `pidof starbound_server`
+						system("kill -15 #{pid.to_i}") if not pid.empty?
+					end
+				else
+					scheduler.cron "0 */#{restart_schedule} * * *" do
+						pid = `pidof starbound_server`
+						system("kill -15 #{pid.to_i}") if not pid.empty?
+					end
+				end
+			end
+		end
+
+		def start
+			if @config['log_style'] == 'daily' then
+				log = Logger.new("#{@config['log_directory']}/starbound.log", 'daily', @config['log_history'])
+			elsif @config['log_style'] == 'restart' then
+				stamp = "#{Time.now.strftime("%m-%d-%Y-%H-%M-%S")}-starbound"
+				log = Logger.new("#{@config['log_directory']}/#{stamp}.log")
+			else
+				abort("Error: Invalid log style")
+			end
+			log.formatter = proc { |severity, datetime, progname, msg| date_format = datetime.strftime("%H:%M:%S.%N")[0...-6]; "[#{date_format}] #{msg}" }
+			log.level = Logger::INFO
+			log.info("---------- SBCP is starting a new Starbound instance ----------\n")
+			#parser = SBCP::Parser.new
+
+			IO.popen("#{@config['starbound_directory']}/linux64/starbound_server", :chdir=>"#{@config['starbound_directory']}/linux64", :err=>[:child, :out]) do |output|
+				while line = output.gets
+					log.info(line)
+					#parser.async.parse(line)
+				end
+			end
+
+		ensure
+			log.info("---------- Starbound has successfully shut down ----------\n")
+			log.info("\n") # Adds a newline space at the end of the log. Helpful for separating restarts in daily logs.
+			log.close
+			#parser.terminate
+		end
+	end
+end

data/lib/sbcp/version.rb

@@ -0,0 +1,3 @@
+module SBCP
+  VERSION = "0.1.4"
+end

data/sbcp.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sbcp/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sbcp'
+  spec.version       = SBCP::VERSION
+  spec.authors       = ['Kazyyk']
+  spec.email         = ['contact@kazyyk.com']
+
+  spec.summary       = %q{SBCP is a Starbound server management solution for Linux.}
+  spec.homepage      = 'https://www.kazyyk.com/sbcp'
+  spec.license       = 'AGPLv3'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.3.0'
+
+  #spec.add_runtime_dependency 'sinatra', '~> 1.4', '>= 1.4.7'
+  #spec.add_runtime_dependency 'sinatra-flash', '~> 0.3.0'
+  #spec.add_runtime_dependency 'sinatra-contrib', '~> 1.4', '>= 1.4.7'
+  #spec.add_runtime_dependency 'thin', '~> 1.6', '>= 1.6.4'
+  #spec.add_runtime_dependency 'sqlite3', '~> 1.3', '>= 1.3.11'
+  #spec.add_runtime_dependency 'data_mapper', '~> 1.2'
+  #spec.add_runtime_dependency 'dm-sqlite-adapter', '~> 1.2'
+  spec.add_runtime_dependency 'celluloid', '~> 0.17.3'
+  spec.add_runtime_dependency 'rufus-scheduler', '~> 3.2'
+  #spec.add_runtime_dependency 'steam-condenser', '~> 1.3', '>= 1.3.11'
+  spec.add_runtime_dependency 'rsync', '~> 1.0', '>= 1.0.9'
+  spec.add_runtime_dependency 'rbzip2', '~> 0.2.0' # seven_zip_ruby would not compile, using this instead
+  spec.add_runtime_dependency 'highline', '~> 1.7', '>= 1.7.8'
+
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rack-test', '~> 0.6.3'
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: sbcp
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Kazyyk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: rufus-scheduler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rsync
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.9
+- !ruby/object:Gem::Dependency
+  name: rbzip2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: highline
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.7.8
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.3
+description: 
+email:
+- contact@kazyyk.com
+executables:
+- sbcp
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitattributes"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- backup/README.md
+- bin/sbcp
+- config.yml
+- lib/sbcp.rb
+- lib/sbcp/backup.rb
+- lib/sbcp/daemon.rb
+- lib/sbcp/logs.rb
+- lib/sbcp/parser.rb
+- lib/sbcp/starbound.rb
+- lib/sbcp/version.rb
+- sbcp.gemspec
+homepage: https://www.kazyyk.com/sbcp
+licenses:
+- AGPLv3
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: SBCP is a Starbound server management solution for Linux.
+test_files: []