pdflinkcheck 1.1.73__py3-none-any.whl → 1.1.94__py3-none-any.whl

pdflinkcheck/gui.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python3 
+# SPDX-License-Identifier: MIT
 # src/pdflinkcheck/gui.py
 import tkinter as tk
 from tkinter import filedialog, ttk, messagebox # Added messagebox
@@ -7,20 +9,15 @@ from typing import Optional # Added Optional
 import unicodedata
 from importlib.resources import files
 import pyhabitat
-"""
-try:
-    import sv_ttk
-    # Apply Sun Valley Tk theme
-    sv_ttk.set_theme("light")
-except Exception:
-    # Theme not available in bundle — use default
-    pass
-"""
+import ctypes
+
+
+
 # Import the core analysis function
-from pdflinkcheck.report import run_report
-from pdflinkcheck.validate import run_validation 
+from pdflinkcheck.report import run_report_and_call_exports
 from pdflinkcheck.version_info import get_version_from_pyproject
 from pdflinkcheck.io import get_first_pdf_in_cwd, get_friendly_path, PDFLINKCHECK_HOME
+from pdflinkcheck.environment import pymupdf_is_available, clear_all_caches, is_in_git_repo
 
 class RedirectText:
     """A class to redirect sys.stdout messages to a Tkinter Text widget."""
@@ -37,30 +34,79 @@ class RedirectText:
         """Required for file-like objects, but does nothing here."""
         pass
 
+
 class PDFLinkCheckerApp(tk.Tk):
+
+    def _initialize_forest_theme(self):
+        from importlib.resources import files 
+        # Path to pdflinkcheck/data/themes/forest/ 
+        theme_dir = files("pdflinkcheck.data.themes.forest") 
+        # Load the theme files
+        self.tk.call("source", str(theme_dir / f"forest-light.tcl")) 
+        self.tk.call("source", str(theme_dir / f"forest-dark.tcl")) 
+
+    
+
+    def _toggle_theme(self):
+        # You could instead assign the dark to light of a single theme here
+        """
+        Calls light/dark toggle for the forest theme with self._toggle_theme_just_forest()
+        """
+        return self._toggle_theme_forest()
+
+    def _toggle_theme_forest(self):
+        if ttk.Style().theme_use() == "forest-light":
+            ttk.Style().theme_use("forest-dark")
+        elif ttk.Style().theme_use() == "forest-dark":
+            ttk.Style().theme_use("forest-light")
+
+    def _set_icon(self):
+        from importlib.resources import files 
+        # Path to pdflinkcheck/data/icons/
+        icon_dir = files("pdflinkcheck.data.icons") 
+        # Convert to a real filesystem path 
+        icon_path = icon_dir.joinpath("red_pdf_128px.ico")
+        icon_path = icon_dir.joinpath("red_pdf_512px.ico")
+        
+        self.iconbitmap(str(icon_path))
+            
     def __init__(self):
         super().__init__()
-        self.title(f"PDF Link Check v{get_version_from_pyproject()}")
-        self.geometry("800x600")
+
+    
+        self._initialize_forest_theme() # load but do not set internally
         
-        # Style for the application
-        style = ttk.Style(self)
-        style.theme_use('clam')
+        ttk.Style().theme_use("forest-dark") # but if you use _toggle_theme_just_forest(), then you had better do this
+
+        if is_in_git_repo() and not pyhabitat.as_pyinstaller() and not pyhabitat.is_pyz():
+            # Checking for PYZ is overkill, because a PYZ s not expected to carry a .git directory, which is a check that is already completed.
+            title_suffix = ""# " [Development]"
+        else:
+            title_suffix = ""
+        
+        self.title(f"PDF Link Check v{get_version_from_pyproject()}{title_suffix}")
+        self.geometry("800x600")
+
+        self._set_icon()
+
         
         # --- 1. Initialize Variables ---
         self.pdf_path = tk.StringVar(value="")
         self.pdf_library_var = tk.StringVar(value="PyMuPDF")
-        #self.pdf_library_var.set("PyMuPDF")
         self.max_links_var = tk.StringVar(value="50")
         self.show_all_links_var = tk.BooleanVar(value=True)  
         self.do_export_report_json_var = tk.BooleanVar(value=True) 
-        self.do_export_report_txt_var = tk.BooleanVar(value=False) 
+        self.do_export_report_txt_var = tk.BooleanVar(value=True) 
         self.current_report_text = None
         self.current_report_data = None
 
         self.supported_export_formats = ["JSON", "MD", "TXT"]
         self.supported_export_formats = ["JSON"]
-        
+
+        if not pymupdf_is_available():
+            print(f"pymupdf_is_available: {pymupdf_is_available()}")
+            self.pdf_library_var.set("pypdf")
+
         
         # --- 2. Create Widgets ---
         self._create_widgets()
@@ -69,7 +115,23 @@ class PDFLinkCheckerApp(tk.Tk):
         self._toggle_max_links_entry() 
         self._toggle_json_export()
         self._toggle_txt_export()
-        
+
+        # --- Menubar with dropdown ---
+        menubar = tk.Menu(self)
+        self.config(menu=menubar)
+
+        # Tools menu
+        tools_menu = tk.Menu(menubar, tearoff=0)
+        menubar.add_cascade(label="Tools", menu=tools_menu)
+
+        tools_menu.add_command(label="Toggle Theme", command=self._toggle_theme)
+        tools_menu.add_command(label="Clear Cache", command=self._clear_all_caches)
+
+        # Add existing License/Readme to tools menu
+        tools_menu.add_separator()
+        tools_menu.add_command(label="License", command=self._show_license)
+        tools_menu.add_command(label="Readme", command=self._show_readme)
+        tools_menu.add_command(label="I Have Questions", command=self._show_i_have_questions)
     # In class PDFLinkCheckerApp:
 
     def _copy_pdf_path(self):
@@ -98,22 +160,43 @@ class PDFLinkCheckerApp(tk.Tk):
         """Scrolls the output text widget to the bottom."""
         self.output_text.see(tk.END) # tk.END is the index for the position just after the last character
 
+    def _clear_all_caches(self):
+        """Clear caches and show confirmation."""
+        clear_all_caches()
+        messagebox.showinfo("Caches Cleared", f"All caches have been cleared.\nPyMuPDF available: {pymupdf_is_available()}")
+
     def _show_license(self):
         """
         Reads the embedded LICENSE file (AGPLv3) and displays its content in a new modal window.
         """
         try:
-            # CORRECT WAY: Use the Traversable object's read_text() method.
+            # Use the Traversable object's read_text() method.
             # This handles files located inside zip archives (.pyz, pipx venvs) correctly.
             license_path_traversable = files("pdflinkcheck.data") / "LICENSE"
             license_content = license_path_traversable.read_text(encoding="utf-8")
             
         except FileNotFoundError:
-            messagebox.showerror(
-                "License Error", 
-                "LICENSE file not found within the installation package (pdflinkcheck.data/LICENSE). Check build process."
-            )
+            if is_in_git_repo():
+                messagebox.showinfo(
+                    "Local Development Mode",
+                    "Embedded data files not found – copying from root..."
+                )
+                try:
+                    from pdflinkcheck.datacopy import ensure_package_license, ensure_data_files_for_build
+                    #ensure_package_license()
+                    ensure_data_files_for_build()  
+                    # Retry display
+                    self._show_license() 
+                    return
+                except Exception as e:
+                    messagebox.showerror("Copy Failed", f"Could not copy file: {e}")
+            else:
+                messagebox.showerror(
+                    "Packaging Error",
+                    "Embedded file not found. This indicates a problem with the package build/installation."
+                )
             return
+        
         except Exception as e:
             messagebox.showerror("Read Error", f"Failed to read embedded LICENSE file: {e}")
             return
@@ -146,17 +229,31 @@ class PDFLinkCheckerApp(tk.Tk):
         Reads the embedded README.md file and displays its content in a new modal window.
         """
         try:
-            # CORRECT WAY: Use the Traversable object's read_text() method.
+            # Use the Traversable object's read_text() method.
             # This handles files located inside zip archives (.pyz, pipx venvs) correctly.
             readme_path_traversable = files("pdflinkcheck.data") / "README.md"
             readme_content = readme_path_traversable.read_text(encoding="utf-8")
             readme_content = sanitize_glyphs_for_tkinter(readme_content)
-            
         except FileNotFoundError:
-            messagebox.showerror(
-                "Readme Error", 
-                "README.md file not found within the installation package (pdflinkcheck.data/README.md). Check build process."
-            )
+            if is_in_git_repo():
+                messagebox.showinfo(
+                    "Local Development Mode",
+                    "Embedded data files not found – copying from root..."
+                )
+                try:
+                    from pdflinkcheck.datacopy import ensure_package_readme, ensure_data_files_for_build 
+                    #ensure_package_readme()
+                    ensure_data_files_for_build()  
+                    # Retry display
+                    self._show_readme() 
+                    return
+                except Exception as e:
+                    messagebox.showerror("Copy Failed", f"Could not copy file: {e}")
+            else:
+                messagebox.showerror(
+                    "Packaging Error",
+                    "Embedded file not found. This indicates a problem with the package build/installation."
+                )
             return
         except Exception as e:
             messagebox.showerror("Read Error", f"Failed to read embedded README.md file: {e}")
@@ -185,6 +282,43 @@ class PDFLinkCheckerApp(tk.Tk):
         readme_window.grab_set()
         self.wait_window(readme_window)
 
+    def _show_i_have_questions(self):
+        """
+        Reads the embedded I Have Questions.md file and displays its content in a new modal window.
+        """
+        try:
+            # Use the Traversable object's read_text() method.
+            # This handles files located inside zip archives (.pyz, pipx venvs) correctly.
+            i_have_questions_path_traversable = files("pdflinkcheck.data") / "I Have Questions.md"
+            i_have_questions_content = i_have_questions_path_traversable.read_text(encoding="utf-8")
+            i_have_questions_content = sanitize_glyphs_for_tkinter(i_have_questions_content)
+        except FileNotFoundError:
+            messagebox.showerror("Read Error", f"Failed to read embedded 'I Have Questions.md' file.")
+            return
+
+        # --- Display in a New Toplevel Window ---
+        i_have_questions_window = tk.Toplevel(self)
+        i_have_questions_window.title("I Have Questions.md")
+        i_have_questions_window.geometry("600x400")
+        
+        # Text widget for content
+        text_widget = tk.Text(i_have_questions_window, wrap=tk.WORD, font=('Monospace', 10), padx=10, pady=10)
+        text_widget.insert(tk.END, i_have_questions_content)
+        text_widget.config(state=tk.DISABLED)
+        
+        # Scrollbar
+        scrollbar = ttk.Scrollbar(i_have_questions_window, command=text_widget.yview)
+        text_widget['yscrollcommand'] = scrollbar.set
+        
+        # Layout
+        scrollbar.pack(side=tk.RIGHT, fill=tk.Y)
+        text_widget.pack(fill='both', expand=True)
+        
+        # Make the window modal (optional, but good practice for notices)
+        i_have_questions_window.transient(self)
+        i_have_questions_window.grab_set()
+        self.wait_window(i_have_questions_window)
+
     def _create_widgets(self):
         # --- Control Frame (Top) ---
         control_frame = ttk.Frame(self, padding="10")
@@ -228,7 +362,7 @@ class PDFLinkCheckerApp(tk.Tk):
         ).pack(side='left', padx=5, pady=1)
 
         ttk.Label(report_brevity_frame, text="Max Links to Display:").pack(side='left', padx=5, pady=1)
-        self.max_links_entry = ttk.Entry(report_brevity_frame, textvariable=self.max_links_var, width=4)
+        self.max_links_entry = ttk.Entry(report_brevity_frame, textvariable=self.max_links_var, width=7)
         self.max_links_entry.pack(side='left', padx=5, pady=5)
 
         # --- PDF Library Selection ---
@@ -274,11 +408,7 @@ class PDFLinkCheckerApp(tk.Tk):
         run_analysis_btn = ttk.Button(control_frame, text="▶ Run Analysis", command=self._run_report_gui, style='Accent.TButton')
         run_analysis_btn.grid(row=3, column=0, columnspan=2, pady=10, sticky='ew', padx=(0, 5))
 
-        run_validation_btn = ttk.Button(control_frame, text="▶ Run Validation", command=self._run_validation_gui, style='Accent.TButton')
-        run_validation_btn.grid(row=4, column=0, columnspan=2, pady=10, sticky='ew', padx=(0, 5))
-        # Ensure the run button frame expands to fill its column
-        #run_analysis_btn.grid_columnconfigure(0, weight=1)
-
+        """
         # 2. Create a Frame to hold the two file link buttons (This frame goes into column 2)
         info_btn_frame = ttk.Frame(control_frame)
         info_btn_frame.grid(row=3, column=2, columnspan=1, pady=10, sticky='ew', padx=(5, 0))
@@ -286,13 +416,14 @@ class PDFLinkCheckerApp(tk.Tk):
         info_btn_frame.grid_columnconfigure(0, weight=1)
         info_btn_frame.grid_columnconfigure(1, weight=1)
 
-        # 3. Place License and Readme buttons inside the new frame
-        license_btn = ttk.Button(info_btn_frame, text="License", command=self._show_license)
+        # 3. Placeholder buttons inside the info button frame
+        info_1_btn = ttk.Button(info_btn_frame, text="Empty1", command=self._do_stuff_1)
         # Use PACK or a 2-column GRID inside the info_btn_frame. GRID is cleaner here.
-        license_btn.grid(row=0, column=0, sticky='ew', padx=(0, 2)) # Left side of the frame
+        info_1_btn.grid(row=0, column=0, sticky='ew', padx=(0, 2)) # Left side of the frame
 
-        readme_btn = ttk.Button(info_btn_frame, text="Readme", command=self._show_readme)
-        readme_btn.grid(row=0, column=1, sticky='ew', padx=(2, 0)) # Right side of the frame
+        info_2_btn = ttk.Button(info_btn_frame, text="Empty2", command=self._do_stuff_2)
+        info_2_btn.grid(row=0, column=1, sticky='ew', padx=(2, 0)) # Right side of the frame
+        """
 
         # Force the columns to distribute space evenly
         control_frame.grid_columnconfigure(0, weight=2)
@@ -342,7 +473,7 @@ class PDFLinkCheckerApp(tk.Tk):
         if self.pdf_path.get():
             initialdir = str(Path(self.pdf_path.get()).parent)
         else:
-            initialdir = str(Path.cwd())
+            initialdir = str(Path.home())
 
         file_path = filedialog.askopenfilename(
             initialdir=initialdir,
@@ -370,6 +501,15 @@ class PDFLinkCheckerApp(tk.Tk):
         if self.do_export_report_txt_var.get():
             pass # placeholder # no side effects
     
+
+
+    def _toggle_pdf_library(self):
+        selected_lib = self.pdf_library_var.get().lower()
+        try:
+            self.pdf_library_var.set("pypdf" if selected_lib == "pymupdf" else "pymupdf")
+        except Exception:
+            pass
+
     def _assess_pdf_path_str(self):
         pdf_path_str = self.pdf_path.get().strip()
         if not pdf_path_str: 
@@ -399,7 +539,7 @@ class PDFLinkCheckerApp(tk.Tk):
         else:
             try:
                 max_links_to_pass = int(self.max_links_var.get())
-                if max_links_to_pass < 1:
+                if max_links_to_pass < 0:
                      self._display_error("Error: Max Links must be a positive number (or use 'Show All').")
                      return
             except ValueError:
@@ -427,7 +567,7 @@ class PDFLinkCheckerApp(tk.Tk):
         try:
             # 3. Call the core logic function
             #self.output_text.insert(tk.END, "--- Starting Analysis ---\n")
-            report_results = run_report(
+            report_results = run_report_and_call_exports(
                 pdf_path=pdf_path_str,
                 max_links=max_links_to_pass,
                 export_format=export_format,
@@ -440,67 +580,44 @@ class PDFLinkCheckerApp(tk.Tk):
 
         except Exception as e:
             # Inform the user in the GUI with a clean message
-            self._display_error(f"An unexpected error occurred during analysis: {e}")
-
-        finally:
-            # 4. Restore standard output and disable editing
-            sys.stdout = original_stdout
-            self.output_text.config(state=tk.DISABLED)
-    
-    def _run_validation_gui(self):
-        
-        pdf_path_str = self._assess_pdf_path_str()
-        if not pdf_path_str:
-            return
-
-        pdf_library = self._discern_pdf_library()
-
-        # 1. Clear previous output and enable editing
-        self.output_text.config(state=tk.NORMAL)
-        self.output_text.delete('1.0', tk.END)
-
-        # 2. Redirect standard output to the Text widget
-        original_stdout = sys.stdout
-        sys.stdout = RedirectText(self.output_text)
-        
-        if not self.current_report_data:
-            self._run_report_gui()
-        report_results = self.current_report_data
-
-        try:
-            # 3. Call the core logic function
-            #self.output_text.insert(tk.END, "--- Starting Analysis ---\n")
-            validation_results = run_validation(
-                report_results=report_results,
-                pdf_path=pdf_path_str,
-                pdf_library=pdf_library,
-                export_json=True,
-                print_bool=True
+            messagebox.showinfo(  # Changed from showwarning – less alarming
+                "PyMuPDF Not Available",
+                "PyMuPDF is not installed or not working.\n"
+                "Switched to pypdf engine automatically.\n\n"
+                "To use the faster PyMuPDF engine:\n"
+                "1. Install it: pip install pymupdf\n"
+                "2. Go to Tools → Clear Cache\n"
+                "3. Run analysis again"
             )
-            self.current_report_text = report_results.get("text", "")
-            self.current_report_data = report_results.get("data", {})
-
-            #self.output_text.insert(tk.END, "\n--- Analysis Complete ---\n")
-
-        except Exception as e:
-            # Inform the user in the GUI with a clean message
-            self._display_error(f"An unexpected error occurred during analysis: {e}")
-
+            self._toggle_pdf_library()
+    
+            
         finally:
             # 4. Restore standard output and disable editing
             sys.stdout = original_stdout
             self.output_text.config(state=tk.DISABLED)
-        
-
+            # -- This call to _toggle_pdf_library() fails currently --
+            
     def _discern_pdf_library(self):
         selected_lib = self.pdf_library_var.get().lower()
         
         if selected_lib == "pymupdf":
-            print("Using high-speed PyMuPDF engine.")
+            self._display_msg("Using high-speed PyMuPDF engine.")
         elif selected_lib == "pypdf":
-            print("Using pure-python pypdf engine.")
+            self._display_msg("Using pure-python pypdf engine.")
         return selected_lib
     
+    def _display_msg(self, message):
+        # Ensure output is in normal state to write
+        original_state = self.output_text.cget('state')
+        if original_state == tk.DISABLED:
+            self.output_text.config(state=tk.NORMAL)
+            
+        #self.output_text.delete('1.0', tk.END)
+        self.output_text.insert(tk.END, f"{message}\n", 'msg')
+        self.output_text.tag_config('msg')#, foreground='red')
+        self.output_text.see(tk.END)
+
     def _display_error(self, message):
         # Ensure output is in normal state to write
         original_state = self.output_text.cget('state')
@@ -536,15 +653,7 @@ class PDFLinkCheckerApp(tk.Tk):
             
         except Exception as e:
             messagebox.showerror("View Error", f"Could not launch editor: {e}")
-
-"""
-def toggle_theme():
-    try:
-        current = sv_ttk.get_theme()
-        sv_ttk.set_theme("dark" if current == "light" else "light")
-    except Exception:
-        pass
-"""     
+    
 def sanitize_glyphs_for_tkinter(text: str) -> str:
     """
     Converts complex Unicode characters (like emojis and symbols) 
@@ -574,13 +683,30 @@ def auto_close_window(root, delay_ms:int = 0):
         return
 
 
+
 def start_gui(time_auto_close:int=0):
     """
     Entry point function to launch the application.
     """
     print("pdflinkcheck: start_gui ...")
+    
     tk_app = PDFLinkCheckerApp()
 
+    # Bring window to front 
+    tk_app.lift() 
+    #tk_app.attributes('-topmost', True) 
+    #tk_app.after(100, lambda: tk_app.attributes('-topmost', False)) 
+    tk_app.wm_attributes("-topmost", True) 
+    tk_app.after(200, lambda: tk_app.wm_attributes("-topmost", False))
+    tk_app.deiconify()
+    tk_app.focus_force()
+
+    # Win32 nudge (optional but helpful)
+    if pyhabitat.on_windows():
+        hwnd = tk_app.winfo_id() 
+        ctypes.windll.user32.SetForegroundWindow(hwnd)
+    
+    # Ths is called in the CLI by the --auto-close flag value, for CI scripted testing purposes (like in .github/workflows/build.yml) 
     auto_close_window(tk_app, time_auto_close)
 
     tk_app.mainloop()

pdflinkcheck/io.py

@@ -1,3 +1,5 @@
+#!/usr/bin/env python3 
+# SPDX-License-Identifier: MIT
 # src/pdflinkcheck/io.py
 import logging
 import json
@@ -112,6 +114,7 @@ def export_report_json(
     pdf_library: str
 ) -> Path:
     """Exports structured dictionary results to a .json file."""
+    
     base_name = Path(pdf_filename).stem
     output_path = PDFLINKCHECK_HOME / f"{base_name}_{pdf_library}_report.json"
 
@@ -130,6 +133,7 @@ def export_report_txt(
     pdf_library: str
 ) -> Path:
     """Exports the formatted string buffer to a .txt file."""
+    #pdf_filename = implement_non_redundant_naming(pdf_filename)
     base_name = Path(pdf_filename).stem
     output_path = PDFLINKCHECK_HOME / f"{base_name}_{pdf_library}_report.txt"
 
@@ -141,24 +145,6 @@ def export_report_txt(
         error_logger.error(f"TXT export failed: {e}", exc_info=True)
         raise RuntimeError(f"TXT export failed: {e}")
 
-def export_validation_json(
-    report_data: Dict[str, Any], 
-    pdf_filename: str, 
-    pdf_library: str
-) -> Path:
-    """Exports structured dictionary validation results to a .json file."""
-    base_name = Path(pdf_filename).stem
-    output_path = PDFLINKCHECK_HOME / f"{base_name}_{pdf_library}_validation.json"
-
-    try:
-        with open(output_path, 'w', encoding='utf-8') as f:
-            json.dump(report_data, f, indent=4)
-        print(f"\nJSON validation exported: {get_friendly_path(output_path)}")
-        return output_path
-    except Exception as e:
-        error_logger.error(f"JSON validation export failed: {e}", exc_info=True)
-        raise RuntimeError(f"JSON validation export failed: {e}")
-
 # --- helpers ---
 def get_friendly_path(full_path: str) -> str:
     p = Path(full_path).resolve()