From a24be1f0915646dd0390884ceb4ee1bfae7fbe0c Mon Sep 17 00:00:00 2001

From: Jakub Filak <jfilak@redhat.com>

Date: Wed, 25 Mar 2015 16:43:19 +0100

Subject: [PATCH 1010/1015] move problem_report to plugins

Get rid of satyr from libreport.

Signed-off-by: Jakub Filak <jfilak@redhat.com>

---

 po/POTFILES.in               |    2 +-

 src/include/Makefile.am      |    1 -

 src/include/problem_report.h |  334 ------------

 src/lib/Makefile.am          |    7 +-

 src/lib/problem_report.c     | 1210 ------------------------------------------

 src/plugins/Makefile.am      |   24 +-

 src/plugins/problem_report.c | 1210 ++++++++++++++++++++++++++++++++++++++++++

 src/plugins/problem_report.h |  334 ++++++++++++

 tests/testsuite.at           |    2 +-

 9 files changed, 1568 insertions(+), 1556 deletions(-)

 delete mode 100644 src/include/problem_report.h

 delete mode 100644 src/lib/problem_report.c

 create mode 100644 src/plugins/problem_report.c

 create mode 100644 src/plugins/problem_report.h

diff --git a/po/POTFILES.in b/po/POTFILES.in

index 9cf8f72..8b62b59 100644

--- a/po/POTFILES.in

+++ b/po/POTFILES.in

@@ -25,11 +25,11 @@ src/lib/ureport.c

 src/lib/make_descr.c

 src/lib/parse_options.c

 src/lib/problem_data.c

-src/lib/problem_report.c

 src/lib/reported_to.c

 src/lib/reporters.c

 src/lib/run_event.c

 src/plugins/abrt_rh_support.c

+src/plugins/problem_report.c

 src/plugins/report_Bugzilla.xml.in.in

 src/plugins/report.c

 src/plugins/reporter-bugzilla.c

diff --git a/src/include/Makefile.am b/src/include/Makefile.am

index 4d8c6a5..7a76cf4 100644

--- a/src/include/Makefile.am

+++ b/src/include/Makefile.am

@@ -5,7 +5,6 @@ libreport_include_HEADERS = \

     dump_dir.h \

     event_config.h \

     problem_data.h \

-    problem_report.h \

     report.h \

     run_event.h \

     libreport_curl.h \

diff --git a/src/include/problem_report.h b/src/include/problem_report.h

deleted file mode 100644

index f2d41d8..0000000

--- a/src/include/problem_report.h

+++ /dev/null

@@ -1,334 +0,0 @@

-/*

-    Copyright (C) 2014  ABRT team

-    Copyright (C) 2014  RedHat Inc

-

-    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.

-

-    @brief API for formating of problem data

-

-    These functions can be used to convert a problem data to its string

-    representation.

-

-    The output format can be parsed from a string:

-

-        problem_formatter_t *formatter = problem_formatter_new();

-        problem_formatter_load_string(formatter, MY_FORMAT_STRING);

-

-    or loaded from a file:

-

-        problem_formatter_t *formatter = problem_formatter_new();

-        problem_formatter_load_file(formatter, MY_FORMAT_FILE);

-

-    Once you have configured your formatter you can convert problem_data to

-    problem_report by calling:

-

-        problem_report_t *report;

-        if (problem_formatter_generate_report(formatter, data, &report) != 0)

-            errx(EXIT_FAILURE, "Problem data cannot be converted to problem report.");

-

-    Now you can print the report:

-

-        printf("Problem: %s\n", problem_report_get_summary());

-        printf("%s\n",          problem_report_get_description());

-

-        puts("Problem attachments:");

-        for (GList *a = problem_report_get_attachments(pr); a != NULL; a = g_list_next(a))

-            printf(" %s\n", a->data);

-

-    Format description:

-

-         ----

-         %summary:: summary format

-         %attach:: elemnt1[,element2]...

-         section:: element1[,element2]...

-         The literal text line to be added to report.

-         ----

-

-         Summary format is a line of text, where %element% is replaced by

-         text element's content, and [[...%element%...]] block is used only if

-         %element% exists. [[...]] blocks can nest.

-

-         Sections can be:

-         - %summary: bug summary format string.

-

-         - %attach: a list of elements to attach.

-

-         - text, double colon (::) and the list of comma-separated elements.

-           Text can be empty (":: elem1, elem2, elem3" works),

-           in this case "Text:" header line will be omitted.

-

-         - %description: this section is implicit and contains all text

-           sections unless another section was specified (%summary and %attach

-           are ignored when determining text section's placement)

-

-         - every text element belongs to the last specified section (%summary

-           and %attach sections are ignored). If no section was specified,

-           the text element belogns to %description.

-

-         - If none of elements exists, the section will not be created.

-

-         - Empty lines are NOT ignored.

-

-         Elements can be:

-         - problem directory element names, which get formatted as

-           <element_name>: <contents>

-           or

-           <element_name>:

-           :<contents>

-           :<contents>

-           :<contents>

-

-         - problem directory element names prefixed by "%bare_",

-           which is formatted as-is, without "<element_name>:" and colons

-

-         - %oneline, %multiline, %text wildcards, which select all corresponding

-           elements for output or attachment

-

-         - %binary wildcard, valid only for %attach section, instructs to attach

-           binary elements

-

-         - problem directory element names prefixed by "-",

-           which excludes given element from all wildcards

-

-         - Nonexistent elements are silently ignored.

-

-    You can add your own section:

-

-        problem_formatter_t *formatter = problem_formatter_new();

-        problem_formatter_add_section(formatter, "additional_info", PFFF_REQUIRED);

-

-    and then you can use the section in the formatting string:

-

-        problem_formatter_load_string(formatter,

-                "::comment\n"

-                "%additional_info:: maps");

-        problem_formatter_generate_report(formatter, data, &report);

-

-        printf("Problem: %s\n",         problem_report_get_summary());

-        printf("%s\n",                  problem_report_get_description());

-        printf("Additional info: %s\n", problem_report_get_section(report, "additiona_info"));

-

-    The lines above are equivalent to the following lines:

-

-        printf("Problem: %s\n",         problem_data_get_content_or_NULL(data, "reason"));

-        printf("%s\n",                  problem_data_get_content_or_NULL(data, "comment"));

-        printf("Additional info: %s\n", problem_data_get_content_or_NULL(data, "maps"));

-*/

-#ifndef LIBREPORT_PROBLEM_REPORT_H

-#define LIBREPORT_PROBLEM_REPORT_H

-

-#include <glib.h>

-#include <stdio.h>

-#include "problem_data.h"

-

-#ifdef __cplusplus

-extern "C" {

-#endif

-

-#define PR_SEC_SUMMARY "summary"

-#define PR_SEC_DESCRIPTION "description"

-

-/*

- * The problem report structure represents a problem data formatted according

- * to a format string.

- *

- * A problem report is composed of well-known sections:

- *   - summary

- *   - descritpion

- *   - attach

- *

- * and custom sections accessed by:

- *   problem_report_get_section();

- */

-struct problem_report;

-typedef struct problem_report problem_report_t;

-

-/*

- * Helpers for easily switching between FILE and struct strbuf

- */

-

-/*

- * Type of buffer used by Problem report

- */

-typedef FILE problem_report_buffer;

-

-/*

- * Wrapper for the proble buffer's formated output function.

- */

-#define problem_report_buffer_printf(buf, fmt, ...)\

-    fprintf((buf), (fmt), ##__VA_ARGS__)

-

-

-/*

- * Get a section buffer

- *

- * Use this function if you need to amend something to a formatted section.

- *

- * @param self Problem report

- * @param section_name Name of required section

- * @return Always valid pointer to a section buffer

- */

-problem_report_buffer *problem_report_get_buffer(const problem_report_t *self,

-        const char *section_name);

-

-/*

- * Get Summary string

- *

- * The returned pointer is valid as long as you perform no further output to

- * the summary buffer.

- *

- * @param self Problem report

- * @return Non-NULL pointer to summary data

- */

-const char *problem_report_get_summary(const problem_report_t *self);

-

-/*

- * Get Description string

- *

- * The returned pointer is valid as long as you perform no further output to

- * the description buffer.

- *

- * @param self Problem report

- * @return Non-NULL pointer to description data

- */

-const char *problem_report_get_description(const problem_report_t *self);

-

-/*

- * Get Section's string

- *

- * The returned pointer is valid as long as you perform no further output to

- * the section's buffer.

- *

- * @param self Problem report

- * @param section_name Name of the required section

- * @return Non-NULL pointer to description data

- */

-const char *problem_report_get_section(const problem_report_t *self,

-        const char *section_name);

-

-/*

- * Get GList of the problem data items that are to be attached

- *

- * @param self Problem report

- * @return A pointer to GList (NULL means empty list)

- */

-GList *problem_report_get_attachments(const problem_report_t *self);

-

-/*

- * Releases all resources allocated by a problem report

- *

- * @param self Problem report

- */

-void problem_report_free(problem_report_t *self);

-

-

-/*

- * An enum of Extra section flags

- */

-enum problem_formatter_section_flags {

-    PFFF_REQUIRED = 1 << 0, ///< section must be present in the format spec

-};

-

-/*

- * The problem formatter structure formats a problem data according to a format

- * string and stores result a problem report.

- *

- * The problem formatter uses '%reason%' as %summary section format string, if

- * %summary is not provided by a format string.

- */

-struct problem_formatter;

-typedef struct problem_formatter problem_formatter_t;

-

-/*

- * Constructs a new problem formatter.

- *

- * @return Non-NULL pointer to the new problem formatter

- */

-problem_formatter_t *problem_formatter_new(void);

-

-/*

- * Releases all resources allocated by a problem formatter

- *

- * @param self Problem formatter

- */

-void problem_formatter_free(problem_formatter_t *self);

-

-/*

- * Adds a new recognized section

- *

- * The problem formatter ignores a section in the format spec if the section is

- * not one of the default nor added by this function.

- *

- * How the problem formatter handles these extra sections:

- *

- * A custom section is something like %description section. %description is the

- * default section where all text (sub)sections are stored. If the formatter

- * finds the custom section in format string, then starts storing text

- * (sub)sections in the custom section.

- *

- * (%description)    |:: comment

- * (%description)    |

- * (%description)    |Package:: package

- * (%description)    |

- * (%additiona_info) |%additional_info::

- * (%additiona_info) |%reporter%

- * (%additiona_info) |User:: user_name,uid

- * (%additiona_info) |

- * (%additiona_info) |Directories:: root,cwd

- *

- *

- * @param self Problem formatter

- * @param name Name of the added section

- * @param flags Info about the added section

- * @return Zero on success. -EEXIST if the name is already known by the formatter

- */

-int problem_formatter_add_section(problem_formatter_t *self, const char *name, int flags);

-

-/*

- * Loads a problem format from a string.

- *

- * @param self Problem formatter

- * @param fmt Format

- * @return Zero on success or number of warnings (e.g. missing section,

- * unrecognized section).

- */

-int problem_formatter_load_string(problem_formatter_t* self, const char *fmt);

-

-/*

- * Loads a problem format from a file.

- *

- * @param self Problem formatter

- * @param pat Path to the format file

- * @return Zero on success or number of warnings (e.g. missing section,

- * unrecognized section).

- */

-int problem_formatter_load_file(problem_formatter_t* self, const char *path);

-

-/*

- * Creates a new problem report, formats the data according to the loaded

- * format string and stores output in the report.

- *

- * @param self Problem formatter

- * @param data Problem data to format

- * @param report Pointer where the created problem report is to be stored

- * @return Zero on success, otherwise non-zero value.

- */

-int problem_formatter_generate_report(const problem_formatter_t *self, problem_data_t *data, problem_report_t **report);

-

-#ifdef __cplusplus

-}

-#endif

-

-#endif // LIBREPORT_PROBLEM_REPORT_H

diff --git a/src/lib/Makefile.am b/src/lib/Makefile.am

index d41e543..80a7c4d 100644

--- a/src/lib/Makefile.am

+++ b/src/lib/Makefile.am

@@ -38,7 +38,6 @@ libreport_la_SOURCES = \

     make_descr.c \

     run_event.c \

     problem_data.c \

-    problem_report.c \

     create_dump_dir.c \

     abrt_types.c \

     parse_release.c \

@@ -80,7 +79,6 @@ libreport_la_CPPFLAGS = \

     $(GLIB_CFLAGS) \

     $(GOBJECT_CFLAGS) \

     $(AUGEAS_CFLAGS) \

-    $(SATYR_CFLAGS) \

     -D_GNU_SOURCE

 libreport_la_LDFLAGS = \

     -ltar \

@@ -90,8 +88,7 @@ libreport_la_LIBADD = \

     $(GLIB_LIBS) \

     $(JOURNAL_LIBS) \

     $(GOBJECT_LIBS) \

-    $(AUGEAS_LIBS) \

-    $(SATYR_LIBS)

+    $(AUGEAS_LIBS)

 libreportconfdir = $(CONF_DIR)

 dist_libreportconf_DATA = \

@@ -152,8 +149,8 @@ libreport_web_la_LIBADD = \

     $(PROXY_LIBS) \

     $(LIBXML_LIBS) \

     $(JSON_C_LIBS) \

-    $(SATYR_LIBS) \

     $(XMLRPC_LIBS) $(XMLRPC_CLIENT_LIBS) \

+    $(SATYR_LIBS) \

     libreport.la

 DEFS = -DLOCALEDIR=\"$(localedir)\" @DEFS@

diff --git a/src/lib/problem_report.c b/src/lib/problem_report.c

deleted file mode 100644

index 2bf5530..0000000

--- a/src/lib/problem_report.c

+++ /dev/null

@@ -1,1210 +0,0 @@

-/*

-    Copyright (C) 2014  ABRT team

-    Copyright (C) 2014  RedHat Inc

-

-    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 "problem_report.h"

-#include "internal_libreport.h"

-

-#include <satyr/stacktrace.h>

-#include <satyr/abrt.h>

-

-#include <assert.h>

-

-#define DESTROYED_POINTER (void *)0xdeadbeef

-

-/* FORMAT:

- * |%summary:: Hello, world

- * |Problem description:: %bare_comment

- * |

- * |Package:: package

- * |

- * |%attach: %binary, backtrace

- * |

- * |%additional_info::

- * |%reporter%

- * |User:: user_name,uid

- * |

- * |Directories:: root,cwd

- *

- * PARSED DATA (list of struct section_t):

- * {

- *   section_t {

- *      .name     = '%summary';

- *      .items    = { 'Hello, world' };

- *      .children = NULL;

- *   },

- *   section_t {

- *      .name     = '%attach'

- *      .items    = { '%binary', 'backtrace' };

- *      .children = NULL;

- *   },

- *   section_t {

- *      .name     = '%description'

- *      .items    = NULL;

- *      .children = {

- *        section_t {

- *          .name     = 'Problem description:';

- *          .items    = { '%bare_comment' };

- *          .children = NULL;

- *        },

- *        section_t {

- *          .name     = '';

- *          .items    = NULL;

- *          .children = NULL;

- *        },

- *        section_t {

- *          .name     = 'Package:';

- *          .items    = { 'package' };

- *          .children = NULL;

- *        },

- *      }

- *   },

- *   section_t {

- *      .name     = '%additional_info'

- *      .items    = { '%reporter%' };

- *      .children = {

- *        section_t {

- *          .name     = 'User:';

- *          .items    = { 'user_name', 'uid' };

- *          .children = NULL;

- *        },

- *        section_t {

- *          .name     = '';

- *          .items    = NULL;

- *          .children = NULL;

- *        },

- *        section_t {

- *          .name     = 'Directories:';

- *          .items    = { 'root', 'cwd' };

- *          .children = NULL;

- *        },

- *      }

- *   }

- * }

- */

-struct section_t {

-    char *name;      ///< name or output text (%summar, 'Package version:');

-    GList *items;    ///< list of file names and special items (%reporter, %binar, ...)

-    GList *children; ///< list of sub sections (struct section_t)

-};

-

-typedef struct section_t section_t;

-

-static section_t *

-section_new(const char *name)

-{

-    section_t *self = xmalloc(sizeof(*self));

-    self->name = xstrdup(name);

-    self->items = NULL;

-    self->children = NULL;

-

-    return self;

-}

-

-static void

-section_free(section_t *self)

-{

-    if (self == NULL)

-        return;

-

-    free(self->name);

-    g_list_free_full(self->items, free);

-    g_list_free_full(self->children, (GDestroyNotify)section_free);

-

-    free(self);

-}

-

-static int

-section_name_cmp(section_t *lhs, const char *rhs)

-{

-    return strcmp((lhs->name + 1), rhs);

-}

-

-/* Utility functions */

-

-static GList*

-split_string_on_char(const char *str, char ch)

-{

-    GList *list = NULL;

-    for (;;)

-    {

-        const char *delim = strchrnul(str, ch);

-        list = g_list_prepend(list, xstrndup(str, delim - str));

-        if (*delim == '\0')

-            break;

-        str = delim + 1;

-    }

-    return g_list_reverse(list);

-}

-

-static int

-compare_item_name(const char *lookup, const char *name)

-{

-    if (lookup[0] == '-')

-        lookup++;

-    else if (strncmp(lookup, "%bare_", 6) == 0)

-        lookup += 6;

-    return strcmp(lookup, name);

-}

-

-static int

-is_item_name_in_section(const section_t *lookup, const char *name)

-{

-    if (g_list_find_custom(lookup->items, name, (GCompareFunc)compare_item_name))

-        return 0; /* "found it!" */

-    return 1;

-}

-

-static bool is_explicit_or_forbidden(const char *name, GList *comment_fmt_spec);

-

-static int

-is_explicit_or_forbidden_child(const section_t *master_section, const char *name)

-{

-    if (is_explicit_or_forbidden(name, master_section->children))

-        return 0; /* "found it!" */

-    return 1;

-}

-

-/* For example: 'package' belongs to '%oneline', but 'package' is used in

- * 'Version of component', so it is not very helpful to include that file once

- * more in another section

- */

-static bool

-is_explicit_or_forbidden(const char *name, GList *comment_fmt_spec)

-{

-    return    g_list_find_custom(comment_fmt_spec, name, (GCompareFunc)is_item_name_in_section)

-           || g_list_find_custom(comment_fmt_spec, name, (GCompareFunc)is_explicit_or_forbidden_child);

-}

-

-static GList*

-load_stream(FILE *fp)

-{

-    assert(fp);

-

-    GList *sections = NULL;

-    section_t *master = section_new("%description");

-    section_t *sec = NULL;

-

-    sections = g_list_append(sections, master);

-

-    char *line;

-    while ((line = xmalloc_fgetline(fp)) != NULL)

-    {

-        /* Skip comments */

-        char first = *skip_whitespace(line);

-        if (first == '#')

-            goto free_line;

-

-        /* Handle trailing backslash continuation */

- check_continuation: ;

-        unsigned len = strlen(line);

-        if (len && line[len-1] == '\\')

-        {

-            line[len-1] = '\0';

-            char *next_line = xmalloc_fgetline(fp);

-            if (next_line)

-            {

-                line = append_to_malloced_string(line, next_line);

-                free(next_line);

-                goto check_continuation;

-            }

-        }

-

-        /* We are reusing line buffer to form temporary

-         * "key\0values\0..." in its beginning

-         */

-        bool summary_line = false;

-        char *value = NULL;

-        char *src;

-        char *dst;

-        for (src = dst = line; *src; src++)

-        {

-            char c = *src;

-            /* did we reach the value list? */

-            if (!value && c == ':' && src[1] == ':')

-            {

-                *dst++ = '\0'; /* terminate key */

-                src += 1;

-                value = dst; /* remember where value starts */

-                summary_line = (strcmp(line, "%summary") == 0);

-                if (summary_line)

-                {

-                    value = (src + 1);

-                    break;

-                }

-                continue;

-            }

-            /* skip whitespace in value list */

-            if (value && isspace(c))

-                continue;

-            *dst++ = c; /* store next key or value char */

-        }

-

-        GList *item_list = NULL;

-        if (summary_line)

-        {

-            /* %summary is special */

-            item_list = g_list_append(NULL, xstrdup(skip_whitespace(value)));

-        }

-        else

-        {

-            *dst = '\0'; /* terminate value (or key) */

-            if (value)

-                item_list = split_string_on_char(value, ',');

-        }

-

-        sec = section_new(line);

-        sec->items = item_list;

-

-        if (sec->name[0] == '%')

-        {

-            if (!summary_line && strcmp(sec->name, "%attach") != 0)

-            {

-                master->children = g_list_reverse(master->children);

-                master = sec;

-            }