[cuegui] Add LockState Filter to "Monitor Hosts" window in CueCommander (#1679)

- Add `LockStateSeq` message with `repeated LockState state` in
`host.proto` and update HostSearchCriteria
- Update `HostMonitor.py` to include the menu to filter by lock state
- Update `HostSearch.java` to include lock state filtering
- Add lock state handling in `_setOptions` function in `search.py`

**Link the Issue(s) this Pull Request is related to.**
#1678

Author: ramonfigueiredo

VERSION.in

@@ -1 +1 @@
-1.7
+1.8

cuebot/src/main/java/com/imageworks/spcue/dao/criteria/postgres/HostSearch.java

@@ -21,6 +21,7 @@
 import com.imageworks.spcue.AllocationInterface;
 import com.imageworks.spcue.dao.criteria.HostSearchInterface;
 import com.imageworks.spcue.grpc.host.HardwareState;
+import com.imageworks.spcue.grpc.host.LockState;
 import com.imageworks.spcue.grpc.host.HostSearchCriteria;
 
 public class HostSearch extends Criteria implements HostSearchInterface {
@@ -45,10 +46,16 @@ public void buildWhereClause() {
         addLikePhrase("host.str_name", new HashSet<>(criteria.getSubstrList()));
         addRegexPhrase("host.str_name", new HashSet<>(criteria.getRegexList()));
         addPhrase("alloc.str_name", criteria.getAllocsList());
-        Set<String> items = new HashSet<>(criteria.getStates().getStateCount());
-        for (HardwareState w : criteria.getStates().getStateList()) {
-            items.add(w.toString());
+        Set<String> hardwareStateItems = new HashSet<>(criteria.getStates().getStateCount());
+        for (HardwareState state : criteria.getStates().getStateList()) {
+            hardwareStateItems.add(state.toString());
         }
-        addPhrase("host_stat.str_state", items);
+        addPhrase("host_stat.str_state", hardwareStateItems);
+
+        Set<String> lockStateItems = new HashSet<>(criteria.getLockStates().getStateCount());
+        for (LockState lockState : criteria.getLockStates().getStateList()) {
+            lockStateItems.add(lockState.toString());
+        }
+        addPhrase("host.str_lock_state", lockStateItems);
     }
 }

cuegui/cuegui/HostMonitor.py

@@ -60,6 +60,7 @@ def __init__(self, parent):
         self.__filterByHostNameSetup(hlayout)
         self.__filterAllocationSetup(hlayout)
         self.__filterHardwareStateSetup(hlayout)
+        self.__filterLockStateSetup(hlayout)
         hlayout.addStretch()
         self.__refreshToggleCheckBoxSetup(hlayout)
         self.__refreshButtonSetup(hlayout)
@@ -265,6 +266,96 @@ def __filterHardwareStateHandle(self, action):
 
         self.hostMonitorTree.updateRequest()
 
+    # ==============================================================================
+    # Menu to filter by lock state
+    # ==============================================================================
+    def __filterLockStateSetup(self, layout):
+        self.__filterLockStateList = sorted(opencue.api.host_pb2.LockState.keys())
+
+        btn = QtWidgets.QPushButton("Filter LockState")
+        btn.setMaximumHeight(FILTER_HEIGHT)
+        btn.setFocusPolicy(QtCore.Qt.NoFocus)
+        btn.setContentsMargins(0, 0, 0, 0)
+        btn.setFlat(True)
+
+        menu = QtWidgets.QMenu(self)
+        btn.setMenu(menu)
+        QtCore.QObject.connect(menu,
+                               QtCore.SIGNAL("triggered(QAction*)"),
+                               self.__filterLockStateHandle)
+
+        for item in ["Clear", None] + self.__filterLockStateList:
+            if item:
+                a = QtWidgets.QAction(menu)
+                a.setText(str(item))
+                if item != "Clear":
+                    a.setCheckable(True)
+                menu.addAction(a)
+            else:
+                menu.addSeparator()
+
+        layout.addWidget(btn)
+        self.__filterLockStateButton = btn
+
+    def __filterLockStateClear(self):
+        """Clears the currently selected lock state menu items"""
+        btn = self.__filterLockStateButton
+        menu = btn.menu()
+        for action in menu.actions():
+            action.setChecked(False)
+        self.hostMonitorTree.hostSearch.options['lock_state'] = []
+
+    def __filterLockStateHandle(self, action):
+        """Called when an option in the filter lock state menu is triggered.
+        Tells the HostMonitorTree widget what lock state to filter by.
+        @param action: Defines the menu item selected
+        @type  action: QAction"""
+        __hostSearch = self.hostMonitorTree.hostSearch
+        if action.text() == "Clear":
+            self.__clearLockStateFilter(__hostSearch)
+            return
+
+        self.__updateLockStateFilter(__hostSearch, action)
+
+        self.hostMonitorTree.updateRequest()
+
+    def __clearLockStateFilter(self, __hostSearch):
+        """
+        Clears the currently selected lock state menu items and updates the search options.
+        @param __hostSearch: The host search criteria object to update.
+        @type __hostSearch: HostSearchCriteria
+        """
+        for item in self.__filterLockStateButton.menu().actions():
+            if item.isChecked() and item.text() != "Clear":
+                # Remove the lock state from the search options
+                __hostSearch.options['lock_state'].remove(
+                    getattr(opencue.api.host_pb2, str(item.text())))
+            # Uncheck the menu item
+            item.setChecked(False)
+
+    def __updateLockStateFilter(self, __hostSearch, action):
+        """
+        Updates the lock state filter based on the selected action.
+        @param __hostSearch: The host search criteria object to update.
+        @type __hostSearch: HostSearchCriteria
+        @param action: The action that was triggered.
+        @type action: QAction
+        """
+        # Get the current lock states from the search options
+        lock_states = __hostSearch.options.get('lock_state', [])
+        # Get the lock state corresponding to the action text
+        lock_state = getattr(opencue.api.host_pb2, str(action.text()))
+
+        if action.isChecked():
+            # Add the lock state if the action is checked
+            lock_states.append(lock_state)
+        else:
+            # Remove the lock state if the action is unchecked
+            lock_states.remove(lock_state)
+
+        # Update the search options with the new lock states
+        __hostSearch.options['lock_state'] = lock_states
+
     # ==============================================================================
     # Checkbox to toggle auto-refresh
     # ==============================================================================
@@ -326,6 +417,7 @@ def __clearButtonHandle(self):
         self.hostMonitorTree.ticksWithoutUpdate = -1
         self.__filterAllocationClear()
         self.__filterHardwareStateClear()
+        self.__filterLockStateClear()
         self.__filterByHostNameClear()
         self.hostMonitorTree.clearFilters()
 

proto/host.proto

@@ -240,6 +240,10 @@ message HardwareStateSeq {
     repeated HardwareState state = 1;
 }
 
+message LockStateSeq {
+    repeated LockState state = 1;
+}
+
 message Host {
     string id = 1;
     string name = 2;
@@ -279,6 +283,7 @@ message HostSearchCriteria {
     repeated string ids = 4;
     repeated string allocs = 5;
     HardwareStateSeq states = 6;
+    LockStateSeq lock_states = 7;
 }
 
 message HostSeq {

pycue/opencue/search.py

@@ -340,6 +340,9 @@ def _setOptions(criteria, options):
         elif k == "state" and isinstance(criteria, host_pb2.HostSearchCriteria):
             raiseIfNotList(k, v)
             criteria.states.state.extend(v)
+        elif k == "lock_state" and isinstance(criteria, host_pb2.HostSearchCriteria):
+            raiseIfNotList(k, v)
+            criteria.lock_states.state.extend(v)
         elif k == "layer":
             raiseIfNotList(k, v)
             criteria.layers.extend(v)