malcontent/libmalcontent/manager.h

/* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
 *
 * Copyright © 2019 Endless Mobile, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 *
 * Authors:
 *  - Philip Withnall <withnall@endlessm.com>
 */

#pragma once

#include <gio/gio.h>
#include <glib.h>
#include <glib-object.h>

G_BEGIN_DECLS

/**
 * MctManagerGetValueFlags:
 * @MCT_MANAGER_GET_VALUE_FLAGS_NONE: No flags set.
 * @MCT_MANAGER_GET_VALUE_FLAGS_INTERACTIVE: Allow interactive polkit dialogs
 *    when requesting authorization.
 *
 * Flags to control the behaviour of getter functions like
 * mct_manager_get_app_filter() and mct_manager_get_app_filter_async().
 *
 * Since: 0.5.0
 */
typedef enum
{
  MCT_MANAGER_GET_VALUE_FLAGS_NONE = 0,
  MCT_MANAGER_GET_VALUE_FLAGS_INTERACTIVE = (1 << 0),
} MctManagerGetValueFlags;

/* FIXME: Eventually deprecate these compatibility fallbacks. */
typedef MctManagerGetValueFlags MctGetAppFilterFlags;
#define MCT_GET_APP_FILTER_FLAGS_NONE MCT_MANAGER_GET_VALUE_FLAGS_NONE
#define MCT_GET_APP_FILTER_FLAGS_INTERACTIVE MCT_MANAGER_GET_VALUE_FLAGS_INTERACTIVE

/**
 * MctManagerSetValueFlags:
 * @MCT_MANAGER_SET_VALUE_FLAGS_NONE: No flags set.
 * @MCT_MANAGER_SET_VALUE_FLAGS_INTERACTIVE: Allow interactive polkit dialogs
 *    when requesting authorization.
 *
 * Flags to control the behaviour of setter functions like
 * mct_manager_set_app_filter() and mct_manager_set_app_filter_async().
 *
 * Since: 0.5.0
 */
typedef enum
{
  MCT_MANAGER_SET_VALUE_FLAGS_NONE = 0,
  MCT_MANAGER_SET_VALUE_FLAGS_INTERACTIVE = (1 << 0),
} MctManagerSetValueFlags;

/* FIXME: Eventually deprecate these compatibility fallbacks. */
typedef MctManagerSetValueFlags MctSetAppFilterFlags;
#define MCT_SET_APP_FILTER_FLAGS_NONE MCT_MANAGER_SET_VALUE_FLAGS_NONE
#define MCT_SET_APP_FILTER_FLAGS_INTERACTIVE MCT_MANAGER_SET_VALUE_FLAGS_INTERACTIVE

/**
 * MctManagerError:
 * @MCT_MANAGER_ERROR_INVALID_USER: Given user ID doesn’t exist
 * @MCT_MANAGER_ERROR_PERMISSION_DENIED: Not authorized to query properties of
 *     the given user
 * @MCT_MANAGER_ERROR_INVALID_DATA: The data stored in a property of the given
 *     user is inconsistent or invalid
 * @MCT_MANAGER_ERROR_DISABLED: Parental controls are disabled for all users
 *
 * Errors relating to get/set operations on an #MctManager instance.
 *
 * Since: 0.5.0
 */
typedef enum
{
  MCT_MANAGER_ERROR_INVALID_USER,
  MCT_MANAGER_ERROR_PERMISSION_DENIED,
  MCT_MANAGER_ERROR_INVALID_DATA,
  MCT_MANAGER_ERROR_DISABLED,
} MctManagerError;

GQuark mct_manager_error_quark (void);
#define MCT_MANAGER_ERROR mct_manager_error_quark ()

#include <libmalcontent/app-filter.h>
#include <libmalcontent/session-limits.h>

#define MCT_TYPE_MANAGER mct_manager_get_type ()
G_DECLARE_FINAL_TYPE (MctManager, mct_manager, MCT, MANAGER, GObject)

MctManager   *mct_manager_new (GDBusConnection *connection);

MctAppFilter *mct_manager_get_app_filter        (MctManager            *self,
                                                 uid_t                  user_id,
                                                 MctManagerGetValueFlags flags,
                                                 GCancellable          *cancellable,
                                                 GError               **error);
void          mct_manager_get_app_filter_async  (MctManager            *self,
                                                 uid_t                  user_id,
                                                 MctManagerGetValueFlags flags,
                                                 GCancellable          *cancellable,
                                                 GAsyncReadyCallback    callback,
                                                 gpointer               user_data);
MctAppFilter *mct_manager_get_app_filter_finish (MctManager            *self,
                                                 GAsyncResult          *result,
                                                 GError               **error);

gboolean      mct_manager_set_app_filter        (MctManager            *self,
                                                 uid_t                  user_id,
                                                 MctAppFilter          *app_filter,
                                                 MctManagerSetValueFlags flags,
                                                 GCancellable          *cancellable,
                                                 GError               **error);
void          mct_manager_set_app_filter_async  (MctManager            *self,
                                                 uid_t                  user_id,
                                                 MctAppFilter          *app_filter,
                                                 MctManagerSetValueFlags flags,
                                                 GCancellable          *cancellable,
                                                 GAsyncReadyCallback    callback,
                                                 gpointer               user_data);
gboolean      mct_manager_set_app_filter_finish (MctManager            *self,
                                                 GAsyncResult          *result,
                                                 GError               **error);

MctSessionLimits *mct_manager_get_session_limits        (MctManager                *self,
                                                         uid_t                      user_id,
                                                         MctManagerGetValueFlags    flags,
                                                         GCancellable              *cancellable,
                                                         GError                   **error);
void              mct_manager_get_session_limits_async  (MctManager                *self,
                                                         uid_t                      user_id,
                                                         MctManagerGetValueFlags    flags,
                                                         GCancellable              *cancellable,
                                                         GAsyncReadyCallback        callback,
                                                         gpointer                   user_data);
MctSessionLimits *mct_manager_get_session_limits_finish (MctManager                *self,
                                                         GAsyncResult              *result,
                                                         GError                   **error);

gboolean      mct_manager_set_session_limits        (MctManager                *self,
                                                     uid_t                      user_id,
                                                     MctSessionLimits          *session_limits,
                                                     MctManagerSetValueFlags    flags,
                                                     GCancellable              *cancellable,
                                                     GError                   **error);
void          mct_manager_set_session_limits_async  (MctManager                *self,
                                                     uid_t                      user_id,
                                                     MctSessionLimits          *session_limits,
                                                     MctManagerSetValueFlags    flags,
                                                     GCancellable              *cancellable,
                                                     GAsyncReadyCallback        callback,
                                                     gpointer                   user_data);
gboolean      mct_manager_set_session_limits_finish (MctManager                *self,
                                                     GAsyncResult              *result,
                                                     GError                   **error);

G_END_DECLS