1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
27 #include "gmountoperation.h"
28 #include "gioenumtypes.h"
29 #include "gio-marshal.h"
35 * SECTION:gmountoperation
36 * @short_description: Authentication methods for mountable locations
39 * #GMountOperation provides a mechanism for authenticating mountable
40 * operations, such as loop mounting files, hard drive partitions or
43 * Mounting operations are handed a #GMountOperation that then can use
44 * if they require any privileges or authentication for their volumes
45 * to be mounted (e.g. a hard disk partition or an encrypted filesystem),
46 * or if they are implementing a remote server protocol which requires
47 * user credentials such as FTP or WebDAV.
49 * Users should instantiate a subclass of this that implements all
50 * the various callbacks to show the required dialogs, such as
54 G_DEFINE_TYPE (GMountOperation, g_mount_operation, G_TYPE_OBJECT);
63 static guint signals[LAST_SIGNAL] = { 0 };
65 struct _GMountOperationPrivate {
70 GPasswordSave password_save;
85 g_mount_operation_set_property (GObject *object,
90 GMountOperation *operation;
92 operation = G_MOUNT_OPERATION (object);
97 g_mount_operation_set_username (operation,
98 g_value_get_string (value));
102 g_mount_operation_set_password (operation,
103 g_value_get_string (value));
107 g_mount_operation_set_anonymous (operation,
108 g_value_get_boolean (value));
112 g_mount_operation_set_domain (operation,
113 g_value_get_string (value));
116 case PROP_PASSWORD_SAVE:
117 g_mount_operation_set_password_save (operation,
118 g_value_get_enum (value));
122 g_mount_operation_set_choice (operation,
123 g_value_get_int (value));
127 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
134 g_mount_operation_get_property (GObject *object,
139 GMountOperation *operation;
140 GMountOperationPrivate *priv;
142 operation = G_MOUNT_OPERATION (object);
143 priv = operation->priv;
148 g_value_set_string (value, priv->user);
152 g_value_set_string (value, priv->password);
156 g_value_set_boolean (value, priv->anonymous);
160 g_value_set_string (value, priv->domain);
163 case PROP_PASSWORD_SAVE:
164 g_value_set_enum (value, priv->password_save);
168 g_value_set_int (value, priv->choice);
172 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
179 g_mount_operation_finalize (GObject *object)
181 GMountOperation *operation;
182 GMountOperationPrivate *priv;
184 operation = G_MOUNT_OPERATION (object);
186 priv = operation->priv;
188 g_free (priv->password);
190 g_free (priv->domain);
192 G_OBJECT_CLASS (g_mount_operation_parent_class)->finalize (object);
196 reply_non_handled_in_idle (gpointer data)
198 GMountOperation *op = data;
200 g_mount_operation_reply (op, G_MOUNT_OPERATION_UNHANDLED);
205 ask_password (GMountOperation *op,
207 const char *default_user,
208 const char *default_domain,
209 GAskPasswordFlags flags)
211 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
212 reply_non_handled_in_idle,
218 ask_question (GMountOperation *op,
220 const char *choices[])
222 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
223 reply_non_handled_in_idle,
229 g_mount_operation_class_init (GMountOperationClass *klass)
231 GObjectClass *object_class;
233 g_type_class_add_private (klass, sizeof (GMountOperationPrivate));
235 object_class = G_OBJECT_CLASS (klass);
236 object_class->finalize = g_mount_operation_finalize;
237 object_class->get_property = g_mount_operation_get_property;
238 object_class->set_property = g_mount_operation_set_property;
240 klass->ask_password = ask_password;
241 klass->ask_question = ask_question;
244 * GMountOperation::ask-password:
245 * @op: a #GMountOperation requesting a password.
246 * @message: string containing a message to display to the user.
247 * @default_user: string containing the default user name.
248 * @default_domain: string containing the default domain.
249 * @flags: a set of #GAskPasswordFlags.
251 * Emitted when a mount operation asks the user for a password.
253 signals[ASK_PASSWORD] =
254 g_signal_new (I_("ask_password"),
255 G_TYPE_FROM_CLASS (object_class),
257 G_STRUCT_OFFSET (GMountOperationClass, ask_password),
259 _gio_marshal_VOID__STRING_STRING_STRING_FLAGS,
261 G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_ASK_PASSWORD_FLAGS);
264 * GMountOperation::ask-question:
265 * @op: a #GMountOperation asking a question.
266 * @message: string containing a message to display to the user.
267 * @choices: an array of strings for each possible choice.
269 * Emitted when asking the user a question and gives a list of
270 * choices for the user to choose from.
272 signals[ASK_QUESTION] =
273 g_signal_new (I_("ask_question"),
274 G_TYPE_FROM_CLASS (object_class),
276 G_STRUCT_OFFSET (GMountOperationClass, ask_question),
278 _gio_marshal_VOID__STRING_BOXED,
280 G_TYPE_STRING, G_TYPE_STRV);
283 * GMountOperation::reply:
284 * @op: a #GMountOperation.
285 * @abort: a boolean indicating %TRUE if the operation was aborted.
287 * Emitted when the user has replied to the mount operation.
290 g_signal_new (I_("reply"),
291 G_TYPE_FROM_CLASS (object_class),
293 G_STRUCT_OFFSET (GMountOperationClass, reply),
295 g_cclosure_marshal_VOID__ENUM,
297 G_TYPE_MOUNT_OPERATION_RESULT);
300 * GMountOperation:username:
302 * The user name that is used for authentication when carrying out
303 * the mount operation.
305 g_object_class_install_property (object_class,
307 g_param_spec_string ("username",
312 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
315 * GMountOperation:password:
317 * The password that is used for authentication when carrying out
318 * the mount operation.
320 g_object_class_install_property (object_class,
322 g_param_spec_string ("password",
327 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
330 * GMountOperation:anonymous:
332 * Whether to use an anonymous user when authenticating.
334 g_object_class_install_property (object_class,
336 g_param_spec_boolean ("anonymous",
338 P_("Whether to use an anonymous user"),
341 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
344 * GMountOperation:domain:
346 * The domain to use for the mount operation.
348 g_object_class_install_property (object_class,
350 g_param_spec_string ("domain",
352 P_("The domain of the mount operation"),
355 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
358 * GMountOperation:password-save:
360 * Determines if and how the password information should be saved.
362 g_object_class_install_property (object_class,
364 g_param_spec_enum ("password-save",
366 P_("How passwords should be saved"),
367 G_TYPE_PASSWORD_SAVE,
368 G_PASSWORD_SAVE_NEVER,
370 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
373 * GMountOperation:choice:
375 * The index of the user's choice when a question is asked during the
376 * mount operation. See the #GMountOperation::ask-question signal.
378 g_object_class_install_property (object_class,
380 g_param_spec_int ("choice",
382 P_("The users choice"),
385 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
389 g_mount_operation_init (GMountOperation *operation)
391 operation->priv = G_TYPE_INSTANCE_GET_PRIVATE (operation,
392 G_TYPE_MOUNT_OPERATION,
393 GMountOperationPrivate);
397 * g_mount_operation_new:
399 * Creates a new mount operation.
401 * Returns: a #GMountOperation.
404 g_mount_operation_new (void)
406 return g_object_new (G_TYPE_MOUNT_OPERATION, NULL);
410 * g_mount_operation_get_username
411 * @op: a #GMountOperation.
413 * Get the user name from the mount operation.
415 * Returns: a string containing the user name.
418 g_mount_operation_get_username (GMountOperation *op)
420 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
421 return op->priv->user;
425 * g_mount_operation_set_username:
426 * @op: a #GMountOperation.
427 * @username: input username.
429 * Sets the user name within @op to @username.
433 g_mount_operation_set_username (GMountOperation *op,
434 const char *username)
436 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
437 g_free (op->priv->user);
438 op->priv->user = g_strdup (username);
439 g_object_notify (G_OBJECT (op), "username");
443 * g_mount_operation_get_password:
444 * @op: a #GMountOperation.
446 * Gets a password from the mount operation.
448 * Returns: a string containing the password within @op.
451 g_mount_operation_get_password (GMountOperation *op)
453 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
454 return op->priv->password;
458 * g_mount_operation_set_password:
459 * @op: a #GMountOperation.
460 * @password: password to set.
462 * Sets the mount operation's password to @password.
466 g_mount_operation_set_password (GMountOperation *op,
467 const char *password)
469 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
470 g_free (op->priv->password);
471 op->priv->password = g_strdup (password);
472 g_object_notify (G_OBJECT (op), "password");
476 * g_mount_operation_get_anonymous:
477 * @op: a #GMountOperation.
479 * Check to see whether the mount operation is being used
480 * for an anonymous user.
482 * Returns: %TRUE if mount operation is anonymous.
485 g_mount_operation_get_anonymous (GMountOperation *op)
487 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), FALSE);
488 return op->priv->anonymous;
492 * g_mount_operation_set_anonymous:
493 * @op: a #GMountOperation.
494 * @anonymous: boolean value.
496 * Sets the mount operation to use an anonymous user if @anonymous is %TRUE.
499 g_mount_operation_set_anonymous (GMountOperation *op,
502 GMountOperationPrivate *priv;
503 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
506 if (priv->anonymous != anonymous)
508 priv->anonymous = anonymous;
509 g_object_notify (G_OBJECT (op), "anonymous");
514 * g_mount_operation_get_domain:
515 * @op: a #GMountOperation.
517 * Gets the domain of the mount operation.
519 * Returns: a string set to the domain.
522 g_mount_operation_get_domain (GMountOperation *op)
524 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
525 return op->priv->domain;
529 * g_mount_operation_set_domain:
530 * @op: a #GMountOperation.
531 * @domain: the domain to set.
533 * Sets the mount operation's domain.
536 g_mount_operation_set_domain (GMountOperation *op,
539 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
540 g_free (op->priv->domain);
541 op->priv->domain = g_strdup (domain);
542 g_object_notify (G_OBJECT (op), "domain");
546 * g_mount_operation_get_password_save:
547 * @op: a #GMountOperation.
549 * Gets the state of saving passwords for the mount operation.
551 * Returns: a #GPasswordSave flag.
555 g_mount_operation_get_password_save (GMountOperation *op)
557 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), G_PASSWORD_SAVE_NEVER);
558 return op->priv->password_save;
562 * g_mount_operation_set_password_save:
563 * @op: a #GMountOperation.
564 * @save: a set of #GPasswordSave flags.
566 * Sets the state of saving passwords for the mount operation.
570 g_mount_operation_set_password_save (GMountOperation *op,
573 GMountOperationPrivate *priv;
574 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
577 if (priv->password_save != save)
579 priv->password_save = save;
580 g_object_notify (G_OBJECT (op), "password-save");
585 * g_mount_operation_get_choice:
586 * @op: a #GMountOperation.
588 * Gets a choice from the mount operation.
590 * Returns: an integer containing an index of the user's choice from
591 * the choice's list, or %0.
594 g_mount_operation_get_choice (GMountOperation *op)
596 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), 0);
597 return op->priv->choice;
601 * g_mount_operation_set_choice:
602 * @op: a #GMountOperation.
603 * @choice: an integer.
605 * Sets a default choice for the mount operation.
608 g_mount_operation_set_choice (GMountOperation *op,
611 GMountOperationPrivate *priv;
612 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
614 if (priv->choice != choice)
616 priv->choice = choice;
617 g_object_notify (G_OBJECT (op), "choice");
622 * g_mount_operation_reply:
623 * @op: a #GMountOperation
624 * @result: a #GMountOperationResult
626 * Emits the #GMountOperation::reply signal.
629 g_mount_operation_reply (GMountOperation *op,
630 GMountOperationResult result)
632 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
633 g_signal_emit (op, signals[REPLY], 0, result);
636 #define __G_MOUNT_OPERATION_C__
637 #include "gioaliasdef.c"