src/session.h

   1 /*
   2  * Copyright (C) 2010-2011 Robert Ancell.
   3  * Author: Robert Ancell <robert.ancell@canonical.com>
   4  *
   5  * This program is free software: you can redistribute it and/or modify it under
   6  * the terms of the GNU General Public License as published by the Free Software
   7  * Foundation, either version 3 of the License, or (at your option) any later
   8  * version. See http://www.gnu.org/copyleft/gpl.html the full text of the
   9  * license.
  10  */
  11
  12 #ifndef SESSION_H_
  13 #define SESSION_H_
  14
  15 #include <glib-object.h>
  16
  17 #include <security/pam_appl.h>
  18
  19 typedef struct Session Session;
  20
  21 #include "display-server.h"
  22 #include "accounts.h"
  23 #include "x-authority.h"
  24 #include "logger.h"
  25
  26 G_BEGIN_DECLS
  27
  28 #define SESSION_TYPE           (session_get_type())
  29 #define SESSION(obj)           (G_TYPE_CHECK_INSTANCE_CAST ((obj), SESSION_TYPE, Session))
  30 #define SESSION_CLASS(klass)   (G_TYPE_CHECK_CLASS_CAST ((klass), SESSION_TYPE, SessionClass))
  31 #define SESSION_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), SESSION_TYPE, SessionClass))
  32
  33 typedef struct SessionPrivate SessionPrivate;
  34
  35 struct Session
  36 {
  37     GObject         parent_instance;
  38     SessionPrivate *priv;
  39 };
  40
  41 typedef struct
  42 {
  43     GObjectClass parent_class;
  44
  45     gboolean (*start)(Session *session);
  46     void (*run)(Session *session);
  47     void (*stop)(Session *session);
  48
  49     void (*got_messages)(Session *session);
  50     void (*authentication_complete)(Session *session);
  51     void (*stopped)(Session *session);
  52 } SessionClass;
  53
  54 typedef enum
  55 {
  56     SESSION_TYPE_LOCAL,
  57     SESSION_TYPE_REMOTE
  58 } SessionType;
  59
  60 GType session_get_type (void);
  61
  62 Session *session_new (void);
  63
  64 void session_set_session_type (Session *session, const gchar *session_type);
  65
  66 const gchar *session_get_session_type (Session *session);
  67
  68 void session_set_pam_service (Session *session, const gchar *pam_service);
  69
  70 void session_set_username (Session *session, const gchar *username);
  71
  72 void session_set_do_authenticate (Session *session, gboolean do_authenticate);
  73
  74 void session_set_is_interactive (Session *session, gboolean is_interactive);
  75
  76 void session_set_is_guest (Session *session, gboolean is_guest);
  77
  78 gboolean session_get_is_guest (Session *session);
  79
  80 void session_set_log_file (Session *session, const gchar *filename);
  81
  82 void session_set_display_server (Session *session, DisplayServer *display_server);
  83
  84 DisplayServer *session_get_display_server (Session *session);
  85
  86 void session_set_tty (Session *session, const gchar *tty);
  87
  88 void session_set_xdisplay (Session *session, const gchar *xdisplay);
  89
  90 void session_set_x_authority (Session *session, XAuthority *authority, gboolean use_system_location);
  91
  92 void session_set_remote_host_name (Session *session, const gchar *remote_host_name);
  93
  94 void session_set_env (Session *session, const gchar *name, const gchar *value);
  95
  96 const gchar *session_get_env (Session *session, const gchar *name);
  97
  98 void session_unset_env (Session *session, const gchar *name);
  99
 100 void session_set_argv (Session *session, gchar **argv);
 101
 102 // FIXME: Remove
 103 User *session_get_user (Session *session);
 104
 105 gboolean session_start (Session *session);
 106
 107 gboolean session_get_is_started (Session *session);
 108
 109 const gchar *session_get_username (Session *session);
 110
 111 const gchar *session_get_console_kit_cookie (Session *session);
 112
 113 void session_respond (Session *session, struct pam_response *response);
 114
 115 void session_respond_error (Session *session, int error);
 116
 117 int session_get_messages_length (Session *session);
 118
 119 const struct pam_message *session_get_messages (Session *session);
 120
 121 gboolean session_get_is_authenticated (Session *session);
 122
 123 int session_get_authentication_result (Session *session);
 124
 125 const gchar *session_get_authentication_result_string (Session *session);
 126
 127 void session_run (Session *session);
 128
 129 void session_lock (Session *session);
 130
 131 void session_unlock (Session *session);
 132
 133 void session_activate (Session *session);
 134
 135 void session_stop (Session *session);
 136
 137 gboolean session_get_is_stopping (Session *session);
 138
 139 G_END_DECLS
 140
 141 #endif /* SESSION_H_ */