# Open your $EDITOR to compose a message in weechat
#
# Usage:
# /edit
#
# Optional settings:
# /set plugins.var.python.edit.editor "vim -f"
# /set plugins.var.python.edit.run_externally "false"
#
# If run_externally, the editor is spawned without blocking weechat. The
# process should not output to the terminal (use GUI program or spawn a new
# terminal). Otherwise the editor is executed in the current terminal (blocking
# weechat, which can break stuff).
#
# History:
# 2022-09-09
# Version 1.0.4: Use temporary files for the message
# Version 1.0.3: Drop terminal option and leave that up to the user
# 10-18-2015
# Version 1.0.2: Add the ability to run the editor in a external terminal
# Version 1.0.1: Add configurable editor key
# Version 1.0.0: initial release

VERSION = "1.0.4"

import json
import os
import os.path
import shlex
import subprocess
import tempfile
import weechat

def xdg_cache_dir():
    return os.path.expanduser(os.environ.get("XDG_CACHE_HOME", "~/.cache/"))

def weechat_cache_dir():
    cache_dir = os.path.join(xdg_cache_dir(), "weechat")
    if os.path.exists(cache_dir):
        return cache_dir
    return os.path.expanduser(os.environ.get("WEECHAT_HOME", "~/.weechat/"))


def editor_process_cb(data, command, return_code, out, err):
    buf, path = json.loads(data)

    if return_code != 0:
        cleanup(path, buf)
        weechat.prnt("", "{}: {}".format(
            err.strip(),
            return_code
        ))
        return weechat.WEECHAT_RC_ERROR

    if return_code == 0:
        read_file(path, buf)
        cleanup(path, buf)

    return weechat.WEECHAT_RC_OK


def cleanup(path, buf):
    try:
        os.remove(path)
    except (OSError, IOError):
        pass

    weechat.command(buf, "/window refresh")


def read_file(path, buf):
    try:
        with open(path) as f:
            text = f.read().strip()

        weechat.buffer_set(buf, "input", text)
        weechat.buffer_set(buf, "input_pos", str(len(text)))

    except (OSError, IOError):
        pass

    weechat.command(buf, "/window refresh")


def hook_editor_process(editor, path, buf):
    editor_cmd = "{} {}".format(editor, path)
    data = json.dumps([buf, path])
    weechat.hook_process(
        shlex.join(shlex.split(editor) + [path]), 0, "editor_process_cb", data)


def run_blocking(editor, path, buf):
    cmd = shlex.split(editor) + [path]
    code = subprocess.Popen(cmd).wait()

    if code != 0:
        cleanup(path,  buf)

    read_file(path, buf)


def edit(data, buf, args):
    editor = (weechat.config_get_plugin("editor")
              or os.environ.get("EDITOR", "vim -f"))

    run_externally = weechat.config_string_to_boolean(
        weechat.config_get_plugin("run_externally")
    )
    run_externally = bool(run_externally)

    f, path = tempfile.mkstemp(prefix = "weechat-edit-")
    os.close(f)

    with open(path, "w+") as f:
        f.write(weechat.buffer_get_string(buf, "input"))

    if run_externally:
        hook_editor_process(editor, path, buf)
    else:
        run_blocking(editor, path, buf)

    return weechat.WEECHAT_RC_OK


def main():
    if not weechat.register("edit", "Keith Smiley", VERSION, "MIT",
                            "Open your $EDITOR to compose a message", "", ""):
        return weechat.WEECHAT_RC_ERROR

    weechat.hook_command("edit", "Open your $EDITOR to compose a message", "",
                         "", "", "edit", "")


if __name__ == "__main__":
    main()