/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- * * Copyright (C) 2010-2011 Richard Hughes * * 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 #include #include #include #include #include "cd-common.h" #include "cd-mapping-db.h" static void cd_mapping_db_finalize (GObject *object); #define GET_PRIVATE(o) (cd_mapping_db_get_instance_private (o)) typedef struct { sqlite3 *db; } CdMappingDbPrivate; static gpointer cd_mapping_db_object = NULL; G_DEFINE_TYPE_WITH_PRIVATE (CdMappingDb, cd_mapping_db, G_TYPE_OBJECT) static gint cd_mapping_db_convert_cb (void *data, gint argc, gchar **argv, gchar **col_name) { CdMappingDb *mdb = (CdMappingDb *) data; CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gchar *statement; gint rc; statement = sqlite3_mprintf ("INSERT INTO mappings_v2 (device, profile, timestamp) " "VALUES ('%q', '%q', '%q')", argv[0], argv[1], argv[2]); rc = sqlite3_exec (priv->db, statement, NULL, NULL, NULL); sqlite3_free (statement); return rc; } static gboolean cd_mapping_db_open (CdMappingDb *mdb, const gchar *filename, gboolean retry, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gchar *error_msg = NULL; gint rc; g_autofree gchar *path = NULL; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db == NULL, FALSE); /* ensure the path exists */ path = g_path_get_dirname (filename); if (!cd_main_mkdir_with_parents (path, error)) return FALSE; g_debug ("CdMappingDb: trying to open database '%s'", filename); g_info ("Using mapping database file %s", filename); rc = sqlite3_open (filename, &priv->db); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Can't open database: %s\n", sqlite3_errmsg (priv->db)); sqlite3_close (priv->db); return FALSE; } /* sanity check of the database */ rc = sqlite3_exec (priv->db, "PRAGMA quick_check", NULL, NULL, &error_msg); if (rc != SQLITE_OK) { /* Database appears to be mangled, so wipe it and try again */ sqlite3_close (priv->db); priv->db = NULL; if (retry) { if (g_unlink (filename) != 0) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Cannot remove damaged database: %s", g_strerror (errno)); return FALSE; } return cd_mapping_db_open (mdb, filename, FALSE, error); } else { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Cannot open mapping database: %s", error_msg); sqlite3_free (error_msg); return FALSE; } } return TRUE; } gboolean cd_mapping_db_load (CdMappingDb *mdb, const gchar *filename, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); const gchar *statement; gchar *error_msg = NULL; gint rc; g_autofree gchar *path = NULL; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db == NULL, FALSE); if (!cd_mapping_db_open (mdb, filename, TRUE, error)) return FALSE; /* we don't need to keep doing fsync */ rc = sqlite3_exec (priv->db, "PRAGMA synchronous=OFF", NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Failed to turn off synchronous operations: SQL error: %s", error_msg); sqlite3_free (error_msg); return FALSE; } /* check mappings */ rc = sqlite3_exec (priv->db, "SELECT * FROM mappings LIMIT 1", NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_debug ("CdMappingDb: creating table to repair: %s", error_msg); sqlite3_free (error_msg); statement = "CREATE TABLE mappings (" "timestamp INTEGER DEFAULT 0," "device TEXT," "profile TEXT);"; sqlite3_exec (priv->db, statement, NULL, NULL, NULL); } /* check mappings has timestamp (since 0.1.8) */ rc = sqlite3_exec (priv->db, "SELECT timestamp FROM mappings LIMIT 1", NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_debug ("CdMappingDb: altering table to repair: %s", error_msg); sqlite3_free (error_msg); statement = "ALTER TABLE mappings ADD COLUMN timestamp INTEGER DEFAULT 0;"; sqlite3_exec (priv->db, statement, NULL, NULL, NULL); } /* check mappings version 2 exists (since 0.1.29) */ rc = sqlite3_exec (priv->db, "SELECT * FROM mappings_v2 LIMIT 1", NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_debug ("CdMappingDb: altering table to convert: %s", error_msg); sqlite3_free (error_msg); statement = "CREATE TABLE mappings_v2 (" "timestamp INTEGER DEFAULT 0," "device TEXT," "profile TEXT," "PRIMARY KEY (device, profile));"; sqlite3_exec (priv->db, statement, NULL, NULL, NULL); /* copy all the mapping data from v1 to v2 */ statement = "SELECT device, profile, timestamp FROM mappings;"; rc = sqlite3_exec (priv->db, statement, cd_mapping_db_convert_cb, mdb, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Failed to migrate mappings: SQL error: %s", error_msg); sqlite3_free (error_msg); return FALSE; } /* remove old table data */ statement = "DELETE FROM mappings;"; rc = sqlite3_exec (priv->db, statement, NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "Failed to migrate mappings: SQL error: %s", error_msg); sqlite3_free (error_msg); return FALSE; } } return TRUE; } gboolean cd_mapping_db_empty (CdMappingDb *mdb, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); const gchar *statement; gchar *error_msg = NULL; gint rc; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db != NULL, FALSE); statement = "DELETE FROM mappings_v2;"; rc = sqlite3_exec (priv->db, statement, NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); return FALSE; } return TRUE; } gboolean cd_mapping_db_add (CdMappingDb *mdb, const gchar *device_id, const gchar *profile_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gboolean ret = TRUE; gchar *error_msg = NULL; gchar *statement; gint rc; gint64 timestamp; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db != NULL, FALSE); g_debug ("CdMappingDb: add %s<=>%s", device_id, profile_id); timestamp = g_get_real_time (); statement = sqlite3_mprintf ("INSERT OR REPLACE INTO mappings_v2 (device, profile, timestamp) " "VALUES ('%q', '%q', %"G_GINT64_FORMAT")", device_id, profile_id, timestamp); /* insert the entry */ rc = sqlite3_exec (priv->db, statement, NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); ret = FALSE; goto out; } out: sqlite3_free (statement); return ret; } /** * cd_mapping_db_clear_timestamp: * * Setting a timestamp to zero means that the soft-auto-add should not * be done as the user has explicitly removed it. * * If the mapping does not exist then it will be automatically added. **/ gboolean cd_mapping_db_clear_timestamp (CdMappingDb *mdb, const gchar *device_id, const gchar *profile_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gboolean ret = TRUE; gchar *error_msg = NULL; gchar *statement; gint rc; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db != NULL, FALSE); g_debug ("CdMappingDb: clearing timestamp %s<=>%s", device_id, profile_id); statement = sqlite3_mprintf ("INSERT OR REPLACE INTO mappings_v2 (device, profile, timestamp) " "VALUES ('%q', '%q', 0);", device_id, profile_id); /* update the entry */ rc = sqlite3_exec (priv->db, statement, NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); ret = FALSE; goto out; } out: sqlite3_free (statement); return ret; } /** * cd_mapping_db_remove: * * You probably don't want to use this function. See the related * cd_mapping_db_clear_timestamp() for more details. **/ gboolean cd_mapping_db_remove (CdMappingDb *mdb, const gchar *device_id, const gchar *profile_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gboolean ret = TRUE; gchar *error_msg = NULL; gchar *statement; gint rc; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), FALSE); g_return_val_if_fail (priv->db != NULL, FALSE); g_debug ("CdMappingDb: remove %s<=>%s", device_id, profile_id); statement = sqlite3_mprintf ("DELETE FROM mappings_v2 WHERE " "device = '%q' AND profile = '%q';", device_id, profile_id); /* remove the entry */ rc = sqlite3_exec (priv->db, statement, NULL, NULL, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); ret = FALSE; goto out; } out: sqlite3_free (statement); return ret; } static gint cd_mapping_db_sqlite_cb (void *data, gint argc, gchar **argv, gchar **col_name) { GPtrArray *array = (GPtrArray *) data; /* should only be one entry */ g_debug ("CdMappingDb: got sql entry %s", argv[0]); g_ptr_array_add (array, g_strdup (argv[0])); return 0; } /** * cd_mapping_db_get_profiles: * * The returned values are returned with the oldest assigned profile in * the first position and the newest assigned profile in last posision. **/ GPtrArray * cd_mapping_db_get_profiles (CdMappingDb *mdb, const gchar *device_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gchar *error_msg = NULL; gchar *statement; gint rc; GPtrArray *array = NULL; g_autoptr(GPtrArray) array_tmp = NULL; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), NULL); g_return_val_if_fail (priv->db != NULL, NULL); g_debug ("CdMappingDb: get profiles for %s", device_id); statement = sqlite3_mprintf ("SELECT profile FROM mappings_v2 WHERE " "device = '%q' AND timestamp > 0 " "ORDER BY timestamp ASC;", device_id); /* remove the entry */ array_tmp = g_ptr_array_new_with_free_func (g_free); rc = sqlite3_exec (priv->db, statement, cd_mapping_db_sqlite_cb, array_tmp, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); goto out; } /* success */ array = g_ptr_array_ref (array_tmp); out: sqlite3_free (statement); return array; } /** * cd_mapping_db_get_devices: * * The returned values are returned with the oldest assigned profile in * the first position and the newest assigned profile in last posision. **/ GPtrArray * cd_mapping_db_get_devices (CdMappingDb *mdb, const gchar *profile_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gchar *error_msg = NULL; gchar *statement; gint rc; GPtrArray *array = NULL; g_autoptr(GPtrArray) array_tmp = NULL; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), NULL); g_return_val_if_fail (priv->db != NULL, NULL); g_debug ("CdMappingDb: get devices for %s", profile_id); statement = sqlite3_mprintf ("SELECT device FROM mappings_v2 WHERE " "profile = '%q' AND timestamp > 0 " "ORDER BY timestamp ASC;", profile_id); /* remove the entry */ array_tmp = g_ptr_array_new_with_free_func (g_free); rc = sqlite3_exec (priv->db, statement, cd_mapping_db_sqlite_cb, array_tmp, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); goto out; } /* success */ array = g_ptr_array_ref (array_tmp); out: sqlite3_free (statement); return array; } static gint cd_mapping_db_sqlite_timestamp_cb (void *data, gint argc, gchar **argv, gchar **col_name) { guint64 *timestamp = (guint64 *) data; /* should only be one entry */ g_debug ("CdMappingDb: got sql entry %s", argv[0]); *timestamp = g_ascii_strtoull (argv[0], NULL, 10); return 0; } /** * cd_mapping_db_get_timestamp: * * Gets when the profile was added to the device. * * Return value: %G_MAXUINT64 for error or not found **/ guint64 cd_mapping_db_get_timestamp (CdMappingDb *mdb, const gchar *device_id, const gchar *profile_id, GError **error) { CdMappingDbPrivate *priv = GET_PRIVATE (mdb); gchar *error_msg = NULL; gchar *statement; gint rc; guint64 timestamp = G_MAXUINT64; g_return_val_if_fail (CD_IS_MAPPING_DB (mdb), G_MAXUINT64); g_return_val_if_fail (priv->db != NULL, G_MAXUINT64); g_debug ("CdMappingDb: get checksum for %s<->%s", device_id, profile_id); statement = sqlite3_mprintf ("SELECT timestamp FROM mappings_v2 WHERE " "device = '%q' AND profile = '%q' " "LIMIT 1;", device_id, profile_id); /* query the checksum */ rc = sqlite3_exec (priv->db, statement, cd_mapping_db_sqlite_timestamp_cb, ×tamp, &error_msg); if (rc != SQLITE_OK) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "SQL error: %s", error_msg); sqlite3_free (error_msg); goto out; } /* nothing found */ if (timestamp == G_MAXUINT64) { g_set_error (error, CD_CLIENT_ERROR, CD_CLIENT_ERROR_INTERNAL, "device and profile %s<>%s not found", device_id, profile_id); goto out; } out: sqlite3_free (statement); return timestamp; } static void cd_mapping_db_class_init (CdMappingDbClass *klass) { GObjectClass *object_class = G_OBJECT_CLASS (klass); object_class->finalize = cd_mapping_db_finalize; } static void cd_mapping_db_init (CdMappingDb *mdb) { } static void cd_mapping_db_finalize (GObject *object) { CdMappingDb *mdb = CD_MAPPING_DB (object); CdMappingDbPrivate *priv = GET_PRIVATE (mdb); /* close the database */ sqlite3_close (priv->db); G_OBJECT_CLASS (cd_mapping_db_parent_class)->finalize (object); } CdMappingDb * cd_mapping_db_new (void) { if (cd_mapping_db_object != NULL) { g_object_ref (cd_mapping_db_object); } else { cd_mapping_db_object = g_object_new (CD_TYPE_MAPPING_DB, NULL); g_object_add_weak_pointer (cd_mapping_db_object, &cd_mapping_db_object); } return CD_MAPPING_DB (cd_mapping_db_object); }