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"
33 * SECTION:gmountoperation
34 * @short_description: Object used for authentication and user interaction
37 * #GMountOperation provides a mechanism for interacting with the user.
38 * It can be used for authenticating mountable operations, such as loop
39 * mounting files, hard drive partitions or server locations. It can
40 * also be used to ask the user questions or show a list of applications
41 * preventing unmount or eject operations from completing.
43 * Note that #GMountOperation is used for more than just #GMount
44 * objects – for example it is also used in g_drive_start() and
47 * Users should instantiate a subclass of this that implements all the
48 * various callbacks to show the required dialogs, such as
49 * #GtkMountOperation. If no user interaction is desired (for example
50 * when automounting filesystems at login time), usually %NULL can be
51 * passed, see each method taking a #GMountOperation for details.
54 G_DEFINE_TYPE (GMountOperation, g_mount_operation, G_TYPE_OBJECT);
65 static guint signals[LAST_SIGNAL] = { 0 };
67 struct _GMountOperationPrivate {
72 GPasswordSave password_save;
87 g_mount_operation_set_property (GObject *object,
92 GMountOperation *operation;
94 operation = G_MOUNT_OPERATION (object);
99 g_mount_operation_set_username (operation,
100 g_value_get_string (value));
104 g_mount_operation_set_password (operation,
105 g_value_get_string (value));
109 g_mount_operation_set_anonymous (operation,
110 g_value_get_boolean (value));
114 g_mount_operation_set_domain (operation,
115 g_value_get_string (value));
118 case PROP_PASSWORD_SAVE:
119 g_mount_operation_set_password_save (operation,
120 g_value_get_enum (value));
124 g_mount_operation_set_choice (operation,
125 g_value_get_int (value));
129 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
136 g_mount_operation_get_property (GObject *object,
141 GMountOperation *operation;
142 GMountOperationPrivate *priv;
144 operation = G_MOUNT_OPERATION (object);
145 priv = operation->priv;
150 g_value_set_string (value, priv->user);
154 g_value_set_string (value, priv->password);
158 g_value_set_boolean (value, priv->anonymous);
162 g_value_set_string (value, priv->domain);
165 case PROP_PASSWORD_SAVE:
166 g_value_set_enum (value, priv->password_save);
170 g_value_set_int (value, priv->choice);
174 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
181 g_mount_operation_finalize (GObject *object)
183 GMountOperation *operation;
184 GMountOperationPrivate *priv;
186 operation = G_MOUNT_OPERATION (object);
188 priv = operation->priv;
190 g_free (priv->password);
192 g_free (priv->domain);
194 G_OBJECT_CLASS (g_mount_operation_parent_class)->finalize (object);
198 reply_non_handled_in_idle (gpointer data)
200 GMountOperation *op = data;
202 g_mount_operation_reply (op, G_MOUNT_OPERATION_UNHANDLED);
207 ask_password (GMountOperation *op,
209 const char *default_user,
210 const char *default_domain,
211 GAskPasswordFlags flags)
213 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
214 reply_non_handled_in_idle,
220 ask_question (GMountOperation *op,
222 const char *choices[])
224 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
225 reply_non_handled_in_idle,
231 show_processes (GMountOperation *op,
232 const gchar *message,
234 const gchar *choices[])
236 g_idle_add_full (G_PRIORITY_DEFAULT_IDLE,
237 reply_non_handled_in_idle,
243 g_mount_operation_class_init (GMountOperationClass *klass)
245 GObjectClass *object_class;
247 g_type_class_add_private (klass, sizeof (GMountOperationPrivate));
249 object_class = G_OBJECT_CLASS (klass);
250 object_class->finalize = g_mount_operation_finalize;
251 object_class->get_property = g_mount_operation_get_property;
252 object_class->set_property = g_mount_operation_set_property;
254 klass->ask_password = ask_password;
255 klass->ask_question = ask_question;
256 klass->show_processes = show_processes;
259 * GMountOperation::ask-password:
260 * @op: a #GMountOperation requesting a password.
261 * @message: string containing a message to display to the user.
262 * @default_user: string containing the default user name.
263 * @default_domain: string containing the default domain.
264 * @flags: a set of #GAskPasswordFlags.
266 * Emitted when a mount operation asks the user for a password.
268 * If the message contains a line break, the first line should be
269 * presented as a heading. For example, it may be used as the
270 * primary text in a #GtkMessageDialog.
272 signals[ASK_PASSWORD] =
273 g_signal_new (I_("ask-password"),
274 G_TYPE_FROM_CLASS (object_class),
276 G_STRUCT_OFFSET (GMountOperationClass, ask_password),
278 g_cclosure_marshal_generic,
280 G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING, G_TYPE_ASK_PASSWORD_FLAGS);
283 * GMountOperation::ask-question:
284 * @op: a #GMountOperation asking a question.
285 * @message: string containing a message to display to the user.
286 * @choices: an array of strings for each possible choice.
288 * Emitted when asking the user a question and gives a list of
289 * choices for the user to choose from.
291 * If the message contains a line break, the first line should be
292 * presented as a heading. For example, it may be used as the
293 * primary text in a #GtkMessageDialog.
295 signals[ASK_QUESTION] =
296 g_signal_new (I_("ask-question"),
297 G_TYPE_FROM_CLASS (object_class),
299 G_STRUCT_OFFSET (GMountOperationClass, ask_question),
301 g_cclosure_marshal_generic,
303 G_TYPE_STRING, G_TYPE_STRV);
306 * GMountOperation::reply:
307 * @op: a #GMountOperation.
308 * @result: a #GMountOperationResult indicating how the request was handled
310 * Emitted when the user has replied to the mount operation.
313 g_signal_new (I_("reply"),
314 G_TYPE_FROM_CLASS (object_class),
316 G_STRUCT_OFFSET (GMountOperationClass, reply),
318 g_cclosure_marshal_VOID__ENUM,
320 G_TYPE_MOUNT_OPERATION_RESULT);
323 * GMountOperation::aborted:
325 * Emitted by the backend when e.g. a device becomes unavailable
326 * while a mount operation is in progress.
328 * Implementations of GMountOperation should handle this signal
329 * by dismissing open password dialogs.
334 g_signal_new (I_("aborted"),
335 G_TYPE_FROM_CLASS (object_class),
337 G_STRUCT_OFFSET (GMountOperationClass, aborted),
339 g_cclosure_marshal_VOID__VOID,
343 * GMountOperation::show-processes:
344 * @op: a #GMountOperation.
345 * @message: string containing a message to display to the user.
346 * @processes: an array of #GPid for processes blocking the operation.
347 * @choices: an array of strings for each possible choice.
349 * Emitted when one or more processes are blocking an operation
350 * e.g. unmounting/ejecting a #GMount or stopping a #GDrive.
352 * Note that this signal may be emitted several times to update the
353 * list of blocking processes as processes close files. The
354 * application should only respond with g_mount_operation_reply() to
355 * the latest signal (setting #GMountOperation:choice to the choice
358 * If the message contains a line break, the first line should be
359 * presented as a heading. For example, it may be used as the
360 * primary text in a #GtkMessageDialog.
364 signals[SHOW_PROCESSES] =
365 g_signal_new (I_("show-processes"),
366 G_TYPE_FROM_CLASS (object_class),
368 G_STRUCT_OFFSET (GMountOperationClass, show_processes),
370 g_cclosure_marshal_generic,
372 G_TYPE_STRING, G_TYPE_ARRAY, G_TYPE_STRV);
375 * GMountOperation:username:
377 * The user name that is used for authentication when carrying out
378 * the mount operation.
380 g_object_class_install_property (object_class,
382 g_param_spec_string ("username",
387 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
390 * GMountOperation:password:
392 * The password that is used for authentication when carrying out
393 * the mount operation.
395 g_object_class_install_property (object_class,
397 g_param_spec_string ("password",
402 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
405 * GMountOperation:anonymous:
407 * Whether to use an anonymous user when authenticating.
409 g_object_class_install_property (object_class,
411 g_param_spec_boolean ("anonymous",
413 P_("Whether to use an anonymous user"),
416 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
419 * GMountOperation:domain:
421 * The domain to use for the mount operation.
423 g_object_class_install_property (object_class,
425 g_param_spec_string ("domain",
427 P_("The domain of the mount operation"),
430 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
433 * GMountOperation:password-save:
435 * Determines if and how the password information should be saved.
437 g_object_class_install_property (object_class,
439 g_param_spec_enum ("password-save",
441 P_("How passwords should be saved"),
442 G_TYPE_PASSWORD_SAVE,
443 G_PASSWORD_SAVE_NEVER,
445 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
448 * GMountOperation:choice:
450 * The index of the user's choice when a question is asked during the
451 * mount operation. See the #GMountOperation::ask-question signal.
453 g_object_class_install_property (object_class,
455 g_param_spec_int ("choice",
457 P_("The users choice"),
460 G_PARAM_STATIC_NAME|G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
464 g_mount_operation_init (GMountOperation *operation)
466 operation->priv = G_TYPE_INSTANCE_GET_PRIVATE (operation,
467 G_TYPE_MOUNT_OPERATION,
468 GMountOperationPrivate);
472 * g_mount_operation_new:
474 * Creates a new mount operation.
476 * Returns: a #GMountOperation.
479 g_mount_operation_new (void)
481 return g_object_new (G_TYPE_MOUNT_OPERATION, NULL);
485 * g_mount_operation_get_username
486 * @op: a #GMountOperation.
488 * Get the user name from the mount operation.
490 * Returns: a string containing the user name.
493 g_mount_operation_get_username (GMountOperation *op)
495 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
496 return op->priv->user;
500 * g_mount_operation_set_username:
501 * @op: a #GMountOperation.
502 * @username: input username.
504 * Sets the user name within @op to @username.
507 g_mount_operation_set_username (GMountOperation *op,
508 const char *username)
510 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
511 g_free (op->priv->user);
512 op->priv->user = g_strdup (username);
513 g_object_notify (G_OBJECT (op), "username");
517 * g_mount_operation_get_password:
518 * @op: a #GMountOperation.
520 * Gets a password from the mount operation.
522 * Returns: a string containing the password within @op.
525 g_mount_operation_get_password (GMountOperation *op)
527 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
528 return op->priv->password;
532 * g_mount_operation_set_password:
533 * @op: a #GMountOperation.
534 * @password: password to set.
536 * Sets the mount operation's password to @password.
540 g_mount_operation_set_password (GMountOperation *op,
541 const char *password)
543 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
544 g_free (op->priv->password);
545 op->priv->password = g_strdup (password);
546 g_object_notify (G_OBJECT (op), "password");
550 * g_mount_operation_get_anonymous:
551 * @op: a #GMountOperation.
553 * Check to see whether the mount operation is being used
554 * for an anonymous user.
556 * Returns: %TRUE if mount operation is anonymous.
559 g_mount_operation_get_anonymous (GMountOperation *op)
561 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), FALSE);
562 return op->priv->anonymous;
566 * g_mount_operation_set_anonymous:
567 * @op: a #GMountOperation.
568 * @anonymous: boolean value.
570 * Sets the mount operation to use an anonymous user if @anonymous is %TRUE.
573 g_mount_operation_set_anonymous (GMountOperation *op,
576 GMountOperationPrivate *priv;
577 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
580 if (priv->anonymous != anonymous)
582 priv->anonymous = anonymous;
583 g_object_notify (G_OBJECT (op), "anonymous");
588 * g_mount_operation_get_domain:
589 * @op: a #GMountOperation.
591 * Gets the domain of the mount operation.
593 * Returns: a string set to the domain.
596 g_mount_operation_get_domain (GMountOperation *op)
598 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), NULL);
599 return op->priv->domain;
603 * g_mount_operation_set_domain:
604 * @op: a #GMountOperation.
605 * @domain: the domain to set.
607 * Sets the mount operation's domain.
610 g_mount_operation_set_domain (GMountOperation *op,
613 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
614 g_free (op->priv->domain);
615 op->priv->domain = g_strdup (domain);
616 g_object_notify (G_OBJECT (op), "domain");
620 * g_mount_operation_get_password_save:
621 * @op: a #GMountOperation.
623 * Gets the state of saving passwords for the mount operation.
625 * Returns: a #GPasswordSave flag.
629 g_mount_operation_get_password_save (GMountOperation *op)
631 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), G_PASSWORD_SAVE_NEVER);
632 return op->priv->password_save;
636 * g_mount_operation_set_password_save:
637 * @op: a #GMountOperation.
638 * @save: a set of #GPasswordSave flags.
640 * Sets the state of saving passwords for the mount operation.
644 g_mount_operation_set_password_save (GMountOperation *op,
647 GMountOperationPrivate *priv;
648 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
651 if (priv->password_save != save)
653 priv->password_save = save;
654 g_object_notify (G_OBJECT (op), "password-save");
659 * g_mount_operation_get_choice:
660 * @op: a #GMountOperation.
662 * Gets a choice from the mount operation.
664 * Returns: an integer containing an index of the user's choice from
665 * the choice's list, or %0.
668 g_mount_operation_get_choice (GMountOperation *op)
670 g_return_val_if_fail (G_IS_MOUNT_OPERATION (op), 0);
671 return op->priv->choice;
675 * g_mount_operation_set_choice:
676 * @op: a #GMountOperation.
677 * @choice: an integer.
679 * Sets a default choice for the mount operation.
682 g_mount_operation_set_choice (GMountOperation *op,
685 GMountOperationPrivate *priv;
686 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
688 if (priv->choice != choice)
690 priv->choice = choice;
691 g_object_notify (G_OBJECT (op), "choice");
696 * g_mount_operation_reply:
697 * @op: a #GMountOperation
698 * @result: a #GMountOperationResult
700 * Emits the #GMountOperation::reply signal.
703 g_mount_operation_reply (GMountOperation *op,
704 GMountOperationResult result)
706 g_return_if_fail (G_IS_MOUNT_OPERATION (op));
707 g_signal_emit (op, signals[REPLY], 0, result);