From: Ben Pfaff Date: Wed, 9 Feb 2011 00:09:45 +0000 (-0800) Subject: ovsdb-client: Break table formatting into new library. X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=3a3eb9daef012e58d6604a6fc726a5115b25945f;p=openvswitch ovsdb-client: Break table formatting into new library. This makes the table formatting functions available to other programs. ovs-vsctl will start using it soon on the "list" and "find" commands. --- diff --git a/lib/automake.mk b/lib/automake.mk index c51d3ed8..2758d361 100644 --- a/lib/automake.mk +++ b/lib/automake.mk @@ -140,6 +140,8 @@ lib_libopenvswitch_a_SOURCES = \ lib/string.h \ lib/svec.c \ lib/svec.h \ + lib/table.c \ + lib/table.h \ lib/tag.c \ lib/tag.h \ lib/timeval.c \ @@ -229,6 +231,7 @@ EXTRA_DIST += \ lib/ssl.man \ lib/ssl-syn.man \ lib/stress-unixctl.man \ + lib/table.man \ lib/unixctl.man \ lib/unixctl-syn.man \ lib/vconn-active.man \ diff --git a/lib/table.c b/lib/table.c new file mode 100644 index 00000000..d150b292 --- /dev/null +++ b/lib/table.c @@ -0,0 +1,518 @@ +/* + * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#include + +#include "table.h" + +#include + +#include "dynamic-string.h" +#include "json.h" +#include "ovsdb-data.h" +#include "util.h" + +struct column { + char *heading; +}; + +static char * +cell_to_text(struct cell *cell, const struct table_style *style) +{ + if (!cell->text) { + if (cell->json) { + if (style->cell_format == CF_JSON || !cell->type) { + cell->text = json_to_string(cell->json, JSSF_SORT); + } else if (style->cell_format == CF_STRING) { + struct ovsdb_datum datum; + struct ovsdb_error *error; + struct ds s; + + error = ovsdb_datum_from_json(&datum, cell->type, cell->json, + NULL); + if (!error) { + ds_init(&s); + ovsdb_datum_to_string(&datum, cell->type, &s); + ovsdb_datum_destroy(&datum, cell->type); + cell->text = ds_steal_cstr(&s); + } else { + cell->text = json_to_string(cell->json, JSSF_SORT); + } + } else { + NOT_REACHED(); + } + } else { + cell->text = xstrdup(""); + } + } + + return cell->text; +} + +static void +cell_destroy(struct cell *cell) +{ + free(cell->text); + json_destroy(cell->json); +} + +/* Initializes 'table' as an empty table. + * + * The caller should then: + * + * 1. Call table_add_column() once for each column. + * 2. For each row: + * 2a. Call table_add_row(). + * 2b. For each column in the cell, call table_add_cell() and fill in + * the returned cell. + * 3. Call table_print() to print the final table. + * 4. Free the table with table_destroy(). + */ +void +table_init(struct table *table) +{ + memset(table, 0, sizeof *table); +} + +/* Destroys 'table' and frees all associated storage. (However, the client + * owns the 'type' members pointed to by cells, so these are not destroyed.) */ +void +table_destroy(struct table *table) +{ + if (table) { + size_t i; + + for (i = 0; i < table->n_columns; i++) { + free(table->columns[i].heading); + } + free(table->columns); + + for (i = 0; i < table->n_columns * table->n_rows; i++) { + cell_destroy(&table->cells[i]); + } + free(table->cells); + + free(table->caption); + } +} + +/* Sets 'caption' as the caption for 'table'. + * + * 'table' takes ownership of 'caption'. */ +void +table_set_caption(struct table *table, char *caption) +{ + free(table->caption); + table->caption = caption; +} + +/* Adds a new column to 'table' just to the right of any existing column, with + * 'heading' as a title for the column. 'heading' must be a valid printf() + * format specifier. + * + * Columns must be added before any data is put into 'table'. */ +void +table_add_column(struct table *table, const char *heading, ...) +{ + struct column *column; + va_list args; + + assert(!table->n_rows); + if (table->n_columns >= table->allocated_columns) { + table->columns = x2nrealloc(table->columns, &table->allocated_columns, + sizeof *table->columns); + } + column = &table->columns[table->n_columns++]; + + va_start(args, heading); + column->heading = xvasprintf(heading, args); + va_end(args); +} + +static struct cell * +table_cell__(const struct table *table, size_t row, size_t column) +{ + return &table->cells[column + row * table->n_columns]; +} + +/* Adds a new row to 'table'. The table's columns must already have been added + * with table_add_column(). + * + * The row is initially empty; use table_add_cell() to start filling it in. */ +void +table_add_row(struct table *table) +{ + size_t x, y; + + if (table->n_rows >= table->allocated_rows) { + table->cells = x2nrealloc(table->cells, &table->allocated_rows, + table->n_columns * sizeof *table->cells); + } + + y = table->n_rows++; + table->current_column = 0; + for (x = 0; x < table->n_columns; x++) { + struct cell *cell = table_cell__(table, y, x); + memset(cell, 0, sizeof *cell); + } +} + +/* Adds a new cell in the current row of 'table', which must have been added + * with table_add_row(). Cells are filled in the same order that the columns + * were added with table_add_column(). + * + * The caller is responsible for filling in the returned cell, in one of two + * fashions: + * + * - If the cell should contain an ovsdb_datum, formatted according to the + * table style, then fill in the 'json' member with the JSON representation + * of the datum and 'type' with its type. + * + * - If the cell should contain a fixed text string, then the caller should + * assign that string to the 'text' member. This is undesirable if the + * cell actually contains OVSDB data because 'text' cannot be formatted + * according to the table style; it is always output verbatim. + */ +struct cell * +table_add_cell(struct table *table) +{ + size_t x, y; + + assert(table->n_rows > 0); + assert(table->current_column < table->n_columns); + + x = table->current_column++; + y = table->n_rows - 1; + + return table_cell__(table, y, x); +} + +static void +table_print_table_line__(struct ds *line) +{ + puts(ds_cstr(line)); + ds_clear(line); +} + +static void +table_print_table__(const struct table *table, const struct table_style *style) +{ + static int n = 0; + struct ds line = DS_EMPTY_INITIALIZER; + int *widths; + size_t x, y; + + if (n++ > 0) { + putchar('\n'); + } + + if (table->caption) { + puts(table->caption); + } + + widths = xmalloc(table->n_columns * sizeof *widths); + for (x = 0; x < table->n_columns; x++) { + const struct column *column = &table->columns[x]; + + widths[x] = strlen(column->heading); + for (y = 0; y < table->n_rows; y++) { + const char *text = cell_to_text(table_cell__(table, y, x), style); + size_t length = strlen(text); + + if (length > widths[x]) { + widths[x] = length; + } + } + } + + if (style->headings) { + for (x = 0; x < table->n_columns; x++) { + const struct column *column = &table->columns[x]; + if (x) { + ds_put_char(&line, ' '); + } + ds_put_format(&line, "%-*s", widths[x], column->heading); + } + table_print_table_line__(&line); + + for (x = 0; x < table->n_columns; x++) { + if (x) { + ds_put_char(&line, ' '); + } + ds_put_char_multiple(&line, '-', widths[x]); + } + table_print_table_line__(&line); + } + + for (y = 0; y < table->n_rows; y++) { + for (x = 0; x < table->n_columns; x++) { + const char *text = cell_to_text(table_cell__(table, y, x), style); + if (x) { + ds_put_char(&line, ' '); + } + ds_put_format(&line, "%-*s", widths[x], text); + } + table_print_table_line__(&line); + } + + ds_destroy(&line); + free(widths); +} + +static void +table_escape_html_text__(const char *s, size_t n) +{ + size_t i; + + for (i = 0; i < n; i++) { + char c = s[i]; + + switch (c) { + case '&': + fputs("&", stdout); + break; + case '<': + fputs("<", stdout); + break; + case '>': + fputs(">", stdout); + break; + case '"': + fputs(""", stdout); + break; + default: + putchar(c); + break; + } + } +} + +static void +table_print_html_cell__(const char *element, const char *content) +{ + const char *p; + + printf(" <%s>", element); + for (p = content; *p; ) { + struct uuid uuid; + + if (uuid_from_string_prefix(&uuid, p)) { + printf("%.*s", UUID_LEN, p, 8, p); + p += UUID_LEN; + } else { + table_escape_html_text__(p, 1); + p++; + } + } + printf("\n", element); +} + +static void +table_print_html__(const struct table *table, const struct table_style *style) +{ + size_t x, y; + + fputs("\n", stdout); + + if (table->caption) { + table_print_html_cell__("caption", table->caption); + } + + if (style->headings) { + fputs(" \n", stdout); + for (x = 0; x < table->n_columns; x++) { + const struct column *column = &table->columns[x]; + table_print_html_cell__("th", column->heading); + } + fputs(" \n", stdout); + } + + for (y = 0; y < table->n_rows; y++) { + fputs(" \n", stdout); + for (x = 0; x < table->n_columns; x++) { + const char *content; + + content = cell_to_text(table_cell__(table, y, x), style); + if (!strcmp(table->columns[x].heading, "_uuid")) { + fputs(" \n", stdout); + } else { + table_print_html_cell__("td", content); + } + } + fputs(" \n", stdout); + } + + fputs("
", stdout); + table_escape_html_text__(content, 8); + fputs("
\n", stdout); +} + +static void +table_print_csv_cell__(const char *content) +{ + const char *p; + + if (!strpbrk(content, "\n\",")) { + fputs(content, stdout); + } else { + putchar('"'); + for (p = content; *p != '\0'; p++) { + switch (*p) { + case '"': + fputs("\"\"", stdout); + break; + default: + putchar(*p); + break; + } + } + putchar('"'); + } +} + +static void +table_print_csv__(const struct table *table, const struct table_style *style) +{ + static int n = 0; + size_t x, y; + + if (n++ > 0) { + putchar('\n'); + } + + if (table->caption) { + puts(table->caption); + } + + if (style->headings) { + for (x = 0; x < table->n_columns; x++) { + const struct column *column = &table->columns[x]; + if (x) { + putchar(','); + } + table_print_csv_cell__(column->heading); + } + putchar('\n'); + } + + for (y = 0; y < table->n_rows; y++) { + for (x = 0; x < table->n_columns; x++) { + if (x) { + putchar(','); + } + table_print_csv_cell__(cell_to_text(table_cell__(table, y, x), + style)); + } + putchar('\n'); + } +} + +static void +table_print_json__(const struct table *table, const struct table_style *style) +{ + struct json *json, *headings, *data; + size_t x, y; + char *s; + + json = json_object_create(); + if (table->caption) { + json_object_put_string(json, "caption", table->caption); + } + + headings = json_array_create_empty(); + for (x = 0; x < table->n_columns; x++) { + const struct column *column = &table->columns[x]; + json_array_add(headings, json_string_create(column->heading)); + } + json_object_put(json, "headings", headings); + + data = json_array_create_empty(); + for (y = 0; y < table->n_rows; y++) { + struct json *row = json_array_create_empty(); + for (x = 0; x < table->n_columns; x++) { + const struct cell *cell = table_cell__(table, y, x); + if (cell->text) { + json_array_add(row, json_string_create(cell->text)); + } else { + json_array_add(row, json_clone(cell->json)); + } + } + json_array_add(data, row); + } + json_object_put(json, "data", data); + + s = json_to_string(json, style->json_flags); + json_destroy(json); + puts(s); + free(s); +} + +/* Parses 'format' as the argument to a --format command line option, updating + * 'style->format'. */ +void +table_parse_format(struct table_style *style, const char *format) +{ + if (!strcmp(format, "table")) { + style->format = TF_TABLE; + } else if (!strcmp(format, "html")) { + style->format = TF_HTML; + } else if (!strcmp(format, "csv")) { + style->format = TF_CSV; + } else if (!strcmp(format, "json")) { + style->format = TF_JSON; + } else { + ovs_fatal(0, "unknown output format \"%s\"", format); + } +} + +/* Parses 'format' as the argument to a --data command line option, updating + * 'style->cell_format'. */ +void +table_parse_cell_format(struct table_style *style, const char *format) +{ + if (!strcmp(format, "string")) { + style->cell_format = CF_STRING; + } else if (!strcmp(format, "json")) { + style->cell_format = CF_JSON; + } else { + ovs_fatal(0, "unknown data format \"%s\"", format); + } +} + +/* Outputs 'table' on stdout in the specified 'style'. */ +void +table_print(const struct table *table, const struct table_style *style) +{ + switch (style->format) { + case TF_TABLE: + table_print_table__(table, style); + break; + + case TF_HTML: + table_print_html__(table, style); + break; + + case TF_CSV: + table_print_csv__(table, style); + break; + + case TF_JSON: + table_print_json__(table, style); + break; + } +} diff --git a/lib/table.h b/lib/table.h new file mode 100644 index 00000000..c24bca2a --- /dev/null +++ b/lib/table.h @@ -0,0 +1,113 @@ +/* + * Copyright (c) 2009, 2010, 2011 Nicira Networks. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at: + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +#ifndef TABLE_H +#define TABLE_H 1 + +#include +#include +#include "compiler.h" + +struct table_style; + +/* Manipulating tables and their rows and columns. */ + +struct table { + struct cell *cells; + struct column *columns; + size_t n_columns, allocated_columns; + size_t n_rows, allocated_rows; + size_t current_column; + char *caption; +}; + +void table_init(struct table *); +void table_destroy(struct table *); +void table_set_caption(struct table *, char *caption); + +void table_add_column(struct table *, const char *heading, ...) + PRINTF_FORMAT(2, 3); +void table_add_row(struct table *); + +/* Table cells. */ + +struct cell { + /* Literal text. */ + char *text; + + /* JSON. */ + struct json *json; + const struct ovsdb_type *type; +}; + +struct cell *table_add_cell(struct table *); + +/* Table formatting. */ + +enum table_format { + TF_TABLE, /* 2-d table. */ + TF_HTML, /* HTML table. */ + TF_CSV, /* Comma-separated lines. */ + TF_JSON /* JSON. */ +}; + +enum cell_format { + CF_STRING, /* String format. */ + CF_JSON /* JSON. */ +}; + +struct table_style { + enum table_format format; /* TF_*. */ + enum cell_format cell_format; /* CF_*. */ + bool headings; /* Include headings? */ + int json_flags; /* CF_JSON: Flags for json_to_string(). */ +}; + +#define TABLE_STYLE_DEFAULT { TF_TABLE, CF_STRING, true, JSSF_SORT } + +#define TABLE_OPTION_ENUMS \ + OPT_NO_HEADINGS, \ + OPT_PRETTY + +#define TABLE_LONG_OPTIONS \ + {"format", required_argument, 0, 'f'}, \ + {"data", required_argument, 0, 'd'}, \ + {"no-headings", no_argument, 0, OPT_NO_HEADINGS}, \ + {"pretty", no_argument, 0, OPT_PRETTY}, + +#define TABLE_OPTION_HANDLERS(STYLE) \ + case 'f': \ + table_parse_format(STYLE, optarg); \ + break; \ + \ + case 'd': \ + table_parse_cell_format(STYLE, optarg); \ + break; \ + \ + case OPT_NO_HEADINGS: \ + (STYLE)->headings = false; \ + break; \ + \ + case OPT_PRETTY: \ + (STYLE)->json_flags |= JSSF_PRETTY; \ + break; + +void table_parse_format(struct table_style *, const char *format); +void table_parse_cell_format(struct table_style *, const char *format); + +void table_print(const struct table *, const struct table_style *); + +#endif /* table.h */ diff --git a/lib/table.man b/lib/table.man new file mode 100644 index 00000000..8be272aa --- /dev/null +++ b/lib/table.man @@ -0,0 +1,58 @@ +.IP "\fB\-f \fIformat\fR" +.IQ "\fB\-\-format=\fIformat\fR" +Sets the type of table formatting. The following types of +\fIformat\fR are available: +.RS +.IP "\fBtable\fR (default)" +Text-based tables with aligned columns. +.IP "\fBhtml\fR" +HTML tables. +.IP "\fBcvs\fR" +Comma-separated values as defined in RFC 4180. +.IP "\fBjson\fR" +JSON format as defined in RFC 4627. The output is a sequence of JSON +objects, each of which corresponds to one table. Each JSON object has +the following members with the noted values: +.RS +.IP "\fBcaption\fR" +The table's caption. This member is omitted if the table has no +caption. +.IP "\fBheadings\fR" +An array with one element per table column. Each array element is a +string giving the corresponding column's heading. +.IP "\fBdata\fR" +An array with one element per table row. Each element is also an +array with one element per table column. The elements of this +second-level array are the cells that constitute the table. Cells +that represent OVSDB data or data types are expressed in the format +described in the OVSDB specification; other cells are simply expressed +as text strings. +.RE +.RE +. +.IP "\fB\-d \fIformat\fR" +.IP "\fB\-\-data=\fIformat\fR" +Sets the formatting for cells within output tables. The following +types of \fIformat\fR are available: +.RS +.IP "\fBstring\fR (default)" +The simple format described in \fBovs\-vsctl\fR(8). +.IP "\fBjson\fR" +JSON. +.RE +.IP +The \fBjson\fR output format always outputs cells in JSON format, +ignoring this option. +. +.IP "\fB\-\-no\-heading\fR" +This option suppresses the heading row that otherwise appears in the +first row of table output. +. +.IP "\fB\-\-pretty\fR" +By default, JSON in output is printed as compactly as possible. This +option causes JSON in output to be printed in a more readable +fashion. Members of objects and elements of arrays are printed one +per line, with indentation. +.IP +This option does not affect JSON in tables, which is always printed +compactly. diff --git a/ovsdb/ovsdb-client.1.in b/ovsdb/ovsdb-client.1.in index 725211d7..2b1281dc 100644 --- a/ovsdb/ovsdb-client.1.in +++ b/ovsdb/ovsdb-client.1.in @@ -127,64 +127,7 @@ contents of \fItable\fR. Much of the output from \fBovsdb\-client\fR is in the form of tables. The following options controlling output formatting: . -.IP "\fB\-f \fIformat\fR" -.IQ "\fB\-\-format=\fIformat\fR" -Sets the type of table formatting. The following types of -\fIformat\fR are available: -.RS -.IP "\fBtable\fR (default)" -Text-based tables with aligned columns. -.IP "\fBhtml\fR" -HTML tables. -.IP "\fBcvs\fR" -Comma-separated values as defined in RFC 4180. -.IP "\fBjson\fR" -JSON format as defined in RFC 4627. The output is a sequence of JSON -objects, each of which corresponds to one table. Each JSON object has -the following members with the noted values: -.RS -.IP "\fBcaption\fR" -The table's caption. This member is omitted if the table has no -caption. -.IP "\fBheadings\fR" -An array with one element per table column. Each array element is a -string giving the corresponding column's heading. -.IP "\fBdata\fR" -An array with one element per table row. Each element is also an -array with one element per table column. The elements of this -second-level array are the cells that constitute the table. Cells -that represent OVSDB data or data types are expressed in the format -described in the OVSDB specification; other cells are simply expressed -as text strings. -.RE -.RE -. -.IP "\fB\-d \fIformat\fR" -.IP "\fB\-\-data=\fIformat\fR" -Sets the formatting for cells within output tables. The following -types of \fIformat\fR are available: -.RS -.IP "\fBstring\fR (default)" -The simple format described in \fBovs\-vsctl\fR(8). -.IP "\fBjson\fR" -JSON. -.RE -.IP -The \fBjson\fR output format always outputs cells in JSON format, -ignoring this option. -. -.IP "\fB\-\-no\-heading\fR" -This option suppresses the heading row that otherwise appears in the -first row of table output. -. -.IP "\fB\-\-pretty\fR" -By default, JSON in output is printed as compactly as possible. This -option causes JSON in output to be printed in a more readable -fashion. Members of objects and elements of arrays are printed one -per line, with indentation. -.IP -This option does not affect JSON in tables, which is always printed -compactly. +.so lib/table.man . .SS "Daemon Options" The daemon options apply only to the \fBmonitor\fR command. With any diff --git a/ovsdb/ovsdb-client.c b/ovsdb/ovsdb-client.c index 295a9be5..6402e907 100644 --- a/ovsdb/ovsdb-client.c +++ b/ovsdb/ovsdb-client.c @@ -1,5 +1,5 @@ /* - * Copyright (c) 2009, 2010 Nicira Networks. + * Copyright (c) 2009, 2010, 2011 Nicira Networks. * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. @@ -32,6 +32,7 @@ #include "dynamic-string.h" #include "json.h" #include "jsonrpc.h" +#include "lib/table.h" #include "ovsdb.h" #include "ovsdb-data.h" #include "ovsdb-error.h" @@ -45,25 +46,8 @@ VLOG_DEFINE_THIS_MODULE(ovsdb_client); -/* --format: Output formatting. */ -static enum { - FMT_TABLE, /* Textual table. */ - FMT_HTML, /* HTML table. */ - FMT_CSV, /* Comma-separated lines. */ - FMT_JSON /* JSON. */ -} output_format; - -/* --no-headings: Whether table output should include headings. */ -static int output_headings = true; - -/* --pretty: Flags to pass to json_to_string(). */ -static int json_flags = JSSF_SORT; - -/* --data: Format of data in output tables. */ -static enum { - DF_STRING, /* String format. */ - DF_JSON, /* JSON. */ -} data_format; +/* Format for table output. */ +static struct table_style table_style = TABLE_STYLE_DEFAULT; static const struct command all_commands[]; @@ -87,18 +71,16 @@ parse_options(int argc, char *argv[]) enum { OPT_BOOTSTRAP_CA_CERT = UCHAR_MAX + 1, DAEMON_OPTION_ENUMS, + TABLE_OPTION_ENUMS }; static struct option long_options[] = { - {"format", required_argument, 0, 'f'}, - {"data", required_argument, 0, 'd'}, - {"no-headings", no_argument, &output_headings, 0}, - {"pretty", no_argument, &json_flags, JSSF_PRETTY | JSSF_SORT}, {"verbose", optional_argument, 0, 'v'}, {"help", no_argument, 0, 'h'}, {"version", no_argument, 0, 'V'}, DAEMON_LONG_OPTIONS, #ifdef HAVE_OPENSSL {"bootstrap-ca-cert", required_argument, 0, OPT_BOOTSTRAP_CA_CERT}, + TABLE_LONG_OPTIONS STREAM_SSL_LONG_OPTIONS #endif {0, 0, 0, 0}, @@ -114,30 +96,6 @@ parse_options(int argc, char *argv[]) } switch (c) { - case 'f': - if (!strcmp(optarg, "table")) { - output_format = FMT_TABLE; - } else if (!strcmp(optarg, "html")) { - output_format = FMT_HTML; - } else if (!strcmp(optarg, "csv")) { - output_format = FMT_CSV; - } else if (!strcmp(optarg, "json")) { - output_format = FMT_JSON; - } else { - ovs_fatal(0, "unknown output format \"%s\"", optarg); - } - break; - - case 'd': - if (!strcmp(optarg, "string")) { - data_format = DF_STRING; - } else if (!strcmp(optarg, "json")) { - data_format = DF_JSON; - } else { - ovs_fatal(0, "unknown data format \"%s\"", optarg); - } - break; - case 'h': usage(); @@ -151,6 +109,8 @@ parse_options(int argc, char *argv[]) DAEMON_OPTION_HANDLERS + TABLE_OPTION_HANDLERS(&table_style) + #ifdef HAVE_OPENSSL STREAM_SSL_OPTION_HANDLERS @@ -257,7 +217,7 @@ open_jsonrpc(const char *server) static void print_json(struct json *json) { - char *string = json_to_string(json, json_flags); + char *string = json_to_string(json, table_style.json_flags); fputs(string, stdout); free(string); } @@ -311,440 +271,6 @@ fetch_schema(const char *server, const char *database) return schema; } -struct column { - char *heading; -}; - -struct cell { - /* Literal text. */ - char *text; - - /* JSON. */ - struct json *json; - const struct ovsdb_type *type; -}; - -static const char * -cell_to_text(const struct cell *cell_) -{ - struct cell *cell = (struct cell *) cell_; - if (!cell->text) { - if (cell->json) { - if (data_format == DF_JSON || !cell->type) { - cell->text = json_to_string(cell->json, JSSF_SORT); - } else if (data_format == DF_STRING) { - struct ovsdb_datum datum; - struct ovsdb_error *error; - struct ds s; - - error = ovsdb_datum_from_json(&datum, cell->type, cell->json, - NULL); - if (!error) { - ds_init(&s); - ovsdb_datum_to_string(&datum, cell->type, &s); - ovsdb_datum_destroy(&datum, cell->type); - cell->text = ds_steal_cstr(&s); - } else { - cell->text = json_to_string(cell->json, JSSF_SORT); - } - } else { - NOT_REACHED(); - } - } else { - cell->text = xstrdup(""); - } - } - - return cell->text; -} - -static void -cell_destroy(struct cell *cell) -{ - free(cell->text); - json_destroy(cell->json); -} - -struct table { - struct cell *cells; - struct column *columns; - size_t n_columns, allocated_columns; - size_t n_rows, allocated_rows; - size_t current_column; - char *caption; -}; - -static void -table_init(struct table *table) -{ - memset(table, 0, sizeof *table); -} - -static void -table_destroy(struct table *table) -{ - size_t i; - - for (i = 0; i < table->n_columns; i++) { - free(table->columns[i].heading); - } - free(table->columns); - - for (i = 0; i < table->n_columns * table->n_rows; i++) { - cell_destroy(&table->cells[i]); - } - free(table->cells); - - free(table->caption); -} - -static void -table_set_caption(struct table *table, char *caption) -{ - free(table->caption); - table->caption = caption; -} - -static void -table_add_column(struct table *table, const char *heading, ...) - PRINTF_FORMAT(2, 3); - -static void -table_add_column(struct table *table, const char *heading, ...) -{ - struct column *column; - va_list args; - - assert(!table->n_rows); - if (table->n_columns >= table->allocated_columns) { - table->columns = x2nrealloc(table->columns, &table->allocated_columns, - sizeof *table->columns); - } - column = &table->columns[table->n_columns++]; - - va_start(args, heading); - column->heading = xvasprintf(heading, args); - va_end(args); -} - -static struct cell * -table_cell__(const struct table *table, size_t row, size_t column) -{ - return &table->cells[column + row * table->n_columns]; -} - -static void -table_add_row(struct table *table) -{ - size_t x, y; - - if (table->n_rows >= table->allocated_rows) { - table->cells = x2nrealloc(table->cells, &table->allocated_rows, - table->n_columns * sizeof *table->cells); - } - - y = table->n_rows++; - table->current_column = 0; - for (x = 0; x < table->n_columns; x++) { - struct cell *cell = table_cell__(table, y, x); - memset(cell, 0, sizeof *cell); - } -} - -static struct cell * -table_add_cell(struct table *table) -{ - size_t x, y; - - assert(table->n_rows > 0); - assert(table->current_column < table->n_columns); - - x = table->current_column++; - y = table->n_rows - 1; - - return table_cell__(table, y, x); -} - -static void -table_print_table_line__(struct ds *line) -{ - puts(ds_cstr(line)); - ds_clear(line); -} - -static void -table_print_table__(const struct table *table) -{ - static int n = 0; - struct ds line = DS_EMPTY_INITIALIZER; - int *widths; - size_t x, y; - - if (n++ > 0) { - putchar('\n'); - } - - if (table->caption) { - puts(table->caption); - } - - widths = xmalloc(table->n_columns * sizeof *widths); - for (x = 0; x < table->n_columns; x++) { - const struct column *column = &table->columns[x]; - - widths[x] = strlen(column->heading); - for (y = 0; y < table->n_rows; y++) { - const char *text = cell_to_text(table_cell__(table, y, x)); - size_t length = strlen(text); - - if (length > widths[x]) - widths[x] = length; - } - } - - if (output_headings) { - for (x = 0; x < table->n_columns; x++) { - const struct column *column = &table->columns[x]; - if (x) { - ds_put_char(&line, ' '); - } - ds_put_format(&line, "%-*s", widths[x], column->heading); - } - table_print_table_line__(&line); - - for (x = 0; x < table->n_columns; x++) { - if (x) { - ds_put_char(&line, ' '); - } - ds_put_char_multiple(&line, '-', widths[x]); - } - table_print_table_line__(&line); - } - - for (y = 0; y < table->n_rows; y++) { - for (x = 0; x < table->n_columns; x++) { - const char *text = cell_to_text(table_cell__(table, y, x)); - if (x) { - ds_put_char(&line, ' '); - } - ds_put_format(&line, "%-*s", widths[x], text); - } - table_print_table_line__(&line); - } - - ds_destroy(&line); - free(widths); -} - -static void -table_escape_html_text__(const char *s, size_t n) -{ - size_t i; - - for (i = 0; i < n; i++) { - char c = s[i]; - - switch (c) { - case '&': - fputs("&", stdout); - break; - case '<': - fputs("<", stdout); - break; - case '>': - fputs(">", stdout); - break; - case '"': - fputs(""", stdout); - break; - default: - putchar(c); - break; - } - } -} - -static void -table_print_html_cell__(const char *element, const char *content) -{ - const char *p; - - printf(" <%s>", element); - for (p = content; *p; ) { - struct uuid uuid; - - if (uuid_from_string_prefix(&uuid, p)) { - printf("%.*s", UUID_LEN, p, 8, p); - p += UUID_LEN; - } else { - table_escape_html_text__(p, 1); - p++; - } - } - printf("\n", element); -} - -static void -table_print_html__(const struct table *table) -{ - size_t x, y; - - fputs("\n", stdout); - - if (table->caption) { - table_print_html_cell__("caption", table->caption); - } - - if (output_headings) { - fputs(" \n", stdout); - for (x = 0; x < table->n_columns; x++) { - const struct column *column = &table->columns[x]; - table_print_html_cell__("th", column->heading); - } - fputs(" \n", stdout); - } - - for (y = 0; y < table->n_rows; y++) { - fputs(" \n", stdout); - for (x = 0; x < table->n_columns; x++) { - const char *content = cell_to_text(table_cell__(table, y, x)); - - if (!strcmp(table->columns[x].heading, "_uuid")) { - fputs(" \n", stdout); - } else { - table_print_html_cell__("td", content); - } - } - fputs(" \n", stdout); - } - - fputs("
", stdout); - table_escape_html_text__(content, 8); - fputs("
\n", stdout); -} - -static void -table_print_csv_cell__(const char *content) -{ - const char *p; - - if (!strpbrk(content, "\n\",")) { - fputs(content, stdout); - } else { - putchar('"'); - for (p = content; *p != '\0'; p++) { - switch (*p) { - case '"': - fputs("\"\"", stdout); - break; - default: - putchar(*p); - break; - } - } - putchar('"'); - } -} - -static void -table_print_csv__(const struct table *table) -{ - static int n = 0; - size_t x, y; - - if (n++ > 0) { - putchar('\n'); - } - - if (table->caption) { - puts(table->caption); - } - - if (output_headings) { - for (x = 0; x < table->n_columns; x++) { - const struct column *column = &table->columns[x]; - if (x) { - putchar(','); - } - table_print_csv_cell__(column->heading); - } - putchar('\n'); - } - - for (y = 0; y < table->n_rows; y++) { - for (x = 0; x < table->n_columns; x++) { - if (x) { - putchar(','); - } - table_print_csv_cell__(cell_to_text(table_cell__(table, y, x))); - } - putchar('\n'); - } -} - -static void -table_print_json__(const struct table *table) -{ - struct json *json, *headings, *data; - size_t x, y; - char *s; - - json = json_object_create(); - if (table->caption) { - json_object_put_string(json, "caption", table->caption); - } - - headings = json_array_create_empty(); - for (x = 0; x < table->n_columns; x++) { - const struct column *column = &table->columns[x]; - json_array_add(headings, json_string_create(column->heading)); - } - json_object_put(json, "headings", headings); - - data = json_array_create_empty(); - for (y = 0; y < table->n_rows; y++) { - struct json *row = json_array_create_empty(); - for (x = 0; x < table->n_columns; x++) { - const struct cell *cell = table_cell__(table, y, x); - if (cell->text) { - json_array_add(row, json_string_create(cell->text)); - } else { - json_array_add(row, json_clone(cell->json)); - } - } - json_array_add(data, row); - } - json_object_put(json, "data", data); - - s = json_to_string(json, json_flags); - json_destroy(json); - puts(s); - free(s); -} - -static void -table_print(const struct table *table) -{ - switch (output_format) { - case FMT_TABLE: - table_print_table__(table); - break; - - case FMT_HTML: - table_print_html__(table); - break; - - case FMT_CSV: - table_print_csv__(table); - break; - - case FMT_JSON: - table_print_json__(table); - break; - } -} static void do_list_dbs(int argc OVS_UNUSED, char *argv[]) @@ -810,7 +336,7 @@ do_list_tables(int argc OVS_UNUSED, char *argv[]) table_add_cell(&t)->text = xstrdup(ts->name); } ovsdb_schema_destroy(schema); - table_print(&t); + table_print(&t, &table_style); } static void @@ -847,7 +373,7 @@ do_list_columns(int argc OVS_UNUSED, char *argv[]) } } ovsdb_schema_destroy(schema); - table_print(&t); + table_print(&t, &table_style); } static void @@ -868,7 +394,7 @@ do_transact(int argc OVS_UNUSED, char *argv[]) } if (reply->error) { ovs_fatal(error, "transaction returned error: %s", - json_to_string(reply->error, json_flags)); + json_to_string(reply->error, table_style.json_flags)); } print_json(reply->result); putchar('\n'); @@ -955,7 +481,7 @@ monitor_print(struct json *table_updates, monitor_print_row(new, "new", "", columns, &t); } } - table_print(&t); + table_print(&t, &table_style); table_destroy(&t); } @@ -1266,7 +792,7 @@ dump_table(const struct ovsdb_table_schema *ts, struct json_array *rows) cell->type = &columns[x]->type; } } - table_print(&t); + table_print(&t, &table_style); table_destroy(&t); }