'Managing bukkit so you dont have to.',

'Helping Minecraft admins since 2011.',

'Wrapping the wrapper.',

'Open Sourced for your enjoyment. (Open Source responsibly)',

'Pythonically awesome!',

'Repository on github!',

'Less than 800 Lines!',

'Helps ease Notchian headaches!',

'I ran out of catchy slogans. :(',

'42.',

'killall -9 everyone and let root@localhost sort \'em out',

'What does this do?',

'All your minecraft are belong to us',

'Ni!',

'We want a shrubbery!',

'%>what_girls_say.mp3 > /dev/null',

'#: cat pay_check > beer',

'caffeine | brain > minecraft',

'chown -R us ./base',

'Keep staring ... I may do a trick.',

'Occupy Minecraft',

Written by: %s

Please report any bugs or problems to the #bukget IRC channel on irc.esper.net

Baskit: %s

global config

global conf_loc

userhome = os.environ["HOME"]

cf_locs = ['/etc/baskit.ini', userhome+'/.baskit.ini', 'baskit.ini']

for cf_loc in cf_locs:

if os.path.exists(cf_loc) and not config.has_section('Settings'):

conf_loc = cf_loc

config.read(cf_loc)

if not config.has_section('Settings'):

print ''.join(['No Config File found. Creating a default configuration',

'in\nthe current location. This file may exist in any of',

'the\nfollowing locations:\n',

' /etc/baskit.ini\n',

' ~/.baskit.ini\n',

' ./baskit.ini'

])

config.add_section('Settings')

config.set('Settings', 'environment', os.getcwd())

config.set('Settings', 'build', '0')

config.set('Settings', 'branch', 'stable')

config.set('Settings', 'memory_min', '1024')

config.set('Settings', 'memory_max', '1024')

config.set('Settings', 'flags', '')

conf_loc = 'baskit.ini'

output = run('screen -wipe bukkit_server')

if output[:20] == 'There is a screen on':

return True

else:

if not alive():

print 'Server not Alive, could not send command'

return None

line = None

if wait is not None:

rex = re.compile(wait)

lfname = os.path.join(env, 'env', 'server.log')

logfile = open(lfname, 'r')

size = os.stat(lfname)[6]

logfile.seek(size)

run('screen -S bukkit_server -p0 -X stuff \'%s\n\'' % command)

if wait is not None:

found = False

while not found:

where = logfile.tell()

line = logfile.readline()

if not line:

time.sleep(0.1)

logfile.seek(where)

else:

if len(rex.findall(line)) > 0:

found = True

logfile.close()

'''rsyncFolder sourcepath destpath verbose

verbose - if > 0 output rsync command

if > 1 output files copied

NOTE: current implementation is a non-destructive sync

other code relies on this being non-destructive'''

args = ["rsync", "-r", "-t", "-v", sourcepath + os.path.sep, destpath]

if verbose > 0:

print " ".join(args)

output = run(" ".join(args))

if verbose > 1:

'''RamWorld utility class for RamManager holds the data about one world'''

def __init__(self, worldname, rampath, persistpath, freewarn=5):

self.worldname = worldname # world name (no path)

self.rampath = rampath # full path to ram disk

self.persistpath = persistpath # full path to persist folder

'''RamManager - ram disk configuration and list'''

def __init__(self, env):

'''env - environment directory

The configuration will be loaded with default values if the RamDisk section is not found'''

global config

self.env = env

self.enable = False # are ram disks enabled

self.persistFolder = 'persist' # where are the persistent world folders

self.autoMount = False # should baskit mount/unmount

self.sudoPW = '' # if sudo needs a password what is it

self.worlds = {} # dictionary of active worlds

self.persistPath = None # path to persist directory

# look for RamDisk section and create it if it doesn't exist

if not config.has_section('RamDisk'):

print ''.join(['\n',

'Config File did not contain RamDisk support section.\n',

'Adding section, defaulting RamDisk Support to off.\n',

])

config.add_section('RamDisk')

config.set('RamDisk', 'enable_ramdisks', 'false')

config.set('RamDisk', 'persist_folder', 'persist')

config.set('RamDisk', 'automount_ramdisks', 'yes')

config.set('RamDisk', 'sudo_password_if_required', '')

update_config()

# Load configuration

self.enable = config.getboolean('RamDisk', 'enable_ramdisks')

self.persistFolder = config.get('RamDisk', 'persist_folder')

self.autoMount = config.getboolean('RamDisk', 'automount_ramdisks')

self.sudoPW = config.get('RamDisk', 'sudo_password_if_required')

self.persistPath = os.path.join(self.env, self.persistFolder)

if not os.path.exists(self.persistPath):

os.makedirs(self.persistPath)

if self.enable:

self.buildRamWorldList()

def buildRamWorldList(self):

'''Search the persist folder for folders to mirror to ram'''

for name in os.listdir(self.persistPath):

namepath = os.path.join(self.persistPath, name)

if os.path.isdir(namepath):

rampath = os.path.join(self.env, "env", name)

self.worlds[name] = RamWorld(name, rampath, namepath)

def mountWorld(self, world, verbose=0):

'''world - instance of RamWorld'''

assert isinstance(world, RamWorld)

if self.enable:

# get disk size in mb

size = int(run("du -m -s %s" % world.persistpath).split()[0])

bumpsize = size / 10 # default to 10%

if bumpsize < 10: # but with a 10mb minimum

bumpsize = 10

target_mountsize = size + bumpsize

world.freewarn = bumpsize / 2 # warn at 50% of free space

if self.autoMount:

if not os.path.exists(world.rampath):

os.makedirs(world.rampath)

# mount the ramdisk

args = ["sudo"]

if len(self.sudoPW) > 0:

args.append("-S")

args.extend(["mount", "-t", "tmpfs", "none", world.rampath, "-o", "size=%sm" % target_mountsize])

if verbose > 0:

print " ".join(args)

if len(self.sudoPW) > 0:

xx = subprocess.Popen(args, stdin=subprocess.PIPE)

xx.communicate("%s\n" % self.sudoPW)

else:

xx = subprocess.Popen(args)

xx.wait()

else:

# Verify ramdisk is mounted

if not os.path.ismount(world.rampath):

print "RAMDISK MOUNT ERROR:"

print " No mounted volume found at %s" % world.rampath

sys.exit(1)

# Verify size of the ramdisk

mountsize = int(run("df -B 1M %s" % world.rampath).split()[1])

if mountsize < target_mountsize:

print "RAMDISK SIZE ERROR:"

print " The ramdisk at %s" % world.rampath

print " is %dmb but needs to be at least %dmb" % (mountsize, target_mountsize)

sys.exit(1)

def unmountWorld(self, world, verbose=0):

'''world - instance of RamWorld'''

assert isinstance(world, RamWorld)

if self.enable:

if self.autoMount:

# unmount the ramdisk

args = ["sudo"]

if len(self.sudoPW) > 0:

args.append("-S")

args.extend(["umount", "-t", "tmpfs", world.rampath])

if verbose > 0:

print " ".join(args)

if len(self.sudoPW) > 0:

xx = subprocess.Popen(args, stdin=subprocess.PIPE)

xx.communicate("%s\n" % self.sudoPW)

else:

xx = subprocess.Popen(args)

xx.wait()

def setupWorlds(self, verbose=0):

'''Called to mount the ram disk worlds and populate them with data'''

lockfile = open(os.path.join(self.env, "baskitlock"), "w")

fcntl.flock(lockfile, fcntl.LOCK_EX)

for world in self.worlds.itervalues():

assert isinstance(world, RamWorld)

# if the ramdisk is still mounted

if os.path.ismount(world.rampath):

rsyncFolder(world.rampath, world.persistpath, verbose)

self.unmountWorld(world, verbose)

self.mountWorld(world, verbose)

rsyncFolder(world.persistpath, world.rampath, verbose)

lockfile.close()

def cleanupWorlds(self, verbose=0):

'''Called to save the data from the worlds and unmount them'''

lockfile = open(os.path.join(self.env, "baskitlock"), "w")

fcntl.flock(lockfile, fcntl.LOCK_EX)

for world in self.worlds.itervalues():

assert isinstance(world, RamWorld)

rsyncFolder(world.rampath, world.persistpath, verbose)

self.unmountWorld(world, verbose)

lockfile.close()

def mergeWorlds(self, verbose=0):

'''Called to save the data from the ramdisk worlds'''

lockfile = open(os.path.join(self.env, "baskitlock"), "w")

fcntl.flock(lockfile, fcntl.LOCK_EX)

for world in self.worlds.itervalues():

assert isinstance(world, RamWorld)

rsyncFolder(world.rampath, world.persistpath, verbose)

freesize = int(run("df -B 1M %s | tail -1" % world.rampath).split()[3])

if freesize < world.freewarn:

print "WARNING: space is low on %s" % world.worldname

lockfile.close()

def preBackup(self, worldname, worldpath, verbose):

'''prepBackup worldname

worldname - name of the world being backed up

worldpath - full path to world in env directory

will sync data if appropriate

returns full path to directory to backup

'''

if self.worlds.has_key(worldname):

lockfile = open(os.path.join(self.env, "baskitlock"), "w")

fcntl.flock(lockfile, fcntl.LOCK_EX)

world = self.worlds[worldname]

assert isinstance(world, RamWorld)

rsyncFolder(world.rampath, world.persistpath, verbose)

lockfile.close()

return world.persistpath

prompt = 'baskit> '

def __init__(self):

cmd.Cmd.__init__(self)

get_config()

self.env = config.get('Settings', 'environment')

# Create any needed folders if they do not already exist.

if not os.path.exists(self.env):

os.makedirs(self.env)

if not os.path.exists(os.path.join(self.env, 'env')):

os.makedirs(os.path.join(self.env, 'env'))

if not os.path.exists(os.path.join(self.env, 'backup')):

os.makedirs(os.path.join(self.env, 'backup', 'worlds'))

os.makedirs(os.path.join(self.env, 'backup', 'snapshots'))

self.ram = RamManager(self.env)

# Check to see if java and screen is installed

need_deps = False

for package in ['java', 'screen']:

output = run('which %s' % package)

chk = re.compile(r'which:\sno\s%s' % package)

if len(chk.findall(output)) > 0:

need_deps = True

if output == '':

need_deps = True

# If there were any issues, then we need to warn the user.

if sys.platform != 'win32':

if need_deps:

print ''.join(['\nWARNING\n-------\n',

'Before you continue, please perform the following ',

'operations\nto install the needed software to get ',

'baskit working. We\ndepend on this software in ',

'order to properly background and\nrun the bukkit ',

'server. As it is expected for this\nscript to be ',

'run as a non-privileged user, we should not\nbe ',

'able to run these commands on our own.\n'])

if sys.platform == 'linux2':

if run('which apt-get') == '/usr/bin/apt-get':

print 'sudo apt-get -y install openjdk-6-jre screen\n'

elif run('which yum') == '/usr/bin/yum' :

print 'yum -y install java-1.6.0-openjdk screen\n'

else:

print 'Please install java & screen.\n'

def help_help(self, s):

print 'help [COMMAND]'

def do_exit(self, s):

'''exit

Exits the Interactive CLI'''

return True

def do_c(self, s):

'''c [COMMAND]

Sends all data after the c to the bukkit console

'''

console(s)

print 'Sent to console: %s' % s

def do_players(self, s, silent=False):

'''players

Returns the list of currently connected players.

'''

if not alive():

print 'Server is not running, cannot list players.'

return

#players = []

replayers = re.compile(r' ([^,]*)')

line = console('listt', wait=r'Connected players:', env=self.env)

players = replayers.findall(line.split(':')[3])

if silent:

return players

else:

print 'Players Online: %s' % ', '.join(players)

def do_console(self, s):

'''console

Opens the Bukkit console To exit the console type Ctrl+A D

'''

os.system('screen -DRS bukkit_server')

def do_update(self, s):

'''update [OPTIONS]

Updates the Craftbukkit binary based on the options provided.

-b (--build) [BUILD_NUMBER] Updates the binary to a specific build.

-d (--dev) Sets the branch flag to dev.

-t (--beta) Sets the branch flag to beta.

-s (--stable) Sets the branch flag to stable.

-f (--force) Forces the update, even if the build is

older than the current binary.

'''

global config

force = False

#env = config.get('Settings', 'environment')

branch = config.get('Settings', 'branch')

cbuild = config.getint('Settings', 'build')

build = 0

dl = 'http://dl.bukkit.org/api/1.0/downloads/projects/craftbukkit/view'

opts, unused_args = getopt.getopt(s.split(), 'b:dtsf',

['build=','dev', 'test', 'stable', 'force'])

for opt, val in opts:

if opt in ('-b', '--build'):

branch = 'build'

build = int(val)

if opt in ('-d', '--dev'):

branch = 'dev'

if opt in ('-t', '--beta'):

branch = 'beta'

if opt in ('-s', '--stable'):

branch = 'stable'

if opt in ('-f', '--force'):

force = True

branches = {

'stable': '%s/latest-rb' % dl,

'beta': '%s/latest-beta' % dl,

'dev': '%s/latest-dev' % dl,

'build': '%s/build-%i' % (dl, build)

}

url = branches[branch]

print 'Parsing dl.bukkit.org for version information... '

try:

resp = urllib2.urlopen(urllib2.Request(url,'',{'accept':'application/json'}))

except urllib2.URLError, e:

if hasattr(e, 'reason'):

print 'Failed to reach the server. Reason: ', e.reason

elif hasattr(e, 'code'):

if (e.code == 404 and branch == 'build'):

print 'No such build number: %s' % build

else:

print 'The server couldn\'t fulfill the request. Error code: ', e.code

return

page = resp.read()

json_artifact = json.loads(page)

build = int(json_artifact["build_number"])

print 'Build %s.' % json_artifact["build_number"]

#print 'File %s.' % json_artifact["file"]["url"]

if build > cbuild or force:

print 'Downloading craftbukkit to temporary location...'

try:

resp = urllib2.urlopen(json_artifact["file"]["url"])

except urllib2.URLError, e:

if hasattr(e, 'reason'):

print 'Failed to reach the server. Reason: ', e.reason

elif hasattr(e, 'code'):

print 'The server couldn\'t fulfill the request. Error code: ', e.code

return

try:

cb_tmp = open(os.path.join(self.env, 'env', '.craftbukkit.jar'), 'wb')

cb_tmp.write(resp.read())

cb_tmp.close()

except:

cb_tmp.close()

print 'ERROR: Could not successfully save binary!'

return

print 'Validating checksums...'

hash = hashlib.md5(file(os.path.join(self.env, 'env', '.craftbukkit.jar'), 'r').read()).hexdigest()

#print ' url md5 %s' % json_artifact["file"]["checksum_md5"]

#print 'computed md5 %s' % hash

if (hash == json_artifact["file"]["checksum_md5"]):

print 'Moving new binary into place...'

shutil.move(os.path.join(self.env, 'env', '.craftbukkit.jar'),

os.path.join(self.env, 'env', 'craftbukkit.jar'))

else:

print 'ERROR: File download was corrupted! Please re-run update.'

os.remove(os.path.join(self.env, 'env', '.craftbukkit.jar'))

return

print 'Updating configuration...'

config.set('Settings', 'build', build)

config.set('Settings', 'branch', branch)

update_config()

print 'Success! Craftbukkit binary now build %s.' % build

else:

print 'Existing binary current. No update needed.'

def do_crashfix(self, s):

'''crashfix [OPTIONS]

Command to sync and unmount ramdisk worlds following abnormal stop of server

-v (--verbose) Make the crashfix output verbose

'''

if alive():

print 'ERROR: Server cannot be running during crashfix!'

return

verbose = 0

opts, unused_args = getopt.getopt(s.split(), 'v',

['verbose'])

for opt, unused_val in opts:

if opt in ('-v', '--verbose'):

verbose += 1

self.ram.cleanupWorlds(verbose)

def do_merge(self, s):

'''merge [OPTIONS]

merge the data from the ramdisk into the non-ram world copy

-v (--verbose) Make the merge output verbose

'''

verbose = 0

opts, unused_args = getopt.getopt(s.split(), 'v',

['verbose'])

for opt, unused_val in opts:

if opt in ('-v', '--verbose'):

verbose += 1

if not alive():

# server is down, attempt to cleanup

self.ram.cleanupWorlds(verbose)

else:

# server is running, just merge

self.ram.mergeWorlds(verbose)

def do_stop(self, s):

'''stop [OPTIONS]

Stops the bukkit binary based on the options provided.

-t (--timer) [SECONDS] Shuts the server down after the timer

expires.

--no-players Will wait until the server has no players

online before shutting down.

-n (--notify) Notifys the players that the server is in

a shutdown period.

'''

if not alive():

print 'No Server running.'

return

players = False

notify = False

wait = datetime.datetime.now()

opts, unused_args = getopt.getopt(s.split(), 't:n',

['timer=','no-players', 'notify'])

for opt, val in opts:

if opt in ('-t', '--timer'):

wait = datetime.datetime.now() + datetime.timedelta(seconds=int(val))

if opt in ('--no-players'):

players = True

if opt in ('-n', '--notify'):

notify = True

while wait > datetime.datetime.now() and not players:

if players:

if len(self.do_players('',silent=True)) < 1:

players = False

if notify:

command = 'say SERVER WILL SHUT DOWN '

countdown = (wait - datetime.datetime.now())

if countdown.days > -1:

command += 'IN %s SECONDS ' % countdown.seconds

if players:

command += 'WHEN ALL PLAYERS HAVE LEFT'

console(command)

time.sleep(30)

console('stop')

print 'Server has been told to shutdown.'

print 'Waiting for server to stop...'

while alive():

time.sleep(1)

self.ram.cleanupWorlds(0)

def do_start(self, s):

'''start

Starts the bukkit server.

'''

if alive():

print 'Server already running.'

return

self.ram.setupWorlds(0)

runenv = os.path.join(self.env, 'env')

java = run('which java')

startup = '%s %s -Xms%sm -Xmx%sm -jar craftbukkit.jar' % (java,

config.get('Settings', 'flags'),

config.get('Settings', 'memory_min'),

config.get('Settings', 'memory_max'))

screen = 'screen -dmLS bukkit_server bash -c \'%s\'' % startup

command = 'cd %s;%s' % (runenv, screen)

run(command)

time.sleep(1) # added to make sure alive can settle a little

if alive():

print 'Server startup initiated.'

else:

print 'Server startup failed.'

def do_restart(self, s):

'''restart

Convenience function to restart the server. No options are provided.

'''

self.do_stop('')

self.do_start('')

def do_status(self, s):

'''status

Returns the running status and basic information about the server.

'''

sts = {True: 'ALIVE', False: 'DOWN'}

print 'Craftbukkit Build %s' % config.get('Settings', 'build')

print 'Server Status is %s.' % sts[alive()]

def do_snapshot(self, s):

'''snapshot [OPTIONS]

Creates, displays, and manages server snapshots. A server snapshot

contains the completely functional state of the bukkit server environment.

Snapshots can only be taken when the server is shut down, so please keep

this in mind before using. Snapshots are most useful in making a restore

point before an upgrade. Snapshots do NOT contain map or world data.

-l (--list) Lists the available snapshots.

-n (--name) [NAME] Sets the name of the snapshot. Default is:

bukkit-[DATE]-[BUILD].snap

-r (--restore) [NAME] Restores a snapshot.

-v (--verbose) Adds extra verbosity to output.

'''

global config

#env = config.get('Settings', 'environment')

worlds = []

#desc = None

verbose = False

cur = datetime.datetime.now()

name = 'bukkit-%s-%s' % (config.get('Settings', 'build'),

cur.strftime('%Y-%m-%d_%H.%M'))

opts, unused_args = getopt.getopt(s.split(), 'vln:r:',

['list', 'name=', 'recover=', 'verbose'])

for opt, val in opts:

if opt in ('-l', '--list'):

files = os.listdir(os.path.join(self.env, 'backup', 'snapshots'))

backups = []

for fname in files:

timestamp = os.stat(os.path.join(self.env, 'backup', 'snapshots',

fname)).st_mtime

backups.append((fname.strip('.snap'),

datetime.datetime.fromtimestamp(timestamp)))

for item in backups:

print '%-30s %15s' % (item[0], item[1].strftime('%Y-%m-%d %H:%M'))

return

if opt in ('-r', '--restore'):

if alive():

print 'ERROR: Server cannot be running during snapshot restore!'

return

else:

snap = os.path.join(self.env, 'backup', 'snapshots', '%s.snap' % val)

print 'Moving current environment to env.old...'

shutil.move(os.path.join(self.env,'env'), os.path.join(self.env,'env.old'))

os.makedirs(os.path.join(self.env, 'env'))

print 'Starting Snapshot Restoration Process...'

out = run('tar xzvf %s -C %s' % (snap, self.env))

if verbose:

print out

conf = ConfigParser()

conf.read(os.path.join(self.env, 'env', 'config.ini'))

print 'Updating settings based on snapshot...'

config.set('Settings', 'build', conf.get('Settings', 'build'))

config.set('Settings', 'branch', conf.get('Settings', 'branch'))

update_config()

print 'Cleaning up...'

os.remove(os.path.join(self.env, 'env', 'config.ini'))

print 'Snapshot restore complete.'

return

if opt in ('-n', '--name'):

name = val

if opt in ('-v', '--verbose'):

verbose = True

if alive():

print 'ERROR: Server cannot be running during snapshot!'

return

else:

print 'Building world exclusions...'

for item in os.listdir(os.path.join(self.env, 'env')):

if os.path.exists(os.path.join(self.env, 'env', item, 'level.dat')):

worlds.append('--exclude="env/%s"' % item)

print 'Copying config into snapshot path...'

shutil.copyfile(conf_loc, os.path.join(self.env, 'env', 'config.ini'))

snap = os.path.join(self.env, 'backup', 'snapshots', '%s.snap' % name)

exbackup = '--exclude="backup"'

expersist = '--exclude="%s"' % self.ram.persistFolder

print 'Generating snapshot %s...' % name

out = run('tar czvf %s -C %s %s %s %s ./' % (snap, self.env, exbackup, expersist, ' '.join(worlds)))

if verbose:

print out

print 'Snapshot generation complete.'

return

def do_backup(self, s):

'''backup [OPTIONS] [WORLD]

Creates, displays, and recovers world backups. If no world name is

specified, the default of 'world' will be used.

-l (--list) Lists the available backups.

-n (--name) [NAME] Sets the name of the backup. Default is:

[WORLD]-[DATE].bck

-r (--recover) [NAME] Recovers a backup.

-v (--verbose) Adds extra verbosity to output.

'''

name = None

verbose = False

#env = config.get('Settings', 'environment')

opts, args = getopt.getopt(s.split(), 'vln:r:',

['list', 'name=', 'recover=', 'verbose'])

if len(args) > 0:

world = args[0]

else:

world = 'world'

for opt, val in opts:

if opt in ('-l', '--list'):

files = os.listdir(os.path.join(self.env, 'backup', 'worlds'))

backups = []

for fname in files:

timestamp = os.stat(os.path.join(self.env, 'backup', 'worlds',

fname)).st_mtime

backups.append((fname.strip('.bck'),

datetime.datetime.fromtimestamp(timestamp)))

for item in backups:

print '%-30s %15s' % (item[0], item[1].strftime('%Y-%m-%d %H:%M'))

return

if opt in ('-r', '--recover'):

if alive():

print 'ERROR: Server cannot be running during restore!'

else:

path = os.path.join(self.env, 'env', world)

# RamDisk support -- may change target path

path = self.ram.preBackup(world, path, 2 if verbose else 0)

if not os.path.exists(path):

os.makedirs(path)

backup = os.path.join(self.env, 'backup', 'worlds', '%s.bck' % val)

print 'Restoring backup %s to %s...' % (val, world)

out = run('tar xzvf %s -C %s' % (backup, path))

if verbose:

print out

print 'Restore complete.'

return

if opt in ('-n', '--name'):

name = val

if name is None:

cur = datetime.datetime.now()

name = '%s-%s' % (world, cur.strftime('%Y-%m-%d_%H.%M'))

print name

backup = os.path.join(self.env, 'backup', 'worlds', '%s.bck' % name)

path = os.path.join(self.env, 'env', world)

print 'Generating Backup of %s named %s...' % (world, name)

if alive():

console('save-all', wait=r'Save complete', env=self.env)

console('save-off', wait=r'Disabling level saving', env=self.env)

# RamDisk support -- may change target path

path = self.ram.preBackup(world, path, 2 if verbose else 0)

out = run('tar czvf %s -C %s ./' % (backup, path))

if verbose:

print out

if alive():

console('save-on', wait='Enabling level saving', env=self.env)