1 /*
2 * Copyright (C) 2010 Robert Ancell.
3 * Author: Robert Ancell <robert.ancell@canonical.com>
4 *
5 * This library is free software; you can redistribute it and/or modify it under
6 * the terms of the GNU Lesser General Public License as published by the Free
7 * Software Foundation; either version 2 or version 3 of the License.
8 * See http://www.gnu.org/copyleft/lgpl.html the full text of the license.
9 */
10
11 #ifndef LIGHTDM_GREETER_H_
12 #define LIGHTDM_GREETER_H_
13
14 #include <glib-object.h>
15 #include <gio/gio.h>
16
17 G_BEGIN_DECLS
18
19 #define LIGHTDM_TYPE_GREETER (lightdm_greeter_get_type())
20 #define LIGHTDM_GREETER(obj) (G_TYPE_CHECK_INSTANCE_CAST ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeter))
21 #define LIGHTDM_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST ((klass), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
22 #define LIGHTDM_IS_GREETER(obj) (G_TYPE_CHECK_INSTANCE_TYPE ((obj), LIGHTDM_TYPE_GREETER))
23 #define LIGHTDM_IS_GREETER_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), LIGHTDM_TYPE_GREETER))
24 #define LIGHTDM_GREETER_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS ((obj), LIGHTDM_TYPE_GREETER, LightDMGreeterClass))
25
26 typedef struct _LightDMGreeter LightDMGreeter;
27 typedef struct _LightDMGreeterClass LightDMGreeterClass;
28
29 #define LIGHTDM_GREETER_ERROR lightdm_greeter_error_quark ()
30
31 #define LIGHTDM_GREETER_SIGNAL_SHOW_PROMPT "show-prompt"
32 #define LIGHTDM_GREETER_SIGNAL_SHOW_MESSAGE "show-message"
33 #define LIGHTDM_GREETER_SIGNAL_AUTHENTICATION_COMPLETE "authentication-complete"
34 #define LIGHTDM_GREETER_SIGNAL_AUTOLOGIN_TIMER_EXPIRED "autologin-timer-expired"
35 #define LIGHTDM_GREETER_SIGNAL_IDLE "idle"
36 #define LIGHTDM_GREETER_SIGNAL_RESET "reset"
37
38 /**
39 * LightDMPromptType:
40 * @LIGHTDM_PROMPT_TYPE_QUESTION: prompt is a question. The information can be shown as it is entered.
41 * @LIGHTDM_PROMPT_TYPE_SECRET: prompt is for secret information. The entered information should be obscured so it can't be publically visible.
42 *
43 * Prompt types the client is required to display.
44 */
45 typedef enum
46 {
47 LIGHTDM_PROMPT_TYPE_QUESTION,
48 LIGHTDM_PROMPT_TYPE_SECRET
49 } LightDMPromptType;
50
51 GType lightdm_prompt_type_get_type (void);
52
53 /**
54 * LightDMMessageType:
55 * @LIGHTDM_MESSAGE_TYPE_INFO: Informational message.
56 * @LIGHTDM_MESSAGE_TYPE_ERROR: Error message.
57 */
58 typedef enum
59 {
60 LIGHTDM_MESSAGE_TYPE_INFO,
61 LIGHTDM_MESSAGE_TYPE_ERROR
62 } LightDMMessageType;
63
64 GType lightdm_message_type_get_type (void);
65
66 struct _LightDMGreeter
67 {
68 GObject parent_instance;
69 };
70
71 struct _LightDMGreeterClass
72 {
73 /*< private >*/
74 GObjectClass parent_class;
75
76 void (*show_message)(LightDMGreeter *greeter, const gchar *text, LightDMMessageType type);
77 void (*show_prompt)(LightDMGreeter *greeter, const gchar *text, LightDMPromptType type);
78 void (*authentication_complete)(LightDMGreeter *greeter);
79 void (*autologin_timer_expired)(LightDMGreeter *greeter);
80 void (*idle)(LightDMGreeter *greeter);
81 void (*reset)(LightDMGreeter *greeter);
82
83 /* Reserved */
84 void (*reserved1) (void);
85 void (*reserved2) (void);
86 void (*reserved3) (void);
87 void (*reserved4) (void);
88 };
89
90 #ifdef GLIB_VERSION_2_44
91 typedef LightDMGreeter *LightDMGreeter_autoptr;
glib_autoptr_cleanup_LightDMGreeter(LightDMGreeter ** _ptr)92 static inline void glib_autoptr_cleanup_LightDMGreeter (LightDMGreeter **_ptr)
93 {
94 glib_autoptr_cleanup_GObject ((GObject **) _ptr);
95 }
96 #endif
97
98 /**
99 * LightDMGreeterError:
100 * @LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR: error communicating with daemon.
101 * @LIGHTDM_GREETER_ERROR_CONNECTION_FAILED: failed to connect to the daemon.
102 * @LIGHTDM_GREETER_ERROR_SESSION_FAILED: requested session failed to start.
103 * @LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN: autologin not configured.
104 * @LIGHTDM_GREETER_ERROR_INVALID_USER: autologin not configured.
105 *
106 * Error codes returned by greeter operations.
107 */
108 typedef enum
109 {
110 LIGHTDM_GREETER_ERROR_COMMUNICATION_ERROR,
111 LIGHTDM_GREETER_ERROR_CONNECTION_FAILED,
112 LIGHTDM_GREETER_ERROR_SESSION_FAILED,
113 LIGHTDM_GREETER_ERROR_NO_AUTOLOGIN,
114 LIGHTDM_GREETER_ERROR_INVALID_USER
115 } LightDMGreeterError;
116
117 GQuark lightdm_greeter_error_quark (void);
118
119 GType lightdm_greeter_error_get_type (void);
120
121 GType lightdm_greeter_get_type (void);
122
123 LightDMGreeter *lightdm_greeter_new (void);
124
125 void lightdm_greeter_set_resettable (LightDMGreeter *greeter, gboolean resettable);
126
127 void lightdm_greeter_connect_to_daemon (LightDMGreeter *greeter, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
128
129 gboolean lightdm_greeter_connect_to_daemon_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
130
131 gboolean lightdm_greeter_connect_to_daemon_sync (LightDMGreeter *greeter, GError **error);
132
133 const gchar *lightdm_greeter_get_hint (LightDMGreeter *greeter, const gchar *name);
134
135 const gchar *lightdm_greeter_get_default_session_hint (LightDMGreeter *greeter);
136
137 gboolean lightdm_greeter_get_hide_users_hint (LightDMGreeter *greeter);
138
139 gboolean lightdm_greeter_get_show_manual_login_hint (LightDMGreeter *greeter);
140
141 gboolean lightdm_greeter_get_show_remote_login_hint (LightDMGreeter *greeter);
142
143 gboolean lightdm_greeter_get_lock_hint (LightDMGreeter *greeter);
144
145 gboolean lightdm_greeter_get_has_guest_account_hint (LightDMGreeter *greeter);
146
147 const gchar *lightdm_greeter_get_select_user_hint (LightDMGreeter *greeter);
148
149 gboolean lightdm_greeter_get_select_guest_hint (LightDMGreeter *greeter);
150
151 const gchar *lightdm_greeter_get_autologin_user_hint (LightDMGreeter *greeter);
152
153 const gchar *lightdm_greeter_get_autologin_session_hint (LightDMGreeter *greeter);
154
155 gboolean lightdm_greeter_get_autologin_guest_hint (LightDMGreeter *greeter);
156
157 gint lightdm_greeter_get_autologin_timeout_hint (LightDMGreeter *greeter);
158
159 void lightdm_greeter_cancel_autologin (LightDMGreeter *greeter);
160
161 gboolean lightdm_greeter_authenticate (LightDMGreeter *greeter, const gchar *username, GError **error);
162
163 gboolean lightdm_greeter_authenticate_as_guest (LightDMGreeter *greeter, GError **error);
164
165 gboolean lightdm_greeter_authenticate_autologin (LightDMGreeter *greeter, GError **error);
166
167 gboolean lightdm_greeter_authenticate_remote (LightDMGreeter *greeter, const gchar *session, const gchar *username, GError **error);
168
169 gboolean lightdm_greeter_respond (LightDMGreeter *greeter, const gchar *response, GError **error);
170
171 gboolean lightdm_greeter_cancel_authentication (LightDMGreeter *greeter, GError **error);
172
173 gboolean lightdm_greeter_get_in_authentication (LightDMGreeter *greeter);
174
175 gboolean lightdm_greeter_get_is_authenticated (LightDMGreeter *greeter);
176
177 const gchar *lightdm_greeter_get_authentication_user (LightDMGreeter *greeter);
178
179 gboolean lightdm_greeter_set_language (LightDMGreeter *greeter, const gchar *language, GError **error);
180
181 void lightdm_greeter_start_session (LightDMGreeter *greeter, const gchar *session, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
182
183 gboolean lightdm_greeter_start_session_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
184
185 gboolean lightdm_greeter_start_session_sync (LightDMGreeter *greeter, const gchar *session, GError **error);
186
187 void lightdm_greeter_ensure_shared_data_dir (LightDMGreeter *greeter, const gchar *username, GCancellable *cancellable, GAsyncReadyCallback callback, gpointer user_data);
188
189 gchar *lightdm_greeter_ensure_shared_data_dir_finish (LightDMGreeter *greeter, GAsyncResult *result, GError **error);
190
191 gchar *lightdm_greeter_ensure_shared_data_dir_sync (LightDMGreeter *greeter, const gchar *username, GError **error);
192
193 #ifndef LIGHTDM_DISABLE_DEPRECATED
194 gboolean lightdm_greeter_connect_sync (LightDMGreeter *greeter, GError **error);
195 #endif
196
197 G_END_DECLS
198
199 #endif /* LIGHTDM_GREETER_H_ */
200