summaryrefslogtreecommitdiffstats
path: root/lib/MiddleWare/Database.h
blob: ce29f18b408e9b291bcf8351ea3f5e0cb864b1cb (plain)
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
/*
    Database.h - header file for database plugin

    Copyright (C) 2009  Zdenek Prikryl (zprikryl@redhat.com)
    Copyright (C) 2009  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.
    */


#ifndef DATABASE_H_
#define DATABASE_H_

#include <string>
#include <vector>
#include "Plugin.h"

/**
 * Table
 * =====
 * UUID | UID| DebugDumpPath | Count | Reported | Time | Message
 *
 * primary key (UUID, UID)
 */

#define DATABASE_COLUMN_UUID            "UUID"
#define DATABASE_COLUMN_UID             "UID"
#define DATABASE_COLUMN_DEBUG_DUMP_PATH "DebugDumpPath"
#define DATABASE_COLUMN_COUNT           "Count"
#define DATABASE_COLUMN_REPORTED        "Reported"
#define DATABASE_COLUMN_TIME            "Time"
#define DATABASE_COLUMN_MESSAGE         "Message"

/**
 * A struct contains one database row.
 */
typedef struct SDatabaseRow
{
    std::string m_sUUID; /**< A local UUID.*/
    std::string m_sUID; /**< An UID of an user.*/
    std::string m_sDebugDumpDir; /**< A debugdump directory of a crash.*/
    std::string m_sCount; /**< Crash rate.*/
    std::string m_sReported; /**< Is a row reported?*/
    std::string m_sMessage; /**< if a row is reported, then there can be store message abotu that*/
    std::string m_sTime; /**< Time of last occurred crash with same local UUID*/
} database_row_t;

/**
 * A vector contains one or more database rows.
 */
typedef std::vector<database_row_t> vector_database_rows_t;

/**
 * An abstract class. The class defines a database plugin interface.
 */
class CDatabase : public CPlugin
{
    public:
        /**
         * A method, which connects to a database.
         */
        virtual void Connect() = 0;
        /**
         * A method, which disconnects from a database.
         */
        virtual void DisConnect() = 0;
        /**
         * A method, which inserts one row to a database.
         * @param pUUID A local UUID of a crash.
         * @param pUID An UID of an user.
         * @param pDebugDumpPath A debugdump path.
         * @param pTime Time when a crash occurs.
         */
        virtual void Insert(const std::string& pUUID,
                            const std::string& pUID,
                            const std::string& pDebugDumpPath,
                            const std::string& pTime) = 0;
        /**
         * A method, which deletes one row in a database.
         * @param pUUID A lodal UUID of a crash.
         * @param pUID An UID of an user.
         */
        virtual void Delete(const std::string& pUUID,
                            const std::string& pUID) = 0;
        /**
         * A method, which sets that particular row was reported.
         * @param pUUID A local UUID of a crash.
         * @param pUID An UID of an user.
         * @param pMessga A text explanation of reported problem (where
         * it is stored etc...
         */
        virtual void SetReported(const std::string& pUUID,
                                 const std::string& pUID,
                                 const std::string& pMessage) = 0;
        /**
         * A method, which gets all rows which belongs to particular user.
         * If the user is root, then all rows are returned. If there are no
         * rows, empty vector is returned.
         * @param pUID An UID of an user.
         * @return A vector of matched rows.
         */
        virtual const vector_database_rows_t GetUIDData(const std::string& pUID) = 0;
        /**
         * A method, which returns one row accordind to UUID of a crash and
         * UID of an user. If there are no row, empty row is returned.
         * @param pUUID A UUID of a crash.
         * @param pUID An UID of an user.
         * @return A matched row.
         */
        virtual const database_row_t GetUUIDData(const std::string& pUUID,
                                                 const std::string& pUID) = 0;
};

#endif /* DATABASE_H_ */