Cacher is the code snippet organizer for pro developers

'''
bookmarks.py - Create/List bookmarks in Binary Ninja

Copyright (c) 2016 Josh Watson

Permission is hereby granted, free of charge, to any person obtaining a 
copy of this software and associated documentation files (the "Software"), 
to deal in the Software without restriction, including without limitation 
the rights to use, copy, modify, merge, publish, distribute, sublicense, 
and/or sell copies of the Software, and to permit persons to whom the 
Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in 
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS 
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING 
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER 
DEALINGS IN THE SOFTWARE.
'''

import os
import pickle
import threading

import binaryninja as bn

# On Windows, install PySide in 
# C:\Program Files\Vector35\BinaryNinja\plugins\Lib\site-packages
from PySide.QtGui import QApplication, QInputDialog, QFileDialog

bookmarks = {}

bookmark_file_name = None

# trying to navigate from the thread we create seems to be an issue,
# so we use this global to pass a value back to goto_bookmark
navigate_to = None

def create_prompt(address):
    bookmark_name, ok = QInputDialog.getText(
        None, 'Create new bookmark', 'Enter bookmark name:'
    )

    if ok:
        bookmarks[address] = bookmark_name

def list_prompt(view):
    global navigate_to

    bookmark, ok = QInputDialog.getItem(
        None, 'Go to bookmark', 'Bookmarks:',
        ['0x{:x} {}'.format(addr, bookmark) 
         for addr, bookmark in bookmarks.iteritems()],
        0, False)

    if ok:
        address = int(bookmark.split(' ')[0], 16)
        navigate_to = address
    else:
        navigate_to = None

def load_prompt(file_metadata):
    global bookmark_file_name

    if not bookmark_file_name:
        default_file_name = (os.path.splitext(file_metadata.filename)[0] + 
                             '.bnbm')
    else:
        default_file_name = bookmark_file_name

    load_file_name, ok = QFileDialog.getOpenFileName(
        None, 'Load Bookmarks', default_file_name, '*.bnbm'
    )

    if ok and load_file_name:
        try:
            with open(load_file_name, 'r') as load_file:
                bookmarks.update(pickle.load(load_file))

            bookmark_file_name = load_file_name
        except IOError:
            bn.log_alert('Invalid file!')

def save_prompt(file_metadata):
    global bookmark_file_name

    if not bookmark_file_name:
        default_file_name = (os.path.splitext(file_metadata.filename)[0] + 
                             '.bnbm')
        bn.log_info(default_file_name)
    else:
        default_file_name = bookmark_file_name

    save_file_name, ok = QFileDialog.getSaveFileName(
        None, 'Save Bookmarks', default_file_name, '*.bnbm'
    )

    if ok and save_file_name:
        try:
            with open(save_file_name, 'w') as save_file:
                pickle.dump(bookmarks, save_file)

            bookmark_file_name = save_file_name
        except IOError:
            bn.log_alert('Invalid file!')

def load_bookmarks(view):
    prompt_thread = threading.Thread(target=load_prompt, args=(view.file,))
    prompt_thread.start()
    prompt_thread.join()

def save_bookmarks(view):
    prompt_thread = threading.Thread(target=save_prompt, args=(view.file,))
    prompt_thread.start()
    prompt_thread.join()

def create_bookmark(view, address):
    prompt_thread = threading.Thread(target=create_prompt, args=(address,))
    prompt_thread.start()
    prompt_thread.join()

def goto_bookmark(view):
    prompt_thread = threading.Thread(target=list_prompt, args=(view,))
    prompt_thread.start()
    prompt_thread.join()

    if navigate_to:
        view.file.navigate(view.file.view, navigate_to)

bookmark_app = QApplication([])

bn.PluginCommand.register_for_address(
    'Create Bookmark', 'Create a bookmark at this address.', create_bookmark
)
bn.PluginCommand.register('Go to Bookmark', 'Go to a bookmark.', goto_bookmark)
bn.PluginCommand.register('Load bookmarks', 'Load bookmarks from file.', load_bookmarks)
bn.PluginCommand.register('Save bookmarks', 'Save bookmarks to file.', save_bookmarks)