Merge branch 'signal-performance'
[platform/upstream/glib.git] / gio / gapplicationimpl-dbus.c
1 /*
2  * Copyright © 2010 Codethink Limited
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Lesser General Public License for more details.
13  *
14  * You should have received a copy of the GNU Lesser General
15  * Public License along with this library; if not, write to the
16  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
17  * Boston, MA 02111-1307, USA.
18  *
19  * Authors: Ryan Lortie <desrt@desrt.ca>
20  */
21
22 #include "gapplicationimpl.h"
23
24 #include "gactiongroup.h"
25 #include "gactiongroupexporter.h"
26 #include "gremoteactiongroup.h"
27 #include "gdbusactiongroup.h"
28 #include "gapplication.h"
29 #include "gfile.h"
30 #include "gdbusconnection.h"
31 #include "gdbusintrospection.h"
32 #include "gdbuserror.h"
33
34 #include <string.h>
35 #include <stdio.h>
36
37 #include "gapplicationcommandline.h"
38 #include "gdbusmethodinvocation.h"
39
40 G_GNUC_INTERNAL gboolean
41 g_dbus_action_group_sync (GDBusActionGroup  *group,
42                           GCancellable      *cancellable,
43                           GError           **error);
44
45
46 /* DBus Interface definition {{{1 */
47
48 /* For documentation of these interfaces, see
49  * http://live.gnome.org/GTK+/GApplication-dbus-apis
50  */
51 static const gchar org_gtk_Application_xml[] =
52   "<node>"
53   "  <interface name='org.gtk.Application'>"
54   "    <method name='Activate'>"
55   "      <arg type='a{sv}' name='platform-data' direction='in'/>"
56   "    </method>"
57   "    <method name='Open'>"
58   "      <arg type='as' name='uris' direction='in'/>"
59   "      <arg type='s' name='hint' direction='in'/>"
60   "      <arg type='a{sv}' name='platform-data' direction='in'/>"
61   "    </method>"
62   "    <method name='CommandLine'>"
63   "      <arg type='o' name='path' direction='in'/>"
64   "      <arg type='aay' name='arguments' direction='in'/>"
65   "      <arg type='a{sv}' name='platform-data' direction='in'/>"
66   "      <arg type='i' name='exit-status' direction='out'/>"
67   "    </method>"
68   "  </interface>"
69   "</node>";
70
71 static GDBusInterfaceInfo *org_gtk_Application;
72
73 static const gchar org_gtk_private_CommandLine_xml[] =
74   "<node>"
75   "  <interface name='org.gtk.private.CommandLine'>"
76   "    <method name='Print'>"
77   "      <arg type='s' name='message' direction='in'/>"
78   "    </method>"
79   "    <method name='PrintError'>"
80   "      <arg type='s' name='message' direction='in'/>"
81   "    </method>"
82   "  </interface>"
83   "</node>";
84
85 static GDBusInterfaceInfo *org_gtk_private_CommandLine;
86
87 /* GApplication implementation {{{1 */
88 struct _GApplicationImpl
89 {
90   GDBusConnection *session_bus;
91   GActionGroup    *exported_actions;
92   const gchar     *bus_name;
93
94   gchar           *object_path;
95   guint            object_id;
96   guint            actions_id;
97
98   gboolean         properties_live;
99   gboolean         primary;
100   gpointer         app;
101 };
102
103
104 static GApplicationCommandLine *
105 g_dbus_command_line_new (GDBusMethodInvocation *invocation);
106
107
108 static void
109 g_application_impl_method_call (GDBusConnection       *connection,
110                                 const gchar           *sender,
111                                 const gchar           *object_path,
112                                 const gchar           *interface_name,
113                                 const gchar           *method_name,
114                                 GVariant              *parameters,
115                                 GDBusMethodInvocation *invocation,
116                                 gpointer               user_data)
117 {
118   GApplicationImpl *impl = user_data;
119   GApplicationClass *class;
120
121   class = G_APPLICATION_GET_CLASS (impl->app);
122
123   if (strcmp (method_name, "Activate") == 0)
124     {
125       GVariant *platform_data;
126
127       g_variant_get (parameters, "(@a{sv})", &platform_data);
128       class->before_emit (impl->app, platform_data);
129       g_signal_emit_by_name (impl->app, "activate");
130       class->after_emit (impl->app, platform_data);
131       g_variant_unref (platform_data);
132
133       g_dbus_method_invocation_return_value (invocation, NULL);
134     }
135
136   else if (strcmp (method_name, "Open") == 0)
137     {
138       GVariant *platform_data;
139       const gchar *hint;
140       GVariant *array;
141       GFile **files;
142       gint n, i;
143
144       g_variant_get (parameters, "(@ass@a{sv})",
145                      &array, &hint, &platform_data);
146
147       n = g_variant_n_children (array);
148       files = g_new (GFile *, n + 1);
149
150       for (i = 0; i < n; i++)
151         {
152           const gchar *uri;
153
154           g_variant_get_child (array, i, "&s", &uri);
155           files[i] = g_file_new_for_uri (uri);
156         }
157       g_variant_unref (array);
158       files[n] = NULL;
159
160       class->before_emit (impl->app, platform_data);
161       g_signal_emit_by_name (impl->app, "open", files, n, hint);
162       class->after_emit (impl->app, platform_data);
163
164       g_variant_unref (platform_data);
165
166       for (i = 0; i < n; i++)
167         g_object_unref (files[i]);
168       g_free (files);
169
170       g_dbus_method_invocation_return_value (invocation, NULL);
171     }
172
173   else if (strcmp (method_name, "CommandLine") == 0)
174     {
175       GApplicationCommandLine *cmdline;
176       GVariant *platform_data;
177       int status;
178
179       cmdline = g_dbus_command_line_new (invocation);
180       platform_data = g_variant_get_child_value (parameters, 2);
181       class->before_emit (impl->app, platform_data);
182       g_signal_emit_by_name (impl->app, "command-line", cmdline, &status);
183       g_application_command_line_set_exit_status (cmdline, status);
184       class->after_emit (impl->app, platform_data);
185       g_variant_unref (platform_data);
186       g_object_unref (cmdline);
187     }
188   else
189     g_assert_not_reached ();
190 }
191
192 static gchar *
193 application_path_from_appid (const gchar *appid)
194 {
195   gchar *appid_path, *iter;
196
197   appid_path = g_strconcat ("/", appid, NULL);
198   for (iter = appid_path; *iter; iter++)
199     {
200       if (*iter == '.')
201         *iter = '/';
202
203       if (*iter == '-')
204         *iter = '_';
205     }
206
207   return appid_path;
208 }
209
210 /* Attempt to become the primary instance.
211  *
212  * Returns %TRUE if everything went OK, regardless of if we became the
213  * primary instance or not.  %FALSE is reserved for when something went
214  * seriously wrong (and @error will be set too, in that case).
215  *
216  * After a %TRUE return, impl->primary will be TRUE if we were
217  * successful.
218  */
219 static gboolean
220 g_application_impl_attempt_primary (GApplicationImpl  *impl,
221                                     GCancellable      *cancellable,
222                                     GError           **error)
223 {
224   const static GDBusInterfaceVTable vtable = {
225     g_application_impl_method_call,
226   };
227   GVariant *reply;
228   guint32 rval;
229
230   if (org_gtk_Application == NULL)
231     {
232       GError *error = NULL;
233       GDBusNodeInfo *info;
234
235       info = g_dbus_node_info_new_for_xml (org_gtk_Application_xml, &error);
236       if G_UNLIKELY (info == NULL)
237         g_error ("%s", error->message);
238       org_gtk_Application = g_dbus_node_info_lookup_interface (info, "org.gtk.Application");
239       g_assert (org_gtk_Application != NULL);
240       g_dbus_interface_info_ref (org_gtk_Application);
241       g_dbus_node_info_unref (info);
242     }
243
244   /* We could possibly have been D-Bus activated as a result of incoming
245    * requests on either the application or actiongroup interfaces.
246    * Because of how GDBus dispatches messages, we need to ensure that
247    * both of those things are registered before we attempt to request
248    * our name.
249    *
250    * The action group need not be populated yet, as long as it happens
251    * before we return to the mainloop.  The reason for that is because
252    * GDBus does the check to make sure the object exists from the worker
253    * thread but doesn't actually dispatch the action invocation until we
254    * hit the mainloop in this thread.  There is also no danger of
255    * receiving 'activate' or 'open' signals until after 'startup' runs,
256    * for the same reason.
257    */
258   impl->object_id = g_dbus_connection_register_object (impl->session_bus, impl->object_path,
259                                                        org_gtk_Application, &vtable, impl, NULL, error);
260
261   if (impl->object_id == 0)
262     return FALSE;
263
264   impl->actions_id = g_dbus_connection_export_action_group (impl->session_bus, impl->object_path,
265                                                             impl->exported_actions, error);
266
267   if (impl->actions_id == 0)
268     return FALSE;
269
270   if (impl->bus_name == NULL)
271     {
272       /* If this is a non-unique application then it is sufficient to
273        * have our object paths registered. We can return now.
274        *
275        * Note: non-unique applications always act as primary-instance.
276        */
277       impl->primary = TRUE;
278       return TRUE;
279     }
280
281   /* If this is a unique application then we need to attempt to own
282    * the well-known name and fall back to remote mode (!is_primary)
283    * in the case that we can't do that.
284    */
285   /* DBUS_NAME_FLAG_DO_NOT_QUEUE: 0x4 */
286   reply = g_dbus_connection_call_sync (impl->session_bus, "org.freedesktop.DBus", "/org/freedesktop/DBus",
287                                        "org.freedesktop.DBus", "RequestName",
288                                        g_variant_new ("(su)", impl->bus_name, 0x4), G_VARIANT_TYPE ("(u)"),
289                                        0, -1, cancellable, error);
290
291   if (reply == NULL)
292     return FALSE;
293
294   g_variant_get (reply, "(u)", &rval);
295   g_variant_unref (reply);
296
297   /* DBUS_REQUEST_NAME_REPLY_EXISTS: 3 */
298   impl->primary = (rval != 3);
299
300   return TRUE;
301 }
302
303 /* Stop doing the things that the primary instance does.
304  *
305  * This should be called if attempting to become the primary instance
306  * failed (in order to clean up any partial success) and should also
307  * be called when freeing the GApplication.
308  *
309  * It is safe to call this multiple times.
310  */
311 static void
312 g_application_impl_stop_primary (GApplicationImpl *impl)
313 {
314   if (impl->object_id)
315     {
316       g_dbus_connection_unregister_object (impl->session_bus, impl->object_id);
317       impl->object_id = 0;
318     }
319
320   if (impl->actions_id)
321     {
322       g_dbus_connection_unexport_action_group (impl->session_bus, impl->actions_id);
323       impl->actions_id = 0;
324     }
325
326   if (impl->primary && impl->bus_name)
327     {
328       g_dbus_connection_call (impl->session_bus, "org.freedesktop.DBus",
329                               "/org/freedesktop/DBus", "org.freedesktop.DBus",
330                               "ReleaseName", g_variant_new ("(s)", impl->bus_name),
331                               NULL, G_DBUS_CALL_FLAGS_NONE, -1, NULL, NULL, NULL);
332       impl->primary = FALSE;
333     }
334 }
335
336 void
337 g_application_impl_destroy (GApplicationImpl *impl)
338 {
339   g_application_impl_stop_primary (impl);
340
341   if (impl->session_bus)
342     g_object_unref (impl->session_bus);
343
344   g_free (impl->object_path);
345
346   g_slice_free (GApplicationImpl, impl);
347 }
348
349 GApplicationImpl *
350 g_application_impl_register (GApplication        *application,
351                              const gchar         *appid,
352                              GApplicationFlags    flags,
353                              GActionGroup        *exported_actions,
354                              GRemoteActionGroup **remote_actions,
355                              GCancellable        *cancellable,
356                              GError             **error)
357 {
358   GDBusActionGroup *actions;
359   GApplicationImpl *impl;
360
361   impl = g_slice_new0 (GApplicationImpl);
362
363   impl->app = application;
364   impl->exported_actions = exported_actions;
365
366   /* non-unique applications do not attempt to acquire a bus name */
367   if (~flags & G_APPLICATION_NON_UNIQUE)
368     impl->bus_name = appid;
369
370   impl->session_bus = g_bus_get_sync (G_BUS_TYPE_SESSION, cancellable, NULL);
371
372   if (impl->session_bus == NULL)
373     {
374       /* If we can't connect to the session bus, proceed as a normal
375        * non-unique application.
376        */
377       *remote_actions = NULL;
378       return impl;
379     }
380
381   impl->object_path = application_path_from_appid (appid);
382
383   /* Only try to be the primary instance if
384    * G_APPLICATION_IS_LAUNCHER was not specified.
385    */
386   if (~flags & G_APPLICATION_IS_LAUNCHER)
387     {
388       if (!g_application_impl_attempt_primary (impl, cancellable, error))
389         {
390           g_application_impl_destroy (impl);
391           return NULL;
392         }
393
394       if (impl->primary)
395         return impl;
396
397       /* We didn't make it.  Drop our service-side stuff. */
398       g_application_impl_stop_primary (impl);
399
400       if (flags & G_APPLICATION_IS_SERVICE)
401         {
402           g_set_error (error, G_DBUS_ERROR, G_DBUS_ERROR_FAILED,
403                        "Unable to acquire bus name `%s'", appid);
404           g_application_impl_destroy (impl);
405
406           return NULL;
407         }
408     }
409
410   /* We are non-primary.  Try to get the primary's list of actions.
411    * This also serves as a mechanism to ensure that the primary exists
412    * (ie: DBus service files installed correctly, etc).
413    */
414   actions = g_dbus_action_group_get (impl->session_bus, impl->bus_name, impl->object_path);
415   if (!g_dbus_action_group_sync (actions, cancellable, error))
416     {
417       /* The primary appears not to exist.  Fail the registration. */
418       g_application_impl_destroy (impl);
419       g_object_unref (actions);
420
421       return NULL;
422     }
423
424   *remote_actions = G_REMOTE_ACTION_GROUP (actions);
425
426   return impl;
427 }
428
429 void
430 g_application_impl_activate (GApplicationImpl *impl,
431                              GVariant         *platform_data)
432 {
433   g_dbus_connection_call (impl->session_bus,
434                           impl->bus_name,
435                           impl->object_path,
436                           "org.gtk.Application",
437                           "Activate",
438                           g_variant_new ("(@a{sv})", platform_data),
439                           NULL, 0, -1, NULL, NULL, NULL);
440 }
441
442 void
443 g_application_impl_open (GApplicationImpl  *impl,
444                          GFile            **files,
445                          gint               n_files,
446                          const gchar       *hint,
447                          GVariant          *platform_data)
448 {
449   GVariantBuilder builder;
450   gint i;
451
452   g_variant_builder_init (&builder, G_VARIANT_TYPE ("(assa{sv})"));
453   g_variant_builder_open (&builder, G_VARIANT_TYPE_STRING_ARRAY);
454   for (i = 0; i < n_files; i++)
455     {
456       gchar *uri = g_file_get_uri (files[i]);
457       g_variant_builder_add (&builder, "s", uri);
458       g_free (uri);
459     }
460   g_variant_builder_close (&builder);
461   g_variant_builder_add (&builder, "s", hint);
462   g_variant_builder_add_value (&builder, platform_data);
463
464   g_dbus_connection_call (impl->session_bus,
465                           impl->bus_name,
466                           impl->object_path,
467                           "org.gtk.Application",
468                           "Open",
469                           g_variant_builder_end (&builder),
470                           NULL, 0, -1, NULL, NULL, NULL);
471 }
472
473 static void
474 g_application_impl_cmdline_method_call (GDBusConnection       *connection,
475                                         const gchar           *sender,
476                                         const gchar           *object_path,
477                                         const gchar           *interface_name,
478                                         const gchar           *method_name,
479                                         GVariant              *parameters,
480                                         GDBusMethodInvocation *invocation,
481                                         gpointer               user_data)
482 {
483   const gchar *message;
484
485   g_variant_get_child (parameters, 0, "&s", &message);
486
487   if (strcmp (method_name, "Print") == 0)
488     g_print ("%s", message);
489   else if (strcmp (method_name, "PrintError") == 0)
490     g_printerr ("%s", message);
491   else
492     g_assert_not_reached ();
493
494   g_dbus_method_invocation_return_value (invocation, NULL);
495 }
496
497 typedef struct
498 {
499   GMainLoop *loop;
500   int status;
501 } CommandLineData;
502
503 static void
504 g_application_impl_cmdline_done (GObject      *source,
505                                  GAsyncResult *result,
506                                  gpointer      user_data)
507 {
508   CommandLineData *data = user_data;
509   GError *error = NULL;
510   GVariant *reply;
511
512   reply = g_dbus_connection_call_finish (G_DBUS_CONNECTION (source),
513                                          result, &error);
514
515   if (reply != NULL)
516     {
517       g_variant_get (reply, "(i)", &data->status);
518       g_variant_unref (reply);
519     }
520
521   else
522     {
523       g_printerr ("%s\n", error->message);
524       g_error_free (error);
525       data->status = 1;
526     }
527
528   g_main_loop_quit (data->loop);
529 }
530
531 int
532 g_application_impl_command_line (GApplicationImpl  *impl,
533                                  gchar            **arguments,
534                                  GVariant          *platform_data)
535 {
536   const static GDBusInterfaceVTable vtable = {
537     g_application_impl_cmdline_method_call
538   };
539   const gchar *object_path = "/org/gtk/Application/CommandLine";
540   GMainContext *context;
541   CommandLineData data;
542   guint object_id;
543
544   context = g_main_context_new ();
545   data.loop = g_main_loop_new (context, FALSE);
546   g_main_context_push_thread_default (context);
547
548   if (org_gtk_private_CommandLine == NULL)
549     {
550       GError *error = NULL;
551       GDBusNodeInfo *info;
552
553       info = g_dbus_node_info_new_for_xml (org_gtk_private_CommandLine_xml, &error);
554       if G_UNLIKELY (info == NULL)
555         g_error ("%s", error->message);
556       org_gtk_private_CommandLine = g_dbus_node_info_lookup_interface (info, "org.gtk.private.CommandLine");
557       g_assert (org_gtk_private_CommandLine != NULL);
558       g_dbus_interface_info_ref (org_gtk_private_CommandLine);
559       g_dbus_node_info_unref (info);
560     }
561
562   object_id = g_dbus_connection_register_object (impl->session_bus, object_path,
563                                                  org_gtk_private_CommandLine,
564                                                  &vtable, &data, NULL, NULL);
565   /* In theory we should try other paths... */
566   g_assert (object_id != 0);
567
568   g_dbus_connection_call (impl->session_bus,
569                           impl->bus_name,
570                           impl->object_path,
571                           "org.gtk.Application",
572                           "CommandLine",
573                           g_variant_new ("(o^aay@a{sv})", object_path,
574                                          arguments, platform_data),
575                           G_VARIANT_TYPE ("(i)"), 0, G_MAXINT, NULL,
576                           g_application_impl_cmdline_done, &data);
577
578   g_main_loop_run (data.loop);
579
580   g_main_context_pop_thread_default (context);
581   g_main_context_unref (context);
582   g_main_loop_unref (data.loop);
583
584   return data.status;
585 }
586
587 void
588 g_application_impl_flush (GApplicationImpl *impl)
589 {
590   if (impl->session_bus)
591     g_dbus_connection_flush_sync (impl->session_bus, NULL, NULL);
592 }
593
594
595 /* GDBusCommandLine implementation {{{1 */
596
597 typedef GApplicationCommandLineClass GDBusCommandLineClass;
598 static GType g_dbus_command_line_get_type (void);
599 typedef struct
600 {
601   GApplicationCommandLine  parent_instance;
602   GDBusMethodInvocation   *invocation;
603
604   GDBusConnection *connection;
605   const gchar     *bus_name;
606   const gchar     *object_path;
607 } GDBusCommandLine;
608
609
610 G_DEFINE_TYPE (GDBusCommandLine,
611                g_dbus_command_line,
612                G_TYPE_APPLICATION_COMMAND_LINE)
613
614 static void
615 g_dbus_command_line_print_literal (GApplicationCommandLine *cmdline,
616                                    const gchar             *message)
617 {
618   GDBusCommandLine *gdbcl = (GDBusCommandLine *) cmdline;
619
620   g_dbus_connection_call (gdbcl->connection,
621                           gdbcl->bus_name,
622                           gdbcl->object_path,
623                           "org.gtk.private.CommandLine", "Print",
624                           g_variant_new ("(s)", message),
625                           NULL, 0, -1, NULL, NULL, NULL);
626 }
627
628 static void
629 g_dbus_command_line_printerr_literal (GApplicationCommandLine *cmdline,
630                                       const gchar             *message)
631 {
632   GDBusCommandLine *gdbcl = (GDBusCommandLine *) cmdline;
633
634   g_dbus_connection_call (gdbcl->connection,
635                           gdbcl->bus_name,
636                           gdbcl->object_path,
637                           "org.gtk.private.CommandLine", "PrintError",
638                           g_variant_new ("(s)", message),
639                           NULL, 0, -1, NULL, NULL, NULL);
640 }
641
642 static void
643 g_dbus_command_line_finalize (GObject *object)
644 {
645   GApplicationCommandLine *cmdline = G_APPLICATION_COMMAND_LINE (object);
646   GDBusCommandLine *gdbcl = (GDBusCommandLine *) object;
647   gint status;
648
649   status = g_application_command_line_get_exit_status (cmdline);
650
651   g_dbus_method_invocation_return_value (gdbcl->invocation,
652                                          g_variant_new ("(i)", status));
653   g_object_unref (gdbcl->invocation);
654
655   G_OBJECT_CLASS (g_dbus_command_line_parent_class)
656     ->finalize (object);
657 }
658
659 static void
660 g_dbus_command_line_init (GDBusCommandLine *gdbcl)
661 {
662 }
663
664 static void
665 g_dbus_command_line_class_init (GApplicationCommandLineClass *class)
666 {
667   GObjectClass *object_class = G_OBJECT_CLASS (class);
668
669   object_class->finalize = g_dbus_command_line_finalize;
670   class->printerr_literal = g_dbus_command_line_printerr_literal;
671   class->print_literal = g_dbus_command_line_print_literal;
672 }
673
674 static GApplicationCommandLine *
675 g_dbus_command_line_new (GDBusMethodInvocation *invocation)
676 {
677   GDBusCommandLine *gdbcl;
678   GVariant *args;
679
680   args = g_dbus_method_invocation_get_parameters (invocation);
681
682   gdbcl = g_object_new (g_dbus_command_line_get_type (),
683                         "arguments", g_variant_get_child_value (args, 1),
684                         "platform-data", g_variant_get_child_value (args, 2),
685                         NULL);
686   gdbcl->connection = g_dbus_method_invocation_get_connection (invocation);
687   gdbcl->bus_name = g_dbus_method_invocation_get_sender (invocation);
688   g_variant_get_child (args, 0, "&o", &gdbcl->object_path);
689   gdbcl->invocation = g_object_ref (invocation);
690
691   return G_APPLICATION_COMMAND_LINE (gdbcl);
692 }
693
694 /* Epilogue {{{1 */
695
696 /* vim:set foldmethod=marker: */