c0bb27ed29
The preference types (PREF_*) are #defined as bitmap values. However these values are mutually exclusive. For instance, if a preference type is a PREF_UINT it can't be a PREF_STRING also. In many places a switch statement is used to select the handling for the particular preference type, reinforcing the idea of distinct values, rather than being a bitmap. The only exception is PREF_OBSOLETE, which can be added to the type value. This causes several complications. Before any switch statement the PREF_OBSOLETE bit has to be removed from the type. In other places this aspect is totally overlooked, and the type value is regarded distinct, rather than a bitmap. Somehow the code skirts the issue? With this change the bitmap values are replaced with a dedicated enum, while the preference, just like the modules, gets a distinct boolean 'obsolete' field. This removes the need for bitmap manipulations before using a switch statement, and makes the direct comparison of preference type values actually work. Where required, checks for obsolete are added. This also allows the definitions for Lua preferences to be aligned with epan. Even though the Lua code comment mentioned PREF_OBSOLETE, this is not actually supported there.
438 lines
13 KiB
C++
438 lines
13 KiB
C++
/* protocol_preferences_menu.h
|
|
*
|
|
* Wireshark - Network traffic analyzer
|
|
* By Gerald Combs <gerald@wireshark.org>
|
|
* Copyright 1998 Gerald Combs
|
|
*
|
|
* SPDX-License-Identifier: GPL-2.0-or-later
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <epan/prefs.h>
|
|
#include <epan/prefs-int.h>
|
|
#include <epan/proto.h>
|
|
|
|
#include <cfile.h>
|
|
#include <ui/commandline.h>
|
|
#include <ui/preference_utils.h>
|
|
#include <wsutil/utf8_entities.h>
|
|
|
|
#include "protocol_preferences_menu.h"
|
|
|
|
#include <ui/qt/models/enabled_protocols_model.h>
|
|
#include <ui/qt/utils/qt_ui_utils.h>
|
|
#include "uat_dialog.h"
|
|
#include "main_application.h"
|
|
#include "main_window.h"
|
|
|
|
#include <QActionGroup>
|
|
#include <QMainWindow>
|
|
|
|
// To do:
|
|
// - Elide really long items?
|
|
// - Handle color prefs.
|
|
|
|
class BoolPreferenceAction : public QAction
|
|
{
|
|
public:
|
|
BoolPreferenceAction(pref_t *pref, QObject *parent=0) :
|
|
QAction(parent),
|
|
pref_(pref)
|
|
{
|
|
setText(prefs_get_title(pref_));
|
|
setCheckable(true);
|
|
setChecked(prefs_get_bool_value(pref_, pref_current));
|
|
}
|
|
|
|
unsigned int setBoolValue() {
|
|
return prefs_set_bool_value(pref_, isChecked(), pref_current);
|
|
}
|
|
|
|
pref_t *getPref() { return pref_; }
|
|
|
|
private:
|
|
pref_t *pref_;
|
|
};
|
|
|
|
class EnumPreferenceAction : public QAction
|
|
{
|
|
public:
|
|
EnumPreferenceAction(pref_t *pref, const char *title, int enumval, QActionGroup *ag, QObject *parent=0) :
|
|
QAction(parent),
|
|
pref_(pref),
|
|
enumval_(enumval)
|
|
{
|
|
setText(title);
|
|
setActionGroup(ag);
|
|
setCheckable(true);
|
|
}
|
|
|
|
unsigned int setEnumValue() {
|
|
return prefs_set_enum_value(pref_, enumval_, pref_current);
|
|
}
|
|
|
|
pref_t *getPref() { return pref_; }
|
|
|
|
private:
|
|
pref_t *pref_;
|
|
int enumval_;
|
|
};
|
|
|
|
class EnumCustomTCPOverridePreferenceAction : public QAction
|
|
{
|
|
public:
|
|
EnumCustomTCPOverridePreferenceAction(pref_t *pref, const char *title, int enumval, QActionGroup *ag, QObject *parent=0) :
|
|
QAction(parent),
|
|
pref_(pref),
|
|
enumval_(enumval)
|
|
{
|
|
setText(title);
|
|
setActionGroup(ag);
|
|
setCheckable(true);
|
|
}
|
|
|
|
unsigned int setEnumValue() {
|
|
return prefs_set_enum_value(pref_, enumval_, pref_current);
|
|
}
|
|
|
|
int getEnumValue() { return enumval_; }
|
|
|
|
pref_t *getPref() { return pref_; }
|
|
|
|
private:
|
|
pref_t *pref_;
|
|
int enumval_;
|
|
};
|
|
|
|
class UatPreferenceAction : public QAction
|
|
{
|
|
public:
|
|
UatPreferenceAction(pref_t *pref, QObject *parent=0) :
|
|
QAction(parent),
|
|
pref_(pref)
|
|
{
|
|
setText(QStringLiteral("%1%2").arg(prefs_get_title(pref_), UTF8_HORIZONTAL_ELLIPSIS));
|
|
}
|
|
|
|
void showUatDialog() {
|
|
UatDialog *uat_dlg = new UatDialog(mainApp->mainWindow(), prefs_get_uat_value(pref_));
|
|
connect(uat_dlg, &UatDialog::destroyed, mainApp, &MainApplication::flushAppSignals);
|
|
uat_dlg->setWindowModality(Qt::ApplicationModal);
|
|
uat_dlg->setAttribute(Qt::WA_DeleteOnClose);
|
|
uat_dlg->show();
|
|
}
|
|
|
|
pref_t *getPref() { return pref_; }
|
|
|
|
private:
|
|
pref_t *pref_;
|
|
};
|
|
|
|
// Preference requires an external editor (PreferenceEditorFrame)
|
|
class EditorPreferenceAction : public QAction
|
|
{
|
|
public:
|
|
EditorPreferenceAction(pref_t *pref, QObject *parent=0) :
|
|
QAction(parent),
|
|
pref_(pref)
|
|
{
|
|
QString title = prefs_get_title(pref_);
|
|
|
|
title.append(QStringLiteral(": %1%2").arg(gchar_free_to_qstring(prefs_pref_to_str(pref_, pref_current)), UTF8_HORIZONTAL_ELLIPSIS));
|
|
|
|
setText(title);
|
|
}
|
|
pref_t *pref() { return pref_; }
|
|
|
|
private:
|
|
pref_t *pref_;
|
|
};
|
|
|
|
extern "C" {
|
|
// Preference callback
|
|
|
|
static unsigned
|
|
add_prefs_menu_item(pref_t *pref, void *menu_ptr)
|
|
{
|
|
ProtocolPreferencesMenu *pp_menu = static_cast<ProtocolPreferencesMenu *>(menu_ptr);
|
|
if (!pp_menu) return 1;
|
|
|
|
pp_menu->addMenuItem(pref);
|
|
|
|
return 0;
|
|
}
|
|
}
|
|
|
|
|
|
ProtocolPreferencesMenu::ProtocolPreferencesMenu(QWidget *parent) :
|
|
QMenu(parent)
|
|
{
|
|
setTitle(tr("Protocol Preferences"));
|
|
setModule(NULL);
|
|
}
|
|
|
|
ProtocolPreferencesMenu::ProtocolPreferencesMenu(const QString &title, const QString &module_name, QWidget *parent) :
|
|
QMenu(title, parent)
|
|
{
|
|
setModule(module_name);
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::setModule(const QString module_name)
|
|
{
|
|
QAction *action;
|
|
int proto_id = -1;
|
|
|
|
if (!module_name.isEmpty()) {
|
|
proto_id = proto_get_id_by_filter_name(module_name.toUtf8().constData());
|
|
}
|
|
|
|
clear();
|
|
module_name_.clear();
|
|
module_ = NULL;
|
|
|
|
protocol_ = find_protocol_by_id(proto_id);
|
|
const QString long_name = proto_get_protocol_long_name(protocol_);
|
|
const QString short_name = proto_get_protocol_short_name(protocol_);
|
|
if (module_name.isEmpty() || proto_id < 0 || !protocol_) {
|
|
action = addAction(tr("No protocol preferences available"));
|
|
action->setDisabled(true);
|
|
return;
|
|
}
|
|
|
|
QAction *disable_action = new QAction(tr("Disable %1").arg(short_name), this);
|
|
connect(disable_action, &QAction::triggered, this, &ProtocolPreferencesMenu::disableProtocolTriggered);
|
|
disable_action->setDisabled(!proto_can_toggle_protocol(proto_id));
|
|
|
|
module_ = prefs_find_module(module_name.toUtf8().constData());
|
|
if (!module_ || !prefs_is_registered_protocol(module_name.toUtf8().constData())) {
|
|
action = addAction(tr("%1 has no preferences").arg(long_name));
|
|
action->setDisabled(true);
|
|
addSeparator();
|
|
addAction(disable_action);
|
|
return;
|
|
}
|
|
|
|
module_name_ = module_name;
|
|
|
|
action = addAction(tr("Open %1 preferences…").arg(long_name));
|
|
if (module_->use_gui) {
|
|
action->setData(QString(module_name));
|
|
connect(action, &QAction::triggered, this, &ProtocolPreferencesMenu::modulePreferencesTriggered);
|
|
} else {
|
|
action->setDisabled(true);
|
|
}
|
|
addSeparator();
|
|
|
|
prefs_pref_foreach(module_, add_prefs_menu_item, this);
|
|
|
|
if (!actions().constLast()->isSeparator()) {
|
|
addSeparator();
|
|
}
|
|
addAction(disable_action);
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::addMenuItem(preference *pref)
|
|
{
|
|
if (prefs_is_preference_obsolete(pref))
|
|
return;
|
|
|
|
switch (prefs_get_type(pref)) {
|
|
case PREF_BOOL:
|
|
{
|
|
BoolPreferenceAction *bpa = new BoolPreferenceAction(pref, this);
|
|
addAction(bpa);
|
|
connect(bpa, &BoolPreferenceAction::triggered, this, &ProtocolPreferencesMenu::boolPreferenceTriggered);
|
|
break;
|
|
}
|
|
case PREF_ENUM:
|
|
{
|
|
QMenu *enum_menu = addMenu(prefs_get_title(pref));
|
|
const enum_val_t *enum_valp = prefs_get_enumvals(pref);
|
|
if (enum_valp && enum_valp->name) {
|
|
QActionGroup *ag = new QActionGroup(this);
|
|
while (enum_valp->name) {
|
|
EnumPreferenceAction *epa = new EnumPreferenceAction(pref, enum_valp->description, enum_valp->value, ag, this);
|
|
if (prefs_get_enum_value(pref, pref_current) == enum_valp->value) {
|
|
epa->setChecked(true);
|
|
}
|
|
enum_menu->addAction(epa);
|
|
connect(epa, &EnumPreferenceAction::triggered, this, &ProtocolPreferencesMenu::enumPreferenceTriggered);
|
|
enum_valp++;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
case PREF_UINT:
|
|
case PREF_STRING:
|
|
case PREF_SAVE_FILENAME:
|
|
case PREF_OPEN_FILENAME:
|
|
case PREF_DIRNAME:
|
|
case PREF_RANGE:
|
|
case PREF_DECODE_AS_RANGE:
|
|
case PREF_PASSWORD:
|
|
case PREF_DISSECTOR:
|
|
{
|
|
EditorPreferenceAction *epa = new EditorPreferenceAction(pref, this);
|
|
addAction(epa);
|
|
connect(epa, &EditorPreferenceAction::triggered, this, &ProtocolPreferencesMenu::editorPreferenceTriggered);
|
|
break;
|
|
}
|
|
case PREF_UAT:
|
|
{
|
|
UatPreferenceAction *upa = new UatPreferenceAction(pref, this);
|
|
addAction(upa);
|
|
connect(upa, &UatPreferenceAction::triggered, this, &ProtocolPreferencesMenu::uatPreferenceTriggered);
|
|
break;
|
|
}
|
|
case PREF_CUSTOM:
|
|
case PREF_STATIC_TEXT:
|
|
break;
|
|
case PREF_PROTO_TCP_SNDAMB_ENUM:
|
|
{
|
|
int override_id = -1;
|
|
|
|
/* ensure we have access to MainWindow, and indirectly to the selection */
|
|
if (mainApp) {
|
|
MainWindow * mainWin = mainApp->mainWindow();
|
|
|
|
if (mainWin != nullptr && !mainWin->selectedRows().isEmpty()) {
|
|
frame_data * fdata = mainWin->frameDataForRow(mainWin->selectedRows().at(0));
|
|
if(fdata) {
|
|
override_id = fdata->tcp_snd_manual_analysis;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (override_id != -1) {
|
|
QMenu *enum_menu = addMenu(prefs_get_title(pref));
|
|
const enum_val_t *enum_valp = prefs_get_enumvals(pref);
|
|
if (enum_valp && enum_valp->name) {
|
|
QActionGroup *ag = new QActionGroup(this);
|
|
while (enum_valp->name) {
|
|
EnumCustomTCPOverridePreferenceAction *epa = new EnumCustomTCPOverridePreferenceAction(pref, enum_valp->description, enum_valp->value, ag, this);
|
|
if (override_id>=0) {
|
|
if(override_id==enum_valp->value)
|
|
epa->setChecked(true);
|
|
}
|
|
else {
|
|
if(enum_valp->value == 0)
|
|
epa->setChecked(true);
|
|
}
|
|
|
|
enum_menu->addAction(epa);
|
|
connect(epa, &EnumCustomTCPOverridePreferenceAction::triggered, this, &ProtocolPreferencesMenu::enumCustomTCPOverridePreferenceTriggered);
|
|
enum_valp++;
|
|
}
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
default:
|
|
// A type we currently don't handle. Just open the prefs dialog.
|
|
QString title = QStringLiteral("%1%2").arg(prefs_get_title(pref), UTF8_HORIZONTAL_ELLIPSIS);
|
|
QAction *mpa = addAction(title);
|
|
connect(mpa, &QAction::triggered, this, &ProtocolPreferencesMenu::modulePreferencesTriggered);
|
|
break;
|
|
}
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::disableProtocolTriggered()
|
|
{
|
|
EnabledProtocolsModel::disableProtocol(protocol_);
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::modulePreferencesTriggered()
|
|
{
|
|
if (!module_name_.isEmpty()) {
|
|
emit showProtocolPreferences(module_name_);
|
|
}
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::editorPreferenceTriggered()
|
|
{
|
|
EditorPreferenceAction *epa = static_cast<EditorPreferenceAction *>(QObject::sender());
|
|
if (!epa) return;
|
|
|
|
if (epa->pref() && module_) {
|
|
emit editProtocolPreference(epa->pref(), module_);
|
|
}
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::boolPreferenceTriggered()
|
|
{
|
|
BoolPreferenceAction *bpa = static_cast<BoolPreferenceAction *>(QObject::sender());
|
|
if (!bpa) return;
|
|
|
|
module_->prefs_changed_flags |= bpa->setBoolValue();
|
|
unsigned int changed_flags = module_->prefs_changed_flags;
|
|
|
|
prefs_apply(module_);
|
|
prefs_main_write();
|
|
commandline_options_drop(module_->name, prefs_get_name(bpa->getPref()));
|
|
|
|
if (changed_flags & PREF_EFFECT_FIELDS) {
|
|
mainApp->emitAppSignal(MainApplication::FieldsChanged);
|
|
}
|
|
/* Protocol preference changes almost always affect dissection,
|
|
so don't bother checking flags */
|
|
mainApp->emitAppSignal(MainApplication::PacketDissectionChanged);
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::enumPreferenceTriggered()
|
|
{
|
|
EnumPreferenceAction *epa = static_cast<EnumPreferenceAction *>(QObject::sender());
|
|
if (!epa) return;
|
|
|
|
unsigned int changed_flags = epa->setEnumValue();
|
|
if (changed_flags) { // Changed
|
|
module_->prefs_changed_flags |= changed_flags;
|
|
prefs_apply(module_);
|
|
prefs_main_write();
|
|
commandline_options_drop(module_->name, prefs_get_name(epa->getPref()));
|
|
|
|
if (changed_flags & PREF_EFFECT_FIELDS) {
|
|
mainApp->emitAppSignal(MainApplication::FieldsChanged);
|
|
}
|
|
/* Protocol preference changes almost always affect dissection,
|
|
so don't bother checking flags */
|
|
mainApp->emitAppSignal(MainApplication::PacketDissectionChanged);
|
|
}
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::enumCustomTCPOverridePreferenceTriggered()
|
|
{
|
|
EnumCustomTCPOverridePreferenceAction *epa = static_cast<EnumCustomTCPOverridePreferenceAction *>(QObject::sender());
|
|
if (!epa) return;
|
|
|
|
/* ensure we have access to MainWindow, and indirectly to the selection */
|
|
if (mainApp) {
|
|
MainWindow * mainWin = mainApp->mainWindow();
|
|
if (mainWin != nullptr && !mainWin->selectedRows().isEmpty()) {
|
|
frame_data * fdata = mainWin->frameDataForRow(mainWin->selectedRows().at(0));
|
|
if(!fdata)
|
|
return;
|
|
|
|
if (fdata->tcp_snd_manual_analysis != epa->getEnumValue()) { // Changed
|
|
fdata->tcp_snd_manual_analysis = epa->getEnumValue();
|
|
|
|
unsigned int changed_flags = prefs_get_effect_flags(epa->getPref());
|
|
if (changed_flags & PREF_EFFECT_FIELDS) {
|
|
mainApp->emitAppSignal(MainApplication::FieldsChanged);
|
|
}
|
|
/* Protocol preference changes almost always affect dissection,
|
|
so don't bother checking flags */
|
|
mainApp->emitAppSignal(MainApplication::PacketDissectionChanged);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
void ProtocolPreferencesMenu::uatPreferenceTriggered()
|
|
{
|
|
UatPreferenceAction *upa = static_cast<UatPreferenceAction *>(QObject::sender());
|
|
if (!upa) return;
|
|
|
|
upa->showUatDialog();
|
|
}
|