aboutsummaryrefslogtreecommitdiffstats
path: root/src/base/database.hpp
blob: 08087c7feaa279f3497ff94a04ac9facaa5358ee (plain) (blame)
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
/*
 * UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 */

#ifndef DATABASE_HPP
#define DATABASE_HPP

#include <ctime>
#include <iostream>
#include <string>
#include <sqlite3.h>
#include <log4cxx/logger.h>

namespace usdx
{
	class StatResult;

	/* Wrapper for statistic database */
	class StatDatabase
	{
	private:
		static log4cxx::LoggerPtr log;

		/**
		 * Filename of the opened statistic database.
		 */
		std::string filename;

		/**
		 * Internal reference to the sqlite database handle of the open
		 * sqlite database.
		 */
		sqlite3 *database;

		/**
		 * Wrapper arround the sqlite_prepare_v2 function with propper
		 * logging and exception throwing on error.
		 *
		 * @param sqlStatement SQL Statement for preparing to
		 * 	sqlite3_stmt
		 * @return Pointner to a sqlite3_stmt used for binding
		 * 	parameters and excuting the statement. Need to be freed
		 * 	with sqlite3_finalize.
		 */
		sqlite3_stmt *sqlite_prepare(const std::string sqlStatement);

		/**
		 * Just a quick alias for sqlite_prepare, sqlite3_step and
		 * sqlite3_finalize.
		 */
		void sqlite_exec(const std::string sqlStatement);

		/**
		 * Check if the given table exists in the database.
		 *
		 * @param table Name to check if exists
		 * @return true, if table exists, false if not
		 */
		const bool sqlite_table_exists(const std::string table);

		/**
		 * Check if the given table has the given column by name.
		 *
		 * @param table Table to examine
		 * @param column Name of the column to check if exists
		 * @return true, if column exists in that table, false if not
		 */
		const bool sqlite_table_contains_column(const std::string table, const std::string column);

		// Singleton
		StatDatabase(std::string filename);

		static StatDatabase* instance;

	protected:
		int get_version(void);
		void set_version(int version);

	public:
		static StatDatabase* get_instance();

		~StatDatabase(void);

		/**
		 * Opens a sqlite3 database from the given path and initializes
		 * that class by saving a reference to the open database handle.
		 *
		 * @param filename Filename of a database to open.
		 */
		static void init(const std::string filename);

/*		void read_score(Song *song);
		void add_score(Song *song, int level, const char* name, int score);
		void write_score(Song *song);
*/
		const std::string get_filename(void);

		StatResult* get_stats(StatResult *list, short count, unsigned int page, bool reversed);
//		unsigned int get_total_entrys(StatType type);

		/**
		 * Get the timestamp of the last reset of the database.
		 *
		 * @return Timestamp
		 */
		time_t get_stat_reset(void);

		/**
		 * Convert a timestamp to a data representation in a string.
		 *
		 * @param time Pointer to a char buffer that will contain the
		 * 	the date string.
		 * @param max Maximum bytes that could be written to the buffer.
		 * @param timestamp Timestamp to convert to the string.
		 * @return Pointer to the buffer supplied as first parameter,
		 * 	containing:
		 *		- only a '\\0' at first position if timestamp was
		 * 		  0 or if max was to short to contain the date
		 *		- the date string with the terminating '\\0'
		 */
		char* format_date(char* time, size_t max, time_t timestamp);

#ifdef STAT_DATABASE_TEST
		// for testing private members
		friend class StatDatabaseTest;
#endif
	};

	/* Element for linked list with pointer to next */
	class StatResult
	{
	private:
		StatResult() {};
		StatResult(const StatResult &source) {};
		void operator=(const StatResult &source) {};

	protected:
		StatResult *next;

	public:
		virtual ~StatResult(void);
	};

	class StatResultBestScores : StatResult
	{
	private:
		char *singer;
		unsigned short score;
		unsigned short difficulty;
		char *song_artist;
		char *song_title;
		time_t date;

	public:
		StatResultBestScores(
			char *singer,
			unsigned short score,
			unsigned short difficulty,
			char* song_artist,
			char* song_title,
			time_t date);
		~StatResultBestScores(void);
	};

	class StatResultBestSingers : StatResult
	{
	private:
		char *singer;
		unsigned short average_score;

	public:
		StatResultBestSingers(char *singer, unsigned short average_score);
		~StatResultBestSingers(void);
	};

	class StatResultMostSungSong : StatResult
	{
	private:
		char *song_artist;
		char *song_title;
		unsigned short times_sung;

	public:
		StatResultMostSungSong(char* song_artist, char* song_title, unsigned short times_sung);
		~StatResultMostSungSong(void);
	};

	class StatResultMostSungBand : StatResult
	{
	private:
		char *song_artist;
		unsigned short times_sung;

	public:
		StatResultMostSungBand(char* song_artist, unsigned short times_sung);
		~StatResultMostSungBand(void);
	};
};

#endif