From b0a3e4276e8318475c39c2b7b4b5bc4040dcd19e Mon Sep 17 00:00:00 2001
From: Alexander Lohnau <alexander.lohnau@gmx.de>
Date: Sun, 26 Sep 2021 18:47:44 +0200
Subject: Create enum to to authorize common keys

By using an enum we have a central place to provide docs for the most
common actions/restrictions. Also consumers can pass in type-safe enum
values instead of potentially undocumented strings that might contain typos.

Also it is better documents is a value is supposed to be authorized using
KAuthorized::authorize or KAuthorized::authorizeAction, in the case of "shell_access"
this was mixed up from time to time.

Considering that we do not want the parameter for the methods to become too long
I have deliberately decided against using `enum class`. Also we don't have
and usecases for the binary operators in combination with the newly added enums.

Task: https://phabricator.kde.org/T11948
---
 src/core/kauthorized.cpp | 18 ++++++++++++++++
 src/core/kauthorized.h   | 54 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 72 insertions(+)

(limited to 'src')

diff --git a/src/core/kauthorized.cpp b/src/core/kauthorized.cpp
index 3c0941d5..0c8beef9 100644
--- a/src/core/kauthorized.cpp
+++ b/src/core/kauthorized.cpp
@@ -218,6 +218,15 @@ bool KAuthorized::authorize(const QString &genericAction)
     return cg.readEntry(genericAction, true);
 }
 
+bool KAuthorized::authorize(KAuthorized::GenericRestriction action)
+{
+    const QMetaEnum metaEnum = QMetaEnum::fromType<KAuthorized::GenericRestriction>();
+    if (metaEnum.isValid()) {
+        return KAuthorized::authorize(QString::fromLatin1(metaEnum.valueToKey(action)).toLower());
+    }
+    return false;
+}
+
 bool KAuthorized::authorizeAction(const QString &action)
 {
     MY_D if (d->blockEverything)
@@ -231,6 +240,15 @@ bool KAuthorized::authorizeAction(const QString &action)
     return authorize(QLatin1String("action/") + action);
 }
 
+bool KAuthorized::authorizeAction(KAuthorized::GenericAction action)
+{
+    const QMetaEnum metaEnum = QMetaEnum::fromType<KAuthorized::GenericAction>();
+    if (metaEnum.isValid()) {
+        return KAuthorized::authorizeAction(QString::fromLatin1(metaEnum.valueToKey(action)).toLower());
+    }
+    return false;
+}
+
 #if KCONFIGCORE_BUILD_DEPRECATED_SINCE(5, 24)
 bool KAuthorized::authorizeKAction(const QString &action)
 {
diff --git a/src/core/kauthorized.h b/src/core/kauthorized.h
index a61e0927..b7fa4c97 100644
--- a/src/core/kauthorized.h
+++ b/src/core/kauthorized.h
@@ -10,7 +10,10 @@
 
 #include <kconfigcore_export.h>
 
+#include <QMetaEnum>
+#include <QObject>
 #include <QStringList>
+#include <QVariant>
 
 class QUrl;
 class QString;
@@ -25,6 +28,39 @@ class QString;
  */
 namespace KAuthorized
 {
+Q_NAMESPACE_EXPORT(KCONFIGCORE_EXPORT);
+
+/**
+ * The enum values lower cased represent the action that is authorized
+ * For example the SHELL_ACCESS value is converted to the "shell_access" string.
+ *
+ * @since 5.88
+ */
+enum GenericRestriction {
+    SHELL_ACCESS, // if the user is authorized to open a shell or execute shell commands
+    GHNS, /// if the collaborative data sharing framework KNewStuff is authorized
+    // GUI behavior
+    LINEEDIT_REVEAL_PASSWORD, /// if typed characters in password fields can be made visible
+    LINEEDIT_TEXT_COMPLETION, /// if line edits should be allowed to display completions
+    MOVABLE_TOOLBARS, /// if toolbars of of apps should be movable
+    RUN_DESKTOP_FILES, /// if .desktop files should be run as executables when clicked
+};
+Q_ENUM_NS(GenericRestriction)
+
+/**
+ *
+ * @since 5.88
+ */
+enum GenericAction {
+    OPEN_WITH, /// if the open-with menu should be shown for files etc.
+    EDITFILETYPE, /// if mime-type accociations are allowed to be configured
+
+    OPTIONS_SHOW_TOOLBAR, /// if the toolbar should be displayed in apps
+    SWITCH_APPLICATION_LANGUAGE, /// if an action to switch the app language should be shown
+    BOOKMARKS, /// saving bookmarks is allowed
+};
+Q_ENUM_NS(GenericAction)
+
 /**
  * Returns whether the user is permitted to perform a certain action.
  *
@@ -57,6 +93,16 @@ namespace KAuthorized
  */
 KCONFIGCORE_EXPORT bool authorize(const QString &action);
 
+/**
+ * Returns whether the user is permitted to perform a common action.
+ * The enum values lower cased represent the action that is
+ * passed in to @p authorize(QString)
+ *
+ * @overload
+ * @since 5.88
+ */
+KCONFIGCORE_EXPORT bool authorize(GenericRestriction action);
+
 /**
  * Returns whether the user is permitted to perform a certain action.
  *
@@ -84,6 +130,14 @@ KCONFIGCORE_EXPORT bool authorize(const QString &action);
  */
 KCONFIGCORE_EXPORT bool authorizeAction(const QString &action);
 
+/**
+ * Overload to authorize common actions.
+ *
+ * @overload
+ * @since 5.88
+ */
+KCONFIGCORE_EXPORT bool authorizeAction(GenericAction action);
+
 #if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(5, 24)
 /**
  * Returns whether the user is permitted to perform a certain action.
-- 
cgit v1.2.1