Merge pull request #2 from Freedom-Club-FC/feature/contact-context-menu

feature: Right click Context Menu and Nicknames support

Author: chadsec1

assets/nicknames.json

@@ -0,0 +1,11 @@
+{
+    "nicknames": [
+        "Contact",
+        "Friend",
+        "Anon",
+        "Shadow",
+        "Ghost",
+        "Wire",
+        "Cold"
+    ]
+}

logic/contacts.py

@@ -1,5 +1,34 @@
+import secrets
+import string
+import json
+import math
 import copy
 
+
+def generate_nickname_id(length: int = 4) -> str:
+    # Calculate nickname ID: digits get >= letters
+    digit_len  = math.ceil(length / 2)
+    letter_len = length - digit_len
+
+    digits  = ''.join(secrets.choice(string.digits)        for _ in range(digit_len))
+    letters = ''.join(secrets.choice(string.ascii_letters) for _ in range(letter_len))
+
+    return letters + digits
+
+def generate_random_nickname(user_data: dict, user_data_lock, contact_id: str, nicknames_prefixes_file: str = "assets/nicknames.json", nickname_id_len = 4) -> str:
+    with open(nicknames_prefixes_file, "r", encoding="utf-8") as f:
+        nickname_prefixes = json.load(f)["nicknames"]
+
+    with user_data_lock:
+        existing_nicknames = {v["nickname"] for v in user_data.get("contacts", {}).values()}
+
+
+    while True:
+        nickname = secrets.choice(nickname_prefixes) + " " + generate_nickname_id(length = nickname_id_len)
+        if nickname not in existing_nicknames:
+            return nickname
+
+
 def save_contact(user_data: dict, user_data_lock, contact_id: str, contact_public_key: bytes) -> None:
     with user_data_lock:
         if contact_id in user_data["contacts"]:
@@ -11,6 +40,7 @@ def save_contact(user_data: dict, user_data_lock, contact_id: str, contact_publi
 
 
         user_data["contacts"][contact_id] = {
+                "nickname": None,
                 "lt_sign_public_key": contact_public_key,
                 "lt_sign_key_smp": {
                     "verified": False,

ui/chat_window.py

@@ -60,7 +60,7 @@ def on_send(self, event=None):
         self.append_message(f"You: {message}")
         return "break"
 
-    def append_message(self, message: str, save_msg: bool = True):
+    def append_message(self, message: str, save_msg: bool = True, contact_nickname: str = "Contact"):
         self.chat_display.config(state="normal")
         if message.startswith("You:"):
             self.chat_display.insert("end", "You:", "you")
@@ -71,8 +71,8 @@ def append_message(self, message: str, save_msg: bool = True):
             self.chat_display.insert("end", message[1:] + "\n")
 
         else:
-            self.chat_display.insert("end", "Contact:", "contact")
-            self.chat_display.insert("end", message[8:] + "\n")
+            self.chat_display.insert("end", contact_nickname + ":", "contact")
+            self.chat_display.insert("end", message[len(contact_nickname):] + "\n")
 
 
 

ui/contact_list.py

@@ -6,8 +6,9 @@
 from ui.add_contact_prompt import AddContactPrompt
 from ui.smp_setup_window import SMPSetupWindow
 from ui.smp_question_window import SMPQuestionWindow
+from ui.contact_nickname_prompt import ContactNicknamePrompt
 from logic.authentication import authenticate_account
-from logic.storage import check_account_file, load_account_data
+from logic.storage import check_account_file, save_account_data, load_account_data
 from logic.background_worker import background_worker
 from logic.utils import thread_failsafe_wrapper
 import tkinter as tk
@@ -105,7 +106,14 @@ def poll_ui_queue(self):
                         logger.debug("Opening chat window for contact (%s) because a new message arrived", msg["contact_id"])
                         self.chat_windows_store_tmp[msg["contact_id"]] = ChatWindow(self, msg["contact_id"], self.ui_queue)
 
-                    self.chat_windows_store_tmp[msg["contact_id"]].append_message("Contact: " + msg["message"])
+                    with self.user_data_lock:
+                        contact_nickname = self.user_data["contacts"][msg["contact_id"]]["nickname"]
+                   
+
+                    if not contact_nickname:
+                        contact_nickname = "Contact"
+
+                    self.chat_windows_store_tmp[msg["contact_id"]].append_message(contact_nickname + ": " + msg["message"], contact_nickname=contact_nickname)
 
                 elif msg["type"] == "chat_closed":
                     del self.chat_windows_store_tmp[msg["contact_id"]]
@@ -163,7 +171,7 @@ def show_contacts(self):
             cursor="hand2"
         )
         username_label.pack(side="left")
-        username_label.bind("<Button-1>", lambda e: self.copy_to_clipboard(username))
+        username_label.bind("<Button-1>", lambda e: self.copy_to_clipboard(username, "Your User ID has been copied to clipboard."))
 
         header_frame = tk.Frame(self, bg="black")
         header_frame.pack(pady=10)
@@ -191,35 +199,117 @@ def show_contacts(self):
         add_button.image = plus_icon # Prevents garbage collection
         add_button.pack(side="left", padx=(5, 0))
 
-        self.contact_frame = tk.Frame(self, bg="black")
-        self.contact_frame.pack(fill="both", expand=True)
 
 
-        # Insert our saved contacts
-        for contact_id in self.user_data["contacts"]:
-            self.new_contact(contact_id)
+        canvas = tk.Canvas(self, bg="black", highlightthickness=0)
+        scrollbar = tk.Scrollbar(self, orient="vertical", command=canvas.yview)
+        self.contact_frame = tk.Frame(canvas, bg="black")
+
+        self.contact_frame.bind(
+            "<Configure>",
+            lambda e: canvas.configure(scrollregion=canvas.bbox("all"))
+        )
+
+        contact_window = canvas.create_window((0, 0), window=self.contact_frame, anchor="nw")
+
+        canvas.configure(yscrollcommand=scrollbar.set)
 
+        canvas.pack(side="left", fill="both", expand=True)
+        scrollbar.pack(side="right", fill="y")
+
+        canvas.bind_all("<MouseWheel>", lambda e: canvas.yview_scroll(int(-1 * (event.delta / 120)), "units")) # Windows / Linux mouse scrolling support
+        canvas.bind_all("<Button-4>", lambda e: canvas.yview_scroll(-1, "units")) # MacOS
+        canvas.bind_all("<Button-5>", lambda e: canvas.yview_scroll(1, "units"))  # MacOS again
+
+        canvas_frame = canvas.create_window((0, 0), window=self.contact_frame, anchor="nw")
+
+        canvas.bind("<Configure>", lambda e: canvas.itemconfig(canvas_frame, width=e.width))
+
+
+        # Draw our saved contacts
+        self.draw_contact_list()
 
         # We initialize the background worker thread and other hooks here to prevent race conditions
         self.init_hooks_and_background_worker()
 
+    def on_mousewheel(event):
+        canvas.yview_scroll(int(-1 * (event.delta / 120)), "units")
+
+
     def new_contact(self, contact_id):
-        btn = tk.Button(
+        with self.user_data_lock:
+            contact_name = contact_id if not self.user_data["contacts"][contact_id]["nickname"] else self.user_data["contacts"][contact_id]["nickname"]
+            contact_is_verified = self.user_data["contacts"][contact_id]["lt_sign_key_smp"]["verified"]
+
+        button = tk.Button(
             self.contact_frame,
-            text=contact_id,
+            text=contact_name,
             bg="gray15",
             fg="white",
             relief="flat",
             anchor="w",
             command=lambda: self.open_chat(contact_id)
         )
-        btn.pack(fill="x", padx=15, pady=5)
+        button.pack(fill="x", padx=15, pady=5)
+
+        context_menu = tk.Menu(self, tearoff=0)
+        context_menu.add_command(
+                label="Copy Contact ID", 
+                command=lambda: self.copy_to_clipboard(contact_id, "Contact ID has been copied to the clipboard")
+            )
+        context_menu.add_separator()
+
+        # If no nickname is set
+        if (contact_name == contact_id):
+            # We only allow setting nicknames after SMP verification succeeds 
+            if contact_is_verified:
+                context_menu.add_command(
+                    label="Set nickname", 
+                    command=lambda: self.change_contact_nickname(contact_id)
+                )
+        else:
+            context_menu.add_command(
+                    label="Change nickname", 
+                    command=lambda: self.change_contact_nickname(contact_id)
+                )
+
+            context_menu.add_separator()
+            
+            context_menu.add_command(
+                    label="Remove nickname", 
+                    command=lambda: self.remove_contact_nickname(contact_id)
+                )
+
+        button.bind("<Button-3>", lambda event: context_menu.tk_popup(event.x_root, event.y_root))  # Windows / Linux
+        button.bind("<Button-2>", lambda event: context_menu.tk_popup(event.x_root, event.y_root))  # MacOS
+
+    def change_contact_nickname(self, contact_id):
+        ContactNicknamePrompt(self, contact_id)
+
+    def remove_contact_nickname(self, contact_id):
+        with self.user_data_lock:
+            self.user_data["contacts"][contact_id]["nickname"] = None
+
+        logger.info("Removed nickname for contact (%s)", contact_id)
+        save_account_data(self.user_data, self.user_data_lock)
+        self.draw_contact_list()
+
+    def draw_contact_list(self):
+        logger.debug("Redrawing the contact list")
+        for widget in self.contact_frame.winfo_children():
+            widget.destroy()
+
+        with self.user_data_lock:
+            contact_ids = list(self.user_data["contacts"].keys())
+
+        for contact_id in self.user_data["contacts"]:
+            self.new_contact(contact_id)
 
-    
-    def copy_to_clipboard(self, text):
+        logger.debug("Redrew the contact list")
+    def copy_to_clipboard(self, text, success_message):
         self.clipboard_clear()
         self.clipboard_append(text)
-        messagebox.showinfo("Copied", "Your User ID has been copied to clipboard.")
+        messagebox.showinfo("Copied", success_message)
 
     def open_chat(self, contact_id):
         with self.user_data_lock:

ui/contact_nickname_prompt.py

@@ -0,0 +1,131 @@
+from tkinter import messagebox
+from ui.utils import *
+from logic.contacts import generate_random_nickname
+from logic.storage import save_account_data
+import tkinter as tk
+import logging
+
+logger = logging.getLogger(__name__)
+
+class ContactNicknamePrompt(tk.Toplevel):
+    def __init__(self, master, contact_id):
+        super().__init__(master)
+        self.title("Set Nickname")
+        self.geometry("460x300")
+        self.configure(bg="black")
+        self.resizable(False, False)
+
+        self.contact_id = contact_id
+        self.random_nickname = None
+
+        # Top warning text (We use text instead of label to color key warning parts)
+        warning_text = tk.Text(
+                self, 
+                bg="black", 
+                fg="white", 
+                font=("Helvetica", 11), 
+                wrap="word", 
+                height=9, 
+                width=50, 
+                borderwidth=0, 
+                highlightthickness=0,
+                relief="flat"
+            )
+        warning_text.insert("1.0", "Choose an anonymous nickname.\n")
+        warning_text.insert("end", "Do NOT ", "warning_italic") 
+        warning_text.insert("end", "use real names or anything identifying.\n")
+        warning_text.insert("end", "Good ", "good_bold")
+        warning_text.insert("end", "examples: Contact 1, Friend A, C1, etc.\n")
+        warning_text.insert("end", "Bad   ", "warning_bold") 
+        warning_text.insert("end", "examples: George, CIA contact, Z Dealer, etc.\n\n")
+        warning_text.insert("end", "WARNING: ", "warning_bold")
+        warning_text.insert("end", "If your device hard disk is ever compromised, custom nicknames can link handles to people.\n") 
+        warning_text.insert("end", "Please proceed with EXTREME caution.", "warning_italic")
+
+        warning_text.tag_config("italic", font=("Helvetica", 10, "italic"))
+        warning_text.tag_config("warning_bold", font=("Helvetica", 10, "bold"), foreground="red")
+        warning_text.tag_config("warning_italic", font=("Helvetica", 10, "italic"), foreground="red")
+
+        warning_text.tag_config("good_bold", font=("Helvetica", 10, "bold"), foreground="green")
+
+        warning_text.configure(state="disabled")
+        warning_text.pack(pady=(10, 10))
+
+
+        # Entry + generator button container
+        entry_frame = tk.Frame(self, bg="black")
+        entry_frame.pack(pady=5)
+
+        self.entry = tk.Entry(entry_frame, font=("Helvetica", 12), width=20)
+        self.entry.pack(side="left", padx=(0, 5))
+        self.entry.focus()
+
+        # Random nickname generator button
+        tk.Button(
+            entry_frame,
+            text="Randomize",
+            command=self.generate_nickname,
+            bg="gray25",
+            fg="white",
+            font=("Helvetica", 10, "bold"),
+            width=10
+        ).pack(side="left")
+
+        # Save button
+        tk.Button(
+            self,
+            text="Save nickname",
+            command=self.submit_nickname,
+            bg="gray20",
+            fg="white",
+            font=("Helvetica", 10, "bold"),
+            width=15
+        ).pack(pady=15)
+
+        # Enter key = save
+        self.entry.bind("<Return>", lambda e: self.submit_nickname())
+
+    def generate_nickname(self):
+        nickname = generate_random_nickname(self.master.user_data, self.master.user_data_lock, self.contact_id)
+        self.random_nickname = nickname
+
+        self.entry.delete(0, tk.END)
+        self.entry.insert(0, nickname)
+
+    def submit_nickname(self):
+        nickname = self.entry.get().strip()
+        
+        if not nickname:
+            messagebox.showerror("Error", "Field cannot be empty!")
+            return
+
+        if len(nickname) > 32:
+            messagebox.showerror("Error", "Nickname must be less than 32 characters long!")
+            return1
+
+        if nickname != self.random_nickname:
+            if not messagebox.askyesno(
+                "Warning",
+                "You did not use the Randomize button.\n\n"
+                "Custom nicknames can link your contacts to real-world identities.\n"
+                "This risks their privacy if your device is ever compromised.\n\n"
+                "Are you sure you want to proceed?"
+            ):
+                return
+
+            if not messagebox.askyesno(
+                "Final Warning",
+                "Custom nicknames can permanently compromise both your privacy and your contact’s.\n"
+                "If your device is ever seized or leaked, this link may expose real identities.\n\n"
+                "Are you ABSOLUTELY sure you want to proceed?"
+            ):
+                return
+
+        with self.master.user_data_lock:
+            self.master.user_data["contacts"][self.contact_id]["nickname"] = nickname
+
+        save_account_data(self.master.user_data, self.master.user_data_lock)
+        logger.info("Updated contact (%s) nickname to: %s", self.contact_id, nickname)
+
+        self.master.draw_contact_list()
+        self.destroy()

ui/password_window.py

@@ -45,7 +45,7 @@ def submit(self):
             self.status_label.config(text="Passwords do not match.")
             return
 
-        if len(password) < 8:
+        if password and len(password) < 8:
             if not messagebox.askyesno("No Password", "Password is less than 8 characters long, this is insecure. Are you sure you want to continue?"):
                 return
 
@@ -55,7 +55,10 @@ def submit(self):
             if not messagebox.askyesno("No Password", "You entered no password. Continue anyway?"):
                 return
 
-            if not messagebox.askyesno("No Password", "Disabling encryption allows anyone with access to your device to see your contacts, and cryptographic keys. Do this only in fully trusted environments. Are you sure?"):
+            if not messagebox.askyesno(
+                "No Password", 
+                "Disabling encryption allows anyone with access to your device to see your contacts, and cryptographic keys. Do this only in fully trusted environments. Are you absolutely sure?"
+            ):
                 return
 
         self.destroy()