ui/qt/extcap_argument_file.cpp

   1 /* extcap_argument_file.cpp
   2  *
   3  * Wireshark - Network traffic analyzer
   4  * By Gerald Combs <gerald@wireshark.org>
   5  * Copyright 1998 Gerald Combs
   6  *
   7  * SPDX-License-Identifier: GPL-2.0-or-later
   8  */
   9
  10 #include <extcap_argument.h>
  11 #include <extcap_argument_file.h>
  12
  13 #include <wsutil/utf8_entities.h>
  14
  15 #include "ui/qt/widgets/wireshark_file_dialog.h"
  16
  17 #include <QObject>
  18 #include <QWidget>
  19 #include <QLabel>
  20 #include <QLineEdit>
  21 #include <QBoxLayout>
  22 #include <QPushButton>
  23 #include <QDir>
  24 #include <QFileInfo>
  25 #include <QVariant>
  26
  27 #include <epan/prefs.h>
  28 #include <ui/qt/utils/color_utils.h>
  29
  30 #include <ui/all_files_wildcard.h>
  31
  32 #include <extcap_parser.h>
  33
  34 ExtcapArgumentFileSelection::ExtcapArgumentFileSelection (extcap_arg * argument, QObject *parent) :
  35     ExtcapArgument(argument, parent), textBox(0)
  36 {
  37 }
  38
  39 ExtcapArgumentFileSelection::~ExtcapArgumentFileSelection()
  40 {
  41     if (textBox != NULL)
  42         delete textBox;
  43 }
  44
  45 QWidget * ExtcapArgumentFileSelection::createEditor(QWidget * parent)
  46 {
  47     QString text = defaultValue();
  48     QString buttonText(UTF8_HORIZONTAL_ELLIPSIS);
  49     QString buttonClearText(tr("Clear"));
  50
  51     QWidget * fileWidget = new QWidget(parent);
  52     QHBoxLayout * editLayout = new QHBoxLayout();
  53     QMargins margins = editLayout->contentsMargins();
  54     editLayout->setContentsMargins(0, 0, 0, margins.bottom());
  55     fileWidget->setContentsMargins(margins.left(), margins.right(), 0, margins.bottom());
  56     QPushButton * buttonSelect = new QPushButton(buttonText, fileWidget);
  57     QPushButton * buttonClear = new QPushButton(buttonClearText, fileWidget);
  58
  59     textBox = new QLineEdit(text, parent);
  60     textBox->setReadOnly(true);
  61
  62     /* Value is empty if no file is selected */
  63     const char *prefval = (_argument->pref_valptr && (*_argument->pref_valptr)) ? *_argument->pref_valptr : NULL;
  64     if (prefval)
  65     {
  66         QString storeValue(prefval);
  67
  68         if (storeValue.length() > 0 && storeValue.compare(text) != 0)
  69             text = storeValue.trimmed();
  70     }
  71     textBox->setText(text);
  72
  73     if (_argument->tooltip != NULL)
  74     {
  75         textBox->setToolTip(QString().fromUtf8(_argument->tooltip));
  76         buttonSelect->setToolTip(QString().fromUtf8(_argument->tooltip));
  77     }
  78
  79     connect(buttonSelect, &QPushButton::clicked, this, &ExtcapArgumentFileSelection::openFileDialog);
  80     connect(buttonClear, &QPushButton::clicked, this, &ExtcapArgumentFileSelection::clearFilename);
  81
  82     editLayout->addWidget(textBox);
  83     editLayout->addWidget(buttonSelect);
  84     editLayout->addWidget(buttonClear);
  85
  86     fileWidget->setLayout(editLayout);
  87
  88     return fileWidget;
  89 }
  90
  91 QString ExtcapArgumentFileSelection::value()
  92 {
  93     if (textBox == 0)
  94         return QString();
  95     return textBox->text();
  96 }
  97
  98 /* opens the file dialog */
  99 void ExtcapArgumentFileSelection::openFileDialog()
 100 {
 101     QString filename = textBox->text();
 102
 103     QDir workingDir = QDir::currentPath();
 104     if (QFileInfo(filename).exists())
 105         workingDir = QFileInfo(filename).dir();
 106
 107     QString fileExt(tr("All Files (" ALL_FILES_WILDCARD ")"));
 108     if (_argument->fileextension != NULL)
 109     {
 110         QString givenExt = QString().fromUtf8(_argument->fileextension);
 111         if (givenExt.length() != 0)
 112             fileExt.prepend(";;").prepend(givenExt);
 113     }
 114
 115     if (fileExists())
 116     {
 117         /* UI should check that the file exists */
 118         filename = WiresharkFileDialog::getOpenFileName((QWidget*)(textBox->parent()),
 119             tr("%1 Open File").arg(QString::fromUtf8(_argument->display)),
 120             workingDir.absolutePath(), fileExt);
 121     }
 122     else
 123     {
 124         /* File might or might not exist. Actual overwrite handling is extcap specific
 125          * (e.g. boolflag argument if user wants to always overwrite the file)
 126          */
 127         filename = WiresharkFileDialog::getSaveFileName((QWidget*)(textBox->parent()),
 128             tr("%1 Select File").arg(QString::fromUtf8(_argument->display)),
 129             workingDir.absolutePath(), fileExt, nullptr, QFileDialog::Option::DontConfirmOverwrite);
 130     }
 131
 132     if (! filename.isEmpty() && (! fileExists() || QFileInfo(filename).exists()))
 133     {
 134         textBox->setText(filename);
 135         emit valueChanged();
 136     }
 137 }
 138
 139 void ExtcapArgumentFileSelection::clearFilename()
 140 {
 141     textBox->clear();
 142     emit valueChanged();
 143 }
 144
 145 bool ExtcapArgumentFileSelection::isValid()
 146 {
 147     bool valid = false;
 148
 149     if (textBox->text().length() > 0)
 150     {
 151         if (_argument->fileexists)
 152             valid = QFileInfo(textBox->text()).exists();
 153         else
 154             valid = true;
 155     }
 156     else if (! isRequired())
 157         valid = true;
 158
 159     QString lblInvalidColor = ColorUtils::fromColorT(prefs.gui_text_invalid).name();
 160     QString txtStyle("QLineEdit { background-color: %1; } ");
 161     textBox->setStyleSheet(txtStyle.arg(valid ? QString("") : lblInvalidColor));
 162
 163     return valid;
 164 }
 165
 166 void ExtcapArgumentFileSelection::setDefaultValue()
 167 {
 168     clearFilename();
 169 }
 170