Save 'disk' scope devices to a system-wide database

This also means we add the permanent devices on daemon startup
and apply any saved properties like 'Model' and 'Type'.

1 files changed, 487 insertions, 0 deletions

diff --git a/src/cd-device-db.c b/src/cd-device-db.c
new file mode 100644
index 0000000..0b865f3
--- /dev/null
+++ b/src/cd-device-db.c
@@ -0,0 +1,487 @@
+/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
+ *
+ * Copyright (C) 2010 Richard Hughes <richard@hughsie.com>
+ *
+ * Licensed under the GNU General Public License Version 2
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#include "config.h"
+
+#include <gio/gio.h>
+#include <glib-object.h>
+#include <sqlite3.h>
+
+#include "cd-common.h"
+#include "cd-device-db.h"
+
+static void     cd_device_db_finalize	(GObject        *object);
+
+#define CD_DEVICE_DB_GET_PRIVATE(o) (G_TYPE_INSTANCE_GET_PRIVATE ((o), CD_TYPE_DEVICE_DB, CdDeviceDbPrivate))
+
+struct CdDeviceDbPrivate
+{
+	sqlite3			*db;
+};
+
+static gpointer cd_device_db_object = NULL;
+
+G_DEFINE_TYPE (CdDeviceDb, cd_device_db, G_TYPE_OBJECT)
+
+/**
+ * cd_device_db_load:
+ **/
+gboolean  
+cd_device_db_load (CdDeviceDb *ddb,
+		    const gchar *filename,
+		    GError  **error)
+{
+	const gchar *statement;
+	gboolean ret = TRUE;
+	gchar *error_msg = NULL;
+	gchar *path = NULL;
+	gint rc;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db == NULL, FALSE);
+
+	/* ensure the path exists */
+	path = g_path_get_dirname (filename);
+	ret = cd_main_mkdir_with_parents (path, error);
+	if (!ret)
+		goto out;
+
+	g_debug ("trying to open database '%s'", filename);
+	rc = sqlite3_open (filename, &ddb->priv->db);
+	if (rc != SQLITE_OK) {
+		ret = FALSE;
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "Can't open database: %s\n",
+			     sqlite3_errmsg (ddb->priv->db));
+		sqlite3_close (ddb->priv->db);
+		goto out;
+	}
+
+	/* we don't need to keep doing fsync */
+	sqlite3_exec (ddb->priv->db, "PRAGMA synchronous=OFF",
+		      NULL, NULL, NULL);
+
+	/* check devices */
+	rc = sqlite3_exec (ddb->priv->db, "SELECT * FROM devices LIMIT 1",
+			   NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		g_debug ("creating table to repair: %s", error_msg);
+		sqlite3_free (error_msg);
+		statement = "CREATE TABLE devices ("
+			    "device_id TEXT PRIMARY KEY,"
+			    "device TEXT);";
+		sqlite3_exec (ddb->priv->db, statement, NULL, NULL, NULL);
+		statement = "CREATE TABLE properties ("
+			    "device_id TEXT,"
+			    "property TEXT,"
+			    "value TEXT);";
+		sqlite3_exec (ddb->priv->db, statement, NULL, NULL, NULL);
+	}
+out:
+	g_free (path);
+	return ret;
+}
+
+/**
+ * cd_device_db_empty:
+ **/
+gboolean  
+cd_device_db_empty (CdDeviceDb *ddb,
+		     GError  **error)
+{
+	const gchar *statement;
+	gboolean ret = TRUE;
+	gchar *error_msg = NULL;
+	gint rc;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	statement = "DELETE FROM devices;DELETE FROM properties;";
+	rc = sqlite3_exec (ddb->priv->db, statement,
+			   NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		ret = FALSE;
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		goto out;
+	}
+out:
+	return ret;
+}
+
+/**
+ * cd_device_db_add:
+ **/
+gboolean  
+cd_device_db_add (CdDeviceDb *ddb,
+		   const gchar *device_id,
+		   GError  **error)
+{
+	gboolean ret = TRUE;
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	g_debug ("add device %s", device_id);
+	statement = g_strdup_printf ("INSERT INTO devices (device_id) "
+				     "VALUES ('%s')",
+				     device_id);
+
+	/* insert the entry */
+	rc = sqlite3_exec (ddb->priv->db, statement, NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		ret = FALSE;
+		goto out;
+	}
+out:
+	g_free (statement);
+	return ret;
+}
+
+/**
+ * cd_device_db_set_property:
+ **/
+gboolean  
+cd_device_db_set_property (CdDeviceDb *ddb,
+			   const gchar *device_id,
+			   const gchar *property,
+			   const gchar *value,
+			   GError  **error)
+{
+	gboolean ret = TRUE;
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	g_debug ("add device %s [%s=%s]", device_id, property, value);
+	statement = g_strdup_printf ("INSERT INTO properties (device_id, "
+				     "property, value) "
+				     "VALUES ('%s', '%s', '%s')",
+				     device_id, property, value);
+
+	/* insert the entry */
+	rc = sqlite3_exec (ddb->priv->db, statement, NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		ret = FALSE;
+		goto out;
+	}
+out:
+	g_free (statement);
+	return ret;
+}
+
+/**
+ * cd_device_db_remove:
+ **/
+gboolean  
+cd_device_db_remove (CdDeviceDb *ddb,
+		     const gchar *device_id,
+		     GError  **error)
+{
+	gboolean ret = TRUE;
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	/* remove the entry */
+	g_debug ("remove device %s", device_id);
+	statement = g_strdup_printf ("DELETE FROM devices WHERE "
+				     "device_id = '%s';",
+				     device_id);
+	rc = sqlite3_exec (ddb->priv->db, statement, NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		ret = FALSE;
+		goto out;
+	}
+	statement = g_strdup_printf ("DELETE FROM properties WHERE "
+				     "device_id = '%s';",
+				     device_id);
+	rc = sqlite3_exec (ddb->priv->db, statement, NULL, NULL, &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		ret = FALSE;
+		goto out;
+	}
+out:
+	g_free (statement);
+	return ret;
+}
+
+/**
+ * cd_device_db_sqlite_cb:
+ **/
+static gint
+cd_device_db_sqlite_cb (void *data,
+			gint argc,
+			gchar **argv,
+			gchar **col_name)
+{
+	GPtrArray *array = (GPtrArray *) data;
+
+	/* should only be one entry */
+	g_debug ("adding %s", argv[0]);
+	g_ptr_array_add (array, g_strdup (argv[0]));
+	return 0;
+}
+
+/**
+ * cd_device_db_get_property:
+ **/
+gchar *
+cd_device_db_get_property (CdDeviceDb *ddb,
+			   const gchar *device_id,
+			   const gchar *property,
+			   GError  **error)
+{
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+	GPtrArray *array_tmp = NULL;
+	gchar *value = NULL;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	g_debug ("get property %s for %s", property, device_id);
+	statement = g_strdup_printf ("SELECT value FROM properties WHERE "
+				     "device_id = '%s' AND "
+				     "property = '%s' LIMIT 1;",
+				     device_id, property);
+
+	/* remove the entry */
+	array_tmp = g_ptr_array_new_with_free_func (g_free);
+	rc = sqlite3_exec (ddb->priv->db,
+			   statement,
+			   cd_device_db_sqlite_cb,
+			   array_tmp,
+			   &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		goto out;
+	}
+
+	/* never set */
+	if (array_tmp->len == 0) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "no such property %s for %s",
+			     property, device_id);
+		goto out;
+	}
+
+	/* success */
+	value = g_strdup (g_ptr_array_index (array_tmp, 0));
+out:
+	g_ptr_array_unref (array_tmp);
+	g_free (statement);
+	return value;
+}
+
+/**
+ * cd_device_db_get_devices:
+ **/
+GPtrArray *
+cd_device_db_get_devices (CdDeviceDb *ddb,
+			  GError  **error)
+{
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+	GPtrArray *array = NULL;
+	GPtrArray *array_tmp = NULL;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	/* get all the devices */
+	g_debug ("get devices");
+	statement = g_strdup_printf ("SELECT device_id FROM devices;");
+	array_tmp = g_ptr_array_new_with_free_func (g_free);
+	rc = sqlite3_exec (ddb->priv->db,
+			   statement,
+			   cd_device_db_sqlite_cb,
+			   array_tmp,
+			   &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		goto out;
+	}
+
+	/* success */
+	array = g_ptr_array_ref (array_tmp);
+out:
+	g_ptr_array_unref (array_tmp);
+	g_free (statement);
+	return array;
+}
+
+/**
+ * cd_device_db_get_properties:
+ **/
+GPtrArray *
+cd_device_db_get_properties (CdDeviceDb *ddb,
+			     const gchar *device_id,
+			     GError  **error)
+{
+	gchar *error_msg = NULL;
+	gchar *statement;
+	gint rc;
+	GPtrArray *array = NULL;
+	GPtrArray *array_tmp = NULL;
+
+	g_return_val_if_fail (CD_IS_DEVICE_DB (ddb), FALSE);
+	g_return_val_if_fail (ddb->priv->db != NULL, FALSE);
+
+	/* get all the devices */
+	g_debug ("get properties for device %s", device_id);
+	statement = g_strdup_printf ("SELECT property FROM properties "
+				     "WHERE device_id = '%s';",
+				     device_id);
+	array_tmp = g_ptr_array_new_with_free_func (g_free);
+	rc = sqlite3_exec (ddb->priv->db,
+			   statement,
+			   cd_device_db_sqlite_cb,
+			   array_tmp,
+			   &error_msg);
+	if (rc != SQLITE_OK) {
+		g_set_error (error,
+			     CD_MAIN_ERROR,
+			     CD_MAIN_ERROR_FAILED,
+			     "SQL error: %s",
+			     error_msg);
+		sqlite3_free (error_msg);
+		goto out;
+	}
+
+	/* success */
+	array = g_ptr_array_ref (array_tmp);
+out:
+	g_ptr_array_unref (array_tmp);
+	g_free (statement);
+	return array;
+}
+
+/**
+ * cd_device_db_class_init:
+ * @klass: The CdDeviceDbClass
+ **/
+static void
+cd_device_db_class_init (CdDeviceDbClass *klass)
+{
+	GObjectClass *object_class = G_OBJECT_CLASS (klass);
+	object_class->finalize = cd_device_db_finalize;
+	g_type_class_add_private (klass, sizeof (CdDeviceDbPrivate));
+}
+
+/**
+ * cd_device_db_init:
+ **/
+static void
+cd_device_db_init (CdDeviceDb *ddb)
+{
+	ddb->priv = CD_DEVICE_DB_GET_PRIVATE (ddb);
+}
+
+/**
+ * cd_device_db_finalize:
+ * @object: The object to finalize
+ **/
+static void
+cd_device_db_finalize (GObject *object)
+{
+	CdDeviceDb *ddb;
+	g_return_if_fail (CD_IS_DEVICE_DB (object));
+	ddb = CD_DEVICE_DB (object);
+	g_return_if_fail (ddb->priv != NULL);
+
+	/* close the database */
+	sqlite3_close (ddb->priv->db);
+
+	G_OBJECT_CLASS (cd_device_db_parent_class)->finalize (object);
+}
+
+/**
+ * cd_device_db_new:
+ *
+ * Return value: a new CdDeviceDb object.
+ **/
+CdDeviceDb *
+cd_device_db_new (void)
+{
+	if (cd_device_db_object != NULL) {
+		g_object_ref (cd_device_db_object);
+	} else {
+		cd_device_db_object = g_object_new (CD_TYPE_DEVICE_DB, NULL);
+		g_object_add_weak_pointer (cd_device_db_object, &cd_device_db_object);
+	}
+	return CD_DEVICE_DB (cd_device_db_object);
+}
+