revamp icon/chassis determination method
[systembsd.git] / src / interfaces / hostnamed / hostnamed.c
index 3d1b3d2305d98d553ca9bae1811b5b136fcbb24f..7779870b5a46c27070477c1dd819e782ea6c0655 100644 (file)
 
 #include <unistd.h>
 #include <limits.h>
+#include <signal.h>
 
 #include <sys/param.h>
+#include <sys/sysctl.h>
+#include <string.h>
 
 #include <glib/gprintf.h>
+#include <glib-unix.h>
+/* #include <gtk/gtk.h> */
 
 #include "hostnamed-gen.h"
+#include "hostnamed.h"
+
+/* add any sysctl strings that suggest virtualization here */
+/* format: {
+ *           (1) string to be matched against runtime machine's sysctl output.
+ *               can be either the exact string or a substring contained
+ *               within sysctl strings. no "guesses" here, a match should
+ *               reliably indicate the chassis/icon. 
+ *
+ *           (2) string describing chassis type divulged by (1).
+ *               must be one of "desktop", "laptop", "server",
+ *               "tablet", "handset", "vm", "container" or NULL
+ *               if only icon string can be ascertained. "vm" refers
+ *               to operating systems running on baremetal hypervisors
+ *               (hardware virtualization, like XEN) while "container"
+ *               refers to OSs running on shared hypervisors like
+ *               virtualbox or VMware. consider the distinction carefully
+ *               as common virtualization software like KVM may share
+ *               characteristics of both "vm" and "container" types.
+ *
+ *           (3) string specifying icon to use. follows XDG icon spec.
+ *               see http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
+ *               for allowed strings.
+ *
+ *           (4) chassis precedence bit. TRUE if (2) is defined and
+ *               we're certain it is the proper string. FALSE in the
+ *               circumstance (2) may be the correct string, unless
+ *               a match with this bit set to TRUE overrides it.
+ *               if (2) is NULL, this bit is inconsequential.
+ *
+ *           (5) icon precedence bit. see previous definition.
+ *         }                                               */
+struct SYSCTL_LOOKUP_TABLE {
+    gchar    *match_string;
+    gchar    *chassis;
+    gchar    *icon;
+    gboolean chassis_precedence;
+    gboolean icon_precedence;
+};
 
 GPtrArray *hostnamed_freeable;
-GDBusNodeInfo *spect_data;
-hostnamedHostname1 *hostnamed_interf;
-
-/* begin method/property/signal code */
+Hostname1 *hostnamed_interf;
+
+GMainLoop *hostnamed_loop;
+
+guint bus_descriptor;
+gboolean dbus_interface_exported; /* reliable because of gdbus operational guarantees */
+
+gchar *CHASSIS, *ICON;
+
+/* TODO no specific vm or laptop icon in gnome
+ * NOTE paravirtualization on xen is only available for linuxes right now
+ * dmesg on linux systems reveals xen and virtualization method (HVM or PVM) 
+ * but we will worry about those later */
+const struct SYSCTL_LOOKUP_TABLE chassis_indicator_table[] =
+{
+    { "QEMU Virtual CPU",        "container", "drive-optical",   FALSE, FALSE }, /* could be QEMU running in userspace or as part of KVM */
+    { "SmartDC HVM",             "vm",        "drive-multidisk", TRUE,  TRUE  }, /* oracle solaris kvm */
+    { "VirtualBox",              "container", "drive-optical",   TRUE,  TRUE  },
+    { "VMware, Inc.",            "container", "drive-optical",   TRUE,  TRUE  },
+    { "VMware Virtual Platform", "container", "drive-optical",   TRUE,  TRUE  },
+    { "Parallels",               "container", "drive-optical",   TRUE,  TRUE  } /* need verification */
+};
+
+/*const gchar* vmstring_list[] = { 
+    "QEMU Virtual CPU",
+    "SmartDC HVM",
+    "KVM",
+    "VirtualBox"
+};*/
+
+/* --- begin method/property/dbus signal code --- */
 
-/* TODO make sure these guys only work if called by root */
 static gboolean
-on_handle_set_hostname(hostnamedHostname1 *hn1_passed_interf,
+on_handle_set_hostname(Hostname1 *hn1_passed_interf,
                        GDBusMethodInvocation *invoc,
                        const gchar *greet,
                        gpointer data) {
@@ -39,7 +109,7 @@ on_handle_set_hostname(hostnamedHostname1 *hn1_passed_interf,
 }
 
 static gboolean
-on_handle_set_static_hostname(hostnamedHostname1 *hn1_passed_interf,
+on_handle_set_static_hostname(Hostname1 *hn1_passed_interf,
                               GDBusMethodInvocation *invoc,
                               const gchar *greet,
                               gpointer data) {
@@ -47,7 +117,7 @@ on_handle_set_static_hostname(hostnamedHostname1 *hn1_passed_interf,
 }
 
 static gboolean
-on_handle_set_pretty_hostname(hostnamedHostname1 *hn1_passed_interf,
+on_handle_set_pretty_hostname(Hostname1 *hn1_passed_interf,
                               GDBusMethodInvocation *invoc,
                               const gchar *greet,
                               gpointer data) {
@@ -55,7 +125,7 @@ on_handle_set_pretty_hostname(hostnamedHostname1 *hn1_passed_interf,
 }
 
 static gboolean
-on_handle_set_chassis(hostnamedHostname1 *hn1_passed_interf,
+on_handle_set_chassis(Hostname1 *hn1_passed_interf,
                       GDBusMethodInvocation *invoc,
                       const gchar *greet,
                       gpointer data) {
@@ -63,7 +133,7 @@ on_handle_set_chassis(hostnamedHostname1 *hn1_passed_interf,
 }
 
 static gboolean
-on_handle_set_icon_name(hostnamedHostname1 *hn1_passed_interf,
+on_handle_set_icon_name(Hostname1 *hn1_passed_interf,
                         GDBusMethodInvocation *invoc,
                         const gchar *greet,
                         gpointer data) {
@@ -79,31 +149,69 @@ on_handle_set_icon_name(hostnamedHostname1 *hn1_passed_interf,
 const gchar *
 our_get_hostname() {
 
-       int hostname_try;
-       gchar *hostname_buf;
+    gchar *hostname_buf, *ret;
+    size_t hostname_divider;
 
-       hostname_buf = (gchar*) g_malloc0(MAXHOSTNAMELEN);
-       hostname_try = gethostname(hostname_buf, MAXHOSTNAMELEN);
+    hostname_buf = (gchar*) g_malloc0(MAXHOSTNAMELEN);
+    ret          = (gchar*) g_malloc0(MAXHOSTNAMELEN);
 
-       return hostname_buf;
+    g_ptr_array_add(hostnamed_freeable, hostname_buf);
+    g_ptr_array_add(hostnamed_freeable, ret);
+
+    if(gethostname(hostname_buf, MAXHOSTNAMELEN) || g_strcmp0(hostname_buf, "") == 0) 
+        return "localhost"; 
+
+    hostname_divider = strcspn(hostname_buf, ".");
+
+    return strncpy(ret, hostname_buf, hostname_divider);
 }
 
 const gchar *
 our_get_static_hostname() {
 
-    return "TODO";
+    const gchar *pretty_hostname;
+    const gchar *ret;
+
+    pretty_hostname = our_get_pretty_hostname();
+
+    if(g_strcmp0(pretty_hostname, "") == 0)
+        ret = our_get_hostname();
+
+    else if((ret = g_hostname_to_ascii(pretty_hostname))) {
+
+        g_ptr_array_add(hostnamed_freeable, (gpointer)ret);
+        return ret;
+    }
+
+    return ret;
 }
 
 const gchar *
 our_get_pretty_hostname() {
 
-    return "TODO";
+    GKeyFile *config;
+    gchar *ret;
+
+    config = g_key_file_new();
+
+    if(g_key_file_load_from_file(config, "/etc/systemd_compat.conf", G_KEY_FILE_NONE, NULL)
+        && (ret = g_key_file_get_value(config, "hostnamed", "PrettyHostname", NULL))) { /* ret might need to be freed, docs dont specify but i am suspicious */
+
+        g_key_file_unref(config);
+        return ret;
+    }
+
+    if(config)
+        g_free(config);
+
+    return "";
 }
 
 const gchar *
 our_get_chassis() {
 
-    return "TODO";
+   return "asdf";
+
 }
 
 const gchar *
@@ -142,23 +250,15 @@ our_get_os_pretty_name() {
     return "TODO";
 }
 
-/* end method/property/signal code, begin bus/name handlers */
+/* --- 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_print("got bus, name: %s\n", name);   
+    g_printf("got bus/name, exporting %s's interface...\n", name);
 
-}
-
-static void hostnamed_on_name_acquired(GDBusConnection *conn,
-                             const gchar *name,
-                             gpointer user_data) {
-
-    g_print("got '%s' on system bus\n", name);
-
-    hostnamed_interf = hostnamed_hostname1_skeleton_new();
+    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);
@@ -168,75 +268,164 @@ static void hostnamed_on_name_acquired(GDBusConnection *conn,
     g_signal_connect(hostnamed_interf, "handle-set-icon-name", G_CALLBACK(on_handle_set_icon_name), NULL);
 
     /* set our properties before export */
-    hostnamed_hostname1_set_hostname(hostnamed_interf, our_get_hostname());
-    hostnamed_hostname1_set_static_hostname(hostnamed_interf, our_get_static_hostname());
-    hostnamed_hostname1_set_pretty_hostname(hostnamed_interf, our_get_pretty_hostname());
-    hostnamed_hostname1_set_chassis(hostnamed_interf, our_get_chassis());
-    hostnamed_hostname1_set_icon_name(hostnamed_interf, our_get_icon_name());
-    hostnamed_hostname1_set_kernel_name(hostnamed_interf, our_get_kernel_name());
-    hostnamed_hostname1_set_kernel_version(hostnamed_interf, our_get_kernel_version());
-    hostnamed_hostname1_set_kernel_release(hostnamed_interf, our_get_kernel_release());
-    hostnamed_hostname1_set_operating_system_cpename(hostnamed_interf, our_get_os_cpename());
-    hostnamed_hostname1_set_operating_system_pretty_name(hostnamed_interf, our_get_os_pretty_name());
+    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)) {
+                                         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...\n", name);
+    }
+}
+
+static void hostnamed_on_name_acquired(GDBusConnection *conn,
+                                       const gchar *name,
+                                       gpointer user_data) {
+
+    g_printf("success!\n");
+}
 
-        g_printf("failed to export hostname1's interface on system bus!");
+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.\n", name);
+        hostnamed_mem_clean();
     }
 
+    g_printf("lost name %s, exiting...\n", name);
+
+    hostnamed_mem_clean();
 }
 
-/* free()'s */
+/* --- 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_ptr_array_foreach(hostnamed_freeable, (GFunc) g_free, NULL);
+    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);
+
 }
 
-static void hostnamed_on_name_lost(GDBusConnection *conn,
-                         const gchar *name,
-                         gpointer user_data) {
+/* 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_print("lost name %s, exiting...", name);
+    g_printf("caught SIGINT/HUP/TERM, exiting\n");
 
     hostnamed_mem_clean();
-    g_dbus_interface_skeleton_unexport(G_DBUS_INTERFACE_SKELETON(hostnamed_interf));
+    return G_SOURCE_REMOVE; 
+}
+
+void set_signal_handlers() {
 
-    /* TODO exit through g_main_loop properly... */
+    /* 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);
+
+    /* TODO: the "only once" guarantee only counts towards specific signals.
+     *       make sure calling a SIGINT and SIGHUP doesn't cause term_handler()
+     *       to be called twice */
 }
 
-/* safe call to try and start hostnamed */
-void hostnamed_init() {
+int main() {
+    
+    set_signal_handlers();
 
-    guint bus_descriptor;
+    if(!build_chassis_table() || !determine_chassis_and_icon())
+        return 1;
+    
+    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);
-
-    /* TODO: malloc and return reference as if a main() closed */
+                                   "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;
 }
 
-int main() {
+static gboolean build_chassis_table() {
+   return TRUE; 
+}
+
+gboolean determine_chassis_and_icon() {
+
+    char *hwproduct, *hwmodel, *hwvendor;
+    size_t hwproduct_size, hwmodel_size, hwvendor_size;
+    int hwproduct_name[2], hwmodel_name[2], hwvendor_name[2];
+    unsigned int i;
+
+    hwproduct_name[0] = CTL_HW;
+    hwproduct_name[1] = HW_PRODUCT;
 
-       GMainLoop *hostnamed_loop;
-       hostnamed_loop = g_main_loop_new(NULL, TRUE);
+    hwmodel_name[0] = CTL_HW;
+    hwmodel_name[1] = HW_MODEL;
 
-       /* config stuff here */
+    hwvendor_name[0] = CTL_HW;
+    hwvendor_name[1] = HW_VENDOR;
 
+    /* pass NULL buffer to check size first, then pass hw to be filled according to freshly-set hw_size */
+    if(-1 == sysctl(hwproduct_name, 2, NULL, &hwproduct_size, NULL, 0) || -1 == sysctl(hwproduct_name, 2, hwproduct, &hwproduct_size, NULL, 0))
+        return FALSE;
+
+    if(-1 == sysctl(hwmodel_name, 2, NULL, &hwmodel_size, NULL, 0) || -1 == sysctl(hwmodel_name, 2, hwmodel, &hwmodel_size, NULL, 0))
+        return FALSE;
+    if(-1 == sysctl(hwvendor_name, 2, NULL, &hwvendor_size, NULL, 0) || -1 == sysctl(hwvendor_name, 2, hwvendor, &hwvendor_size, NULL, 0))
+        return FALSE;
+
+    /* TODO: test for laptop, if not, dmidecode for desktop vs. server
+     *       probably move this code to vm test func and set a global after running it early, once */
+    for(; i < G_N_ELEMENTS(chassis_indicator_table); i++)
+        
+        /* if(strcasestr(sysctl_string, vmstring_list[i]))
+            return (CHASSIS = ) ? TRUE : FALSE; */
 
-       hostnamed_init();
-       g_main_loop_run(hostnamed_loop);
-       g_main_loop_unref(hostnamed_loop);
+         return FALSE;
 
-       return 0;
+    return TRUE; /* temp */
 }
 
 /* TODO figure out DMI variables on obsd */