1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
* soup-cookie-jar-db.c: database-based cookie storage
*
* Using danw's soup-cookie-jar-text as template
* Copyright (C) 2008 Diego Escalante Urrelo
* Copyright (C) 2009 Collabora Ltd.
*/
#ifdef HAVE_CONFIG_H
#include <config.h>
#endif
#include <stdlib.h>
#include <sqlite3.h>
#include "soup-cookie-jar-db.h"
#include "soup.h"
/**
* SECTION:soup-cookie-jar-db
* @short_description: Database-based Cookie Jar
*
* #SoupCookieJarDB is a #SoupCookieJar that reads cookies from and
* writes them to a sqlite database in the new Mozilla format.
*
* (This is identical to <literal>SoupCookieJarSqlite</literal> in
* libsoup-gnome; it has just been moved into libsoup proper, and
* renamed to avoid conflicting.)
**/
enum {
PROP_0,
PROP_FILENAME,
LAST_PROP
};
typedef struct {
char *filename;
sqlite3 *db;
} SoupCookieJarDBPrivate;
G_DEFINE_TYPE_WITH_PRIVATE (SoupCookieJarDB, soup_cookie_jar_db, SOUP_TYPE_COOKIE_JAR)
static void load (SoupCookieJar *jar);
static void
soup_cookie_jar_db_init (SoupCookieJarDB *db)
{
}
static void
soup_cookie_jar_db_finalize (GObject *object)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (object));
g_free (priv->filename);
g_clear_pointer (&priv->db, sqlite3_close);
G_OBJECT_CLASS (soup_cookie_jar_db_parent_class)->finalize (object);
}
static void
soup_cookie_jar_db_set_property (GObject *object, guint prop_id,
const GValue *value, GParamSpec *pspec)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (object));
switch (prop_id) {
case PROP_FILENAME:
priv->filename = g_value_dup_string (value);
load (SOUP_COOKIE_JAR (object));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
soup_cookie_jar_db_get_property (GObject *object, guint prop_id,
GValue *value, GParamSpec *pspec)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (object));
switch (prop_id) {
case PROP_FILENAME:
g_value_set_string (value, priv->filename);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
/**
* soup_cookie_jar_db_new:
* @filename: the filename to read to/write from, or %NULL
* @read_only: %TRUE if @filename is read-only
*
* Creates a #SoupCookieJarDB.
*
* @filename will be read in at startup to create an initial set of
* cookies. If @read_only is %FALSE, then the non-session cookies will
* be written to @filename when the 'changed' signal is emitted from
* the jar. (If @read_only is %TRUE, then the cookie jar will only be
* used for this session, and changes made to it will be lost when the
* jar is destroyed.)
*
* Return value: the new #SoupCookieJar
*
* Since: 2.42
**/
SoupCookieJar *
soup_cookie_jar_db_new (const char *filename, gboolean read_only)
{
g_return_val_if_fail (filename != NULL, NULL);
return g_object_new (SOUP_TYPE_COOKIE_JAR_DB,
SOUP_COOKIE_JAR_DB_FILENAME, filename,
SOUP_COOKIE_JAR_READ_ONLY, read_only,
NULL);
}
#define QUERY_ALL "SELECT id, name, value, host, path, expiry, lastAccessed, isSecure, isHttpOnly, sameSite FROM moz_cookies;"
#define CREATE_TABLE "CREATE TABLE moz_cookies (id INTEGER PRIMARY KEY, name TEXT, value TEXT, host TEXT, path TEXT, expiry INTEGER, lastAccessed INTEGER, isSecure INTEGER, isHttpOnly INTEGER, sameSite INTEGER)"
#define QUERY_INSERT "INSERT INTO moz_cookies VALUES(NULL, %Q, %Q, %Q, %Q, %d, NULL, %d, %d, %d);"
#define QUERY_DELETE "DELETE FROM moz_cookies WHERE name=%Q AND host=%Q;"
enum {
COL_ID,
COL_NAME,
COL_VALUE,
COL_HOST,
COL_PATH,
COL_EXPIRY,
COL_LAST_ACCESS,
COL_SECURE,
COL_HTTP_ONLY,
COL_SAME_SITE_POLICY,
N_COL,
};
static int
callback (void *data, int argc, char **argv, char **colname)
{
SoupCookie *cookie = NULL;
SoupCookieJar *jar = SOUP_COOKIE_JAR (data);
char *name, *value, *host, *path;
gulong expire_time;
time_t now;
int max_age;
gboolean http_only = FALSE, secure = FALSE;
SoupSameSitePolicy same_site_policy;
now = time (NULL);
name = argv[COL_NAME];
value = argv[COL_VALUE];
host = argv[COL_HOST];
path = argv[COL_PATH];
expire_time = strtoul (argv[COL_EXPIRY], NULL, 10);
if (now >= expire_time)
return 0;
max_age = (expire_time - now <= G_MAXINT ? expire_time - now : G_MAXINT);
http_only = (g_strcmp0 (argv[COL_HTTP_ONLY], "1") == 0);
secure = (g_strcmp0 (argv[COL_SECURE], "1") == 0);
same_site_policy = g_ascii_strtoll (argv[COL_SAME_SITE_POLICY], NULL, 0);
cookie = soup_cookie_new (name, value, host, path, max_age);
if (secure)
soup_cookie_set_secure (cookie, TRUE);
if (http_only)
soup_cookie_set_http_only (cookie, TRUE);
if (same_site_policy)
soup_cookie_set_same_site_policy (cookie, same_site_policy);
soup_cookie_jar_add_cookie (jar, cookie);
return 0;
}
static void
try_create_table (sqlite3 *db)
{
char *error = NULL;
if (sqlite3_exec (db, CREATE_TABLE, NULL, NULL, &error)) {
g_warning ("Failed to execute query: %s", error);
sqlite3_free (error);
}
}
static void
exec_query_with_try_create_table (sqlite3 *db,
const char *sql,
int (*callback)(void*,int,char**,char**),
void *argument)
{
char *error = NULL;
gboolean try_create = TRUE;
try_exec:
if (sqlite3_exec (db, sql, callback, argument, &error)) {
if (try_create) {
try_create = FALSE;
try_create_table (db);
sqlite3_free (error);
error = NULL;
goto try_exec;
} else {
g_warning ("Failed to execute query: %s", error);
sqlite3_free (error);
}
}
}
/* Follows sqlite3 convention; returns TRUE on error */
static gboolean
open_db (SoupCookieJar *jar)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (jar));
char *error = NULL;
if (sqlite3_open (priv->filename, &priv->db)) {
sqlite3_close (priv->db);
priv->db = NULL;
g_warning ("Can't open %s", priv->filename);
return TRUE;
}
if (sqlite3_exec (priv->db, "PRAGMA synchronous = OFF; PRAGMA secure_delete = 1;", NULL, NULL, &error)) {
g_warning ("Failed to execute query: %s", error);
sqlite3_free (error);
}
/* Migrate old DB to include same-site info. We simply always run this as it
will safely handle a column with the same name existing */
sqlite3_exec (priv->db, "ALTER TABLE moz_cookies ADD COLUMN sameSite INTEGER DEFAULT 0", NULL, NULL, NULL);
return FALSE;
}
static void
load (SoupCookieJar *jar)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (jar));
if (priv->db == NULL) {
if (open_db (jar))
return;
}
exec_query_with_try_create_table (priv->db, QUERY_ALL, callback, jar);
}
static void
soup_cookie_jar_db_changed (SoupCookieJar *jar,
SoupCookie *old_cookie,
SoupCookie *new_cookie)
{
SoupCookieJarDBPrivate *priv =
soup_cookie_jar_db_get_instance_private (SOUP_COOKIE_JAR_DB (jar));
char *query;
if (priv->db == NULL) {
if (open_db (jar))
return;
}
if (old_cookie) {
query = sqlite3_mprintf (QUERY_DELETE,
old_cookie->name,
old_cookie->domain);
exec_query_with_try_create_table (priv->db, query, NULL, NULL);
sqlite3_free (query);
}
if (new_cookie && new_cookie->expires) {
gulong expires;
expires = (gulong)soup_date_to_time_t (new_cookie->expires);
query = sqlite3_mprintf (QUERY_INSERT,
new_cookie->name,
new_cookie->value,
new_cookie->domain,
new_cookie->path,
expires,
new_cookie->secure,
new_cookie->http_only,
soup_cookie_get_same_site_policy (new_cookie));
exec_query_with_try_create_table (priv->db, query, NULL, NULL);
sqlite3_free (query);
}
}
static gboolean
soup_cookie_jar_db_is_persistent (SoupCookieJar *jar)
{
return TRUE;
}
static void
soup_cookie_jar_db_class_init (SoupCookieJarDBClass *db_class)
{
SoupCookieJarClass *cookie_jar_class =
SOUP_COOKIE_JAR_CLASS (db_class);
GObjectClass *object_class = G_OBJECT_CLASS (db_class);
cookie_jar_class->is_persistent = soup_cookie_jar_db_is_persistent;
cookie_jar_class->changed = soup_cookie_jar_db_changed;
object_class->finalize = soup_cookie_jar_db_finalize;
object_class->set_property = soup_cookie_jar_db_set_property;
object_class->get_property = soup_cookie_jar_db_get_property;
/**
* SOUP_COOKIE_JAR_DB_FILENAME:
*
* Alias for the #SoupCookieJarDB:filename property. (The
* cookie-storage filename.)
**/
g_object_class_install_property (
object_class, PROP_FILENAME,
g_param_spec_string (SOUP_COOKIE_JAR_DB_FILENAME,
"Filename",
"Cookie-storage filename",
NULL,
G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS));
}
|