diff --git a/src/dialogs/adduseriddialog.cpp b/src/dialogs/adduseriddialog.cpp index dc1bd6322..95d887920 100644 --- a/src/dialogs/adduseriddialog.cpp +++ b/src/dialogs/adduseriddialog.cpp @@ -1,252 +1,252 @@ /* -*- mode: c++; c-basic-offset:4 -*- dialogs/adduseriddialog.cpp This file is part of Kleopatra, the KDE keymanager SPDX-FileCopyrightText: 2008 Klarälvdalens Datakonsult AB SPDX-FileCopyrightText: 2022 g10 Code GmbH SPDX-FileContributor: Ingo Klöcker SPDX-License-Identifier: GPL-2.0-or-later */ #include #include "adduseriddialog.h" #include "utils/accessibility.h" #include "view/errorlabel.h" #include "view/formtextinput.h" #include "view/htmllabel.h" #include #include #include #include #include #include #include #include #include #include #include #include #include "kleopatra_debug.h" using namespace Kleo; namespace { QString buildUserId(const QString &name, const QString &email) { if (name.isEmpty()) { return email; } else if (email.isEmpty()) { return name; } else { return QStringLiteral("%1 <%2>").arg(name, email); } } } class AddUserIDDialog::Private { friend class ::Kleo::AddUserIDDialog; AddUserIDDialog *const q; struct { std::unique_ptr> nameInput; std::unique_ptr> emailInput; HtmlLabel *resultLabel; QDialogButtonBox *buttonBox; } ui; LabelHelper labelHelper; public: explicit Private(AddUserIDDialog *qq) : q{qq} { q->setWindowTitle(i18nc("title:window", "Add User ID")); const KConfigGroup config{KSharedConfig::openConfig(), "CertificateCreationWizard"}; const auto attrOrder = config.readEntry("OpenPGPAttributeOrder", QStringList{}); const auto nameIsRequired = attrOrder.contains(QLatin1String{"NAME!"}, Qt::CaseInsensitive); const auto emailIsRequired = attrOrder.contains(QLatin1String{"EMAIL!"}, Qt::CaseInsensitive); auto mainLayout = new QVBoxLayout{q}; const auto infoText = nameIsRequired || emailIsRequired ? i18n("Enter a name and an email address to use for the user ID.") : i18n("Enter a name and/or an email address to use for the user ID."); mainLayout->addWidget(new QLabel{infoText, q}); mainLayout->addWidget(new KSeparator{Qt::Horizontal, q}); { ui.nameInput = FormTextInput::create(q); ui.nameInput->setLabelText(i18nc("@label", "Name")); ui.nameInput->setIsRequired(nameIsRequired); - ui.nameInput->setValueRequiredErrorMessage(i18n("Error: Enter a name.")); + ui.nameInput->setValueRequiredErrorMessage(i18n("Enter a name.")); const auto regexp = config.readEntry("NAME_regex"); if (regexp.isEmpty()) { ui.nameInput->setValidator(Validation::simpleName(Validation::Optional, q)); ui.nameInput->setHint(i18n("Must not include <, >, and @."), i18nc("text for screen readers", "Must not include less-than sign, greater-than sign, and at sign.")); ui.nameInput->setInvalidEntryErrorMessage( - i18n("Error: The name must not include <, >, and @."), + i18n("The name must not include <, >, and @."), i18nc("text for screen readers", - "Error: The name must not include less-than sign, greater-than sign, and at sign.")); + "The name must not include less-than sign, greater-than sign, and at sign.")); } else { ui.nameInput->setValidator(Validation::simpleName(regexp, Validation::Optional, q)); ui.nameInput->setHint(i18n("Must be in the format required by your organization and " "must not include <, >, and @."), i18nc("text for screen readers", "Must be in the format required by your organization and " "must not include less-than sign, greater-than sign, and at sign.")); ui.nameInput->setInvalidEntryErrorMessage( - i18n("Error: The name must be in the format required by your organization and " + i18n("The name must be in the format required by your organization and " "it must not include <, >, and @."), i18nc("text for screen readers", - "Error: The name must be in the format required by your organization and " + "The name must be in the format required by your organization and " "it must not include less-than sign, greater-than sign, and at sign.")); } mainLayout->addWidget(ui.nameInput->label()); mainLayout->addWidget(ui.nameInput->hintLabel()); mainLayout->addWidget(ui.nameInput->errorLabel()); mainLayout->addWidget(ui.nameInput->widget()); } connect(ui.nameInput->widget(), &QLineEdit::textChanged, q, [this]() { updateResultLabel(); }); { ui.emailInput = FormTextInput::create(q); ui.emailInput->setLabelText(i18nc("@label", "Email address")); ui.emailInput->setIsRequired(emailIsRequired); - ui.emailInput->setValueRequiredErrorMessage(i18n("Error: Enter an email address.")); + ui.emailInput->setValueRequiredErrorMessage(i18n("Enter an email address.")); const auto regexp = config.readEntry(QLatin1String("EMAIL_regex")); if (regexp.isEmpty()) { ui.emailInput->setValidator(Validation::email(Validation::Optional, q)); ui.emailInput->setInvalidEntryErrorMessage(i18n( - "Error: Enter an email address in the correct format, like name@example.com.")); + "Enter an email address in the correct format, like name@example.com.")); } else { ui.emailInput->setValidator(Validation::email(regexp, Validation::Optional, q)); ui.emailInput->setHint(i18n( "Must be in the format required by your organization")); ui.emailInput->setInvalidEntryErrorMessage(i18n( - "Error: Enter an email address in the correct format required by your organization.")); + "Enter an email address in the correct format required by your organization.")); } mainLayout->addWidget(ui.emailInput->label()); mainLayout->addWidget(ui.emailInput->hintLabel()); mainLayout->addWidget(ui.emailInput->errorLabel()); mainLayout->addWidget(ui.emailInput->widget()); } connect(ui.emailInput->widget(), &QLineEdit::textChanged, q, [this]() { updateResultLabel(); }); mainLayout->addWidget(new KSeparator{Qt::Horizontal, q}); { ui.resultLabel = new HtmlLabel{q}; ui.resultLabel->setFocusPolicy(Qt::ClickFocus); labelHelper.addLabel(ui.resultLabel); mainLayout->addWidget(ui.resultLabel); } mainLayout->addWidget(new KSeparator{Qt::Horizontal, q}); mainLayout->addStretch(1); ui.buttonBox = new QDialogButtonBox{QDialogButtonBox::Ok | QDialogButtonBox::Cancel, q}; mainLayout->addWidget(ui.buttonBox); connect(ui.buttonBox, &QDialogButtonBox::accepted, q, [this]() { checkAccept(); }); connect(ui.buttonBox, &QDialogButtonBox::rejected, q, &QDialog::reject); updateResultLabel(); } QString name() const { return ui.nameInput->widget()->text().trimmed(); } QString email() const { return ui.emailInput->widget()->text().trimmed(); } private: void checkAccept() { QStringList errors; if (ui.resultLabel->text().isEmpty() && !ui.nameInput->isRequired() && !ui.emailInput->isRequired()) { errors.push_back(i18n("Name and email address cannot both be empty.")); } if (ui.nameInput->isRequired() && !ui.nameInput->hasValue()) { errors.push_back(i18n("A name is required.")); } else if (!ui.nameInput->hasAcceptableInput()) { errors.push_back(i18n("The entered name is not valid.")); } if (ui.emailInput->isRequired() && !ui.emailInput->hasValue()) { errors.push_back(i18n("An email address is required.")); } else if (!ui.emailInput->hasAcceptableInput()) { errors.push_back(i18n("The entered email address is not valid.")); } if (errors.size() > 1) { KMessageBox::errorList(q, i18n("Sorry, the entered data is not acceptable."), errors); } else if (!errors.empty()) { KMessageBox::sorry(q, errors.first()); } else { q->accept(); } } void updateResultLabel() { ui.resultLabel->setHtml(i18nc("@info", "
This is how the new user ID will be stored in the certificate:
" "
%1
", buildUserId(name(), email()).toHtmlEscaped())); } }; AddUserIDDialog::AddUserIDDialog(QWidget *parent, Qt::WindowFlags f) : QDialog{parent, f} , d(new Private{this}) { } AddUserIDDialog::~AddUserIDDialog() = default; void AddUserIDDialog::setName(const QString &name) { d->ui.nameInput->widget()->setText(name); } QString AddUserIDDialog::name() const { return d->name(); } void AddUserIDDialog::setEmail(const QString &email) { d->ui.emailInput->widget()->setText(email); } QString AddUserIDDialog::email() const { return d->email(); } QString AddUserIDDialog::userID() const { return d->ui.resultLabel->text(); } diff --git a/src/view/formtextinput.cpp b/src/view/formtextinput.cpp index 41d1e0a9c..b3389106c 100644 --- a/src/view/formtextinput.cpp +++ b/src/view/formtextinput.cpp @@ -1,397 +1,405 @@ /* view/formtextinput.cpp This file is part of Kleopatra, the KDE keymanager SPDX-FileCopyrightText: 2022 g10 Code GmbH SPDX-FileContributor: Ingo Klöcker SPDX-License-Identifier: GPL-2.0-or-later */ #include "formtextinput.h" #include "errorlabel.h" #include "utils/accessibility.h" #include #include #include #include #include #include "kleopatra_debug.h" namespace { auto defaultValueRequiredErrorMessage() { return i18n("Error: Enter a value."); } auto defaultInvalidEntryErrorMessage() { return i18n("Error: Enter a value in the correct format."); } } namespace Kleo::_detail { class FormTextInputBase::Private { FormTextInputBase *q; public: enum Error { EntryOK, EntryMissing, // a required entry is missing InvalidEntry // the validator doesn't accept the entry }; Private(FormTextInputBase *q) : q{q} , mValueRequiredErrorMessage{defaultValueRequiredErrorMessage()} , mInvalidEntryErrorMessage{defaultInvalidEntryErrorMessage()} {} QString annotatedIfRequired(const QString &text) const; void updateLabel(); void setLabelText(const QString &text, const QString &accessibleName); void setHint(const QString &text, const QString &accessibleDescription); QString errorMessage(Error error) const; QString accessibleErrorMessage(Error error) const; void updateError(); QString accessibleDescription() const; void updateAccessibleNameAndDescription(); QPointer mLabel; QPointer mHintLabel; QPointer mWidget; QPointer mErrorLabel; QPointer mValidator; QString mLabelText; QString mAccessibleName; QString mValueRequiredErrorMessage; QString mAccessibleValueRequiredErrorMessage; QString mInvalidEntryErrorMessage; QString mAccessibleInvalidEntryErrorMessage; Error mError = EntryOK; bool mRequired = false; bool mEditingInProgress = false; }; QString FormTextInputBase::Private::annotatedIfRequired(const QString &text) const { return mRequired ? i18nc("@label label text (required)", "%1 (required)", text) : text; } void FormTextInputBase::Private::updateLabel() { if (mLabel) { mLabel->setText(annotatedIfRequired(mLabelText)); } } void FormTextInputBase::Private::setLabelText(const QString &text, const QString &accessibleName) { mLabelText = text; mAccessibleName = accessibleName.isEmpty() ? text : accessibleName; updateLabel(); updateAccessibleNameAndDescription(); } void FormTextInputBase::Private::setHint(const QString &text, const QString &accessibleDescription) { if (!mHintLabel) { return; } mHintLabel->setVisible(!text.isEmpty()); mHintLabel->setText(text); mHintLabel->setAccessibleName(accessibleDescription.isEmpty() ? text : accessibleDescription); updateAccessibleNameAndDescription(); } +namespace +{ +QString decoratedError(const QString &text) +{ + return text.isEmpty() ? QString() : i18nc("@info", "Error: %1", text); +} +} + QString FormTextInputBase::Private::errorMessage(Error error) const { switch (error) { case EntryOK: return {}; case EntryMissing: return mValueRequiredErrorMessage; case InvalidEntry: return mInvalidEntryErrorMessage; } return {}; } QString FormTextInputBase::Private::accessibleErrorMessage(Error error) const { switch (error) { case EntryOK: return {}; case EntryMissing: return mAccessibleValueRequiredErrorMessage; case InvalidEntry: return mAccessibleInvalidEntryErrorMessage; } return {}; } void FormTextInputBase::Private::updateError() { if (!mErrorLabel) { return; } if (mRequired && !q->hasValue()) { mError = EntryMissing; } else if (!q->hasAcceptableInput()) { mError = InvalidEntry; } else { mError = EntryOK; } const auto currentErrorMessage = mErrorLabel->text(); - const auto newErrorMessage = errorMessage(mError); + const auto newErrorMessage = decoratedError(errorMessage(mError)); if (newErrorMessage == currentErrorMessage) { return; } if (currentErrorMessage.isEmpty() && mEditingInProgress) { // delay showing the error message until editing is finished, so that we // do not annoy the user with an error message while they are still // entering the recipient; // on the other hand, we clear the error message immediately if it does // not apply anymore and we update the error message immediately if it // changed return; } mErrorLabel->setVisible(!newErrorMessage.isEmpty()); mErrorLabel->setText(newErrorMessage); - mErrorLabel->setAccessibleName(accessibleErrorMessage(mError)); + mErrorLabel->setAccessibleName(decoratedError(accessibleErrorMessage(mError))); updateAccessibleNameAndDescription(); } QString FormTextInputBase::Private::accessibleDescription() const { QString description; if (mHintLabel) { // get the explicitly set accessible hint text description = mHintLabel->accessibleName(); } if (description.isEmpty()) { // fall back to the default accessible description of the input widget description = getAccessibleDescription(mWidget); } return description; } void FormTextInputBase::Private::updateAccessibleNameAndDescription() { // fall back to default accessible name if accessible name wasn't set explicitly if (mAccessibleName.isEmpty()) { mAccessibleName = getAccessibleName(mWidget); } const bool errorShown = mErrorLabel && mErrorLabel->isVisible(); // Qt does not support "described-by" relations (like WCAG's "aria-describedby" relationship attribute); // emulate this by setting the hint text and, if the error is shown, the error message as accessible // description of the input field const auto description = errorShown ? accessibleDescription() + QLatin1String{" "} + mErrorLabel->accessibleName() : accessibleDescription(); if (mWidget && mWidget->accessibleDescription() != description) { mWidget->setAccessibleDescription(description); } // Qt does not support IA2's "invalid entry" state (like WCAG's "aria-invalid" state attribute); // screen readers say something like "invalid entry" if this state is set; // emulate this by adding "invalid entry" to the accessible name of the input field // and its label QString name = annotatedIfRequired(mAccessibleName); if (errorShown) { name += QLatin1String{", "} + invalidEntryText(); }; if (mLabel && mLabel->accessibleName() != name) { mLabel->setAccessibleName(name); } if (mWidget && mWidget->accessibleName() != name) { mWidget->setAccessibleName(name); } } FormTextInputBase::FormTextInputBase() : d{new Private{this}} { } FormTextInputBase::~FormTextInputBase() = default; QWidget *FormTextInputBase::widget() const { return d->mWidget; } QLabel *FormTextInputBase::label() const { return d->mLabel; } QLabel *FormTextInputBase::hintLabel() const { return d->mHintLabel; } ErrorLabel *FormTextInputBase::errorLabel() const { return d->mErrorLabel; } void FormTextInputBase::setLabelText(const QString &text, const QString &accessibleName) { d->setLabelText(text, accessibleName); } void FormTextInputBase::setHint(const QString &text, const QString &accessibleDescription) { d->setHint(text, accessibleDescription); } void FormTextInputBase::setIsRequired(bool required) { d->mRequired = required; d->updateLabel(); d->updateAccessibleNameAndDescription(); } bool FormTextInputBase::isRequired() const { return d->mRequired; } void FormTextInputBase::setValidator(const QValidator *validator) { d->mValidator = validator; } void FormTextInputBase::setValueRequiredErrorMessage(const QString &text, const QString &accessibleText) { if (text.isEmpty()) { d->mValueRequiredErrorMessage = defaultValueRequiredErrorMessage(); } else { d->mValueRequiredErrorMessage = text; } if (accessibleText.isEmpty()) { d->mAccessibleValueRequiredErrorMessage = d->mValueRequiredErrorMessage; } else { d->mAccessibleValueRequiredErrorMessage = accessibleText; } } void FormTextInputBase::setInvalidEntryErrorMessage(const QString &text, const QString &accessibleText) { if (text.isEmpty()) { d->mInvalidEntryErrorMessage = defaultInvalidEntryErrorMessage(); } else { d->mInvalidEntryErrorMessage = text; } if (accessibleText.isEmpty()) { d->mAccessibleInvalidEntryErrorMessage = d->mInvalidEntryErrorMessage; } else { d->mAccessibleInvalidEntryErrorMessage = accessibleText; } } void FormTextInputBase::setToolTip(const QString &toolTip) { if (d->mLabel) { d->mLabel->setToolTip(toolTip); } if (d->mWidget) { d->mWidget->setToolTip(toolTip); } } void FormTextInputBase::setWidget(QWidget *widget) { auto parent = widget ? widget->parentWidget() : nullptr; d->mWidget = widget; d->mLabel = new QLabel{parent}; d->mLabel->setTextFormat(Qt::PlainText); QFont font = d->mLabel->font(); font.setBold(true); d->mLabel->setFont(font); d->mLabel->setBuddy(d->mWidget); d->mHintLabel = new QLabel{parent}; d->mHintLabel->setTextFormat(Qt::PlainText); // set widget as buddy of hint label, so that the label isn't considered unrelated d->mHintLabel->setBuddy(d->mWidget); d->mHintLabel->setVisible(false); d->mErrorLabel = new ErrorLabel{parent}; d->mErrorLabel->setTextFormat(Qt::PlainText); // set widget as buddy of error label, so that the label isn't considered unrelated d->mErrorLabel->setBuddy(d->mWidget); d->mErrorLabel->setVisible(false); connectWidget(); } void FormTextInputBase::setEnabled(bool enabled) { if (d->mLabel) { d->mLabel->setEnabled(enabled); } if (d->mWidget) { d->mWidget->setEnabled(enabled); } if (d->mErrorLabel) { d->mErrorLabel->setVisible(enabled && !d->mErrorLabel->text().isEmpty()); } } bool FormTextInputBase::validate(const QString &text, int pos) const { QString textCopy = text; if (d->mValidator && d->mValidator->validate(textCopy, pos) != QValidator::Acceptable) { return false; } return true; } void FormTextInputBase::onTextChanged() { d->mEditingInProgress = true; d->updateError(); } void FormTextInputBase::onEditingFinished() { d->mEditingInProgress = false; d->updateError(); } } template<> bool Kleo::FormTextInput::hasValue() const { const auto w = widget(); return w && !w->text().trimmed().isEmpty(); } template<> bool Kleo::FormTextInput::hasAcceptableInput() const { const auto w = widget(); return w && validate(w->text(), w->cursorPosition()); } template<> void Kleo::FormTextInput::connectWidget() { const auto w = widget(); QObject::connect(w, &QLineEdit::editingFinished, w, [this]() { onEditingFinished(); }); QObject::connect(w, &QLineEdit::textChanged, w, [this]() { onTextChanged(); }); }