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 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
|
/* vim: set sw=8: -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/* Interface Gnumeric to Databases
* Copyright (C) 1998,1999 Michael Lausch
* Copyright (C) 2000-2002 Rodrigo Moya
* Copyright (C) 2006 Vivien Malerba
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Library General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
* Library General Public License for more details.
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the Free
* Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#include <gnumeric-config.h>
#include <gnumeric.h>
#include <libgda/libgda.h>
#include <libgda/control-center/gdaui-login-dialog.h>
#include <sql-parser/gda-sql-parser.h>
#include <string.h>
#include "func.h"
#include "expr.h"
#include "value.h"
#include "workbook.h"
#include "sheet.h"
#include "gnm-i18n.h"
#include <goffice/goffice.h>
#include <gnm-plugin.h>
GNM_PLUGIN_MODULE_HEADER;
static gboolean libgda_init_done = FALSE;
static GHashTable *cnc_hash = NULL;
static GnmValue *
gnm_value_new_from_gda (GValue const *gval,
GODateConventions const *date_conv)
{
GnmValue *res;
GType t;
if (NULL == gval)
return value_new_empty ();
t = G_VALUE_TYPE (gval);
if (t == GDA_TYPE_NULL)
return value_new_empty ();
if (t == GDA_TYPE_SHORT)
return value_new_int (gda_value_get_short (gval));
if (t == GDA_TYPE_USHORT)
return value_new_int (gda_value_get_ushort (gval));
if (t == G_TYPE_DATE) {
res = value_new_int (go_date_g_to_serial (
(GDate const *) g_value_get_boxed (gval), date_conv));
value_set_fmt (res, go_format_default_date ());
return res;
}
if (t == GDA_TYPE_TIME) {
GdaTime const *time = gda_value_get_time (gval);
res = value_new_float ( (time->hour +
(time->minute +
time->second / 60.) / 60.) / 24.),
value_set_fmt (res, go_format_default_time ());
return res;
}
switch (t) {
case G_TYPE_BOOLEAN :
return value_new_bool (g_value_get_boolean (gval));
case G_TYPE_DOUBLE :
return value_new_float (g_value_get_double (gval));
case G_TYPE_FLOAT :
return value_new_float (g_value_get_float (gval));
#if 0
case G_TYPE_INT64 : /* g_value_get_int64 (gval) */
case G_TYPE_UINT64 : /* g_value_get_uint64 (gval) */
#endif
case G_TYPE_INT :
return value_new_int (g_value_get_int (gval));
case G_TYPE_UINT :
return value_new_int (g_value_get_uint (gval));
#if 0
/* No way to represent a timezone, leave it as a string for now */
case GDA_TYPE_TIMESTAMP:
#endif
#if 0
/* Do we want to consider nested arrays ??
* The rest of the system is not strong enough yet. */
case GDA_TYPE_LIST : {
GList const *ptr;
for (ptr = gda_value_get_list (gval) ; NULL != ptr ; ptr = ptr->next) {
}
return array;
}
#endif
#if 0
/* Use the default gvalue conversions for these */
case G_TYPE_CHAR :
case G_TYPE_UCHAR :
case G_TYPE_STRING :
case GDA_TYPE_GEOMETRIC_POINT :
case GDA_TYPE_BINARY :
/* this is stored as a string, let gda handle it */
case GDA_TYPE_NUMERIC :
#endif
default :
break;
}
if (g_value_type_transformable (G_VALUE_TYPE (gval), G_TYPE_STRING)) {
GValue str = { 0 };
g_value_init (&str, G_TYPE_STRING);
if (g_value_transform (gval, &str))
return value_new_string (g_value_get_string (&str));
g_value_unset (&str);
}
return value_new_empty ();
}
static GnmValue *
display_recordset (GdaDataModel *recset, GnmFuncEvalInfo *ei)
{
GODateConventions const *date_conv;
GnmValue* array = NULL;
gint col;
gint row;
gint fieldcount = 0;
gint rowcount = 0;
g_return_val_if_fail (GDA_IS_DATA_MODEL (recset), NULL);
fieldcount = gda_data_model_get_n_columns (recset);
rowcount = gda_data_model_get_n_rows (recset);
/* convert the GdaDataModel in an array */
if (rowcount <= 0)
return value_new_empty ();
if (rowcount >= gnm_sheet_get_max_rows (ei->pos->sheet))
return value_new_error (ei->pos, _("Too much data returned"));
date_conv = workbook_date_conv (ei->pos->sheet->workbook);
array = value_new_array_empty (fieldcount, rowcount);
for (row = 0; row < rowcount; row++) {
for (col = 0; col < fieldcount; col++) {
const GValue *cv;
cv = gda_data_model_get_value_at (recset, col, row, NULL);
if (!cv)
return value_new_error (ei->pos, _("Can't obtain data"));
value_array_set (array, col, row,
gnm_value_new_from_gda (cv,
date_conv));
}
}
return array;
}
/*
* Key structure and hash functions for that structure
*/
typedef struct {
gchar *dsn;
gchar *user;
gchar *pass;
} CncKey;
static guint
cnc_key_hash_func (CncKey *key)
{
guint retval = 0;
if (key->dsn)
retval = g_str_hash (key->dsn);
if (key->user)
retval = (retval << 4) + g_str_hash (key->user);
if (key->pass)
retval = (retval << 4) + g_str_hash (key->pass);
return retval;
}
static gboolean
cnc_key_equal_func (CncKey *key1, CncKey *key2)
{
if ((key1->dsn && !key2->dsn) ||
(!key1->dsn && key2->dsn) ||
(key1->dsn && key2->dsn && strcmp (key1->dsn, key2->dsn)))
return FALSE;
if ((key1->user && !key2->user) ||
(!key1->user && key2->user) ||
(key1->user && key2->user && strcmp (key1->user, key2->user)))
return FALSE;
if ((key1->pass && !key2->pass) ||
(!key1->pass && key2->pass) ||
(key1->pass && key2->pass && strcmp (key1->pass, key2->pass)))
return FALSE;
return TRUE;
}
static void
cnc_key_free (CncKey *key)
{
g_free (key->dsn);
g_free (key->user);
g_free (key->pass);
g_free (key);
}
static GdaConnection *
open_connection (const gchar *dsn, const gchar *user, const gchar *password, GdaConnectionOptions options)
{
GdaConnection *cnc = NULL;
gchar *real_dsn, *real_user, *real_password;
GError *error = NULL;
/* initialize connection pool if first time */
if (!libgda_init_done) {
gda_init ();
libgda_init_done = TRUE;
}
/* try to find a cnc object if we already have one */
if (!cnc_hash)
cnc_hash = g_hash_table_new_full ((GHashFunc) cnc_key_hash_func,
(GEqualFunc) cnc_key_equal_func,
(GDestroyNotify) cnc_key_free,
(GDestroyNotify) g_object_unref);
else {
CncKey key;
key.dsn = (gchar *) dsn;
key.user = (gchar *) user;
key.pass = (gchar *) password;
cnc = g_hash_table_lookup (cnc_hash, &key);
}
if (!cnc) {
CncKey *key;
gchar *auth, *tmp1, *tmp2;
GtkWidget *dialog = gdaui_login_dialog_new (_("Database Connection"), NULL); /* FIXME: pass a pointer to parent window */
GnomeDbLogin *login = gdaui_login_dialog_get_login_widget (GDAUI_LOGIN_DIALOG (dialog));
gnome_db_login_set_dsn (login, dsn);
gnome_db_login_set_username (login, user);
gnome_db_login_set_password (login, password);
if (gdaui_login_dialog_run (GDAUI_LOGIN_DIALOG (dialog))) {
real_dsn = g_strdup (gdauilogin_get_dsn (login));
real_user = g_strdup (gdauilogin_get_username (login));
real_password = g_strdup (gdauilogin_get_password (login));
gtk_widget_destroy (dialog);
} else {
gtk_widget_destroy (dialog);
return NULL;
}
tmp1 = gda_rfc1738_encode (real_user);
tmp2 = gda_rfc1738_encode (real_password);
auth = g_strdup_printf ("USERNAME=%s;PASSWORD=%s", tmp1, tmp2);
g_free (tmp1);
g_free (tmp2);
cnc = gda_connection_open_from_dsn (real_dsn, auth, options, &error);
if (!cnc) {
g_warning ("Libgda error: %s\n", error->message);
g_error_free (error);
}
g_free (real_dsn);
g_free (real_user);
g_free (real_password);
g_free (auth);
key = g_new0 (CncKey, 1);
if (dsn)
key->dsn = g_strdup (dsn);
if (user)
key->user = g_strdup (user);
if (password)
key->pass = g_strdup (password);
g_hash_table_insert (cnc_hash, key, cnc);
}
return cnc;
}
/*
* execSQL function
*/
static GnmFuncHelp const help_execSQL[] = {
{ GNM_FUNC_HELP_NAME, F_("EXECSQL:result of executing @{sql} in the "
"libgda data source @{dsn}") },
{ GNM_FUNC_HELP_ARG, F_("dsn:libgda data source") },
{ GNM_FUNC_HELP_ARG, F_("username:user name to access @{dsn}") },
{ GNM_FUNC_HELP_ARG, F_("password:password to access @{dsn} as @{username}") },
{ GNM_FUNC_HELP_ARG, F_("sql:SQL command") },
{ GNM_FUNC_HELP_NOTE, F_("Before using EXECSQL, you need to set up a libgda "
"data source.") },
{ GNM_FUNC_HELP_EXAMPLES, "=EXECSQL(\"mydatasource\",\"username\",\"password\""
",\"SELECT * FROM customers\")" },
{ GNM_FUNC_HELP_SEEALSO, "READDBTABLE" },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_execSQL (GnmFuncEvalInfo *ei, GnmValue const * const *args)
{
GnmValue* ret;
gchar* dsn_name;
gchar* user_name;
gchar* password;
gchar* sql;
GdaConnection* cnc;
GdaDataModel* recset;
GdaStatement* stmt;
GError* error = NULL;
GdaSqlParser *parser;
const gchar *remain;
dsn_name = value_get_as_string (args[0]);
user_name = value_get_as_string (args[1]);
password = value_get_as_string (args[2]);
sql = value_get_as_string (args[3]);
if (!dsn_name || !sql)
return value_new_error (ei->pos, _("Format: execSQL(dsn,user,password,sql)"));
cnc = open_connection (dsn_name, user_name, password, GDA_CONNECTION_OPTIONS_READ_ONLY);
if (!GDA_IS_CONNECTION (cnc)) {
return value_new_error(ei->pos, _("Error: could not open connection to %s"));
}
/* execute command */
parser = gda_connection_create_parser (cnc);
if (!parser)
parser = gda_sql_parser_new ();
stmt = gda_sql_parser_parse_string (parser, sql, &remain, &error);
g_object_unref (parser);
if (!stmt) {
ret = value_new_error (ei->pos, error->message);
g_error_free (error);
return ret;
}
if (remain) {
g_object_unref (stmt);
return value_new_error (ei->pos, _("More than one statement in SQL string"));
}
recset = gda_connection_statement_execute_select (cnc, stmt, NULL, &error);
g_object_unref (stmt);
if (recset) {
ret = display_recordset (recset, ei);
g_object_unref (recset);
} else {
if (error) {
ret = value_new_error (ei->pos, error->message);
g_error_free (error);
} else
ret = value_new_empty ();
}
return ret;
}
/*
* readDBTable function
*/
static GnmFuncHelp const help_readDBTable[] = {
{ GNM_FUNC_HELP_NAME, F_("READDBTABLE:all rows of the table @{table} in @{dsn}") },
{ GNM_FUNC_HELP_ARG, F_("dsn:libgda data source") },
{ GNM_FUNC_HELP_ARG, F_("username:user name to access @{dsn}") },
{ GNM_FUNC_HELP_ARG, F_("password:password to access @{dsn} as @{username}") },
{ GNM_FUNC_HELP_ARG, F_("table:SQL table to retrieve") },
{ GNM_FUNC_HELP_NOTE, F_("Before using EXECSQL, you need to set up a libgda "
"data source.") },
{ GNM_FUNC_HELP_EXAMPLES, "=READDBTABLE(\"mydatasource\",\"username\","
"\"password\",\"customers\")" },
{ GNM_FUNC_HELP_SEEALSO, "EXECSQL" },
{ GNM_FUNC_HELP_END }
};
static GnmValue *
gnumeric_readDBTable (GnmFuncEvalInfo *ei, GnmValue const * const *args)
{
GnmValue* ret;
gchar* dsn_name;
gchar* user_name;
gchar* password;
gchar* table;
GdaConnection* cnc;
GdaDataModel* recset;
GdaStatement* stmt;
GError* error = NULL;
GdaSqlParser *parser;
const gchar *remain;
gchar *sql;
dsn_name = value_get_as_string (args[0]);
user_name = value_get_as_string (args[1]);
password = value_get_as_string (args[2]);
table = value_get_as_string (args[3]);
if (!dsn_name || !table)
return value_new_error (ei->pos, _("Format: readDBTable(dsn,user,password,table)"));
cnc = open_connection (dsn_name, user_name, password, GDA_CONNECTION_OPTIONS_READ_ONLY);
if (!GDA_IS_CONNECTION (cnc)) {
return value_new_error(ei->pos, _("Error: could not open connection to %s"));
}
/* execute command */
parser = gda_connection_create_parser (cnc);
if (!parser)
parser = gda_sql_parser_new ();
sql = g_strdup_printf ("SELECT * FROM %s", table); /* FIXME: create statement from API */
stmt = gda_sql_parser_parse_string (parser, sql, &remain, &error);
g_free (sql);
g_object_unref (parser);
if (!stmt) {
ret = value_new_error (ei->pos, error->message);
g_error_free (error);
return ret;
}
if (remain) {
g_object_unref (stmt);
return value_new_error (ei->pos, _("More than one statement in SQL string"));
}
recset = gda_connection_statement_execute_select (cnc, stmt, NULL, &error);
g_object_unref (stmt);
if (recset) {
ret = display_recordset (recset, ei);
g_object_unref (recset);
} else {
if (error) {
ret = value_new_error (ei->pos, error->message);
g_error_free (error);
} else
ret = value_new_empty ();
}
return ret;
}
static void
view_data_sources (GnmAction const *action, WorkbookControl *wbc)
{
char *argv[2];
argv[0] = gda_get_application_exec_path ("gda-control-center");
argv[1] = NULL;
if (!g_spawn_async (NULL, argv, NULL, G_SPAWN_SEARCH_PATH, NULL, NULL, NULL, NULL)) {
char *msg = g_strdup_printf (
_("Could not run GNOME database configuration tool ('%s')"),
argv[0]);
go_gtk_notice_dialog (wbcg_toplevel (WBC_GTK (wbc)),
GTK_MESSAGE_INFO, msg);
g_free (msg);
}
g_free (argv[0]);
}
G_MODULE_EXPORT void
go_plugin_shutdown (GOPlugin *plugin, GOCmdContext *cc)
{
/* nothing to do */
g_hash_table_destroy (cnc_hash);
cnc_hash = NULL;
}
ModulePluginUIActions const gdaif_ui_actions[] = {
{"ViewDataSources", view_data_sources},
{NULL}
};
GnmFuncDescriptor gdaif_functions[] = {
{
"execSQL", "ssss", "dsn,username,password,sql",
help_execSQL, &gnumeric_execSQL, NULL, NULL, NULL
},
{
"readDBTable", "ssss", "dsn,username,password,table",
help_readDBTable, &gnumeric_readDBTable, NULL, NULL, NULL
},
{NULL}
};
|