GUI.py

"""
#
# Cherry-Picker
#
# Copyright (C) 2020 by Leonardo Coelho: https://www.linkedin.com/in/leo-coelho/
#
################################################################################
#
# This file is subject to the terms and conditions defined in
# file 'LICENSE', which is part of this source code package.
#
"""
import tkinter as tk
from tkinter import ttk, filedialog
from tkinter.scrolledtext import ScrolledText

import Pmw
import logging


class GUI:
    def __init__(self, controller):
        self.controller = controller

        self.jira_url_label = None
        self.jira_url_input = None
        self.jira_user_label = None
        self.jira_user_input = None
        self.jira_password_label = None
        self.jira_password_input = None

        self.github_user_label = None
        self.github_user_input = None
        self.github_password_label = None
        self.github_password_input = None

        self.service_pack_label = None
        self.service_pack_input = None
        self.assignee_label = None
        self.assignee_input = None
        self.base_folder_label = None
        self.base_folder_input = None
        self.base_folder_button = None

        self.master1_label = None
        self.master1_input = None
        self.master2_label = None
        self.master2_input = None

        self.sps_listbox = None
        self.copy_button = None
        self.clear_button = None
        self.backports_listbox = None

        self.log_text = None
        self.text_handler = None
        self.logger = None

        self.window = tk.Tk()
        self.window.state('normal')
        self.window.title("Tatooine Backporter")
        self.create_widgets()

    def create_widgets(self):
        # Create some room around all the internal frames
        self.window['padx'] = 5
        self.window['pady'] = 5

        self.window.grid_columnconfigure(1, weight=1)
        self.window.grid_columnconfigure(2, weight=70)

        # - - - - - - - - - - - - - - - - - - - - -
        # JIRA Credentials
        jira_frame = tk.LabelFrame(self.window, text="JIRA Credentials", padx=5, pady=5)
        jira_frame.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        self.jira_url_label, self.jira_url_input, self.jira_user_label, self.jira_user_input, self.jira_password_label, self.jira_password_input = self.\
            create_jira_credentials_fields(jira_frame)

        # - - - - - - - - - - - - - - - - - - - - -
        # GitHub Credentials
        github_frame = tk.LabelFrame(self.window, text="GitHub Credentials", padx=5, pady=5)
        github_frame.grid(row=2, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        self.github_user_label, self.github_user_input, self.github_password_label, self.github_password_input = self.\
            create_github_fields(github_frame)

        # - - - - - - - - - - - - - - - - - - - - -
        # Backport Fields
        backport_frame = tk.LabelFrame(self.window, text="Backport Fields", padx=5, pady=5)
        backport_frame.grid(row=3, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        self.service_pack_label, self.service_pack_input, self.assignee_label, self.assignee_input, self.base_folder_label, self.base_folder_input, self.base_folder_button = self.\
            create_backport_fields(backport_frame)
        # - - - - - - - - - - - - - - - - - - - - -
        # Merge Masters Fields
        merge_master_frame = tk.LabelFrame(self.window, text="Merge Masters", padx=5, pady=5)
        merge_master_frame.grid(row=4, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        self.master1_label, self.master1_input, self.master2_label, self.master2_input = self.\
            create_merge_master_fields(merge_master_frame)

        # - - - - - - - - - - - - - - - - - - - - -
        # Get SP Cases
        do_btn = ttk.Button(self.window, text="Get Cases!", command=self.controller.get_sp_cases)
        do_btn.grid(row=9, column=1, sticky=tk.E + tk.W + tk.N + tk.S)

        # - - - - - - - - - - - - - - - - - - - - -
        # SP Cases
        sp_cases_frame = tk.LabelFrame(self.window, text="SP Cases to be backported", padx=5, pady=5)
        sp_cases_frame.grid(row=1, column=2, sticky=tk.E + tk.W + tk.N + tk.S, rowspan=9)

        self.sps_listbox, self.copy_button, self.clear_button, self.backports_listbox = self.\
            create_sp_cases_fields(sp_cases_frame)

        # - - - - - - - - - - - - - - - - - - - - -
        # Do It
        do_btn = ttk.Button(self.window, text="Do It!", command=self.controller.backport)
        do_btn.grid(row=9, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        # - - - - - - - - - - - - - - - - - - - - -
        # Logger Text Box
        self.log_text = ScrolledText(self.window, state='disabled')
        self.log_text.configure(font='TkFixedFont')
        self.log_text.grid(row=10, column=1, columnspan=3, sticky=tk.E + tk.W + tk.N + tk.S)
        self.config_logging()
        logging.info("Hello! Let's do some Backports!")

    def log_info(self, message):
        logging.info(message)
        self.log_text.update()

    def log_error(self, message):
        logging.error(message)
        self.log_text.update()

    def log_warn(self, message):
        logging.warning(message)
        self.log_text.update()

    def clear_logs(self):
        self.log_text = ScrolledText(self.window, state='disabled')
        self.log_text.configure(font='TkFixedFont')
        self.log_text.grid(row=10, column=1, columnspan=3, sticky=tk.E + tk.W + tk.N + tk.S)
        self.log_text.update()
        self.config_logging()

    def update_sp_list(self, sp_cases):
        self.sps_listbox.clear()
        for sp_case in sp_cases:
            self.sps_listbox.insert(tk.END, sp_case)

    def add_backports(self):
        currents_items = [sp for sp in self.backports_listbox.get() if sp]
        selected = self.sps_listbox.getcurselection()
        if selected:
            new_items = [sp for sp in selected if sp not in currents_items]
            for item in new_items:
                self.backports_listbox.insert(tk.END, item)

    def remove_backports(self):
        selected = self.backports_listbox.getcurselection()
        if selected:
            for item in selected:
                idx = self.backports_listbox.get(0, tk.END).index(item)
                self.backports_listbox.delete(idx)

    def clear_backports(self):
        self.backports_listbox.clear()

    def create_jira_credentials_fields(self, parent):
        parent.grid_columnconfigure(1, weight=1)
        parent.grid_columnconfigure(2, weight=70)

        url_label = ttk.Label(parent, text="JIRA URL: ")
        url_label.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        url_input = ttk.Entry(parent)
        url_input.grid(row=1, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        user_label = ttk.Label(parent, text="Username: ")
        user_label.grid(row=2, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        user_input = ttk.Entry(parent)
        user_input.grid(row=2, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        password_label = ttk.Label(parent, text="Password: ")
        password_label.grid(row=3, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        password_input = ttk.Entry(parent, show="*")
        password_input.grid(row=3, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        return url_label, url_input, user_label, user_input, password_label, password_input

    def create_github_fields(self, parent):
        parent.grid_columnconfigure(1, weight=1)
        parent.grid_columnconfigure(2, weight=70)

        user_label = ttk.Label(parent, text="Username: ")
        user_label.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        user_input = ttk.Entry(parent)
        user_input.grid(row=1, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        password_label = ttk.Label(parent, text="Password: ")
        password_label.grid(row=2, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        password_input = ttk.Entry(parent, show="*")
        password_input.grid(row=2, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        return user_label, user_input, password_label, password_input

    def create_backport_fields(self, parent):
        parent.grid_columnconfigure(1, weight=1)
        parent.grid_columnconfigure(2, weight=70)

        service_pack_label = ttk.Label(parent, text="Service Pack: ")
        service_pack_label.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        service_pack_input = ttk.Entry(parent)
        service_pack_input.grid(row=1, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        assignee_label = ttk.Label(parent, text="Assignee: ")
        assignee_label.grid(row=2, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        assignee_input = ttk.Entry(parent)
        assignee_input.grid(row=2, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        base_folder_label = ttk.Label(parent, text="Base Folder: ")
        base_folder_label.grid(row=3, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        base_folder_frame = tk.Frame(parent)
        base_folder_frame.grid(row=3, column=2, sticky=tk.E + tk.W + tk.N + tk.S)
        base_folder_frame.grid_columnconfigure(1, weight=70)
        base_folder_frame.grid_columnconfigure(2, weight=1)
        base_folder_input = ttk.Entry(base_folder_frame)
        base_folder_input.grid(row=0, column=0, sticky=tk.E + tk.W + tk.N + tk.S)
        base_folder_button = tk.Button(base_folder_frame, text="...", command=self.browse_button)
        base_folder_button.grid(row=0, column=1, sticky=tk.E + tk.W + tk.N + tk.S)

        return service_pack_label, service_pack_input, assignee_label, assignee_input, base_folder_label, base_folder_input, base_folder_button

    def create_merge_master_fields(self, parent):
        parent.grid_columnconfigure(1, weight=1)
        parent.grid_columnconfigure(2, weight=70)

        master1_label = ttk.Label(parent, text="Master 1: ")
        master1_label.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        master1_input = ttk.Entry(parent)
        master1_input.grid(row=1, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        master2_label = ttk.Label(parent, text="Master 2: ")
        master2_label.grid(row=2, column=1, sticky=tk.E + tk.W + tk.N + tk.S)
        master2_input = ttk.Entry(parent)
        master2_input.grid(row=2, column=2, sticky=tk.E + tk.W + tk.N + tk.S)

        return master1_label, master1_input, master2_label, master2_input

    def create_sp_cases_fields(self, parent):
        parent.grid_columnconfigure(1, weight=50)
        parent.grid_columnconfigure(2, weight=1)
        parent.grid_columnconfigure(3, weight=50)

        sps_listbox = Pmw.ScrolledListBox(parent,
                                          listbox_height=18,
                                          listbox_selectmode=tk.EXTENDED)
        sps_listbox.grid(row=1, column=1, sticky=tk.E + tk.W + tk.N + tk.S, rowspan=9)

        copy_button = tk.Button(parent, text=">>>", command=self.add_backports)
        copy_button.grid(row=4, column=2)

        copy_button = tk.Button(parent, text="<<<", command=self.remove_backports)
        copy_button.grid(row=5, column=2)

        clear_button = tk.Button(parent, text="Clear", command=self.clear_backports)
        clear_button.grid(row=6, column=2)

        backports_listbox = Pmw.ScrolledListBox(parent,
                                                listbox_height=18,
                                                listbox_selectmode=tk.EXTENDED)
        backports_listbox.grid(row=1, column=3, sticky=tk.E + tk.W + tk.N + tk.S, rowspan=9)

        return sps_listbox, copy_button, clear_button, backports_listbox

    def config_logging(self):
        # Create textLogger
        self.text_handler = TextHandler(self.log_text)

        # Logging configuration
        logging.basicConfig(filename='test.log',
                            level=logging.INFO,
                            format='%(asctime)s - %(levelname)s - %(message)s')

        # Add the handler to logger
        self.logger = logging.getLogger()
        self.logger.addHandler(self.text_handler)

    # Allow user to select a directory
    def browse_button(self):
        filename = filedialog.askdirectory()
        self.base_folder_input.delete(0, tk.END)
        self.base_folder_input.insert(0, filename)
        self.base_folder_input.update()


class TextHandler(logging.Handler):
    # This class allows you to log to a Tkinter Text or ScrolledText widget
    # Adapted from Moshe Kaplan: https://gist.github.com/moshekaplan/c425f861de7bbf28ef06

    def __init__(self, text):
        # run the regular Handler __init__
        logging.Handler.__init__(self)
        # Store a reference to the Text it will log to
        self.text = text

        # Add Log Level colours.
        self.text.tag_config('INFO', foreground='black')
        self.text.tag_config('DEBUG', foreground='gray')
        self.text.tag_config('WARNING', foreground='orange')
        self.text.tag_config('ERROR', foreground='red')
        self.text.tag_config('CRITICAL', foreground='red', underline=1)

    def emit(self, record):
        msg = self.format(record)

        def append():
            self.text.configure(state='normal')
            self.text.insert(tk.END, msg + '\n', record.levelname)
            self.text.configure(state='disabled')
            # Autoscroll to the bottom
            self.text.yview(tk.END)
        # This is necessary because we can't modify the Text from other threads
        self.text.after(0, append)