__init__.py

#!/usr/bin/env python
# coding: utf-8

__author__ = 'ievans3024'
__version__ = '0.0.2'

# TODO: REDO ALL OF THIS WITH PySide/Qt4/QML

from os import getcwd, getenv, walk, access, F_OK
from os.path import expanduser, join, split
from sys import platform
from tkinter import BOTH, filedialog, Menu, N, NW, PhotoImage, S, Tk, messagebox
from tkinter.ttk import Button, Frame, Separator, Style, Treeview

import nbt
import Pmw

# Tk instantiated outside of __main__ to allow use of Image classes for icon definitions
root = Tk()

# Icon definitions are necessary because widgets do not save data provided to the 'image' kwarg to the instance.
# To prevent image data from being garbage collected, they must exist in an external possible reference.
icons = {
    'about': PhotoImage(file='icons/gnome-about-logo.png'),
    'actions': {
        'chunk_find': PhotoImage(file='icons/workspace-switcher.png'),
        'copy': PhotoImage(file='icons/edit-copy.png'),
        'cut': PhotoImage(file='icons/edit-cut.png'),
        'delete': PhotoImage(file='icons/list-remove.png'),
        'edit': PhotoImage(file='icons/gtk-edit.png'),
        'exit': PhotoImage(file='icons/system-log-out.png'),
        'move': {
            'down': PhotoImage(file='icons/go-down.png'),
            'right': PhotoImage(file='icons/go-next.png'),
            'up': PhotoImage(file='icons/go-up.png')
        },
        'new': {
            'generic': PhotoImage(file='icons/list-add.png'),
            'tag': {
                'byte': PhotoImage(file='icons/tag-byte-new.png'),
                'byte_array': PhotoImage(file='icons/tag-byte-array-new.png'),
                'compound': PhotoImage(file='icons/tag-compound-new.png'),
                'double': PhotoImage(file='icons/tag-double-new.png'),
                'float': PhotoImage(file='icons/tag-float-new.png'),
                'int': PhotoImage(file='icons/tag-int-new.png'),
                'int_array': PhotoImage(file='icons/tag-int-array-new.png'),
                'list': PhotoImage(file='icons/tag-list-new.png'),
                'long': PhotoImage(file='icons/tag-long-new.png'),
                'short': PhotoImage(file='icons/tag-short-new.png'),
                'string': PhotoImage(file='icons/tag-string-new.png'),
            }
        },
        'open': {
            'file': PhotoImage(file='icons/document-open.png'),
            'folder': PhotoImage(file='icons/folder-move.png'),
            'mc_folder': PhotoImage(file='icons/go-home.png')
        },
        'paste': PhotoImage(file='icons/edit-paste.png'),
        'refresh': PhotoImage(file='icons/view-refresh.png'),
        'rename': PhotoImage(file='icons/format-text-strikethrough.png'),
        'replace': PhotoImage(file='icons/edit-find-replace.png'),
        'save': PhotoImage(file='icons/media-floppy.png'),
        'search': PhotoImage(file='icons/edit-find.png')
    },
    'tags': {
        'byte': PhotoImage(file='icons/tag-byte.png'),
        'byte_array': PhotoImage(file='icons/tag-byte-array.png'),
        'compound': PhotoImage(file='icons/tag-compound.png'),
        'double': PhotoImage(file='icons/tag-double.png'),
        'float': PhotoImage(file='icons/tag-float.png'),
        'int': PhotoImage(file='icons/tag-int.png'),
        'int_array': PhotoImage(file='icons/tag-int-array.png'),
        'list': PhotoImage(file='icons/tag-list.png'),
        'long': PhotoImage(file='icons/tag-long.png'),
        'short': PhotoImage(file='icons/tag-short.png'),
        'string': PhotoImage(file='icons/text-plain.png'),
    }
}

loaded_files = {}
loaded_dir = ''


class EventHandler(object):

    def __init__(self):
        super().__init__()
        self.events = []

    def fire(self, trigger):
        for e in self.events:
            if e[0] == trigger:
                e[1]()

    def bind(self, trigger, event):
        self.events.append((trigger, event))


handler = EventHandler()


def new_file():
    global loaded_files
    newfile = filedialog.asksaveasfilename(defaultextension='.nbt',
                                           filetypes=(('Generic NBT', '*.nbt'), ('All Files', '*')),
                                           initialdir=getcwd())
    nbtfile = nbt.nbt.NBTFile()
    nbtfile.name = split(newfile)[1]
    loaded_files[newfile] = nbtfile
    handler.fire('open_files')


def open_files(get_files=()):
    global loaded_files
    loaded_files = {}
    failures = []
    if not get_files:
        get_files = filedialog.askopenfilenames(initialdir=getcwd())
    for f in get_files:
        try:
            loaded_files[f] = nbt.nbt.NBTFile(f)
        except OSError:
            failures.append(f)
    if len(failures) > 1:
        messagebox.showwarning('Open File', 'One or more files did not appear to be an NBT file and were not opened.')
    elif len(failures) == 1:
        messagebox.showwarning('Open File', '%s does not appear to be an NBT file.' % f)
    handler.fire('open_files')


def open_folder():
    global loaded_files, loaded_dir
    get_dir = filedialog.askdirectory(initialdir=getcwd())
    filetree = walk(get_dir)
    files = []
    for t in filetree:
        for f in t[2]:
            files.append(join(t[0], f))
    open_files(get_files=files)


def open_mc_dir():
    global loaded_files

    if str(platform) in ('win32', 'win64'):
        mc_dir = join(getenv('APPDATA'), '.minecraft', 'saves')
    elif str(platform) in ('mac', 'darwin'):
        mc_dir = join(expanduser('~'), 'Library', 'Application Support', 'minecraft', 'saves')
    else:
        mc_dir = join(expanduser('~'), '.minecraft', 'saves')

    get_files = filedialog.askopenfilename(initialdir=mc_dir)
    # TODO: decide if I want to open all savegame nbt files or just level.dat


def refresh_files():
    global loaded_files
    files = (f for f in loaded_files)
    open_files(get_files=files)


def save_files():
    global loaded_files
    for f in loaded_files:
        if isinstance(loaded_files[f], nbt.nbt.NBTFile):
            loaded_files[f].write_file(f)


class MainMenu(Menu):
    """
    Macro class for main window menus
    """
    def __init__(self, parent):

        Menu.__init__(self, parent)

        self.parent = parent

        menu_file = Menu(self, tearoff=0)
        menu_file.add_command(compound='left',
                              image=icons['actions']['new']['generic'], label='New...', command=new_file)
        menu_file.add_command(compound='left',
                              image=icons['actions']['open']['file'], label='Open...', command=open_files)
        menu_file.add_command(compound='left',
                              image=icons['actions']['open']['folder'], label='Open Folder...', command=open_folder)
        menu_file.add_command(compound='left',
                              image=icons['actions']['open']['mc_folder'],
                              label='Open Minecraft Save Folder...', command=open_mc_dir)
        menu_file.add_separator()
        menu_file.add_command(compound='left', image=icons['actions']['save'], label='Save...', command=save_files)
        menu_file.add_command(compound='left', image=icons['actions']['refresh'],
                              label='Refresh', command=refresh_files)
        menu_file.add_separator()
        menu_file.add_command(compound='left', image=icons['actions']['exit'], label='Exit', command=root.quit)

        menu_edit = Menu(self, tearoff=0)
        menu_edit.add_command(compound='left', image=icons['actions']['copy'], label='Copy')
        menu_edit.add_command(compound='left', image=icons['actions']['cut'], label='Cut')
        menu_edit.add_command(compound='left', image=icons['actions']['paste'], label='Paste')
        menu_edit.add_separator()
        menu_edit.add_command(compound='left', image=icons['actions']['rename'], label='Rename')
        menu_edit.add_command(compound='left', image=icons['actions']['edit'], label='Edit')
        menu_edit.add_command(compound='left', image=icons['actions']['delete'], label='Delete')
        menu_edit.add_separator()
        menu_edit.add_command(compound='left', image=icons['actions']['move']['up'], label='Move Up')
        menu_edit.add_command(compound='left', image=icons['actions']['move']['down'], label='Move Down')

        menu_search = Menu(self, tearoff=0)
        menu_search.add_command(compound='left', image=icons['actions']['search'], label='Find')
        menu_search.add_command(compound='left', image=icons['actions']['move']['right'], label='Find Next')
        menu_search.add_separator()
        menu_search.add_command(compound='left', image=icons['actions']['replace'], label='Replace')
        menu_search.add_separator()
        menu_search.add_command(compound='left', image=icons['actions']['chunk_find'], label='Chunk Finder')

        menu_help = Menu(self, tearoff=0)
        menu_help.add_command(compound='left', image=icons['about'], label='About')

        self.add_cascade(label='File', menu=menu_file)
        self.add_cascade(label='Edit', menu=menu_edit)
        self.add_cascade(label='Search', menu=menu_search)
        self.add_cascade(label='Help', menu=menu_help)


class ToolBar(Frame):
    """
    Macro class for main window toolbar
    """
    def __init__(self, parent):

        Frame.__init__(self, parent)

        self.parent = parent

        toolbar_config = [
            {
                'type': 'button',
                'title': 'Open Files',
                'icon': icons['actions']['open']['file'],
                'command': open_files
            },
            {
                'type': 'button',
                'title': 'Open Folder',
                'icon': icons['actions']['open']['folder'],
                'command': open_folder
            },
            {
                'type': 'button',
                'title': 'Save Files',
                'icon': icons['actions']['save'],
                'command': save_files
            },
            {
                'type': 'button',
                'title': 'Refresh Contents From Disk...',
                'icon': icons['actions']['refresh'],
                'command': refresh_files
            },
            {
                'type': 'separator'
            },
            {
                'type': 'button',
                'title': 'Cut',
                'icon': icons['actions']['cut'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'Copy',
                'icon': icons['actions']['copy'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'Paste',
                'icon': icons['actions']['paste'],
                'command': None
            },
            {
                'type': 'separator'
            },
            {
                'type': 'button',
                'title': 'Rename Tag',
                'icon': icons['actions']['rename'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'Edit Tag',
                'icon': icons['actions']['edit'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'Delete Tag',
                'icon': icons['actions']['delete'],
                'command': None
            },
            {
                'type': 'separator'
            },
            {
                'type': 'button',
                'title': 'New Byte Tag',
                'icon': icons['actions']['new']['tag']['byte'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Short Tag',
                'icon': icons['actions']['new']['tag']['short'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Int Tag',
                'icon': icons['actions']['new']['tag']['int'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Long Tag',
                'icon': icons['actions']['new']['tag']['long'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Float Tag',
                'icon': icons['actions']['new']['tag']['float'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Double Tag',
                'icon': icons['actions']['new']['tag']['double'],
                'command': None
            },
            {
                'type': 'button',
                'order': 19,
                'title': 'New Byte Array Tag',
                'icon': icons['actions']['new']['tag']['byte_array'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Int Array Tag',
                'icon': icons['actions']['new']['tag']['int_array'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New String Tag',
                'icon': icons['actions']['new']['tag']['string'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New List Tag',
                'icon': icons['actions']['new']['tag']['list'],
                'command': None
            },
            {
                'type': 'button',
                'title': 'New Compound Tag',
                'icon': icons['actions']['new']['tag']['compound'],
                'command': None
            },
            {
                'type': 'separator'
            },
            {
                'type': 'button',
                'title': 'Find...',
                'icon': icons['actions']['search'],
                'command': None
            }
        ]

        elements = []
        for element in toolbar_config:
            if element['type'] == 'separator':
                elements.append(
                    Separator(self, orient='vertical')
                )
            elif element['type'] == 'button':
                button = Button(self, image=element['icon'], command=element['command'])
                Pmw.Balloon(self).bind(button, element['title'])
                elements.append(button)

        for e in elements:
            if isinstance(e, Separator):
                e.grid(row=0, column=elements.index(e), sticky=N+S, padx=6)
            else:
                e.grid(row=0, column=elements.index(e), padx=1)


class TreeDisplay(object):
    """
    Acts as an intermediary between a treeview object and one or more nbt objects
    """

    def __init__(self, treeview):

        self.treeview = treeview
        self.file_tree_map = {}

    def refresh(self):

        global loaded_files

        if loaded_files:
            file_counter = 0
            for f in loaded_files:
                filename = '{file} ({save})'.format(
                    save=split(split(loaded_files[f].filename)[0])[-1],
                    file=split(loaded_files[f].filename)[-1]
                )
                self.treeview.insert('', '%i' % file_counter, filename,
                                     text=filename, image=icons['tags']['compound'])
                file_counter += 1


class MainWindow(Frame):
    """
    Macro class for the main program window
    """
    def __init__(self, parent):

        Frame.__init__(self, parent)

        self.parent = parent
        self.parent.title('PyNBTx %s' % __version__)

        self.style = Style()
        self.style.theme_use('default')
        self.style.configure('TButton', padding=0)

        self.pack(fill=BOTH, expand=1)

        self.menu = MainMenu(root)
        self.toolbar = ToolBar(self)
        self.tree = Treeview(self, height=20)
        self.tree_display = TreeDisplay(self.tree)

        self.ui_init()

    def ui_init(self):
        root['menu'] = self.menu
        self.toolbar.pack(anchor=NW, padx=4, pady=4)
        self.tree.column('#0', width=300)
        self.tree.pack(fill=BOTH, anchor=NW, padx=4, pady=4)


def main():

    app = MainWindow(root)
    handler.bind('open_files', app.tree_display.refresh)
    root.mainloop()

if __name__ == '__main__':
    main()