Support deletion of multiple sources #2252

rocodes · 2024-10-04T14:29:51Z

Status

WIP and not yet runnable

Description

Still WIP - probably not yet runnable.

Add support for selecting multiple sources in the SourceList (styling tk)
Add pyqtSignal/Slot listener/requester so the top bar (actions/toolbar) can request updates on sourcelist selection status
Add another view in EmptyConversationView that instructs the user that multiple sources are selected. This is to avoid ambiguity where a single source conversation is previewed, but multiple sources are selected in the sourcelist.
"Naive"/straightforward multi delete implementation that sequentially sends DeleteSourceJob (this approach for now, pending server changes that allow for true batch delete will be an easy addition)

Fixes #2160. Details TK

Test Plan

TK

Checklist

If these changes modify code paths involving cryptography, the opening of files in VMs or network (via the RPC service) traffic, Qubes testing in the staging environment is required. For fine tuning of the graphical user interface, testing in any environment in Qubes is required. Please check as applicable:

I have tested these changes in the appropriate Qubes environment
I do not have an appropriate Qubes OS workstation set up (the reviewer will need to test these changes)
These changes should not need testing in Qubes

If these changes add or remove files other than client code, the AppArmor profile may need to be updated. Please check as applicable:

I have updated the AppArmor profile
No update to the AppArmor profile is required for these changes
I don't know and would appreciate guidance

If these changes modify the database schema, you should include a database migration. Please check as applicable:

I have written a migration and upgraded a test database based on main and confirmed that the migration is self-contained and applies cleanly
I have written a migration but have not upgraded a test database based on main and would like the reviewer to do so
I need help writing a database migration
No database schema changes are needed

MainView layout to QVBoxLayout and add inner horizontal container to accommodate inner top bar. Update strings

rocodes · 2024-10-04T15:42:04Z

client/securedrop_client/gui/actions.py

@@ -74,26 +74,24 @@ def _set_enabled_initial_value(self) -> None:


 class DeleteSourceAction(QAction):


(these changes aren't strictly needed and I might revert them; I initially was thinking we could use a single DeleteSourceAction for both the source menu and the toolbar, but in the case of the source menu, the target sources are supplied when the action is created, but in the case of the toolbar, the action is created before the target sources are available. The benefit to keeping the changes in is that they will work for if/when we do eventually deprecate the source menu and consolidate around one deletion mechanism.)

rocodes · 2024-10-04T15:46:51Z

client/securedrop_client/gui/main.py

@@ -75,6 +80,13 @@ def __init__(
        self.main_pane.setLayout(layout)
        self.left_pane = LeftPane()
        self.main_view = MainView(self.main_pane, app_state)


(I think I've introduced a bug here that I need to fix - there's a logline about attempting to apply a layout to MainView when a layout has already been applied. It doesn't have any ill effects, but it's on my radar to find + fix before this PR is ready for review.)

rocodes · 2024-10-04T15:54:53Z

client/securedrop_client/gui/main.py

+        self.main_view.add_sourcelist_listener(
+            self.top_pane._source_requester(), self.top_pane._source_listener()
+        )
+


There's a couple different ways we can do this, this one felt like the least-worst way, but I'm open to opinions.

Basically, the main view (holds the sourcelist) and the top bar (holds the toolbar) need a way of communicating; either the top bar receives a constant feed of events as the selected item of the sourcelist changes (in which case it would just connect to onItemChanged in the sourcelist and would not need to have a request signal, but it would need to push or pop items from the selected set all the time to keep track of the list); or, on demand it requests the selected set when it needs them (what I have implemented here). I felt like this way was a little less error-prone than that way.

I could have/could still skip the main_view and top_pane abstraction, and go for self.main_view.source_list.connect.... etc, but that felt like reaching quite far into the business of another gui element; similarly, top_pane.batch_actions.toolbar. could be accessed directly. I have no strong preferences and was trying make things fairly easy to read/follow. feedback welcome.

rocodes · 2024-10-04T15:56:31Z

client/securedrop_client/locale/messages.pot

+msgid "Select or de-select sources using Ctrl+click, Shift+click, or by dragging the mouse."
+msgstr ""
+
+msgid "Use the top toolbar to delete multiple sources at once."


(When/if we add more options, this text will change. I'm not attached to it)

rocodes · 2024-10-04T15:57:49Z

client/securedrop_client/resources/css/sdclient.css

+#InnerTopPane {
+    background-color: #f3f5f9;
+}
+


These colours aren't right, someone please help me, this is a cry for help :) (I will try and make some changes to the button disabled state and the active states to make them less jarring, but help slash a reminder that I don't do a good job at visual things)

…pdated list of selected sources from sourcelist. Disable toolbar unless logged in. Change list selection method of SourceList to allow for multi-select.

…iew pane in the conversationview.

rocodes added 2 commits October 3, 2024 12:12

Add "Delete Sources" (batch delete) buttin in top bar. Change

c8aecc3

MainView layout to QVBoxLayout and add inner horizontal container to accommodate inner top bar. Update strings

Add "Delete Sources" (batch delete) buttin in top bar. Change

61fc75e

MainView layout to QVBoxLayout and add inner horizontal container to accommodate inner top bar. Update strings

rocodes commented Oct 4, 2024

View reviewed changes

rocodes added 5 commits October 4, 2024 12:02

Fix LeftPane docstring

67400fd

wip

d316f0a

WIP: Provide pyqtSignal and Slot for toolbar to request and receive u…

a49f109

…pdated list of selected sources from sourcelist. Disable toolbar unless logged in. Change list selection method of SourceList to allow for multi-select.

WIP: Add support for multi-source selection, and add a multi-source v…

5d215e8

…iew pane in the conversationview.

Update strings

ddbb33a

rocodes force-pushed the 2160-batch-delete-sources branch from f433abe to ddbb33a Compare October 4, 2024 16:04

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Support deletion of multiple sources #2252

Support deletion of multiple sources #2252

rocodes commented Oct 4, 2024

rocodes Oct 4, 2024 •

edited

Loading

rocodes Oct 4, 2024

rocodes Oct 4, 2024 •

edited

Loading

rocodes Oct 4, 2024

rocodes Oct 4, 2024

		@@ -74,26 +74,24 @@ def _set_enabled_initial_value(self) -> None:


		class DeleteSourceAction(QAction):

Support deletion of multiple sources #2252

Are you sure you want to change the base?

Support deletion of multiple sources #2252

Conversation

rocodes commented Oct 4, 2024

Status

Description

Test Plan

Checklist

rocodes Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

rocodes Oct 4, 2024

Choose a reason for hiding this comment

rocodes Oct 4, 2024 • edited Loading

Choose a reason for hiding this comment

rocodes Oct 4, 2024

Choose a reason for hiding this comment

rocodes Oct 4, 2024

Choose a reason for hiding this comment

rocodes Oct 4, 2024 •

edited

Loading

rocodes Oct 4, 2024 •

edited

Loading