194 lines
7.5 KiB
C++
194 lines
7.5 KiB
C++
//
|
|
// SuperTuxKart - a fun racing game with go-kart
|
|
// Copyright (C) 2013-2015 Glenn De Jonghe
|
|
//
|
|
// 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 3
|
|
// 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
|
|
#ifndef HEADER_ONLINE_PROFILE_HPP
|
|
#define HEADER_ONLINE_PROFILE_HPP
|
|
|
|
#include "utils/types.hpp"
|
|
#include "utils/ptr_vector.hpp"
|
|
|
|
#include "irrString.h"
|
|
|
|
#include <atomic>
|
|
#include <map>
|
|
#include <string>
|
|
|
|
class XMLNode;
|
|
|
|
namespace Online
|
|
{
|
|
/** Class that represents an online profile. It manages the online profile
|
|
* for any user on this system, but also for users for which information
|
|
* is requested (e.g. to see the achievements of friends). All those profiles
|
|
* are managed by the ProfileManager.
|
|
* \ingroup online
|
|
*/
|
|
class OnlineProfile
|
|
{
|
|
public:
|
|
enum ConstructorType
|
|
{
|
|
C_DEFAULT = 1,
|
|
C_RELATION_INFO
|
|
};
|
|
|
|
// ========================================================================
|
|
class RelationInfo
|
|
{
|
|
private:
|
|
bool m_is_online;
|
|
bool m_is_pending;
|
|
bool m_is_asker;
|
|
irr::core::stringw m_date;
|
|
|
|
public:
|
|
RelationInfo(const irr::core::stringw & date, bool is_online,
|
|
bool is_pending, bool is_asker = false);
|
|
void setOnline(bool online);
|
|
|
|
// --------------------------------------------------------------------
|
|
bool isPending() const { return m_is_pending; }
|
|
|
|
// --------------------------------------------------------------------
|
|
bool isAsker() const { return m_is_asker; }
|
|
|
|
// --------------------------------------------------------------------
|
|
const irr::core::stringw & getDate() const { return m_date; }
|
|
|
|
// --------------------------------------------------------------------
|
|
bool isOnline() const { return m_is_online; }
|
|
}; // class RelationInfo
|
|
// ========================================================================
|
|
|
|
typedef std::vector<uint32_t> IDList;
|
|
private:
|
|
|
|
/** The profile can either be fetching data, or be ready. */
|
|
enum State
|
|
{
|
|
S_FETCHING_ACHIEVEMENTS = 0x01,
|
|
S_FETCHING_FRIENDS = 0x02,
|
|
};
|
|
|
|
State m_state;
|
|
bool m_is_current_user;
|
|
uint32_t m_id;
|
|
irr::core::stringw m_username;
|
|
/** information about the relation with the current user */
|
|
RelationInfo * m_relation_info;
|
|
/** Whether or not the user of this profile, is a friend of the current user */
|
|
bool m_is_friend;
|
|
|
|
std::atomic_bool m_has_fetched_friends;
|
|
|
|
/** List of user id's that are friends with the user of this profile.
|
|
* In case this profile is of the current user, this list also contains
|
|
* any id's of users that still have a friend request pending. */
|
|
std::vector<uint32_t> m_friends;
|
|
|
|
bool m_has_fetched_achievements;
|
|
std::vector<uint32_t> m_achievements;
|
|
std::map<uint32_t, irr::core::stringw> m_friend_server_map;
|
|
bool m_cache_bit;
|
|
|
|
void storeFriends(const XMLNode * input);
|
|
void storeAchievements(const XMLNode * input);
|
|
|
|
public:
|
|
OnlineProfile(const uint32_t & userid,
|
|
const irr::core::stringw & username,
|
|
bool is_current_user = false );
|
|
OnlineProfile(const XMLNode * xml, ConstructorType type = C_DEFAULT);
|
|
~OnlineProfile();
|
|
void fetchFriends();
|
|
const IDList& getFriends();
|
|
void fetchAchievements();
|
|
void removeFriend(const uint32_t id);
|
|
void addFriend(const uint32_t id);
|
|
void deleteRelationalInfo();
|
|
const IDList& getAchievements();
|
|
void merge(OnlineProfile * profile);
|
|
// ------------------------------------------------------------------------
|
|
std::map<uint32_t, irr::core::stringw>& getFriendServerMap()
|
|
{ return m_friend_server_map; }
|
|
// ------------------------------------------------------------------------
|
|
/** Returns true if the achievements for this profile have been fetched. */
|
|
bool hasFetchedAchievements() const { return m_has_fetched_achievements; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Unsets the flag that all friends of this profile are in cache. Used
|
|
* when a profile is pushed out of cache. */
|
|
void unsetHasFetchedFriends() { m_has_fetched_friends.store(false); }
|
|
// ------------------------------------------------------------------------
|
|
/** Returns true if the friend list for this profile has been fetched. */
|
|
bool hasFetchedFriends() const { return m_has_fetched_friends.load(); }
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** True if the profile has fetched friends. */
|
|
bool finishedFetchingFriends() const
|
|
{
|
|
return (m_state & S_FETCHING_FRIENDS) == 0;
|
|
} // finishedFetchingFriends
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** True if the profile has fetched friends. */
|
|
bool finishedFetchingAchievements() const
|
|
{
|
|
return (m_state & S_FETCHING_ACHIEVEMENTS) == 0;
|
|
} // hasFetchedAchievements
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Returns true if this item is the current user. */
|
|
bool isCurrentUser() const { return m_is_current_user; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
bool isFriend() const { return m_is_friend; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
void setFriend() { m_is_friend = true; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
RelationInfo* getRelationInfo() { return m_relation_info; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
void setRelationInfo(RelationInfo * r)
|
|
{
|
|
delete m_relation_info; m_relation_info = r;
|
|
} // setRelationInfo
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Sets the cache bit of this profile. Used by the cache eviction
|
|
* algorithm. */
|
|
void setCacheBit(bool cache_bit) { m_cache_bit = cache_bit; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Returns the cache bit for this profile. Used by the cache eviction
|
|
* algorithm. */
|
|
bool getCacheBit() const { return m_cache_bit; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Returns the online id of this profile. */
|
|
uint32_t getID() const { return m_id; }
|
|
|
|
// ------------------------------------------------------------------------
|
|
/** Returns the user name of this profile. */
|
|
const irr::core::stringw& getUserName() const { return m_username; }
|
|
}; // class OnlineProfile
|
|
} // namespace Online
|
|
#endif // HEADER_ONLINE_PROFILE_HPP
|