Add "Act as Administrator" toggle action

This commit adds an "Act as Administrator" toggle action to the
View menu if kio-admin is installed. The action allows switching
between acting as an admin with root-access or not.

This was already possible in Dolphin when kio-admin is installed by
editing the location bar directly. However this is somewhat
unintuitive and there are no warnings at all about the dangers of
acting as an administrator.

This commit adds a warning dialog when triggering the action. It is
somewhat explicit about the risks because this is in fact very
dangerous.

Furthermore, while acting on a view with administrative privileges,
a bar above the view shows up that contains a warning. The bar can
be closed to stop acting with elevated privileges.

The warning dialog can be disabled and re-enabled from the Dolphin
settings but only if the action is even available.

There is a lot more to be done to further improve this feature both
security-wise as well as when it comes to usability. But
considering that we are already encouraging users to use this
feature without any warnings at all, I feel like now is a good time
to merge this.

This work is part of a project funded through the NGI0 Entrust
Fund, a fund established by NLnet with financial support from the
European Commission's Next Generation Internet programme, under the
aegis of DG Communications Networks, Content and Technology. As
such, please contact me if you plan on doing related work so what
you are doing doesn't collide with work I am being funded to do.

1 files changed, 75 insertions, 0 deletions

diff --git a/src/admin/workerintegration.h b/src/admin/workerintegration.h
new file mode 100644
index 000000000..512303744
--- /dev/null
+++ b/src/admin/workerintegration.h
@@ -0,0 +1,75 @@
+/*
+    This file is part of the KDE project
+    SPDX-FileCopyrightText: 2022 Felix Ernst <[email protected]>
+
+    SPDX-License-Identifier: LGPL-2.1-only OR LGPL-3.0-only OR LicenseRef-KDE-Accepted-LGPL
+*/
+
+#ifndef ADMINWORKERINTEGRATION_H
+#define ADMINWORKERINTEGRATION_H
+
+#include <QObject>
+
+class DolphinMainWindow;
+class KActionCollection;
+class QAction;
+class QUrl;
+
+/**
+ * @brief This namespace contains everything that is necessary to nicely integrate "KIO Admin Worker" into Dolphin.
+ *
+ * @see https://commits.kde.org/kio-admin
+ */
+namespace Admin
+{
+/**
+ * Used with the KMessageBox API so users can disable the warning.
+ * @see KMessageBox::saveDontShowAgainContinue()
+ * @see KMessageBox::enableMessage()
+ */
+constexpr QLatin1String warningDontShowAgainName{"warnAboutRisksBeforeActingAsAdmin"};
+
+/** @returns an elaborate warning about the dangers of acting with administrative privileges. */
+QString warningMessage();
+
+/**
+ * @brief A class encapsulating the "Act as Admin"-toggle action.
+ *
+ * @see https://commits.kde.org/kio-admin
+ */
+class WorkerIntegration : public QObject
+{
+    Q_OBJECT
+
+public:
+    /**
+     * Adds a toggle action to the \a actionCollection.
+     * The action switches between acting as a normal user or acting as an administrator.
+     */
+    static void createActAsAdminAction(KActionCollection *actionCollection, DolphinMainWindow *dolphinMainWindow);
+
+    /**
+     * Triggers the m_actAsAdminAction only if it is currently checked.
+     */
+    static void exitAdminMode();
+
+private:
+    WorkerIntegration(DolphinMainWindow *parent, QAction *actAsAdminAction);
+
+    /**
+     * Toggles between acting with admin rights or not.
+     * This enables editing more files than the normal user account would be allowed to but requires re-authorization.
+     */
+    void toggleActAsAdmin();
+
+    /** Updates the toggled/checked state of the action depending on the state of the currently active view. */
+    static void updateActAsAdminAction();
+
+private:
+    /** @see createActAsAdminAction() */
+    QAction *const m_actAsAdminAction = nullptr;
+};
+
+}
+
+#endif // ADMINWORKERINTEGRATION_H