started conversion of UDatabase, added first tests for framework

you will need a Ultrastar.db in the game folder to pass the tests

3 files changed, 565 insertions, 0 deletions

diff --git a/src/base/database.cpp b/src/base/database.cpp
new file mode 100644
index 00000000..33b5f0b6
--- /dev/null
+++ b/src/base/database.cpp
@@ -0,0 +1,349 @@
+/*
+ * 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$
+ */
+
+#include "database.hpp"
+#include <string.h>
+#include <sstream>
+
+namespace usdx
+{
+	const int db_version = 1;
+	const char usdx_scores[] = "us_scores";
+	const char usdx_songs[]  = "us_songs";
+	const char usdx_statistics_info[] = "us_statistics_info";
+
+	StatDatabase* StatDatabase::instance;
+
+	StatDatabase::StatDatabase(const std::string filename)
+	{
+		this->filename = filename;
+
+		if (SQLITE_OK != sqlite3_open_v2(this->filename.c_str(), &this->database, SQLITE_OPEN_READWRITE | SQLITE_OPEN_CREATE, NULL)) {
+			sqlite3_close(database);
+			throw "Error opening database.";
+		}
+	}
+
+	StatDatabase::~StatDatabase(void)
+	{
+		/* frees database */
+		// TODO: LOG
+		// Log->get_instance()->info("StatDatabase::~StatDatabase") << "~StatDatabase" << endl;
+
+		sqlite3_close(database);
+		database = NULL;
+	}
+
+	StatDatabase* StatDatabase::get_instance()
+	{
+		return instance;
+	}
+
+	void StatDatabase::init(const std::string filename)
+	{
+		// TODO: LOG
+		// Log->get_instance()->status("StatDatabase::init") << "Initializing database: \"" << filename->to_native() << "\"" << endl;
+
+		instance = new StatDatabase(filename);
+		// TODO
+	}
+
+	int StatDatabase::get_version(void)
+	{
+		char sqlStatement[] = "PRAGMA user_version;";
+		sqlite3_stmt *sqliteStatement;
+		int result = -1;
+
+		if (SQLITE_OK != sqlite3_prepare_v2(database, sqlStatement, strlen(sqlStatement), &sqliteStatement, NULL)) {
+			sqlite3_finalize(sqliteStatement);
+			throw "Error preparing statement.";
+		}
+
+		int rc = sqlite3_step(sqliteStatement);
+		if (rc == SQLITE_DONE || rc == SQLITE_ROW) {
+			result = sqlite3_column_int(sqliteStatement, 0);
+		}
+
+		sqlite3_finalize(sqliteStatement);
+		return result;
+	}
+
+	void StatDatabase::set_version(int version)
+	{
+		// format the PRAGMA statement (PRAGMA does _not_ support parameters)
+		std::ostringstream sqlStatementBuffer (std::ostringstream::out);
+		sqlStatementBuffer << "PRAGMA user_version = " << version << ";";
+		std::string sqlStatement = sqlStatementBuffer.str();
+
+		sqlite3_stmt *sqliteStatement;
+		if (SQLITE_OK != sqlite3_prepare_v2(database, sqlStatement.c_str(), sqlStatement.length(), &sqliteStatement, NULL)) {
+			sqlite3_finalize(sqliteStatement);
+
+			// TODO: LOG
+			// std::cerr << sqlite3_errmsg(database) << std::endl;
+			throw "Error preparing statement.";
+		}
+
+		sqlite3_bind_int(sqliteStatement, 1, version);
+		sqlite3_step(sqliteStatement);
+		sqlite3_finalize(sqliteStatement);
+	}
+
+/*	void StatDatabase::read_score(Song *song)
+	{
+		// TODO
+		// var
+		//   TableData:  TSQLiteUniTable;
+		//   Difficulty: integer;
+		//   I: integer;
+		//   PlayerListed: boolean;
+		// begin
+		//   if not Assigned(ScoreDB) then
+		//     Exit;
+
+		//   TableData := nil;
+		//   try
+		//     // Search Song in DB
+		//     TableData := ScoreDB.GetUniTable(
+		//       'SELECT [Difficulty], [Player], [Score], [Date] FROM [' + cUS_Scores + '] ' +
+		//       'WHERE [SongID] = (' +
+		//         'SELECT [ID] FROM [' + cUS_Songs + '] ' +
+		//         'WHERE [Artist] = ? AND [Title] = ? ' +
+		//         'LIMIT 1) ' +
+		//       'ORDER BY [Score] DESC;', //no LIMIT! see filter below!
+		//       [Song.Artist, Song.Title]);
+
+		//     // Empty Old Scores
+		//     SetLength(Song.Score[0], 0); //easy
+		//     SetLength(Song.Score[1], 0); //medium
+		//     SetLength(Song.Score[2], 0); //hard
+
+		//     // Go through all Entrys
+		//     while (not TableData.EOF) do
+		//     begin
+		//       // Add one Entry to Array
+		//       Difficulty := TableData.FieldAsInteger(TableData.FieldIndex['Difficulty']);
+		//       if ((Difficulty >= 0) and (Difficulty <= 2)) and
+		//          (Length(Song.Score[Difficulty]) < 5) then
+		//       begin
+		//         //filter player
+		//         PlayerListed:=false;
+		//         if (Length(Song.Score[Difficulty])>0) then
+		//         begin
+		//           for I := 0 to Length(Song.Score[Difficulty]) - 1 do
+		//           begin
+		//             if (Song.Score[Difficulty, I].Name = TableData.FieldByName['Player']) then
+		//             begin
+		//               PlayerListed:=true;
+		//               break;
+		//             end;
+		//           end;
+		//         end;
+
+		//         if not PlayerListed then
+		//         begin
+		//           SetLength(Song.Score[Difficulty], Length(Song.Score[Difficulty]) + 1);
+
+		//           Song.Score[Difficulty, High(Song.Score[Difficulty])].Name  :=
+		//             TableData.FieldByName['Player'];
+		//           Song.Score[Difficulty, High(Song.Score[Difficulty])].Score :=
+		//             TableData.FieldAsInteger(TableData.FieldIndex['Score']);
+		//           Song.Score[Difficulty, High(Song.Score[Difficulty])].Date :=
+		//             FormatDate(TableData.FieldAsInteger(TableData.FieldIndex['Date']));
+		//         end;
+		//       end;
+
+		//       TableData.Next;
+		//     end; // while
+
+		//   except
+		//     for Difficulty := 0 to 2 do
+		//     begin
+		//       SetLength(Song.Score[Difficulty], 1);
+		//       Song.Score[Difficulty, 1].Name := 'Error Reading ScoreDB';
+		//     end;
+		//   end;
+
+		//   TableData.Free;
+	}
+
+	void StatDatabase::add_score(Song *song, int level, const char* name, int score)
+	{
+		// TODO
+		// var
+		//   ID:        integer;
+		//   TableData: TSQLiteTable;
+		// begin
+		//   if not Assigned(ScoreDB) then
+		//     Exit;
+
+		//   // Prevent 0 Scores from being added EDIT: ==> UScreenTop5.pas!
+		//   //if (Score <= 0) then
+		//   //  Exit;
+
+		//   TableData := nil;
+
+		//   try
+
+		//     ID := ScoreDB.GetTableValue(
+		//         'SELECT [ID] FROM [' + cUS_Songs + '] ' +
+		//         'WHERE [Artist] = ? AND [Title] = ?',
+		//         [Song.Artist, Song.Title]);
+		//     if (ID = 0) then
+		//     begin
+		//       // Create song if it does not exist
+		//       ScoreDB.ExecSQL(
+		//           'INSERT INTO [' + cUS_Songs + '] ' +
+		//           '([ID], [Artist], [Title], [TimesPlayed]) VALUES ' +
+		//           '(NULL, ?, ?, 0);',
+		//           [Song.Artist, Song.Title]);
+		//       // Get song-ID
+		//       ID := ScoreDB.GetLastInsertRowID();
+		//     end;
+		//     // Create new entry
+		//     ScoreDB.ExecSQL(
+		//       'INSERT INTO [' + cUS_Scores + '] ' +
+		//       '([SongID] ,[Difficulty], [Player], [Score], [Date]) VALUES ' +
+		//       '(?, ?, ?, ?, ?);',
+		//       [ID, Level, Name, Score, DateTimeToUnix(Now())]);
+
+		//   except on E: Exception do
+		//     Log.LogError(E.Message, 'TDataBaseSystem.AddScore');
+		//   end;
+
+		//   TableData.Free;
+ 	}
+
+	void StatDatabase::write_score(Song *song)
+	{
+		// TODO
+		// if not Assigned(ScoreDB) then
+		//   Exit;
+
+		// try
+		//   // Increase TimesPlayed
+		//   ScoreDB.ExecSQL(
+		//       'UPDATE [' + cUS_Songs + '] ' +
+		//       'SET [TimesPlayed] = [TimesPlayed] + 1 ' +
+		//       'WHERE [Title] = ? AND [Artist] = ?;',
+		//       [Song.Title, Song.Artist]);
+		// except on E: Exception do
+		//   Log.LogError(E.Message, 'TDataBaseSystem.WriteScore');
+		// end;
+	}
+
+*/
+	const std::string StatDatabase::get_filename(void)
+	{
+		return this->filename;
+	}
+
+
+	StatResult* StatDatabase::get_stats(StatResult *list, short count, unsigned int page, bool reversed)
+	{
+		// TODO
+		return NULL;
+	}
+
+/*	unsigned int StatDatabase::get_total_entrys(StatType type)
+	{
+		// TODO
+		// var
+		//   Query: string;
+		// begin
+		//   Result := 0;
+
+		//   if not Assigned(ScoreDB) then
+		//     Exit;
+
+		//   try
+		//     // Create query
+		//     case Typ of
+		//       stBestScores:
+		//         Query := 'SELECT COUNT([SongID]) FROM [' + cUS_Scores + '];';
+		//       stBestSingers:
+		//         Query := 'SELECT COUNT(DISTINCT [Player]) FROM [' + cUS_Scores + '];';
+		//       stMostSungSong:
+		//         Query := 'SELECT COUNT([ID]) FROM [' + cUS_Songs + '];';
+		//       stMostPopBand:
+		//         Query := 'SELECT COUNT(DISTINCT [Artist]) FROM [' + cUS_Songs + '];';
+		//     end;
+
+		//     Result := ScoreDB.GetTableValue(Query);
+		//   except on E: Exception do
+		//     Log.LogError(E.Message, 'TDataBaseSystem.GetTotalEntrys');
+		//   end;
+	}
+*/
+	time_t StatDatabase::get_stat_reset(void)
+	{
+		// TODO
+		// var
+		//   Query: string;
+		// begin
+		//   Result := 0;
+
+		//   if not Assigned(ScoreDB) then
+		//     Exit;
+
+		//   try
+		//     Query := 'SELECT [ResetTime] FROM [' + cUS_Statistics_Info + '];';
+		//     Result := UnixToDateTime(ScoreDB.GetTableValue(Query));
+		//   except on E: Exception do
+		//     Log.LogError(E.Message, 'TDataBaseSystem.GetStatReset');
+		//   end;
+		return 0;
+	}
+
+	char* StatDatabase::format_date(char* time, size_t max, time_t timestamp)
+	{
+		// TODO
+		// if (timestamp != 0) {
+		// 	struct tm *tmp = localtime(&timestamp);
+		// 	if (tmp) {
+		// 		if (strftime(time, max, Language.Translate("STAT_FORMAT_DATE"), tmp)) {
+		// 			return time;
+		// 		}
+		// 	}
+		// }
+
+		// if (max > 0) {
+		// 	time[0] = '\0';
+		// 	return time;
+		// }
+
+		return NULL;
+	}
+
+	/* recursive delete the list items */
+	StatResult::~StatResult(void)
+	{
+		if (this->next) {
+			delete this->next;
+			this->next = NULL;
+		}
+	}
+};
diff --git a/src/base/database.hpp b/src/base/database.hpp
new file mode 100644
index 00000000..e9ebdb20
--- /dev/null
+++ b/src/base/database.hpp
@@ -0,0 +1,144 @@
+/*
+ * 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 <time.h>
+#include <sqlite3.h>
+#include <iostream>
+#include <string>
+
+namespace usdx
+{
+	class StatResult;
+
+	/* Wrapper for statistic database */
+	class StatDatabase
+	{
+	private:
+		std::string filename;
+		sqlite3 *database;
+
+		// Singleton
+		StatDatabase(std::string filename);
+
+		static StatDatabase* instance;
+	public:
+		static StatDatabase* get_instance();
+
+		~StatDatabase(void);
+
+		static void init(const std::string filename);
+
+		int get_version(void);
+		void set_version(int version);
+
+/*		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);
+
+		time_t get_stat_reset(void);
+		char* format_date(char* time, size_t max, time_t timestamp);
+	};
+
+	/* 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
diff --git a/test/base/database.cpp b/test/base/database.cpp
new file mode 100644
index 00000000..74a5bcad
--- /dev/null
+++ b/test/base/database.cpp
@@ -0,0 +1,72 @@
+/*
+ * 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$
+ */
+
+#include "database.hpp"
+#include <cppunit/extensions/HelperMacros.h>
+
+namespace usdx
+{
+	class StatDatabaseTest : public CppUnit::TestFixture {
+		CPPUNIT_TEST_SUITE(StatDatabaseTest);
+		CPPUNIT_TEST(testNotNull);
+		CPPUNIT_TEST(testGetVersion);
+		CPPUNIT_TEST(testSetAndGetVersion);
+		CPPUNIT_TEST_SUITE_END();
+	private:
+		StatDatabase *db;
+	public:
+		void setUp()
+		{
+			StatDatabase::init("/home/alex/projects/usdx/game/Ultrastar.db");
+		}
+
+		void tearDown()
+		{
+			delete StatDatabase::get_instance();
+		}
+
+		void testNotNull()
+		{
+			CPPUNIT_ASSERT( NULL != StatDatabase::get_instance() );
+		}
+
+		void testGetVersion()
+		{
+			CPPUNIT_ASSERT( 1 == StatDatabase::get_instance()->get_version() );
+		}
+
+		void testSetAndGetVersion()
+		{
+			CPPUNIT_ASSERT( 1 == StatDatabase::get_instance()->get_version() );
+			StatDatabase::get_instance()->set_version(0);
+			CPPUNIT_ASSERT( 0 == StatDatabase::get_instance()->get_version() );
+			StatDatabase::get_instance()->set_version(1);
+			CPPUNIT_ASSERT( 1 == StatDatabase::get_instance()->get_version() );
+		}
+	};
+
+	CPPUNIT_TEST_SUITE_REGISTRATION(StatDatabaseTest);
+};