Add new BoolQueryTab implementation.

Signed-off-by: Chris PeBenito <pebenito@ieee.org>
This commit is contained in:
Chris PeBenito 2023-11-16 14:28:27 -05:00 committed by Chris PeBenito
parent 8138dd21b1
commit 394a897410
6 changed files with 159 additions and 656 deletions

View File

@ -19,7 +19,8 @@ from . import config, widgets
# Supported analyses. These are not directly used here, but
# will init the tab registry in widgets.tab for apol's analyses.
# pylint: disable=unused-import
from .widgets import (constraintquery,
from .widgets import (boolquery,
constraintquery,
fsusequery,
genfsconquery,
ibendportconquery,

View File

@ -1,192 +0,0 @@
# Copyright 2016, Tresys Technology, LLC
#
# SPDX-License-Identifier: LGPL-2.1-only
#
#
import logging
from contextlib import suppress
from PyQt5.QtCore import Qt, QSortFilterProxyModel, QStringListModel, QThread
from PyQt5.QtGui import QPalette, QTextCursor
from PyQt5.QtWidgets import QCompleter, QHeaderView, QMessageBox, QProgressDialog
from setools import BoolQuery
from ..logtosignal import LogHandlerToSignal
from ..models import SEToolsListModel, invert_list_selection
from ..boolmodel import BooleanTableModel, boolean_detail
from .analysistab import AnalysisSection, AnalysisTab
from .exception import TabFieldError
from .queryupdater import QueryResultsUpdater
from .workspace import load_checkboxes, load_lineedits, load_textedits, \
save_checkboxes, save_lineedits, save_textedits
class BoolQueryTab(AnalysisTab):
"""Bool browser and query tab."""
section = AnalysisSection.Components
tab_title = "Booleans"
mlsonly = False
def __init__(self, parent, policy, perm_map):
super(BoolQueryTab, self).__init__(parent)
self.log = logging.getLogger(__name__)
self.policy = policy
self.query = BoolQuery(policy)
self.setupUi()
def __del__(self):
with suppress(RuntimeError):
self.thread.quit()
self.thread.wait(5000)
logging.getLogger("setools.boolquery").removeHandler(self.handler)
def setupUi(self):
self.load_ui("apol/boolquery.ui")
# populate bool list
self.bool_model = SEToolsListModel(self)
self.bool_model.item_list = sorted(r for r in self.policy.bools())
self.bools.setModel(self.bool_model)
# set up results
self.table_results_model = BooleanTableModel(self)
self.sort_proxy = QSortFilterProxyModel(self)
self.sort_proxy.setSourceModel(self.table_results_model)
self.table_results.setModel(self.sort_proxy)
self.table_results.sortByColumn(0, Qt.SortOrder.AscendingOrder)
# setup indications of errors on level/range
self.errors = set()
self.orig_palette = self.name.palette()
self.error_palette = self.name.palette()
self.error_palette.setColor(QPalette.ColorRole.Base, Qt.GlobalColor.red)
self.clear_name_error()
# set up processing thread
self.thread = QThread()
self.worker = QueryResultsUpdater(self.query, self.table_results_model)
self.worker.moveToThread(self.thread)
self.worker.raw_line.connect(self.raw_results.appendPlainText)
self.worker.finished.connect(self.update_complete)
self.worker.finished.connect(self.thread.quit)
self.thread.started.connect(self.worker.update)
# create a "busy, please wait" dialog
self.busy = QProgressDialog(self)
self.busy.setModal(True)
self.busy.setRange(0, 0)
self.busy.setMinimumDuration(0)
self.busy.canceled.connect(self.thread.requestInterruption)
self.busy.reset()
# update busy dialog from query INFO logs
self.handler = LogHandlerToSignal()
self.handler.message.connect(self.busy.setLabelText)
logging.getLogger("setools.boolquery").addHandler(self.handler)
# Ensure settings are consistent with the initial .ui state
self.notes.setHidden(not self.notes_expander.isChecked())
# connect signals
self.bools.doubleClicked.connect(self.get_detail)
self.bools.get_detail.triggered.connect(self.get_detail)
self.name.textEdited.connect(self.clear_name_error)
self.name.editingFinished.connect(self.set_name)
self.name_regex.toggled.connect(self.set_name_regex)
self.buttonBox.clicked.connect(self.run)
#
# Booleans browser
#
def get_detail(self):
# .ui is set for single item selection.
index = self.bools.selectedIndexes()[0]
item = self.bool_model.data(index, Qt.ItemDataRole.UserRole)
self.log.debug("Generating detail window for {0}".format(item))
boolean_detail(self, item)
#
# Name criteria
#
def clear_name_error(self):
self.clear_criteria_error(self.name, "Match the Boolean name.")
def set_name(self):
try:
self.query.name = self.name.text()
except Exception as ex:
self.log.error("Boolean name error: {0}".format(ex))
self.set_criteria_error(self.name, ex)
def set_name_regex(self, state):
self.log.debug("Setting name_regex {0}".format(state))
self.query.name_regex = state
self.clear_name_error()
self.set_name()
#
# Save/Load tab
#
def save(self):
"""Return a dictionary of settings."""
if self.errors:
raise TabFieldError("Field(s) are in error: {0}".
format(" ".join(o.objectName() for o in self.errors)))
settings = {}
save_checkboxes(self, settings, ["criteria_expander", "notes_expander",
"default_any", "default_true", "default_false",
"name_regex"])
save_lineedits(self, settings, ["name"])
save_textedits(self, settings, ["notes"])
return settings
def load(self, settings):
load_checkboxes(self, settings, ["criteria_expander", "notes_expander",
"default_any", "default_true", "default_false",
"name_regex"])
load_lineedits(self, settings, ["name"])
load_textedits(self, settings, ["notes"])
#
# Results runner
#
def run(self, button):
# right now there is only one button.
if self.default_any.isChecked():
self.query.default = None
else:
self.query.default = self.default_true.isChecked()
# start processing
self.busy.setLabelText("Processing query...")
self.busy.show()
self.raw_results.clear()
self.thread.start()
def update_complete(self, count):
self.log.info("{0} Boolean(s) found.".format(count))
# update sizes/location of result displays
if not self.busy.wasCanceled():
self.busy.setLabelText("Resizing the result table's columns; GUI may be unresponsive")
self.busy.repaint()
self.table_results.resizeColumnsToContents()
if not self.busy.wasCanceled():
self.busy.setLabelText("Resizing the result table's rows; GUI may be unresponsive")
self.busy.repaint()
self.table_results.resizeRowsToContents()
if not self.busy.wasCanceled():
self.busy.setLabelText("Moving the raw result to top; GUI may be unresponsive")
self.busy.repaint()
self.raw_results.moveCursor(QTextCursor.MoveOperation.Start)
self.busy.reset()

View File

@ -1,459 +0,0 @@
<?xml version="1.0" encoding="UTF-8"?>
<ui version="4.0">
<class>BoolQueryTab_ui</class>
<widget class="QScrollArea" name="BoolQueryTab_ui">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>774</width>
<height>846</height>
</rect>
</property>
<property name="sizeAdjustPolicy">
<enum>QAbstractScrollArea::AdjustToContents</enum>
</property>
<property name="widgetResizable">
<bool>true</bool>
</property>
<widget class="QWidget" name="contents">
<property name="geometry">
<rect>
<x>0</x>
<y>0</y>
<width>772</width>
<height>844</height>
</rect>
</property>
<property name="minimumSize">
<size>
<width>0</width>
<height>0</height>
</size>
</property>
<layout class="QGridLayout" name="gridLayout_3">
<item row="0" column="0">
<widget class="QLabel" name="label">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="maximumSize">
<size>
<width>16777215</width>
<height>20</height>
</size>
</property>
<property name="font">
<font>
<pointsize>11</pointsize>
<weight>75</weight>
<bold>true</bold>
</font>
</property>
<property name="text">
<string>Booleans</string>
</property>
</widget>
</item>
<item row="3" column="0" colspan="5">
<widget class="QTextEdit" name="notes">
<property name="minimumSize">
<size>
<width>0</width>
<height>80</height>
</size>
</property>
<property name="toolTip">
<string>Optionally enter notes here about the query.</string>
</property>
<property name="placeholderText">
<string>Enter notes here.</string>
</property>
</widget>
</item>
<item row="0" column="1">
<spacer name="horizontalSpacer">
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<property name="sizeHint" stdset="0">
<size>
<width>440</width>
<height>20</height>
</size>
</property>
</spacer>
</item>
<item row="0" column="2">
<widget class="QLabel" name="label_2">
<property name="text">
<string>Show:</string>
</property>
</widget>
</item>
<item row="0" column="3">
<widget class="QCheckBox" name="criteria_expander">
<property name="toolTip">
<string>Show or hide the search criteria (no settings are lost)</string>
</property>
<property name="text">
<string>Criteria</string>
</property>
<property name="checked">
<bool>true</bool>
</property>
</widget>
</item>
<item row="0" column="4">
<widget class="QCheckBox" name="notes_expander">
<property name="toolTip">
<string>Show or hide the notes field (no data is lost)</string>
</property>
<property name="text">
<string>Notes</string>
</property>
</widget>
</item>
<item row="1" column="0" rowspan="2" colspan="5">
<widget class="QSplitter" name="splitter">
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="Preferred">
<horstretch>0</horstretch>
<verstretch>1</verstretch>
</sizepolicy>
</property>
<property name="orientation">
<enum>Qt::Horizontal</enum>
</property>
<widget class="QGroupBox" name="browser_groupBox">
<property name="title">
<string>Boolean Browser</string>
</property>
<layout class="QGridLayout" name="gridLayout">
<item row="0" column="0">
<widget class="GetDetailsListView" name="bools"/>
</item>
</layout>
</widget>
<widget class="QWidget" name="verticalLayoutWidget">
<layout class="QVBoxLayout" name="verticalLayout">
<item>
<widget class="QGroupBox" name="criteria_frame">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="Preferred">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="maximumSize">
<size>
<width>16777215</width>
<height>16777215</height>
</size>
</property>
<property name="title">
<string>Search Criteria</string>
</property>
<layout class="QGridLayout" name="gridLayout_2">
<item row="0" column="0">
<widget class="QGroupBox" name="name_criteria">
<property name="maximumSize">
<size>
<width>16777215</width>
<height>120</height>
</size>
</property>
<property name="title">
<string>Boolean Name</string>
</property>
<layout class="QGridLayout" name="gridLayout_8">
<property name="leftMargin">
<number>6</number>
</property>
<property name="topMargin">
<number>6</number>
</property>
<property name="rightMargin">
<number>6</number>
</property>
<property name="bottomMargin">
<number>6</number>
</property>
<property name="spacing">
<number>3</number>
</property>
<item row="0" column="1">
<widget class="QLineEdit" name="name">
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="Fixed">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="minimumSize">
<size>
<width>150</width>
<height>20</height>
</size>
</property>
<property name="maximumSize">
<size>
<width>250</width>
<height>16777215</height>
</size>
</property>
</widget>
</item>
<item row="0" column="2">
<widget class="QCheckBox" name="name_regex">
<property name="toolTip">
<string>Use regular expressions to match the user's name.</string>
</property>
<property name="text">
<string>Regex</string>
</property>
</widget>
</item>
</layout>
</widget>
</item>
<item row="0" column="1">
<widget class="QGroupBox" name="default_criteria">
<property name="minimumSize">
<size>
<width>120</width>
<height>0</height>
</size>
</property>
<property name="title">
<string>Default State</string>
</property>
<layout class="QVBoxLayout" name="verticalLayout_4">
<item>
<widget class="QRadioButton" name="default_any">
<property name="text">
<string>Any</string>
</property>
<property name="checked">
<bool>true</bool>
</property>
</widget>
</item>
<item>
<widget class="QRadioButton" name="default_true">
<property name="text">
<string>True</string>
</property>
</widget>
</item>
<item>
<widget class="QRadioButton" name="default_false">
<property name="text">
<string>False</string>
</property>
</widget>
</item>
</layout>
</widget>
</item>
<item row="1" column="0" colspan="2">
<widget class="QDialogButtonBox" name="buttonBox">
<property name="standardButtons">
<set>QDialogButtonBox::Apply</set>
</property>
</widget>
</item>
</layout>
</widget>
</item>
<item>
<widget class="QTabWidget" name="results_frame">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>1</verstretch>
</sizepolicy>
</property>
<property name="currentIndex">
<number>0</number>
</property>
<widget class="QWidget" name="table_page">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<attribute name="title">
<string>Results</string>
</attribute>
<layout class="QVBoxLayout" name="verticalLayout_3">
<property name="leftMargin">
<number>6</number>
</property>
<property name="topMargin">
<number>6</number>
</property>
<property name="rightMargin">
<number>6</number>
</property>
<property name="bottomMargin">
<number>6</number>
</property>
<item>
<widget class="SEToolsTableView" name="table_results">
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="sizeAdjustPolicy">
<enum>QAbstractScrollArea::AdjustIgnored</enum>
</property>
<property name="alternatingRowColors">
<bool>true</bool>
</property>
<property name="sortingEnabled">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</widget>
<widget class="QWidget" name="raw_page">
<property name="sizePolicy">
<sizepolicy hsizetype="Preferred" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<attribute name="title">
<string>Raw Results</string>
</attribute>
<layout class="QVBoxLayout" name="verticalLayout_2">
<property name="leftMargin">
<number>6</number>
</property>
<property name="topMargin">
<number>6</number>
</property>
<property name="rightMargin">
<number>6</number>
</property>
<property name="bottomMargin">
<number>6</number>
</property>
<item>
<widget class="QPlainTextEdit" name="raw_results">
<property name="sizePolicy">
<sizepolicy hsizetype="Expanding" vsizetype="MinimumExpanding">
<horstretch>0</horstretch>
<verstretch>0</verstretch>
</sizepolicy>
</property>
<property name="minimumSize">
<size>
<width>0</width>
<height>0</height>
</size>
</property>
<property name="font">
<font>
<family>Monospace</family>
</font>
</property>
<property name="documentTitle">
<string/>
</property>
<property name="lineWrapMode">
<enum>QPlainTextEdit::NoWrap</enum>
</property>
<property name="readOnly">
<bool>true</bool>
</property>
</widget>
</item>
</layout>
</widget>
</widget>
</item>
</layout>
</widget>
</widget>
</item>
</layout>
<zorder>splitter</zorder>
<zorder>notes</zorder>
<zorder>label</zorder>
<zorder>label_2</zorder>
<zorder>horizontalSpacer</zorder>
<zorder>criteria_expander</zorder>
<zorder>notes_expander</zorder>
</widget>
</widget>
<customwidgets>
<customwidget>
<class>SEToolsTableView</class>
<extends>QTableView</extends>
<header>setoolsgui/tableview.h</header>
</customwidget>
<customwidget>
<class>GetDetailsListView</class>
<extends>QListView</extends>
<header>setoolsgui/getdetailslist.h</header>
</customwidget>
</customwidgets>
<tabstops>
<tabstop>criteria_expander</tabstop>
<tabstop>notes_expander</tabstop>
<tabstop>bools</tabstop>
<tabstop>name</tabstop>
<tabstop>name_regex</tabstop>
<tabstop>default_any</tabstop>
<tabstop>default_true</tabstop>
<tabstop>default_false</tabstop>
<tabstop>results_frame</tabstop>
<tabstop>table_results</tabstop>
<tabstop>raw_results</tabstop>
<tabstop>notes</tabstop>
</tabstops>
<resources/>
<connections>
<connection>
<sender>notes_expander</sender>
<signal>toggled(bool)</signal>
<receiver>notes</receiver>
<slot>setVisible(bool)</slot>
<hints>
<hint type="sourcelabel">
<x>732</x>
<y>20</y>
</hint>
<hint type="destinationlabel">
<x>386</x>
<y>754</y>
</hint>
</hints>
</connection>
<connection>
<sender>criteria_expander</sender>
<signal>toggled(bool)</signal>
<receiver>criteria_frame</receiver>
<slot>setVisible(bool)</slot>
<hints>
<hint type="sourcelabel">
<x>583</x>
<y>20</y>
</hint>
<hint type="destinationlabel">
<x>496</x>
<y>226</y>
</hint>
</hints>
</connection>
</connections>
</ui>

View File

@ -0,0 +1,81 @@
# SPDX-License-Identifier: LGPL-2.1-only
from PyQt6 import QtWidgets
import setools
from . import criteria, models, tab
__all__ = ("BoolQueryTab",)
class BoolQueryTab(tab.TableResultTabWidget):
"""A boolean query."""
section = tab.AnalysisSection.Components
tab_title = "Booleans"
mlsonly = False
def __init__(self, policy: setools.SELinuxPolicy, _, /, *,
parent: QtWidgets.QWidget | None = None) -> None:
super().__init__(setools.BoolQuery(policy), None, enable_criteria=True,
enable_browser=True, parent=parent)
self.setWhatsThis("<b>Search Booleans in a SELinux policy.</b>")
#
# Set up criteria widgets
#
name = criteria.BooleanNameCriteriaWidget("Name", self.query, "name",
enable_regex=True,
parent=self.criteria_frame)
name.setToolTip("Search for Booleans by name.")
name.setWhatsThis("<p>Search for Booleans by name.</p>")
state = criteria.BooleanState("Default State", self.query, "default",
enable_any=True,
parent=self.criteria_frame)
state.setToolTip("Search for Booleans by default state.")
state.setWhatsThis("<p>Search for Booleans by default state.</p>")
# Add widgets to layout
self.criteria_frame_layout.addWidget(name, 0, 0, 1, 1)
self.criteria_frame_layout.addWidget(state, 0, 1, 1, 1)
self.criteria_frame_layout.addWidget(self.buttonBox, 1, 0, 1, 2)
# Save widget references
self.criteria = (name, state)
# Set result table's model
self.table_results_model = models.BooleanTable(self.table_results)
#
# Set up browser
#
self.browser.setModel(models.BooleanTable(self.browser,
data=sorted(self.query.policy.bools())))
if __name__ == '__main__':
import sys
import warnings
import pprint
import logging
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s|%(levelname)s|%(name)s|%(message)s')
warnings.simplefilter("default")
app = QtWidgets.QApplication(sys.argv)
mw = QtWidgets.QMainWindow()
widget = BoolQueryTab(setools.SELinuxPolicy(), mw)
mw.setCentralWidget(widget)
mw.resize(1280, 1024)
whatsthis = QtWidgets.QWhatsThis.createAction(mw)
mw.menuBar().addAction(whatsthis) # type: ignore[union-attr]
mw.setStatusBar(QtWidgets.QStatusBar(mw))
mw.show()
rc = app.exec()
pprint.pprint(widget.save())
sys.exit(rc)

View File

@ -1,15 +1,17 @@
# SPDX-License-Identifier: LGPL-2.1-only
from PyQt6 import QtWidgets
import setools
from .. import models
from .combobox import ComboBoxWidget
from .list import ListCriteriaWidget
from .name import NameCriteriaWidget
# Regex for exact matches to types/attrs
VALIDATE_EXACT = r"[A-Za-z0-9._-]*"
__all__ = ("BooleanListCriteriaWidget", "BooleanNameCriteriaWidget",)
__all__ = ("BooleanListCriteriaWidget", "BooleanNameCriteriaWidget", "BooleanState")
class BooleanListCriteriaWidget(ListCriteriaWidget):
@ -48,12 +50,24 @@ class BooleanNameCriteriaWidget(NameCriteriaWidget):
enable_regex=enable_regex, required=required, parent=parent)
class BooleanState(ComboBoxWidget):
"""Criteria selection widget presenting possible Boolean states."""
def __init__(self, title: str, query: setools.PolicyQuery, attrname: str, /, *,
enable_any: bool = True, parent: QtWidgets.QWidget | None = None) -> None:
super().__init__(title, query, attrname, enable_any=enable_any, parent=parent)
self.criteria.addItem("False", False)
self.criteria.addItem("True", True)
if __name__ == '__main__':
import sys
import logging
import warnings
import setools
import pprint
logging.basicConfig(level=logging.DEBUG,
format='%(asctime)s|%(levelname)s|%(name)s|%(message)s')
@ -69,8 +83,10 @@ if __name__ == '__main__':
layout = QtWidgets.QHBoxLayout(window)
widget1 = BooleanListCriteriaWidget("Test Booleans list", q1, "boolean", parent=window)
widget2 = BooleanNameCriteriaWidget("Test Booleans linedit", q2, "name", parent=window)
widget3 = BooleanState("Test Booleans State", q2, "default", enable_any=True, parent=window)
layout.addWidget(widget1)
layout.addWidget(widget2)
layout.addWidget(widget3)
window.setToolTip("test tooltip")
window.setWhatsThis("test whats this")
mw.setCentralWidget(window)
@ -79,6 +95,4 @@ if __name__ == '__main__':
mw.menuBar().addAction(whatsthis) # type: ignore[union-attr]
mw.show()
rc = app.exec()
print("Query settings:")
pprint.pprint(q1.boolean)
sys.exit(rc)

View File

@ -0,0 +1,58 @@
# SPDX-License-Identifier: GPL-2.0-only
import typing
from PyQt6 import QtWidgets
from pytestqt.qtbot import QtBot
import setools
from setoolsgui.widgets.boolquery import BoolQueryTab
from .criteria.util import build_mock_policy
def test_docs(qtbot: QtBot) -> None:
"""Check that docs are provided for the widget."""
mock_policy = build_mock_policy()
widget = BoolQueryTab(mock_policy, None)
qtbot.addWidget(widget)
assert widget.whatsThis()
assert widget.table_results.whatsThis()
assert widget.raw_results.whatsThis()
for w in widget.criteria:
assert w.toolTip()
assert w.whatsThis()
results = typing.cast(QtWidgets.QTabWidget, widget.results)
for index in range(results.count()):
assert results.tabWhatsThis(index)
def test_layout(qtbot: QtBot) -> None:
"""Test the layout of the criteria frame."""
mock_policy = build_mock_policy()
widget = BoolQueryTab(mock_policy, None)
qtbot.addWidget(widget)
name, state = widget.criteria
assert widget.criteria_frame_layout.columnCount() == 2
assert widget.criteria_frame_layout.rowCount() == 2
assert widget.criteria_frame_layout.itemAtPosition(0, 0).widget() == name
assert widget.criteria_frame_layout.itemAtPosition(0, 1).widget() == state
assert widget.criteria_frame_layout.itemAtPosition(1, 0).widget() == widget.buttonBox
assert widget.criteria_frame_layout.itemAtPosition(1, 1).widget() == widget.buttonBox
def test_criteria_mapping(qtbot: QtBot) -> None:
"""Test that widgets save to the correct query fields."""
mock_policy = build_mock_policy()
widget = BoolQueryTab(mock_policy, None)
qtbot.addWidget(widget)
name, state = widget.criteria
assert isinstance(widget.query, setools.BoolQuery)
assert name.attrname == "name"
assert state.attrname == "default"