/* This file is part of the KDE libraries SPDX-FileCopyrightText: 1997 Matthias Kalle Dalheimer SPDX-FileCopyrightText: 1998, 1999 Waldo Bastian SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef KAUTHORIZED_H #define KAUTHORIZED_H #include #include #include #include #include class QUrl; class QString; /** * The functions in this namespace provide the core of the Kiosk action * restriction system; the KIO and KXMLGui frameworks build on this. * * The relevant settings are read from the application's KSharedConfig * instance, so actions can be disabled on a per-application or global * basis (by using the kdeglobals file). */ 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 = 1, // 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 = 1, /// 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. * * All settings are read from the "[KDE Action Restrictions]" group. * For example, if kdeglobals contains * @verbatim [KDE Action Restrictions][$i] shell_access=false @endverbatim * then * @code * KAuthorized::authorize("shell_access"); * @endcode * will return @c false. * * This method is intended for actions that do not necessarily have a * one-to-one correspondence with a menu or toolbar item (ie: a QAction * in a KXMLGui application). "shell_access" is an example of such a * "generic" action. * * The convention for actions like "File->New" is to prepend the action * name with "action/", for example "action/file_new". This is what * authorizeAction() does. * * @param action The name of the action. * @return @c true if the action is authorized, @c false * otherwise. * * @see authorizeAction() */ 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. * * This behaves like authorize(), except that "action/" is prepended to * @p action. So if kdeglobals contains * @verbatim [KDE Action Restrictions][$i] action/file_new=false @endverbatim * then * @code * KAuthorized::authorizeAction("file_new"); * @endcode * will return @c false. * * KXMLGui-based applications should not normally need to call this * function, as KActionCollection will do it automatically. * * @param action The name of a QAction action. * @return @c true if the QAction is authorized, @c false * otherwise. * @since 5.24 * * @see authorize() */ 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. * * This behaves like authorize(), except that "action/" is prepended to * @p action. So if kdeglobals contains * @verbatim [KDE Action Restrictions][$i] action/file_new=false @endverbatim * then * @code * KAuthorized::authorizeKAction("file_new"); * @endcode * will return @c false. * * KXMLGui-based applications should not normally need to call this * function, as KActionCollection will do it automatically. * * @param action The name of a KAction action. * @return @c true if the KAction is authorized, @c false * otherwise. * * @see authorize() * @deprecated since 5.24, use authorizeAction() instead. */ KCONFIGCORE_EXPORT KCONFIGCORE_DEPRECATED_VERSION(5, 24, "Use KAuthorized::authorizeAction(const QString&)") bool authorizeKAction(const QString &action); #endif /** * Returns whether the user is permitted to use a certain control * module. * * All settings are read from the "[KDE Control Module Restrictions]" * group. For example, if kdeglobals contains * @verbatim [KDE Control Module Restrictions][$i] desktop-settings.desktop=false @endverbatim * then * @code * KAuthorized::authorizeControlModule("desktop-settings.desktop"); * @endcode * will return @c false. * * @param menuId The desktop menu ID for the control module. * @return @c true if access to the module is authorized, * @c false otherwise. * * @see authorizeControlModules() */ KCONFIGCORE_EXPORT bool authorizeControlModule(const QString &menuId); /** * Determines which control modules from a list the user is permitted to * use. * * @param menuIds A list of desktop menu IDs for control modules. * @return The entries in @p menuIds for which * authorizeControlModule() returns @c true. * * @see authorizeControlModule() */ KCONFIGCORE_EXPORT QStringList authorizeControlModules(const QStringList &menuIds); } #endif