Data Structures | |
struct | QofMain_s |
The qof-main context struct. More... | |
Files | |
file | qof-main.c |
Common functions for the QOF external framework. | |
file | qof-main.h |
Common functions for the QOF external framework. | |
Defines | |
#define | _GNU_SOURCE |
#define | MAX_LINE 79 |
#define | ERR_INDENT strlen(PACKAGE) + 2 |
Indent error messages as paragraphs. | |
#define | QOF_DATE_STRING_LENGTH MAX_DATE_LENGTH |
#define | QOF_MAIN_CLI "QOF-mod-command-line" |
#define | CATEGORY_NAME "category" |
Category name. | |
#define | QSF_COMPRESS "compression_level" |
#define | QSF_ENCODING "encoding_string" |
#define | QSF_DATE_CONVERT "convert_date_to_time" |
#define | QOF_SQL_SUPPORTED "^SELECT|INSERT" |
#define | QOF_CLI_OPTIONS |
Common QOF CLI options. | |
#define | QOF_MAIN_OP |
#define | QOF_OP_VARS |
#define | QOF_OP_INIT |
Typedefs | |
typedef struct QofMain_s | QofMainContext |
The qof-main context struct. | |
Functions | |
void | qof_main_wrap_line (FILE *fp, gint indent, const gchar *template_str,...) __attribute__((format(printf |
Wrap long lines in popt-style. | |
static void | qof_main_run_sql (QofMainContext *context) |
static void | qof_main_run_query (QofMainContext *context) |
void | qof_main_free (QofMainContext *context) |
static void | find_param_cb (QofParam *param, gpointer user_data) |
static void | build_database_list (QofIdTypeConst obj_type, QofMainContext *context) |
static void | select_cb (QofObject *obj, gpointer data) |
void | qof_main_moderate_query (QofMainContext *context) |
Assemble the components of the query. | |
static void | option_cb (QofBackendOption *option, gpointer data) |
void | qof_mod_compression (gint64 gz_level, QofMainContext *context) |
void | qof_mod_encoding (const gchar *encoding, QofMainContext *context) |
void | qof_mod_convert_deprecated (gint64 convert, QofMainContext *context) |
void | qof_cmd_xmlfile (QofMainContext *context) |
static void | qof_main_list (QofObject *obj, gpointer data) |
void | qof_main_select (QofMainContext *context) |
void | qof_cmd_list (void) |
Lists all databases supported by the current QOF framework. | |
static void | explain_cb (QofParam *param, gpointer user_data) |
void | qof_cmd_explain (QofMainContext *context) |
void | qof_mod_category (const gchar *category, QofMainContext *data) |
Shorthand to only query objects that are set to the specified category. | |
glong | qof_mod_get_local_offset (void) |
Get the gmt_off offset for this locale. | |
void | qof_mod_database (const gchar *database, QofMainContext *data) |
Shorthand to only query objects within one specific supported database. | |
void | qof_mod_time (const gchar *date_time, QofMainContext *data) |
Shorthand to only query objects that contain the specified date. | |
void | qof_mod_exclude (const gchar *exclude, QofMainContext *data) |
Shorthand to exclude a supported database from the query. | |
void | qof_mod_sql (const gchar *sql_query, QofMainContext *data) |
Specify a SQL query on the command line. | |
void | qof_mod_sql_file (const gchar *sql_file, QofMainContext *data) |
Specify one or more SQL queries contained in a file. | |
void | qof_mod_write (const gchar *write_file, QofMainContext *data) |
Write the results of any query to the file. | |
void | qof_main_show_error (QofSession *session) |
Output error messages from QOF. | |
GSList * | qof_main_get_param_list (QofIdTypeConst object_type, QofType param_type) |
List of all parameters for this object of one QOF type. | |
Variables | |
static QofLogModule | log_module = "QOF-mod-command-line" |
QOF provides an outline CLI that is easily patched from the qof-generator project to make it easier to keep various QOF projects updated.
This CLI is easily extended to support your own functions and options and includes macros to help you keep up to date with changes in main QOF options. It is recommended that you do not edit this file, instead please feed patches back to the QOF-devel mailing list at http://lists.sourceforge.net/mailman/listinfo/qof-devel so that other projects can be updated.
#define CATEGORY_NAME "category" |
Category name.
The name of the parameter that holds the category of the entity.
Many CLI data sources categorise data by user-editable category strings. If your program does not, simply implement a modified QOF_CLI_OPTIONS in your code without the category option:
{"category", 'c', POPT_ARG_STRING, &category, qof_op_category, _("Shorthand to only query objects that are set to the specified category."), "string"},
Definition at line 118 of file qof-main.h.
Referenced by pilot_qof_pack().
#define QOF_CLI_OPTIONS |
Common QOF CLI options.
These are definitions for popt support in the CLI. Every program's popt table should start with QOF_CLI_OPTIONS or a replacement to insert the standard options into it. Also enables autohelp. End your popt option list with POPT_TABLEEND. If you want to remove any of these options, simply copy QOF_CLI_OPTIONS into a macro of your own and remove the options you do not need.
Popt Auto help is customised to use the translated version.
Definition at line 424 of file qof-main.h.
Referenced by main().
#define QOF_DATE_STRING_LENGTH MAX_DATE_LENGTH |
Maximum length of the UTC timestamp used by QSF
QOF_UTC_DATE_FORMAT "%Y-%m-%dT%H:%M:%SZ"
Definition at line 100 of file qof-main.h.
#define QOF_MAIN_CLI "QOF-mod-command-line" |
#define QOF_MAIN_OP |
Value:
_(qof_op_noop, = 0) \ _(qof_op_list,) \ _(qof_op_xmlfile,) \ _(qof_op_category,) \ _(qof_op_database,) \ _(qof_op_time,) \ _(qof_op_exclude,) \ _(qof_op_sql,) \ _(qof_op_sql_file,) \ _(qof_op_write, ) \ _(qof_op_explain,) \ _(qof_op_vers,) \ _(qof_op_compress,) \ _(qof_op_debug,)
Definition at line 462 of file qof-main.h.
#define QOF_OP_INIT |
Value:
exclude = NULL; \ category = NULL; \ database = NULL; \ sql_file = NULL; \ write_file = NULL; \ sql_query = NULL; \ filename = NULL;
A simple convenience macro.
Definition at line 491 of file qof-main.h.
Referenced by main().
#define QOF_OP_VARS |
Value:
const gchar *exclude, *date_time, *category, *database; \ const gchar *sql_file, *write_file, *sql_query, *filename;
If you remove any QOF CLI options, ensure you also remove the option variable and it's initialiser.
Definition at line 483 of file qof-main.h.
Referenced by main().
#define QOF_SQL_SUPPORTED "^SELECT|INSERT" |
The SQL commands supported by QOF
A regular expression used to exclude unsupported commands from SQL files. Anything that does not match the expression will be silently ignored. This allows genuine SQL dump files to be parsed without errors.
A QOF object is similar to a definition of a SQL table.
A QOF entity is similar to an instance of a SQL record.
A QOF parameter is similar to data in a SQL field.
Certain SQL commands have no QOF equivalent and should always be ignored silently:
Definition at line 159 of file qof-main.h.
Referenced by qof_mod_sql_file().
#define QSF_COMPRESS "compression_level" |
backend configuration index string for QSF
The identifier for the configuration option within QSF supported by the CLI. Matches the QofBackendOption->option_name in the KvpFrame holding the options.
Definition at line 127 of file qof-main.h.
#define QSF_DATE_CONVERT "convert_date_to_time" |
convert deprecated date fields into times.
Definition at line 133 of file qof-main.h.
#define QSF_ENCODING "encoding_string" |
backend configuration encoding string
Definition at line 130 of file qof-main.h.
typedef struct QofMain_s QofMainContext |
The qof-main context struct.
Intended as a core type for QOF-based CLI programs, wrap your own context struct around qof_main_context
void qof_cmd_explain | ( | QofMainContext * | context | ) |
Print a list of available parameters for a database.
Used with qof_mod_database to print a list of QofParam for the QofObject set in context->database.
Definition at line 435 of file qof-main.c.
References QofMain_s::database, and QofMain_s::error.
Referenced by main().
00436 { 00437 if (context->error) 00438 return; 00439 fprintf (stdout, _("\nParameters of the %s database:\n\n"), 00440 context->database); 00441 qof_class_param_foreach (context->database, explain_cb, NULL); 00442 fprintf (stdout, _("\nThank you for using %s\n\n"), PACKAGE); 00443 }
void qof_cmd_list | ( | void | ) |
Lists all databases supported by the current QOF framework.
Prints the name and description for each object type registered with this instance of QOF. No options are used.
Definition at line 411 of file qof-main.c.
References qof_main_wrap_line().
Referenced by main().
00412 { 00413 qof_main_wrap_line (stdout, 0, 00414 _("\n%s: You can use the supported database names with '%s -d' " 00415 "and in SQL queries (as the table name) with '%s -s|f'. " 00416 "Descriptions are shown only for readability.\n"), 00417 PACKAGE, PACKAGE, PACKAGE); 00418 fprintf (stdout, "%-20s%-20s\n", _("Name"), _("Description")); 00419 qof_object_foreach_type (qof_main_list, NULL); 00420 qof_main_wrap_line (stdout, 0, 00421 _("\nUse '%s -d <database> --explain' to see the list of fields " 00422 "within any supported database."), PACKAGE); 00423 fprintf (stdout, _("\nThank you for using %s\n\n"), PACKAGE); 00424 }
void qof_cmd_xmlfile | ( | QofMainContext * | context | ) |
query the QSF XML data
Definition at line 354 of file qof-main.c.
References QofMain_s::database, QofMain_s::encoding, ERR_INDENT, QofMain_s::exclude, QofMain_s::export_session, QofMain_s::filename, QofMain_s::gz_level, QofMain_s::input_session, qof_main_moderate_query(), qof_main_show_error(), qof_main_wrap_line(), qof_mod_compression(), qof_mod_encoding(), and QofMain_s::write_file.
Referenced by main().
00355 { 00356 QofSession *input_session, *export_session; 00357 00358 ENTER (" "); 00359 input_session = context->input_session; 00360 if (0 == safe_strcmp (context->exclude, context->database) 00361 && (context->exclude != NULL)) 00362 { 00363 qof_main_wrap_line (stderr, ERR_INDENT, 00364 _("%s: Error: Cannot exclude database \"%s\" with option -e " 00365 "because option -d is set to include the database: \"%s\". " 00366 "Use the \'-l\' command to see the full list of supported " 00367 "databases.\n"), PACKAGE, context->exclude, 00368 context->database); 00369 qof_session_end (input_session); 00370 LEAVE (" conflicting options"); 00371 return; 00372 } 00373 qof_session_begin (input_session, context->filename, TRUE, FALSE); 00374 if (0 != safe_strcmp (QOF_STDOUT, context->filename)) 00375 qof_session_load (input_session, NULL); 00376 export_session = qof_session_new (); 00377 context->export_session = export_session; 00378 if (context->write_file) 00379 { 00380 qof_session_begin (export_session, context->write_file, TRUE, 00381 TRUE); 00382 qof_mod_compression (context->gz_level, context); 00383 } 00384 else 00385 qof_session_begin (export_session, QOF_STDOUT, TRUE, FALSE); 00386 /* ensure encoding value is set in the new export_session */ 00387 qof_mod_encoding (context->encoding, context); 00388 qof_main_moderate_query (context); 00389 qof_session_save (export_session, NULL); 00390 qof_main_show_error (export_session); 00391 qof_main_show_error (input_session); 00392 qof_session_end (input_session); 00393 qof_session_end (export_session); 00394 LEAVE (" "); 00395 }
void qof_main_free | ( | QofMainContext * | context | ) |
Free qof_main_context values when work is done.
Definition at line 132 of file qof-main.c.
References QofMain_s::category, QofMain_s::database, QofMain_s::filename, QofMain_s::sql_file, and QofMain_s::write_file.
00133 { 00134 g_free (context->filename); 00135 g_free (context->write_file); 00136 g_free (context->sql_file); 00137 g_free (context->database); 00138 g_free (context->category); 00139 }
GSList* qof_main_get_param_list | ( | QofIdTypeConst | object_type, | |
QofType | param_type | |||
) |
List of all parameters for this object of one QOF type.
Return a GSList of all parameters of this object that are a particular QOF type, QOF_TYPE_STRING, QOF_TYPE_BOOLEAN etc.
The returned GSList should be freed by the caller.
object_type | object->e_type for the relevant object. | |
param_type | The type of parameter to match, QOF_TYPE_STRING etc. |
void qof_main_moderate_query | ( | QofMainContext * | context | ) |
Assemble the components of the query.
If any SQL statements are found, run separately from any -c, -d or -t options.
All queries are additive: Successive queries add more entities to the result set but no entity is set more than once.
Definition at line 221 of file qof-main.c.
References QofMain_s::database, QofMain_s::exclude, QofMain_s::query, QofMain_s::sql_list, and QofMain_s::sql_str.
Referenced by qof_cmd_hotsync(), and qof_cmd_xmlfile().
00222 { 00223 GSList *date_param_list, *category_param_list; 00224 gboolean all; 00225 00226 ENTER (" "); 00227 all = TRUE; 00228 context->query = qof_query_create (); 00229 date_param_list = NULL; 00230 category_param_list = NULL; 00231 while (context->sql_list) 00232 { 00233 PINFO ("running sql_list"); 00234 context->sql_str = g_strdup (context->sql_list->data); 00235 qof_main_run_sql (context); 00236 qof_main_run_query (context); 00237 if (context->query) 00238 qof_query_clear (context->query); 00239 g_free (context->sql_str); 00240 context->sql_str = NULL; 00241 all = FALSE; 00242 context->sql_list = g_list_next (context->sql_list); 00243 } 00244 if (0 < g_list_length (context->sql_list)) 00245 { 00246 context->sql_str = NULL; 00247 g_list_free (context->sql_list); 00248 all = FALSE; 00249 } 00250 if (context->sql_str != NULL) 00251 { 00252 PINFO ("running sql_str"); 00253 qof_main_run_sql (context); 00254 qof_main_run_query (context); 00255 if (context->query) 00256 qof_query_clear (context->query); 00257 all = FALSE; 00258 } 00259 if ((context->exclude != NULL) 00260 && (qof_class_is_registered (context->exclude))) 00261 { 00262 qof_object_foreach_type (select_cb, context); 00263 all = FALSE; 00264 } 00265 if ((context->database != NULL) 00266 && (qof_class_is_registered (context->database))) 00267 { 00268 build_database_list (context->database, context); 00269 all = FALSE; 00270 } 00271 if (all == TRUE) 00272 qof_object_foreach_type (select_cb, context); 00273 LEAVE (" "); 00274 }
void qof_main_show_error | ( | QofSession * | session | ) |
Output error messages from QOF.
QOF will set errors in the QofSession. The application determines how to output those messages and for the CLI, this will be to stderr. Not all these messages are implemented in any one QOF CLI.
session | Any current session. |
Definition at line 591 of file qof-main.c.
References ERR_INDENT, and qof_main_wrap_line().
Referenced by qof_cmd_hotsync(), and qof_cmd_xmlfile().
00592 { 00593 gchar *newfile; 00594 const gchar *fmt; 00595 QofErrorId id; 00596 00597 newfile = g_strdup (qof_session_get_file_path (session)); 00598 id = qof_error_check (session); 00599 if (id != QOF_SUCCESS) 00600 { 00601 fmt = "%s: %d %s\n"; 00602 qof_main_wrap_line (stderr, ERR_INDENT, fmt, PACKAGE, 00603 id, qof_error_get_message (session)); 00604 qof_error_clear (session); 00605 } 00606 g_free (newfile); 00607 }
void qof_main_wrap_line | ( | FILE * | fp, | |
gint | indent, | |||
const gchar * | template_str, | |||
... | ||||
) |
Wrap long lines in popt-style.
Defaults to a line width of 79 characters. Indents lines following the first according to the value of indent.
fp | A file stream, including stdout or stderr. | |
indent | The number of characters to indent from the left. Values over or equal to 79 or less than zero are adjusted. | |
template_str | String to be wrapped, containing positional parameters, as specified in the Single Unix Specification. Can be translated but should not contain newline characters except at the beginning or end of the message. |
Definition at line 52 of file qof-main.c.
Referenced by main(), qof_cmd_hotsync(), qof_cmd_list(), qof_cmd_xmlfile(), qof_main_show_error(), and qof_mod_sql_file().
00054 { 00055 gint line_length, msg_length; 00056 va_list wraps; 00057 gchar *message; 00058 00059 line_length = MAX_LINE; 00060 /* note the modulus. Don't use CLAMP here */ 00061 /* indent != line_length or particularly close to it. */ 00062 indent = indent >= line_length ? indent % line_length : indent; 00063 indent = indent < 0 ? 0 : indent; 00064 message = NULL; 00065 g_return_if_fail (template); 00066 va_start (wraps, template); 00067 message = g_strdup_vprintf (template, wraps); 00068 va_end (wraps); 00069 g_return_if_fail (message); 00070 msg_length = strlen (message); 00071 while (msg_length > line_length) 00072 { 00073 gchar *chunk; 00074 gchar format[16]; 00075 00076 chunk = message + line_length - 1; 00077 while (chunk > message && !g_ascii_isspace (*chunk)) 00078 chunk--; 00079 if (chunk == message) 00080 break; /* give up */ 00081 while (chunk > (message + 1) && g_ascii_isspace (*chunk)) 00082 chunk--; 00083 chunk++; 00084 g_sprintf (format, "%%.%ds\n%%%ds", (gint) (chunk - message), 00085 indent); 00086 g_fprintf (fp, format, message, ""); 00087 message = chunk; 00088 while (g_ascii_isspace (*message) && *message) 00089 message++; 00090 msg_length = strlen (message); 00091 if (line_length == MAX_LINE) 00092 line_length -= indent; 00093 } 00094 if (msg_length) 00095 g_fprintf (fp, "%s\n", message); 00096 }
void qof_mod_category | ( | const gchar * | category, | |
QofMainContext * | data | |||
) |
Shorthand to only query objects that are set to the specified category.
Modifies the QOF query to only query objects that are set to category.
Definition at line 446 of file qof-main.c.
References QofMain_s::category.
Referenced by main().
00447 { 00448 data->category = g_strdup (category); 00449 }
void qof_mod_compression | ( | gint64 | gz_level, | |
QofMainContext * | context | |||
) |
Pass the requested compression to QSF
gz_level | Integer between 0 and 9, 9 highest compression, 0 for none. | |
context | The QofMain context. |
Definition at line 298 of file qof-main.c.
References QofMain_s::export_session, and QofMain_s::gz_level.
Referenced by qof_cmd_hotsync(), and qof_cmd_xmlfile().
00299 { 00300 KvpFrame *be_config; 00301 QofBook *book; 00302 QofBackend *be; 00303 00304 ENTER (" compression=%" G_GINT64_FORMAT, gz_level); 00305 if ((gz_level > 0) && (gz_level <= 9)) 00306 { 00307 book = qof_session_get_book (context->export_session); 00308 be = qof_book_get_backend (book); 00309 be_config = qof_backend_get_config (be); 00310 context->gz_level = gz_level; 00311 qof_backend_option_foreach (be_config, option_cb, context); 00312 qof_backend_load_config (be, be_config); 00313 } 00314 LEAVE (" "); 00315 }
void qof_mod_convert_deprecated | ( | gint64 | convert, | |
QofMainContext * | context | |||
) |
configure handling of deprecated date fields.
Definition at line 335 of file qof-main.c.
References QofMain_s::convert, and QofMain_s::export_session.
Referenced by main().
00336 { 00337 KvpFrame *be_config; 00338 QofBook *book; 00339 QofBackend *be; 00340 gboolean set; 00341 00342 set = (convert == 0) ? FALSE : TRUE; 00343 ENTER (" convert deprecated date values? %i No if 0.", set); 00344 book = qof_session_get_book (context->export_session); 00345 be = qof_book_get_backend (book); 00346 be_config = qof_backend_get_config (be); 00347 context->convert = convert; 00348 qof_backend_option_foreach (be_config, option_cb, context); 00349 qof_backend_load_config (be, be_config); 00350 LEAVE (" "); 00351 }
void qof_mod_database | ( | const gchar * | database, | |
QofMainContext * | data | |||
) |
Shorthand to only query objects within one specific supported database.
Used to only query objects within the specified database.
Definition at line 466 of file qof-main.c.
References QofMain_s::database.
Referenced by main().
00467 { 00468 if (qof_class_is_registered (database)) 00469 data->database = g_strdup (database); 00470 }
void qof_mod_encoding | ( | const gchar * | encoding, | |
QofMainContext * | context | |||
) |
Pass an encoding string to the backend.
Definition at line 318 of file qof-main.c.
References QofMain_s::encoding, and QofMain_s::export_session.
Referenced by main(), and qof_cmd_xmlfile().
00319 { 00320 KvpFrame *be_config; 00321 QofBook *book; 00322 QofBackend *be; 00323 00324 ENTER (" encode to %s", encoding); 00325 book = qof_session_get_book (context->export_session); 00326 be = qof_book_get_backend (book); 00327 be_config = qof_backend_get_config (be); 00328 context->encoding = encoding; 00329 qof_backend_option_foreach (be_config, option_cb, context); 00330 qof_backend_load_config (be, be_config); 00331 LEAVE (" "); 00332 }
void qof_mod_exclude | ( | const gchar * | exclude, | |
QofMainContext * | data | |||
) |
Shorthand to exclude a supported database from the query.
Excludes the (single) specified database from the query.
Definition at line 521 of file qof-main.c.
References QofMain_s::exclude.
Referenced by main().
00522 { 00523 if (qof_class_is_registered (exclude)) 00524 data->exclude = g_strdup (exclude); 00525 }
glong qof_mod_get_local_offset | ( | void | ) |
Get the gmt_off offset for this locale.
User specified strings can be assumed to be in localtime, but values are stored as UTC. This offset allows the application to modify the minimum and maximum time settings for queries so that the user gets the expected results.
If the timezone is +0100 and the date is 24th July 2006, values could be stored as 11pm on 23rd July 2006 UTC. qof_mod_get_local_offset returns -86400. Add this value to the minimum and maximum time passed to the query to ensure queries select expected timeframe: 2006-07-23T23:00:00Z to 2006-07-24T22:59:59Z.
Definition at line 452 of file qof-main.c.
Referenced by qof_mod_time().
00453 { 00454 glong local_offset; 00455 struct tm local; 00456 time_t now; 00457 00458 local_offset = 0; /* UTC */ 00459 now = time (NULL); 00460 local = *localtime_r (&now, &local); 00461 local_offset -= local.tm_gmtoff; 00462 return local_offset; 00463 }
void qof_mod_sql | ( | const gchar * | sql_query, | |
QofMainContext * | data | |||
) |
Specify a SQL query on the command line.
For SELECT, the returned list is a list of all of the instances of 'SomeObj' that match the query. The 'SORT' term is optional. The 'WHERE' term is optional; but if you don't include 'WHERE', you will get a list of all of the object instances. The Boolean operations 'AND' and 'OR' together with parenthesis can be used to construct arbitrarily nested predicates.
For INSERT, the returned list is a list containing the newly created instance of 'SomeObj'.
Date queries handle full date and time strings, using the format exported by the QSF backend. To query dates and times, convert user input into UTC time using qof_date_print and QOF_DATE_FORMAT_UTC
If the param is a KVP frame, then we use a special markup to indicate frame values. The markup should look like /some/kvp/path:value. Thus, for example,
SELECT * FROM SomeObj WHERE (param_a < '/some/kvp:10.0')
will search for the object where param_a is a KVP frame, and this KVP frame contains a path '/some/kvp' and the value stored at that path is floating-point and that float value is less than 10.0.
sql_query | Examples: |
"select * from pilot_expenses where type_of_expense = 'Mileage';"
"SELECT * from pilot_datebook where start_time > '2004-04-06T00:00Z' and end_time < '2005-04-05T23:59:59Z';"
"insert into pilot_todo (description, date_due, todo_priority) values ('put the cat out', '2005-11-24T21:30:00Z', 1)"
data | The QofMain context. |
Definition at line 528 of file qof-main.c.
References QofMain_s::sql_str.
Referenced by main().
00529 { 00530 data->sql_str = g_strdup (sql_query); 00531 }
void qof_mod_sql_file | ( | const gchar * | sql_file, | |
QofMainContext * | data | |||
) |
Specify one or more SQL queries contained in a file.
The rules for single SQL commands also apply with regard to the lack of explicit support for joins and the pending support for selecting only certain parameters from a certain object.
See qof_mod_sql for information on the queries supported.
Definition at line 534 of file qof-main.c.
References ERR_INDENT, qof_main_wrap_line(), QOF_SQL_SUPPORTED, QofMain_s::sql_file, and QofMain_s::sql_list.
Referenced by main().
00535 { 00536 FILE *filehandle; 00537 #ifndef HAVE_GETLINE 00538 gchar lineptr[1024]; 00539 #else 00540 gchar *lineptr; 00541 #endif 00542 gchar *buf; 00543 size_t n; 00544 QofQuery *q; 00545 regex_t *r; 00546 gint reg_exp_check; 00547 const gchar *fmt; 00548 static const gchar *pattern = QOF_SQL_SUPPORTED; 00549 00550 ENTER (" "); 00551 data->sql_file = g_strdup (sql_file); 00552 n = 0; 00553 q = NULL; 00554 data->sql_list = NULL; 00555 filehandle = fopen (sql_file, "r"); 00556 if (!filehandle) 00557 { 00558 fmt = _("%s: There was an error reading the file '%s'.\n"); 00559 qof_main_wrap_line (stderr, ERR_INDENT, fmt, PACKAGE, sql_file); 00560 return; 00561 } 00562 r = g_new (regex_t, 1); 00563 #ifndef HAVE_GETLINE 00564 while (NULL != (fgets (lineptr, sizeof (lineptr), filehandle))) 00565 #else 00566 lineptr = NULL; 00567 while (0 < getline (&lineptr, &n, filehandle)) 00568 #endif 00569 { 00570 reg_exp_check = 00571 regcomp (r, pattern, REG_ICASE | REG_NOSUB | REG_EXTENDED); 00572 g_return_if_fail (reg_exp_check == 0); 00573 if (0 != regexec (r, lineptr, 0, NULL, 0)) 00574 continue; 00575 buf = g_strdup (g_strchomp (lineptr)); 00576 data->sql_list = g_list_prepend (data->sql_list, buf); 00577 } 00578 regfree (r); 00579 g_free (r); 00580 fclose (filehandle); 00581 LEAVE (" sql_list=%d", g_list_length (data->sql_list)); 00582 }
void qof_mod_time | ( | const gchar * | date_time, | |
QofMainContext * | data | |||
) |
Shorthand to only query objects that contain the specified date.
Used to modify the QOF query to only query objects that contain at least one parameter containing a QOF_TYPE_TIME that matches the range specified. Dates need to be specified as YY-MM-DD, i.e. QOF_DATE_FORMAT_ISO.
You can specify a UTC timestring, just as normally output by QSF, but the time will not be matched when using the shorthand option, only the year, month and day.
For more precise time matches or to set a defined period that doesn't follow whole calendar months, (e.g. the UK financial year) use a SQL statement:
"SELECT * from pilot_datebook where start_time > '2004-04-06T00:00Z'
and end_time < '2005-04-05T23:59:59Z';"
Partial matches are allowed, so YY-MM matches any object where a date is within the specified month and year, YY matches any object where a date is within the specified year.
The query range starts at midnight on the first day of the range and ends at 1 second to midnight on the last day of the range.
Definition at line 473 of file qof-main.c.
References QofMain_s::max_qt, QofMain_s::min_qt, and qof_mod_get_local_offset().
Referenced by main().
00474 { 00475 QofDate *qd; 00476 gboolean all_year, all_month; 00477 gint adding_days; 00478 gchar *info; 00479 00480 /* incoming date is assumed to be localtime */ 00481 ENTER (" date_time=%s", date_time); 00482 all_month = all_year = FALSE; 00483 g_return_if_fail (date_time); 00484 qd = qof_date_parse (date_time, QOF_DATE_FORMAT_ISO); 00485 if (!qd) 00486 qd = qof_date_parse (date_time, QOF_DATE_FORMAT_UTC); 00487 info = qof_date_print (qd, QOF_DATE_FORMAT_ISO8601); 00488 PINFO (" parsed start_time=%s", info); 00489 g_free (info); 00490 /* set first second of day, UTC */ 00491 qof_date_set_day_start (qd); 00492 data->min_qt = qof_date_to_qtime (qd); 00493 /* adjust for incoming localtime */ 00494 qof_time_add_secs (data->min_qt, 00495 qof_mod_get_local_offset()); 00496 /* year specified but no month or day, select the entire year */ 00497 if (strlen (date_time) == 4) 00498 { 00499 PINFO (" match entire year %s", date_time); 00500 /* go to end of this year, not first day of next. */ 00501 adding_days = qof_date_isleap(qd->qd_year) ? 365 : 364; 00502 qof_date_adddays (qd, adding_days); 00503 } 00504 /* month specified, but no day, select entire month */ 00505 if (strlen (date_time) == 7) 00506 { 00507 PINFO (" match entire month %s", date_time); 00508 adding_days = qof_date_get_mday (qd->qd_mon, qd->qd_year); 00509 qof_date_adddays (qd, adding_days - 1); 00510 } 00511 /* set last second of day */ 00512 qof_date_set_day_end (qd); 00513 data->max_qt = qof_date_to_qtime (qd); 00514 /* adjust for incoming localtime */ 00515 qof_time_add_secs (data->max_qt, 00516 qof_mod_get_local_offset()); 00517 LEAVE (" "); 00518 }
void qof_mod_write | ( | const gchar * | write_file, | |
QofMainContext * | data | |||
) |
Write the results of any query to the file.
filename of the file to be written out.
Definition at line 585 of file qof-main.c.
References QofMain_s::write_file.
Referenced by main().
00586 { 00587 data->write_file = g_strdup (write_file); 00588 }