ilikecats/stk-code_catmod
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added separate create() function for ProfileManager, and some cosmetic changes.

Browse Source
This commit is contained in:
hiker 2014-02-26 16:34:46 +11:00
parent 4d6b110e56
commit 1c6d63acc7
3 changed files with 245 additions and 220 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
src/main.cpp
View File

@ -158,8 +158,8 @@
#include "guiengine/engine.hpp"
#include "guiengine/event_handler.hpp"
#include "guiengine/dialog_queue.hpp"
#include "input/input_manager.hpp"
#include "input/device_manager.hpp"
#include "input/input_manager.hpp"
#include "input/wiimote_manager.hpp"
#include "io/file_manager.hpp"
#include "items/attachment_manager.hpp"
@ -170,20 +170,18 @@
#include "karts/kart_properties_manager.hpp"
#include "modes/demo_world.hpp"
#include "modes/profile_world.hpp"
#include "network/client_network_manager.hpp"
#include "network/network_manager.hpp"
#include "network/protocol_manager.hpp"
#include "network/protocols/server_lobby_room_protocol.hpp"
#include "network/server_network_manager.hpp"
#include "network/client_network_manager.hpp"
#include "network/server_network_manager.hpp"
#include "network/protocol_manager.hpp"
#include "network/protocols/server_lobby_room_protocol.hpp"
#include "online/current_user.hpp"
#include "online/request_manager.hpp"
#include "network/client_network_manager.hpp"
#include "network/server_network_manager.hpp"
#include "network/protocol_manager.hpp"
#include "network/protocols/server_lobby_room_protocol.hpp"
#include "online/current_user.hpp"
#include "online/request_manager.hpp"
#include "online/profile_manager.hpp"
#include "online/request_manager.hpp"
#include "online/servers_manager.hpp"
#include "race/grand_prix_manager.hpp"
#include "race/highscore_manager.hpp"
@ -1009,6 +1007,7 @@ void initRest()
// online section of the addons manager will be initialised from a
// separate thread running in network http.
addons_manager = new AddonsManager();
Online::ProfileManager::create();
Online::RequestManager::get()->startNetworkThread();
NewsManager::get(); // this will create the news manager
@ -1393,7 +1392,7 @@ static void cleanSuperTuxKart()
//see InitTuxkart()
Online::RequestManager::deallocate();
Online::ServersManager::deallocate();
Online::ProfileManager::deallocate();
Online::ProfileManager::destroy();
Online::CurrentUser::deallocate();
GUIEngine::DialogQueue::deallocate();

329
src/online/profile_manager.cpp
View File

@ -29,202 +29,195 @@
using namespace Online;
namespace Online{
static ProfileManager* profile_manager_singleton(NULL);
namespace Online
{
ProfileManager* ProfileManager::get()
{
if (profile_manager_singleton == NULL)
profile_manager_singleton = new ProfileManager();
return profile_manager_singleton;
ProfileManager* ProfileManager::m_profile_manager = NULL;
// ------------------------------------------------------------------------
/** Private constructor, used by static create() function.
*/
ProfileManager::ProfileManager()
{
assert(m_max_cache_size > 1);
m_currently_visiting = NULL;
} // ProfileManager
// ------------------------------------------------------------------------
/** Destructor, which frees the persistent and cached data.
*/
ProfileManager::~ProfileManager()
{
clearPersistent();
ProfilesMap::iterator it;
for (it = m_profiles_cache.begin(); it != m_profiles_cache.end(); ++it) {
delete it->second;
}
} // ~ProfileManager
void ProfileManager::deallocate()
// ------------------------------------------------------------------------
void ProfileManager::iterateCache(Profile * profile)
{
if (m_profiles_cache.size() == m_max_cache_size)
{
delete profile_manager_singleton;
profile_manager_singleton = NULL;
} // deallocate
// ============================================================================
ProfileManager::ProfileManager()
{
assert(m_max_cache_size > 1);
m_currently_visiting = NULL;
}
// ============================================================================
ProfileManager::~ProfileManager()
{
clearPersistent();
ProfilesMap::iterator it;
for ( it = m_profiles_cache.begin(); it != m_profiles_cache.end(); ++it ) {
delete it->second;
}
}
// ============================================================================
void ProfileManager::iterateCache(Profile * profile)
{
if(m_profiles_cache.size() == m_max_cache_size)
profile->setCacheBit(true);
ProfilesMap::iterator iter;
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end(); ++iter)
{
profile->setCacheBit(true);
ProfilesMap::iterator iter;
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end(); ++iter)
if (!iter->second->getCacheBit())
return;
}
//All cache bits are one! Set them all to zero except the one currently being visited
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end(); ++iter)
{
iter->second->setCacheBit(false);
}
profile->setCacheBit(true);
}
} // iterateCache
// ------------------------------------------------------------------------
/** Initialisation before the object is displayed. If necessary this function
* will pause the race if it is running (i.e. world exists). While only some
* of the screen can be shown during the race (via the in-game menu you
* can get the options screen and the help screens only). This is used by
* the RaceResultGUI to leave the race running (for the end animation) while
* the results are being shown.
*/
void ProfileManager::directToCache(Profile * profile)
{
assert(profile != NULL);
if (m_profiles_cache.size() == m_max_cache_size)
{
ProfilesMap::iterator iter;
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end();)
{
if (!iter->second->getCacheBit())
{
if (!iter->second->getCacheBit())
return;
delete iter->second;
m_profiles_cache.erase(iter);
break;
}
//All cache bits are one! Set them all to zero except the one currently being visited
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end(); ++iter)
{
iter->second->setCacheBit(false);
}
profile->setCacheBit(true);
}
}
// ============================================================================
/** Initialisation before the object is displayed. If necessary this function
* will pause the race if it is running (i.e. world exists). While only some
* of the screen can be shown during the race (via the in-game menu you
* can get the options screen and the help screens only). This is used by
* the RaceResultGUI to leave the race running (for the end animation) while
* the results are being shown.
*/
void ProfileManager::directToCache(Profile * profile)
{
assert(profile != NULL);
if(m_profiles_cache.size() == m_max_cache_size)
{
ProfilesMap::iterator iter;
for (iter = m_profiles_cache.begin(); iter != m_profiles_cache.end();)
{
if (!iter->second->getCacheBit())
{
delete iter->second;
m_profiles_cache.erase(iter);
break;
}
else
++iter;
}
}
m_profiles_cache[profile->getID()] = profile;
assert(m_profiles_cache.size() <= m_max_cache_size);
}
// ============================================================================
/**
* Adds a profile to the persistent map.
* If a profile with the same id is already in there, the profiles are "merged" with as goal saving as much information.
* (i.e. one profile instance could have already fetched the friends, while the other could have fetched the achievements.)
*/
void ProfileManager::addPersistent(Profile * profile)
{
if(inPersistent(profile->getID()))
{
m_profiles_persistent[profile->getID()]->merge(profile);
}
else
{
m_profiles_persistent[profile->getID()] = profile;
else
++iter;
}
}
// ============================================================================
/**
* Removes and deletes an entry from the persistent map.
*/
void ProfileManager::deleteFromPersistent(const uint32_t id)
m_profiles_cache[profile->getID()] = profile;
assert(m_profiles_cache.size() <= m_max_cache_size);
} // directToCache
// ------------------------------------------------------------------------
/** Adds a profile to the persistent map. If a profile with the same id
* is already in there, the profiles are "merged" with as goal saving as
* much information (i.e. one profile instance could have already fetched
* the friends, while the other could have fetched the achievements.)
*/
void ProfileManager::addPersistent(Profile * profile)
{
if (inPersistent(profile->getID()))
{
if (inPersistent(id))
{
delete m_profiles_persistent[id];
m_profiles_persistent.erase(id);
}
else
Log::warn("ProfileManager::removePersistent", "Tried to remove profile with id %d from persistent while not present", id);
m_profiles_persistent[profile->getID()]->merge(profile);
}
// ============================================================================
void ProfileManager::clearPersistent()
else
{
ProfilesMap::iterator it;
for ( it = m_profiles_persistent.begin(); it != m_profiles_persistent.end(); ++it ) {
delete it->second;
}
m_profiles_persistent.clear();
m_profiles_persistent[profile->getID()] = profile;
}
} // addPersistent
// ============================================================================
void ProfileManager::moveToCache(const uint32_t id)
// ------------------------------------------------------------------------
/**
* Removes and deletes an entry from the persistent map.
*/
void ProfileManager::deleteFromPersistent(const uint32_t id)
{
if (inPersistent(id))
{
if (inPersistent(id))
{
Profile * profile = getProfileByID(id);
m_profiles_persistent.erase(id);
addToCache(profile);
}
else
Log::warn("ProfileManager::moveToCache", "Tried to move profile with id %d from persistent to cache while not present", id);
delete m_profiles_persistent[id];
m_profiles_persistent.erase(id);
}
else
Log::warn("ProfileManager::removePersistent", "Tried to remove profile with id %d from persistent while not present", id);
} // deleteFromPersistent
// ============================================================================
// ------------------------------------------------------------------------
void ProfileManager::addToCache(Profile * profile)
void ProfileManager::clearPersistent()
{
ProfilesMap::iterator it;
for (it = m_profiles_persistent.begin(); it != m_profiles_persistent.end(); ++it) {
delete it->second;
}
m_profiles_persistent.clear();
} // clearPersistent
// ------------------------------------------------------------------------
void ProfileManager::moveToCache(const uint32_t id)
{
if (inPersistent(id))
{
if(inPersistent(profile->getID()))
m_profiles_persistent[profile->getID()]->merge(profile);
else if(cacheHit(profile->getID()))
m_profiles_cache[profile->getID()]->merge(profile);
else
directToCache(profile);
Profile * profile = getProfileByID(id);
m_profiles_persistent.erase(id);
addToCache(profile);
}
else
Log::warn("ProfileManager::moveToCache", "Tried to move profile with id %d from persistent to cache while not present", id);
} // moveToCache
// ============================================================================
// ------------------------------------------------------------------------
bool ProfileManager::inPersistent(const uint32_t id)
void ProfileManager::addToCache(Profile * profile)
{
if (inPersistent(profile->getID()))
m_profiles_persistent[profile->getID()]->merge(profile);
else if (cacheHit(profile->getID()))
m_profiles_cache[profile->getID()]->merge(profile);
else
directToCache(profile);
} // addToCache
// ------------------------------------------------------------------------
bool ProfileManager::inPersistent(const uint32_t id)
{
if (m_profiles_persistent.find(id) != m_profiles_persistent.end())
return true;
return false;
} // inPersistent
// ------------------------------------------------------------------------
bool ProfileManager::cacheHit(const uint32_t id)
{
if (m_profiles_cache.find(id) != m_profiles_cache.end())
{
if (m_profiles_persistent.find(id) != m_profiles_persistent.end())
return true;
return false;
iterateCache(m_profiles_cache[id]);
return true;
}
return false;
} // cacheHit
// ============================================================================
// ------------------------------------------------------------------------
void ProfileManager::setVisiting(const uint32_t id)
{
m_currently_visiting = getProfileByID(id);
} // setVisiting
bool ProfileManager::cacheHit(const uint32_t id)
{
if (m_profiles_cache.find(id) != m_profiles_cache.end())
{
iterateCache(m_profiles_cache[id]);
return true;
}
return false;
}
// ------------------------------------------------------------------------
// ============================================================================
void ProfileManager::setVisiting(const uint32_t id)
{
m_currently_visiting = getProfileByID(id);
}
// ============================================================================
Profile * ProfileManager::getProfileByID(const uint32_t id)
{
if(inPersistent(id))
return m_profiles_persistent[id];
if(cacheHit(id))
return m_profiles_cache[id];
//FIXME not able to get! Now this should actually fetch the info from the server, but I haven't come up with a good asynchronous idea yet.
return NULL;
}
Profile * ProfileManager::getProfileByID(const uint32_t id)
{
if (inPersistent(id))
return m_profiles_persistent[id];
if (cacheHit(id))
return m_profiles_cache[id];
//FIXME not able to get! Now this should actually fetch the info from the
// server, but I haven't come up with a good asynchronous idea yet.
return NULL;
} // getProfileByID
} // namespace Online

119
src/online/profile_manager.hpp
View File

@ -27,52 +27,85 @@
#include <string>
namespace Online{
/**
* \brief Class that takes care of online profiles
* \ingroup online
*/
class ProfileManager
namespace Online
{
/** Class that takes care of online profiles.
* \ingroup online.
*/
class ProfileManager
{
private:
/** Singleton pointer. */
static ProfileManager* m_profile_manager;
ProfileManager();
~ProfileManager();
/** The mapping of ids to profile. */
typedef std::map<uint32_t, Profile*> ProfilesMap;
/** A map of profiles that is persistent. (i.e. no automatic
* removing happens) Normally used for the current user's profile
* and friends. */
ProfilesMap m_profiles_persistent;
/** Any profiles that don't go into the persistent map, go here.
* Using a Least Recent Used caching algorithm with age bits to
* remove entries when the max size is reached.*/
ProfilesMap m_profiles_cache;
/** A temporary profile that is currently being 'visited',
* e.g. its data is shown in a gui. */
Profile* m_currently_visiting;
/** The max size of the m_profiles cache. */
static const unsigned int m_max_cache_size = 20;
void iterateCache(Profile * profile);
void directToCache(Profile * profile);
public:
/** Create the singleton instance. */
static void create()
{
assert(!m_profile_manager);
m_profile_manager = new ProfileManager();
} // create
// ----------------------------------------------------------------
/** Returns the singleton.
* \pre create has been called to create the singleton.
*/
static ProfileManager* get()
{
assert(m_profile_manager);
return m_profile_manager;
} // get
// ----------------------------------------------------------------
/** Destroys the singleton. */
static void destroy()
{
assert(m_profile_manager);
delete m_profile_manager;
m_profile_manager = NULL;
} // destroy
// ----------------------------------------------------------------
private:
ProfileManager ();
~ProfileManager ();
void addToCache(Profile * profile);
void addPersistent(Profile * profile);
void deleteFromPersistent(const uint32_t id);
void clearPersistent();
void moveToCache(const uint32_t id);
void setVisiting(const uint32_t id);
bool cacheHit(const uint32_t id);
bool inPersistent(const uint32_t id);
Profile* getProfileByID(const uint32_t id);
// ----------------------------------------------------------------
/** \return the instance of the profile that's currently being
* visited */
Profile* getVisitingProfile() { return m_currently_visiting; }
typedef std::map<uint32_t, Profile*> ProfilesMap;
/** A map of profiles that is persistent. (i.e. no automatic removing happens) Normally used for the current user's profile and friends. */
ProfilesMap m_profiles_persistent;
/**
* Any profiles that don't go into the persistent map, go here.
* Using a Least Recent Used caching algorithm with age bits to remove entries when the max size is reached.
**/
ProfilesMap m_profiles_cache;
Profile * m_currently_visiting;
/** The max size of the m_profiles cache. */
static const unsigned int m_max_cache_size = 20;
void iterateCache(Profile * profile);
void directToCache(Profile * profile);
public:
/**Singleton */
static ProfileManager * get();
static void deallocate();
void addToCache(Profile * profile);
void addPersistent(Profile * profile);
void deleteFromPersistent(const uint32_t id);
void clearPersistent();
void moveToCache(const uint32_t id);
void setVisiting(const uint32_t id);
bool cacheHit(const uint32_t id);
bool inPersistent(const uint32_t id);
/** \return the instance of the profile that's currently being visited */
Profile * getVisitingProfile() {return m_currently_visiting;}
Profile * getProfileByID(const uint32_t id);
}; // class CurrentUser
}; // class CurrentUser
} // namespace Online