ui: improved rows selection (3)

 - Pressing the Space key on a view paginates the view forward.
 - Apply rule actions both to visible selections (the ones the user
   sees), and non-visible selections (those out of the viewport).
 - Right clicking on a selection does not discard the selection.
 - Left clicking on a selection discards the selection and selects the
   clicked row.
 - Left clicking on a selected row selects/deselects the row.

ref: #1291

Author: gustavo-iniguez-goya

ui/opensnitch/customwidgets/firewalltableview.py

@@ -298,7 +298,7 @@ def refresh(self):
     def clearSelection(self):
         pass
 
-    def copySelection(self):
+    def selectedRows(self):
         selection = self.selectedIndexes()
         if not selection:
             return None

ui/opensnitch/customwidgets/generictableview.py

@@ -213,7 +213,7 @@ def __init__(self, parent):
         self.mousePressed = False
         self.shiftPressed = False
         self.ctrlPressed = False
-        self.selectedRows = {}
+        self._rows_selection = {}
         self.trackingCol = 0
 
         #eventFilter to catch key up/down events and wheel events
@@ -275,12 +275,17 @@ def scrollViewport(self, row):
             self.vScrollBar.setValue(pos)
             return pos
 
+        return None
+
     def mouseReleaseEvent(self, event):
         super().mouseReleaseEvent(event)
         self.mousePressed = False
+        if event.button() != Qt.LeftButton:
+            return
+
         for idx in self.selectionModel().selectedRows(self.trackingCol):
-            if idx.data() not in self.selectedRows.keys():
-                self.selectedRows[idx.data()] = self.getRowCells(idx.row())
+            if idx.data() != None and idx.data() not in self._rows_selection.keys():
+                self._rows_selection[idx.data()] = self.getRowCells(idx.row())
 
         # TODO: handle selection ranges when Shift is pressed
         self._selectSavedIndex()
@@ -294,7 +299,7 @@ def mouseMoveEvent(self, event):
             if item == None:
                 return
 
-            clickedItem = self.model().index(item.row(), self.trackingCol)
+            clickedItem = self.model().index(row, self.trackingCol)
             if clickedItem.data() == None:
                 return
             self.handleMouseMoveEvent(row, clickedItem, self.selectionModel().isRowSelected(row))
@@ -305,10 +310,10 @@ def mouseMoveEvent(self, event):
 
     def handleMouseMoveEvent(self, row, clickedItem, selected):
         if not selected:
-            if clickedItem.data() in self.selectedRows.keys():
-                del self.selectedRows[clickedItem.data()]
+            if clickedItem.data() in self._rows_selection.keys():
+                del self._rows_selection[clickedItem.data()]
         else:
-            self.selectedRows[clickedItem.data()] = self.getRowCells(row)
+            self._rows_selection[clickedItem.data()] = self.getRowCells(row)
 
         # handle scrolling the view while dragging the mouse.
         if self.mousePressed:
@@ -319,15 +324,14 @@ def handleMouseMoveEvent(self, row, clickedItem, selected):
             nextItem = self.model().index(scrollPos, self.trackingCol)
             if nextItem == None or nextItem.data() == None:
                 return
-            if clickedItem.data() not in self.selectedRows.keys():
-                self.selectedRows[nextItem.data()] = self.getRowCells(nextItem.row())
+            if clickedItem.data() not in self._rows_selection.keys():
+                self._rows_selection[nextItem.data()] = self.getRowCells(nextItem.row())
 
     # save the selected index, to preserve selection when moving around.
     def mousePressEvent(self, event):
         # we need to call upper class to paint selections properly
         super().mousePressEvent(event)
-        if event.button() != Qt.LeftButton:
-            return
+        rightBtnPressed = event.button() != Qt.LeftButton
 
         pos = event.pos()
         item = self.indexAt(pos)
@@ -339,7 +343,7 @@ def mousePressEvent(self, event):
         if clickedItem.data() == None:
             return
 
-        self.mousePressed = True
+        self.mousePressed = not rightBtnPressed
         flags = QItemSelectionModel.Rows | QItemSelectionModel.SelectCurrent
 
         # 1. if ctrl is pressed, select / deselect current row
@@ -349,20 +353,21 @@ def mousePressEvent(self, event):
         # 3. if ctrl is not pressed and there's more than one row selected, and
         # the clicked row is selected: discard selection, and select current
         # clicked row.
-        rowSelected = clickedItem.data() in self.selectedRows.keys()
+        # 4. if Left button has not been pressed, do not discard the selection.
+        rowSelected = clickedItem.data() in self._rows_selection.keys()
         if self.ctrlPressed:
             if rowSelected:
-                del self.selectedRows[clickedItem.data()]
+                del self._rows_selection[clickedItem.data()]
                 flags = QItemSelectionModel.Rows | QItemSelectionModel.Deselect
         else:
-            deselectCurRow = len(self.selectedRows.keys()) == 1
-            self.selectionModel().clear()
-            self.selectedRows = {}
-            if rowSelected and deselectCurRow:
-                #del self.selectedRows[clickedItem.data()]
+            deselectCurRow = len(self._rows_selection.keys()) == 1
+            if not rightBtnPressed:
+                self.selectionModel().clear()
+                self._rows_selection = {}
+            if rowSelected and deselectCurRow and not rightBtnPressed:
                 flags = QItemSelectionModel.Rows | QItemSelectionModel.Deselect
             else:
-                self.selectedRows[clickedItem.data()] = self.getRowCells(row)
+                self._rows_selection[clickedItem.data()] = self.getRowCells(row)
 
         self.selectionModel().setCurrentIndex(
             clickedItem,
@@ -400,16 +405,16 @@ def clearSelection(self):
         self.selectionModel().reset()
         self.selectionModel().clearCurrentIndex()
 
-    def copySelection(self):
+    def selectedRows(self, limit=""):
         model = self.selectionModel()
         curModel = self.model()
         selection = model.selectedRows()
         if not selection:
             return None
 
         rows = []
-        for k in self.selectedRows:
-            rows.append(self.selectedRows[k])
+        for k in self._rows_selection:
+            rows.append(self._rows_selection[k])
         return rows
 
     def getCurrentIndex(self):
@@ -428,7 +433,7 @@ def selectItem(self, _data, _column):
     def _selectSavedIndex(self):
         sel = QItemSelection()
 
-        for text in self.selectedRows.keys():
+        for text in self._rows_selection.keys():
             items = self.model().findItems(text, column=self.trackingCol)
             if len(items) == 0:
                 continue
@@ -457,8 +462,8 @@ def onScrollbarValueChanged(self, vSBNewValue):
     def onKeyUp(self):
         curIdx = self.selectionModel().currentIndex()
         if not self.shiftPressed:
-            self.selectedRows = {}
-        self.selectedRows[curIdx.data()] = self.getRowCells(curIdx.row())
+            self._rows_selection = {}
+        self._rows_selection[curIdx.data()] = self.getRowCells(curIdx.row())
 
         if self.selectionModel().currentIndex().row() == 0:
             self.vScrollBar.setValue(max(0, self.vScrollBar.value() - 1))
@@ -467,8 +472,8 @@ def onKeyDown(self):
         curIdx = self.selectionModel().currentIndex()
         curRow = curIdx.row()
         if not self.shiftPressed:
-            self.selectedRows = {}
-        self.selectedRows[curIdx.data()] = self.getRowCells(curRow)
+            self._rows_selection = {}
+        self._rows_selection[curIdx.data()] = self.getRowCells(curRow)
 
         if curRow >= self.maxRowsInViewport-2:
             self.onKeyPageDown()
@@ -498,6 +503,13 @@ def onKeyPageDown(self):
         newValue = self.vScrollBar.value() + (self.maxRowsInViewport-2)
         self.vScrollBar.setValue(newValue)
 
+    def onKeySpace(self):
+        if self.vScrollBar.isVisible() == False:
+            return
+
+        newValue = self.vScrollBar.value() + (self.maxRowsInViewport-2)
+        self.vScrollBar.setValue(newValue)
+
     def eventFilter(self, obj, event):
         if event.type() == QEvent.KeyRelease:
             if event.key() == Qt.Key_Shift:
@@ -522,11 +534,13 @@ def eventFilter(self, obj, event):
                 self.onKeyPageDown()
             elif event.key() == Qt.Key_Escape:
                 self.selectionModel().clear()
-                self.selectedRows = {}
+                self._rows_selection = {}
             elif event.key() == Qt.Key_Shift:
                 self.shiftPressed = True
             elif event.key() == Qt.Key_Control:
                 self.ctrlPressed = True
+            elif event.key() == Qt.Key_Space:
+                self.onKeySpace()
 
         elif event.type() == QEvent.Wheel:
             self.vScrollBar.wheelEvent(event)

ui/opensnitch/dialogs/stats.py

@@ -1202,9 +1202,7 @@ def _configure_rules_contextual_menu(self, pos):
             table = self._get_active_table()
             model = table.model()
 
-            selection = table.selectionModel().selectedRows()
-            if not selection:
-                return False
+            selection = table.selectedRows()
 
             menu = QtWidgets.QMenu()
             durMenu = QtWidgets.QMenu(self.COL_STR_DURATION)
@@ -1231,12 +1229,18 @@ def _configure_rules_contextual_menu(self, pos):
             _dur5m = durMenu.addAction(Config.DURATION_5m)
             menu.addMenu(durMenu)
 
-            is_rule_enabled = model.index(selection[0].row(), self.COL_R_ENABLED).data()
-            menu_label_enable = QC.translate("stats", "Disable")
-            if is_rule_enabled == "False":
-                menu_label_enable = QC.translate("stats", "Enable")
+            is_rule_enabled = True
+            _menu_enable = None
+            # if there's more than one rule selected, we choose an action
+            # based on the status of the first rule.
+            if selection and len(selection) > 0:
+                is_rule_enabled = selection[0][self.COL_R_ENABLED]
+                menu_label_enable = QC.translate("stats", "Disable")
+                if is_rule_enabled == "False":
+                    menu_label_enable = QC.translate("stats", "Enable")
+
+                _menu_enable = menu.addAction(QC.translate("stats", menu_label_enable))
 
-            _menu_enable = menu.addAction(QC.translate("stats", menu_label_enable))
             _menu_duplicate = menu.addAction(QC.translate("stats", "Duplicate"))
             _menu_edit = menu.addAction(QC.translate("stats", "Edit"))
             _menu_delete = menu.addAction(QC.translate("stats", "Delete"))
@@ -1365,9 +1369,9 @@ def _table_menu_export_clipboard(self, cur_idx, model, selection):
                     rules_list.append(self._fw.rule_to_json(r))
 
         elif cur_idx == self.TAB_RULES and self.rulesTable.isVisible():
-            for idx in selection:
-                rule_name = model.index(idx.row(), self.COL_R_NAME).data()
-                node_addr = model.index(idx.row(), self.COL_R_NODE).data()
+            for row in selection:
+                rule_name = row[self.COL_R_NAME]
+                node_addr = row[self.COL_R_NODE]
 
                 json_rule = self._nodes.rule_to_json(node_addr, rule_name)
                 if json_rule != None:
@@ -1393,17 +1397,19 @@ def _table_menu_export_clipboard(self, cur_idx, model, selection):
         QtWidgets.qApp.clipboard().setText(cliptext)
 
     def _table_menu_export_disk(self, cur_idx, model, selection):
-        outdir = QtWidgets.QFileDialog.getExistingDirectory(self,
-                                                            os.path.expanduser("~"),
-                                                            QC.translate("stats", 'Select a directory to export rules'),
-                                                            QtWidgets.QFileDialog.ShowDirsOnly | QtWidgets.QFileDialog.DontResolveSymlinks)
+        outdir = QtWidgets.QFileDialog.getExistingDirectory(
+            self,
+            os.path.expanduser("~"),
+            QC.translate("stats", 'Select a directory to export rules'),
+            QtWidgets.QFileDialog.ShowDirsOnly | QtWidgets.QFileDialog.DontResolveSymlinks
+        )
         if outdir == "":
             return
 
         error_list = []
-        for idx in selection:
-            rule_name = model.index(idx.row(), self.COL_R_NAME).data()
-            node_addr = model.index(idx.row(), self.COL_R_NODE).data()
+        for row in selection:
+            node_addr = row[self.COL_R_NODE]
+            rule_name = row[self.COL_R_NAME]
 
             ok = self._nodes.export_rule(node_addr, rule_name, outdir)
             if not ok:
@@ -1426,9 +1432,9 @@ def _table_menu_export_disk(self, cur_idx, model, selection):
 
     def _table_menu_duplicate(self, cur_idx, model, selection):
 
-        for idx in selection:
-            rule_name = model.index(idx.row(), self.COL_R_NAME).data()
-            node_addr = model.index(idx.row(), self.COL_R_NODE).data()
+        for row in selection:
+            node_addr = row[self.COL_R_NODE]
+            rule_name = row[self.COL_R_NAME]
 
             records = None
             for idx in range(0,100):
@@ -1460,9 +1466,9 @@ def _table_menu_apply_to_node(self, cur_idx, model, selection, node_addr):
 
     def _table_menu_change_rule_field(self, cur_idx, model, selection, field, value):
         if cur_idx == self.TAB_RULES and self.rulesTable.isVisible():
-            for idx in selection:
-                rule_name = model.index(idx.row(), self.COL_R_NAME).data()
-                node_addr = model.index(idx.row(), self.COL_R_NODE).data()
+            for row in selection:
+                rule_name = row[self.COL_R_NAME]
+                node_addr = row[self.COL_R_NODE]
 
                 records = self._get_rule(rule_name, node_addr)
                 rule = Rule.new_from_records(records)
@@ -1503,9 +1509,9 @@ def _table_menu_enable(self, cur_idx, model, selection, is_rule_enabled):
         enable_rule = False if is_rule_enabled == "True" else True
 
         if cur_idx == self.TAB_RULES and self.rulesTable.isVisible():
-            for idx in selection:
-                rule_name = model.index(idx.row(), self.COL_R_NAME).data()
-                node_addr = model.index(idx.row(), self.COL_R_NODE).data()
+            for row in selection:
+                rule_name = row[self.COL_R_NAME]
+                node_addr = row[self.COL_R_NODE]
 
                 records = self._get_rule(rule_name, node_addr)
                 rule = Rule.new_from_records(records)
@@ -1564,10 +1570,9 @@ def _table_menu_delete(self, cur_idx, model, selection):
                 self._notifications_sent[nid] = noti
 
         elif cur_idx == self.TAB_RULES and self.rulesTable.isVisible():
-            for idx in selection:
-                name = model.index(idx.row(), self.COL_R_NAME).data()
-                node = model.index(idx.row(), self.COL_R_NODE).data()
-                self._del_rule(name, node)
+            for row in selection:
+                node = row[self.COL_R_NODE]
+                name = row[self.COL_R_NAME]
             self._refresh_active_table()
 
         elif cur_idx == self.TAB_RULES and self.alertsTable.isVisible():
@@ -1600,9 +1605,9 @@ def _table_menu_new_rule_from_row(self, cur_idx, model, selection):
 
     def _table_menu_edit(self, cur_idx, model, selection):
         if cur_idx == self.TAB_RULES and self.rulesTable.isVisible():
-            for idx in selection:
-                name = model.index(idx.row(), self.COL_R_NAME).data()
-                node = model.index(idx.row(), self.COL_R_NODE).data()
+            for row in selection:
+                node = row[self.COL_R_NODE]
+                name = row[self.COL_R_NAME]
                 records = self._get_rule(name, node)
                 if records == None or records == -1:
                     Message.ok(QC.translate("stats", "New rule error"),