see full message -- safe signal/lifetime/glib code
[systembsd.git] / src / interfaces / hostnamed / hostnamed.c
index a7c960d76056d5a7b90329b57979df1f53e5c6db..979df6e78da437ed16d09f7b034ef61137804ab8 100644 (file)
+/*
+ * Copyright (c) 2014 Ian Sutton <ian@kremlin.cc>
+ *
+ * Permission to use, copy, modify, and distribute this software for any
+ * purpose with or without fee is hereby granted, provided that the above
+ * copyright notice and this permission notice appear in all copies.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+ * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+ * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+ * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+ * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ */
+
 #include <unistd.h>
 #include <limits.h>
-#include <gio/gio.h>
-
-
-GDBusNodeInfo *spect_data;
-
-static gchar *hostname;
-static gchar *pretty_hostname;
-static gchar *static_hostname;
-static gchar *icon_name;
-static gchar *chassis;
-static gchar *kernel_name;
-static gchar *kernel_release;
-static gchar *kernel_version;
-static gchar *os_prettyname;
-static gchar *os_cpe;         //common platform enumeration string
-
-static void handle_method_call(GDBusConnection *conn,
-                                                          const gchar *sender,
-                                                          const gchar *obj_path,
-                                                          const gchar *interf_name,
-                                                          const gchar *method_name,
-                                                          GVariant *params,
-                                                          GDBusMethodInvocation *invc,
-                                                          gpointer usrdat) {
-
-       if(g_strcmp0(interf_name, "org.freedesktop.DBus.Introspectable") == 0
-               && g_strcmp0(method_name, "Introspect") == 0) {
-
-               GVariant *xml_ret_gvar;
-               GString  *xml_ret;
-       
-               g_dbus_interface_info_generate_xml(spect_data->interfaces[0], (guint)0, xml_ret);
-               xml_ret_gvar = g_variant_new_string(xml_ret->str);
-               g_dbus_method_invocation_return_value(invc, xml_ret_gvar);
-       } 
+#include <signal.h>
 
-}
+#include <sys/param.h>
+#include <string.h>
 
-static GVariant * handle_get_property(GDBusConnection *conn,
-                                                                         const gchar *sender,
-                                                                         const gchar *obj_path,
-                                                                         const gchar *interf_name,
-                                                                         const gchar *prop_name,
-                                                                         GError **err,
-                                                                         gpointer usr_data) {
-       
-       const gchar *our_interf_name = "org.freedesktop.hostname1";
-       const gchar *our_obj_path    = "/org/freedesktop/hostname1";
+#include <glib/gprintf.h>
+#include <glib-unix.h>
 
-       if(g_strcmp0(interf_name, our_interf_name) != 0
-               || g_strcmp0(obj_path, our_obj_path) != 0) {
+#include "hostnamed-gen.h"
+#include "hostnamed.h"
 
-               return NULL; //TODO error
-       }
+GPtrArray *hostnamed_freeable;
+Hostname1 *hostnamed_interf;
+
+GMainLoop *hostnamed_loop;
 
-       if(g_strcmp0(prop_name, "Hostname") == 0)
-               return g_variant_new_string(hostname);
+guint bus_descriptor;
+gboolean dbus_interface_exported; /* reliable because of gdbus operational guarantees */
 
-       else if(g_strcmp0(prop_name, "StaticHostname") == 0)
-               return g_variant_new_string(static_hostname);
+/* --- begin method/property/dbus signal code --- */
 
-       else if(g_strcmp0(prop_name, "PrettyHostname") == 0)
-               return g_variant_new_string(pretty_hostname);
+static gboolean
+on_handle_set_hostname(Hostname1 *hn1_passed_interf,
+                       GDBusMethodInvocation *invoc,
+                       const gchar *greet,
+                       gpointer data) {
+    return FALSE;
+}
 
-       else if(g_strcmp0(prop_name, "IconName") == 0)
-               return g_variant_new_string(icon_name);
+static gboolean
+on_handle_set_static_hostname(Hostname1 *hn1_passed_interf,
+                              GDBusMethodInvocation *invoc,
+                              const gchar *greet,
+                              gpointer data) {
+    return FALSE;
+}
 
-       else 
-               return NULL; //TODO error
-       
+static gboolean
+on_handle_set_pretty_hostname(Hostname1 *hn1_passed_interf,
+                              GDBusMethodInvocation *invoc,
+                              const gchar *greet,
+                              gpointer data) {
+    return FALSE;
 }
 
-static gboolean handle_set_property(GDBusConnection *conn,
-                                                                       const gchar *sender,
-                                                                       const gchar *obj_path,
-                                                                       const gchar *interf_name,
-                                                                       const gchar *prop_name,
-                                                                       GVariant *val,
-                                                                       GError **err,
-                                                                       gpointer usr_data) {
-
-       g_dbus_connection_emit_signal(conn,
-                                                                 NULL,
-                                                                 obj_path,
-                                                                 "org.freedesktop.DBus.Properties",
-                                                                 "PropertiesChanged",
-                                                                 NULL, /* incorrect */
-                                                                 NULL);
-
-       return TRUE;
+static gboolean
+on_handle_set_chassis(Hostname1 *hn1_passed_interf,
+                      GDBusMethodInvocation *invoc,
+                      const gchar *greet,
+                      gpointer data) {
+    return FALSE;
 }
 
-/* "hot" functions initially passed to gdbus */
-static const GDBusInterfaceVTable interface_vtable =
-{
-       handle_method_call,
-       handle_get_property,
-       handle_set_property
-};
-
-/* end method/property functions, begin bus name handlers
- * TODO: these should be intertwined as to handle edge cases
- * for when the system cannot immediately grab the name, as
- * well as cases where the system unintendedly loses the name
+static gboolean
+on_handle_set_icon_name(Hostname1 *hn1_passed_interf,
+                        GDBusMethodInvocation *invoc,
+                        const gchar *greet,
+                        gpointer data) {
+    return FALSE;
+}
+
+/* note: all hostnamed/hostname1's properties are read-only,
+ * and do not need set_ functions, gdbus-codegen realized
+ * this from the XML and handled the to-be error of trying
+ * to set a read-only property's value 
  */
-static void on_bus_acquired(GDBusConnection *conn,
-                                                       const gchar *name,
-                                                       gpointer user_data) {
 
-       GError *err;
+const gchar *
+our_get_hostname() {
+
+       gchar *hostname_buf, *ret;
+       size_t hostname_divider;
+
+       hostname_buf = (gchar*) g_malloc0(MAXHOSTNAMELEN); /* todo check & free */
+       ret          = (gchar*) g_malloc0(MAXHOSTNAMELEN);
+       g_ptr_array_add(hostnamed_freeable, hostname_buf);
+       g_ptr_array_add(hostnamed_freeable, ret);
 
-       g_print("got bus, name: %s\n", name);   
+       if(gethostname(hostname_buf, MAXHOSTNAMELEN))
+               return "";
 
-       //GDBusObjectSkeleton *hostnamed_dbobj = g_dbus_object_skeleton_new("/org/freedesktop/hostname1");
+       hostname_divider = strcspn(hostname_buf, ".");
 
-       g_dbus_connection_register_object(conn,
-                                                                         "/org/freedesktop/hostname1",
-                                                                         spect_data->interfaces[0],
-                                                                         &interface_vtable,
-                                                                         NULL, NULL, NULL);
+       return strncpy(ret, hostname_buf, hostname_divider);
 }
 
-static void on_name_acquired(GDBusConnection *conn,
-                                                        const gchar *name,
-                                                        gpointer user_data) {
+const gchar *
+our_get_static_hostname() {
 
-       g_print("got name %s\n", name);
+    return "TODO";
 }
 
-static void on_name_lost(GDBusConnection *conn,
-                                                const gchar *name,
-                                                gpointer user_data) {
+const gchar *
+our_get_pretty_hostname() {
 
-       g_print("lost name %s, exiting...", name);
-       //TODO exit through g_main_loop properly...
-       exit(0);
+    return "TODO";
 }
 
-/* safe call to try and start hostnamed */
-GError * hostnamed_init() {
+const gchar *
+our_get_chassis() {
 
-       guint bus_descriptor;
-       GError *err = NULL;
-       gchar **hostnamed_ispect_xml = g_malloc(3000);
-       gchar  *hostnamed_joined_xml = g_malloc(3000);
+    return "TODO";
+}
 
-       g_file_get_contents("conf/hostnamed-ispect.xml", hostnamed_ispect_xml, NULL, err);
-       hostnamed_joined_xml = g_strjoinv("\n", hostnamed_ispect_xml);
-       spect_data = g_dbus_node_info_new_for_xml(hostnamed_joined_xml, NULL);
+const gchar *
+our_get_icon_name() {
 
-       if(!init_props())
-               return err; //TODO error
-       
-       bus_descriptor = g_bus_own_name(G_BUS_TYPE_SYSTEM,
-                                       "org.freedesktop.hostname1",
-                                                   G_BUS_NAME_OWNER_FLAGS_NONE,
-                                                   on_bus_acquired,
-                                                   on_name_acquired,
-                                                   on_name_lost,
-                                                   NULL,
-                                                   NULL);
-
-       //TODO: malloc and return reference as if a main() closed
-       return err;
+    return "TODO";
 }
 
-gboolean init_props() {
-       
-       if(init_hostname()
-               && init_static_hostname()
-               && init_pretty_hostname()
-               && init_icon_name()
-               && init_chassis()
-               && init_kernel_name()
-               && init_kernel_version()
-               && init_os_name()
-               && init_os_cpe() )
-               return TRUE;
-
-       return FALSE;
+const gchar *
+our_get_kernel_name() {
+
+    return "TODO";
 }
 
-//POSIX, for future ports try_hostname should be checked for null-termination
-gboolean init_hostname() {
+const gchar *
+our_get_kernel_version() {
 
-       gchar try_hostname[HOST_NAME_MAX];
+    return "TODO";
+}
 
-       if(!gethostname(try_hostname, HOST_NAME_MAX)) {
-               hostname = try_hostname;
-               return TRUE;
-       }
+const gchar *
+our_get_kernel_release() {
 
-       return FALSE;
+    return "TODO";
 }
 
-gboolean init_static_hostname() {
-       //TODO
-       return TRUE;
+const gchar *
+our_get_os_cpename() {
+
+    return "TODO";
 }
 
-gboolean init_pretty_hostname() {
-       //TODO
-       return TRUE;
+const gchar *
+our_get_os_pretty_name() {
+
+    return "TODO";
 }
 
-gboolean init_icon_name() {
-       //TODO
-       return TRUE;
+/* --- end method/property/dbus signal code, begin bus/name handlers --- */
+
+static void hostnamed_on_bus_acquired(GDBusConnection *conn,
+                            const gchar *name,
+                            gpointer user_data) {
+
+    g_printf("got bus/name, exporting %s's interface...\n", name);
+
+       hostnamed_interf = hostname1_skeleton_new();
+
+    /* attach function pointers to generated struct's method handlers */
+    g_signal_connect(hostnamed_interf, "handle-set-hostname", G_CALLBACK(on_handle_set_hostname), NULL);
+    g_signal_connect(hostnamed_interf, "handle-set-static-hostname", G_CALLBACK(on_handle_set_static_hostname), NULL);
+    g_signal_connect(hostnamed_interf, "handle-set-pretty-hostname", G_CALLBACK(on_handle_set_pretty_hostname), NULL);
+    g_signal_connect(hostnamed_interf, "handle-set-chassis", G_CALLBACK(on_handle_set_chassis), NULL);
+    g_signal_connect(hostnamed_interf, "handle-set-icon-name", G_CALLBACK(on_handle_set_icon_name), NULL);
+
+    /* set our properties before export */
+    hostname1_set_hostname(hostnamed_interf, our_get_hostname());
+    hostname1_set_static_hostname(hostnamed_interf, our_get_static_hostname());
+    hostname1_set_pretty_hostname(hostnamed_interf, our_get_pretty_hostname());
+    hostname1_set_chassis(hostnamed_interf, our_get_chassis());
+    hostname1_set_icon_name(hostnamed_interf, our_get_icon_name());
+    hostname1_set_kernel_name(hostnamed_interf, our_get_kernel_name());
+    hostname1_set_kernel_version(hostnamed_interf, our_get_kernel_version());
+    hostname1_set_kernel_release(hostnamed_interf, our_get_kernel_release());
+    hostname1_set_operating_system_cpename(hostnamed_interf, our_get_os_cpename());
+    hostname1_set_operating_system_pretty_name(hostnamed_interf, our_get_os_pretty_name());
+    if(!g_dbus_interface_skeleton_export(G_DBUS_INTERFACE_SKELETON(hostnamed_interf),
+                                         conn,
+                                         "/org/freedesktop/hostname1",
+                                         NULL)) {
+
+        g_printf("failed to export %s's interface!\n", name); /* unusual edge case, TODO check errno */
+               hostnamed_mem_clean();
+
+    } else {
+
+               dbus_interface_exported = TRUE;
+               g_printf("exported %s's interface on the system bus...", name);
+       }
+
 }
 
-gboolean init_chassis() {
-       //TODO
-       return TRUE;
+static void hostnamed_on_name_acquired(GDBusConnection *conn,
+                                          const gchar *name,
+                                       gpointer user_data) {
+
+    g_printf("success!\n");
 }
 
-gboolean init_kernel_name() {
-       //TODO
-       return TRUE;
+static void hostnamed_on_name_lost(GDBusConnection *conn,
+                                   const gchar *name,
+                                   gpointer user_data) {
+
+       if(!conn) {
+
+               g_printf("failed to connect to the system bus while trying to acquire name '%s': either dbus-daemon isn't running or we don't have permission to push names and/or their interfaces to it", name);
+
+               hostnamed_mem_clean();
+       }
+
+    g_printf("lost name %s, exiting...", name);
+
+    hostnamed_mem_clean();
 }
 
-gboolean init_kernel_version() {
-       //TODO
-       return TRUE;
+/* --- end bus/name handlers, begin misc unix functions --- */
+
+/* safe call to clean and then exit
+ * this stops our GMainLoop safely before letting main() return  */
+void hostnamed_mem_clean() {
+
+       g_printf("exiting...\n");
+
+       if(dbus_interface_exported)
+               g_dbus_interface_skeleton_unexport(G_DBUS_INTERFACE_SKELETON(hostnamed_interf));
+
+       if(g_main_loop_is_running(hostnamed_loop)) 
+               g_main_loop_quit(hostnamed_loop);
+
+}
+
+/* wrapper for glib's unix signal handling; called only once if terminatating signal is raised against us */
+gboolean unix_sig_terminate_handler(gpointer data) {
+
+       g_printf("caught SIGINT/HUP/TERM, exiting\n");
+
+       hostnamed_mem_clean();
+       return G_SOURCE_REMOVE; 
 }
 
-gboolean init_os_name() {
-       //TODO
-       return TRUE;
+void set_signal_handlers() {
+
+       /* we don't care about its descriptor, we never need to unregister these */
+       g_unix_signal_add(SIGINT,  unix_sig_terminate_handler, NULL);
+       g_unix_signal_add(SIGHUP,  unix_sig_terminate_handler, NULL);
+       g_unix_signal_add(SIGTERM, unix_sig_terminate_handler, NULL);
 }
 
-gboolean init_os_cpe() {
-       //TODO
-       return TRUE;
+int main() {
+       
+       set_signal_handlers();
+
+       hostnamed_loop = g_main_loop_new(NULL, TRUE);
+       hostnamed_freeable = g_ptr_array_new();
+
+       bus_descriptor = g_bus_own_name(G_BUS_TYPE_SYSTEM,
+                                   "org.freedesktop.hostname1",
+                                   G_BUS_NAME_OWNER_FLAGS_NONE,
+                                   hostnamed_on_bus_acquired,
+                                   hostnamed_on_name_acquired,
+                                   hostnamed_on_name_lost,
+                                   NULL,
+                                   NULL);
+
+       g_main_loop_run(hostnamed_loop);
+       /* runs until single g_main_loop_quit() call is raised inside <interface>_mem_clean() */
+       g_main_loop_unref(hostnamed_loop);
+
+       /* guaranteed unownable */
+       g_bus_unown_name(bus_descriptor);
+
+       /* at this point no operations can occur with our data, it is safe to free it + its container */
+       g_ptr_array_free(hostnamed_freeable, TRUE);
+
+       return 0;
 }
 
-//TODO figure out DMI variables on obsd
+/* TODO figure out DMI variables on obsd */
 /*static gchar *guess_icon_name() {
 
     gchar *filebuf = NULL;
     gchar *ret = NULL;
 
-       //TODO vm check
-
-       #if defined(__i386__) || defined(__x86_64__)
-    /*
+    #if defined(__i386__) || defined(__x86_64__)
+    
        Taken with a few minor changes from systemd's hostnamed.c,
        copyright 2011 Lennart Poettering.
 
@@ -252,7 +302,7 @@ gboolean init_os_cpe() {
        details about the values listed here:
 
        http://www.dmtf.org/sites/default/files/standards/documents/DSP0134_2.7.1.pdf
-    */   /*
+
 
     if (g_file_get_contents ("/sys/class/dmi/id/chassis_type", &filebuf, NULL, NULL)) {
         switch (g_ascii_strtoull (filebuf, NULL, 10)) {
@@ -276,9 +326,10 @@ gboolean init_os_cpe() {
             goto out;
         }
     }
-       #endif
+    #endif
     ret = g_strdup ("computer");
   out:
     g_free (filebuf);
     return ret;
 }*/
+