malcontent/libmalcontent/session-limits.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

/**
 * MctSessionLimits:
 *
 * #MctSessionLimits is an opaque, immutable structure which contains a snapshot
 * of the session limits settings for a user at a given time. This includes
 * whether session limits are being enforced, and the limit policy — for
 * example, the times of day when a user is allowed to use the computer.
 *
 * Typically, session limits settings can only be changed by the administrator,
 * and are read-only for non-administrative users. The precise policy is set
 * using polkit.
 *
 * Since: 0.5.0
 */
typedef struct _MctSessionLimits MctSessionLimits;
GType mct_session_limits_get_type (void);
#define MCT_TYPE_SESSION_LIMITS mct_session_limits_get_type ()

MctSessionLimits *mct_session_limits_ref   (MctSessionLimits *limits);
void              mct_session_limits_unref (MctSessionLimits *limits);

G_DEFINE_AUTOPTR_CLEANUP_FUNC (MctSessionLimits, mct_session_limits_unref)

uid_t    mct_session_limits_get_user_id          (MctSessionLimits *limits);
gboolean mct_session_limits_check_time_remaining (MctSessionLimits *limits,
                                                  guint64           now_usecs,
                                                  guint64          *time_remaining_secs_out,
                                                  gboolean         *time_limit_enabled_out);

/**
 * MctSessionLimitsBuilder:
 *
 * #MctSessionLimitsBuilder is a stack-allocated mutable structure used to build
 * an #MctSessionLimits instance. Use mct_session_limits_builder_init(), various
 * method calls to set properties of the session limits, and then
 * mct_session_limits_builder_end(), to construct an #MctSessionLimits.
 *
 * Since: 0.5.0
 */
typedef struct
{
  /*< private >*/
  guint u0;
  guint u1;
  guint u2;
  gpointer p0[10];
} MctSessionLimitsBuilder;

GType mct_session_limits_builder_get_type (void);

/**
 * MCT_SESSION_LIMITS_BUILDER_INIT:
 *
 * Initialise a stack-allocated #MctSessionLimitsBuilder instance at declaration
 * time.
 *
 * This is typically used with g_auto():
 * |[
 * g_auto(MctSessionLimitsBuilder) builder = MCT_SESSION_LIMITS_BUILDER_INIT ();
 * ]|
 *
 * Since: 0.5.0
 */
#define MCT_SESSION_LIMITS_BUILDER_INIT() \
  { \
    0,  /* MCT_SESSION_LIMITS_TYPE_NONE */ \
    0, \
    0, \
    /* padding: */ \
    { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } \
  }

void mct_session_limits_builder_init  (MctSessionLimitsBuilder *builder);
void mct_session_limits_builder_clear (MctSessionLimitsBuilder *builder);

G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC (MctSessionLimitsBuilder,
                                  mct_session_limits_builder_clear)

MctSessionLimitsBuilder *mct_session_limits_builder_new  (void);
MctSessionLimitsBuilder *mct_session_limits_builder_copy (MctSessionLimitsBuilder *builder);
void                     mct_session_limits_builder_free (MctSessionLimitsBuilder *builder);

G_DEFINE_AUTOPTR_CLEANUP_FUNC (MctSessionLimitsBuilder, mct_session_limits_builder_free)

MctSessionLimits *mct_session_limits_builder_end (MctSessionLimitsBuilder *builder);

void mct_session_limits_builder_set_none (MctSessionLimitsBuilder *builder);

void mct_session_limits_builder_set_daily_schedule (MctSessionLimitsBuilder *builder,
                                                    guint                    start_time_secs,
                                                    guint                    end_time_secs);

G_END_DECLS