cli.py

#!/usr/bin/env python

import optparse
import struct
import sys

import starbound
import starbound.sbbf02
import starbound.sbon

def print_leaves(file, block_number=None, depth=0, prefix=None):
    """Prints out the full B-tree of accessible leaves"""

    if block_number is None:
        block_number = file.root_block
    block = file.get_block(block_number)

    sys.stdout.write('   ' * depth)
    if prefix:
        sys.stdout.write(prefix + ': ')
    print block, '@', block_number

    if isinstance(block, starbound.sbbf02.StarBlockIndex):
        for index, block_reference in enumerate(block.values):
            if index == 0:
                key_hex = '^' * file.key_size * 2
            else:
                key_hex = block.keys[index - 1].encode('hex')

            print_leaves(file, block_reference, depth + 1, prefix=key_hex)

    if isinstance(block, starbound.sbbf02.StarBlockLeaf):
        stream = starbound.sbbf02.LeafReader(file, block)
        num_keys, = struct.unpack('>i', stream.read(4))
        for _ in xrange(num_keys):
            cur_key = stream.read(file.key_size)
            value_length = starbound.sbon.read_varlen_number(stream)
            value = stream.read(value_length)
            sys.stdout.write('    ' * (depth + 1))
            print cur_key.encode('hex'), '=', len(value), 'byte(s)'

def get_world_value(file, key_path):
    """Get a value out of the world's data section"""

    assert isinstance(file, starbound.StarWorld), 'Requires a world file'

    key_parts = key_path.split('.')
    data = file.get_world_data()
    for key in key_parts:
        data = data[key]
    print key_path, '=', data


def main():
    p = optparse.OptionParser()

    p.add_option('-l', '--print-leaves', dest='print_leaves',
                 action='store_true', default=False,
                 help=print_leaves.__doc__)

    p.add_option('-w', '--get-world-value', dest='world_key_path',
                 help=get_world_value.__doc__)

    options, arguments = p.parse_args()

    for path in arguments:
        with starbound.open_file(path) as file:
            print file
            print

            if options.world_key_path:
                get_world_value(file, options.world_key_path)
                print

            if options.print_leaves:
                print_leaves(file)
                print

if __name__ == '__main__':
    main()