Add GUI support for selecting files to collect/upload by raverburg · Pull Request #238 · fox-it/acquire

raverburg · 2025-04-17T14:49:19Z

This update adds functionality to the GUI that allows users to select specific files for collection and/or upload. Selected files are passed to the existing logic used by acquire, allowing users to either collect them during acquisition or upload them independently.

Notes:
We use a custom version of acquire internally that looks for a config.json file in the same directory instead of using config.py

Miauwkeru · 2025-09-16T08:49:09Z

    def choose_folder(self) -> None:
        if self._closed:
            return
+


I noticed there is empty space here, most of the style/lint issues can be fixed by running tox run -e fix and then you can check it with tox run -e lint

Miauwkeru · 2025-09-16T08:55:39Z

+                    self.choose_files()
            elif lParam == self.start_button:
                user32.EnableWindow(self.start_button, False)
                user32.EnableWindow(self.choose_folder_button, False)


Suggested change

self.choose_files()

elif lParam == self.start_button:

user32.EnableWindow(self.start_button, False)

user32.EnableWindow(self.choose_folder_button, False)

self.choose_files()

elif lParam == self.start_button:

user32.EnableWindow(self.start_button, False)

user32.EnableWindow(self.choose_folder_button, False)

user32.EnableWindow(self.choose_files_button, False)

Miauwkeru · 2025-09-16T10:27:38Z

+                user32.SetWindowTextA(self.choose_files_button, b"Clear file(s)") 
+                user32.EnableWindow(self.start_button, True)
+        else:
+            print("User cancelled file selection")


Technically it could also be because the filename(s) exceeded the 4096 wchar buffer. Is there a way to distinguish between those errors? And then, show it to the user if it isn't a cancelled operation?

Miauwkeru · 2025-09-16T11:05:04Z

+        ("lStructSize", w.DWORD),
+        ("hwndOwner", w.HWND),
+        ("hInstance", w.HINSTANCE),
+        ("lpstrFilter", w.LPWSTR),


Suggested change

("lpstrFilter", w.LPWSTR),

("lpstrFilter", w.LPCWSTR),

Miauwkeru · 2025-09-16T11:07:14Z

+        ("lpstrDefExt", w.LPWSTR),
+        ("lCustData", w.LPARAM),
+        ("lpfnHook", w.LPVOID),
+        ("lpTemplateName", w.LPWSTR),


Suggested change

("lpTemplateName", w.LPWSTR),

("lpTemplateName", w.LPCSTR),

Miauwkeru · 2025-09-16T11:07:56Z

+        ("lpstrInitialDir", w.LPWSTR),
+        ("lpstrTitle", w.LPWSTR),


Suggested change

("lpstrInitialDir", w.LPWSTR),

("lpstrTitle", w.LPWSTR),

("lpstrInitialDir", w.LPCWSTR),

("lpstrTitle", w.LPCWSTR),

Miauwkeru · 2025-09-16T11:12:55Z

    get_last_error,
    sizeof,
    string_at,
+    wstring_at


Currently unused

raverburg · 2026-04-22T07:45:00Z

Hi! Sorry for the long wait. I only remembered this PR was still open when I ran into the same issue again: there's no easy way for clients to upload investigation material (without 3rd party tools), which is exactly what acquire GUI aims to fix.

I've addressed your feedback:

Correct ctypes pointer types on OPENFILENAME fields
Declare argtypes/restype for CommDlgExtendedError
Fix nMaxFile to use character count instead of byte size
Surface FNERR_BUFFERTOOSMALL error via MessageBox
Disable "Choose files" button once acquisition starts
Update wait_for_start return type to reflect list[str] for files

Miauwkeru

If acquire output folder is selected, it might be good to disable the
"select file(s) to collect" chooser.
As currently you can select both where the upload part will get ignored. Looking just at the GUI you would not expect that to happen

Miauwkeru · 2026-04-29T09:22:07Z

-    def wait_for_start(self, args: Namespace) -> tuple[str, bool, bool]:
-        return args.output, args.auto_upload, False
+    def wait_for_start(self, args: Namespace) -> tuple[str, list[str], bool, bool]:
+        return args.output, None, args.auto_upload, False


Suggested change

return args.output, None, args.auto_upload, False

return args.output, [], args.auto_upload, False

Either an empty list or change the typehint that you know you could get a None value

Miauwkeru · 2026-04-29T09:39:05Z

+            error_code = comdlg32.CommDlgExtendedError()
+            if error_code == FNERR_BUFFERTOOSMALL:
+                user32.MessageBoxA(
+                    self.hwnd, b"Too many or too long file names selected. Please select fewer files.", b"Acquire", 0


Suggested change

self.hwnd, b"Too many or too long file names selected. Please select fewer files.", b"Acquire", 0

self.hwnd, b"The combined filename length exceeded the expected size. Please select fewer files.", b"Acquire", 0

This reads better to me, but feel free to add some suggestions

Miauwkeru · 2026-05-05T14:22:10Z

+        ofn.nMaxFile = buffer_size
+        ofn.lpstrFilter = "All Files\0*.*\0Text Files\0*.txt\0\0"
+        ofn.nFilterIndex = 1
+        ofn.Flags = 0x00002000 | 0x00080000 | 0x00000200


Could you add a comment with what these magic numbers actually mean?

I noticed I was using a wrong flag so I corrected this and changed the numbers with named constants

…ing files

Co-authored-by: Miauwkeru <Miauwkeru@users.noreply.github.com>

Miauwkeru

For consistency :P

Miauwkeru · 2026-05-06T09:29:12Z

+
+
+comdlg32 = WinDLL("comdlg32", use_last_error=True)
+comdlg32.GetOpenFileNameW.argtypes = (POINTER(OPENFILENAME),)


Suggested change

comdlg32.GetOpenFileNameW.argtypes = (POINTER(OPENFILENAME),)

comdlg32.GetOpenFileNameW.argtypes = (POINTER(OPENFILENAMEW),)

Miauwkeru · 2026-05-06T09:29:40Z

+        ofn = OPENFILENAME()
+        ofn.lStructSize = sizeof(OPENFILENAME)


Suggested change

ofn = OPENFILENAME()

ofn.lStructSize = sizeof(OPENFILENAME)

ofn = OPENFILENAMEW()

ofn.lStructSize = sizeof(OPENFILENAMEW)

Miauwkeru · 2026-05-06T11:18:39Z

I reordered some function definitions so its a bit more visually distinct what belongs together. This was some general cleanup that wasn't related to the PR, so I did it myself. I will now do some final checks!

codecov · 2026-05-06T11:32:08Z

Codecov Report

❌ Patch coverage is 2.67857% with 109 lines in your changes missing coverage. Please review.
✅ Project coverage is 43.74%. Comparing base (2956b06) to head (de024d7).

Files with missing lines	Patch %	Lines
acquire/gui/win32.py	0.00%	98 Missing ⚠️
acquire/acquire.py	0.00%	9 Missing ⚠️
acquire/gui/base.py	60.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #238      +/-   ##
==========================================
- Coverage   44.75%   43.74%   -1.01%     
==========================================
  Files          26       26              
  Lines        3546     3630      +84     
==========================================
+ Hits         1587     1588       +1     
- Misses       1959     2042      +83

Flag	Coverage Δ
unittests	`43.74% <2.67%> (-1.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

raverburg · 2026-05-06T11:59:58Z

Great! Thank you for everything @Miauwkeru 😄

Miauwkeru · 2026-05-06T12:06:59Z

no problem @raverburg :)

raverburg added 3 commits April 17, 2025 07:18

Add GUI support for selecting files to collect

a9dcdb6

Update wait_for_start to pass selected files from GUI to main acquire

ff9d15d

Use existing file collection code for GUI integration

6a60c69

EinatFox mentioned this pull request Jul 1, 2025

Add GUI support for selecting files to collect/upload #252

Closed

EinatFox linked an issue Jul 1, 2025 that may be closed by this pull request

Add GUI support for selecting files to collect/upload #252

Closed

Miauwkeru requested changes Sep 16, 2025

View reviewed changes

raverburg added 3 commits November 17, 2025 14:30

Merge branch 'fox-it:main' into feature/collect_files_gui

224674d

Merge branch 'fox-it:main' into feature/collect_files_gui

989f4fb

Address PR review feedback on file-select GUI

ad1b8e2

Miauwkeru requested changes Apr 29, 2026

View reviewed changes

Address PR review feedback 2

e7db77c

raverburg force-pushed the feature/collect_files_gui branch from 86ae76a to e7db77c Compare April 29, 2026 14:33

Miauwkeru reviewed May 5, 2026

View reviewed changes

Replace OFN flag magic numbers with named constants and require exist…

0e24600

…ing files

Miauwkeru requested changes May 6, 2026

View reviewed changes

Comment thread acquire/gui/win32.py Outdated

Change OPENFILENAME to OPENFILENAMEW in win32.py

e7260fd

Co-authored-by: Miauwkeru <Miauwkeru@users.noreply.github.com>

Miauwkeru reviewed May 6, 2026

View reviewed changes

OPENFILENAME with OPENFILENAMEW

35b7016

raverburg force-pushed the feature/collect_files_gui branch from ec8f8ab to 35b7016 Compare May 6, 2026 10:05

Ordering some dll function definitions

de024d7

Miauwkeru approved these changes May 6, 2026

View reviewed changes

Miauwkeru merged commit 4ace12e into fox-it:main May 6, 2026
19 of 23 checks passed

	return args.output, None, args.auto_upload, False
	return args.output, [], args.auto_upload, False

	self.hwnd, b"Too many or too long file names selected. Please select fewer files.", b"Acquire", 0
	self.hwnd, b"The combined filename length exceeded the expected size. Please select fewer files.", b"Acquire", 0



		comdlg32 = WinDLL("comdlg32", use_last_error=True)
		comdlg32.GetOpenFileNameW.argtypes = (POINTER(OPENFILENAME),)

Conversation

raverburg commented Apr 17, 2025

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

raverburg commented Apr 22, 2026

Uh oh!

Miauwkeru left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Miauwkeru left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Miauwkeru commented May 6, 2026

Uh oh!

codecov Bot commented May 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

raverburg commented May 6, 2026

Uh oh!

Miauwkeru commented May 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

codecov Bot commented May 6, 2026 •

edited

Loading